1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2012 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 nil
)
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 temporary buffer before writing it to an export file.
164 A useful function 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 it is by 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
""
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. However,
228 <style>...</style> is required, if not present the variable will be ignored."
229 :group
'org-agenda-export
230 :group
'org-export-html
233 (defcustom org-agenda-persistent-filter nil
234 "When set, keep filters from one agenda view to the next."
238 (defgroup org-agenda-custom-commands nil
239 "Options concerning agenda views in Org-mode."
240 :tag
"Org Agenda Custom Commands"
243 (defconst org-sorting-choice
245 (const time-up
) (const time-down
)
246 (const category-keep
) (const category-up
) (const category-down
)
247 (const tag-down
) (const tag-up
)
248 (const priority-up
) (const priority-down
)
249 (const todo-state-up
) (const todo-state-down
)
250 (const effort-up
) (const effort-down
)
251 (const habit-up
) (const habit-down
)
252 (const alpha-up
) (const alpha-down
)
253 (const user-defined-up
) (const user-defined-down
))
256 ;; Keep custom values for `org-agenda-filter-preset' compatible with
257 ;; the new variable `org-agenda-tag-filter-preset'.
258 (if (fboundp 'defvaralias
)
259 (defvaralias 'org-agenda-filter-preset
'org-agenda-tag-filter-preset
)
260 (defvaralias 'org-agenda-filter
'org-agenda-tag-filter
))
262 (defconst org-agenda-custom-commands-local-options
263 `(repeat :tag
"Local settings for this command. Remember to quote values"
264 (choice :tag
"Setting"
265 (list :tag
"Heading for this block"
266 (const org-agenda-overriding-header
)
267 (string :tag
"Headline"))
268 (list :tag
"Files to be searched"
269 (const org-agenda-files
)
271 (const :format
"" quote
)
273 (list :tag
"Sorting strategy"
274 (const org-agenda-sorting-strategy
)
276 (const :format
"" quote
)
278 ,org-sorting-choice
)))
279 (list :tag
"Prefix format"
280 (const org-agenda-prefix-format
:value
" %-12:c%?-12t% s")
282 (list :tag
"Number of days in agenda"
283 (const org-agenda-span
)
284 (choice (const :tag
"Day" 'day
)
285 (const :tag
"Week" 'week
)
286 (const :tag
"Month" 'month
)
287 (const :tag
"Year" 'year
)
288 (integer :tag
"Custom")))
289 (list :tag
"Fixed starting date"
290 (const org-agenda-start-day
)
291 (string :value
"2007-11-01"))
292 (list :tag
"Start on day of week"
293 (const org-agenda-start-on-weekday
)
295 (const :tag
"Today" nil
)
296 (integer :tag
"Weekday No.")))
297 (list :tag
"Include data from diary"
298 (const org-agenda-include-diary
)
300 (list :tag
"Deadline Warning days"
301 (const org-deadline-warning-days
)
303 (list :tag
"Category filter preset"
304 (const org-agenda-category-filter-preset
)
306 (const :format
"" quote
)
308 (string :tag
"+category or -category"))))
309 (list :tag
"Tags filter preset"
310 (const org-agenda-tag-filter-preset
)
312 (const :format
"" quote
)
314 (string :tag
"+tag or -tag"))))
315 (list :tag
"Set daily/weekly entry types"
316 (const org-agenda-entry-types
)
318 (const :format
"" quote
)
319 (set :greedy t
:value
(:deadline
:scheduled
:timestamp
:sexp
)
324 (list :tag
"Standard skipping condition"
325 :value
(org-agenda-skip-function '(org-agenda-skip-entry-if))
326 (const org-agenda-skip-function
)
328 (const :format
"" quote
)
331 :tag
"Skipping range"
332 (const :tag
"Skip entry" org-agenda-skip-entry-if
)
333 (const :tag
"Skip subtree" org-agenda-skip-subtree-if
))
334 (repeat :inline t
:tag
"Conditions for skipping"
336 :tag
"Condition type"
337 (list :tag
"Regexp matches" :inline t
(const :format
"" 'regexp
) (regexp))
338 (list :tag
"Regexp does not match" :inline t
(const :format
"" 'notregexp
) (regexp))
339 (list :tag
"TODO state is" :inline t
342 (const :tag
"any not-done state" 'todo
)
343 (const :tag
"any done state" 'done
)
344 (const :tag
"any state" 'any
)
345 (list :tag
"Keyword list"
346 (const :format
"" quote
)
347 (repeat (string :tag
"Keyword")))))
348 (list :tag
"TODO state is not" :inline t
351 (const :tag
"any not-done state" 'todo
)
352 (const :tag
"any done state" 'done
)
353 (const :tag
"any state" 'any
)
354 (list :tag
"Keyword list"
355 (const :format
"" quote
)
356 (repeat (string :tag
"Keyword")))))
357 (const :tag
"scheduled" 'scheduled
)
358 (const :tag
"not scheduled" 'notscheduled
)
359 (const :tag
"deadline" 'deadline
)
360 (const :tag
"no deadline" 'notdeadline
)
361 (const :tag
"timestamp" 'timestamp
)
362 (const :tag
"no timestamp" 'nottimestamp
))))))
363 (list :tag
"Non-standard skipping condition"
364 :value
(org-agenda-skip-function)
365 (const org-agenda-skip-function
)
366 (sexp :tag
"Function or form (quoted!)"))
367 (list :tag
"Any variable"
368 (variable :tag
"Variable")
369 (sexp :tag
"Value (sexp)"))))
370 "Selection of examples for agenda command settings.
371 This will be spliced into the custom type of
372 `org-agenda-custom-commands'.")
375 (defcustom org-agenda-custom-commands
'(("n" "Agenda and all TODO's"
376 ((agenda "") (alltodo))))
377 "Custom commands for the agenda.
378 These commands will be offered on the splash screen displayed by the
379 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
381 (key desc type match settings files)
383 key The key (one or more characters as a string) to be associated
385 desc A description of the command, when omitted or nil, a default
386 description is built using MATCH.
387 type The command type, any of the following symbols:
388 agenda The daily/weekly agenda.
389 todo Entries with a specific TODO keyword, in all agenda files.
390 search Entries containing search words entry or headline.
391 tags Tags/Property/TODO match in all agenda files.
392 tags-todo Tags/P/T match in all agenda files, TODO entries only.
393 todo-tree Sparse tree of specific TODO keyword in *current* file.
394 tags-tree Sparse tree with all tags matches in *current* file.
395 occur-tree Occur sparse tree for *current* file.
396 ... A user-defined function.
397 match What to search for:
398 - a single keyword for TODO keyword searches
399 - a tags match expression for tags searches
400 - a word search expression for text searches.
401 - a regular expression for occur searches
402 For all other commands, this should be the empty string.
403 settings A list of option settings, similar to that in a let form, so like
404 this: ((opt1 val1) (opt2 val2) ...). The values will be
405 evaluated at the moment of execution, so quote them when needed.
406 files A list of files file to write the produced agenda buffer to
407 with the command `org-store-agenda-views'.
408 If a file name ends in \".html\", an HTML version of the buffer
409 is written out. If it ends in \".ps\", a postscript version is
410 produced. Otherwise, only the plain text is written to the file.
412 You can also define a set of commands, to create a composite agenda buffer.
413 In this case, an entry looks like this:
415 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
419 desc A description string to be displayed in the dispatcher menu.
420 cmd An agenda command, similar to the above. However, tree commands
421 are not allowed, but instead you can get agenda and global todo list.
422 So valid commands for a set are:
423 (agenda \"\" settings)
424 (alltodo \"\" settings)
425 (stuck \"\" settings)
426 (todo \"match\" settings files)
427 (search \"match\" settings files)
428 (tags \"match\" settings files)
429 (tags-todo \"match\" settings files)
431 Each command can carry a list of options, and another set of options can be
432 given for the whole set of commands. Individual command options take
433 precedence over the general options.
435 When using several characters as key to a command, the first characters
436 are prefix commands. For the dispatcher to display useful information, you
437 should provide a description for the prefix, like
439 (setq org-agenda-custom-commands
440 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
441 (\"hl\" tags \"+HOME+Lisa\")
442 (\"hp\" tags \"+HOME+Peter\")
443 (\"hk\" tags \"+HOME+Kim\")))"
444 :group
'org-agenda-custom-commands
446 (choice :value
("x" "Describe command here" tags
"" nil
)
447 (list :tag
"Single command"
448 (string :tag
"Access Key(s) ")
449 (option (string :tag
"Description"))
451 (const :tag
"Agenda" agenda
)
452 (const :tag
"TODO list" alltodo
)
453 (const :tag
"Search words" search
)
454 (const :tag
"Stuck projects" stuck
)
455 (const :tag
"Tags/Property match (all agenda files)" tags
)
456 (const :tag
"Tags/Property match of TODO entries (all agenda files)" tags-todo
)
457 (const :tag
"TODO keyword search (all agenda files)" todo
)
458 (const :tag
"Tags sparse tree (current buffer)" tags-tree
)
459 (const :tag
"TODO keyword tree (current buffer)" todo-tree
)
460 (const :tag
"Occur tree (current buffer)" occur-tree
)
461 (sexp :tag
"Other, user-defined function"))
462 (string :tag
"Match (only for some commands)")
463 ,org-agenda-custom-commands-local-options
464 (option (repeat :tag
"Export" (file :tag
"Export to"))))
465 (list :tag
"Command series, all agenda files"
466 (string :tag
"Access Key(s)")
467 (string :tag
"Description ")
468 (repeat :tag
"Component"
471 (const :format
"" agenda
)
472 (const :tag
"" :format
"" "")
473 ,org-agenda-custom-commands-local-options
)
474 (list :tag
"TODO list (all keywords)"
475 (const :format
"" alltodo
)
476 (const :tag
"" :format
"" "")
477 ,org-agenda-custom-commands-local-options
)
478 (list :tag
"Search words"
479 (const :format
"" search
)
480 (string :tag
"Match")
481 ,org-agenda-custom-commands-local-options
)
482 (list :tag
"Stuck projects"
483 (const :format
"" stuck
)
484 (const :tag
"" :format
"" "")
485 ,org-agenda-custom-commands-local-options
)
486 (list :tag
"Tags search"
487 (const :format
"" tags
)
488 (string :tag
"Match")
489 ,org-agenda-custom-commands-local-options
)
490 (list :tag
"Tags search, TODO entries only"
491 (const :format
"" tags-todo
)
492 (string :tag
"Match")
493 ,org-agenda-custom-commands-local-options
)
494 (list :tag
"TODO keyword search"
495 (const :format
"" todo
)
496 (string :tag
"Match")
497 ,org-agenda-custom-commands-local-options
)
498 (list :tag
"Other, user-defined function"
499 (symbol :tag
"function")
500 (string :tag
"Match")
501 ,org-agenda-custom-commands-local-options
)))
503 (repeat :tag
"Settings for entire command set"
504 (list (variable :tag
"Any variable")
505 (sexp :tag
"Value")))
506 (option (repeat :tag
"Export" (file :tag
"Export to"))))
507 (cons :tag
"Prefix key documentation"
508 (string :tag
"Access Key(s)")
509 (string :tag
"Description ")))))
511 (defcustom org-agenda-query-register ?o
512 "The register holding the current query string.
513 The purpose of this is that if you construct a query string interactively,
514 you can then use it to define a custom command."
515 :group
'org-agenda-custom-commands
518 (defcustom org-stuck-projects
519 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil
"")
520 "How to identify stuck projects.
521 This is a list of four items:
522 1. A tags/todo/property matcher string that is used to identify a project.
523 See the manual for a description of tag and property searches.
524 The entire tree below a headline matched by this is considered one project.
525 2. A list of TODO keywords identifying non-stuck projects.
526 If the project subtree contains any headline with one of these todo
527 keywords, the project is considered to be not stuck. If you specify
528 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
529 3. A list of tags identifying non-stuck projects.
530 If the project subtree contains any headline with one of these tags,
531 the project is considered to be not stuck. If you specify \"*\" as
532 a tag, any tag will mark the project unstuck. Note that this is about
533 the explicit presence of a tag somewhere in the subtree, inherited
534 tags to not count here. If inherited tags make a project not stuck,
535 use \"-TAG\" in the tags part of the matcher under (1.) above.
536 4. An arbitrary regular expression matching non-stuck projects.
538 If the project turns out to be not stuck, search continues also in the
539 subtree to see if any of the subtasks have project status.
541 See also the variable `org-tags-match-list-sublevels' which applies
542 to projects matched by this search as well.
544 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
545 or `C-c a #' to produce the list."
546 :group
'org-agenda-custom-commands
548 (string :tag
"Tags/TODO match to identify a project")
549 (repeat :tag
"Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
550 (repeat :tag
"Projects are *not* stuck if they have an entry with TAG being any of" (string))
551 (regexp :tag
"Projects are *not* stuck if this regexp matches inside the subtree")))
553 (defcustom org-agenda-filter-effort-default-operator
"<"
554 "The default operator for effort estimate filtering.
555 If you select an effort estimate limit without first pressing an operator,
556 this one will be used."
557 :group
'org-agenda-custom-commands
558 :type
'(choice (const :tag
"less or equal" "<")
559 (const :tag
"greater or equal"">")
560 (const :tag
"equal" "=")))
562 (defgroup org-agenda-skip nil
563 "Options concerning skipping parts of agenda files."
564 :tag
"Org Agenda Skip"
567 (defcustom org-agenda-skip-function-global nil
568 "Function to be called at each match during agenda construction.
569 If this function returns nil, the current match should not be skipped.
570 If the function decided to skip an agenda match, is must return the
571 buffer position from which the search should be continued.
572 This may also be a Lisp form, which will be evaluated.
574 This variable will be applied to every agenda match, including
575 tags/property searches and TODO lists. So try to make the test function
576 do its checking as efficiently as possible. To implement a skipping
577 condition just for specific agenda commands, use the variable
578 `org-agenda-skip-function' which can be set in the options section
579 of custom agenda commands."
580 :group
'org-agenda-skip
583 (defgroup org-agenda-daily
/weekly nil
584 "Options concerning the daily/weekly agenda."
585 :tag
"Org Agenda Daily/Weekly"
587 (defgroup org-agenda-todo-list nil
588 "Options concerning the global todo list agenda view."
589 :tag
"Org Agenda Todo List"
591 (defgroup org-agenda-match-view nil
592 "Options concerning the general tags/property/todo match agenda view."
593 :tag
"Org Agenda Match View"
595 (defgroup org-agenda-search-view nil
596 "Options concerning the general tags/property/todo match agenda view."
597 :tag
"Org Agenda Match View"
600 (defvar org-agenda-archives-mode nil
601 "Non-nil means the agenda will include archived items.
602 If this is the symbol `trees', trees in the selected agenda scope
603 that are marked with the ARCHIVE tag will be included anyway. When this is
604 t, also all archive files associated with the current selection of agenda
605 files will be included.")
607 (defcustom org-agenda-skip-comment-trees t
608 "Non-nil means skip trees that start with the COMMENT keyword.
609 When nil, these trees are also scanned by agenda commands."
610 :group
'org-agenda-skip
613 (defcustom org-agenda-todo-list-sublevels t
614 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
615 When nil, the sublevels of a TODO entry are not checked, resulting in
616 potentially much shorter TODO lists."
617 :group
'org-agenda-skip
618 :group
'org-agenda-todo-list
621 (defcustom org-agenda-todo-ignore-with-date nil
622 "Non-nil means don't show entries with a date in the global todo list.
623 You can use this if you prefer to mark mere appointments with a TODO keyword,
624 but don't want them to show up in the TODO list.
625 When this is set, it also covers deadlines and scheduled items, the settings
626 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
628 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
629 :group
'org-agenda-skip
630 :group
'org-agenda-todo-list
633 (defcustom org-agenda-todo-ignore-timestamp nil
634 "Non-nil means don't show entries with a timestamp.
635 This applies when creating the global todo list.
638 past Don't show entries for today or in the past.
640 future Don't show entries with a timestamp in the future.
641 The idea behind this is that if it has a future
642 timestamp, you don't want to think about it until the
645 all Don't show any entries with a timestamp in the global todo list.
646 The idea behind this is that by setting a timestamp, you
647 have already \"taken care\" of this item.
649 This variable can also have an integer as a value. If positive (N),
650 todos with a timestamp N or more days in the future will be ignored. If
651 negative (-N), todos with a timestamp N or more days in the past will be
652 ignored. If 0, todos with a timestamp either today or in the future will
653 be ignored. For example, a value of -1 will exclude todos with a
654 timestamp in the past (yesterday or earlier), while a value of 7 will
655 exclude todos with a timestamp a week or more in the future.
657 See also `org-agenda-todo-ignore-with-date'.
658 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
659 to make his option also apply to the tags-todo list."
660 :group
'org-agenda-skip
661 :group
'org-agenda-todo-list
664 (const :tag
"Ignore future timestamp todos" future
)
665 (const :tag
"Ignore past or present timestamp todos" past
)
666 (const :tag
"Ignore all timestamp todos" all
)
667 (const :tag
"Show timestamp todos" nil
)
668 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
670 (defcustom org-agenda-todo-ignore-scheduled nil
671 "Non-nil means, ignore some scheduled TODO items when making TODO list.
672 This applies when creating the global todo list.
675 past Don't show entries scheduled today or in the past.
677 future Don't show entries scheduled in the future.
678 The idea behind this is that by scheduling it, you don't want to
679 think about it until the scheduled date.
681 all Don't show any scheduled entries in the global todo list.
682 The idea behind this is that by scheduling it, you have already
683 \"taken care\" of this item.
685 t Same as `all', for backward compatibility.
687 This variable can also have an integer as a value. See
688 `org-agenda-todo-ignore-timestamp' for more details.
690 See also `org-agenda-todo-ignore-with-date'.
691 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
692 to make his option also apply to the tags-todo list."
693 :group
'org-agenda-skip
694 :group
'org-agenda-todo-list
696 (const :tag
"Ignore future-scheduled todos" future
)
697 (const :tag
"Ignore past- or present-scheduled todos" past
)
698 (const :tag
"Ignore all scheduled todos" all
)
699 (const :tag
"Ignore all scheduled todos (compatibility)" t
)
700 (const :tag
"Show scheduled todos" nil
)
701 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
703 (defcustom org-agenda-todo-ignore-deadlines nil
704 "Non-nil means ignore some deadlined TODO items when making TODO list.
705 There are different motivations for using different values, please think
706 carefully when configuring this variable.
708 This applies when creating the global todo list.
711 near Don't show near deadline entries. A deadline is near when it is
712 closer than `org-deadline-warning-days' days. The idea behind this
713 is that such items will appear in the agenda anyway.
715 far Don't show TODO entries where a deadline has been defined, but
716 the deadline is not near. This is useful if you don't want to
717 use the todo list to figure out what to do now.
719 past Don't show entries with a deadline timestamp for today or in the past.
721 future Don't show entries with a deadline timestamp in the future, not even
722 when they become `near' ones. Use it with caution.
724 all Ignore all TODO entries that do have a deadline.
726 t Same as `near', for backward compatibility.
728 This variable can also have an integer as a value. See
729 `org-agenda-todo-ignore-timestamp' for more details.
731 See also `org-agenda-todo-ignore-with-date'.
732 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
733 to make his option also apply to the tags-todo list."
734 :group
'org-agenda-skip
735 :group
'org-agenda-todo-list
737 (const :tag
"Ignore near deadlines" near
)
738 (const :tag
"Ignore near deadlines (compatibility)" t
)
739 (const :tag
"Ignore far deadlines" far
)
740 (const :tag
"Ignore all TODOs with a deadlines" all
)
741 (const :tag
"Show all TODOs, even if they have a deadline" nil
)
742 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
744 (defcustom org-agenda-tags-todo-honor-ignore-options nil
745 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
747 `org-agenda-todo-ignore-with-date',
748 `org-agenda-todo-ignore-timestamp',
749 `org-agenda-todo-ignore-scheduled',
750 `org-agenda-todo-ignore-deadlines'
751 make the global TODO list skip entries that have time stamps of certain
752 kinds. If this option is set, the same options will also apply for the
753 tags-todo search, which is the general tags/property matcher
754 restricted to unfinished TODO entries only."
755 :group
'org-agenda-skip
756 :group
'org-agenda-todo-list
757 :group
'org-agenda-match-view
760 (defcustom org-agenda-skip-scheduled-if-done nil
761 "Non-nil means don't show scheduled items in agenda when they are done.
762 This is relevant for the daily/weekly agenda, not for the TODO list. And
763 it applies only to the actual date of the scheduling. Warnings about
764 an item with a past scheduling dates are always turned off when the item
766 :group
'org-agenda-skip
767 :group
'org-agenda-daily
/weekly
770 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
771 "Non-nil means skip scheduling line if same entry shows because of deadline.
772 In the agenda of today, an entry can show up multiple times because
773 it is both scheduled and has a nearby deadline, and maybe a plain time
775 When this variable is t, then only the deadline is shown and the fact that
776 the entry is scheduled today or was scheduled previously is not shown.
777 When this variable is nil, the entry will be shown several times. When
778 the variable is the symbol `not-today', then skip scheduled previously,
779 but not scheduled today."
780 :group
'org-agenda-skip
781 :group
'org-agenda-daily
/weekly
783 (const :tag
"Never" nil
)
784 (const :tag
"Always" t
)
785 (const :tag
"Not when scheduled today" not-today
)))
787 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
788 "Non-nil means skip timestamp line if same entry shows because of deadline.
789 In the agenda of today, an entry can show up multiple times
790 because it has both a plain timestamp and has a nearby deadline.
791 When this variable is t, then only the deadline is shown and the
792 fact that the entry has a timestamp for or including today is not
793 shown. When this variable is nil, the entry will be shown
795 :group
'org-agenda-skip
796 :group
'org-agenda-daily
/weekly
799 (const :tag
"Never" nil
)
800 (const :tag
"Always" t
)))
802 (defcustom org-agenda-skip-deadline-if-done nil
803 "Non-nil means don't show deadlines when the corresponding item is done.
804 When nil, the deadline is still shown and should give you a happy feeling.
805 This is relevant for the daily/weekly agenda. And it applied only to the
806 actually date of the deadline. Warnings about approaching and past-due
807 deadlines are always turned off when the item is DONE."
808 :group
'org-agenda-skip
809 :group
'org-agenda-daily
/weekly
812 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
813 "Non-nil means skip deadline prewarning when entry is also scheduled.
814 This will apply on all days where a prewarning for the deadline would
815 be shown, but not at the day when the entry is actually due. On that day,
816 the deadline will be shown anyway.
817 This variable may be set to nil, t, or a number which will then give
818 the number of days before the actual deadline when the prewarnings
820 This can be used in a workflow where the first showing of the deadline will
821 trigger you to schedule it, and then you don't want to be reminded of it
822 because you will take care of it on the day when scheduled."
823 :group
'org-agenda-skip
824 :group
'org-agenda-daily
/weekly
827 (const :tag
"Alwas show prewarning" nil
)
828 (const :tag
"Remove prewarning if entry is scheduled" t
)
829 (integer :tag
"Restart prewarning N days before deadline")))
831 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
832 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
833 When non-nil, after the search for timestamps has matched once in an
834 entry, the rest of the entry will not be searched."
835 :group
'org-agenda-skip
838 (defcustom org-agenda-skip-timestamp-if-done nil
839 "Non-nil means don't select item by timestamp or -range if it is DONE."
840 :group
'org-agenda-skip
841 :group
'org-agenda-daily
/weekly
844 (defcustom org-agenda-dim-blocked-tasks t
845 "Non-nil means dim blocked tasks in the agenda display.
846 This causes some overhead during agenda construction, but if you
847 have turned on `org-enforce-todo-dependencies',
848 `org-enforce-todo-checkbox-dependencies', or any other blocking
849 mechanism, this will create useful feedback in the agenda.
851 Instead of t, this variable can also have the value `invisible'.
852 Then blocked tasks will be invisible and only become visible when
853 they become unblocked. An exemption to this behavior is when a task is
854 blocked because of unchecked checkboxes below it. Since checkboxes do
855 not show up in the agenda views, making this task invisible you remove any
856 trace from agenda views that there is something to do. Therefore, a task
857 that is blocked because of checkboxes will never be made invisible, it
858 will only be dimmed."
859 :group
'org-agenda-daily
/weekly
860 :group
'org-agenda-todo-list
862 (const :tag
"Do not dim" nil
)
863 (const :tag
"Dim to a gray face" t
)
864 (const :tag
"Make invisible" invisible
)))
866 (defcustom org-timeline-show-empty-dates
3
867 "Non-nil means `org-timeline' also shows dates without an entry.
868 When nil, only the days which actually have entries are shown.
869 When t, all days between the first and the last date are shown.
870 When an integer, show also empty dates, but if there is a gap of more than
871 N days, just insert a special line indicating the size of the gap."
872 :group
'org-agenda-skip
874 (const :tag
"None" nil
)
876 (integer :tag
"at most")))
878 (defgroup org-agenda-startup nil
879 "Options concerning initial settings in the Agenda in Org Mode."
880 :tag
"Org Agenda Startup"
883 (defcustom org-agenda-menu-show-matcher t
884 "Non-nil means show the match string in the agenda dispatcher menu.
885 When nil, the matcher string is not shown, but is put into the help-echo
886 property so than moving the mouse over the command shows it.
887 Setting it to nil is good if matcher strings are very long and/or if
888 you want to use two-columns display (see `org-agenda-menu-two-columns')."
893 (make-obsolete-variable 'org-agenda-menu-two-column
'org-agenda-menu-two-columns
"24.3")
895 (defcustom org-agenda-menu-two-columns nil
896 "Non-nil means, use two columns to show custom commands in the dispatcher.
897 If you use this, you probably want to set `org-agenda-menu-show-matcher'
903 (make-obsolete-variable 'org-finalize-agenda-hook
'org-agenda-finalize-hook
"24.3")
904 (defcustom org-agenda-finalize-hook nil
905 "Hook run just before displaying an agenda buffer."
906 :group
'org-agenda-startup
909 (defcustom org-agenda-mouse-1-follows-link nil
910 "Non-nil means mouse-1 on a link will follow the link in the agenda.
911 A longer mouse click will still set point. Does not work on XEmacs.
912 Needs to be set before org.el is loaded."
913 :group
'org-agenda-startup
916 (defcustom org-agenda-start-with-follow-mode nil
917 "The initial value of follow mode in a newly created agenda window."
918 :group
'org-agenda-startup
921 (defcustom org-agenda-follow-indirect nil
922 "Non-nil means `org-agenda-follow-mode' displays only the
923 current item's tree, in an indirect buffer."
928 (defcustom org-agenda-show-outline-path t
929 "Non-nil means show outline path in echo area after line motion."
930 :group
'org-agenda-startup
933 (defcustom org-agenda-start-with-entry-text-mode nil
934 "The initial value of entry-text-mode in a newly created agenda window."
935 :group
'org-agenda-startup
938 (defcustom org-agenda-entry-text-maxlines
5
939 "Number of text lines to be added when `E' is pressed in the agenda.
941 Note that this variable only used during agenda display. Add add entry text
942 when exporting the agenda, configure the variable
943 `org-agenda-add-entry-ext-maxlines'."
947 (defcustom org-agenda-entry-text-exclude-regexps nil
948 "List of regular expressions to clean up entry text.
949 The complete matches of all regular expressions in this list will be
950 removed from entry text before it is shown in the agenda."
952 :type
'(repeat (regexp)))
954 (defvar org-agenda-entry-text-cleanup-hook nil
955 "Hook that is run after basic cleanup of entry text to be shown in agenda.
956 This cleanup is done in a temporary buffer, so the function may inspect and
957 change the entire buffer.
958 Some default stuff like drawers and scheduling/deadline dates will already
959 have been removed when this is called, as will any matches for regular
960 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
962 (defvar org-agenda-include-inactive-timestamps nil
963 "Non-nil means include inactive time stamps in agenda and timeline.
964 Dynamically scoped.")
966 (defgroup org-agenda-windows nil
967 "Options concerning the windows used by the Agenda in Org Mode."
968 :tag
"Org Agenda Windows"
971 (defcustom org-agenda-window-setup
'reorganize-frame
972 "How the agenda buffer should be displayed.
973 Possible values for this option are:
975 current-window Show agenda in the current window, keeping all other windows.
976 other-window Use `switch-to-buffer-other-window' to display agenda.
977 reorganize-frame Show only two windows on the current frame, the current
978 window and the agenda.
979 other-frame Use `switch-to-buffer-other-frame' to display agenda.
980 Also, when exiting the agenda, kill that frame.
981 See also the variable `org-agenda-restore-windows-after-quit'."
982 :group
'org-agenda-windows
984 (const current-window
)
987 (const reorganize-frame
)))
989 (defcustom org-agenda-window-frame-fractions
'(0.5 .
0.75)
990 "The min and max height of the agenda window as a fraction of frame height.
991 The value of the variable is a cons cell with two numbers between 0 and 1.
992 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
993 :group
'org-agenda-windows
994 :type
'(cons (number :tag
"Minimum") (number :tag
"Maximum")))
996 (defcustom org-agenda-restore-windows-after-quit nil
997 "Non-nil means restore window configuration upon exiting agenda.
998 Before the window configuration is changed for displaying the agenda,
999 the current status is recorded. When the agenda is exited with
1000 `q' or `x' and this option is set, the old state is restored. If
1001 `org-agenda-window-setup' is `other-frame', the value of this
1002 option will be ignored."
1003 :group
'org-agenda-windows
1006 (defcustom org-agenda-ndays nil
1007 "Number of days to include in overview display.
1009 Obsolete, see `org-agenda-span'."
1010 :group
'org-agenda-daily
/weekly
1013 (make-obsolete-variable 'org-agenda-ndays
'org-agenda-span
"24.1")
1015 (defcustom org-agenda-span
'week
1016 "Number of days to include in overview display.
1017 Can be day, week, month, year, or any number of days.
1018 Custom commands can set this variable in the options section."
1019 :group
'org-agenda-daily
/weekly
1020 :type
'(choice (const :tag
"Day" day
)
1021 (const :tag
"Week" week
)
1022 (const :tag
"Month" month
)
1023 (const :tag
"Year" year
)
1024 (integer :tag
"Custom")))
1026 (defcustom org-agenda-start-on-weekday
1
1027 "Non-nil means start the overview always on the specified weekday.
1028 0 denotes Sunday, 1 denotes Monday etc.
1029 When nil, always start on the current day.
1030 Custom commands can set this variable in the options section."
1031 :group
'org-agenda-daily
/weekly
1032 :type
'(choice (const :tag
"Today" nil
)
1033 (integer :tag
"Weekday No.")))
1035 (defcustom org-agenda-show-all-dates t
1036 "Non-nil means `org-agenda' shows every day in the selected range.
1037 When nil, only the days which actually have entries are shown."
1038 :group
'org-agenda-daily
/weekly
1041 (defcustom org-agenda-format-date
'org-agenda-format-date-aligned
1042 "Format string for displaying dates in the agenda.
1043 Used by the daily/weekly agenda and by the timeline. This should be
1044 a format string understood by `format-time-string', or a function returning
1045 the formatted date as a string. The function must take a single argument,
1046 a calendar-style date list like (month day year)."
1047 :group
'org-agenda-daily
/weekly
1049 (string :tag
"Format string")
1050 (function :tag
"Function")))
1052 (defun org-agenda-format-date-aligned (date)
1053 "Format a date string for display in the daily/weekly agenda, or timeline.
1054 This function makes sure that dates are aligned for easy reading."
1056 (let* ((dayname (calendar-day-name date
))
1058 (day-of-week (calendar-day-of-week date
))
1060 (monthname (calendar-month-name month
))
1062 (iso-week (org-days-to-iso-week
1063 (calendar-absolute-from-gregorian date
)))
1064 (weekyear (cond ((and (= month
1) (>= iso-week
52))
1066 ((and (= month
12) (<= iso-week
1))
1069 (weekstring (if (= day-of-week
1)
1070 (format " W%02d" iso-week
)
1072 (format "%-10s %2d %s %4d%s"
1073 dayname day monthname year weekstring
)))
1075 (defcustom org-agenda-time-leading-zero nil
1076 "Non-nil means use leading zero for military times in agenda.
1077 For example, 9:30am would become 09:30 rather than 9:30."
1078 :group
'org-agenda-daily
/weekly
1082 (defcustom org-agenda-timegrid-use-ampm nil
1083 "When set, show AM/PM style timestamps on the timegrid."
1088 (defun org-agenda-time-of-day-to-ampm (time)
1089 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1090 (let* ((hour-number (string-to-number (substring time
0 -
3)))
1091 (minute (substring time -
2))
1094 ((equal hour-number
12)
1098 (setq hour-number
(- hour-number
12))))
1100 (if org-agenda-time-leading-zero
1101 (format "%02d" hour-number
)
1102 (format "%02s" (number-to-string hour-number
)))
1105 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1106 "Conditionally convert TIME to AM/PM format
1107 based on `org-agenda-timegrid-use-ampm'"
1108 (if org-agenda-timegrid-use-ampm
1109 (org-agenda-time-of-day-to-ampm time
)
1112 (defcustom org-agenda-weekend-days
'(6 0)
1113 "Which days are weekend?
1114 These days get the special face `org-agenda-date-weekend' in the agenda
1115 and timeline buffers."
1116 :group
'org-agenda-daily
/weekly
1117 :type
'(set :greedy t
1118 (const :tag
"Monday" 1)
1119 (const :tag
"Tuesday" 2)
1120 (const :tag
"Wednesday" 3)
1121 (const :tag
"Thursday" 4)
1122 (const :tag
"Friday" 5)
1123 (const :tag
"Saturday" 6)
1124 (const :tag
"Sunday" 0)))
1126 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1127 "Non-nil means jump to today when moving a past date forward in time.
1128 When using S-right in the agenda to move a a date forward, and the date
1129 stamp currently points to the past, the first key press will move it
1130 to today. WHen nil, just move one day forward even if the date stays
1132 :group
'org-agenda-daily
/weekly
1136 (defcustom org-agenda-include-diary nil
1137 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1138 Custom commands can set this variable in the options section."
1139 :group
'org-agenda-daily
/weekly
1142 (defcustom org-agenda-include-deadlines t
1143 "If non-nil, include entries within their deadline warning period.
1144 Custom commands can set this variable in the options section."
1145 :group
'org-agenda-daily
/weekly
1149 (defcustom org-agenda-repeating-timestamp-show-all t
1150 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1151 When set to a list of strings, only show occurrences of repeating
1152 stamps for these TODO keywords. When nil, only one occurrence is
1153 shown, either today or the nearest into the future."
1154 :group
'org-agenda-daily
/weekly
1156 (const :tag
"Show repeating stamps" t
)
1157 (repeat :tag
"Show repeating stamps for these TODO keywords"
1158 (string :tag
"TODO Keyword"))
1159 (const :tag
"Don't show repeating stamps" nil
)))
1161 (defcustom org-scheduled-past-days
10000
1162 "No. of days to continue listing scheduled items that are not marked DONE.
1163 When an item is scheduled on a date, it shows up in the agenda on this
1164 day and will be listed until it is marked done for the number of days
1166 :group
'org-agenda-daily
/weekly
1169 (defcustom org-agenda-log-mode-items
'(closed clock
)
1170 "List of items that should be shown in agenda log mode.
1171 This list may contain the following symbols:
1173 closed Show entries that have been closed on that day.
1174 clock Show entries that have received clocked time on that day.
1175 state Show all logged state changes.
1176 Note that instead of changing this variable, you can also press `C-u l' in
1177 the agenda to display all available LOG items temporarily."
1178 :group
'org-agenda-daily
/weekly
1179 :type
'(set :greedy t
(const closed
) (const clock
) (const state
)))
1181 (defcustom org-agenda-clock-consistency-checks
1182 '(:max-duration
"10:00" :min-duration
0 :max-gap
"0:05"
1183 :gap-ok-around
("4:00")
1184 :default-face
((:background
"DarkRed") (:foreground
"white"))
1185 :overlap-face nil
:gap-face nil
:no-end-time-face nil
1186 :long-face nil
:short-face nil
)
1187 "This is a property list, with the following keys:
1189 :max-duration Mark clocking chunks that are longer than this time.
1190 This is a time string like \"HH:MM\", or the number
1191 of minutes as an integer.
1193 :min-duration Mark clocking chunks that are shorter that this.
1194 This is a time string like \"HH:MM\", or the number
1195 of minutes as an integer.
1197 :max-gap Mark gaps between clocking chunks that are longer than
1198 this duration. A number of minutes, or a string
1201 :gap-ok-around List of times during the day which are usually not working
1202 times. When a gap is detected, but the gap contains any
1203 of these times, the gap is *not* reported. For example,
1204 if this is (\"4:00\" \"13:00\") then gaps that contain
1205 4:00 in the morning (i.e. the night) and 13:00
1206 (i.e. a typical lunch time) do not cause a warning.
1207 You should have at least one time during the night in this
1208 list, or otherwise the first task each morning will trigger
1209 a warning because it follows a long gap.
1211 Furthermore, the following properties can be used to define faces for
1214 :default-face the default face, if the specific face is undefined
1215 :overlap-face face for overlapping clocks
1216 :gap-face face for gaps between clocks
1217 :no-end-time-face face for incomplete clocks
1218 :long-face face for clock intervals that are too long
1219 :short-face face for clock intervals that are too short"
1220 :group
'org-agenda-daily
/weekly
1225 (defcustom org-agenda-log-mode-add-notes t
1226 "Non-nil means add first line of notes to log entries in agenda views.
1227 If a log item like a state change or a clock entry is associated with
1228 notes, the first line of these notes will be added to the entry in the
1230 :group
'org-agenda-daily
/weekly
1233 (defcustom org-agenda-start-with-log-mode nil
1234 "The initial value of log-mode in a newly created agenda window.
1235 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1236 explanations on the possible values."
1237 :group
'org-agenda-startup
1238 :group
'org-agenda-daily
/weekly
1239 :type
'(choice (const :tag
"Don't show log items" nil
)
1240 (const :tag
"Show only log items" 'only
)
1241 (const :tag
"Show all possible log items" 'clockcheck
)
1242 (repeat :tag
"Choose among possible values for `org-agenda-log-mode-items'"
1243 (choice (const :tag
"Show closed log items" 'closed
)
1244 (const :tag
"Show clocked log items" 'clock
)
1245 (const :tag
"Show all logged state changes" 'state
)))))
1247 (defcustom org-agenda-start-with-clockreport-mode nil
1248 "The initial value of clockreport-mode in a newly created agenda window."
1249 :group
'org-agenda-startup
1250 :group
'org-agenda-daily
/weekly
1253 (defcustom org-agenda-clockreport-parameter-plist
'(:link t
:maxlevel
2)
1254 "Property list with parameters for the clocktable in clockreport mode.
1255 This is the display mode that shows a clock table in the daily/weekly
1256 agenda, the properties for this dynamic block can be set here.
1257 The usual clocktable parameters are allowed here, but you cannot set
1258 the properties :name, :tstart, :tend, :block, and :scope - these will
1259 be overwritten to make sure the content accurately reflects the
1260 current display in the agenda."
1261 :group
'org-agenda-daily
/weekly
1264 (defcustom org-agenda-search-view-always-boolean nil
1265 "Non-nil means the search string is interpreted as individual parts.
1267 The search string for search view can either be interpreted as a phrase,
1268 or as a list of snippets that define a boolean search for a number of
1271 When this is non-nil, the string will be split on whitespace, and each
1272 snippet will be searched individually, and all must match in order to
1273 select an entry. A snippet is then a single string of non-white
1274 characters, or a string in double quotes, or a regexp in {} braces.
1275 If a snippet is preceded by \"-\", the snippet must *not* match.
1276 \"+\" is syntactic sugar for positive selection. Each snippet may
1277 be found as a full word or a partial word, but see the variable
1278 `org-agenda-search-view-force-full-words'.
1280 When this is nil, search will look for the entire search phrase as one,
1281 with each space character matching any amount of whitespace, including
1284 Even when this is nil, you can still switch to Boolean search dynamically
1285 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1286 is a regexp marked with braces like \"{abc}\", this will also switch to
1288 :group
'org-agenda-search-view
1292 (if (fboundp 'defvaralias
)
1293 (defvaralias 'org-agenda-search-view-search-words-only
1294 'org-agenda-search-view-always-boolean
))
1296 (defcustom org-agenda-search-view-force-full-words nil
1297 "Non-nil means, search words must be matches as complete words.
1298 When nil, they may also match part of a word."
1299 :group
'org-agenda-search-view
1303 (defgroup org-agenda-time-grid nil
1304 "Options concerning the time grid in the Org-mode Agenda."
1305 :tag
"Org Agenda Time Grid"
1308 (defcustom org-agenda-search-headline-for-time t
1309 "Non-nil means search headline for a time-of-day.
1310 If the headline contains a time-of-day in one format or another, it will
1311 be used to sort the entry into the time sequence of items for a day.
1312 Some people have time stamps in the headline that refer to the creation
1313 time or so, and then this produces an unwanted side effect. If this is
1314 the case for your, use this variable to turn off searching the headline
1316 :group
'org-agenda-time-grid
1319 (defcustom org-agenda-use-time-grid t
1320 "Non-nil means show a time grid in the agenda schedule.
1321 A time grid is a set of lines for specific times (like every two hours between
1322 8:00 and 20:00). The items scheduled for a day at specific times are
1323 sorted in between these lines.
1324 For details about when the grid will be shown, and what it will look like, see
1325 the variable `org-agenda-time-grid'."
1326 :group
'org-agenda-time-grid
1329 (defcustom org-agenda-time-grid
1330 '((daily today require-timed
)
1332 (800 1000 1200 1400 1600 1800 2000))
1334 "The settings for time grid for agenda display.
1335 This is a list of three items. The first item is again a list. It contains
1336 symbols specifying conditions when the grid should be displayed:
1338 daily if the agenda shows a single day
1339 weekly if the agenda shows an entire week
1340 today show grid on current date, independent of daily/weekly display
1341 require-timed show grid only if at least one item has a time specification
1343 The second item is a string which will be placed behind the grid time.
1345 The third item is a list of integers, indicating the times that should have
1347 :group
'org-agenda-time-grid
1350 (set :greedy t
:tag
"Grid Display Options"
1351 (const :tag
"Show grid in single day agenda display" daily
)
1352 (const :tag
"Show grid in weekly agenda display" weekly
)
1353 (const :tag
"Always show grid for today" today
)
1354 (const :tag
"Show grid only if any timed entries are present"
1356 (const :tag
"Skip grid times already present in an entry"
1358 (string :tag
"Grid String")
1359 (repeat :tag
"Grid Times" (integer :tag
"Time"))))
1361 (defcustom org-agenda-show-current-time-in-grid t
1362 "Non-nil means show the current time in the time grid."
1363 :group
'org-agenda-time-grid
1367 (defcustom org-agenda-current-time-string
1368 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1369 "The string for the current time marker in the agenda."
1370 :group
'org-agenda-time-grid
1374 (defgroup org-agenda-sorting nil
1375 "Options concerning sorting in the Org-mode Agenda."
1376 :tag
"Org Agenda Sorting"
1379 (defcustom org-agenda-sorting-strategy
1380 '((agenda habit-down time-up priority-down category-keep
)
1381 (todo priority-down category-keep
)
1382 (tags priority-down category-keep
)
1383 (search category-keep
))
1384 "Sorting structure for the agenda items of a single day.
1385 This is a list of symbols which will be used in sequence to determine
1386 if an entry should be listed before another entry. The following
1387 symbols are recognized:
1389 time-up Put entries with time-of-day indications first, early first
1390 time-down Put entries with time-of-day indications first, late first
1391 category-keep Keep the default order of categories, corresponding to the
1392 sequence in `org-agenda-files'.
1393 category-up Sort alphabetically by category, A-Z.
1394 category-down Sort alphabetically by category, Z-A.
1395 tag-up Sort alphabetically by last tag, A-Z.
1396 tag-down Sort alphabetically by last tag, Z-A.
1397 priority-up Sort numerically by priority, high priority last.
1398 priority-down Sort numerically by priority, high priority first.
1399 todo-state-up Sort by todo state, tasks that are done last.
1400 todo-state-down Sort by todo state, tasks that are done first.
1401 effort-up Sort numerically by estimated effort, high effort last.
1402 effort-down Sort numerically by estimated effort, high effort first.
1403 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1404 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1405 habit-up Put entries that are habits first
1406 habit-down Put entries that are habits last
1407 alpha-up Sort headlines alphabetically
1408 alpha-down Sort headlines alphabetically, reversed
1410 The different possibilities will be tried in sequence, and testing stops
1411 if one comparison returns a \"not-equal\". For example, the default
1412 '(time-up category-keep priority-down)
1413 means: Pull out all entries having a specified time of day and sort them,
1414 in order to make a time schedule for the current day the first thing in the
1415 agenda listing for the day. Of the entries without a time indication, keep
1416 the grouped in categories, don't sort the categories, but keep them in
1417 the sequence given in `org-agenda-files'. Within each category sort by
1420 Leaving out `category-keep' would mean that items will be sorted across
1421 categories by priority.
1423 Instead of a single list, this can also be a set of list for specific
1424 contents, with a context symbol in the car of the list, any of
1425 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1427 Custom commands can bind this variable in the options section."
1428 :group
'org-agenda-sorting
1430 (repeat :tag
"General" ,org-sorting-choice
)
1431 (list :tag
"Individually"
1432 (cons (const :tag
"Strategy for Weekly/Daily agenda" agenda
)
1433 (repeat ,org-sorting-choice
))
1434 (cons (const :tag
"Strategy for TODO lists" todo
)
1435 (repeat ,org-sorting-choice
))
1436 (cons (const :tag
"Strategy for Tags matches" tags
)
1437 (repeat ,org-sorting-choice
))
1438 (cons (const :tag
"Strategy for search matches" search
)
1439 (repeat ,org-sorting-choice
)))))
1441 (defcustom org-agenda-cmp-user-defined nil
1442 "A function to define the comparison `user-defined'.
1443 This function must receive two arguments, agenda entry a and b.
1444 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1445 the user comparison, return nil.
1446 When this is defined, you can make `user-defined-up' and `user-defined-down'
1447 part of an agenda sorting strategy."
1448 :group
'org-agenda-sorting
1451 (defcustom org-sort-agenda-notime-is-late t
1452 "Non-nil means items without time are considered late.
1453 This is only relevant for sorting. When t, items which have no explicit
1454 time like 15:30 will be considered as 99:01, i.e. later than any items which
1455 do have a time. When nil, the default time is before 0:00. You can use this
1456 option to decide if the schedule for today should come before or after timeless
1458 :group
'org-agenda-sorting
1461 (defcustom org-sort-agenda-noeffort-is-high t
1462 "Non-nil means items without effort estimate are sorted as high effort.
1463 This also applies when filtering an agenda view with respect to the
1464 < or > effort operator. Then, tasks with no effort defined will be treated
1465 as tasks with high effort.
1466 When nil, such items are sorted as 0 minutes effort."
1467 :group
'org-agenda-sorting
1470 (defgroup org-agenda-line-format nil
1471 "Options concerning the entry prefix in the Org-mode agenda display."
1472 :tag
"Org Agenda Line Format"
1475 (defcustom org-agenda-prefix-format
1476 '((agenda .
" %i %-12:c%?-12t% s")
1478 (todo .
" %i %-12:c")
1479 (tags .
" %i %-12:c")
1480 (search .
" %i %-12:c"))
1481 "Format specifications for the prefix of items in the agenda views.
1482 An alist with five entries, each for the different agenda types. The
1483 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1484 The values are format strings.
1486 This format works similar to a printf format, with the following meaning:
1488 %c the category of the item, \"Diary\" for entries from the diary,
1489 or as given by the CATEGORY keyword or derived from the file name
1490 %e the effort required by the item
1491 %i the icon category of the item, see `org-agenda-category-icon-alist'
1492 %T the last tag of the item (ignore inherited tags, which come first)
1493 %t the HH:MM time-of-day specification if one applies to the entry
1494 %s Scheduling/Deadline information, a short string
1495 %(expression) Eval EXPRESSION and replace the control string
1498 All specifiers work basically like the standard `%s' of printf, but may
1499 contain two additional characters: a question mark just after the `%'
1500 and a whitespace/punctuation character just before the final letter.
1502 If the first character after `%' is a question mark, the entire field
1503 will only be included if the corresponding value applies to the current
1504 entry. This is useful for fields which should have fixed width when
1505 present, but zero width when absent. For example, \"%?-12t\" will
1506 result in a 12 character time field if a time of the day is specified,
1507 but will completely disappear in entries which do not contain a time.
1509 If there is punctuation or whitespace character just before the final
1510 format letter, this character will be appended to the field value if
1511 the value is not empty. For example, the format \"%-12:c\" leads to
1512 \"Diary: \" if the category is \"Diary\". If the category were be
1513 empty, no additional colon would be inserted.
1515 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1518 - Indent the line with two space characters
1519 - Give the category a 12 chars wide field, padded with whitespace on
1520 the right (because of `-'). Append a colon if there is a category
1522 - If there is a time-of-day, put it into a 12 chars wide field. If no
1523 time, don't put in an empty field, just skip it (because of '?').
1524 - Finally, put the scheduling information.
1526 See also the variables `org-agenda-remove-times-when-in-prefix' and
1527 `org-agenda-remove-tags'.
1529 Custom commands can set this variable in the options section."
1531 (string :tag
"General format")
1532 (list :greedy t
:tag
"View dependent"
1533 (cons (const agenda
) (string :tag
"Format"))
1534 (cons (const timeline
) (string :tag
"Format"))
1535 (cons (const todo
) (string :tag
"Format"))
1536 (cons (const tags
) (string :tag
"Format"))
1537 (cons (const search
) (string :tag
"Format"))))
1538 :group
'org-agenda-line-format
)
1540 (defvar org-prefix-format-compiled nil
1541 "The compiled prefix format and associated variables.
1542 This is a list where first element is a list of variable bindings, and second
1543 element is the compiled format expression. See the variable
1544 `org-agenda-prefix-format'.")
1546 (defcustom org-agenda-todo-keyword-format
"%-1s"
1547 "Format for the TODO keyword in agenda lines.
1548 Set this to something like \"%-12s\" if you want all TODO keywords
1549 to occupy a fixed space in the agenda display."
1550 :group
'org-agenda-line-format
1553 (defcustom org-agenda-diary-sexp-prefix nil
1554 "A regexp that matches part of a diary sexp entry
1555 which should be treated as scheduling/deadline information in
1558 For example, you can use this to extract the `diary-remind-message' from
1559 `diary-remind' entries."
1560 :group
'org-agenda-line-format
1561 :type
'(choice (const :tag
"None" nil
) (regexp :tag
"Regexp")))
1563 (defcustom org-agenda-timerange-leaders
'("" "(%d/%d): ")
1564 "Text preceding timerange entries in the agenda view.
1565 This is a list with two strings. The first applies when the range
1566 is entirely on one day. The second applies if the range spans several days.
1567 The strings may have two \"%d\" format specifiers which will be filled
1568 with the sequence number of the days, and the total number of days in the
1569 range, respectively."
1570 :group
'org-agenda-line-format
1572 (string :tag
"Deadline today ")
1573 (choice :tag
"Deadline relative"
1574 (string :tag
"Format string")
1577 (defcustom org-agenda-scheduled-leaders
'("Scheduled: " "Sched.%2dx: ")
1578 "Text preceding scheduled items in the agenda view.
1579 This is a list with two strings. The first applies when the item is
1580 scheduled on the current day. The second applies when it has been scheduled
1581 previously, it may contain a %d indicating that this is the nth time that
1582 this item is scheduled, due to automatic rescheduling of unfinished items
1583 for the following day. So this number is one larger than the number of days
1584 that passed since this item was scheduled first."
1585 :group
'org-agenda-line-format
1587 (string :tag
"Scheduled today ")
1588 (string :tag
"Scheduled previously")))
1590 (defcustom org-agenda-inactive-leader
"["
1591 "Text preceding item pulled into the agenda by inactive time stamps.
1592 These entries are added to the agenda when pressing \"[\"."
1593 :group
'org-agenda-line-format
1596 (string :tag
"Scheduled today ")
1597 (string :tag
"Scheduled previously")))
1599 (defcustom org-agenda-deadline-leaders
'("Deadline: " "In %3d d.: ")
1600 "Text preceding deadline items in the agenda view.
1601 This is a list with two strings. The first applies when the item has its
1602 deadline on the current day. The second applies when it is in the past or
1603 in the future, it may contain %d to capture how many days away the deadline
1605 :group
'org-agenda-line-format
1607 (string :tag
"Deadline today ")
1608 (choice :tag
"Deadline relative"
1609 (string :tag
"Format string")
1612 (defcustom org-agenda-remove-times-when-in-prefix t
1613 "Non-nil means remove duplicate time specifications in agenda items.
1614 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1615 time-of-day specification in a headline or diary entry is extracted and
1616 placed into the prefix. If this option is non-nil, the original specification
1617 \(a timestamp or -range, or just a plain time(range) specification like
1618 11:30-4pm) will be removed for agenda display. This makes the agenda less
1620 The option can be t or nil. It may also be the symbol `beg', indicating
1621 that the time should only be removed when it is located at the beginning of
1622 the headline/diary entry."
1623 :group
'org-agenda-line-format
1625 (const :tag
"Always" t
)
1626 (const :tag
"Never" nil
)
1627 (const :tag
"When at beginning of entry" beg
)))
1629 (defcustom org-agenda-remove-timeranges-from-blocks nil
1630 "Non-nil means remove time ranges specifications in agenda
1631 items that span on several days."
1632 :group
'org-agenda-line-format
1636 (defcustom org-agenda-default-appointment-duration nil
1637 "Default duration for appointments that only have a starting time.
1638 When nil, no duration is specified in such cases.
1639 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1640 :group
'org-agenda-line-format
1642 (integer :tag
"Minutes")
1643 (const :tag
"No default duration")))
1645 (defcustom org-agenda-show-inherited-tags t
1646 "Non-nil means show inherited tags in each agenda line."
1647 :group
'org-agenda-line-format
1650 (defcustom org-agenda-hide-tags-regexp nil
1651 "Regular expression used to filter away specific tags in agenda views.
1652 This means that these tags will be present, but not be shown in the agenda
1653 line. Secondary filtering will still work on the hidden tags.
1654 Nil means don't hide any tags."
1655 :group
'org-agenda-line-format
1657 (const :tag
"Hide none" nil
)
1658 (string :tag
"Regexp ")))
1660 (defcustom org-agenda-remove-tags nil
1661 "Non-nil means remove the tags from the headline copy in the agenda.
1662 When this is the symbol `prefix', only remove tags when
1663 `org-agenda-prefix-format' contains a `%T' specifier."
1664 :group
'org-agenda-line-format
1666 (const :tag
"Always" t
)
1667 (const :tag
"Never" nil
)
1668 (const :tag
"When prefix format contains %T" prefix
)))
1670 (if (fboundp 'defvaralias
)
1671 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1672 'org-agenda-remove-tags
))
1674 (defcustom org-agenda-tags-column
(if (featurep 'xemacs
) -
79 -
80)
1675 "Shift tags in agenda items to this column.
1676 If this number is positive, it specifies the column. If it is negative,
1677 it means that the tags should be flushright to that column. For example,
1678 -80 works well for a normal 80 character screen."
1679 :group
'org-agenda-line-format
1682 (if (fboundp 'defvaralias
)
1683 (defvaralias 'org-agenda-align-tags-to-column
'org-agenda-tags-column
))
1685 (defcustom org-agenda-fontify-priorities
'cookies
1686 "Non-nil means highlight low and high priorities in agenda.
1687 When t, the highest priority entries are bold, lowest priority italic.
1688 However, settings in `org-priority-faces' will overrule these faces.
1689 When this variable is the symbol `cookies', only fontify the
1690 cookies, not the entire task.
1691 This may also be an association list of priority faces, whose
1692 keys are the character values of `org-highest-priority',
1693 `org-default-priority', and `org-lowest-priority' (the default values
1694 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1695 color as a string, or a list like `(:background \"Red\")'.
1696 If it is a color, the variable `org-faces-easy-properties'
1697 determines if it is a foreground or a background color."
1698 :group
'org-agenda-line-format
1700 (const :tag
"Never" nil
)
1701 (const :tag
"Defaults" t
)
1702 (const :tag
"Cookies only" cookies
)
1703 (repeat :tag
"Specify"
1704 (list (character :tag
"Priority" :value ?A
)
1705 (choice :tag
"Face "
1706 (string :tag
"Color")
1707 (sexp :tag
"Face"))))))
1709 (defcustom org-agenda-day-face-function nil
1710 "Function called to determine what face should be used to display a day.
1711 The only argument passed to that function is the day. It should
1712 returns a face, or nil if does not want to specify a face and let
1713 the normal rules apply."
1714 :group
'org-agenda-line-format
1718 (defcustom org-agenda-category-icon-alist nil
1719 "Alist of category icon to be displayed in agenda views.
1721 Each entry should have the following format:
1723 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1725 Where CATEGORY-REGEXP is a regexp matching the categories where
1726 the icon should be displayed.
1727 FILE-OR-DATA either a file path or a string containing image data.
1729 The other fields can be omitted safely if not needed:
1730 TYPE indicates the image type.
1731 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1733 PROPS are additional image attributes to assign to the image,
1734 like, e.g. `:ascent center'.
1736 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1738 If you want to set the display properties yourself, just put a
1739 list as second element:
1741 (CATEGORY-REGEXP (MY PROPERTY LIST))
1743 For example, to display a 16px horizontal space for Emacs
1744 category, you can use:
1746 (\"Emacs\" '(space . (:width (16))))"
1747 :group
'org-agenda-line-format
1749 :type
'(alist :key-type
(string :tag
"Regexp matching category")
1750 :value-type
(choice (list :tag
"Icon"
1751 (string :tag
"File or data")
1752 (symbol :tag
"Type")
1753 (boolean :tag
"Data?")
1754 (repeat :tag
"Extra image properties" :inline t symbol
))
1755 (list :tag
"Display properties" sexp
))))
1757 (defgroup org-agenda-column-view nil
1758 "Options concerning column view in the agenda."
1759 :tag
"Org Agenda Column View"
1762 (defcustom org-agenda-columns-show-summaries t
1763 "Non-nil means show summaries for columns displayed in the agenda view."
1764 :group
'org-agenda-column-view
1767 (defcustom org-agenda-columns-compute-summary-properties t
1768 "Non-nil means recompute all summary properties before column view.
1769 When column view in the agenda is listing properties that have a summary
1770 operator, it can go to all relevant buffers and recompute the summaries
1771 there. This can mean overhead for the agenda column view, but is necessary
1772 to have thing up to date.
1773 As a special case, a CLOCKSUM property also makes sure that the clock
1774 computations are current."
1775 :group
'org-agenda-column-view
1778 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1779 "Non-nil means the duration of an appointment will add to day effort.
1780 The property to which appointment durations will be added is the one given
1781 in the option `org-effort-property'. If an appointment does not have
1782 an end time, `org-agenda-default-appointment-duration' will be used. If that
1783 is not set, an appointment without end time will not contribute to the time
1785 :group
'org-agenda-column-view
1788 (defcustom org-agenda-auto-exclude-function nil
1789 "A function called with a tag to decide if it is filtered on '/ RET'.
1790 The sole argument to the function, which is called once for each
1791 possible tag, is a string giving the name of the tag. The
1792 function should return either nil if the tag should be included
1793 as normal, or \"-<TAG>\" to exclude the tag.
1794 Note that for the purpose of tag filtering, only the lower-case version of
1795 all tags will be considered, so that this function will only ever see
1796 the lower-case version of all tags."
1800 (defcustom org-agenda-bulk-custom-functions nil
1801 "Alist of characters and custom functions for bulk actions.
1802 For example, this value makes those two functions available:
1807 With selected entries in an agenda buffer, `B R' will call
1808 the custom function `set-category' on the selected entries.
1809 Note that functions in this alist don't need to be quoted."
1814 (defmacro org-agenda-with-point-at-orig-entry
(string &rest body
)
1815 "Execute BODY with point at location given by `org-hd-marker' property.
1816 If STRING is non-nil, the text property will be fetched from position 0
1817 in that string. If STRING is nil, it will be fetched from the beginning
1818 of the current line."
1819 (org-with-gensyms (marker)
1820 `(let ((,marker
(get-text-property (if string
0 (point-at-bol))
1821 'org-hd-marker
,string
)))
1822 (with-current-buffer (marker-buffer ,marker
)
1826 (def-edebug-spec org-agenda-with-point-at-orig-entry
(form body
))
1828 (defun org-add-agenda-custom-command (entry)
1829 "Replace or add a command in `org-agenda-custom-commands'.
1830 This is mostly for hacking and trying a new command - once the command
1831 works you probably want to add it to `org-agenda-custom-commands' for good."
1832 (let ((ass (assoc (car entry
) org-agenda-custom-commands
)))
1834 (setcdr ass
(cdr entry
))
1835 (push entry org-agenda-custom-commands
))))
1837 ;;; Define the org-agenda-mode
1839 (defvar org-agenda-mode-map
(make-sparse-keymap)
1840 "Keymap for `org-agenda-mode'.")
1841 (if (fboundp 'defvaralias
)
1842 (defvaralias 'org-agenda-keymap
'org-agenda-mode-map
))
1844 (defvar org-agenda-menu
) ; defined later in this file.
1845 (defvar org-agenda-restrict nil
) ; defined later in this file.
1846 (defvar org-agenda-follow-mode nil
)
1847 (defvar org-agenda-entry-text-mode nil
)
1848 (defvar org-agenda-clockreport-mode nil
)
1849 (defvar org-agenda-show-log nil
)
1850 (defvar org-agenda-redo-command nil
)
1851 (defvar org-agenda-query-string nil
)
1852 (defvar org-agenda-mode-hook nil
1853 "Hook for `org-agenda-mode', run after the mode is turned on.")
1854 (defvar org-agenda-type nil
)
1855 (defvar org-agenda-force-single-file nil
)
1856 (defvar org-agenda-bulk-marked-entries nil
1857 "List of markers that refer to marked entries in the agenda.")
1859 ;;; Multiple agenda buffers support
1861 (defcustom org-agenda-sticky nil
1862 "Non-nil means agenda q key will bury agenda buffers.
1863 Agenda commands will then show existing buffer instead of generating new ones.
1864 When nil, `q' will kill the single agenda buffer."
1867 :set
(lambda (var val
)
1869 (org-toggle-sticky-agenda (if val
1 0))
1873 (defun org-toggle-sticky-agenda (&optional arg
)
1874 "Toggle `org-agenda-sticky'."
1876 (let ((new-value (if arg
1877 (> (prefix-numeric-value arg
) 0)
1878 (not org-agenda-sticky
))))
1879 (if (equal new-value org-agenda-sticky
)
1880 (and (org-called-interactively-p 'interactive
)
1881 (message "Sticky agenda was already %s"
1882 (if org-agenda-sticky
"enabled" "disabled")))
1883 (setq org-agenda-sticky new-value
)
1884 (org-agenda-kill-all-agenda-buffers)
1885 (and (org-called-interactively-p 'interactive
)
1886 (message "Sticky agenda was %s"
1887 (if org-agenda-sticky
"enabled" "disabled"))))))
1889 (defvar org-agenda-buffer nil
1890 "Agenda buffer currently being generated.")
1892 (defvar org-agenda-last-prefix-arg nil
)
1893 (defvar org-agenda-this-buffer-name nil
)
1894 (defvar org-agenda-doing-sticky-redo nil
)
1895 (defvar org-agenda-this-buffer-is-sticky nil
)
1897 (defconst org-agenda-local-vars
1898 '(org-agenda-this-buffer-name
1899 org-agenda-undo-list
1900 org-agenda-pending-undo-list
1901 org-agenda-follow-mode
1902 org-agenda-entry-text-mode
1903 org-agenda-clockreport-mode
1905 org-agenda-redo-command
1906 org-agenda-query-string
1908 org-agenda-bulk-marked-entries
1909 org-agenda-undo-has-started-in
1911 org-agenda-tag-filter-overlays
1912 org-agenda-cat-filter-overlays
1913 org-agenda-pre-window-conf
1914 org-agenda-columns-active
1915 org-agenda-tag-filter
1916 org-agenda-category-filter
1918 org-agenda-last-search-view-search-was-boolean
1919 org-agenda-filtered-by-category
1920 org-agenda-filter-form
1921 org-agenda-show-window
1922 org-agenda-cycle-counter
1923 org-agenda-last-prefix-arg
)
1924 "Variables that must be local in agenda buffers to allow multiple buffers.")
1926 (defun org-agenda-mode ()
1927 "Mode for time-sorted view on action items in Org-mode files.
1929 The following commands are available:
1931 \\{org-agenda-mode-map}"
1933 (cond (org-agenda-doing-sticky-redo
1934 ;; Refreshing sticky agenda-buffer
1936 ;; Preserve the value of `org-agenda-local-vars' variables,
1937 ;; while letting `kill-all-local-variables' kill the rest
1938 (let ((save (buffer-local-variables)))
1939 (kill-all-local-variables)
1940 (mapc 'make-local-variable org-agenda-local-vars
)
1942 (let ((var (car elem
))
1945 (member var org-agenda-local-vars
))
1947 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
1949 ;; Creating a sticky Agenda buffer for the first time
1950 (kill-all-local-variables)
1951 (mapc 'make-local-variable org-agenda-local-vars
)
1952 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
1954 ;; Creating a non-sticky agenda buffer
1955 (kill-all-local-variables)
1956 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) nil
)))
1957 (setq org-agenda-undo-list nil
1958 org-agenda-pending-undo-list nil
1959 org-agenda-bulk-marked-entries nil
)
1960 (setq major-mode
'org-agenda-mode
)
1961 ;; Keep global-font-lock-mode from turning on font-lock-mode
1962 (org-set-local 'font-lock-global-modes
(list 'not major-mode
))
1963 (setq mode-name
"Org-Agenda")
1964 (use-local-map org-agenda-mode-map
)
1965 (easy-menu-add org-agenda-menu
)
1966 (if org-startup-truncated
(setq truncate-lines t
))
1967 (org-set-local 'line-move-visual nil
)
1968 (org-add-hook 'post-command-hook
'org-agenda-post-command-hook nil
'local
)
1969 (org-add-hook 'pre-command-hook
'org-unhighlight nil
'local
)
1970 ;; Make sure properties are removed when copying text
1971 (make-local-variable 'filter-buffer-substring-functions
)
1972 (add-hook 'filter-buffer-substring-functions
1973 (lambda (fun start end delete
)
1974 (substring-no-properties (funcall fun start end delete
))))
1975 (unless org-agenda-keep-modes
1976 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1977 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1978 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1979 org-agenda-show-log org-agenda-start-with-log-mode
))
1982 '("Agenda") "Agenda Files"
1986 (if (get 'org-agenda-files
'org-restrict
)
1987 "Restricted to single file"
1989 '(org-edit-agenda-file-list)
1990 (not (get 'org-agenda-files
'org-restrict
)))
1992 (mapcar 'org-file-menu-entry
(org-agenda-files))))
1993 (org-agenda-set-mode-name)
1995 (if (fboundp 'run-mode-hooks
) 'run-mode-hooks
'run-hooks
)
1996 (list 'org-agenda-mode-hook
)))
1998 (substitute-key-definition 'undo
'org-agenda-undo
1999 org-agenda-mode-map global-map
)
2000 (org-defkey org-agenda-mode-map
"\C-i" 'org-agenda-goto
)
2001 (org-defkey org-agenda-mode-map
[(tab)] 'org-agenda-goto
)
2002 (org-defkey org-agenda-mode-map
"\C-m" 'org-agenda-switch-to
)
2003 (org-defkey org-agenda-mode-map
"\C-k" 'org-agenda-kill
)
2004 (org-defkey org-agenda-mode-map
"\C-c\C-w" 'org-agenda-refile
)
2005 (org-defkey org-agenda-mode-map
"m" 'org-agenda-bulk-mark
)
2006 (org-defkey org-agenda-mode-map
"*" 'org-agenda-bulk-mark-all
)
2007 (org-defkey org-agenda-mode-map
"%" 'org-agenda-bulk-mark-regexp
)
2008 (org-defkey org-agenda-mode-map
"u" 'org-agenda-bulk-unmark
)
2009 (org-defkey org-agenda-mode-map
"U" 'org-agenda-bulk-unmark-all
)
2010 (org-defkey org-agenda-mode-map
"B" 'org-agenda-bulk-action
)
2011 (org-defkey org-agenda-mode-map
"k" 'org-agenda-capture
)
2012 (org-defkey org-agenda-mode-map
"A" 'org-agenda-append-agenda
)
2013 (org-defkey org-agenda-mode-map
"\C-c\C-x!" 'org-reload
)
2014 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-a" 'org-agenda-archive-default
)
2015 (org-defkey org-agenda-mode-map
"\C-c\C-xa" 'org-agenda-toggle-archive-tag
)
2016 (org-defkey org-agenda-mode-map
"\C-c\C-xA" 'org-agenda-archive-to-archive-sibling
)
2017 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-s" 'org-agenda-archive
)
2018 (org-defkey org-agenda-mode-map
"\C-c$" 'org-agenda-archive
)
2019 (org-defkey org-agenda-mode-map
"$" 'org-agenda-archive
)
2020 (org-defkey org-agenda-mode-map
"\C-c\C-o" 'org-agenda-open-link
)
2021 (org-defkey org-agenda-mode-map
" " 'org-agenda-show-and-scroll-up
)
2022 (org-defkey org-agenda-mode-map
[backspace] 'org-agenda-show-scroll-down)
2023 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2024 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2025 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2026 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2027 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2028 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2029 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2030 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2031 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2032 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2033 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2034 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2035 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2036 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2037 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2038 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2039 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2040 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2041 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2042 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2043 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2044 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2046 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2047 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2048 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2049 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2050 (while l (org-defkey org-agenda-mode-map
2051 (int-to-string (pop l)) 'digit-argument)))
2053 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2054 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2055 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2056 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2057 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2058 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2059 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2060 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2061 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2062 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2063 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2064 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2065 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2066 'org-clock-modify-effort-estimate)
2067 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2068 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2069 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2070 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2071 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2072 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2073 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2074 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2075 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2076 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2077 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2078 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2079 (substitute-key-definition 'next-line 'org-agenda-next-line
2080 org-agenda-mode-map global-map)
2081 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2082 org-agenda-mode-map global-map)
2083 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2084 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2085 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2086 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2087 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
2088 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2089 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2090 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2091 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2092 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2093 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2094 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2095 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2096 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2097 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2098 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2099 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2100 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2101 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2102 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2103 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2104 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2105 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2106 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2107 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2108 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2109 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2110 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2111 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2112 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2114 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2115 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2116 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2117 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2118 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2119 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2120 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2121 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2122 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2123 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2124 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2125 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2127 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2128 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2129 (when org-agenda-mouse-1-follows-link
2130 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2131 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2136 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2137 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2138 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2139 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2142 ["Day View" org-agenda-day-view
2143 :active (org-agenda-check-type nil 'agenda)
2144 :style radio :selected (eq org-agenda-current-span 'day)
2145 :keys "v d (or just d)"]
2146 ["Week View" org-agenda-week-view
2147 :active (org-agenda-check-type nil 'agenda)
2148 :style radio :selected (eq org-agenda-current-span 'week)
2149 :keys "v w (or just w)"]
2150 ["Month View" org-agenda-month-view
2151 :active (org-agenda-check-type nil 'agenda)
2152 :style radio :selected (eq org-agenda-current-span 'month)
2154 ["Year View" org-agenda-year-view
2155 :active (org-agenda-check-type nil 'agenda)
2156 :style radio :selected (eq org-agenda-current-span 'year)
2159 ["Include Diary" org-agenda-toggle-diary
2160 :style toggle :selected org-agenda-include-diary
2161 :active (org-agenda-check-type nil 'agenda)]
2162 ["Include Deadlines" org-agenda-toggle-deadlines
2163 :style toggle :selected org-agenda-include-deadlines
2164 :active (org-agenda-check-type nil 'agenda)]
2165 ["Use Time Grid" org-agenda-toggle-time-grid
2166 :style toggle :selected org-agenda-use-time-grid
2167 :active (org-agenda-check-type nil 'agenda)]
2169 ["Show clock report" org-agenda-clockreport-mode
2170 :style toggle :selected org-agenda-clockreport-mode
2171 :active (org-agenda-check-type nil 'agenda)]
2172 ["Show some entry text" org-agenda-entry-text-mode
2173 :style toggle :selected org-agenda-entry-text-mode
2176 ["Show Logbook entries" org-agenda-log-mode
2177 :style toggle :selected org-agenda-show-log
2178 :active (org-agenda-check-type nil 'agenda 'timeline)
2179 :keys "v l (or just l)"]
2180 ["Include archived trees" org-agenda-archives-mode
2181 :style toggle :selected org-agenda-archives-mode :active t
2183 ["Include archive files" (org-agenda-archives-mode t)
2184 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2187 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2188 ["Write view to file" org-agenda-write t]
2189 ["Rebuild buffer" org-agenda-redo t]
2190 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2192 ["Show original entry" org-agenda-show t]
2193 ["Go To (other window)" org-agenda-goto t]
2194 ["Go To (this window)" org-agenda-switch-to t]
2195 ["Capture with cursor date" org-agenda-capture t]
2196 ["Follow Mode" org-agenda-follow-mode
2197 :style toggle :selected org-agenda-follow-mode :active t]
2198 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2201 ["Cycle TODO" org-agenda-todo t]
2202 ["Next TODO set" org-agenda-todo-nextset t]
2203 ["Previous TODO set" org-agenda-todo-previousset t]
2204 ["Add note" org-agenda-add-note t])
2205 ("Archive/Refile/Delete"
2206 ["Archive default" org-agenda-archive-default t]
2207 ["Archive default" org-agenda-archive-default-with-confirmation t]
2208 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2209 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2210 ["Archive subtree" org-agenda-archive t]
2212 ["Refile" org-agenda-refile t]
2214 ["Delete subtree" org-agenda-kill t])
2216 ["Mark entry" org-agenda-bulk-mark t]
2217 ["Mark all" org-agenda-bulk-mark-all t]
2218 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2219 ["Unmark entry" org-agenda-bulk-unmark t]
2220 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "U"])
2221 ["Act on all marked" org-agenda-bulk-action t]
2223 ("Tags and Properties"
2224 ["Show all Tags" org-agenda-show-tags t]
2225 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2226 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2228 ["Column View" org-columns t])
2229 ("Deadline/Schedule"
2230 ["Schedule" org-agenda-schedule t]
2231 ["Set Deadline" org-agenda-deadline t]
2233 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2234 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2235 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2236 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2237 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2238 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2239 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2241 ["Clock in" org-agenda-clock-in t]
2242 ["Clock out" org-agenda-clock-out t]
2243 ["Clock cancel" org-agenda-clock-cancel t]
2244 ["Goto running clock" org-clock-goto t]
2246 ["Set Effort" org-agenda-set-effort t]
2247 ["Change clocked effort" org-clock-modify-effort-estimate
2248 (org-clock-is-active)])
2250 ["Set Priority" org-agenda-priority t]
2251 ["Increase Priority" org-agenda-priority-up t]
2252 ["Decrease Priority" org-agenda-priority-down t]
2253 ["Show Priority" org-agenda-show-priority t])
2255 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2256 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2257 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2258 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2259 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2260 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2262 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2264 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2267 ["Push Files and Views" org-mobile-push t]
2268 ["Get Captured and Flagged" org-mobile-pull t]
2269 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2270 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2272 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2274 ["Quit" org-agenda-quit t]
2275 ["Exit and Release Buffers" org-agenda-exit t]
2280 (defvar org-agenda-allow-remote-undo t
2281 "Non-nil means allow remote undo from the agenda buffer.")
2282 (defvar org-agenda-undo-has-started-in nil
2283 "Buffers that have already seen `undo-start' in the current undo sequence.")
2285 (defun org-agenda-undo ()
2286 "Undo a remote editing step in the agenda.
2287 This undoes changes both in the agenda buffer and in the remote buffer
2288 that have been changed along."
2290 (or org-agenda-allow-remote-undo
2291 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2292 (if (not (eq this-command last-command))
2293 (setq org-agenda-undo-has-started-in nil
2294 org-agenda-pending-undo-list org-agenda-undo-list))
2295 (if (not org-agenda-pending-undo-list)
2296 (error "No further undo information"))
2297 (let* ((entry (pop org-agenda-pending-undo-list))
2298 buf line cmd rembuf)
2299 (setq cmd (pop entry) line (pop entry))
2300 (setq rembuf (nth 2 entry))
2301 (org-with-remote-undo rembuf
2302 (while (bufferp (setq buf (pop entry)))
2304 (with-current-buffer buf
2305 (let ((last-undo-buffer buf)
2306 (inhibit-read-only t))
2307 (unless (memq buf org-agenda-undo-has-started-in)
2308 (push buf org-agenda-undo-has-started-in)
2309 (make-local-variable 'pending-undo-list)
2311 (while (and pending-undo-list
2312 (listp pending-undo-list)
2313 (not (car pending-undo-list)))
2314 (pop pending-undo-list))
2316 (org-goto-line line)
2317 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2319 (defun org-verify-change-for-undo (l1 l2)
2320 "Verify that a real change occurred between the undo lists L1 and L2."
2321 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2322 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2327 (defvar org-agenda-restrict-begin (make-marker))
2328 (defvar org-agenda-restrict-end (make-marker))
2329 (defvar org-agenda-last-dispatch-buffer nil)
2330 (defvar org-agenda-overriding-restriction nil)
2332 (defcustom org-agenda-custom-commands-contexts nil
2333 "Alist of custom agenda keys and contextual rules.
2335 For example, if you have a custom agenda command \"p\" and you
2336 want this command to be accessible only from plain text files,
2339 '((\"p\" (in-file . \"\\.txt\")))
2341 Here are the available contexts definitions:
2343 in-file: command displayed only in matching files
2344 in-mode: command displayed only in matching modes
2345 not-in-file: command not displayed in matching files
2346 not-in-mode: command not displayed in matching modes
2347 [function]: a custom function taking no argument
2349 If you define several checks, the agenda command will be
2350 accessible if there is at least one valid check.
2352 You can also bind a key to another agenda custom command
2353 depending on contextual rules.
2355 '((\"p\" \"q\" (in-file . \"\\.txt\")))
2357 Here it means: in .txt files, use \"p\" as the key for the
2358 agenda command otherwise associated with \"q\". (The command
2359 originally associated with \"q\" is not displayed to avoid
2362 :group 'org-agenda-custom-commands
2363 :type '(repeat (list :tag "Rule"
2364 (string :tag " Agenda key")
2365 (string :tag "Replace by command")
2366 (repeat :tag "Available when"
2368 (cons :tag "Condition"
2370 (const :tag "In file" in-file)
2371 (const :tag "Not in file" not-in-file)
2372 (const :tag "In mode" in-mode)
2373 (const :tag "Not in mode" not-in-mode))
2375 (function :tag "Custom function"))))))
2377 (defvar org-keys nil)
2378 (defvar org-match nil)
2380 (defun org-agenda (&optional arg org-keys restriction)
2381 "Dispatch agenda commands to collect entries to the agenda buffer.
2382 Prompts for a command to execute. Any prefix arg will be passed
2383 on to the selected command. The default selections are:
2385 a Call `org-agenda-list' to display the agenda for current day or week.
2386 t Call `org-todo-list' to display the global todo list.
2387 T Call `org-todo-list' to display the global todo list, select only
2388 entries with a specific TODO keyword (the user gets a prompt).
2389 m Call `org-tags-view' to display headlines with tags matching
2390 a condition (the user is prompted for the condition).
2391 M Like `m', but select only TODO entries, no ordinary headlines.
2392 L Create a timeline for the current buffer.
2393 e Export views to associated files.
2394 s Search entries for keywords.
2395 S Search entries for keywords, only with TODO keywords.
2396 / Multi occur across all agenda files and also files listed
2397 in `org-agenda-text-search-extra-files'.
2398 < Restrict agenda commands to buffer, subtree, or region.
2399 Press several times to get the desired effect.
2400 > Remove a previous restriction.
2401 # List \"stuck\" projects.
2402 ! Configure what \"stuck\" means.
2403 C Configure custom agenda commands.
2405 More commands can be added by configuring the variable
2406 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2407 searches can be pre-defined in this way.
2409 If the current buffer is in Org-mode and visiting a file, you can also
2410 first press `<' once to indicate that the agenda should be temporarily
2411 \(until the next use of \\[org-agenda]) restricted to the current file.
2412 Pressing `<' twice means to restrict to the current subtree or region
2416 (let* ((prefix-descriptions nil)
2417 (org-agenda-buffer-name org-agenda-buffer-name)
2418 (org-agenda-window-setup (if (equal (buffer-name)
2419 org-agenda-buffer-name)
2421 org-agenda-window-setup))
2422 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2423 (org-agenda-custom-commands
2424 ;; normalize different versions
2428 (cond ((stringp (cdr x))
2429 (push x prefix-descriptions)
2431 ((stringp (nth 1 x)) x)
2432 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2433 (t (cons (car x) (cons "" (cdr x))))))
2434 org-agenda-custom-commands)))
2435 (org-agenda-custom-commands
2436 (org-contextualize-keys
2437 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2438 (buf (current-buffer))
2439 (bfn (buffer-file-name (buffer-base-buffer)))
2440 entry key type org-match lprops ans)
2441 ;; Turn off restriction unless there is an overriding one,
2442 (unless org-agenda-overriding-restriction
2443 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2444 ;; There is a request to keep the file list in place
2445 (put 'org-agenda-files 'org-restrict nil))
2446 (setq org-agenda-restrict nil)
2447 (move-marker org-agenda-restrict-begin nil)
2448 (move-marker org-agenda-restrict-end nil))
2449 ;; Delete old local properties
2450 (put 'org-agenda-redo-command 'org-lprops nil)
2451 ;; Delete previously set last-arguments
2452 (put 'org-agenda-redo-command 'last-args nil)
2453 ;; Remember where this call originated
2454 (setq org-agenda-last-dispatch-buffer (current-buffer))
2456 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2458 restriction (cdr ans)))
2459 ;; If we have sticky agenda buffers, set a name for the buffer,
2460 ;; depending on the invoking keys. The user may still set this
2461 ;; as a command option, which will overwrite what we do here.
2462 (if org-agenda-sticky
2463 (setq org-agenda-buffer-name
2464 (format "*Org Agenda(%s)*" org-keys)))
2465 ;; Establish the restriction, if any
2466 (when (and (not org-agenda-overriding-restriction) restriction)
2467 (put 'org-agenda-files 'org-restrict (list bfn))
2469 ((eq restriction 'region)
2470 (setq org-agenda-restrict t)
2471 (move-marker org-agenda-restrict-begin (region-beginning))
2472 (move-marker org-agenda-restrict-end (region-end)))
2473 ((eq restriction 'subtree)
2475 (setq org-agenda-restrict t)
2476 (org-back-to-heading t)
2477 (move-marker org-agenda-restrict-begin (point))
2478 (move-marker org-agenda-restrict-end
2479 (progn (org-end-of-subtree t)))))))
2481 ;; For example the todo list should not need it (but does...)
2483 ((setq entry (assoc org-keys org-agenda-custom-commands))
2484 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2486 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2487 lprops (nth 4 entry))
2488 (if org-agenda-sticky
2489 (setq org-agenda-buffer-name
2490 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2491 (format "*Org Agenda(%s)*" org-keys))))
2492 (put 'org-agenda-redo-command 'org-lprops lprops)
2495 (org-let lprops '(org-agenda-list current-prefix-arg)))
2497 (org-let lprops '(org-todo-list current-prefix-arg)))
2499 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2501 (org-let lprops '(org-agenda-list-stuck-projects
2502 current-prefix-arg)))
2504 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2505 ((eq type 'tags-todo)
2506 (org-let lprops '(org-tags-view '(4) org-match)))
2508 (org-let lprops '(org-todo-list org-match)))
2509 ((eq type 'tags-tree)
2510 (org-check-for-org-mode)
2511 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2512 ((eq type 'todo-tree)
2513 (org-check-for-org-mode)
2515 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2516 (regexp-quote org-match) "\\>"))))
2517 ((eq type 'occur-tree)
2518 (org-check-for-org-mode)
2519 (org-let lprops '(org-occur org-match)))
2521 (org-let lprops '(funcall type org-match)))
2523 (org-let lprops '(funcall type org-match)))
2524 (t (error "Invalid custom agenda command type %s" type))))
2525 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2526 ((equal org-keys "C")
2527 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2528 (customize-variable 'org-agenda-custom-commands))
2529 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2530 ((equal org-keys "s") (call-interactively 'org-search-view))
2531 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2532 ((equal org-keys "t") (call-interactively 'org-todo-list))
2533 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2534 ((equal org-keys "m") (call-interactively 'org-tags-view))
2535 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2536 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2537 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2541 (unless (current-message)
2542 (let* ((m (org-agenda-get-any-marker))
2543 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2546 "FLAGGING-NOTE ([?] for more info): "
2548 (replace-regexp-in-string
2550 (copy-sequence note))
2551 nil 'face 'org-warning)))))))
2553 ((equal org-keys "L")
2554 (unless (derived-mode-p 'org-mode)
2555 (error "This is not an Org-mode file"))
2557 (put 'org-agenda-files 'org-restrict (list bfn))
2558 (org-call-with-arg 'org-timeline arg)))
2559 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2560 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2561 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2562 (t (error "Invalid agenda key"))))))
2564 (defun org-agenda-append-agenda ()
2565 "Append another agenda view to the current one.
2566 This function allows interactive building of block agendas.
2567 Agenda views are separated by `org-agenda-block-separator'."
2569 (unless (derived-mode-p 'org-agenda-mode)
2570 (error "Can only append from within agenda buffer"))
2571 (let ((org-agenda-multi t))
2574 (org-agenda-finalize)
2575 (org-agenda-fit-window-to-buffer)))
2577 (defun org-agenda-normalize-custom-commands (cmds)
2581 (cond ((stringp (cdr x)) nil)
2582 ((stringp (nth 1 x)) x)
2583 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2584 (t (cons (car x) (cons "" (cdr x))))))
2587 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2588 "The user interface for selecting an agenda command."
2590 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2591 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2592 (region-p (org-region-active-p))
2593 (custom org-agenda-custom-commands)
2595 restriction second-time
2596 c entry key type match prefixes rmheader header-end custom1 desc
2597 line lines left right n n1)
2598 (save-window-excursion
2599 (delete-other-windows)
2600 (org-switch-to-buffer-other-window " *Agenda Commands*")
2602 (insert (eval-when-compile
2604 "Press key for an agenda command: < Buffer, subtree/region restriction
2605 -------------------------------- > Remove restriction
2606 a Agenda for current week or day e Export agenda views
2607 t List of all TODO entries T Entries with special TODO kwd
2608 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2609 s Search for keywords S Like s, but only TODO entries
2610 L Timeline for current buffer # List stuck projects (!=configure)
2611 / Multi-occur C Configure custom agenda commands
2612 ? Find :FLAGGED: entries * Toggle sticky agenda views
2615 (while (string-match
2616 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2618 (setq start (match-end 0))
2619 (add-text-properties (match-beginning 2) (match-end 2)
2620 '(face bold) header))
2622 (setq header-end (move-marker (make-marker) (point)))
2624 (setq custom1 custom)
2625 (when (eq rmheader t)
2627 (re-search-forward ":" nil t)
2628 (delete-region (match-end 0) (point-at-eol))
2631 (delete-region (match-end 0) (point-at-eol))
2632 (move-marker header-end (match-end 0)))
2633 (goto-char header-end)
2634 (delete-region (point) (point-max))
2636 ;; Produce all the lines that describe custom commands and prefixes
2638 (while (setq entry (pop custom1))
2639 (setq key (car entry) desc (nth 1 entry)
2641 match (nth 3 entry))
2642 (if (> (length key) 1)
2643 (add-to-list 'prefixes (string-to-char key))
2647 (org-add-props (copy-sequence key)
2650 ((string-match "\\S-" desc) desc)
2651 ((eq type 'agenda) "Agenda for current week or day")
2652 ((eq type 'alltodo) "List of all TODO entries")
2653 ((eq type 'search) "Word search")
2654 ((eq type 'stuck) "List of stuck projects")
2655 ((eq type 'todo) "TODO keyword")
2656 ((eq type 'tags) "Tags query")
2657 ((eq type 'tags-todo) "Tags (TODO)")
2658 ((eq type 'tags-tree) "Tags tree")
2659 ((eq type 'todo-tree) "TODO kwd tree")
2660 ((eq type 'occur-tree) "Occur tree")
2661 ((functionp type) (if (symbolp type)
2663 "Lambda expression"))
2665 (if org-agenda-menu-show-matcher
2670 (setq match (copy-sequence match))
2671 (org-add-props match nil 'face 'org-warning))
2673 (format "set of %d commands" (length match)))
2675 (if (org-string-nw-p match)
2676 (add-text-properties
2677 0 (length line) (list 'help-echo
2678 (concat "Matcher: "match)) line)))
2680 (setq lines (nreverse lines))
2685 (org-add-props (char-to-string x)
2687 (or (cdr (assoc (concat selstring
2689 prefix-descriptions))
2694 ;; Check if we should display in two columns
2695 (if org-agenda-menu-two-columns
2697 (setq n (length lines)
2698 n1 (+ (/ n 2) (mod n 2))
2699 right (nthcdr n1 lines)
2700 left (copy-sequence lines))
2701 (setcdr (nthcdr (1- n1) left) nil))
2702 (setq left lines right nil))
2704 (insert "\n" (pop left))
2706 (if (< (current-column) 40)
2707 (move-to-column 40 t)
2709 (insert (pop right))))
2711 ;; Make the window the right size
2712 (goto-char (point-min))
2714 (if (not (pos-visible-in-window-p (point-max)))
2715 (org-fit-window-to-buffer))
2716 (setq second-time t)
2717 (org-fit-window-to-buffer))
2719 ;; Ask for selection
2720 (message "Press key for agenda command%s:"
2721 (if (or restrict-ok org-agenda-overriding-restriction)
2722 (if org-agenda-overriding-restriction
2723 " (restriction lock active)"
2725 (format " (restricted to %s)" restriction)
2728 (setq c (read-char-exclusive))
2731 ((assoc (char-to-string c) custom)
2732 (setq selstring (concat selstring (char-to-string c)))
2733 (throw 'exit (cons selstring restriction)))
2735 (setq selstring (concat selstring (char-to-string c))
2737 rmheader (or rmheader t)
2738 custom (delq nil (mapcar
2740 (if (or (= (length (car x)) 1)
2741 (/= (string-to-char (car x)) c))
2743 (cons (substring (car x) 1) (cdr x))))
2746 (call-interactively 'org-toggle-sticky-agenda)
2748 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2749 (message "Restriction is only possible in Org-mode buffers")
2752 (org-agenda-remove-restriction-lock 'noupdate)
2753 (setq restriction 'buffer))
2755 (org-agenda-remove-restriction-lock 'noupdate)
2756 (setq restriction (if region-p 'region 'subtree)))
2758 (org-agenda-remove-restriction-lock 'noupdate)
2761 ((eq restriction 'buffer)
2762 (if region-p 'region 'subtree))
2763 ((memq restriction '(subtree region))
2767 (org-agenda-remove-restriction-lock 'noupdate)
2768 (setq restriction nil))
2769 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2770 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2771 ((and (> (length selstring) 0) (eq c ?\d))
2773 (org-agenda-get-restriction-and-command prefix-descriptions))
2775 ((equal c ?q) (error "Abort"))
2776 (t (error "Invalid key %c" c))))))))
2778 (defun org-agenda-fit-window-to-buffer ()
2779 "Fit the window to the buffer size."
2780 (and (memq org-agenda-window-setup '(reorganize-frame))
2781 (fboundp 'fit-window-to-buffer)
2782 (org-fit-window-to-buffer
2784 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
2785 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
2787 (defvar org-cmd nil)
2788 (defvar org-agenda-overriding-cmd nil)
2789 (defvar org-agenda-overriding-arguments nil)
2790 (defvar org-agenda-overriding-cmd-arguments nil)
2791 (defun org-agenda-run-series (name series)
2792 (org-let (nth 1 series) '(org-agenda-prepare name))
2793 ;; We need to reset agenda markers here, because when constructing a
2794 ;; block agenda, the individual blocks do not do that.
2795 (org-agenda-reset-markers)
2796 (let* ((org-agenda-multi t)
2797 (redo (list 'org-agenda-run-series name (list 'quote series)))
2799 (gprops (nth 1 series))
2800 match ;; The byte compiler incorrectly complains about this. Keep it!
2801 org-cmd type lprops)
2802 (while (setq org-cmd (pop cmds))
2803 (setq type (car org-cmd)
2804 match (eval (nth 1 org-cmd))
2805 lprops (nth 2 org-cmd))
2806 (let ((org-agenda-overriding-arguments
2807 (if (eq org-agenda-overriding-cmd org-cmd)
2808 (or org-agenda-overriding-arguments
2809 org-agenda-overriding-cmd-arguments))))
2812 (org-let2 gprops lprops
2813 '(call-interactively 'org-agenda-list)))
2815 (org-let2 gprops lprops
2816 '(call-interactively 'org-todo-list)))
2818 (org-let2 gprops lprops
2819 '(org-search-view current-prefix-arg match nil)))
2821 (org-let2 gprops lprops
2822 '(call-interactively 'org-agenda-list-stuck-projects)))
2824 (org-let2 gprops lprops
2825 '(org-tags-view current-prefix-arg match)))
2826 ((eq type 'tags-todo)
2827 (org-let2 gprops lprops
2828 '(org-tags-view '(4) match)))
2830 (org-let2 gprops lprops
2831 '(org-todo-list match)))
2833 (org-let2 gprops lprops
2834 '(funcall type match)))
2835 (t (error "Invalid type in command series")))))
2837 (let ((inhibit-read-only t))
2838 (add-text-properties (point-min) (point-max)
2839 `(org-serie t org-serie-redo-cmd ,redo)))
2840 (setq org-agenda-redo-command redo)
2841 (goto-char (point-min)))
2842 (org-agenda-fit-window-to-buffer)
2843 (org-let (nth 1 series) '(org-agenda-finalize)))
2846 (defmacro org-batch-agenda (cmd-key &rest parameters)
2847 "Run an agenda command in batch mode and send the result to STDOUT.
2848 If CMD-KEY is a string of length 1, it is used as a key in
2849 `org-agenda-custom-commands' and triggers this command. If it is a
2850 longer string it is used as a tags/todo match string.
2851 Parameters are alternating variable names and values that will be bound
2852 before running the agenda command."
2853 (org-eval-in-environment (org-make-parameter-alist parameters)
2854 (if (> (length cmd-key) 2)
2855 (org-tags-view nil cmd-key)
2856 (org-agenda nil cmd-key)))
2857 (set-buffer org-agenda-buffer-name)
2858 (princ (buffer-string)))
2859 (def-edebug-spec org-batch-agenda (form &rest sexp))
2861 (defvar org-agenda-info nil)
2864 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2865 "Run an agenda command in batch mode and send the result to STDOUT.
2866 If CMD-KEY is a string of length 1, it is used as a key in
2867 `org-agenda-custom-commands' and triggers this command. If it is a
2868 longer string it is used as a tags/todo match string.
2869 Parameters are alternating variable names and values that will be bound
2870 before running the agenda command.
2872 The output gives a line for each selected agenda item. Each
2873 item is a list of comma-separated values, like this:
2875 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2877 category The category of the item
2878 head The headline, without TODO kwd, TAGS and PRIORITY
2879 type The type of the agenda entry, can be
2880 todo selected in TODO match
2881 tagsmatch selected in tags match
2882 diary imported from diary
2883 deadline a deadline on given date
2884 scheduled scheduled on given date
2885 timestamp entry has timestamp on given date
2886 closed entry was closed on given date
2887 upcoming-deadline warning about deadline
2888 past-scheduled forwarded scheduled item
2889 block entry has date block including g. date
2890 todo The todo keyword, if any
2891 tags All tags including inherited ones, separated by colons
2892 date The relevant date, like 2007-2-14
2893 time The time, like 15:00-16:50
2894 extra Sting with extra planning info
2895 priority-l The priority letter if any was given
2896 priority-n The computed numerical priority
2897 agenda-day The day in the agenda where this is listed"
2898 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2899 (org-make-parameter-alist parameters))
2900 (if (> (length cmd-key) 2)
2901 (org-tags-view nil cmd-key)
2902 (org-agenda nil cmd-key)))
2903 (set-buffer org-agenda-buffer-name)
2904 (let* ((lines (org-split-string (buffer-string) "\n"))
2906 (while (setq line (pop lines))
2908 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2909 (setq org-agenda-info
2910 (org-fix-agenda-info (text-properties-at 0 line)))
2912 (mapconcat 'org-agenda-export-csv-mapper
2913 '(org-category txt type todo tags date time extra
2914 priority-letter priority agenda-day)
2917 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2919 (defun org-fix-agenda-info (props)
2920 "Make sure all properties on an agenda item have a canonical form.
2921 This ensures the export commands can easily use it."
2923 (when (setq tmp (plist-get props 'tags))
2924 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2925 (when (setq tmp (plist-get props 'date))
2926 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2927 (let ((calendar-date-display-form '(year "-" month "-" day)))
2928 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2930 (setq tmp (calendar-date-string tmp)))
2931 (setq props (plist-put props 'date tmp)))
2932 (when (setq tmp (plist-get props 'day))
2933 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2934 (let ((calendar-date-display-form '(year "-" month "-" day)))
2935 (setq tmp (calendar-date-string tmp)))
2936 (setq props (plist-put props 'day tmp))
2937 (setq props (plist-put props 'agenda-day tmp)))
2938 (when (setq tmp (plist-get props 'txt))
2939 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2940 (plist-put props 'priority-letter (match-string 1 tmp))
2941 (setq tmp (replace-match "" t t tmp)))
2942 (when (and (setq re (plist-get props 'org-todo-regexp))
2943 (setq re (concat "\\`\\.*" re " ?"))
2944 (string-match re tmp))
2945 (plist-put props 'todo (match-string 1 tmp))
2946 (setq tmp (replace-match "" t t tmp)))
2947 (plist-put props 'txt tmp)))
2950 (defun org-agenda-export-csv-mapper (prop)
2951 (let ((res (plist-get org-agenda-info prop)))
2956 (t (prin1-to-string res))))
2957 (while (string-match "," res)
2958 (setq res (replace-match ";" t t res)))
2962 (defun org-store-agenda-views (&rest parameters)
2964 (eval (list 'org-batch-store-agenda-views)))
2967 (defmacro org-batch-store-agenda-views (&rest parameters)
2968 "Run all custom agenda commands that have a file argument."
2969 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2971 (dir default-directory)
2972 (pars (org-make-parameter-alist parameters))
2973 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
2974 (save-window-excursion
2976 (setq cmd (pop cmds)
2977 thiscmdkey (car cmd)
2978 thiscmdcmd (cdr cmd)
2979 match (nth 2 thiscmdcmd)
2980 bufname (if org-agenda-sticky
2981 (or (and (stringp match)
2982 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
2983 (format "*Org Agenda(%s)*" thiscmdkey))
2984 org-agenda-buffer-name)
2985 cmd-or-set (nth 2 cmd)
2986 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2987 files (nth (if (listp cmd-or-set) 4 5) cmd))
2988 (if (stringp files) (setq files (list files)))
2990 (org-eval-in-environment (append org-agenda-exporter-settings
2992 (org-agenda nil thiscmdkey))
2993 (set-buffer bufname)
2995 (org-eval-in-environment (append org-agenda-exporter-settings
2997 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
2998 (and (get-buffer bufname)
2999 (kill-buffer bufname)))))))
3000 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
3002 (defvar org-agenda-current-span nil
3003 "The current span used in the agenda view.") ; local variable in the agenda buffer
3004 (defun org-agenda-mark-header-line (pos)
3005 "Mark the line at POS as an agenda structure header."
3008 (put-text-property (point-at-bol) (point-at-eol)
3009 'org-agenda-structural-header t)
3010 (when org-agenda-title-append
3011 (put-text-property (point-at-bol) (point-at-eol)
3012 'org-agenda-title-append org-agenda-title-append))))
3014 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3015 (defvar org-agenda-write-buffer-name "Agenda View")
3016 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3017 "Write the current buffer (an agenda view) as a file.
3018 Depending on the extension of the file name, plain text (.txt),
3019 HTML (.html or .htm) or Postscript (.ps) is produced.
3020 If the extension is .ics, run icalendar export over all files used
3021 to construct the agenda and limit the export to entries listed in the
3023 With prefix argument OPEN, open the new file immediately.
3024 If NOSETTINGS is given, do not scope the settings of
3025 `org-agenda-exporter-settings' into the export commands. This is used when
3026 the settings have already been scoped and we do not wish to overrule other,
3027 higher priority settings.
3028 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3029 (interactive "FWrite agenda to file: \nP")
3030 (if (not (file-writable-p file))
3031 (error "Cannot write agenda to file %s" file))
3032 (org-let (if nosettings nil org-agenda-exporter-settings)
3034 (save-window-excursion
3035 (org-agenda-mark-filtered-text)
3036 (let ((bs (copy-sequence (buffer-string))) beg)
3037 (org-agenda-unmark-filtered-text)
3039 (rename-buffer org-agenda-write-buffer-name t)
3040 (set-buffer-modified-p nil)
3042 (org-agenda-remove-marked-text 'org-filtered)
3043 (while (setq beg (text-property-any (point-min) (point-max)
3046 beg (or (next-single-property-change beg 'org-filtered)
3048 (run-hooks 'org-agenda-before-write-hook)
3050 ((org-bound-and-true-p org-mobile-creating-agendas)
3051 (org-mobile-write-agenda-for-mobile file))
3052 ((string-match "\\.html?\\'" file)
3054 (set-buffer (htmlize-buffer (current-buffer)))
3055 (when (and org-agenda-export-html-style
3056 (string-match "<style>" org-agenda-export-html-style))
3057 ;; replace <style> section with org-agenda-export-html-style
3058 (goto-char (point-min))
3059 (kill-region (- (search-forward "<style") 6)
3060 (search-forward "</style>"))
3061 (insert org-agenda-export-html-style))
3063 (kill-buffer (current-buffer))
3064 (message "HTML written to %s" file))
3065 ((string-match "\\.ps\\'" file)
3067 (ps-print-buffer-with-faces file)
3068 (message "Postscript written to %s" file))
3069 ((string-match "\\.pdf\\'" file)
3071 (ps-print-buffer-with-faces
3072 (concat (file-name-sans-extension file) ".ps"))
3073 (call-process "ps2pdf" nil nil nil
3075 (concat (file-name-sans-extension file) ".ps"))
3076 (expand-file-name file))
3077 (delete-file (concat (file-name-sans-extension file) ".ps"))
3078 (message "PDF written to %s" file))
3079 ((string-match "\\.ics\\'" file)
3080 (require 'org-icalendar)
3081 (let ((org-agenda-marker-table
3082 (org-create-marker-find-array
3083 (org-agenda-collect-markers)))
3084 (org-icalendar-verify-function 'org-check-agenda-marker-table)
3085 (org-combined-agenda-icalendar-file file))
3086 (apply 'org-export-icalendar 'combine
3087 (org-agenda-files nil 'ifmode))))
3089 (let ((bs (buffer-string)))
3094 (kill-buffer (current-buffer))
3095 (message "Plain text written to %s" file))))))))
3096 (set-buffer (or agenda-bufname
3097 (and (called-interactively-p 'any) (buffer-name))
3098 org-agenda-buffer-name)))
3099 (when open (org-open-file file)))
3101 (defvar org-agenda-tag-filter-overlays nil)
3102 (defvar org-agenda-cat-filter-overlays nil)
3104 (defun org-agenda-mark-filtered-text ()
3105 "Mark all text hidden by filtering with a text property."
3106 (let ((inhibit-read-only t))
3109 (when (equal (overlay-buffer o) (current-buffer))
3111 (overlay-start o) (overlay-end o)
3113 (append org-agenda-tag-filter-overlays
3114 org-agenda-cat-filter-overlays))))
3116 (defun org-agenda-unmark-filtered-text ()
3117 "Remove the filtering text property."
3118 (let ((inhibit-read-only t))
3119 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3121 (defun org-agenda-remove-marked-text (property &optional value)
3122 "Delete all text marked with VALUE of PROPERTY.
3123 VALUE defaults to t."
3125 (setq value (or value t))
3126 (while (setq beg (text-property-any (point-min) (point-max)
3129 beg (or (next-single-property-change beg 'org-filtered)
3132 (defun org-agenda-add-entry-text ()
3133 "Add entry text to agenda lines.
3134 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3135 entry text following headings shown in the agenda.
3136 Drawers will be excluded, also the line with scheduling/deadline info."
3137 (when (and (> org-agenda-add-entry-text-maxlines 0)
3138 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3140 (goto-char (point-min))
3142 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3143 (beginning-of-line 2)
3144 (setq txt (org-agenda-get-some-entry-text
3145 m org-agenda-add-entry-text-maxlines " > "))
3147 (if (string-match "\\S-" txt)
3149 (or (eobp) (forward-char 1))))))))
3151 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3153 "Extract entry text from MARKER, at most N-LINES lines.
3154 This will ignore drawers etc, just get the text.
3155 If INDENT is given, prefix every line with this string. If KEEP is
3156 given, it is a list of symbols, defining stuff that should not be
3157 removed from the entry content. Currently only `planning' is allowed here."
3158 (let (txt drawer-re kwd-time-re ind)
3160 (with-current-buffer (marker-buffer marker)
3161 (if (not (derived-mode-p 'org-mode))
3168 (setq txt (buffer-substring
3169 (min (1+ (point)) (point-max))
3170 (progn (outline-next-heading) (point)))
3171 drawer-re org-drawer-regexp
3172 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3176 (when org-agenda-add-entry-text-descriptive-links
3177 (goto-char (point-min))
3178 (while (org-activate-bracket-links (point-max))
3179 (add-text-properties (match-beginning 0) (match-end 0)
3181 (goto-char (point-min))
3182 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3183 (set-text-properties (match-beginning 0) (match-end 0)
3185 (goto-char (point-min))
3186 (while (re-search-forward drawer-re nil t)
3189 (progn (re-search-forward
3190 "^[ \t]*:END:.*\n?" nil 'move)
3192 (unless (member 'planning keep)
3193 (goto-char (point-min))
3194 (while (re-search-forward kwd-time-re nil t)
3195 (replace-match "")))
3196 (goto-char (point-min))
3197 (when org-agenda-entry-text-exclude-regexps
3198 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3199 (while (setq re (pop re-list))
3200 (goto-char (point-min))
3201 (while (re-search-forward re nil t)
3202 (replace-match "")))))
3203 (goto-char (point-max))
3204 (skip-chars-backward " \t\n")
3205 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3207 ;; find and remove min common indentation
3208 (goto-char (point-min))
3209 (untabify (point-min) (point-max))
3210 (setq ind (org-get-indentation))
3212 (unless (looking-at "[ \t]*$")
3213 (setq ind (min ind (org-get-indentation))))
3214 (beginning-of-line 2))
3215 (goto-char (point-min))
3217 (unless (looking-at "[ \t]*$")
3218 (move-to-column ind)
3219 (delete-region (point-at-bol) (point)))
3220 (beginning-of-line 2))
3222 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3224 (goto-char (point-min))
3226 (while (and (not (eobp)) (re-search-forward "^" nil t))
3227 (replace-match indent t t)))
3228 (goto-char (point-min))
3229 (while (looking-at "[ \t]*\n") (replace-match ""))
3230 (goto-char (point-max))
3231 (when (> (org-current-line)
3233 (org-goto-line (1+ n-lines))
3235 (setq txt (buffer-substring (point-min) (point)))))))))
3238 (defun org-agenda-collect-markers ()
3239 "Collect the markers pointing to entries in the agenda buffer."
3242 (goto-char (point-min))
3244 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3245 (org-get-at-bol 'org-marker)))
3247 (beginning-of-line 2)))
3248 (nreverse markers)))
3250 (defun org-create-marker-find-array (marker-list)
3251 "Create a alist of files names with all marker positions in that file."
3253 (while (setq m (pop marker-list))
3254 (setq p (marker-position m)
3255 f (buffer-file-name (or (buffer-base-buffer
3257 (marker-buffer m))))
3258 (if (setq a (assoc f tbl))
3259 (push (marker-position m) (cdr a))
3260 (push (list f p) tbl)))
3261 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3264 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3265 (defun org-check-agenda-marker-table ()
3266 "Check of the current entry is on the marker list."
3267 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3269 (and (setq a (assoc file org-agenda-marker-table))
3272 (org-back-to-heading t)
3273 (member (point) (cdr a)))))))
3275 (defun org-check-for-org-mode ()
3276 "Make sure current buffer is in org-mode. Error if not."
3277 (or (derived-mode-p 'org-mode)
3278 (error "Cannot execute org-mode agenda command on buffer in %s"
3281 ;;; Agenda prepare and finalize
3283 (defvar org-agenda-multi nil) ; dynamically scoped
3284 (defvar org-agenda-pre-window-conf nil)
3285 (defvar org-agenda-columns-active nil)
3286 (defvar org-agenda-name nil)
3287 (defvar org-agenda-tag-filter nil)
3288 (defvar org-agenda-category-filter nil)
3289 (defvar org-agenda-top-category-filter nil)
3290 (defvar org-agenda-tag-filter-while-redo nil)
3291 (defvar org-agenda-tag-filter-preset nil
3292 "A preset of the tags filter used for secondary agenda filtering.
3293 This must be a list of strings, each string must be a single tag preceded
3295 This variable should not be set directly, but agenda custom commands can
3296 bind it in the options section. The preset filter is a global property of
3297 the entire agenda view. In a block agenda, it will not work reliably to
3298 define a filter for one of the individual blocks. You need to set it in
3299 the global options and expect it to be applied to the entire view.")
3301 (defvar org-agenda-category-filter-preset nil
3302 "A preset of the category filter used for secondary agenda filtering.
3303 This must be a list of strings, each string must be a single category
3304 preceded by \"+\" or \"-\".
3305 This variable should not be set directly, but agenda custom commands can
3306 bind it in the options section. The preset filter is a global property of
3307 the entire agenda view. In a block agenda, it will not work reliably to
3308 define a filter for one of the individual blocks. You need to set it in
3309 the global options and expect it to be applied to the entire view.")
3312 (defun org-agenda-use-sticky-p ()
3313 "Return non-nil if an agenda buffer named
3314 `org-agenda-buffer-name' exists and should be shown instead of
3315 generating a new one."
3317 ;; turned off by user
3319 ;; For multi-agenda buffer already exists
3320 (not org-agenda-multi)
3322 (get-buffer org-agenda-buffer-name)
3323 ;; C-u parameter is same as last call
3324 (with-current-buffer (get-buffer org-agenda-buffer-name)
3326 (equal current-prefix-arg
3327 org-agenda-last-prefix-arg)
3328 ;; In case user turned stickiness on, while having existing
3329 ;; Agenda buffer active, don't reuse that buffer, because it
3330 ;; does not have org variables local
3331 org-agenda-this-buffer-is-sticky))))
3333 (defun org-agenda-prepare-window (abuf)
3334 "Setup agenda buffer in the window."
3335 (let* ((awin (get-buffer-window abuf))
3338 ((equal (current-buffer) abuf) nil)
3339 (awin (select-window awin))
3340 ((not (setq wconf (current-window-configuration))))
3341 ((equal org-agenda-window-setup 'current-window)
3342 (org-pop-to-buffer-same-window abuf))
3343 ((equal org-agenda-window-setup 'other-window)
3344 (org-switch-to-buffer-other-window abuf))
3345 ((equal org-agenda-window-setup 'other-frame)
3346 (switch-to-buffer-other-frame abuf))
3347 ((equal org-agenda-window-setup 'reorganize-frame)
3348 (delete-other-windows)
3349 (org-switch-to-buffer-other-window abuf)))
3350 ;; additional test in case agenda is invoked from within agenda
3351 ;; buffer via elisp link
3352 (unless (equal (current-buffer) abuf)
3353 (org-pop-to-buffer-same-window abuf))
3354 (setq org-agenda-pre-window-conf
3355 (or org-agenda-pre-window-conf wconf))))
3357 (defun org-agenda-prepare (&optional name)
3358 (if (org-agenda-use-sticky-p)
3360 ;; Popup existing buffer
3361 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
3362 (message "Sticky Agenda buffer, use `r' to refresh")
3363 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3364 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3365 (setq org-todo-keywords-for-agenda nil)
3366 (setq org-drawers-for-agenda nil)
3367 (unless org-agenda-persistent-filter
3368 (setq org-agenda-tag-filter nil
3369 org-agenda-category-filter nil))
3370 (put 'org-agenda-tag-filter :preset-filter
3371 org-agenda-tag-filter-preset)
3372 (put 'org-agenda-category-filter :preset-filter
3373 org-agenda-category-filter-preset)
3374 (if org-agenda-multi
3376 (setq buffer-read-only nil)
3377 (goto-char (point-max))
3378 (unless (or (bobp) org-agenda-compact-blocks
3379 (not org-agenda-block-separator))
3381 (if (stringp org-agenda-block-separator)
3382 org-agenda-block-separator
3383 (make-string (window-width) org-agenda-block-separator))
3385 (narrow-to-region (point) (point-max)))
3386 (setq org-done-keywords-for-agenda nil)
3388 ;; Setting any org variables that are in org-agenda-local-vars
3389 ;; list need to be done after the prepare call
3390 (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
3391 (setq buffer-read-only nil)
3392 (org-agenda-reset-markers)
3393 (let ((inhibit-read-only t)) (erase-buffer))
3395 (setq org-agenda-buffer (current-buffer))
3396 (setq org-agenda-contributing-files nil)
3397 (setq org-agenda-columns-active nil)
3398 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3399 (setq org-todo-keywords-for-agenda
3400 (org-uniquify org-todo-keywords-for-agenda))
3401 (setq org-done-keywords-for-agenda
3402 (org-uniquify org-done-keywords-for-agenda))
3403 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3404 (setq org-agenda-last-prefix-arg current-prefix-arg)
3405 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3406 (and name (not org-agenda-name)
3407 (org-set-local 'org-agenda-name name)))
3408 (setq buffer-read-only nil)))
3410 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3411 (defun org-agenda-finalize ()
3412 "Finishing touch for the agenda buffer, called just before displaying it."
3413 (unless org-agenda-multi
3415 (let ((inhibit-read-only t))
3416 (goto-char (point-min))
3417 (while (org-activate-bracket-links (point-max))
3418 (add-text-properties (match-beginning 0) (match-end 0)
3420 (org-agenda-align-tags)
3421 (unless org-agenda-with-colors
3422 (remove-text-properties (point-min) (point-max) '(face nil))))
3423 (if (and (boundp 'org-agenda-overriding-columns-format)
3424 org-agenda-overriding-columns-format)
3425 (org-set-local 'org-agenda-overriding-columns-format
3426 org-agenda-overriding-columns-format))
3427 (if (and (boundp 'org-agenda-view-columns-initially)
3428 org-agenda-view-columns-initially)
3429 (org-agenda-columns))
3430 (when org-agenda-fontify-priorities
3431 (org-agenda-fontify-priorities))
3432 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3433 (org-agenda-dim-blocked-tasks))
3434 (org-agenda-mark-clocking-task)
3435 (when org-agenda-entry-text-mode
3436 (org-agenda-entry-text-hide)
3437 (org-agenda-entry-text-show))
3438 (if (functionp 'org-habit-insert-consistency-graphs)
3439 (org-habit-insert-consistency-graphs))
3440 (run-hooks 'org-agenda-finalize-hook)
3441 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3442 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3443 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3444 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3445 (org-agenda-filter-apply org-agenda-category-filter 'category))
3446 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3449 (defun org-agenda-mark-clocking-task ()
3450 "Mark the current clock entry in the agenda if it is present."
3452 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3453 (delete-overlay o)))
3454 (overlays-in (point-min) (point-max)))
3455 (when (marker-buffer org-clock-hd-marker)
3457 (goto-char (point-min))
3459 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3461 (when (equal (org-get-at-bol 'org-hd-marker)
3462 org-clock-hd-marker)
3463 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3464 (overlay-put ov 'type 'org-agenda-clocking)
3465 (overlay-put ov 'face 'org-agenda-clocking)
3466 (overlay-put ov 'help-echo
3467 "The clock is running in this item")))))))
3469 (defun org-agenda-fontify-priorities ()
3470 "Make highest priority lines bold, and lowest italic."
3472 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3473 (delete-overlay o)))
3474 (overlays-in (point-min) (point-max)))
3476 (let ((inhibit-read-only t)
3478 (goto-char (point-min))
3479 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3480 (setq h (or (get-char-property (point) 'org-highest-priority)
3481 org-highest-priority)
3482 l (or (get-char-property (point) 'org-lowest-priority)
3483 org-lowest-priority)
3484 p (string-to-char (match-string 1))
3485 b (match-beginning 0)
3486 e (if (eq org-agenda-fontify-priorities 'cookies)
3489 ov (make-overlay b e))
3492 (cond ((org-face-from-face-or-color
3494 (cdr (assoc p org-priority-faces))))
3495 ((and (listp org-agenda-fontify-priorities)
3496 (org-face-from-face-or-color
3498 (cdr (assoc p org-agenda-fontify-priorities)))))
3499 ((equal p l) 'italic)
3500 ((equal p h) 'bold)))
3501 (overlay-put ov 'org-type 'org-priority)))))
3503 (defun org-agenda-dim-blocked-tasks ()
3504 "Dim currently blocked TODO's in the agenda display."
3505 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3506 (delete-overlay o)))
3507 (overlays-in (point-min) (point-max)))
3509 (let ((inhibit-read-only t)
3510 (org-depend-tag-blocked nil)
3511 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3512 org-blocked-by-checkboxes
3513 invis1 b e p ov h l)
3514 (goto-char (point-min))
3515 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3516 (and pos (goto-char (1+ pos))))
3517 (setq org-blocked-by-checkboxes nil invis1 invis)
3518 (let ((marker (org-get-at-bol 'org-hd-marker)))
3520 (with-current-buffer (marker-buffer marker)
3521 (save-excursion (goto-char marker)
3522 (org-entry-blocked-p))))
3523 (if org-blocked-by-checkboxes (setq invis1 nil))
3525 (max (point-min) (1- (point-at-bol)))
3528 ov (make-overlay b e))
3530 (overlay-put ov 'invisible t)
3531 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3532 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3534 (defvar org-agenda-skip-function nil
3535 "Function to be called at each match during agenda construction.
3536 If this function returns nil, the current match should not be skipped.
3537 Otherwise, the function must return a position from where the search
3538 should be continued.
3539 This may also be a Lisp form, it will be evaluated.
3540 Never set this variable using `setq' or so, because then it will apply
3541 to all future agenda commands. If you do want a global skipping condition,
3542 use the option `org-agenda-skip-function-global' instead.
3543 The correct usage for `org-agenda-skip-function' is to bind it with
3544 `let' to scope it dynamically into the agenda-constructing command.
3545 A good way to set it is through options in `org-agenda-custom-commands'.")
3547 (defun org-agenda-skip ()
3548 "Throw to `:skip' in places that should be skipped.
3549 Also moves point to the end of the skipped region, so that search can
3550 continue from there."
3551 (let ((p (point-at-bol)) to)
3552 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3553 (get-text-property p :org-archived)
3554 (org-end-of-subtree t)
3556 (and org-agenda-skip-comment-trees
3557 (get-text-property p :org-comment)
3558 (org-end-of-subtree t)
3560 (if (equal (char-after p) ?#) (throw :skip t))
3561 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3562 (org-agenda-skip-eval org-agenda-skip-function)))
3566 (defun org-agenda-skip-eval (form)
3567 "If FORM is a function or a list, call (or eval) is and return result.
3568 `save-excursion' and `save-match-data' are wrapped around the call, so point
3569 and match data are returned to the previous state no matter what these
3573 (or (setq fp (functionp form))
3581 (defvar org-agenda-markers nil
3582 "List of all currently active markers created by `org-agenda'.")
3583 (defvar org-agenda-last-marker-time (org-float-time)
3584 "Creation time of the last agenda marker.")
3586 (defun org-agenda-new-marker (&optional pos)
3587 "Return a new agenda marker.
3588 Org-mode keeps a list of these markers and resets them when they are
3590 (let ((m (copy-marker (or pos (point)))))
3591 (setq org-agenda-last-marker-time (org-float-time))
3592 (if org-agenda-buffer
3593 (with-current-buffer org-agenda-buffer
3594 (push m org-agenda-markers))
3595 (push m org-agenda-markers))
3598 (defun org-agenda-reset-markers ()
3599 "Reset markers created by `org-agenda'."
3600 (while org-agenda-markers
3601 (move-marker (pop org-agenda-markers) nil)))
3603 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3604 "Save relative positions of markers in region.
3605 This check for agenda markers in all agenda buffers currently active."
3606 (dolist (buf (buffer-list))
3607 (with-current-buffer buf
3608 (when (eq major-mode 'org-agenda-mode)
3609 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3610 org-agenda-markers)))))
3614 (defun org-agenda-entry-text-show-here ()
3615 "Add some text from the entry as context to the current line."
3617 (setq m (org-get-at-bol 'org-hd-marker))
3618 (unless (marker-buffer m)
3619 (error "No marker points to an entry here"))
3620 (setq txt (concat "\n" (org-no-properties
3621 (org-agenda-get-some-entry-text
3622 m org-agenda-entry-text-maxlines " > "))))
3623 (when (string-match "\\S-" txt)
3624 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3625 (overlay-put o 'evaporate t)
3626 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3627 (overlay-put o 'after-string txt))))
3629 (defun org-agenda-entry-text-show ()
3630 "Add entry context for all agenda lines."
3633 (goto-char (point-max))
3634 (beginning-of-line 1)
3636 (when (org-get-at-bol 'org-hd-marker)
3637 (org-agenda-entry-text-show-here))
3638 (beginning-of-line 0))))
3640 (defun org-agenda-entry-text-hide ()
3641 "Remove any shown entry context."
3644 (if (eq (overlay-get o 'org-overlay-type)
3645 'agenda-entry-content)
3646 (progn (delete-overlay o) t)))
3647 (overlays-in (point-min) (point-max)))))
3649 (defun org-agenda-get-day-face (date)
3650 "Return the face DATE should be displayed with."
3651 (or (and (functionp org-agenda-day-face-function)
3652 (funcall org-agenda-day-face-function date))
3653 (cond ((org-agenda-todayp date)
3654 'org-agenda-date-today)
3655 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3656 'org-agenda-date-weekend)
3657 (t 'org-agenda-date))))
3661 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3663 (defun org-timeline (&optional dotodo)
3664 "Show a time-sorted view of the entries in the current org file.
3665 Only entries with a time stamp of today or later will be listed. With
3666 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3667 under the current date.
3668 If the buffer contains an active region, only check the region for
3672 (org-agenda-show-log-scoped org-agenda-show-log)
3673 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3675 (date (calendar-current-date))
3676 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3677 (end (if (org-region-active-p) (region-end) (point-max)))
3678 (day-numbers (org-get-all-dates
3680 t org-agenda-show-log-scoped ; always include today
3681 org-timeline-show-empty-dates))
3682 (org-deadline-warning-days 0)
3683 (org-agenda-only-exact-dates t)
3688 (setq org-agenda-redo-command
3690 (list 'org-switch-to-buffer-other-window (current-buffer))
3691 (list 'org-timeline (list 'quote dotodo))))
3693 ;; Remove past dates from the list of dates.
3694 (setq day-numbers (delq nil (mapcar (lambda(x)
3695 (if (>= x today) x nil))
3697 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
3698 (org-compile-prefix-format 'timeline)
3699 (org-set-sorting-strategy 'timeline)
3700 (if org-agenda-show-log-scoped (push :closed args))
3701 (push :timestamp args)
3702 (push :deadline args)
3703 (push :scheduled args)
3705 (if dotodo (push :todo args))
3706 (insert "Timeline of file " entry "\n")
3707 (add-text-properties (point-min) (point)
3708 (list 'face 'org-agenda-structure))
3709 (org-agenda-mark-header-line (point-min))
3710 (while (setq d (pop day-numbers))
3711 (if (and (listp d) (eq (car d) :omitted))
3714 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3715 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3716 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3717 (if (and (>= d today)
3722 (insert (make-string 79 ?-) "\n")))
3723 (setq date (calendar-gregorian-from-absolute d))
3725 (setq rtn (and (not emptyp)
3726 (apply 'org-agenda-get-day-entries entry
3728 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3731 (if (stringp org-agenda-format-date)
3732 (format-time-string org-agenda-format-date
3733 (org-time-from-absolute date))
3734 (funcall org-agenda-format-date date))
3736 (put-text-property s (1- (point)) 'face
3737 (org-agenda-get-day-face date))
3738 (put-text-property s (1- (point)) 'org-date-line t)
3739 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3741 (put-text-property s (1- (point)) 'org-today t))
3742 (and rtn (insert (org-agenda-finalize-entries rtn) "\n"))
3743 (put-text-property s (1- (point)) 'day d)))))
3744 (goto-char (point-min))
3745 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3747 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3748 (org-agenda-finalize)
3749 (setq buffer-read-only t)))
3751 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3752 "Return a list of all relevant day numbers from BEG to END buffer positions.
3753 If NO-RANGES is non-nil, include only the start and end dates of a range,
3754 not every single day in the range. If FORCE-TODAY is non-nil, make
3755 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3756 inactive time stamps (those in square brackets) are included.
3757 When EMPTY is non-nil, also include days without any entries."
3759 (if pre-re pre-re "")
3760 (if inactive org-ts-regexp-both org-ts-regexp)))
3761 dates dates1 date day day1 day2 ts1 ts2 pos)
3763 (setq dates (list (org-today))))
3766 (while (re-search-forward re end t)
3767 (setq day (time-to-days (org-time-string-to-time
3768 (substring (match-string 1) 0 10)
3769 (current-buffer) (match-beginning 0))))
3770 (or (memq day dates) (push day dates)))
3773 (while (re-search-forward org-tr-regexp end t)
3774 (setq pos (match-beginning 0))
3775 (setq ts1 (substring (match-string 1) 0 10)
3776 ts2 (substring (match-string 2) 0 10)
3777 day1 (time-to-days (org-time-string-to-time
3778 ts1 (current-buffer) pos))
3779 day2 (time-to-days (org-time-string-to-time
3780 ts2 (current-buffer) pos)))
3781 (while (< (setq day1 (1+ day1)) day2)
3782 (or (memq day1 dates) (push day1 dates)))))
3783 (setq dates (sort dates '<))
3785 (while (setq day (pop dates))
3786 (setq day2 (car dates))
3788 (when (and day2 empty)
3789 (if (or (eq empty t)
3790 (and (numberp empty) (<= (- day2 day) empty)))
3791 (while (< (setq day (1+ day)) day2)
3792 (push (list day) dates1))
3793 (push (cons :omitted (- day2 day)) dates1))))
3794 (setq dates (nreverse dates1)))
3797 ;;; Agenda Daily/Weekly
3799 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3800 "Start day for the agenda view.
3801 Custom commands can set this variable in the options section.")
3802 (defvar org-starting-day nil) ; local variable in the agenda buffer
3803 (defvar org-arg-loc nil) ; local variable
3805 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3806 "List of types searched for when creating the daily/weekly agenda.
3807 This variable is a list of symbols that controls the types of
3808 items that appear in the daily/weekly agenda. Allowed symbols in this
3811 :timestamp List items containing a date stamp or date range matching
3812 the selected date. This includes sexp entries in
3815 :sexp List entries resulting from plain diary-like sexps.
3817 :deadline List deadline due on that date. When the date is today,
3818 also list any deadlines past due, or due within
3819 `org-deadline-warning-days'. `:deadline' must appear before
3820 `:scheduled' if the setting of
3821 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3824 :scheduled List all items which are scheduled for the given date.
3825 The diary for *today* also contains items which were
3826 scheduled earlier and are not yet marked DONE.
3828 By default, all four types are turned on.
3830 Never set this variable globally using `setq', because then it
3831 will apply to all future agenda commands. Instead, bind it with
3832 `let' to scope it dynamically into the agenda-constructing
3833 command. A good way to set it is through options in
3834 `org-agenda-custom-commands'. For a more flexible (though
3835 somewhat less efficient) way of determining what is included in
3836 the daily/weekly agenda, see `org-agenda-skip-function'.")
3838 (defvar org-agenda-buffer-tmp-name nil)
3840 (defun org-agenda-list (&optional arg start-day span)
3841 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3842 The view will be for the current day or week, but from the overview buffer
3843 you will be able to go to other days/weeks.
3845 With a numeric prefix argument in an interactive call, the agenda will
3846 span ARG days. Lisp programs should instead specify SPAN to change
3847 the number of days. SPAN defaults to `org-agenda-span'.
3849 START-DAY defaults to TODAY, or to the most recent match for the weekday
3850 given in `org-agenda-start-on-weekday'."
3852 (if org-agenda-overriding-arguments
3853 (setq arg (car org-agenda-overriding-arguments)
3854 start-day (nth 1 org-agenda-overriding-arguments)
3855 span (nth 2 org-agenda-overriding-arguments)))
3856 (if (and (integerp arg) (> arg 0))
3857 (setq span arg arg nil))
3859 (setq org-agenda-buffer-name
3860 (or org-agenda-buffer-tmp-name
3861 (if org-agenda-sticky
3862 (cond ((and org-keys (stringp org-match))
3863 (format "*Org Agenda(%s:%s)*" org-keys org-match))
3865 (format "*Org Agenda(%s)*" org-keys))
3866 (t "*Org Agenda(a)*")))
3867 org-agenda-buffer-name))
3868 (org-agenda-prepare "Day/Week")
3869 (setq start-day (or start-day org-agenda-start-day))
3870 (if (stringp start-day)
3871 ;; Convert to an absolute day number
3872 (setq start-day (time-to-days (org-read-date nil t start-day))))
3873 (org-compile-prefix-format 'agenda)
3874 (org-set-sorting-strategy 'agenda)
3875 (let* ((span (org-agenda-ndays-to-span
3876 (or span org-agenda-ndays org-agenda-span)))
3878 (sd (or start-day today))
3879 (ndays (org-agenda-span-to-ndays span sd))
3880 (org-agenda-start-on-weekday
3882 org-agenda-start-on-weekday))
3883 (thefiles (org-agenda-files nil 'ifmode))
3885 (start (if (or (null org-agenda-start-on-weekday)
3888 (let* ((nt (calendar-day-of-week
3889 (calendar-gregorian-from-absolute sd)))
3890 (n1 org-agenda-start-on-weekday)
3892 (- sd (+ (if (< d 0) 7 0) d)))))
3893 (day-numbers (list start))
3895 (inhibit-redisplay (not debug-on-error))
3896 (org-agenda-show-log-scoped org-agenda-show-log)
3897 s e rtn rtnall file date d start-pos end-pos todayp
3898 clocktable-start clocktable-end filter)
3899 (setq org-agenda-redo-command
3900 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3901 (dotimes (n (1- ndays))
3902 (push (1+ (car day-numbers)) day-numbers))
3903 (setq day-numbers (nreverse day-numbers))
3904 (setq clocktable-start (car day-numbers)
3905 clocktable-end (1+ (or (org-last day-numbers) 0)))
3906 (org-set-local 'org-starting-day (car day-numbers))
3907 (org-set-local 'org-arg-loc arg)
3908 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3909 (unless org-agenda-compact-blocks
3910 (let* ((d1 (car day-numbers))
3911 (d2 (org-last day-numbers))
3912 (w1 (org-days-to-iso-week d1))
3913 (w2 (org-days-to-iso-week d2)))
3915 (if org-agenda-overriding-header
3916 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3917 nil 'face 'org-agenda-structure) "\n")
3918 (insert (org-agenda-span-name span)
3920 (if (< (- d2 d1) 350)
3922 (format " (W%02d)" w1)
3923 (format " (W%02d-W%02d)" w1 w2))
3926 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3928 (org-agenda-mark-header-line s))
3929 (while (setq d (pop day-numbers))
3930 (setq date (calendar-gregorian-from-absolute d)
3932 (if (or (setq todayp (= d today))
3933 (and (not start-pos) (= d sd)))
3934 (setq start-pos (point))
3935 (if (and start-pos (not end-pos))
3936 (setq end-pos (point))))
3937 (setq files thefiles
3939 (while (setq file (pop files))
3941 (org-check-agenda-file file)
3942 (let ((org-agenda-entry-types org-agenda-entry-types))
3943 (unless org-agenda-include-deadlines
3944 (setq org-agenda-entry-types
3945 (delq :deadline org-agenda-entry-types)))
3947 ((memq org-agenda-show-log-scoped '(only clockcheck))
3948 (setq rtn (org-agenda-get-day-entries
3949 file date :closed)))
3950 (org-agenda-show-log-scoped
3951 (setq rtn (apply 'org-agenda-get-day-entries
3953 (append '(:closed) org-agenda-entry-types))))
3955 (setq rtn (apply 'org-agenda-get-day-entries
3957 org-agenda-entry-types)))))
3958 (setq rtnall (append rtnall rtn)))) ;; all entries
3959 (if org-agenda-include-diary
3960 (let ((org-agenda-search-headline-for-time t))
3961 (require 'diary-lib)
3962 (setq rtn (org-get-entries-from-diary date))
3963 (setq rtnall (append rtnall rtn))))
3964 (if (or rtnall org-agenda-show-all-dates)
3966 (setq day-cnt (1+ day-cnt))
3968 (if (stringp org-agenda-format-date)
3969 (format-time-string org-agenda-format-date
3970 (org-time-from-absolute date))
3971 (funcall org-agenda-format-date date))
3973 (put-text-property s (1- (point)) 'face
3974 (org-agenda-get-day-face date))
3975 (put-text-property s (1- (point)) 'org-date-line t)
3976 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3977 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3979 (put-text-property s (1- (point)) 'org-today t))
3981 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
3982 (if rtnall (insert ;; all entries
3983 (org-agenda-finalize-entries rtnall)
3985 (put-text-property s (1- (point)) 'day d)
3986 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3987 (when (and org-agenda-clockreport-mode clocktable-start)
3988 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3989 ;; the above line is to ensure the restricted range!
3990 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3992 (setq p (org-plist-delete p :block))
3993 (setq p (plist-put p :tstart clocktable-start))
3994 (setq p (plist-put p :tend clocktable-end))
3995 (setq p (plist-put p :scope 'agenda))
3996 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3997 (setq filter (or org-agenda-tag-filter-while-redo
3998 (get 'org-agenda-tag-filter :preset-filter))))
3999 (setq p (plist-put p :tags (mapconcat (lambda (x)
4000 (if (string-match "[<>=]" x)
4004 (setq tbl (apply 'org-get-clocktable p))
4006 (goto-char (point-min))
4007 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4008 (unless (and (pos-visible-in-window-p (point-min))
4009 (pos-visible-in-window-p (point-max)))
4010 (goto-char (1- (point-max)))
4012 (if (not (pos-visible-in-window-p (or start-pos 1)))
4014 (goto-char (or start-pos 1))
4016 (goto-char (or start-pos 1))
4017 (add-text-properties (point-min) (point-max)
4018 `(org-agenda-type agenda
4019 org-last-args (,arg ,start-day ,span)
4020 org-redo-cmd ,org-agenda-redo-command
4021 org-serie-cmd ,org-cmd))
4022 (if (eq org-agenda-show-log-scoped 'clockcheck)
4023 (org-agenda-show-clocking-issues))
4024 (org-agenda-finalize)
4025 (setq buffer-read-only t)
4028 (defun org-agenda-ndays-to-span (n)
4029 "Return a span symbol for a span of N days, or N if none matches."
4030 (cond ((symbolp n) n)
4035 (defun org-agenda-span-to-ndays (span &optional start-day)
4036 "Return ndays from SPAN, possibly starting at START-DAY."
4037 (cond ((numberp span) span)
4041 (let ((date (calendar-gregorian-from-absolute start-day)))
4042 (calendar-last-day-of-month (car date) (caddr date))))
4044 (let ((date (calendar-gregorian-from-absolute start-day)))
4045 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4047 (defun org-agenda-span-name (span)
4048 "Return a SPAN name."
4052 (capitalize (symbol-name span))
4053 (format "%d days" span))))
4055 ;;; Agenda word search
4057 (defvar org-agenda-search-history nil)
4059 (defvar org-search-syntax-table nil
4060 "Special syntax table for org-mode search.
4061 In this table, we have single quotes not as word constituents, to
4062 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4064 (defvar org-mode-syntax-table) ; From org.el
4065 (defun org-search-syntax-table ()
4066 (unless org-search-syntax-table
4067 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4068 (modify-syntax-entry ?' "." org-search-syntax-table)
4069 (modify-syntax-entry ?` "." org-search-syntax-table))
4070 org-search-syntax-table)
4072 (defvar org-agenda-last-search-view-search-was-boolean nil)
4075 (defun org-search-view (&optional todo-only string edit-at)
4076 "Show all entries that contain a phrase or words or regular expressions.
4078 With optional prefix argument TODO-ONLY, only consider entries that are
4079 TODO entries. The argument STRING can be used to pass a default search
4080 string into this function. If EDIT-AT is non-nil, it means that the
4081 user should get a chance to edit this string, with cursor at position
4084 The search string can be viewed either as a phrase that should be found as
4085 is, or it can be broken into a number of snippets, each of which must match
4086 in a Boolean way to select an entry. The default depends on the variable
4087 `org-agenda-search-view-always-boolean'.
4088 Even if this is turned off (the default) you can always switch to
4089 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4091 The default is a direct search of the whole phrase, where each space in
4092 the search string can expand to an arbitrary amount of whitespace,
4095 If using a Boolean search, the search string is split on whitespace and
4096 each snippet is searched separately, with logical AND to select an entry.
4097 Words prefixed with a minus must *not* occur in the entry. Words without
4098 a prefix or prefixed with a plus must occur in the entry. Matching is
4099 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4100 match whole words, not parts of a word) if
4101 `org-agenda-search-view-force-full-words' is set (default is nil).
4103 Boolean search snippets enclosed by curly braces are interpreted as
4104 regular expressions that must or (when preceded with \"-\") must not
4105 match in the entry. Snippets enclosed into double quotes will be taken
4106 as a whole, to include whitespace.
4108 - If the search string starts with an asterisk, search only in headlines.
4109 - If (possibly after the leading star) the search string starts with an
4110 exclamation mark, this also means to look at TODO entries only, an effect
4111 that can also be achieved with a prefix argument.
4112 - If (possibly after star and exclamation mark) the search string starts
4113 with a colon, this will mean that the (non-regexp) snippets of the
4114 Boolean search must match as full words.
4116 This command searches the agenda files, and in addition the files listed
4117 in `org-agenda-text-search-extra-files'."
4119 (if org-agenda-overriding-arguments
4120 (setq todo-only (car org-agenda-overriding-arguments)
4121 string (nth 1 org-agenda-overriding-arguments)
4122 edit-at (nth 2 org-agenda-overriding-arguments)))
4123 (let* ((props (list 'face nil
4124 'done-face 'org-agenda-done
4125 'org-not-done-regexp org-not-done-regexp
4126 'org-todo-regexp org-todo-regexp
4127 'org-complex-heading-regexp org-complex-heading-regexp
4128 'mouse-face 'highlight
4129 'help-echo (format "mouse-2 or RET jump to location")))
4130 (full-words org-agenda-search-view-force-full-words)
4131 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4132 regexp rtn rtnall files file pos
4133 marker category category-pos tags c neg re boolean
4134 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4135 (unless (and (not edit-at)
4137 (string-match "\\S-" string))
4138 (setq string (read-string
4139 (if org-agenda-search-view-always-boolean
4140 "[+-]Word/{Regexp} ...: "
4141 "Phrase or [+-]Word/{Regexp} ...: ")
4143 ((integerp edit-at) (cons string edit-at))
4145 'org-agenda-search-history)))
4147 (if org-agenda-sticky
4148 (setq org-agenda-buffer-name
4149 (if (stringp string)
4150 (format "*Org Agenda(%s:%s)*"
4151 (or org-keys (or (and todo-only "S") "s")) string)
4152 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4153 (org-agenda-prepare "SEARCH")
4154 (org-compile-prefix-format 'search)
4155 (org-set-sorting-strategy 'search)
4156 (setq org-agenda-redo-command
4157 (list 'org-search-view (if todo-only t nil)
4158 (list 'if 'current-prefix-arg nil string)))
4159 (setq org-agenda-query-string string)
4160 (if (equal (string-to-char string) ?*)
4162 words (substring string 1))
4163 (setq words string))
4164 (when (equal (string-to-char words) ?!)
4166 words (substring words 1)))
4167 (when (equal (string-to-char words) ?:)
4169 words (substring words 1)))
4170 (if (or org-agenda-search-view-always-boolean
4171 (member (string-to-char words) '(?- ?+ ?\{)))
4173 (setq words (org-split-string words))
4175 (while (setq w (pop words))
4176 (while (and (string-match "\\\\\\'" w) words)
4177 (setq w (concat (substring w 0 -1) " " (pop words))))
4179 (setq words (nreverse www) www nil)
4180 (while (setq w (pop words))
4181 (when (and (string-match "\\`[-+]?{" w)
4182 (not (string-match "}\\'" w)))
4183 (while (and words (not (string-match "}\\'" (car words))))
4184 (setq w (concat w " " (pop words))))
4185 (setq w (concat w " " (pop words))))
4187 (setq words (nreverse www)))
4188 (setq org-agenda-last-search-view-search-was-boolean boolean)
4191 (while (setq w (pop words))
4192 (if (or (equal (substring w 0 1) "\"")
4193 (and (> (length w) 1)
4194 (member (substring w 0 1) '("+" "-"))
4195 (equal (substring w 1 2) "\"")))
4196 (while (and words (not (equal (substring w -1) "\"")))
4197 (setq w (concat w " " (pop words)))))
4198 (and (string-match "\\`\\([-+]?\\)\"" w)
4199 (setq w (replace-match "\\1" nil nil w)))
4200 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4202 (setq words (nreverse wds))))
4205 (setq c (string-to-char w))
4207 (setq neg t w (substring w 1))
4209 (setq neg nil w (substring w 1))
4211 (if (string-match "\\`{.*}\\'" w)
4212 (setq re (substring w 1 -1))
4214 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4215 (setq re (regexp-quote (downcase w)))))
4216 (if neg (push re regexps-) (push re regexps+)))
4218 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4220 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4222 (setq regexp org-outline-regexp-bol)
4223 (setq regexp (pop regexps+))
4224 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4226 (setq files (org-agenda-files nil 'ifmode))
4227 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4228 (pop org-agenda-text-search-extra-files)
4229 (setq files (org-add-archive-files files)))
4230 (setq files (append files org-agenda-text-search-extra-files)
4232 (while (setq file (pop files))
4235 (org-check-agenda-file file)
4236 (setq buffer (if (file-exists-p file)
4237 (org-get-agenda-file-buffer file)
4238 (error "No such file %s" file)))
4240 ;; If file does not exist, make sure an error message is sent
4241 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4243 (with-current-buffer buffer
4244 (with-syntax-table (org-search-syntax-table)
4245 (unless (derived-mode-p 'org-mode)
4246 (error "Agenda file %s is not in `org-mode'" file))
4247 (let ((case-fold-search t))
4250 (if org-agenda-restrict
4251 (narrow-to-region org-agenda-restrict-begin
4252 org-agenda-restrict-end)
4254 (goto-char (point-min))
4255 (unless (or (org-at-heading-p)
4256 (outline-next-heading))
4257 (throw 'nextfile t))
4258 (goto-char (max (point-min) (1- (point))))
4259 (while (re-search-forward regexp nil t)
4260 (org-back-to-heading t)
4261 (skip-chars-forward "* ")
4262 (setq beg (point-at-bol)
4264 end (progn (outline-next-heading) (point)))
4268 (setq str (buffer-substring-no-properties
4270 (if hdl-only (point-at-eol) end)))
4271 (mapc (lambda (wr) (when (string-match wr str)
4272 (goto-char (1- end))
4275 (mapc (lambda (wr) (unless (string-match wr str)
4276 (goto-char (1- end))
4279 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4283 (setq marker (org-agenda-new-marker (point))
4284 category (org-get-category)
4285 category-pos (get-text-property (point) 'org-category-position)
4286 tags (org-get-tags-at (point))
4287 txt (org-agenda-format-item
4289 (buffer-substring-no-properties
4290 beg1 (point-at-eol))
4292 (org-add-props txt props
4293 'org-marker marker 'org-hd-marker marker
4294 'org-todo-regexp org-todo-regexp
4295 'org-complex-heading-regexp org-complex-heading-regexp
4296 'priority 1000 'org-category category
4297 'org-category-position category-pos
4300 (goto-char (1- end))))))))))
4301 (setq rtn (nreverse ee))
4302 (setq rtnall (append rtnall rtn)))
4303 (if org-agenda-overriding-header
4304 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4305 nil 'face 'org-agenda-structure) "\n")
4306 (insert "Search words: ")
4307 (add-text-properties (point-min) (1- (point))
4308 (list 'face 'org-agenda-structure))
4310 (insert string "\n")
4311 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4313 (unless org-agenda-multi
4314 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4315 (add-text-properties pos (1- (point))
4316 (list 'face 'org-agenda-structure))))
4317 (org-agenda-mark-header-line (point-min))
4319 (insert (org-agenda-finalize-entries rtnall) "\n"))
4320 (goto-char (point-min))
4321 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4322 (add-text-properties (point-min) (point-max)
4323 `(org-agenda-type search
4324 org-last-args (,todo-only ,string ,edit-at)
4325 org-redo-cmd ,org-agenda-redo-command
4326 org-serie-cmd ,org-cmd))
4327 (org-agenda-finalize)
4328 (setq buffer-read-only t))))
4330 ;;; Agenda TODO list
4332 (defvar org-select-this-todo-keyword nil)
4333 (defvar org-last-arg nil)
4336 (defun org-todo-list (&optional arg)
4337 "Show all (not done) TODO entries from all agenda file in a single list.
4338 The prefix arg can be used to select a specific TODO keyword and limit
4339 the list to these. When using \\[universal-argument], you will be prompted
4340 for a keyword. A numeric prefix directly selects the Nth keyword in
4341 `org-todo-keywords-1'."
4343 (if org-agenda-overriding-arguments
4344 (setq arg org-agenda-overriding-arguments))
4345 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4346 (let* ((today (org-today))
4347 (date (calendar-gregorian-from-absolute today))
4348 (kwds org-todo-keywords-for-agenda)
4349 (completion-ignore-case t)
4350 (org-select-this-todo-keyword
4351 (if (stringp arg) arg
4352 (and arg (integerp arg) (> arg 0)
4353 (nth (1- arg) kwds))))
4354 rtn rtnall files file pos)
4355 (when (equal arg '(4))
4356 (setq org-select-this-todo-keyword
4357 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4358 (mapcar 'list kwds) nil nil)))
4359 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4361 (if org-agenda-sticky
4362 (setq org-agenda-buffer-name
4363 (if (stringp org-select-this-todo-keyword)
4364 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4365 org-select-this-todo-keyword)
4366 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4367 (org-agenda-prepare "TODO")
4368 (org-compile-prefix-format 'todo)
4369 (org-set-sorting-strategy 'todo)
4370 (setq org-agenda-redo-command
4371 `(org-todo-list (or current-prefix-arg (quote ,arg))))
4372 (setq files (org-agenda-files nil 'ifmode)
4374 (while (setq file (pop files))
4376 (org-check-agenda-file file)
4377 (setq rtn (org-agenda-get-day-entries file date :todo))
4378 (setq rtnall (append rtnall rtn))))
4379 (if org-agenda-overriding-header
4380 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4381 nil 'face 'org-agenda-structure) "\n")
4382 (insert "Global list of TODO items of type: ")
4383 (add-text-properties (point-min) (1- (point))
4384 (list 'face 'org-agenda-structure
4387 (or org-select-this-todo-keyword "ALL"))))
4388 (org-agenda-mark-header-line (point-min))
4390 (insert (or org-select-this-todo-keyword "ALL") "\n")
4391 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4393 (unless org-agenda-multi
4394 (insert "Available with `N r': (0)[ALL]")
4397 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4398 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4403 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4404 (org-agenda-mark-header-line (point-min))
4406 (insert (org-agenda-finalize-entries rtnall) "\n"))
4407 (goto-char (point-min))
4408 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4409 (add-text-properties (point-min) (point-max)
4410 `(org-agenda-type todo
4412 org-redo-cmd ,org-agenda-redo-command
4413 org-serie-cmd ,org-cmd))
4414 (org-agenda-finalize)
4415 (setq buffer-read-only t))))
4417 ;;; Agenda tags match
4420 (defun org-tags-view (&optional todo-only match)
4421 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4422 The prefix arg TODO-ONLY limits the search to TODO entries."
4424 (if org-agenda-overriding-arguments
4425 (setq todo-only (car org-agenda-overriding-arguments)
4426 match (nth 1 org-agenda-overriding-arguments)))
4427 (let* ((org-tags-match-list-sublevels
4428 org-tags-match-list-sublevels)
4429 (completion-ignore-case t)
4430 rtn rtnall files file pos matcher
4432 (when (and (stringp match) (not (string-match "\\S-" match)))
4434 (setq matcher (org-make-tags-matcher match)
4435 match (car matcher) matcher (cdr matcher))
4437 (if org-agenda-sticky
4438 (setq org-agenda-buffer-name
4440 (format "*Org Agenda(%s:%s)*"
4441 (or org-keys (or (and todo-only "M") "m")) match)
4442 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4443 (org-agenda-prepare (concat "TAGS " match))
4444 (org-compile-prefix-format 'tags)
4445 (org-set-sorting-strategy 'tags)
4446 (setq org-agenda-query-string match)
4447 (setq org-agenda-redo-command
4448 (list 'org-tags-view `(quote ,todo-only)
4449 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4450 (setq files (org-agenda-files nil 'ifmode)
4452 (while (setq file (pop files))
4454 (org-check-agenda-file file)
4455 (setq buffer (if (file-exists-p file)
4456 (org-get-agenda-file-buffer file)
4457 (error "No such file %s" file)))
4459 ;; If file does not exist, error message to agenda
4461 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4462 rtnall (append rtnall rtn))
4463 (with-current-buffer buffer
4464 (unless (derived-mode-p 'org-mode)
4465 (error "Agenda file %s is not in `org-mode'" file))
4468 (if org-agenda-restrict
4469 (narrow-to-region org-agenda-restrict-begin
4470 org-agenda-restrict-end)
4472 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4473 (setq rtnall (append rtnall rtn))))))))
4474 (if org-agenda-overriding-header
4475 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4476 nil 'face 'org-agenda-structure) "\n")
4477 (insert "Headlines with TAGS match: ")
4478 (add-text-properties (point-min) (1- (point))
4479 (list 'face 'org-agenda-structure
4481 (concat "Match: " match)))
4484 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4486 (unless org-agenda-multi
4487 (insert "Press `C-u r' to search again with new search string\n"))
4488 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4489 (org-agenda-mark-header-line (point-min))
4491 (insert (org-agenda-finalize-entries rtnall) "\n"))
4492 (goto-char (point-min))
4493 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4494 (add-text-properties (point-min) (point-max)
4495 `(org-agenda-type tags
4496 org-last-args (,todo-only ,match)
4497 org-redo-cmd ,org-agenda-redo-command
4498 org-serie-cmd ,org-cmd))
4499 (org-agenda-finalize)
4500 (setq buffer-read-only t))))
4502 ;;; Agenda Finding stuck projects
4504 (defvar org-agenda-skip-regexp nil
4505 "Regular expression used in skipping subtrees for the agenda.
4506 This is basically a temporary global variable that can be set and then
4507 used by user-defined selections using `org-agenda-skip-function'.")
4509 (defvar org-agenda-overriding-header nil
4510 "When set during agenda, todo and tags searches it replaces the header.
4511 This variable should not be set directly, but custom commands can bind it
4512 in the options section.")
4514 (defun org-agenda-skip-entry-when-regexp-matches ()
4515 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4516 If yes, it returns the end position of this entry, causing agenda commands
4517 to skip the entry but continuing the search in the subtree. This is a
4518 function that can be put into `org-agenda-skip-function' for the duration
4520 (let ((end (save-excursion (org-end-of-subtree t)))
4523 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4526 (defun org-agenda-skip-subtree-when-regexp-matches ()
4527 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4528 If yes, it returns the end position of this tree, causing agenda commands
4529 to skip this subtree. This is a function that can be put into
4530 `org-agenda-skip-function' for the duration of a command."
4531 (let ((end (save-excursion (org-end-of-subtree t)))
4534 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4537 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4538 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4539 If yes, it returns the end position of the current entry (NOT the tree),
4540 causing agenda commands to skip the entry but continuing the search in
4541 the subtree. This is a function that can be put into
4542 `org-agenda-skip-function' for the duration of a command. An important
4543 use of this function is for the stuck project list."
4544 (let ((end (save-excursion (org-end-of-subtree t)))
4545 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4548 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4549 (and skip entry-end)))
4551 (defun org-agenda-skip-entry-if (&rest conditions)
4552 "Skip entry if any of CONDITIONS is true.
4553 See `org-agenda-skip-if' for details."
4554 (org-agenda-skip-if nil conditions))
4556 (defun org-agenda-skip-subtree-if (&rest conditions)
4557 "Skip entry if any of CONDITIONS is true.
4558 See `org-agenda-skip-if' for details."
4559 (org-agenda-skip-if t conditions))
4561 (defun org-agenda-skip-if (subtree conditions)
4562 "Checks current entity for CONDITIONS.
4563 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4564 the entry (i.e. the text before the next heading) is checked.
4566 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4567 from different tests. Valid conditions are:
4569 scheduled Check if there is a scheduled cookie
4570 notscheduled Check if there is no scheduled cookie
4571 deadline Check if there is a deadline
4572 notdeadline Check if there is no deadline
4573 timestamp Check if there is a timestamp (also deadline or scheduled)
4574 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4575 regexp Check if regexp matches
4576 notregexp Check if regexp does not match.
4577 todo Check if TODO keyword matches
4578 nottodo Check if TODO keyword does not match
4580 The regexp is taken from the conditions list, it must come right after
4581 the `regexp' or `notregexp' element.
4583 `todo' and `nottodo' accept as an argument a list of todo
4584 keywords, which may include \"*\" to match any todo keyword.
4586 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4588 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4590 Instead of a list, a keyword class may be given. For example:
4592 (org-agenda-skip-entry-if 'nottodo 'done)
4594 would skip entries that haven't been marked with any of \"DONE\"
4595 keywords. Possible classes are: `todo', `done', `any'.
4597 If any of these conditions is met, this function returns the end point of
4598 the entity, causing the search to continue from there. This is a function
4599 that can be put into `org-agenda-skip-function' for the duration of a command."
4601 (org-back-to-heading t)
4604 (progn (org-end-of-subtree t) (point))
4605 (progn (outline-next-heading) (1- (point)))))
4609 (and (memq 'scheduled conditions)
4610 (re-search-forward org-scheduled-time-regexp end t))
4611 (and (memq 'notscheduled conditions)
4612 (not (re-search-forward org-scheduled-time-regexp end t)))
4613 (and (memq 'deadline conditions)
4614 (re-search-forward org-deadline-time-regexp end t))
4615 (and (memq 'notdeadline conditions)
4616 (not (re-search-forward org-deadline-time-regexp end t)))
4617 (and (memq 'timestamp conditions)
4618 (re-search-forward org-ts-regexp end t))
4619 (and (memq 'nottimestamp conditions)
4620 (not (re-search-forward org-ts-regexp end t)))
4621 (and (setq m (memq 'regexp conditions))
4623 (re-search-forward (nth 1 m) end t))
4624 (and (setq m (memq 'notregexp conditions))
4626 (not (re-search-forward (nth 1 m) end t)))
4628 (setq m (memq 'nottodo conditions))
4629 (setq m (memq 'todo-unblocked conditions))
4630 (setq m (memq 'nottodo-unblocked conditions))
4631 (setq m (memq 'todo conditions)))
4632 (org-agenda-skip-if-todo m end)))
4635 (defun org-agenda-skip-if-todo (args end)
4636 "Helper function for `org-agenda-skip-if', do not use it directly.
4637 ARGS is a list with first element either `todo', `nottodo',
4638 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4639 a list of TODO keywords, or a state symbol `todo' or `done' or
4641 (let ((kw (car args))
4647 ((listp arg) ;; list of keywords
4648 (if (member "*" arg)
4649 (mapcar 'substring-no-properties org-todo-keywords-1)
4651 ((symbolp arg) ;; keyword class name
4654 (org-delete-all org-done-keywords
4655 (mapcar 'substring-no-properties
4656 org-todo-keywords-1)))
4657 ((eq arg 'done) org-done-keywords)
4659 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4661 (concat "^\\*+[ \t]+\\<\\("
4662 (mapconcat 'identity todo-wds "\\|")
4665 ((eq kw 'todo) (re-search-forward todo-re end t))
4666 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4667 ((eq kw 'todo-unblocked)
4669 (while (re-search-forward todo-re end t)
4670 (or (org-entry-blocked-p) (throw 'unblocked t)))
4672 ((eq kw 'nottodo-unblocked)
4674 (while (re-search-forward todo-re end t)
4675 (or (org-entry-blocked-p) (throw 'unblocked nil)))
4680 (defun org-agenda-list-stuck-projects (&rest ignore)
4681 "Create agenda view for projects that are stuck.
4682 Stuck projects are project that have no next actions. For the definitions
4683 of what a project is and how to check if it stuck, customize the variable
4684 `org-stuck-projects'."
4686 (let* ((org-agenda-skip-function
4687 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4688 ;; We could have used org-agenda-skip-if here.
4689 (org-agenda-overriding-header
4690 (or org-agenda-overriding-header "List of stuck projects: "))
4691 (matcher (nth 0 org-stuck-projects))
4692 (todo (nth 1 org-stuck-projects))
4693 (todo-wds (if (member "*" todo)
4695 (org-agenda-prepare-buffers (org-agenda-files
4698 org-done-keywords-for-agenda
4699 (copy-sequence org-todo-keywords-for-agenda)))
4701 (todo-re (concat "^\\*+[ \t]+\\("
4702 (mapconcat 'identity todo-wds "\\|")
4704 (tags (nth 2 org-stuck-projects))
4705 (tags-re (if (member "*" tags)
4706 (concat org-outline-regexp-bol
4707 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4709 (concat org-outline-regexp-bol
4711 (mapconcat 'identity tags "\\|")
4712 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4713 (gen-re (nth 3 org-stuck-projects))
4719 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4721 (setq org-agenda-skip-regexp
4723 (mapconcat 'identity re-list "\\|")
4724 (error "No information how to identify unstuck projects")))
4725 (org-tags-view nil matcher)
4726 (with-current-buffer org-agenda-buffer-name
4727 (setq org-agenda-redo-command
4728 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
4730 ;;; Diary integration
4732 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4733 (defvar diary-list-entries-hook)
4734 (defvar diary-time-regexp)
4735 (defun org-get-entries-from-diary (date)
4736 "Get the (Emacs Calendar) diary entries for DATE."
4737 (require 'diary-lib)
4738 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4739 (diary-display-hook '(fancy-diary-display))
4740 (diary-display-function 'fancy-diary-display)
4742 (diary-list-entries-hook
4743 (cons 'org-diary-default-entry diary-list-entries-hook))
4744 (diary-file-name-prefix-function nil) ; turn this feature off
4745 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4747 (org-disable-agenda-to-diary t))
4749 (save-window-excursion
4750 (funcall (if (fboundp 'diary-list-entries)
4751 'diary-list-entries 'list-diary-entries)
4753 (if (not (get-buffer diary-fancy-buffer))
4755 (with-current-buffer diary-fancy-buffer
4756 (setq buffer-read-only nil)
4757 (if (zerop (buffer-size))
4760 ;; Omit the date and other unnecessary stuff
4761 (org-agenda-cleanup-fancy-diary)
4762 ;; Add prefix to each line and extend the text properties
4763 (if (zerop (buffer-size))
4765 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4768 (insert entries) (goto-char (point-min))
4769 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4770 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4771 (replace-match (concat "; " (match-string 1)))))
4773 (set-buffer-modified-p nil)
4774 (kill-buffer diary-fancy-buffer)))
4776 (setq entries (org-split-string entries "\n"))
4780 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4781 ;; Extend the text properties to the beginning of the line
4782 (org-add-props x (text-properties-at (1- (length x)) x)
4783 'type "diary" 'date date 'face 'org-agenda-diary))
4786 (defvar org-agenda-cleanup-fancy-diary-hook nil
4787 "Hook run when the fancy diary buffer is cleaned up.")
4789 (defun org-agenda-cleanup-fancy-diary ()
4790 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4791 This gets rid of the date, the underline under the date, and
4792 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4793 date. It also removes lines that contain only whitespace."
4794 (goto-char (point-min))
4795 (if (looking-at ".*?:[ \t]*")
4798 (re-search-forward "\n=+$" nil t)
4800 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4801 (re-search-forward "\n=+$" nil t)
4802 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4803 (goto-char (point-min))
4804 (while (re-search-forward "^ +\n" nil t)
4806 (goto-char (point-min))
4807 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4809 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4811 ;; Make sure entries from the diary have the right text properties.
4812 (eval-after-load "diary-lib"
4813 '(if (boundp 'diary-modify-entry-list-string-function)
4814 ;; We can rely on the hook, nothing to do
4816 ;; Hook not available, must use advice to make this work
4817 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4818 "Make the position visible."
4819 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4822 (setq string (org-modify-diary-entry-string string))))))
4824 (defun org-modify-diary-entry-string (string)
4825 "Add text properties to string, allowing org-mode to act on it."
4826 (org-add-props string nil
4827 'mouse-face 'highlight
4828 'help-echo (if buffer-file-name
4829 (format "mouse-2 or RET jump to diary file %s"
4830 (abbreviate-file-name buffer-file-name))
4832 'org-agenda-diary-link t
4833 'org-marker (org-agenda-new-marker (point-at-bol))))
4835 (defun org-diary-default-entry ()
4836 "Add a dummy entry to the diary.
4837 Needed to avoid empty dates which mess up holiday display."
4838 ;; Catch the error if dealing with the new add-to-diary-alist
4839 (when org-disable-agenda-to-diary
4841 (org-add-to-diary-list original-date "Org-mode dummy" "")
4843 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4845 (defun org-add-to-diary-list (&rest args)
4846 (if (fboundp 'diary-add-to-list)
4847 (apply 'diary-add-to-list args)
4848 (apply 'add-to-diary-list args)))
4850 (defvar org-diary-last-run-time nil)
4853 (defun org-diary (&rest args)
4854 "Return diary information from org files.
4855 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4856 It accesses org files and extracts information from those files to be
4857 listed in the diary. The function accepts arguments specifying what
4858 items should be listed. For a list of arguments allowed here, see the
4859 variable `org-agenda-entry-types'.
4861 The call in the diary file should look like this:
4863 &%%(org-diary) ~/path/to/some/orgfile.org
4865 Use a separate line for each org file to check. Or, if you omit the file name,
4866 all files listed in `org-agenda-files' will be checked automatically:
4870 If you don't give any arguments (as in the example above), the default
4871 arguments (:deadline :scheduled :timestamp :sexp) are used.
4872 So the example above may also be written as
4874 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4876 The function expects the lisp variables `entry' and `date' to be provided
4877 by the caller, because this is how the calendar works. Don't use this
4878 function from a program - use `org-agenda-get-day-entries' instead."
4879 (when (> (- (org-float-time)
4880 org-agenda-last-marker-time)
4882 ;; I am not sure if this works with sticky agendas, because the marker
4883 ;; list is then no longer a global variable.
4884 (org-agenda-reset-markers))
4885 (org-compile-prefix-format 'agenda)
4886 (org-set-sorting-strategy 'agenda)
4887 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4888 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4890 (org-agenda-files t)))
4891 (time (org-float-time))
4893 (when (or (not org-diary-last-run-time)
4895 org-diary-last-run-time)
4897 (org-agenda-prepare-buffers files))
4898 (setq org-diary-last-run-time time)
4899 ;; If this is called during org-agenda, don't return any entries to
4900 ;; the calendar. Org Agenda will list these entries itself.
4901 (if org-disable-agenda-to-diary (setq files nil))
4902 (while (setq file (pop files))
4903 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4904 (setq results (append results rtn)))
4906 (concat (org-agenda-finalize-entries results) "\n"))))
4908 ;;; Agenda entry finders
4910 (defun org-agenda-get-day-entries (file date &rest args)
4911 "Does the work for `org-diary' and `org-agenda'.
4912 FILE is the path to a file to be checked for entries. DATE is date like
4913 the one returned by `calendar-current-date'. ARGS are symbols indicating
4914 which kind of entries should be extracted. For details about these, see
4915 the documentation of `org-diary'."
4916 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4917 (let* ((org-startup-folded nil)
4918 (org-startup-align-all-tables nil)
4919 (buffer (if (file-exists-p file)
4920 (org-get-agenda-file-buffer file)
4921 (error "No such file %s" file)))
4922 arg results rtn deadline-results)
4924 ;; If file does not exist, make sure an error message ends up in diary
4925 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4926 (with-current-buffer buffer
4927 (unless (derived-mode-p 'org-mode)
4928 (error "Agenda file %s is not in `org-mode'" file))
4929 (setq org-agenda-buffer (or org-agenda-buffer buffer))
4930 (let ((case-fold-search nil))
4933 (if org-agenda-restrict
4934 (narrow-to-region org-agenda-restrict-begin
4935 org-agenda-restrict-end)
4937 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4938 (while (setq arg (pop args))
4940 ((and (eq arg :todo)
4941 (equal date (calendar-gregorian-from-absolute
4943 (setq rtn (org-agenda-get-todos))
4944 (setq results (append results rtn)))
4945 ((eq arg :timestamp)
4946 (setq rtn (org-agenda-get-blocks))
4947 (setq results (append results rtn))
4948 (setq rtn (org-agenda-get-timestamps deadline-results))
4949 (setq results (append results rtn)))
4951 (setq rtn (org-agenda-get-sexps))
4952 (setq results (append results rtn)))
4953 ((eq arg :scheduled)
4954 (setq rtn (org-agenda-get-scheduled deadline-results))
4955 (setq results (append results rtn)))
4957 (setq rtn (org-agenda-get-progress))
4958 (setq results (append results rtn)))
4960 (setq rtn (org-agenda-get-deadlines))
4961 (setq deadline-results (copy-sequence rtn))
4962 (setq results (append results rtn))))))))
4965 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4966 (defun org-agenda-get-todos ()
4967 "Return the TODO information for agenda display."
4968 (let* ((props (list 'face nil
4969 'done-face 'org-agenda-done
4970 'org-not-done-regexp org-not-done-regexp
4971 'org-todo-regexp org-todo-regexp
4972 'org-complex-heading-regexp org-complex-heading-regexp
4973 'mouse-face 'highlight
4975 (format "mouse-2 or RET jump to org file %s"
4976 (abbreviate-file-name buffer-file-name))))
4977 (regexp (format org-heading-keyword-regexp-format
4979 ((and org-select-this-todo-keyword
4980 (equal org-select-this-todo-keyword "*"))
4982 (org-select-this-todo-keyword
4984 (mapconcat 'identity
4986 org-select-this-todo-keyword
4989 (t org-not-done-regexp))))
4990 marker priority category category-pos tags todo-state
4992 (goto-char (point-min))
4993 (while (re-search-forward regexp nil t)
4998 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4999 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5000 (goto-char (1+ beg))
5001 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5003 (goto-char (match-beginning 2))
5004 (setq marker (org-agenda-new-marker (match-beginning 0))
5005 category (org-get-category)
5006 category-pos (get-text-property (point) 'org-category-position)
5008 (buffer-substring (match-beginning 2) (match-end 0)))
5009 tags (org-get-tags-at (point))
5010 txt (org-agenda-format-item "" txt category tags)
5011 priority (1+ (org-get-priority txt))
5012 todo-state (org-get-todo-state))
5013 (org-add-props txt props
5014 'org-marker marker 'org-hd-marker marker
5015 'priority priority 'org-category category
5016 'org-category-position category-pos
5017 'type "todo" 'todo-state todo-state)
5019 (if org-agenda-todo-list-sublevels
5020 (goto-char (match-end 2))
5021 (org-end-of-subtree 'invisible))))
5024 (defun org-agenda-todo-custom-ignore-p (time n)
5025 "Check whether timestamp is farther away then n number of days.
5026 This function is invoked if `org-agenda-todo-ignore-deadlines',
5027 `org-agenda-todo-ignore-scheduled' or
5028 `org-agenda-todo-ignore-timestamp' is set to an integer."
5029 (let ((days (org-days-to-time time)))
5035 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5037 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5038 (when (or org-agenda-todo-ignore-with-date
5039 org-agenda-todo-ignore-scheduled
5040 org-agenda-todo-ignore-deadlines
5041 org-agenda-todo-ignore-timestamp)
5042 (setq end (or end (save-excursion (outline-next-heading) (point))))
5044 (or (and org-agenda-todo-ignore-with-date
5045 (re-search-forward org-ts-regexp end t))
5046 (and org-agenda-todo-ignore-scheduled
5047 (re-search-forward org-scheduled-time-regexp end t)
5049 ((eq org-agenda-todo-ignore-scheduled 'future)
5050 (> (org-days-to-time (match-string 1)) 0))
5051 ((eq org-agenda-todo-ignore-scheduled 'past)
5052 (<= (org-days-to-time (match-string 1)) 0))
5053 ((numberp org-agenda-todo-ignore-scheduled)
5054 (org-agenda-todo-custom-ignore-p
5055 (match-string 1) org-agenda-todo-ignore-scheduled))
5057 (and org-agenda-todo-ignore-deadlines
5058 (re-search-forward org-deadline-time-regexp end t)
5060 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5061 ((eq org-agenda-todo-ignore-deadlines 'far)
5062 (not (org-deadline-close (match-string 1))))
5063 ((eq org-agenda-todo-ignore-deadlines 'future)
5064 (> (org-days-to-time (match-string 1)) 0))
5065 ((eq org-agenda-todo-ignore-deadlines 'past)
5066 (<= (org-days-to-time (match-string 1)) 0))
5067 ((numberp org-agenda-todo-ignore-deadlines)
5068 (org-agenda-todo-custom-ignore-p
5069 (match-string 1) org-agenda-todo-ignore-deadlines))
5070 (t (org-deadline-close (match-string 1)))))
5071 (and org-agenda-todo-ignore-timestamp
5072 (let ((buffer (current-buffer))
5075 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5077 ;; Copy current buffer into a temporary one
5079 (insert-buffer-substring buffer start end)
5080 (goto-char (point-min))
5081 ;; Delete SCHEDULED and DEADLINE items
5082 (while (re-search-forward regexp end t)
5083 (delete-region (match-beginning 0) (match-end 0)))
5084 (goto-char (point-min))
5085 ;; No search for timestamp left
5086 (when (re-search-forward org-ts-regexp nil t)
5088 ((eq org-agenda-todo-ignore-timestamp 'future)
5089 (> (org-days-to-time (match-string 1)) 0))
5090 ((eq org-agenda-todo-ignore-timestamp 'past)
5091 (<= (org-days-to-time (match-string 1)) 0))
5092 ((numberp org-agenda-todo-ignore-timestamp)
5093 (org-agenda-todo-custom-ignore-p
5094 (match-string 1) org-agenda-todo-ignore-timestamp))
5097 (defconst org-agenda-no-heading-message
5098 "No heading for this item in buffer or region.")
5100 (defun org-agenda-get-timestamps (&optional deadline-results)
5101 "Return the date stamp information for agenda display."
5102 (let* ((props (list 'face 'org-agenda-calendar-event
5103 'org-not-done-regexp org-not-done-regexp
5104 'org-todo-regexp org-todo-regexp
5105 'org-complex-heading-regexp org-complex-heading-regexp
5106 'mouse-face 'highlight
5108 (format "mouse-2 or RET jump to org file %s"
5109 (abbreviate-file-name buffer-file-name))))
5110 (d1 (calendar-absolute-from-gregorian date))
5112 (deadline-position-alist
5113 (mapcar (lambda (a) (and (setq mm (get-text-property
5114 0 'org-hd-marker a))
5115 (cons (marker-position mm) a)))
5117 (remove-re org-ts-regexp)
5120 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5124 (car org-time-stamp-formats)
5125 (apply 'encode-time ; DATE bound by calendar
5126 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5128 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5129 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5130 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5131 donep tmp priority category category-pos ee txt timestr tags
5132 b0 b3 e3 head todo-state end-of-match show-all warntime)
5133 (goto-char (point-min))
5134 (while (setq end-of-match (re-search-forward regexp nil t))
5135 (setq b0 (match-beginning 0)
5136 b3 (match-beginning 3) e3 (match-end 3)
5137 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5138 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5140 org-agenda-repeating-timestamp-show-all)))
5142 (and (org-at-date-range-p) (throw :skip nil))
5144 (if (and (match-end 1)
5145 (not (= d1 (org-time-string-to-absolute
5146 (match-string 1) d1 nil show-all
5147 (current-buffer) b0))))
5150 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5152 (setq tmp (buffer-substring (max (point-min)
5153 (- b0 org-ds-keyword-length))
5155 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5156 inactivep (= (char-after b0) ?\[)
5157 deadlinep (string-match org-deadline-regexp tmp)
5158 scheduledp (string-match org-scheduled-regexp tmp)
5159 closedp (and org-agenda-include-inactive-timestamps
5160 (string-match org-closed-string tmp))
5161 clockp (and org-agenda-include-inactive-timestamps
5162 (or (string-match org-clock-string tmp)
5163 (string-match "]-+\\'" tmp)))
5164 warntime (org-entry-get (point) "APPT_WARNTIME")
5165 donep (member todo-state org-done-keywords))
5166 (if (or scheduledp deadlinep closedp clockp
5167 (and donep org-agenda-skip-timestamp-if-done))
5169 (if (string-match ">" timestr)
5170 ;; substring should only run to end of time stamp
5171 (setq timestr (substring timestr 0 (match-end 0))))
5172 (setq marker (org-agenda-new-marker b0)
5173 category (org-get-category b0)
5174 category-pos (get-text-property b0 'org-category-position))
5176 (if (not (re-search-backward org-outline-regexp-bol nil t))
5177 (setq txt org-agenda-no-heading-message)
5178 (goto-char (match-beginning 0))
5179 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5180 (assoc (point) deadline-position-alist))
5182 (setq hdmarker (org-agenda-new-marker)
5183 tags (org-get-tags-at))
5184 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5185 (setq head (or (match-string 1) ""))
5186 (setq txt (org-agenda-format-item
5187 (if inactivep org-agenda-inactive-leader nil)
5188 head category tags timestr
5190 (setq priority (org-get-priority txt))
5191 (org-add-props txt props
5192 'org-marker marker 'org-hd-marker hdmarker)
5193 (org-add-props txt nil 'priority priority
5194 'org-category category 'date date
5195 'org-category-position category-pos
5196 'todo-state todo-state
5200 (if org-agenda-skip-additional-timestamps-same-entry
5201 (outline-next-heading)
5202 (goto-char end-of-match))))
5205 (defun org-agenda-get-sexps ()
5206 "Return the sexp information for agenda display."
5207 (require 'diary-lib)
5208 (let* ((props (list 'face 'org-agenda-calendar-sexp
5209 'mouse-face 'highlight
5211 (format "mouse-2 or RET jump to org file %s"
5212 (abbreviate-file-name buffer-file-name))))
5214 marker category extra category-pos ee txt tags entry
5215 result beg b sexp sexp-entry todo-state warntime)
5216 (goto-char (point-min))
5217 (while (re-search-forward regexp nil t)
5220 (setq beg (match-beginning 0))
5221 (goto-char (1- (match-end 0)))
5224 (setq sexp (buffer-substring b (point)))
5225 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5226 (org-trim (match-string 1))
5228 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5230 (setq marker (org-agenda-new-marker beg)
5231 category (org-get-category beg)
5232 category-pos (get-text-property beg 'org-category-position)
5233 tags (save-excursion (org-backward-heading-same-level 0)
5235 todo-state (org-get-todo-state)
5236 warntime (org-entry-get (point) "APPT_WARNTIME"))
5238 (dolist (r (if (stringp result)
5240 result)) ;; we expect a list here
5241 (when (and org-agenda-diary-sexp-prefix
5242 (string-match org-agenda-diary-sexp-prefix r))
5243 (setq extra (match-string 0 r)
5244 r (replace-match "" nil nil r)))
5245 (if (string-match "\\S-" r)
5247 (setq txt "SEXP entry returned empty string"))
5249 (setq txt (org-agenda-format-item
5250 extra txt category tags 'time))
5251 (org-add-props txt props 'org-marker marker)
5252 (org-add-props txt nil
5253 'org-category category 'date date 'todo-state todo-state
5254 'org-category-position category-pos 'tags tags
5255 'type "sexp" 'warntime warntime)
5259 ;; Calendar sanity: define some functions that are independent of
5260 ;; `calendar-date-style'.
5261 ;; Normally I would like to use ISO format when calling the diary functions,
5262 ;; but to make sure we still have Emacs 22 compatibility we bind
5263 ;; also `european-calendar-style' and use european format
5264 (defun org-anniversary (year month day &optional mark)
5265 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5267 (let ((calendar-date-style 'european) (european-calendar-style t))
5268 (diary-anniversary day month year mark))))
5269 (defun org-cyclic (N year month day &optional mark)
5270 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5272 (let ((calendar-date-style 'european) (european-calendar-style t))
5273 (diary-cyclic N day month year mark))))
5274 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5275 "Like `diary-block', but with fixed (ISO) order of arguments."
5277 (let ((calendar-date-style 'european) (european-calendar-style t))
5278 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5279 (defun org-date (year month day &optional mark)
5280 "Like `diary-date', but with fixed (ISO) order of arguments."
5282 (let ((calendar-date-style 'european) (european-calendar-style t))
5283 (diary-date day month year mark))))
5284 (defalias 'org-float 'diary-float)
5286 ;; Define the` org-class' function
5287 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5288 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5289 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5290 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5291 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5292 `holidays', then any date that is known by the Emacs calendar to be a
5293 holiday will also be skipped."
5294 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5295 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5296 (d (calendar-absolute-from-gregorian date)))
5300 (= (calendar-day-of-week date) dayname)
5301 (or (not skip-weeks)
5304 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5305 (not (and (memq 'holidays skip-weeks)
5306 (calendar-check-holidays date)))
5309 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5310 "Like `org-class', but honor `calendar-date-style'.
5311 The order of the first 2 times 3 arguments depends on the variable
5312 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5313 So for American calendars, give this as MONTH DAY YEAR, for European as
5314 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5315 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5316 is any number of ISO weeks in the block period for which the item should
5319 This function is here only for backward compatibility and it is deprecated,
5320 please use `org-class' instead."
5321 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5322 (date2 (org-order-calendar-date-args m2 d2 y2)))
5324 (nth 2 date1) (car date1) (nth 1 date1)
5325 (nth 2 date2) (car date2) (nth 1 date2)
5326 dayname skip-weeks)))
5327 (make-obsolete 'org-diary-class 'org-class "")
5329 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
5330 (defalias 'org-get-closed 'org-agenda-get-progress)
5331 (defun org-agenda-get-progress ()
5332 "Return the logged TODO entries for agenda display."
5333 (let* ((props (list 'mouse-face 'highlight
5334 'org-not-done-regexp org-not-done-regexp
5335 'org-todo-regexp org-todo-regexp
5336 'org-complex-heading-regexp org-complex-heading-regexp
5338 (format "mouse-2 or RET jump to org file %s"
5339 (abbreviate-file-name buffer-file-name))))
5340 (items (if (consp org-agenda-show-log-scoped)
5341 org-agenda-show-log-scoped
5342 (if (eq org-agenda-show-log-scoped 'clockcheck)
5344 org-agenda-log-mode-items)))
5348 (if (memq 'closed items) (concat "\\<" org-closed-string))
5349 (if (memq 'clock items) (concat "\\<" org-clock-string))
5350 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5351 (parts-re (if parts (mapconcat 'identity parts "\\|")
5352 (error "`org-agenda-log-mode-items' is empty")))
5354 "\\(" parts-re "\\)"
5359 (car org-time-stamp-formats)
5360 (apply 'encode-time ; DATE bound by calendar
5361 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5363 (org-agenda-search-headline-for-time nil)
5364 marker hdmarker priority category category-pos tags closedp
5365 statep clockp state ee txt extra timestr rest clocked)
5366 (goto-char (point-min))
5367 (while (re-search-forward regexp nil t)
5370 (setq marker (org-agenda-new-marker (match-beginning 0))
5371 closedp (equal (match-string 1) org-closed-string)
5372 statep (equal (string-to-char (match-string 1)) ?-)
5373 clockp (not (or closedp statep))
5374 state (and statep (match-string 2))
5375 category (org-get-category (match-beginning 0))
5376 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5377 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5378 (when (string-match "\\]" timestr)
5379 ;; substring should only run to end of time stamp
5380 (setq rest (substring timestr (match-end 0))
5381 timestr (substring timestr 0 (match-end 0)))
5382 (if (and (not closedp) (not statep)
5383 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5385 (progn (setq timestr (concat (substring timestr 0 -1)
5386 "-" (match-string 1 rest) "]"))
5387 (setq clocked (match-string 2 rest)))
5388 (setq clocked "-")))
5392 ((not org-agenda-log-mode-add-notes) nil)
5394 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5397 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5398 (match-string 1)))))
5399 (if (not (re-search-backward org-outline-regexp-bol nil t))
5400 (setq txt org-agenda-no-heading-message)
5401 (goto-char (match-beginning 0))
5402 (setq hdmarker (org-agenda-new-marker)
5403 tags (org-get-tags-at))
5404 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5405 (setq txt (match-string 1))
5407 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5408 (setq txt (concat (substring txt 0 (match-beginning 1))
5409 " - " extra " " (match-string 2 txt)))
5410 (setq txt (concat txt " - " extra))))
5411 (setq txt (org-agenda-format-item
5413 (closedp "Closed: ")
5414 (statep (concat "State: (" state ")"))
5415 (t (concat "Clocked: (" clocked ")")))
5416 txt category tags timestr)))
5417 (setq priority 100000)
5418 (org-add-props txt props
5419 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5420 'priority priority 'org-category category
5421 'org-category-position category-pos
5422 'type "closed" 'date date
5423 'undone-face 'org-warning 'done-face 'org-agenda-done)
5425 (goto-char (point-at-eol))))
5428 (defun org-agenda-show-clocking-issues ()
5429 "Add overlays, showing issues with clocking.
5430 See also the user option `org-agenda-clock-consistency-checks'."
5432 (let* ((pl org-agenda-clock-consistency-checks)
5433 (re (concat "^[ \t]*"
5436 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5437 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5440 (maxtime (org-hh:mm-string-to-minutes
5441 (or (plist-get pl :max-duration) "24:00")))
5442 (mintime (org-hh:mm-string-to-minutes
5443 (or (plist-get pl :min-duration) 0)))
5444 (maxgap (org-hh:mm-string-to-minutes
5445 ;; default 30:00 means never complain
5446 (or (plist-get pl :max-gap) "30:00")))
5447 (gapok (mapcar 'org-hh:mm-string-to-minutes
5448 (plist-get pl :gap-ok-around)))
5449 (def-face (or (plist-get pl :default-face)
5450 '((:background "DarkRed") (:foreground "white"))))
5451 issue face m te ts dt ov)
5452 (goto-char (point-min))
5453 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5454 (setq issue nil face def-face)
5456 (setq m (org-get-at-bol 'org-marker)
5458 (unless (and m (markerp m))
5459 (setq issue "No valid clock line") (throw 'next t))
5460 (org-with-point-at m
5462 (goto-char (point-at-bol))
5463 (unless (looking-at re)
5464 (error "No valid Clock line")
5466 (unless (match-end 3)
5467 (setq issue "No end time"
5468 face (or (plist-get pl :no-end-time-face) face))
5470 (setq ts (match-string 1)
5473 (apply 'encode-time (org-parse-time-string ts)))
5475 (apply 'encode-time (org-parse-time-string te)))
5478 ((> dt (* 60 maxtime))
5479 ;; a very long clocking chunk
5480 (setq issue (format "Clocking interval is very long: %s"
5481 (org-minutes-to-hh:mm-string
5482 (floor (/ (float dt) 60.))))
5483 face (or (plist-get pl :long-face) face)))
5484 ((< dt (* 60 mintime))
5485 ;; a very short clocking chunk
5486 (setq issue (format "Clocking interval is very short: %s"
5487 (org-minutes-to-hh:mm-string
5488 (floor (/ (float dt) 60.))))
5489 face (or (plist-get pl :short-face) face)))
5490 ((and (> tlend 0) (< ts tlend))
5491 ;; Two clock entries are overlapping
5492 (setq issue (format "Clocking overlap: %d minutes"
5493 (/ (- tlend ts) 60))
5494 face (or (plist-get pl :overlap-face) face)))
5495 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5496 ;; There is a gap, lets see if we need to report it
5497 (unless (org-agenda-check-clock-gap tlend ts gapok)
5498 (setq issue (format "Clocking gap: %d minutes"
5499 (/ (- ts tlend) 60))
5500 face (or (plist-get pl :gap-face) face))))
5502 (setq tlend (or te tlend) tlstart (or ts tlstart))
5504 ;; OK, there was some issue, add an overlay to show the issue
5505 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5506 (overlay-put ov 'before-string
5509 (format "%-43s" (concat " " issue))
5513 (overlay-put ov 'evaporate t)))))
5515 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5516 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5519 ;; there are no OK times for gaps...
5521 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5522 ;; This is more than 24 hours, so it is OK.
5523 ;; because we have at least one OK time, that must be in the
5524 ;; 24 hour interval.
5526 ;; We have a shorter gap.
5527 ;; Now we have to get the minute of the day when these times are
5528 (let* ((t1dec (decode-time (seconds-to-time t1)))
5529 (t2dec (decode-time (seconds-to-time t2)))
5530 ;; compute the minute on the day
5531 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5532 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5534 ;; if min2 is smaller than min1, this means it is on the next day.
5535 ;; Wrap it to after midnight.
5536 (setq min2 (+ min2 1440)))
5537 ;; Now check if any of the OK times is in the gap
5539 ;; Wrap the time to after midnight if necessary
5540 (if (< x min1) (setq x (+ x 1440)))
5541 ;; Check if in interval
5542 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5544 ;; Nope, this gap is not OK
5547 (defun org-agenda-get-deadlines ()
5548 "Return the deadline information for agenda display."
5549 (let* ((props (list 'mouse-face 'highlight
5550 'org-not-done-regexp org-not-done-regexp
5551 'org-todo-regexp org-todo-regexp
5552 'org-complex-heading-regexp org-complex-heading-regexp
5554 (format "mouse-2 or RET jump to org file %s"
5555 (abbreviate-file-name buffer-file-name))))
5556 (regexp org-deadline-time-regexp)
5557 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5558 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5559 d2 diff dfrac wdays pos pos1 category category-pos
5560 tags suppress-prewarning ee txt head face s todo-state
5561 show-all upcomingp donep timestr warntime)
5562 (goto-char (point-min))
5563 (while (re-search-forward regexp nil t)
5564 (setq suppress-prewarning nil)
5567 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5569 (string-match org-scheduled-time-regexp
5570 (buffer-substring (point-at-bol)
5572 (setq suppress-prewarning
5573 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5574 org-agenda-skip-deadline-prewarning-if-scheduled
5576 (setq s (match-string 1)
5578 pos (1- (match-beginning 1))
5579 todo-state (save-match-data (org-get-todo-state))
5580 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5582 org-agenda-repeating-timestamp-show-all))
5583 d2 (org-time-string-to-absolute
5584 (match-string 1) d1 'past show-all
5585 (current-buffer) pos)
5587 wdays (if suppress-prewarning
5588 (let ((org-deadline-warning-days suppress-prewarning))
5591 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5592 upcomingp (and todayp (> diff 0)))
5593 ;; When to show a deadline in the calendar:
5594 ;; If the expiration is within wdays warning time.
5595 ;; Past-due deadlines are only shown on the current date
5596 (if (and (or (and (<= diff wdays)
5597 (and todayp (not org-agenda-only-exact-dates)))
5600 ;; (setq todo-state (org-get-todo-state))
5601 (setq donep (member todo-state org-done-keywords))
5603 (or org-agenda-skip-deadline-if-done
5606 (setq category (org-get-category)
5607 warntime (org-entry-get (point) "APPT_WARNTIME")
5608 category-pos (get-text-property (point) 'org-category-position))
5609 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5610 (setq txt org-agenda-no-heading-message)
5611 (goto-char (match-end 0))
5612 (setq pos1 (match-beginning 0))
5613 (setq tags (org-get-tags-at pos1))
5614 (setq head (buffer-substring-no-properties
5616 (progn (skip-chars-forward "^\r\n")
5618 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5620 (concat (substring s (match-beginning 1)) " "))
5621 (setq timestr 'time))
5622 (setq txt (org-agenda-format-item
5624 (car org-agenda-deadline-leaders)
5626 (nth 1 org-agenda-deadline-leaders))
5628 (nth 1 org-agenda-deadline-leaders)
5630 (format (nth 1 org-agenda-deadline-leaders)
5633 (if (not (= diff 0)) nil timestr)))))
5635 (setq face (org-agenda-deadline-face dfrac))
5636 (org-add-props txt props
5637 'org-marker (org-agenda-new-marker pos)
5639 'org-hd-marker (org-agenda-new-marker pos1)
5640 'priority (+ (- diff)
5641 (org-get-priority txt))
5642 'org-category category
5643 'org-category-position category-pos
5644 'todo-state todo-state
5645 'type (if upcomingp "upcoming-deadline" "deadline")
5646 'date (if upcomingp date d2)
5647 'face (if donep 'org-agenda-done face)
5648 'undone-face face 'done-face 'org-agenda-done)
5652 (defun org-agenda-deadline-face (fraction)
5653 "Return the face to displaying a deadline item.
5654 FRACTION is what fraction of the head-warning time has passed."
5655 (let ((faces org-agenda-deadline-faces) f)
5657 (while (setq f (pop faces))
5658 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5660 (defun org-agenda-get-scheduled (&optional deadline-results)
5661 "Return the scheduled information for agenda display."
5662 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5663 'org-todo-regexp org-todo-regexp
5664 'org-complex-heading-regexp org-complex-heading-regexp
5665 'done-face 'org-agenda-done
5666 'mouse-face 'highlight
5668 (format "mouse-2 or RET jump to org file %s"
5669 (abbreviate-file-name buffer-file-name))))
5670 (regexp org-scheduled-time-regexp)
5671 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5672 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5674 (deadline-position-alist
5675 (mapcar (lambda (a) (and (setq mm (get-text-property
5676 0 'org-hd-marker a))
5677 (cons (marker-position mm) a)))
5679 d2 diff pos pos1 category category-pos tags donep
5680 ee txt head pastschedp todo-state face timestr s habitp show-all
5681 did-habit-check-p warntime)
5682 (goto-char (point-min))
5683 (while (re-search-forward regexp nil t)
5686 (setq s (match-string 1)
5688 pos (1- (match-beginning 1))
5689 todo-state (save-match-data (org-get-todo-state))
5690 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5692 org-agenda-repeating-timestamp-show-all))
5693 d2 (org-time-string-to-absolute
5694 (match-string 1) d1 'past show-all
5695 (current-buffer) pos)
5697 warntime (org-entry-get (point) "APPT_WARNTIME"))
5698 (setq pastschedp (and todayp (< diff 0)))
5699 (setq did-habit-check-p nil)
5700 ;; When to show a scheduled item in the calendar:
5701 ;; If it is on or past the date.
5702 (when (or (and (< diff 0)
5703 (< (abs diff) org-scheduled-past-days)
5704 (and todayp (not org-agenda-only-exact-dates)))
5706 ;; org-is-habit-p uses org-entry-get, which is expansive
5707 ;; so we go extra mile to only call it once
5709 org-habit-show-all-today
5710 (setq did-habit-check-p t)
5711 (setq habitp (and (functionp 'org-is-habit-p)
5712 (org-is-habit-p)))))
5714 (setq donep (member todo-state org-done-keywords))
5716 (or org-agenda-skip-scheduled-if-done
5718 (and (functionp 'org-is-habit-p)
5721 (setq habitp (if did-habit-check-p habitp
5722 (and (functionp 'org-is-habit-p)
5724 (setq category (org-get-category)
5725 category-pos (get-text-property (point) 'org-category-position))
5726 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5727 (setq txt org-agenda-no-heading-message)
5728 (goto-char (match-end 0))
5729 (setq pos1 (match-beginning 0))
5731 (if (or (not org-habit-show-habits)
5733 org-habit-show-habits-only-for-today))
5736 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5737 (and org-agenda-skip-scheduled-if-deadline-is-shown
5739 (setq mm (assoc pos1 deadline-position-alist)))
5741 (setq tags (org-get-tags-at))
5742 (setq head (buffer-substring-no-properties
5744 (progn (skip-chars-forward "^\r\n") (point))))
5745 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5747 (concat (substring s (match-beginning 1)) " "))
5748 (setq timestr 'time))
5749 (setq txt (org-agenda-format-item
5751 (car org-agenda-scheduled-leaders)
5752 (format (nth 1 org-agenda-scheduled-leaders)
5755 (if (not (= diff 0)) nil timestr)
5760 ((and (not habitp) pastschedp)
5761 'org-scheduled-previously)
5762 (todayp 'org-scheduled-today)
5764 habitp (and habitp (org-habit-parse-todo)))
5765 (org-add-props txt props
5767 'face (if donep 'org-agenda-done face)
5768 'org-marker (org-agenda-new-marker pos)
5769 'org-hd-marker (org-agenda-new-marker pos1)
5770 'type (if pastschedp "past-scheduled" "scheduled")
5771 'date (if pastschedp d2 date)
5773 'priority (if habitp
5774 (org-habit-get-priority habitp)
5775 (+ 94 (- 5 diff) (org-get-priority txt)))
5776 'org-category category
5777 'category-position category-pos
5779 'todo-state todo-state)
5783 (defun org-agenda-get-blocks ()
5784 "Return the date-range information for agenda display."
5785 (let* ((props (list 'face nil
5786 'org-not-done-regexp org-not-done-regexp
5787 'org-todo-regexp org-todo-regexp
5788 'org-complex-heading-regexp org-complex-heading-regexp
5789 'mouse-face 'highlight
5791 (format "mouse-2 or RET jump to org file %s"
5792 (abbreviate-file-name buffer-file-name))))
5793 (regexp org-tr-regexp)
5794 (d0 (calendar-absolute-from-gregorian date))
5795 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
5796 todo-state tags pos head donep)
5797 (goto-char (point-min))
5798 (while (re-search-forward regexp nil t)
5802 (let ((start-time (match-string 1))
5803 (end-time (match-string 2)))
5804 (setq s1 (match-string 1)
5806 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5807 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5808 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5809 ;; Only allow days between the limits, because the normal
5810 ;; date stamps will catch the limits.
5812 (setq todo-state (org-get-todo-state))
5813 (setq donep (member todo-state org-done-keywords))
5814 (if (and donep org-agenda-skip-timestamp-if-done)
5816 (setq marker (org-agenda-new-marker (point)))
5817 (setq category (org-get-category)
5818 category-pos (get-text-property (point) 'org-category-position))
5819 (if (not (re-search-backward org-outline-regexp-bol nil t))
5820 (setq txt org-agenda-no-heading-message)
5821 (goto-char (match-beginning 0))
5822 (setq hdmarker (org-agenda-new-marker (point)))
5823 (setq tags (org-get-tags-at))
5824 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5825 (setq head (match-string 1))
5827 (if org-agenda-remove-timeranges-from-blocks
5829 "<" (regexp-quote s1) ".*?>"
5831 "<" (regexp-quote s2) ".*?>")
5833 (setq txt (org-agenda-format-item
5835 (nth (if (= d1 d2) 0 1)
5836 org-agenda-timerange-leaders)
5837 (1+ (- d0 d1)) (1+ (- d2 d1)))
5839 (cond ((and (= d1 d0) (= d2 d0))
5840 (concat "<" start-time ">--<" end-time ">"))
5842 (concat "<" start-time ">"))
5844 (concat "<" end-time ">")))
5846 (org-add-props txt props
5847 'org-marker marker 'org-hd-marker hdmarker
5848 'type "block" 'date date
5849 'todo-state todo-state
5850 'priority (org-get-priority txt) 'org-category category
5851 'org-category-position category-pos)
5854 ;; Sort the entries by expiration date.
5857 ;;; Agenda presentation and sorting
5859 (defvar org-prefix-has-time nil
5860 "A flag, set by `org-compile-prefix-format'.
5861 The flag is set if the currently compiled format contains a `%t'.")
5862 (defvar org-prefix-has-tag nil
5863 "A flag, set by `org-compile-prefix-format'.
5864 The flag is set if the currently compiled format contains a `%T'.")
5865 (defvar org-prefix-has-effort nil
5866 "A flag, set by `org-compile-prefix-format'.
5867 The flag is set if the currently compiled format contains a `%e'.")
5868 (defvar org-prefix-category-length nil
5869 "Used by `org-compile-prefix-format' to remember the category field width.")
5870 (defvar org-prefix-category-max-length nil
5871 "Used by `org-compile-prefix-format' to remember the category field width.")
5873 (defun org-agenda-get-category-icon (category)
5874 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5875 (dolist (entry org-agenda-category-icon-alist)
5876 (when (org-string-match-p (car entry) category)
5877 (if (listp (cadr entry))
5878 (return (cadr entry))
5879 (return (apply 'create-image (cdr entry)))))))
5881 (defun org-agenda-format-item (extra txt &optional category tags dotime
5883 "Format TXT to be inserted into the agenda buffer.
5884 In particular, it adds the prefix and corresponding text properties. EXTRA
5885 must be a string and replaces the `%s' specifier in the prefix format.
5886 CATEGORY (string, symbol or nil) may be used to overrule the default
5887 category taken from local variable or file name. It will replace the `%c'
5888 specifier in the format. DOTIME, when non-nil, indicates that a
5889 time-of-day should be extracted from TXT for sorting of this entry, and for
5890 the `%t' specifier in the format. When DOTIME is a string, this string is
5891 searched for a time before TXT is. TAGS can be the tags of the headline.
5892 Any match of REMOVE-RE will be removed from TXT."
5893 ;; We keep the org-prefix-* variable values along with a compiled
5894 ;; formatter, so that multiple agendas existing at the same time, do
5895 ;; not step on each other toes.
5897 ;; It was inconvenient to make these variables buffer local in
5898 ;; Agenda buffers, because this function expects to be called with
5899 ;; the buffer where item comes from being current, and not agenda
5901 (let* ((bindings (car org-prefix-format-compiled))
5902 (formatter (cadr org-prefix-format-compiled)))
5903 (loop for (var value) in bindings
5906 ;; Diary entries sometimes have extra whitespace at the beginning
5907 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5909 ;; Fix the tags part in txt
5910 (setq txt (org-agenda-fix-displayed-tags
5912 org-agenda-show-inherited-tags
5913 org-agenda-hide-tags-regexp))
5914 (let* ((category (or category
5915 (if (stringp org-category)
5917 (and org-category (symbol-name org-category)))
5918 (if buffer-file-name
5919 (file-name-sans-extension
5920 (file-name-nondirectory buffer-file-name))
5922 (category-icon (org-agenda-get-category-icon category))
5923 (category-icon (if category-icon
5924 (propertize " " 'display category-icon)
5926 ;; time, tag, effort are needed for the eval of the prefix format
5927 (tag (if tags (nth (1- (length tags)) tags) ""))
5929 (ts (if dotime (concat
5930 (if (stringp dotime) dotime "")
5931 (and org-agenda-search-headline-for-time txt))))
5932 (time-of-day (and dotime (org-get-time-of-day ts)))
5933 stamp plain s0 s1 s2 rtn srp l
5934 duration thecategory)
5935 (and (derived-mode-p 'org-mode) buffer-file-name
5936 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5937 (when (and dotime time-of-day)
5938 ;; Extract starting and ending time and move them to prefix
5939 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5940 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5941 (setq s0 (match-string 0 ts)
5942 srp (and stamp (match-end 3))
5943 s1 (match-string (if plain 1 2) ts)
5944 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5946 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5947 ;; them, we might want to remove them there to avoid duplication.
5948 ;; The user can turn this off with a variable.
5949 (if (and org-prefix-has-time
5950 org-agenda-remove-times-when-in-prefix (or stamp plain)
5951 (string-match (concat (regexp-quote s0) " *") txt)
5952 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5953 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5954 (= (match-beginning 0) 0)
5956 (setq txt (replace-match "" nil nil txt))))
5957 ;; Normalize the time(s) to 24 hour
5958 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5959 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5961 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5962 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5964 (org-minutes-to-hh:mm-string
5965 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5967 ;; Compute the duration
5969 (setq duration (- (org-hh:mm-string-to-minutes s2)
5970 (org-hh:mm-string-to-minutes s1)))))
5972 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5974 ;; Tags are in the string
5975 (if (or (eq org-agenda-remove-tags t)
5976 (and org-agenda-remove-tags
5977 org-prefix-has-tag))
5978 (setq txt (replace-match "" t t txt))
5979 (setq txt (replace-match
5980 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5981 (match-string 2 txt))
5983 (when (derived-mode-p 'org-mode)
5987 (or (get-text-property 0 'org-hd-marker txt)
5988 (get-text-property 0 'org-marker txt)))
5991 (setq neffort (org-duration-string-to-minutes effort)
5992 effort (setq effort (concat "[" effort "]")))))
5993 ;; prevent erroring out with %e format when there is no effort
5994 (or effort (setq effort ""))
5997 (while (string-match remove-re txt)
5998 (setq txt (replace-match "" t t txt))))
6000 ;; Set org-heading property on `txt' to mark the start of the
6002 (add-text-properties 0 (length txt) '(org-heading t) txt)
6004 ;; Prepare the variables needed in the eval of the compiled format
6005 (setq time (cond (s2 (concat
6006 (org-agenda-time-of-day-to-ampm-maybe s1)
6007 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6008 (if org-agenda-timegrid-use-ampm " ")))
6010 (org-agenda-time-of-day-to-ampm-maybe s1)
6011 (if org-agenda-timegrid-use-ampm
6015 extra (or (and (not habitp) extra) "")
6016 category (if (symbolp category) (symbol-name category) category)
6017 thecategory (copy-sequence category))
6018 (if (string-match org-bracket-link-regexp category)
6020 (setq l (if (match-end 3)
6021 (- (match-end 3) (match-beginning 3))
6022 (- (match-end 1) (match-beginning 1))))
6023 (when (< l (or org-prefix-category-length 0))
6024 (setq category (copy-sequence category))
6025 (org-add-props category nil
6026 'extra-space (make-string
6027 (- org-prefix-category-length l 1) ?\ ))))
6028 (if (and org-prefix-category-max-length
6029 (>= (length category) org-prefix-category-max-length))
6030 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6031 ;; Evaluate the compiled format
6032 (setq rtn (concat (eval formatter) txt))
6034 ;; And finally add the text properties
6035 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6036 (org-add-props rtn nil
6037 'org-category (if thecategory (downcase thecategory) category)
6038 'tags (mapcar 'org-downcase-keep-props tags)
6039 'org-highest-priority org-highest-priority
6040 'org-lowest-priority org-lowest-priority
6041 'time-of-day time-of-day
6044 'effort-minutes neffort
6048 'format org-prefix-format-compiled
6051 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6052 "Remove tags string from TXT, and add a modified list of tags.
6053 The modified list may contain inherited tags, and tags matched by
6054 `org-agenda-hide-tags-regexp' will be removed."
6055 (when (or add-inherited hide-re)
6056 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6057 (setq txt (substring txt 0 (match-beginning 0))))
6060 (mapcar (lambda (tg)
6061 (if (or (and hide-re (string-match hide-re tg))
6062 (and (not add-inherited)
6063 (get-text-property 0 'inherited tg)))
6068 (let ((have-i (get-text-property 0 'inherited (car tags)))
6070 (setq txt (concat txt " :"
6073 (setq i (get-text-property 0 'inherited x))
6074 (if (and have-i (not i))
6080 (if have-i "::" ":"))))))
6083 (defun org-downcase-keep-props (s)
6084 (let ((props (text-properties-at 0 s)))
6085 (setq s (downcase s))
6086 (add-text-properties 0 (length s) props s)
6089 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6090 (defvar org-agenda-sorting-strategy-selected nil)
6092 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6094 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6095 ((and todayp (member 'today (car org-agenda-time-grid))))
6096 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6097 ((member 'weekly (car org-agenda-time-grid)))
6098 (t (throw 'exit list)))
6099 (let* ((have (delq nil (mapcar
6100 (lambda (x) (get-text-property 1 'time-of-day x))
6102 (string (nth 1 org-agenda-time-grid))
6103 (gridtimes (nth 2 org-agenda-time-grid))
6104 (req (car org-agenda-time-grid))
6105 (remove (member 'remove-match req))
6107 (if (and (member 'require-timed req) (not have))
6108 ;; don't show empty grid
6110 (while (setq time (pop gridtimes))
6111 (unless (and remove (member time have))
6112 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6113 (push (org-agenda-format-item
6115 (concat (substring time 0 -2) ":" (substring time -2)))
6118 2 (length (car new)) 'face 'org-time-grid (car new))))
6119 (when (and todayp org-agenda-show-current-time-in-grid)
6120 (push (org-agenda-format-item
6122 org-agenda-current-time-string
6124 (format-time-string "%H:%M "))
6127 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6129 (if (member 'time-up org-agenda-sorting-strategy-selected)
6131 (append list new)))))
6133 (defun org-compile-prefix-format (key)
6134 "Compile the prefix format into a Lisp form that can be evaluated.
6135 The resulting form and associated variable bindings is returned
6136 and stored in the variable `org-prefix-format-compiled'."
6137 (setq org-prefix-has-time nil org-prefix-has-tag nil
6138 org-prefix-category-length nil
6139 org-prefix-has-effort nil)
6141 ((stringp org-agenda-prefix-format)
6142 org-agenda-prefix-format)
6143 ((assq key org-agenda-prefix-format)
6144 (cdr (assq key org-agenda-prefix-format)))
6145 (t " %-12:c%?-12t% s")))
6147 varform vars var e c f opt)
6148 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
6150 (setq var (or (cdr (assoc (match-string 4 s)
6151 '(("c" . category) ("t" . time) ("s" . extra)
6152 ("i" . category-icon) ("T" . tag) ("e" . effort))))
6154 c (or (match-string 3 s) "")
6155 opt (match-beginning 1)
6156 start (1+ (match-beginning 0)))
6157 (if (equal var 'time) (setq org-prefix-has-time t))
6158 (if (equal var 'tag) (setq org-prefix-has-tag t))
6159 (if (equal var 'effort) (setq org-prefix-has-effort t))
6160 (setq f (concat "%" (match-string 2 s) "s"))
6161 (when (equal var 'category)
6162 (setq org-prefix-category-length
6163 (floor (abs (string-to-number (match-string 2 s)))))
6164 (setq org-prefix-category-max-length
6165 (let ((x (match-string 2 s)))
6167 (if (string-match "\\.[0-9]+" x)
6168 (string-to-number (substring (match-string 0 x) 1)))))))
6170 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6173 `(if (equal "" ,var)
6175 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6176 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6177 (setq s (replace-match "%s" t nil s))
6178 (push varform vars))
6179 (setq vars (nreverse vars))
6180 (with-current-buffer (or org-agenda-buffer (current-buffer))
6181 (setq org-prefix-format-compiled
6183 `((org-prefix-has-time ,org-prefix-has-time)
6184 (org-prefix-has-tag ,org-prefix-has-tag)
6185 (org-prefix-category-length ,org-prefix-category-length)
6186 (org-prefix-has-effort ,org-prefix-has-effort))
6187 `(format ,s ,@vars))))))
6189 (defun org-set-sorting-strategy (key)
6190 (if (symbolp (car org-agenda-sorting-strategy))
6192 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6193 (setq org-agenda-sorting-strategy-selected
6194 (or (cdr (assq key org-agenda-sorting-strategy))
6195 (cdr (assq 'agenda org-agenda-sorting-strategy))
6196 '(time-up category-keep priority-down)))))
6198 (defun org-get-time-of-day (s &optional string mod24)
6199 "Check string S for a time of day.
6200 If found, return it as a military time number between 0 and 2400.
6201 If not found, return nil.
6202 The optional STRING argument forces conversion into a 5 character wide string
6206 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6207 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6208 (let* ((h (string-to-number (match-string 1 s)))
6209 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6210 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6211 (am-p (equal ampm "am"))
6212 (h1 (cond ((not ampm) h)
6213 ((= h 12) (if am-p 0 12))
6214 (t (+ h (if am-p 0 12)))))
6215 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6217 (t0 (+ (* 100 h2) m))
6218 (t1 (concat (if (>= h1 24) "+" " ")
6219 (if (and org-agenda-time-leading-zero
6220 (< t0 1000)) "0" "")
6221 (if (< t0 100) "0" "")
6222 (if (< t0 10) "0" "")
6223 (int-to-string t0))))
6224 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6226 (defvar org-agenda-before-sorting-filter-function nil
6227 "Function to be applied to agenda items prior to sorting.
6228 Prior to sorting also means just before they are inserted into the agenda.
6230 To aid sorting, you may revisit the original entries and add more text
6231 properties which will later be used by the sorting functions.
6233 The function should take a string argument, an agenda line.
6234 It has access to the text properties in that line, which contain among
6235 other things, the property `org-hd-marker' that points to the entry
6236 where the line comes from. Note that not all lines going into the agenda
6237 have this property, only most.
6239 The function should return the modified string. It is probably best
6240 to ONLY change text properties.
6242 You can also use this function as a filter, by returning nil for lines
6243 you don't want to have in the agenda at all. For this application, you
6244 could bind the variable in the options section of a custom command.")
6246 (defun org-agenda-finalize-entries (list &optional nosort)
6247 "Sort and concatenate the agenda items."
6248 (setq list (mapcar 'org-agenda-highlight-todo list))
6251 (when org-agenda-before-sorting-filter-function
6252 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6253 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6255 (defun org-agenda-highlight-todo (x)
6256 (let ((org-done-keywords org-done-keywords-for-agenda)
6257 (case-fold-search nil)
6261 (beginning-of-line 1)
6262 (setq re (org-get-at-bol 'org-todo-regexp))
6263 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6264 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6265 (add-text-properties (match-beginning 0) (match-end 1)
6266 (list 'face (org-get-todo-face 1)))
6267 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6268 (delete-region (match-beginning 1) (1- (match-end 0)))
6269 (goto-char (match-beginning 1))
6270 (insert (format org-agenda-todo-keyword-format s)))))
6271 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6272 (setq re (get-text-property 0 'org-todo-regexp x))
6274 ;; Test `pl' because if there's no heading content,
6275 ;; there's no point matching to highlight. Note
6276 ;; that if we didn't test `pl' first, and there
6277 ;; happened to be no keyword from `org-todo-regexp'
6278 ;; on this heading line, then the `equal' comparison
6279 ;; afterwards would spuriously succeed in the case
6280 ;; where `pl' is nil -- causing an args-out-of-range
6281 ;; error when we try to add text properties to text
6282 ;; that isn't there.
6284 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6286 (add-text-properties
6287 (or (match-end 1) (match-end 0)) (match-end 0)
6288 (list 'face (org-get-todo-face (match-string 2 x)))
6291 (setq x (concat (substring x 0 (match-end 1))
6292 (format org-agenda-todo-keyword-format
6294 (org-add-props " " (text-properties-at 0 x))
6295 (substring x (match-end 3)))))))
6298 (defsubst org-cmp-priority (a b)
6299 "Compare the priorities of string A and B."
6300 (let ((pa (or (get-text-property 1 'priority a) 0))
6301 (pb (or (get-text-property 1 'priority b) 0)))
6302 (cond ((> pa pb) +1)
6305 (defsubst org-cmp-effort (a b)
6306 "Compare the effort values of string A and B."
6307 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6308 (ea (or (get-text-property 1 'effort-minutes a) def))
6309 (eb (or (get-text-property 1 'effort-minutes b) def)))
6310 (cond ((> ea eb) +1)
6313 (defsubst org-cmp-category (a b)
6314 "Compare the string values of categories of strings A and B."
6315 (let ((ca (or (get-text-property 1 'org-category a) ""))
6316 (cb (or (get-text-property 1 'org-category b) "")))
6317 (cond ((string-lessp ca cb) -1)
6318 ((string-lessp cb ca) +1))))
6320 (defsubst org-cmp-todo-state (a b)
6321 "Compare the todo states of strings A and B."
6322 (let* ((ma (or (get-text-property 1 'org-marker a)
6323 (get-text-property 1 'org-hd-marker a)))
6324 (mb (or (get-text-property 1 'org-marker b)
6325 (get-text-property 1 'org-hd-marker b)))
6326 (fa (and ma (marker-buffer ma)))
6327 (fb (and mb (marker-buffer mb)))
6329 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6330 (and fb (with-current-buffer fb org-todo-keywords-1))))
6331 (ta (or (get-text-property 1 'todo-state a) ""))
6332 (tb (or (get-text-property 1 'todo-state b) ""))
6333 (la (- (length (member ta todo-kwds))))
6334 (lb (- (length (member tb todo-kwds))))
6335 (donepa (member ta org-done-keywords-for-agenda))
6336 (donepb (member tb org-done-keywords-for-agenda)))
6337 (cond ((and donepa (not donepb)) -1)
6338 ((and (not donepa) donepb) +1)
6342 (defsubst org-cmp-alpha (a b)
6343 "Compare the headlines, alphabetically."
6344 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6345 (plb (text-property-any 0 (length b) 'org-heading t b))
6346 (ta (and pla (substring a pla)))
6347 (tb (and plb (substring b plb))))
6349 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6350 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6351 (setq ta (substring ta (match-end 0))))
6352 (setq ta (downcase ta)))
6354 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6355 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6356 (setq tb (substring tb (match-end 0))))
6357 (setq tb (downcase tb)))
6360 ((string-lessp ta tb) -1)
6361 ((string-lessp tb ta) +1))))
6363 (defsubst org-cmp-tag (a b)
6364 "Compare the string values of the first tags of A and B."
6365 (let ((ta (car (last (get-text-property 1 'tags a))))
6366 (tb (car (last (get-text-property 1 'tags b)))))
6369 ((string-lessp ta tb) -1)
6370 ((string-lessp tb ta) +1))))
6372 (defsubst org-cmp-time (a b)
6373 "Compare the time-of-day values of strings A and B."
6374 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6375 (ta (or (get-text-property 1 'time-of-day a) def))
6376 (tb (or (get-text-property 1 'time-of-day b) def)))
6377 (cond ((< ta tb) -1)
6380 (defsubst org-cmp-habit-p (a b)
6381 "Compare the todo states of strings A and B."
6382 (let ((ha (get-text-property 1 'org-habit-p a))
6383 (hb (get-text-property 1 'org-habit-p b)))
6384 (cond ((and ha (not hb)) -1)
6385 ((and (not ha) hb) +1))))
6387 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6389 (defun org-entries-lessp (a b)
6390 "Predicate for sorting agenda entries."
6391 ;; The following variables will be used when the form is evaluated.
6392 ;; So even though the compiler complains, keep them.
6393 (let* ((ss org-agenda-sorting-strategy-selected)
6394 (time-up (and (org-em 'time-up 'time-down ss)
6395 (org-cmp-time a b)))
6396 (time-down (if time-up (- time-up) nil))
6397 (priority-up (and (org-em 'priority-up 'priority-down ss)
6398 (org-cmp-priority a b)))
6399 (priority-down (if priority-up (- priority-up) nil))
6400 (effort-up (and (org-em 'effort-up 'effort-down ss)
6401 (org-cmp-effort a b)))
6402 (effort-down (if effort-up (- effort-up) nil))
6403 (category-up (and (or (org-em 'category-up 'category-down ss)
6404 (memq 'category-keep ss))
6405 (org-cmp-category a b)))
6406 (category-down (if category-up (- category-up) nil))
6407 (category-keep (if category-up +1 nil))
6408 (tag-up (and (org-em 'tag-up 'tag-down ss)
6410 (tag-down (if tag-up (- tag-up) nil))
6411 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6412 (org-cmp-todo-state a b)))
6413 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6414 (habit-up (and (org-em 'habit-up 'habit-down ss)
6415 (org-cmp-habit-p a b)))
6416 (habit-down (if habit-up (- habit-up) nil))
6417 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6418 (org-cmp-alpha a b)))
6419 (alpha-down (if alpha-up (- alpha-up) nil))
6420 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6421 user-defined-up user-defined-down)
6422 (if (and need-user-cmp org-agenda-cmp-user-defined
6423 (functionp org-agenda-cmp-user-defined))
6424 (setq user-defined-up
6425 (funcall org-agenda-cmp-user-defined a b)
6426 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6428 (eval (cons 'or org-agenda-sorting-strategy-selected))
6429 '((-1 . t) (1 . nil) (nil . nil))))))
6431 ;;; Agenda restriction lock
6433 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6434 "Overlay to mark the headline to which agenda commands are restricted.")
6435 (overlay-put org-agenda-restriction-lock-overlay
6436 'face 'org-agenda-restriction-lock)
6437 (overlay-put org-agenda-restriction-lock-overlay
6438 'help-echo "Agendas are currently limited to this subtree.")
6439 (org-detach-overlay org-agenda-restriction-lock-overlay)
6441 (defun org-agenda-set-restriction-lock (&optional type)
6442 "Set restriction lock for agenda, to current subtree or file.
6443 Restriction will be the file if TYPE is `file', or if type is the
6444 universal prefix '(4), or if the cursor is before the first headline
6445 in the file. Otherwise, restriction will be to the current subtree."
6447 (and (equal type '(4)) (setq type 'file))
6450 ((org-at-heading-p) 'subtree)
6451 ((condition-case nil (org-back-to-heading t) (error nil))
6454 (if (eq type 'subtree)
6456 (setq org-agenda-restrict t)
6457 (setq org-agenda-overriding-restriction 'subtree)
6458 (put 'org-agenda-files 'org-restrict
6459 (list (buffer-file-name (buffer-base-buffer))))
6460 (org-back-to-heading t)
6461 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6462 (move-marker org-agenda-restrict-begin (point))
6463 (move-marker org-agenda-restrict-end
6464 (save-excursion (org-end-of-subtree t)))
6465 (message "Locking agenda restriction to subtree"))
6466 (put 'org-agenda-files 'org-restrict
6467 (list (buffer-file-name (buffer-base-buffer))))
6468 (setq org-agenda-restrict nil)
6469 (setq org-agenda-overriding-restriction 'file)
6470 (move-marker org-agenda-restrict-begin nil)
6471 (move-marker org-agenda-restrict-end nil)
6472 (message "Locking agenda restriction to file"))
6473 (setq current-prefix-arg nil)
6474 (org-agenda-maybe-redo))
6476 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6477 "Remove the agenda restriction lock."
6479 (org-detach-overlay org-agenda-restriction-lock-overlay)
6480 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6481 (setq org-agenda-overriding-restriction nil)
6482 (setq org-agenda-restrict nil)
6483 (put 'org-agenda-files 'org-restrict nil)
6484 (move-marker org-agenda-restrict-begin nil)
6485 (move-marker org-agenda-restrict-end nil)
6486 (setq current-prefix-arg nil)
6487 (message "Agenda restriction lock removed")
6488 (or noupdate (org-agenda-maybe-redo)))
6490 (defun org-agenda-maybe-redo ()
6491 "If there is any window showing the agenda view, update it."
6492 (let ((w (get-buffer-window org-agenda-buffer-name t))
6493 (w0 (selected-window)))
6498 (if org-agenda-overriding-restriction
6499 (message "Agenda view shifted to new %s restriction"
6500 org-agenda-overriding-restriction)
6501 (message "Agenda restriction lock removed")))))
6505 (defun org-agenda-check-type (error &rest types)
6506 "Check if agenda buffer is of allowed type.
6507 If ERROR is non-nil, throw an error, otherwise just return nil."
6508 (if (not org-agenda-type)
6509 (error "No Org agenda currently displayed")
6510 (if (memq org-agenda-type types)
6513 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6516 (defun org-agenda-Quit (&optional arg)
6517 "Exit agenda by removing the window or the buffer."
6519 (if org-agenda-columns-active
6521 (let ((buf (current-buffer)))
6522 (if (eq org-agenda-window-setup 'other-frame)
6524 (org-agenda-reset-markers)
6526 (org-columns-remove-overlays)
6527 (setq org-agenda-archives-mode nil)
6529 (and (not (eq org-agenda-window-setup 'current-window))
6530 (not (one-window-p))
6532 (org-agenda-reset-markers)
6534 (org-columns-remove-overlays)
6535 (setq org-agenda-archives-mode nil)))
6536 ;; Maybe restore the pre-agenda window configuration.
6537 (and org-agenda-restore-windows-after-quit
6538 (not (eq org-agenda-window-setup 'other-frame))
6539 org-agenda-pre-window-conf
6540 (set-window-configuration org-agenda-pre-window-conf)
6541 (setq org-agenda-pre-window-conf nil))))
6543 (defun org-agenda-quit ()
6544 "Exit agenda by killing agenda buffer or burying it when
6545 `org-agenda-sticky' is non-NIL"
6547 (if org-agenda-columns-active
6549 (if org-agenda-sticky
6550 (let ((buf (current-buffer)))
6551 (if (eq org-agenda-window-setup 'other-frame)
6554 (and (not (eq org-agenda-window-setup 'current-window))
6555 (not (one-window-p))
6557 (with-current-buffer buf
6559 ;; Maybe restore the pre-agenda window configuration.
6560 (and org-agenda-restore-windows-after-quit
6561 (not (eq org-agenda-window-setup 'other-frame))
6562 org-agenda-pre-window-conf
6563 (set-window-configuration org-agenda-pre-window-conf)
6564 (setq org-agenda-pre-window-conf nil))))
6565 (org-agenda-Quit))))
6567 (defun org-agenda-exit ()
6568 "Exit agenda by removing the window or the buffer.
6569 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6570 Org-mode buffers visited directly by the user will not be touched."
6572 (org-release-buffers org-agenda-new-buffers)
6573 (setq org-agenda-new-buffers nil)
6576 (defun org-agenda-kill-all-agenda-buffers ()
6577 "Kill all buffers in `org-agena-mode'.
6578 This is used when toggling sticky agendas. You can also explicitly invoke it
6582 (dolist (buf (buffer-list))
6583 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6585 (mapc 'kill-buffer blist)))
6587 (defun org-agenda-execute (arg)
6588 "Execute another agenda command, keeping same window.
6589 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6592 (let ((org-agenda-window-setup 'current-window))
6595 (defun org-agenda-redo (&optional all)
6596 "Rebuild possibly ALL agenda view(s) in the current buffer."
6598 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
6599 (cpa (unless (eq all t) current-prefix-arg))
6600 (org-agenda-doing-sticky-redo org-agenda-sticky)
6601 (org-agenda-sticky nil)
6602 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6603 org-agenda-buffer-name))
6604 (org-agenda-keep-modes t)
6605 (tag-filter org-agenda-tag-filter)
6606 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6607 (top-cat-filter org-agenda-top-category-filter)
6608 (cat-filter org-agenda-category-filter)
6609 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6610 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6611 (cols org-agenda-columns-active)
6612 (line (org-current-line))
6613 (window-line (- line (org-current-line (window-start))))
6614 (lprops (get 'org-agenda-redo-command 'org-lprops))
6615 (redo-cmd (get-text-property p 'org-redo-cmd))
6616 (last-args (get-text-property p 'org-last-args))
6617 (org-agenda-overriding-cmd (get-text-property p 'org-serie-cmd))
6618 (org-agenda-overriding-cmd-arguments
6620 (cond ((listp last-args)
6621 (cons (or cpa (car last-args)) (cdr last-args)))
6622 ((stringp last-args)
6624 (serie-redo-cmd (get-text-property p 'org-serie-redo-cmd)))
6625 (put 'org-agenda-tag-filter :preset-filter nil)
6626 (put 'org-agenda-category-filter :preset-filter nil)
6627 (and cols (org-columns-quit))
6628 (message "Rebuilding agenda buffer...")
6630 (eval serie-redo-cmd)
6631 (org-let lprops '(eval redo-cmd)))
6632 (setq org-agenda-undo-list nil
6633 org-agenda-pending-undo-list nil)
6634 (message "Rebuilding agenda buffer...done")
6635 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6636 (put 'org-agenda-category-filter :preset-filter cat-preset)
6637 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6638 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6639 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
6640 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6641 (org-goto-line line)
6642 (recenter window-line)))
6644 (defvar org-global-tags-completion-table nil)
6645 (defvar org-agenda-filter-form nil)
6646 (defvar org-agenda-filtered-by-category nil)
6648 (defun org-agenda-filter-by-category (strip)
6649 "Keep only those lines in the agenda buffer that have a specific category.
6650 The category is that of the current line."
6652 (if (and org-agenda-filtered-by-category
6653 org-agenda-category-filter)
6654 (org-agenda-filter-show-all-cat)
6655 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6656 (if cat (org-agenda-filter-apply
6657 (list (concat (if strip "-" "+") cat)) 'category)
6658 (error "No category at point")))))
6660 (defun org-find-top-category (&optional pos)
6662 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
6663 (if pos (goto-char pos))
6664 ;; Skip up to the topmost parent
6665 (while (ignore-errors (outline-up-heading 1) t))
6667 (nth 4 (org-heading-components))))))
6669 (defvar org-agenda-filtered-by-top-category nil)
6671 (defun org-agenda-filter-by-top-category (strip)
6672 "Keep only those lines in the agenda buffer that have a specific category.
6673 The category is that of the current line."
6675 (if org-agenda-filtered-by-top-category
6677 (setq org-agenda-filtered-by-top-category nil
6678 org-agenda-top-category-filter nil)
6679 (org-agenda-filter-show-all-cat))
6680 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
6681 (if cat (org-agenda-filter-top-category-apply cat strip)
6682 (error "No top-level category at point")))))
6684 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6685 "Keep only those lines in the agenda buffer that have a specific tag.
6686 The tag is selected with its fast selection letter, as configured.
6687 With prefix argument STRIP, remove all lines that do have the tag.
6688 A lisp caller can specify CHAR. NARROW means that the new tag should be
6689 used to narrow the search - the interactive user can also press `-' or `+'
6690 to switch to narrowing."
6692 (let* ((alist org-tag-alist-for-agenda)
6693 (tag-chars (mapconcat
6694 (lambda (x) (if (and (not (symbolp (car x)))
6696 (char-to-string (cdr x))
6699 (efforts (org-split-string
6700 (or (cdr (assoc (concat org-effort-property "_ALL")
6701 org-global-properties))
6702 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6704 (effort-op org-agenda-filter-effort-default-operator)
6706 (inhibit-read-only t)
6707 (current org-agenda-tag-filter)
6708 maybe-refresh a n tag)
6711 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6712 (if narrow "Narrow" "Filter") tag-chars
6713 (if org-agenda-auto-exclude-function "[RET], " ""))
6714 (setq char (read-char-exclusive)))
6715 (when (member char '(?+ ?-))
6717 (cond ((equal char ?-) (setq strip t narrow t))
6718 ((equal char ?+) (setq strip nil narrow t)))
6720 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6721 (setq char (read-char-exclusive)))
6722 (when (member char '(?< ?> ?= ??))
6723 ;; An effort operator
6724 (setq effort-op (char-to-string char))
6725 (setq alist nil) ; to make sure it will be interpreted as effort.
6726 (unless (equal char ??)
6727 (loop for i from 0 to 9 do
6731 (if (= i 9) "0" (int-to-string (1+ i)))
6732 "]" (nth i efforts))))
6733 (message "Effort%s: %s " effort-op effort-prompt)
6734 (setq char (read-char-exclusive))
6735 (when (or (< char ?0) (> char ?9))
6736 (error "Need 1-9,0 to select effort"))))
6737 (when (equal char ?\t)
6738 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6739 (org-set-local 'org-global-tags-completion-table
6740 (org-global-tags-completion-table)))
6741 (let ((completion-ignore-case t))
6742 (setq tag (org-icompleting-read
6743 "Tag: " org-global-tags-completion-table))))
6746 (org-agenda-filter-show-all-tag)
6747 (when org-agenda-auto-exclude-function
6748 (setq org-agenda-tag-filter '())
6749 (dolist (tag (org-agenda-get-represented-tags))
6750 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6752 (push modifier org-agenda-tag-filter))))
6753 (if (not (null org-agenda-tag-filter))
6754 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6755 (setq maybe-refresh t))
6757 (org-agenda-filter-show-all-tag)
6758 (when (get 'org-agenda-tag-filter :preset-filter)
6759 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6760 (setq maybe-refresh t))
6762 (setq org-agenda-tag-filter
6763 (mapcar (lambda(tag) (concat "+" tag))
6764 (org-get-at-bol 'tags)))
6765 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6766 (setq maybe-refresh t))
6767 ((or (equal char ?\ )
6768 (setq a (rassoc char alist))
6769 (and (>= char ?0) (<= char ?9)
6770 (setq n (if (= char ?0) 9 (- char ?0 1))
6771 tag (concat effort-op (nth n efforts))
6776 (and tag (setq a (cons tag nil))))
6777 (org-agenda-filter-show-all-tag)
6779 (setq org-agenda-tag-filter
6780 (cons (concat (if strip "-" "+") tag)
6781 (if narrow current nil)))
6782 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6783 (setq maybe-refresh t))
6784 (t (error "Invalid tag selection character %c" char)))
6785 (when (and maybe-refresh
6786 (eq org-agenda-clockreport-mode 'with-filter))
6787 (org-agenda-redo))))
6789 (defun org-agenda-get-represented-tags ()
6790 "Get a list of all tags currently represented in the agenda."
6793 (goto-char (point-min))
6794 (while (setq p (next-single-property-change (point) 'tags))
6796 (mapc (lambda (x) (add-to-list 'tags x))
6797 (get-text-property (point) 'tags))))
6800 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6801 "Refine the current filter. See `org-agenda-filter-by-tag'."
6803 (org-agenda-filter-by-tag strip char 'refine))
6805 (defun org-agenda-filter-make-matcher ()
6806 "Create the form that tests a line for agenda filter."
6808 ;; first compute the tag-filter matcher
6809 (dolist (x (delete-dups
6810 (append (get 'org-agenda-tag-filter
6811 :preset-filter) org-agenda-tag-filter)))
6812 (if (member x '("-" "+"))
6813 (setq f1 (if (equal x "-") 'tags '(not tags)))
6814 (if (string-match "[<=>?]" x)
6815 (setq f1 (org-agenda-filter-effort-form x))
6816 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6817 (if (equal (string-to-char x) ?-)
6818 (setq f1 (list 'not f1))))
6820 ;; then compute the category-filter matcher
6821 (dolist (x (delete-dups
6822 (append (get 'org-agenda-category-filter
6823 :preset-filter) org-agenda-category-filter)))
6824 (if (equal "-" (substring x 0 1))
6825 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
6826 (setq f1 (list 'equal (substring x 1) 'cat)))
6828 (cons 'and (nreverse f))))
6830 (defun org-agenda-filter-effort-form (e)
6831 "Return the form to compare the effort of the current line with what E says.
6832 E looks like \"+<2:25\"."
6834 (setq e (substring e 1))
6835 (setq op (string-to-char e) e (substring e 1))
6836 (setq op (cond ((equal op ?<) '<=)
6840 (list 'org-agenda-compare-effort (list 'quote op)
6841 (org-duration-string-to-minutes e))))
6843 (defun org-agenda-compare-effort (op value)
6844 "Compare the effort of the current line with VALUE, using OP.
6845 If the line does not have an effort defined, return nil."
6846 (let ((eff (org-get-at-bol 'effort-minutes)))
6849 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6852 (defun org-agenda-filter-apply (filter type)
6853 "Set FILTER as the new agenda filter and apply it."
6856 (setq org-agenda-tag-filter filter)
6857 (setq org-agenda-category-filter filter))
6858 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6859 (if (and (eq type 'category)
6860 (not (equal (substring (car filter) 0 1) "-")))
6861 ;; Only set `org-agenda-filtered-by-category' to t
6862 ;; when a unique category is used as the filter
6863 (setq org-agenda-filtered-by-category t))
6864 (org-agenda-set-mode-name)
6866 (goto-char (point-min))
6868 (if (org-get-at-bol 'org-marker)
6870 (setq tags (org-get-at-bol 'tags) ; used in eval
6871 cat (get-text-property (point) 'org-category))
6872 (if (not (eval org-agenda-filter-form))
6873 (org-agenda-filter-hide-line type))
6874 (beginning-of-line 2))
6875 (beginning-of-line 2))))
6876 (if (get-char-property (point) 'invisible)
6877 (ignore-errors (org-agenda-previous-line)))))
6879 (defun org-agenda-filter-top-category-apply (category &optional negative)
6880 "Set FILTER as the new agenda filter and apply it."
6881 (org-agenda-set-mode-name)
6883 (goto-char (point-min))
6885 (let* ((pos (org-get-at-bol 'org-hd-marker))
6886 (topcat (and pos (org-find-top-category pos))))
6887 (if (and topcat (funcall (if negative 'identity 'not)
6888 (string= category topcat)))
6889 (org-agenda-filter-hide-line 'category)))
6890 (beginning-of-line 2)))
6891 (if (get-char-property (point) 'invisible)
6892 (org-agenda-previous-line))
6893 (setq org-agenda-top-category-filter category
6894 org-agenda-filtered-by-top-category t))
6896 (defun org-agenda-filter-hide-line (type)
6898 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6900 (overlay-put ov 'invisible t)
6901 (overlay-put ov 'type type)
6903 (push ov org-agenda-tag-filter-overlays)
6904 (push ov org-agenda-cat-filter-overlays))))
6906 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6907 (setq pos (or pos (point)))
6909 (dolist (ov (overlays-at pos))
6910 (when (and (overlay-get ov 'invisible)
6911 (eq (overlay-get ov 'type) 'tag))
6913 (if (< (overlay-start ov) (point-at-eol))
6914 (move-overlay ov (point-at-eol)
6915 (overlay-end ov)))))))
6917 (defun org-agenda-filter-show-all-tag nil
6918 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6919 (setq org-agenda-tag-filter-overlays nil
6920 org-agenda-tag-filter nil
6921 org-agenda-filter-form nil)
6922 (org-agenda-set-mode-name))
6924 (defun org-agenda-filter-show-all-cat nil
6925 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6926 (setq org-agenda-cat-filter-overlays nil
6927 org-agenda-filtered-by-category nil
6928 org-agenda-category-filter nil
6929 org-agenda-filter-form nil)
6930 (org-agenda-set-mode-name))
6932 (defun org-agenda-manipulate-query-add ()
6933 "Manipulate the query by adding a search term with positive selection.
6934 Positive selection means the term must be matched for selection of an entry."
6936 (org-agenda-manipulate-query ?\[))
6937 (defun org-agenda-manipulate-query-subtract ()
6938 "Manipulate the query by adding a search term with negative selection.
6939 Negative selection means term must not be matched for selection of an entry."
6941 (org-agenda-manipulate-query ?\]))
6942 (defun org-agenda-manipulate-query-add-re ()
6943 "Manipulate the query by adding a search regexp with positive selection.
6944 Positive selection means the regexp must match for selection of an entry."
6946 (org-agenda-manipulate-query ?\{))
6947 (defun org-agenda-manipulate-query-subtract-re ()
6948 "Manipulate the query by adding a search regexp with negative selection.
6949 Negative selection means regexp must not match for selection of an entry."
6951 (org-agenda-manipulate-query ?\}))
6952 (defun org-agenda-manipulate-query (char)
6954 ((memq org-agenda-type '(timeline agenda))
6955 (let ((org-agenda-include-inactive-timestamps t))
6957 (message "Display now includes inactive timestamps as well"))
6958 ((eq org-agenda-type 'search)
6960 'org-agenda-query-string
6961 (if org-agenda-last-search-view-search-was-boolean
6962 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6963 (?\{ . " +{}") (?\} . " -{}"))))
6965 (setq org-agenda-redo-command
6966 (list 'org-search-view
6967 (car (get-text-property (point) 'org-last-args))
6968 org-agenda-query-string
6969 (+ (length org-agenda-query-string)
6970 (if (member char '(?\{ ?\})) 0 1))))
6971 (set-register org-agenda-query-register org-agenda-query-string)
6972 (let ((org-agenda-overriding-arguments
6973 (cdr org-agenda-redo-command)))
6975 (t (error "Cannot manipulate query for %s-type agenda buffers"
6978 (defun org-add-to-string (var string)
6979 (set var (concat (symbol-value var) string)))
6981 (defun org-agenda-goto-date (span)
6982 "Jump to DATE in agenda."
6984 (let* ((org-read-date-prefer-future
6985 (eval org-agenda-jump-prefer-future))
6986 (date (org-read-date))
6987 (org-agenda-sticky-orig org-agenda-sticky)
6988 (org-agenda-buffer-tmp-name (buffer-name))
6989 (args (get-text-property (point) 'org-last-args))
6990 (0-arg (or current-prefix-arg (car args)))
6991 (2-arg (nth 2 args))
6992 (newcmd (list 'org-agenda-list 0-arg date
6993 (org-agenda-span-to-ndays 2-arg)))
6994 (newargs (cdr newcmd))
6995 (inhibit-read-only t)
6997 (if (not (org-agenda-check-type t 'agenda))
6998 (error "Not available in non-agenda blocks")
6999 (add-text-properties (point-min) (point-max)
7000 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7002 (setq org-agenda-sticky org-agenda-sticky-orig
7003 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7005 (defun org-agenda-goto-today ()
7008 (org-agenda-check-type t 'timeline 'agenda)
7009 (let* ((args (get-text-property (point) 'org-last-args))
7010 (curspan (nth 2 args))
7011 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7013 (tdpos (goto-char tdpos))
7014 ((eq org-agenda-type 'agenda)
7015 (let* ((sd (org-agenda-compute-starting-span
7016 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7017 (org-agenda-overriding-arguments args))
7018 (setf (nth 1 org-agenda-overriding-arguments) sd)
7020 (org-agenda-find-same-or-today-or-agenda)))
7021 (t (error "Cannot find today")))))
7023 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7025 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7026 (text-property-any (point-min) (point-max) 'org-today t)
7027 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7028 (and (get-text-property (point) 'org-serie)
7029 (org-agenda-goto-block-beginning))
7032 (defun org-agenda-goto-block-beginning ()
7033 "Go the agenda block beginning."
7035 (if (not (derived-mode-p 'org-agenda-mode))
7036 (error "Cannot execute this command outside of org-agenda-mode buffers")
7039 (unless (looking-at "\\'")
7041 (let* ((prop 'org-agenda-structural-header)
7042 (p (previous-single-property-change (point) prop))
7043 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7044 (1- (point))) prop)))
7045 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7047 (error "Cannot find the beginning of the blog")
7049 (move-beginning-of-line 1)))))
7051 (defun org-agenda-later (arg)
7052 "Go forward in time by thee current span.
7053 With prefix ARG, go forward that many times the current span."
7055 (org-agenda-check-type t 'agenda)
7056 (let* ((args (get-text-property (point) 'org-last-args))
7057 (span (or (nth 2 args) org-agenda-current-span))
7058 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7059 (greg (calendar-gregorian-from-absolute sd))
7060 (cnt (org-get-at-bol 'org-day-cnt))
7064 (setq sd (+ span sd)))
7066 (setq sd (+ arg sd)))
7068 (setq sd (+ (* 7 arg) sd)))
7070 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7071 sd (calendar-absolute-from-gregorian greg2))
7072 (setcar greg2 (1+ (car greg2))))
7074 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7075 sd (calendar-absolute-from-gregorian greg2))
7076 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7078 (setq sd (+ (* span arg) sd))))
7079 (let ((org-agenda-overriding-cmd
7080 ;; `cmd' may have been set by `org-agenda-run-series' which
7081 ;; uses `org-agenda-overriding-cmd' to decide whether
7082 ;; overriding is allowed for `cmd'
7083 (get-text-property (point) 'org-serie-cmd))
7084 (org-agenda-overriding-arguments
7085 (list (car args) sd span)))
7087 (org-agenda-find-same-or-today-or-agenda cnt))))
7089 (defun org-agenda-earlier (arg)
7090 "Go backward in time by the current span.
7091 With prefix ARG, go backward that many times the current span."
7093 (org-agenda-later (- arg)))
7095 (defun org-agenda-view-mode-dispatch ()
7096 "Call one of the view mode commands."
7098 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
7099 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7100 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7101 (let ((a (read-char-exclusive)))
7103 (?\ (call-interactively 'org-agenda-reset-view))
7104 (?d (call-interactively 'org-agenda-day-view))
7105 (?w (call-interactively 'org-agenda-week-view))
7106 (?m (call-interactively 'org-agenda-month-view))
7107 (?y (call-interactively 'org-agenda-year-view))
7108 (?l (call-interactively 'org-agenda-log-mode))
7109 (?L (org-agenda-log-mode '(4)))
7110 (?c (org-agenda-log-mode 'clockcheck))
7111 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7112 (?a (call-interactively 'org-agenda-archives-mode))
7113 (?A (org-agenda-archives-mode 'files))
7114 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7115 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7116 (?G (call-interactively 'org-agenda-toggle-time-grid))
7117 (?D (call-interactively 'org-agenda-toggle-diary))
7118 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7119 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7120 (org-agenda-check-type t 'timeline 'agenda)
7122 (message "Display now includes inactive timestamps as well"))
7123 (?q (message "Abort"))
7124 (otherwise (error "Invalid key" )))))
7126 (defun org-agenda-reset-view ()
7127 "Switch to default view for agenda."
7129 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7130 (defun org-agenda-day-view (&optional day-of-year)
7131 "Switch to daily view for agenda.
7132 With argument DAY-OF-YEAR, switch to that day of the year."
7134 (org-agenda-change-time-span 'day day-of-year))
7135 (defun org-agenda-week-view (&optional iso-week)
7136 "Switch to daily view for agenda.
7137 With argument ISO-WEEK, switch to the corresponding ISO week.
7138 If ISO-WEEK has more then 2 digits, only the last two encode the
7139 week. Any digits before this encode a year. So 200712 means
7140 week 12 of year 2007. Years in the range 1938-2037 can also be
7141 written as 2-digit years."
7143 (org-agenda-change-time-span 'week iso-week))
7144 (defun org-agenda-month-view (&optional month)
7145 "Switch to monthly view for agenda.
7146 With argument MONTH, switch to that month."
7148 (org-agenda-change-time-span 'month month))
7149 (defun org-agenda-year-view (&optional year)
7150 "Switch to yearly view for agenda.
7151 With argument YEAR, switch to that year.
7152 If MONTH has more then 2 digits, only the last two encode the
7153 month. Any digits before this encode a year. So 200712 means
7154 December year 2007. Years in the range 1938-2037 can also be
7155 written as 2-digit years."
7158 (setq year (org-small-year-to-year year)))
7159 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7160 (org-agenda-change-time-span 'year year)
7163 (defun org-agenda-change-time-span (span &optional n)
7164 "Change the agenda view to SPAN.
7165 SPAN may be `day', `week', `month', `year'."
7166 (org-agenda-check-type t 'agenda)
7167 (let* ((args (get-text-property (point) 'org-last-args))
7168 (curspan (nth 2 args)))
7169 (if (and (not n) (equal curspan span))
7170 (error "Viewing span is already \"%s\"" span))
7171 (let* ((sd (or (org-get-at-bol 'day)
7174 (sd (org-agenda-compute-starting-span sd span n))
7175 (org-agenda-overriding-cmd
7176 (get-text-property (point) 'org-serie-cmd))
7177 (org-agenda-overriding-arguments
7178 (list (car args) sd span)))
7180 (org-agenda-find-same-or-today-or-agenda))
7181 (org-agenda-set-mode-name)
7182 (message "Switched to %s view" span)))
7184 (defun org-agenda-compute-starting-span (sd span &optional n)
7185 "Compute starting date for agenda.
7186 SPAN may be `day', `week', `month', `year'. The return value
7187 is a cons cell with the starting date and the number of days,
7188 so that the date SD will be in that range."
7189 (let* ((greg (calendar-gregorian-from-absolute sd))
7196 (setq sd (+ (calendar-absolute-from-gregorian
7200 (let* ((nt (calendar-day-of-week
7201 (calendar-gregorian-from-absolute sd)))
7202 (d (if org-agenda-start-on-weekday
7203 (- nt org-agenda-start-on-weekday)
7206 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7210 (setq y1 (org-small-year-to-year (/ n 100))
7213 (calendar-absolute-from-iso
7215 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7218 (when (and n (> n 99))
7219 (setq y1 (org-small-year-to-year (/ n 100))
7221 (setq sd (calendar-absolute-from-gregorian
7222 (list (or n mg) 1 (or y1 yg))))))
7224 (setq sd (calendar-absolute-from-gregorian
7225 (list 1 1 (or n yg))))))
7228 (defun org-agenda-next-date-line (&optional arg)
7229 "Jump to the next line indicating a date in agenda buffer."
7231 (org-agenda-check-type t 'agenda 'timeline)
7232 (beginning-of-line 1)
7233 ;; This does not work if user makes date format that starts with a blank
7234 (if (looking-at "^\\S-") (forward-char 1))
7235 (if (not (re-search-forward "^\\S-" nil t arg))
7238 (error "No next date after this line in this buffer")))
7239 (goto-char (match-beginning 0)))
7241 (defun org-agenda-previous-date-line (&optional arg)
7242 "Jump to the previous line indicating a date in agenda buffer."
7244 (org-agenda-check-type t 'agenda 'timeline)
7245 (beginning-of-line 1)
7246 (if (not (re-search-backward "^\\S-" nil t arg))
7247 (error "No previous date before this line in this buffer")))
7249 ;; Initialize the highlight
7250 (defvar org-hl (make-overlay 1 1))
7251 (overlay-put org-hl 'face 'highlight)
7253 (defun org-highlight (begin end &optional buffer)
7254 "Highlight a region with overlay."
7255 (move-overlay org-hl begin end (or buffer (current-buffer))))
7257 (defun org-unhighlight ()
7258 "Detach overlay INDEX."
7259 (org-detach-overlay org-hl))
7261 (defun org-unhighlight-once ()
7262 "Remove the highlight from its position, and this function from the hook."
7263 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7266 (defun org-agenda-follow-mode ()
7267 "Toggle follow mode in an agenda buffer."
7269 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7270 (org-agenda-set-mode-name)
7271 (org-agenda-do-context-action)
7272 (message "Follow mode is %s"
7273 (if org-agenda-follow-mode "on" "off")))
7275 (defun org-agenda-entry-text-mode (&optional arg)
7276 "Toggle entry text mode in an agenda buffer."
7278 (setq org-agenda-entry-text-mode (or (integerp arg)
7279 (not org-agenda-entry-text-mode)))
7280 (org-agenda-entry-text-hide)
7281 (and org-agenda-entry-text-mode
7282 (let ((org-agenda-entry-text-maxlines
7283 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7284 (org-agenda-entry-text-show)))
7285 (org-agenda-set-mode-name)
7286 (message "Entry text mode is %s. Maximum number of lines is %d"
7287 (if org-agenda-entry-text-mode "on" "off")
7288 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7290 (defun org-agenda-clockreport-mode (&optional with-filter)
7291 "Toggle clocktable mode in an agenda buffer.
7292 With prefix arg WITH-FILTER, make the clocktable respect the current
7295 (org-agenda-check-type t 'agenda)
7297 (setq org-agenda-clockreport-mode 'with-filter)
7298 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7299 (org-agenda-set-mode-name)
7301 (message "Clocktable mode is %s"
7302 (if org-agenda-clockreport-mode "on" "off")))
7304 (defun org-agenda-log-mode (&optional special)
7305 "Toggle log mode in an agenda buffer.
7306 With argument SPECIAL, show all possible log items, not only the ones
7307 configured in `org-agenda-log-mode-items'.
7308 With a double `C-u' prefix arg, show *only* log items, nothing else."
7310 (org-agenda-check-type t 'agenda 'timeline)
7311 (setq org-agenda-show-log
7313 ((equal special '(16)) 'only)
7314 ((eq special 'clockcheck)
7315 (if (eq org-agenda-show-log 'clockcheck)
7317 (special '(closed clock state))
7318 (t (not org-agenda-show-log))))
7319 (org-agenda-set-mode-name)
7321 (message "Log mode is %s"
7322 (if org-agenda-show-log "on" "off")))
7324 (defun org-agenda-archives-mode (&optional with-files)
7325 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7326 When called with a prefix argument, include all archive files as well."
7328 (setq org-agenda-archives-mode
7329 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7330 (org-agenda-set-mode-name)
7335 ((eq org-agenda-archives-mode nil)
7336 "No archives are included")
7337 ((eq org-agenda-archives-mode 'trees)
7338 (format "Trees with :%s: tag are included" org-archive-tag))
7339 ((eq org-agenda-archives-mode t)
7340 (format "Trees with :%s: tag and all active archive files are included"
7341 org-archive-tag)))))
7343 (defun org-agenda-toggle-diary ()
7344 "Toggle diary inclusion in an agenda buffer."
7346 (org-agenda-check-type t 'agenda)
7347 (setq org-agenda-include-diary (not org-agenda-include-diary))
7349 (org-agenda-set-mode-name)
7350 (message "Diary inclusion turned %s"
7351 (if org-agenda-include-diary "on" "off")))
7353 (defun org-agenda-toggle-deadlines ()
7354 "Toggle inclusion of entries with a deadline in an agenda buffer."
7356 (org-agenda-check-type t 'agenda)
7357 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7359 (org-agenda-set-mode-name)
7360 (message "Deadlines inclusion turned %s"
7361 (if org-agenda-include-deadlines "on" "off")))
7363 (defun org-agenda-toggle-time-grid ()
7364 "Toggle time grid in an agenda buffer."
7366 (org-agenda-check-type t 'agenda)
7367 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7369 (org-agenda-set-mode-name)
7370 (message "Time-grid turned %s"
7371 (if org-agenda-use-time-grid "on" "off")))
7373 (defun org-agenda-set-mode-name ()
7374 "Set the mode name to indicate all the small mode settings."
7377 (if (get 'org-agenda-files 'org-restrict) " []" "")
7379 '(:eval (org-agenda-span-name org-agenda-current-span))
7380 (if org-agenda-follow-mode " Follow" "")
7381 (if org-agenda-entry-text-mode " ETxt" "")
7382 (if org-agenda-include-diary " Diary" "")
7383 (if org-agenda-include-deadlines " Ddl" "")
7384 (if org-agenda-use-time-grid " Grid" "")
7385 (if (and (boundp 'org-habit-show-habits)
7386 org-habit-show-habits) " Habit" "")
7388 ((consp org-agenda-show-log) " LogAll")
7389 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7390 (org-agenda-show-log " Log")
7392 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7394 '(:eval (org-propertize
7399 (get 'org-agenda-category-filter :preset-filter)
7400 org-agenda-category-filter)
7403 'face 'org-agenda-filter-category
7404 'help-echo "Category used in filtering"))
7406 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7408 '(:eval (org-propertize
7413 (get 'org-agenda-tag-filter :preset-filter)
7414 org-agenda-tag-filter)
7417 'face 'org-agenda-filter-tags
7418 'help-echo "Tags used in filtering"))
7420 (if org-agenda-archives-mode
7421 (if (eq org-agenda-archives-mode t)
7423 (format " :%s:" org-archive-tag))
7425 (if org-agenda-clockreport-mode
7426 (if (eq org-agenda-clockreport-mode 'with-filter)
7427 " Clock{}" " Clock")
7429 (force-mode-line-update))
7431 (defun org-agenda-post-command-hook ()
7432 (setq org-agenda-type
7433 (or (get-text-property (point) 'org-agenda-type)
7434 (get-text-property (max (point-min) (1- (point)))
7435 'org-agenda-type))))
7437 (defun org-agenda-next-line ()
7438 "Move cursor to the next line, and show if follow mode is active."
7440 (call-interactively 'next-line)
7441 (org-agenda-do-context-action))
7443 (defun org-agenda-previous-line ()
7444 "Move cursor to the previous line, and show if follow-mode is active."
7446 (call-interactively 'previous-line)
7447 (org-agenda-do-context-action))
7449 (defun org-agenda-next-item (n)
7450 "Move cursor to next agenda item."
7452 (let ((col (current-column)))
7454 (when (next-single-property-change (point-at-eol) 'org-marker)
7455 (move-end-of-line 1)
7456 (goto-char (next-single-property-change (point) 'org-marker))))
7457 (org-move-to-column col))
7458 (org-agenda-do-context-action))
7460 (defun org-agenda-previous-item (n)
7461 "Move cursor to next agenda item."
7464 (let ((col (current-column))
7465 (goto (save-excursion
7466 (move-end-of-line 0)
7467 (previous-single-property-change (point) 'org-marker))))
7468 (if goto (goto-char goto))
7469 (org-move-to-column col)))
7470 (org-agenda-do-context-action))
7472 (defun org-agenda-do-context-action ()
7473 "Show outline path and, maybe, follow mode window."
7474 (let ((m (org-get-at-bol 'org-marker)))
7475 (when (and (markerp m) (marker-buffer m))
7476 (and org-agenda-follow-mode
7477 (if org-agenda-follow-indirect
7478 (org-agenda-tree-to-indirect-buffer)
7480 (and org-agenda-show-outline-path
7481 (org-with-point-at m (org-display-outline-path t))))))
7483 (defun org-agenda-show-priority ()
7484 "Show the priority of the current item.
7485 This priority is composed of the main priority given with the [#A] cookies,
7486 and by additional input from the age of a schedules or deadline entry."
7488 (let* ((pri (org-get-at-bol 'priority)))
7489 (message "Priority is %d" (if pri pri -1000))))
7491 (defun org-agenda-show-tags ()
7492 "Show the tags applicable to the current item."
7494 (let* ((tags (org-get-at-bol 'tags)))
7496 (message "Tags are :%s:"
7497 (org-no-properties (mapconcat 'identity tags ":")))
7498 (message "No tags associated with this line"))))
7500 (defun org-agenda-goto (&optional highlight)
7501 "Go to the Org-mode file which contains the item at point."
7503 (let* ((marker (or (org-get-at-bol 'org-marker)
7504 (org-agenda-error)))
7505 (buffer (marker-buffer marker))
7506 (pos (marker-position marker)))
7507 (switch-to-buffer-other-window buffer)
7511 (when (derived-mode-p 'org-mode)
7512 (org-show-context 'agenda)
7514 (and (outline-next-heading)
7515 (org-flag-heading nil)))) ; show the next heading
7516 (when (outline-invisible-p)
7517 (show-entry)) ; display invisible text
7518 (recenter (/ (window-height) 2))
7519 (run-hooks 'org-agenda-after-show-hook)
7520 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7522 (defvar org-agenda-after-show-hook nil
7523 "Normal hook run after an item has been shown from the agenda.
7524 Point is in the buffer where the item originated.")
7526 (defun org-agenda-kill ()
7527 "Kill the entry or subtree belonging to the current agenda entry."
7529 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7530 (let* ((bufname-orig (buffer-name))
7531 (marker (or (org-get-at-bol 'org-marker)
7532 (org-agenda-error)))
7533 (buffer (marker-buffer marker))
7534 (pos (marker-position marker))
7535 (type (org-get-at-bol 'type))
7536 dbeg dend (n 0) conf)
7537 (org-with-remote-undo buffer
7538 (with-current-buffer buffer
7541 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
7542 (setq dbeg (progn (org-back-to-heading t) (point))
7543 dend (org-end-of-subtree t t))
7544 (setq dbeg (point-at-bol)
7545 dend (min (point-max) (1+ (point-at-eol)))))
7547 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7548 (setq conf (or (eq t org-agenda-confirm-kill)
7549 (and (numberp org-agenda-confirm-kill)
7550 (> n org-agenda-confirm-kill))))
7553 (format "Delete entry with %d lines in buffer \"%s\"? "
7554 n (buffer-name buffer))))
7556 (let ((org-agenda-buffer-name bufname-orig))
7557 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
7558 (with-current-buffer buffer (delete-region dbeg dend))
7559 (message "Agenda item and source killed"))))
7561 (defvar org-archive-default-command) ; defined in org-archive.el
7562 (defun org-agenda-archive-default ()
7563 "Archive the entry or subtree belonging to the current agenda entry."
7565 (require 'org-archive)
7566 (org-agenda-archive-with org-archive-default-command))
7568 (defun org-agenda-archive-default-with-confirmation ()
7569 "Archive the entry or subtree belonging to the current agenda entry."
7571 (require 'org-archive)
7572 (org-agenda-archive-with org-archive-default-command 'confirm))
7574 (defun org-agenda-archive ()
7575 "Archive the entry or subtree belonging to the current agenda entry."
7577 (org-agenda-archive-with 'org-archive-subtree))
7579 (defun org-agenda-archive-to-archive-sibling ()
7580 "Move the entry to the archive sibling."
7582 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7584 (defun org-agenda-archive-with (cmd &optional confirm)
7585 "Move the entry to the archive sibling."
7587 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7588 (let* ((bufname-orig (buffer-name))
7589 (marker (or (org-get-at-bol 'org-marker)
7590 (org-agenda-error)))
7591 (buffer (marker-buffer marker))
7592 (pos (marker-position marker)))
7593 (org-with-remote-undo buffer
7594 (with-current-buffer buffer
7595 (if (derived-mode-p 'org-mode)
7597 (not (y-or-n-p "Archive this subtree or entry? ")))
7601 (let ((org-agenda-buffer-name bufname-orig))
7602 (org-remove-subtree-entries-from-agenda))
7603 (org-back-to-heading t)
7605 (error "Archiving works only in Org-mode files"))))))
7607 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7608 "Remove all lines in the agenda that correspond to a given subtree.
7609 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7610 If this information is not given, the function uses the tree at point."
7611 (let ((buf (or buf (current-buffer))) m p)
7613 (unless (and beg end)
7614 (org-back-to-heading t)
7616 (org-end-of-subtree t)
7618 (set-buffer (get-buffer org-agenda-buffer-name))
7620 (goto-char (point-max))
7621 (beginning-of-line 1)
7623 (when (and (setq m (org-get-at-bol 'org-marker))
7624 (equal buf (marker-buffer m))
7625 (setq p (marker-position m))
7628 (let ((inhibit-read-only t))
7629 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7630 (beginning-of-line 0))))))
7632 (defun org-agenda-refile (&optional goto rfloc no-update)
7633 "Refile the item at point."
7635 (if (equal goto '(16))
7636 (org-refile-goto-last-stored)
7637 (let* ((buffer-orig (buffer-name))
7638 (marker (or (org-get-at-bol 'org-hd-marker)
7639 (org-agenda-error)))
7640 (buffer (marker-buffer marker))
7641 (pos (marker-position marker))
7643 (org-refile-get-location
7644 (if goto "Goto" "Refile to") buffer
7645 org-refile-allow-creating-parent-nodes))))
7646 (with-current-buffer buffer
7651 (let ((org-agenda-buffer-name buffer-orig))
7652 (org-remove-subtree-entries-from-agenda))
7653 (org-refile goto buffer rfloc)))))
7654 (unless no-update (org-agenda-redo))))
7656 (defun org-agenda-open-link (&optional arg)
7657 "Follow the link in the current line, if any.
7658 This looks for a link in the displayed line in the agenda. It also looks
7659 at the text of the entry itself."
7661 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7662 (org-get-at-bol 'org-marker)))
7663 (buffer (and marker (marker-buffer marker)))
7664 (prefix (buffer-substring
7665 (point-at-bol) (point-at-eol))))
7668 (with-current-buffer buffer
7673 (org-offer-links-in-entry arg prefix)))))
7674 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7676 (beginning-of-line 1)
7677 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7678 (org-open-link-from-string (match-string 1)))
7679 (t (error "No link to open here")))))
7681 (defun org-agenda-copy-local-variable (var)
7682 "Get a variable from a referenced buffer and install it here."
7683 (let ((m (org-get-at-bol 'org-marker)))
7684 (when (and m (buffer-live-p (marker-buffer m)))
7685 (org-set-local var (with-current-buffer (marker-buffer m)
7686 (symbol-value var))))))
7688 (defun org-agenda-switch-to (&optional delete-other-windows)
7689 "Go to the Org-mode file which contains the item at point."
7691 (if (and org-return-follows-link
7692 (not (org-get-at-bol 'org-marker))
7693 (org-in-regexp org-bracket-link-regexp))
7694 (org-open-link-from-string (match-string 0))
7695 (let* ((marker (or (org-get-at-bol 'org-marker)
7696 (org-agenda-error)))
7697 (buffer (marker-buffer marker))
7698 (pos (marker-position marker)))
7699 (org-pop-to-buffer-same-window buffer)
7700 (and delete-other-windows (delete-other-windows))
7703 (when (derived-mode-p 'org-mode)
7704 (org-show-context 'agenda)
7706 (and (outline-next-heading)
7707 (org-flag-heading nil))) ; show the next heading
7708 (when (outline-invisible-p)
7709 (show-entry)) ; display invisible text
7710 (run-hooks 'org-agenda-after-show-hook)))))
7712 (defun org-agenda-goto-mouse (ev)
7713 "Go to the Org-mode file which contains the item at the mouse click."
7715 (mouse-set-point ev)
7718 (defun org-agenda-show (&optional full-entry)
7719 "Display the Org-mode file which contains the item at point.
7720 With prefix argument FULL-ENTRY, make the entire entry visible
7721 if it was hidden in the outline."
7723 (let ((win (selected-window)))
7725 (let ((org-show-entry-below t))
7726 (org-agenda-goto t))
7727 (org-agenda-goto t))
7728 (select-window win)))
7730 (defvar org-agenda-show-window nil)
7731 (defun org-agenda-show-and-scroll-up (&optional arg)
7732 "Display the Org-mode file which contains the item at point.
7733 When called repeatedly, scroll the window that is displaying the buffer.
7734 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7735 `show-subtree' to display the item, so that drawers and logbooks stay
7738 (let ((win (selected-window)))
7739 (if (and (window-live-p org-agenda-show-window)
7740 (eq this-command last-command))
7742 (select-window org-agenda-show-window)
7743 (ignore-errors (scroll-up)))
7745 (if arg (org-show-entry) (show-subtree))
7746 (setq org-agenda-show-window (selected-window)))
7747 (select-window win)))
7749 (defun org-agenda-show-scroll-down ()
7750 "Scroll down the window showing the agenda."
7752 (let ((win (selected-window)))
7753 (when (window-live-p org-agenda-show-window)
7754 (select-window org-agenda-show-window)
7755 (ignore-errors (scroll-down))
7756 (select-window win))))
7758 (defun org-agenda-show-1 (&optional more)
7759 "Display the Org-mode file which contains the item at point.
7760 The prefix arg selects the amount of information to display:
7763 1 just show the entry according to defaults.
7764 2 show the children view
7765 3 show the subtree view
7766 4 show the entire subtree and any LOGBOOK drawers
7767 5 show the entire subtree and any drawers
7768 With prefix argument FULL-ENTRY, make the entire entry visible
7769 if it was hidden in the outline."
7771 (let ((win (selected-window)))
7773 (org-recenter-heading 1)
7778 (org-back-to-heading)
7779 (run-hook-with-args 'org-cycle-hook 'folded))
7780 (message "Remote: FOLDED"))
7781 ((and (org-called-interactively-p 'any) (= more 1))
7782 (message "Remote: show with default settings"))
7787 (org-back-to-heading)
7788 (run-hook-with-args 'org-cycle-hook 'children))
7789 (message "Remote: CHILDREN"))
7793 (org-back-to-heading)
7794 (run-hook-with-args 'org-cycle-hook 'subtree))
7795 (message "Remote: SUBTREE"))
7797 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7799 (concat "^[ \t]*:\\("
7800 (mapconcat 'regexp-quote org-drawers "\\|")
7804 (org-back-to-heading)
7805 (org-cycle-hide-drawers 'subtree)))
7806 (message "Remote: SUBTREE AND LOGBOOK"))
7809 (message "Remote: SUBTREE AND ALL DRAWERS")))
7810 (select-window win)))
7812 (defun org-recenter-heading (n)
7814 (org-back-to-heading)
7817 (defvar org-agenda-cycle-counter nil)
7818 (defun org-agenda-cycle-show (&optional n)
7819 "Show the current entry in another window, with default settings.
7820 Default settings are taken from `org-show-hierarchy-above' and siblings.
7821 When use repeatedly in immediate succession, the remote entry will cycle
7824 children -> subtree -> folded
7826 When called with a numeric prefix arg, that arg will be passed through to
7827 `org-agenda-show-1'. For the interpretation of that argument, see the
7828 docstring of `org-agenda-show-1'."
7831 (setq org-agenda-cycle-counter n)
7832 (if (not (eq last-command this-command))
7833 (setq org-agenda-cycle-counter 1)
7834 (if (equal org-agenda-cycle-counter 0)
7835 (setq org-agenda-cycle-counter 2)
7836 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7837 (if (> org-agenda-cycle-counter 3)
7838 (setq org-agenda-cycle-counter 0)))))
7839 (org-agenda-show-1 org-agenda-cycle-counter))
7841 (defun org-agenda-recenter (arg)
7842 "Display the Org-mode file which contains the item at point and recenter."
7844 (let ((win (selected-window)))
7847 (select-window win)))
7849 (defun org-agenda-show-mouse (ev)
7850 "Display the Org-mode file which contains the item at the mouse click."
7852 (mouse-set-point ev)
7855 (defun org-agenda-check-no-diary ()
7856 "Check if the entry is a diary link and abort if yes."
7857 (if (org-get-at-bol 'org-agenda-diary-link)
7858 (org-agenda-error)))
7860 (defun org-agenda-error ()
7861 (error "Command not allowed in this line"))
7863 (defun org-agenda-tree-to-indirect-buffer ()
7864 "Show the subtree corresponding to the current entry in an indirect buffer.
7865 This calls the command `org-tree-to-indirect-buffer' from the original
7867 With numerical prefix arg ARG, go up to this level and then take that tree.
7868 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7869 use the dedicated frame)."
7871 (if (and current-prefix-arg (listp current-prefix-arg))
7872 (org-agenda-do-tree-to-indirect-buffer)
7873 (let ((agenda-window (selected-window))
7875 (and org-last-indirect-buffer
7876 (get-buffer-window org-last-indirect-buffer))))
7877 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7880 (unless (and indirect-window (window-live-p indirect-window))
7881 (setq indirect-window (split-window agenda-window)))
7882 (select-window indirect-window)
7883 (switch-to-buffer org-last-indirect-buffer :norecord)
7884 (fit-window-to-buffer indirect-window))
7885 (select-window (get-buffer-window org-agenda-buffer-name))))))
7887 (defun org-agenda-do-tree-to-indirect-buffer ()
7888 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7889 (org-agenda-check-no-diary)
7890 (let* ((marker (or (org-get-at-bol 'org-marker)
7891 (org-agenda-error)))
7892 (buffer (marker-buffer marker))
7893 (pos (marker-position marker)))
7894 (with-current-buffer buffer
7897 (call-interactively 'org-tree-to-indirect-buffer)))))
7899 (defvar org-last-heading-marker (make-marker)
7900 "Marker pointing to the headline that last changed its TODO state
7901 by a remote command from the agenda.")
7903 (defun org-agenda-todo-nextset ()
7904 "Switch TODO entry to next sequence."
7906 (org-agenda-todo 'nextset))
7908 (defun org-agenda-todo-previousset ()
7909 "Switch TODO entry to previous sequence."
7911 (org-agenda-todo 'previousset))
7913 (defun org-agenda-todo (&optional arg)
7914 "Cycle TODO state of line at point, also in Org-mode file.
7915 This changes the line at point, all other lines in the agenda referring to
7916 the same tree node, and the headline of the tree node in the Org-mode file."
7918 (org-agenda-check-no-diary)
7919 (let* ((col (current-column))
7920 (marker (or (org-get-at-bol 'org-marker)
7921 (org-agenda-error)))
7922 (buffer (marker-buffer marker))
7923 (pos (marker-position marker))
7924 (hdmarker (org-get-at-bol 'org-hd-marker))
7925 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7926 (inhibit-read-only t)
7927 org-agenda-headline-snapshot-before-repeat newhead just-one)
7928 (org-with-remote-undo buffer
7929 (with-current-buffer buffer
7932 (org-show-context 'agenda)
7934 (and (outline-next-heading)
7935 (org-flag-heading nil))) ; show the next heading
7936 (let ((current-prefix-arg arg))
7937 (call-interactively 'org-todo))
7938 (and (bolp) (forward-char 1))
7939 (setq newhead (org-get-heading))
7940 (when (and (org-bound-and-true-p
7941 org-agenda-headline-snapshot-before-repeat)
7942 (not (equal org-agenda-headline-snapshot-before-repeat
7945 (setq newhead org-agenda-headline-snapshot-before-repeat
7948 (org-back-to-heading)
7949 (move-marker org-last-heading-marker (point))))
7950 (beginning-of-line 1)
7952 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7953 (org-move-to-column col))))
7955 (defun org-agenda-add-note (&optional arg)
7956 "Add a time-stamped note to the entry at point."
7958 (org-agenda-check-no-diary)
7959 (let* ((marker (or (org-get-at-bol 'org-marker)
7960 (org-agenda-error)))
7961 (buffer (marker-buffer marker))
7962 (pos (marker-position marker))
7963 (hdmarker (org-get-at-bol 'org-hd-marker))
7964 (inhibit-read-only t))
7965 (with-current-buffer buffer
7968 (org-show-context 'agenda)
7970 (and (outline-next-heading)
7971 (org-flag-heading nil))) ; show the next heading
7974 (defun org-agenda-change-all-lines (newhead hdmarker
7975 &optional fixface just-this)
7976 "Change all lines in the agenda buffer which match HDMARKER.
7977 The new content of the line will be NEWHEAD (as modified by
7978 `org-agenda-format-item'). HDMARKER is checked with
7979 `equal' against all `org-hd-marker' text properties in the file.
7980 If FIXFACE is non-nil, the face of each item is modified according to
7982 If JUST-THIS is non-nil, change just the current line, not all.
7983 If FORCE-TAGS is non nil, the car of it returns the new tags."
7984 (let* ((inhibit-read-only t)
7985 (line (org-current-line))
7986 (org-agenda-buffer (current-buffer))
7987 (thetags (with-current-buffer (marker-buffer hdmarker)
7988 (save-excursion (save-restriction (widen)
7989 (goto-char hdmarker)
7990 (org-get-tags-at)))))
7991 props m pl undone-face done-face finish new dotime cat tags)
7993 (goto-char (point-max))
7994 (beginning-of-line 1)
7996 (setq finish (bobp))
7997 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7998 (or (not just-this) (= (org-current-line) line))
8000 (setq props (text-properties-at (point))
8001 dotime (org-get-at-bol 'dotime)
8002 cat (org-get-at-bol 'org-category)
8005 (let ((org-prefix-format-compiled
8006 (or (get-text-property (point) 'format)
8007 org-prefix-format-compiled))
8008 (extra (org-get-at-bol 'extra)))
8009 (with-current-buffer (marker-buffer hdmarker)
8013 (org-agenda-format-item extra newhead cat tags dotime)))))
8014 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8015 undone-face (org-get-at-bol 'undone-face)
8016 done-face (org-get-at-bol 'done-face))
8017 (beginning-of-line 1)
8020 (and (looking-at ".*\n?") (replace-match "")))
8022 (replace-match new t t)
8023 (beginning-of-line 1)
8024 (add-text-properties (point-at-bol) (point-at-eol) props)
8026 (add-text-properties
8027 (point-at-bol) (point-at-eol)
8029 (if org-last-todo-state-is-todo
8030 undone-face done-face))))
8031 (org-agenda-highlight-todo 'line)
8032 (beginning-of-line 1))
8033 (t (error "Line update did not work"))))
8034 (beginning-of-line 0)))
8035 (org-agenda-finalize)))
8037 (defun org-agenda-align-tags (&optional line)
8038 "Align all tags in agenda items to `org-agenda-tags-column'."
8039 (let ((inhibit-read-only t) l c)
8041 (goto-char (if line (point-at-bol) (point-min)))
8042 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8043 (if line (point-at-eol) nil) t)
8044 (add-text-properties
8045 (match-beginning 2) (match-end 2)
8046 (list 'face (delq nil (let ((prop (get-text-property
8047 (match-beginning 2) 'face)))
8048 (or (listp prop) (setq prop (list prop)))
8049 (if (memq 'org-tag prop)
8051 (cons 'org-tag prop))))))
8052 (setq l (- (match-end 2) (match-beginning 2))
8053 c (if (< org-agenda-tags-column 0)
8054 (- (abs org-agenda-tags-column) l)
8055 org-agenda-tags-column))
8056 (delete-region (match-beginning 1) (match-end 1))
8057 (goto-char (match-beginning 1))
8058 (insert (org-add-props
8059 (make-string (max 1 (- c (current-column))) ?\ )
8060 (plist-put (copy-sequence (text-properties-at (point)))
8062 (goto-char (point-min))
8063 (org-font-lock-add-tag-faces (point-max)))))
8065 (defun org-agenda-priority-up ()
8066 "Increase the priority of line at point, also in Org-mode file."
8068 (org-agenda-priority 'up))
8070 (defun org-agenda-priority-down ()
8071 "Decrease the priority of line at point, also in Org-mode file."
8073 (org-agenda-priority 'down))
8075 (defun org-agenda-priority (&optional force-direction)
8076 "Set the priority of line at point, also in Org-mode file.
8077 This changes the line at point, all other lines in the agenda referring to
8078 the same tree node, and the headline of the tree node in the Org-mode file."
8080 (unless org-enable-priority-commands
8081 (error "Priority commands are disabled"))
8082 (org-agenda-check-no-diary)
8083 (let* ((marker (or (org-get-at-bol 'org-marker)
8084 (org-agenda-error)))
8085 (hdmarker (org-get-at-bol 'org-hd-marker))
8086 (buffer (marker-buffer hdmarker))
8087 (pos (marker-position hdmarker))
8088 (inhibit-read-only t)
8090 (org-with-remote-undo buffer
8091 (with-current-buffer buffer
8094 (org-show-context 'agenda)
8096 (and (outline-next-heading)
8097 (org-flag-heading nil))) ; show the next heading
8098 (funcall 'org-priority force-direction)
8100 (setq newhead (org-get-heading)))
8101 (org-agenda-change-all-lines newhead hdmarker)
8102 (beginning-of-line 1))))
8104 ;; FIXME: should fix the tags property of the agenda line.
8105 (defun org-agenda-set-tags (&optional tag onoff)
8106 "Set tags for the current headline."
8108 (org-agenda-check-no-diary)
8109 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8110 (call-interactively 'org-change-tag-in-region)
8111 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8112 (org-agenda-error)))
8113 (buffer (marker-buffer hdmarker))
8114 (pos (marker-position hdmarker))
8115 (inhibit-read-only t)
8117 (org-with-remote-undo buffer
8118 (with-current-buffer buffer
8122 (org-show-context 'agenda))
8124 (and (outline-next-heading)
8125 (org-flag-heading nil))) ; show the next heading
8128 (org-toggle-tag tag onoff)
8129 (call-interactively 'org-set-tags))
8131 (setq newhead (org-get-heading)))
8132 (org-agenda-change-all-lines newhead hdmarker)
8133 (beginning-of-line 1)))))
8135 (defun org-agenda-set-property ()
8136 "Set a property for the current headline."
8138 (org-agenda-check-no-diary)
8139 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8140 (org-agenda-error)))
8141 (buffer (marker-buffer hdmarker))
8142 (pos (marker-position hdmarker))
8143 (inhibit-read-only t)
8145 (org-with-remote-undo buffer
8146 (with-current-buffer buffer
8150 (org-show-context 'agenda))
8152 (and (outline-next-heading)
8153 (org-flag-heading nil))) ; show the next heading
8155 (call-interactively 'org-set-property)))))
8157 (defun org-agenda-set-effort ()
8158 "Set the effort property for the current headline."
8160 (org-agenda-check-no-diary)
8161 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8162 (org-agenda-error)))
8163 (buffer (marker-buffer hdmarker))
8164 (pos (marker-position hdmarker))
8165 (inhibit-read-only t)
8167 (org-with-remote-undo buffer
8168 (with-current-buffer buffer
8172 (org-show-context 'agenda))
8174 (and (outline-next-heading)
8175 (org-flag-heading nil))) ; show the next heading
8177 (call-interactively 'org-set-effort)
8179 (setq newhead (org-get-heading)))
8180 (org-agenda-change-all-lines newhead hdmarker))))
8182 (defun org-agenda-toggle-archive-tag ()
8183 "Toggle the archive tag for the current entry."
8185 (org-agenda-check-no-diary)
8186 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8187 (org-agenda-error)))
8188 (buffer (marker-buffer hdmarker))
8189 (pos (marker-position hdmarker))
8190 (inhibit-read-only t)
8192 (org-with-remote-undo buffer
8193 (with-current-buffer buffer
8196 (org-show-context 'agenda)
8198 (and (outline-next-heading)
8199 (org-flag-heading nil))) ; show the next heading
8200 (call-interactively 'org-toggle-archive-tag)
8202 (setq newhead (org-get-heading)))
8203 (org-agenda-change-all-lines newhead hdmarker)
8204 (beginning-of-line 1))))
8206 (defun org-agenda-do-date-later (arg)
8209 ((or (equal arg '(16))
8211 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8212 (setq this-command 'org-agenda-date-later-minutes)
8213 (org-agenda-date-later-minutes 1))
8214 ((or (equal arg '(4))
8216 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8217 (setq this-command 'org-agenda-date-later-hours)
8218 (org-agenda-date-later-hours 1))
8220 (org-agenda-date-later (prefix-numeric-value arg)))))
8222 (defun org-agenda-do-date-earlier (arg)
8225 ((or (equal arg '(16))
8227 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8228 (setq this-command 'org-agenda-date-earlier-minutes)
8229 (org-agenda-date-earlier-minutes 1))
8230 ((or (equal arg '(4))
8232 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8233 (setq this-command 'org-agenda-date-earlier-hours)
8234 (org-agenda-date-earlier-hours 1))
8236 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8238 (defun org-agenda-date-later (arg &optional what)
8239 "Change the date of this item to ARG day(s) later."
8241 (org-agenda-check-type t 'agenda 'timeline)
8242 (org-agenda-check-no-diary)
8243 (let* ((marker (or (org-get-at-bol 'org-marker)
8244 (org-agenda-error)))
8245 (buffer (marker-buffer marker))
8246 (pos (marker-position marker))
8248 (org-with-remote-undo buffer
8249 (with-current-buffer buffer
8252 (if (not (org-at-timestamp-p))
8253 (error "Cannot find time stamp"))
8254 (when (and org-agenda-move-date-from-past-immediately-to-today
8256 (or (not what) (eq what 'day))
8257 (not (save-match-data (org-at-date-range-p))))
8258 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8259 cdate (calendar-absolute-from-gregorian
8260 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8263 ;; immediately shift to today
8264 (setq arg (- today cdate))))
8265 (org-timestamp-change arg (or what 'day))
8266 (when (and (org-at-date-range-p)
8267 (re-search-backward org-tr-regexp-both (point-at-bol)))
8268 (let ((end org-last-changed-timestamp))
8269 (org-timestamp-change arg (or what 'day))
8270 (setq org-last-changed-timestamp
8271 (concat org-last-changed-timestamp "--" end)))))
8272 (org-agenda-show-new-time marker org-last-changed-timestamp))
8273 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8275 (defun org-agenda-date-earlier (arg &optional what)
8276 "Change the date of this item to ARG day(s) earlier."
8278 (org-agenda-date-later (- arg) what))
8280 (defun org-agenda-date-later-minutes (arg)
8281 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8283 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8284 (org-agenda-date-later arg 'minute))
8286 (defun org-agenda-date-earlier-minutes (arg)
8287 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8289 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8290 (org-agenda-date-earlier arg 'minute))
8292 (defun org-agenda-date-later-hours (arg)
8293 "Change the time of this item, in hour steps."
8295 (org-agenda-date-later arg 'hour))
8297 (defun org-agenda-date-earlier-hours (arg)
8298 "Change the time of this item, in hour steps."
8300 (org-agenda-date-earlier arg 'hour))
8302 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8303 "Show new date stamp via text properties."
8304 ;; We use text properties to make this undoable
8305 (let ((inhibit-read-only t)
8306 (buffer-invisibility-spec))
8307 (setq stamp (concat " " prefix " => " stamp))
8309 (goto-char (point-max))
8311 (when (equal marker (org-get-at-bol 'org-marker))
8312 (org-move-to-column (- (window-width) (length stamp)) t)
8313 (org-agenda-fix-tags-filter-overlays-at (point))
8314 (if (featurep 'xemacs)
8315 ;; Use `duplicable' property to trigger undo recording
8316 (let ((ex (make-extent nil nil))
8317 (gl (make-glyph stamp)))
8318 (set-glyph-face gl 'secondary-selection)
8319 (set-extent-properties
8320 ex (list 'invisible t 'end-glyph gl 'duplicable t))
8321 (insert-extent ex (1- (point)) (point-at-eol)))
8322 (add-text-properties
8323 (1- (point)) (point-at-eol)
8324 (list 'display (org-add-props stamp nil
8325 'face 'secondary-selection))))
8326 (beginning-of-line 1))
8327 (beginning-of-line 0)))))
8329 (defun org-agenda-date-prompt (arg)
8330 "Change the date of this item. Date is prompted for, with default today.
8331 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8332 be used to request time specification in the time stamp."
8334 (org-agenda-check-type t 'agenda 'timeline)
8335 (org-agenda-check-no-diary)
8336 (let* ((marker (or (org-get-at-bol 'org-marker)
8337 (org-agenda-error)))
8338 (buffer (marker-buffer marker))
8339 (pos (marker-position marker)))
8340 (org-with-remote-undo buffer
8341 (with-current-buffer buffer
8344 (if (not (org-at-timestamp-p t))
8345 (error "Cannot find time stamp"))
8346 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
8347 (org-agenda-show-new-time marker org-last-changed-timestamp))
8348 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8350 (defun org-agenda-schedule (arg &optional time)
8351 "Schedule the item at point.
8352 ARG is passed through to `org-schedule'."
8354 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8355 (org-agenda-check-no-diary)
8356 (let* ((marker (or (org-get-at-bol 'org-marker)
8357 (org-agenda-error)))
8358 (type (marker-insertion-type marker))
8359 (buffer (marker-buffer marker))
8360 (pos (marker-position marker))
8361 (org-insert-labeled-timestamps-at-point nil)
8363 (set-marker-insertion-type marker t)
8364 (org-with-remote-undo buffer
8365 (with-current-buffer buffer
8368 (setq ts (org-schedule arg time)))
8369 (org-agenda-show-new-time marker ts "S"))
8370 (message "Item scheduled for %s" ts)))
8372 (defun org-agenda-deadline (arg &optional time)
8373 "Schedule the item at point.
8374 ARG is passed through to `org-deadline'."
8376 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8377 (org-agenda-check-no-diary)
8378 (let* ((marker (or (org-get-at-bol 'org-marker)
8379 (org-agenda-error)))
8380 (buffer (marker-buffer marker))
8381 (pos (marker-position marker))
8382 (org-insert-labeled-timestamps-at-point nil)
8384 (org-with-remote-undo buffer
8385 (with-current-buffer buffer
8388 (setq ts (org-deadline arg time)))
8389 (org-agenda-show-new-time marker ts "D"))
8390 (message "Deadline for this item set to %s" ts)))
8392 (defun org-agenda-clock-in (&optional arg)
8393 "Start the clock on the currently selected item."
8395 (org-agenda-check-no-diary)
8396 (if (equal arg '(4))
8398 (let* ((marker (or (org-get-at-bol 'org-marker)
8399 (org-agenda-error)))
8400 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8402 (pos (marker-position marker))
8404 (org-with-remote-undo (marker-buffer marker)
8405 (with-current-buffer (marker-buffer marker)
8408 (org-show-context 'agenda)
8410 (org-cycle-hide-drawers 'children)
8412 (setq newhead (org-get-heading)))
8413 (org-agenda-change-all-lines newhead hdmarker)))))
8415 (defun org-agenda-clock-out ()
8416 "Stop the currently running clock."
8418 (unless (marker-buffer org-clock-marker)
8419 (error "No running clock"))
8420 (let ((marker (make-marker)) newhead)
8421 (org-with-remote-undo (marker-buffer org-clock-marker)
8422 (with-current-buffer (marker-buffer org-clock-marker)
8426 (goto-char org-clock-marker)
8427 (org-back-to-heading t)
8428 (move-marker marker (point))
8430 (setq newhead (org-get-heading))))))
8431 (org-agenda-change-all-lines newhead marker)
8432 (move-marker marker nil)))
8434 (defun org-agenda-clock-cancel (&optional arg)
8435 "Cancel the currently running clock."
8437 (unless (marker-buffer org-clock-marker)
8438 (error "No running clock"))
8439 (org-with-remote-undo (marker-buffer org-clock-marker)
8440 (org-clock-cancel)))
8442 (defun org-agenda-clock-goto ()
8443 "Jump to the currently clocked in task within the agenda.
8444 If the currently clocked in task is not listed in the agenda
8445 buffer, display it in another window."
8449 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8450 (setq pos (overlay-start o))))
8451 (overlays-in (point-min) (point-max)))
8452 (cond (pos (goto-char pos))
8453 ;; If the currently clocked entry is not in the agenda
8454 ;; buffer, we visit it in another window:
8455 (org-clock-current-task
8456 (org-switch-to-buffer-other-window (org-clock-goto)))
8457 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8459 (defun org-agenda-diary-entry-in-org-file ()
8460 "Make a diary entry in the file `org-agenda-diary-file'."
8461 (let (d1 d2 char (text "") dp1 dp2)
8462 (if (equal (buffer-name) "*Calendar*")
8463 (setq d1 (calendar-cursor-to-date t)
8464 d2 (car calendar-mark-ring))
8465 (setq dp1 (get-text-property (point-at-bol) 'day))
8466 (unless dp1 (error "No date defined in current line"))
8467 (setq d1 (calendar-gregorian-from-absolute dp1)
8468 d2 (and (ignore-errors (mark))
8471 (setq dp2 (get-text-property (point-at-bol) 'day)))
8472 (calendar-gregorian-from-absolute dp2))))
8473 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8474 (setq char (read-char-exclusive))
8477 (setq text (read-string "Day entry: "))
8478 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8479 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8481 (setq d1 (list (car d1) (nth 1 d1)
8482 (read-number (format "Reference year [%d]: " (nth 2 d1))
8484 (setq text (read-string "Anniversary (use %d to show years): "))
8485 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8486 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8488 (setq text (read-string "Block entry: "))
8489 (unless (and d1 d2 (not (equal d1 d2)))
8490 (error "No block of days selected"))
8491 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8492 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8494 (org-switch-to-buffer-other-window
8495 (find-file-noselect org-agenda-diary-file))
8496 (require 'org-datetree)
8497 (org-datetree-find-date-create d1)
8499 (t (error "Invalid selection character `%c'" char)))))
8501 (defcustom org-agenda-insert-diary-strategy 'date-tree
8502 "Where in `org-agenda-diary-file' should new entries be added?
8505 date-tree in the date tree, as child of the date
8506 top-level as top-level entries at the end of the file."
8509 (const :tag "in a date tree" date-tree)
8510 (const :tag "as top level at end of file" top-level)))
8512 (defcustom org-agenda-insert-diary-extract-time nil
8513 "Non-nil means extract any time specification from the diary entry."
8518 (defcustom org-agenda-bulk-mark-char ">"
8519 "A single-character string to be used as the bulk mark."
8524 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8525 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8526 If TEXT is not empty, it will become the headline of the new entry, and
8527 the resulting entry will not be shown. When TEXT is empty, switch to
8528 `org-agenda-diary-file' and let the user finish the entry there."
8529 (let ((cw (current-window-configuration)))
8530 (org-switch-to-buffer-other-window
8531 (find-file-noselect org-agenda-diary-file))
8533 (goto-char (point-min))
8535 ((eq type 'anniversary)
8536 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8538 (or (org-at-heading-p t)
8540 (outline-next-heading)
8541 (insert "* Anniversaries\n\n")
8542 (beginning-of-line -1)))))
8543 (outline-next-heading)
8544 (org-back-over-empty-lines)
8547 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8548 (nth 2 d1) (car d1) (nth 1 d1) text)))
8550 (let ((org-prefix-has-time t)
8551 (org-agenda-time-leading-zero t)
8553 (if org-agenda-insert-diary-extract-time
8554 ;; Use org-agenda-format-item to parse text for a time-range and
8555 ;; remove it. FIXME: This is a hack, we should refactor
8556 ;; that function to make time extraction available separately
8557 (setq fmt (org-agenda-format-item nil text nil nil t)
8558 time (get-text-property 0 'time fmt)
8559 time2 (if (> (length time) 0)
8560 ;; split-string removes trailing ...... if
8561 ;; no end time given. First space
8562 ;; separates time from date.
8563 (concat " " (car (split-string time "\\.")))
8565 text (get-text-property 0 'txt fmt)))
8566 (if (eq org-agenda-insert-diary-strategy 'top-level)
8567 (org-agenda-insert-diary-as-top-level text)
8568 (require 'org-datetree)
8569 (org-datetree-find-date-create d1)
8570 (org-agenda-insert-diary-make-new-entry text))
8571 (org-insert-time-stamp (org-time-from-absolute
8572 (calendar-absolute-from-gregorian d1))
8573 nil nil nil nil time2))
8576 (if (> (calendar-absolute-from-gregorian d1)
8577 (calendar-absolute-from-gregorian d2))
8578 (setq d1 (prog1 d2 (setq d2 d1))))
8579 (if (eq org-agenda-insert-diary-strategy 'top-level)
8580 (org-agenda-insert-diary-as-top-level text)
8581 (require 'org-datetree)
8582 (org-datetree-find-date-create d1)
8583 (org-agenda-insert-diary-make-new-entry text))
8584 (org-insert-time-stamp (org-time-from-absolute
8585 (calendar-absolute-from-gregorian d1)))
8587 (org-insert-time-stamp (org-time-from-absolute
8588 (calendar-absolute-from-gregorian d2)))
8590 (if (string-match "\\S-" text)
8592 (set-window-configuration cw)
8593 (message "%s entry added to %s"
8594 (capitalize (symbol-name type))
8595 (abbreviate-file-name org-agenda-diary-file)))
8597 (message "Please finish entry here"))))
8599 (defun org-agenda-insert-diary-as-top-level (text)
8600 "Make new entry as a top-level entry at the end of the file.
8601 Add TEXT as headline, and position the cursor in the second line so that
8602 a timestamp can be added there."
8604 (goto-char (point-max))
8605 (or (bolp) (insert "\n"))
8606 (insert "* " text "\n")
8607 (if org-adapt-indentation (org-indent-to-column 2)))
8609 (defun org-agenda-insert-diary-make-new-entry (text)
8610 "Make new entry as last child of current entry.
8611 Add TEXT as headline, and position the cursor in the second line so that
8612 a timestamp can be added there."
8613 (let ((org-show-following-heading t)
8614 (org-show-siblings t)
8615 (org-show-hierarchy-above t)
8616 (org-show-entry-below t)
8618 (outline-next-heading)
8619 (org-back-over-empty-lines)
8620 (or (looking-at "[ \t]*$")
8621 (progn (insert "\n") (backward-char 1)))
8622 (org-insert-heading nil t)
8624 (setq col (current-column))
8626 (if org-adapt-indentation (org-indent-to-column col))
8627 (let ((org-show-following-heading t)
8628 (org-show-siblings t)
8629 (org-show-hierarchy-above t)
8630 (org-show-entry-below t))
8631 (org-show-context))))
8633 (defun org-agenda-diary-entry ()
8634 "Make a diary entry, like the `i' command from the calendar.
8635 All the standard commands work: block, weekly etc.
8636 When `org-agenda-diary-file' points to a file,
8637 `org-agenda-diary-entry-in-org-file' is called instead to create
8638 entries in that Org-mode file."
8640 (org-agenda-check-type t 'agenda 'timeline)
8641 (if (not (eq org-agenda-diary-file 'diary-file))
8642 (org-agenda-diary-entry-in-org-file)
8643 (require 'diary-lib)
8645 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8646 (read-char-exclusive)))
8647 (cmd (cdr (assoc char
8648 '((?d . insert-diary-entry)
8649 (?w . insert-weekly-diary-entry)
8650 (?m . insert-monthly-diary-entry)
8651 (?y . insert-yearly-diary-entry)
8652 (?a . insert-anniversary-diary-entry)
8653 (?b . insert-block-diary-entry)
8654 (?c . insert-cyclic-diary-entry)))))
8655 (oldf (symbol-function 'calendar-cursor-to-date))
8656 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8658 (mark (or (mark t) (point))))
8660 (error "No command associated with <%c>" char))
8661 (unless (and (get-text-property point 'day)
8662 (or (not (equal ?b char))
8663 (get-text-property mark 'day)))
8664 (error "Don't know which date to use for diary entry"))
8665 ;; We implement this by hacking the `calendar-cursor-to-date' function
8666 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8667 (let ((calendar-mark-ring
8668 (list (calendar-gregorian-from-absolute
8669 (or (get-text-property mark 'day)
8670 (get-text-property point 'day))))))
8673 (fset 'calendar-cursor-to-date
8674 (lambda (&optional error dummy)
8675 (calendar-gregorian-from-absolute
8676 (get-text-property point 'day))))
8677 (call-interactively cmd))
8678 (fset 'calendar-cursor-to-date oldf))))))
8680 (defun org-agenda-execute-calendar-command (cmd)
8681 "Execute a calendar command from the agenda, with the date associated to
8682 the cursor position."
8683 (org-agenda-check-type t 'agenda 'timeline)
8684 (require 'diary-lib)
8685 (unless (get-text-property (point) 'day)
8686 (error "Don't know which date to use for calendar command"))
8687 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8689 (date (calendar-gregorian-from-absolute
8690 (get-text-property point 'day)))
8691 ;; the following 2 vars are needed in the calendar
8692 (displayed-month (car date))
8693 (displayed-year (nth 2 date)))
8696 (fset 'calendar-cursor-to-date
8697 (lambda (&optional error dummy)
8698 (calendar-gregorian-from-absolute
8699 (get-text-property point 'day))))
8700 (call-interactively cmd))
8701 (fset 'calendar-cursor-to-date oldf))))
8703 (defun org-agenda-phases-of-moon ()
8704 "Display the phases of the moon for the 3 months around the cursor date."
8706 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8708 (defun org-agenda-holidays ()
8709 "Display the holidays for the 3 months around the cursor date."
8711 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8713 (defvar calendar-longitude) ; defined in calendar.el
8714 (defvar calendar-latitude) ; defined in calendar.el
8715 (defvar calendar-location-name) ; defined in calendar.el
8717 (defun org-agenda-sunrise-sunset (arg)
8718 "Display sunrise and sunset for the cursor date.
8719 Latitude and longitude can be specified with the variables
8720 `calendar-latitude' and `calendar-longitude'. When called with prefix
8721 argument, latitude and longitude will be prompted for."
8724 (let ((calendar-longitude (if arg nil calendar-longitude))
8725 (calendar-latitude (if arg nil calendar-latitude))
8726 (calendar-location-name
8727 (if arg "the given coordinates" calendar-location-name)))
8728 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8730 (defun org-agenda-goto-calendar ()
8731 "Open the Emacs calendar with the date at the cursor."
8733 (org-agenda-check-type t 'agenda 'timeline)
8734 (let* ((day (or (get-text-property (point) 'day)
8735 (error "Don't know which date to open in calendar")))
8736 (date (calendar-gregorian-from-absolute day))
8737 (calendar-move-hook nil)
8738 (calendar-view-holidays-initially-flag nil)
8739 (calendar-view-diary-initially-flag nil))
8741 (calendar-goto-date date)))
8744 (defun org-calendar-goto-agenda ()
8745 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8746 This is a command that has to be installed in `calendar-mode-map'."
8748 (org-agenda-list nil (calendar-absolute-from-gregorian
8749 (calendar-cursor-to-date))
8752 (defun org-agenda-convert-date ()
8754 (org-agenda-check-type t 'agenda 'timeline)
8755 (let ((day (get-text-property (point) 'day))
8758 (error "Don't know which date to convert"))
8759 (setq date (calendar-gregorian-from-absolute day))
8761 "Gregorian: " (calendar-date-string date) "\n"
8762 "ISO: " (calendar-iso-date-string date) "\n"
8763 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8764 "Julian: " (calendar-julian-date-string date) "\n"
8765 "Astron. JD: " (calendar-astro-date-string date)
8766 " (Julian date number at noon UTC)\n"
8767 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8768 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8769 "French: " (calendar-french-date-string date) "\n"
8770 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8771 "Mayan: " (calendar-mayan-date-string date) "\n"
8772 "Coptic: " (calendar-coptic-date-string date) "\n"
8773 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8774 "Persian: " (calendar-persian-date-string date) "\n"
8775 "Chinese: " (calendar-chinese-date-string date) "\n"))
8776 (with-output-to-temp-buffer "*Dates*"
8778 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8782 (defun org-agenda-bulk-marked-p ()
8783 (eq (get-char-property (point-at-bol) 'type)
8784 'org-marked-entry-overlay))
8786 (defun org-agenda-bulk-mark (&optional arg)
8787 "Mark the entry at point for future bulk action."
8789 (dotimes (i (or arg 1))
8790 (unless (org-get-at-bol 'org-agenda-diary-link)
8791 (let* ((m (org-get-at-bol 'org-hd-marker))
8793 (unless (org-agenda-bulk-marked-p)
8794 (unless m (error "Nothing to mark at point"))
8795 (push m org-agenda-bulk-marked-entries)
8796 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8797 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
8798 (org-get-todo-face "TODO")
8800 (overlay-put ov 'type 'org-marked-entry-overlay))
8801 (beginning-of-line 2)
8802 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8803 (beginning-of-line 2))
8804 (message "%d entries marked for bulk action"
8805 (length org-agenda-bulk-marked-entries))))))
8807 (defun org-agenda-bulk-mark-all ()
8808 "Mark all entries for future agenda bulk action."
8810 (org-agenda-bulk-mark-regexp "."))
8812 (defun org-agenda-bulk-mark-regexp (regexp)
8813 "Mark entries matching REGEXP for future agenda bulk action."
8814 (interactive "sMark entries matching regexp: ")
8815 (let ((entries-marked 0))
8817 (goto-char (point-min))
8818 (goto-char (next-single-property-change (point) 'txt))
8819 (while (re-search-forward regexp nil t)
8820 (when (string-match regexp (get-text-property (point) 'txt))
8821 (setq entries-marked (1+ entries-marked))
8822 (call-interactively 'org-agenda-bulk-mark))))
8823 (if (not entries-marked)
8824 (message "No entry matching this regexp."))))
8826 (defun org-agenda-bulk-unmark (&optional arg)
8827 "Unmark the entry at point for future bulk action."
8830 (org-agenda-bulk-unmark-all)
8831 (cond ((org-agenda-bulk-marked-p)
8832 (org-agenda-bulk-remove-overlays
8833 (point-at-bol) (+ 2 (point-at-bol)))
8834 (setq org-agenda-bulk-marked-entries
8835 (delete (org-get-at-bol 'org-hd-marker)
8836 org-agenda-bulk-marked-entries))
8837 (beginning-of-line 2)
8838 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8839 (beginning-of-line 2))
8840 (message "%d entries left marked for bulk action"
8841 (length org-agenda-bulk-marked-entries)))
8842 (t (message "No entry to unmark here")))))
8844 (defun org-agenda-bulk-toggle ()
8845 "Toggle marking the entry at point for bulk action."
8847 (if (org-agenda-bulk-marked-p)
8848 (org-agenda-bulk-unmark)
8849 (org-agenda-bulk-mark)))
8851 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8852 "Remove the mark overlays between BEG and END in the agenda buffer.
8853 BEG and END default to the buffer limits.
8855 This only removes the overlays, it does not remove the markers
8856 from the list in `org-agenda-bulk-marked-entries'."
8859 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8860 (delete-overlay ov)))
8861 (overlays-in (or beg (point-min)) (or end (point-max)))))
8863 (defun org-agenda-bulk-unmark-all ()
8864 "Remove all marks in the agenda buffer.
8865 This will remove the markers and the overlays."
8867 (if (null org-agenda-bulk-marked-entries)
8868 (message "No entry to unmark")
8869 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8870 (setq org-agenda-bulk-marked-entries nil)
8871 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
8873 (defcustom org-agenda-persistent-marks nil
8874 "Non-nil means marked items will stay marked after a bulk action.
8875 You can toggle this interactively by typing `p' when prompted for a
8881 (defun org-agenda-bulk-action (&optional arg)
8882 "Execute an remote-editing action on all marked entries.
8883 The prefix arg is passed through to the command if possible."
8885 ;; Make sure we have markers, and only valid ones
8886 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8889 (unless (and (markerp m)
8891 (buffer-live-p (marker-buffer m))
8892 (marker-position m))
8893 (error "Marker %s for bulk command is invalid" m)))
8894 org-agenda-bulk-marked-entries)
8896 ;; Prompt for the bulk command
8897 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
8898 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
8899 "[S]catter [f]unction "
8900 (when org-agenda-bulk-custom-functions
8901 (concat " Custom: ["
8902 (mapconcat (lambda(f) (char-to-string (car f)))
8903 org-agenda-bulk-custom-functions "")
8906 (let* ((action (read-char-exclusive))
8907 (org-log-refile (if org-log-refile 'time nil))
8908 (entries (reverse org-agenda-bulk-marked-entries))
8909 (org-overriding-default-time
8910 (if (get-text-property (point) 'org-agenda-date-header)
8911 (org-get-cursor-date)))
8913 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8916 (let ((org-agenda-persistent-marks
8917 (not org-agenda-persistent-marks)))
8918 (org-agenda-bulk-action)
8922 (setq cmd '(org-agenda-archive)))
8925 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8927 ((member action '(?r ?w))
8928 (setq rfloc (org-refile-get-location
8930 (marker-buffer (car entries))
8931 org-refile-allow-creating-parent-nodes))
8933 (setcar (nthcdr 3 rfloc)
8934 (move-marker (make-marker) (nth 3 rfloc)
8935 (or (get-file-buffer (nth 1 rfloc))
8936 (find-buffer-visiting (nth 1 rfloc))
8937 (error "This should not happen")))))
8939 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8943 (setq state (org-icompleting-read
8945 (with-current-buffer (marker-buffer (car entries))
8946 (mapcar 'list org-todo-keywords-1))))
8947 (setq cmd `(let ((org-inhibit-blocking t)
8948 (org-inhibit-logging 'note))
8949 (org-agenda-todo ,state))))
8951 ((memq action '(?- ?+))
8952 (setq tag (org-icompleting-read
8953 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8954 (with-current-buffer (marker-buffer (car entries))
8957 (if (stringp (car x)) x)) org-tag-alist)))))
8958 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8960 ((memq action '(?s ?d))
8965 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
8966 org-overriding-default-time)))
8967 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8968 (setq cmd `(eval '(,c1 arg ,time)))))
8971 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8972 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8973 (let ((days (read-number
8974 (format "Scatter tasks across how many %sdays: "
8975 (if arg "week" "")) 7)))
8977 `(let ((distance (1+ (random ,days))))
8979 (let ((dist distance)
8981 (calendar-day-of-week
8982 (calendar-gregorian-from-absolute (org-today)))))
8983 (dotimes (i (1+ dist))
8984 (while (member day-of-week org-agenda-weekend-days)
8987 (if (= day-of-week 7)
8988 (setq day-of-week 0)))
8990 (if (= day-of-week 7)
8991 (setq day-of-week 0)))))
8992 ;; silently fail when try to replan a sexp entry
8994 (let* ((date (calendar-gregorian-from-absolute
8995 (+ (org-today) distance)))
8996 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8998 (org-agenda-schedule nil time))
9001 ((assoc action org-agenda-bulk-custom-functions)
9002 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9006 (setq cmd (list (intern
9007 (org-icompleting-read "Function: "
9008 obarray 'fboundp t nil nil)))))
9010 (t (error "Invalid bulk action")))
9012 ;; Sort the markers, to make sure that parents are handled before children
9013 (setq entries (sort entries
9016 ((equal (marker-buffer a) (marker-buffer b))
9017 (< (marker-position a) (marker-position b)))
9019 (string< (buffer-name (marker-buffer a))
9020 (buffer-name (marker-buffer b))))))))
9022 ;; Now loop over all markers and apply cmd
9023 (while (setq e (pop entries))
9024 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9026 (progn (message "Skipping removed entry at %s" e)
9027 (setq cntskip (1+ cntskip)))
9029 (let (org-loop-over-headlines-in-active-region)
9031 (setq cnt (1+ cnt))))
9032 (when redo-at-end (org-agenda-redo))
9033 (unless org-agenda-persistent-marks
9034 (org-agenda-bulk-unmark-all))
9035 (message "Acted on %d entries%s%s"
9039 (format ", skipped %d (disappeared before their turn)"
9041 (if (not org-agenda-persistent-marks)
9042 "" " (kept marked)"))))))
9044 (defun org-agenda-capture ()
9045 "Call `org-capture' with the date at point."
9047 (if (not (eq major-mode 'org-agenda-mode))
9048 (error "You cannot do this outside of agenda buffers")
9049 (let ((org-overriding-default-time
9050 (org-get-cursor-date)))
9051 (call-interactively 'org-capture))))
9055 (defun org-agenda-show-the-flagging-note ()
9056 "Display the flagging note in the other window.
9057 When called a second time in direct sequence, offer to remove the FLAGGING
9058 tag and (if present) the flagging note."
9060 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9061 (win (selected-window))
9062 note heading newhead)
9064 (error "No linked entry at point"))
9065 (if (and (eq this-command last-command)
9066 (y-or-n-p "Unflag and remove any flagging note? "))
9068 (org-agenda-remove-flag hdmarker)
9069 (let ((win (get-buffer-window "*Flagging Note*")))
9070 (and win (delete-window win)))
9071 (message "Entry unflagged"))
9072 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9074 (error "No flagging note"))
9076 (org-switch-to-buffer-other-window "*Flagging Note*")
9079 (goto-char (point-min))
9080 (while (re-search-forward "\\\\n" nil t)
9081 (replace-match "\n" t t))
9082 (goto-char (point-min))
9084 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9086 (defun org-agenda-remove-flag (marker)
9087 "Remove the FLAGGED tag and any flagging note in the entry."
9089 (org-with-point-at marker
9090 (org-toggle-tag "FLAGGED" 'off)
9091 (org-entry-delete nil "THEFLAGGINGNOTE")
9092 (setq newhead (org-get-heading)))
9093 (org-agenda-change-all-lines newhead marker)
9094 (message "Entry unflagged")))
9096 (defun org-agenda-get-any-marker (&optional pos)
9097 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9098 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9100 ;;; Appointment reminders
9102 (defvar appt-time-msg-list) ; defined in appt.el
9105 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9106 "Activate appointments found in `org-agenda-files'.
9107 With a \\[universal-argument] prefix, refresh the list of
9110 If FILTER is t, interactively prompt the user for a regular
9111 expression, and filter out entries that don't match it.
9113 If FILTER is a string, use this string as a regular expression
9114 for filtering entries out.
9116 If FILTER is a function, filter out entries against which
9117 calling the function returns nil. This function takes one
9118 argument: an entry from `org-agenda-get-day-entries'.
9120 FILTER can also be an alist with the car of each cell being
9121 either 'headline or 'category. For example:
9123 '((headline \"IMPORTANT\")
9124 (category \"Work\"))
9126 will only add headlines containing IMPORTANT or headlines
9127 belonging to the \"Work\" category.
9129 ARGS are symbols indicating what kind of entries to consider.
9130 By default `org-agenda-to-appt' will use :deadline, :scheduled
9131 and :timestamp entries. See the docstring of `org-diary' for
9132 details and examples.
9134 If an entry as a APPT_WARNTIME property, its value will be used
9135 to override `appt-message-warning-time'."
9137 (if refresh (setq appt-time-msg-list nil))
9139 (setq filter (read-from-minibuffer "Regexp filter: ")))
9140 (let* ((cnt 0) ; count added events
9141 (scope (or args '(:deadline :scheduled :timestamp)))
9142 (org-agenda-new-buffers nil)
9143 (org-deadline-warning-days 0)
9144 ;; Do not use `org-today' here because appt only takes
9145 ;; time and without date as argument, so it may pass wrong
9146 ;; information otherwise
9147 (today (org-date-to-gregorian
9148 (time-to-days (current-time))))
9149 (org-agenda-restrict nil)
9150 (files (org-agenda-files 'unrestricted)) entries file
9151 (org-agenda-buffer nil))
9152 ;; Get all entries which may contain an appt
9153 (org-agenda-prepare-buffers files)
9154 (while (setq file (pop files))
9158 (apply 'org-agenda-get-day-entries
9159 file today scope)))))
9160 ;; Map thru entries and find if we should filter them out
9163 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
9164 (cat (get-text-property 1 'org-category x))
9165 (tod (get-text-property 1 'time-of-day x))
9166 (ok (or (null filter)
9167 (and (stringp filter) (string-match filter evt))
9168 (and (functionp filter) (funcall filter x))
9170 (let ((cat-filter (cadr (assoc 'category filter)))
9171 (evt-filter (cadr (assoc 'headline filter))))
9172 (or (and (stringp cat-filter)
9173 (string-match cat-filter cat))
9174 (and (stringp evt-filter)
9175 (string-match evt-filter evt)))))))
9176 (wrn (get-text-property 1 'warntime x)))
9177 ;; FIXME: Shall we remove text-properties for the appt text?
9178 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9180 (setq tod (concat "00" (number-to-string tod))
9181 tod (when (string-match
9182 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9183 (concat (match-string 1 tod) ":"
9184 (match-string 2 tod))))
9185 (if (version< emacs-version "23.3")
9187 (appt-add tod evt wrn))
9188 (setq cnt (1+ cnt))))) entries)
9189 (org-release-buffers org-agenda-new-buffers)
9191 (message "No event to add")
9192 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9194 (defun org-agenda-todayp (date)
9195 "Does DATE mean today, when considering `org-extend-today-until'?"
9196 (let ((today (org-today))
9197 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9201 (defun org-agenda-todo-yesterday (&optional arg)
9202 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9204 (let* ((hour (third (decode-time
9205 (org-current-time))))
9206 (org-extend-today-until (1+ hour)))
9207 (org-agenda-todo arg)))
9209 (provide 'org-agenda)
9211 ;;; org-agenda.el ends here