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
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
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.
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."
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."
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."
133 (const :tag
"Disabled" nil
)
137 (defgroup org-agenda-export nil
138 "Options concerning exporting agenda views in Org-mode."
139 :tag
"Org Agenda Export"
142 (defcustom org-agenda-with-colors t
143 "Non-nil means use colors in agenda views."
144 :group
'org-agenda-export
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
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
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'."
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."
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 {
217 .title { text-align: center; }
218 .todo, .deadline { color: red; }
219 .done { color: green; }
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
232 (defcustom org-agenda-persistent-filter nil
233 "When set, keep filters from one agenda view to the next."
237 (defgroup org-agenda-custom-commands nil
238 "Options concerning agenda views in Org-mode."
239 :tag
"Org Agenda Custom Commands"
242 (defconst org-sorting-choice
244 (const time-up
) (const time-down
)
245 (const timestamp-up
) (const timestamp-down
)
246 (const scheduled-up
) (const scheduled-down
)
247 (const deadline-up
) (const deadline-down
)
248 (const ts-up
) (const ts-down
)
249 (const tsia-up
) (const tsia-down
)
250 (const category-keep
) (const category-up
) (const category-down
)
251 (const tag-down
) (const tag-up
)
252 (const priority-up
) (const priority-down
)
253 (const todo-state-up
) (const todo-state-down
)
254 (const effort-up
) (const effort-down
)
255 (const habit-up
) (const habit-down
)
256 (const alpha-up
) (const alpha-down
)
257 (const user-defined-up
) (const user-defined-down
))
260 ;; Keep custom values for `org-agenda-filter-preset' compatible with
261 ;; the new variable `org-agenda-tag-filter-preset'.
262 (org-defvaralias 'org-agenda-filter-preset
'org-agenda-tag-filter-preset
)
263 (org-defvaralias 'org-agenda-filter
'org-agenda-tag-filter
)
265 (defvar org-agenda-entry-types
'(:deadline
:scheduled
:timestamp
:sexp
)
266 "List of types searched for when creating the daily/weekly agenda.
267 This variable is a list of symbols that controls the types of
268 items that appear in the daily/weekly agenda. Allowed symbols in this
271 :timestamp List items containing a date stamp or date range matching
272 the selected date. This includes sexp entries in angular
275 :sexp List entries resulting from plain diary-like sexps.
277 :deadline List deadline due on that date. When the date is today,
278 also list any deadlines past due, or due within
279 `org-deadline-warning-days'. `:deadline' must appear before
280 `:scheduled' if the setting of
281 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
284 :deadline* Same as above, but only include the deadline if it has an
285 hour specification as [h]h:mm.
287 :scheduled List all items which are scheduled for the given date.
288 The diary for *today* also contains items which were
289 scheduled earlier and are not yet marked DONE.
291 :scheduled* Same as above, but only include the scheduled item if it
292 has an hour specification as [h]h:mm.
294 By default, all four non-starred types are turned on.
296 When :scheduled* or :deadline* are included, :schedule or :deadline
299 Never set this variable globally using `setq', because then it
300 will apply to all future agenda commands. Instead, bind it with
301 `let' to scope it dynamically into the agenda-constructing
302 command. A good way to set it is through options in
303 `org-agenda-custom-commands'. For a more flexible (though
304 somewhat less efficient) way of determining what is included in
305 the daily/weekly agenda, see `org-agenda-skip-function'.")
307 (defconst org-agenda-custom-commands-local-options
308 `(repeat :tag
"Local settings for this command. Remember to quote values"
309 (choice :tag
"Setting"
310 (list :tag
"Heading for this block"
311 (const org-agenda-overriding-header
)
312 (string :tag
"Headline"))
313 (list :tag
"Files to be searched"
314 (const org-agenda-files
)
316 (const :format
"" quote
)
318 (list :tag
"Sorting strategy"
319 (const org-agenda-sorting-strategy
)
321 (const :format
"" quote
)
323 ,org-sorting-choice
)))
324 (list :tag
"Prefix format"
325 (const org-agenda-prefix-format
:value
" %-12:c%?-12t% s")
327 (list :tag
"Number of days in agenda"
328 (const org-agenda-span
)
329 (choice (const :tag
"Day" 'day
)
330 (const :tag
"Week" 'week
)
331 (const :tag
"Month" 'month
)
332 (const :tag
"Year" 'year
)
333 (integer :tag
"Custom")))
334 (list :tag
"Fixed starting date"
335 (const org-agenda-start-day
)
336 (string :value
"2007-11-01"))
337 (list :tag
"Start on day of week"
338 (const org-agenda-start-on-weekday
)
340 (const :tag
"Today" nil
)
341 (integer :tag
"Weekday No.")))
342 (list :tag
"Include data from diary"
343 (const org-agenda-include-diary
)
345 (list :tag
"Deadline Warning days"
346 (const org-deadline-warning-days
)
348 (list :tag
"Category filter preset"
349 (const org-agenda-category-filter-preset
)
351 (const :format
"" quote
)
353 (string :tag
"+category or -category"))))
354 (list :tag
"Tags filter preset"
355 (const org-agenda-tag-filter-preset
)
357 (const :format
"" quote
)
359 (string :tag
"+tag or -tag"))))
360 (list :tag
"Regexp filter preset"
361 (const org-agenda-regexp-filter-preset
)
363 (const :format
"" quote
)
365 (string :tag
"+regexp or -regexp"))))
366 (list :tag
"Set daily/weekly entry types"
367 (const org-agenda-entry-types
)
369 (const :format
"" quote
)
370 (set :greedy t
:value
,org-agenda-entry-types
377 (list :tag
"Standard skipping condition"
378 :value
(org-agenda-skip-function '(org-agenda-skip-entry-if))
379 (const org-agenda-skip-function
)
381 (const :format
"" quote
)
384 :tag
"Skipping range"
385 (const :tag
"Skip entry" org-agenda-skip-entry-if
)
386 (const :tag
"Skip subtree" org-agenda-skip-subtree-if
))
387 (repeat :inline t
:tag
"Conditions for skipping"
389 :tag
"Condition type"
390 (list :tag
"Regexp matches" :inline t
(const :format
"" 'regexp
) (regexp))
391 (list :tag
"Regexp does not match" :inline t
(const :format
"" 'notregexp
) (regexp))
392 (list :tag
"TODO state is" :inline t
395 (const :tag
"any not-done state" 'todo
)
396 (const :tag
"any done state" 'done
)
397 (const :tag
"any state" 'any
)
398 (list :tag
"Keyword list"
399 (const :format
"" quote
)
400 (repeat (string :tag
"Keyword")))))
401 (list :tag
"TODO state is not" :inline t
404 (const :tag
"any not-done state" 'todo
)
405 (const :tag
"any done state" 'done
)
406 (const :tag
"any state" 'any
)
407 (list :tag
"Keyword list"
408 (const :format
"" quote
)
409 (repeat (string :tag
"Keyword")))))
410 (const :tag
"scheduled" 'scheduled
)
411 (const :tag
"not scheduled" 'notscheduled
)
412 (const :tag
"deadline" 'deadline
)
413 (const :tag
"no deadline" 'notdeadline
)
414 (const :tag
"timestamp" 'timestamp
)
415 (const :tag
"no timestamp" 'nottimestamp
))))))
416 (list :tag
"Non-standard skipping condition"
417 :value
(org-agenda-skip-function)
418 (const org-agenda-skip-function
)
419 (sexp :tag
"Function or form (quoted!)"))
420 (list :tag
"Any variable"
421 (variable :tag
"Variable")
422 (sexp :tag
"Value (sexp)"))))
423 "Selection of examples for agenda command settings.
424 This will be spliced into the custom type of
425 `org-agenda-custom-commands'.")
428 (defcustom org-agenda-custom-commands
429 '(("n" "Agenda and all TODO's" ((agenda "") (alltodo ""))))
430 "Custom commands for the agenda.
431 These commands will be offered on the splash screen displayed by the
432 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
434 (key desc type match settings files)
436 key The key (one or more characters as a string) to be associated
438 desc A description of the command, when omitted or nil, a default
439 description is built using MATCH.
440 type The command type, any of the following symbols:
441 agenda The daily/weekly agenda.
442 todo Entries with a specific TODO keyword, in all agenda files.
443 search Entries containing search words entry or headline.
444 tags Tags/Property/TODO match in all agenda files.
445 tags-todo Tags/P/T match in all agenda files, TODO entries only.
446 todo-tree Sparse tree of specific TODO keyword in *current* file.
447 tags-tree Sparse tree with all tags matches in *current* file.
448 occur-tree Occur sparse tree for *current* file.
449 ... A user-defined function.
450 match What to search for:
451 - a single keyword for TODO keyword searches
452 - a tags match expression for tags searches
453 - a word search expression for text searches.
454 - a regular expression for occur searches
455 For all other commands, this should be the empty string.
456 settings A list of option settings, similar to that in a let form, so like
457 this: ((opt1 val1) (opt2 val2) ...). The values will be
458 evaluated at the moment of execution, so quote them when needed.
459 files A list of files file to write the produced agenda buffer to
460 with the command `org-store-agenda-views'.
461 If a file name ends in \".html\", an HTML version of the buffer
462 is written out. If it ends in \".ps\", a postscript version is
463 produced. Otherwise, only the plain text is written to the file.
465 You can also define a set of commands, to create a composite agenda buffer.
466 In this case, an entry looks like this:
468 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
472 desc A description string to be displayed in the dispatcher menu.
473 cmd An agenda command, similar to the above. However, tree commands
474 are not allowed, but instead you can get agenda and global todo list.
475 So valid commands for a set are:
476 (agenda \"\" settings)
477 (alltodo \"\" settings)
478 (stuck \"\" settings)
479 (todo \"match\" settings files)
480 (search \"match\" settings files)
481 (tags \"match\" settings files)
482 (tags-todo \"match\" settings files)
484 Each command can carry a list of options, and another set of options can be
485 given for the whole set of commands. Individual command options take
486 precedence over the general options.
488 When using several characters as key to a command, the first characters
489 are prefix commands. For the dispatcher to display useful information, you
490 should provide a description for the prefix, like
492 (setq org-agenda-custom-commands
493 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
494 (\"hl\" tags \"+HOME+Lisa\")
495 (\"hp\" tags \"+HOME+Peter\")
496 (\"hk\" tags \"+HOME+Kim\")))"
497 :group
'org-agenda-custom-commands
499 (choice :value
("x" "Describe command here" tags
"" nil
)
500 (list :tag
"Single command"
501 (string :tag
"Access Key(s) ")
502 (option (string :tag
"Description"))
504 (const :tag
"Agenda" agenda
)
505 (const :tag
"TODO list" alltodo
)
506 (const :tag
"Search words" search
)
507 (const :tag
"Stuck projects" stuck
)
508 (const :tag
"Tags/Property match (all agenda files)" tags
)
509 (const :tag
"Tags/Property match of TODO entries (all agenda files)" tags-todo
)
510 (const :tag
"TODO keyword search (all agenda files)" todo
)
511 (const :tag
"Tags sparse tree (current buffer)" tags-tree
)
512 (const :tag
"TODO keyword tree (current buffer)" todo-tree
)
513 (const :tag
"Occur tree (current buffer)" occur-tree
)
514 (sexp :tag
"Other, user-defined function"))
515 (string :tag
"Match (only for some commands)")
516 ,org-agenda-custom-commands-local-options
517 (option (repeat :tag
"Export" (file :tag
"Export to"))))
518 (list :tag
"Command series, all agenda files"
519 (string :tag
"Access Key(s)")
520 (string :tag
"Description ")
521 (repeat :tag
"Component"
524 (const :format
"" agenda
)
525 (const :tag
"" :format
"" "")
526 ,org-agenda-custom-commands-local-options
)
527 (list :tag
"TODO list (all keywords)"
528 (const :format
"" alltodo
)
529 (const :tag
"" :format
"" "")
530 ,org-agenda-custom-commands-local-options
)
531 (list :tag
"Search words"
532 (const :format
"" search
)
533 (string :tag
"Match")
534 ,org-agenda-custom-commands-local-options
)
535 (list :tag
"Stuck projects"
536 (const :format
"" stuck
)
537 (const :tag
"" :format
"" "")
538 ,org-agenda-custom-commands-local-options
)
539 (list :tag
"Tags search"
540 (const :format
"" tags
)
541 (string :tag
"Match")
542 ,org-agenda-custom-commands-local-options
)
543 (list :tag
"Tags search, TODO entries only"
544 (const :format
"" tags-todo
)
545 (string :tag
"Match")
546 ,org-agenda-custom-commands-local-options
)
547 (list :tag
"TODO keyword search"
548 (const :format
"" todo
)
549 (string :tag
"Match")
550 ,org-agenda-custom-commands-local-options
)
551 (list :tag
"Other, user-defined function"
552 (symbol :tag
"function")
553 (string :tag
"Match")
554 ,org-agenda-custom-commands-local-options
)))
556 (repeat :tag
"Settings for entire command set"
557 (list (variable :tag
"Any variable")
558 (sexp :tag
"Value")))
559 (option (repeat :tag
"Export" (file :tag
"Export to"))))
560 (cons :tag
"Prefix key documentation"
561 (string :tag
"Access Key(s)")
562 (string :tag
"Description ")))))
564 (defcustom org-agenda-query-register ?o
565 "The register holding the current query string.
566 The purpose of this is that if you construct a query string interactively,
567 you can then use it to define a custom command."
568 :group
'org-agenda-custom-commands
571 (defcustom org-stuck-projects
572 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil
"")
573 "How to identify stuck projects.
574 This is a list of four items:
575 1. A tags/todo/property matcher string that is used to identify a project.
576 See the manual for a description of tag and property searches.
577 The entire tree below a headline matched by this is considered one project.
578 2. A list of TODO keywords identifying non-stuck projects.
579 If the project subtree contains any headline with one of these todo
580 keywords, the project is considered to be not stuck. If you specify
581 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
582 3. A list of tags identifying non-stuck projects.
583 If the project subtree contains any headline with one of these tags,
584 the project is considered to be not stuck. If you specify \"*\" as
585 a tag, any tag will mark the project unstuck. Note that this is about
586 the explicit presence of a tag somewhere in the subtree, inherited
587 tags do not count here. If inherited tags make a project not stuck,
588 use \"-TAG\" in the tags part of the matcher under (1.) above.
589 4. An arbitrary regular expression matching non-stuck projects.
591 If the project turns out to be not stuck, search continues also in the
592 subtree to see if any of the subtasks have project status.
594 See also the variable `org-tags-match-list-sublevels' which applies
595 to projects matched by this search as well.
597 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
598 or `C-c a #' to produce the list."
599 :group
'org-agenda-custom-commands
601 (string :tag
"Tags/TODO match to identify a project")
602 (repeat :tag
"Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
603 (repeat :tag
"Projects are *not* stuck if they have an entry with TAG being any of" (string))
604 (regexp :tag
"Projects are *not* stuck if this regexp matches inside the subtree")))
606 (defcustom org-agenda-filter-effort-default-operator
"<"
607 "The default operator for effort estimate filtering.
608 If you select an effort estimate limit without first pressing an operator,
609 this one will be used."
610 :group
'org-agenda-custom-commands
611 :type
'(choice (const :tag
"less or equal" "<")
612 (const :tag
"greater or equal"">")
613 (const :tag
"equal" "=")))
615 (defgroup org-agenda-skip nil
616 "Options concerning skipping parts of agenda files."
617 :tag
"Org Agenda Skip"
620 (defcustom org-agenda-skip-function-global nil
621 "Function to be called at each match during agenda construction.
622 If this function returns nil, the current match should not be skipped.
623 If the function decided to skip an agenda match, is must return the
624 buffer position from which the search should be continued.
625 This may also be a Lisp form, which will be evaluated.
627 This variable will be applied to every agenda match, including
628 tags/property searches and TODO lists. So try to make the test function
629 do its checking as efficiently as possible. To implement a skipping
630 condition just for specific agenda commands, use the variable
631 `org-agenda-skip-function' which can be set in the options section
632 of custom agenda commands."
633 :group
'org-agenda-skip
636 (defgroup org-agenda-daily
/weekly nil
637 "Options concerning the daily/weekly agenda."
638 :tag
"Org Agenda Daily/Weekly"
640 (defgroup org-agenda-todo-list nil
641 "Options concerning the global todo list agenda view."
642 :tag
"Org Agenda Todo List"
644 (defgroup org-agenda-match-view nil
645 "Options concerning the general tags/property/todo match agenda view."
646 :tag
"Org Agenda Match View"
648 (defgroup org-agenda-search-view nil
649 "Options concerning the general tags/property/todo match agenda view."
650 :tag
"Org Agenda Match View"
653 (defvar org-agenda-archives-mode nil
654 "Non-nil means the agenda will include archived items.
655 If this is the symbol `trees', trees in the selected agenda scope
656 that are marked with the ARCHIVE tag will be included anyway. When this is
657 t, also all archive files associated with the current selection of agenda
658 files will be included.")
660 (defcustom org-agenda-skip-comment-trees t
661 "Non-nil means skip trees that start with the COMMENT keyword.
662 When nil, these trees are also scanned by agenda commands."
663 :group
'org-agenda-skip
666 (defcustom org-agenda-todo-list-sublevels t
667 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
668 When nil, the sublevels of a TODO entry are not checked, resulting in
669 potentially much shorter TODO lists."
670 :group
'org-agenda-skip
671 :group
'org-agenda-todo-list
674 (defcustom org-agenda-todo-ignore-with-date nil
675 "Non-nil means don't show entries with a date in the global todo list.
676 You can use this if you prefer to mark mere appointments with a TODO keyword,
677 but don't want them to show up in the TODO list.
678 When this is set, it also covers deadlines and scheduled items, the settings
679 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
681 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
682 :group
'org-agenda-skip
683 :group
'org-agenda-todo-list
686 (defcustom org-agenda-todo-ignore-timestamp nil
687 "Non-nil means don't show entries with a timestamp.
688 This applies when creating the global todo list.
691 past Don't show entries for today or in the past.
693 future Don't show entries with a timestamp in the future.
694 The idea behind this is that if it has a future
695 timestamp, you don't want to think about it until the
698 all Don't show any entries with a timestamp in the global todo list.
699 The idea behind this is that by setting a timestamp, you
700 have already \"taken care\" of this item.
702 This variable can also have an integer as a value. If positive (N),
703 todos with a timestamp N or more days in the future will be ignored. If
704 negative (-N), todos with a timestamp N or more days in the past will be
705 ignored. If 0, todos with a timestamp either today or in the future will
706 be ignored. For example, a value of -1 will exclude todos with a
707 timestamp in the past (yesterday or earlier), while a value of 7 will
708 exclude todos with a timestamp a week or more in the future.
710 See also `org-agenda-todo-ignore-with-date'.
711 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
712 to make his option also apply to the tags-todo list."
713 :group
'org-agenda-skip
714 :group
'org-agenda-todo-list
717 (const :tag
"Ignore future timestamp todos" future
)
718 (const :tag
"Ignore past or present timestamp todos" past
)
719 (const :tag
"Ignore all timestamp todos" all
)
720 (const :tag
"Show timestamp todos" nil
)
721 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
723 (defcustom org-agenda-todo-ignore-scheduled nil
724 "Non-nil means, ignore some scheduled TODO items when making TODO list.
725 This applies when creating the global todo list.
728 past Don't show entries scheduled today or in the past.
730 future Don't show entries scheduled in the future.
731 The idea behind this is that by scheduling it, you don't want to
732 think about it until the scheduled date.
734 all Don't show any scheduled entries in the global todo list.
735 The idea behind this is that by scheduling it, you have already
736 \"taken care\" of this item.
738 t Same as `all', for backward compatibility.
740 This variable can also have an integer as a value. See
741 `org-agenda-todo-ignore-timestamp' for more details.
743 See also `org-agenda-todo-ignore-with-date'.
744 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
745 to make his option also apply to the tags-todo list."
746 :group
'org-agenda-skip
747 :group
'org-agenda-todo-list
749 (const :tag
"Ignore future-scheduled todos" future
)
750 (const :tag
"Ignore past- or present-scheduled todos" past
)
751 (const :tag
"Ignore all scheduled todos" all
)
752 (const :tag
"Ignore all scheduled todos (compatibility)" t
)
753 (const :tag
"Show scheduled todos" nil
)
754 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
756 (defcustom org-agenda-todo-ignore-deadlines nil
757 "Non-nil means ignore some deadlined TODO items when making TODO list.
758 There are different motivations for using different values, please think
759 carefully when configuring this variable.
761 This applies when creating the global todo list.
764 near Don't show near deadline entries. A deadline is near when it is
765 closer than `org-deadline-warning-days' days. The idea behind this
766 is that such items will appear in the agenda anyway.
768 far Don't show TODO entries where a deadline has been defined, but
769 the deadline is not near. This is useful if you don't want to
770 use the todo list to figure out what to do now.
772 past Don't show entries with a deadline timestamp for today or in the past.
774 future Don't show entries with a deadline timestamp in the future, not even
775 when they become `near' ones. Use it with caution.
777 all Ignore all TODO entries that do have a deadline.
779 t Same as `near', for backward compatibility.
781 This variable can also have an integer as a value. See
782 `org-agenda-todo-ignore-timestamp' for more details.
784 See also `org-agenda-todo-ignore-with-date'.
785 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
786 to make his option also apply to the tags-todo list."
787 :group
'org-agenda-skip
788 :group
'org-agenda-todo-list
790 (const :tag
"Ignore near deadlines" near
)
791 (const :tag
"Ignore near deadlines (compatibility)" t
)
792 (const :tag
"Ignore far deadlines" far
)
793 (const :tag
"Ignore all TODOs with a deadlines" all
)
794 (const :tag
"Show all TODOs, even if they have a deadline" nil
)
795 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
797 (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
798 "Time unit to use when possibly ignoring an agenda item.
800 See the docstring of various `org-agenda-todo-ignore-*' options.
801 The default is to compare time stamps using days. An item is thus
802 considered to be in the future if it is at least one day after today.
803 Non-nil means to compare time stamps using seconds. An item is then
804 considered future if it has a time value later than current time."
805 :group
'org-agenda-skip
806 :group
'org-agenda-todo-list
808 :package-version
'(Org .
"8.0")
810 (const :tag
"Compare time with days" nil
)
811 (const :tag
"Compare time with seconds" t
)))
813 (defcustom org-agenda-tags-todo-honor-ignore-options nil
814 "Non-nil means honor todo-list ignores options also in tags-todo search.
816 `org-agenda-todo-ignore-with-date',
817 `org-agenda-todo-ignore-timestamp',
818 `org-agenda-todo-ignore-scheduled',
819 `org-agenda-todo-ignore-deadlines'
820 make the global TODO list skip entries that have time stamps of certain
821 kinds. If this option is set, the same options will also apply for the
822 tags-todo search, which is the general tags/property matcher
823 restricted to unfinished TODO entries only."
824 :group
'org-agenda-skip
825 :group
'org-agenda-todo-list
826 :group
'org-agenda-match-view
829 (defcustom org-agenda-skip-scheduled-if-done nil
830 "Non-nil means don't show scheduled items in agenda when they are done.
831 This is relevant for the daily/weekly agenda, not for the TODO list. And
832 it applies only to the actual date of the scheduling. Warnings about
833 an item with a past scheduling dates are always turned off when the item
835 :group
'org-agenda-skip
836 :group
'org-agenda-daily
/weekly
839 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
840 "Non-nil means skip scheduling line if same entry shows because of deadline.
842 In the agenda of today, an entry can show up multiple times
843 because it is both scheduled and has a nearby deadline, and maybe
844 a plain time stamp as well.
846 When this variable is nil, the entry will be shown several times.
848 When set to t, then only the deadline is shown and the fact that
849 the entry is scheduled today or was scheduled previously is not
852 When set to the symbol `not-today', skip scheduled previously,
853 but not scheduled today.
855 When set to the symbol `repeated-after-deadline', skip scheduled
856 items if they are repeated beyond the current dealine."
857 :group
'org-agenda-skip
858 :group
'org-agenda-daily
/weekly
860 (const :tag
"Never" nil
)
861 (const :tag
"Always" t
)
862 (const :tag
"Not when scheduled today" not-today
)
863 (const :tag
"When repeated past deadline" repeated-after-deadline
)))
865 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
866 "Non-nil means skip timestamp line if same entry shows because of deadline.
867 In the agenda of today, an entry can show up multiple times
868 because it has both a plain timestamp and has a nearby deadline.
869 When this variable is t, then only the deadline is shown and the
870 fact that the entry has a timestamp for or including today is not
871 shown. When this variable is nil, the entry will be shown
873 :group
'org-agenda-skip
874 :group
'org-agenda-daily
/weekly
877 (const :tag
"Never" nil
)
878 (const :tag
"Always" t
)))
880 (defcustom org-agenda-skip-deadline-if-done nil
881 "Non-nil means don't show deadlines when the corresponding item is done.
882 When nil, the deadline is still shown and should give you a happy feeling.
883 This is relevant for the daily/weekly agenda. And it applied only to the
884 actually date of the deadline. Warnings about approaching and past-due
885 deadlines are always turned off when the item is DONE."
886 :group
'org-agenda-skip
887 :group
'org-agenda-daily
/weekly
890 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
891 "Non-nil means skip deadline prewarning when entry is also scheduled.
892 This will apply on all days where a prewarning for the deadline would
893 be shown, but not at the day when the entry is actually due. On that day,
894 the deadline will be shown anyway.
895 This variable may be set to nil, t, the symbol `pre-scheduled',
896 or a number which will then give the number of days before the actual
897 deadline when the prewarnings should resume. The symbol `pre-scheduled'
898 eliminates the deadline prewarning only prior to the scheduled date.
899 This can be used in a workflow where the first showing of the deadline will
900 trigger you to schedule it, and then you don't want to be reminded of it
901 because you will take care of it on the day when scheduled."
902 :group
'org-agenda-skip
903 :group
'org-agenda-daily
/weekly
906 (const :tag
"Always show prewarning" nil
)
907 (const :tag
"Remove prewarning prior to scheduled date" pre-scheduled
)
908 (const :tag
"Remove prewarning if entry is scheduled" t
)
909 (integer :tag
"Restart prewarning N days before deadline")))
911 (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
912 "Non-nil means skip scheduled delay when entry also has a deadline.
913 This variable may be set to nil, t, the symbol `post-deadline',
914 or a number which will then give the number of days after the actual
915 scheduled date when the delay should expire. The symbol `post-deadline'
916 eliminates the schedule delay when the date is posterior to the deadline."
917 :group
'org-agenda-skip
918 :group
'org-agenda-daily
/weekly
920 :package-version
'(Org .
"8.0")
922 (const :tag
"Always honor delay" nil
)
923 (const :tag
"Ignore delay if posterior to the deadline" post-deadline
)
924 (const :tag
"Ignore delay if entry has a deadline" t
)
925 (integer :tag
"Honor delay up until N days after the scheduled date")))
927 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
928 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
929 When non-nil, after the search for timestamps has matched once in an
930 entry, the rest of the entry will not be searched."
931 :group
'org-agenda-skip
934 (defcustom org-agenda-skip-timestamp-if-done nil
935 "Non-nil means don't select item by timestamp or -range if it is DONE."
936 :group
'org-agenda-skip
937 :group
'org-agenda-daily
/weekly
940 (defcustom org-agenda-dim-blocked-tasks t
941 "Non-nil means dim blocked tasks in the agenda display.
942 This causes some overhead during agenda construction, but if you
943 have turned on `org-enforce-todo-dependencies',
944 `org-enforce-todo-checkbox-dependencies', or any other blocking
945 mechanism, this will create useful feedback in the agenda.
947 Instead of t, this variable can also have the value `invisible'.
948 Then blocked tasks will be invisible and only become visible when
949 they become unblocked. An exemption to this behavior is when a task is
950 blocked because of unchecked checkboxes below it. Since checkboxes do
951 not show up in the agenda views, making this task invisible you remove any
952 trace from agenda views that there is something to do. Therefore, a task
953 that is blocked because of checkboxes will never be made invisible, it
954 will only be dimmed."
955 :group
'org-agenda-daily
/weekly
956 :group
'org-agenda-todo-list
959 (const :tag
"Do not dim" nil
)
960 (const :tag
"Dim to a gray face" t
)
961 (const :tag
"Make invisible" invisible
)))
963 (defcustom org-timeline-show-empty-dates
3
964 "Non-nil means `org-timeline' also shows dates without an entry.
965 When nil, only the days which actually have entries are shown.
966 When t, all days between the first and the last date are shown.
967 When an integer, show also empty dates, but if there is a gap of more than
968 N days, just insert a special line indicating the size of the gap."
969 :group
'org-agenda-skip
971 (const :tag
"None" nil
)
973 (integer :tag
"at most")))
975 (defgroup org-agenda-startup nil
976 "Options concerning initial settings in the Agenda in Org Mode."
977 :tag
"Org Agenda Startup"
980 (defcustom org-agenda-menu-show-matcher t
981 "Non-nil means show the match string in the agenda dispatcher menu.
982 When nil, the matcher string is not shown, but is put into the help-echo
983 property so than moving the mouse over the command shows it.
984 Setting it to nil is good if matcher strings are very long and/or if
985 you want to use two-columns display (see `org-agenda-menu-two-columns')."
990 (define-obsolete-variable-alias 'org-agenda-menu-two-column
'org-agenda-menu-two-columns
"24.3")
992 (defcustom org-agenda-menu-two-columns nil
993 "Non-nil means, use two columns to show custom commands in the dispatcher.
994 If you use this, you probably want to set `org-agenda-menu-show-matcher'
1000 (define-obsolete-variable-alias 'org-finalize-agenda-hook
'org-agenda-finalize-hook
"24.3")
1001 (defcustom org-agenda-finalize-hook nil
1002 "Hook run just before displaying an agenda buffer.
1003 The buffer is still writable when the hook is called.
1005 You can modify some of the buffer substrings but you should be
1006 extra careful not to modify the text properties of the agenda
1007 headlines as the agenda display heavily relies on them."
1008 :group
'org-agenda-startup
1011 (defcustom org-agenda-mouse-1-follows-link nil
1012 "Non-nil means mouse-1 on a link will follow the link in the agenda.
1013 A longer mouse click will still set point. Does not work on XEmacs.
1014 Needs to be set before org.el is loaded."
1015 :group
'org-agenda-startup
1018 (defcustom org-agenda-start-with-follow-mode nil
1019 "The initial value of follow mode in a newly created agenda window."
1020 :group
'org-agenda-startup
1023 (defcustom org-agenda-follow-indirect nil
1024 "Non-nil means `org-agenda-follow-mode' displays only the
1025 current item's tree, in an indirect buffer."
1030 (defcustom org-agenda-show-outline-path t
1031 "Non-nil means show outline path in echo area after line motion."
1032 :group
'org-agenda-startup
1035 (defcustom org-agenda-start-with-entry-text-mode nil
1036 "The initial value of entry-text-mode in a newly created agenda window."
1037 :group
'org-agenda-startup
1040 (defcustom org-agenda-entry-text-maxlines
5
1041 "Number of text lines to be added when `E' is pressed in the agenda.
1043 Note that this variable only used during agenda display. Add add entry text
1044 when exporting the agenda, configure the variable
1045 `org-agenda-add-entry-ext-maxlines'."
1049 (defcustom org-agenda-entry-text-exclude-regexps nil
1050 "List of regular expressions to clean up entry text.
1051 The complete matches of all regular expressions in this list will be
1052 removed from entry text before it is shown in the agenda."
1054 :type
'(repeat (regexp)))
1056 (defcustom org-agenda-entry-text-leaders
" > "
1057 "Text prepended to the entry text in agenda buffers."
1059 :package-version
'(Org .
"8.0")
1063 (defvar org-agenda-entry-text-cleanup-hook nil
1064 "Hook that is run after basic cleanup of entry text to be shown in agenda.
1065 This cleanup is done in a temporary buffer, so the function may inspect and
1066 change the entire buffer.
1067 Some default stuff like drawers and scheduling/deadline dates will already
1068 have been removed when this is called, as will any matches for regular
1069 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
1071 (defvar org-agenda-include-inactive-timestamps nil
1072 "Non-nil means include inactive time stamps in agenda and timeline.
1073 Dynamically scoped.")
1075 (defgroup org-agenda-windows nil
1076 "Options concerning the windows used by the Agenda in Org Mode."
1077 :tag
"Org Agenda Windows"
1080 (defcustom org-agenda-window-setup
'reorganize-frame
1081 "How the agenda buffer should be displayed.
1082 Possible values for this option are:
1084 current-window Show agenda in the current window, keeping all other windows.
1085 other-window Use `switch-to-buffer-other-window' to display agenda.
1086 reorganize-frame Show only two windows on the current frame, the current
1087 window and the agenda.
1088 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1089 Also, when exiting the agenda, kill that frame.
1090 See also the variable `org-agenda-restore-windows-after-quit'."
1091 :group
'org-agenda-windows
1093 (const current-window
)
1095 (const other-window
)
1096 (const reorganize-frame
)))
1098 (defcustom org-agenda-window-frame-fractions
'(0.5 .
0.75)
1099 "The min and max height of the agenda window as a fraction of frame height.
1100 The value of the variable is a cons cell with two numbers between 0 and 1.
1101 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1102 :group
'org-agenda-windows
1103 :type
'(cons (number :tag
"Minimum") (number :tag
"Maximum")))
1105 (defcustom org-agenda-restore-windows-after-quit nil
1106 "Non-nil means restore window configuration upon exiting agenda.
1107 Before the window configuration is changed for displaying the agenda,
1108 the current status is recorded. When the agenda is exited with
1109 `q' or `x' and this option is set, the old state is restored. If
1110 `org-agenda-window-setup' is `other-frame', the value of this
1111 option will be ignored."
1112 :group
'org-agenda-windows
1115 (defcustom org-agenda-ndays nil
1116 "Number of days to include in overview display.
1118 Obsolete, see `org-agenda-span'."
1119 :group
'org-agenda-daily
/weekly
1122 (make-obsolete-variable 'org-agenda-ndays
'org-agenda-span
"24.1")
1124 (defcustom org-agenda-span
'week
1125 "Number of days to include in overview display.
1126 Can be day, week, month, year, or any number of days.
1127 Custom commands can set this variable in the options section."
1128 :group
'org-agenda-daily
/weekly
1129 :type
'(choice (const :tag
"Day" day
)
1130 (const :tag
"Week" week
)
1131 (const :tag
"Month" month
)
1132 (const :tag
"Year" year
)
1133 (integer :tag
"Custom")))
1135 (defcustom org-agenda-start-on-weekday
1
1136 "Non-nil means start the overview always on the specified weekday.
1137 0 denotes Sunday, 1 denotes Monday etc.
1138 When nil, always start on the current day.
1139 Custom commands can set this variable in the options section."
1140 :group
'org-agenda-daily
/weekly
1141 :type
'(choice (const :tag
"Today" nil
)
1142 (integer :tag
"Weekday No.")))
1144 (defcustom org-agenda-show-all-dates t
1145 "Non-nil means `org-agenda' shows every day in the selected range.
1146 When nil, only the days which actually have entries are shown."
1147 :group
'org-agenda-daily
/weekly
1150 (defcustom org-agenda-format-date
'org-agenda-format-date-aligned
1151 "Format string for displaying dates in the agenda.
1152 Used by the daily/weekly agenda and by the timeline. This should be
1153 a format string understood by `format-time-string', or a function returning
1154 the formatted date as a string. The function must take a single argument,
1155 a calendar-style date list like (month day year)."
1156 :group
'org-agenda-daily
/weekly
1158 (string :tag
"Format string")
1159 (function :tag
"Function")))
1161 (defun org-agenda-format-date-aligned (date)
1162 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1163 This function makes sure that dates are aligned for easy reading."
1165 (let* ((dayname (calendar-day-name date
))
1167 (day-of-week (calendar-day-of-week date
))
1169 (monthname (calendar-month-name month
))
1171 (iso-week (org-days-to-iso-week
1172 (calendar-absolute-from-gregorian date
)))
1173 (weekyear (cond ((and (= month
1) (>= iso-week
52))
1175 ((and (= month
12) (<= iso-week
1))
1178 (weekstring (if (= day-of-week
1)
1179 (format " W%02d" iso-week
)
1181 (format "%-10s %2d %s %4d%s"
1182 dayname day monthname year weekstring
)))
1184 (defcustom org-agenda-time-leading-zero nil
1185 "Non-nil means use leading zero for military times in agenda.
1186 For example, 9:30am would become 09:30 rather than 9:30."
1187 :group
'org-agenda-daily
/weekly
1191 (defcustom org-agenda-timegrid-use-ampm nil
1192 "When set, show AM/PM style timestamps on the timegrid."
1197 (defun org-agenda-time-of-day-to-ampm (time)
1198 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1199 (let* ((hour-number (string-to-number (substring time
0 -
3)))
1200 (minute (substring time -
2))
1203 ((equal hour-number
12)
1207 (setq hour-number
(- hour-number
12))))
1209 (if org-agenda-time-leading-zero
1210 (format "%02d" hour-number
)
1211 (format "%02s" (number-to-string hour-number
)))
1214 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1215 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1216 (if org-agenda-timegrid-use-ampm
1217 (org-agenda-time-of-day-to-ampm time
)
1220 (defcustom org-agenda-weekend-days
'(6 0)
1221 "Which days are weekend?
1222 These days get the special face `org-agenda-date-weekend' in the agenda
1223 and timeline buffers."
1224 :group
'org-agenda-daily
/weekly
1225 :type
'(set :greedy t
1226 (const :tag
"Monday" 1)
1227 (const :tag
"Tuesday" 2)
1228 (const :tag
"Wednesday" 3)
1229 (const :tag
"Thursday" 4)
1230 (const :tag
"Friday" 5)
1231 (const :tag
"Saturday" 6)
1232 (const :tag
"Sunday" 0)))
1234 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1235 "Non-nil means jump to today when moving a past date forward in time.
1236 When using S-right in the agenda to move a a date forward, and the date
1237 stamp currently points to the past, the first key press will move it
1238 to today. WHen nil, just move one day forward even if the date stays
1240 :group
'org-agenda-daily
/weekly
1244 (defcustom org-agenda-include-diary nil
1245 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1246 Custom commands can set this variable in the options section."
1247 :group
'org-agenda-daily
/weekly
1250 (defcustom org-agenda-include-deadlines t
1251 "If non-nil, include entries within their deadline warning period.
1252 Custom commands can set this variable in the options section."
1253 :group
'org-agenda-daily
/weekly
1257 (defcustom org-agenda-repeating-timestamp-show-all t
1258 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1259 When set to a list of strings, only show occurrences of repeating
1260 stamps for these TODO keywords. When nil, only one occurrence is
1261 shown, either today or the nearest into the future."
1262 :group
'org-agenda-daily
/weekly
1264 (const :tag
"Show repeating stamps" t
)
1265 (repeat :tag
"Show repeating stamps for these TODO keywords"
1266 (string :tag
"TODO Keyword"))
1267 (const :tag
"Don't show repeating stamps" nil
)))
1269 (defcustom org-scheduled-past-days
10000
1270 "Number of days to continue listing scheduled items not marked DONE.
1271 When an item is scheduled on a date, it shows up in the agenda on this
1272 day and will be listed until it is marked done for the number of days
1274 :group
'org-agenda-daily
/weekly
1277 (defcustom org-agenda-log-mode-items
'(closed clock
)
1278 "List of items that should be shown in agenda log mode.
1279 This list may contain the following symbols:
1281 closed Show entries that have been closed on that day.
1282 clock Show entries that have received clocked time on that day.
1283 state Show all logged state changes.
1284 Note that instead of changing this variable, you can also press `C-u l' in
1285 the agenda to display all available LOG items temporarily."
1286 :group
'org-agenda-daily
/weekly
1287 :type
'(set :greedy t
(const closed
) (const clock
) (const state
)))
1289 (defcustom org-agenda-clock-consistency-checks
1290 '(:max-duration
"10:00" :min-duration
0 :max-gap
"0:05"
1291 :gap-ok-around
("4:00")
1292 :default-face
((:background
"DarkRed") (:foreground
"white"))
1293 :overlap-face nil
:gap-face nil
:no-end-time-face nil
1294 :long-face nil
:short-face nil
)
1295 "This is a property list, with the following keys:
1297 :max-duration Mark clocking chunks that are longer than this time.
1298 This is a time string like \"HH:MM\", or the number
1299 of minutes as an integer.
1301 :min-duration Mark clocking chunks that are shorter that this.
1302 This is a time string like \"HH:MM\", or the number
1303 of minutes as an integer.
1305 :max-gap Mark gaps between clocking chunks that are longer than
1306 this duration. A number of minutes, or a string
1309 :gap-ok-around List of times during the day which are usually not working
1310 times. When a gap is detected, but the gap contains any
1311 of these times, the gap is *not* reported. For example,
1312 if this is (\"4:00\" \"13:00\") then gaps that contain
1313 4:00 in the morning (i.e. the night) and 13:00
1314 (i.e. a typical lunch time) do not cause a warning.
1315 You should have at least one time during the night in this
1316 list, or otherwise the first task each morning will trigger
1317 a warning because it follows a long gap.
1319 Furthermore, the following properties can be used to define faces for
1322 :default-face the default face, if the specific face is undefined
1323 :overlap-face face for overlapping clocks
1324 :gap-face face for gaps between clocks
1325 :no-end-time-face face for incomplete clocks
1326 :long-face face for clock intervals that are too long
1327 :short-face face for clock intervals that are too short"
1328 :group
'org-agenda-daily
/weekly
1333 (defcustom org-agenda-log-mode-add-notes t
1334 "Non-nil means add first line of notes to log entries in agenda views.
1335 If a log item like a state change or a clock entry is associated with
1336 notes, the first line of these notes will be added to the entry in the
1338 :group
'org-agenda-daily
/weekly
1341 (defcustom org-agenda-start-with-log-mode nil
1342 "The initial value of log-mode in a newly created agenda window.
1343 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1344 explanations on the possible values."
1345 :group
'org-agenda-startup
1346 :group
'org-agenda-daily
/weekly
1347 :type
'(choice (const :tag
"Don't show log items" nil
)
1348 (const :tag
"Show only log items" 'only
)
1349 (const :tag
"Show all possible log items" 'clockcheck
)
1350 (repeat :tag
"Choose among possible values for `org-agenda-log-mode-items'"
1351 (choice (const :tag
"Show closed log items" 'closed
)
1352 (const :tag
"Show clocked log items" 'clock
)
1353 (const :tag
"Show all logged state changes" 'state
)))))
1355 (defcustom org-agenda-start-with-clockreport-mode nil
1356 "The initial value of clockreport-mode in a newly created agenda window."
1357 :group
'org-agenda-startup
1358 :group
'org-agenda-daily
/weekly
1361 (defcustom org-agenda-clockreport-parameter-plist
'(:link t
:maxlevel
2)
1362 "Property list with parameters for the clocktable in clockreport mode.
1363 This is the display mode that shows a clock table in the daily/weekly
1364 agenda, the properties for this dynamic block can be set here.
1365 The usual clocktable parameters are allowed here, but you cannot set
1366 the properties :name, :tstart, :tend, :block, and :scope - these will
1367 be overwritten to make sure the content accurately reflects the
1368 current display in the agenda."
1369 :group
'org-agenda-daily
/weekly
1372 (defcustom org-agenda-search-view-always-boolean nil
1373 "Non-nil means the search string is interpreted as individual parts.
1375 The search string for search view can either be interpreted as a phrase,
1376 or as a list of snippets that define a boolean search for a number of
1379 When this is non-nil, the string will be split on whitespace, and each
1380 snippet will be searched individually, and all must match in order to
1381 select an entry. A snippet is then a single string of non-white
1382 characters, or a string in double quotes, or a regexp in {} braces.
1383 If a snippet is preceded by \"-\", the snippet must *not* match.
1384 \"+\" is syntactic sugar for positive selection. Each snippet may
1385 be found as a full word or a partial word, but see the variable
1386 `org-agenda-search-view-force-full-words'.
1388 When this is nil, search will look for the entire search phrase as one,
1389 with each space character matching any amount of whitespace, including
1392 Even when this is nil, you can still switch to Boolean search dynamically
1393 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1394 is a regexp marked with braces like \"{abc}\", this will also switch to
1396 :group
'org-agenda-search-view
1400 (org-defvaralias 'org-agenda-search-view-search-words-only
1401 'org-agenda-search-view-always-boolean
)
1403 (defcustom org-agenda-search-view-force-full-words nil
1404 "Non-nil means, search words must be matches as complete words.
1405 When nil, they may also match part of a word."
1406 :group
'org-agenda-search-view
1410 (defcustom org-agenda-search-view-max-outline-level nil
1411 "Maximum outline level to display in search view.
1412 E.g. when this is set to 1, the search view will only
1413 show headlines of level 1."
1414 :group
'org-agenda-search-view
1416 :package-version
'(Org .
"8.0")
1419 (defgroup org-agenda-time-grid nil
1420 "Options concerning the time grid in the Org-mode Agenda."
1421 :tag
"Org Agenda Time Grid"
1424 (defcustom org-agenda-search-headline-for-time t
1425 "Non-nil means search headline for a time-of-day.
1426 If the headline contains a time-of-day in one format or another, it will
1427 be used to sort the entry into the time sequence of items for a day.
1428 Some people have time stamps in the headline that refer to the creation
1429 time or so, and then this produces an unwanted side effect. If this is
1430 the case for your, use this variable to turn off searching the headline
1432 :group
'org-agenda-time-grid
1435 (defcustom org-agenda-use-time-grid t
1436 "Non-nil means show a time grid in the agenda schedule.
1437 A time grid is a set of lines for specific times (like every two hours between
1438 8:00 and 20:00). The items scheduled for a day at specific times are
1439 sorted in between these lines.
1440 For details about when the grid will be shown, and what it will look like, see
1441 the variable `org-agenda-time-grid'."
1442 :group
'org-agenda-time-grid
1445 (defcustom org-agenda-time-grid
1446 '((daily today require-timed
)
1448 (800 1000 1200 1400 1600 1800 2000))
1450 "The settings for time grid for agenda display.
1451 This is a list of three items. The first item is again a list. It contains
1452 symbols specifying conditions when the grid should be displayed:
1454 daily if the agenda shows a single day
1455 weekly if the agenda shows an entire week
1456 today show grid on current date, independent of daily/weekly display
1457 require-timed show grid only if at least one item has a time specification
1459 The second item is a string which will be placed behind the grid time.
1461 The third item is a list of integers, indicating the times that should have
1463 :group
'org-agenda-time-grid
1466 (set :greedy t
:tag
"Grid Display Options"
1467 (const :tag
"Show grid in single day agenda display" daily
)
1468 (const :tag
"Show grid in weekly agenda display" weekly
)
1469 (const :tag
"Always show grid for today" today
)
1470 (const :tag
"Show grid only if any timed entries are present"
1472 (const :tag
"Skip grid times already present in an entry"
1474 (string :tag
"Grid String")
1475 (repeat :tag
"Grid Times" (integer :tag
"Time"))))
1477 (defcustom org-agenda-show-current-time-in-grid t
1478 "Non-nil means show the current time in the time grid."
1479 :group
'org-agenda-time-grid
1483 (defcustom org-agenda-current-time-string
1484 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1485 "The string for the current time marker in the agenda."
1486 :group
'org-agenda-time-grid
1490 (defgroup org-agenda-sorting nil
1491 "Options concerning sorting in the Org-mode Agenda."
1492 :tag
"Org Agenda Sorting"
1495 (defcustom org-agenda-sorting-strategy
1496 '((agenda habit-down time-up priority-down category-keep
)
1497 (todo priority-down category-keep
)
1498 (tags priority-down category-keep
)
1499 (search category-keep
))
1500 "Sorting structure for the agenda items of a single day.
1501 This is a list of symbols which will be used in sequence to determine
1502 if an entry should be listed before another entry. The following
1503 symbols are recognized:
1505 time-up Put entries with time-of-day indications first, early first
1506 time-down Put entries with time-of-day indications first, late first
1507 timestamp-up Sort by any timestamp, early first
1508 timestamp-down Sort by any timestamp, late first
1509 scheduled-up Sort by scheduled timestamp, early first
1510 scheduled-down Sort by scheduled timestamp, late first
1511 deadline-up Sort by deadline timestamp, early first
1512 deadline-down Sort by deadline timestamp, late first
1513 ts-up Sort by active timestamp, early first
1514 ts-down Sort by active timestamp, late first
1515 tsia-up Sort by inactive timestamp, early first
1516 tsia-down Sort by inactive timestamp, late first
1517 category-keep Keep the default order of categories, corresponding to the
1518 sequence in `org-agenda-files'.
1519 category-up Sort alphabetically by category, A-Z.
1520 category-down Sort alphabetically by category, Z-A.
1521 tag-up Sort alphabetically by last tag, A-Z.
1522 tag-down Sort alphabetically by last tag, Z-A.
1523 priority-up Sort numerically by priority, high priority last.
1524 priority-down Sort numerically by priority, high priority first.
1525 todo-state-up Sort by todo state, tasks that are done last.
1526 todo-state-down Sort by todo state, tasks that are done first.
1527 effort-up Sort numerically by estimated effort, high effort last.
1528 effort-down Sort numerically by estimated effort, high effort first.
1529 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1530 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1531 habit-up Put entries that are habits first
1532 habit-down Put entries that are habits last
1533 alpha-up Sort headlines alphabetically
1534 alpha-down Sort headlines alphabetically, reversed
1536 The different possibilities will be tried in sequence, and testing stops
1537 if one comparison returns a \"not-equal\". For example, the default
1538 '(time-up category-keep priority-down)
1539 means: Pull out all entries having a specified time of day and sort them,
1540 in order to make a time schedule for the current day the first thing in the
1541 agenda listing for the day. Of the entries without a time indication, keep
1542 the grouped in categories, don't sort the categories, but keep them in
1543 the sequence given in `org-agenda-files'. Within each category sort by
1546 Leaving out `category-keep' would mean that items will be sorted across
1547 categories by priority.
1549 Instead of a single list, this can also be a set of list for specific
1550 contents, with a context symbol in the car of the list, any of
1551 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1553 Custom commands can bind this variable in the options section."
1554 :group
'org-agenda-sorting
1556 (repeat :tag
"General" ,org-sorting-choice
)
1557 (list :tag
"Individually"
1558 (cons (const :tag
"Strategy for Weekly/Daily agenda" agenda
)
1559 (repeat ,org-sorting-choice
))
1560 (cons (const :tag
"Strategy for TODO lists" todo
)
1561 (repeat ,org-sorting-choice
))
1562 (cons (const :tag
"Strategy for Tags matches" tags
)
1563 (repeat ,org-sorting-choice
))
1564 (cons (const :tag
"Strategy for search matches" search
)
1565 (repeat ,org-sorting-choice
)))))
1567 (defcustom org-agenda-cmp-user-defined nil
1568 "A function to define the comparison `user-defined'.
1569 This function must receive two arguments, agenda entry a and b.
1570 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1571 the user comparison, return nil.
1572 When this is defined, you can make `user-defined-up' and `user-defined-down'
1573 part of an agenda sorting strategy."
1574 :group
'org-agenda-sorting
1577 (defcustom org-sort-agenda-notime-is-late t
1578 "Non-nil means items without time are considered late.
1579 This is only relevant for sorting. When t, items which have no explicit
1580 time like 15:30 will be considered as 99:01, i.e. later than any items which
1581 do have a time. When nil, the default time is before 0:00. You can use this
1582 option to decide if the schedule for today should come before or after timeless
1584 :group
'org-agenda-sorting
1587 (defcustom org-sort-agenda-noeffort-is-high t
1588 "Non-nil means items without effort estimate are sorted as high effort.
1589 This also applies when filtering an agenda view with respect to the
1590 < or > effort operator. Then, tasks with no effort defined will be treated
1591 as tasks with high effort.
1592 When nil, such items are sorted as 0 minutes effort."
1593 :group
'org-agenda-sorting
1596 (defgroup org-agenda-line-format nil
1597 "Options concerning the entry prefix in the Org-mode agenda display."
1598 :tag
"Org Agenda Line Format"
1601 (defcustom org-agenda-prefix-format
1602 '((agenda .
" %i %-12:c%?-12t% s")
1604 (todo .
" %i %-12:c")
1605 (tags .
" %i %-12:c")
1606 (search .
" %i %-12:c"))
1607 "Format specifications for the prefix of items in the agenda views.
1608 An alist with five entries, each for the different agenda types. The
1609 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1610 The values are format strings.
1612 This format works similar to a printf format, with the following meaning:
1614 %c the category of the item, \"Diary\" for entries from the diary,
1615 or as given by the CATEGORY keyword or derived from the file name
1616 %e the effort required by the item
1617 %l the level of the item (insert X space(s) if item is of level X)
1618 %i the icon category of the item, see `org-agenda-category-icon-alist'
1619 %T the last tag of the item (ignore inherited tags, which come first)
1620 %t the HH:MM time-of-day specification if one applies to the entry
1621 %s Scheduling/Deadline information, a short string
1622 %b show breadcrumbs, i.e., the names of the higher levels
1623 %(expression) Eval EXPRESSION and replace the control string
1626 All specifiers work basically like the standard `%s' of printf, but may
1627 contain two additional characters: a question mark just after the `%'
1628 and a whitespace/punctuation character just before the final letter.
1630 If the first character after `%' is a question mark, the entire field
1631 will only be included if the corresponding value applies to the current
1632 entry. This is useful for fields which should have fixed width when
1633 present, but zero width when absent. For example, \"%?-12t\" will
1634 result in a 12 character time field if a time of the day is specified,
1635 but will completely disappear in entries which do not contain a time.
1637 If there is punctuation or whitespace character just before the
1638 final format letter, this character will be appended to the field
1639 value if the value is not empty. For example, the format
1640 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1641 the category is empty, no additional colon is inserted.
1643 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1646 - Indent the line with two space characters
1647 - Give the category a 12 chars wide field, padded with whitespace on
1648 the right (because of `-'). Append a colon if there is a category
1650 - If there is a time-of-day, put it into a 12 chars wide field. If no
1651 time, don't put in an empty field, just skip it (because of '?').
1652 - Finally, put the scheduling information.
1654 See also the variables `org-agenda-remove-times-when-in-prefix' and
1655 `org-agenda-remove-tags'.
1657 Custom commands can set this variable in the options section."
1659 (string :tag
"General format")
1660 (list :greedy t
:tag
"View dependent"
1661 (cons (const agenda
) (string :tag
"Format"))
1662 (cons (const timeline
) (string :tag
"Format"))
1663 (cons (const todo
) (string :tag
"Format"))
1664 (cons (const tags
) (string :tag
"Format"))
1665 (cons (const search
) (string :tag
"Format"))))
1666 :group
'org-agenda-line-format
)
1668 (defvar org-prefix-format-compiled nil
1669 "The compiled prefix format and associated variables.
1670 This is a list where first element is a list of variable bindings, and second
1671 element is the compiled format expression. See the variable
1672 `org-agenda-prefix-format'.")
1674 (defcustom org-agenda-todo-keyword-format
"%-1s"
1675 "Format for the TODO keyword in agenda lines.
1676 Set this to something like \"%-12s\" if you want all TODO keywords
1677 to occupy a fixed space in the agenda display."
1678 :group
'org-agenda-line-format
1681 (defcustom org-agenda-diary-sexp-prefix nil
1682 "A regexp that matches part of a diary sexp entry
1683 which should be treated as scheduling/deadline information in
1686 For example, you can use this to extract the `diary-remind-message' from
1687 `diary-remind' entries."
1688 :group
'org-agenda-line-format
1689 :type
'(choice (const :tag
"None" nil
) (regexp :tag
"Regexp")))
1691 (defcustom org-agenda-timerange-leaders
'("" "(%d/%d): ")
1692 "Text preceding timerange entries in the agenda view.
1693 This is a list with two strings. The first applies when the range
1694 is entirely on one day. The second applies if the range spans several days.
1695 The strings may have two \"%d\" format specifiers which will be filled
1696 with the sequence number of the days, and the total number of days in the
1697 range, respectively."
1698 :group
'org-agenda-line-format
1700 (string :tag
"Deadline today ")
1701 (choice :tag
"Deadline relative"
1702 (string :tag
"Format string")
1705 (defcustom org-agenda-scheduled-leaders
'(" Scheduled: " "Sched.%3dx: ")
1706 "Text preceding scheduled items in the agenda view.
1707 This is a list with two strings. The first applies when the item is
1708 scheduled on the current day. The second applies when it has been scheduled
1709 previously, it may contain a %d indicating that this is the nth time that
1710 this item is scheduled, due to automatic rescheduling of unfinished items
1711 for the following day. So this number is one larger than the number of days
1712 that passed since this item was scheduled first."
1713 :group
'org-agenda-line-format
1715 :package-version
'(Org .
"8.0")
1717 (string :tag
"Scheduled today ")
1718 (string :tag
"Scheduled previously")))
1720 (defcustom org-agenda-inactive-leader
"["
1721 "Text preceding item pulled into the agenda by inactive time stamps.
1722 These entries are added to the agenda when pressing \"[\"."
1723 :group
'org-agenda-line-format
1726 (string :tag
"Scheduled today ")
1727 (string :tag
"Scheduled previously")))
1729 (defcustom org-agenda-deadline-leaders
'(" Deadline: " " In %3d d.: " "%3d d. ago: ")
1730 "Text preceding deadline items in the agenda view.
1731 This is a list with three strings. The first applies when the item has its
1732 deadline on the current day. The second applies when the deadline is in the
1733 future, the third one when it is in the past. The strings may contain %d
1734 to capture the number of days."
1735 :group
'org-agenda-line-format
1737 :package-version
'(Org .
"8.0")
1739 (string :tag
"Deadline today ")
1740 (choice :tag
"Deadline relative"
1741 (string :tag
"Format string")
1744 (defcustom org-agenda-remove-times-when-in-prefix t
1745 "Non-nil means remove duplicate time specifications in agenda items.
1746 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1747 time-of-day specification in a headline or diary entry is extracted and
1748 placed into the prefix. If this option is non-nil, the original specification
1749 \(a timestamp or -range, or just a plain time(range) specification like
1750 11:30-4pm) will be removed for agenda display. This makes the agenda less
1752 The option can be t or nil. It may also be the symbol `beg', indicating
1753 that the time should only be removed when it is located at the beginning of
1754 the headline/diary entry."
1755 :group
'org-agenda-line-format
1757 (const :tag
"Always" t
)
1758 (const :tag
"Never" nil
)
1759 (const :tag
"When at beginning of entry" beg
)))
1761 (defcustom org-agenda-remove-timeranges-from-blocks nil
1762 "Non-nil means remove time ranges specifications in agenda
1763 items that span on several days."
1764 :group
'org-agenda-line-format
1768 (defcustom org-agenda-default-appointment-duration nil
1769 "Default duration for appointments that only have a starting time.
1770 When nil, no duration is specified in such cases.
1771 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1772 :group
'org-agenda-line-format
1774 (integer :tag
"Minutes")
1775 (const :tag
"No default duration")))
1777 (defcustom org-agenda-show-inherited-tags t
1778 "Non-nil means show inherited tags in each agenda line.
1780 When this option is set to 'always, it take precedences over
1781 `org-agenda-use-tag-inheritance' and inherited tags are shown
1784 When this option is set to t (the default), inherited tags are
1785 shown when they are available, i.e. when the value of
1786 `org-agenda-use-tag-inheritance' has been taken into account.
1788 This can be set to a list of agenda types in which the agenda
1789 must display the inherited tags. Available types are 'todo,
1790 'agenda, 'search and 'timeline.
1792 When set to nil, never show inherited tags in agenda lines."
1793 :group
'org-agenda-line-format
1797 (const :tag
"Show inherited tags when available" t
)
1798 (const :tag
"Always show inherited tags" 'always
)
1799 (repeat :tag
"Show inherited tags only in selected agenda types"
1800 (symbol :tag
"Agenda type"))))
1802 (defcustom org-agenda-use-tag-inheritance
'(todo search timeline agenda
)
1803 "List of agenda view types where to use tag inheritance.
1805 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1806 controlled by `org-use-tag-inheritance'. In other agenda types,
1807 `org-use-tag-inheritance' is not used for the selection of the
1808 agenda entries. Still, you may want the agenda to be aware of
1809 the inherited tags anyway, e.g. for later tag filtering.
1811 Allowed value are 'todo, 'search, 'timeline and 'agenda.
1813 This variable has no effect if `org-agenda-show-inherited-tags'
1814 is set to 'always. In that case, the agenda is aware of those
1817 The default value sets tags in every agenda type. Setting this
1818 option to nil will speed up non-tags agenda view a lot."
1822 (const :tag
"Use tag inheritance in all agenda types" t
)
1823 (repeat :tag
"Use tag inheritance in selected agenda types"
1824 (symbol :tag
"Agenda type"))))
1826 (defcustom org-agenda-hide-tags-regexp nil
1827 "Regular expression used to filter away specific tags in agenda views.
1828 This means that these tags will be present, but not be shown in the agenda
1829 line. Secondary filtering will still work on the hidden tags.
1830 Nil means don't hide any tags."
1831 :group
'org-agenda-line-format
1833 (const :tag
"Hide none" nil
)
1834 (string :tag
"Regexp ")))
1836 (defcustom org-agenda-remove-tags nil
1837 "Non-nil means remove the tags from the headline copy in the agenda.
1838 When this is the symbol `prefix', only remove tags when
1839 `org-agenda-prefix-format' contains a `%T' specifier."
1840 :group
'org-agenda-line-format
1842 (const :tag
"Always" t
)
1843 (const :tag
"Never" nil
)
1844 (const :tag
"When prefix format contains %T" prefix
)))
1846 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1847 'org-agenda-remove-tags
)
1849 (defcustom org-agenda-tags-column
(if (featurep 'xemacs
) -
79 -
80)
1850 "Shift tags in agenda items to this column.
1851 If this number is positive, it specifies the column. If it is negative,
1852 it means that the tags should be flushright to that column. For example,
1853 -80 works well for a normal 80 character screen."
1854 :group
'org-agenda-line-format
1857 (org-defvaralias 'org-agenda-align-tags-to-column
'org-agenda-tags-column
)
1859 (defcustom org-agenda-fontify-priorities
'cookies
1860 "Non-nil means highlight low and high priorities in agenda.
1861 When t, the highest priority entries are bold, lowest priority italic.
1862 However, settings in `org-priority-faces' will overrule these faces.
1863 When this variable is the symbol `cookies', only fontify the
1864 cookies, not the entire task.
1865 This may also be an association list of priority faces, whose
1866 keys are the character values of `org-highest-priority',
1867 `org-default-priority', and `org-lowest-priority' (the default values
1868 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1869 color as a string, or a list like `(:background \"Red\")'.
1870 If it is a color, the variable `org-faces-easy-properties'
1871 determines if it is a foreground or a background color."
1872 :group
'org-agenda-line-format
1874 (const :tag
"Never" nil
)
1875 (const :tag
"Defaults" t
)
1876 (const :tag
"Cookies only" cookies
)
1877 (repeat :tag
"Specify"
1878 (list (character :tag
"Priority" :value ?A
)
1879 (choice :tag
"Face "
1880 (string :tag
"Color")
1881 (sexp :tag
"Face"))))))
1883 (defcustom org-agenda-day-face-function nil
1884 "Function called to determine what face should be used to display a day.
1885 The only argument passed to that function is the day. It should
1886 returns a face, or nil if does not want to specify a face and let
1887 the normal rules apply."
1888 :group
'org-agenda-line-format
1892 (defcustom org-agenda-category-icon-alist nil
1893 "Alist of category icon to be displayed in agenda views.
1895 Each entry should have the following format:
1897 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1899 Where CATEGORY-REGEXP is a regexp matching the categories where
1900 the icon should be displayed.
1901 FILE-OR-DATA either a file path or a string containing image data.
1903 The other fields can be omitted safely if not needed:
1904 TYPE indicates the image type.
1905 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1907 PROPS are additional image attributes to assign to the image,
1908 like, e.g. `:ascent center'.
1910 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1912 If you want to set the display properties yourself, just put a
1913 list as second element:
1915 (CATEGORY-REGEXP (MY PROPERTY LIST))
1917 For example, to display a 16px horizontal space for Emacs
1918 category, you can use:
1920 (\"Emacs\" '(space . (:width (16))))"
1921 :group
'org-agenda-line-format
1923 :type
'(alist :key-type
(string :tag
"Regexp matching category")
1924 :value-type
(choice (list :tag
"Icon"
1925 (string :tag
"File or data")
1926 (symbol :tag
"Type")
1927 (boolean :tag
"Data?")
1928 (repeat :tag
"Extra image properties" :inline t symbol
))
1929 (list :tag
"Display properties" sexp
))))
1931 (defgroup org-agenda-column-view nil
1932 "Options concerning column view in the agenda."
1933 :tag
"Org Agenda Column View"
1936 (defcustom org-agenda-columns-show-summaries t
1937 "Non-nil means show summaries for columns displayed in the agenda view."
1938 :group
'org-agenda-column-view
1941 (defcustom org-agenda-columns-compute-summary-properties t
1942 "Non-nil means recompute all summary properties before column view.
1943 When column view in the agenda is listing properties that have a summary
1944 operator, it can go to all relevant buffers and recompute the summaries
1945 there. This can mean overhead for the agenda column view, but is necessary
1946 to have thing up to date.
1947 As a special case, a CLOCKSUM property also makes sure that the clock
1948 computations are current."
1949 :group
'org-agenda-column-view
1952 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1953 "Non-nil means the duration of an appointment will add to day effort.
1954 The property to which appointment durations will be added is the one given
1955 in the option `org-effort-property'. If an appointment does not have
1956 an end time, `org-agenda-default-appointment-duration' will be used. If that
1957 is not set, an appointment without end time will not contribute to the time
1959 :group
'org-agenda-column-view
1962 (defcustom org-agenda-auto-exclude-function nil
1963 "A function called with a tag to decide if it is filtered on '/ RET'.
1964 The sole argument to the function, which is called once for each
1965 possible tag, is a string giving the name of the tag. The
1966 function should return either nil if the tag should be included
1967 as normal, or \"-<TAG>\" to exclude the tag.
1968 Note that for the purpose of tag filtering, only the lower-case version of
1969 all tags will be considered, so that this function will only ever see
1970 the lower-case version of all tags."
1974 (defcustom org-agenda-bulk-custom-functions nil
1975 "Alist of characters and custom functions for bulk actions.
1976 For example, this value makes those two functions available:
1981 With selected entries in an agenda buffer, `B R' will call
1982 the custom function `set-category' on the selected entries.
1983 Note that functions in this alist don't need to be quoted."
1988 (defmacro org-agenda-with-point-at-orig-entry
(string &rest body
)
1989 "Execute BODY with point at location given by `org-hd-marker' property.
1990 If STRING is non-nil, the text property will be fetched from position 0
1991 in that string. If STRING is nil, it will be fetched from the beginning
1992 of the current line."
1993 (org-with-gensyms (marker)
1994 `(let ((,marker
(get-text-property (if string
0 (point-at-bol))
1995 'org-hd-marker
,string
)))
1996 (with-current-buffer (marker-buffer ,marker
)
2000 (def-edebug-spec org-agenda-with-point-at-orig-entry
(form body
))
2002 (defun org-add-agenda-custom-command (entry)
2003 "Replace or add a command in `org-agenda-custom-commands'.
2004 This is mostly for hacking and trying a new command - once the command
2005 works you probably want to add it to `org-agenda-custom-commands' for good."
2006 (let ((ass (assoc (car entry
) org-agenda-custom-commands
)))
2008 (setcdr ass
(cdr entry
))
2009 (push entry org-agenda-custom-commands
))))
2011 ;;; Define the org-agenda-mode
2013 (defvar org-agenda-mode-map
(make-sparse-keymap)
2014 "Keymap for `org-agenda-mode'.")
2015 (org-defvaralias 'org-agenda-keymap
'org-agenda-mode-map
)
2017 (defvar org-agenda-menu
) ; defined later in this file.
2018 (defvar org-agenda-restrict nil
) ; defined later in this file.
2019 (defvar org-agenda-follow-mode nil
)
2020 (defvar org-agenda-entry-text-mode nil
)
2021 (defvar org-agenda-clockreport-mode nil
)
2022 (defvar org-agenda-show-log nil
)
2023 (defvar org-agenda-redo-command nil
)
2024 (defvar org-agenda-query-string nil
)
2025 (defvar org-agenda-mode-hook nil
2026 "Hook run after `org-agenda-mode' is turned on.
2027 The buffer is still writable when this hook is called.")
2028 (defvar org-agenda-type nil
)
2029 (defvar org-agenda-force-single-file nil
)
2030 (defvar org-agenda-bulk-marked-entries nil
2031 "List of markers that refer to marked entries in the agenda.")
2033 ;;; Multiple agenda buffers support
2035 (defcustom org-agenda-sticky nil
2036 "Non-nil means agenda q key will bury agenda buffers.
2037 Agenda commands will then show existing buffer instead of generating new ones.
2038 When nil, `q' will kill the single agenda buffer."
2045 (defun org-toggle-sticky-agenda (&optional arg
)
2046 "Toggle `org-agenda-sticky'."
2048 (let ((new-value (if arg
2049 (> (prefix-numeric-value arg
) 0)
2050 (not org-agenda-sticky
))))
2051 (if (equal new-value org-agenda-sticky
)
2052 (and (org-called-interactively-p 'interactive
)
2053 (message "Sticky agenda was already %s"
2054 (if org-agenda-sticky
"enabled" "disabled")))
2055 (setq org-agenda-sticky new-value
)
2056 (org-agenda-kill-all-agenda-buffers)
2057 (and (org-called-interactively-p 'interactive
)
2058 (message "Sticky agenda was %s"
2059 (if org-agenda-sticky
"enabled" "disabled"))))))
2061 (defvar org-agenda-buffer nil
2062 "Agenda buffer currently being generated.")
2064 (defvar org-agenda-last-prefix-arg nil
)
2065 (defvar org-agenda-this-buffer-name nil
)
2066 (defvar org-agenda-doing-sticky-redo nil
)
2067 (defvar org-agenda-this-buffer-is-sticky nil
)
2069 (defconst org-agenda-local-vars
2070 '(org-agenda-this-buffer-name
2071 org-agenda-undo-list
2072 org-agenda-pending-undo-list
2073 org-agenda-follow-mode
2074 org-agenda-entry-text-mode
2075 org-agenda-clockreport-mode
2077 org-agenda-redo-command
2078 org-agenda-query-string
2080 org-agenda-bulk-marked-entries
2081 org-agenda-undo-has-started-in
2083 org-agenda-pre-window-conf
2084 org-agenda-columns-active
2085 org-agenda-tag-filter-overlays
2086 org-agenda-tag-filter
2087 org-agenda-cat-filter-overlays
2088 org-agenda-category-filter
2089 org-agenda-re-filter-overlays
2090 org-agenda-regexp-filter
2092 org-agenda-last-search-view-search-was-boolean
2093 org-agenda-filtered-by-category
2094 org-agenda-filter-form
2095 org-agenda-cycle-counter
2096 org-agenda-last-prefix-arg
)
2097 "Variables that must be local in agenda buffers to allow multiple buffers.")
2099 (defun org-agenda-mode ()
2100 "Mode for time-sorted view on action items in Org-mode files.
2102 The following commands are available:
2104 \\{org-agenda-mode-map}"
2106 (cond (org-agenda-doing-sticky-redo
2107 ;; Refreshing sticky agenda-buffer
2109 ;; Preserve the value of `org-agenda-local-vars' variables,
2110 ;; while letting `kill-all-local-variables' kill the rest
2111 (let ((save (buffer-local-variables)))
2112 (kill-all-local-variables)
2113 (mapc 'make-local-variable org-agenda-local-vars
)
2115 (let ((var (car elem
))
2118 (member var org-agenda-local-vars
))
2120 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
2122 ;; Creating a sticky Agenda buffer for the first time
2123 (kill-all-local-variables)
2124 (mapc 'make-local-variable org-agenda-local-vars
)
2125 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
2127 ;; Creating a non-sticky agenda buffer
2128 (kill-all-local-variables)
2129 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) nil
)))
2130 (setq org-agenda-undo-list nil
2131 org-agenda-pending-undo-list nil
2132 org-agenda-bulk-marked-entries nil
)
2133 (setq major-mode
'org-agenda-mode
)
2134 ;; Keep global-font-lock-mode from turning on font-lock-mode
2135 (org-set-local 'font-lock-global-modes
(list 'not major-mode
))
2136 (setq mode-name
"Org-Agenda")
2137 (use-local-map org-agenda-mode-map
)
2138 (easy-menu-add org-agenda-menu
)
2139 (if org-startup-truncated
(setq truncate-lines t
))
2140 (org-set-local 'line-move-visual nil
)
2141 (org-add-hook 'post-command-hook
'org-agenda-update-agenda-type nil
'local
)
2142 (org-add-hook 'pre-command-hook
'org-unhighlight nil
'local
)
2143 ;; Make sure properties are removed when copying text
2144 (make-local-variable 'filter-buffer-substring-functions
)
2145 (add-hook 'filter-buffer-substring-functions
2146 (lambda (fun start end delete
)
2147 (substring-no-properties (funcall fun start end delete
))))
2148 (unless org-agenda-keep-modes
2149 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2150 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
2151 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
2152 org-agenda-show-log org-agenda-start-with-log-mode
))
2155 '("Agenda") "Agenda Files"
2159 (if (get 'org-agenda-files
'org-restrict
)
2160 "Restricted to single file"
2162 '(org-edit-agenda-file-list)
2163 (not (get 'org-agenda-files
'org-restrict
)))
2165 (mapcar 'org-file-menu-entry
(org-agenda-files))))
2166 (org-agenda-set-mode-name)
2168 (if (fboundp 'run-mode-hooks
) 'run-mode-hooks
'run-hooks
)
2169 (list 'org-agenda-mode-hook
)))
2171 (substitute-key-definition 'undo
'org-agenda-undo
2172 org-agenda-mode-map global-map
)
2173 (org-defkey org-agenda-mode-map
"\C-i" 'org-agenda-goto
)
2174 (org-defkey org-agenda-mode-map
[(tab)] 'org-agenda-goto
)
2175 (org-defkey org-agenda-mode-map
"\C-m" 'org-agenda-switch-to
)
2176 (org-defkey org-agenda-mode-map
"\C-k" 'org-agenda-kill
)
2177 (org-defkey org-agenda-mode-map
"\C-c\C-w" 'org-agenda-refile
)
2178 (org-defkey org-agenda-mode-map
"m" 'org-agenda-bulk-mark
)
2179 (org-defkey org-agenda-mode-map
"*" 'org-agenda-bulk-mark-all
)
2180 (org-defkey org-agenda-mode-map
"#" 'org-agenda-dim-blocked-tasks
)
2181 (org-defkey org-agenda-mode-map
"%" 'org-agenda-bulk-mark-regexp
)
2182 (org-defkey org-agenda-mode-map
"u" 'org-agenda-bulk-unmark
)
2183 (org-defkey org-agenda-mode-map
"U" 'org-agenda-bulk-unmark-all
)
2184 (org-defkey org-agenda-mode-map
"B" 'org-agenda-bulk-action
)
2185 (org-defkey org-agenda-mode-map
"k" 'org-agenda-capture
)
2186 (org-defkey org-agenda-mode-map
"A" 'org-agenda-append-agenda
)
2187 (org-defkey org-agenda-mode-map
"\C-c\C-x!" 'org-reload
)
2188 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-a" 'org-agenda-archive-default
)
2189 (org-defkey org-agenda-mode-map
"\C-c\C-xa" 'org-agenda-toggle-archive-tag
)
2190 (org-defkey org-agenda-mode-map
"\C-c\C-xA" 'org-agenda-archive-to-archive-sibling
)
2191 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-s" 'org-agenda-archive
)
2192 (org-defkey org-agenda-mode-map
"\C-c$" 'org-agenda-archive
)
2193 (org-defkey org-agenda-mode-map
"$" 'org-agenda-archive
)
2194 (org-defkey org-agenda-mode-map
"\C-c\C-o" 'org-agenda-open-link
)
2195 (org-defkey org-agenda-mode-map
" " 'org-agenda-show-and-scroll-up
)
2196 (org-defkey org-agenda-mode-map
[backspace] 'org-agenda-show-scroll-down)
2197 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2198 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2199 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2200 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2201 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2202 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2203 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2204 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2205 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2206 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2207 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2208 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2209 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2210 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2211 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2212 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2213 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2214 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2215 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2216 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2217 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2218 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2220 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2221 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2222 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2223 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2224 (while l (org-defkey org-agenda-mode-map
2225 (int-to-string (pop l)) 'digit-argument)))
2227 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2228 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2229 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2230 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2231 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2232 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2233 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2234 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2235 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2236 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2237 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2238 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2239 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2240 'org-clock-modify-effort-estimate)
2241 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2242 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2243 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2244 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2245 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2246 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2247 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2248 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2249 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2250 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2251 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2252 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2253 (substitute-key-definition 'next-line 'org-agenda-next-line
2254 org-agenda-mode-map global-map)
2255 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2256 org-agenda-mode-map global-map)
2257 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2258 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2259 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2260 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2261 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2262 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2263 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2264 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2265 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2266 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2267 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2268 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2269 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2270 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2271 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2272 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2273 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2274 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2275 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2276 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2277 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2278 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2279 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2280 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2281 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2282 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2283 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2284 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2285 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2286 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2288 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2289 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2290 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2291 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2292 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2293 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2294 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2295 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2296 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2297 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2298 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2299 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2300 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2301 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2303 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2304 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2305 (when org-agenda-mouse-1-follows-link
2306 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2307 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2312 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2313 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2314 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2315 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2318 ["Day View" org-agenda-day-view
2319 :active (org-agenda-check-type nil 'agenda)
2320 :style radio :selected (eq org-agenda-current-span 'day)
2321 :keys "v d (or just d)"]
2322 ["Week View" org-agenda-week-view
2323 :active (org-agenda-check-type nil 'agenda)
2324 :style radio :selected (eq org-agenda-current-span 'week)
2325 :keys "v w (or just w)"]
2326 ["Month View" org-agenda-month-view
2327 :active (org-agenda-check-type nil 'agenda)
2328 :style radio :selected (eq org-agenda-current-span 'month)
2330 ["Year View" org-agenda-year-view
2331 :active (org-agenda-check-type nil 'agenda)
2332 :style radio :selected (eq org-agenda-current-span 'year)
2335 ["Include Diary" org-agenda-toggle-diary
2336 :style toggle :selected org-agenda-include-diary
2337 :active (org-agenda-check-type nil 'agenda)]
2338 ["Include Deadlines" org-agenda-toggle-deadlines
2339 :style toggle :selected org-agenda-include-deadlines
2340 :active (org-agenda-check-type nil 'agenda)]
2341 ["Use Time Grid" org-agenda-toggle-time-grid
2342 :style toggle :selected org-agenda-use-time-grid
2343 :active (org-agenda-check-type nil 'agenda)]
2345 ["Show clock report" org-agenda-clockreport-mode
2346 :style toggle :selected org-agenda-clockreport-mode
2347 :active (org-agenda-check-type nil 'agenda)]
2348 ["Show some entry text" org-agenda-entry-text-mode
2349 :style toggle :selected org-agenda-entry-text-mode
2352 ["Show Logbook entries" org-agenda-log-mode
2353 :style toggle :selected org-agenda-show-log
2354 :active (org-agenda-check-type nil 'agenda 'timeline)
2355 :keys "v l (or just l)"]
2356 ["Include archived trees" org-agenda-archives-mode
2357 :style toggle :selected org-agenda-archives-mode :active t
2359 ["Include archive files" (org-agenda-archives-mode t)
2360 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2363 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2364 ["Write view to file" org-agenda-write t]
2365 ["Rebuild buffer" org-agenda-redo t]
2366 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2368 ["Show original entry" org-agenda-show t]
2369 ["Go To (other window)" org-agenda-goto t]
2370 ["Go To (this window)" org-agenda-switch-to t]
2371 ["Capture with cursor date" org-agenda-capture t]
2372 ["Follow Mode" org-agenda-follow-mode
2373 :style toggle :selected org-agenda-follow-mode :active t]
2374 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2377 ["Cycle TODO" org-agenda-todo t]
2378 ["Next TODO set" org-agenda-todo-nextset t]
2379 ["Previous TODO set" org-agenda-todo-previousset t]
2380 ["Add note" org-agenda-add-note t])
2381 ("Archive/Refile/Delete"
2382 ["Archive default" org-agenda-archive-default t]
2383 ["Archive default" org-agenda-archive-default-with-confirmation t]
2384 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2385 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2386 ["Archive subtree" org-agenda-archive t]
2388 ["Refile" org-agenda-refile t]
2390 ["Delete subtree" org-agenda-kill t])
2392 ["Mark entry" org-agenda-bulk-mark t]
2393 ["Mark all" org-agenda-bulk-mark-all t]
2394 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2395 ["Unmark entry" org-agenda-bulk-unmark t]
2396 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "U"])
2397 ["Act on all marked" org-agenda-bulk-action t]
2399 ("Tags and Properties"
2400 ["Show all Tags" org-agenda-show-tags t]
2401 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2402 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2404 ["Column View" org-columns t])
2405 ("Deadline/Schedule"
2406 ["Schedule" org-agenda-schedule t]
2407 ["Set Deadline" org-agenda-deadline t]
2409 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2410 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2411 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2412 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2413 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2414 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2415 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2417 ["Clock in" org-agenda-clock-in t]
2418 ["Clock out" org-agenda-clock-out t]
2419 ["Clock cancel" org-agenda-clock-cancel t]
2420 ["Goto running clock" org-clock-goto t]
2422 ["Set Effort" org-agenda-set-effort t]
2423 ["Change clocked effort" org-clock-modify-effort-estimate
2424 (org-clock-is-active)])
2426 ["Set Priority" org-agenda-priority t]
2427 ["Increase Priority" org-agenda-priority-up t]
2428 ["Decrease Priority" org-agenda-priority-down t]
2429 ["Show Priority" org-show-priority t])
2431 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2432 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2433 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2434 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2435 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2436 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2438 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2440 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2443 ["Push Files and Views" org-mobile-push t]
2444 ["Get Captured and Flagged" org-mobile-pull t]
2445 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2446 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2448 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2450 ["Quit" org-agenda-quit t]
2451 ["Exit and Release Buffers" org-agenda-exit t]
2456 (defvar org-agenda-allow-remote-undo t
2457 "Non-nil means allow remote undo from the agenda buffer.")
2458 (defvar org-agenda-undo-has-started-in nil
2459 "Buffers that have already seen `undo-start' in the current undo sequence.")
2461 (defun org-agenda-undo ()
2462 "Undo a remote editing step in the agenda.
2463 This undoes changes both in the agenda buffer and in the remote buffer
2464 that have been changed along."
2466 (or org-agenda-allow-remote-undo
2467 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2468 (if (not (eq this-command last-command))
2469 (setq org-agenda-undo-has-started-in nil
2470 org-agenda-pending-undo-list org-agenda-undo-list))
2471 (if (not org-agenda-pending-undo-list)
2472 (error "No further undo information"))
2473 (let* ((entry (pop org-agenda-pending-undo-list))
2474 buf line cmd rembuf)
2475 (setq cmd (pop entry) line (pop entry))
2476 (setq rembuf (nth 2 entry))
2477 (org-with-remote-undo rembuf
2478 (while (bufferp (setq buf (pop entry)))
2480 (with-current-buffer buf
2481 (let ((last-undo-buffer buf)
2482 (inhibit-read-only t))
2483 (unless (memq buf org-agenda-undo-has-started-in)
2484 (push buf org-agenda-undo-has-started-in)
2485 (make-local-variable 'pending-undo-list)
2487 (while (and pending-undo-list
2488 (listp pending-undo-list)
2489 (not (car pending-undo-list)))
2490 (pop pending-undo-list))
2492 (org-goto-line line)
2493 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2495 (defun org-verify-change-for-undo (l1 l2)
2496 "Verify that a real change occurred between the undo lists L1 and L2."
2497 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2498 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2503 (defvar org-agenda-restrict-begin (make-marker))
2504 (defvar org-agenda-restrict-end (make-marker))
2505 (defvar org-agenda-last-dispatch-buffer nil)
2506 (defvar org-agenda-overriding-restriction nil)
2508 (defcustom org-agenda-custom-commands-contexts nil
2509 "Alist of custom agenda keys and contextual rules.
2511 For example, if you have a custom agenda command \"p\" and you
2512 want this command to be accessible only from plain text files,
2515 '((\"p\" ((in-file . \"\\.txt\"))))
2517 Here are the available contexts definitions:
2519 in-file: command displayed only in matching files
2520 in-mode: command displayed only in matching modes
2521 not-in-file: command not displayed in matching files
2522 not-in-mode: command not displayed in matching modes
2523 in-buffer: command displayed only in matching buffers
2524 not-in-buffer: command not displayed in matching buffers
2525 [function]: a custom function taking no argument
2527 If you define several checks, the agenda command will be
2528 accessible if there is at least one valid check.
2530 You can also bind a key to another agenda custom command
2531 depending on contextual rules.
2533 '((\"p\" \"q\" ((in-file . \"\\.txt\"))))
2535 Here it means: in .txt files, use \"p\" as the key for the
2536 agenda command otherwise associated with \"q\". (The command
2537 originally associated with \"q\" is not displayed to avoid
2540 :group 'org-agenda-custom-commands
2541 :type '(repeat (list :tag "Rule"
2542 (string :tag " Agenda key")
2543 (string :tag "Replace by command")
2544 (repeat :tag "Available when"
2546 (cons :tag "Condition"
2548 (const :tag "In file" in-file)
2549 (const :tag "Not in file" not-in-file)
2550 (const :tag "In buffer" in-buffer)
2551 (const :tag "Not in buffer" not-in-buffer)
2552 (const :tag "In mode" in-mode)
2553 (const :tag "Not in mode" not-in-mode))
2555 (function :tag "Custom function"))))))
2557 (defcustom org-agenda-max-entries nil
2558 "Maximum number of entries to display in an agenda.
2559 This can be nil (no limit) or an integer or an alist of agenda
2560 types with an associated number of entries to display in this
2563 :package-version '(Org . "8.0")
2564 :group 'org-agenda-custom-commands
2565 :type '(choice (symbol :tag "No limit" nil)
2566 (integer :tag "Max number of entries")
2568 (cons (choice :tag "Agenda type"
2574 (integer :tag "Max number of entries")))))
2576 (defcustom org-agenda-max-todos nil
2577 "Maximum number of TODOs to display in an agenda.
2578 This can be nil (no limit) or an integer or an alist of agenda
2579 types with an associated number of entries to display in this
2582 :package-version '(Org . "8.0")
2583 :group 'org-agenda-custom-commands
2584 :type '(choice (symbol :tag "No limit" nil)
2585 (integer :tag "Max number of entries")
2587 (cons (choice :tag "Agenda type"
2593 (integer :tag "Max number of entries")))))
2595 (defcustom org-agenda-max-tags nil
2596 "Maximum number of tagged entries to display in an agenda.
2597 This can be nil (no limit) or an integer or an alist of agenda
2598 types with an associated number of entries to display in this
2601 :package-version '(Org . "8.0")
2602 :group 'org-agenda-custom-commands
2603 :type '(choice (symbol :tag "No limit" nil)
2604 (integer :tag "Max number of entries")
2606 (cons (choice :tag "Agenda type"
2612 (integer :tag "Max number of entries")))))
2614 (defcustom org-agenda-max-effort nil
2615 "Maximum cumulated effort duration for the agenda.
2616 This can be nil (no limit) or a number of minutes (as an integer)
2617 or an alist of agenda types with an associated number of minutes
2618 to limit entries to in this type."
2620 :package-version '(Org . "8.0")
2621 :group 'org-agenda-custom-commands
2622 :type '(choice (symbol :tag "No limit" nil)
2623 (integer :tag "Max number of entries")
2625 (cons (choice :tag "Agenda type"
2631 (integer :tag "Max number of entries")))))
2633 (defvar org-keys nil)
2634 (defvar org-match nil)
2636 (defun org-agenda (&optional arg org-keys restriction)
2637 "Dispatch agenda commands to collect entries to the agenda buffer.
2638 Prompts for a command to execute. Any prefix arg will be passed
2639 on to the selected command. The default selections are:
2641 a Call `org-agenda-list' to display the agenda for current day or week.
2642 t Call `org-todo-list' to display the global todo list.
2643 T Call `org-todo-list' to display the global todo list, select only
2644 entries with a specific TODO keyword (the user gets a prompt).
2645 m Call `org-tags-view' to display headlines with tags matching
2646 a condition (the user is prompted for the condition).
2647 M Like `m', but select only TODO entries, no ordinary headlines.
2648 L Create a timeline for the current buffer.
2649 e Export views to associated files.
2650 s Search entries for keywords.
2651 S Search entries for keywords, only with TODO keywords.
2652 / Multi occur across all agenda files and also files listed
2653 in `org-agenda-text-search-extra-files'.
2654 < Restrict agenda commands to buffer, subtree, or region.
2655 Press several times to get the desired effect.
2656 > Remove a previous restriction.
2657 # List \"stuck\" projects.
2658 ! Configure what \"stuck\" means.
2659 C Configure custom agenda commands.
2661 More commands can be added by configuring the variable
2662 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2663 searches can be pre-defined in this way.
2665 If the current buffer is in Org-mode and visiting a file, you can also
2666 first press `<' once to indicate that the agenda should be temporarily
2667 \(until the next use of \\[org-agenda]) restricted to the current file.
2668 Pressing `<' twice means to restrict to the current subtree or region
2672 (let* ((prefix-descriptions nil)
2673 (org-agenda-buffer-name org-agenda-buffer-name)
2674 (org-agenda-window-setup (if (equal (buffer-name)
2675 org-agenda-buffer-name)
2677 org-agenda-window-setup))
2678 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2679 (org-agenda-custom-commands
2680 ;; normalize different versions
2684 (cond ((stringp (cdr x))
2685 (push x prefix-descriptions)
2687 ((stringp (nth 1 x)) x)
2688 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2689 (t (cons (car x) (cons "" (cdr x))))))
2690 org-agenda-custom-commands)))
2691 (org-agenda-custom-commands
2692 (org-contextualize-keys
2693 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2694 (buf (current-buffer))
2695 (bfn (buffer-file-name (buffer-base-buffer)))
2696 entry key type org-match lprops ans)
2697 ;; Turn off restriction unless there is an overriding one,
2698 (unless org-agenda-overriding-restriction
2699 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2700 ;; There is a request to keep the file list in place
2701 (put 'org-agenda-files 'org-restrict nil))
2702 (setq org-agenda-restrict nil)
2703 (move-marker org-agenda-restrict-begin nil)
2704 (move-marker org-agenda-restrict-end nil))
2705 ;; Delete old local properties
2706 (put 'org-agenda-redo-command 'org-lprops nil)
2707 ;; Delete previously set last-arguments
2708 (put 'org-agenda-redo-command 'last-args nil)
2709 ;; Remember where this call originated
2710 (setq org-agenda-last-dispatch-buffer (current-buffer))
2712 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2714 restriction (cdr ans)))
2715 ;; If we have sticky agenda buffers, set a name for the buffer,
2716 ;; depending on the invoking keys. The user may still set this
2717 ;; as a command option, which will overwrite what we do here.
2718 (if org-agenda-sticky
2719 (setq org-agenda-buffer-name
2720 (format "*Org Agenda(%s)*" org-keys)))
2721 ;; Establish the restriction, if any
2722 (when (and (not org-agenda-overriding-restriction) restriction)
2723 (put 'org-agenda-files 'org-restrict (list bfn))
2725 ((eq restriction 'region)
2726 (setq org-agenda-restrict t)
2727 (move-marker org-agenda-restrict-begin (region-beginning))
2728 (move-marker org-agenda-restrict-end (region-end)))
2729 ((eq restriction 'subtree)
2731 (setq org-agenda-restrict t)
2732 (org-back-to-heading t)
2733 (move-marker org-agenda-restrict-begin (point))
2734 (move-marker org-agenda-restrict-end
2735 (progn (org-end-of-subtree t)))))))
2737 ;; For example the todo list should not need it (but does...)
2739 ((setq entry (assoc org-keys org-agenda-custom-commands))
2740 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2742 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2743 lprops (nth 4 entry))
2744 (if org-agenda-sticky
2745 (setq org-agenda-buffer-name
2746 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2747 (format "*Org Agenda(%s)*" org-keys))))
2748 (put 'org-agenda-redo-command 'org-lprops lprops)
2751 (org-let lprops '(org-agenda-list current-prefix-arg)))
2753 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2755 (org-let lprops '(org-todo-list current-prefix-arg)))
2757 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2759 (org-let lprops '(org-agenda-list-stuck-projects
2760 current-prefix-arg)))
2762 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2763 ((eq type 'tags-todo)
2764 (org-let lprops '(org-tags-view '(4) org-match)))
2766 (org-let lprops '(org-todo-list org-match)))
2767 ((eq type 'tags-tree)
2768 (org-check-for-org-mode)
2769 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2770 ((eq type 'todo-tree)
2771 (org-check-for-org-mode)
2773 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2774 (regexp-quote org-match) "\\>"))))
2775 ((eq type 'occur-tree)
2776 (org-check-for-org-mode)
2777 (org-let lprops '(org-occur org-match)))
2779 (org-let lprops '(funcall type org-match)))
2781 (org-let lprops '(funcall type org-match)))
2782 (t (error "Invalid custom agenda command type %s" type))))
2783 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2784 ((equal org-keys "C")
2785 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2786 (customize-variable 'org-agenda-custom-commands))
2787 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2788 ((equal org-keys "s") (call-interactively 'org-search-view))
2789 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2790 ((equal org-keys "t") (call-interactively 'org-todo-list))
2791 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2792 ((equal org-keys "m") (call-interactively 'org-tags-view))
2793 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2794 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2795 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2799 (unless (current-message)
2800 (let* ((m (org-agenda-get-any-marker))
2801 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2804 "FLAGGING-NOTE ([?] for more info): "
2806 (replace-regexp-in-string
2808 (copy-sequence note))
2809 nil 'face 'org-warning)))))))
2811 ((equal org-keys "L")
2812 (unless (derived-mode-p 'org-mode)
2813 (error "This is not an Org-mode file"))
2815 (put 'org-agenda-files 'org-restrict (list bfn))
2816 (org-call-with-arg 'org-timeline arg)))
2817 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2818 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2819 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2820 (t (error "Invalid agenda key"))))))
2822 (defun org-agenda-append-agenda ()
2823 "Append another agenda view to the current one.
2824 This function allows interactive building of block agendas.
2825 Agenda views are separated by `org-agenda-block-separator'."
2827 (unless (derived-mode-p 'org-agenda-mode)
2828 (error "Can only append from within agenda buffer"))
2829 (let ((org-agenda-multi t))
2832 (org-agenda-finalize)
2833 (org-agenda-fit-window-to-buffer)))
2835 (defun org-agenda-normalize-custom-commands (cmds)
2836 "Normalize custom commands CMDS."
2840 (cond ((stringp (cdr x)) nil)
2841 ((stringp (nth 1 x)) x)
2842 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2843 (t (cons (car x) (cons "" (cdr x))))))
2846 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2847 "The user interface for selecting an agenda command."
2849 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2850 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2851 (region-p (org-region-active-p))
2852 (custom org-agenda-custom-commands)
2854 restriction second-time
2855 c entry key type match prefixes rmheader header-end custom1 desc
2856 line lines left right n n1)
2857 (save-window-excursion
2858 (delete-other-windows)
2859 (org-switch-to-buffer-other-window " *Agenda Commands*")
2861 (insert (eval-when-compile
2863 "Press key for an agenda command: < Buffer, subtree/region restriction
2864 -------------------------------- > Remove restriction
2865 a Agenda for current week or day e Export agenda views
2866 t List of all TODO entries T Entries with special TODO kwd
2867 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2868 s Search for keywords S Like s, but only TODO entries
2869 L Timeline for current buffer # List stuck projects (!=configure)
2870 / Multi-occur C Configure custom agenda commands
2871 ? Find :FLAGGED: entries * Toggle sticky agenda views
2874 (while (string-match
2875 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2877 (setq start (match-end 0))
2878 (add-text-properties (match-beginning 2) (match-end 2)
2879 '(face bold) header))
2881 (setq header-end (point-marker))
2883 (setq custom1 custom)
2884 (when (eq rmheader t)
2886 (re-search-forward ":" nil t)
2887 (delete-region (match-end 0) (point-at-eol))
2890 (delete-region (match-end 0) (point-at-eol))
2891 (move-marker header-end (match-end 0)))
2892 (goto-char header-end)
2893 (delete-region (point) (point-max))
2895 ;; Produce all the lines that describe custom commands and prefixes
2897 (while (setq entry (pop custom1))
2898 (setq key (car entry) desc (nth 1 entry)
2900 match (nth 3 entry))
2901 (if (> (length key) 1)
2902 (add-to-list 'prefixes (string-to-char key))
2906 (org-add-props (copy-sequence key)
2909 ((string-match "\\S-" desc) desc)
2910 ((eq type 'agenda) "Agenda for current week or day")
2911 ((eq type 'agenda*) "Appointments for current week or day")
2912 ((eq type 'alltodo) "List of all TODO entries")
2913 ((eq type 'search) "Word search")
2914 ((eq type 'stuck) "List of stuck projects")
2915 ((eq type 'todo) "TODO keyword")
2916 ((eq type 'tags) "Tags query")
2917 ((eq type 'tags-todo) "Tags (TODO)")
2918 ((eq type 'tags-tree) "Tags tree")
2919 ((eq type 'todo-tree) "TODO kwd tree")
2920 ((eq type 'occur-tree) "Occur tree")
2921 ((functionp type) (if (symbolp type)
2923 "Lambda expression"))
2925 (if org-agenda-menu-show-matcher
2930 (setq match (copy-sequence match))
2931 (org-add-props match nil 'face 'org-warning))
2933 (format "set of %d commands" (length type))))))
2934 (if (org-string-nw-p match)
2935 (add-text-properties
2936 0 (length line) (list 'help-echo
2937 (concat "Matcher: " match)) line)))
2939 (setq lines (nreverse lines))
2944 (org-add-props (char-to-string x)
2946 (or (cdr (assoc (concat selstring
2948 prefix-descriptions))
2953 ;; Check if we should display in two columns
2954 (if org-agenda-menu-two-columns
2956 (setq n (length lines)
2957 n1 (+ (/ n 2) (mod n 2))
2958 right (nthcdr n1 lines)
2959 left (copy-sequence lines))
2960 (setcdr (nthcdr (1- n1) left) nil))
2961 (setq left lines right nil))
2963 (insert "\n" (pop left))
2965 (if (< (current-column) 40)
2966 (move-to-column 40 t)
2968 (insert (pop right))))
2970 ;; Make the window the right size
2971 (goto-char (point-min))
2973 (if (not (pos-visible-in-window-p (point-max)))
2974 (org-fit-window-to-buffer))
2975 (setq second-time t)
2976 (org-fit-window-to-buffer))
2978 ;; Ask for selection
2979 (message "Press key for agenda command%s:"
2980 (if (or restrict-ok org-agenda-overriding-restriction)
2981 (if org-agenda-overriding-restriction
2982 " (restriction lock active)"
2984 (format " (restricted to %s)" restriction)
2987 (setq c (read-char-exclusive))
2990 ((assoc (char-to-string c) custom)
2991 (setq selstring (concat selstring (char-to-string c)))
2992 (throw 'exit (cons selstring restriction)))
2994 (setq selstring (concat selstring (char-to-string c))
2996 rmheader (or rmheader t)
2997 custom (delq nil (mapcar
2999 (if (or (= (length (car x)) 1)
3000 (/= (string-to-char (car x)) c))
3002 (cons (substring (car x) 1) (cdr x))))
3005 (call-interactively 'org-toggle-sticky-agenda)
3007 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3008 (message "Restriction is only possible in Org-mode buffers")
3011 (org-agenda-remove-restriction-lock 'noupdate)
3012 (setq restriction 'buffer))
3014 (org-agenda-remove-restriction-lock 'noupdate)
3015 (setq restriction (if region-p 'region 'subtree)))
3017 (org-agenda-remove-restriction-lock 'noupdate)
3020 ((eq restriction 'buffer)
3021 (if region-p 'region 'subtree))
3022 ((memq restriction '(subtree region))
3026 (org-agenda-remove-restriction-lock 'noupdate)
3027 (setq restriction nil))
3028 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3029 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3030 ((and (> (length selstring) 0) (eq c ?\d))
3032 (org-agenda-get-restriction-and-command prefix-descriptions))
3034 ((equal c ?q) (error "Abort"))
3035 (t (error "Invalid key %c" c))))))))
3037 (defun org-agenda-fit-window-to-buffer ()
3038 "Fit the window to the buffer size."
3039 (and (memq org-agenda-window-setup '(reorganize-frame))
3040 (fboundp 'fit-window-to-buffer)
3041 (org-fit-window-to-buffer
3043 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3044 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3046 (defvar org-cmd nil)
3047 (defvar org-agenda-overriding-cmd nil)
3048 (defvar org-agenda-overriding-arguments nil)
3049 (defvar org-agenda-overriding-cmd-arguments nil)
3050 (defun org-agenda-run-series (name series)
3051 "Run agenda NAME as a SERIES of agenda commands."
3052 (org-let (nth 1 series) '(org-agenda-prepare name))
3053 ;; We need to reset agenda markers here, because when constructing a
3054 ;; block agenda, the individual blocks do not do that.
3055 (org-agenda-reset-markers)
3056 (let* ((org-agenda-multi t)
3057 (redo (list 'org-agenda-run-series name (list 'quote series)))
3059 (gprops (nth 1 series))
3060 match ;; The byte compiler incorrectly complains about this. Keep it!
3061 org-cmd type lprops)
3062 (while (setq org-cmd (pop cmds))
3063 (setq type (car org-cmd)
3064 match (eval (nth 1 org-cmd))
3065 lprops (nth 2 org-cmd))
3066 (let ((org-agenda-overriding-arguments
3067 (if (eq org-agenda-overriding-cmd org-cmd)
3068 (or org-agenda-overriding-arguments
3069 org-agenda-overriding-cmd-arguments))))
3072 (org-let2 gprops lprops
3073 '(call-interactively 'org-agenda-list)))
3075 (org-let2 gprops lprops
3076 '(funcall 'org-agenda-list nil nil t)))
3078 (org-let2 gprops lprops
3079 '(call-interactively 'org-todo-list)))
3081 (org-let2 gprops lprops
3082 '(org-search-view current-prefix-arg match nil)))
3084 (org-let2 gprops lprops
3085 '(call-interactively 'org-agenda-list-stuck-projects)))
3087 (org-let2 gprops lprops
3088 '(org-tags-view current-prefix-arg match)))
3089 ((eq type 'tags-todo)
3090 (org-let2 gprops lprops
3091 '(org-tags-view '(4) match)))
3093 (org-let2 gprops lprops
3094 '(org-todo-list match)))
3096 (org-let2 gprops lprops
3097 '(funcall type match)))
3098 (t (error "Invalid type in command series")))))
3100 (let ((inhibit-read-only t))
3101 (add-text-properties (point-min) (point-max)
3102 `(org-series t org-series-redo-cmd ,redo)))
3103 (setq org-agenda-redo-command redo)
3104 (goto-char (point-min)))
3105 (org-agenda-fit-window-to-buffer)
3106 (org-let (nth 1 series) '(org-agenda-finalize)))
3109 (defmacro org-batch-agenda (cmd-key &rest parameters)
3110 "Run an agenda command in batch mode and send the result to STDOUT.
3111 If CMD-KEY is a string of length 1, it is used as a key in
3112 `org-agenda-custom-commands' and triggers this command. If it is a
3113 longer string it is used as a tags/todo match string.
3114 Parameters are alternating variable names and values that will be bound
3115 before running the agenda command."
3116 (org-eval-in-environment (org-make-parameter-alist parameters)
3117 (if (> (length cmd-key) 2)
3118 (org-tags-view nil cmd-key)
3119 (org-agenda nil cmd-key)))
3120 (set-buffer org-agenda-buffer-name)
3121 (princ (buffer-string)))
3123 (defvar org-agenda-info nil)
3126 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3127 "Run an agenda command in batch mode and send the result to STDOUT.
3128 If CMD-KEY is a string of length 1, it is used as a key in
3129 `org-agenda-custom-commands' and triggers this command. If it is a
3130 longer string it is used as a tags/todo match string.
3131 Parameters are alternating variable names and values that will be bound
3132 before running the agenda command.
3134 The output gives a line for each selected agenda item. Each
3135 item is a list of comma-separated values, like this:
3137 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3139 category The category of the item
3140 head The headline, without TODO kwd, TAGS and PRIORITY
3141 type The type of the agenda entry, can be
3142 todo selected in TODO match
3143 tagsmatch selected in tags match
3144 diary imported from diary
3145 deadline a deadline on given date
3146 scheduled scheduled on given date
3147 timestamp entry has timestamp on given date
3148 closed entry was closed on given date
3149 upcoming-deadline warning about deadline
3150 past-scheduled forwarded scheduled item
3151 block entry has date block including g. date
3152 todo The todo keyword, if any
3153 tags All tags including inherited ones, separated by colons
3154 date The relevant date, like 2007-2-14
3155 time The time, like 15:00-16:50
3156 extra Sting with extra planning info
3157 priority-l The priority letter if any was given
3158 priority-n The computed numerical priority
3159 agenda-day The day in the agenda where this is listed"
3160 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3161 (org-make-parameter-alist parameters))
3162 (if (> (length cmd-key) 2)
3163 (org-tags-view nil cmd-key)
3164 (org-agenda nil cmd-key)))
3165 (set-buffer org-agenda-buffer-name)
3166 (let* ((lines (org-split-string (buffer-string) "\n"))
3168 (while (setq line (pop lines))
3170 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3171 (setq org-agenda-info
3172 (org-fix-agenda-info (text-properties-at 0 line)))
3174 (mapconcat 'org-agenda-export-csv-mapper
3175 '(org-category txt type todo tags date time extra
3176 priority-letter priority agenda-day)
3180 (defun org-fix-agenda-info (props)
3181 "Make sure all properties on an agenda item have a canonical form.
3182 This ensures the export commands can easily use it."
3184 (when (setq tmp (plist-get props 'tags))
3185 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3186 (when (setq tmp (plist-get props 'date))
3187 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3188 (let ((calendar-date-display-form '(year "-" month "-" day)))
3189 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3191 (setq tmp (calendar-date-string tmp)))
3192 (setq props (plist-put props 'date tmp)))
3193 (when (setq tmp (plist-get props 'day))
3194 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3195 (let ((calendar-date-display-form '(year "-" month "-" day)))
3196 (setq tmp (calendar-date-string tmp)))
3197 (setq props (plist-put props 'day tmp))
3198 (setq props (plist-put props 'agenda-day tmp)))
3199 (when (setq tmp (plist-get props 'txt))
3200 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3201 (plist-put props 'priority-letter (match-string 1 tmp))
3202 (setq tmp (replace-match "" t t tmp)))
3203 (when (and (setq re (plist-get props 'org-todo-regexp))
3204 (setq re (concat "\\`\\.*" re " ?"))
3205 (string-match re tmp))
3206 (plist-put props 'todo (match-string 1 tmp))
3207 (setq tmp (replace-match "" t t tmp)))
3208 (plist-put props 'txt tmp)))
3211 (defun org-agenda-export-csv-mapper (prop)
3212 (let ((res (plist-get org-agenda-info prop)))
3217 (t (prin1-to-string res))))
3218 (while (string-match "," res)
3219 (setq res (replace-match ";" t t res)))
3223 (defun org-store-agenda-views (&rest parameters)
3224 "Store agenda views."
3226 (eval (list 'org-batch-store-agenda-views)))
3229 (defmacro org-batch-store-agenda-views (&rest parameters)
3230 "Run all custom agenda commands that have a file argument."
3231 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3233 (dir default-directory)
3234 (pars (org-make-parameter-alist parameters))
3235 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3236 (save-window-excursion
3238 (setq cmd (pop cmds)
3239 thiscmdkey (car cmd)
3240 thiscmdcmd (cdr cmd)
3241 match (nth 2 thiscmdcmd)
3242 bufname (if org-agenda-sticky
3243 (or (and (stringp match)
3244 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3245 (format "*Org Agenda(%s)*" thiscmdkey))
3246 org-agenda-buffer-name)
3247 cmd-or-set (nth 2 cmd)
3248 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3249 files (nth (if (listp cmd-or-set) 4 5) cmd))
3250 (if (stringp files) (setq files (list files)))
3252 (org-eval-in-environment (append org-agenda-exporter-settings
3254 (org-agenda nil thiscmdkey))
3255 (set-buffer bufname)
3257 (org-eval-in-environment (append org-agenda-exporter-settings
3259 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3260 (and (get-buffer bufname)
3261 (kill-buffer bufname)))))))
3263 (defvar org-agenda-current-span nil
3264 "The current span used in the agenda view.") ; local variable in the agenda buffer
3265 (defun org-agenda-mark-header-line (pos)
3266 "Mark the line at POS as an agenda structure header."
3269 (put-text-property (point-at-bol) (point-at-eol)
3270 'org-agenda-structural-header t)
3271 (when org-agenda-title-append
3272 (put-text-property (point-at-bol) (point-at-eol)
3273 'org-agenda-title-append org-agenda-title-append))))
3275 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3276 (defvar org-agenda-write-buffer-name "Agenda View")
3277 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3278 "Write the current buffer (an agenda view) as a file.
3279 Depending on the extension of the file name, plain text (.txt),
3280 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3281 If the extension is .ics, run icalendar export over all files used
3282 to construct the agenda and limit the export to entries listed in the
3284 If the extension is .org, collect all subtrees corresponding to the
3285 agenda entries and add them in an .org file.
3286 With prefix argument OPEN, open the new file immediately.
3287 If NOSETTINGS is given, do not scope the settings of
3288 `org-agenda-exporter-settings' into the export commands. This is used when
3289 the settings have already been scoped and we do not wish to overrule other,
3290 higher priority settings.
3291 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3292 (interactive "FWrite agenda to file: \nP")
3293 (if (or (not (file-writable-p file))
3294 (and (file-exists-p file)
3295 (if (called-interactively-p 'any)
3296 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3297 (error "Cannot write agenda to file %s" file))
3298 (org-let (if nosettings nil org-agenda-exporter-settings)
3300 (save-window-excursion
3301 (org-agenda-mark-filtered-text)
3302 (let ((bs (copy-sequence (buffer-string))) beg content)
3303 (org-agenda-unmark-filtered-text)
3305 (rename-buffer org-agenda-write-buffer-name t)
3306 (set-buffer-modified-p nil)
3308 (org-agenda-remove-marked-text 'org-filtered)
3309 (while (setq beg (text-property-any (point-min) (point-max)
3312 beg (or (next-single-property-change beg 'org-filtered)
3314 (run-hooks 'org-agenda-before-write-hook)
3316 ((org-bound-and-true-p org-mobile-creating-agendas)
3317 (org-mobile-write-agenda-for-mobile file))
3318 ((string-match "\\.org\\'" file)
3319 (let (content p m message-log-max)
3320 (goto-char (point-min))
3321 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3323 (setq m (get-text-property (point) 'org-hd-marker))
3325 (push (save-excursion
3326 (set-buffer (marker-buffer m))
3328 (org-copy-subtree 1 nil t t)
3333 (mapcar (lambda (s) (org-paste-subtree 1 s)) (reverse content))
3335 (kill-buffer (current-buffer))
3336 (message "Org file written to %s" file)))
3337 ((string-match "\\.html?\\'" file)
3339 (set-buffer (htmlize-buffer (current-buffer)))
3340 (when org-agenda-export-html-style
3341 ;; replace <style> section with org-agenda-export-html-style
3342 (goto-char (point-min))
3343 (kill-region (- (search-forward "<style") 6)
3344 (search-forward "</style>"))
3345 (insert org-agenda-export-html-style))
3347 (kill-buffer (current-buffer))
3348 (message "HTML written to %s" file))
3349 ((string-match "\\.ps\\'" file)
3351 (ps-print-buffer-with-faces file)
3352 (message "Postscript written to %s" file))
3353 ((string-match "\\.pdf\\'" file)
3355 (ps-print-buffer-with-faces
3356 (concat (file-name-sans-extension file) ".ps"))
3357 (call-process "ps2pdf" nil nil nil
3359 (concat (file-name-sans-extension file) ".ps"))
3360 (expand-file-name file))
3361 (delete-file (concat (file-name-sans-extension file) ".ps"))
3362 (message "PDF written to %s" file))
3363 ((string-match "\\.ics\\'" file)
3364 (require 'ox-icalendar)
3365 (org-icalendar-export-current-agenda (expand-file-name file)))
3367 (let ((bs (buffer-string)))
3372 (kill-buffer (current-buffer))
3373 (message "Plain text written to %s" file))))))))
3374 (set-buffer (or agenda-bufname
3375 (and (org-called-interactively-p 'any) (buffer-name))
3376 org-agenda-buffer-name)))
3377 (when open (org-open-file file)))
3379 (defvar org-agenda-tag-filter-overlays nil)
3380 (defvar org-agenda-cat-filter-overlays nil)
3381 (defvar org-agenda-re-filter-overlays nil)
3383 (defun org-agenda-mark-filtered-text ()
3384 "Mark all text hidden by filtering with a text property."
3385 (let ((inhibit-read-only t))
3388 (when (equal (overlay-buffer o) (current-buffer))
3390 (overlay-start o) (overlay-end o)
3392 (append org-agenda-tag-filter-overlays
3393 org-agenda-cat-filter-overlays
3394 org-agenda-re-filter-overlays))))
3396 (defun org-agenda-unmark-filtered-text ()
3397 "Remove the filtering text property."
3398 (let ((inhibit-read-only t))
3399 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3401 (defun org-agenda-remove-marked-text (property &optional value)
3402 "Delete all text marked with VALUE of PROPERTY.
3403 VALUE defaults to t."
3405 (setq value (or value t))
3406 (while (setq beg (text-property-any (point-min) (point-max)
3409 beg (or (next-single-property-change beg 'org-filtered)
3412 (defun org-agenda-add-entry-text ()
3413 "Add entry text to agenda lines.
3414 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3415 entry text following headings shown in the agenda.
3416 Drawers will be excluded, also the line with scheduling/deadline info."
3417 (when (and (> org-agenda-add-entry-text-maxlines 0)
3418 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3420 (goto-char (point-min))
3422 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3423 (beginning-of-line 2)
3424 (setq txt (org-agenda-get-some-entry-text
3425 m org-agenda-add-entry-text-maxlines " > "))
3427 (if (string-match "\\S-" txt)
3429 (or (eobp) (forward-char 1))))))))
3431 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3433 "Extract entry text from MARKER, at most N-LINES lines.
3434 This will ignore drawers etc, just get the text.
3435 If INDENT is given, prefix every line with this string. If KEEP is
3436 given, it is a list of symbols, defining stuff that should not be
3437 removed from the entry content. Currently only `planning' is allowed here."
3438 (let (txt drawer-re kwd-time-re ind)
3440 (with-current-buffer (marker-buffer marker)
3441 (if (not (derived-mode-p 'org-mode))
3448 (setq txt (buffer-substring
3449 (min (1+ (point)) (point-max))
3450 (progn (outline-next-heading) (point)))
3451 drawer-re org-drawer-regexp
3452 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3456 (when org-agenda-add-entry-text-descriptive-links
3457 (goto-char (point-min))
3458 (while (org-activate-bracket-links (point-max))
3459 (add-text-properties (match-beginning 0) (match-end 0)
3461 (goto-char (point-min))
3462 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3463 (set-text-properties (match-beginning 0) (match-end 0)
3465 (goto-char (point-min))
3466 (while (re-search-forward drawer-re nil t)
3469 (progn (re-search-forward
3470 "^[ \t]*:END:.*\n?" nil 'move)
3472 (unless (member 'planning keep)
3473 (goto-char (point-min))
3474 (while (re-search-forward kwd-time-re nil t)
3475 (replace-match "")))
3476 (goto-char (point-min))
3477 (when org-agenda-entry-text-exclude-regexps
3478 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3479 (while (setq re (pop re-list))
3480 (goto-char (point-min))
3481 (while (re-search-forward re nil t)
3482 (replace-match "")))))
3483 (goto-char (point-max))
3484 (skip-chars-backward " \t\n")
3485 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3487 ;; find and remove min common indentation
3488 (goto-char (point-min))
3489 (untabify (point-min) (point-max))
3490 (setq ind (org-get-indentation))
3492 (unless (looking-at "[ \t]*$")
3493 (setq ind (min ind (org-get-indentation))))
3494 (beginning-of-line 2))
3495 (goto-char (point-min))
3497 (unless (looking-at "[ \t]*$")
3498 (move-to-column ind)
3499 (delete-region (point-at-bol) (point)))
3500 (beginning-of-line 2))
3502 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3504 (goto-char (point-min))
3506 (while (and (not (eobp)) (re-search-forward "^" nil t))
3507 (replace-match indent t t)))
3508 (goto-char (point-min))
3509 (while (looking-at "[ \t]*\n") (replace-match ""))
3510 (goto-char (point-max))
3511 (when (> (org-current-line)
3513 (org-goto-line (1+ n-lines))
3515 (setq txt (buffer-substring (point-min) (point)))))))))
3518 (defun org-check-for-org-mode ()
3519 "Make sure current buffer is in org-mode. Error if not."
3520 (or (derived-mode-p 'org-mode)
3521 (error "Cannot execute org-mode agenda command on buffer in %s"
3524 ;;; Agenda prepare and finalize
3526 (defvar org-agenda-multi nil) ; dynamically scoped
3527 (defvar org-agenda-pre-window-conf nil)
3528 (defvar org-agenda-columns-active nil)
3529 (defvar org-agenda-name nil)
3530 (defvar org-agenda-tag-filter nil)
3531 (defvar org-agenda-category-filter nil)
3532 (defvar org-agenda-regexp-filter nil)
3533 (defvar org-agenda-top-category-filter nil)
3534 (defvar org-agenda-tag-filter-while-redo nil)
3535 (defvar org-agenda-tag-filter-preset nil
3536 "A preset of the tags filter used for secondary agenda filtering.
3537 This must be a list of strings, each string must be a single tag preceded
3539 This variable should not be set directly, but agenda custom commands can
3540 bind it in the options section. The preset filter is a global property of
3541 the entire agenda view. In a block agenda, it will not work reliably to
3542 define a filter for one of the individual blocks. You need to set it in
3543 the global options and expect it to be applied to the entire view.")
3545 (defvar org-agenda-category-filter-preset nil
3546 "A preset of the category filter used for secondary agenda filtering.
3547 This must be a list of strings, each string must be a single category
3548 preceded by \"+\" or \"-\".
3549 This variable should not be set directly, but agenda custom commands can
3550 bind it in the options section. The preset filter is a global property of
3551 the entire agenda view. In a block agenda, it will not work reliably to
3552 define a filter for one of the individual blocks. You need to set it in
3553 the global options and expect it to be applied to the entire view.")
3555 (defvar org-agenda-regexp-filter-preset nil
3556 "A preset of the regexp filter used for secondary agenda filtering.
3557 This must be a list of strings, each string must be a single category
3558 preceded by \"+\" or \"-\".
3559 This variable should not be set directly, but agenda custom commands can
3560 bind it in the options section. The preset filter is a global property of
3561 the entire agenda view. In a block agenda, it will not work reliably to
3562 define a filter for one of the individual blocks. You need to set it in
3563 the global options and expect it to be applied to the entire view.")
3565 (defun org-agenda-use-sticky-p ()
3566 "Return non-nil if an agenda buffer named
3567 `org-agenda-buffer-name' exists and should be shown instead of
3568 generating a new one."
3570 ;; turned off by user
3572 ;; For multi-agenda buffer already exists
3573 (not org-agenda-multi)
3575 (get-buffer org-agenda-buffer-name)
3576 ;; C-u parameter is same as last call
3577 (with-current-buffer (get-buffer org-agenda-buffer-name)
3579 (equal current-prefix-arg
3580 org-agenda-last-prefix-arg)
3581 ;; In case user turned stickiness on, while having existing
3582 ;; Agenda buffer active, don't reuse that buffer, because it
3583 ;; does not have org variables local
3584 org-agenda-this-buffer-is-sticky))))
3586 (defun org-agenda-prepare-window (abuf)
3587 "Setup agenda buffer in the window."
3588 (let* ((awin (get-buffer-window abuf))
3591 ((equal (current-buffer) abuf) nil)
3592 (awin (select-window awin))
3593 ((not (setq wconf (current-window-configuration))))
3594 ((equal org-agenda-window-setup 'current-window)
3595 (org-pop-to-buffer-same-window abuf))
3596 ((equal org-agenda-window-setup 'other-window)
3597 (org-switch-to-buffer-other-window abuf))
3598 ((equal org-agenda-window-setup 'other-frame)
3599 (switch-to-buffer-other-frame abuf))
3600 ((equal org-agenda-window-setup 'reorganize-frame)
3601 (delete-other-windows)
3602 (org-switch-to-buffer-other-window abuf)))
3603 ;; additional test in case agenda is invoked from within agenda
3604 ;; buffer via elisp link
3605 (unless (equal (current-buffer) abuf)
3606 (org-pop-to-buffer-same-window abuf))
3607 (setq org-agenda-pre-window-conf
3608 (or org-agenda-pre-window-conf wconf))))
3610 (defun org-agenda-prepare (&optional name)
3611 (if (org-agenda-use-sticky-p)
3613 ;; Popup existing buffer
3614 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
3615 (message "Sticky Agenda buffer, use `r' to refresh")
3616 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3617 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3618 (setq org-todo-keywords-for-agenda nil)
3619 (setq org-drawers-for-agenda nil)
3620 (unless org-agenda-persistent-filter
3621 (setq org-agenda-tag-filter nil
3622 org-agenda-category-filter nil
3623 org-agenda-regexp-filter nil))
3624 (put 'org-agenda-tag-filter :preset-filter
3625 org-agenda-tag-filter-preset)
3626 (put 'org-agenda-category-filter :preset-filter
3627 org-agenda-category-filter-preset)
3628 (put 'org-agenda-regexp-filter :preset-filter
3629 org-agenda-regexp-filter-preset)
3630 (if org-agenda-multi
3632 (setq buffer-read-only nil)
3633 (goto-char (point-max))
3634 (unless (or (bobp) org-agenda-compact-blocks
3635 (not org-agenda-block-separator))
3637 (if (stringp org-agenda-block-separator)
3638 org-agenda-block-separator
3639 (make-string (window-width) org-agenda-block-separator))
3641 (narrow-to-region (point) (point-max)))
3642 (setq org-done-keywords-for-agenda nil)
3644 ;; Setting any org variables that are in org-agenda-local-vars
3645 ;; list need to be done after the prepare call
3646 (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
3647 (setq buffer-read-only nil)
3648 (org-agenda-reset-markers)
3649 (let ((inhibit-read-only t)) (erase-buffer))
3651 (setq org-agenda-buffer (current-buffer))
3652 (setq org-agenda-contributing-files nil)
3653 (setq org-agenda-columns-active nil)
3654 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3655 (setq org-todo-keywords-for-agenda
3656 (org-uniquify org-todo-keywords-for-agenda))
3657 (setq org-done-keywords-for-agenda
3658 (org-uniquify org-done-keywords-for-agenda))
3659 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3660 (setq org-agenda-last-prefix-arg current-prefix-arg)
3661 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3662 (and name (not org-agenda-name)
3663 (org-set-local 'org-agenda-name name)))
3664 (setq buffer-read-only nil)))
3666 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3667 (defun org-agenda-finalize ()
3668 "Finishing touch for the agenda buffer, called just before displaying it."
3669 (unless org-agenda-multi
3671 (let ((inhibit-read-only t))
3672 (goto-char (point-min))
3674 (while (org-activate-bracket-links (point-max))
3675 (add-text-properties (match-beginning 0) (match-end 0)
3678 (while (org-activate-plain-links (point-max))
3679 (add-text-properties (match-beginning 0) (match-end 0)
3681 (unless (eq org-agenda-remove-tags t)
3682 (org-agenda-align-tags))
3683 (unless org-agenda-with-colors
3684 (remove-text-properties (point-min) (point-max) '(face nil)))
3685 (if (and (boundp 'org-agenda-overriding-columns-format)
3686 org-agenda-overriding-columns-format)
3687 (org-set-local 'org-agenda-overriding-columns-format
3688 org-agenda-overriding-columns-format))
3689 (if (and (boundp 'org-agenda-view-columns-initially)
3690 org-agenda-view-columns-initially)
3691 (org-agenda-columns))
3692 (when org-agenda-fontify-priorities
3693 (org-agenda-fontify-priorities))
3694 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3695 (org-agenda-dim-blocked-tasks))
3696 ;; We need to widen when `org-agenda-finalize' is called from
3697 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3698 (when org-clock-current-task
3701 (org-agenda-mark-clocking-task)))
3702 (when org-agenda-entry-text-mode
3703 (org-agenda-entry-text-hide)
3704 (org-agenda-entry-text-show))
3705 (if (and (functionp 'org-habit-insert-consistency-graphs)
3706 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3707 (org-habit-insert-consistency-graphs))
3708 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3709 (unless (or (eq org-agenda-show-inherited-tags 'always)
3710 (and (listp org-agenda-show-inherited-tags)
3711 (memq org-agenda-type org-agenda-show-inherited-tags))
3712 (and (eq org-agenda-show-inherited-tags t)
3713 (or (eq org-agenda-use-tag-inheritance t)
3714 (and (listp org-agenda-use-tag-inheritance)
3715 (not (memq org-agenda-type
3716 org-agenda-use-tag-inheritance))))))
3719 (goto-char (point-min))
3720 (while (equal (forward-line) 0)
3721 (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
3722 (get-text-property (point) 'org-hd-marker)))
3723 (put-text-property (point-at-bol) (point-at-eol)
3724 'tags (org-with-point-at mrk
3726 (mapcar 'downcase (org-get-tags-at))))))))))
3727 (run-hooks 'org-agenda-finalize-hook)
3728 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3729 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3730 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3731 (org-agenda-filter-apply org-agenda-category-filter 'category))
3732 (when (or org-agenda-regexp-filter (get 'org-agenda-regexp-filter :preset-filter))
3733 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3734 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3736 (defun org-agenda-mark-clocking-task ()
3737 "Mark the current clock entry in the agenda if it is present."
3738 (org-agenda-unmark-clocking-task)
3739 (when (marker-buffer org-clock-hd-marker)
3741 (goto-char (point-min))
3743 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3745 (when (equal (org-get-at-bol 'org-hd-marker)
3746 org-clock-hd-marker)
3747 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3748 (overlay-put ov 'type 'org-agenda-clocking)
3749 (overlay-put ov 'face 'org-agenda-clocking)
3750 (overlay-put ov 'help-echo
3751 "The clock is running in this item")))))))
3753 (defun org-agenda-unmark-clocking-task ()
3754 "Unmark the current clocking task."
3756 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3757 (delete-overlay o)))
3758 (overlays-in (point-min) (point-max))))
3760 (defun org-agenda-fontify-priorities ()
3761 "Make highest priority lines bold, and lowest italic."
3763 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3764 (delete-overlay o)))
3765 (overlays-in (point-min) (point-max)))
3768 (goto-char (point-min))
3769 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3770 (setq h (or (get-char-property (point) 'org-highest-priority)
3771 org-highest-priority)
3772 l (or (get-char-property (point) 'org-lowest-priority)
3773 org-lowest-priority)
3774 p (string-to-char (match-string 1))
3775 b (match-beginning 0)
3776 e (if (eq org-agenda-fontify-priorities 'cookies)
3779 ov (make-overlay b e))
3782 (cons (cond ((org-face-from-face-or-color
3784 (cdr (assoc p org-priority-faces))))
3785 ((and (listp org-agenda-fontify-priorities)
3786 (org-face-from-face-or-color
3788 (cdr (assoc p org-agenda-fontify-priorities)))))
3789 ((equal p l) 'italic)
3790 ((equal p h) 'bold))
3792 (overlay-put ov 'org-type 'org-priority)))))
3794 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3796 "Dim currently blocked TODO's in the agenda display."
3797 (message "Dim or hide blocked tasks...")
3798 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3799 (delete-overlay o)))
3800 (overlays-in (point-min) (point-max)))
3802 (let ((inhibit-read-only t)
3803 (org-depend-tag-blocked nil)
3804 (invis (or (not (null invisible))
3805 (eq org-agenda-dim-blocked-tasks 'invisible)))
3806 org-blocked-by-checkboxes
3807 invis1 b e p ov h l)
3808 (goto-char (point-min))
3809 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3810 (and pos (goto-char (1+ pos))))
3811 (setq org-blocked-by-checkboxes nil invis1 invis)
3812 (let ((marker (org-get-at-bol 'org-hd-marker)))
3814 (with-current-buffer (marker-buffer marker)
3815 (save-excursion (goto-char marker)
3816 (org-entry-blocked-p))))
3817 (if org-blocked-by-checkboxes (setq invis1 nil))
3819 (max (point-min) (1- (point-at-bol)))
3822 ov (make-overlay b e))
3824 (overlay-put ov 'invisible t)
3825 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3826 (overlay-put ov 'org-type 'org-blocked-todo))))))
3827 (message "Dim or hide blocked tasks...done"))
3829 (defvar org-agenda-skip-function nil
3830 "Function to be called at each match during agenda construction.
3831 If this function returns nil, the current match should not be skipped.
3832 Otherwise, the function must return a position from where the search
3833 should be continued.
3834 This may also be a Lisp form, it will be evaluated.
3835 Never set this variable using `setq' or so, because then it will apply
3836 to all future agenda commands. If you do want a global skipping condition,
3837 use the option `org-agenda-skip-function-global' instead.
3838 The correct usage for `org-agenda-skip-function' is to bind it with
3839 `let' to scope it dynamically into the agenda-constructing command.
3840 A good way to set it is through options in `org-agenda-custom-commands'.")
3842 (defun org-agenda-skip ()
3843 "Throw to `:skip' in places that should be skipped.
3844 Also moves point to the end of the skipped region, so that search can
3845 continue from there."
3846 (let ((p (point-at-bol)) to)
3848 (save-excursion (goto-char p) (looking-at comment-start-skip))
3849 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3850 (get-text-property p :org-archived)
3851 (org-end-of-subtree t))
3852 (and org-agenda-skip-comment-trees
3853 (get-text-property p :org-comment)
3854 (org-end-of-subtree t))
3855 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3856 (org-agenda-skip-eval org-agenda-skip-function)))
3858 (org-in-src-block-p t))
3861 (defun org-agenda-skip-eval (form)
3862 "If FORM is a function or a list, call (or eval) is and return result.
3863 `save-excursion' and `save-match-data' are wrapped around the call, so point
3864 and match data are returned to the previous state no matter what these
3868 (or (setq fp (functionp form))
3876 (defvar org-agenda-markers nil
3877 "List of all currently active markers created by `org-agenda'.")
3878 (defvar org-agenda-last-marker-time (org-float-time)
3879 "Creation time of the last agenda marker.")
3881 (defun org-agenda-new-marker (&optional pos)
3882 "Return a new agenda marker.
3883 Org-mode keeps a list of these markers and resets them when they are
3885 (let ((m (copy-marker (or pos (point)))))
3886 (setq org-agenda-last-marker-time (org-float-time))
3887 (if org-agenda-buffer
3888 (with-current-buffer org-agenda-buffer
3889 (push m org-agenda-markers))
3890 (push m org-agenda-markers))
3893 (defun org-agenda-reset-markers ()
3894 "Reset markers created by `org-agenda'."
3895 (while org-agenda-markers
3896 (move-marker (pop org-agenda-markers) nil)))
3898 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3899 "Save relative positions of markers in region.
3900 This check for agenda markers in all agenda buffers currently active."
3901 (dolist (buf (buffer-list))
3902 (with-current-buffer buf
3903 (when (eq major-mode 'org-agenda-mode)
3904 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3905 org-agenda-markers)))))
3909 (defun org-agenda-entry-text-show-here ()
3910 "Add some text from the entry as context to the current line."
3912 (setq m (org-get-at-bol 'org-hd-marker))
3913 (unless (marker-buffer m)
3914 (error "No marker points to an entry here"))
3915 (setq txt (concat "\n" (org-no-properties
3916 (org-agenda-get-some-entry-text
3917 m org-agenda-entry-text-maxlines
3918 org-agenda-entry-text-leaders))))
3919 (when (string-match "\\S-" txt)
3920 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3921 (overlay-put o 'evaporate t)
3922 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3923 (overlay-put o 'after-string txt))))
3925 (defun org-agenda-entry-text-show ()
3926 "Add entry context for all agenda lines."
3929 (goto-char (point-max))
3930 (beginning-of-line 1)
3932 (when (org-get-at-bol 'org-hd-marker)
3933 (org-agenda-entry-text-show-here))
3934 (beginning-of-line 0))))
3936 (defun org-agenda-entry-text-hide ()
3937 "Remove any shown entry context."
3940 (if (eq (overlay-get o 'org-overlay-type)
3941 'agenda-entry-content)
3942 (progn (delete-overlay o) t)))
3943 (overlays-in (point-min) (point-max)))))
3945 (defun org-agenda-get-day-face (date)
3946 "Return the face DATE should be displayed with."
3947 (or (and (functionp org-agenda-day-face-function)
3948 (funcall org-agenda-day-face-function date))
3949 (cond ((org-agenda-todayp date)
3950 'org-agenda-date-today)
3951 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3952 'org-agenda-date-weekend)
3953 (t 'org-agenda-date))))
3957 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3959 (defun org-timeline (&optional dotodo)
3960 "Show a time-sorted view of the entries in the current org file.
3961 Only entries with a time stamp of today or later will be listed. With
3962 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3963 under the current date.
3964 If the buffer contains an active region, only check the region for
3968 (org-agenda-show-log-scoped org-agenda-show-log)
3969 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3971 (date (calendar-current-date))
3972 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3973 (end (if (org-region-active-p) (region-end) (point-max)))
3974 (day-numbers (org-get-all-dates
3976 t org-agenda-show-log-scoped ; always include today
3977 org-timeline-show-empty-dates))
3978 (org-deadline-warning-days 0)
3979 (org-agenda-only-exact-dates t)
3984 (setq org-agenda-redo-command
3986 (list 'org-switch-to-buffer-other-window (current-buffer))
3987 (list 'org-timeline (list 'quote dotodo))))
3989 ;; Remove past dates from the list of dates.
3990 (setq day-numbers (delq nil (mapcar (lambda(x)
3991 (if (>= x today) x nil))
3993 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
3994 (org-compile-prefix-format 'timeline)
3995 (org-set-sorting-strategy 'timeline)
3996 (if org-agenda-show-log-scoped (push :closed args))
3997 (push :timestamp args)
3998 (push :deadline args)
3999 (push :scheduled args)
4001 (if dotodo (push :todo args))
4002 (insert "Timeline of file " entry "\n")
4003 (add-text-properties (point-min) (point)
4004 (list 'face 'org-agenda-structure))
4005 (org-agenda-mark-header-line (point-min))
4006 (while (setq d (pop day-numbers))
4007 (if (and (listp d) (eq (car d) :omitted))
4010 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4011 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4012 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4013 (if (and (>= d today)
4018 (insert (make-string 79 ?-) "\n")))
4019 (setq date (calendar-gregorian-from-absolute d))
4021 (setq rtn (and (not emptyp)
4022 (apply 'org-agenda-get-day-entries entry
4024 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4027 (if (stringp org-agenda-format-date)
4028 (format-time-string org-agenda-format-date
4029 (org-time-from-absolute date))
4030 (funcall org-agenda-format-date date))
4032 (put-text-property s (1- (point)) 'face
4033 (org-agenda-get-day-face date))
4034 (put-text-property s (1- (point)) 'org-date-line t)
4035 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4037 (put-text-property s (1- (point)) 'org-today t))
4038 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4039 (put-text-property s (1- (point)) 'day d)))))
4040 (goto-char (point-min))
4041 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4043 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
4044 (org-agenda-finalize)
4045 (setq buffer-read-only t)))
4047 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4048 "Return a list of all relevant day numbers from BEG to END buffer positions.
4049 If NO-RANGES is non-nil, include only the start and end dates of a range,
4050 not every single day in the range. If FORCE-TODAY is non-nil, make
4051 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4052 inactive time stamps (those in square brackets) are included.
4053 When EMPTY is non-nil, also include days without any entries."
4055 (if pre-re pre-re "")
4056 (if inactive org-ts-regexp-both org-ts-regexp)))
4057 dates dates1 date day day1 day2 ts1 ts2 pos)
4059 (setq dates (list (org-today))))
4062 (while (re-search-forward re end t)
4063 (setq day (time-to-days (org-time-string-to-time
4064 (substring (match-string 1) 0 10)
4065 (current-buffer) (match-beginning 0))))
4066 (or (memq day dates) (push day dates)))
4069 (while (re-search-forward org-tr-regexp end t)
4070 (setq pos (match-beginning 0))
4071 (setq ts1 (substring (match-string 1) 0 10)
4072 ts2 (substring (match-string 2) 0 10)
4073 day1 (time-to-days (org-time-string-to-time
4074 ts1 (current-buffer) pos))
4075 day2 (time-to-days (org-time-string-to-time
4076 ts2 (current-buffer) pos)))
4077 (while (< (setq day1 (1+ day1)) day2)
4078 (or (memq day1 dates) (push day1 dates)))))
4079 (setq dates (sort dates '<))
4081 (while (setq day (pop dates))
4082 (setq day2 (car dates))
4084 (when (and day2 empty)
4085 (if (or (eq empty t)
4086 (and (numberp empty) (<= (- day2 day) empty)))
4087 (while (< (setq day (1+ day)) day2)
4088 (push (list day) dates1))
4089 (push (cons :omitted (- day2 day)) dates1))))
4090 (setq dates (nreverse dates1)))
4093 ;;; Agenda Daily/Weekly
4095 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4096 "Start day for the agenda view.
4097 Custom commands can set this variable in the options section.
4098 See the docstring of `org-read-date' on allowed values.")
4099 (defvar org-starting-day nil) ; local variable in the agenda buffer
4100 (defvar org-arg-loc nil) ; local variable
4102 (defvar org-agenda-buffer-tmp-name nil)
4104 (defun org-agenda-list (&optional arg start-day span with-hour)
4105 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4106 The view will be for the current day or week, but from the overview buffer
4107 you will be able to go to other days/weeks.
4109 With a numeric prefix argument in an interactive call, the agenda will
4110 span ARG days. Lisp programs should instead specify SPAN to change
4111 the number of days. SPAN defaults to `org-agenda-span'.
4113 START-DAY defaults to TODAY, or to the most recent match for the weekday
4114 given in `org-agenda-start-on-weekday'.
4116 When WITH-HOUR is non-nil, only include scheduled and deadline
4117 items if they have an hour specification like [h]h:mm."
4119 (if org-agenda-overriding-arguments
4120 (setq arg (car org-agenda-overriding-arguments)
4121 start-day (nth 1 org-agenda-overriding-arguments)
4122 span (nth 2 org-agenda-overriding-arguments)))
4123 (if (and (integerp arg) (> arg 0))
4124 (setq span arg arg nil))
4126 (setq org-agenda-buffer-name
4127 (or org-agenda-buffer-tmp-name
4128 (if org-agenda-sticky
4129 (cond ((and org-keys (stringp org-match))
4130 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4132 (format "*Org Agenda(%s)*" org-keys))
4133 (t "*Org Agenda(a)*")))
4134 org-agenda-buffer-name))
4135 (org-agenda-prepare "Day/Week")
4136 (setq start-day (or start-day org-agenda-start-day))
4137 (if (stringp start-day)
4138 ;; Convert to an absolute day number
4139 (setq start-day (time-to-days (org-read-date nil t start-day))))
4140 (org-compile-prefix-format 'agenda)
4141 (org-set-sorting-strategy 'agenda)
4142 (let* ((span (org-agenda-ndays-to-span
4143 (or span org-agenda-ndays org-agenda-span)))
4145 (sd (or start-day today))
4146 (ndays (org-agenda-span-to-ndays span sd))
4147 (org-agenda-start-on-weekday
4149 org-agenda-start-on-weekday))
4150 (thefiles (org-agenda-files nil 'ifmode))
4152 (start (if (or (null org-agenda-start-on-weekday)
4155 (let* ((nt (calendar-day-of-week
4156 (calendar-gregorian-from-absolute sd)))
4157 (n1 org-agenda-start-on-weekday)
4159 (- sd (+ (if (< d 0) 7 0) d)))))
4160 (day-numbers (list start))
4162 (inhibit-redisplay (not debug-on-error))
4163 (org-agenda-show-log-scoped org-agenda-show-log)
4164 s e rtn rtnall file date d start-pos end-pos todayp
4165 clocktable-start clocktable-end filter)
4166 (setq org-agenda-redo-command
4167 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4168 (dotimes (n (1- ndays))
4169 (push (1+ (car day-numbers)) day-numbers))
4170 (setq day-numbers (nreverse day-numbers))
4171 (setq clocktable-start (car day-numbers)
4172 clocktable-end (1+ (or (org-last day-numbers) 0)))
4173 (org-set-local 'org-starting-day (car day-numbers))
4174 (org-set-local 'org-arg-loc arg)
4175 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4176 (unless org-agenda-compact-blocks
4177 (let* ((d1 (car day-numbers))
4178 (d2 (org-last day-numbers))
4179 (w1 (org-days-to-iso-week d1))
4180 (w2 (org-days-to-iso-week d2)))
4182 (if org-agenda-overriding-header
4183 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4184 nil 'face 'org-agenda-structure) "\n")
4185 (insert (org-agenda-span-name span)
4187 (if (< (- d2 d1) 350)
4189 (format " (W%02d)" w1)
4190 (format " (W%02d-W%02d)" w1 w2))
4193 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4195 (org-agenda-mark-header-line s))
4196 (while (setq d (pop day-numbers))
4197 (setq date (calendar-gregorian-from-absolute d)
4199 (if (or (setq todayp (= d today))
4200 (and (not start-pos) (= d sd)))
4201 (setq start-pos (point))
4202 (if (and start-pos (not end-pos))
4203 (setq end-pos (point))))
4204 (setq files thefiles
4206 (while (setq file (pop files))
4208 (org-check-agenda-file file)
4209 (let ((org-agenda-entry-types org-agenda-entry-types))
4210 ;; Starred types override non-starred equivalents
4211 (when (member :deadline* org-agenda-entry-types)
4212 (setq org-agenda-entry-types
4213 (delq :deadline org-agenda-entry-types)))
4214 (when (member :scheduled* org-agenda-entry-types)
4215 (setq org-agenda-entry-types
4216 (delq :scheduled org-agenda-entry-types)))
4219 (when (member :deadline org-agenda-entry-types)
4220 (setq org-agenda-entry-types
4221 (delq :deadline org-agenda-entry-types))
4222 (push :deadline* org-agenda-entry-types))
4223 (when (member :scheduled org-agenda-entry-types)
4224 (setq org-agenda-entry-types
4225 (delq :scheduled org-agenda-entry-types))
4226 (push :scheduled* org-agenda-entry-types)))
4227 (unless org-agenda-include-deadlines
4228 (setq org-agenda-entry-types
4229 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4231 ((memq org-agenda-show-log-scoped '(only clockcheck))
4232 (setq rtn (org-agenda-get-day-entries
4233 file date :closed)))
4234 (org-agenda-show-log-scoped
4235 (setq rtn (apply 'org-agenda-get-day-entries
4237 (append '(:closed) org-agenda-entry-types))))
4239 (setq rtn (apply 'org-agenda-get-day-entries
4241 org-agenda-entry-types)))))
4242 (setq rtnall (append rtnall rtn)))) ;; all entries
4243 (if org-agenda-include-diary
4244 (let ((org-agenda-search-headline-for-time t))
4245 (require 'diary-lib)
4246 (setq rtn (org-get-entries-from-diary date))
4247 (setq rtnall (append rtnall rtn))))
4248 (if (or rtnall org-agenda-show-all-dates)
4250 (setq day-cnt (1+ day-cnt))
4252 (if (stringp org-agenda-format-date)
4253 (format-time-string org-agenda-format-date
4254 (org-time-from-absolute date))
4255 (funcall org-agenda-format-date date))
4257 (put-text-property s (1- (point)) 'face
4258 (org-agenda-get-day-face date))
4259 (put-text-property s (1- (point)) 'org-date-line t)
4260 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4261 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4263 (put-text-property s (1- (point)) 'org-today t))
4265 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4266 (if rtnall (insert ;; all entries
4267 (org-agenda-finalize-entries rtnall 'agenda)
4269 (put-text-property s (1- (point)) 'day d)
4270 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4271 (when (and org-agenda-clockreport-mode clocktable-start)
4272 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4273 ;; the above line is to ensure the restricted range!
4274 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4276 (setq p (org-plist-delete p :block))
4277 (setq p (plist-put p :tstart clocktable-start))
4278 (setq p (plist-put p :tend clocktable-end))
4279 (setq p (plist-put p :scope 'agenda))
4280 (when (and (eq org-agenda-clockreport-mode 'with-filter)
4281 (setq filter (or org-agenda-tag-filter-while-redo
4282 (get 'org-agenda-tag-filter :preset-filter))))
4283 (setq p (plist-put p :tags (mapconcat (lambda (x)
4284 (if (string-match "[<>=]" x)
4288 (setq tbl (apply 'org-clock-get-clocktable p))
4290 (goto-char (point-min))
4291 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4292 (unless (and (pos-visible-in-window-p (point-min))
4293 (pos-visible-in-window-p (point-max)))
4294 (goto-char (1- (point-max)))
4296 (if (not (pos-visible-in-window-p (or start-pos 1)))
4298 (goto-char (or start-pos 1))
4300 (goto-char (or start-pos 1))
4301 (add-text-properties (point-min) (point-max)
4302 `(org-agenda-type agenda
4303 org-last-args (,arg ,start-day ,span)
4304 org-redo-cmd ,org-agenda-redo-command
4305 org-series-cmd ,org-cmd))
4306 (if (eq org-agenda-show-log-scoped 'clockcheck)
4307 (org-agenda-show-clocking-issues))
4308 (org-agenda-finalize)
4309 (setq buffer-read-only t)
4312 (defun org-agenda-ndays-to-span (n)
4313 "Return a span symbol for a span of N days, or N if none matches."
4314 (cond ((symbolp n) n)
4319 (defun org-agenda-span-to-ndays (span &optional start-day)
4320 "Return ndays from SPAN, possibly starting at START-DAY."
4321 (cond ((numberp span) span)
4325 (let ((date (calendar-gregorian-from-absolute start-day)))
4326 (calendar-last-day-of-month (car date) (caddr date))))
4328 (let ((date (calendar-gregorian-from-absolute start-day)))
4329 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4331 (defun org-agenda-span-name (span)
4332 "Return a SPAN name."
4336 (capitalize (symbol-name span))
4337 (format "%d days" span))))
4339 ;;; Agenda word search
4341 (defvar org-agenda-search-history nil)
4343 (defvar org-search-syntax-table nil
4344 "Special syntax table for org-mode search.
4345 In this table, we have single quotes not as word constituents, to
4346 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4348 (defvar org-mode-syntax-table) ; From org.el
4349 (defun org-search-syntax-table ()
4350 (unless org-search-syntax-table
4351 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4352 (modify-syntax-entry ?' "." org-search-syntax-table)
4353 (modify-syntax-entry ?` "." org-search-syntax-table))
4354 org-search-syntax-table)
4356 (defvar org-agenda-last-search-view-search-was-boolean nil)
4359 (defun org-search-view (&optional todo-only string edit-at)
4360 "Show all entries that contain a phrase or words or regular expressions.
4362 With optional prefix argument TODO-ONLY, only consider entries that are
4363 TODO entries. The argument STRING can be used to pass a default search
4364 string into this function. If EDIT-AT is non-nil, it means that the
4365 user should get a chance to edit this string, with cursor at position
4368 The search string can be viewed either as a phrase that should be found as
4369 is, or it can be broken into a number of snippets, each of which must match
4370 in a Boolean way to select an entry. The default depends on the variable
4371 `org-agenda-search-view-always-boolean'.
4372 Even if this is turned off (the default) you can always switch to
4373 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4375 The default is a direct search of the whole phrase, where each space in
4376 the search string can expand to an arbitrary amount of whitespace,
4379 If using a Boolean search, the search string is split on whitespace and
4380 each snippet is searched separately, with logical AND to select an entry.
4381 Words prefixed with a minus must *not* occur in the entry. Words without
4382 a prefix or prefixed with a plus must occur in the entry. Matching is
4383 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4384 match whole words, not parts of a word) if
4385 `org-agenda-search-view-force-full-words' is set (default is nil).
4387 Boolean search snippets enclosed by curly braces are interpreted as
4388 regular expressions that must or (when preceded with \"-\") must not
4389 match in the entry. Snippets enclosed into double quotes will be taken
4390 as a whole, to include whitespace.
4392 - If the search string starts with an asterisk, search only in headlines.
4393 - If (possibly after the leading star) the search string starts with an
4394 exclamation mark, this also means to look at TODO entries only, an effect
4395 that can also be achieved with a prefix argument.
4396 - If (possibly after star and exclamation mark) the search string starts
4397 with a colon, this will mean that the (non-regexp) snippets of the
4398 Boolean search must match as full words.
4400 This command searches the agenda files, and in addition the files listed
4401 in `org-agenda-text-search-extra-files'."
4403 (if org-agenda-overriding-arguments
4404 (setq todo-only (car org-agenda-overriding-arguments)
4405 string (nth 1 org-agenda-overriding-arguments)
4406 edit-at (nth 2 org-agenda-overriding-arguments)))
4407 (let* ((props (list 'face nil
4408 'done-face 'org-agenda-done
4409 'org-not-done-regexp org-not-done-regexp
4410 'org-todo-regexp org-todo-regexp
4411 'org-complex-heading-regexp org-complex-heading-regexp
4412 'mouse-face 'highlight
4413 'help-echo (format "mouse-2 or RET jump to location")))
4414 (full-words org-agenda-search-view-force-full-words)
4415 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4416 regexp rtn rtnall files file pos inherited-tags
4417 marker category category-pos level tags c neg re boolean
4418 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4419 (unless (and (not edit-at)
4421 (string-match "\\S-" string))
4422 (setq string (read-string
4423 (if org-agenda-search-view-always-boolean
4424 "[+-]Word/{Regexp} ...: "
4425 "Phrase or [+-]Word/{Regexp} ...: ")
4427 ((integerp edit-at) (cons string edit-at))
4429 'org-agenda-search-history)))
4431 (if org-agenda-sticky
4432 (setq org-agenda-buffer-name
4433 (if (stringp string)
4434 (format "*Org Agenda(%s:%s)*"
4435 (or org-keys (or (and todo-only "S") "s")) string)
4436 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4437 (org-agenda-prepare "SEARCH")
4438 (org-compile-prefix-format 'search)
4439 (org-set-sorting-strategy 'search)
4440 (setq org-agenda-redo-command
4441 (list 'org-search-view (if todo-only t nil)
4442 (list 'if 'current-prefix-arg nil string)))
4443 (setq org-agenda-query-string string)
4444 (if (equal (string-to-char string) ?*)
4446 words (substring string 1))
4447 (setq words string))
4448 (when (equal (string-to-char words) ?!)
4450 words (substring words 1)))
4451 (when (equal (string-to-char words) ?:)
4453 words (substring words 1)))
4454 (if (or org-agenda-search-view-always-boolean
4455 (member (string-to-char words) '(?- ?+ ?\{)))
4457 (setq words (org-split-string words))
4459 (while (setq w (pop words))
4460 (while (and (string-match "\\\\\\'" w) words)
4461 (setq w (concat (substring w 0 -1) " " (pop words))))
4463 (setq words (nreverse www) www nil)
4464 (while (setq w (pop words))
4465 (when (and (string-match "\\`[-+]?{" w)
4466 (not (string-match "}\\'" w)))
4467 (while (and words (not (string-match "}\\'" (car words))))
4468 (setq w (concat w " " (pop words))))
4469 (setq w (concat w " " (pop words))))
4471 (setq words (nreverse www)))
4472 (setq org-agenda-last-search-view-search-was-boolean boolean)
4475 (while (setq w (pop words))
4476 (if (or (equal (substring w 0 1) "\"")
4477 (and (> (length w) 1)
4478 (member (substring w 0 1) '("+" "-"))
4479 (equal (substring w 1 2) "\"")))
4480 (while (and words (not (equal (substring w -1) "\"")))
4481 (setq w (concat w " " (pop words)))))
4482 (and (string-match "\\`\\([-+]?\\)\"" w)
4483 (setq w (replace-match "\\1" nil nil w)))
4484 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4486 (setq words (nreverse wds))))
4489 (setq c (string-to-char w))
4491 (setq neg t w (substring w 1))
4493 (setq neg nil w (substring w 1))
4495 (if (string-match "\\`{.*}\\'" w)
4496 (setq re (substring w 1 -1))
4498 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4499 (setq re (regexp-quote (downcase w)))))
4500 (if neg (push re regexps-) (push re regexps+)))
4502 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4504 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4506 (setq regexp org-outline-regexp-bol)
4507 (setq regexp (pop regexps+))
4508 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4510 (setq files (org-agenda-files nil 'ifmode))
4511 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4512 (pop org-agenda-text-search-extra-files)
4513 (setq files (org-add-archive-files files)))
4514 (setq files (append files org-agenda-text-search-extra-files)
4516 (while (setq file (pop files))
4519 (org-check-agenda-file file)
4520 (setq buffer (if (file-exists-p file)
4521 (org-get-agenda-file-buffer file)
4522 (error "No such file %s" file)))
4524 ;; If file does not exist, make sure an error message is sent
4525 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4527 (with-current-buffer buffer
4528 (with-syntax-table (org-search-syntax-table)
4529 (unless (derived-mode-p 'org-mode)
4530 (error "Agenda file %s is not in `org-mode'" file))
4531 (let ((case-fold-search t))
4534 (if org-agenda-restrict
4535 (narrow-to-region org-agenda-restrict-begin
4536 org-agenda-restrict-end)
4538 (goto-char (point-min))
4539 (unless (or (org-at-heading-p)
4540 (outline-next-heading))
4541 (throw 'nextfile t))
4542 (goto-char (max (point-min) (1- (point))))
4543 (while (re-search-forward regexp nil t)
4544 (org-back-to-heading t)
4545 (while (and org-agenda-search-view-max-outline-level
4546 (> (org-reduced-level (org-outline-level))
4547 org-agenda-search-view-max-outline-level)
4549 (outline-back-to-heading t)))
4550 (skip-chars-forward "* ")
4551 (setq beg (point-at-bol)
4554 (outline-next-heading)
4555 (while (and org-agenda-search-view-max-outline-level
4556 (> (org-reduced-level (org-outline-level))
4557 org-agenda-search-view-max-outline-level)
4559 (outline-next-heading)))
4565 (setq str (buffer-substring-no-properties
4567 (if hdl-only (point-at-eol) end)))
4568 (mapc (lambda (wr) (when (string-match wr str)
4569 (goto-char (1- end))
4572 (mapc (lambda (wr) (unless (string-match wr str)
4573 (goto-char (1- end))
4576 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4580 (setq marker (org-agenda-new-marker (point))
4581 category (org-get-category)
4582 level (make-string (org-reduced-level (org-outline-level)) ? )
4583 category-pos (get-text-property (point) 'org-category-position)
4585 (or (eq org-agenda-show-inherited-tags 'always)
4586 (and (listp org-agenda-show-inherited-tags)
4587 (memq 'todo org-agenda-show-inherited-tags))
4588 (and (eq org-agenda-show-inherited-tags t)
4589 (or (eq org-agenda-use-tag-inheritance t)
4590 (memq 'todo org-agenda-use-tag-inheritance))))
4591 tags (org-get-tags-at nil (not inherited-tags))
4592 txt (org-agenda-format-item
4594 (buffer-substring-no-properties
4595 beg1 (point-at-eol))
4596 level category tags t))
4597 (org-add-props txt props
4598 'org-marker marker 'org-hd-marker marker
4599 'org-todo-regexp org-todo-regexp
4601 'org-complex-heading-regexp org-complex-heading-regexp
4602 'priority 1000 'org-category category
4603 'org-category-position category-pos
4606 (goto-char (1- end))))))))))
4607 (setq rtn (nreverse ee))
4608 (setq rtnall (append rtnall rtn)))
4609 (if org-agenda-overriding-header
4610 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4611 nil 'face 'org-agenda-structure) "\n")
4612 (insert "Search words: ")
4613 (add-text-properties (point-min) (1- (point))
4614 (list 'face 'org-agenda-structure))
4616 (insert string "\n")
4617 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4619 (unless org-agenda-multi
4620 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4621 (add-text-properties pos (1- (point))
4622 (list 'face 'org-agenda-structure))))
4623 (org-agenda-mark-header-line (point-min))
4625 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4626 (goto-char (point-min))
4627 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4628 (add-text-properties (point-min) (point-max)
4629 `(org-agenda-type search
4630 org-last-args (,todo-only ,string ,edit-at)
4631 org-redo-cmd ,org-agenda-redo-command
4632 org-series-cmd ,org-cmd))
4633 (org-agenda-finalize)
4634 (setq buffer-read-only t))))
4636 ;;; Agenda TODO list
4638 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4639 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4641 (if (or (equal keywords "ALL") (not keywords))
4642 (propertize "ALL" 'face 'warning)
4645 (propertize kw 'face (org-get-todo-face kw)))
4646 (org-split-string keywords "|")
4650 (defvar org-select-this-todo-keyword nil)
4651 (defvar org-last-arg nil)
4654 (defun org-todo-list (&optional arg)
4655 "Show all (not done) TODO entries from all agenda file in a single list.
4656 The prefix arg can be used to select a specific TODO keyword and limit
4657 the list to these. When using \\[universal-argument], you will be prompted
4658 for a keyword. A numeric prefix directly selects the Nth keyword in
4659 `org-todo-keywords-1'."
4661 (if org-agenda-overriding-arguments
4662 (setq arg org-agenda-overriding-arguments))
4663 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4664 (let* ((today (org-today))
4665 (date (calendar-gregorian-from-absolute today))
4666 (kwds org-todo-keywords-for-agenda)
4667 (completion-ignore-case t)
4668 (org-select-this-todo-keyword
4669 (if (stringp arg) arg
4670 (and arg (integerp arg) (> arg 0)
4671 (nth (1- arg) kwds))))
4672 rtn rtnall files file pos)
4673 (when (equal arg '(4))
4674 (setq org-select-this-todo-keyword
4675 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4676 (mapcar 'list kwds) nil nil)))
4677 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4679 (if org-agenda-sticky
4680 (setq org-agenda-buffer-name
4681 (if (stringp org-select-this-todo-keyword)
4682 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4683 org-select-this-todo-keyword)
4684 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4685 (org-agenda-prepare "TODO")
4686 (org-compile-prefix-format 'todo)
4687 (org-set-sorting-strategy 'todo)
4688 (setq org-agenda-redo-command
4689 `(org-todo-list (or (and (numberp current-prefix-arg)
4691 ,org-select-this-todo-keyword
4692 current-prefix-arg ,arg)))
4693 (setq files (org-agenda-files nil 'ifmode)
4695 (while (setq file (pop files))
4697 (org-check-agenda-file file)
4698 (setq rtn (org-agenda-get-day-entries file date :todo))
4699 (setq rtnall (append rtnall rtn))))
4700 (if org-agenda-overriding-header
4701 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4702 nil 'face 'org-agenda-structure) "\n")
4703 (insert "Global list of TODO items of type: ")
4704 (add-text-properties (point-min) (1- (point))
4705 (list 'face 'org-agenda-structure
4708 (or org-select-this-todo-keyword "ALL"))))
4709 (org-agenda-mark-header-line (point-min))
4710 (insert (org-agenda-propertize-selected-todo-keywords
4711 org-select-this-todo-keyword))
4713 (unless org-agenda-multi
4714 (insert "Available with `N r': (0)[ALL]")
4717 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4718 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4723 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4724 (org-agenda-mark-header-line (point-min))
4726 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4727 (goto-char (point-min))
4728 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4729 (add-text-properties (point-min) (point-max)
4730 `(org-agenda-type todo
4732 org-redo-cmd ,org-agenda-redo-command
4733 org-series-cmd ,org-cmd))
4734 (org-agenda-finalize)
4735 (setq buffer-read-only t))))
4737 ;;; Agenda tags match
4740 (defun org-tags-view (&optional todo-only match)
4741 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4742 The prefix arg TODO-ONLY limits the search to TODO entries."
4744 (if org-agenda-overriding-arguments
4745 (setq todo-only (car org-agenda-overriding-arguments)
4746 match (nth 1 org-agenda-overriding-arguments)))
4747 (let* ((org-tags-match-list-sublevels
4748 org-tags-match-list-sublevels)
4749 (completion-ignore-case t)
4750 rtn rtnall files file pos matcher
4752 (when (and (stringp match) (not (string-match "\\S-" match)))
4754 (setq matcher (org-make-tags-matcher match)
4755 match (car matcher) matcher (cdr matcher))
4757 (if org-agenda-sticky
4758 (setq org-agenda-buffer-name
4760 (format "*Org Agenda(%s:%s)*"
4761 (or org-keys (or (and todo-only "M") "m")) match)
4762 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4763 (org-agenda-prepare (concat "TAGS " match))
4764 (org-compile-prefix-format 'tags)
4765 (org-set-sorting-strategy 'tags)
4766 (setq org-agenda-query-string match)
4767 (setq org-agenda-redo-command
4768 (list 'org-tags-view `(quote ,todo-only)
4769 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4770 (setq files (org-agenda-files nil 'ifmode)
4772 (while (setq file (pop files))
4774 (org-check-agenda-file file)
4775 (setq buffer (if (file-exists-p file)
4776 (org-get-agenda-file-buffer file)
4777 (error "No such file %s" file)))
4779 ;; If file does not exist, error message to agenda
4781 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4782 rtnall (append rtnall rtn))
4783 (with-current-buffer buffer
4784 (unless (derived-mode-p 'org-mode)
4785 (error "Agenda file %s is not in `org-mode'" file))
4788 (if org-agenda-restrict
4789 (narrow-to-region org-agenda-restrict-begin
4790 org-agenda-restrict-end)
4792 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4793 (setq rtnall (append rtnall rtn))))))))
4794 (if org-agenda-overriding-header
4795 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4796 nil 'face 'org-agenda-structure) "\n")
4797 (insert "Headlines with TAGS match: ")
4798 (add-text-properties (point-min) (1- (point))
4799 (list 'face 'org-agenda-structure
4801 (concat "Match: " match)))
4804 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4806 (unless org-agenda-multi
4807 (insert "Press `C-u r' to search again with new search string\n"))
4808 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4809 (org-agenda-mark-header-line (point-min))
4811 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4812 (goto-char (point-min))
4813 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4814 (add-text-properties (point-min) (point-max)
4815 `(org-agenda-type tags
4816 org-last-args (,todo-only ,match)
4817 org-redo-cmd ,org-agenda-redo-command
4818 org-series-cmd ,org-cmd))
4819 (org-agenda-finalize)
4820 (setq buffer-read-only t))))
4822 ;;; Agenda Finding stuck projects
4824 (defvar org-agenda-skip-regexp nil
4825 "Regular expression used in skipping subtrees for the agenda.
4826 This is basically a temporary global variable that can be set and then
4827 used by user-defined selections using `org-agenda-skip-function'.")
4829 (defvar org-agenda-overriding-header nil
4830 "When set during agenda, todo and tags searches it replaces the header.
4831 This variable should not be set directly, but custom commands can bind it
4832 in the options section.")
4834 (defun org-agenda-skip-entry-when-regexp-matches ()
4835 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4836 If yes, it returns the end position of this entry, causing agenda commands
4837 to skip the entry but continuing the search in the subtree. This is a
4838 function that can be put into `org-agenda-skip-function' for the duration
4840 (let ((end (save-excursion (org-end-of-subtree t)))
4843 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4846 (defun org-agenda-skip-subtree-when-regexp-matches ()
4847 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4848 If yes, it returns the end position of this tree, causing agenda commands
4849 to skip this subtree. This is a function that can be put into
4850 `org-agenda-skip-function' for the duration of a command."
4851 (let ((end (save-excursion (org-end-of-subtree t)))
4854 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4857 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4858 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4859 If yes, it returns the end position of the current entry (NOT the tree),
4860 causing agenda commands to skip the entry but continuing the search in
4861 the subtree. This is a function that can be put into
4862 `org-agenda-skip-function' for the duration of a command. An important
4863 use of this function is for the stuck project list."
4864 (let ((end (save-excursion (org-end-of-subtree t)))
4865 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4868 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4869 (and skip entry-end)))
4871 (defun org-agenda-skip-entry-if (&rest conditions)
4872 "Skip entry if any of CONDITIONS is true.
4873 See `org-agenda-skip-if' for details."
4874 (org-agenda-skip-if nil conditions))
4876 (defun org-agenda-skip-subtree-if (&rest conditions)
4877 "Skip entry if any of CONDITIONS is true.
4878 See `org-agenda-skip-if' for details."
4879 (org-agenda-skip-if t conditions))
4881 (defun org-agenda-skip-if (subtree conditions)
4882 "Checks current entity for CONDITIONS.
4883 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4884 the entry (i.e. the text before the next heading) is checked.
4886 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4887 from different tests. Valid conditions are:
4889 scheduled Check if there is a scheduled cookie
4890 notscheduled Check if there is no scheduled cookie
4891 deadline Check if there is a deadline
4892 notdeadline Check if there is no deadline
4893 timestamp Check if there is a timestamp (also deadline or scheduled)
4894 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4895 regexp Check if regexp matches
4896 notregexp Check if regexp does not match.
4897 todo Check if TODO keyword matches
4898 nottodo Check if TODO keyword does not match
4900 The regexp is taken from the conditions list, it must come right after
4901 the `regexp' or `notregexp' element.
4903 `todo' and `nottodo' accept as an argument a list of todo
4904 keywords, which may include \"*\" to match any todo keyword.
4906 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4908 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4910 Instead of a list, a keyword class may be given. For example:
4912 (org-agenda-skip-entry-if 'nottodo 'done)
4914 would skip entries that haven't been marked with any of \"DONE\"
4915 keywords. Possible classes are: `todo', `done', `any'.
4917 If any of these conditions is met, this function returns the end point of
4918 the entity, causing the search to continue from there. This is a function
4919 that can be put into `org-agenda-skip-function' for the duration of a command."
4921 (org-back-to-heading t)
4924 (progn (org-end-of-subtree t) (point))
4925 (progn (outline-next-heading) (1- (point)))))
4929 (and (memq 'scheduled conditions)
4930 (re-search-forward org-scheduled-time-regexp end t))
4931 (and (memq 'notscheduled conditions)
4932 (not (re-search-forward org-scheduled-time-regexp end t)))
4933 (and (memq 'deadline conditions)
4934 (re-search-forward org-deadline-time-regexp end t))
4935 (and (memq 'notdeadline conditions)
4936 (not (re-search-forward org-deadline-time-regexp end t)))
4937 (and (memq 'timestamp conditions)
4938 (re-search-forward org-ts-regexp end t))
4939 (and (memq 'nottimestamp conditions)
4940 (not (re-search-forward org-ts-regexp end t)))
4941 (and (setq m (memq 'regexp conditions))
4943 (re-search-forward (nth 1 m) end t))
4944 (and (setq m (memq 'notregexp conditions))
4946 (not (re-search-forward (nth 1 m) end t)))
4948 (setq m (memq 'nottodo conditions))
4949 (setq m (memq 'todo-unblocked conditions))
4950 (setq m (memq 'nottodo-unblocked conditions))
4951 (setq m (memq 'todo conditions)))
4952 (org-agenda-skip-if-todo m end)))
4955 (defun org-agenda-skip-if-todo (args end)
4956 "Helper function for `org-agenda-skip-if', do not use it directly.
4957 ARGS is a list with first element either `todo', `nottodo',
4958 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4959 a list of TODO keywords, or a state symbol `todo' or `done' or
4961 (let ((kw (car args))
4967 ((listp arg) ;; list of keywords
4968 (if (member "*" arg)
4969 (mapcar 'substring-no-properties org-todo-keywords-1)
4971 ((symbolp arg) ;; keyword class name
4974 (org-delete-all org-done-keywords
4975 (mapcar 'substring-no-properties
4976 org-todo-keywords-1)))
4977 ((eq arg 'done) org-done-keywords)
4979 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4981 (concat "^\\*+[ \t]+\\<\\("
4982 (mapconcat 'identity todo-wds "\\|")
4985 ((eq kw 'todo) (re-search-forward todo-re end t))
4986 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4987 ((eq kw 'todo-unblocked)
4989 (while (re-search-forward todo-re end t)
4990 (or (org-entry-blocked-p) (throw 'unblocked t)))
4992 ((eq kw 'nottodo-unblocked)
4994 (while (re-search-forward todo-re end t)
4995 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5000 (defun org-agenda-list-stuck-projects (&rest ignore)
5001 "Create agenda view for projects that are stuck.
5002 Stuck projects are project that have no next actions. For the definitions
5003 of what a project is and how to check if it stuck, customize the variable
5004 `org-stuck-projects'."
5006 (let* ((org-agenda-skip-function
5007 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5008 ;; We could have used org-agenda-skip-if here.
5009 (org-agenda-overriding-header
5010 (or org-agenda-overriding-header "List of stuck projects: "))
5011 (matcher (nth 0 org-stuck-projects))
5012 (todo (nth 1 org-stuck-projects))
5013 (todo-wds (if (member "*" todo)
5015 (org-agenda-prepare-buffers (org-agenda-files
5018 org-done-keywords-for-agenda
5019 (copy-sequence org-todo-keywords-for-agenda)))
5021 (todo-re (concat "^\\*+[ \t]+\\("
5022 (mapconcat 'identity todo-wds "\\|")
5024 (tags (nth 2 org-stuck-projects))
5025 (tags-re (if (member "*" tags)
5026 (concat org-outline-regexp-bol
5027 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5029 (concat org-outline-regexp-bol
5031 (mapconcat 'identity tags "\\|")
5032 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5033 (gen-re (nth 3 org-stuck-projects))
5039 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5041 (setq org-agenda-skip-regexp
5043 (mapconcat 'identity re-list "\\|")
5044 (error "No information how to identify unstuck projects")))
5045 (org-tags-view nil matcher)
5046 (with-current-buffer org-agenda-buffer-name
5047 (setq org-agenda-redo-command
5048 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5050 ;;; Diary integration
5052 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5053 (defvar diary-list-entries-hook)
5054 (defvar diary-time-regexp)
5055 (defun org-get-entries-from-diary (date)
5056 "Get the (Emacs Calendar) diary entries for DATE."
5057 (require 'diary-lib)
5058 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5059 (diary-display-hook '(fancy-diary-display))
5060 (diary-display-function 'fancy-diary-display)
5062 (diary-list-entries-hook
5063 (cons 'org-diary-default-entry diary-list-entries-hook))
5064 (diary-file-name-prefix nil) ; turn this feature off
5065 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5067 (org-disable-agenda-to-diary t))
5069 (save-window-excursion
5070 (funcall (if (fboundp 'diary-list-entries)
5071 'diary-list-entries 'list-diary-entries)
5073 (if (not (get-buffer diary-fancy-buffer))
5075 (with-current-buffer diary-fancy-buffer
5076 (setq buffer-read-only nil)
5077 (if (zerop (buffer-size))
5080 ;; Omit the date and other unnecessary stuff
5081 (org-agenda-cleanup-fancy-diary)
5082 ;; Add prefix to each line and extend the text properties
5083 (if (zerop (buffer-size))
5085 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5088 (insert entries) (goto-char (point-min))
5089 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5090 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5091 (replace-match (concat "; " (match-string 1)))))
5093 (set-buffer-modified-p nil)
5094 (kill-buffer diary-fancy-buffer)))
5096 (setq entries (org-split-string entries "\n"))
5100 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5101 ;; Extend the text properties to the beginning of the line
5102 (org-add-props x (text-properties-at (1- (length x)) x)
5103 'type "diary" 'date date 'face 'org-agenda-diary))
5106 (defvar org-agenda-cleanup-fancy-diary-hook nil
5107 "Hook run when the fancy diary buffer is cleaned up.")
5109 (defun org-agenda-cleanup-fancy-diary ()
5110 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5111 This gets rid of the date, the underline under the date, and
5112 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5113 date. It also removes lines that contain only whitespace."
5114 (goto-char (point-min))
5115 (if (looking-at ".*?:[ \t]*")
5118 (re-search-forward "\n=+$" nil t)
5120 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5121 (re-search-forward "\n=+$" nil t)
5122 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5123 (goto-char (point-min))
5124 (while (re-search-forward "^ +\n" nil t)
5126 (goto-char (point-min))
5127 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5129 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5131 ;; Make sure entries from the diary have the right text properties.
5132 (eval-after-load "diary-lib"
5133 '(if (boundp 'diary-modify-entry-list-string-function)
5134 ;; We can rely on the hook, nothing to do
5136 ;; Hook not available, must use advice to make this work
5137 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5138 "Make the position visible."
5139 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5142 (setq string (org-modify-diary-entry-string string))))))
5144 (defun org-modify-diary-entry-string (string)
5145 "Add text properties to string, allowing org-mode to act on it."
5146 (org-add-props string nil
5147 'mouse-face 'highlight
5148 'help-echo (if buffer-file-name
5149 (format "mouse-2 or RET jump to diary file %s"
5150 (abbreviate-file-name buffer-file-name))
5152 'org-agenda-diary-link t
5153 'org-marker (org-agenda-new-marker (point-at-bol))))
5155 (defun org-diary-default-entry ()
5156 "Add a dummy entry to the diary.
5157 Needed to avoid empty dates which mess up holiday display."
5158 ;; Catch the error if dealing with the new add-to-diary-alist
5159 (when org-disable-agenda-to-diary
5161 (org-add-to-diary-list original-date "Org-mode dummy" "")
5163 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5165 (defun org-add-to-diary-list (&rest args)
5166 (if (fboundp 'diary-add-to-list)
5167 (apply 'diary-add-to-list args)
5168 (apply 'add-to-diary-list args)))
5170 (defvar org-diary-last-run-time nil)
5173 (defun org-diary (&rest args)
5174 "Return diary information from org files.
5175 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5176 It accesses org files and extracts information from those files to be
5177 listed in the diary. The function accepts arguments specifying what
5178 items should be listed. For a list of arguments allowed here, see the
5179 variable `org-agenda-entry-types'.
5181 The call in the diary file should look like this:
5183 &%%(org-diary) ~/path/to/some/orgfile.org
5185 Use a separate line for each org file to check. Or, if you omit the file name,
5186 all files listed in `org-agenda-files' will be checked automatically:
5190 If you don't give any arguments (as in the example above), the default value
5191 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5192 So the example above may also be written as
5194 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5196 The function expects the lisp variables `entry' and `date' to be provided
5197 by the caller, because this is how the calendar works. Don't use this
5198 function from a program - use `org-agenda-get-day-entries' instead."
5199 (when (> (- (org-float-time)
5200 org-agenda-last-marker-time)
5202 ;; I am not sure if this works with sticky agendas, because the marker
5203 ;; list is then no longer a global variable.
5204 (org-agenda-reset-markers))
5205 (org-compile-prefix-format 'agenda)
5206 (org-set-sorting-strategy 'agenda)
5207 (setq args (or args org-agenda-entry-types))
5208 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5210 (org-agenda-files t)))
5211 (time (org-float-time))
5213 (when (or (not org-diary-last-run-time)
5215 org-diary-last-run-time)
5217 (org-agenda-prepare-buffers files))
5218 (setq org-diary-last-run-time time)
5219 ;; If this is called during org-agenda, don't return any entries to
5220 ;; the calendar. Org Agenda will list these entries itself.
5221 (if org-disable-agenda-to-diary (setq files nil))
5222 (while (setq file (pop files))
5223 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5224 (setq results (append results rtn)))
5227 (mapcar (lambda (i) (replace-regexp-in-string
5228 org-bracket-link-regexp "\\3" i)) results))
5229 (concat (org-agenda-finalize-entries results) "\n"))))
5231 ;;; Agenda entry finders
5233 (defun org-agenda-get-day-entries (file date &rest args)
5234 "Does the work for `org-diary' and `org-agenda'.
5235 FILE is the path to a file to be checked for entries. DATE is date like
5236 the one returned by `calendar-current-date'. ARGS are symbols indicating
5237 which kind of entries should be extracted. For details about these, see
5238 the documentation of `org-diary'."
5239 (setq args (or args org-agenda-entry-types))
5240 (let* ((org-startup-folded nil)
5241 (org-startup-align-all-tables nil)
5242 (buffer (if (file-exists-p file)
5243 (org-get-agenda-file-buffer file)
5244 (error "No such file %s" file)))
5245 arg results rtn deadline-results)
5247 ;; If file does not exist, make sure an error message ends up in diary
5248 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5249 (with-current-buffer buffer
5250 (unless (derived-mode-p 'org-mode)
5251 (error "Agenda file %s is not in `org-mode'" file))
5252 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5253 (let ((case-fold-search nil))
5256 (if org-agenda-restrict
5257 (narrow-to-region org-agenda-restrict-begin
5258 org-agenda-restrict-end)
5260 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5261 (while (setq arg (pop args))
5263 ((and (eq arg :todo)
5264 (equal date (calendar-gregorian-from-absolute
5266 (setq rtn (org-agenda-get-todos))
5267 (setq results (append results rtn)))
5268 ((eq arg :timestamp)
5269 (setq rtn (org-agenda-get-blocks))
5270 (setq results (append results rtn))
5271 (setq rtn (org-agenda-get-timestamps deadline-results))
5272 (setq results (append results rtn)))
5274 (setq rtn (org-agenda-get-sexps))
5275 (setq results (append results rtn)))
5276 ((eq arg :scheduled)
5277 (setq rtn (org-agenda-get-scheduled deadline-results))
5278 (setq results (append results rtn)))
5279 ((eq arg :scheduled*)
5280 (setq rtn (org-agenda-get-scheduled deadline-results t))
5281 (setq results (append results rtn)))
5283 (setq rtn (org-agenda-get-progress))
5284 (setq results (append results rtn)))
5286 (setq rtn (org-agenda-get-deadlines))
5287 (setq deadline-results (copy-sequence rtn))
5288 (setq results (append results rtn)))
5289 ((eq arg :deadline*)
5290 (setq rtn (org-agenda-get-deadlines t))
5291 (setq deadline-results (copy-sequence rtn))
5292 (setq results (append results rtn))))))))
5295 (defsubst org-em (x y list)
5296 "Is X or Y a member of LIST?"
5297 (or (memq x list) (memq y list)))
5299 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5300 (defvar org-agenda-sorting-strategy-selected nil)
5302 (defun org-agenda-get-todos ()
5303 "Return the TODO information for agenda display."
5304 (let* ((props (list 'face nil
5305 'done-face 'org-agenda-done
5306 'org-not-done-regexp org-not-done-regexp
5307 'org-todo-regexp org-todo-regexp
5308 'org-complex-heading-regexp org-complex-heading-regexp
5309 'mouse-face 'highlight
5311 (format "mouse-2 or RET jump to org file %s"
5312 (abbreviate-file-name buffer-file-name))))
5313 (regexp (format org-heading-keyword-regexp-format
5315 ((and org-select-this-todo-keyword
5316 (equal org-select-this-todo-keyword "*"))
5318 (org-select-this-todo-keyword
5320 (mapconcat 'identity
5322 org-select-this-todo-keyword
5325 (t org-not-done-regexp))))
5326 marker priority category category-pos level tags todo-state ts-date ts-date-type
5327 ee txt beg end inherited-tags)
5328 (goto-char (point-min))
5329 (while (re-search-forward regexp nil t)
5334 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5335 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5336 (goto-char (1+ beg))
5337 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5339 (goto-char (match-beginning 2))
5340 (setq marker (org-agenda-new-marker (match-beginning 0))
5341 category (org-get-category)
5344 (cond ((org-em 'scheduled-up 'scheduled-down
5345 org-agenda-sorting-strategy-selected)
5346 (setq ts (org-entry-get (point) "SCHEDULED")
5347 ts-date-type " scheduled"))
5348 ((org-em 'deadline-up 'deadline-down
5349 org-agenda-sorting-strategy-selected)
5350 (setq ts (org-entry-get (point) "DEADLINE")
5351 ts-date-type " deadline"))
5352 ((org-em 'ts-up 'ts-down
5353 org-agenda-sorting-strategy-selected)
5354 (setq ts (org-entry-get (point) "TIMESTAMP")
5355 ts-date-type " timestamp"))
5356 ((org-em 'tsia-up 'tsia-down
5357 org-agenda-sorting-strategy-selected)
5358 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5359 ts-date-type " timestamp_ia"))
5360 ((org-em 'timestamp-up 'timestamp-down
5361 org-agenda-sorting-strategy-selected)
5362 (setq ts (or (org-entry-get (point) "SCHEDULED")
5363 (org-entry-get (point) "DEADLINE")
5364 (org-entry-get (point) "TIMESTAMP")
5365 (org-entry-get (point) "TIMESTAMP_IA"))
5367 (t (setq ts-date-type "")))
5368 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5369 category-pos (get-text-property (point) 'org-category-position)
5371 (buffer-substring (match-beginning 2) (match-end 0)))
5373 (or (eq org-agenda-show-inherited-tags 'always)
5374 (and (listp org-agenda-show-inherited-tags)
5375 (memq 'todo org-agenda-show-inherited-tags))
5376 (and (eq org-agenda-show-inherited-tags t)
5377 (or (eq org-agenda-use-tag-inheritance t)
5378 (memq 'todo org-agenda-use-tag-inheritance))))
5379 tags (org-get-tags-at nil (not inherited-tags))
5380 level (make-string (org-reduced-level (org-outline-level)) ? )
5381 txt (org-agenda-format-item "" txt level category tags t)
5382 priority (1+ (org-get-priority txt))
5383 todo-state (org-get-todo-state))
5384 (org-add-props txt props
5385 'org-marker marker 'org-hd-marker marker
5386 'priority priority 'org-category category
5389 'org-category-position category-pos
5390 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5392 (if org-agenda-todo-list-sublevels
5393 (goto-char (match-end 2))
5394 (org-end-of-subtree 'invisible))))
5397 (defun org-agenda-todo-custom-ignore-p (time n)
5398 "Check whether timestamp is farther away than n number of days.
5399 This function is invoked if `org-agenda-todo-ignore-deadlines',
5400 `org-agenda-todo-ignore-scheduled' or
5401 `org-agenda-todo-ignore-timestamp' is set to an integer."
5402 (let ((days (org-time-stamp-to-now
5403 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5408 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5410 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5411 (when (or org-agenda-todo-ignore-with-date
5412 org-agenda-todo-ignore-scheduled
5413 org-agenda-todo-ignore-deadlines
5414 org-agenda-todo-ignore-timestamp)
5415 (setq end (or end (save-excursion (outline-next-heading) (point))))
5417 (or (and org-agenda-todo-ignore-with-date
5418 (re-search-forward org-ts-regexp end t))
5419 (and org-agenda-todo-ignore-scheduled
5420 (re-search-forward org-scheduled-time-regexp end t)
5422 ((eq org-agenda-todo-ignore-scheduled 'future)
5423 (> (org-time-stamp-to-now
5424 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5425 ((eq org-agenda-todo-ignore-scheduled 'past)
5426 (<= (org-time-stamp-to-now
5427 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5428 ((numberp org-agenda-todo-ignore-scheduled)
5429 (org-agenda-todo-custom-ignore-p
5430 (match-string 1) org-agenda-todo-ignore-scheduled))
5432 (and org-agenda-todo-ignore-deadlines
5433 (re-search-forward org-deadline-time-regexp end t)
5435 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5436 ((eq org-agenda-todo-ignore-deadlines 'far)
5437 (not (org-deadline-close (match-string 1))))
5438 ((eq org-agenda-todo-ignore-deadlines 'future)
5439 (> (org-time-stamp-to-now
5440 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5441 ((eq org-agenda-todo-ignore-deadlines 'past)
5442 (<= (org-time-stamp-to-now
5443 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5444 ((numberp org-agenda-todo-ignore-deadlines)
5445 (org-agenda-todo-custom-ignore-p
5446 (match-string 1) org-agenda-todo-ignore-deadlines))
5447 (t (org-deadline-close (match-string 1)))))
5448 (and org-agenda-todo-ignore-timestamp
5449 (let ((buffer (current-buffer))
5452 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5454 ;; Copy current buffer into a temporary one
5456 (insert-buffer-substring buffer start end)
5457 (goto-char (point-min))
5458 ;; Delete SCHEDULED and DEADLINE items
5459 (while (re-search-forward regexp end t)
5460 (delete-region (match-beginning 0) (match-end 0)))
5461 (goto-char (point-min))
5462 ;; No search for timestamp left
5463 (when (re-search-forward org-ts-regexp nil t)
5465 ((eq org-agenda-todo-ignore-timestamp 'future)
5466 (> (org-time-stamp-to-now
5467 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5468 ((eq org-agenda-todo-ignore-timestamp 'past)
5469 (<= (org-time-stamp-to-now
5470 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5471 ((numberp org-agenda-todo-ignore-timestamp)
5472 (org-agenda-todo-custom-ignore-p
5473 (match-string 1) org-agenda-todo-ignore-timestamp))
5476 (defun org-agenda-get-timestamps (&optional deadline-results)
5477 "Return the date stamp information for agenda display."
5478 (let* ((props (list 'face 'org-agenda-calendar-event
5479 'org-not-done-regexp org-not-done-regexp
5480 'org-todo-regexp org-todo-regexp
5481 'org-complex-heading-regexp org-complex-heading-regexp
5482 'mouse-face 'highlight
5484 (format "mouse-2 or RET jump to org file %s"
5485 (abbreviate-file-name buffer-file-name))))
5486 (d1 (calendar-absolute-from-gregorian date))
5488 (deadline-position-alist
5489 (mapcar (lambda (a) (and (setq mm (get-text-property
5490 0 'org-hd-marker a))
5491 (cons (marker-position mm) a)))
5493 (remove-re org-ts-regexp)
5496 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5500 (car org-time-stamp-formats)
5501 (apply 'encode-time ; DATE bound by calendar
5502 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5504 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5505 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5506 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5507 donep tmp priority category category-pos level ee txt timestr tags
5508 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5509 inherited-tags ts-date)
5510 (goto-char (point-min))
5511 (while (setq end-of-match (re-search-forward regexp nil t))
5512 (setq b0 (match-beginning 0)
5513 b3 (match-beginning 3) e3 (match-end 3)
5514 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5515 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5516 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5518 org-agenda-repeating-timestamp-show-all)))
5520 (and (org-at-date-range-p) (throw :skip nil))
5522 (if (and (match-end 1)
5523 (not (= d1 (org-time-string-to-absolute
5524 (match-string 1) d1 nil show-all
5525 (current-buffer) b0))))
5528 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5530 (setq tmp (buffer-substring (max (point-min)
5531 (- b0 org-ds-keyword-length))
5533 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5534 inactivep (= (char-after b0) ?\[)
5535 deadlinep (string-match org-deadline-regexp tmp)
5536 scheduledp (string-match org-scheduled-regexp tmp)
5537 closedp (and org-agenda-include-inactive-timestamps
5538 (string-match org-closed-string tmp))
5539 clockp (and org-agenda-include-inactive-timestamps
5540 (or (string-match org-clock-string tmp)
5541 (string-match "]-+\\'" tmp)))
5542 warntime (get-text-property (point) 'org-appt-warntime)
5543 donep (member todo-state org-done-keywords))
5544 (if (or scheduledp deadlinep closedp clockp
5545 (and donep org-agenda-skip-timestamp-if-done))
5547 (if (string-match ">" timestr)
5548 ;; substring should only run to end of time stamp
5549 (setq timestr (substring timestr 0 (match-end 0))))
5550 (setq marker (org-agenda-new-marker b0)
5551 category (org-get-category b0)
5552 category-pos (get-text-property b0 'org-category-position))
5554 (if (not (re-search-backward org-outline-regexp-bol nil t))
5556 (goto-char (match-beginning 0))
5557 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5558 (assoc (point) deadline-position-alist))
5560 (setq hdmarker (org-agenda-new-marker)
5562 (or (eq org-agenda-show-inherited-tags 'always)
5563 (and (listp org-agenda-show-inherited-tags)
5564 (memq 'agenda org-agenda-show-inherited-tags))
5565 (and (eq org-agenda-show-inherited-tags t)
5566 (or (eq org-agenda-use-tag-inheritance t)
5567 (memq 'agenda org-agenda-use-tag-inheritance))))
5568 tags (org-get-tags-at nil (not inherited-tags))
5569 level (make-string (org-reduced-level (org-outline-level)) ? ))
5570 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5571 (setq head (or (match-string 1) ""))
5572 (setq txt (org-agenda-format-item
5573 (if inactivep org-agenda-inactive-leader nil)
5574 head level category tags timestr
5576 (setq priority (org-get-priority txt))
5577 (org-add-props txt props 'priority priority
5578 'org-marker marker 'org-hd-marker hdmarker
5579 'org-category category 'date date
5582 (ignore-errors (org-time-string-to-absolute timestr))
5583 'org-category-position category-pos
5584 'todo-state todo-state
5588 (if org-agenda-skip-additional-timestamps-same-entry
5589 (outline-next-heading)
5590 (goto-char end-of-match))))
5593 (defun org-agenda-get-sexps ()
5594 "Return the sexp information for agenda display."
5595 (require 'diary-lib)
5596 (let* ((props (list 'face 'org-agenda-calendar-sexp
5597 'mouse-face 'highlight
5599 (format "mouse-2 or RET jump to org file %s"
5600 (abbreviate-file-name buffer-file-name))))
5602 marker category extra category-pos level ee txt tags entry
5603 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5604 (goto-char (point-min))
5605 (while (re-search-forward regexp nil t)
5608 (setq beg (match-beginning 0))
5609 (goto-char (1- (match-end 0)))
5612 (setq sexp (buffer-substring b (point)))
5613 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5614 (org-trim (match-string 1))
5616 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5618 (setq marker (org-agenda-new-marker beg)
5619 level (make-string (org-reduced-level (org-outline-level)) ? )
5620 category (org-get-category beg)
5621 category-pos (get-text-property beg 'org-category-position)
5623 (or (eq org-agenda-show-inherited-tags 'always)
5624 (and (listp org-agenda-show-inherited-tags)
5625 (memq 'agenda org-agenda-show-inherited-tags))
5626 (and (eq org-agenda-show-inherited-tags t)
5627 (or (eq org-agenda-use-tag-inheritance t)
5628 (memq 'agenda org-agenda-use-tag-inheritance))))
5629 tags (org-get-tags-at nil (not inherited-tags))
5630 todo-state (org-get-todo-state)
5631 warntime (get-text-property (point) 'org-appt-warntime)
5634 (dolist (r (if (stringp result)
5636 result)) ;; we expect a list here
5637 (when (and org-agenda-diary-sexp-prefix
5638 (string-match org-agenda-diary-sexp-prefix r))
5639 (setq extra (match-string 0 r)
5640 r (replace-match "" nil nil r)))
5641 (if (string-match "\\S-" r)
5643 (setq txt "SEXP entry returned empty string"))
5644 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5645 (org-add-props txt props 'org-marker marker
5646 'org-category category 'date date 'todo-state todo-state
5647 'org-category-position category-pos 'tags tags
5649 'type "sexp" 'warntime warntime)
5653 ;; Calendar sanity: define some functions that are independent of
5654 ;; `calendar-date-style'.
5655 ;; Normally I would like to use ISO format when calling the diary functions,
5656 ;; but to make sure we still have Emacs 22 compatibility we bind
5657 ;; also `european-calendar-style' and use european format
5658 (defun org-anniversary (year month day &optional mark)
5659 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5661 (let ((calendar-date-style 'european) (european-calendar-style t))
5662 (diary-anniversary day month year mark))))
5663 (defun org-cyclic (N year month day &optional mark)
5664 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5666 (let ((calendar-date-style 'european) (european-calendar-style t))
5667 (diary-cyclic N day month year mark))))
5668 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5669 "Like `diary-block', but with fixed (ISO) order of arguments."
5671 (let ((calendar-date-style 'european) (european-calendar-style t))
5672 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5673 (defun org-date (year month day &optional mark)
5674 "Like `diary-date', but with fixed (ISO) order of arguments."
5676 (let ((calendar-date-style 'european) (european-calendar-style t))
5677 (diary-date day month year mark))))
5679 ;; Define the` org-class' function
5680 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5681 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5682 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5683 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5684 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5685 `holidays', then any date that is known by the Emacs calendar to be a
5686 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5687 then those holidays will be skipped."
5688 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5689 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5690 (d (calendar-absolute-from-gregorian date))
5691 (h (when skip-weeks (calendar-check-holidays date))))
5695 (= (calendar-day-of-week date) dayname)
5696 (or (not skip-weeks)
5699 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5700 (not (or (and h (memq 'holidays skip-weeks))
5701 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5704 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5705 "Like `org-class', but honor `calendar-date-style'.
5706 The order of the first 2 times 3 arguments depends on the variable
5707 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5708 So for American calendars, give this as MONTH DAY YEAR, for European as
5709 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5710 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5711 is any number of ISO weeks in the block period for which the item should
5714 This function is here only for backward compatibility and it is deprecated,
5715 please use `org-class' instead."
5716 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5717 (date2 (org-order-calendar-date-args m2 d2 y2)))
5719 (nth 2 date1) (car date1) (nth 1 date1)
5720 (nth 2 date2) (car date2) (nth 1 date2)
5721 dayname skip-weeks)))
5722 (make-obsolete 'org-diary-class 'org-class "")
5724 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
5725 (defalias 'org-get-closed 'org-agenda-get-progress)
5726 (defun org-agenda-get-progress ()
5727 "Return the logged TODO entries for agenda display."
5728 (let* ((props (list 'mouse-face 'highlight
5729 'org-not-done-regexp org-not-done-regexp
5730 'org-todo-regexp org-todo-regexp
5731 'org-complex-heading-regexp org-complex-heading-regexp
5733 (format "mouse-2 or RET jump to org file %s"
5734 (abbreviate-file-name buffer-file-name))))
5735 (items (if (consp org-agenda-show-log-scoped)
5736 org-agenda-show-log-scoped
5737 (if (eq org-agenda-show-log-scoped 'clockcheck)
5739 org-agenda-log-mode-items)))
5743 (if (memq 'closed items) (concat "\\<" org-closed-string))
5744 (if (memq 'clock items) (concat "\\<" org-clock-string))
5745 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5746 (parts-re (if parts (mapconcat 'identity parts "\\|")
5747 (error "`org-agenda-log-mode-items' is empty")))
5749 "\\(" parts-re "\\)"
5754 (car org-time-stamp-formats)
5755 (apply 'encode-time ; DATE bound by calendar
5756 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5758 (org-agenda-search-headline-for-time nil)
5759 marker hdmarker priority category category-pos level tags closedp
5760 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5761 (goto-char (point-min))
5762 (while (re-search-forward regexp nil t)
5765 (setq marker (org-agenda-new-marker (match-beginning 0))
5766 closedp (equal (match-string 1) org-closed-string)
5767 statep (equal (string-to-char (match-string 1)) ?-)
5768 clockp (not (or closedp statep))
5769 state (and statep (match-string 2))
5770 category (org-get-category (match-beginning 0))
5771 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5772 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5773 (when (string-match "\\]" timestr)
5774 ;; substring should only run to end of time stamp
5775 (setq rest (substring timestr (match-end 0))
5776 timestr (substring timestr 0 (match-end 0)))
5777 (if (and (not closedp) (not statep)
5778 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5780 (progn (setq timestr (concat (substring timestr 0 -1)
5781 "-" (match-string 1 rest) "]"))
5782 (setq clocked (match-string 2 rest)))
5783 (setq clocked "-")))
5787 ((not org-agenda-log-mode-add-notes) nil)
5789 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5792 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5793 (match-string 1)))))
5794 (if (not (re-search-backward org-outline-regexp-bol nil t))
5796 (goto-char (match-beginning 0))
5797 (setq hdmarker (org-agenda-new-marker)
5799 (or (eq org-agenda-show-inherited-tags 'always)
5800 (and (listp org-agenda-show-inherited-tags)
5801 (memq 'todo org-agenda-show-inherited-tags))
5802 (and (eq org-agenda-show-inherited-tags t)
5803 (or (eq org-agenda-use-tag-inheritance t)
5804 (memq 'todo org-agenda-use-tag-inheritance))))
5805 tags (org-get-tags-at nil (not inherited-tags))
5806 level (make-string (org-reduced-level (org-outline-level)) ? ))
5807 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5808 (setq txt (match-string 1))
5810 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5811 (setq txt (concat (substring txt 0 (match-beginning 1))
5812 " - " extra " " (match-string 2 txt)))
5813 (setq txt (concat txt " - " extra))))
5814 (setq txt (org-agenda-format-item
5816 (closedp "Closed: ")
5817 (statep (concat "State: (" state ")"))
5818 (t (concat "Clocked: (" clocked ")")))
5819 txt level category tags timestr)))
5820 (setq priority 100000)
5821 (org-add-props txt props
5822 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5823 'priority priority 'org-category category
5824 'org-category-position category-pos
5826 'type "closed" 'date date
5827 'undone-face 'org-warning 'done-face 'org-agenda-done)
5829 (goto-char (point-at-eol))))
5832 (defun org-agenda-show-clocking-issues ()
5833 "Add overlays, showing issues with clocking.
5834 See also the user option `org-agenda-clock-consistency-checks'."
5836 (let* ((org-time-clocksum-use-effort-durations nil)
5837 (pl org-agenda-clock-consistency-checks)
5838 (re (concat "^[ \t]*"
5841 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5842 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5845 (maxtime (org-hh:mm-string-to-minutes
5846 (or (plist-get pl :max-duration) "24:00")))
5847 (mintime (org-hh:mm-string-to-minutes
5848 (or (plist-get pl :min-duration) 0)))
5849 (maxgap (org-hh:mm-string-to-minutes
5850 ;; default 30:00 means never complain
5851 (or (plist-get pl :max-gap) "30:00")))
5852 (gapok (mapcar 'org-hh:mm-string-to-minutes
5853 (plist-get pl :gap-ok-around)))
5854 (def-face (or (plist-get pl :default-face)
5855 '((:background "DarkRed") (:foreground "white"))))
5856 issue face m te ts dt ov)
5857 (goto-char (point-min))
5858 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5859 (setq issue nil face def-face)
5861 (setq m (org-get-at-bol 'org-marker)
5863 (unless (and m (markerp m))
5864 (setq issue "No valid clock line") (throw 'next t))
5865 (org-with-point-at m
5867 (goto-char (point-at-bol))
5868 (unless (looking-at re)
5869 (error "No valid Clock line")
5871 (unless (match-end 3)
5872 (setq issue "No end time"
5873 face (or (plist-get pl :no-end-time-face) face))
5875 (setq ts (match-string 1)
5878 (apply 'encode-time (org-parse-time-string ts)))
5880 (apply 'encode-time (org-parse-time-string te)))
5883 ((> dt (* 60 maxtime))
5884 ;; a very long clocking chunk
5885 (setq issue (format "Clocking interval is very long: %s"
5886 (org-minutes-to-clocksum-string
5887 (floor (/ (float dt) 60.))))
5888 face (or (plist-get pl :long-face) face)))
5889 ((< dt (* 60 mintime))
5890 ;; a very short clocking chunk
5891 (setq issue (format "Clocking interval is very short: %s"
5892 (org-minutes-to-clocksum-string
5893 (floor (/ (float dt) 60.))))
5894 face (or (plist-get pl :short-face) face)))
5895 ((and (> tlend 0) (< ts tlend))
5896 ;; Two clock entries are overlapping
5897 (setq issue (format "Clocking overlap: %d minutes"
5898 (/ (- tlend ts) 60))
5899 face (or (plist-get pl :overlap-face) face)))
5900 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5901 ;; There is a gap, lets see if we need to report it
5902 (unless (org-agenda-check-clock-gap tlend ts gapok)
5903 (setq issue (format "Clocking gap: %d minutes"
5904 (/ (- ts tlend) 60))
5905 face (or (plist-get pl :gap-face) face))))
5907 (setq tlend (or te tlend) tlstart (or ts tlstart))
5909 ;; OK, there was some issue, add an overlay to show the issue
5910 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5911 (overlay-put ov 'before-string
5914 (format "%-43s" (concat " " issue))
5918 (overlay-put ov 'evaporate t)))))
5920 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5921 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5924 ;; there are no OK times for gaps...
5926 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5927 ;; This is more than 24 hours, so it is OK.
5928 ;; because we have at least one OK time, that must be in the
5929 ;; 24 hour interval.
5931 ;; We have a shorter gap.
5932 ;; Now we have to get the minute of the day when these times are
5933 (let* ((t1dec (decode-time (seconds-to-time t1)))
5934 (t2dec (decode-time (seconds-to-time t2)))
5935 ;; compute the minute on the day
5936 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5937 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5939 ;; if min2 is smaller than min1, this means it is on the next day.
5940 ;; Wrap it to after midnight.
5941 (setq min2 (+ min2 1440)))
5942 ;; Now check if any of the OK times is in the gap
5944 ;; Wrap the time to after midnight if necessary
5945 (if (< x min1) (setq x (+ x 1440)))
5946 ;; Check if in interval
5947 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5949 ;; Nope, this gap is not OK
5952 (defun org-agenda-get-deadlines (&optional with-hour)
5953 "Return the deadline information for agenda display.
5954 When WITH-HOUR is non-nil, only return deadlines with an hour
5955 specification like [h]h:mm."
5956 (let* ((props (list 'mouse-face 'highlight
5957 'org-not-done-regexp org-not-done-regexp
5958 'org-todo-regexp org-todo-regexp
5959 'org-complex-heading-regexp org-complex-heading-regexp
5961 (format "mouse-2 or RET jump to org file %s"
5962 (abbreviate-file-name buffer-file-name))))
5963 (regexp (if with-hour
5964 org-deadline-time-hour-regexp
5965 org-deadline-time-regexp))
5966 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5967 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5968 (dl0 (car org-agenda-deadline-leaders))
5969 (dl1 (nth 1 org-agenda-deadline-leaders))
5970 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
5971 d2 diff dfrac wdays pos pos1 category category-pos level
5972 tags suppress-prewarning ee txt head face s todo-state
5973 show-all upcomingp donep timestr warntime inherited-tags ts-date)
5974 (goto-char (point-min))
5975 (while (re-search-forward regexp nil t)
5978 (setq s (match-string 1)
5980 pos (1- (match-beginning 1))
5981 todo-state (save-match-data (org-get-todo-state))
5982 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5984 org-agenda-repeating-timestamp-show-all))
5985 d2 (org-time-string-to-absolute
5986 s d1 'past show-all (current-buffer) pos)
5988 (setq suppress-prewarning
5989 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
5990 (let ((item (buffer-substring (point-at-bol)
5994 org-scheduled-time-regexp item)
5995 (match-string 1 item)))))))
5998 ;; The current item has a scheduled date (in ds), so
5999 ;; evaluate its prewarning lead time.
6000 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6001 ;; Use global prewarning-restart lead time.
6002 org-agenda-skip-deadline-prewarning-if-scheduled)
6003 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6005 ;; Set prewarning to no earlier than scheduled.
6006 (min (- d2 (org-time-string-to-absolute
6007 ds d1 'past show-all (current-buffer) pos))
6008 org-deadline-warning-days))
6009 ;; Set prewarning to deadline.
6011 (setq wdays (if suppress-prewarning
6012 (let ((org-deadline-warning-days suppress-prewarning))
6015 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6016 upcomingp (and todayp (> diff 0)))
6017 ;; When to show a deadline in the calendar:
6018 ;; If the expiration is within wdays warning time.
6019 ;; Past-due deadlines are only shown on the current date
6020 (if (and (or (and (<= diff wdays)
6021 (and todayp (not org-agenda-only-exact-dates)))
6024 ;; (setq todo-state (org-get-todo-state))
6025 (setq donep (member todo-state org-done-keywords))
6027 (or org-agenda-skip-deadline-if-done
6030 (setq category (org-get-category)
6031 warntime (get-text-property (point) 'org-appt-warntime)
6032 category-pos (get-text-property (point) 'org-category-position))
6033 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6035 (goto-char (match-end 0))
6036 (setq pos1 (match-beginning 0))
6037 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6038 (setq inherited-tags
6039 (or (eq org-agenda-show-inherited-tags 'always)
6040 (and (listp org-agenda-show-inherited-tags)
6041 (memq 'agenda org-agenda-show-inherited-tags))
6042 (and (eq org-agenda-show-inherited-tags t)
6043 (or (eq org-agenda-use-tag-inheritance t)
6044 (memq 'agenda org-agenda-use-tag-inheritance))))
6045 tags (org-get-tags-at pos1 (not inherited-tags)))
6046 (setq head (buffer-substring
6048 (progn (skip-chars-forward "^\r\n")
6050 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6052 (concat (substring s (match-beginning 1)) " "))
6053 (setq timestr 'time))
6054 (setq txt (org-agenda-format-item
6055 (cond ((= diff 0) dl0)
6058 (funcall dl1 diff date)
6062 (funcall dl2 diff date)
6063 (format dl2 (if (string= dl2 dl1)
6064 diff (abs diff))))))
6065 head level category tags
6066 (if (not (= diff 0)) nil timestr)))))
6068 (setq face (org-agenda-deadline-face dfrac))
6069 (org-add-props txt props
6070 'org-marker (org-agenda-new-marker pos)
6074 'org-hd-marker (org-agenda-new-marker pos1)
6075 'priority (+ (- diff)
6076 (org-get-priority txt))
6077 'org-category category
6078 'org-category-position category-pos
6079 'todo-state todo-state
6080 'type (if upcomingp "upcoming-deadline" "deadline")
6081 'date (if upcomingp date d2)
6082 'face (if donep 'org-agenda-done face)
6083 'undone-face face 'done-face 'org-agenda-done)
6087 (defun org-agenda-deadline-face (fraction)
6088 "Return the face to displaying a deadline item.
6089 FRACTION is what fraction of the head-warning time has passed."
6090 (let ((faces org-agenda-deadline-faces) f)
6092 (while (setq f (pop faces))
6093 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6095 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6096 "Return the scheduled information for agenda display.
6097 When WITH-HOUR is non-nil, only return scheduled items with
6098 an hour specification like [h]h:mm."
6099 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6100 'org-todo-regexp org-todo-regexp
6101 'org-complex-heading-regexp org-complex-heading-regexp
6102 'done-face 'org-agenda-done
6103 'mouse-face 'highlight
6105 (format "mouse-2 or RET jump to org file %s"
6106 (abbreviate-file-name buffer-file-name))))
6107 (regexp (if with-hour
6108 org-scheduled-time-hour-regexp
6109 org-scheduled-time-regexp))
6110 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6111 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6113 (deadline-position-alist
6114 (mapcar (lambda (a) (and (setq mm (get-text-property
6115 0 'org-hd-marker a))
6116 (cons (marker-position mm) a)))
6118 d2 diff pos pos1 category category-pos level tags donep
6119 ee txt head pastschedp todo-state face timestr s habitp show-all
6120 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6122 (goto-char (point-min))
6123 (while (re-search-forward regexp nil t)
6126 (setq s (match-string 1)
6128 pos (1- (match-beginning 1))
6129 todo-state (save-match-data (org-get-todo-state))
6130 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6132 org-agenda-repeating-timestamp-show-all))
6133 d2 (org-time-string-to-absolute
6134 s d1 'past show-all (current-buffer) pos)
6136 warntime (get-text-property (point) 'org-appt-warntime))
6137 (setq pastschedp (and todayp (< diff 0)))
6138 (setq did-habit-check-p nil)
6139 (setq suppress-delay
6140 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6141 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6144 org-deadline-time-regexp item)
6145 (match-string 1 item)))))))
6148 ;; The current item has a deadline date (in ds), so
6149 ;; evaluate its delay time.
6150 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6151 ;; Use global delay time.
6152 (- org-agenda-skip-scheduled-delay-if-deadline))
6153 ((eq org-agenda-skip-scheduled-delay-if-deadline
6155 ;; Set delay to no later than deadline.
6156 (min (- d2 (org-time-string-to-absolute
6157 ds d1 'past show-all (current-buffer) pos))
6158 org-scheduled-delay-days))
6160 (setq ddays (if suppress-delay
6161 (let ((org-scheduled-delay-days suppress-delay))
6162 (org-get-wdays s t t))
6163 (org-get-wdays s t)))
6164 ;; Use a delay of 0 when there is a repeater and the delay is
6166 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6167 (< (org-time-string-to-absolute s)
6168 (org-time-string-to-absolute
6169 s d2 'past nil (current-buffer) pos)))
6171 ;; When to show a scheduled item in the calendar:
6172 ;; If it is on or past the date.
6173 (when (or (and (> ddays 0) (= diff (- ddays)))
6174 (and (zerop ddays) (= diff 0))
6175 (and (< (+ diff ddays) 0)
6176 (< (abs diff) org-scheduled-past-days)
6177 (and todayp (not org-agenda-only-exact-dates)))
6178 ;; org-is-habit-p uses org-entry-get, which is expansive
6179 ;; so we go extra mile to only call it once
6181 (boundp 'org-habit-show-all-today)
6182 org-habit-show-all-today
6183 (setq did-habit-check-p t)
6184 (setq habitp (and (functionp 'org-is-habit-p)
6185 (org-is-habit-p)))))
6187 (setq donep (member todo-state org-done-keywords))
6189 (or org-agenda-skip-scheduled-if-done
6191 (and (functionp 'org-is-habit-p)
6194 (setq habitp (if did-habit-check-p habitp
6195 (and (functionp 'org-is-habit-p)
6197 (setq category (org-get-category)
6198 category-pos (get-text-property (point) 'org-category-position))
6199 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6200 'repeated-after-deadline)
6201 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6203 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6205 (goto-char (match-end 0))
6206 (setq pos1 (match-beginning 0))
6208 (if (or (not org-habit-show-habits)
6210 (boundp 'org-habit-show-habits-only-for-today)
6211 org-habit-show-habits-only-for-today))
6214 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6215 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6217 (setq mm (assoc pos1 deadline-position-alist)))
6219 (setq inherited-tags
6220 (or (eq org-agenda-show-inherited-tags 'always)
6221 (and (listp org-agenda-show-inherited-tags)
6222 (memq 'agenda org-agenda-show-inherited-tags))
6223 (and (eq org-agenda-show-inherited-tags t)
6224 (or (eq org-agenda-use-tag-inheritance t)
6225 (memq 'agenda org-agenda-use-tag-inheritance))))
6227 tags (org-get-tags-at nil (not inherited-tags)))
6228 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6229 (setq head (buffer-substring
6231 (progn (skip-chars-forward "^\r\n") (point))))
6232 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6234 (concat (substring s (match-beginning 1)) " "))
6235 (setq timestr 'time))
6236 (setq txt (org-agenda-format-item
6238 (car org-agenda-scheduled-leaders)
6239 (format (nth 1 org-agenda-scheduled-leaders)
6241 head level category tags
6242 (if (not (= diff 0)) nil timestr)
6247 ((and (not habitp) pastschedp)
6248 'org-scheduled-previously)
6249 (todayp 'org-scheduled-today)
6251 habitp (and habitp (org-habit-parse-todo)))
6252 (org-add-props txt props
6254 'face (if donep 'org-agenda-done face)
6255 'org-marker (org-agenda-new-marker pos)
6256 'org-hd-marker (org-agenda-new-marker pos1)
6257 'type (if pastschedp "past-scheduled" "scheduled")
6258 'date (if pastschedp d2 date)
6262 'priority (if habitp
6263 (org-habit-get-priority habitp)
6264 (+ 94 (- 5 diff) (org-get-priority txt)))
6265 'org-category category
6266 'category-position category-pos
6268 'todo-state todo-state)
6272 (defun org-agenda-get-blocks ()
6273 "Return the date-range information for agenda display."
6274 (let* ((props (list 'face nil
6275 'org-not-done-regexp org-not-done-regexp
6276 'org-todo-regexp org-todo-regexp
6277 'org-complex-heading-regexp org-complex-heading-regexp
6278 'mouse-face 'highlight
6280 (format "mouse-2 or RET jump to org file %s"
6281 (abbreviate-file-name buffer-file-name))))
6282 (regexp org-tr-regexp)
6283 (d0 (calendar-absolute-from-gregorian date))
6284 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
6285 level todo-state tags pos head donep inherited-tags)
6286 (goto-char (point-min))
6287 (while (re-search-forward regexp nil t)
6291 (let ((start-time (match-string 1))
6292 (end-time (match-string 2)))
6293 (setq s1 (match-string 1)
6295 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6296 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6297 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6298 ;; Only allow days between the limits, because the normal
6299 ;; date stamps will catch the limits.
6301 (setq todo-state (org-get-todo-state))
6302 (setq donep (member todo-state org-done-keywords))
6303 (if (and donep org-agenda-skip-timestamp-if-done)
6305 (setq marker (org-agenda-new-marker (point)))
6306 (setq category (org-get-category)
6307 category-pos (get-text-property (point) 'org-category-position))
6308 (if (not (re-search-backward org-outline-regexp-bol nil t))
6310 (goto-char (match-beginning 0))
6311 (setq hdmarker (org-agenda-new-marker (point))
6313 (or (eq org-agenda-show-inherited-tags 'always)
6314 (and (listp org-agenda-show-inherited-tags)
6315 (memq 'agenda org-agenda-show-inherited-tags))
6316 (and (eq org-agenda-show-inherited-tags t)
6317 (or (eq org-agenda-use-tag-inheritance t)
6318 (memq 'agenda org-agenda-use-tag-inheritance))))
6320 tags (org-get-tags-at nil (not inherited-tags)))
6321 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6322 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6323 (setq head (match-string 1))
6325 (if org-agenda-remove-timeranges-from-blocks
6327 "<" (regexp-quote s1) ".*?>"
6329 "<" (regexp-quote s2) ".*?>")
6331 (setq txt (org-agenda-format-item
6333 (nth (if (= d1 d2) 0 1)
6334 org-agenda-timerange-leaders)
6335 (1+ (- d0 d1)) (1+ (- d2 d1)))
6336 head level category tags
6337 (cond ((and (= d1 d0) (= d2 d0))
6338 (concat "<" start-time ">--<" end-time ">"))
6340 (concat "<" start-time ">"))
6342 (concat "<" end-time ">")))
6344 (org-add-props txt props
6345 'org-marker marker 'org-hd-marker hdmarker
6346 'type "block" 'date date
6348 'todo-state todo-state
6349 'priority (org-get-priority txt) 'org-category category
6350 'org-category-position category-pos)
6353 ;; Sort the entries by expiration date.
6356 ;;; Agenda presentation and sorting
6358 (defvar org-prefix-has-time nil
6359 "A flag, set by `org-compile-prefix-format'.
6360 The flag is set if the currently compiled format contains a `%t'.")
6361 (defvar org-prefix-has-tag nil
6362 "A flag, set by `org-compile-prefix-format'.
6363 The flag is set if the currently compiled format contains a `%T'.")
6364 (defvar org-prefix-has-effort nil
6365 "A flag, set by `org-compile-prefix-format'.
6366 The flag is set if the currently compiled format contains a `%e'.")
6367 (defvar org-prefix-has-breadcrumbs nil
6368 "A flag, set by `org-compile-prefix-format'.
6369 The flag is set if the currently compiled format contains a `%b'.")
6370 (defvar org-prefix-category-length nil
6371 "Used by `org-compile-prefix-format' to remember the category field width.")
6372 (defvar org-prefix-category-max-length nil
6373 "Used by `org-compile-prefix-format' to remember the category field width.")
6375 (defun org-agenda-get-category-icon (category)
6376 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6377 (dolist (entry org-agenda-category-icon-alist)
6378 (when (org-string-match-p (car entry) category)
6379 (if (listp (cadr entry))
6380 (return (cadr entry))
6381 (return (apply 'create-image (cdr entry)))))))
6383 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6385 "Format TXT to be inserted into the agenda buffer.
6386 In particular, add the prefix and corresponding text properties.
6388 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6389 LEVEL may be a string to replace the `%l' specifier.
6390 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6391 category taken from local variable or file name. It will replace the `%c'
6392 specifier in the format.
6393 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6394 TXT for sorting of this entry, and for the `%t' specifier in the format.
6395 When DOTIME is a string, this string is searched for a time before TXT is.
6396 TAGS can be the tags of the headline.
6397 Any match of REMOVE-RE will be removed from TXT."
6398 ;; We keep the org-prefix-* variable values along with a compiled
6399 ;; formatter, so that multiple agendas existing at the same time do
6400 ;; not step on each other toes.
6402 ;; It was inconvenient to make these variables buffer local in
6403 ;; Agenda buffers, because this function expects to be called with
6404 ;; the buffer where item comes from being current, and not agenda
6406 (let* ((bindings (car org-prefix-format-compiled))
6407 (formatter (cadr org-prefix-format-compiled)))
6408 (loop for (var value) in bindings
6411 ;; Diary entries sometimes have extra whitespace at the beginning
6412 (setq txt (org-trim txt))
6414 ;; Fix the tags part in txt
6415 (setq txt (org-agenda-fix-displayed-tags
6417 org-agenda-show-inherited-tags
6418 org-agenda-hide-tags-regexp))
6420 (let* ((category (or category
6421 (if (stringp org-category)
6423 (and org-category (symbol-name org-category)))
6424 (if buffer-file-name
6425 (file-name-sans-extension
6426 (file-name-nondirectory buffer-file-name))
6428 (category-icon (org-agenda-get-category-icon category))
6429 (category-icon (if category-icon
6430 (propertize " " 'display category-icon)
6432 ;; time, tag, effort are needed for the eval of the prefix format
6433 (tag (if tags (nth (1- (length tags)) tags) ""))
6435 (ts (if dotime (concat
6436 (if (stringp dotime) dotime "")
6437 (and org-agenda-search-headline-for-time txt))))
6438 (time-of-day (and dotime (org-get-time-of-day ts)))
6439 stamp plain s0 s1 s2 rtn srp l
6440 duration thecategory breadcrumbs)
6441 (and (derived-mode-p 'org-mode) buffer-file-name
6442 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6443 (when (and dotime time-of-day)
6444 ;; Extract starting and ending time and move them to prefix
6445 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6446 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6447 (setq s0 (match-string 0 ts)
6448 srp (and stamp (match-end 3))
6449 s1 (match-string (if plain 1 2) ts)
6450 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6452 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6453 ;; them, we might want to remove them there to avoid duplication.
6454 ;; The user can turn this off with a variable.
6455 (if (and org-prefix-has-time
6456 org-agenda-remove-times-when-in-prefix (or stamp plain)
6457 (string-match (concat (regexp-quote s0) " *") txt)
6458 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6459 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6460 (= (match-beginning 0) 0)
6462 (setq txt (replace-match "" nil nil txt))))
6463 ;; Normalize the time(s) to 24 hour
6464 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6465 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6467 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6468 (let (org-time-clocksum-use-effort-durations)
6469 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6471 (org-minutes-to-clocksum-string
6472 (+ (org-hh:mm-string-to-minutes s1)
6473 org-agenda-default-appointment-duration)))))
6475 ;; Compute the duration
6477 (setq duration (- (org-hh:mm-string-to-minutes s2)
6478 (org-hh:mm-string-to-minutes s1)))))
6480 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6482 ;; Tags are in the string
6483 (if (or (eq org-agenda-remove-tags t)
6484 (and org-agenda-remove-tags
6485 org-prefix-has-tag))
6486 (setq txt (replace-match "" t t txt))
6487 (setq txt (replace-match
6488 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6489 (match-string 2 txt))
6491 (when (derived-mode-p 'org-mode)
6492 (setq effort (ignore-errors (get-text-property 0 'org-effort txt)))
6494 (setq neffort (org-duration-string-to-minutes effort)
6495 effort (setq effort (concat "[" effort "]")))
6496 ;; prevent erroring out with %e format when there is no effort
6500 (while (string-match remove-re txt)
6501 (setq txt (replace-match "" t t txt))))
6503 ;; Set org-heading property on `txt' to mark the start of the
6505 (add-text-properties 0 (length txt) '(org-heading t) txt)
6507 ;; Prepare the variables needed in the eval of the compiled format
6508 (if org-prefix-has-breadcrumbs
6509 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6510 (let ((s (org-display-outline-path nil nil "->" t)))
6511 (if (eq "" s) "" (concat s "->"))))))
6512 (setq time (cond (s2 (concat
6513 (org-agenda-time-of-day-to-ampm-maybe s1)
6514 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6515 (if org-agenda-timegrid-use-ampm " ")))
6517 (org-agenda-time-of-day-to-ampm-maybe s1)
6518 (if org-agenda-timegrid-use-ampm
6522 extra (or (and (not habitp) extra) "")
6523 category (if (symbolp category) (symbol-name category) category)
6524 thecategory (copy-sequence category)
6525 level (or level ""))
6526 (if (string-match org-bracket-link-regexp category)
6528 (setq l (if (match-end 3)
6529 (- (match-end 3) (match-beginning 3))
6530 (- (match-end 1) (match-beginning 1))))
6531 (when (< l (or org-prefix-category-length 0))
6532 (setq category (copy-sequence category))
6533 (org-add-props category nil
6534 'extra-space (make-string
6535 (- org-prefix-category-length l 1) ?\ ))))
6536 (if (and org-prefix-category-max-length
6537 (>= (length category) org-prefix-category-max-length))
6538 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6539 ;; Evaluate the compiled format
6540 (setq rtn (concat (eval formatter) txt))
6542 ;; And finally add the text properties
6543 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6544 (org-add-props rtn nil
6545 'org-category (if thecategory (downcase thecategory) category)
6546 'tags (mapcar 'org-downcase-keep-props tags)
6547 'org-highest-priority org-highest-priority
6548 'org-lowest-priority org-lowest-priority
6549 'time-of-day time-of-day
6552 'effort-minutes neffort
6553 'breadcrumbs breadcrumbs
6558 'format org-prefix-format-compiled
6561 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6562 "Remove tags string from TXT, and add a modified list of tags.
6563 The modified list may contain inherited tags, and tags matched by
6564 `org-agenda-hide-tags-regexp' will be removed."
6565 (when (or add-inherited hide-re)
6566 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6567 (setq txt (substring txt 0 (match-beginning 0))))
6570 (mapcar (lambda (tg)
6571 (if (or (and hide-re (string-match hide-re tg))
6572 (and (not add-inherited)
6573 (get-text-property 0 'inherited tg)))
6578 (let ((have-i (get-text-property 0 'inherited (car tags)))
6580 (setq txt (concat txt " :"
6583 (setq i (get-text-property 0 'inherited x))
6584 (if (and have-i (not i))
6590 (if have-i "::" ":"))))))
6593 (defun org-downcase-keep-props (s)
6594 (let ((props (text-properties-at 0 s)))
6595 (setq s (downcase s))
6596 (add-text-properties 0 (length s) props s)
6599 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6601 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6602 "Add a time-grid for agenda items which need it.
6604 LIST is the list of agenda items formatted by `org-agenda-list'.
6605 NDAYS is the span of the current agenda view.
6606 TODAYP is `t' when the current agenda view is on today."
6608 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6609 ((and todayp (member 'today (car org-agenda-time-grid))))
6610 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6611 ((member 'weekly (car org-agenda-time-grid)))
6612 (t (throw 'exit list)))
6613 (let* ((have (delq nil (mapcar
6614 (lambda (x) (get-text-property 1 'time-of-day x))
6616 (string (nth 1 org-agenda-time-grid))
6617 (gridtimes (nth 2 org-agenda-time-grid))
6618 (req (car org-agenda-time-grid))
6619 (remove (member 'remove-match req))
6621 (if (and (member 'require-timed req) (not have))
6622 ;; don't show empty grid
6624 (while (setq time (pop gridtimes))
6625 (unless (and remove (member time have))
6626 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6627 (push (org-agenda-format-item
6628 nil string nil "" nil
6629 (concat (substring time 0 -2) ":" (substring time -2)))
6632 2 (length (car new)) 'face 'org-time-grid (car new))))
6633 (when (and todayp org-agenda-show-current-time-in-grid)
6634 (push (org-agenda-format-item
6635 nil org-agenda-current-time-string nil "" nil
6636 (format-time-string "%H:%M "))
6639 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6641 (if (member 'time-up org-agenda-sorting-strategy-selected)
6643 (append list new)))))
6645 (defun org-compile-prefix-format (key)
6646 "Compile the prefix format into a Lisp form that can be evaluated.
6647 The resulting form and associated variable bindings is returned
6648 and stored in the variable `org-prefix-format-compiled'."
6649 (setq org-prefix-has-time nil
6650 org-prefix-has-tag nil
6651 org-prefix-category-length nil
6652 org-prefix-has-effort nil
6653 org-prefix-has-breadcrumbs nil)
6655 ((stringp org-agenda-prefix-format)
6656 org-agenda-prefix-format)
6657 ((assq key org-agenda-prefix-format)
6658 (cdr (assq key org-agenda-prefix-format)))
6659 (t " %-12:c%?-12t% s")))
6661 varform vars var e c f opt)
6662 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6664 (setq var (or (cdr (assoc (match-string 4 s)
6665 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6666 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6668 c (or (match-string 3 s) "")
6669 opt (match-beginning 1)
6670 start (1+ (match-beginning 0)))
6671 (if (equal var 'time) (setq org-prefix-has-time t))
6672 (if (equal var 'tag) (setq org-prefix-has-tag t))
6673 (if (equal var 'effort) (setq org-prefix-has-effort t))
6674 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6675 (setq f (concat "%" (match-string 2 s) "s"))
6676 (when (equal var 'category)
6677 (setq org-prefix-category-length
6678 (floor (abs (string-to-number (match-string 2 s)))))
6679 (setq org-prefix-category-max-length
6680 (let ((x (match-string 2 s)))
6682 (if (string-match "\\.[0-9]+" x)
6683 (string-to-number (substring (match-string 0 x) 1)))))))
6685 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6688 `(if (equal "" ,var)
6690 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6691 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6692 (setq s (replace-match "%s" t nil s))
6693 (push varform vars))
6694 (setq vars (nreverse vars))
6695 (with-current-buffer (or org-agenda-buffer (current-buffer))
6696 (setq org-prefix-format-compiled
6698 `((org-prefix-has-time ,org-prefix-has-time)
6699 (org-prefix-has-tag ,org-prefix-has-tag)
6700 (org-prefix-category-length ,org-prefix-category-length)
6701 (org-prefix-has-effort ,org-prefix-has-effort)
6702 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6703 `(format ,s ,@vars))))))
6705 (defun org-set-sorting-strategy (key)
6706 (if (symbolp (car org-agenda-sorting-strategy))
6708 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6709 (setq org-agenda-sorting-strategy-selected
6710 (or (cdr (assq key org-agenda-sorting-strategy))
6711 (cdr (assq 'agenda org-agenda-sorting-strategy))
6712 '(time-up category-keep priority-down)))))
6714 (defun org-get-time-of-day (s &optional string mod24)
6715 "Check string S for a time of day.
6716 If found, return it as a military time number between 0 and 2400.
6717 If not found, return nil.
6718 The optional STRING argument forces conversion into a 5 character wide string
6722 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6723 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6724 (let* ((h (string-to-number (match-string 1 s)))
6725 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6726 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6727 (am-p (equal ampm "am"))
6728 (h1 (cond ((not ampm) h)
6729 ((= h 12) (if am-p 0 12))
6730 (t (+ h (if am-p 0 12)))))
6731 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6733 (t0 (+ (* 100 h2) m))
6734 (t1 (concat (if (>= h1 24) "+" " ")
6735 (if (and org-agenda-time-leading-zero
6736 (< t0 1000)) "0" "")
6737 (if (< t0 100) "0" "")
6738 (if (< t0 10) "0" "")
6739 (int-to-string t0))))
6740 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6742 (defvar org-agenda-before-sorting-filter-function nil
6743 "Function to be applied to agenda items prior to sorting.
6744 Prior to sorting also means just before they are inserted into the agenda.
6746 To aid sorting, you may revisit the original entries and add more text
6747 properties which will later be used by the sorting functions.
6749 The function should take a string argument, an agenda line.
6750 It has access to the text properties in that line, which contain among
6751 other things, the property `org-hd-marker' that points to the entry
6752 where the line comes from. Note that not all lines going into the agenda
6753 have this property, only most.
6755 The function should return the modified string. It is probably best
6756 to ONLY change text properties.
6758 You can also use this function as a filter, by returning nil for lines
6759 you don't want to have in the agenda at all. For this application, you
6760 could bind the variable in the options section of a custom command.")
6762 (defun org-agenda-finalize-entries (list &optional type)
6763 "Sort, limit and concatenate the LIST of agenda items.
6764 The optional argument TYPE tells the agenda type."
6765 (let ((max-effort (cond ((listp org-agenda-max-effort)
6766 (cdr (assoc type org-agenda-max-effort)))
6767 (t org-agenda-max-effort)))
6768 (max-todo (cond ((listp org-agenda-max-todos)
6769 (cdr (assoc type org-agenda-max-todos)))
6770 (t org-agenda-max-todos)))
6771 (max-tags (cond ((listp org-agenda-max-tags)
6772 (cdr (assoc type org-agenda-max-tags)))
6773 (t org-agenda-max-tags)))
6774 (max-entries (cond ((listp org-agenda-max-entries)
6775 (cdr (assoc type org-agenda-max-entries)))
6776 (t org-agenda-max-entries))) l)
6777 (when org-agenda-before-sorting-filter-function
6781 org-agenda-before-sorting-filter-function list))))
6782 (setq list (mapcar 'org-agenda-highlight-todo list)
6783 list (mapcar 'identity (sort list 'org-entries-lessp))
6784 list (org-agenda-limit-entries
6785 list 'effort-minutes max-effort 'identity)
6786 list (org-agenda-limit-entries list 'todo-state max-todo)
6787 list (org-agenda-limit-entries list 'tags max-tags)
6788 list (org-agenda-limit-entries list 'org-hd-marker max-entries)
6789 list (mapconcat 'identity list "\n"))))
6791 (defun org-agenda-limit-entries (list prop limit &optional fn)
6792 "Limit the number of agenda entries."
6794 (let ((f (or fn (lambda (p) (and p 1)))) (lim 0))
6798 (let ((pval (funcall f (get-text-property 1 prop e))))
6799 (if pval (setq lim (+ lim pval)))
6800 (if (or (not pval) (<= lim limit)) e)))
6804 (defun org-agenda-highlight-todo (x)
6805 (let ((org-done-keywords org-done-keywords-for-agenda)
6806 (case-fold-search nil)
6810 (beginning-of-line 1)
6811 (setq re (org-get-at-bol 'org-todo-regexp))
6812 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6813 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6814 (add-text-properties (match-beginning 0) (match-end 1)
6815 (list 'face (org-get-todo-face 1)))
6816 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6817 (delete-region (match-beginning 1) (1- (match-end 0)))
6818 (goto-char (match-beginning 1))
6819 (insert (format org-agenda-todo-keyword-format s)))))
6820 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6821 (setq re (get-text-property 0 'org-todo-regexp x))
6823 ;; Test `pl' because if there's no heading content,
6824 ;; there's no point matching to highlight. Note
6825 ;; that if we didn't test `pl' first, and there
6826 ;; happened to be no keyword from `org-todo-regexp'
6827 ;; on this heading line, then the `equal' comparison
6828 ;; afterwards would spuriously succeed in the case
6829 ;; where `pl' is nil -- causing an args-out-of-range
6830 ;; error when we try to add text properties to text
6831 ;; that isn't there.
6833 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6835 (add-text-properties
6836 (or (match-end 1) (match-end 0)) (match-end 0)
6837 (list 'face (org-get-todo-face (match-string 2 x)))
6840 (setq x (concat (substring x 0 (match-end 1))
6841 (format org-agenda-todo-keyword-format
6843 (org-add-props " " (text-properties-at 0 x))
6844 (substring x (match-end 3)))))))
6847 (defsubst org-cmp-priority (a b)
6848 "Compare the priorities of string A and B."
6849 (let ((pa (or (get-text-property 1 'priority a) 0))
6850 (pb (or (get-text-property 1 'priority b) 0)))
6851 (cond ((> pa pb) +1)
6854 (defsubst org-cmp-effort (a b)
6855 "Compare the effort values of string A and B."
6856 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6857 (ea (or (get-text-property 1 'effort-minutes a) def))
6858 (eb (or (get-text-property 1 'effort-minutes b) def)))
6859 (cond ((> ea eb) +1)
6862 (defsubst org-cmp-category (a b)
6863 "Compare the string values of categories of strings A and B."
6864 (let ((ca (or (get-text-property 1 'org-category a) ""))
6865 (cb (or (get-text-property 1 'org-category b) "")))
6866 (cond ((string-lessp ca cb) -1)
6867 ((string-lessp cb ca) +1))))
6869 (defsubst org-cmp-todo-state (a b)
6870 "Compare the todo states of strings A and B."
6871 (let* ((ma (or (get-text-property 1 'org-marker a)
6872 (get-text-property 1 'org-hd-marker a)))
6873 (mb (or (get-text-property 1 'org-marker b)
6874 (get-text-property 1 'org-hd-marker b)))
6875 (fa (and ma (marker-buffer ma)))
6876 (fb (and mb (marker-buffer mb)))
6878 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6879 (and fb (with-current-buffer fb org-todo-keywords-1))))
6880 (ta (or (get-text-property 1 'todo-state a) ""))
6881 (tb (or (get-text-property 1 'todo-state b) ""))
6882 (la (- (length (member ta todo-kwds))))
6883 (lb (- (length (member tb todo-kwds))))
6884 (donepa (member ta org-done-keywords-for-agenda))
6885 (donepb (member tb org-done-keywords-for-agenda)))
6886 (cond ((and donepa (not donepb)) -1)
6887 ((and (not donepa) donepb) +1)
6891 (defsubst org-cmp-alpha (a b)
6892 "Compare the headlines, alphabetically."
6893 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6894 (plb (text-property-any 0 (length b) 'org-heading t b))
6895 (ta (and pla (substring a pla)))
6896 (tb (and plb (substring b plb))))
6898 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6899 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6900 (setq ta (substring ta (match-end 0))))
6901 (setq ta (downcase ta)))
6903 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6904 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6905 (setq tb (substring tb (match-end 0))))
6906 (setq tb (downcase tb)))
6909 ((string-lessp ta tb) -1)
6910 ((string-lessp tb ta) +1))))
6912 (defsubst org-cmp-tag (a b)
6913 "Compare the string values of the first tags of A and B."
6914 (let ((ta (car (last (get-text-property 1 'tags a))))
6915 (tb (car (last (get-text-property 1 'tags b)))))
6918 ((string-lessp ta tb) -1)
6919 ((string-lessp tb ta) +1))))
6921 (defsubst org-cmp-time (a b)
6922 "Compare the time-of-day values of strings A and B."
6923 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6924 (ta (or (get-text-property 1 'time-of-day a) def))
6925 (tb (or (get-text-property 1 'time-of-day b) def)))
6926 (cond ((< ta tb) -1)
6929 (defsubst org-cmp-ts (a b &optional type)
6930 "Compare the timestamps values of entries A and B.
6931 When TYPE is \"scheduled\", \"deadline\", \"timestamp\"
6932 or \"timestamp_ia\", compare within each of these type.
6933 When TYPE is the empty string, compare all timestamps
6934 without respect of their type."
6935 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6936 (ta (or (and (string-match type (get-text-property 1 'type a))
6937 (get-text-property 1 'ts-date a)) def))
6938 (tb (or (and (string-match type (get-text-property 1 'type b))
6939 (get-text-property 1 'ts-date b)) def)))
6940 (cond ((< ta tb) -1)
6943 (defsubst org-cmp-habit-p (a b)
6944 "Compare the todo states of strings A and B."
6945 (let ((ha (get-text-property 1 'org-habit-p a))
6946 (hb (get-text-property 1 'org-habit-p b)))
6947 (cond ((and ha (not hb)) -1)
6948 ((and (not ha) hb) +1))))
6950 (defun org-entries-lessp (a b)
6951 "Predicate for sorting agenda entries."
6952 ;; The following variables will be used when the form is evaluated.
6953 ;; So even though the compiler complains, keep them.
6954 (let* ((ss org-agenda-sorting-strategy-selected)
6955 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
6956 (org-cmp-ts a b "")))
6957 (timestamp-down (if timestamp-up (- timestamp-up) nil))
6958 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
6959 (org-cmp-ts a b "scheduled")))
6960 (scheduled-down (if scheduled-up (- scheduled-up) nil))
6961 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
6962 (org-cmp-ts a b "deadline")))
6963 (deadline-down (if deadline-up (- deadline-up) nil))
6964 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
6965 (org-cmp-ts a b "iatimestamp_ia")))
6966 (tsia-down (if tsia-up (- tsia-up) nil))
6967 (ts-up (and (org-em 'ts-up 'ts-down ss)
6968 (org-cmp-ts a b "timestamp")))
6969 (ts-down (if ts-up (- ts-up) nil))
6970 (time-up (and (org-em 'time-up 'time-down ss)
6971 (org-cmp-time a b)))
6972 (time-down (if time-up (- time-up) nil))
6973 (priority-up (and (org-em 'priority-up 'priority-down ss)
6974 (org-cmp-priority a b)))
6975 (priority-down (if priority-up (- priority-up) nil))
6976 (effort-up (and (org-em 'effort-up 'effort-down ss)
6977 (org-cmp-effort a b)))
6978 (effort-down (if effort-up (- effort-up) nil))
6979 (category-up (and (or (org-em 'category-up 'category-down ss)
6980 (memq 'category-keep ss))
6981 (org-cmp-category a b)))
6982 (category-down (if category-up (- category-up) nil))
6983 (category-keep (if category-up +1 nil))
6984 (tag-up (and (org-em 'tag-up 'tag-down ss)
6986 (tag-down (if tag-up (- tag-up) nil))
6987 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6988 (org-cmp-todo-state a b)))
6989 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6990 (habit-up (and (org-em 'habit-up 'habit-down ss)
6991 (org-cmp-habit-p a b)))
6992 (habit-down (if habit-up (- habit-up) nil))
6993 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6994 (org-cmp-alpha a b)))
6995 (alpha-down (if alpha-up (- alpha-up) nil))
6996 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6997 user-defined-up user-defined-down)
6998 (if (and need-user-cmp org-agenda-cmp-user-defined
6999 (functionp org-agenda-cmp-user-defined))
7000 (setq user-defined-up
7001 (funcall org-agenda-cmp-user-defined a b)
7002 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7004 (eval (cons 'or org-agenda-sorting-strategy-selected))
7005 '((-1 . t) (1 . nil) (nil . nil))))))
7007 ;;; Agenda restriction lock
7009 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7010 "Overlay to mark the headline to which agenda commands are restricted.")
7011 (overlay-put org-agenda-restriction-lock-overlay
7012 'face 'org-agenda-restriction-lock)
7013 (overlay-put org-agenda-restriction-lock-overlay
7014 'help-echo "Agendas are currently limited to this subtree.")
7015 (org-detach-overlay org-agenda-restriction-lock-overlay)
7017 (defun org-agenda-set-restriction-lock (&optional type)
7018 "Set restriction lock for agenda, to current subtree or file.
7019 Restriction will be the file if TYPE is `file', or if type is the
7020 universal prefix '(4), or if the cursor is before the first headline
7021 in the file. Otherwise, restriction will be to the current subtree."
7023 (and (equal type '(4)) (setq type 'file))
7026 ((org-at-heading-p) 'subtree)
7027 ((condition-case nil (org-back-to-heading t) (error nil))
7030 (if (eq type 'subtree)
7032 (setq org-agenda-restrict t)
7033 (setq org-agenda-overriding-restriction 'subtree)
7034 (put 'org-agenda-files 'org-restrict
7035 (list (buffer-file-name (buffer-base-buffer))))
7036 (org-back-to-heading t)
7037 (move-overlay org-agenda-restriction-lock-overlay
7038 (point) (save-excursion (org-end-of-subtree t t) (point)))
7039 (move-marker org-agenda-restrict-begin (point))
7040 (move-marker org-agenda-restrict-end
7041 (save-excursion (org-end-of-subtree t t)))
7042 (message "Locking agenda restriction to subtree"))
7043 (put 'org-agenda-files 'org-restrict
7044 (list (buffer-file-name (buffer-base-buffer))))
7045 (setq org-agenda-restrict nil)
7046 (setq org-agenda-overriding-restriction 'file)
7047 (move-marker org-agenda-restrict-begin nil)
7048 (move-marker org-agenda-restrict-end nil)
7049 (message "Locking agenda restriction to file"))
7050 (setq current-prefix-arg nil)
7051 (org-agenda-maybe-redo))
7053 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7054 "Remove the agenda restriction lock."
7056 (org-detach-overlay org-agenda-restriction-lock-overlay)
7057 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7058 (setq org-agenda-overriding-restriction nil)
7059 (setq org-agenda-restrict nil)
7060 (put 'org-agenda-files 'org-restrict nil)
7061 (move-marker org-agenda-restrict-begin nil)
7062 (move-marker org-agenda-restrict-end nil)
7063 (setq current-prefix-arg nil)
7064 (message "Agenda restriction lock removed")
7065 (or noupdate (org-agenda-maybe-redo)))
7067 (defun org-agenda-maybe-redo ()
7068 "If there is any window showing the agenda view, update it."
7069 (let ((w (get-buffer-window org-agenda-buffer-name t))
7070 (w0 (selected-window)))
7075 (if org-agenda-overriding-restriction
7076 (message "Agenda view shifted to new %s restriction"
7077 org-agenda-overriding-restriction)
7078 (message "Agenda restriction lock removed")))))
7082 (defun org-agenda-check-type (error &rest types)
7083 "Check if agenda buffer is of allowed type.
7084 If ERROR is non-nil, throw an error, otherwise just return nil.
7085 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7086 (if (not org-agenda-type)
7087 (error "No Org agenda currently displayed")
7088 (if (memq org-agenda-type types)
7091 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7094 (defun org-agenda-Quit ()
7095 "Exit the agenda and kill buffers loaded by `org-agenda'.
7096 Also restore the window configuration."
7098 (if org-agenda-columns-active
7100 (let ((buf (current-buffer)))
7101 (if (eq org-agenda-window-setup 'other-frame)
7103 (org-agenda-reset-markers)
7105 (org-columns-remove-overlays)
7106 (setq org-agenda-archives-mode nil)
7108 (and (not (eq org-agenda-window-setup 'current-window))
7109 (not (one-window-p))
7111 (org-agenda-reset-markers)
7113 (org-columns-remove-overlays)
7114 (setq org-agenda-archives-mode nil)))
7115 (setq org-agenda-buffer nil)
7116 ;; Maybe restore the pre-agenda window configuration.
7117 (and org-agenda-restore-windows-after-quit
7118 (not (eq org-agenda-window-setup 'other-frame))
7119 org-agenda-pre-window-conf
7120 (set-window-configuration org-agenda-pre-window-conf)
7121 (setq org-agenda-pre-window-conf nil))))
7123 (defun org-agenda-quit ()
7124 "Exit the agenda and restore the window configuration.
7125 When `org-agenda-sticky' is non-nil, only bury the agenda."
7127 (if (and (eq org-indirect-buffer-display 'other-window)
7128 org-last-indirect-buffer)
7129 (let ((org-last-indirect-window
7130 (get-buffer-window org-last-indirect-buffer)))
7131 (if org-last-indirect-window
7132 (delete-window org-last-indirect-window))))
7133 (if org-agenda-columns-active
7135 (if org-agenda-sticky
7136 (let ((buf (current-buffer)))
7137 (if (eq org-agenda-window-setup 'other-frame)
7140 (and (not (eq org-agenda-window-setup 'current-window))
7141 (not (one-window-p))
7143 (with-current-buffer buf
7145 ;; Maybe restore the pre-agenda window configuration.
7146 (and org-agenda-restore-windows-after-quit
7147 (not (eq org-agenda-window-setup 'other-frame))
7148 org-agenda-pre-window-conf
7149 (set-window-configuration org-agenda-pre-window-conf)
7150 (setq org-agenda-pre-window-conf nil))))
7151 (org-agenda-Quit))))
7153 (defun org-agenda-exit ()
7154 "Exit the agenda and restore the window configuration.
7155 Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
7156 buffers visited directly by the user will not be touched."
7158 (org-release-buffers org-agenda-new-buffers)
7159 (setq org-agenda-new-buffers nil)
7162 (defun org-agenda-kill-all-agenda-buffers ()
7163 "Kill all buffers in `org-agenda-mode'.
7164 This is used when toggling sticky agendas.
7165 You can also explicitly invoke it with `C-c a C-k'."
7168 (dolist (buf (buffer-list))
7169 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7171 (mapc 'kill-buffer blist)))
7173 (defun org-agenda-execute (arg)
7174 "Execute another agenda command, keeping same window.
7175 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7178 (let ((org-agenda-window-setup 'current-window))
7181 (defun org-agenda-redo (&optional all)
7182 "Rebuild possibly ALL agenda view(s) in the current buffer."
7184 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7185 (cpa (unless (eq all t) current-prefix-arg))
7186 (org-agenda-doing-sticky-redo org-agenda-sticky)
7187 (org-agenda-sticky nil)
7188 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7189 org-agenda-buffer-name))
7190 (org-agenda-keep-modes t)
7191 (tag-filter org-agenda-tag-filter)
7192 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7193 (top-cat-filter org-agenda-top-category-filter)
7194 (cat-filter org-agenda-category-filter)
7195 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7196 (re-filter org-agenda-regexp-filter)
7197 (re-preset (get 'org-agenda-category-filter :preset-filter))
7198 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7199 (cols org-agenda-columns-active)
7200 (line (org-current-line))
7201 (window-line (- line (org-current-line (window-start))))
7202 (lprops (get 'org-agenda-redo-command 'org-lprops))
7203 (redo-cmd (get-text-property p 'org-redo-cmd))
7204 (last-args (get-text-property p 'org-last-args))
7205 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7206 (org-agenda-overriding-cmd-arguments
7208 (cond ((listp last-args)
7209 (cons (or cpa (car last-args)) (cdr last-args)))
7210 ((stringp last-args)
7212 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7213 (put 'org-agenda-tag-filter :preset-filter nil)
7214 (put 'org-agenda-category-filter :preset-filter nil)
7215 (and cols (org-columns-quit))
7216 (message "Rebuilding agenda buffer...")
7218 (eval series-redo-cmd)
7219 (org-let lprops '(eval redo-cmd)))
7220 (setq org-agenda-undo-list nil
7221 org-agenda-pending-undo-list nil)
7222 (message "Rebuilding agenda buffer...done")
7223 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7224 (put 'org-agenda-category-filter :preset-filter cat-preset)
7225 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7226 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
7227 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
7228 (and (or re-filter re-preset) (org-agenda-filter-apply re-filter 'regexp))
7229 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
7230 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7231 (org-goto-line line)
7232 (recenter window-line)))
7234 (defvar org-global-tags-completion-table nil)
7235 (defvar org-agenda-filter-form nil)
7236 (defvar org-agenda-filtered-by-category nil)
7238 (defun org-agenda-filter-by-category (strip)
7239 "Keep only those lines in the agenda buffer that have a specific category.
7240 The category is that of the current line."
7242 (if (and org-agenda-filtered-by-category
7243 org-agenda-category-filter)
7244 (org-agenda-filter-show-all-cat)
7245 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
7246 (if (and cat (not (string= "" cat)))
7247 (org-agenda-filter-apply
7248 (setq org-agenda-category-filter
7249 (list (concat (if strip "-" "+") cat)))
7251 (error "No category at point")))))
7253 (defun org-find-top-category (&optional pos)
7255 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7256 (if pos (goto-char pos))
7257 ;; Skip up to the topmost parent
7258 (while (ignore-errors (outline-up-heading 1) t))
7260 (nth 4 (org-heading-components))))))
7262 (defvar org-agenda-filtered-by-top-category nil)
7263 (defun org-agenda-filter-by-top-category (strip)
7264 "Keep only those lines in the agenda buffer that have a specific category.
7265 The category is that of the current line."
7267 (if org-agenda-filtered-by-top-category
7269 (setq org-agenda-filtered-by-top-category nil
7270 org-agenda-top-category-filter nil)
7271 (org-agenda-filter-show-all-cat))
7272 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
7273 (if cat (org-agenda-filter-top-category-apply cat strip)
7274 (error "No top-level category at point")))))
7276 (defvar org-agenda-regexp-filter nil)
7277 (defun org-agenda-filter-by-regexp (strip)
7278 "Filter agenda entries by a regular expression.
7279 Regexp filters are cumulative.
7280 With no prefix argument, keep entries matching the regexp.
7281 With one prefix argument, filter out entries matching the regexp.
7282 With two prefix arguments, remove the regexp filters."
7284 (if (not (equal strip '(16)))
7285 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7286 (read-from-minibuffer
7287 (if (equal strip '(4))
7288 "Filter out entries matching regexp: "
7289 "Narrow to entries matching regexp: ")))))
7290 (push flt org-agenda-regexp-filter)
7291 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7292 (org-agenda-filter-show-all-re)
7293 (message "Regexp filter removed")))
7295 (defun org-agenda-filter-remove-all ()
7296 "Remove all filters from the current agenda buffer."
7298 (when org-agenda-tag-filter
7299 (org-agenda-filter-show-all-tag))
7300 (when org-agenda-category-filter
7301 (org-agenda-filter-show-all-cat))
7302 (when org-agenda-regexp-filter
7303 (org-agenda-filter-show-all-re)))
7305 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7306 "Keep only those lines in the agenda buffer that have a specific tag.
7307 The tag is selected with its fast selection letter, as configured.
7308 With prefix argument STRIP, remove all lines that do have the tag.
7309 A lisp caller can specify CHAR. NARROW means that the new tag should be
7310 used to narrow the search - the interactive user can also press `-' or `+'
7311 to switch to narrowing."
7313 (let* ((alist org-tag-alist-for-agenda)
7314 (tag-chars (mapconcat
7315 (lambda (x) (if (and (not (symbolp (car x)))
7317 (char-to-string (cdr x))
7320 (efforts (org-split-string
7321 (or (cdr (assoc (concat org-effort-property "_ALL")
7322 org-global-properties))
7323 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7325 (effort-op org-agenda-filter-effort-default-operator)
7327 (inhibit-read-only t)
7328 (current org-agenda-tag-filter)
7329 maybe-refresh a n tag)
7332 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
7333 (if narrow "Narrow" "Filter") tag-chars
7334 (if org-agenda-auto-exclude-function "[RET], " ""))
7335 (setq char (read-char-exclusive)))
7336 (when (member char '(?+ ?-))
7338 (cond ((equal char ?-) (setq strip t narrow t))
7339 ((equal char ?+) (setq strip nil narrow t)))
7341 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
7342 (setq char (read-char-exclusive)))
7343 (when (member char '(?< ?> ?= ??))
7344 ;; An effort operator
7345 (setq effort-op (char-to-string char))
7346 (setq alist nil) ; to make sure it will be interpreted as effort.
7347 (unless (equal char ??)
7348 (loop for i from 0 to 9 do
7352 (if (= i 9) "0" (int-to-string (1+ i)))
7353 "]" (nth i efforts))))
7354 (message "Effort%s: %s " effort-op effort-prompt)
7355 (setq char (read-char-exclusive))
7356 (when (or (< char ?0) (> char ?9))
7357 (error "Need 1-9,0 to select effort"))))
7358 (when (equal char ?\t)
7359 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7360 (org-set-local 'org-global-tags-completion-table
7361 (org-global-tags-completion-table)))
7362 (let ((completion-ignore-case t))
7363 (setq tag (org-icompleting-read
7364 "Tag: " org-global-tags-completion-table))))
7367 (org-agenda-filter-show-all-tag)
7368 (when org-agenda-auto-exclude-function
7369 (setq org-agenda-tag-filter '())
7370 (dolist (tag (org-agenda-get-represented-tags))
7371 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7373 (push modifier org-agenda-tag-filter))))
7374 (if (not (null org-agenda-tag-filter))
7375 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7376 (setq maybe-refresh t))
7378 (org-agenda-filter-show-all-tag)
7379 (when (get 'org-agenda-tag-filter :preset-filter)
7380 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7381 (setq maybe-refresh t))
7383 (setq org-agenda-tag-filter
7384 (mapcar (lambda(tag) (concat "+" tag))
7385 (org-get-at-bol 'tags)))
7386 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7387 (setq maybe-refresh t))
7388 ((or (equal char ?\ )
7389 (setq a (rassoc char alist))
7390 (and (>= char ?0) (<= char ?9)
7391 (setq n (if (= char ?0) 9 (- char ?0 1))
7392 tag (concat effort-op (nth n efforts))
7397 (and tag (setq a (cons tag nil))))
7398 (org-agenda-filter-show-all-tag)
7400 (setq org-agenda-tag-filter
7401 (cons (concat (if strip "-" "+") tag)
7402 (if narrow current nil)))
7403 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7404 (setq maybe-refresh t))
7405 (t (error "Invalid tag selection character %c" char)))
7406 (when (and maybe-refresh
7407 (eq org-agenda-clockreport-mode 'with-filter))
7408 (org-agenda-redo))))
7410 (defun org-agenda-get-represented-tags ()
7411 "Get a list of all tags currently represented in the agenda."
7414 (goto-char (point-min))
7415 (while (setq p (next-single-property-change (point) 'tags))
7417 (mapc (lambda (x) (add-to-list 'tags x))
7418 (get-text-property (point) 'tags))))
7421 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7422 "Refine the current filter. See `org-agenda-filter-by-tag'."
7424 (org-agenda-filter-by-tag strip char 'refine))
7426 (defun org-agenda-filter-make-matcher ()
7427 "Create the form that tests a line for agenda filter."
7429 ;; first compute the tag-filter matcher
7430 (dolist (x (delete-dups
7431 (append (get 'org-agenda-tag-filter
7432 :preset-filter) org-agenda-tag-filter)))
7433 (if (member x '("-" "+"))
7434 (setq f1 (if (equal x "-") 'tags '(not tags)))
7435 (if (string-match "[<=>?]" x)
7436 (setq f1 (org-agenda-filter-effort-form x))
7437 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
7438 (if (equal (string-to-char x) ?-)
7439 (setq f1 (list 'not f1))))
7441 ;; then compute the category-filter matcher
7442 (dolist (x (delete-dups
7443 (append (get 'org-agenda-category-filter
7444 :preset-filter) org-agenda-category-filter)))
7445 (if (equal "-" (substring x 0 1))
7446 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7447 (setq f1 (list 'equal (substring x 1) 'cat)))
7449 ;; Finally compute the regexp filter
7450 (dolist (x (delete-dups
7451 (append (get 'org-agenda-regexp-filter
7452 :preset-filter) org-agenda-regexp-filter)))
7453 (if (equal "-" (substring x 0 1))
7454 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7455 (setq f1 (list 'string-match (substring x 1) 'txt)))
7457 (cons 'and (nreverse f))))
7459 (defun org-agenda-filter-effort-form (e)
7460 "Return the form to compare the effort of the current line with what E says.
7461 E looks like \"+<2:25\"."
7463 (setq e (substring e 1))
7464 (setq op (string-to-char e) e (substring e 1))
7465 (setq op (cond ((equal op ?<) '<=)
7469 (list 'org-agenda-compare-effort (list 'quote op)
7470 (org-duration-string-to-minutes e))))
7472 (defun org-agenda-compare-effort (op value)
7473 "Compare the effort of the current line with VALUE, using OP.
7474 If the line does not have an effort defined, return nil."
7475 (let ((eff (org-get-at-bol 'effort-minutes)))
7478 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
7481 (defun org-agenda-filter-apply (filter type)
7482 "Set FILTER as the new agenda filter and apply it."
7483 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7484 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7486 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
7487 (if (and (eq type 'category)
7488 (not (equal (substring (car filter) 0 1) "-")))
7489 ;; Only set `org-agenda-filtered-by-category' to t
7490 ;; when a unique category is used as the filter
7491 (setq org-agenda-filtered-by-category t))
7492 (org-agenda-set-mode-name)
7494 (goto-char (point-min))
7496 (if (org-get-at-bol 'org-marker)
7498 (setq tags (org-get-at-bol 'tags) ; used in eval
7499 cat (get-text-property (point) 'org-category)
7500 txt (get-text-property (point) 'txt))
7501 (if (not (eval org-agenda-filter-form))
7502 (org-agenda-filter-hide-line type))
7503 (beginning-of-line 2))
7504 (beginning-of-line 2))))
7505 (if (get-char-property (point) 'invisible)
7506 (ignore-errors (org-agenda-previous-line)))))
7508 (defun org-agenda-filter-top-category-apply (category &optional negative)
7509 "Set FILTER as the new agenda filter and apply it."
7510 (org-agenda-set-mode-name)
7512 (goto-char (point-min))
7514 (let* ((pos (org-get-at-bol 'org-hd-marker))
7515 (topcat (and pos (org-find-top-category pos))))
7516 (if (and topcat (funcall (if negative 'identity 'not)
7517 (string= category topcat)))
7518 (org-agenda-filter-hide-line 'category)))
7519 (beginning-of-line 2)))
7520 (if (get-char-property (point) 'invisible)
7521 (org-agenda-previous-line))
7522 (setq org-agenda-top-category-filter category
7523 org-agenda-filtered-by-top-category t))
7525 (defun org-agenda-filter-hide-line (type)
7526 "Hide lines with TYPE in the agenda buffer."
7528 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
7530 (overlay-put ov 'invisible t)
7531 (overlay-put ov 'type type)
7532 (cond ((eq type 'tag) (push ov org-agenda-tag-filter-overlays))
7533 ((eq type 'category) (push ov org-agenda-cat-filter-overlays))
7534 ((eq type 'regexp) (push ov org-agenda-re-filter-overlays)))))
7536 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
7537 (setq pos (or pos (point)))
7539 (dolist (ov (overlays-at pos))
7540 (when (and (overlay-get ov 'invisible)
7541 (eq (overlay-get ov 'type) 'tag))
7543 (if (< (overlay-start ov) (point-at-eol))
7544 (move-overlay ov (point-at-eol)
7545 (overlay-end ov)))))))
7547 (defun org-agenda-filter-show-all-tag nil
7548 "Remove tag filter overlays from the agenda buffer."
7549 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
7550 (setq org-agenda-tag-filter-overlays nil
7551 org-agenda-tag-filter nil
7552 org-agenda-filter-form nil)
7553 (org-agenda-set-mode-name))
7555 (defun org-agenda-filter-show-all-re nil
7556 "Remove regexp filter overlays from the agenda buffer."
7557 (mapc 'delete-overlay org-agenda-re-filter-overlays)
7558 (setq org-agenda-re-filter-overlays nil
7559 org-agenda-regexp-filter nil
7560 org-agenda-filter-form nil)
7561 (org-agenda-set-mode-name))
7563 (defun org-agenda-filter-show-all-cat nil
7564 "Remove category filter overlays from the agenda buffer."
7565 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
7566 (setq org-agenda-cat-filter-overlays nil
7567 org-agenda-filtered-by-category nil
7568 org-agenda-category-filter nil
7569 org-agenda-filter-form nil)
7570 (org-agenda-set-mode-name))
7572 (defun org-agenda-manipulate-query-add ()
7573 "Manipulate the query by adding a search term with positive selection.
7574 Positive selection means the term must be matched for selection of an entry."
7576 (org-agenda-manipulate-query ?\[))
7577 (defun org-agenda-manipulate-query-subtract ()
7578 "Manipulate the query by adding a search term with negative selection.
7579 Negative selection means term must not be matched for selection of an entry."
7581 (org-agenda-manipulate-query ?\]))
7582 (defun org-agenda-manipulate-query-add-re ()
7583 "Manipulate the query by adding a search regexp with positive selection.
7584 Positive selection means the regexp must match for selection of an entry."
7586 (org-agenda-manipulate-query ?\{))
7587 (defun org-agenda-manipulate-query-subtract-re ()
7588 "Manipulate the query by adding a search regexp with negative selection.
7589 Negative selection means regexp must not match for selection of an entry."
7591 (org-agenda-manipulate-query ?\}))
7592 (defun org-agenda-manipulate-query (char)
7594 ((memq org-agenda-type '(timeline agenda))
7595 (let ((org-agenda-include-inactive-timestamps t))
7597 (message "Display now includes inactive timestamps as well"))
7598 ((eq org-agenda-type 'search)
7600 'org-agenda-query-string
7601 (if org-agenda-last-search-view-search-was-boolean
7602 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7603 (?\{ . " +{}") (?\} . " -{}"))))
7605 (setq org-agenda-redo-command
7606 (list 'org-search-view
7607 (car (get-text-property (min (1- (point-max)) (point))
7609 org-agenda-query-string
7610 (+ (length org-agenda-query-string)
7611 (if (member char '(?\{ ?\})) 0 1))))
7612 (set-register org-agenda-query-register org-agenda-query-string)
7613 (let ((org-agenda-overriding-arguments
7614 (cdr org-agenda-redo-command)))
7616 (t (error "Cannot manipulate query for %s-type agenda buffers"
7619 (defun org-add-to-string (var string)
7620 (set var (concat (symbol-value var) string)))
7622 (defun org-agenda-goto-date (span)
7623 "Jump to DATE in agenda."
7625 (let* ((org-read-date-prefer-future
7626 (eval org-agenda-jump-prefer-future))
7627 (date (org-read-date))
7628 (org-agenda-sticky-orig org-agenda-sticky)
7629 (org-agenda-buffer-tmp-name (buffer-name))
7630 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7631 (0-arg (or current-prefix-arg (car args)))
7632 (2-arg (nth 2 args))
7633 (newcmd (list 'org-agenda-list 0-arg date
7634 (org-agenda-span-to-ndays 2-arg)))
7635 (newargs (cdr newcmd))
7636 (inhibit-read-only t)
7638 (if (not (org-agenda-check-type t 'agenda))
7639 (error "Not available in non-agenda blocks")
7640 (add-text-properties (point-min) (point-max)
7641 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7643 (setq org-agenda-sticky org-agenda-sticky-orig
7644 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7646 (defun org-agenda-goto-today ()
7649 (org-agenda-check-type t 'timeline 'agenda)
7650 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7651 (curspan (nth 2 args))
7652 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7654 (tdpos (goto-char tdpos))
7655 ((eq org-agenda-type 'agenda)
7656 (let* ((sd (org-agenda-compute-starting-span
7657 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7658 (org-agenda-overriding-arguments args))
7659 (setf (nth 1 org-agenda-overriding-arguments) sd)
7661 (org-agenda-find-same-or-today-or-agenda)))
7662 (t (error "Cannot find today")))))
7664 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7666 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7667 (text-property-any (point-min) (point-max) 'org-today t)
7668 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7669 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7670 (org-agenda-goto-block-beginning))
7673 (defun org-agenda-goto-block-beginning ()
7674 "Go the agenda block beginning."
7676 (if (not (derived-mode-p 'org-agenda-mode))
7677 (error "Cannot execute this command outside of org-agenda-mode buffers")
7680 (unless (looking-at "\\'")
7682 (let* ((prop 'org-agenda-structural-header)
7683 (p (previous-single-property-change (point) prop))
7684 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7685 (1- (point))) prop)))
7686 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7688 (error "Cannot find the beginning of the blog")
7690 (move-beginning-of-line 1)))))
7692 (defun org-agenda-later (arg)
7693 "Go forward in time by the current span.
7694 With prefix ARG, go forward that many times the current span."
7696 (org-agenda-check-type t 'agenda)
7697 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7698 (span (or (nth 2 args) org-agenda-current-span))
7699 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7700 (greg (calendar-gregorian-from-absolute sd))
7701 (cnt (org-get-at-bol 'org-day-cnt))
7705 (setq sd (+ (* span arg) sd)))
7707 (setq sd (+ arg sd)))
7709 (setq sd (+ (* 7 arg) sd)))
7711 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7712 sd (calendar-absolute-from-gregorian greg2))
7713 (setcar greg2 (1+ (car greg2))))
7715 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7716 sd (calendar-absolute-from-gregorian greg2))
7717 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7719 (setq sd (+ (* span arg) sd))))
7720 (let ((org-agenda-overriding-cmd
7721 ;; `cmd' may have been set by `org-agenda-run-series' which
7722 ;; uses `org-agenda-overriding-cmd' to decide whether
7723 ;; overriding is allowed for `cmd'
7724 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7725 (org-agenda-overriding-arguments
7726 (list (car args) sd span)))
7728 (org-agenda-find-same-or-today-or-agenda cnt))))
7730 (defun org-agenda-earlier (arg)
7731 "Go backward in time by the current span.
7732 With prefix ARG, go backward that many times the current span."
7734 (org-agenda-later (- arg)))
7736 (defun org-agenda-view-mode-dispatch ()
7737 "Call one of the view mode commands."
7739 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
7740 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7741 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7742 (let ((a (read-char-exclusive)))
7744 (?\ (call-interactively 'org-agenda-reset-view))
7745 (?d (call-interactively 'org-agenda-day-view))
7746 (?w (call-interactively 'org-agenda-week-view))
7747 (?m (call-interactively 'org-agenda-month-view))
7748 (?y (call-interactively 'org-agenda-year-view))
7749 (?l (call-interactively 'org-agenda-log-mode))
7750 (?L (org-agenda-log-mode '(4)))
7751 (?c (org-agenda-log-mode 'clockcheck))
7752 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7753 (?a (call-interactively 'org-agenda-archives-mode))
7754 (?A (org-agenda-archives-mode 'files))
7755 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7756 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7757 (?G (call-interactively 'org-agenda-toggle-time-grid))
7758 (?D (call-interactively 'org-agenda-toggle-diary))
7759 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7760 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7761 (org-agenda-check-type t 'timeline 'agenda)
7763 (message "Display now includes inactive timestamps as well"))
7764 (?q (message "Abort"))
7765 (otherwise (error "Invalid key" )))))
7767 (defun org-agenda-reset-view ()
7768 "Switch to default view for agenda."
7770 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7771 (defun org-agenda-day-view (&optional day-of-month)
7772 "Switch to daily view for agenda.
7773 With argument DAY-OF-MONTH, switch to that day of the month."
7775 (org-agenda-change-time-span 'day day-of-month))
7776 (defun org-agenda-week-view (&optional iso-week)
7777 "Switch to daily view for agenda.
7778 With argument ISO-WEEK, switch to the corresponding ISO week.
7779 If ISO-WEEK has more then 2 digits, only the last two encode the
7780 week. Any digits before this encode a year. So 200712 means
7781 week 12 of year 2007. Years in the range 1938-2037 can also be
7782 written as 2-digit years."
7784 (org-agenda-change-time-span 'week iso-week))
7785 (defun org-agenda-month-view (&optional month)
7786 "Switch to monthly view for agenda.
7787 With argument MONTH, switch to that month."
7789 (org-agenda-change-time-span 'month month))
7790 (defun org-agenda-year-view (&optional year)
7791 "Switch to yearly view for agenda.
7792 With argument YEAR, switch to that year.
7793 If MONTH has more then 2 digits, only the last two encode the
7794 month. Any digits before this encode a year. So 200712 means
7795 December year 2007. Years in the range 1938-2037 can also be
7796 written as 2-digit years."
7799 (setq year (org-small-year-to-year year)))
7800 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7801 (org-agenda-change-time-span 'year year)
7804 (defun org-agenda-change-time-span (span &optional n)
7805 "Change the agenda view to SPAN.
7806 SPAN may be `day', `week', `month', `year'."
7807 (org-agenda-check-type t 'agenda)
7808 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7809 (curspan (nth 2 args)))
7810 (if (and (not n) (equal curspan span))
7811 (error "Viewing span is already \"%s\"" span))
7812 (let* ((sd (or (org-get-at-bol 'day)
7815 (sd (org-agenda-compute-starting-span sd span n))
7816 (org-agenda-overriding-cmd
7817 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7818 (org-agenda-overriding-arguments
7819 (list (car args) sd span)))
7821 (org-agenda-find-same-or-today-or-agenda))
7822 (org-agenda-set-mode-name)
7823 (message "Switched to %s view" span)))
7825 (defun org-agenda-compute-starting-span (sd span &optional n)
7826 "Compute starting date for agenda.
7827 SPAN may be `day', `week', `month', `year'. The return value
7828 is a cons cell with the starting date and the number of days,
7829 so that the date SD will be in that range."
7830 (let* ((greg (calendar-gregorian-from-absolute sd))
7837 (setq sd (+ (calendar-absolute-from-gregorian
7841 (let* ((nt (calendar-day-of-week
7842 (calendar-gregorian-from-absolute sd)))
7843 (d (if org-agenda-start-on-weekday
7844 (- nt org-agenda-start-on-weekday)
7847 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7851 (setq y1 (org-small-year-to-year (/ n 100))
7854 (calendar-absolute-from-iso
7856 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7859 (when (and n (> n 99))
7860 (setq y1 (org-small-year-to-year (/ n 100))
7862 (setq sd (calendar-absolute-from-gregorian
7863 (list (or n mg) 1 (or y1 yg))))))
7865 (setq sd (calendar-absolute-from-gregorian
7866 (list 1 1 (or n yg))))))
7869 (defun org-agenda-next-date-line (&optional arg)
7870 "Jump to the next line indicating a date in agenda buffer."
7872 (org-agenda-check-type t 'agenda 'timeline)
7873 (beginning-of-line 1)
7874 ;; This does not work if user makes date format that starts with a blank
7875 (if (looking-at "^\\S-") (forward-char 1))
7876 (if (not (re-search-forward "^\\S-" nil t arg))
7879 (error "No next date after this line in this buffer")))
7880 (goto-char (match-beginning 0)))
7882 (defun org-agenda-previous-date-line (&optional arg)
7883 "Jump to the previous line indicating a date in agenda buffer."
7885 (org-agenda-check-type t 'agenda 'timeline)
7886 (beginning-of-line 1)
7887 (if (not (re-search-backward "^\\S-" nil t arg))
7888 (error "No previous date before this line in this buffer")))
7890 ;; Initialize the highlight
7891 (defvar org-hl (make-overlay 1 1))
7892 (overlay-put org-hl 'face 'highlight)
7894 (defun org-highlight (begin end &optional buffer)
7895 "Highlight a region with overlay."
7896 (move-overlay org-hl begin end (or buffer (current-buffer))))
7898 (defun org-unhighlight ()
7899 "Detach overlay INDEX."
7900 (org-detach-overlay org-hl))
7902 (defun org-unhighlight-once ()
7903 "Remove the highlight from its position, and this function from the hook."
7904 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7907 (defvar org-agenda-pre-follow-window-conf nil)
7908 (defun org-agenda-follow-mode ()
7909 "Toggle follow mode in an agenda buffer."
7911 (unless org-agenda-follow-mode
7912 (setq org-agenda-pre-follow-window-conf
7913 (current-window-configuration)))
7914 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7915 (unless org-agenda-follow-mode
7916 (set-window-configuration org-agenda-pre-follow-window-conf))
7917 (org-agenda-set-mode-name)
7918 (org-agenda-do-context-action)
7919 (message "Follow mode is %s"
7920 (if org-agenda-follow-mode "on" "off")))
7922 (defun org-agenda-entry-text-mode (&optional arg)
7923 "Toggle entry text mode in an agenda buffer."
7925 (if (or org-agenda-tag-filter
7926 org-agenda-category-filter
7927 org-agenda-top-category-filter)
7928 (user-error "Can't show entry text in filtered views")
7929 (setq org-agenda-entry-text-mode (or (integerp arg)
7930 (not org-agenda-entry-text-mode)))
7931 (org-agenda-entry-text-hide)
7932 (and org-agenda-entry-text-mode
7933 (let ((org-agenda-entry-text-maxlines
7934 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7935 (org-agenda-entry-text-show)))
7936 (org-agenda-set-mode-name)
7937 (message "Entry text mode is %s%s"
7938 (if org-agenda-entry-text-mode "on" "off")
7939 (if (not org-agenda-entry-text-mode) ""
7940 (format " (maximum number of lines is %d)"
7941 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
7943 (defun org-agenda-clockreport-mode (&optional with-filter)
7944 "Toggle clocktable mode in an agenda buffer.
7945 With prefix arg WITH-FILTER, make the clocktable respect the current
7948 (org-agenda-check-type t 'agenda)
7950 (setq org-agenda-clockreport-mode 'with-filter)
7951 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7952 (org-agenda-set-mode-name)
7954 (message "Clocktable mode is %s"
7955 (if org-agenda-clockreport-mode "on" "off")))
7957 (defun org-agenda-log-mode (&optional special)
7958 "Toggle log mode in an agenda buffer.
7959 With argument SPECIAL, show all possible log items, not only the ones
7960 configured in `org-agenda-log-mode-items'.
7961 With a double `C-u' prefix arg, show *only* log items, nothing else."
7963 (org-agenda-check-type t 'agenda 'timeline)
7964 (setq org-agenda-show-log
7966 ((equal special '(16)) 'only)
7967 ((eq special 'clockcheck)
7968 (if (eq org-agenda-show-log 'clockcheck)
7970 (special '(closed clock state))
7971 (t (not org-agenda-show-log))))
7972 (org-agenda-set-mode-name)
7974 (message "Log mode is %s"
7975 (if org-agenda-show-log "on" "off")))
7977 (defun org-agenda-archives-mode (&optional with-files)
7978 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7979 When called with a prefix argument, include all archive files as well."
7981 (setq org-agenda-archives-mode
7982 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7983 (org-agenda-set-mode-name)
7988 ((eq org-agenda-archives-mode nil)
7989 "No archives are included")
7990 ((eq org-agenda-archives-mode 'trees)
7991 (format "Trees with :%s: tag are included" org-archive-tag))
7992 ((eq org-agenda-archives-mode t)
7993 (format "Trees with :%s: tag and all active archive files are included"
7994 org-archive-tag)))))
7996 (defun org-agenda-toggle-diary ()
7997 "Toggle diary inclusion in an agenda buffer."
7999 (org-agenda-check-type t 'agenda)
8000 (setq org-agenda-include-diary (not org-agenda-include-diary))
8002 (org-agenda-set-mode-name)
8003 (message "Diary inclusion turned %s"
8004 (if org-agenda-include-diary "on" "off")))
8006 (defun org-agenda-toggle-deadlines ()
8007 "Toggle inclusion of entries with a deadline in an agenda buffer."
8009 (org-agenda-check-type t 'agenda)
8010 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8012 (org-agenda-set-mode-name)
8013 (message "Deadlines inclusion turned %s"
8014 (if org-agenda-include-deadlines "on" "off")))
8016 (defun org-agenda-toggle-time-grid ()
8017 "Toggle time grid in an agenda buffer."
8019 (org-agenda-check-type t 'agenda)
8020 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8022 (org-agenda-set-mode-name)
8023 (message "Time-grid turned %s"
8024 (if org-agenda-use-time-grid "on" "off")))
8026 (defun org-agenda-set-mode-name ()
8027 "Set the mode name to indicate all the small mode settings."
8030 (if (get 'org-agenda-files 'org-restrict) " []" "")
8032 '(:eval (org-agenda-span-name org-agenda-current-span))
8033 (if org-agenda-follow-mode " Follow" "")
8034 (if org-agenda-entry-text-mode " ETxt" "")
8035 (if org-agenda-include-diary " Diary" "")
8036 (if org-agenda-include-deadlines " Ddl" "")
8037 (if org-agenda-use-time-grid " Grid" "")
8038 (if (and (boundp 'org-habit-show-habits)
8039 org-habit-show-habits) " Habit" "")
8041 ((consp org-agenda-show-log) " LogAll")
8042 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8043 (org-agenda-show-log " Log")
8045 (if (or org-agenda-category-filter
8046 (get 'org-agenda-category-filter :preset-filter))
8047 '(:eval (org-propertize
8052 (get 'org-agenda-category-filter :preset-filter)
8053 org-agenda-category-filter)
8056 'face 'org-agenda-filter-category
8057 'help-echo "Category used in filtering")) "")
8058 (if (or org-agenda-tag-filter
8059 (get 'org-agenda-tag-filter :preset-filter))
8060 '(:eval (org-propertize
8065 (get 'org-agenda-tag-filter :preset-filter)
8066 org-agenda-tag-filter)
8069 'face 'org-agenda-filter-tags
8070 'help-echo "Tags used in filtering")) "")
8071 (if (or org-agenda-regexp-filter
8072 (get 'org-agenda-regexp-filter :preset-filter))
8073 '(:eval (org-propertize
8078 (get 'org-agenda-regexp-filter :preset-filter)
8079 org-agenda-regexp-filter)
8082 'face 'org-agenda-filter-regexp
8083 'help-echo "Regexp used in filtering")) "")
8084 (if org-agenda-archives-mode
8085 (if (eq org-agenda-archives-mode t)
8087 (format " :%s:" org-archive-tag))
8089 (if org-agenda-clockreport-mode
8090 (if (eq org-agenda-clockreport-mode 'with-filter)
8091 " Clock{}" " Clock")
8093 (force-mode-line-update))
8095 (define-obsolete-function-alias
8096 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8098 (defun org-agenda-update-agenda-type ()
8099 "Update the agenda type after each command."
8100 (setq org-agenda-type
8101 (or (get-text-property (point) 'org-agenda-type)
8102 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8104 (defun org-agenda-next-line ()
8105 "Move cursor to the next line, and show if follow mode is active."
8107 (call-interactively 'next-line)
8108 (org-agenda-do-context-action))
8110 (defun org-agenda-previous-line ()
8111 "Move cursor to the previous line, and show if follow-mode is active."
8113 (call-interactively 'previous-line)
8114 (org-agenda-do-context-action))
8116 (defun org-agenda-next-item (n)
8117 "Move cursor to next agenda item."
8119 (let ((col (current-column)))
8121 (when (next-single-property-change (point-at-eol) 'org-marker)
8122 (move-end-of-line 1)
8123 (goto-char (next-single-property-change (point) 'org-marker))))
8124 (org-move-to-column col))
8125 (org-agenda-do-context-action))
8127 (defun org-agenda-previous-item (n)
8128 "Move cursor to next agenda item."
8131 (let ((col (current-column))
8132 (goto (save-excursion
8133 (move-end-of-line 0)
8134 (previous-single-property-change (point) 'org-marker))))
8135 (if goto (goto-char goto))
8136 (org-move-to-column col)))
8137 (org-agenda-do-context-action))
8139 (defun org-agenda-do-context-action ()
8140 "Show outline path and, maybe, follow mode window."
8141 (let ((m (org-get-at-bol 'org-marker)))
8142 (when (and (markerp m) (marker-buffer m))
8143 (and org-agenda-follow-mode
8144 (if org-agenda-follow-indirect
8145 (org-agenda-tree-to-indirect-buffer nil)
8147 (and org-agenda-show-outline-path
8148 (org-with-point-at m (org-display-outline-path t))))))
8150 (defun org-agenda-show-tags ()
8151 "Show the tags applicable to the current item."
8153 (let* ((tags (org-get-at-bol 'tags)))
8155 (message "Tags are :%s:"
8156 (org-no-properties (mapconcat 'identity tags ":")))
8157 (message "No tags associated with this line"))))
8159 (defun org-agenda-goto (&optional highlight)
8160 "Go to the Org-mode file which contains the item at point."
8162 (let* ((marker (or (org-get-at-bol 'org-marker)
8163 (org-agenda-error)))
8164 (buffer (marker-buffer marker))
8165 (pos (marker-position marker)))
8166 (switch-to-buffer-other-window buffer)
8170 (when (derived-mode-p 'org-mode)
8171 (org-show-context 'agenda)
8173 (and (outline-next-heading)
8174 (org-flag-heading nil)))) ; show the next heading
8175 (when (outline-invisible-p)
8176 (show-entry)) ; display invisible text
8177 (recenter (/ (window-height) 2))
8178 (run-hooks 'org-agenda-after-show-hook)
8179 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8181 (defvar org-agenda-after-show-hook nil
8182 "Normal hook run after an item has been shown from the agenda.
8183 Point is in the buffer where the item originated.")
8185 (defun org-agenda-kill ()
8186 "Kill the entry or subtree belonging to the current agenda entry."
8188 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8189 (let* ((bufname-orig (buffer-name))
8190 (marker (or (org-get-at-bol 'org-marker)
8191 (org-agenda-error)))
8192 (buffer (marker-buffer marker))
8193 (pos (marker-position marker))
8194 (type (org-get-at-bol 'type))
8195 dbeg dend (n 0) conf)
8196 (org-with-remote-undo buffer
8197 (with-current-buffer buffer
8200 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8201 (setq dbeg (progn (org-back-to-heading t) (point))
8202 dend (org-end-of-subtree t t))
8203 (setq dbeg (point-at-bol)
8204 dend (min (point-max) (1+ (point-at-eol)))))
8206 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8207 (setq conf (or (eq t org-agenda-confirm-kill)
8208 (and (numberp org-agenda-confirm-kill)
8209 (> n org-agenda-confirm-kill))))
8212 (format "Delete entry with %d lines in buffer \"%s\"? "
8213 n (buffer-name buffer))))
8215 (let ((org-agenda-buffer-name bufname-orig))
8216 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8217 (with-current-buffer buffer (delete-region dbeg dend))
8218 (message "Agenda item and source killed"))))
8220 (defvar org-archive-default-command) ; defined in org-archive.el
8221 (defun org-agenda-archive-default ()
8222 "Archive the entry or subtree belonging to the current agenda entry."
8224 (require 'org-archive)
8225 (org-agenda-archive-with org-archive-default-command))
8227 (defun org-agenda-archive-default-with-confirmation ()
8228 "Archive the entry or subtree belonging to the current agenda entry."
8230 (require 'org-archive)
8231 (org-agenda-archive-with org-archive-default-command 'confirm))
8233 (defun org-agenda-archive ()
8234 "Archive the entry or subtree belonging to the current agenda entry."
8236 (org-agenda-archive-with 'org-archive-subtree))
8238 (defun org-agenda-archive-to-archive-sibling ()
8239 "Move the entry to the archive sibling."
8241 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8243 (defun org-agenda-archive-with (cmd &optional confirm)
8244 "Move the entry to the archive sibling."
8246 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8247 (let* ((bufname-orig (buffer-name))
8248 (marker (or (org-get-at-bol 'org-marker)
8249 (org-agenda-error)))
8250 (buffer (marker-buffer marker))
8251 (pos (marker-position marker)))
8252 (org-with-remote-undo buffer
8253 (with-current-buffer buffer
8254 (if (derived-mode-p 'org-mode)
8256 (not (y-or-n-p "Archive this subtree or entry? ")))
8260 (let ((org-agenda-buffer-name bufname-orig))
8261 (org-remove-subtree-entries-from-agenda))
8262 (org-back-to-heading t)
8264 (error "Archiving works only in Org-mode files"))))))
8266 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8267 "Remove all lines in the agenda that correspond to a given subtree.
8268 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8269 If this information is not given, the function uses the tree at point."
8270 (let ((buf (or buf (current-buffer))) m p)
8272 (unless (and beg end)
8273 (org-back-to-heading t)
8275 (org-end-of-subtree t)
8277 (set-buffer (get-buffer org-agenda-buffer-name))
8279 (goto-char (point-max))
8280 (beginning-of-line 1)
8282 (when (and (setq m (org-get-at-bol 'org-marker))
8283 (equal buf (marker-buffer m))
8284 (setq p (marker-position m))
8287 (let ((inhibit-read-only t))
8288 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8289 (beginning-of-line 0))))))
8291 (defun org-agenda-refile (&optional goto rfloc no-update)
8292 "Refile the item at point.
8294 When GOTO is 0 or '(64), clear the refile cache.
8295 When GOTO is '(16), go to the location of the last refiled item.
8296 RFLOC can be a refile location obtained in a different way.
8297 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8300 ((member goto '(0 (64)))
8301 (org-refile-cache-clear))
8303 (org-refile-goto-last-stored))
8305 (let* ((buffer-orig (buffer-name))
8306 (marker (or (org-get-at-bol 'org-hd-marker)
8307 (org-agenda-error)))
8308 (buffer (marker-buffer marker))
8309 (pos (marker-position marker))
8311 (org-refile-get-location
8312 (if goto "Goto" "Refile to") buffer
8313 org-refile-allow-creating-parent-nodes))))
8314 (with-current-buffer buffer
8319 (let ((org-agenda-buffer-name buffer-orig))
8320 (org-remove-subtree-entries-from-agenda))
8321 (org-refile goto buffer rfloc)))))
8322 (unless no-update (org-agenda-redo)))))
8324 (defun org-agenda-open-link (&optional arg)
8325 "Open the link(s) in the current entry, if any.
8326 This looks for a link in the displayed line in the agenda.
8327 It also looks at the text of the entry itself."
8329 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8330 (org-get-at-bol 'org-marker)))
8331 (buffer (and marker (marker-buffer marker)))
8332 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8333 (lkall (org-offer-links-in-entry buffer marker arg prefix))
8335 (lk (if (stringp lk0) (list lk0) lk0))
8341 (with-current-buffer buffer
8342 (setq trg (and (string-match org-bracket-link-regexp l)
8343 (match-string 1 l)))
8344 (if (or (not trg) (string-match org-any-link-re trg))
8349 (when (search-forward l nil lkend)
8350 (goto-char (match-beginning 0))
8351 (org-open-at-point))))
8352 ;; This is an internal link, widen the buffer
8353 (switch-to-buffer-other-window buffer)
8356 (when (search-forward l nil lkend)
8357 (goto-char (match-beginning 0))
8358 (org-open-at-point)))))
8360 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8362 (beginning-of-line 1)
8363 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8364 (org-open-link-from-string (match-string 1)))
8365 (t (message "No link to open here")))))
8367 (defun org-agenda-copy-local-variable (var)
8368 "Get a variable from a referenced buffer and install it here."
8369 (let ((m (org-get-at-bol 'org-marker)))
8370 (when (and m (buffer-live-p (marker-buffer m)))
8371 (org-set-local var (with-current-buffer (marker-buffer m)
8372 (symbol-value var))))))
8374 (defun org-agenda-switch-to (&optional delete-other-windows)
8375 "Go to the Org-mode file which contains the item at point."
8377 (if (and org-return-follows-link
8378 (not (org-get-at-bol 'org-marker))
8379 (org-in-regexp org-bracket-link-regexp))
8380 (org-open-link-from-string (match-string 0))
8381 (let* ((marker (or (org-get-at-bol 'org-marker)
8382 (org-agenda-error)))
8383 (buffer (marker-buffer marker))
8384 (pos (marker-position marker)))
8385 (org-pop-to-buffer-same-window buffer)
8386 (and delete-other-windows (delete-other-windows))
8389 (when (derived-mode-p 'org-mode)
8390 (org-show-context 'agenda)
8392 (and (outline-next-heading)
8393 (org-flag-heading nil))) ; show the next heading
8394 (when (outline-invisible-p)
8395 (show-entry)) ; display invisible text
8396 (run-hooks 'org-agenda-after-show-hook)))))
8398 (defun org-agenda-goto-mouse (ev)
8399 "Go to the Org-mode file which contains the item at the mouse click."
8401 (mouse-set-point ev)
8404 (defun org-agenda-show (&optional full-entry)
8405 "Display the Org-mode file which contains the item at point.
8406 With prefix argument FULL-ENTRY, make the entire entry visible
8407 if it was hidden in the outline."
8409 (let ((win (selected-window)))
8411 (let ((org-show-entry-below t))
8412 (org-agenda-goto t))
8413 (org-agenda-goto t))
8414 (select-window win)))
8416 (defvar org-agenda-show-window nil)
8417 (defun org-agenda-show-and-scroll-up (&optional arg)
8418 "Display the Org-mode file which contains the item at point.
8419 When called repeatedly, scroll the window that is displaying the buffer.
8420 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8421 `show-subtree' to display the item, so that drawers and logbooks stay
8424 (let ((win (selected-window)))
8425 (if (and (window-live-p org-agenda-show-window)
8426 (eq this-command last-command))
8428 (select-window org-agenda-show-window)
8429 (ignore-errors (scroll-up)))
8431 (if arg (org-show-entry) (show-subtree))
8432 (setq org-agenda-show-window (selected-window)))
8433 (select-window win)))
8435 (defun org-agenda-show-scroll-down ()
8436 "Scroll down the window showing the agenda."
8438 (let ((win (selected-window)))
8439 (when (window-live-p org-agenda-show-window)
8440 (select-window org-agenda-show-window)
8441 (ignore-errors (scroll-down))
8442 (select-window win))))
8444 (defun org-agenda-show-1 (&optional more)
8445 "Display the Org-mode file which contains the item at point.
8446 The prefix arg selects the amount of information to display:
8449 1 just show the entry according to defaults.
8450 2 show the children view
8451 3 show the subtree view
8452 4 show the entire subtree and any LOGBOOK drawers
8453 5 show the entire subtree and any drawers
8454 With prefix argument FULL-ENTRY, make the entire entry visible
8455 if it was hidden in the outline."
8457 (let ((win (selected-window)))
8459 (org-recenter-heading 1)
8464 (org-back-to-heading)
8465 (run-hook-with-args 'org-cycle-hook 'folded))
8466 (message "Remote: FOLDED"))
8467 ((and (org-called-interactively-p 'any) (= more 1))
8468 (message "Remote: show with default settings"))
8473 (org-back-to-heading)
8474 (run-hook-with-args 'org-cycle-hook 'children))
8475 (message "Remote: CHILDREN"))
8479 (org-back-to-heading)
8480 (run-hook-with-args 'org-cycle-hook 'subtree))
8481 (message "Remote: SUBTREE"))
8483 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
8485 (concat "^[ \t]*:\\("
8486 (mapconcat 'regexp-quote org-drawers "\\|")
8490 (org-back-to-heading)
8491 (org-cycle-hide-drawers 'subtree)))
8492 (message "Remote: SUBTREE AND LOGBOOK"))
8495 (message "Remote: SUBTREE AND ALL DRAWERS")))
8496 (select-window win)))
8498 (defun org-recenter-heading (n)
8500 (org-back-to-heading)
8503 (defvar org-agenda-cycle-counter nil)
8504 (defun org-agenda-cycle-show (&optional n)
8505 "Show the current entry in another window, with default settings.
8506 Default settings are taken from `org-show-hierarchy-above' and siblings.
8507 When use repeatedly in immediate succession, the remote entry will cycle
8510 children -> subtree -> folded
8512 When called with a numeric prefix arg, that arg will be passed through to
8513 `org-agenda-show-1'. For the interpretation of that argument, see the
8514 docstring of `org-agenda-show-1'."
8517 (setq org-agenda-cycle-counter n)
8518 (if (not (eq last-command this-command))
8519 (setq org-agenda-cycle-counter 1)
8520 (if (equal org-agenda-cycle-counter 0)
8521 (setq org-agenda-cycle-counter 2)
8522 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8523 (if (> org-agenda-cycle-counter 3)
8524 (setq org-agenda-cycle-counter 0)))))
8525 (org-agenda-show-1 org-agenda-cycle-counter))
8527 (defun org-agenda-recenter (arg)
8528 "Display the Org-mode file which contains the item at point and recenter."
8530 (let ((win (selected-window)))
8533 (select-window win)))
8535 (defun org-agenda-show-mouse (ev)
8536 "Display the Org-mode file which contains the item at the mouse click."
8538 (mouse-set-point ev)
8541 (defun org-agenda-check-no-diary ()
8542 "Check if the entry is a diary link and abort if yes."
8543 (if (org-get-at-bol 'org-agenda-diary-link)
8544 (org-agenda-error)))
8546 (defun org-agenda-error ()
8547 (error "Command not allowed in this line"))
8549 (defun org-agenda-tree-to-indirect-buffer (arg)
8550 "Show the subtree corresponding to the current entry in an indirect buffer.
8551 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8553 With a numerical prefix ARG, go up to this level and then take that tree.
8554 With a negative numeric ARG, go up by this number of levels.
8555 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8556 use the dedicated frame)."
8558 (if current-prefix-arg
8559 (org-agenda-do-tree-to-indirect-buffer arg)
8560 (let ((agenda-buffer (buffer-name))
8561 (agenda-window (selected-window))
8563 (and org-last-indirect-buffer
8564 (get-buffer-window org-last-indirect-buffer))))
8565 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8566 (unless (or (eq org-indirect-buffer-display 'new-frame)
8567 (eq org-indirect-buffer-display 'dedicated-frame))
8569 (unless (and indirect-window (window-live-p indirect-window))
8570 (setq indirect-window (split-window agenda-window)))
8571 (and indirect-window (select-window indirect-window))
8572 (switch-to-buffer org-last-indirect-buffer :norecord)
8573 (fit-window-to-buffer indirect-window)))
8574 (select-window (get-buffer-window agenda-buffer)))))
8576 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8577 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8578 (org-agenda-check-no-diary)
8579 (let* ((marker (or (org-get-at-bol 'org-marker)
8580 (org-agenda-error)))
8581 (buffer (marker-buffer marker))
8582 (pos (marker-position marker)))
8583 (with-current-buffer buffer
8586 (funcall 'org-tree-to-indirect-buffer arg)))))
8588 (defvar org-last-heading-marker (make-marker)
8589 "Marker pointing to the headline that last changed its TODO state
8590 by a remote command from the agenda.")
8592 (defun org-agenda-todo-nextset ()
8593 "Switch TODO entry to next sequence."
8595 (org-agenda-todo 'nextset))
8597 (defun org-agenda-todo-previousset ()
8598 "Switch TODO entry to previous sequence."
8600 (org-agenda-todo 'previousset))
8602 (defun org-agenda-todo (&optional arg)
8603 "Cycle TODO state of line at point, also in Org-mode file.
8604 This changes the line at point, all other lines in the agenda referring to
8605 the same tree node, and the headline of the tree node in the Org-mode file."
8607 (org-agenda-check-no-diary)
8608 (let* ((col (current-column))
8609 (marker (or (org-get-at-bol 'org-marker)
8610 (org-agenda-error)))
8611 (buffer (marker-buffer marker))
8612 (pos (marker-position marker))
8613 (hdmarker (org-get-at-bol 'org-hd-marker))
8614 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8615 (inhibit-read-only t)
8616 org-agenda-headline-snapshot-before-repeat newhead just-one)
8617 (org-with-remote-undo buffer
8618 (with-current-buffer buffer
8621 (org-show-context 'agenda)
8623 (and (outline-next-heading)
8624 (org-flag-heading nil))) ; show the next heading
8625 (let ((current-prefix-arg arg))
8626 (call-interactively 'org-todo))
8627 (and (bolp) (forward-char 1))
8628 (setq newhead (org-get-heading))
8629 (when (and (org-bound-and-true-p
8630 org-agenda-headline-snapshot-before-repeat)
8631 (not (equal org-agenda-headline-snapshot-before-repeat
8634 (setq newhead org-agenda-headline-snapshot-before-repeat
8637 (org-back-to-heading)
8638 (move-marker org-last-heading-marker (point))))
8639 (beginning-of-line 1)
8641 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8642 (org-move-to-column col))))
8644 (defun org-agenda-add-note (&optional arg)
8645 "Add a time-stamped note to the entry at point."
8647 (org-agenda-check-no-diary)
8648 (let* ((marker (or (org-get-at-bol 'org-marker)
8649 (org-agenda-error)))
8650 (buffer (marker-buffer marker))
8651 (pos (marker-position marker))
8652 (hdmarker (org-get-at-bol 'org-hd-marker))
8653 (inhibit-read-only t))
8654 (with-current-buffer buffer
8657 (org-show-context 'agenda)
8659 (and (outline-next-heading)
8660 (org-flag-heading nil))) ; show the next heading
8663 (defun org-agenda-change-all-lines (newhead hdmarker
8664 &optional fixface just-this)
8665 "Change all lines in the agenda buffer which match HDMARKER.
8666 The new content of the line will be NEWHEAD (as modified by
8667 `org-agenda-format-item'). HDMARKER is checked with
8668 `equal' against all `org-hd-marker' text properties in the file.
8669 If FIXFACE is non-nil, the face of each item is modified according to
8671 If JUST-THIS is non-nil, change just the current line, not all.
8672 If FORCE-TAGS is non nil, the car of it returns the new tags."
8673 (let* ((inhibit-read-only t)
8674 (line (org-current-line))
8675 (org-agenda-buffer (current-buffer))
8676 (thetags (with-current-buffer (marker-buffer hdmarker)
8677 (save-excursion (save-restriction (widen)
8678 (goto-char hdmarker)
8679 (org-get-tags-at)))))
8680 props m pl undone-face done-face finish new dotime level cat tags)
8682 (goto-char (point-max))
8683 (beginning-of-line 1)
8685 (setq finish (bobp))
8686 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8687 (or (not just-this) (= (org-current-line) line))
8689 (setq props (text-properties-at (point))
8690 dotime (org-get-at-bol 'dotime)
8691 cat (org-get-at-bol 'org-category)
8692 level (org-get-at-bol 'level)
8695 (let ((org-prefix-format-compiled
8696 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8697 org-prefix-format-compiled))
8698 (extra (org-get-at-bol 'extra)))
8699 (with-current-buffer (marker-buffer hdmarker)
8703 (org-agenda-format-item extra newhead level cat tags dotime)))))
8704 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8705 undone-face (org-get-at-bol 'undone-face)
8706 done-face (org-get-at-bol 'done-face))
8707 (beginning-of-line 1)
8710 (and (looking-at ".*\n?") (replace-match "")))
8712 (replace-match new t t)
8713 (beginning-of-line 1)
8714 (add-text-properties (point-at-bol) (point-at-eol) props)
8716 (add-text-properties
8717 (point-at-bol) (point-at-eol)
8719 (if org-last-todo-state-is-todo
8720 undone-face done-face))))
8721 (org-agenda-highlight-todo 'line)
8722 (beginning-of-line 1))
8723 (t (error "Line update did not work")))
8725 (narrow-to-region (point-at-bol) (point-at-eol))
8726 (org-agenda-finalize)))
8727 (beginning-of-line 0)))))
8729 (defun org-agenda-align-tags (&optional line)
8730 "Align all tags in agenda items to `org-agenda-tags-column'."
8731 (let ((inhibit-read-only t) l c)
8733 (goto-char (if line (point-at-bol) (point-min)))
8734 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8735 (if line (point-at-eol) nil) t)
8736 (add-text-properties
8737 (match-beginning 2) (match-end 2)
8738 (list 'face (delq nil (let ((prop (get-text-property
8739 (match-beginning 2) 'face)))
8740 (or (listp prop) (setq prop (list prop)))
8741 (if (memq 'org-tag prop)
8743 (cons 'org-tag prop))))))
8744 (setq l (- (match-end 2) (match-beginning 2))
8745 c (if (< org-agenda-tags-column 0)
8746 (- (abs org-agenda-tags-column) l)
8747 org-agenda-tags-column))
8748 (delete-region (match-beginning 1) (match-end 1))
8749 (goto-char (match-beginning 1))
8750 (insert (org-add-props
8751 (make-string (max 1 (- c (current-column))) ?\ )
8752 (plist-put (copy-sequence (text-properties-at (point)))
8754 (goto-char (point-min))
8755 (org-font-lock-add-tag-faces (point-max)))))
8757 (defun org-agenda-priority-up ()
8758 "Increase the priority of line at point, also in Org-mode file."
8760 (org-agenda-priority 'up))
8762 (defun org-agenda-priority-down ()
8763 "Decrease the priority of line at point, also in Org-mode file."
8765 (org-agenda-priority 'down))
8767 (defun org-agenda-priority (&optional force-direction)
8768 "Set the priority of line at point, also in Org-mode file.
8769 This changes the line at point, all other lines in the agenda referring to
8770 the same tree node, and the headline of the tree node in the Org-mode file.
8771 Called with a universal prefix arg, show the priority instead of setting it."
8773 (if (equal force-direction '(4))
8775 (unless org-enable-priority-commands
8776 (error "Priority commands are disabled"))
8777 (org-agenda-check-no-diary)
8778 (let* ((marker (or (org-get-at-bol 'org-marker)
8779 (org-agenda-error)))
8780 (hdmarker (org-get-at-bol 'org-hd-marker))
8781 (buffer (marker-buffer hdmarker))
8782 (pos (marker-position hdmarker))
8783 (inhibit-read-only t)
8785 (org-with-remote-undo buffer
8786 (with-current-buffer buffer
8789 (org-show-context 'agenda)
8791 (and (outline-next-heading)
8792 (org-flag-heading nil))) ; show the next heading
8793 (funcall 'org-priority force-direction)
8795 (setq newhead (org-get-heading)))
8796 (org-agenda-change-all-lines newhead hdmarker)
8797 (beginning-of-line 1)))))
8799 ;; FIXME: should fix the tags property of the agenda line.
8800 (defun org-agenda-set-tags (&optional tag onoff)
8801 "Set tags for the current headline."
8803 (org-agenda-check-no-diary)
8804 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8805 (call-interactively 'org-change-tag-in-region)
8806 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8807 (org-agenda-error)))
8808 (buffer (marker-buffer hdmarker))
8809 (pos (marker-position hdmarker))
8810 (inhibit-read-only t)
8812 (org-with-remote-undo buffer
8813 (with-current-buffer buffer
8817 (org-show-context 'agenda))
8819 (and (outline-next-heading)
8820 (org-flag-heading nil))) ; show the next heading
8823 (org-toggle-tag tag onoff)
8824 (call-interactively 'org-set-tags))
8826 (setq newhead (org-get-heading)))
8827 (org-agenda-change-all-lines newhead hdmarker)
8828 (beginning-of-line 1)))))
8830 (defun org-agenda-set-property ()
8831 "Set a property for the current headline."
8833 (org-agenda-check-no-diary)
8834 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8835 (org-agenda-error)))
8836 (buffer (marker-buffer hdmarker))
8837 (pos (marker-position hdmarker))
8838 (inhibit-read-only t)
8840 (org-with-remote-undo buffer
8841 (with-current-buffer buffer
8845 (org-show-context 'agenda))
8847 (and (outline-next-heading)
8848 (org-flag-heading nil))) ; show the next heading
8850 (call-interactively 'org-set-property)))))
8852 (defun org-agenda-set-effort ()
8853 "Set the effort property for the current headline."
8855 (org-agenda-check-no-diary)
8856 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8857 (org-agenda-error)))
8858 (buffer (marker-buffer hdmarker))
8859 (pos (marker-position hdmarker))
8860 (inhibit-read-only t)
8862 (org-with-remote-undo buffer
8863 (with-current-buffer buffer
8867 (org-show-context 'agenda))
8869 (and (outline-next-heading)
8870 (org-flag-heading nil))) ; show the next heading
8872 (call-interactively 'org-set-effort)
8874 (setq newhead (org-get-heading)))
8875 (org-agenda-change-all-lines newhead hdmarker))))
8877 (defun org-agenda-toggle-archive-tag ()
8878 "Toggle the archive tag for the current entry."
8880 (org-agenda-check-no-diary)
8881 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8882 (org-agenda-error)))
8883 (buffer (marker-buffer hdmarker))
8884 (pos (marker-position hdmarker))
8885 (inhibit-read-only t)
8887 (org-with-remote-undo buffer
8888 (with-current-buffer buffer
8891 (org-show-context 'agenda)
8893 (and (outline-next-heading)
8894 (org-flag-heading nil))) ; show the next heading
8895 (call-interactively 'org-toggle-archive-tag)
8897 (setq newhead (org-get-heading)))
8898 (org-agenda-change-all-lines newhead hdmarker)
8899 (beginning-of-line 1))))
8901 (defun org-agenda-do-date-later (arg)
8904 ((or (equal arg '(16))
8906 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8907 (setq this-command 'org-agenda-date-later-minutes)
8908 (org-agenda-date-later-minutes 1))
8909 ((or (equal arg '(4))
8911 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8912 (setq this-command 'org-agenda-date-later-hours)
8913 (org-agenda-date-later-hours 1))
8915 (org-agenda-date-later (prefix-numeric-value arg)))))
8917 (defun org-agenda-do-date-earlier (arg)
8920 ((or (equal arg '(16))
8922 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8923 (setq this-command 'org-agenda-date-earlier-minutes)
8924 (org-agenda-date-earlier-minutes 1))
8925 ((or (equal arg '(4))
8927 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8928 (setq this-command 'org-agenda-date-earlier-hours)
8929 (org-agenda-date-earlier-hours 1))
8931 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8933 (defun org-agenda-date-later (arg &optional what)
8934 "Change the date of this item to ARG day(s) later."
8936 (org-agenda-check-type t 'agenda 'timeline)
8937 (org-agenda-check-no-diary)
8938 (let* ((marker (or (org-get-at-bol 'org-marker)
8939 (org-agenda-error)))
8940 (buffer (marker-buffer marker))
8941 (pos (marker-position marker))
8943 (org-with-remote-undo buffer
8944 (with-current-buffer buffer
8947 (if (not (org-at-timestamp-p))
8948 (error "Cannot find time stamp"))
8949 (when (and org-agenda-move-date-from-past-immediately-to-today
8951 (or (not what) (eq what 'day))
8952 (not (save-match-data (org-at-date-range-p))))
8953 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8954 cdate (calendar-absolute-from-gregorian
8955 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8958 ;; immediately shift to today
8959 (setq arg (- today cdate))))
8960 (org-timestamp-change arg (or what 'day))
8961 (when (and (org-at-date-range-p)
8962 (re-search-backward org-tr-regexp-both (point-at-bol)))
8963 (let ((end org-last-changed-timestamp))
8964 (org-timestamp-change arg (or what 'day))
8965 (setq org-last-changed-timestamp
8966 (concat org-last-changed-timestamp "--" end)))))
8967 (org-agenda-show-new-time marker org-last-changed-timestamp))
8968 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8970 (defun org-agenda-date-earlier (arg &optional what)
8971 "Change the date of this item to ARG day(s) earlier."
8973 (org-agenda-date-later (- arg) what))
8975 (defun org-agenda-date-later-minutes (arg)
8976 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8978 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8979 (org-agenda-date-later arg 'minute))
8981 (defun org-agenda-date-earlier-minutes (arg)
8982 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8984 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8985 (org-agenda-date-earlier arg 'minute))
8987 (defun org-agenda-date-later-hours (arg)
8988 "Change the time of this item, in hour steps."
8990 (org-agenda-date-later arg 'hour))
8992 (defun org-agenda-date-earlier-hours (arg)
8993 "Change the time of this item, in hour steps."
8995 (org-agenda-date-earlier arg 'hour))
8997 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8998 "Show new date stamp via text properties."
8999 ;; We use text properties to make this undoable
9000 (let ((inhibit-read-only t))
9001 (setq stamp (concat prefix " => " stamp " "))
9003 (goto-char (point-max))
9005 (when (equal marker (org-get-at-bol 'org-marker))
9006 (org-move-to-column (- (window-width) (length stamp)) t)
9007 (org-agenda-fix-tags-filter-overlays-at (point))
9008 (if (featurep 'xemacs)
9009 ;; Use `duplicable' property to trigger undo recording
9010 (let ((ex (make-extent nil nil))
9011 (gl (make-glyph stamp)))
9012 (set-glyph-face gl 'secondary-selection)
9013 (set-extent-properties
9014 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9015 (insert-extent ex (1- (point)) (point-at-eol)))
9016 (add-text-properties
9017 (1- (point)) (point-at-eol)
9018 (list 'display (org-add-props stamp nil
9019 'face 'secondary-selection))))
9020 (beginning-of-line 1))
9021 (beginning-of-line 0)))))
9023 (defun org-agenda-date-prompt (arg)
9024 "Change the date of this item. Date is prompted for, with default today.
9025 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9026 be used to request time specification in the time stamp."
9028 (org-agenda-check-type t 'agenda 'timeline)
9029 (org-agenda-check-no-diary)
9030 (let* ((marker (or (org-get-at-bol 'org-marker)
9031 (org-agenda-error)))
9032 (buffer (marker-buffer marker))
9033 (pos (marker-position marker)))
9034 (org-with-remote-undo buffer
9035 (with-current-buffer buffer
9038 (if (not (org-at-timestamp-p t))
9039 (error "Cannot find time stamp"))
9040 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9041 (org-agenda-show-new-time marker org-last-changed-timestamp))
9042 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9044 (defun org-agenda-schedule (arg &optional time)
9045 "Schedule the item at point.
9046 ARG is passed through to `org-schedule'."
9048 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9049 (org-agenda-check-no-diary)
9050 (let* ((marker (or (org-get-at-bol 'org-marker)
9051 (org-agenda-error)))
9052 (type (marker-insertion-type marker))
9053 (buffer (marker-buffer marker))
9054 (pos (marker-position marker))
9055 (org-insert-labeled-timestamps-at-point nil)
9057 (set-marker-insertion-type marker t)
9058 (org-with-remote-undo buffer
9059 (with-current-buffer buffer
9062 (setq ts (org-schedule arg time)))
9063 (org-agenda-show-new-time marker ts " S"))
9066 (defun org-agenda-deadline (arg &optional time)
9067 "Schedule the item at point.
9068 ARG is passed through to `org-deadline'."
9070 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9071 (org-agenda-check-no-diary)
9072 (let* ((marker (or (org-get-at-bol 'org-marker)
9073 (org-agenda-error)))
9074 (buffer (marker-buffer marker))
9075 (pos (marker-position marker))
9076 (org-insert-labeled-timestamps-at-point nil)
9078 (org-with-remote-undo buffer
9079 (with-current-buffer buffer
9082 (setq ts (org-deadline arg time)))
9083 (org-agenda-show-new-time marker ts " D"))
9086 (defun org-agenda-clock-in (&optional arg)
9087 "Start the clock on the currently selected item."
9089 (org-agenda-check-no-diary)
9090 (if (equal arg '(4))
9092 (let* ((marker (or (org-get-at-bol 'org-marker)
9093 (org-agenda-error)))
9094 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9095 (pos (marker-position marker))
9096 (col (current-column))
9098 (org-with-remote-undo (marker-buffer marker)
9099 (with-current-buffer (marker-buffer marker)
9102 (org-show-context 'agenda)
9104 (org-cycle-hide-drawers 'children)
9106 (setq newhead (org-get-heading)))
9107 (org-agenda-change-all-lines newhead hdmarker))
9108 (org-move-to-column col))))
9110 (defun org-agenda-clock-out ()
9111 "Stop the currently running clock."
9113 (unless (marker-buffer org-clock-marker)
9114 (error "No running clock"))
9115 (let ((marker (make-marker)) (col (current-column)) newhead)
9116 (org-with-remote-undo (marker-buffer org-clock-marker)
9117 (with-current-buffer (marker-buffer org-clock-marker)
9121 (goto-char org-clock-marker)
9122 (org-back-to-heading t)
9123 (move-marker marker (point))
9125 (setq newhead (org-get-heading))))))
9126 (org-agenda-change-all-lines newhead marker)
9127 (move-marker marker nil)
9128 (org-move-to-column col)
9129 (org-agenda-unmark-clocking-task)))
9131 (defun org-agenda-clock-cancel (&optional arg)
9132 "Cancel the currently running clock."
9134 (unless (marker-buffer org-clock-marker)
9135 (error "No running clock"))
9136 (org-with-remote-undo (marker-buffer org-clock-marker)
9137 (org-clock-cancel)))
9139 (defun org-agenda-clock-goto ()
9140 "Jump to the currently clocked in task within the agenda.
9141 If the currently clocked in task is not listed in the agenda
9142 buffer, display it in another window."
9146 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9147 (setq pos (overlay-start o))))
9148 (overlays-in (point-min) (point-max)))
9149 (cond (pos (goto-char pos))
9150 ;; If the currently clocked entry is not in the agenda
9151 ;; buffer, we visit it in another window:
9152 (org-clock-current-task
9153 (org-switch-to-buffer-other-window (org-clock-goto)))
9154 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9156 (defun org-agenda-diary-entry-in-org-file ()
9157 "Make a diary entry in the file `org-agenda-diary-file'."
9158 (let (d1 d2 char (text "") dp1 dp2)
9159 (if (equal (buffer-name) "*Calendar*")
9160 (setq d1 (calendar-cursor-to-date t)
9161 d2 (car calendar-mark-ring))
9162 (setq dp1 (get-text-property (point-at-bol) 'day))
9163 (unless dp1 (error "No date defined in current line"))
9164 (setq d1 (calendar-gregorian-from-absolute dp1)
9165 d2 (and (ignore-errors (mark))
9168 (setq dp2 (get-text-property (point-at-bol) 'day)))
9169 (calendar-gregorian-from-absolute dp2))))
9170 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9171 (setq char (read-char-exclusive))
9174 (setq text (read-string "Day entry: "))
9175 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9176 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9178 (setq d1 (list (car d1) (nth 1 d1)
9179 (read-number (format "Reference year [%d]: " (nth 2 d1))
9181 (setq text (read-string "Anniversary (use %d to show years): "))
9182 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9183 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9185 (setq text (read-string "Block entry: "))
9186 (unless (and d1 d2 (not (equal d1 d2)))
9187 (error "No block of days selected"))
9188 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9189 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9191 (org-switch-to-buffer-other-window
9192 (find-file-noselect org-agenda-diary-file))
9193 (require 'org-datetree)
9194 (org-datetree-find-date-create d1)
9196 (t (error "Invalid selection character `%c'" char)))))
9198 (defcustom org-agenda-insert-diary-strategy 'date-tree
9199 "Where in `org-agenda-diary-file' should new entries be added?
9202 date-tree in the date tree, as child of the date
9203 top-level as top-level entries at the end of the file."
9206 (const :tag "in a date tree" date-tree)
9207 (const :tag "as top level at end of file" top-level)))
9209 (defcustom org-agenda-insert-diary-extract-time nil
9210 "Non-nil means extract any time specification from the diary entry."
9215 (defcustom org-agenda-bulk-mark-char ">"
9216 "A single-character string to be used as the bulk mark."
9221 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9222 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9223 If TEXT is not empty, it will become the headline of the new entry, and
9224 the resulting entry will not be shown. When TEXT is empty, switch to
9225 `org-agenda-diary-file' and let the user finish the entry there."
9226 (let ((cw (current-window-configuration)))
9227 (org-switch-to-buffer-other-window
9228 (find-file-noselect org-agenda-diary-file))
9230 (goto-char (point-min))
9232 ((eq type 'anniversary)
9233 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9235 (or (org-at-heading-p t)
9237 (outline-next-heading)
9238 (insert "* Anniversaries\n\n")
9239 (beginning-of-line -1)))))
9240 (outline-next-heading)
9241 (org-back-over-empty-lines)
9244 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9245 (nth 2 d1) (car d1) (nth 1 d1) text)))
9247 (let ((org-prefix-has-time t)
9248 (org-agenda-time-leading-zero t)
9250 (if org-agenda-insert-diary-extract-time
9251 ;; Use org-agenda-format-item to parse text for a time-range and
9252 ;; remove it. FIXME: This is a hack, we should refactor
9253 ;; that function to make time extraction available separately
9254 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9255 time (get-text-property 0 'time fmt)
9256 time2 (if (> (length time) 0)
9257 ;; split-string removes trailing ...... if
9258 ;; no end time given. First space
9259 ;; separates time from date.
9260 (concat " " (car (split-string time "\\.")))
9262 text (get-text-property 0 'txt fmt)))
9263 (if (eq org-agenda-insert-diary-strategy 'top-level)
9264 (org-agenda-insert-diary-as-top-level text)
9265 (require 'org-datetree)
9266 (org-datetree-find-date-create d1)
9267 (org-agenda-insert-diary-make-new-entry text))
9268 (org-insert-time-stamp (org-time-from-absolute
9269 (calendar-absolute-from-gregorian d1))
9270 nil nil nil nil time2))
9273 (if (> (calendar-absolute-from-gregorian d1)
9274 (calendar-absolute-from-gregorian d2))
9275 (setq d1 (prog1 d2 (setq d2 d1))))
9276 (if (eq org-agenda-insert-diary-strategy 'top-level)
9277 (org-agenda-insert-diary-as-top-level text)
9278 (require 'org-datetree)
9279 (org-datetree-find-date-create d1)
9280 (org-agenda-insert-diary-make-new-entry text))
9281 (org-insert-time-stamp (org-time-from-absolute
9282 (calendar-absolute-from-gregorian d1)))
9284 (org-insert-time-stamp (org-time-from-absolute
9285 (calendar-absolute-from-gregorian d2)))
9287 (if (string-match "\\S-" text)
9289 (set-window-configuration cw)
9290 (message "%s entry added to %s"
9291 (capitalize (symbol-name type))
9292 (abbreviate-file-name org-agenda-diary-file)))
9294 (message "Please finish entry here"))))
9296 (defun org-agenda-insert-diary-as-top-level (text)
9297 "Make new entry as a top-level entry at the end of the file.
9298 Add TEXT as headline, and position the cursor in the second line so that
9299 a timestamp can be added there."
9301 (goto-char (point-max))
9302 (or (bolp) (insert "\n"))
9303 (insert "* " text "\n")
9304 (if org-adapt-indentation (org-indent-to-column 2)))
9306 (defun org-agenda-insert-diary-make-new-entry (text)
9307 "Make new entry as last child of current entry.
9308 Add TEXT as headline, and position the cursor in the second line so that
9309 a timestamp can be added there."
9310 (let ((org-show-following-heading t)
9311 (org-show-siblings t)
9312 (org-show-hierarchy-above t)
9313 (org-show-entry-below t)
9315 (outline-next-heading)
9316 (org-back-over-empty-lines)
9317 (or (looking-at "[ \t]*$")
9318 (progn (insert "\n") (backward-char 1)))
9319 (org-insert-heading nil t)
9321 (setq col (current-column))
9323 (if org-adapt-indentation (org-indent-to-column col))
9324 (let ((org-show-following-heading t)
9325 (org-show-siblings t)
9326 (org-show-hierarchy-above t)
9327 (org-show-entry-below t))
9328 (org-show-context))))
9330 (defun org-agenda-diary-entry ()
9331 "Make a diary entry, like the `i' command from the calendar.
9332 All the standard commands work: block, weekly etc.
9333 When `org-agenda-diary-file' points to a file,
9334 `org-agenda-diary-entry-in-org-file' is called instead to create
9335 entries in that Org-mode file."
9337 (if (not (eq org-agenda-diary-file 'diary-file))
9338 (org-agenda-diary-entry-in-org-file)
9339 (require 'diary-lib)
9341 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9342 (read-char-exclusive)))
9343 (cmd (cdr (assoc char
9344 '((?d . insert-diary-entry)
9345 (?w . insert-weekly-diary-entry)
9346 (?m . insert-monthly-diary-entry)
9347 (?y . insert-yearly-diary-entry)
9348 (?a . insert-anniversary-diary-entry)
9349 (?b . insert-block-diary-entry)
9350 (?c . insert-cyclic-diary-entry)))))
9351 (oldf (symbol-function 'calendar-cursor-to-date))
9352 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9354 (mark (or (mark t) (point))))
9356 (error "No command associated with <%c>" char))
9357 (unless (and (get-text-property point 'day)
9358 (or (not (equal ?b char))
9359 (get-text-property mark 'day)))
9360 (error "Don't know which date to use for diary entry"))
9361 ;; We implement this by hacking the `calendar-cursor-to-date' function
9362 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9363 (let ((calendar-mark-ring
9364 (list (calendar-gregorian-from-absolute
9365 (or (get-text-property mark 'day)
9366 (get-text-property point 'day))))))
9369 (fset 'calendar-cursor-to-date
9370 (lambda (&optional error dummy)
9371 (calendar-gregorian-from-absolute
9372 (get-text-property point 'day))))
9373 (call-interactively cmd))
9374 (fset 'calendar-cursor-to-date oldf))))))
9376 (defun org-agenda-execute-calendar-command (cmd)
9377 "Execute a calendar command from the agenda with date from cursor."
9378 (org-agenda-check-type t 'agenda 'timeline)
9379 (require 'diary-lib)
9380 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9381 (error "Don't know which date to use for the calendar command"))
9382 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9384 (date (calendar-gregorian-from-absolute
9385 (get-text-property point 'day)))
9386 ;; the following 2 vars are needed in the calendar
9387 (displayed-month (car date))
9388 (displayed-year (nth 2 date)))
9391 (fset 'calendar-cursor-to-date
9392 (lambda (&optional error dummy)
9393 (calendar-gregorian-from-absolute
9394 (get-text-property point 'day))))
9395 (call-interactively cmd))
9396 (fset 'calendar-cursor-to-date oldf))))
9398 (defun org-agenda-phases-of-moon ()
9399 "Display the phases of the moon for the 3 months around the cursor date."
9401 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
9403 (defun org-agenda-holidays ()
9404 "Display the holidays for the 3 months around the cursor date."
9406 (org-agenda-execute-calendar-command 'list-calendar-holidays))
9408 (defvar calendar-longitude) ; defined in calendar.el
9409 (defvar calendar-latitude) ; defined in calendar.el
9410 (defvar calendar-location-name) ; defined in calendar.el
9412 (defun org-agenda-sunrise-sunset (arg)
9413 "Display sunrise and sunset for the cursor date.
9414 Latitude and longitude can be specified with the variables
9415 `calendar-latitude' and `calendar-longitude'. When called with prefix
9416 argument, latitude and longitude will be prompted for."
9419 (let ((calendar-longitude (if arg nil calendar-longitude))
9420 (calendar-latitude (if arg nil calendar-latitude))
9421 (calendar-location-name
9422 (if arg "the given coordinates" calendar-location-name)))
9423 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9425 (defun org-agenda-goto-calendar ()
9426 "Open the Emacs calendar with the date at the cursor."
9428 (org-agenda-check-type t 'agenda 'timeline)
9429 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9430 (error "Don't know which date to open in calendar")))
9431 (date (calendar-gregorian-from-absolute day))
9432 (calendar-move-hook nil)
9433 (calendar-view-holidays-initially-flag nil)
9434 (calendar-view-diary-initially-flag nil))
9436 (calendar-goto-date date)))
9439 (defun org-calendar-goto-agenda ()
9440 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9441 This is a command that has to be installed in `calendar-mode-map'."
9443 (org-agenda-list nil (calendar-absolute-from-gregorian
9444 (calendar-cursor-to-date))
9447 (defun org-agenda-convert-date ()
9449 (org-agenda-check-type t 'agenda 'timeline)
9450 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9453 (error "Don't know which date to convert"))
9454 (setq date (calendar-gregorian-from-absolute day))
9456 "Gregorian: " (calendar-date-string date) "\n"
9457 "ISO: " (calendar-iso-date-string date) "\n"
9458 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9459 "Julian: " (calendar-julian-date-string date) "\n"
9460 "Astron. JD: " (calendar-astro-date-string date)
9461 " (Julian date number at noon UTC)\n"
9462 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9463 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9464 "French: " (calendar-french-date-string date) "\n"
9465 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
9466 "Mayan: " (calendar-mayan-date-string date) "\n"
9467 "Coptic: " (calendar-coptic-date-string date) "\n"
9468 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9469 "Persian: " (calendar-persian-date-string date) "\n"
9470 "Chinese: " (calendar-chinese-date-string date) "\n"))
9471 (with-output-to-temp-buffer "*Dates*"
9473 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9477 (defun org-agenda-bulk-marked-p ()
9478 (eq (get-char-property (point-at-bol) 'type)
9479 'org-marked-entry-overlay))
9481 (defun org-agenda-bulk-mark (&optional arg)
9482 "Mark the entry at point for future bulk action."
9484 (dotimes (i (or arg 1))
9485 (unless (org-get-at-bol 'org-agenda-diary-link)
9486 (let* ((m (org-get-at-bol 'org-hd-marker))
9488 (unless (org-agenda-bulk-marked-p)
9489 (unless m (error "Nothing to mark at point"))
9490 (push m org-agenda-bulk-marked-entries)
9491 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9492 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9493 (org-get-todo-face "TODO")
9495 (overlay-put ov 'type 'org-marked-entry-overlay))
9496 (beginning-of-line 2)
9497 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9498 (beginning-of-line 2))
9499 (message "%d entries marked for bulk action"
9500 (length org-agenda-bulk-marked-entries))))))
9502 (defun org-agenda-bulk-mark-all ()
9503 "Mark all entries for future agenda bulk action."
9505 (org-agenda-bulk-mark-regexp "."))
9507 (defun org-agenda-bulk-mark-regexp (regexp)
9508 "Mark entries matching REGEXP for future agenda bulk action."
9509 (interactive "sMark entries matching regexp: ")
9510 (let ((entries-marked 0))
9512 (goto-char (point-min))
9513 (goto-char (next-single-property-change (point) 'txt))
9514 (while (re-search-forward regexp nil t)
9515 (when (string-match regexp (get-text-property (point) 'txt))
9516 (setq entries-marked (1+ entries-marked))
9517 (call-interactively 'org-agenda-bulk-mark))))
9518 (if (not entries-marked)
9519 (message "No entry matching this regexp."))))
9521 (defun org-agenda-bulk-unmark (&optional arg)
9522 "Unmark the entry at point for future bulk action."
9525 (org-agenda-bulk-unmark-all)
9526 (cond ((org-agenda-bulk-marked-p)
9527 (org-agenda-bulk-remove-overlays
9528 (point-at-bol) (+ 2 (point-at-bol)))
9529 (setq org-agenda-bulk-marked-entries
9530 (delete (org-get-at-bol 'org-hd-marker)
9531 org-agenda-bulk-marked-entries))
9532 (beginning-of-line 2)
9533 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9534 (beginning-of-line 2))
9535 (message "%d entries left marked for bulk action"
9536 (length org-agenda-bulk-marked-entries)))
9537 (t (message "No entry to unmark here")))))
9539 (defun org-agenda-bulk-toggle ()
9540 "Toggle marking the entry at point for bulk action."
9542 (if (org-agenda-bulk-marked-p)
9543 (org-agenda-bulk-unmark)
9544 (org-agenda-bulk-mark)))
9546 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9547 "Remove the mark overlays between BEG and END in the agenda buffer.
9548 BEG and END default to the buffer limits.
9550 This only removes the overlays, it does not remove the markers
9551 from the list in `org-agenda-bulk-marked-entries'."
9554 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9555 (delete-overlay ov)))
9556 (overlays-in (or beg (point-min)) (or end (point-max)))))
9558 (defun org-agenda-bulk-unmark-all ()
9559 "Remove all marks in the agenda buffer.
9560 This will remove the markers and the overlays."
9562 (if (null org-agenda-bulk-marked-entries)
9563 (message "No entry to unmark")
9564 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9565 (setq org-agenda-bulk-marked-entries nil)
9566 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9568 (defcustom org-agenda-persistent-marks nil
9569 "Non-nil means marked items will stay marked after a bulk action.
9570 You can toggle this interactively by typing `p' when prompted for a
9576 (defun org-agenda-bulk-action (&optional arg)
9577 "Execute an remote-editing action on all marked entries.
9578 The prefix arg is passed through to the command if possible."
9580 ;; Make sure we have markers, and only valid ones
9581 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
9584 (unless (and (markerp m)
9586 (buffer-live-p (marker-buffer m))
9587 (marker-position m))
9588 (error "Marker %s for bulk command is invalid" m)))
9589 org-agenda-bulk-marked-entries)
9591 ;; Prompt for the bulk command
9592 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9593 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9594 "[S]catter [f]unction "
9595 (when org-agenda-bulk-custom-functions
9596 (concat " Custom: ["
9597 (mapconcat (lambda(f) (char-to-string (car f)))
9598 org-agenda-bulk-custom-functions "")
9601 (let* ((action (read-char-exclusive))
9602 (org-log-refile (if org-log-refile 'time nil))
9603 (entries (reverse org-agenda-bulk-marked-entries))
9604 (org-overriding-default-time
9605 (if (get-text-property (point) 'org-agenda-date-header)
9606 (org-get-cursor-date)))
9608 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9611 (let ((org-agenda-persistent-marks
9612 (not org-agenda-persistent-marks)))
9613 (org-agenda-bulk-action)
9617 (setq cmd '(org-agenda-archive)))
9620 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9622 ((member action '(?r ?w))
9623 (setq rfloc (org-refile-get-location
9625 (marker-buffer (car entries))
9626 org-refile-allow-creating-parent-nodes))
9628 (setcar (nthcdr 3 rfloc)
9629 (move-marker (make-marker) (nth 3 rfloc)
9630 (or (get-file-buffer (nth 1 rfloc))
9631 (find-buffer-visiting (nth 1 rfloc))
9632 (error "This should not happen")))))
9634 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9638 (setq state (org-icompleting-read
9640 (with-current-buffer (marker-buffer (car entries))
9641 (mapcar 'list org-todo-keywords-1))))
9642 (setq cmd `(let ((org-inhibit-blocking t)
9643 (org-inhibit-logging 'note))
9644 (org-agenda-todo ,state))))
9646 ((memq action '(?- ?+))
9647 (setq tag (org-icompleting-read
9648 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9649 (with-current-buffer (marker-buffer (car entries))
9652 (if (stringp (car x)) x)) org-tag-alist)))))
9653 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9655 ((memq action '(?s ?d))
9660 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9661 org-overriding-default-time)))
9662 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9663 (setq cmd `(eval '(,c1 arg ,time)))))
9666 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9667 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9668 (let ((days (read-number
9669 (format "Scatter tasks across how many %sdays: "
9670 (if arg "week" "")) 7)))
9672 `(let ((distance (1+ (random ,days))))
9674 (let ((dist distance)
9676 (calendar-day-of-week
9677 (calendar-gregorian-from-absolute (org-today)))))
9678 (dotimes (i (1+ dist))
9679 (while (member day-of-week org-agenda-weekend-days)
9682 (if (= day-of-week 7)
9683 (setq day-of-week 0)))
9685 (if (= day-of-week 7)
9686 (setq day-of-week 0)))))
9687 ;; silently fail when try to replan a sexp entry
9689 (let* ((date (calendar-gregorian-from-absolute
9690 (+ (org-today) distance)))
9691 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9693 (org-agenda-schedule nil time))
9696 ((assoc action org-agenda-bulk-custom-functions)
9697 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9701 (setq cmd (list (intern
9702 (org-icompleting-read "Function: "
9703 obarray 'fboundp t nil nil)))))
9705 (t (error "Invalid bulk action")))
9707 ;; Sort the markers, to make sure that parents are handled before children
9708 (setq entries (sort entries
9711 ((equal (marker-buffer a) (marker-buffer b))
9712 (< (marker-position a) (marker-position b)))
9714 (string< (buffer-name (marker-buffer a))
9715 (buffer-name (marker-buffer b))))))))
9717 ;; Now loop over all markers and apply cmd
9718 (while (setq e (pop entries))
9719 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9721 (progn (message "Skipping removed entry at %s" e)
9722 (setq cntskip (1+ cntskip)))
9724 (let (org-loop-over-headlines-in-active-region)
9726 (setq cnt (1+ cnt))))
9727 (when redo-at-end (org-agenda-redo))
9728 (unless org-agenda-persistent-marks
9729 (org-agenda-bulk-unmark-all))
9730 (message "Acted on %d entries%s%s"
9734 (format ", skipped %d (disappeared before their turn)"
9736 (if (not org-agenda-persistent-marks)
9737 "" " (kept marked)"))))))
9739 (defun org-agenda-capture (&optional with-time)
9740 "Call `org-capture' with the date at point.
9741 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9742 current HH:MM time."
9744 (if (not (eq major-mode 'org-agenda-mode))
9745 (user-error "You cannot do this outside of agenda buffers")
9746 (let ((org-overriding-default-time
9747 (org-get-cursor-date (equal with-time 1))))
9748 (call-interactively 'org-capture))))
9752 (defun org-agenda-show-the-flagging-note ()
9753 "Display the flagging note in the other window.
9754 When called a second time in direct sequence, offer to remove the FLAGGING
9755 tag and (if present) the flagging note."
9757 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9758 (win (selected-window))
9759 note heading newhead)
9761 (error "No linked entry at point"))
9762 (if (and (eq this-command last-command)
9763 (y-or-n-p "Unflag and remove any flagging note? "))
9765 (org-agenda-remove-flag hdmarker)
9766 (let ((win (get-buffer-window "*Flagging Note*")))
9767 (and win (delete-window win)))
9768 (message "Entry unflagged"))
9769 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9771 (error "No flagging note"))
9773 (org-switch-to-buffer-other-window "*Flagging Note*")
9776 (goto-char (point-min))
9777 (while (re-search-forward "\\\\n" nil t)
9778 (replace-match "\n" t t))
9779 (goto-char (point-min))
9781 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9783 (defun org-agenda-remove-flag (marker)
9784 "Remove the FLAGGED tag and any flagging note in the entry."
9786 (org-with-point-at marker
9787 (org-toggle-tag "FLAGGED" 'off)
9788 (org-entry-delete nil "THEFLAGGINGNOTE")
9789 (setq newhead (org-get-heading)))
9790 (org-agenda-change-all-lines newhead marker)
9791 (message "Entry unflagged")))
9793 (defun org-agenda-get-any-marker (&optional pos)
9794 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9795 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9797 ;;; Appointment reminders
9799 (defvar appt-time-msg-list) ; defined in appt.el
9802 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9803 "Activate appointments found in `org-agenda-files'.
9804 With a \\[universal-argument] prefix, refresh the list of
9807 If FILTER is t, interactively prompt the user for a regular
9808 expression, and filter out entries that don't match it.
9810 If FILTER is a string, use this string as a regular expression
9811 for filtering entries out.
9813 If FILTER is a function, filter out entries against which
9814 calling the function returns nil. This function takes one
9815 argument: an entry from `org-agenda-get-day-entries'.
9817 FILTER can also be an alist with the car of each cell being
9818 either 'headline or 'category. For example:
9820 '((headline \"IMPORTANT\")
9821 (category \"Work\"))
9823 will only add headlines containing IMPORTANT or headlines
9824 belonging to the \"Work\" category.
9826 ARGS are symbols indicating what kind of entries to consider.
9827 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
9828 \(i.e., deadlines and scheduled items with a hh:mm specification)
9829 and :timestamp entries. See the docstring of `org-diary' for
9830 details and examples.
9832 If an entry has a APPT_WARNTIME property, its value will be used
9833 to override `appt-message-warning-time'."
9835 (if refresh (setq appt-time-msg-list nil))
9837 (setq filter (read-from-minibuffer "Regexp filter: ")))
9838 (let* ((cnt 0) ; count added events
9839 (scope (or args '(:deadline* :scheduled* :timestamp)))
9840 (org-agenda-new-buffers nil)
9841 (org-deadline-warning-days 0)
9842 ;; Do not use `org-today' here because appt only takes
9843 ;; time and without date as argument, so it may pass wrong
9844 ;; information otherwise
9845 (today (org-date-to-gregorian
9846 (time-to-days (current-time))))
9847 (org-agenda-restrict nil)
9848 (files (org-agenda-files 'unrestricted)) entries file
9849 (org-agenda-buffer nil))
9850 ;; Get all entries which may contain an appt
9851 (org-agenda-prepare-buffers files)
9852 (while (setq file (pop files))
9856 (apply 'org-agenda-get-day-entries
9857 file today scope)))))
9858 ;; Map thru entries and find if we should filter them out
9861 (let* ((evt (org-trim
9862 (replace-regexp-in-string
9863 org-bracket-link-regexp "\\3"
9864 (or (get-text-property 1 'txt x) ""))))
9865 (cat (get-text-property 1 'org-category x))
9866 (tod (get-text-property 1 'time-of-day x))
9867 (ok (or (null filter)
9868 (and (stringp filter) (string-match filter evt))
9869 (and (functionp filter) (funcall filter x))
9871 (let ((cat-filter (cadr (assoc 'category filter)))
9872 (evt-filter (cadr (assoc 'headline filter))))
9873 (or (and (stringp cat-filter)
9874 (string-match cat-filter cat))
9875 (and (stringp evt-filter)
9876 (string-match evt-filter evt)))))))
9877 (wrn (get-text-property 1 'warntime x)))
9878 ;; FIXME: Shall we remove text-properties for the appt text?
9879 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9881 (setq tod (concat "00" (number-to-string tod))
9882 tod (when (string-match
9883 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9884 (concat (match-string 1 tod) ":"
9885 (match-string 2 tod))))
9886 (if (version< emacs-version "23.3")
9888 (appt-add tod evt wrn))
9889 (setq cnt (1+ cnt))))) entries)
9890 (org-release-buffers org-agenda-new-buffers)
9892 (message "No event to add")
9893 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9895 (defun org-agenda-todayp (date)
9896 "Does DATE mean today, when considering `org-extend-today-until'?"
9897 (let ((today (org-today))
9898 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9902 (defun org-agenda-todo-yesterday (&optional arg)
9903 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9905 (let* ((hour (third (decode-time
9906 (org-current-time))))
9907 (org-extend-today-until (1+ hour)))
9908 (org-agenda-todo arg)))
9910 (provide 'org-agenda)
9912 ;;; org-agenda.el ends here