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))
87 (defvar calendar-mode-map
)
88 (defvar org-clock-current-task
) ; defined in org-clock.el
89 (defvar org-mobile-force-id-on-agenda-items
) ; defined in org-mobile.el
90 (defvar org-habit-show-habits
)
91 (defvar org-habit-show-habits-only-for-today
)
92 (defvar org-habit-show-all-today nil
)
94 ;; Defined somewhere in this file, but used before definition.
95 (defvar org-agenda-buffer-name
)
96 (defvar org-agenda-overriding-header
)
97 (defvar org-agenda-title-append nil
)
98 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
99 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
100 (defvar org-agenda-undo-list
)
101 (defvar org-agenda-pending-undo-list
)
102 (defvar original-date
) ; dynamically scoped, calendar.el does scope this
104 (defcustom org-agenda-confirm-kill
1
105 "When set, remote killing from the agenda buffer needs confirmation.
106 When t, a confirmation is always needed. When a number N, confirmation is
107 only needed when the text to be killed contains more than N non-white lines."
110 (const :tag
"Never" nil
)
111 (const :tag
"Always" t
)
112 (integer :tag
"When more than N lines")))
114 (defcustom org-agenda-compact-blocks nil
115 "Non-nil means make the block agenda more compact.
116 This is done globally by leaving out lines like the agenda span
117 name and week number or the separator lines."
121 (defcustom org-agenda-block-separator ?
=
122 "The separator between blocks in the agenda.
123 If this is a string, it will be used as the separator, with a newline added.
124 If it is a character, it will be repeated to fill the window width.
125 If nil the separator is disabled. In `org-agenda-custom-commands' this
126 addresses the separator between the current and the previous block."
129 (const :tag
"Disabled" nil
)
133 (defgroup org-agenda-export nil
134 "Options concerning exporting agenda views in Org-mode."
135 :tag
"Org Agenda Export"
138 (defcustom org-agenda-with-colors t
139 "Non-nil means use colors in agenda views."
140 :group
'org-agenda-export
143 (defcustom org-agenda-exporter-settings nil
144 "Alist of variable/value pairs that should be active during agenda export.
145 This is a good place to set options for ps-print and for htmlize.
146 Note that the way this is implemented, the values will be evaluated
147 before assigned to the variables. So make sure to quote values you do
148 *not* want evaluated, for example
150 (setq org-agenda-exporter-settings
151 '((ps-print-color-p 'black-white)))"
152 :group
'org-agenda-export
156 (sexp :tag
"Value"))))
158 (defcustom org-agenda-before-write-hook
'(org-agenda-add-entry-text)
159 "Hook run in temporary buffer before writing it to an export file.
160 A useful function is `org-agenda-add-entry-text'."
161 :group
'org-agenda-export
163 :options
'(org-agenda-add-entry-text))
165 (defcustom org-agenda-add-entry-text-maxlines
0
166 "Maximum number of entry text lines to be added to agenda.
167 This is only relevant when `org-agenda-add-entry-text' is part of
168 `org-agenda-before-write-hook', which it is by default.
169 When this is 0, nothing will happen. When it is greater than 0, it
170 specifies the maximum number of lines that will be added for each entry
171 that is listed in the agenda view.
173 Note that this variable is not used during display, only when exporting
174 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
175 and `org-agenda-entry-text-maxlines'."
179 (defcustom org-agenda-add-entry-text-descriptive-links t
180 "Non-nil means export org-links as descriptive links in agenda added text.
181 This variable applies to the text added to the agenda when
182 `org-agenda-add-entry-text-maxlines' is larger than 0.
183 When this variable nil, the URL will (also) be shown."
187 (defcustom org-agenda-export-html-style
""
188 "The style specification for exported HTML Agenda files.
189 If this variable contains a string, it will replace the default <style>
190 section as produced by `htmlize'.
191 Since there are different ways of setting style information, this variable
192 needs to contain the full HTML structure to provide a style, including the
193 surrounding HTML tags. The style specifications should include definitions
194 the fonts used by the agenda, here is an example:
196 <style type=\"text/css\">
197 p { font-weight: normal; color: gray; }
198 .org-agenda-structure {
213 .title { text-align: center; }
214 .todo, .deadline { color: red; }
215 .done { color: green; }
218 or, if you want to keep the style in a file,
220 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
222 As the value of this option simply gets inserted into the HTML <head> header,
223 you can \"misuse\" it to also add other text to the header. However,
224 <style>...</style> is required, if not present the variable will be ignored."
225 :group
'org-agenda-export
226 :group
'org-export-html
229 (defcustom org-agenda-persistent-filter nil
230 "When set, keep filters from one agenda view to the next."
234 (defgroup org-agenda-custom-commands nil
235 "Options concerning agenda views in Org-mode."
236 :tag
"Org Agenda Custom Commands"
239 (defconst org-sorting-choice
241 (const time-up
) (const time-down
)
242 (const category-keep
) (const category-up
) (const category-down
)
243 (const tag-down
) (const tag-up
)
244 (const priority-up
) (const priority-down
)
245 (const todo-state-up
) (const todo-state-down
)
246 (const effort-up
) (const effort-down
)
247 (const habit-up
) (const habit-down
)
248 (const alpha-up
) (const alpha-down
)
249 (const user-defined-up
) (const user-defined-down
))
252 ;; Keep custom values for `org-agenda-filter-preset' compatible with
253 ;; the new variable `org-agenda-tag-filter-preset'.
254 (if (fboundp 'defvaralias
)
255 (defvaralias 'org-agenda-filter-preset
'org-agenda-tag-filter-preset
)
256 (defvaralias 'org-agenda-filter
'org-agenda-tag-filter
))
258 (defconst org-agenda-custom-commands-local-options
259 `(repeat :tag
"Local settings for this command. Remember to quote values"
260 (choice :tag
"Setting"
261 (list :tag
"Heading for this block"
262 (const org-agenda-overriding-header
)
263 (string :tag
"Headline"))
264 (list :tag
"Files to be searched"
265 (const org-agenda-files
)
267 (const :format
"" quote
)
269 (list :tag
"Sorting strategy"
270 (const org-agenda-sorting-strategy
)
272 (const :format
"" quote
)
274 ,org-sorting-choice
)))
275 (list :tag
"Prefix format"
276 (const org-agenda-prefix-format
:value
" %-12:c%?-12t% s")
278 (list :tag
"Number of days in agenda"
279 (const org-agenda-span
)
280 (choice (const :tag
"Day" 'day
)
281 (const :tag
"Week" 'week
)
282 (const :tag
"Month" 'month
)
283 (const :tag
"Year" 'year
)
284 (integer :tag
"Custom")))
285 (list :tag
"Fixed starting date"
286 (const org-agenda-start-day
)
287 (string :value
"2007-11-01"))
288 (list :tag
"Start on day of week"
289 (const org-agenda-start-on-weekday
)
291 (const :tag
"Today" nil
)
292 (integer :tag
"Weekday No.")))
293 (list :tag
"Include data from diary"
294 (const org-agenda-include-diary
)
296 (list :tag
"Deadline Warning days"
297 (const org-deadline-warning-days
)
299 (list :tag
"Category filter preset"
300 (const org-agenda-category-filter-preset
)
302 (const :format
"" quote
)
304 (string :tag
"+category or -category"))))
305 (list :tag
"Tags filter preset"
306 (const org-agenda-tag-filter-preset
)
308 (const :format
"" quote
)
310 (string :tag
"+tag or -tag"))))
311 (list :tag
"Set daily/weekly entry types"
312 (const org-agenda-entry-types
)
314 (const :format
"" quote
)
315 (set :greedy t
:value
(:deadline
:scheduled
:timestamp
:sexp
)
320 (list :tag
"Standard skipping condition"
321 :value
(org-agenda-skip-function '(org-agenda-skip-entry-if))
322 (const org-agenda-skip-function
)
324 (const :format
"" quote
)
327 :tag
"Skipping range"
328 (const :tag
"Skip entry" org-agenda-skip-entry-if
)
329 (const :tag
"Skip subtree" org-agenda-skip-subtree-if
))
330 (repeat :inline t
:tag
"Conditions for skipping"
332 :tag
"Condition type"
333 (list :tag
"Regexp matches" :inline t
(const :format
"" 'regexp
) (regexp))
334 (list :tag
"Regexp does not match" :inline t
(const :format
"" 'notregexp
) (regexp))
335 (list :tag
"TODO state is" :inline t
338 (const :tag
"any not-done state" 'todo
)
339 (const :tag
"any done state" 'done
)
340 (const :tag
"any state" 'any
)
341 (list :tag
"Keyword list"
342 (const :format
"" quote
)
343 (repeat (string :tag
"Keyword")))))
344 (list :tag
"TODO state is not" :inline t
347 (const :tag
"any not-done state" 'todo
)
348 (const :tag
"any done state" 'done
)
349 (const :tag
"any state" 'any
)
350 (list :tag
"Keyword list"
351 (const :format
"" quote
)
352 (repeat (string :tag
"Keyword")))))
353 (const :tag
"scheduled" 'scheduled
)
354 (const :tag
"not scheduled" 'notscheduled
)
355 (const :tag
"deadline" 'deadline
)
356 (const :tag
"no deadline" 'notdeadline
)
357 (const :tag
"timestamp" 'timestamp
)
358 (const :tag
"no timestamp" 'nottimestamp
))))))
359 (list :tag
"Non-standard skipping condition"
360 :value
(org-agenda-skip-function)
361 (const org-agenda-skip-function
)
362 (sexp :tag
"Function or form (quoted!)"))
363 (list :tag
"Any variable"
364 (variable :tag
"Variable")
365 (sexp :tag
"Value (sexp)"))))
366 "Selection of examples for agenda command settings.
367 This will be spliced into the custom type of
368 `org-agenda-custom-commands'.")
371 (defcustom org-agenda-custom-commands
'(("n" "Agenda and all TODO's"
372 ((agenda "") (alltodo))))
373 "Custom commands for the agenda.
374 These commands will be offered on the splash screen displayed by the
375 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
377 (key desc type match settings files)
379 key The key (one or more characters as a string) to be associated
381 desc A description of the command, when omitted or nil, a default
382 description is built using MATCH.
383 type The command type, any of the following symbols:
384 agenda The daily/weekly agenda.
385 todo Entries with a specific TODO keyword, in all agenda files.
386 search Entries containing search words entry or headline.
387 tags Tags/Property/TODO match in all agenda files.
388 tags-todo Tags/P/T match in all agenda files, TODO entries only.
389 todo-tree Sparse tree of specific TODO keyword in *current* file.
390 tags-tree Sparse tree with all tags matches in *current* file.
391 occur-tree Occur sparse tree for *current* file.
392 ... A user-defined function.
393 match What to search for:
394 - a single keyword for TODO keyword searches
395 - a tags match expression for tags searches
396 - a word search expression for text searches.
397 - a regular expression for occur searches
398 For all other commands, this should be the empty string.
399 settings A list of option settings, similar to that in a let form, so like
400 this: ((opt1 val1) (opt2 val2) ...). The values will be
401 evaluated at the moment of execution, so quote them when needed.
402 files A list of files file to write the produced agenda buffer to
403 with the command `org-store-agenda-views'.
404 If a file name ends in \".html\", an HTML version of the buffer
405 is written out. If it ends in \".ps\", a postscript version is
406 produced. Otherwise, only the plain text is written to the file.
408 You can also define a set of commands, to create a composite agenda buffer.
409 In this case, an entry looks like this:
411 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
415 desc A description string to be displayed in the dispatcher menu.
416 cmd An agenda command, similar to the above. However, tree commands
417 are not allowed, but instead you can get agenda and global todo list.
418 So valid commands for a set are:
419 (agenda \"\" settings)
420 (alltodo \"\" settings)
421 (stuck \"\" settings)
422 (todo \"match\" settings files)
423 (search \"match\" settings files)
424 (tags \"match\" settings files)
425 (tags-todo \"match\" settings files)
427 Each command can carry a list of options, and another set of options can be
428 given for the whole set of commands. Individual command options take
429 precedence over the general options.
431 When using several characters as key to a command, the first characters
432 are prefix commands. For the dispatcher to display useful information, you
433 should provide a description for the prefix, like
435 (setq org-agenda-custom-commands
436 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
437 (\"hl\" tags \"+HOME+Lisa\")
438 (\"hp\" tags \"+HOME+Peter\")
439 (\"hk\" tags \"+HOME+Kim\")))"
440 :group
'org-agenda-custom-commands
442 (choice :value
("x" "Describe command here" tags
"" nil
)
443 (list :tag
"Single command"
444 (string :tag
"Access Key(s) ")
445 (option (string :tag
"Description"))
447 (const :tag
"Agenda" agenda
)
448 (const :tag
"TODO list" alltodo
)
449 (const :tag
"Search words" search
)
450 (const :tag
"Stuck projects" stuck
)
451 (const :tag
"Tags/Property match (all agenda files)" tags
)
452 (const :tag
"Tags/Property match of TODO entries (all agenda files)" tags-todo
)
453 (const :tag
"TODO keyword search (all agenda files)" todo
)
454 (const :tag
"Tags sparse tree (current buffer)" tags-tree
)
455 (const :tag
"TODO keyword tree (current buffer)" todo-tree
)
456 (const :tag
"Occur tree (current buffer)" occur-tree
)
457 (sexp :tag
"Other, user-defined function"))
458 (string :tag
"Match (only for some commands)")
459 ,org-agenda-custom-commands-local-options
460 (option (repeat :tag
"Export" (file :tag
"Export to"))))
461 (list :tag
"Command series, all agenda files"
462 (string :tag
"Access Key(s)")
463 (string :tag
"Description ")
464 (repeat :tag
"Component"
467 (const :format
"" agenda
)
468 (const :tag
"" :format
"" "")
469 ,org-agenda-custom-commands-local-options
)
470 (list :tag
"TODO list (all keywords)"
471 (const :format
"" alltodo
)
472 (const :tag
"" :format
"" "")
473 ,org-agenda-custom-commands-local-options
)
474 (list :tag
"Search words"
475 (const :format
"" search
)
476 (string :tag
"Match")
477 ,org-agenda-custom-commands-local-options
)
478 (list :tag
"Stuck projects"
479 (const :format
"" stuck
)
480 (const :tag
"" :format
"" "")
481 ,org-agenda-custom-commands-local-options
)
482 (list :tag
"Tags search"
483 (const :format
"" tags
)
484 (string :tag
"Match")
485 ,org-agenda-custom-commands-local-options
)
486 (list :tag
"Tags search, TODO entries only"
487 (const :format
"" tags-todo
)
488 (string :tag
"Match")
489 ,org-agenda-custom-commands-local-options
)
490 (list :tag
"TODO keyword search"
491 (const :format
"" todo
)
492 (string :tag
"Match")
493 ,org-agenda-custom-commands-local-options
)
494 (list :tag
"Other, user-defined function"
495 (symbol :tag
"function")
496 (string :tag
"Match")
497 ,org-agenda-custom-commands-local-options
)))
499 (repeat :tag
"Settings for entire command set"
500 (list (variable :tag
"Any variable")
501 (sexp :tag
"Value")))
502 (option (repeat :tag
"Export" (file :tag
"Export to"))))
503 (cons :tag
"Prefix key documentation"
504 (string :tag
"Access Key(s)")
505 (string :tag
"Description ")))))
507 (defcustom org-agenda-query-register ?o
508 "The register holding the current query string.
509 The purpose of this is that if you construct a query string interactively,
510 you can then use it to define a custom command."
511 :group
'org-agenda-custom-commands
514 (defcustom org-stuck-projects
515 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil
"")
516 "How to identify stuck projects.
517 This is a list of four items:
518 1. A tags/todo/property matcher string that is used to identify a project.
519 See the manual for a description of tag and property searches.
520 The entire tree below a headline matched by this is considered one project.
521 2. A list of TODO keywords identifying non-stuck projects.
522 If the project subtree contains any headline with one of these todo
523 keywords, the project is considered to be not stuck. If you specify
524 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
525 3. A list of tags identifying non-stuck projects.
526 If the project subtree contains any headline with one of these tags,
527 the project is considered to be not stuck. If you specify \"*\" as
528 a tag, any tag will mark the project unstuck. Note that this is about
529 the explicit presence of a tag somewhere in the subtree, inherited
530 tags to not count here. If inherited tags make a project not stuck,
531 use \"-TAG\" in the tags part of the matcher under (1.) above.
532 4. An arbitrary regular expression matching non-stuck projects.
534 If the project turns out to be not stuck, search continues also in the
535 subtree to see if any of the subtasks have project status.
537 See also the variable `org-tags-match-list-sublevels' which applies
538 to projects matched by this search as well.
540 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
541 or `C-c a #' to produce the list."
542 :group
'org-agenda-custom-commands
544 (string :tag
"Tags/TODO match to identify a project")
545 (repeat :tag
"Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
546 (repeat :tag
"Projects are *not* stuck if they have an entry with TAG being any of" (string))
547 (regexp :tag
"Projects are *not* stuck if this regexp matches inside the subtree")))
549 (defcustom org-agenda-filter-effort-default-operator
"<"
550 "The default operator for effort estimate filtering.
551 If you select an effort estimate limit without first pressing an operator,
552 this one will be used."
553 :group
'org-agenda-custom-commands
554 :type
'(choice (const :tag
"less or equal" "<")
555 (const :tag
"greater or equal"">")
556 (const :tag
"equal" "=")))
558 (defgroup org-agenda-skip nil
559 "Options concerning skipping parts of agenda files."
560 :tag
"Org Agenda Skip"
563 (defcustom org-agenda-skip-function-global nil
564 "Function to be called at each match during agenda construction.
565 If this function returns nil, the current match should not be skipped.
566 If the function decided to skip an agenda match, is must return the
567 buffer position from which the search should be continued.
568 This may also be a Lisp form, which will be evaluated.
570 This variable will be applied to every agenda match, including
571 tags/property searches and TODO lists. So try to make the test function
572 do its checking as efficiently as possible. To implement a skipping
573 condition just for specific agenda commands, use the variable
574 `org-agenda-skip-function' which can be set in the options section
575 of custom agenda commands."
576 :group
'org-agenda-skip
579 (defgroup org-agenda-daily
/weekly nil
580 "Options concerning the daily/weekly agenda."
581 :tag
"Org Agenda Daily/Weekly"
583 (defgroup org-agenda-todo-list nil
584 "Options concerning the global todo list agenda view."
585 :tag
"Org Agenda Todo List"
587 (defgroup org-agenda-match-view nil
588 "Options concerning the general tags/property/todo match agenda view."
589 :tag
"Org Agenda Match View"
591 (defgroup org-agenda-search-view nil
592 "Options concerning the general tags/property/todo match agenda view."
593 :tag
"Org Agenda Match View"
596 (defvar org-agenda-archives-mode nil
597 "Non-nil means the agenda will include archived items.
598 If this is the symbol `trees', trees in the selected agenda scope
599 that are marked with the ARCHIVE tag will be included anyway. When this is
600 t, also all archive files associated with the current selection of agenda
601 files will be included.")
603 (defcustom org-agenda-skip-comment-trees t
604 "Non-nil means skip trees that start with the COMMENT keyword.
605 When nil, these trees are also scanned by agenda commands."
606 :group
'org-agenda-skip
609 (defcustom org-agenda-todo-list-sublevels t
610 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
611 When nil, the sublevels of a TODO entry are not checked, resulting in
612 potentially much shorter TODO lists."
613 :group
'org-agenda-skip
614 :group
'org-agenda-todo-list
617 (defcustom org-agenda-todo-ignore-with-date nil
618 "Non-nil means don't show entries with a date in the global todo list.
619 You can use this if you prefer to mark mere appointments with a TODO keyword,
620 but don't want them to show up in the TODO list.
621 When this is set, it also covers deadlines and scheduled items, the settings
622 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
624 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
625 :group
'org-agenda-skip
626 :group
'org-agenda-todo-list
629 (defcustom org-agenda-todo-ignore-timestamp nil
630 "Non-nil means don't show entries with a timestamp.
631 This applies when creating the global todo list.
634 past Don't show entries for today or in the past.
636 future Don't show entries with a timestamp in the future.
637 The idea behind this is that if it has a future
638 timestamp, you don't want to think about it until the
641 all Don't show any entries with a timestamp in the global todo list.
642 The idea behind this is that by setting a timestamp, you
643 have already \"taken care\" of this item.
645 This variable can also have an integer as a value. If positive (N),
646 todos with a timestamp N or more days in the future will be ignored. If
647 negative (-N), todos with a timestamp N or more days in the past will be
648 ignored. If 0, todos with a timestamp either today or in the future will
649 be ignored. For example, a value of -1 will exclude todos with a
650 timestamp in the past (yesterday or earlier), while a value of 7 will
651 exclude todos with a timestamp a week or more in the future.
653 See also `org-agenda-todo-ignore-with-date'.
654 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
655 to make his option also apply to the tags-todo list."
656 :group
'org-agenda-skip
657 :group
'org-agenda-todo-list
660 (const :tag
"Ignore future timestamp todos" future
)
661 (const :tag
"Ignore past or present timestamp todos" past
)
662 (const :tag
"Ignore all timestamp todos" all
)
663 (const :tag
"Show timestamp todos" nil
)
664 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
666 (defcustom org-agenda-todo-ignore-scheduled nil
667 "Non-nil means, ignore some scheduled TODO items when making TODO list.
668 This applies when creating the global todo list.
671 past Don't show entries scheduled today or in the past.
673 future Don't show entries scheduled in the future.
674 The idea behind this is that by scheduling it, you don't want to
675 think about it until the scheduled date.
677 all Don't show any scheduled entries in the global todo list.
678 The idea behind this is that by scheduling it, you have already
679 \"taken care\" of this item.
681 t Same as `all', for backward compatibility.
683 This variable can also have an integer as a value. See
684 `org-agenda-todo-ignore-timestamp' for more details.
686 See also `org-agenda-todo-ignore-with-date'.
687 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
688 to make his option also apply to the tags-todo list."
689 :group
'org-agenda-skip
690 :group
'org-agenda-todo-list
692 (const :tag
"Ignore future-scheduled todos" future
)
693 (const :tag
"Ignore past- or present-scheduled todos" past
)
694 (const :tag
"Ignore all scheduled todos" all
)
695 (const :tag
"Ignore all scheduled todos (compatibility)" t
)
696 (const :tag
"Show scheduled todos" nil
)
697 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
699 (defcustom org-agenda-todo-ignore-deadlines nil
700 "Non-nil means ignore some deadlined TODO items when making TODO list.
701 There are different motivations for using different values, please think
702 carefully when configuring this variable.
704 This applies when creating the global todo list.
707 near Don't show near deadline entries. A deadline is near when it is
708 closer than `org-deadline-warning-days' days. The idea behind this
709 is that such items will appear in the agenda anyway.
711 far Don't show TODO entries where a deadline has been defined, but
712 the deadline is not near. This is useful if you don't want to
713 use the todo list to figure out what to do now.
715 past Don't show entries with a deadline timestamp for today or in the past.
717 future Don't show entries with a deadline timestamp in the future, not even
718 when they become `near' ones. Use it with caution.
720 all Ignore all TODO entries that do have a deadline.
722 t Same as `near', for backward compatibility.
724 This variable can also have an integer as a value. See
725 `org-agenda-todo-ignore-timestamp' for more details.
727 See also `org-agenda-todo-ignore-with-date'.
728 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
729 to make his option also apply to the tags-todo list."
730 :group
'org-agenda-skip
731 :group
'org-agenda-todo-list
733 (const :tag
"Ignore near deadlines" near
)
734 (const :tag
"Ignore near deadlines (compatibility)" t
)
735 (const :tag
"Ignore far deadlines" far
)
736 (const :tag
"Ignore all TODOs with a deadlines" all
)
737 (const :tag
"Show all TODOs, even if they have a deadline" nil
)
738 (integer :tag
"Ignore if N or more days in past(-) or future(+).")))
740 (defcustom org-agenda-tags-todo-honor-ignore-options nil
741 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
743 `org-agenda-todo-ignore-with-date',
744 `org-agenda-todo-ignore-timestamp',
745 `org-agenda-todo-ignore-scheduled',
746 `org-agenda-todo-ignore-deadlines'
747 make the global TODO list skip entries that have time stamps of certain
748 kinds. If this option is set, the same options will also apply for the
749 tags-todo search, which is the general tags/property matcher
750 restricted to unfinished TODO entries only."
751 :group
'org-agenda-skip
752 :group
'org-agenda-todo-list
753 :group
'org-agenda-match-view
756 (defcustom org-agenda-skip-scheduled-if-done nil
757 "Non-nil means don't show scheduled items in agenda when they are done.
758 This is relevant for the daily/weekly agenda, not for the TODO list. And
759 it applies only to the actual date of the scheduling. Warnings about
760 an item with a past scheduling dates are always turned off when the item
762 :group
'org-agenda-skip
763 :group
'org-agenda-daily
/weekly
766 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
767 "Non-nil means skip scheduling line if same entry shows because of deadline.
768 In the agenda of today, an entry can show up multiple times because
769 it is both scheduled and has a nearby deadline, and maybe a plain time
771 When this variable is t, then only the deadline is shown and the fact that
772 the entry is scheduled today or was scheduled previously is not shown.
773 When this variable is nil, the entry will be shown several times. When
774 the variable is the symbol `not-today', then skip scheduled previously,
775 but not scheduled today."
776 :group
'org-agenda-skip
777 :group
'org-agenda-daily
/weekly
779 (const :tag
"Never" nil
)
780 (const :tag
"Always" t
)
781 (const :tag
"Not when scheduled today" not-today
)))
783 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
784 "Non-nil means skip timestamp line if same entry shows because of deadline.
785 In the agenda of today, an entry can show up multiple times
786 because it has both a plain timestamp and has a nearby deadline.
787 When this variable is t, then only the deadline is shown and the
788 fact that the entry has a timestamp for or including today is not
789 shown. When this variable is nil, the entry will be shown
791 :group
'org-agenda-skip
792 :group
'org-agenda-daily
/weekly
795 (const :tag
"Never" nil
)
796 (const :tag
"Always" t
)))
798 (defcustom org-agenda-skip-deadline-if-done nil
799 "Non-nil means don't show deadlines when the corresponding item is done.
800 When nil, the deadline is still shown and should give you a happy feeling.
801 This is relevant for the daily/weekly agenda. And it applied only to the
802 actually date of the deadline. Warnings about approaching and past-due
803 deadlines are always turned off when the item is DONE."
804 :group
'org-agenda-skip
805 :group
'org-agenda-daily
/weekly
808 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
809 "Non-nil means skip deadline prewarning when entry is also scheduled.
810 This will apply on all days where a prewarning for the deadline would
811 be shown, but not at the day when the entry is actually due. On that day,
812 the deadline will be shown anyway.
813 This variable may be set to nil, t, or a number which will then give
814 the number of days before the actual deadline when the prewarnings
816 This can be used in a workflow where the first showing of the deadline will
817 trigger you to schedule it, and then you don't want to be reminded of it
818 because you will take care of it on the day when scheduled."
819 :group
'org-agenda-skip
820 :group
'org-agenda-daily
/weekly
823 (const :tag
"Alwas show prewarning" nil
)
824 (const :tag
"Remove prewarning if entry is scheduled" t
)
825 (integer :tag
"Restart prewarning N days before deadline")))
827 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
828 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
829 When non-nil, after the search for timestamps has matched once in an
830 entry, the rest of the entry will not be searched."
831 :group
'org-agenda-skip
834 (defcustom org-agenda-skip-timestamp-if-done nil
835 "Non-nil means don't select item by timestamp or -range if it is DONE."
836 :group
'org-agenda-skip
837 :group
'org-agenda-daily
/weekly
840 (defcustom org-agenda-dim-blocked-tasks t
841 "Non-nil means dim blocked tasks in the agenda display.
842 This causes some overhead during agenda construction, but if you
843 have turned on `org-enforce-todo-dependencies',
844 `org-enforce-todo-checkbox-dependencies', or any other blocking
845 mechanism, this will create useful feedback in the agenda.
847 Instead of t, this variable can also have the value `invisible'.
848 Then blocked tasks will be invisible and only become visible when
849 they become unblocked. An exemption to this behavior is when a task is
850 blocked because of unchecked checkboxes below it. Since checkboxes do
851 not show up in the agenda views, making this task invisible you remove any
852 trace from agenda views that there is something to do. Therefore, a task
853 that is blocked because of checkboxes will never be made invisible, it
854 will only be dimmed."
855 :group
'org-agenda-daily
/weekly
856 :group
'org-agenda-todo-list
858 (const :tag
"Do not dim" nil
)
859 (const :tag
"Dim to a gray face" t
)
860 (const :tag
"Make invisible" invisible
)))
862 (defcustom org-timeline-show-empty-dates
3
863 "Non-nil means `org-timeline' also shows dates without an entry.
864 When nil, only the days which actually have entries are shown.
865 When t, all days between the first and the last date are shown.
866 When an integer, show also empty dates, but if there is a gap of more than
867 N days, just insert a special line indicating the size of the gap."
868 :group
'org-agenda-skip
870 (const :tag
"None" nil
)
872 (integer :tag
"at most")))
874 (defgroup org-agenda-startup nil
875 "Options concerning initial settings in the Agenda in Org Mode."
876 :tag
"Org Agenda Startup"
879 (defcustom org-agenda-menu-show-matcher t
880 "Non-nil means show the match string in the agenda dispatcher menu.
881 When nil, the matcher string is not shown, but is put into the help-echo
882 property so than moving the mouse over the command shows it.
883 Setting it to nil is good if matcher strings are very long and/or if
884 you want to use two-columns display (see `org-agenda-menu-two-columns')."
889 (make-obsolete-variable 'org-agenda-menu-two-column
'org-agenda-menu-two-columns
"24.3")
891 (defcustom org-agenda-menu-two-columns nil
892 "Non-nil means, use two columns to show custom commands in the dispatcher.
893 If you use this, you probably want to set `org-agenda-menu-show-matcher'
899 (defcustom org-finalize-agenda-hook nil
900 "Hook run just before displaying an agenda buffer."
901 :group
'org-agenda-startup
904 (defcustom org-agenda-mouse-1-follows-link nil
905 "Non-nil means mouse-1 on a link will follow the link in the agenda.
906 A longer mouse click will still set point. Does not work on XEmacs.
907 Needs to be set before org.el is loaded."
908 :group
'org-agenda-startup
911 (defcustom org-agenda-start-with-follow-mode nil
912 "The initial value of follow mode in a newly created agenda window."
913 :group
'org-agenda-startup
916 (defcustom org-agenda-follow-indirect nil
917 "Non-nil means `org-agenda-follow-mode' displays only the
918 current item's tree, in an indirect buffer."
923 (defcustom org-agenda-show-outline-path t
924 "Non-nil means show outline path in echo area after line motion."
925 :group
'org-agenda-startup
928 (defcustom org-agenda-start-with-entry-text-mode nil
929 "The initial value of entry-text-mode in a newly created agenda window."
930 :group
'org-agenda-startup
933 (defcustom org-agenda-entry-text-maxlines
5
934 "Number of text lines to be added when `E' is pressed in the agenda.
936 Note that this variable only used during agenda display. Add add entry text
937 when exporting the agenda, configure the variable
938 `org-agenda-add-entry-ext-maxlines'."
942 (defcustom org-agenda-entry-text-exclude-regexps nil
943 "List of regular expressions to clean up entry text.
944 The complete matches of all regular expressions in this list will be
945 removed from entry text before it is shown in the agenda."
947 :type
'(repeat (regexp)))
949 (defvar org-agenda-entry-text-cleanup-hook nil
950 "Hook that is run after basic cleanup of entry text to be shown in agenda.
951 This cleanup is done in a temporary buffer, so the function may inspect and
952 change the entire buffer.
953 Some default stuff like drawers and scheduling/deadline dates will already
954 have been removed when this is called, as will any matches for regular
955 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
957 (defvar org-agenda-include-inactive-timestamps nil
958 "Non-nil means include inactive time stamps in agenda and timeline.
959 Dynamically scoped.")
961 (defgroup org-agenda-windows nil
962 "Options concerning the windows used by the Agenda in Org Mode."
963 :tag
"Org Agenda Windows"
966 (defcustom org-agenda-window-setup
'reorganize-frame
967 "How the agenda buffer should be displayed.
968 Possible values for this option are:
970 current-window Show agenda in the current window, keeping all other windows.
971 other-window Use `switch-to-buffer-other-window' to display agenda.
972 reorganize-frame Show only two windows on the current frame, the current
973 window and the agenda.
974 other-frame Use `switch-to-buffer-other-frame' to display agenda.
975 Also, when exiting the agenda, kill that frame.
976 See also the variable `org-agenda-restore-windows-after-quit'."
977 :group
'org-agenda-windows
979 (const current-window
)
982 (const reorganize-frame
)))
984 (defcustom org-agenda-window-frame-fractions
'(0.5 .
0.75)
985 "The min and max height of the agenda window as a fraction of frame height.
986 The value of the variable is a cons cell with two numbers between 0 and 1.
987 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
988 :group
'org-agenda-windows
989 :type
'(cons (number :tag
"Minimum") (number :tag
"Maximum")))
991 (defcustom org-agenda-restore-windows-after-quit nil
992 "Non-nil means restore window configuration upon exiting agenda.
993 Before the window configuration is changed for displaying the agenda,
994 the current status is recorded. When the agenda is exited with
995 `q' or `x' and this option is set, the old state is restored. If
996 `org-agenda-window-setup' is `other-frame', the value of this
997 option will be ignored."
998 :group
'org-agenda-windows
1001 (defcustom org-agenda-ndays nil
1002 "Number of days to include in overview display.
1004 Obsolete, see `org-agenda-span'."
1005 :group
'org-agenda-daily
/weekly
1008 (make-obsolete-variable 'org-agenda-ndays
'org-agenda-span
"24.1")
1010 (defcustom org-agenda-span
'week
1011 "Number of days to include in overview display.
1012 Can be day, week, month, year, or any number of days.
1013 Custom commands can set this variable in the options section."
1014 :group
'org-agenda-daily
/weekly
1015 :type
'(choice (const :tag
"Day" day
)
1016 (const :tag
"Week" week
)
1017 (const :tag
"Month" month
)
1018 (const :tag
"Year" year
)
1019 (integer :tag
"Custom")))
1021 (defcustom org-agenda-start-on-weekday
1
1022 "Non-nil means start the overview always on the specified weekday.
1023 0 denotes Sunday, 1 denotes Monday etc.
1024 When nil, always start on the current day.
1025 Custom commands can set this variable in the options section."
1026 :group
'org-agenda-daily
/weekly
1027 :type
'(choice (const :tag
"Today" nil
)
1028 (integer :tag
"Weekday No.")))
1030 (defcustom org-agenda-show-all-dates t
1031 "Non-nil means `org-agenda' shows every day in the selected range.
1032 When nil, only the days which actually have entries are shown."
1033 :group
'org-agenda-daily
/weekly
1036 (defcustom org-agenda-format-date
'org-agenda-format-date-aligned
1037 "Format string for displaying dates in the agenda.
1038 Used by the daily/weekly agenda and by the timeline. This should be
1039 a format string understood by `format-time-string', or a function returning
1040 the formatted date as a string. The function must take a single argument,
1041 a calendar-style date list like (month day year)."
1042 :group
'org-agenda-daily
/weekly
1044 (string :tag
"Format string")
1045 (function :tag
"Function")))
1047 (defun org-agenda-format-date-aligned (date)
1048 "Format a date string for display in the daily/weekly agenda, or timeline.
1049 This function makes sure that dates are aligned for easy reading."
1051 (let* ((dayname (calendar-day-name date
))
1053 (day-of-week (calendar-day-of-week date
))
1055 (monthname (calendar-month-name month
))
1057 (iso-week (org-days-to-iso-week
1058 (calendar-absolute-from-gregorian date
)))
1059 (weekyear (cond ((and (= month
1) (>= iso-week
52))
1061 ((and (= month
12) (<= iso-week
1))
1064 (weekstring (if (= day-of-week
1)
1065 (format " W%02d" iso-week
)
1067 (format "%-10s %2d %s %4d%s"
1068 dayname day monthname year weekstring
)))
1070 (defcustom org-agenda-time-leading-zero nil
1071 "Non-nil means use leading zero for military times in agenda.
1072 For example, 9:30am would become 09:30 rather than 9:30."
1073 :group
'org-agenda-daily
/weekly
1077 (defcustom org-agenda-timegrid-use-ampm nil
1078 "When set, show AM/PM style timestamps on the timegrid."
1083 (defun org-agenda-time-of-day-to-ampm (time)
1084 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1085 (let* ((hour-number (string-to-number (substring time
0 -
3)))
1086 (minute (substring time -
2))
1089 ((equal hour-number
12)
1093 (setq hour-number
(- hour-number
12))))
1095 (if org-agenda-time-leading-zero
1096 (format "%02d" hour-number
)
1097 (format "%02s" (number-to-string hour-number
)))
1100 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1101 "Conditionally convert TIME to AM/PM format
1102 based on `org-agenda-timegrid-use-ampm'"
1103 (if org-agenda-timegrid-use-ampm
1104 (org-agenda-time-of-day-to-ampm time
)
1107 (defcustom org-agenda-weekend-days
'(6 0)
1108 "Which days are weekend?
1109 These days get the special face `org-agenda-date-weekend' in the agenda
1110 and timeline buffers."
1111 :group
'org-agenda-daily
/weekly
1112 :type
'(set :greedy t
1113 (const :tag
"Monday" 1)
1114 (const :tag
"Tuesday" 2)
1115 (const :tag
"Wednesday" 3)
1116 (const :tag
"Thursday" 4)
1117 (const :tag
"Friday" 5)
1118 (const :tag
"Saturday" 6)
1119 (const :tag
"Sunday" 0)))
1121 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1122 "Non-nil means jump to today when moving a past date forward in time.
1123 When using S-right in the agenda to move a a date forward, and the date
1124 stamp currently points to the past, the first key press will move it
1125 to today. WHen nil, just move one day forward even if the date stays
1127 :group
'org-agenda-daily
/weekly
1131 (defcustom org-agenda-include-diary nil
1132 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1133 Custom commands can set this variable in the options section."
1134 :group
'org-agenda-daily
/weekly
1137 (defcustom org-agenda-include-deadlines t
1138 "If non-nil, include entries within their deadline warning period.
1139 Custom commands can set this variable in the options section."
1140 :group
'org-agenda-daily
/weekly
1144 (defcustom org-agenda-repeating-timestamp-show-all t
1145 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1146 When set to a list of strings, only show occurrences of repeating
1147 stamps for these TODO keywords. When nil, only one occurrence is
1148 shown, either today or the nearest into the future."
1149 :group
'org-agenda-daily
/weekly
1151 (const :tag
"Show repeating stamps" t
)
1152 (repeat :tag
"Show repeating stamps for these TODO keywords"
1153 (string :tag
"TODO Keyword"))
1154 (const :tag
"Don't show repeating stamps" nil
)))
1156 (defcustom org-scheduled-past-days
10000
1157 "No. of days to continue listing scheduled items that are not marked DONE.
1158 When an item is scheduled on a date, it shows up in the agenda on this
1159 day and will be listed until it is marked done for the number of days
1161 :group
'org-agenda-daily
/weekly
1164 (defcustom org-agenda-log-mode-items
'(closed clock
)
1165 "List of items that should be shown in agenda log mode.
1166 This list may contain the following symbols:
1168 closed Show entries that have been closed on that day.
1169 clock Show entries that have received clocked time on that day.
1170 state Show all logged state changes.
1171 Note that instead of changing this variable, you can also press `C-u l' in
1172 the agenda to display all available LOG items temporarily."
1173 :group
'org-agenda-daily
/weekly
1174 :type
'(set :greedy t
(const closed
) (const clock
) (const state
)))
1176 (defcustom org-agenda-clock-consistency-checks
1177 '(:max-duration
"10:00" :min-duration
0 :max-gap
"0:05"
1178 :gap-ok-around
("4:00")
1179 :default-face
((:background
"DarkRed") (:foreground
"white"))
1180 :overlap-face nil
:gap-face nil
:no-end-time-face nil
1181 :long-face nil
:short-face nil
)
1182 "This is a property list, with the following keys:
1184 :max-duration Mark clocking chunks that are longer than this time.
1185 This is a time string like \"HH:MM\", or the number
1186 of minutes as an integer.
1188 :min-duration Mark clocking chunks that are shorter that this.
1189 This is a time string like \"HH:MM\", or the number
1190 of minutes as an integer.
1192 :max-gap Mark gaps between clocking chunks that are longer than
1193 this duration. A number of minutes, or a string
1196 :gap-ok-around List of times during the day which are usually not working
1197 times. When a gap is detected, but the gap contains any
1198 of these times, the gap is *not* reported. For example,
1199 if this is (\"4:00\" \"13:00\") then gaps that contain
1200 4:00 in the morning (i.e. the night) and 13:00
1201 (i.e. a typical lunch time) do not cause a warning.
1202 You should have at least one time during the night in this
1203 list, or otherwise the first task each morning will trigger
1204 a warning because it follows a long gap.
1206 Furthermore, the following properties can be used to define faces for
1209 :default-face the default face, if the specific face is undefined
1210 :overlap-face face for overlapping clocks
1211 :gap-face face for gaps between clocks
1212 :no-end-time-face face for incomplete clocks
1213 :long-face face for clock intervals that are too long
1214 :short-face face for clock intervals that are too short"
1215 :group
'org-agenda-daily
/weekly
1220 (defcustom org-agenda-log-mode-add-notes t
1221 "Non-nil means add first line of notes to log entries in agenda views.
1222 If a log item like a state change or a clock entry is associated with
1223 notes, the first line of these notes will be added to the entry in the
1225 :group
'org-agenda-daily
/weekly
1228 (defcustom org-agenda-start-with-log-mode nil
1229 "The initial value of log-mode in a newly created agenda window.
1230 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1231 explanations on the possible values."
1232 :group
'org-agenda-startup
1233 :group
'org-agenda-daily
/weekly
1234 :type
'(choice (const :tag
"Don't show log items" nil
)
1235 (const :tag
"Show only log items" 'only
)
1236 (const :tag
"Show all possible log items" 'clockcheck
)
1237 (repeat :tag
"Choose among possible values for `org-agenda-log-mode-items'"
1238 (choice (const :tag
"Show closed log items" 'closed
)
1239 (const :tag
"Show clocked log items" 'clock
)
1240 (const :tag
"Show all logged state changes" 'state
)))))
1242 (defcustom org-agenda-start-with-clockreport-mode nil
1243 "The initial value of clockreport-mode in a newly created agenda window."
1244 :group
'org-agenda-startup
1245 :group
'org-agenda-daily
/weekly
1248 (defcustom org-agenda-clockreport-parameter-plist
'(:link t
:maxlevel
2)
1249 "Property list with parameters for the clocktable in clockreport mode.
1250 This is the display mode that shows a clock table in the daily/weekly
1251 agenda, the properties for this dynamic block can be set here.
1252 The usual clocktable parameters are allowed here, but you cannot set
1253 the properties :name, :tstart, :tend, :block, and :scope - these will
1254 be overwritten to make sure the content accurately reflects the
1255 current display in the agenda."
1256 :group
'org-agenda-daily
/weekly
1259 (defcustom org-agenda-search-view-always-boolean nil
1260 "Non-nil means the search string is interpreted as individual parts.
1262 The search string for search view can either be interpreted as a phrase,
1263 or as a list of snippets that define a boolean search for a number of
1266 When this is non-nil, the string will be split on whitespace, and each
1267 snippet will be searched individually, and all must match in order to
1268 select an entry. A snippet is then a single string of non-white
1269 characters, or a string in double quotes, or a regexp in {} braces.
1270 If a snippet is preceded by \"-\", the snippet must *not* match.
1271 \"+\" is syntactic sugar for positive selection. Each snippet may
1272 be found as a full word or a partial word, but see the variable
1273 `org-agenda-search-view-force-full-words'.
1275 When this is nil, search will look for the entire search phrase as one,
1276 with each space character matching any amount of whitespace, including
1279 Even when this is nil, you can still switch to Boolean search dynamically
1280 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1281 is a regexp marked with braces like \"{abc}\", this will also switch to
1283 :group
'org-agenda-search-view
1287 (if (fboundp 'defvaralias
)
1288 (defvaralias 'org-agenda-search-view-search-words-only
1289 'org-agenda-search-view-always-boolean
))
1291 (defcustom org-agenda-search-view-force-full-words nil
1292 "Non-nil means, search words must be matches as complete words.
1293 When nil, they may also match part of a word."
1294 :group
'org-agenda-search-view
1298 (defgroup org-agenda-time-grid nil
1299 "Options concerning the time grid in the Org-mode Agenda."
1300 :tag
"Org Agenda Time Grid"
1303 (defcustom org-agenda-search-headline-for-time t
1304 "Non-nil means search headline for a time-of-day.
1305 If the headline contains a time-of-day in one format or another, it will
1306 be used to sort the entry into the time sequence of items for a day.
1307 Some people have time stamps in the headline that refer to the creation
1308 time or so, and then this produces an unwanted side effect. If this is
1309 the case for your, use this variable to turn off searching the headline
1311 :group
'org-agenda-time-grid
1314 (defcustom org-agenda-use-time-grid t
1315 "Non-nil means show a time grid in the agenda schedule.
1316 A time grid is a set of lines for specific times (like every two hours between
1317 8:00 and 20:00). The items scheduled for a day at specific times are
1318 sorted in between these lines.
1319 For details about when the grid will be shown, and what it will look like, see
1320 the variable `org-agenda-time-grid'."
1321 :group
'org-agenda-time-grid
1324 (defcustom org-agenda-time-grid
1325 '((daily today require-timed
)
1327 (800 1000 1200 1400 1600 1800 2000))
1329 "The settings for time grid for agenda display.
1330 This is a list of three items. The first item is again a list. It contains
1331 symbols specifying conditions when the grid should be displayed:
1333 daily if the agenda shows a single day
1334 weekly if the agenda shows an entire week
1335 today show grid on current date, independent of daily/weekly display
1336 require-timed show grid only if at least one item has a time specification
1338 The second item is a string which will be placed behind the grid time.
1340 The third item is a list of integers, indicating the times that should have
1342 :group
'org-agenda-time-grid
1345 (set :greedy t
:tag
"Grid Display Options"
1346 (const :tag
"Show grid in single day agenda display" daily
)
1347 (const :tag
"Show grid in weekly agenda display" weekly
)
1348 (const :tag
"Always show grid for today" today
)
1349 (const :tag
"Show grid only if any timed entries are present"
1351 (const :tag
"Skip grid times already present in an entry"
1353 (string :tag
"Grid String")
1354 (repeat :tag
"Grid Times" (integer :tag
"Time"))))
1356 (defcustom org-agenda-show-current-time-in-grid t
1357 "Non-nil means show the current time in the time grid."
1358 :group
'org-agenda-time-grid
1362 (defcustom org-agenda-current-time-string
1363 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1364 "The string for the current time marker in the agenda."
1365 :group
'org-agenda-time-grid
1369 (defgroup org-agenda-sorting nil
1370 "Options concerning sorting in the Org-mode Agenda."
1371 :tag
"Org Agenda Sorting"
1374 (defcustom org-agenda-sorting-strategy
1375 '((agenda habit-down time-up priority-down category-keep
)
1376 (todo priority-down category-keep
)
1377 (tags priority-down category-keep
)
1378 (search category-keep
))
1379 "Sorting structure for the agenda items of a single day.
1380 This is a list of symbols which will be used in sequence to determine
1381 if an entry should be listed before another entry. The following
1382 symbols are recognized:
1384 time-up Put entries with time-of-day indications first, early first
1385 time-down Put entries with time-of-day indications first, late first
1386 category-keep Keep the default order of categories, corresponding to the
1387 sequence in `org-agenda-files'.
1388 category-up Sort alphabetically by category, A-Z.
1389 category-down Sort alphabetically by category, Z-A.
1390 tag-up Sort alphabetically by last tag, A-Z.
1391 tag-down Sort alphabetically by last tag, Z-A.
1392 priority-up Sort numerically by priority, high priority last.
1393 priority-down Sort numerically by priority, high priority first.
1394 todo-state-up Sort by todo state, tasks that are done last.
1395 todo-state-down Sort by todo state, tasks that are done first.
1396 effort-up Sort numerically by estimated effort, high effort last.
1397 effort-down Sort numerically by estimated effort, high effort first.
1398 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1399 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1400 habit-up Put entries that are habits first
1401 habit-down Put entries that are habits last
1402 alpha-up Sort headlines alphabetically
1403 alpha-down Sort headlines alphabetically, reversed
1405 The different possibilities will be tried in sequence, and testing stops
1406 if one comparison returns a \"not-equal\". For example, the default
1407 '(time-up category-keep priority-down)
1408 means: Pull out all entries having a specified time of day and sort them,
1409 in order to make a time schedule for the current day the first thing in the
1410 agenda listing for the day. Of the entries without a time indication, keep
1411 the grouped in categories, don't sort the categories, but keep them in
1412 the sequence given in `org-agenda-files'. Within each category sort by
1415 Leaving out `category-keep' would mean that items will be sorted across
1416 categories by priority.
1418 Instead of a single list, this can also be a set of list for specific
1419 contents, with a context symbol in the car of the list, any of
1420 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1422 Custom commands can bind this variable in the options section."
1423 :group
'org-agenda-sorting
1425 (repeat :tag
"General" ,org-sorting-choice
)
1426 (list :tag
"Individually"
1427 (cons (const :tag
"Strategy for Weekly/Daily agenda" agenda
)
1428 (repeat ,org-sorting-choice
))
1429 (cons (const :tag
"Strategy for TODO lists" todo
)
1430 (repeat ,org-sorting-choice
))
1431 (cons (const :tag
"Strategy for Tags matches" tags
)
1432 (repeat ,org-sorting-choice
))
1433 (cons (const :tag
"Strategy for search matches" search
)
1434 (repeat ,org-sorting-choice
)))))
1436 (defcustom org-agenda-cmp-user-defined nil
1437 "A function to define the comparison `user-defined'.
1438 This function must receive two arguments, agenda entry a and b.
1439 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1440 the user comparison, return nil.
1441 When this is defined, you can make `user-defined-up' and `user-defined-down'
1442 part of an agenda sorting strategy."
1443 :group
'org-agenda-sorting
1446 (defcustom org-sort-agenda-notime-is-late t
1447 "Non-nil means items without time are considered late.
1448 This is only relevant for sorting. When t, items which have no explicit
1449 time like 15:30 will be considered as 99:01, i.e. later than any items which
1450 do have a time. When nil, the default time is before 0:00. You can use this
1451 option to decide if the schedule for today should come before or after timeless
1453 :group
'org-agenda-sorting
1456 (defcustom org-sort-agenda-noeffort-is-high t
1457 "Non-nil means items without effort estimate are sorted as high effort.
1458 This also applies when filtering an agenda view with respect to the
1459 < or > effort operator. Then, tasks with no effort defined will be treated
1460 as tasks with high effort.
1461 When nil, such items are sorted as 0 minutes effort."
1462 :group
'org-agenda-sorting
1465 (defgroup org-agenda-line-format nil
1466 "Options concerning the entry prefix in the Org-mode agenda display."
1467 :tag
"Org Agenda Line Format"
1470 (defcustom org-agenda-prefix-format
1471 '((agenda .
" %i %-12:c%?-12t% s")
1473 (todo .
" %i %-12:c")
1474 (tags .
" %i %-12:c")
1475 (search .
" %i %-12:c"))
1476 "Format specifications for the prefix of items in the agenda views.
1477 An alist with five entries, each for the different agenda types. The
1478 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1479 The values are format strings.
1481 This format works similar to a printf format, with the following meaning:
1483 %c the category of the item, \"Diary\" for entries from the diary,
1484 or as given by the CATEGORY keyword or derived from the file name
1485 %e the effort required by the item
1486 %i the icon category of the item, see `org-agenda-category-icon-alist'
1487 %T the last tag of the item (ignore inherited tags, which come first)
1488 %t the HH:MM time-of-day specification if one applies to the entry
1489 %s Scheduling/Deadline information, a short string
1490 %(expression) Eval EXPRESSION and replace the control string
1493 All specifiers work basically like the standard `%s' of printf, but may
1494 contain two additional characters: a question mark just after the `%'
1495 and a whitespace/punctuation character just before the final letter.
1497 If the first character after `%' is a question mark, the entire field
1498 will only be included if the corresponding value applies to the current
1499 entry. This is useful for fields which should have fixed width when
1500 present, but zero width when absent. For example, \"%?-12t\" will
1501 result in a 12 character time field if a time of the day is specified,
1502 but will completely disappear in entries which do not contain a time.
1504 If there is punctuation or whitespace character just before the final
1505 format letter, this character will be appended to the field value if
1506 the value is not empty. For example, the format \"%-12:c\" leads to
1507 \"Diary: \" if the category is \"Diary\". If the category were be
1508 empty, no additional colon would be inserted.
1510 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1513 - Indent the line with two space characters
1514 - Give the category a 12 chars wide field, padded with whitespace on
1515 the right (because of `-'). Append a colon if there is a category
1517 - If there is a time-of-day, put it into a 12 chars wide field. If no
1518 time, don't put in an empty field, just skip it (because of '?').
1519 - Finally, put the scheduling information.
1521 See also the variables `org-agenda-remove-times-when-in-prefix' and
1522 `org-agenda-remove-tags'.
1524 Custom commands can set this variable in the options section."
1526 (string :tag
"General format")
1527 (list :greedy t
:tag
"View dependent"
1528 (cons (const agenda
) (string :tag
"Format"))
1529 (cons (const timeline
) (string :tag
"Format"))
1530 (cons (const todo
) (string :tag
"Format"))
1531 (cons (const tags
) (string :tag
"Format"))
1532 (cons (const search
) (string :tag
"Format"))))
1533 :group
'org-agenda-line-format
)
1535 (defvar org-prefix-format-compiled nil
1536 "The compiled prefix format and associated variables.
1537 This is a list where first element is a list of variable bindings, and second
1538 element is the compiled format expression. See the variable
1539 `org-agenda-prefix-format'.")
1541 (defcustom org-agenda-todo-keyword-format
"%-1s"
1542 "Format for the TODO keyword in agenda lines.
1543 Set this to something like \"%-12s\" if you want all TODO keywords
1544 to occupy a fixed space in the agenda display."
1545 :group
'org-agenda-line-format
1548 (defcustom org-agenda-diary-sexp-prefix nil
1549 "A regexp that matches part of a diary sexp entry
1550 which should be treated as scheduling/deadline information in
1553 For example, you can use this to extract the `diary-remind-message' from
1554 `diary-remind' entries."
1555 :group
'org-agenda-line-format
1556 :type
'(choice (const :tag
"None" nil
) (regexp :tag
"Regexp")))
1558 (defcustom org-agenda-timerange-leaders
'("" "(%d/%d): ")
1559 "Text preceding timerange entries in the agenda view.
1560 This is a list with two strings. The first applies when the range
1561 is entirely on one day. The second applies if the range spans several days.
1562 The strings may have two \"%d\" format specifiers which will be filled
1563 with the sequence number of the days, and the total number of days in the
1564 range, respectively."
1565 :group
'org-agenda-line-format
1567 (string :tag
"Deadline today ")
1568 (choice :tag
"Deadline relative"
1569 (string :tag
"Format string")
1572 (defcustom org-agenda-scheduled-leaders
'("Scheduled: " "Sched.%2dx: ")
1573 "Text preceding scheduled items in the agenda view.
1574 This is a list with two strings. The first applies when the item is
1575 scheduled on the current day. The second applies when it has been scheduled
1576 previously, it may contain a %d indicating that this is the nth time that
1577 this item is scheduled, due to automatic rescheduling of unfinished items
1578 for the following day. So this number is one larger than the number of days
1579 that passed since this item was scheduled first."
1580 :group
'org-agenda-line-format
1582 (string :tag
"Scheduled today ")
1583 (string :tag
"Scheduled previously")))
1585 (defcustom org-agenda-inactive-leader
"["
1586 "Text preceding item pulled into the agenda by inactive time stamps.
1587 These entries are added to the agenda when pressing \"[\"."
1588 :group
'org-agenda-line-format
1591 (string :tag
"Scheduled today ")
1592 (string :tag
"Scheduled previously")))
1594 (defcustom org-agenda-deadline-leaders
'("Deadline: " "In %3d d.: ")
1595 "Text preceding deadline items in the agenda view.
1596 This is a list with two strings. The first applies when the item has its
1597 deadline on the current day. The second applies when it is in the past or
1598 in the future, it may contain %d to capture how many days away the deadline
1600 :group
'org-agenda-line-format
1602 (string :tag
"Deadline today ")
1603 (choice :tag
"Deadline relative"
1604 (string :tag
"Format string")
1607 (defcustom org-agenda-remove-times-when-in-prefix t
1608 "Non-nil means remove duplicate time specifications in agenda items.
1609 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1610 time-of-day specification in a headline or diary entry is extracted and
1611 placed into the prefix. If this option is non-nil, the original specification
1612 \(a timestamp or -range, or just a plain time(range) specification like
1613 11:30-4pm) will be removed for agenda display. This makes the agenda less
1615 The option can be t or nil. It may also be the symbol `beg', indicating
1616 that the time should only be removed when it is located at the beginning of
1617 the headline/diary entry."
1618 :group
'org-agenda-line-format
1620 (const :tag
"Always" t
)
1621 (const :tag
"Never" nil
)
1622 (const :tag
"When at beginning of entry" beg
)))
1624 (defcustom org-agenda-remove-timeranges-from-blocks nil
1625 "Non-nil means remove time ranges specifications in agenda
1626 items that span on several days."
1627 :group
'org-agenda-line-format
1631 (defcustom org-agenda-default-appointment-duration nil
1632 "Default duration for appointments that only have a starting time.
1633 When nil, no duration is specified in such cases.
1634 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1635 :group
'org-agenda-line-format
1637 (integer :tag
"Minutes")
1638 (const :tag
"No default duration")))
1640 (defcustom org-agenda-show-inherited-tags t
1641 "Non-nil means show inherited tags in each agenda line."
1642 :group
'org-agenda-line-format
1645 (defcustom org-agenda-hide-tags-regexp nil
1646 "Regular expression used to filter away specific tags in agenda views.
1647 This means that these tags will be present, but not be shown in the agenda
1648 line. Secondary filtering will still work on the hidden tags.
1649 Nil means don't hide any tags."
1650 :group
'org-agenda-line-format
1652 (const :tag
"Hide none" nil
)
1653 (string :tag
"Regexp ")))
1655 (defcustom org-agenda-remove-tags nil
1656 "Non-nil means remove the tags from the headline copy in the agenda.
1657 When this is the symbol `prefix', only remove tags when
1658 `org-agenda-prefix-format' contains a `%T' specifier."
1659 :group
'org-agenda-line-format
1661 (const :tag
"Always" t
)
1662 (const :tag
"Never" nil
)
1663 (const :tag
"When prefix format contains %T" prefix
)))
1665 (if (fboundp 'defvaralias
)
1666 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1667 'org-agenda-remove-tags
))
1669 (defcustom org-agenda-tags-column
(if (featurep 'xemacs
) -
79 -
80)
1670 "Shift tags in agenda items to this column.
1671 If this number is positive, it specifies the column. If it is negative,
1672 it means that the tags should be flushright to that column. For example,
1673 -80 works well for a normal 80 character screen."
1674 :group
'org-agenda-line-format
1677 (if (fboundp 'defvaralias
)
1678 (defvaralias 'org-agenda-align-tags-to-column
'org-agenda-tags-column
))
1680 (defcustom org-agenda-fontify-priorities
'cookies
1681 "Non-nil means highlight low and high priorities in agenda.
1682 When t, the highest priority entries are bold, lowest priority italic.
1683 However, settings in `org-priority-faces' will overrule these faces.
1684 When this variable is the symbol `cookies', only fontify the
1685 cookies, not the entire task.
1686 This may also be an association list of priority faces, whose
1687 keys are the character values of `org-highest-priority',
1688 `org-default-priority', and `org-lowest-priority' (the default values
1689 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1690 color as a string, or a list like `(:background \"Red\")'.
1691 If it is a color, the variable `org-faces-easy-properties'
1692 determines if it is a foreground or a background color."
1693 :group
'org-agenda-line-format
1695 (const :tag
"Never" nil
)
1696 (const :tag
"Defaults" t
)
1697 (const :tag
"Cookies only" cookies
)
1698 (repeat :tag
"Specify"
1699 (list (character :tag
"Priority" :value ?A
)
1700 (choice :tag
"Face "
1701 (string :tag
"Color")
1702 (sexp :tag
"Face"))))))
1704 (defcustom org-agenda-day-face-function nil
1705 "Function called to determine what face should be used to display a day.
1706 The only argument passed to that function is the day. It should
1707 returns a face, or nil if does not want to specify a face and let
1708 the normal rules apply."
1709 :group
'org-agenda-line-format
1713 (defcustom org-agenda-category-icon-alist nil
1714 "Alist of category icon to be displayed in agenda views.
1716 Each entry should have the following format:
1718 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1720 Where CATEGORY-REGEXP is a regexp matching the categories where
1721 the icon should be displayed.
1722 FILE-OR-DATA either a file path or a string containing image data.
1724 The other fields can be omitted safely if not needed:
1725 TYPE indicates the image type.
1726 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1728 PROPS are additional image attributes to assign to the image,
1729 like, e.g. `:ascent center'.
1731 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1733 If you want to set the display properties yourself, just put a
1734 list as second element:
1736 (CATEGORY-REGEXP (MY PROPERTY LIST))
1738 For example, to display a 16px horizontal space for Emacs
1739 category, you can use:
1741 (\"Emacs\" '(space . (:width (16))))"
1742 :group
'org-agenda-line-format
1744 :type
'(alist :key-type
(string :tag
"Regexp matching category")
1745 :value-type
(choice (list :tag
"Icon"
1746 (string :tag
"File or data")
1747 (symbol :tag
"Type")
1748 (boolean :tag
"Data?")
1749 (repeat :tag
"Extra image properties" :inline t symbol
))
1750 (list :tag
"Display properties" sexp
))))
1752 (defgroup org-agenda-column-view nil
1753 "Options concerning column view in the agenda."
1754 :tag
"Org Agenda Column View"
1757 (defcustom org-agenda-columns-show-summaries t
1758 "Non-nil means show summaries for columns displayed in the agenda view."
1759 :group
'org-agenda-column-view
1762 (defcustom org-agenda-columns-compute-summary-properties t
1763 "Non-nil means recompute all summary properties before column view.
1764 When column view in the agenda is listing properties that have a summary
1765 operator, it can go to all relevant buffers and recompute the summaries
1766 there. This can mean overhead for the agenda column view, but is necessary
1767 to have thing up to date.
1768 As a special case, a CLOCKSUM property also makes sure that the clock
1769 computations are current."
1770 :group
'org-agenda-column-view
1773 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1774 "Non-nil means the duration of an appointment will add to day effort.
1775 The property to which appointment durations will be added is the one given
1776 in the option `org-effort-property'. If an appointment does not have
1777 an end time, `org-agenda-default-appointment-duration' will be used. If that
1778 is not set, an appointment without end time will not contribute to the time
1780 :group
'org-agenda-column-view
1783 (defcustom org-agenda-auto-exclude-function nil
1784 "A function called with a tag to decide if it is filtered on '/ RET'.
1785 The sole argument to the function, which is called once for each
1786 possible tag, is a string giving the name of the tag. The
1787 function should return either nil if the tag should be included
1788 as normal, or \"-<TAG>\" to exclude the tag.
1789 Note that for the purpose of tag filtering, only the lower-case version of
1790 all tags will be considered, so that this function will only ever see
1791 the lower-case version of all tags."
1795 (defcustom org-agenda-bulk-custom-functions nil
1796 "Alist of characters and custom functions for bulk actions.
1797 For example, this value makes those two functions available:
1802 With selected entries in an agenda buffer, `B R' will call
1803 the custom function `set-category' on the selected entries.
1804 Note that functions in this alist don't need to be quoted."
1809 (defmacro org-agenda-with-point-at-orig-entry
(string &rest body
)
1810 "Execute BODY with point at location given by `org-hd-marker' property.
1811 If STRING is non-nil, the text property will be fetched from position 0
1812 in that string. If STRING is nil, it will be fetched from the beginning
1813 of the current line."
1814 (org-with-gensyms (marker)
1815 `(let ((,marker
(get-text-property (if string
0 (point-at-bol))
1816 'org-hd-marker
,string
)))
1817 (with-current-buffer (marker-buffer ,marker
)
1821 (def-edebug-spec org-agenda-with-point-at-orig-entry
(form body
))
1823 (defun org-add-agenda-custom-command (entry)
1824 "Replace or add a command in `org-agenda-custom-commands'.
1825 This is mostly for hacking and trying a new command - once the command
1826 works you probably want to add it to `org-agenda-custom-commands' for good."
1827 (let ((ass (assoc (car entry
) org-agenda-custom-commands
)))
1829 (setcdr ass
(cdr entry
))
1830 (push entry org-agenda-custom-commands
))))
1832 ;;; Define the org-agenda-mode
1834 (defvar org-agenda-mode-map
(make-sparse-keymap)
1835 "Keymap for `org-agenda-mode'.")
1836 (if (fboundp 'defvaralias
)
1837 (defvaralias 'org-agenda-keymap
'org-agenda-mode-map
))
1839 (defvar org-agenda-menu
) ; defined later in this file.
1840 (defvar org-agenda-restrict
) ; defined later in this file.
1841 (defvar org-agenda-follow-mode nil
)
1842 (defvar org-agenda-entry-text-mode nil
)
1843 (defvar org-agenda-clockreport-mode nil
)
1844 (defvar org-agenda-show-log nil
)
1845 (defvar org-agenda-redo-command nil
)
1846 (defvar org-agenda-query-string nil
)
1847 (defvar org-agenda-mode-hook nil
1848 "Hook for `org-agenda-mode', run after the mode is turned on.")
1849 (defvar org-agenda-type nil
)
1850 (defvar org-agenda-force-single-file nil
)
1851 (defvar org-agenda-bulk-marked-entries
) ;; Defined further down in this file
1854 ;;; Multiple agenda buffers support
1856 (defcustom org-agenda-sticky nil
1857 "Non-nil means agenda q key will bury agenda buffers.
1858 Agenda commands will then show existing buffer instead of generating new ones.
1859 When nil, `q' will kill the single agenda buffer."
1862 :set
(lambda (var val
)
1864 (org-toggle-sticky-agenda (if val
1 0))
1867 (defun org-toggle-sticky-agenda (&optional arg
)
1868 "Toggle `org-agenda-sticky'."
1870 (let ((new-value (if arg
1871 (> (prefix-numeric-value arg
) 0)
1872 (not org-agenda-sticky
))))
1873 (if (equal new-value org-agenda-sticky
)
1874 (and (org-called-interactively-p 'interactive
)
1875 (message "Sticky agenda was already %s"
1876 (if org-agenda-sticky
"enabled" "disabled")))
1877 (setq org-agenda-sticky new-value
)
1878 (org-agenda-kill-all-agenda-buffers)
1879 (and (org-called-interactively-p 'interactive
)
1880 (message "Sticky agenda was %s"
1881 (if org-agenda-sticky
"enabled" "disabled"))))))
1883 (defvar org-agenda-buffer nil
1884 "Agenda buffer currently being generated.")
1886 (defvar org-agenda-last-prefix-arg nil
)
1887 (defvar org-agenda-this-buffer-name nil
)
1888 (defvar org-agenda-doing-sticky-redo nil
)
1889 (defvar org-agenda-this-buffer-is-sticky nil
)
1891 (defconst org-agenda-local-vars
1892 '(org-agenda-this-buffer-name
1893 org-agenda-undo-list
1894 org-agenda-pending-undo-list
1895 org-agenda-follow-mode
1896 org-agenda-entry-text-mode
1897 org-agenda-clockreport-mode
1899 org-agenda-redo-command
1900 org-agenda-query-string
1902 org-agenda-bulk-marked-entries
1903 org-agenda-undo-has-started-in
1904 org-agenda-last-arguments
1906 org-agenda-tag-filter-overlays
1907 org-agenda-cat-filter-overlays
1908 org-pre-agenda-window-conf
1909 org-agenda-columns-active
1910 org-agenda-tag-filter
1911 org-agenda-category-filter
1913 org-agenda-last-search-view-search-was-boolean
1914 org-agenda-filtered-by-category
1915 org-agenda-filter-form
1916 org-agenda-show-window
1917 org-agenda-cycle-counter
1918 org-agenda-last-prefix-arg
)
1919 "Variables that must be local in agenda buffers to allow multiple buffers.")
1921 (defun org-agenda-mode ()
1922 "Mode for time-sorted view on action items in Org-mode files.
1924 The following commands are available:
1926 \\{org-agenda-mode-map}"
1928 (cond (org-agenda-doing-sticky-redo
1929 ;; Refreshing sticky agenda-buffer
1931 ;; Preserve the value of `org-agenda-local-vars' variables,
1932 ;; while letting `kill-all-local-variables' kill the rest
1933 (let ((save (buffer-local-variables)))
1934 (kill-all-local-variables)
1935 (mapc 'make-local-variable org-agenda-local-vars
)
1937 (let ((var (car elem
))
1940 (member var org-agenda-local-vars
))
1942 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
1944 ;; Creating a sticky Agenda buffer for the first time
1945 (kill-all-local-variables)
1946 (mapc 'make-local-variable org-agenda-local-vars
)
1947 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) t
))
1949 ;; Creating a non-sticky agenda buffer
1950 (kill-all-local-variables)
1951 (set (make-local-variable 'org-agenda-this-buffer-is-sticky
) nil
)))
1952 (setq org-agenda-undo-list nil
1953 org-agenda-pending-undo-list nil
1954 org-agenda-bulk-marked-entries nil
)
1955 (setq major-mode
'org-agenda-mode
)
1956 ;; Keep global-font-lock-mode from turning on font-lock-mode
1957 (org-set-local 'font-lock-global-modes
(list 'not major-mode
))
1958 (setq mode-name
"Org-Agenda")
1959 (use-local-map org-agenda-mode-map
)
1960 (easy-menu-add org-agenda-menu
)
1961 (if org-startup-truncated
(setq truncate-lines t
))
1962 (org-set-local 'line-move-visual nil
)
1963 (org-add-hook 'post-command-hook
'org-agenda-post-command-hook nil
'local
)
1964 (org-add-hook 'pre-command-hook
'org-unhighlight nil
'local
)
1965 ;; Make sure properties are removed when copying text
1966 (make-local-variable 'filter-buffer-substring-functions
)
1967 (add-hook 'filter-buffer-substring-functions
1968 (lambda (fun start end delete
)
1969 (substring-no-properties (funcall fun start end delete
))))
1970 (unless org-agenda-keep-modes
1971 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1972 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1973 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1974 org-agenda-show-log org-agenda-start-with-log-mode
))
1977 '("Agenda") "Agenda Files"
1981 (if (get 'org-agenda-files
'org-restrict
)
1982 "Restricted to single file"
1984 '(org-edit-agenda-file-list)
1985 (not (get 'org-agenda-files
'org-restrict
)))
1987 (mapcar 'org-file-menu-entry
(org-agenda-files))))
1988 (org-agenda-set-mode-name)
1990 (if (fboundp 'run-mode-hooks
) 'run-mode-hooks
'run-hooks
)
1991 (list 'org-agenda-mode-hook
)))
1993 (substitute-key-definition 'undo
'org-agenda-undo
1994 org-agenda-mode-map global-map
)
1995 (org-defkey org-agenda-mode-map
"\C-i" 'org-agenda-goto
)
1996 (org-defkey org-agenda-mode-map
[(tab)] 'org-agenda-goto
)
1997 (org-defkey org-agenda-mode-map
"\C-m" 'org-agenda-switch-to
)
1998 (org-defkey org-agenda-mode-map
"\C-k" 'org-agenda-kill
)
1999 (org-defkey org-agenda-mode-map
"\C-c\C-w" 'org-agenda-refile
)
2000 (org-defkey org-agenda-mode-map
"m" 'org-agenda-bulk-mark
)
2001 (org-defkey org-agenda-mode-map
"*" 'org-agenda-bulk-mark-all
)
2002 (org-defkey org-agenda-mode-map
"%" 'org-agenda-bulk-mark-regexp
)
2003 (org-defkey org-agenda-mode-map
"u" 'org-agenda-bulk-unmark
)
2004 (org-defkey org-agenda-mode-map
"U" 'org-agenda-bulk-unmark-all
)
2005 (org-defkey org-agenda-mode-map
"A" 'org-agenda-append-agenda
)
2006 (org-defkey org-agenda-mode-map
"B" 'org-agenda-bulk-action
)
2007 (org-defkey org-agenda-mode-map
"\C-c\C-x!" 'org-reload
)
2008 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-a" 'org-agenda-archive-default
)
2009 (org-defkey org-agenda-mode-map
"\C-c\C-xa" 'org-agenda-toggle-archive-tag
)
2010 (org-defkey org-agenda-mode-map
"\C-c\C-xA" 'org-agenda-archive-to-archive-sibling
)
2011 (org-defkey org-agenda-mode-map
"\C-c\C-x\C-s" 'org-agenda-archive
)
2012 (org-defkey org-agenda-mode-map
"\C-c$" 'org-agenda-archive
)
2013 (org-defkey org-agenda-mode-map
"$" 'org-agenda-archive
)
2014 (org-defkey org-agenda-mode-map
"\C-c\C-o" 'org-agenda-open-link
)
2015 (org-defkey org-agenda-mode-map
" " 'org-agenda-show-and-scroll-up
)
2016 (org-defkey org-agenda-mode-map
[backspace] 'org-agenda-show-scroll-down)
2017 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2018 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2019 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2020 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2021 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2022 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2023 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2024 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2025 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2026 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2027 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2028 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2029 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2030 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2031 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2032 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2033 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2034 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2035 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
2036 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
2037 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2038 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2039 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2040 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2042 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2043 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2044 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2045 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2046 (while l (org-defkey org-agenda-mode-map
2047 (int-to-string (pop l)) 'digit-argument)))
2049 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2050 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2051 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2052 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2053 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2054 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2055 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2056 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2057 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2058 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
2059 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2060 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2061 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2062 'org-clock-modify-effort-estimate)
2063 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2064 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2065 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2066 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2067 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2068 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2069 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2070 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2071 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2072 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2073 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2074 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2075 (substitute-key-definition 'next-line 'org-agenda-next-line
2076 org-agenda-mode-map global-map)
2077 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2078 org-agenda-mode-map global-map)
2079 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2080 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2081 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2082 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2083 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-show-priority)
2084 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2085 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2086 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2087 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2088 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2089 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2090 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2091 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2092 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2093 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2094 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2095 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2096 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2097 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2098 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2099 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2100 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2101 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2102 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2103 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2104 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2105 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2106 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2107 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2108 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2110 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2111 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2112 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2113 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2114 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2115 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2116 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2117 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-category)
2118 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2119 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2120 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2121 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2123 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2124 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2125 (when org-agenda-mouse-1-follows-link
2126 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2127 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2132 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2133 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2134 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2135 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2138 ["Day View" org-agenda-day-view
2139 :active (org-agenda-check-type nil 'agenda)
2140 :style radio :selected (eq org-agenda-current-span 'day)
2141 :keys "v d (or just d)"]
2142 ["Week View" org-agenda-week-view
2143 :active (org-agenda-check-type nil 'agenda)
2144 :style radio :selected (eq org-agenda-current-span 'week)
2145 :keys "v w (or just w)"]
2146 ["Month View" org-agenda-month-view
2147 :active (org-agenda-check-type nil 'agenda)
2148 :style radio :selected (eq org-agenda-current-span 'month)
2150 ["Year View" org-agenda-year-view
2151 :active (org-agenda-check-type nil 'agenda)
2152 :style radio :selected (eq org-agenda-current-span 'year)
2155 ["Include Diary" org-agenda-toggle-diary
2156 :style toggle :selected org-agenda-include-diary
2157 :active (org-agenda-check-type nil 'agenda)]
2158 ["Include Deadlines" org-agenda-toggle-deadlines
2159 :style toggle :selected org-agenda-include-deadlines
2160 :active (org-agenda-check-type nil 'agenda)]
2161 ["Use Time Grid" org-agenda-toggle-time-grid
2162 :style toggle :selected org-agenda-use-time-grid
2163 :active (org-agenda-check-type nil 'agenda)]
2165 ["Show clock report" org-agenda-clockreport-mode
2166 :style toggle :selected org-agenda-clockreport-mode
2167 :active (org-agenda-check-type nil 'agenda)]
2168 ["Show some entry text" org-agenda-entry-text-mode
2169 :style toggle :selected org-agenda-entry-text-mode
2172 ["Show Logbook entries" org-agenda-log-mode
2173 :style toggle :selected org-agenda-show-log
2174 :active (org-agenda-check-type nil 'agenda 'timeline)
2175 :keys "v l (or just l)"]
2176 ["Include archived trees" org-agenda-archives-mode
2177 :style toggle :selected org-agenda-archives-mode :active t
2179 ["Include archive files" (org-agenda-archives-mode t)
2180 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2183 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2184 ["Write view to file" org-agenda-write t]
2185 ["Rebuild buffer" org-agenda-redo t]
2186 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2188 ["Show original entry" org-agenda-show t]
2189 ["Go To (other window)" org-agenda-goto t]
2190 ["Go To (this window)" org-agenda-switch-to t]
2191 ["Follow Mode" org-agenda-follow-mode
2192 :style toggle :selected org-agenda-follow-mode :active t]
2193 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2196 ["Cycle TODO" org-agenda-todo t]
2197 ["Next TODO set" org-agenda-todo-nextset t]
2198 ["Previous TODO set" org-agenda-todo-previousset t]
2199 ["Add note" org-agenda-add-note t])
2200 ("Archive/Refile/Delete"
2201 ["Archive default" org-agenda-archive-default t]
2202 ["Archive default" org-agenda-archive-default-with-confirmation t]
2203 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2204 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2205 ["Archive subtree" org-agenda-archive t]
2207 ["Refile" org-agenda-refile t]
2209 ["Delete subtree" org-agenda-kill t])
2211 ["Mark entry" org-agenda-bulk-mark t]
2212 ["Mark all" org-agenda-bulk-mark-all t]
2213 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2214 ["Unmark entry" org-agenda-bulk-unmark t]
2215 ["Unmark all entries" org-agenda-bulk-unmark-all :active t :keys "C-u s"])
2216 ["Act on all marked" org-agenda-bulk-action t]
2218 ("Tags and Properties"
2219 ["Show all Tags" org-agenda-show-tags t]
2220 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2221 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2223 ["Column View" org-columns t])
2224 ("Deadline/Schedule"
2225 ["Schedule" org-agenda-schedule t]
2226 ["Set Deadline" org-agenda-deadline t]
2228 ["Mark item" org-agenda-action :active t :keys "k m"]
2229 ["Show mark item" org-agenda-action :active t :keys "k v"]
2230 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2231 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
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-list nil
2283 "List of undoable operations in the agenda since last refresh.")
2284 (defvar org-agenda-undo-has-started-in nil
2285 "Buffers that have already seen `undo-start' in the current undo sequence.")
2286 (defvar org-agenda-pending-undo-list nil
2287 "In a series of undo commands, this is the list of remaining undo items.")
2289 (defun org-agenda-undo ()
2290 "Undo a remote editing step in the agenda.
2291 This undoes changes both in the agenda buffer and in the remote buffer
2292 that have been changed along."
2294 (or org-agenda-allow-remote-undo
2295 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2296 (if (not (eq this-command last-command))
2297 (setq org-agenda-undo-has-started-in nil
2298 org-agenda-pending-undo-list org-agenda-undo-list))
2299 (if (not org-agenda-pending-undo-list)
2300 (error "No further undo information"))
2301 (let* ((entry (pop org-agenda-pending-undo-list))
2302 buf line cmd rembuf)
2303 (setq cmd (pop entry) line (pop entry))
2304 (setq rembuf (nth 2 entry))
2305 (org-with-remote-undo rembuf
2306 (while (bufferp (setq buf (pop entry)))
2308 (with-current-buffer buf
2309 (let ((last-undo-buffer buf)
2310 (inhibit-read-only t))
2311 (unless (memq buf org-agenda-undo-has-started-in)
2312 (push buf org-agenda-undo-has-started-in)
2313 (make-local-variable 'pending-undo-list)
2315 (while (and pending-undo-list
2316 (listp pending-undo-list)
2317 (not (car pending-undo-list)))
2318 (pop pending-undo-list))
2320 (org-goto-line line)
2321 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2323 (defun org-verify-change-for-undo (l1 l2)
2324 "Verify that a real change occurred between the undo lists L1 and L2."
2325 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2326 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2331 (defvar org-agenda-restrict nil)
2332 (defvar org-agenda-restrict-begin (make-marker))
2333 (defvar org-agenda-restrict-end (make-marker))
2334 (defvar org-agenda-last-dispatch-buffer nil)
2335 (defvar org-agenda-overriding-restriction nil)
2337 (defcustom org-agenda-custom-commands-contexts nil
2338 "Alist of custom agenda keys and contextual rules.
2340 For example, if you have a custom agenda command \"p\" and you
2341 want this command to be accessible only from plain text files,
2344 '((\"p\" (in-file . \"\\.txt\")))
2346 Here are the available contexts definitions:
2348 in-file: command displayed only in matching files
2349 in-mode: command displayed only in matching modes
2350 not-in-file: command not displayed in matching files
2351 not-in-mode: command not displayed in matching modes
2352 [function]: a custom function taking no argument
2354 If you define several checks, the agenda command will be
2355 accessible if there is at least one valid check.
2357 You can also bind a key to another agenda custom command
2358 depending on contextual rules.
2360 '((\"p\" \"q\" (in-file . \"\\.txt\")))
2362 Here it means: in .txt files, use \"p\" as the key for the
2363 agenda command otherwise associated with \"q\". (The command
2364 originally associated with \"q\" is not displayed to avoid
2367 :group 'org-agenda-custom-commands
2368 :type '(repeat (list :tag "Rule"
2369 (string :tag " Agenda key")
2370 (string :tag "Replace by command")
2371 (repeat :tag "Available when"
2373 (cons :tag "Condition"
2375 (const :tag "In file" in-file)
2376 (const :tag "Not in file" not-in-file)
2377 (const :tag "In mode" in-mode)
2378 (const :tag "Not in mode" not-in-mode))
2380 (function :tag "Custom function"))))))
2383 (defun org-agenda (&optional arg keys restriction)
2384 "Dispatch agenda commands to collect entries to the agenda buffer.
2385 Prompts for a command to execute. Any prefix arg will be passed
2386 on to the selected command. The default selections are:
2388 a Call `org-agenda-list' to display the agenda for current day or week.
2389 t Call `org-todo-list' to display the global todo list.
2390 T Call `org-todo-list' to display the global todo list, select only
2391 entries with a specific TODO keyword (the user gets a prompt).
2392 m Call `org-tags-view' to display headlines with tags matching
2393 a condition (the user is prompted for the condition).
2394 M Like `m', but select only TODO entries, no ordinary headlines.
2395 L Create a timeline for the current buffer.
2396 e Export views to associated files.
2397 s Search entries for keywords.
2398 / Multi occur across all agenda files and also files listed
2399 in `org-agenda-text-search-extra-files'.
2400 < Restrict agenda commands to buffer, subtree, or region.
2401 Press several times to get the desired effect.
2402 > Remove a previous restriction.
2403 # List \"stuck\" projects.
2404 ! Configure what \"stuck\" means.
2405 C Configure custom agenda commands.
2407 More commands can be added by configuring the variable
2408 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2409 searches can be pre-defined in this way.
2411 If the current buffer is in Org-mode and visiting a file, you can also
2412 first press `<' once to indicate that the agenda should be temporarily
2413 \(until the next use of \\[org-agenda]) restricted to the current file.
2414 Pressing `<' twice means to restrict to the current subtree or region
2418 (let* ((prefix-descriptions nil)
2419 (org-agenda-buffer-name org-agenda-buffer-name)
2420 (org-agenda-window-setup (if (equal (buffer-name)
2421 org-agenda-buffer-name)
2423 org-agenda-window-setup))
2424 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2425 (org-agenda-custom-commands
2426 ;; normalize different versions
2430 (cond ((stringp (cdr x))
2431 (push x prefix-descriptions)
2433 ((stringp (nth 1 x)) x)
2434 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2435 (t (cons (car x) (cons "" (cdr x))))))
2436 org-agenda-custom-commands)))
2437 (org-agenda-custom-commands
2438 (org-contextualize-keys
2439 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2440 (buf (current-buffer))
2441 (bfn (buffer-file-name (buffer-base-buffer)))
2442 entry key type match lprops ans)
2443 ;; Turn off restriction unless there is an overriding one,
2444 (unless org-agenda-overriding-restriction
2445 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2446 ;; There is a request to keep the file list in place
2447 (put 'org-agenda-files 'org-restrict nil))
2448 (setq org-agenda-restrict nil)
2449 (move-marker org-agenda-restrict-begin nil)
2450 (move-marker org-agenda-restrict-end nil))
2451 ;; Delete old local properties
2452 (put 'org-agenda-redo-command 'org-lprops nil)
2453 ;; Delete previously set last-arguments
2454 (put 'org-agenda-redo-command 'last-args nil)
2455 ;; Remember where this call originated
2456 (setq org-agenda-last-dispatch-buffer (current-buffer))
2458 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2460 restriction (cdr ans)))
2461 ;; If we have sticky agenda buffers, set a name for the buffer,
2462 ;; depending on the invoking keys. The user may still set this
2463 ;; as a command option, which will overwrite what we do here.
2464 (if org-agenda-sticky
2465 (setq org-agenda-buffer-name (format "*Org Agenda(%s)*" keys)))
2466 ;; Establish the restriction, if any
2467 (when (and (not org-agenda-overriding-restriction) restriction)
2468 (put 'org-agenda-files 'org-restrict (list bfn))
2470 ((eq restriction 'region)
2471 (setq org-agenda-restrict t)
2472 (move-marker org-agenda-restrict-begin (region-beginning))
2473 (move-marker org-agenda-restrict-end (region-end)))
2474 ((eq restriction 'subtree)
2476 (setq org-agenda-restrict t)
2477 (org-back-to-heading t)
2478 (move-marker org-agenda-restrict-begin (point))
2479 (move-marker org-agenda-restrict-end
2480 (progn (org-end-of-subtree t)))))))
2482 ;; For example the todo list should not need it (but does...)
2484 ((setq entry (assoc keys org-agenda-custom-commands))
2485 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2487 (setq type (nth 2 entry) match (eval (nth 3 entry))
2488 lprops (nth 4 entry))
2489 (put 'org-agenda-redo-command 'org-lprops lprops)
2492 (org-let lprops '(org-agenda-list current-prefix-arg)))
2494 (org-let lprops '(org-todo-list current-prefix-arg)))
2496 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2498 (org-let lprops '(org-agenda-list-stuck-projects
2499 current-prefix-arg)))
2501 (org-let lprops '(org-tags-view current-prefix-arg match)))
2502 ((eq type 'tags-todo)
2503 (org-let lprops '(org-tags-view '(4) match)))
2505 (org-let lprops '(org-todo-list match)))
2506 ((eq type 'tags-tree)
2507 (org-check-for-org-mode)
2508 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2509 ((eq type 'todo-tree)
2510 (org-check-for-org-mode)
2512 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2513 (regexp-quote match) "\\>"))))
2514 ((eq type 'occur-tree)
2515 (org-check-for-org-mode)
2516 (org-let lprops '(org-occur match)))
2518 (org-let lprops '(funcall type match)))
2520 (org-let lprops '(funcall type match)))
2521 (t (error "Invalid custom agenda command type %s" type))))
2522 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2524 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2525 (customize-variable 'org-agenda-custom-commands))
2526 ((equal keys "a") (call-interactively 'org-agenda-list))
2527 ((equal keys "s") (call-interactively 'org-search-view))
2528 ((equal keys "t") (call-interactively 'org-todo-list))
2529 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2530 ((equal keys "m") (call-interactively 'org-tags-view))
2531 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2532 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2533 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2537 (unless (current-message)
2538 (let* ((m (org-agenda-get-any-marker))
2539 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2542 "FLAGGING-NOTE ([?] for more info): "
2544 (replace-regexp-in-string
2546 (copy-sequence note))
2547 nil 'face 'org-warning)))))))
2550 (unless (derived-mode-p 'org-mode)
2551 (error "This is not an Org-mode file"))
2553 (put 'org-agenda-files 'org-restrict (list bfn))
2554 (org-call-with-arg 'org-timeline arg)))
2555 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2556 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2557 ((equal keys "!") (customize-variable 'org-stuck-projects))
2558 (t (error "Invalid agenda key"))))))
2560 (defun org-agenda-append-agenda ()
2561 "Append another agenda view to the current one.
2562 This function allows interactive building of block agendas.
2563 Agenda views are separated by `org-agenda-block-separator'."
2565 (unless (string= (buffer-name) org-agenda-buffer-name)
2566 (error "Can only append from within agenda buffer"))
2567 (let ((org-agenda-multi t))
2571 (defun org-agenda-normalize-custom-commands (cmds)
2575 (cond ((stringp (cdr x)) nil)
2576 ((stringp (nth 1 x)) x)
2577 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2578 (t (cons (car x) (cons "" (cdr x))))))
2581 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2582 "The user interface for selecting an agenda command."
2584 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2585 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2586 (region-p (org-region-active-p))
2587 (custom org-agenda-custom-commands)
2589 restriction second-time
2590 c entry key type match prefixes rmheader header-end custom1 desc
2591 line lines left right n n1)
2592 (save-window-excursion
2593 (delete-other-windows)
2594 (org-switch-to-buffer-other-window " *Agenda Commands*")
2596 (insert (eval-when-compile
2598 "Press key for an agenda command: < Buffer, subtree/region restriction
2599 -------------------------------- > Remove restriction
2600 a Agenda for current week or day e Export agenda views
2601 t List of all TODO entries T Entries with special TODO kwd
2602 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2603 L Timeline for current buffer # List stuck projects (!=configure)
2604 s Search for keywords * Toggle sticky agenda views
2605 / Multi-occur ? Find :FLAGGED: entries
2606 C Configure custom agenda commands
2609 (while (string-match
2610 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2612 (setq start (match-end 0))
2613 (add-text-properties (match-beginning 2) (match-end 2)
2614 '(face bold) header))
2616 (setq header-end (move-marker (make-marker) (point)))
2618 (setq custom1 custom)
2619 (when (eq rmheader t)
2621 (re-search-forward ":" nil t)
2622 (delete-region (match-end 0) (point-at-eol))
2625 (delete-region (match-end 0) (point-at-eol))
2626 (move-marker header-end (match-end 0)))
2627 (goto-char header-end)
2628 (delete-region (point) (point-max))
2630 ;; Produce all the lines that describe custom commands and prefixes
2632 (while (setq entry (pop custom1))
2633 (setq key (car entry) desc (nth 1 entry)
2635 match (nth 3 entry))
2636 (if (> (length key) 1)
2637 (add-to-list 'prefixes (string-to-char key))
2641 (org-add-props (copy-sequence key)
2644 ((string-match "\\S-" desc) desc)
2645 ((eq type 'agenda) "Agenda for current week or day")
2646 ((eq type 'alltodo) "List of all TODO entries")
2647 ((eq type 'search) "Word search")
2648 ((eq type 'stuck) "List of stuck projects")
2649 ((eq type 'todo) "TODO keyword")
2650 ((eq type 'tags) "Tags query")
2651 ((eq type 'tags-todo) "Tags (TODO)")
2652 ((eq type 'tags-tree) "Tags tree")
2653 ((eq type 'todo-tree) "TODO kwd tree")
2654 ((eq type 'occur-tree) "Occur tree")
2655 ((functionp type) (if (symbolp type)
2657 "Lambda expression"))
2659 (if org-agenda-menu-show-matcher
2664 (setq match (copy-sequence match))
2665 (org-add-props match nil 'face 'org-warning))
2667 (format "set of %d commands" (length match)))
2669 (if (org-string-nw-p match)
2670 (add-text-properties
2671 0 (length line) (list 'help-echo
2672 (concat "Matcher: "match)) line)))
2674 (setq lines (nreverse lines))
2679 (org-add-props (char-to-string x)
2681 (or (cdr (assoc (concat selstring
2683 prefix-descriptions))
2688 ;; Check if we should display in two columns
2689 (if org-agenda-menu-two-columns
2691 (setq n (length lines)
2692 n1 (+ (/ n 2) (mod n 2))
2693 right (nthcdr n1 lines)
2694 left (copy-sequence lines))
2695 (setcdr (nthcdr (1- n1) left) nil))
2696 (setq left lines right nil))
2698 (insert "\n" (pop left))
2700 (if (< (current-column) 40)
2701 (move-to-column 40 t)
2703 (insert (pop right))))
2705 ;; Make the window the right size
2706 (goto-char (point-min))
2708 (if (not (pos-visible-in-window-p (point-max)))
2709 (org-fit-window-to-buffer))
2710 (setq second-time t)
2711 (org-fit-window-to-buffer))
2713 ;; Ask for selection
2714 (message "Press key for agenda command%s:"
2715 (if (or restrict-ok org-agenda-overriding-restriction)
2716 (if org-agenda-overriding-restriction
2717 " (restriction lock active)"
2719 (format " (restricted to %s)" restriction)
2722 (setq c (read-char-exclusive))
2725 ((assoc (char-to-string c) custom)
2726 (setq selstring (concat selstring (char-to-string c)))
2727 (throw 'exit (cons selstring restriction)))
2729 (setq selstring (concat selstring (char-to-string c))
2731 rmheader (or rmheader t)
2732 custom (delq nil (mapcar
2734 (if (or (= (length (car x)) 1)
2735 (/= (string-to-char (car x)) c))
2737 (cons (substring (car x) 1) (cdr x))))
2740 (call-interactively 'org-toggle-sticky-agenda)
2742 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2743 (message "Restriction is only possible in Org-mode buffers")
2746 (org-agenda-remove-restriction-lock 'noupdate)
2747 (setq restriction 'buffer))
2749 (org-agenda-remove-restriction-lock 'noupdate)
2750 (setq restriction (if region-p 'region 'subtree)))
2752 (org-agenda-remove-restriction-lock 'noupdate)
2755 ((eq restriction 'buffer)
2756 (if region-p 'region 'subtree))
2757 ((memq restriction '(subtree region))
2761 (org-agenda-remove-restriction-lock 'noupdate)
2762 (setq restriction nil))
2763 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2764 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2765 ((and (> (length selstring) 0) (eq c ?\d))
2767 (org-agenda-get-restriction-and-command prefix-descriptions))
2769 ((equal c ?q) (error "Abort"))
2770 (t (error "Invalid key %c" c))))))))
2772 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2773 (defvar org-agenda-last-arguments nil
2774 "The arguments of the previous call to `org-agenda'.")
2775 (defun org-agenda-run-series (name series)
2776 (org-let (nth 1 series) '(org-prepare-agenda name))
2777 ;; We need to reset agenda markers here, because when constructing a
2778 ;; block agenda, the individual blocks do not do that.
2779 (org-agenda-reset-markers)
2780 (let* ((org-agenda-multi t)
2781 (redo (list 'org-agenda-run-series name (list 'quote series)))
2782 (org-agenda-overriding-arguments
2783 (or org-agenda-overriding-arguments
2784 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2785 (get 'org-agenda-redo-command 'last-args))))
2787 (gprops (nth 1 series))
2788 match ;; The byte compiler incorrectly complains about this. Keep it!
2790 (while (setq cmd (pop cmds))
2791 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2794 (org-let2 gprops lprops
2795 '(call-interactively 'org-agenda-list)))
2797 (org-let2 gprops lprops
2798 '(call-interactively 'org-todo-list)))
2800 (org-let2 gprops lprops
2801 '(org-search-view current-prefix-arg match nil)))
2803 (org-let2 gprops lprops
2804 '(call-interactively 'org-agenda-list-stuck-projects)))
2806 (org-let2 gprops lprops
2807 '(org-tags-view current-prefix-arg match)))
2808 ((eq type 'tags-todo)
2809 (org-let2 gprops lprops
2810 '(org-tags-view '(4) match)))
2812 (org-let2 gprops lprops
2813 '(org-todo-list match)))
2815 (org-let2 gprops lprops
2816 '(funcall type match)))
2817 (t (error "Invalid type in command series"))))
2819 (setq org-agenda-redo-command redo)
2820 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2821 (goto-char (point-min)))
2822 (org-fit-agenda-window)
2823 (org-let (nth 1 series) '(org-finalize-agenda)))
2826 (defmacro org-batch-agenda (cmd-key &rest parameters)
2827 "Run an agenda command in batch mode and send the result to STDOUT.
2828 If CMD-KEY is a string of length 1, it is used as a key in
2829 `org-agenda-custom-commands' and triggers this command. If it is a
2830 longer string it is used as a tags/todo match string.
2831 Parameters are alternating variable names and values that will be bound
2832 before running the agenda command."
2833 (org-eval-in-environment (org-make-parameter-alist parameters)
2834 (if (> (length cmd-key) 2)
2835 (org-tags-view nil cmd-key)
2836 (org-agenda nil cmd-key)))
2837 (set-buffer org-agenda-buffer-name)
2838 (princ (buffer-string)))
2839 (def-edebug-spec org-batch-agenda (form &rest sexp))
2841 (defvar org-agenda-info nil)
2844 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2845 "Run an agenda command in batch mode and send the result to STDOUT.
2846 If CMD-KEY is a string of length 1, it is used as a key in
2847 `org-agenda-custom-commands' and triggers this command. If it is a
2848 longer string it is used as a tags/todo match string.
2849 Parameters are alternating variable names and values that will be bound
2850 before running the agenda command.
2852 The output gives a line for each selected agenda item. Each
2853 item is a list of comma-separated values, like this:
2855 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2857 category The category of the item
2858 head The headline, without TODO kwd, TAGS and PRIORITY
2859 type The type of the agenda entry, can be
2860 todo selected in TODO match
2861 tagsmatch selected in tags match
2862 diary imported from diary
2863 deadline a deadline on given date
2864 scheduled scheduled on given date
2865 timestamp entry has timestamp on given date
2866 closed entry was closed on given date
2867 upcoming-deadline warning about deadline
2868 past-scheduled forwarded scheduled item
2869 block entry has date block including g. date
2870 todo The todo keyword, if any
2871 tags All tags including inherited ones, separated by colons
2872 date The relevant date, like 2007-2-14
2873 time The time, like 15:00-16:50
2874 extra Sting with extra planning info
2875 priority-l The priority letter if any was given
2876 priority-n The computed numerical priority
2877 agenda-day The day in the agenda where this is listed"
2878 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2879 (org-make-parameter-alist parameters))
2880 (if (> (length cmd-key) 2)
2881 (org-tags-view nil cmd-key)
2882 (org-agenda nil cmd-key)))
2883 (set-buffer org-agenda-buffer-name)
2884 (let* ((lines (org-split-string (buffer-string) "\n"))
2886 (while (setq line (pop lines))
2888 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2889 (setq org-agenda-info
2890 (org-fix-agenda-info (text-properties-at 0 line)))
2892 (mapconcat 'org-agenda-export-csv-mapper
2893 '(org-category txt type todo tags date time extra
2894 priority-letter priority agenda-day)
2897 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2899 (defun org-fix-agenda-info (props)
2900 "Make sure all properties on an agenda item have a canonical form.
2901 This ensures the export commands can easily use it."
2903 (when (setq tmp (plist-get props 'tags))
2904 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2905 (when (setq tmp (plist-get props 'date))
2906 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2907 (let ((calendar-date-display-form '(year "-" month "-" day)))
2908 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2910 (setq tmp (calendar-date-string tmp)))
2911 (setq props (plist-put props 'date tmp)))
2912 (when (setq tmp (plist-get props 'day))
2913 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2914 (let ((calendar-date-display-form '(year "-" month "-" day)))
2915 (setq tmp (calendar-date-string tmp)))
2916 (setq props (plist-put props 'day tmp))
2917 (setq props (plist-put props 'agenda-day tmp)))
2918 (when (setq tmp (plist-get props 'txt))
2919 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2920 (plist-put props 'priority-letter (match-string 1 tmp))
2921 (setq tmp (replace-match "" t t tmp)))
2922 (when (and (setq re (plist-get props 'org-todo-regexp))
2923 (setq re (concat "\\`\\.*" re " ?"))
2924 (string-match re tmp))
2925 (plist-put props 'todo (match-string 1 tmp))
2926 (setq tmp (replace-match "" t t tmp)))
2927 (plist-put props 'txt tmp)))
2930 (defun org-agenda-export-csv-mapper (prop)
2931 (let ((res (plist-get org-agenda-info prop)))
2936 (t (prin1-to-string res))))
2937 (while (string-match "," res)
2938 (setq res (replace-match ";" t t res)))
2942 (defun org-store-agenda-views (&rest parameters)
2944 (eval (list 'org-batch-store-agenda-views)))
2947 (defmacro org-batch-store-agenda-views (&rest parameters)
2948 "Run all custom agenda commands that have a file argument."
2949 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2951 (dir default-directory)
2952 (pars (org-make-parameter-alist parameters))
2953 cmd thiscmdkey files opts cmd-or-set bufname)
2954 (save-window-excursion
2956 (setq cmd (pop cmds)
2957 thiscmdkey (car cmd)
2958 bufname (if org-agenda-sticky (format "*Org Agenda(%s)*" thiscmdkey)
2959 org-agenda-buffer-name)
2960 cmd-or-set (nth 2 cmd)
2961 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2962 files (nth (if (listp cmd-or-set) 4 5) cmd))
2963 (if (stringp files) (setq files (list files)))
2965 (org-eval-in-environment (append org-agenda-exporter-settings
2967 (org-agenda nil thiscmdkey))
2968 (set-buffer bufname)
2970 (org-eval-in-environment (append org-agenda-exporter-settings
2972 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
2973 (and (get-buffer bufname)
2974 (kill-buffer bufname)))))))
2975 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2977 (defun org-agenda-mark-header-line (pos)
2978 "Mark the line at POS as an agenda structure header."
2981 (put-text-property (point-at-bol) (point-at-eol)
2982 'org-agenda-structural-header t)
2983 (when org-agenda-title-append
2984 (put-text-property (point-at-bol) (point-at-eol)
2985 'org-agenda-title-append org-agenda-title-append))))
2987 (defvar org-mobile-creating-agendas)
2988 (defvar org-agenda-write-buffer-name "Agenda View")
2989 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
2990 "Write the current buffer (an agenda view) as a file.
2991 Depending on the extension of the file name, plain text (.txt),
2992 HTML (.html or .htm) or Postscript (.ps) is produced.
2993 If the extension is .ics, run icalendar export over all files used
2994 to construct the agenda and limit the export to entries listed in the
2996 With prefix argument OPEN, open the new file immediately.
2997 If NOSETTINGS is given, do not scope the settings of
2998 `org-agenda-exporter-settings' into the export commands. This is used when
2999 the settings have already been scoped and we do not wish to overrule other,
3000 higher priority settings.
3001 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3002 (interactive "FWrite agenda to file: \nP")
3003 (if (not (file-writable-p file))
3004 (error "Cannot write agenda to file %s" file))
3005 (org-let (if nosettings nil org-agenda-exporter-settings)
3007 (save-window-excursion
3008 (org-agenda-mark-filtered-text)
3009 (let ((bs (copy-sequence (buffer-string))) beg)
3010 (org-agenda-unmark-filtered-text)
3012 (rename-buffer org-agenda-write-buffer-name t)
3013 (set-buffer-modified-p nil)
3015 (org-agenda-remove-marked-text 'org-filtered)
3016 (while (setq beg (text-property-any (point-min) (point-max)
3019 beg (or (next-single-property-change beg 'org-filtered)
3021 (run-hooks 'org-agenda-before-write-hook)
3023 ((org-bound-and-true-p org-mobile-creating-agendas)
3024 (org-mobile-write-agenda-for-mobile file))
3025 ((string-match "\\.html?\\'" file)
3027 (set-buffer (htmlize-buffer (current-buffer)))
3028 (when (and org-agenda-export-html-style
3029 (string-match "<style>" org-agenda-export-html-style))
3030 ;; replace <style> section with org-agenda-export-html-style
3031 (goto-char (point-min))
3032 (kill-region (- (search-forward "<style") 6)
3033 (search-forward "</style>"))
3034 (insert org-agenda-export-html-style))
3036 (kill-buffer (current-buffer))
3037 (message "HTML written to %s" file))
3038 ((string-match "\\.ps\\'" file)
3040 (ps-print-buffer-with-faces file)
3041 (message "Postscript written to %s" file))
3042 ((string-match "\\.pdf\\'" file)
3044 (ps-print-buffer-with-faces
3045 (concat (file-name-sans-extension file) ".ps"))
3046 (call-process "ps2pdf" nil nil nil
3048 (concat (file-name-sans-extension file) ".ps"))
3049 (expand-file-name file))
3050 (delete-file (concat (file-name-sans-extension file) ".ps"))
3051 (message "PDF written to %s" file))
3052 ((string-match "\\.ics\\'" file)
3053 (require 'org-icalendar)
3054 (let ((org-agenda-marker-table
3055 (org-create-marker-find-array
3056 (org-agenda-collect-markers)))
3057 (org-icalendar-verify-function 'org-check-agenda-marker-table)
3058 (org-combined-agenda-icalendar-file file))
3059 (apply 'org-export-icalendar 'combine
3060 (org-agenda-files nil 'ifmode))))
3062 (let ((bs (buffer-string)))
3067 (kill-buffer (current-buffer))
3068 (message "Plain text written to %s" file))))))))
3069 (set-buffer (or agenda-bufname
3070 (and (called-interactively-p 'any) (buffer-name))
3071 org-agenda-buffer-name)))
3072 (when open (org-open-file file)))
3074 (defvar org-agenda-tag-filter-overlays nil)
3075 (defvar org-agenda-cat-filter-overlays nil)
3077 (defun org-agenda-mark-filtered-text ()
3078 "Mark all text hidden by filtering with a text property."
3079 (let ((inhibit-read-only t))
3082 (when (equal (overlay-buffer o) (current-buffer))
3084 (overlay-start o) (overlay-end o)
3086 (append org-agenda-tag-filter-overlays
3087 org-agenda-cat-filter-overlays))))
3089 (defun org-agenda-unmark-filtered-text ()
3090 "Remove the filtering text property."
3091 (let ((inhibit-read-only t))
3092 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3094 (defun org-agenda-remove-marked-text (property &optional value)
3095 "Delete all text marked with VALUE of PROPERTY.
3096 VALUE defaults to t."
3098 (setq value (or value t))
3099 (while (setq beg (text-property-any (point-min) (point-max)
3102 beg (or (next-single-property-change beg 'org-filtered)
3105 (defun org-agenda-add-entry-text ()
3106 "Add entry text to agenda lines.
3107 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3108 entry text following headings shown in the agenda.
3109 Drawers will be excluded, also the line with scheduling/deadline info."
3110 (when (and (> org-agenda-add-entry-text-maxlines 0)
3111 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3113 (goto-char (point-min))
3115 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3116 (beginning-of-line 2)
3117 (setq txt (org-agenda-get-some-entry-text
3118 m org-agenda-add-entry-text-maxlines " > "))
3120 (if (string-match "\\S-" txt)
3122 (or (eobp) (forward-char 1))))))))
3124 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3126 "Extract entry text from MARKER, at most N-LINES lines.
3127 This will ignore drawers etc, just get the text.
3128 If INDENT is given, prefix every line with this string. If KEEP is
3129 given, it is a list of symbols, defining stuff that should not be
3130 removed from the entry content. Currently only `planning' is allowed here."
3131 (let (txt drawer-re kwd-time-re ind)
3133 (with-current-buffer (marker-buffer marker)
3134 (if (not (derived-mode-p 'org-mode))
3141 (setq txt (buffer-substring
3142 (min (1+ (point)) (point-max))
3143 (progn (outline-next-heading) (point)))
3144 drawer-re org-drawer-regexp
3145 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3149 (when org-agenda-add-entry-text-descriptive-links
3150 (goto-char (point-min))
3151 (while (org-activate-bracket-links (point-max))
3152 (add-text-properties (match-beginning 0) (match-end 0)
3154 (goto-char (point-min))
3155 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3156 (set-text-properties (match-beginning 0) (match-end 0)
3158 (goto-char (point-min))
3159 (while (re-search-forward drawer-re nil t)
3162 (progn (re-search-forward
3163 "^[ \t]*:END:.*\n?" nil 'move)
3165 (unless (member 'planning keep)
3166 (goto-char (point-min))
3167 (while (re-search-forward kwd-time-re nil t)
3168 (replace-match "")))
3169 (goto-char (point-min))
3170 (when org-agenda-entry-text-exclude-regexps
3171 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3172 (while (setq re (pop re-list))
3173 (goto-char (point-min))
3174 (while (re-search-forward re nil t)
3175 (replace-match "")))))
3176 (goto-char (point-max))
3177 (skip-chars-backward " \t\n")
3178 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3180 ;; find and remove min common indentation
3181 (goto-char (point-min))
3182 (untabify (point-min) (point-max))
3183 (setq ind (org-get-indentation))
3185 (unless (looking-at "[ \t]*$")
3186 (setq ind (min ind (org-get-indentation))))
3187 (beginning-of-line 2))
3188 (goto-char (point-min))
3190 (unless (looking-at "[ \t]*$")
3191 (move-to-column ind)
3192 (delete-region (point-at-bol) (point)))
3193 (beginning-of-line 2))
3195 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3197 (goto-char (point-min))
3199 (while (and (not (eobp)) (re-search-forward "^" nil t))
3200 (replace-match indent t t)))
3201 (goto-char (point-min))
3202 (while (looking-at "[ \t]*\n") (replace-match ""))
3203 (goto-char (point-max))
3204 (when (> (org-current-line)
3206 (org-goto-line (1+ n-lines))
3208 (setq txt (buffer-substring (point-min) (point)))))))))
3211 (defun org-agenda-collect-markers ()
3212 "Collect the markers pointing to entries in the agenda buffer."
3215 (goto-char (point-min))
3217 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3218 (org-get-at-bol 'org-marker)))
3220 (beginning-of-line 2)))
3221 (nreverse markers)))
3223 (defun org-create-marker-find-array (marker-list)
3224 "Create a alist of files names with all marker positions in that file."
3226 (while (setq m (pop marker-list))
3227 (setq p (marker-position m)
3228 f (buffer-file-name (or (buffer-base-buffer
3230 (marker-buffer m))))
3231 (if (setq a (assoc f tbl))
3232 (push (marker-position m) (cdr a))
3233 (push (list f p) tbl)))
3234 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3237 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3238 (defun org-check-agenda-marker-table ()
3239 "Check of the current entry is on the marker list."
3240 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3242 (and (setq a (assoc file org-agenda-marker-table))
3245 (org-back-to-heading t)
3246 (member (point) (cdr a)))))))
3248 (defun org-check-for-org-mode ()
3249 "Make sure current buffer is in org-mode. Error if not."
3250 (or (derived-mode-p 'org-mode)
3251 (error "Cannot execute org-mode agenda command on buffer in %s"
3254 (defun org-fit-agenda-window ()
3255 "Fit the window to the buffer size."
3256 (and (memq org-agenda-window-setup '(reorganize-frame))
3257 (fboundp 'fit-window-to-buffer)
3258 (org-fit-window-to-buffer
3260 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3261 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3263 ;;; Agenda prepare and finalize
3265 (defvar org-agenda-multi nil) ; dynamically scoped
3266 (defvar org-agenda-buffer-name "*Org Agenda*")
3267 (defvar org-pre-agenda-window-conf nil)
3268 (defvar org-agenda-columns-active nil)
3269 (defvar org-agenda-name nil)
3270 (defvar org-agenda-tag-filter nil)
3271 (defvar org-agenda-category-filter nil)
3272 (defvar org-agenda-top-category-filter nil)
3273 (defvar org-agenda-tag-filter-while-redo nil)
3274 (defvar org-agenda-tag-filter-preset nil
3275 "A preset of the tags filter used for secondary agenda filtering.
3276 This must be a list of strings, each string must be a single tag preceded
3278 This variable should not be set directly, but agenda custom commands can
3279 bind it in the options section. The preset filter is a global property of
3280 the entire agenda view. In a block agenda, it will not work reliably to
3281 define a filter for one of the individual blocks. You need to set it in
3282 the global options and expect it to be applied to the entire view.")
3284 (defvar org-agenda-category-filter-preset nil
3285 "A preset of the category filter used for secondary agenda filtering.
3286 This must be a list of strings, each string must be a single category
3287 preceded by \"+\" or \"-\".
3288 This variable should not be set directly, but agenda custom commands can
3289 bind it in the options section. The preset filter is a global property of
3290 the entire agenda view. In a block agenda, it will not work reliably to
3291 define a filter for one of the individual blocks. You need to set it in
3292 the global options and expect it to be applied to the entire view.")
3295 (defun org-agenda-use-sticky-p ()
3296 "Return non-nil if an agenda buffer named
3297 `org-agenda-buffer-name' exists and should be shown instead of
3298 generating a new one."
3300 ;; turned off by user
3302 ;; For multi-agenda buffer already exists
3303 (not org-agenda-multi)
3305 (get-buffer org-agenda-buffer-name)
3306 ;; C-u parameter is same as last call
3307 (with-current-buffer (get-buffer org-agenda-buffer-name)
3309 (equal current-prefix-arg
3310 org-agenda-last-prefix-arg)
3311 ;; In case user turned stickiness on, while having existing
3312 ;; Agenda buffer active, don't reuse that buffer, because it
3313 ;; does not have org variables local
3314 org-agenda-this-buffer-is-sticky))))
3316 (defun org-prepare-agenda-window (abuf)
3317 "Setup agenda buffer in the window."
3318 (let* ((awin (get-buffer-window abuf))
3321 ((equal (current-buffer) abuf) nil)
3322 (awin (select-window awin))
3323 ((not (setq wconf (current-window-configuration))))
3324 ((equal org-agenda-window-setup 'current-window)
3325 (org-pop-to-buffer-same-window abuf))
3326 ((equal org-agenda-window-setup 'other-window)
3327 (org-switch-to-buffer-other-window abuf))
3328 ((equal org-agenda-window-setup 'other-frame)
3329 (switch-to-buffer-other-frame abuf))
3330 ((equal org-agenda-window-setup 'reorganize-frame)
3331 (delete-other-windows)
3332 (org-switch-to-buffer-other-window abuf)))
3333 ;; additional test in case agenda is invoked from within agenda
3334 ;; buffer via elisp link
3335 (unless (equal (current-buffer) abuf)
3336 (org-pop-to-buffer-same-window abuf))
3337 (setq org-pre-agenda-window-conf
3338 (or org-pre-agenda-window-conf wconf))))
3340 (defun org-prepare-agenda (&optional name)
3341 (if (org-agenda-use-sticky-p)
3343 ;; Popup existing buffer
3344 (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
3345 (message "Sticky Agenda buffer, use `r' to refresh")
3347 (setq org-todo-keywords-for-agenda nil)
3348 (setq org-drawers-for-agenda nil)
3349 (unless org-agenda-persistent-filter
3350 (setq org-agenda-tag-filter nil
3351 org-agenda-category-filter nil))
3352 (put 'org-agenda-tag-filter :preset-filter
3353 org-agenda-tag-filter-preset)
3354 (put 'org-agenda-category-filter :preset-filter
3355 org-agenda-category-filter-preset)
3356 (if org-agenda-multi
3358 (setq buffer-read-only nil)
3359 (goto-char (point-max))
3360 (unless (or (bobp) org-agenda-compact-blocks
3361 (not org-agenda-block-separator))
3363 (if (stringp org-agenda-block-separator)
3364 org-agenda-block-separator
3365 (make-string (window-width) org-agenda-block-separator))
3367 (narrow-to-region (point) (point-max)))
3368 (setq org-done-keywords-for-agenda nil)
3370 ;; Setting any org variables that are in org-agenda-local-vars
3371 ;; list need to be done after the prepare call
3372 (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
3373 (setq buffer-read-only nil)
3374 (org-agenda-reset-markers)
3375 (let ((inhibit-read-only t)) (erase-buffer))
3377 (setq org-agenda-buffer (current-buffer))
3378 (setq org-agenda-contributing-files nil)
3379 (setq org-agenda-columns-active nil)
3380 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3381 (setq org-todo-keywords-for-agenda
3382 (org-uniquify org-todo-keywords-for-agenda))
3383 (setq org-done-keywords-for-agenda
3384 (org-uniquify org-done-keywords-for-agenda))
3385 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3386 (setq org-agenda-last-prefix-arg current-prefix-arg)
3387 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3388 (and name (not org-agenda-name)
3389 (org-set-local 'org-agenda-name name)))
3390 (setq buffer-read-only nil)))
3392 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3393 (defun org-finalize-agenda ()
3394 "Finishing touch for the agenda buffer, called just before displaying it."
3395 (unless org-agenda-multi
3397 (let ((inhibit-read-only t))
3398 (goto-char (point-min))
3399 (while (org-activate-bracket-links (point-max))
3400 (add-text-properties (match-beginning 0) (match-end 0)
3402 (org-agenda-align-tags)
3403 (unless org-agenda-with-colors
3404 (remove-text-properties (point-min) (point-max) '(face nil))))
3405 (if (and (boundp 'org-agenda-overriding-columns-format)
3406 org-agenda-overriding-columns-format)
3407 (org-set-local 'org-agenda-overriding-columns-format
3408 org-agenda-overriding-columns-format))
3409 (if (and (boundp 'org-agenda-view-columns-initially)
3410 org-agenda-view-columns-initially)
3411 (org-agenda-columns))
3412 (when org-agenda-fontify-priorities
3413 (org-agenda-fontify-priorities))
3414 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3415 (org-agenda-dim-blocked-tasks))
3416 (org-agenda-mark-clocking-task)
3417 (when org-agenda-entry-text-mode
3418 (org-agenda-entry-text-hide)
3419 (org-agenda-entry-text-show))
3420 (if (functionp 'org-habit-insert-consistency-graphs)
3421 (org-habit-insert-consistency-graphs))
3422 (run-hooks 'org-finalize-agenda-hook)
3423 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3424 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3425 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3426 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3427 (org-agenda-filter-apply org-agenda-category-filter 'category))
3428 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3431 (defun org-agenda-mark-clocking-task ()
3432 "Mark the current clock entry in the agenda if it is present."
3434 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3435 (delete-overlay o)))
3436 (overlays-in (point-min) (point-max)))
3437 (when (marker-buffer org-clock-hd-marker)
3439 (goto-char (point-min))
3441 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3443 (when (equal (org-get-at-bol 'org-hd-marker)
3444 org-clock-hd-marker)
3445 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3446 (overlay-put ov 'type 'org-agenda-clocking)
3447 (overlay-put ov 'face 'org-agenda-clocking)
3448 (overlay-put ov 'help-echo
3449 "The clock is running in this item")))))))
3451 (defun org-agenda-fontify-priorities ()
3452 "Make highest priority lines bold, and lowest italic."
3454 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3455 (delete-overlay o)))
3456 (overlays-in (point-min) (point-max)))
3458 (let ((inhibit-read-only t)
3460 (goto-char (point-min))
3461 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3462 (setq h (or (get-char-property (point) 'org-highest-priority)
3463 org-highest-priority)
3464 l (or (get-char-property (point) 'org-lowest-priority)
3465 org-lowest-priority)
3466 p (string-to-char (match-string 1))
3467 b (match-beginning 0)
3468 e (if (eq org-agenda-fontify-priorities 'cookies)
3471 ov (make-overlay b e))
3474 (cond ((org-face-from-face-or-color
3476 (cdr (assoc p org-priority-faces))))
3477 ((and (listp org-agenda-fontify-priorities)
3478 (org-face-from-face-or-color
3480 (cdr (assoc p org-agenda-fontify-priorities)))))
3481 ((equal p l) 'italic)
3482 ((equal p h) 'bold)))
3483 (overlay-put ov 'org-type 'org-priority)))))
3485 (defun org-agenda-dim-blocked-tasks ()
3486 "Dim currently blocked TODO's in the agenda display."
3487 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3488 (delete-overlay o)))
3489 (overlays-in (point-min) (point-max)))
3491 (let ((inhibit-read-only t)
3492 (org-depend-tag-blocked nil)
3493 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3494 org-blocked-by-checkboxes
3495 invis1 b e p ov h l)
3496 (goto-char (point-min))
3497 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3498 (and pos (goto-char (1+ pos))))
3499 (setq org-blocked-by-checkboxes nil invis1 invis)
3500 (let ((marker (org-get-at-bol 'org-hd-marker)))
3502 (with-current-buffer (marker-buffer marker)
3503 (save-excursion (goto-char marker)
3504 (org-entry-blocked-p))))
3505 (if org-blocked-by-checkboxes (setq invis1 nil))
3507 (max (point-min) (1- (point-at-bol)))
3510 ov (make-overlay b e))
3512 (overlay-put ov 'invisible t)
3513 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3514 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3516 (defvar org-agenda-skip-function nil
3517 "Function to be called at each match during agenda construction.
3518 If this function returns nil, the current match should not be skipped.
3519 Otherwise, the function must return a position from where the search
3520 should be continued.
3521 This may also be a Lisp form, it will be evaluated.
3522 Never set this variable using `setq' or so, because then it will apply
3523 to all future agenda commands. If you do want a global skipping condition,
3524 use the option `org-agenda-skip-function-global' instead.
3525 The correct usage for `org-agenda-skip-function' is to bind it with
3526 `let' to scope it dynamically into the agenda-constructing command.
3527 A good way to set it is through options in `org-agenda-custom-commands'.")
3529 (defun org-agenda-skip ()
3530 "Throw to `:skip' in places that should be skipped.
3531 Also moves point to the end of the skipped region, so that search can
3532 continue from there."
3533 (let ((p (point-at-bol)) to)
3534 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3535 (get-text-property p :org-archived)
3536 (org-end-of-subtree t)
3538 (and org-agenda-skip-comment-trees
3539 (get-text-property p :org-comment)
3540 (org-end-of-subtree t)
3542 (if (equal (char-after p) ?#) (throw :skip t))
3543 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3544 (org-agenda-skip-eval org-agenda-skip-function)))
3548 (defun org-agenda-skip-eval (form)
3549 "If FORM is a function or a list, call (or eval) is and return result.
3550 `save-excursion' and `save-match-data' are wrapped around the call, so point
3551 and match data are returned to the previous state no matter what these
3555 (or (setq fp (functionp form))
3563 (defvar org-agenda-markers nil
3564 "List of all currently active markers created by `org-agenda'.")
3565 (defvar org-agenda-last-marker-time (org-float-time)
3566 "Creation time of the last agenda marker.")
3568 (defun org-agenda-new-marker (&optional pos)
3569 "Return a new agenda marker.
3570 Org-mode keeps a list of these markers and resets them when they are
3572 (let ((m (copy-marker (or pos (point)))))
3573 (setq org-agenda-last-marker-time (org-float-time))
3574 (if org-agenda-buffer
3575 (with-current-buffer org-agenda-buffer
3576 (push m org-agenda-markers))
3577 (push m org-agenda-markers))
3580 (defun org-agenda-reset-markers ()
3581 "Reset markers created by `org-agenda'."
3582 (while org-agenda-markers
3583 (move-marker (pop org-agenda-markers) nil)))
3585 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3586 "Save relative positions of markers in region.
3587 This check for agenda markers in all agenda buffers currently active."
3588 (dolist (buf (buffer-list))
3589 (with-current-buffer buf
3590 (when (eq major-mode 'org-agenda-mode)
3591 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3592 org-agenda-markers)))))
3596 (defun org-agenda-entry-text-show-here ()
3597 "Add some text from the entry as context to the current line."
3599 (setq m (org-get-at-bol 'org-hd-marker))
3600 (unless (marker-buffer m)
3601 (error "No marker points to an entry here"))
3602 (setq txt (concat "\n" (org-no-properties
3603 (org-agenda-get-some-entry-text
3604 m org-agenda-entry-text-maxlines " > "))))
3605 (when (string-match "\\S-" txt)
3606 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3607 (overlay-put o 'evaporate t)
3608 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3609 (overlay-put o 'after-string txt))))
3611 (defun org-agenda-entry-text-show ()
3612 "Add entry context for all agenda lines."
3615 (goto-char (point-max))
3616 (beginning-of-line 1)
3618 (when (org-get-at-bol 'org-hd-marker)
3619 (org-agenda-entry-text-show-here))
3620 (beginning-of-line 0))))
3622 (defun org-agenda-entry-text-hide ()
3623 "Remove any shown entry context."
3626 (if (eq (overlay-get o 'org-overlay-type)
3627 'agenda-entry-content)
3628 (progn (delete-overlay o) t)))
3629 (overlays-in (point-min) (point-max)))))
3631 (defun org-agenda-get-day-face (date)
3632 "Return the face DATE should be displayed with."
3633 (or (and (functionp org-agenda-day-face-function)
3634 (funcall org-agenda-day-face-function date))
3635 (cond ((org-agenda-todayp date)
3636 'org-agenda-date-today)
3637 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3638 'org-agenda-date-weekend)
3639 (t 'org-agenda-date))))
3643 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3645 (defun org-timeline (&optional dotodo)
3646 "Show a time-sorted view of the entries in the current org file.
3647 Only entries with a time stamp of today or later will be listed. With
3648 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3649 under the current date.
3650 If the buffer contains an active region, only check the region for
3654 (org-agenda-show-log-scoped org-agenda-show-log)
3655 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3657 (date (calendar-current-date))
3658 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3659 (end (if (org-region-active-p) (region-end) (point-max)))
3660 (day-numbers (org-get-all-dates
3662 t org-agenda-show-log-scoped ; always include today
3663 org-timeline-show-empty-dates))
3664 (org-deadline-warning-days 0)
3665 (org-agenda-only-exact-dates t)
3670 (setq org-agenda-redo-command
3672 (list 'org-switch-to-buffer-other-window (current-buffer))
3673 (list 'org-timeline (list 'quote dotodo))))
3675 ;; Remove past dates from the list of dates.
3676 (setq day-numbers (delq nil (mapcar (lambda(x)
3677 (if (>= x today) x nil))
3679 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3680 (org-compile-prefix-format 'timeline)
3681 (org-set-sorting-strategy 'timeline)
3682 (if org-agenda-show-log-scoped (push :closed args))
3683 (push :timestamp args)
3684 (push :deadline args)
3685 (push :scheduled args)
3687 (if dotodo (push :todo args))
3688 (insert "Timeline of file " entry "\n")
3689 (add-text-properties (point-min) (point)
3690 (list 'face 'org-agenda-structure))
3691 (org-agenda-mark-header-line (point-min))
3692 (while (setq d (pop day-numbers))
3693 (if (and (listp d) (eq (car d) :omitted))
3696 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3697 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3698 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3699 (if (and (>= d today)
3704 (insert (make-string 79 ?-) "\n")))
3705 (setq date (calendar-gregorian-from-absolute d))
3707 (setq rtn (and (not emptyp)
3708 (apply 'org-agenda-get-day-entries entry
3710 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3713 (if (stringp org-agenda-format-date)
3714 (format-time-string org-agenda-format-date
3715 (org-time-from-absolute date))
3716 (funcall org-agenda-format-date date))
3718 (put-text-property s (1- (point)) 'face
3719 (org-agenda-get-day-face date))
3720 (put-text-property s (1- (point)) 'org-date-line t)
3721 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3723 (put-text-property s (1- (point)) 'org-today t))
3724 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3725 (put-text-property s (1- (point)) 'day d)))))
3726 (goto-char (point-min))
3727 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3729 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3730 (org-finalize-agenda)
3731 (setq buffer-read-only t)))
3733 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3734 "Return a list of all relevant day numbers from BEG to END buffer positions.
3735 If NO-RANGES is non-nil, include only the start and end dates of a range,
3736 not every single day in the range. If FORCE-TODAY is non-nil, make
3737 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3738 inactive time stamps (those in square brackets) are included.
3739 When EMPTY is non-nil, also include days without any entries."
3741 (if pre-re pre-re "")
3742 (if inactive org-ts-regexp-both org-ts-regexp)))
3743 dates dates1 date day day1 day2 ts1 ts2 pos)
3745 (setq dates (list (org-today))))
3748 (while (re-search-forward re end t)
3749 (setq day (time-to-days (org-time-string-to-time
3750 (substring (match-string 1) 0 10)
3751 (current-buffer) (match-beginning 0))))
3752 (or (memq day dates) (push day dates)))
3755 (while (re-search-forward org-tr-regexp end t)
3756 (setq pos (match-beginning 0))
3757 (setq ts1 (substring (match-string 1) 0 10)
3758 ts2 (substring (match-string 2) 0 10)
3759 day1 (time-to-days (org-time-string-to-time
3760 ts1 (current-buffer) pos))
3761 day2 (time-to-days (org-time-string-to-time
3762 ts2 (current-buffer) pos)))
3763 (while (< (setq day1 (1+ day1)) day2)
3764 (or (memq day1 dates) (push day1 dates)))))
3765 (setq dates (sort dates '<))
3767 (while (setq day (pop dates))
3768 (setq day2 (car dates))
3770 (when (and day2 empty)
3771 (if (or (eq empty t)
3772 (and (numberp empty) (<= (- day2 day) empty)))
3773 (while (< (setq day (1+ day)) day2)
3774 (push (list day) dates1))
3775 (push (cons :omitted (- day2 day)) dates1))))
3776 (setq dates (nreverse dates1)))
3779 ;;; Agenda Daily/Weekly
3781 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3782 "Start day for the agenda view.
3783 Custom commands can set this variable in the options section.")
3784 (defvar org-starting-day nil) ; local variable in the agenda buffer
3785 (defvar org-agenda-current-span nil
3786 "The current span used in the agenda view.") ; local variable in the agenda buffer
3787 (defvar org-arg-loc nil) ; local variable
3789 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3790 "List of types searched for when creating the daily/weekly agenda.
3791 This variable is a list of symbols that controls the types of
3792 items that appear in the daily/weekly agenda. Allowed symbols in this
3795 :timestamp List items containing a date stamp or date range matching
3796 the selected date. This includes sexp entries in
3799 :sexp List entries resulting from plain diary-like sexps.
3801 :deadline List deadline due on that date. When the date is today,
3802 also list any deadlines past due, or due within
3803 `org-deadline-warning-days'. `:deadline' must appear before
3804 `:scheduled' if the setting of
3805 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3808 :scheduled List all items which are scheduled for the given date.
3809 The diary for *today* also contains items which were
3810 scheduled earlier and are not yet marked DONE.
3812 By default, all four types are turned on.
3814 Never set this variable globally using `setq', because then it
3815 will apply to all future agenda commands. Instead, bind it with
3816 `let' to scope it dynamically into the agenda-constructing
3817 command. A good way to set it is through options in
3818 `org-agenda-custom-commands'. For a more flexible (though
3819 somewhat less efficient) way of determining what is included in
3820 the daily/weekly agenda, see `org-agenda-skip-function'.")
3823 (defun org-agenda-list (&optional arg start-day span)
3824 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3825 The view will be for the current day or week, but from the overview buffer
3826 you will be able to go to other days/weeks.
3828 With a numeric prefix argument in an interactive call, the agenda will
3829 span ARG days. Lisp programs should instead specify SPAN to change
3830 the number of days. SPAN defaults to `org-agenda-span'.
3832 START-DAY defaults to TODAY, or to the most recent match for the weekday
3833 given in `org-agenda-start-on-weekday'."
3835 (if (and (integerp arg) (> arg 0))
3836 (setq span arg arg nil))
3837 (org-prepare-agenda "Day/Week")
3838 (setq start-day (or start-day org-agenda-start-day))
3839 (if org-agenda-overriding-arguments
3840 (setq arg (car org-agenda-overriding-arguments)
3841 start-day (nth 1 org-agenda-overriding-arguments)
3842 span (nth 2 org-agenda-overriding-arguments)))
3843 (if (stringp start-day)
3844 ;; Convert to an absolute day number
3845 (setq start-day (time-to-days (org-read-date nil t start-day))))
3846 (setq org-agenda-last-arguments (list arg start-day span))
3847 (org-compile-prefix-format 'agenda)
3848 (org-set-sorting-strategy 'agenda)
3849 (let* ((span (org-agenda-ndays-to-span
3850 (or span org-agenda-ndays org-agenda-span)))
3852 (sd (or start-day today))
3853 (ndays (org-agenda-span-to-ndays span sd))
3854 (org-agenda-start-on-weekday
3856 org-agenda-start-on-weekday))
3857 (thefiles (org-agenda-files nil 'ifmode))
3859 (start (if (or (null org-agenda-start-on-weekday)
3862 (let* ((nt (calendar-day-of-week
3863 (calendar-gregorian-from-absolute sd)))
3864 (n1 org-agenda-start-on-weekday)
3866 (- sd (+ (if (< d 0) 7 0) d)))))
3867 (day-numbers (list start))
3869 (inhibit-redisplay (not debug-on-error))
3870 (org-agenda-show-log-scoped org-agenda-show-log)
3871 s e rtn rtnall file date d start-pos end-pos todayp
3872 clocktable-start clocktable-end filter)
3873 (setq org-agenda-redo-command
3874 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3875 (dotimes (n (1- ndays))
3876 (push (1+ (car day-numbers)) day-numbers))
3877 (setq day-numbers (nreverse day-numbers))
3878 (setq clocktable-start (car day-numbers)
3879 clocktable-end (1+ (or (org-last day-numbers) 0)))
3880 (org-set-local 'org-starting-day (car day-numbers))
3881 (org-set-local 'org-arg-loc arg)
3882 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3883 (unless org-agenda-compact-blocks
3884 (let* ((d1 (car day-numbers))
3885 (d2 (org-last day-numbers))
3886 (w1 (org-days-to-iso-week d1))
3887 (w2 (org-days-to-iso-week d2)))
3889 (if org-agenda-overriding-header
3890 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3891 nil 'face 'org-agenda-structure) "\n")
3892 (insert (org-agenda-span-name span)
3894 (if (< (- d2 d1) 350)
3896 (format " (W%02d)" w1)
3897 (format " (W%02d-W%02d)" w1 w2))
3900 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3902 (org-agenda-mark-header-line s))
3903 (while (setq d (pop day-numbers))
3904 (setq date (calendar-gregorian-from-absolute d)
3906 (if (or (setq todayp (= d today))
3907 (and (not start-pos) (= d sd)))
3908 (setq start-pos (point))
3909 (if (and start-pos (not end-pos))
3910 (setq end-pos (point))))
3911 (setq files thefiles
3913 (while (setq file (pop files))
3915 (org-check-agenda-file file)
3916 (let ((org-agenda-entry-types org-agenda-entry-types))
3917 (unless org-agenda-include-deadlines
3918 (setq org-agenda-entry-types
3919 (delq :deadline org-agenda-entry-types)))
3921 ((memq org-agenda-show-log-scoped '(only clockcheck))
3922 (setq rtn (org-agenda-get-day-entries
3923 file date :closed)))
3924 (org-agenda-show-log-scoped
3925 (setq rtn (apply 'org-agenda-get-day-entries
3927 (append '(:closed) org-agenda-entry-types))))
3929 (setq rtn (apply 'org-agenda-get-day-entries
3931 org-agenda-entry-types)))))
3932 (setq rtnall (append rtnall rtn)))) ;; all entries
3933 (if org-agenda-include-diary
3934 (let ((org-agenda-search-headline-for-time t))
3935 (require 'diary-lib)
3936 (setq rtn (org-get-entries-from-diary date))
3937 (setq rtnall (append rtnall rtn))))
3938 (if (or rtnall org-agenda-show-all-dates)
3940 (setq day-cnt (1+ day-cnt))
3942 (if (stringp org-agenda-format-date)
3943 (format-time-string org-agenda-format-date
3944 (org-time-from-absolute date))
3945 (funcall org-agenda-format-date date))
3947 (put-text-property s (1- (point)) 'face
3948 (org-agenda-get-day-face date))
3949 (put-text-property s (1- (point)) 'org-date-line t)
3950 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3951 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3953 (put-text-property s (1- (point)) 'org-today t))
3955 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
3956 (if rtnall (insert ;; all entries
3957 (org-finalize-agenda-entries rtnall)
3959 (put-text-property s (1- (point)) 'day d)
3960 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3961 (when (and org-agenda-clockreport-mode clocktable-start)
3962 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3963 ;; the above line is to ensure the restricted range!
3964 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3966 (setq p (org-plist-delete p :block))
3967 (setq p (plist-put p :tstart clocktable-start))
3968 (setq p (plist-put p :tend clocktable-end))
3969 (setq p (plist-put p :scope 'agenda))
3970 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3971 (setq filter (or org-agenda-tag-filter-while-redo
3972 (get 'org-agenda-tag-filter :preset-filter))))
3973 (setq p (plist-put p :tags (mapconcat (lambda (x)
3974 (if (string-match "[<>=]" x)
3978 (setq tbl (apply 'org-get-clocktable p))
3980 (goto-char (point-min))
3981 (or org-agenda-multi (org-fit-agenda-window))
3982 (unless (and (pos-visible-in-window-p (point-min))
3983 (pos-visible-in-window-p (point-max)))
3984 (goto-char (1- (point-max)))
3986 (if (not (pos-visible-in-window-p (or start-pos 1)))
3988 (goto-char (or start-pos 1))
3990 (goto-char (or start-pos 1))
3991 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3992 (if (eq org-agenda-show-log-scoped 'clockcheck)
3993 (org-agenda-show-clocking-issues))
3994 (org-finalize-agenda)
3995 (setq buffer-read-only t)
3998 (defun org-agenda-ndays-to-span (n)
3999 "Return a span symbol for a span of N days, or N if none matches."
4000 (cond ((symbolp n) n)
4005 (defun org-agenda-span-to-ndays (span start-day)
4006 "Return ndays from SPAN starting at START-DAY."
4007 (cond ((numberp span) span)
4011 (let ((date (calendar-gregorian-from-absolute start-day)))
4012 (calendar-last-day-of-month (car date) (caddr date))))
4014 (let ((date (calendar-gregorian-from-absolute start-day)))
4015 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4017 (defun org-agenda-span-name (span)
4018 "Return a SPAN name."
4022 (capitalize (symbol-name span))
4023 (format "%d days" span))))
4025 ;;; Agenda word search
4027 (defvar org-agenda-search-history nil)
4028 (defvar org-todo-only nil)
4030 (defvar org-search-syntax-table nil
4031 "Special syntax table for org-mode search.
4032 In this table, we have single quotes not as word constituents, to
4033 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4035 (defvar org-mode-syntax-table) ; From org.el
4036 (defun org-search-syntax-table ()
4037 (unless org-search-syntax-table
4038 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4039 (modify-syntax-entry ?' "." org-search-syntax-table)
4040 (modify-syntax-entry ?` "." org-search-syntax-table))
4041 org-search-syntax-table)
4043 (defvar org-agenda-last-search-view-search-was-boolean nil)
4046 (defun org-search-view (&optional todo-only string edit-at)
4047 "Show all entries that contain a phrase or words or regular expressions.
4049 With optional prefix argument TODO-ONLY, only consider entries that are
4050 TODO entries. The argument STRING can be used to pass a default search
4051 string into this function. If EDIT-AT is non-nil, it means that the
4052 user should get a chance to edit this string, with cursor at position
4055 The search string can be viewed either as a phrase that should be found as
4056 is, or it can be broken into a number of snippets, each of which must match
4057 in a Boolean way to select an entry. The default depends on the variable
4058 `org-agenda-search-view-always-boolean'.
4059 Even if this is turned off (the default) you can always switch to
4060 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4062 The default is a direct search of the whole phrase, where each space in
4063 the search string can expand to an arbitrary amount of whitespace,
4066 If using a Boolean search, the search string is split on whitespace and
4067 each snippet is searched separately, with logical AND to select an entry.
4068 Words prefixed with a minus must *not* occur in the entry. Words without
4069 a prefix or prefixed with a plus must occur in the entry. Matching is
4070 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4071 match whole words, not parts of a word) if
4072 `org-agenda-search-view-force-full-words' is set (default is nil).
4074 Boolean search snippets enclosed by curly braces are interpreted as
4075 regular expressions that must or (when preceded with \"-\") must not
4076 match in the entry. Snippets enclosed into double quotes will be taken
4077 as a whole, to include whitespace.
4079 - If the search string starts with an asterisk, search only in headlines.
4080 - If (possibly after the leading star) the search string starts with an
4081 exclamation mark, this also means to look at TODO entries only, an effect
4082 that can also be achieved with a prefix argument.
4083 - If (possibly after star and exclamation mark) the search string starts
4084 with a colon, this will mean that the (non-regexp) snippets of the
4085 Boolean search must match as full words.
4087 This command searches the agenda files, and in addition the files listed
4088 in `org-agenda-text-search-extra-files'."
4090 (org-prepare-agenda "SEARCH")
4091 (org-compile-prefix-format 'search)
4092 (org-set-sorting-strategy 'search)
4093 (let* ((props (list 'face nil
4094 'done-face 'org-agenda-done
4095 'org-not-done-regexp org-not-done-regexp
4096 'org-todo-regexp org-todo-regexp
4097 'org-complex-heading-regexp org-complex-heading-regexp
4098 'mouse-face 'highlight
4099 'help-echo (format "mouse-2 or RET jump to location")))
4100 (full-words org-agenda-search-view-force-full-words)
4101 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4102 regexp rtn rtnall files file pos
4103 marker category category-pos tags c neg re boolean
4104 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4105 (unless (and (not edit-at)
4107 (string-match "\\S-" string))
4108 (setq string (read-string
4109 (if org-agenda-search-view-always-boolean
4110 "[+-]Word/{Regexp} ...: "
4111 "Phrase, or [+-]Word/{Regexp} ...: ")
4113 ((integerp edit-at) (cons string edit-at))
4115 'org-agenda-search-history)))
4116 (org-set-local 'org-todo-only todo-only)
4117 (setq org-agenda-redo-command
4118 (list 'org-search-view (if todo-only t nil) string
4119 '(if current-prefix-arg 1 nil)))
4120 (setq org-agenda-query-string string)
4122 (if (equal (string-to-char string) ?*)
4124 words (substring string 1))
4125 (setq words string))
4126 (when (equal (string-to-char words) ?!)
4128 words (substring words 1)))
4129 (when (equal (string-to-char words) ?:)
4131 words (substring words 1)))
4132 (if (or org-agenda-search-view-always-boolean
4133 (member (string-to-char words) '(?- ?+ ?\{)))
4135 (setq words (org-split-string words))
4137 (while (setq w (pop words))
4138 (while (and (string-match "\\\\\\'" w) words)
4139 (setq w (concat (substring w 0 -1) " " (pop words))))
4141 (setq words (nreverse www) www nil)
4142 (while (setq w (pop words))
4143 (when (and (string-match "\\`[-+]?{" w)
4144 (not (string-match "}\\'" w)))
4145 (while (and words (not (string-match "}\\'" (car words))))
4146 (setq w (concat w " " (pop words))))
4147 (setq w (concat w " " (pop words))))
4149 (setq words (nreverse www)))
4150 (setq org-agenda-last-search-view-search-was-boolean boolean)
4153 (while (setq w (pop words))
4154 (if (or (equal (substring w 0 1) "\"")
4155 (and (> (length w) 1)
4156 (member (substring w 0 1) '("+" "-"))
4157 (equal (substring w 1 2) "\"")))
4158 (while (and words (not (equal (substring w -1) "\"")))
4159 (setq w (concat w " " (pop words)))))
4160 (and (string-match "\\`\\([-+]?\\)\"" w)
4161 (setq w (replace-match "\\1" nil nil w)))
4162 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4164 (setq words (nreverse wds))))
4167 (setq c (string-to-char w))
4169 (setq neg t w (substring w 1))
4171 (setq neg nil w (substring w 1))
4173 (if (string-match "\\`{.*}\\'" w)
4174 (setq re (substring w 1 -1))
4176 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4177 (setq re (regexp-quote (downcase w)))))
4178 (if neg (push re regexps-) (push re regexps+)))
4180 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4182 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4184 (setq regexp org-outline-regexp-bol)
4185 (setq regexp (pop regexps+))
4186 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4188 (setq files (org-agenda-files nil 'ifmode))
4189 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4190 (pop org-agenda-text-search-extra-files)
4191 (setq files (org-add-archive-files files)))
4192 (setq files (append files org-agenda-text-search-extra-files)
4194 (while (setq file (pop files))
4197 (org-check-agenda-file file)
4198 (setq buffer (if (file-exists-p file)
4199 (org-get-agenda-file-buffer file)
4200 (error "No such file %s" file)))
4202 ;; If file does not exist, make sure an error message is sent
4203 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4205 (with-current-buffer buffer
4206 (with-syntax-table (org-search-syntax-table)
4207 (unless (derived-mode-p 'org-mode)
4208 (error "Agenda file %s is not in `org-mode'" file))
4209 (let ((case-fold-search t))
4212 (if org-agenda-restrict
4213 (narrow-to-region org-agenda-restrict-begin
4214 org-agenda-restrict-end)
4216 (goto-char (point-min))
4217 (unless (or (org-at-heading-p)
4218 (outline-next-heading))
4219 (throw 'nextfile t))
4220 (goto-char (max (point-min) (1- (point))))
4221 (while (re-search-forward regexp nil t)
4222 (org-back-to-heading t)
4223 (skip-chars-forward "* ")
4224 (setq beg (point-at-bol)
4226 end (progn (outline-next-heading) (point)))
4230 (setq str (buffer-substring-no-properties
4232 (if hdl-only (point-at-eol) end)))
4233 (mapc (lambda (wr) (when (string-match wr str)
4234 (goto-char (1- end))
4237 (mapc (lambda (wr) (unless (string-match wr str)
4238 (goto-char (1- end))
4241 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4245 (setq marker (org-agenda-new-marker (point))
4246 category (org-get-category)
4247 category-pos (get-text-property (point) 'org-category-position)
4248 tags (org-get-tags-at (point))
4249 txt (org-agenda-format-item
4251 (buffer-substring-no-properties
4252 beg1 (point-at-eol))
4254 (org-add-props txt props
4255 'org-marker marker 'org-hd-marker marker
4256 'org-todo-regexp org-todo-regexp
4257 'org-complex-heading-regexp org-complex-heading-regexp
4258 'priority 1000 'org-category category
4259 'org-category-position category-pos
4262 (goto-char (1- end))))))))))
4263 (setq rtn (nreverse ee))
4264 (setq rtnall (append rtnall rtn)))
4265 (if org-agenda-overriding-header
4266 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4267 nil 'face 'org-agenda-structure) "\n")
4268 (insert "Search words: ")
4269 (add-text-properties (point-min) (1- (point))
4270 (list 'face 'org-agenda-structure))
4272 (insert string "\n")
4273 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4275 (unless org-agenda-multi
4276 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4277 (add-text-properties pos (1- (point))
4278 (list 'face 'org-agenda-structure))))
4279 (org-agenda-mark-header-line (point-min))
4281 (insert (org-finalize-agenda-entries rtnall) "\n"))
4282 (goto-char (point-min))
4283 (or org-agenda-multi (org-fit-agenda-window))
4284 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4285 (org-finalize-agenda)
4286 (setq buffer-read-only t)))
4288 ;;; Agenda TODO list
4290 (defvar org-select-this-todo-keyword nil)
4291 (defvar org-last-arg nil)
4294 (defun org-todo-list (arg)
4295 "Show all (not done) TODO entries from all agenda file in a single list.
4296 The prefix arg can be used to select a specific TODO keyword and limit
4297 the list to these. When using \\[universal-argument], you will be prompted
4298 for a keyword. A numeric prefix directly selects the Nth keyword in
4299 `org-todo-keywords-1'."
4301 (org-prepare-agenda "TODO")
4302 (org-compile-prefix-format 'todo)
4303 (org-set-sorting-strategy 'todo)
4304 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4305 (let* ((today (org-today))
4306 (date (calendar-gregorian-from-absolute today))
4307 (kwds org-todo-keywords-for-agenda)
4308 (completion-ignore-case t)
4309 (org-select-this-todo-keyword
4310 (if (stringp arg) arg
4311 (and arg (integerp arg) (> arg 0)
4312 (nth (1- arg) kwds))))
4313 rtn rtnall files file pos)
4314 (when (equal arg '(4))
4315 (setq org-select-this-todo-keyword
4316 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4317 (mapcar 'list kwds) nil nil)))
4318 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4319 (org-set-local 'org-last-arg arg)
4320 (setq org-agenda-redo-command
4321 '(org-todo-list (or current-prefix-arg org-last-arg)))
4322 (setq files (org-agenda-files nil 'ifmode)
4324 (while (setq file (pop files))
4326 (org-check-agenda-file file)
4327 (setq rtn (org-agenda-get-day-entries file date :todo))
4328 (setq rtnall (append rtnall rtn))))
4329 (if org-agenda-overriding-header
4330 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4331 nil 'face 'org-agenda-structure) "\n")
4332 (insert "Global list of TODO items of type: ")
4333 (add-text-properties (point-min) (1- (point))
4334 (list 'face 'org-agenda-structure
4337 (or org-select-this-todo-keyword "ALL"))))
4338 (org-agenda-mark-header-line (point-min))
4340 (insert (or org-select-this-todo-keyword "ALL") "\n")
4341 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4343 (unless org-agenda-multi
4344 (insert "Available with `N r': (0)ALL")
4347 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4348 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4353 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4354 (org-agenda-mark-header-line (point-min))
4356 (insert (org-finalize-agenda-entries rtnall) "\n"))
4357 (goto-char (point-min))
4358 (or org-agenda-multi (org-fit-agenda-window))
4359 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4360 (org-finalize-agenda)
4361 (setq buffer-read-only t)))
4363 ;;; Agenda tags match
4366 (defun org-tags-view (&optional todo-only match)
4367 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4368 The prefix arg TODO-ONLY limits the search to TODO entries."
4370 (let* ((org-tags-match-list-sublevels
4371 org-tags-match-list-sublevels)
4372 (completion-ignore-case t)
4373 rtn rtnall files file pos matcher
4375 (when (and (stringp match) (not (string-match "\\S-" match)))
4377 (setq matcher (org-make-tags-matcher match)
4378 match (car matcher) matcher (cdr matcher))
4379 (org-prepare-agenda (concat "TAGS " match))
4380 (org-compile-prefix-format 'tags)
4381 (org-set-sorting-strategy 'tags)
4382 (setq org-agenda-query-string match)
4383 (setq org-agenda-redo-command
4384 (list 'org-tags-view (list 'quote todo-only)
4385 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4386 (setq files (org-agenda-files nil 'ifmode)
4388 (while (setq file (pop files))
4390 (org-check-agenda-file file)
4391 (setq buffer (if (file-exists-p file)
4392 (org-get-agenda-file-buffer file)
4393 (error "No such file %s" file)))
4395 ;; If file does not exist, error message to agenda
4397 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4398 rtnall (append rtnall rtn))
4399 (with-current-buffer buffer
4400 (unless (derived-mode-p 'org-mode)
4401 (error "Agenda file %s is not in `org-mode'" file))
4404 (if org-agenda-restrict
4405 (narrow-to-region org-agenda-restrict-begin
4406 org-agenda-restrict-end)
4408 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4409 (setq rtnall (append rtnall rtn))))))))
4410 (if org-agenda-overriding-header
4411 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4412 nil 'face 'org-agenda-structure) "\n")
4413 (insert "Headlines with TAGS match: ")
4414 (add-text-properties (point-min) (1- (point))
4415 (list 'face 'org-agenda-structure
4417 (concat "Match: " match)))
4420 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4422 (unless org-agenda-multi
4423 (insert "Press `C-u r' to search again with new search string\n"))
4424 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4425 (org-agenda-mark-header-line (point-min))
4427 (insert (org-finalize-agenda-entries rtnall) "\n"))
4428 (goto-char (point-min))
4429 (or org-agenda-multi (org-fit-agenda-window))
4430 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4431 (org-finalize-agenda)
4432 (setq buffer-read-only t)))
4434 ;;; Agenda Finding stuck projects
4436 (defvar org-agenda-skip-regexp nil
4437 "Regular expression used in skipping subtrees for the agenda.
4438 This is basically a temporary global variable that can be set and then
4439 used by user-defined selections using `org-agenda-skip-function'.")
4441 (defvar org-agenda-overriding-header nil
4442 "When set during agenda, todo and tags searches it replaces the header.
4443 This variable should not be set directly, but custom commands can bind it
4444 in the options section.")
4446 (defun org-agenda-skip-entry-when-regexp-matches ()
4447 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4448 If yes, it returns the end position of this entry, causing agenda commands
4449 to skip the entry but continuing the search in the subtree. This is a
4450 function that can be put into `org-agenda-skip-function' for the duration
4452 (let ((end (save-excursion (org-end-of-subtree t)))
4455 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4458 (defun org-agenda-skip-subtree-when-regexp-matches ()
4459 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4460 If yes, it returns the end position of this tree, causing agenda commands
4461 to skip this subtree. This is a function that can be put into
4462 `org-agenda-skip-function' for the duration of a command."
4463 (let ((end (save-excursion (org-end-of-subtree t)))
4466 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4469 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4470 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4471 If yes, it returns the end position of the current entry (NOT the tree),
4472 causing agenda commands to skip the entry but continuing the search in
4473 the subtree. This is a function that can be put into
4474 `org-agenda-skip-function' for the duration of a command. An important
4475 use of this function is for the stuck project list."
4476 (let ((end (save-excursion (org-end-of-subtree t)))
4477 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4480 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4481 (and skip entry-end)))
4483 (defun org-agenda-skip-entry-if (&rest conditions)
4484 "Skip entry if any of CONDITIONS is true.
4485 See `org-agenda-skip-if' for details."
4486 (org-agenda-skip-if nil conditions))
4488 (defun org-agenda-skip-subtree-if (&rest conditions)
4489 "Skip entry if any of CONDITIONS is true.
4490 See `org-agenda-skip-if' for details."
4491 (org-agenda-skip-if t conditions))
4493 (defun org-agenda-skip-if (subtree conditions)
4494 "Checks current entity for CONDITIONS.
4495 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4496 the entry (i.e. the text before the next heading) is checked.
4498 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4499 from different tests. Valid conditions are:
4501 scheduled Check if there is a scheduled cookie
4502 notscheduled Check if there is no scheduled cookie
4503 deadline Check if there is a deadline
4504 notdeadline Check if there is no deadline
4505 timestamp Check if there is a timestamp (also deadline or scheduled)
4506 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4507 regexp Check if regexp matches
4508 notregexp Check if regexp does not match.
4509 todo Check if TODO keyword matches
4510 nottodo Check if TODO keyword does not match
4512 The regexp is taken from the conditions list, it must come right after
4513 the `regexp' or `notregexp' element.
4515 `todo' and `nottodo' accept as an argument a list of todo
4516 keywords, which may include \"*\" to match any todo keyword.
4518 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4520 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4522 Instead of a list, a keyword class may be given. For example:
4524 (org-agenda-skip-entry-if 'nottodo 'done)
4526 would skip entries that haven't been marked with any of \"DONE\"
4527 keywords. Possible classes are: `todo', `done', `any'.
4529 If any of these conditions is met, this function returns the end point of
4530 the entity, causing the search to continue from there. This is a function
4531 that can be put into `org-agenda-skip-function' for the duration of a command."
4533 (org-back-to-heading t)
4536 (progn (org-end-of-subtree t) (point))
4537 (progn (outline-next-heading) (1- (point)))))
4541 (and (memq 'scheduled conditions)
4542 (re-search-forward org-scheduled-time-regexp end t))
4543 (and (memq 'notscheduled conditions)
4544 (not (re-search-forward org-scheduled-time-regexp end t)))
4545 (and (memq 'deadline conditions)
4546 (re-search-forward org-deadline-time-regexp end t))
4547 (and (memq 'notdeadline conditions)
4548 (not (re-search-forward org-deadline-time-regexp end t)))
4549 (and (memq 'timestamp conditions)
4550 (re-search-forward org-ts-regexp end t))
4551 (and (memq 'nottimestamp conditions)
4552 (not (re-search-forward org-ts-regexp end t)))
4553 (and (setq m (memq 'regexp conditions))
4555 (re-search-forward (nth 1 m) end t))
4556 (and (setq m (memq 'notregexp conditions))
4558 (not (re-search-forward (nth 1 m) end t)))
4560 (setq m (memq 'nottodo conditions))
4561 (setq m (memq 'todo-unblocked conditions))
4562 (setq m (memq 'nottodo-unblocked conditions))
4563 (setq m (memq 'todo conditions)))
4564 (org-agenda-skip-if-todo m end)))
4567 (defun org-agenda-skip-if-todo (args end)
4568 "Helper function for `org-agenda-skip-if', do not use it directly.
4569 ARGS is a list with first element either `todo', `nottodo',
4570 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
4571 a list of TODO keywords, or a state symbol `todo' or `done' or
4573 (let ((kw (car args))
4579 ((listp arg) ;; list of keywords
4580 (if (member "*" arg)
4581 (mapcar 'substring-no-properties org-todo-keywords-1)
4583 ((symbolp arg) ;; keyword class name
4586 (org-delete-all org-done-keywords
4587 (mapcar 'substring-no-properties
4588 org-todo-keywords-1)))
4589 ((eq arg 'done) org-done-keywords)
4591 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4593 (concat "^\\*+[ \t]+\\<\\("
4594 (mapconcat 'identity todo-wds "\\|")
4597 ((eq kw 'todo) (re-search-forward todo-re end t))
4598 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
4599 ((eq kw 'todo-unblocked)
4601 (while (re-search-forward todo-re end t)
4602 (or (org-entry-blocked-p) (throw 'unblocked t)))
4604 ((eq kw 'nottodo-unblocked)
4606 (while (re-search-forward todo-re end t)
4607 (or (org-entry-blocked-p) (throw 'unblocked nil)))
4612 (defun org-agenda-list-stuck-projects (&rest ignore)
4613 "Create agenda view for projects that are stuck.
4614 Stuck projects are project that have no next actions. For the definitions
4615 of what a project is and how to check if it stuck, customize the variable
4616 `org-stuck-projects'."
4618 (let* ((org-agenda-skip-function
4619 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4620 ;; We could have used org-agenda-skip-if here.
4621 (org-agenda-overriding-header
4622 (or org-agenda-overriding-header "List of stuck projects: "))
4623 (matcher (nth 0 org-stuck-projects))
4624 (todo (nth 1 org-stuck-projects))
4625 (todo-wds (if (member "*" todo)
4627 (org-prepare-agenda-buffers (org-agenda-files
4630 org-done-keywords-for-agenda
4631 (copy-sequence org-todo-keywords-for-agenda)))
4633 (todo-re (concat "^\\*+[ \t]+\\("
4634 (mapconcat 'identity todo-wds "\\|")
4636 (tags (nth 2 org-stuck-projects))
4637 (tags-re (if (member "*" tags)
4638 (concat org-outline-regexp-bol
4639 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4641 (concat org-outline-regexp-bol
4643 (mapconcat 'identity tags "\\|")
4644 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4645 (gen-re (nth 3 org-stuck-projects))
4651 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4653 (setq org-agenda-skip-regexp
4655 (mapconcat 'identity re-list "\\|")
4656 (error "No information how to identify unstuck projects")))
4657 (org-tags-view nil matcher)
4658 (with-current-buffer org-agenda-buffer-name
4659 (setq org-agenda-redo-command
4660 '(org-agenda-list-stuck-projects
4661 (or current-prefix-arg org-last-arg))))))
4663 ;;; Diary integration
4665 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4666 (defvar diary-list-entries-hook)
4667 (defvar diary-time-regexp)
4668 (defun org-get-entries-from-diary (date)
4669 "Get the (Emacs Calendar) diary entries for DATE."
4670 (require 'diary-lib)
4671 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4672 (diary-display-hook '(fancy-diary-display))
4673 (diary-display-function 'fancy-diary-display)
4675 (diary-list-entries-hook
4676 (cons 'org-diary-default-entry diary-list-entries-hook))
4677 (diary-file-name-prefix-function nil) ; turn this feature off
4678 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4680 (org-disable-agenda-to-diary t))
4682 (save-window-excursion
4683 (funcall (if (fboundp 'diary-list-entries)
4684 'diary-list-entries 'list-diary-entries)
4686 (if (not (get-buffer diary-fancy-buffer))
4688 (with-current-buffer diary-fancy-buffer
4689 (setq buffer-read-only nil)
4690 (if (zerop (buffer-size))
4693 ;; Omit the date and other unnecessary stuff
4694 (org-agenda-cleanup-fancy-diary)
4695 ;; Add prefix to each line and extend the text properties
4696 (if (zerop (buffer-size))
4698 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4701 (insert entries) (goto-char (point-min))
4702 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4703 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4704 (replace-match (concat "; " (match-string 1)))))
4706 (set-buffer-modified-p nil)
4707 (kill-buffer diary-fancy-buffer)))
4709 (setq entries (org-split-string entries "\n"))
4713 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4714 ;; Extend the text properties to the beginning of the line
4715 (org-add-props x (text-properties-at (1- (length x)) x)
4716 'type "diary" 'date date 'face 'org-agenda-diary))
4719 (defvar org-agenda-cleanup-fancy-diary-hook nil
4720 "Hook run when the fancy diary buffer is cleaned up.")
4722 (defun org-agenda-cleanup-fancy-diary ()
4723 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4724 This gets rid of the date, the underline under the date, and
4725 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4726 date. It also removes lines that contain only whitespace."
4727 (goto-char (point-min))
4728 (if (looking-at ".*?:[ \t]*")
4731 (re-search-forward "\n=+$" nil t)
4733 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4734 (re-search-forward "\n=+$" nil t)
4735 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4736 (goto-char (point-min))
4737 (while (re-search-forward "^ +\n" nil t)
4739 (goto-char (point-min))
4740 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4742 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4744 ;; Make sure entries from the diary have the right text properties.
4745 (eval-after-load "diary-lib"
4746 '(if (boundp 'diary-modify-entry-list-string-function)
4747 ;; We can rely on the hook, nothing to do
4749 ;; Hook not available, must use advice to make this work
4750 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4751 "Make the position visible."
4752 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4755 (setq string (org-modify-diary-entry-string string))))))
4757 (defun org-modify-diary-entry-string (string)
4758 "Add text properties to string, allowing org-mode to act on it."
4759 (org-add-props string nil
4760 'mouse-face 'highlight
4761 'help-echo (if buffer-file-name
4762 (format "mouse-2 or RET jump to diary file %s"
4763 (abbreviate-file-name buffer-file-name))
4765 'org-agenda-diary-link t
4766 'org-marker (org-agenda-new-marker (point-at-bol))))
4768 (defun org-diary-default-entry ()
4769 "Add a dummy entry to the diary.
4770 Needed to avoid empty dates which mess up holiday display."
4771 ;; Catch the error if dealing with the new add-to-diary-alist
4772 (when org-disable-agenda-to-diary
4774 (org-add-to-diary-list original-date "Org-mode dummy" "")
4776 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4778 (defun org-add-to-diary-list (&rest args)
4779 (if (fboundp 'diary-add-to-list)
4780 (apply 'diary-add-to-list args)
4781 (apply 'add-to-diary-list args)))
4783 (defvar org-diary-last-run-time nil)
4786 (defun org-diary (&rest args)
4787 "Return diary information from org files.
4788 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4789 It accesses org files and extracts information from those files to be
4790 listed in the diary. The function accepts arguments specifying what
4791 items should be listed. For a list of arguments allowed here, see the
4792 variable `org-agenda-entry-types'.
4794 The call in the diary file should look like this:
4796 &%%(org-diary) ~/path/to/some/orgfile.org
4798 Use a separate line for each org file to check. Or, if you omit the file name,
4799 all files listed in `org-agenda-files' will be checked automatically:
4803 If you don't give any arguments (as in the example above), the default
4804 arguments (:deadline :scheduled :timestamp :sexp) are used.
4805 So the example above may also be written as
4807 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4809 The function expects the lisp variables `entry' and `date' to be provided
4810 by the caller, because this is how the calendar works. Don't use this
4811 function from a program - use `org-agenda-get-day-entries' instead."
4812 (when (> (- (org-float-time)
4813 org-agenda-last-marker-time)
4815 ;; I am not sure if this works with sticky agendas, because the marker
4816 ;; list is then no longer a global variable.
4817 (org-agenda-reset-markers))
4818 ;; Prevent `org-compile-prefix-format' to fail when there is no agenda
4819 (when (buffer-live-p org-agenda-buffer)
4820 (org-compile-prefix-format 'agenda))
4821 (org-set-sorting-strategy 'agenda)
4822 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4823 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4825 (org-agenda-files t)))
4826 (time (org-float-time))
4828 (when (or (not org-diary-last-run-time)
4830 org-diary-last-run-time)
4832 (org-prepare-agenda-buffers files))
4833 (setq org-diary-last-run-time time)
4834 ;; If this is called during org-agenda, don't return any entries to
4835 ;; the calendar. Org Agenda will list these entries itself.
4836 (if org-disable-agenda-to-diary (setq files nil))
4837 (while (setq file (pop files))
4838 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4839 (setq results (append results rtn)))
4841 (concat (org-finalize-agenda-entries results) "\n"))))
4843 ;;; Agenda entry finders
4845 (defun org-agenda-get-day-entries (file date &rest args)
4846 "Does the work for `org-diary' and `org-agenda'.
4847 FILE is the path to a file to be checked for entries. DATE is date like
4848 the one returned by `calendar-current-date'. ARGS are symbols indicating
4849 which kind of entries should be extracted. For details about these, see
4850 the documentation of `org-diary'."
4851 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4852 (let* ((org-startup-folded nil)
4853 (org-startup-align-all-tables nil)
4854 (buffer (if (file-exists-p file)
4855 (org-get-agenda-file-buffer file)
4856 (error "No such file %s" file)))
4857 arg results rtn deadline-results)
4859 ;; If file does not exist, make sure an error message ends up in diary
4860 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4861 (with-current-buffer buffer
4862 (unless (derived-mode-p 'org-mode)
4863 (error "Agenda file %s is not in `org-mode'" file))
4864 (let ((case-fold-search nil))
4867 (if org-agenda-restrict
4868 (narrow-to-region org-agenda-restrict-begin
4869 org-agenda-restrict-end)
4871 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4872 (while (setq arg (pop args))
4874 ((and (eq arg :todo)
4875 (equal date (calendar-gregorian-from-absolute
4877 (setq rtn (org-agenda-get-todos))
4878 (setq results (append results rtn)))
4879 ((eq arg :timestamp)
4880 (setq rtn (org-agenda-get-blocks))
4881 (setq results (append results rtn))
4882 (setq rtn (org-agenda-get-timestamps deadline-results))
4883 (setq results (append results rtn)))
4885 (setq rtn (org-agenda-get-sexps))
4886 (setq results (append results rtn)))
4887 ((eq arg :scheduled)
4888 (setq rtn (org-agenda-get-scheduled deadline-results))
4889 (setq results (append results rtn)))
4891 (setq rtn (org-agenda-get-progress))
4892 (setq results (append results rtn)))
4894 (setq rtn (org-agenda-get-deadlines))
4895 (setq deadline-results (copy-sequence rtn))
4896 (setq results (append results rtn))))))))
4899 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4900 (defun org-agenda-get-todos ()
4901 "Return the TODO information for agenda display."
4902 (let* ((props (list 'face nil
4903 'done-face 'org-agenda-done
4904 'org-not-done-regexp org-not-done-regexp
4905 'org-todo-regexp org-todo-regexp
4906 'org-complex-heading-regexp org-complex-heading-regexp
4907 'mouse-face 'highlight
4909 (format "mouse-2 or RET jump to org file %s"
4910 (abbreviate-file-name buffer-file-name))))
4911 (regexp (format org-heading-keyword-regexp-format
4913 ((and org-select-this-todo-keyword
4914 (equal org-select-this-todo-keyword "*"))
4916 (org-select-this-todo-keyword
4918 (mapconcat 'identity
4920 org-select-this-todo-keyword
4923 (t org-not-done-regexp))))
4924 marker priority category category-pos tags todo-state
4926 (goto-char (point-min))
4927 (while (re-search-forward regexp nil t)
4932 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4933 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4934 (goto-char (1+ beg))
4935 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4937 (goto-char (match-beginning 2))
4938 (setq marker (org-agenda-new-marker (match-beginning 0))
4939 category (org-get-category)
4940 category-pos (get-text-property (point) 'org-category-position)
4942 (buffer-substring (match-beginning 2) (match-end 0)))
4943 tags (org-get-tags-at (point))
4944 txt (org-agenda-format-item "" txt category tags)
4945 priority (1+ (org-get-priority txt))
4946 todo-state (org-get-todo-state))
4947 (org-add-props txt props
4948 'org-marker marker 'org-hd-marker marker
4949 'priority priority 'org-category category
4950 'org-category-position category-pos
4951 'type "todo" 'todo-state todo-state)
4953 (if org-agenda-todo-list-sublevels
4954 (goto-char (match-end 2))
4955 (org-end-of-subtree 'invisible))))
4958 (defun org-agenda-todo-custom-ignore-p (time n)
4959 "Check whether timestamp is farther away then n number of days.
4960 This function is invoked if `org-agenda-todo-ignore-deadlines',
4961 `org-agenda-todo-ignore-scheduled' or
4962 `org-agenda-todo-ignore-timestamp' is set to an integer."
4963 (let ((days (org-days-to-time time)))
4969 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4971 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4972 (when (or org-agenda-todo-ignore-with-date
4973 org-agenda-todo-ignore-scheduled
4974 org-agenda-todo-ignore-deadlines
4975 org-agenda-todo-ignore-timestamp)
4976 (setq end (or end (save-excursion (outline-next-heading) (point))))
4978 (or (and org-agenda-todo-ignore-with-date
4979 (re-search-forward org-ts-regexp end t))
4980 (and org-agenda-todo-ignore-scheduled
4981 (re-search-forward org-scheduled-time-regexp end t)
4983 ((eq org-agenda-todo-ignore-scheduled 'future)
4984 (> (org-days-to-time (match-string 1)) 0))
4985 ((eq org-agenda-todo-ignore-scheduled 'past)
4986 (<= (org-days-to-time (match-string 1)) 0))
4987 ((numberp org-agenda-todo-ignore-scheduled)
4988 (org-agenda-todo-custom-ignore-p
4989 (match-string 1) org-agenda-todo-ignore-scheduled))
4991 (and org-agenda-todo-ignore-deadlines
4992 (re-search-forward org-deadline-time-regexp end t)
4994 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4995 ((eq org-agenda-todo-ignore-deadlines 'far)
4996 (not (org-deadline-close (match-string 1))))
4997 ((eq org-agenda-todo-ignore-deadlines 'future)
4998 (> (org-days-to-time (match-string 1)) 0))
4999 ((eq org-agenda-todo-ignore-deadlines 'past)
5000 (<= (org-days-to-time (match-string 1)) 0))
5001 ((numberp org-agenda-todo-ignore-deadlines)
5002 (org-agenda-todo-custom-ignore-p
5003 (match-string 1) org-agenda-todo-ignore-deadlines))
5004 (t (org-deadline-close (match-string 1)))))
5005 (and org-agenda-todo-ignore-timestamp
5006 (let ((buffer (current-buffer))
5009 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5011 ;; Copy current buffer into a temporary one
5013 (insert-buffer-substring buffer start end)
5014 (goto-char (point-min))
5015 ;; Delete SCHEDULED and DEADLINE items
5016 (while (re-search-forward regexp end t)
5017 (delete-region (match-beginning 0) (match-end 0)))
5018 (goto-char (point-min))
5019 ;; No search for timestamp left
5020 (when (re-search-forward org-ts-regexp nil t)
5022 ((eq org-agenda-todo-ignore-timestamp 'future)
5023 (> (org-days-to-time (match-string 1)) 0))
5024 ((eq org-agenda-todo-ignore-timestamp 'past)
5025 (<= (org-days-to-time (match-string 1)) 0))
5026 ((numberp org-agenda-todo-ignore-timestamp)
5027 (org-agenda-todo-custom-ignore-p
5028 (match-string 1) org-agenda-todo-ignore-timestamp))
5031 (defconst org-agenda-no-heading-message
5032 "No heading for this item in buffer or region.")
5034 (defun org-agenda-get-timestamps (&optional deadline-results)
5035 "Return the date stamp information for agenda display."
5036 (let* ((props (list 'face 'org-agenda-calendar-event
5037 'org-not-done-regexp org-not-done-regexp
5038 'org-todo-regexp org-todo-regexp
5039 'org-complex-heading-regexp org-complex-heading-regexp
5040 'mouse-face 'highlight
5042 (format "mouse-2 or RET jump to org file %s"
5043 (abbreviate-file-name buffer-file-name))))
5044 (d1 (calendar-absolute-from-gregorian date))
5046 (deadline-position-alist
5047 (mapcar (lambda (a) (and (setq mm (get-text-property
5048 0 'org-hd-marker a))
5049 (cons (marker-position mm) a)))
5051 (remove-re org-ts-regexp)
5054 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5058 (car org-time-stamp-formats)
5059 (apply 'encode-time ; DATE bound by calendar
5060 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5062 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5063 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5064 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5065 donep tmp priority category category-pos ee txt timestr tags
5066 b0 b3 e3 head todo-state end-of-match show-all warntime)
5067 (goto-char (point-min))
5068 (while (setq end-of-match (re-search-forward regexp nil t))
5069 (setq b0 (match-beginning 0)
5070 b3 (match-beginning 3) e3 (match-end 3)
5071 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5072 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5074 org-agenda-repeating-timestamp-show-all)))
5076 (and (org-at-date-range-p) (throw :skip nil))
5078 (if (and (match-end 1)
5079 (not (= d1 (org-time-string-to-absolute
5080 (match-string 1) d1 nil show-all
5081 (current-buffer) b0))))
5084 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5086 (setq tmp (buffer-substring (max (point-min)
5087 (- b0 org-ds-keyword-length))
5089 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5090 inactivep (= (char-after b0) ?\[)
5091 deadlinep (string-match org-deadline-regexp tmp)
5092 scheduledp (string-match org-scheduled-regexp tmp)
5093 closedp (and org-agenda-include-inactive-timestamps
5094 (string-match org-closed-string tmp))
5095 clockp (and org-agenda-include-inactive-timestamps
5096 (or (string-match org-clock-string tmp)
5097 (string-match "]-+\\'" tmp)))
5098 warntime (org-entry-get (point) "APPT_WARNTIME")
5099 donep (member todo-state org-done-keywords))
5100 (if (or scheduledp deadlinep closedp clockp
5101 (and donep org-agenda-skip-timestamp-if-done))
5103 (if (string-match ">" timestr)
5104 ;; substring should only run to end of time stamp
5105 (setq timestr (substring timestr 0 (match-end 0))))
5106 (setq marker (org-agenda-new-marker b0)
5107 category (org-get-category b0)
5108 category-pos (get-text-property b0 'org-category-position))
5110 (if (not (re-search-backward org-outline-regexp-bol nil t))
5111 (setq txt org-agenda-no-heading-message)
5112 (goto-char (match-beginning 0))
5113 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5114 (assoc (point) deadline-position-alist))
5116 (setq hdmarker (org-agenda-new-marker)
5117 tags (org-get-tags-at))
5118 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5119 (setq head (or (match-string 1) ""))
5120 (setq txt (org-agenda-format-item
5121 (if inactivep org-agenda-inactive-leader nil)
5122 head category tags timestr
5124 (setq priority (org-get-priority txt))
5125 (org-add-props txt props
5126 'org-marker marker 'org-hd-marker hdmarker)
5127 (org-add-props txt nil 'priority priority
5128 'org-category category 'date date
5129 'org-category-position category-pos
5130 'todo-state todo-state
5134 (if org-agenda-skip-additional-timestamps-same-entry
5135 (outline-next-heading)
5136 (goto-char end-of-match))))
5139 (defun org-agenda-get-sexps ()
5140 "Return the sexp information for agenda display."
5141 (require 'diary-lib)
5142 (let* ((props (list 'face 'org-agenda-calendar-sexp
5143 'mouse-face 'highlight
5145 (format "mouse-2 or RET jump to org file %s"
5146 (abbreviate-file-name buffer-file-name))))
5148 marker category extra category-pos ee txt tags entry
5149 result beg b sexp sexp-entry todo-state warntime)
5150 (goto-char (point-min))
5151 (while (re-search-forward regexp nil t)
5154 (setq beg (match-beginning 0))
5155 (goto-char (1- (match-end 0)))
5158 (setq sexp (buffer-substring b (point)))
5159 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5160 (org-trim (match-string 1))
5162 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5164 (setq marker (org-agenda-new-marker beg)
5165 category (org-get-category beg)
5166 category-pos (get-text-property beg 'org-category-position)
5167 tags (save-excursion (org-backward-heading-same-level 0)
5169 todo-state (org-get-todo-state)
5170 warntime (org-entry-get (point) "APPT_WARNTIME"))
5172 (dolist (r (if (stringp result)
5174 result)) ;; we expect a list here
5175 (when (and org-agenda-diary-sexp-prefix
5176 (string-match org-agenda-diary-sexp-prefix r))
5177 (setq extra (match-string 0 r)
5178 r (replace-match "" nil nil r)))
5179 (if (string-match "\\S-" r)
5181 (setq txt "SEXP entry returned empty string"))
5183 (setq txt (org-agenda-format-item
5184 extra txt category tags 'time))
5185 (org-add-props txt props 'org-marker marker)
5186 (org-add-props txt nil
5187 'org-category category 'date date 'todo-state todo-state
5188 'org-category-position category-pos 'tags tags
5189 'type "sexp" 'warntime warntime)
5193 ;; Calendar sanity: define some functions that are independent of
5194 ;; `calendar-date-style'.
5195 ;; Normally I would like to use ISO format when calling the diary functions,
5196 ;; but to make sure we still have Emacs 22 compatibility we bind
5197 ;; also `european-calendar-style' and use european format
5198 (defun org-anniversary (year month day &optional mark)
5199 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5201 (let ((calendar-date-style 'european) (european-calendar-style t))
5202 (diary-anniversary day month year mark))))
5203 (defun org-cyclic (N year month day &optional mark)
5204 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5206 (let ((calendar-date-style 'european) (european-calendar-style t))
5207 (diary-cyclic N day month year mark))))
5208 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5209 "Like `diary-block', but with fixed (ISO) order of arguments."
5211 (let ((calendar-date-style 'european) (european-calendar-style t))
5212 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5213 (defun org-date (year month day &optional mark)
5214 "Like `diary-date', but with fixed (ISO) order of arguments."
5216 (let ((calendar-date-style 'european) (european-calendar-style t))
5217 (diary-date day month year mark))))
5218 (defalias 'org-float 'diary-float)
5220 ;; Define the` org-class' function
5221 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5222 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5223 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5224 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5225 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5226 `holidays', then any date that is known by the Emacs calendar to be a
5227 holiday will also be skipped."
5228 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5229 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5230 (d (calendar-absolute-from-gregorian date)))
5234 (= (calendar-day-of-week date) dayname)
5235 (or (not skip-weeks)
5238 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5239 (not (and (memq 'holidays skip-weeks)
5240 (calendar-check-holidays date)))
5243 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5244 "Like `org-class', but honor `calendar-date-style'.
5245 The order of the first 2 times 3 arguments depends on the variable
5246 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5247 So for American calendars, give this as MONTH DAY YEAR, for European as
5248 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5249 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5250 is any number of ISO weeks in the block period for which the item should
5253 This function is here only for backward compatibility and it is deprecated,
5254 please use `org-class' instead."
5255 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5256 (date2 (org-order-calendar-date-args m2 d2 y2)))
5258 (nth 2 date1) (car date1) (nth 1 date1)
5259 (nth 2 date2) (car date2) (nth 1 date2)
5260 dayname skip-weeks)))
5261 (make-obsolete 'org-diary-class 'org-class "")
5263 (defvar org-agenda-show-log-scoped) ;; dynamically scope in ̀org-timeline' or`org-agenda-list'
5264 (defalias 'org-get-closed 'org-agenda-get-progress)
5265 (defun org-agenda-get-progress ()
5266 "Return the logged TODO entries for agenda display."
5267 (let* ((props (list 'mouse-face 'highlight
5268 'org-not-done-regexp org-not-done-regexp
5269 'org-todo-regexp org-todo-regexp
5270 'org-complex-heading-regexp org-complex-heading-regexp
5272 (format "mouse-2 or RET jump to org file %s"
5273 (abbreviate-file-name buffer-file-name))))
5274 (items (if (consp org-agenda-show-log-scoped)
5275 org-agenda-show-log-scoped
5276 (if (eq org-agenda-show-log-scoped 'clockcheck)
5278 org-agenda-log-mode-items)))
5282 (if (memq 'closed items) (concat "\\<" org-closed-string))
5283 (if (memq 'clock items) (concat "\\<" org-clock-string))
5284 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5285 (parts-re (if parts (mapconcat 'identity parts "\\|")
5286 (error "`org-agenda-log-mode-items' is empty")))
5288 "\\(" parts-re "\\)"
5293 (car org-time-stamp-formats)
5294 (apply 'encode-time ; DATE bound by calendar
5295 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5297 (org-agenda-search-headline-for-time nil)
5298 marker hdmarker priority category category-pos tags closedp
5299 statep clockp state ee txt extra timestr rest clocked)
5300 (goto-char (point-min))
5301 (while (re-search-forward regexp nil t)
5304 (setq marker (org-agenda-new-marker (match-beginning 0))
5305 closedp (equal (match-string 1) org-closed-string)
5306 statep (equal (string-to-char (match-string 1)) ?-)
5307 clockp (not (or closedp statep))
5308 state (and statep (match-string 2))
5309 category (org-get-category (match-beginning 0))
5310 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5311 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5312 (when (string-match "\\]" timestr)
5313 ;; substring should only run to end of time stamp
5314 (setq rest (substring timestr (match-end 0))
5315 timestr (substring timestr 0 (match-end 0)))
5316 (if (and (not closedp) (not statep)
5317 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5319 (progn (setq timestr (concat (substring timestr 0 -1)
5320 "-" (match-string 1 rest) "]"))
5321 (setq clocked (match-string 2 rest)))
5322 (setq clocked "-")))
5326 ((not org-agenda-log-mode-add-notes) nil)
5328 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5331 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5332 (match-string 1)))))
5333 (if (not (re-search-backward org-outline-regexp-bol nil t))
5334 (setq txt org-agenda-no-heading-message)
5335 (goto-char (match-beginning 0))
5336 (setq hdmarker (org-agenda-new-marker)
5337 tags (org-get-tags-at))
5338 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5339 (setq txt (match-string 1))
5341 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5342 (setq txt (concat (substring txt 0 (match-beginning 1))
5343 " - " extra " " (match-string 2 txt)))
5344 (setq txt (concat txt " - " extra))))
5345 (setq txt (org-agenda-format-item
5347 (closedp "Closed: ")
5348 (statep (concat "State: (" state ")"))
5349 (t (concat "Clocked: (" clocked ")")))
5350 txt category tags timestr)))
5351 (setq priority 100000)
5352 (org-add-props txt props
5353 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5354 'priority priority 'org-category category
5355 'org-category-position category-pos
5356 'type "closed" 'date date
5357 'undone-face 'org-warning 'done-face 'org-agenda-done)
5359 (goto-char (point-at-eol))))
5362 (defun org-agenda-show-clocking-issues ()
5363 "Add overlays, showing issues with clocking.
5364 See also the user option `org-agenda-clock-consistency-checks'."
5366 (let* ((pl org-agenda-clock-consistency-checks)
5367 (re (concat "^[ \t]*"
5370 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5371 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5374 (maxtime (org-hh:mm-string-to-minutes
5375 (or (plist-get pl :max-duration) "24:00")))
5376 (mintime (org-hh:mm-string-to-minutes
5377 (or (plist-get pl :min-duration) 0)))
5378 (maxgap (org-hh:mm-string-to-minutes
5379 ;; default 30:00 means never complain
5380 (or (plist-get pl :max-gap) "30:00")))
5381 (gapok (mapcar 'org-hh:mm-string-to-minutes
5382 (plist-get pl :gap-ok-around)))
5383 (def-face (or (plist-get pl :default-face)
5384 '((:background "DarkRed") (:foreground "white"))))
5385 issue face m te ts dt ov)
5386 (goto-char (point-min))
5387 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5388 (setq issue nil face def-face)
5390 (setq m (org-get-at-bol 'org-marker)
5392 (unless (and m (markerp m))
5393 (setq issue "No valid clock line") (throw 'next t))
5394 (org-with-point-at m
5396 (goto-char (point-at-bol))
5397 (unless (looking-at re)
5398 (error "No valid Clock line")
5400 (unless (match-end 3)
5401 (setq issue "No end time"
5402 face (or (plist-get pl :no-end-time-face) face))
5404 (setq ts (match-string 1)
5407 (apply 'encode-time (org-parse-time-string ts)))
5409 (apply 'encode-time (org-parse-time-string te)))
5412 ((> dt (* 60 maxtime))
5413 ;; a very long clocking chunk
5414 (setq issue (format "Clocking interval is very long: %s"
5415 (org-minutes-to-hh:mm-string
5416 (floor (/ (float dt) 60.))))
5417 face (or (plist-get pl :long-face) face)))
5418 ((< dt (* 60 mintime))
5419 ;; a very short clocking chunk
5420 (setq issue (format "Clocking interval is very short: %s"
5421 (org-minutes-to-hh:mm-string
5422 (floor (/ (float dt) 60.))))
5423 face (or (plist-get pl :short-face) face)))
5424 ((and (> tlend 0) (< ts tlend))
5425 ;; Two clock entries are overlapping
5426 (setq issue (format "Clocking overlap: %d minutes"
5427 (/ (- tlend ts) 60))
5428 face (or (plist-get pl :overlap-face) face)))
5429 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5430 ;; There is a gap, lets see if we need to report it
5431 (unless (org-agenda-check-clock-gap tlend ts gapok)
5432 (setq issue (format "Clocking gap: %d minutes"
5433 (/ (- ts tlend) 60))
5434 face (or (plist-get pl :gap-face) face))))
5436 (setq tlend (or te tlend) tlstart (or ts tlstart))
5438 ;; OK, there was some issue, add an overlay to show the issue
5439 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5440 (overlay-put ov 'before-string
5443 (format "%-43s" (concat " " issue))
5447 (overlay-put ov 'evaporate t)))))
5449 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5450 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5453 ;; there are no OK times for gaps...
5455 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5456 ;; This is more than 24 hours, so it is OK.
5457 ;; because we have at least one OK time, that must be in the
5458 ;; 24 hour interval.
5460 ;; We have a shorter gap.
5461 ;; Now we have to get the minute of the day when these times are
5462 (let* ((t1dec (decode-time (seconds-to-time t1)))
5463 (t2dec (decode-time (seconds-to-time t2)))
5464 ;; compute the minute on the day
5465 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5466 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5468 ;; if min2 is smaller than min1, this means it is on the next day.
5469 ;; Wrap it to after midnight.
5470 (setq min2 (+ min2 1440)))
5471 ;; Now check if any of the OK times is in the gap
5473 ;; Wrap the time to after midnight if necessary
5474 (if (< x min1) (setq x (+ x 1440)))
5475 ;; Check if in interval
5476 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5478 ;; Nope, this gap is not OK
5481 (defun org-agenda-get-deadlines ()
5482 "Return the deadline information for agenda display."
5483 (let* ((props (list 'mouse-face 'highlight
5484 'org-not-done-regexp org-not-done-regexp
5485 'org-todo-regexp org-todo-regexp
5486 'org-complex-heading-regexp org-complex-heading-regexp
5488 (format "mouse-2 or RET jump to org file %s"
5489 (abbreviate-file-name buffer-file-name))))
5490 (regexp org-deadline-time-regexp)
5491 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5492 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5493 d2 diff dfrac wdays pos pos1 category category-pos
5494 tags suppress-prewarning ee txt head face s todo-state
5495 show-all upcomingp donep timestr warntime)
5496 (goto-char (point-min))
5497 (while (re-search-forward regexp nil t)
5498 (setq suppress-prewarning nil)
5501 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5503 (string-match org-scheduled-time-regexp
5504 (buffer-substring (point-at-bol)
5506 (setq suppress-prewarning
5507 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5508 org-agenda-skip-deadline-prewarning-if-scheduled
5510 (setq s (match-string 1)
5512 pos (1- (match-beginning 1))
5513 todo-state (save-match-data (org-get-todo-state))
5514 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5516 org-agenda-repeating-timestamp-show-all))
5517 d2 (org-time-string-to-absolute
5518 (match-string 1) d1 'past show-all
5519 (current-buffer) pos)
5521 wdays (if suppress-prewarning
5522 (let ((org-deadline-warning-days suppress-prewarning))
5525 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5526 upcomingp (and todayp (> diff 0)))
5527 ;; When to show a deadline in the calendar:
5528 ;; If the expiration is within wdays warning time.
5529 ;; Past-due deadlines are only shown on the current date
5530 (if (and (or (and (<= diff wdays)
5531 (and todayp (not org-agenda-only-exact-dates)))
5534 ;; (setq todo-state (org-get-todo-state))
5535 (setq donep (member todo-state org-done-keywords))
5537 (or org-agenda-skip-deadline-if-done
5540 (setq category (org-get-category)
5541 warntime (org-entry-get (point) "APPT_WARNTIME")
5542 category-pos (get-text-property (point) 'org-category-position))
5543 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5544 (setq txt org-agenda-no-heading-message)
5545 (goto-char (match-end 0))
5546 (setq pos1 (match-beginning 0))
5547 (setq tags (org-get-tags-at pos1))
5548 (setq head (buffer-substring-no-properties
5550 (progn (skip-chars-forward "^\r\n")
5552 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5554 (concat (substring s (match-beginning 1)) " "))
5555 (setq timestr 'time))
5556 (setq txt (org-agenda-format-item
5558 (car org-agenda-deadline-leaders)
5560 (nth 1 org-agenda-deadline-leaders))
5562 (nth 1 org-agenda-deadline-leaders)
5564 (format (nth 1 org-agenda-deadline-leaders)
5567 (if (not (= diff 0)) nil timestr)))))
5569 (setq face (org-agenda-deadline-face dfrac))
5570 (org-add-props txt props
5571 'org-marker (org-agenda-new-marker pos)
5573 'org-hd-marker (org-agenda-new-marker pos1)
5574 'priority (+ (- diff)
5575 (org-get-priority txt))
5576 'org-category category
5577 'org-category-position category-pos
5578 'todo-state todo-state
5579 'type (if upcomingp "upcoming-deadline" "deadline")
5580 'date (if upcomingp date d2)
5581 'face (if donep 'org-agenda-done face)
5582 'undone-face face 'done-face 'org-agenda-done)
5586 (defun org-agenda-deadline-face (fraction)
5587 "Return the face to displaying a deadline item.
5588 FRACTION is what fraction of the head-warning time has passed."
5589 (let ((faces org-agenda-deadline-faces) f)
5591 (while (setq f (pop faces))
5592 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5594 (defun org-agenda-get-scheduled (&optional deadline-results)
5595 "Return the scheduled information for agenda display."
5596 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5597 'org-todo-regexp org-todo-regexp
5598 'org-complex-heading-regexp org-complex-heading-regexp
5599 'done-face 'org-agenda-done
5600 'mouse-face 'highlight
5602 (format "mouse-2 or RET jump to org file %s"
5603 (abbreviate-file-name buffer-file-name))))
5604 (regexp org-scheduled-time-regexp)
5605 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5606 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5608 (deadline-position-alist
5609 (mapcar (lambda (a) (and (setq mm (get-text-property
5610 0 'org-hd-marker a))
5611 (cons (marker-position mm) a)))
5613 d2 diff pos pos1 category category-pos tags donep
5614 ee txt head pastschedp todo-state face timestr s habitp show-all
5615 did-habit-check-p warntime)
5616 (goto-char (point-min))
5617 (while (re-search-forward regexp nil t)
5620 (setq s (match-string 1)
5622 pos (1- (match-beginning 1))
5623 todo-state (save-match-data (org-get-todo-state))
5624 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5626 org-agenda-repeating-timestamp-show-all))
5627 d2 (org-time-string-to-absolute
5628 (match-string 1) d1 'past show-all
5629 (current-buffer) pos)
5631 warntime (org-entry-get (point) "APPT_WARNTIME"))
5632 (setq pastschedp (and todayp (< diff 0)))
5633 (setq did-habit-check-p nil)
5634 ;; When to show a scheduled item in the calendar:
5635 ;; If it is on or past the date.
5636 (when (or (and (< diff 0)
5637 (< (abs diff) org-scheduled-past-days)
5638 (and todayp (not org-agenda-only-exact-dates)))
5640 ;; org-is-habit-p uses org-entry-get, which is expansive
5641 ;; so we go extra mile to only call it once
5643 org-habit-show-all-today
5644 (setq did-habit-check-p t)
5645 (setq habitp (and (functionp 'org-is-habit-p)
5646 (org-is-habit-p)))))
5648 (setq donep (member todo-state org-done-keywords))
5650 (or org-agenda-skip-scheduled-if-done
5652 (and (functionp 'org-is-habit-p)
5655 (setq habitp (if did-habit-check-p habitp
5656 (and (functionp 'org-is-habit-p)
5658 (setq category (org-get-category)
5659 category-pos (get-text-property (point) 'org-category-position))
5660 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5661 (setq txt org-agenda-no-heading-message)
5662 (goto-char (match-end 0))
5663 (setq pos1 (match-beginning 0))
5665 (if (or (not org-habit-show-habits)
5667 org-habit-show-habits-only-for-today))
5670 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5671 (and org-agenda-skip-scheduled-if-deadline-is-shown
5673 (setq mm (assoc pos1 deadline-position-alist)))
5675 (setq tags (org-get-tags-at))
5676 (setq head (buffer-substring-no-properties
5678 (progn (skip-chars-forward "^\r\n") (point))))
5679 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5681 (concat (substring s (match-beginning 1)) " "))
5682 (setq timestr 'time))
5683 (setq txt (org-agenda-format-item
5685 (car org-agenda-scheduled-leaders)
5686 (format (nth 1 org-agenda-scheduled-leaders)
5689 (if (not (= diff 0)) nil timestr)
5694 ((and (not habitp) pastschedp)
5695 'org-scheduled-previously)
5696 (todayp 'org-scheduled-today)
5698 habitp (and habitp (org-habit-parse-todo)))
5699 (org-add-props txt props
5701 'face (if donep 'org-agenda-done face)
5702 'org-marker (org-agenda-new-marker pos)
5703 'org-hd-marker (org-agenda-new-marker pos1)
5704 'type (if pastschedp "past-scheduled" "scheduled")
5705 'date (if pastschedp d2 date)
5707 'priority (if habitp
5708 (org-habit-get-priority habitp)
5709 (+ 94 (- 5 diff) (org-get-priority txt)))
5710 'org-category category
5711 'category-position category-pos
5713 'todo-state todo-state)
5717 (defun org-agenda-get-blocks ()
5718 "Return the date-range information for agenda display."
5719 (let* ((props (list 'face nil
5720 'org-not-done-regexp org-not-done-regexp
5721 'org-todo-regexp org-todo-regexp
5722 'org-complex-heading-regexp org-complex-heading-regexp
5723 'mouse-face 'highlight
5725 (format "mouse-2 or RET jump to org file %s"
5726 (abbreviate-file-name buffer-file-name))))
5727 (regexp org-tr-regexp)
5728 (d0 (calendar-absolute-from-gregorian date))
5729 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
5730 todo-state tags pos head donep)
5731 (goto-char (point-min))
5732 (while (re-search-forward regexp nil t)
5736 (let ((start-time (match-string 1))
5737 (end-time (match-string 2)))
5738 (setq s1 (match-string 1)
5740 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5741 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5742 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5743 ;; Only allow days between the limits, because the normal
5744 ;; date stamps will catch the limits.
5746 (setq todo-state (org-get-todo-state))
5747 (setq donep (member todo-state org-done-keywords))
5748 (if (and donep org-agenda-skip-timestamp-if-done)
5750 (setq marker (org-agenda-new-marker (point)))
5751 (setq category (org-get-category)
5752 category-pos (get-text-property (point) 'org-category-position))
5753 (if (not (re-search-backward org-outline-regexp-bol nil t))
5754 (setq txt org-agenda-no-heading-message)
5755 (goto-char (match-beginning 0))
5756 (setq hdmarker (org-agenda-new-marker (point)))
5757 (setq tags (org-get-tags-at))
5758 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5759 (setq head (match-string 1))
5761 (if org-agenda-remove-timeranges-from-blocks
5763 "<" (regexp-quote s1) ".*?>"
5765 "<" (regexp-quote s2) ".*?>")
5767 (setq txt (org-agenda-format-item
5769 (nth (if (= d1 d2) 0 1)
5770 org-agenda-timerange-leaders)
5771 (1+ (- d0 d1)) (1+ (- d2 d1)))
5773 (cond ((and (= d1 d0) (= d2 d0))
5774 (concat "<" start-time ">--<" end-time ">"))
5776 (concat "<" start-time ">"))
5778 (concat "<" end-time ">")))
5780 (org-add-props txt props
5781 'org-marker marker 'org-hd-marker hdmarker
5782 'type "block" 'date date
5783 'todo-state todo-state
5784 'priority (org-get-priority txt) 'org-category category
5785 'org-category-position category-pos)
5788 ;; Sort the entries by expiration date.
5791 ;;; Agenda presentation and sorting
5793 (defvar org-prefix-has-time nil
5794 "A flag, set by `org-compile-prefix-format'.
5795 The flag is set if the currently compiled format contains a `%t'.")
5796 (defvar org-prefix-has-tag nil
5797 "A flag, set by `org-compile-prefix-format'.
5798 The flag is set if the currently compiled format contains a `%T'.")
5799 (defvar org-prefix-has-effort nil
5800 "A flag, set by `org-compile-prefix-format'.
5801 The flag is set if the currently compiled format contains a `%e'.")
5802 (defvar org-prefix-category-length nil
5803 "Used by `org-compile-prefix-format' to remember the category field width.")
5804 (defvar org-prefix-category-max-length nil
5805 "Used by `org-compile-prefix-format' to remember the category field width.")
5807 (defun org-agenda-get-category-icon (category)
5808 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5809 (dolist (entry org-agenda-category-icon-alist)
5810 (when (org-string-match-p (car entry) category)
5811 (if (listp (cadr entry))
5812 (return (cadr entry))
5813 (return (apply 'create-image (cdr entry)))))))
5815 (defun org-agenda-format-item (extra txt &optional category tags dotime
5817 "Format TXT to be inserted into the agenda buffer.
5818 In particular, it adds the prefix and corresponding text properties. EXTRA
5819 must be a string and replaces the `%s' specifier in the prefix format.
5820 CATEGORY (string, symbol or nil) may be used to overrule the default
5821 category taken from local variable or file name. It will replace the `%c'
5822 specifier in the format. DOTIME, when non-nil, indicates that a
5823 time-of-day should be extracted from TXT for sorting of this entry, and for
5824 the `%t' specifier in the format. When DOTIME is a string, this string is
5825 searched for a time before TXT is. TAGS can be the tags of the headline.
5826 Any match of REMOVE-RE will be removed from TXT."
5827 ;; We keep the org-prefix-* variable values along with a compiled
5828 ;; formatter, so that multiple agendas existing at the same time, do
5829 ;; not step on each other toes.
5831 ;; It was inconvenient to make these variables buffer local in
5832 ;; Agenda buffers, because this function expects to be called with
5833 ;; the buffer where item comes from being current, and not agenda
5835 (let* ((bindings (car org-prefix-format-compiled))
5836 (formatter (cadr org-prefix-format-compiled)))
5837 (loop for (var value) in bindings
5840 ;; Diary entries sometimes have extra whitespace at the beginning
5841 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5843 ;; Fix the tags part in txt
5844 (setq txt (org-agenda-fix-displayed-tags
5846 org-agenda-show-inherited-tags
5847 org-agenda-hide-tags-regexp))
5848 (let* ((category (or category
5849 (if (stringp org-category)
5851 (and org-category (symbol-name org-category)))
5852 (if buffer-file-name
5853 (file-name-sans-extension
5854 (file-name-nondirectory buffer-file-name))
5856 (category-icon (org-agenda-get-category-icon category))
5857 (category-icon (if category-icon
5858 (propertize " " 'display category-icon)
5860 ;; time, tag, effort are needed for the eval of the prefix format
5861 (tag (if tags (nth (1- (length tags)) tags) ""))
5863 (ts (if dotime (concat
5864 (if (stringp dotime) dotime "")
5865 (and org-agenda-search-headline-for-time txt))))
5866 (time-of-day (and dotime (org-get-time-of-day ts)))
5867 stamp plain s0 s1 s2 rtn srp l
5868 duration thecategory)
5869 (and (derived-mode-p 'org-mode) buffer-file-name
5870 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5871 (when (and dotime time-of-day)
5872 ;; Extract starting and ending time and move them to prefix
5873 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5874 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5875 (setq s0 (match-string 0 ts)
5876 srp (and stamp (match-end 3))
5877 s1 (match-string (if plain 1 2) ts)
5878 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5880 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5881 ;; them, we might want to remove them there to avoid duplication.
5882 ;; The user can turn this off with a variable.
5883 (if (and org-prefix-has-time
5884 org-agenda-remove-times-when-in-prefix (or stamp plain)
5885 (string-match (concat (regexp-quote s0) " *") txt)
5886 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5887 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5888 (= (match-beginning 0) 0)
5890 (setq txt (replace-match "" nil nil txt))))
5891 ;; Normalize the time(s) to 24 hour
5892 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5893 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5895 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5896 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5898 (org-minutes-to-hh:mm-string
5899 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5901 ;; Compute the duration
5903 (setq duration (- (org-hh:mm-string-to-minutes s2)
5904 (org-hh:mm-string-to-minutes s1)))))
5906 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5908 ;; Tags are in the string
5909 (if (or (eq org-agenda-remove-tags t)
5910 (and org-agenda-remove-tags
5911 org-prefix-has-tag))
5912 (setq txt (replace-match "" t t txt))
5913 (setq txt (replace-match
5914 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5915 (match-string 2 txt))
5917 (when (derived-mode-p 'org-mode)
5921 (or (get-text-property 0 'org-hd-marker txt)
5922 (get-text-property 0 'org-marker txt)))
5925 (setq neffort (org-duration-string-to-minutes effort)
5926 effort (setq effort (concat "[" effort "]")))))
5927 ;; prevent erroring out with %e format when there is no effort
5928 (or effort (setq effort ""))
5931 (while (string-match remove-re txt)
5932 (setq txt (replace-match "" t t txt))))
5934 ;; Set org-heading property on `txt' to mark the start of the
5936 (add-text-properties 0 (length txt) '(org-heading t) txt)
5938 ;; Prepare the variables needed in the eval of the compiled format
5939 (setq time (cond (s2 (concat
5940 (org-agenda-time-of-day-to-ampm-maybe s1)
5941 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5942 (if org-agenda-timegrid-use-ampm " ")))
5944 (org-agenda-time-of-day-to-ampm-maybe s1)
5945 (if org-agenda-timegrid-use-ampm
5949 extra (or (and (not habitp) extra) "")
5950 category (if (symbolp category) (symbol-name category) category)
5951 thecategory (copy-sequence category))
5952 (if (string-match org-bracket-link-regexp category)
5954 (setq l (if (match-end 3)
5955 (- (match-end 3) (match-beginning 3))
5956 (- (match-end 1) (match-beginning 1))))
5957 (when (< l (or org-prefix-category-length 0))
5958 (setq category (copy-sequence category))
5959 (org-add-props category nil
5960 'extra-space (make-string
5961 (- org-prefix-category-length l 1) ?\ ))))
5962 (if (and org-prefix-category-max-length
5963 (>= (length category) org-prefix-category-max-length))
5964 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5965 ;; Evaluate the compiled format
5966 (setq rtn (concat (eval formatter) txt))
5968 ;; And finally add the text properties
5969 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5970 (org-add-props rtn nil
5971 'org-category (if thecategory (downcase thecategory) category)
5972 'tags (mapcar 'org-downcase-keep-props tags)
5973 'org-highest-priority org-highest-priority
5974 'org-lowest-priority org-lowest-priority
5975 'time-of-day time-of-day
5978 'effort-minutes neffort
5982 'format org-prefix-format-compiled
5985 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5986 "Remove tags string from TXT, and add a modified list of tags.
5987 The modified list may contain inherited tags, and tags matched by
5988 `org-agenda-hide-tags-regexp' will be removed."
5989 (when (or add-inherited hide-re)
5990 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5991 (setq txt (substring txt 0 (match-beginning 0))))
5994 (mapcar (lambda (tg)
5995 (if (or (and hide-re (string-match hide-re tg))
5996 (and (not add-inherited)
5997 (get-text-property 0 'inherited tg)))
6002 (let ((have-i (get-text-property 0 'inherited (car tags)))
6004 (setq txt (concat txt " :"
6007 (setq i (get-text-property 0 'inherited x))
6008 (if (and have-i (not i))
6014 (if have-i "::" ":"))))))
6017 (defun org-downcase-keep-props (s)
6018 (let ((props (text-properties-at 0 s)))
6019 (setq s (downcase s))
6020 (add-text-properties 0 (length s) props s)
6023 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6024 (defvar org-agenda-sorting-strategy-selected nil)
6026 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6028 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6029 ((and todayp (member 'today (car org-agenda-time-grid))))
6030 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6031 ((member 'weekly (car org-agenda-time-grid)))
6032 (t (throw 'exit list)))
6033 (let* ((have (delq nil (mapcar
6034 (lambda (x) (get-text-property 1 'time-of-day x))
6036 (string (nth 1 org-agenda-time-grid))
6037 (gridtimes (nth 2 org-agenda-time-grid))
6038 (req (car org-agenda-time-grid))
6039 (remove (member 'remove-match req))
6041 (if (and (member 'require-timed req) (not have))
6042 ;; don't show empty grid
6044 (while (setq time (pop gridtimes))
6045 (unless (and remove (member time have))
6046 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6047 (push (org-agenda-format-item
6049 (concat (substring time 0 -2) ":" (substring time -2)))
6052 2 (length (car new)) 'face 'org-time-grid (car new))))
6053 (when (and todayp org-agenda-show-current-time-in-grid)
6054 (push (org-agenda-format-item
6056 org-agenda-current-time-string
6058 (format-time-string "%H:%M "))
6061 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6063 (if (member 'time-up org-agenda-sorting-strategy-selected)
6065 (append list new)))))
6067 (defun org-compile-prefix-format (key)
6068 "Compile the prefix format into a Lisp form that can be evaluated.
6069 The resulting form and associated variable bindings is returned
6070 and stored in the variable `org-prefix-format-compiled'."
6071 (setq org-prefix-has-time nil org-prefix-has-tag nil
6072 org-prefix-category-length nil
6073 org-prefix-has-effort nil)
6075 ((stringp org-agenda-prefix-format)
6076 org-agenda-prefix-format)
6077 ((assq key org-agenda-prefix-format)
6078 (cdr (assq key org-agenda-prefix-format)))
6079 (t " %-12:c%?-12t% s")))
6081 varform vars var e c f opt)
6082 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
6084 (setq var (or (cdr (assoc (match-string 4 s)
6085 '(("c" . category) ("t" . time) ("s" . extra)
6086 ("i" . category-icon) ("T" . tag) ("e" . effort))))
6088 c (or (match-string 3 s) "")
6089 opt (match-beginning 1)
6090 start (1+ (match-beginning 0)))
6091 (if (equal var 'time) (setq org-prefix-has-time t))
6092 (if (equal var 'tag) (setq org-prefix-has-tag t))
6093 (if (equal var 'effort) (setq org-prefix-has-effort t))
6094 (setq f (concat "%" (match-string 2 s) "s"))
6095 (when (equal var 'category)
6096 (setq org-prefix-category-length
6097 (floor (abs (string-to-number (match-string 2 s)))))
6098 (setq org-prefix-category-max-length
6099 (let ((x (match-string 2 s)))
6101 (if (string-match "\\.[0-9]+" x)
6102 (string-to-number (substring (match-string 0 x) 1)))))))
6104 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6107 `(if (equal "" ,var)
6109 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6110 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6111 (setq s (replace-match "%s" t nil s))
6112 (push varform vars))
6113 (setq vars (nreverse vars))
6114 (with-current-buffer org-agenda-buffer
6115 (setq org-prefix-format-compiled
6117 `((org-prefix-has-time ,org-prefix-has-time)
6118 (org-prefix-has-tag ,org-prefix-has-tag)
6119 (org-prefix-category-length ,org-prefix-category-length)
6120 (org-prefix-has-effort ,org-prefix-has-effort))
6121 `(format ,s ,@vars))))))
6123 (defun org-set-sorting-strategy (key)
6124 (if (symbolp (car org-agenda-sorting-strategy))
6126 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6127 (setq org-agenda-sorting-strategy-selected
6128 (or (cdr (assq key org-agenda-sorting-strategy))
6129 (cdr (assq 'agenda org-agenda-sorting-strategy))
6130 '(time-up category-keep priority-down)))))
6132 (defun org-get-time-of-day (s &optional string mod24)
6133 "Check string S for a time of day.
6134 If found, return it as a military time number between 0 and 2400.
6135 If not found, return nil.
6136 The optional STRING argument forces conversion into a 5 character wide string
6140 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6141 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6142 (let* ((h (string-to-number (match-string 1 s)))
6143 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6144 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6145 (am-p (equal ampm "am"))
6146 (h1 (cond ((not ampm) h)
6147 ((= h 12) (if am-p 0 12))
6148 (t (+ h (if am-p 0 12)))))
6149 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6151 (t0 (+ (* 100 h2) m))
6152 (t1 (concat (if (>= h1 24) "+" " ")
6153 (if (and org-agenda-time-leading-zero
6154 (< t0 1000)) "0" "")
6155 (if (< t0 100) "0" "")
6156 (if (< t0 10) "0" "")
6157 (int-to-string t0))))
6158 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6160 (defvar org-agenda-before-sorting-filter-function nil
6161 "Function to be applied to agenda items prior to sorting.
6162 Prior to sorting also means just before they are inserted into the agenda.
6164 To aid sorting, you may revisit the original entries and add more text
6165 properties which will later be used by the sorting functions.
6167 The function should take a string argument, an agenda line.
6168 It has access to the text properties in that line, which contain among
6169 other things, the property `org-hd-marker' that points to the entry
6170 where the line comes from. Note that not all lines going into the agenda
6171 have this property, only most.
6173 The function should return the modified string. It is probably best
6174 to ONLY change text properties.
6176 You can also use this function as a filter, by returning nil for lines
6177 you don't want to have in the agenda at all. For this application, you
6178 could bind the variable in the options section of a custom command.")
6180 (defun org-finalize-agenda-entries (list &optional nosort)
6181 "Sort and concatenate the agenda items."
6182 (setq list (mapcar 'org-agenda-highlight-todo list))
6185 (when org-agenda-before-sorting-filter-function
6186 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6187 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6189 (defun org-agenda-highlight-todo (x)
6190 (let ((org-done-keywords org-done-keywords-for-agenda)
6191 (case-fold-search nil)
6195 (beginning-of-line 1)
6196 (setq re (org-get-at-bol 'org-todo-regexp))
6197 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6198 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6199 (add-text-properties (match-beginning 0) (match-end 1)
6200 (list 'face (org-get-todo-face 1)))
6201 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6202 (delete-region (match-beginning 1) (1- (match-end 0)))
6203 (goto-char (match-beginning 1))
6204 (insert (format org-agenda-todo-keyword-format s)))))
6205 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6206 (setq re (get-text-property 0 'org-todo-regexp x))
6208 ;; Test `pl' because if there's no heading content,
6209 ;; there's no point matching to highlight. Note
6210 ;; that if we didn't test `pl' first, and there
6211 ;; happened to be no keyword from `org-todo-regexp'
6212 ;; on this heading line, then the `equal' comparison
6213 ;; afterwards would spuriously succeed in the case
6214 ;; where `pl' is nil -- causing an args-out-of-range
6215 ;; error when we try to add text properties to text
6216 ;; that isn't there.
6218 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6220 (add-text-properties
6221 (or (match-end 1) (match-end 0)) (match-end 0)
6222 (list 'face (org-get-todo-face (match-string 2 x)))
6225 (setq x (concat (substring x 0 (match-end 1))
6226 (format org-agenda-todo-keyword-format
6228 (org-add-props " " (text-properties-at 0 x))
6229 (substring x (match-end 3)))))))
6232 (defsubst org-cmp-priority (a b)
6233 "Compare the priorities of string A and B."
6234 (let ((pa (or (get-text-property 1 'priority a) 0))
6235 (pb (or (get-text-property 1 'priority b) 0)))
6236 (cond ((> pa pb) +1)
6239 (defsubst org-cmp-effort (a b)
6240 "Compare the effort values of string A and B."
6241 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6242 (ea (or (get-text-property 1 'effort-minutes a) def))
6243 (eb (or (get-text-property 1 'effort-minutes b) def)))
6244 (cond ((> ea eb) +1)
6247 (defsubst org-cmp-category (a b)
6248 "Compare the string values of categories of strings A and B."
6249 (let ((ca (or (get-text-property 1 'org-category a) ""))
6250 (cb (or (get-text-property 1 'org-category b) "")))
6251 (cond ((string-lessp ca cb) -1)
6252 ((string-lessp cb ca) +1))))
6254 (defsubst org-cmp-todo-state (a b)
6255 "Compare the todo states of strings A and B."
6256 (let* ((ma (or (get-text-property 1 'org-marker a)
6257 (get-text-property 1 'org-hd-marker a)))
6258 (mb (or (get-text-property 1 'org-marker b)
6259 (get-text-property 1 'org-hd-marker b)))
6260 (fa (and ma (marker-buffer ma)))
6261 (fb (and mb (marker-buffer mb)))
6263 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6264 (and fb (with-current-buffer fb org-todo-keywords-1))))
6265 (ta (or (get-text-property 1 'todo-state a) ""))
6266 (tb (or (get-text-property 1 'todo-state b) ""))
6267 (la (- (length (member ta todo-kwds))))
6268 (lb (- (length (member tb todo-kwds))))
6269 (donepa (member ta org-done-keywords-for-agenda))
6270 (donepb (member tb org-done-keywords-for-agenda)))
6271 (cond ((and donepa (not donepb)) -1)
6272 ((and (not donepa) donepb) +1)
6276 (defsubst org-cmp-alpha (a b)
6277 "Compare the headlines, alphabetically."
6278 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6279 (plb (text-property-any 0 (length b) 'org-heading t b))
6280 (ta (and pla (substring a pla)))
6281 (tb (and plb (substring b plb))))
6283 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6284 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6285 (setq ta (substring ta (match-end 0))))
6286 (setq ta (downcase ta)))
6288 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6289 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6290 (setq tb (substring tb (match-end 0))))
6291 (setq tb (downcase tb)))
6294 ((string-lessp ta tb) -1)
6295 ((string-lessp tb ta) +1))))
6297 (defsubst org-cmp-tag (a b)
6298 "Compare the string values of the first tags of A and B."
6299 (let ((ta (car (last (get-text-property 1 'tags a))))
6300 (tb (car (last (get-text-property 1 'tags b)))))
6303 ((string-lessp ta tb) -1)
6304 ((string-lessp tb ta) +1))))
6306 (defsubst org-cmp-time (a b)
6307 "Compare the time-of-day values of strings A and B."
6308 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6309 (ta (or (get-text-property 1 'time-of-day a) def))
6310 (tb (or (get-text-property 1 'time-of-day b) def)))
6311 (cond ((< ta tb) -1)
6314 (defsubst org-cmp-habit-p (a b)
6315 "Compare the todo states of strings A and B."
6316 (let ((ha (get-text-property 1 'org-habit-p a))
6317 (hb (get-text-property 1 'org-habit-p b)))
6318 (cond ((and ha (not hb)) -1)
6319 ((and (not ha) hb) +1))))
6321 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6323 (defun org-entries-lessp (a b)
6324 "Predicate for sorting agenda entries."
6325 ;; The following variables will be used when the form is evaluated.
6326 ;; So even though the compiler complains, keep them.
6327 (let* ((ss org-agenda-sorting-strategy-selected)
6328 (time-up (and (org-em 'time-up 'time-down ss)
6329 (org-cmp-time a b)))
6330 (time-down (if time-up (- time-up) nil))
6331 (priority-up (and (org-em 'priority-up 'priority-down ss)
6332 (org-cmp-priority a b)))
6333 (priority-down (if priority-up (- priority-up) nil))
6334 (effort-up (and (org-em 'effort-up 'effort-down ss)
6335 (org-cmp-effort a b)))
6336 (effort-down (if effort-up (- effort-up) nil))
6337 (category-up (and (or (org-em 'category-up 'category-down ss)
6338 (memq 'category-keep ss))
6339 (org-cmp-category a b)))
6340 (category-down (if category-up (- category-up) nil))
6341 (category-keep (if category-up +1 nil))
6342 (tag-up (and (org-em 'tag-up 'tag-down ss)
6344 (tag-down (if tag-up (- tag-up) nil))
6345 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6346 (org-cmp-todo-state a b)))
6347 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6348 (habit-up (and (org-em 'habit-up 'habit-down ss)
6349 (org-cmp-habit-p a b)))
6350 (habit-down (if habit-up (- habit-up) nil))
6351 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6352 (org-cmp-alpha a b)))
6353 (alpha-down (if alpha-up (- alpha-up) nil))
6354 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6355 user-defined-up user-defined-down)
6356 (if (and need-user-cmp org-agenda-cmp-user-defined
6357 (functionp org-agenda-cmp-user-defined))
6358 (setq user-defined-up
6359 (funcall org-agenda-cmp-user-defined a b)
6360 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6362 (eval (cons 'or org-agenda-sorting-strategy-selected))
6363 '((-1 . t) (1 . nil) (nil . nil))))))
6365 ;;; Agenda restriction lock
6367 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6368 "Overlay to mark the headline to which agenda commands are restricted.")
6369 (overlay-put org-agenda-restriction-lock-overlay
6370 'face 'org-agenda-restriction-lock)
6371 (overlay-put org-agenda-restriction-lock-overlay
6372 'help-echo "Agendas are currently limited to this subtree.")
6373 (org-detach-overlay org-agenda-restriction-lock-overlay)
6375 (defun org-agenda-set-restriction-lock (&optional type)
6376 "Set restriction lock for agenda, to current subtree or file.
6377 Restriction will be the file if TYPE is `file', or if type is the
6378 universal prefix '(4), or if the cursor is before the first headline
6379 in the file. Otherwise, restriction will be to the current subtree."
6381 (and (equal type '(4)) (setq type 'file))
6384 ((org-at-heading-p) 'subtree)
6385 ((condition-case nil (org-back-to-heading t) (error nil))
6388 (if (eq type 'subtree)
6390 (setq org-agenda-restrict t)
6391 (setq org-agenda-overriding-restriction 'subtree)
6392 (put 'org-agenda-files 'org-restrict
6393 (list (buffer-file-name (buffer-base-buffer))))
6394 (org-back-to-heading t)
6395 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6396 (move-marker org-agenda-restrict-begin (point))
6397 (move-marker org-agenda-restrict-end
6398 (save-excursion (org-end-of-subtree t)))
6399 (message "Locking agenda restriction to subtree"))
6400 (put 'org-agenda-files 'org-restrict
6401 (list (buffer-file-name (buffer-base-buffer))))
6402 (setq org-agenda-restrict nil)
6403 (setq org-agenda-overriding-restriction 'file)
6404 (move-marker org-agenda-restrict-begin nil)
6405 (move-marker org-agenda-restrict-end nil)
6406 (message "Locking agenda restriction to file"))
6407 (setq current-prefix-arg nil)
6408 (org-agenda-maybe-redo))
6410 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6411 "Remove the agenda restriction lock."
6413 (org-detach-overlay org-agenda-restriction-lock-overlay)
6414 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6415 (setq org-agenda-overriding-restriction nil)
6416 (setq org-agenda-restrict nil)
6417 (put 'org-agenda-files 'org-restrict nil)
6418 (move-marker org-agenda-restrict-begin nil)
6419 (move-marker org-agenda-restrict-end nil)
6420 (setq current-prefix-arg nil)
6421 (message "Agenda restriction lock removed")
6422 (or noupdate (org-agenda-maybe-redo)))
6424 (defun org-agenda-maybe-redo ()
6425 "If there is any window showing the agenda view, update it."
6426 (let ((w (get-buffer-window org-agenda-buffer-name t))
6427 (w0 (selected-window)))
6432 (if org-agenda-overriding-restriction
6433 (message "Agenda view shifted to new %s restriction"
6434 org-agenda-overriding-restriction)
6435 (message "Agenda restriction lock removed")))))
6439 (defun org-agenda-check-type (error &rest types)
6440 "Check if agenda buffer is of allowed type.
6441 If ERROR is non-nil, throw an error, otherwise just return nil."
6442 (if (not org-agenda-type)
6443 (error "No Org agenda currently displayed")
6444 (if (memq org-agenda-type types)
6447 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6450 (defun org-agenda-Quit (&optional arg)
6451 "Exit agenda by removing the window or the buffer."
6453 (if org-agenda-columns-active
6455 (let ((buf (current-buffer)))
6456 (if (eq org-agenda-window-setup 'other-frame)
6458 (org-agenda-reset-markers)
6460 (org-columns-remove-overlays)
6461 (setq org-agenda-archives-mode nil)
6463 (and (not (eq org-agenda-window-setup 'current-window))
6464 (not (one-window-p))
6466 (org-agenda-reset-markers)
6468 (org-columns-remove-overlays)
6469 (setq org-agenda-archives-mode nil)))
6470 ;; Maybe restore the pre-agenda window configuration.
6471 (and org-agenda-restore-windows-after-quit
6472 (not (eq org-agenda-window-setup 'other-frame))
6473 org-pre-agenda-window-conf
6474 (set-window-configuration org-pre-agenda-window-conf)
6475 (setq org-pre-agenda-window-conf nil))))
6477 (defun org-agenda-quit ()
6478 "Exit agenda by killing agenda buffer or burying it when
6479 `org-agenda-sticky' is non-NIL"
6481 (if org-agenda-columns-active
6483 (if org-agenda-sticky
6484 (let ((buf (current-buffer)))
6485 (if (eq org-agenda-window-setup 'other-frame)
6488 (and (not (eq org-agenda-window-setup 'current-window))
6489 (not (one-window-p))
6491 (with-current-buffer buf
6493 ;; Maybe restore the pre-agenda window configuration.
6494 (and org-agenda-restore-windows-after-quit
6495 (not (eq org-agenda-window-setup 'other-frame))
6496 org-pre-agenda-window-conf
6497 (set-window-configuration org-pre-agenda-window-conf)
6498 (setq org-pre-agenda-window-conf nil))))
6499 (org-agenda-Quit))))
6501 (defun org-agenda-exit ()
6502 "Exit agenda by removing the window or the buffer.
6503 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6504 Org-mode buffers visited directly by the user will not be touched."
6506 (org-release-buffers org-agenda-new-buffers)
6507 (setq org-agenda-new-buffers nil)
6510 (defun org-agenda-kill-all-agenda-buffers ()
6511 "Kill all buffers in `org-agena-mode'.
6512 This is used when toggling sticky agendas. You can also explicitly invoke it
6516 (dolist (buf (buffer-list))
6517 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6519 (mapc 'kill-buffer blist)))
6521 (defun org-agenda-execute (arg)
6522 "Execute another agenda command, keeping same window.
6523 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6526 (let ((org-agenda-window-setup 'current-window))
6529 (defun org-agenda-redo ()
6531 When this is the global TODO list, a prefix argument will be interpreted."
6533 (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
6534 (org-agenda-sticky nil)
6535 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6536 org-agenda-buffer-name))
6537 (org-agenda-keep-modes t)
6538 (tag-filter org-agenda-tag-filter)
6539 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6540 (top-cat-filter org-agenda-top-category-filter)
6541 (cat-filter org-agenda-category-filter)
6542 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6543 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6544 (cols org-agenda-columns-active)
6545 (line (org-current-line))
6546 (window-line (- line (org-current-line (window-start))))
6547 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6548 (put 'org-agenda-tag-filter :preset-filter nil)
6549 (put 'org-agenda-category-filter :preset-filter nil)
6550 (and cols (org-columns-quit))
6551 (message "Rebuilding agenda buffer...")
6552 (org-let lprops '(eval org-agenda-redo-command))
6553 (setq org-agenda-undo-list nil
6554 org-agenda-pending-undo-list nil)
6555 (message "Rebuilding agenda buffer...done")
6556 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6557 (put 'org-agenda-category-filter :preset-filter cat-preset)
6558 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6559 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6560 (and top-cat-filter (org-agenda-filter-top-category-apply top-cat-filter))
6561 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6562 (org-goto-line line)
6563 (recenter window-line)))
6565 (defvar org-global-tags-completion-table nil)
6566 (defvar org-agenda-filter-form nil)
6567 (defvar org-agenda-filtered-by-category nil)
6569 (defun org-agenda-filter-by-category (strip)
6570 "Keep only those lines in the agenda buffer that have a specific category.
6571 The category is that of the current line."
6573 (if (and org-agenda-filtered-by-category
6574 org-agenda-category-filter)
6575 (org-agenda-filter-show-all-cat)
6576 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6577 (if cat (org-agenda-filter-apply
6578 (list (concat (if strip "-" "+") cat)) 'category)
6579 (error "No category at point")))))
6581 (defun org-find-top-category (&optional pos)
6583 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
6584 (if pos (goto-char pos))
6585 ;; Skip up to the topmost parent
6586 (while (ignore-errors (outline-up-heading 1) t))
6588 (nth 4 (org-heading-components))))))
6590 (defvar org-agenda-filtered-by-top-category nil)
6592 (defun org-agenda-filter-by-top-category (strip)
6593 "Keep only those lines in the agenda buffer that have a specific category.
6594 The category is that of the current line."
6596 (if org-agenda-filtered-by-top-category
6598 (setq org-agenda-filtered-by-top-category nil
6599 org-agenda-top-category-filter nil)
6600 (org-agenda-filter-show-all-cat))
6601 (let ((cat (org-find-top-category (org-get-at-bol 'org-hd-marker))))
6602 (if cat (org-agenda-filter-top-category-apply cat strip)
6603 (error "No top-level category at point")))))
6605 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6606 "Keep only those lines in the agenda buffer that have a specific tag.
6607 The tag is selected with its fast selection letter, as configured.
6608 With prefix argument STRIP, remove all lines that do have the tag.
6609 A lisp caller can specify CHAR. NARROW means that the new tag should be
6610 used to narrow the search - the interactive user can also press `-' or `+'
6611 to switch to narrowing."
6613 (let* ((alist org-tag-alist-for-agenda)
6614 (tag-chars (mapconcat
6615 (lambda (x) (if (and (not (symbolp (car x)))
6617 (char-to-string (cdr x))
6620 (efforts (org-split-string
6621 (or (cdr (assoc (concat org-effort-property "_ALL")
6622 org-global-properties))
6623 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6625 (effort-op org-agenda-filter-effort-default-operator)
6627 (inhibit-read-only t)
6628 (current org-agenda-tag-filter)
6629 maybe-refresh a n tag)
6632 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6633 (if narrow "Narrow" "Filter") tag-chars
6634 (if org-agenda-auto-exclude-function "[RET], " ""))
6635 (setq char (read-char-exclusive)))
6636 (when (member char '(?+ ?-))
6638 (cond ((equal char ?-) (setq strip t narrow t))
6639 ((equal char ?+) (setq strip nil narrow t)))
6641 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6642 (setq char (read-char-exclusive)))
6643 (when (member char '(?< ?> ?= ??))
6644 ;; An effort operator
6645 (setq effort-op (char-to-string char))
6646 (setq alist nil) ; to make sure it will be interpreted as effort.
6647 (unless (equal char ??)
6648 (loop for i from 0 to 9 do
6652 (if (= i 9) "0" (int-to-string (1+ i)))
6653 "]" (nth i efforts))))
6654 (message "Effort%s: %s " effort-op effort-prompt)
6655 (setq char (read-char-exclusive))
6656 (when (or (< char ?0) (> char ?9))
6657 (error "Need 1-9,0 to select effort"))))
6658 (when (equal char ?\t)
6659 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6660 (org-set-local 'org-global-tags-completion-table
6661 (org-global-tags-completion-table)))
6662 (let ((completion-ignore-case t))
6663 (setq tag (org-icompleting-read
6664 "Tag: " org-global-tags-completion-table))))
6667 (org-agenda-filter-show-all-tag)
6668 (when org-agenda-auto-exclude-function
6669 (setq org-agenda-tag-filter '())
6670 (dolist (tag (org-agenda-get-represented-tags))
6671 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6673 (push modifier org-agenda-tag-filter))))
6674 (if (not (null org-agenda-tag-filter))
6675 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6676 (setq maybe-refresh t))
6678 (org-agenda-filter-show-all-tag)
6679 (when (get 'org-agenda-tag-filter :preset-filter)
6680 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6681 (setq maybe-refresh t))
6683 (setq org-agenda-tag-filter
6684 (mapcar (lambda(tag) (concat "+" tag))
6685 (org-get-at-bol 'tags)))
6686 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6687 (setq maybe-refresh t))
6688 ((or (equal char ?\ )
6689 (setq a (rassoc char alist))
6690 (and (>= char ?0) (<= char ?9)
6691 (setq n (if (= char ?0) 9 (- char ?0 1))
6692 tag (concat effort-op (nth n efforts))
6697 (and tag (setq a (cons tag nil))))
6698 (org-agenda-filter-show-all-tag)
6700 (setq org-agenda-tag-filter
6701 (cons (concat (if strip "-" "+") tag)
6702 (if narrow current nil)))
6703 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6704 (setq maybe-refresh t))
6705 (t (error "Invalid tag selection character %c" char)))
6706 (when (and maybe-refresh
6707 (eq org-agenda-clockreport-mode 'with-filter))
6708 (org-agenda-redo))))
6710 (defun org-agenda-get-represented-tags ()
6711 "Get a list of all tags currently represented in the agenda."
6714 (goto-char (point-min))
6715 (while (setq p (next-single-property-change (point) 'tags))
6717 (mapc (lambda (x) (add-to-list 'tags x))
6718 (get-text-property (point) 'tags))))
6721 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6722 "Refine the current filter. See `org-agenda-filter-by-tag'."
6724 (org-agenda-filter-by-tag strip char 'refine))
6726 (defun org-agenda-filter-make-matcher ()
6727 "Create the form that tests a line for agenda filter."
6729 ;; first compute the tag-filter matcher
6730 (dolist (x (delete-dups
6731 (append (get 'org-agenda-tag-filter
6732 :preset-filter) org-agenda-tag-filter)))
6733 (if (member x '("-" "+"))
6734 (setq f1 (if (equal x "-") 'tags '(not tags)))
6735 (if (string-match "[<=>?]" x)
6736 (setq f1 (org-agenda-filter-effort-form x))
6737 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6738 (if (equal (string-to-char x) ?-)
6739 (setq f1 (list 'not f1))))
6741 ;; then compute the category-filter matcher
6742 (dolist (x (delete-dups
6743 (append (get 'org-agenda-category-filter
6744 :preset-filter) org-agenda-category-filter)))
6745 (if (equal "-" (substring x 0 1))
6746 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
6747 (setq f1 (list 'equal (substring x 1) 'cat)))
6749 (cons 'and (nreverse f))))
6751 (defun org-agenda-filter-effort-form (e)
6752 "Return the form to compare the effort of the current line with what E says.
6753 E looks like \"+<2:25\"."
6755 (setq e (substring e 1))
6756 (setq op (string-to-char e) e (substring e 1))
6757 (setq op (cond ((equal op ?<) '<=)
6761 (list 'org-agenda-compare-effort (list 'quote op)
6762 (org-duration-string-to-minutes e))))
6764 (defun org-agenda-compare-effort (op value)
6765 "Compare the effort of the current line with VALUE, using OP.
6766 If the line does not have an effort defined, return nil."
6767 (let ((eff (org-get-at-bol 'effort-minutes)))
6770 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6773 (defun org-agenda-filter-apply (filter type)
6774 "Set FILTER as the new agenda filter and apply it."
6777 (setq org-agenda-tag-filter filter)
6778 (setq org-agenda-category-filter filter))
6779 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6780 (if (and (eq type 'category)
6781 (not (equal (substring (car filter) 0 1) "-")))
6782 ;; Only set `org-agenda-filtered-by-category' to t
6783 ;; when a unique category is used as the filter
6784 (setq org-agenda-filtered-by-category t))
6785 (org-agenda-set-mode-name)
6787 (goto-char (point-min))
6789 (if (org-get-at-bol 'org-marker)
6791 (setq tags (org-get-at-bol 'tags) ; used in eval
6792 cat (get-text-property (point) 'org-category))
6793 (if (not (eval org-agenda-filter-form))
6794 (org-agenda-filter-hide-line type))
6795 (beginning-of-line 2))
6796 (beginning-of-line 2))))
6797 (if (get-char-property (point) 'invisible)
6798 (ignore-errors (org-agenda-previous-line)))))
6800 (defun org-agenda-filter-top-category-apply (category &optional negative)
6801 "Set FILTER as the new agenda filter and apply it."
6802 (org-agenda-set-mode-name)
6804 (goto-char (point-min))
6806 (let* ((pos (org-get-at-bol 'org-hd-marker))
6807 (topcat (and pos (org-find-top-category pos))))
6808 (if (and topcat (funcall (if negative 'identity 'not)
6809 (string= category topcat)))
6810 (org-agenda-filter-hide-line 'category)))
6811 (beginning-of-line 2)))
6812 (if (get-char-property (point) 'invisible)
6813 (org-agenda-previous-line))
6814 (setq org-agenda-top-category-filter category
6815 org-agenda-filtered-by-top-category t))
6817 (defun org-agenda-filter-hide-line (type)
6819 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6821 (overlay-put ov 'invisible t)
6822 (overlay-put ov 'type type)
6824 (push ov org-agenda-tag-filter-overlays)
6825 (push ov org-agenda-cat-filter-overlays))))
6827 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6828 (setq pos (or pos (point)))
6830 (dolist (ov (overlays-at pos))
6831 (when (and (overlay-get ov 'invisible)
6832 (eq (overlay-get ov 'type) 'tag))
6834 (if (< (overlay-start ov) (point-at-eol))
6835 (move-overlay ov (point-at-eol)
6836 (overlay-end ov)))))))
6838 (defun org-agenda-filter-show-all-tag nil
6839 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6840 (setq org-agenda-tag-filter-overlays nil
6841 org-agenda-tag-filter nil
6842 org-agenda-filter-form nil)
6843 (org-agenda-set-mode-name))
6845 (defun org-agenda-filter-show-all-cat nil
6846 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6847 (setq org-agenda-cat-filter-overlays nil
6848 org-agenda-filtered-by-category nil
6849 org-agenda-category-filter nil
6850 org-agenda-filter-form nil)
6851 (org-agenda-set-mode-name))
6853 (defun org-agenda-manipulate-query-add ()
6854 "Manipulate the query by adding a search term with positive selection.
6855 Positive selection means the term must be matched for selection of an entry."
6857 (org-agenda-manipulate-query ?\[))
6858 (defun org-agenda-manipulate-query-subtract ()
6859 "Manipulate the query by adding a search term with negative selection.
6860 Negative selection means term must not be matched for selection of an entry."
6862 (org-agenda-manipulate-query ?\]))
6863 (defun org-agenda-manipulate-query-add-re ()
6864 "Manipulate the query by adding a search regexp with positive selection.
6865 Positive selection means the regexp must match for selection of an entry."
6867 (org-agenda-manipulate-query ?\{))
6868 (defun org-agenda-manipulate-query-subtract-re ()
6869 "Manipulate the query by adding a search regexp with negative selection.
6870 Negative selection means regexp must not match for selection of an entry."
6872 (org-agenda-manipulate-query ?\}))
6873 (defun org-agenda-manipulate-query (char)
6875 ((memq org-agenda-type '(timeline agenda))
6876 (let ((org-agenda-include-inactive-timestamps t))
6878 (message "Display now includes inactive timestamps as well"))
6879 ((eq org-agenda-type 'search)
6881 'org-agenda-query-string
6882 (if org-agenda-last-search-view-search-was-boolean
6883 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6884 (?\{ . " +{}") (?\} . " -{}"))))
6886 (setq org-agenda-redo-command
6887 (list 'org-search-view
6889 org-agenda-query-string
6890 (+ (length org-agenda-query-string)
6891 (if (member char '(?\{ ?\})) 0 1))))
6892 (set-register org-agenda-query-register org-agenda-query-string)
6894 (t (error "Cannot manipulate query for %s-type agenda buffers"
6897 (defun org-add-to-string (var string)
6898 (set var (concat (symbol-value var) string)))
6900 (defun org-agenda-goto-date (date)
6901 "Jump to DATE in agenda."
6902 (interactive (list (let ((org-read-date-prefer-future
6903 (eval org-agenda-jump-prefer-future)))
6905 (org-agenda-list nil date))
6907 (defun org-agenda-goto-today ()
6910 (org-agenda-check-type t 'timeline 'agenda)
6911 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6913 (tdpos (goto-char tdpos))
6914 ((eq org-agenda-type 'agenda)
6915 (let* ((sd (org-agenda-compute-starting-span
6916 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6917 (org-agenda-overriding-arguments org-agenda-last-arguments))
6918 (setf (nth 1 org-agenda-overriding-arguments) sd)
6920 (org-agenda-find-same-or-today-or-agenda)))
6921 (t (error "Cannot find today")))))
6923 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6925 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6926 (text-property-any (point-min) (point-max) 'org-today t)
6927 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6930 (defun org-agenda-later (arg)
6931 "Go forward in time by thee current span.
6932 With prefix ARG, go forward that many times the current span."
6934 (org-agenda-check-type t 'agenda)
6935 (let* ((span org-agenda-current-span)
6936 (sd org-starting-day)
6937 (greg (calendar-gregorian-from-absolute sd))
6938 (cnt (org-get-at-bol 'org-day-cnt))
6942 (setq sd (+ arg sd)))
6944 (setq sd (+ (* 7 arg) sd)))
6946 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6947 sd (calendar-absolute-from-gregorian greg2))
6948 (setcar greg2 (1+ (car greg2))))
6950 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6951 sd (calendar-absolute-from-gregorian greg2))
6952 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6954 (setq sd (+ (* span arg) sd))))
6955 (let ((org-agenda-overriding-arguments
6956 (list (car org-agenda-last-arguments) sd span t)))
6958 (org-agenda-find-same-or-today-or-agenda cnt))))
6960 (defun org-agenda-earlier (arg)
6961 "Go backward in time by the current span.
6962 With prefix ARG, go backward that many times the current span."
6964 (org-agenda-later (- arg)))
6966 (defun org-agenda-view-mode-dispatch ()
6967 "Call one of the view mode commands."
6969 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6970 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6971 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
6972 (let ((a (read-char-exclusive)))
6974 (?\ (call-interactively 'org-agenda-reset-view))
6975 (?d (call-interactively 'org-agenda-day-view))
6976 (?w (call-interactively 'org-agenda-week-view))
6977 (?m (call-interactively 'org-agenda-month-view))
6978 (?y (call-interactively 'org-agenda-year-view))
6979 (?l (call-interactively 'org-agenda-log-mode))
6980 (?L (org-agenda-log-mode '(4)))
6981 (?c (org-agenda-log-mode 'clockcheck))
6982 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6983 (?a (call-interactively 'org-agenda-archives-mode))
6984 (?A (org-agenda-archives-mode 'files))
6985 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6986 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6987 (?G (call-interactively 'org-agenda-toggle-time-grid))
6988 (?D (call-interactively 'org-agenda-toggle-diary))
6989 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6990 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6991 (org-agenda-check-type t 'timeline 'agenda)
6993 (message "Display now includes inactive timestamps as well"))
6994 (?q (message "Abort"))
6995 (otherwise (error "Invalid key" )))))
6997 (defun org-agenda-reset-view ()
6998 "Switch to default view for agenda."
7000 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7001 (defun org-agenda-day-view (&optional day-of-year)
7002 "Switch to daily view for agenda.
7003 With argument DAY-OF-YEAR, switch to that day of the year."
7005 (org-agenda-change-time-span 'day day-of-year))
7006 (defun org-agenda-week-view (&optional iso-week)
7007 "Switch to daily view for agenda.
7008 With argument ISO-WEEK, switch to the corresponding ISO week.
7009 If ISO-WEEK has more then 2 digits, only the last two encode the
7010 week. Any digits before this encode a year. So 200712 means
7011 week 12 of year 2007. Years in the range 1938-2037 can also be
7012 written as 2-digit years."
7014 (org-agenda-change-time-span 'week iso-week))
7015 (defun org-agenda-month-view (&optional month)
7016 "Switch to monthly view for agenda.
7017 With argument MONTH, switch to that month."
7019 (org-agenda-change-time-span 'month month))
7020 (defun org-agenda-year-view (&optional year)
7021 "Switch to yearly view for agenda.
7022 With argument YEAR, switch to that year.
7023 If MONTH has more then 2 digits, only the last two encode the
7024 month. Any digits before this encode a year. So 200712 means
7025 December year 2007. Years in the range 1938-2037 can also be
7026 written as 2-digit years."
7029 (setq year (org-small-year-to-year year)))
7030 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7031 (org-agenda-change-time-span 'year year)
7034 (defun org-agenda-change-time-span (span &optional n)
7035 "Change the agenda view to SPAN.
7036 SPAN may be `day', `week', `month', `year'."
7037 (org-agenda-check-type t 'agenda)
7038 (if (and (not n) (equal org-agenda-current-span span))
7039 (error "Viewing span is already \"%s\"" span))
7040 (let* ((sd (or (org-get-at-bol 'day)
7042 (sd (org-agenda-compute-starting-span sd span n))
7043 (org-agenda-overriding-arguments
7044 (or org-agenda-overriding-arguments
7045 (list (car org-agenda-last-arguments) sd span t))))
7047 (org-agenda-find-same-or-today-or-agenda))
7048 (org-agenda-set-mode-name)
7049 (message "Switched to %s view" span))
7051 (defun org-agenda-compute-starting-span (sd span &optional n)
7052 "Compute starting date for agenda.
7053 SPAN may be `day', `week', `month', `year'. The return value
7054 is a cons cell with the starting date and the number of days,
7055 so that the date SD will be in that range."
7056 (let* ((greg (calendar-gregorian-from-absolute sd))
7063 (setq sd (+ (calendar-absolute-from-gregorian
7067 (let* ((nt (calendar-day-of-week
7068 (calendar-gregorian-from-absolute sd)))
7069 (d (if org-agenda-start-on-weekday
7070 (- nt org-agenda-start-on-weekday)
7073 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
7077 (setq y1 (org-small-year-to-year (/ n 100))
7080 (calendar-absolute-from-iso
7082 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
7085 (when (and n (> n 99))
7086 (setq y1 (org-small-year-to-year (/ n 100))
7088 (setq sd (calendar-absolute-from-gregorian
7089 (list (or n mg) 1 (or y1 yg))))))
7091 (setq sd (calendar-absolute-from-gregorian
7092 (list 1 1 (or n yg))))))
7095 (defun org-agenda-next-date-line (&optional arg)
7096 "Jump to the next line indicating a date in agenda buffer."
7098 (org-agenda-check-type t 'agenda 'timeline)
7099 (beginning-of-line 1)
7100 ;; This does not work if user makes date format that starts with a blank
7101 (if (looking-at "^\\S-") (forward-char 1))
7102 (if (not (re-search-forward "^\\S-" nil t arg))
7105 (error "No next date after this line in this buffer")))
7106 (goto-char (match-beginning 0)))
7108 (defun org-agenda-previous-date-line (&optional arg)
7109 "Jump to the previous line indicating a date in agenda buffer."
7111 (org-agenda-check-type t 'agenda 'timeline)
7112 (beginning-of-line 1)
7113 (if (not (re-search-backward "^\\S-" nil t arg))
7114 (error "No previous date before this line in this buffer")))
7116 ;; Initialize the highlight
7117 (defvar org-hl (make-overlay 1 1))
7118 (overlay-put org-hl 'face 'highlight)
7120 (defun org-highlight (begin end &optional buffer)
7121 "Highlight a region with overlay."
7122 (move-overlay org-hl begin end (or buffer (current-buffer))))
7124 (defun org-unhighlight ()
7125 "Detach overlay INDEX."
7126 (org-detach-overlay org-hl))
7128 ;; FIXME this is currently not used.
7129 (defun org-highlight-until-next-command (beg end &optional buffer)
7130 "Move the highlight overlay to BEG/END, remove it before the next command."
7131 (org-highlight beg end buffer)
7132 (add-hook 'pre-command-hook 'org-unhighlight-once))
7133 (defun org-unhighlight-once ()
7134 "Remove the highlight from its position, and this function from the hook."
7135 (remove-hook 'pre-command-hook 'org-unhighlight-once)
7138 (defun org-agenda-follow-mode ()
7139 "Toggle follow mode in an agenda buffer."
7141 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
7142 (org-agenda-set-mode-name)
7143 (org-agenda-do-context-action)
7144 (message "Follow mode is %s"
7145 (if org-agenda-follow-mode "on" "off")))
7147 (defun org-agenda-entry-text-mode (&optional arg)
7148 "Toggle entry text mode in an agenda buffer."
7150 (setq org-agenda-entry-text-mode (or (integerp arg)
7151 (not org-agenda-entry-text-mode)))
7152 (org-agenda-entry-text-hide)
7153 (and org-agenda-entry-text-mode
7154 (let ((org-agenda-entry-text-maxlines
7155 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7156 (org-agenda-entry-text-show)))
7157 (org-agenda-set-mode-name)
7158 (message "Entry text mode is %s. Maximum number of lines is %d"
7159 (if org-agenda-entry-text-mode "on" "off")
7160 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
7162 (defun org-agenda-clockreport-mode (&optional with-filter)
7163 "Toggle clocktable mode in an agenda buffer.
7164 With prefix arg WITH-FILTER, make the clocktable respect the current
7167 (org-agenda-check-type t 'agenda)
7169 (setq org-agenda-clockreport-mode 'with-filter)
7170 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
7171 (org-agenda-set-mode-name)
7173 (message "Clocktable mode is %s"
7174 (if org-agenda-clockreport-mode "on" "off")))
7176 (defun org-agenda-log-mode (&optional special)
7177 "Toggle log mode in an agenda buffer.
7178 With argument SPECIAL, show all possible log items, not only the ones
7179 configured in `org-agenda-log-mode-items'.
7180 With a double `C-u' prefix arg, show *only* log items, nothing else."
7182 (org-agenda-check-type t 'agenda 'timeline)
7183 (setq org-agenda-show-log
7185 ((equal special '(16)) 'only)
7186 ((eq special 'clockcheck)
7187 (if (eq org-agenda-show-log 'clockcheck)
7189 (special '(closed clock state))
7190 (t (not org-agenda-show-log))))
7191 (org-agenda-set-mode-name)
7193 (message "Log mode is %s"
7194 (if org-agenda-show-log "on" "off")))
7196 (defun org-agenda-archives-mode (&optional with-files)
7197 "Toggle inclusion of items in trees marked with :ARCHIVE:.
7198 When called with a prefix argument, include all archive files as well."
7200 (setq org-agenda-archives-mode
7201 (if with-files t (if org-agenda-archives-mode nil 'trees)))
7202 (org-agenda-set-mode-name)
7207 ((eq org-agenda-archives-mode nil)
7208 "No archives are included")
7209 ((eq org-agenda-archives-mode 'trees)
7210 (format "Trees with :%s: tag are included" org-archive-tag))
7211 ((eq org-agenda-archives-mode t)
7212 (format "Trees with :%s: tag and all active archive files are included"
7213 org-archive-tag)))))
7215 (defun org-agenda-toggle-diary ()
7216 "Toggle diary inclusion in an agenda buffer."
7218 (org-agenda-check-type t 'agenda)
7219 (setq org-agenda-include-diary (not org-agenda-include-diary))
7221 (org-agenda-set-mode-name)
7222 (message "Diary inclusion turned %s"
7223 (if org-agenda-include-diary "on" "off")))
7225 (defun org-agenda-toggle-deadlines ()
7226 "Toggle inclusion of entries with a deadline in an agenda buffer."
7228 (org-agenda-check-type t 'agenda)
7229 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7231 (org-agenda-set-mode-name)
7232 (message "Deadlines inclusion turned %s"
7233 (if org-agenda-include-deadlines "on" "off")))
7235 (defun org-agenda-toggle-time-grid ()
7236 "Toggle time grid in an agenda buffer."
7238 (org-agenda-check-type t 'agenda)
7239 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7241 (org-agenda-set-mode-name)
7242 (message "Time-grid turned %s"
7243 (if org-agenda-use-time-grid "on" "off")))
7245 (defun org-agenda-set-mode-name ()
7246 "Set the mode name to indicate all the small mode settings."
7249 (if (get 'org-agenda-files 'org-restrict) " []" "")
7251 '(:eval (org-agenda-span-name org-agenda-current-span))
7252 (if org-agenda-follow-mode " Follow" "")
7253 (if org-agenda-entry-text-mode " ETxt" "")
7254 (if org-agenda-include-diary " Diary" "")
7255 (if org-agenda-include-deadlines " Ddl" "")
7256 (if org-agenda-use-time-grid " Grid" "")
7257 (if (and (boundp 'org-habit-show-habits)
7258 org-habit-show-habits) " Habit" "")
7260 ((consp org-agenda-show-log) " LogAll")
7261 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7262 (org-agenda-show-log " Log")
7264 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7266 '(:eval (org-propertize
7271 (get 'org-agenda-category-filter :preset-filter)
7272 org-agenda-category-filter)
7275 'face 'org-agenda-filter-category
7276 'help-echo "Category used in filtering"))
7278 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7280 '(:eval (org-propertize
7285 (get 'org-agenda-tag-filter :preset-filter)
7286 org-agenda-tag-filter)
7289 'face 'org-agenda-filter-tags
7290 'help-echo "Tags used in filtering"))
7292 (if org-agenda-archives-mode
7293 (if (eq org-agenda-archives-mode t)
7295 (format " :%s:" org-archive-tag))
7297 (if org-agenda-clockreport-mode
7298 (if (eq org-agenda-clockreport-mode 'with-filter)
7299 " Clock{}" " Clock")
7301 (force-mode-line-update))
7303 (defun org-agenda-post-command-hook ()
7304 (setq org-agenda-type
7305 (or (get-text-property (point) 'org-agenda-type)
7306 (get-text-property (max (point-min) (1- (point)))
7307 'org-agenda-type))))
7309 (defun org-agenda-next-line ()
7310 "Move cursor to the next line, and show if follow mode is active."
7312 (call-interactively 'next-line)
7313 (org-agenda-do-context-action))
7315 (defun org-agenda-previous-line ()
7316 "Move cursor to the previous line, and show if follow-mode is active."
7318 (call-interactively 'previous-line)
7319 (org-agenda-do-context-action))
7321 (defun org-agenda-next-item (n)
7322 "Move cursor to next agenda item."
7324 (let ((col (current-column)))
7326 (when (next-single-property-change (point-at-eol) 'org-marker)
7327 (move-end-of-line 1)
7328 (goto-char (next-single-property-change (point) 'org-marker))))
7329 (org-move-to-column col))
7330 (org-agenda-do-context-action))
7332 (defun org-agenda-previous-item (n)
7333 "Move cursor to next agenda item."
7336 (let ((col (current-column))
7337 (goto (save-excursion
7338 (move-end-of-line 0)
7339 (previous-single-property-change (point) 'org-marker))))
7340 (if goto (goto-char goto))
7341 (org-move-to-column col)))
7342 (org-agenda-do-context-action))
7344 (defun org-agenda-do-context-action ()
7345 "Show outline path and, maybe, follow mode window."
7346 (let ((m (org-get-at-bol 'org-marker)))
7347 (when (and (markerp m) (marker-buffer m))
7348 (and org-agenda-follow-mode
7349 (if org-agenda-follow-indirect
7350 (org-agenda-tree-to-indirect-buffer)
7352 (and org-agenda-show-outline-path
7353 (org-with-point-at m (org-display-outline-path t))))))
7355 (defun org-agenda-show-priority ()
7356 "Show the priority of the current item.
7357 This priority is composed of the main priority given with the [#A] cookies,
7358 and by additional input from the age of a schedules or deadline entry."
7360 (let* ((pri (org-get-at-bol 'priority)))
7361 (message "Priority is %d" (if pri pri -1000))))
7363 (defun org-agenda-show-tags ()
7364 "Show the tags applicable to the current item."
7366 (let* ((tags (org-get-at-bol 'tags)))
7368 (message "Tags are :%s:"
7369 (org-no-properties (mapconcat 'identity tags ":")))
7370 (message "No tags associated with this line"))))
7372 (defun org-agenda-goto (&optional highlight)
7373 "Go to the Org-mode file which contains the item at point."
7375 (let* ((marker (or (org-get-at-bol 'org-marker)
7376 (org-agenda-error)))
7377 (buffer (marker-buffer marker))
7378 (pos (marker-position marker)))
7379 (switch-to-buffer-other-window buffer)
7383 (when (derived-mode-p 'org-mode)
7384 (org-show-context 'agenda)
7386 (and (outline-next-heading)
7387 (org-flag-heading nil)))) ; show the next heading
7388 (when (outline-invisible-p)
7389 (show-entry)) ; display invisible text
7390 (recenter (/ (window-height) 2))
7391 (run-hooks 'org-agenda-after-show-hook)
7392 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7394 (defvar org-agenda-after-show-hook nil
7395 "Normal hook run after an item has been shown from the agenda.
7396 Point is in the buffer where the item originated.")
7398 (defun org-agenda-kill ()
7399 "Kill the entry or subtree belonging to the current agenda entry."
7401 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7402 (let* ((marker (or (org-get-at-bol 'org-marker)
7403 (org-agenda-error)))
7404 (buffer (marker-buffer marker))
7405 (pos (marker-position marker))
7406 (type (org-get-at-bol 'type))
7407 dbeg dend (n 0) conf)
7408 (org-with-remote-undo buffer
7409 (with-current-buffer buffer
7412 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
7413 (setq dbeg (progn (org-back-to-heading t) (point))
7414 dend (org-end-of-subtree t t))
7415 (setq dbeg (point-at-bol)
7416 dend (min (point-max) (1+ (point-at-eol)))))
7418 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7419 (setq conf (or (eq t org-agenda-confirm-kill)
7420 (and (numberp org-agenda-confirm-kill)
7421 (> n org-agenda-confirm-kill))))
7424 (format "Delete entry with %d lines in buffer \"%s\"? "
7425 n (buffer-name buffer))))
7427 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
7428 (with-current-buffer buffer (delete-region dbeg dend))
7429 (message "Agenda item and source killed"))))
7431 (defvar org-archive-default-command)
7432 (defun org-agenda-archive-default ()
7433 "Archive the entry or subtree belonging to the current agenda entry."
7435 (require 'org-archive)
7436 (org-agenda-archive-with org-archive-default-command))
7438 (defun org-agenda-archive-default-with-confirmation ()
7439 "Archive the entry or subtree belonging to the current agenda entry."
7441 (require 'org-archive)
7442 (org-agenda-archive-with org-archive-default-command 'confirm))
7444 (defun org-agenda-archive ()
7445 "Archive the entry or subtree belonging to the current agenda entry."
7447 (org-agenda-archive-with 'org-archive-subtree))
7449 (defun org-agenda-archive-to-archive-sibling ()
7450 "Move the entry to the archive sibling."
7452 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7454 (defun org-agenda-archive-with (cmd &optional confirm)
7455 "Move the entry to the archive sibling."
7457 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7458 (let* ((marker (or (org-get-at-bol 'org-marker)
7459 (org-agenda-error)))
7460 (buffer (marker-buffer marker))
7461 (pos (marker-position marker)))
7462 (org-with-remote-undo buffer
7463 (with-current-buffer buffer
7464 (if (derived-mode-p 'org-mode)
7466 (not (y-or-n-p "Archive this subtree or entry? ")))
7470 (org-remove-subtree-entries-from-agenda)
7471 (org-back-to-heading t)
7473 (error "Archiving works only in Org-mode files"))))))
7475 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7476 "Remove all lines in the agenda that correspond to a given subtree.
7477 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7478 If this information is not given, the function uses the tree at point."
7479 (let ((buf (or buf (current-buffer))) m p)
7481 (unless (and beg end)
7482 (org-back-to-heading t)
7484 (org-end-of-subtree t)
7486 (set-buffer (get-buffer org-agenda-buffer-name))
7488 (goto-char (point-max))
7489 (beginning-of-line 1)
7491 (when (and (setq m (org-get-at-bol 'org-marker))
7492 (equal buf (marker-buffer m))
7493 (setq p (marker-position m))
7496 (let ((inhibit-read-only t))
7497 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7498 (beginning-of-line 0))))))
7500 (defun org-agenda-refile (&optional goto rfloc no-update)
7501 "Refile the item at point."
7503 (if (equal goto '(16))
7504 (org-refile-goto-last-stored)
7505 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7506 (org-agenda-error)))
7507 (buffer (marker-buffer marker))
7508 (pos (marker-position marker))
7510 (org-refile-get-location
7511 (if goto "Goto" "Refile to") buffer
7512 org-refile-allow-creating-parent-nodes))))
7513 (with-current-buffer buffer
7518 (org-remove-subtree-entries-from-agenda)
7519 (org-refile goto buffer rfloc)))))
7520 (unless no-update (org-agenda-redo))))
7522 (defun org-agenda-open-link (&optional arg)
7523 "Follow the link in the current line, if any.
7524 This looks for a link in the displayed line in the agenda. It also looks
7525 at the text of the entry itself."
7527 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7528 (org-get-at-bol 'org-marker)))
7529 (buffer (and marker (marker-buffer marker)))
7530 (prefix (buffer-substring
7531 (point-at-bol) (point-at-eol))))
7534 (with-current-buffer buffer
7539 (org-offer-links-in-entry arg prefix)))))
7540 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7542 (beginning-of-line 1)
7543 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7544 (org-open-link-from-string (match-string 1)))
7545 (t (error "No link to open here")))))
7547 (defun org-agenda-copy-local-variable (var)
7548 "Get a variable from a referenced buffer and install it here."
7549 (let ((m (org-get-at-bol 'org-marker)))
7550 (when (and m (buffer-live-p (marker-buffer m)))
7551 (org-set-local var (with-current-buffer (marker-buffer m)
7552 (symbol-value var))))))
7554 (defun org-agenda-switch-to (&optional delete-other-windows)
7555 "Go to the Org-mode file which contains the item at point."
7557 (if (and org-return-follows-link
7558 (not (org-get-at-bol 'org-marker))
7559 (org-in-regexp org-bracket-link-regexp))
7560 (org-open-link-from-string (match-string 0))
7561 (let* ((marker (or (org-get-at-bol 'org-marker)
7562 (org-agenda-error)))
7563 (buffer (marker-buffer marker))
7564 (pos (marker-position marker)))
7565 (org-pop-to-buffer-same-window buffer)
7566 (and delete-other-windows (delete-other-windows))
7569 (when (derived-mode-p 'org-mode)
7570 (org-show-context 'agenda)
7572 (and (outline-next-heading)
7573 (org-flag-heading nil))) ; show the next heading
7574 (when (outline-invisible-p)
7575 (show-entry)) ; display invisible text
7576 (run-hooks 'org-agenda-after-show-hook)))))
7578 (defun org-agenda-goto-mouse (ev)
7579 "Go to the Org-mode file which contains the item at the mouse click."
7581 (mouse-set-point ev)
7584 (defun org-agenda-show (&optional full-entry)
7585 "Display the Org-mode file which contains the item at point.
7586 With prefix argument FULL-ENTRY, make the entire entry visible
7587 if it was hidden in the outline."
7589 (let ((win (selected-window)))
7591 (let ((org-show-entry-below t))
7592 (org-agenda-goto t))
7593 (org-agenda-goto t))
7594 (select-window win)))
7596 (defvar org-agenda-show-window nil)
7597 (defun org-agenda-show-and-scroll-up (&optional arg)
7598 "Display the Org-mode file which contains the item at point.
7599 When called repeatedly, scroll the window that is displaying the buffer.
7600 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7601 `show-subtree' to display the item, so that drawers and logbooks stay
7604 (let ((win (selected-window)))
7605 (if (and (window-live-p org-agenda-show-window)
7606 (eq this-command last-command))
7608 (select-window org-agenda-show-window)
7609 (ignore-errors (scroll-up)))
7611 (if arg (org-show-entry) (show-subtree))
7612 (setq org-agenda-show-window (selected-window)))
7613 (select-window win)))
7615 (defun org-agenda-show-scroll-down ()
7616 "Scroll down the window showing the agenda."
7618 (let ((win (selected-window)))
7619 (when (window-live-p org-agenda-show-window)
7620 (select-window org-agenda-show-window)
7621 (ignore-errors (scroll-down))
7622 (select-window win))))
7624 (defun org-agenda-show-1 (&optional more)
7625 "Display the Org-mode file which contains the item at point.
7626 The prefix arg selects the amount of information to display:
7629 1 just show the entry according to defaults.
7630 2 show the children view
7631 3 show the subtree view
7632 4 show the entire subtree and any LOGBOOK drawers
7633 5 show the entire subtree and any drawers
7634 With prefix argument FULL-ENTRY, make the entire entry visible
7635 if it was hidden in the outline."
7637 (let ((win (selected-window)))
7639 (org-recenter-heading 1)
7644 (org-back-to-heading)
7645 (run-hook-with-args 'org-cycle-hook 'folded))
7646 (message "Remote: FOLDED"))
7647 ((and (org-called-interactively-p 'any) (= more 1))
7648 (message "Remote: show with default settings"))
7653 (org-back-to-heading)
7654 (run-hook-with-args 'org-cycle-hook 'children))
7655 (message "Remote: CHILDREN"))
7659 (org-back-to-heading)
7660 (run-hook-with-args 'org-cycle-hook 'subtree))
7661 (message "Remote: SUBTREE"))
7663 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7665 (concat "^[ \t]*:\\("
7666 (mapconcat 'regexp-quote org-drawers "\\|")
7670 (org-back-to-heading)
7671 (org-cycle-hide-drawers 'subtree)))
7672 (message "Remote: SUBTREE AND LOGBOOK"))
7675 (message "Remote: SUBTREE AND ALL DRAWERS")))
7676 (select-window win)))
7678 (defun org-recenter-heading (n)
7680 (org-back-to-heading)
7683 (defvar org-agenda-cycle-counter nil)
7684 (defun org-agenda-cycle-show (&optional n)
7685 "Show the current entry in another window, with default settings.
7686 Default settings are taken from `org-show-hierarchy-above' and siblings.
7687 When use repeatedly in immediate succession, the remote entry will cycle
7690 children -> subtree -> folded
7692 When called with a numeric prefix arg, that arg will be passed through to
7693 `org-agenda-show-1'. For the interpretation of that argument, see the
7694 docstring of `org-agenda-show-1'."
7697 (setq org-agenda-cycle-counter n)
7698 (if (not (eq last-command this-command))
7699 (setq org-agenda-cycle-counter 1)
7700 (if (equal org-agenda-cycle-counter 0)
7701 (setq org-agenda-cycle-counter 2)
7702 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7703 (if (> org-agenda-cycle-counter 3)
7704 (setq org-agenda-cycle-counter 0)))))
7705 (org-agenda-show-1 org-agenda-cycle-counter))
7707 (defun org-agenda-recenter (arg)
7708 "Display the Org-mode file which contains the item at point and recenter."
7710 (let ((win (selected-window)))
7713 (select-window win)))
7715 (defun org-agenda-show-mouse (ev)
7716 "Display the Org-mode file which contains the item at the mouse click."
7718 (mouse-set-point ev)
7721 (defun org-agenda-check-no-diary ()
7722 "Check if the entry is a diary link and abort if yes."
7723 (if (org-get-at-bol 'org-agenda-diary-link)
7724 (org-agenda-error)))
7726 (defun org-agenda-error ()
7727 (error "Command not allowed in this line"))
7729 (defun org-agenda-tree-to-indirect-buffer ()
7730 "Show the subtree corresponding to the current entry in an indirect buffer.
7731 This calls the command `org-tree-to-indirect-buffer' from the original
7733 With numerical prefix arg ARG, go up to this level and then take that tree.
7734 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7735 use the dedicated frame)."
7737 (if (and current-prefix-arg (listp current-prefix-arg))
7738 (org-agenda-do-tree-to-indirect-buffer)
7739 (let ((agenda-window (selected-window))
7741 (and org-last-indirect-buffer
7742 (get-buffer-window org-last-indirect-buffer))))
7743 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7746 (unless (and indirect-window (window-live-p indirect-window))
7747 (setq indirect-window (split-window agenda-window)))
7748 (select-window indirect-window)
7749 (switch-to-buffer org-last-indirect-buffer :norecord)
7750 (fit-window-to-buffer indirect-window))
7751 (select-window (get-buffer-window org-agenda-buffer-name))))))
7753 (defun org-agenda-do-tree-to-indirect-buffer ()
7754 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7755 (org-agenda-check-no-diary)
7756 (let* ((marker (or (org-get-at-bol 'org-marker)
7757 (org-agenda-error)))
7758 (buffer (marker-buffer marker))
7759 (pos (marker-position marker)))
7760 (with-current-buffer buffer
7763 (call-interactively 'org-tree-to-indirect-buffer)))))
7765 (defvar org-last-heading-marker (make-marker)
7766 "Marker pointing to the headline that last changed its TODO state
7767 by a remote command from the agenda.")
7769 (defun org-agenda-todo-nextset ()
7770 "Switch TODO entry to next sequence."
7772 (org-agenda-todo 'nextset))
7774 (defun org-agenda-todo-previousset ()
7775 "Switch TODO entry to previous sequence."
7777 (org-agenda-todo 'previousset))
7779 (defun org-agenda-todo (&optional arg)
7780 "Cycle TODO state of line at point, also in Org-mode file.
7781 This changes the line at point, all other lines in the agenda referring to
7782 the same tree node, and the headline of the tree node in the Org-mode file."
7784 (org-agenda-check-no-diary)
7785 (let* ((col (current-column))
7786 (marker (or (org-get-at-bol 'org-marker)
7787 (org-agenda-error)))
7788 (buffer (marker-buffer marker))
7789 (pos (marker-position marker))
7790 (hdmarker (org-get-at-bol 'org-hd-marker))
7791 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7792 (inhibit-read-only t)
7793 org-agenda-headline-snapshot-before-repeat newhead just-one)
7794 (org-with-remote-undo buffer
7795 (with-current-buffer buffer
7798 (org-show-context 'agenda)
7800 (and (outline-next-heading)
7801 (org-flag-heading nil))) ; show the next heading
7802 (let ((current-prefix-arg arg))
7803 (call-interactively 'org-todo))
7804 (and (bolp) (forward-char 1))
7805 (setq newhead (org-get-heading))
7806 (when (and (org-bound-and-true-p
7807 org-agenda-headline-snapshot-before-repeat)
7808 (not (equal org-agenda-headline-snapshot-before-repeat
7811 (setq newhead org-agenda-headline-snapshot-before-repeat
7814 (org-back-to-heading)
7815 (move-marker org-last-heading-marker (point))))
7816 (beginning-of-line 1)
7818 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7819 (org-move-to-column col))))
7821 (defun org-agenda-add-note (&optional arg)
7822 "Add a time-stamped note to the entry at point."
7824 (org-agenda-check-no-diary)
7825 (let* ((marker (or (org-get-at-bol 'org-marker)
7826 (org-agenda-error)))
7827 (buffer (marker-buffer marker))
7828 (pos (marker-position marker))
7829 (hdmarker (org-get-at-bol 'org-hd-marker))
7830 (inhibit-read-only t))
7831 (with-current-buffer buffer
7834 (org-show-context 'agenda)
7836 (and (outline-next-heading)
7837 (org-flag-heading nil))) ; show the next heading
7840 (defun org-agenda-change-all-lines (newhead hdmarker
7841 &optional fixface just-this)
7842 "Change all lines in the agenda buffer which match HDMARKER.
7843 The new content of the line will be NEWHEAD (as modified by
7844 `org-agenda-format-item'). HDMARKER is checked with
7845 `equal' against all `org-hd-marker' text properties in the file.
7846 If FIXFACE is non-nil, the face of each item is modified according to
7848 If JUST-THIS is non-nil, change just the current line, not all.
7849 If FORCE-TAGS is non nil, the car of it returns the new tags."
7850 (let* ((inhibit-read-only t)
7851 (line (org-current-line))
7852 (org-agenda-buffer (current-buffer))
7853 (thetags (with-current-buffer (marker-buffer hdmarker)
7854 (save-excursion (save-restriction (widen)
7855 (goto-char hdmarker)
7856 (org-get-tags-at)))))
7857 props m pl undone-face done-face finish new dotime cat tags)
7859 (goto-char (point-max))
7860 (beginning-of-line 1)
7862 (setq finish (bobp))
7863 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7864 (or (not just-this) (= (org-current-line) line))
7866 (setq props (text-properties-at (point))
7867 dotime (org-get-at-bol 'dotime)
7868 cat (org-get-at-bol 'org-category)
7871 (let ((org-prefix-format-compiled
7872 (or (get-text-property (point) 'format)
7873 org-prefix-format-compiled))
7874 (extra (org-get-at-bol 'extra)))
7875 (with-current-buffer (marker-buffer hdmarker)
7879 (org-agenda-format-item extra newhead cat tags dotime)))))
7880 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7881 undone-face (org-get-at-bol 'undone-face)
7882 done-face (org-get-at-bol 'done-face))
7883 (beginning-of-line 1)
7886 (and (looking-at ".*\n?") (replace-match "")))
7888 (replace-match new t t)
7889 (beginning-of-line 1)
7890 (add-text-properties (point-at-bol) (point-at-eol) props)
7892 (add-text-properties
7893 (point-at-bol) (point-at-eol)
7895 (if org-last-todo-state-is-todo
7896 undone-face done-face))))
7897 (org-agenda-highlight-todo 'line)
7898 (beginning-of-line 1))
7899 (t (error "Line update did not work"))))
7900 (beginning-of-line 0)))
7901 (org-finalize-agenda)))
7903 (defun org-agenda-align-tags (&optional line)
7904 "Align all tags in agenda items to `org-agenda-tags-column'."
7905 (let ((inhibit-read-only t) l c)
7907 (goto-char (if line (point-at-bol) (point-min)))
7908 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7909 (if line (point-at-eol) nil) t)
7910 (add-text-properties
7911 (match-beginning 2) (match-end 2)
7912 (list 'face (delq nil (let ((prop (get-text-property
7913 (match-beginning 2) 'face)))
7914 (or (listp prop) (setq prop (list prop)))
7915 (if (memq 'org-tag prop)
7917 (cons 'org-tag prop))))))
7918 (setq l (- (match-end 2) (match-beginning 2))
7919 c (if (< org-agenda-tags-column 0)
7920 (- (abs org-agenda-tags-column) l)
7921 org-agenda-tags-column))
7922 (delete-region (match-beginning 1) (match-end 1))
7923 (goto-char (match-beginning 1))
7924 (insert (org-add-props
7925 (make-string (max 1 (- c (current-column))) ?\ )
7926 (plist-put (copy-sequence (text-properties-at (point)))
7928 (goto-char (point-min))
7929 (org-font-lock-add-tag-faces (point-max)))))
7931 (defun org-agenda-priority-up ()
7932 "Increase the priority of line at point, also in Org-mode file."
7934 (org-agenda-priority 'up))
7936 (defun org-agenda-priority-down ()
7937 "Decrease the priority of line at point, also in Org-mode file."
7939 (org-agenda-priority 'down))
7941 (defun org-agenda-priority (&optional force-direction)
7942 "Set the priority of line at point, also in Org-mode file.
7943 This changes the line at point, all other lines in the agenda referring to
7944 the same tree node, and the headline of the tree node in the Org-mode file."
7946 (unless org-enable-priority-commands
7947 (error "Priority commands are disabled"))
7948 (org-agenda-check-no-diary)
7949 (let* ((marker (or (org-get-at-bol 'org-marker)
7950 (org-agenda-error)))
7951 (hdmarker (org-get-at-bol 'org-hd-marker))
7952 (buffer (marker-buffer hdmarker))
7953 (pos (marker-position hdmarker))
7954 (inhibit-read-only t)
7956 (org-with-remote-undo buffer
7957 (with-current-buffer buffer
7960 (org-show-context 'agenda)
7962 (and (outline-next-heading)
7963 (org-flag-heading nil))) ; show the next heading
7964 (funcall 'org-priority force-direction)
7966 (setq newhead (org-get-heading)))
7967 (org-agenda-change-all-lines newhead hdmarker)
7968 (beginning-of-line 1))))
7970 ;; FIXME: should fix the tags property of the agenda line.
7971 (defun org-agenda-set-tags (&optional tag onoff)
7972 "Set tags for the current headline."
7974 (org-agenda-check-no-diary)
7975 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7976 (call-interactively 'org-change-tag-in-region)
7977 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7978 (org-agenda-error)))
7979 (buffer (marker-buffer hdmarker))
7980 (pos (marker-position hdmarker))
7981 (inhibit-read-only t)
7983 (org-with-remote-undo buffer
7984 (with-current-buffer buffer
7988 (org-show-context 'agenda))
7990 (and (outline-next-heading)
7991 (org-flag-heading nil))) ; show the next heading
7994 (org-toggle-tag tag onoff)
7995 (call-interactively 'org-set-tags))
7997 (setq newhead (org-get-heading)))
7998 (org-agenda-change-all-lines newhead hdmarker)
7999 (beginning-of-line 1)))))
8001 (defun org-agenda-set-property ()
8002 "Set a property for the current headline."
8004 (org-agenda-check-no-diary)
8005 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8006 (org-agenda-error)))
8007 (buffer (marker-buffer hdmarker))
8008 (pos (marker-position hdmarker))
8009 (inhibit-read-only t)
8011 (org-with-remote-undo buffer
8012 (with-current-buffer buffer
8016 (org-show-context 'agenda))
8018 (and (outline-next-heading)
8019 (org-flag-heading nil))) ; show the next heading
8021 (call-interactively 'org-set-property)))))
8023 (defun org-agenda-set-effort ()
8024 "Set the effort property for the current headline."
8026 (org-agenda-check-no-diary)
8027 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8028 (org-agenda-error)))
8029 (buffer (marker-buffer hdmarker))
8030 (pos (marker-position hdmarker))
8031 (inhibit-read-only t)
8033 (org-with-remote-undo buffer
8034 (with-current-buffer buffer
8038 (org-show-context 'agenda))
8040 (and (outline-next-heading)
8041 (org-flag-heading nil))) ; show the next heading
8043 (call-interactively 'org-set-effort)
8045 (setq newhead (org-get-heading)))
8046 (org-agenda-change-all-lines newhead hdmarker))))
8048 (defun org-agenda-toggle-archive-tag ()
8049 "Toggle the archive tag for the current entry."
8051 (org-agenda-check-no-diary)
8052 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8053 (org-agenda-error)))
8054 (buffer (marker-buffer hdmarker))
8055 (pos (marker-position hdmarker))
8056 (inhibit-read-only t)
8058 (org-with-remote-undo buffer
8059 (with-current-buffer buffer
8062 (org-show-context 'agenda)
8064 (and (outline-next-heading)
8065 (org-flag-heading nil))) ; show the next heading
8066 (call-interactively 'org-toggle-archive-tag)
8068 (setq newhead (org-get-heading)))
8069 (org-agenda-change-all-lines newhead hdmarker)
8070 (beginning-of-line 1))))
8072 (defun org-agenda-do-date-later (arg)
8075 ((or (equal arg '(16))
8077 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8078 (setq this-command 'org-agenda-date-later-minutes)
8079 (org-agenda-date-later-minutes 1))
8080 ((or (equal arg '(4))
8082 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8083 (setq this-command 'org-agenda-date-later-hours)
8084 (org-agenda-date-later-hours 1))
8086 (org-agenda-date-later (prefix-numeric-value arg)))))
8088 (defun org-agenda-do-date-earlier (arg)
8091 ((or (equal arg '(16))
8093 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
8094 (setq this-command 'org-agenda-date-earlier-minutes)
8095 (org-agenda-date-earlier-minutes 1))
8096 ((or (equal arg '(4))
8098 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
8099 (setq this-command 'org-agenda-date-earlier-hours)
8100 (org-agenda-date-earlier-hours 1))
8102 (org-agenda-date-earlier (prefix-numeric-value arg)))))
8104 (defun org-agenda-date-later (arg &optional what)
8105 "Change the date of this item to ARG day(s) later."
8107 (org-agenda-check-type t 'agenda 'timeline)
8108 (org-agenda-check-no-diary)
8109 (let* ((marker (or (org-get-at-bol 'org-marker)
8110 (org-agenda-error)))
8111 (buffer (marker-buffer marker))
8112 (pos (marker-position marker))
8114 (org-with-remote-undo buffer
8115 (with-current-buffer buffer
8118 (if (not (org-at-timestamp-p))
8119 (error "Cannot find time stamp"))
8120 (when (and org-agenda-move-date-from-past-immediately-to-today
8122 (or (not what) (eq what 'day))
8123 (not (save-match-data (org-at-date-range-p))))
8124 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
8125 cdate (calendar-absolute-from-gregorian
8126 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
8129 ;; immediately shift to today
8130 (setq arg (- today cdate))))
8131 (org-timestamp-change arg (or what 'day))
8132 (when (and (org-at-date-range-p)
8133 (re-search-backward org-tr-regexp-both (point-at-bol)))
8134 (let ((end org-last-changed-timestamp))
8135 (org-timestamp-change arg (or what 'day))
8136 (setq org-last-changed-timestamp
8137 (concat org-last-changed-timestamp "--" end)))))
8138 (org-agenda-show-new-time marker org-last-changed-timestamp))
8139 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8141 (defun org-agenda-date-earlier (arg &optional what)
8142 "Change the date of this item to ARG day(s) earlier."
8144 (org-agenda-date-later (- arg) what))
8146 (defun org-agenda-date-later-minutes (arg)
8147 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8149 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8150 (org-agenda-date-later arg 'minute))
8152 (defun org-agenda-date-earlier-minutes (arg)
8153 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
8155 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
8156 (org-agenda-date-earlier arg 'minute))
8158 (defun org-agenda-date-later-hours (arg)
8159 "Change the time of this item, in hour steps."
8161 (org-agenda-date-later arg 'hour))
8163 (defun org-agenda-date-earlier-hours (arg)
8164 "Change the time of this item, in hour steps."
8166 (org-agenda-date-earlier arg 'hour))
8168 (defun org-agenda-show-new-time (marker stamp &optional prefix)
8169 "Show new date stamp via text properties."
8170 ;; We use text properties to make this undoable
8171 (let ((inhibit-read-only t)
8172 (buffer-invisibility-spec))
8173 (setq stamp (concat " " prefix " => " stamp))
8175 (goto-char (point-max))
8177 (when (equal marker (org-get-at-bol 'org-marker))
8178 (org-move-to-column (- (window-width) (length stamp)) t)
8179 (org-agenda-fix-tags-filter-overlays-at (point))
8180 (if (featurep 'xemacs)
8181 ;; Use `duplicable' property to trigger undo recording
8182 (let ((ex (make-extent nil nil))
8183 (gl (make-glyph stamp)))
8184 (set-glyph-face gl 'secondary-selection)
8185 (set-extent-properties
8186 ex (list 'invisible t 'end-glyph gl 'duplicable t))
8187 (insert-extent ex (1- (point)) (point-at-eol)))
8188 (add-text-properties
8189 (1- (point)) (point-at-eol)
8190 (list 'display (org-add-props stamp nil
8191 'face 'secondary-selection))))
8192 (beginning-of-line 1))
8193 (beginning-of-line 0)))))
8195 (defun org-agenda-date-prompt (arg)
8196 "Change the date of this item. Date is prompted for, with default today.
8197 The prefix ARG is passed to the `org-time-stamp' command and can therefore
8198 be used to request time specification in the time stamp."
8200 (org-agenda-check-type t 'agenda 'timeline)
8201 (org-agenda-check-no-diary)
8202 (let* ((marker (or (org-get-at-bol 'org-marker)
8203 (org-agenda-error)))
8204 (buffer (marker-buffer marker))
8205 (pos (marker-position marker)))
8206 (org-with-remote-undo buffer
8207 (with-current-buffer buffer
8210 (if (not (org-at-timestamp-p t))
8211 (error "Cannot find time stamp"))
8212 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
8213 (org-agenda-show-new-time marker org-last-changed-timestamp))
8214 (message "Time stamp changed to %s" org-last-changed-timestamp)))
8216 (defun org-agenda-schedule (arg &optional time)
8217 "Schedule the item at point.
8218 ARG is passed through to `org-schedule'."
8220 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8221 (org-agenda-check-no-diary)
8222 (let* ((marker (or (org-get-at-bol 'org-marker)
8223 (org-agenda-error)))
8224 (type (marker-insertion-type marker))
8225 (buffer (marker-buffer marker))
8226 (pos (marker-position marker))
8227 (org-insert-labeled-timestamps-at-point nil)
8229 (set-marker-insertion-type marker t)
8230 (org-with-remote-undo buffer
8231 (with-current-buffer buffer
8234 (setq ts (org-schedule arg time)))
8235 (org-agenda-show-new-time marker ts "S"))
8236 (message "Item scheduled for %s" ts)))
8238 (defun org-agenda-deadline (arg &optional time)
8239 "Schedule the item at point.
8240 ARG is passed through to `org-deadline'."
8242 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8243 (org-agenda-check-no-diary)
8244 (let* ((marker (or (org-get-at-bol 'org-marker)
8245 (org-agenda-error)))
8246 (buffer (marker-buffer marker))
8247 (pos (marker-position marker))
8248 (org-insert-labeled-timestamps-at-point nil)
8250 (org-with-remote-undo buffer
8251 (with-current-buffer buffer
8254 (setq ts (org-deadline arg time)))
8255 (org-agenda-show-new-time marker ts "D"))
8256 (message "Deadline for this item set to %s" ts)))
8258 (defun org-agenda-action ()
8259 "Select entry for agenda action, or execute an agenda action.
8260 This command prompts for another letter. Valid inputs are:
8262 m Mark the entry at point for an agenda action
8263 s Schedule the marked entry to the date at the cursor
8264 d Set the deadline of the marked entry to the date at the cursor
8265 r Call `org-remember' with cursor date as the default date
8266 c Call `org-capture' with cursor date as the default date
8267 SPC Show marked entry in other window
8268 TAB Visit marked entry in other window
8270 The cursor may be at a date in the calendar, or in the Org agenda."
8273 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8274 (setq ans (read-char-exclusive))
8278 (if (eq major-mode 'org-agenda-mode)
8279 (let ((m (or (org-get-at-bol 'org-hd-marker)
8280 (org-get-at-bol 'org-marker))))
8283 (move-marker org-agenda-action-marker
8284 (marker-position m) (marker-buffer m))
8285 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8286 (error "Don't know which entry to mark")))
8287 (error "This command works only in the agenda")))
8289 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8291 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8293 (org-agenda-do-action '(org-remember) t))
8295 (org-agenda-do-action '(org-capture) t))
8297 (let ((cw (selected-window)))
8298 (org-switch-to-buffer-other-window
8299 (marker-buffer org-agenda-action-marker))
8300 (goto-char org-agenda-action-marker)
8301 (org-show-context 'agenda)
8302 (select-window cw)))
8304 (org-switch-to-buffer-other-window
8305 (marker-buffer org-agenda-action-marker))
8306 (goto-char org-agenda-action-marker)
8307 (org-show-context 'agenda))
8308 (t (error "Invalid agenda action %c" ans)))))
8310 (defun org-agenda-do-action (form &optional current-buffer)
8311 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8312 (let ((org-overriding-default-time (org-get-cursor-date)))
8315 (if (not (marker-buffer org-agenda-action-marker))
8316 (error "No entry has been selected for agenda action")
8317 (with-current-buffer (marker-buffer org-agenda-action-marker)
8321 (goto-char org-agenda-action-marker)
8324 (defun org-agenda-clock-in (&optional arg)
8325 "Start the clock on the currently selected item."
8327 (org-agenda-check-no-diary)
8328 (if (equal arg '(4))
8330 (let* ((marker (or (org-get-at-bol 'org-marker)
8331 (org-agenda-error)))
8332 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8334 (pos (marker-position marker))
8336 (org-with-remote-undo (marker-buffer marker)
8337 (with-current-buffer (marker-buffer marker)
8340 (org-show-context 'agenda)
8342 (org-cycle-hide-drawers 'children)
8344 (setq newhead (org-get-heading)))
8345 (org-agenda-change-all-lines newhead hdmarker)))))
8347 (defun org-agenda-clock-out ()
8348 "Stop the currently running clock."
8350 (unless (marker-buffer org-clock-marker)
8351 (error "No running clock"))
8352 (let ((marker (make-marker)) newhead)
8353 (org-with-remote-undo (marker-buffer org-clock-marker)
8354 (with-current-buffer (marker-buffer org-clock-marker)
8358 (goto-char org-clock-marker)
8359 (org-back-to-heading t)
8360 (move-marker marker (point))
8362 (setq newhead (org-get-heading))))))
8363 (org-agenda-change-all-lines newhead marker)
8364 (move-marker marker nil)))
8366 (defun org-agenda-clock-cancel (&optional arg)
8367 "Cancel the currently running clock."
8369 (unless (marker-buffer org-clock-marker)
8370 (error "No running clock"))
8371 (org-with-remote-undo (marker-buffer org-clock-marker)
8372 (org-clock-cancel)))
8374 (defun org-agenda-clock-goto ()
8375 "Jump to the currently clocked in task within the agenda.
8376 If the currently clocked in task is not listed in the agenda
8377 buffer, display it in another window."
8381 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8382 (setq pos (overlay-start o))))
8383 (overlays-in (point-min) (point-max)))
8384 (cond (pos (goto-char pos))
8385 ;; If the currently clocked entry is not in the agenda
8386 ;; buffer, we visit it in another window:
8387 (org-clock-current-task
8388 (org-switch-to-buffer-other-window (org-clock-goto)))
8389 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8391 (defun org-agenda-diary-entry-in-org-file ()
8392 "Make a diary entry in the file `org-agenda-diary-file'."
8393 (let (d1 d2 char (text "") dp1 dp2)
8394 (if (equal (buffer-name) "*Calendar*")
8395 (setq d1 (calendar-cursor-to-date t)
8396 d2 (car calendar-mark-ring))
8397 (setq dp1 (get-text-property (point-at-bol) 'day))
8398 (unless dp1 (error "No date defined in current line"))
8399 (setq d1 (calendar-gregorian-from-absolute dp1)
8400 d2 (and (ignore-errors (mark))
8403 (setq dp2 (get-text-property (point-at-bol) 'day)))
8404 (calendar-gregorian-from-absolute dp2))))
8405 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8406 (setq char (read-char-exclusive))
8409 (setq text (read-string "Day entry: "))
8410 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8411 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8413 (setq d1 (list (car d1) (nth 1 d1)
8414 (read-number (format "Reference year [%d]: " (nth 2 d1))
8416 (setq text (read-string "Anniversary (use %d to show years): "))
8417 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8418 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8420 (setq text (read-string "Block entry: "))
8421 (unless (and d1 d2 (not (equal d1 d2)))
8422 (error "No block of days selected"))
8423 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8424 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8426 (org-switch-to-buffer-other-window
8427 (find-file-noselect org-agenda-diary-file))
8428 (require 'org-datetree)
8429 (org-datetree-find-date-create d1)
8431 (t (error "Invalid selection character `%c'" char)))))
8433 (defcustom org-agenda-insert-diary-strategy 'date-tree
8434 "Where in `org-agenda-diary-file' should new entries be added?
8437 date-tree in the date tree, as child of the date
8438 top-level as top-level entries at the end of the file."
8441 (const :tag "in a date tree" date-tree)
8442 (const :tag "as top level at end of file" top-level)))
8444 (defcustom org-agenda-insert-diary-extract-time nil
8445 "Non-nil means extract any time specification from the diary entry."
8450 (defcustom org-agenda-bulk-mark-char ">"
8451 "A single-character string to be used as the bulk mark."
8456 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8457 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8458 If TEXT is not empty, it will become the headline of the new entry, and
8459 the resulting entry will not be shown. When TEXT is empty, switch to
8460 `org-agenda-diary-file' and let the user finish the entry there."
8461 (let ((cw (current-window-configuration)))
8462 (org-switch-to-buffer-other-window
8463 (find-file-noselect org-agenda-diary-file))
8465 (goto-char (point-min))
8467 ((eq type 'anniversary)
8468 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8470 (or (org-at-heading-p t)
8472 (outline-next-heading)
8473 (insert "* Anniversaries\n\n")
8474 (beginning-of-line -1)))))
8475 (outline-next-heading)
8476 (org-back-over-empty-lines)
8479 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8480 (nth 2 d1) (car d1) (nth 1 d1) text)))
8482 (let ((org-prefix-has-time t)
8483 (org-agenda-time-leading-zero t)
8485 (if org-agenda-insert-diary-extract-time
8486 ;; Use org-agenda-format-item to parse text for a time-range and
8487 ;; remove it. FIXME: This is a hack, we should refactor
8488 ;; that function to make time extraction available separately
8489 (setq fmt (org-agenda-format-item nil text nil nil t)
8490 time (get-text-property 0 'time fmt)
8491 time2 (if (> (length time) 0)
8492 ;; split-string removes trailing ...... if
8493 ;; no end time given. First space
8494 ;; separates time from date.
8495 (concat " " (car (split-string time "\\.")))
8497 text (get-text-property 0 'txt fmt)))
8498 (if (eq org-agenda-insert-diary-strategy 'top-level)
8499 (org-agenda-insert-diary-as-top-level text)
8500 (require 'org-datetree)
8501 (org-datetree-find-date-create d1)
8502 (org-agenda-insert-diary-make-new-entry text))
8503 (org-insert-time-stamp (org-time-from-absolute
8504 (calendar-absolute-from-gregorian d1))
8505 nil nil nil nil time2))
8508 (if (> (calendar-absolute-from-gregorian d1)
8509 (calendar-absolute-from-gregorian d2))
8510 (setq d1 (prog1 d2 (setq d2 d1))))
8511 (if (eq org-agenda-insert-diary-strategy 'top-level)
8512 (org-agenda-insert-diary-as-top-level text)
8513 (require 'org-datetree)
8514 (org-datetree-find-date-create d1)
8515 (org-agenda-insert-diary-make-new-entry text))
8516 (org-insert-time-stamp (org-time-from-absolute
8517 (calendar-absolute-from-gregorian d1)))
8519 (org-insert-time-stamp (org-time-from-absolute
8520 (calendar-absolute-from-gregorian d2)))
8522 (if (string-match "\\S-" text)
8524 (set-window-configuration cw)
8525 (message "%s entry added to %s"
8526 (capitalize (symbol-name type))
8527 (abbreviate-file-name org-agenda-diary-file)))
8529 (message "Please finish entry here"))))
8531 (defun org-agenda-insert-diary-as-top-level (text)
8532 "Make new entry as a top-level entry at the end of the file.
8533 Add TEXT as headline, and position the cursor in the second line so that
8534 a timestamp can be added there."
8536 (goto-char (point-max))
8537 (or (bolp) (insert "\n"))
8538 (insert "* " text "\n")
8539 (if org-adapt-indentation (org-indent-to-column 2)))
8541 (defun org-agenda-insert-diary-make-new-entry (text)
8542 "Make new entry as last child of current entry.
8543 Add TEXT as headline, and position the cursor in the second line so that
8544 a timestamp can be added there."
8545 (let ((org-show-following-heading t)
8546 (org-show-siblings t)
8547 (org-show-hierarchy-above t)
8548 (org-show-entry-below t)
8550 (outline-next-heading)
8551 (org-back-over-empty-lines)
8552 (or (looking-at "[ \t]*$")
8553 (progn (insert "\n") (backward-char 1)))
8554 (org-insert-heading nil t)
8556 (setq col (current-column))
8558 (if org-adapt-indentation (org-indent-to-column col))
8559 (let ((org-show-following-heading t)
8560 (org-show-siblings t)
8561 (org-show-hierarchy-above t)
8562 (org-show-entry-below t))
8563 (org-show-context))))
8565 (defun org-agenda-diary-entry ()
8566 "Make a diary entry, like the `i' command from the calendar.
8567 All the standard commands work: block, weekly etc.
8568 When `org-agenda-diary-file' points to a file,
8569 `org-agenda-diary-entry-in-org-file' is called instead to create
8570 entries in that Org-mode file."
8572 (org-agenda-check-type t 'agenda 'timeline)
8573 (if (not (eq org-agenda-diary-file 'diary-file))
8574 (org-agenda-diary-entry-in-org-file)
8575 (require 'diary-lib)
8577 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8578 (read-char-exclusive)))
8579 (cmd (cdr (assoc char
8580 '((?d . insert-diary-entry)
8581 (?w . insert-weekly-diary-entry)
8582 (?m . insert-monthly-diary-entry)
8583 (?y . insert-yearly-diary-entry)
8584 (?a . insert-anniversary-diary-entry)
8585 (?b . insert-block-diary-entry)
8586 (?c . insert-cyclic-diary-entry)))))
8587 (oldf (symbol-function 'calendar-cursor-to-date))
8588 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8590 (mark (or (mark t) (point))))
8592 (error "No command associated with <%c>" char))
8593 (unless (and (get-text-property point 'day)
8594 (or (not (equal ?b char))
8595 (get-text-property mark 'day)))
8596 (error "Don't know which date to use for diary entry"))
8597 ;; We implement this by hacking the `calendar-cursor-to-date' function
8598 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8599 (let ((calendar-mark-ring
8600 (list (calendar-gregorian-from-absolute
8601 (or (get-text-property mark 'day)
8602 (get-text-property point 'day))))))
8605 (fset 'calendar-cursor-to-date
8606 (lambda (&optional error dummy)
8607 (calendar-gregorian-from-absolute
8608 (get-text-property point 'day))))
8609 (call-interactively cmd))
8610 (fset 'calendar-cursor-to-date oldf))))))
8612 (defun org-agenda-execute-calendar-command (cmd)
8613 "Execute a calendar command from the agenda, with the date associated to
8614 the cursor position."
8615 (org-agenda-check-type t 'agenda 'timeline)
8616 (require 'diary-lib)
8617 (unless (get-text-property (point) 'day)
8618 (error "Don't know which date to use for calendar command"))
8619 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8621 (date (calendar-gregorian-from-absolute
8622 (get-text-property point 'day)))
8623 ;; the following 2 vars are needed in the calendar
8624 (displayed-month (car date))
8625 (displayed-year (nth 2 date)))
8628 (fset 'calendar-cursor-to-date
8629 (lambda (&optional error dummy)
8630 (calendar-gregorian-from-absolute
8631 (get-text-property point 'day))))
8632 (call-interactively cmd))
8633 (fset 'calendar-cursor-to-date oldf))))
8635 (defun org-agenda-phases-of-moon ()
8636 "Display the phases of the moon for the 3 months around the cursor date."
8638 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8640 (defun org-agenda-holidays ()
8641 "Display the holidays for the 3 months around the cursor date."
8643 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8645 (defvar calendar-longitude)
8646 (defvar calendar-latitude)
8647 (defvar calendar-location-name)
8649 (defun org-agenda-sunrise-sunset (arg)
8650 "Display sunrise and sunset for the cursor date.
8651 Latitude and longitude can be specified with the variables
8652 `calendar-latitude' and `calendar-longitude'. When called with prefix
8653 argument, latitude and longitude will be prompted for."
8656 (let ((calendar-longitude (if arg nil calendar-longitude))
8657 (calendar-latitude (if arg nil calendar-latitude))
8658 (calendar-location-name
8659 (if arg "the given coordinates" calendar-location-name)))
8660 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8662 (defun org-agenda-goto-calendar ()
8663 "Open the Emacs calendar with the date at the cursor."
8665 (org-agenda-check-type t 'agenda 'timeline)
8666 (let* ((day (or (get-text-property (point) 'day)
8667 (error "Don't know which date to open in calendar")))
8668 (date (calendar-gregorian-from-absolute day))
8669 (calendar-move-hook nil)
8670 (calendar-view-holidays-initially-flag nil)
8671 (calendar-view-diary-initially-flag nil))
8673 (calendar-goto-date date)))
8676 (defun org-calendar-goto-agenda ()
8677 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8678 This is a command that has to be installed in `calendar-mode-map'."
8680 (org-agenda-list nil (calendar-absolute-from-gregorian
8681 (calendar-cursor-to-date))
8684 (defun org-agenda-convert-date ()
8686 (org-agenda-check-type t 'agenda 'timeline)
8687 (let ((day (get-text-property (point) 'day))
8690 (error "Don't know which date to convert"))
8691 (setq date (calendar-gregorian-from-absolute day))
8693 "Gregorian: " (calendar-date-string date) "\n"
8694 "ISO: " (calendar-iso-date-string date) "\n"
8695 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8696 "Julian: " (calendar-julian-date-string date) "\n"
8697 "Astron. JD: " (calendar-astro-date-string date)
8698 " (Julian date number at noon UTC)\n"
8699 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8700 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8701 "French: " (calendar-french-date-string date) "\n"
8702 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8703 "Mayan: " (calendar-mayan-date-string date) "\n"
8704 "Coptic: " (calendar-coptic-date-string date) "\n"
8705 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8706 "Persian: " (calendar-persian-date-string date) "\n"
8707 "Chinese: " (calendar-chinese-date-string date) "\n"))
8708 (with-output-to-temp-buffer "*Dates*"
8710 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8714 (defvar org-agenda-bulk-marked-entries nil
8715 "List of markers that refer to marked entries in the agenda.")
8717 (defun org-agenda-bulk-marked-p ()
8718 (eq (get-char-property (point-at-bol) 'type)
8719 'org-marked-entry-overlay))
8721 (defun org-agenda-bulk-mark (&optional arg)
8722 "Mark the entry at point for future bulk action."
8724 (dotimes (i (or arg 1))
8725 (unless (org-get-at-bol 'org-agenda-diary-link)
8726 (let* ((m (org-get-at-bol 'org-hd-marker))
8728 (unless (org-agenda-bulk-marked-p)
8729 (unless m (error "Nothing to mark at point"))
8730 (push m org-agenda-bulk-marked-entries)
8731 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8732 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
8733 (org-get-todo-face "TODO")
8735 (overlay-put ov 'type 'org-marked-entry-overlay))
8736 (beginning-of-line 2)
8737 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8738 (beginning-of-line 2))
8739 (message "%d entries marked for bulk action"
8740 (length org-agenda-bulk-marked-entries))))))
8742 (defun org-agenda-bulk-mark-all ()
8743 "Mark all entries for future agenda bulk action."
8745 (org-agenda-bulk-mark-regexp "."))
8747 (defun org-agenda-bulk-mark-regexp (regexp)
8748 "Mark entries matching REGEXP for future agenda bulk action."
8749 (interactive "sMark entries matching regexp: ")
8750 (let ((entries-marked 0))
8752 (goto-char (point-min))
8753 (goto-char (next-single-property-change (point) 'txt))
8754 (while (re-search-forward regexp nil t)
8755 (when (string-match regexp (get-text-property (point) 'txt))
8756 (setq entries-marked (1+ entries-marked))
8757 (call-interactively 'org-agenda-bulk-mark))))
8758 (if (not entries-marked)
8759 (message "No entry matching this regexp."))))
8761 (defun org-agenda-bulk-unmark (&optional arg)
8762 "Unmark the entry at point for future bulk action."
8765 (org-agenda-bulk-unmark-all)
8766 (cond ((org-agenda-bulk-marked-p)
8767 (org-agenda-bulk-remove-overlays
8768 (point-at-bol) (+ 2 (point-at-bol)))
8769 (setq org-agenda-bulk-marked-entries
8770 (delete (org-get-at-bol 'org-hd-marker)
8771 org-agenda-bulk-marked-entries))
8772 (beginning-of-line 2)
8773 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8774 (beginning-of-line 2))
8775 (message "%d entries left marked for bulk action"
8776 (length org-agenda-bulk-marked-entries)))
8777 (t (message "No entry to unmark here")))))
8779 (defun org-agenda-bulk-toggle ()
8780 "Toggle marking the entry at point for bulk action."
8782 (if (org-agenda-bulk-marked-p)
8783 (org-agenda-bulk-unmark)
8784 (org-agenda-bulk-mark)))
8786 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8787 "Remove the mark overlays between BEG and END in the agenda buffer.
8788 BEG and END default to the buffer limits.
8790 This only removes the overlays, it does not remove the markers
8791 from the list in `org-agenda-bulk-marked-entries'."
8794 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8795 (delete-overlay ov)))
8796 (overlays-in (or beg (point-min)) (or end (point-max)))))
8798 (defun org-agenda-bulk-unmark-all ()
8799 "Remove all marks in the agenda buffer.
8800 This will remove the markers and the overlays."
8802 (if (null org-agenda-bulk-marked-entries)
8803 (message "No entry to unmark")
8804 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8805 (setq org-agenda-bulk-marked-entries nil)
8806 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
8808 (defcustom org-agenda-persistent-marks nil
8809 "Non-nil means marked items will stay marked after a bulk action.
8810 You can toggle this interactively by typing `p' when prompted for a
8816 (defun org-agenda-bulk-action (&optional arg)
8817 "Execute an remote-editing action on all marked entries.
8818 The prefix arg is passed through to the command if possible."
8820 ;; Make sure we have markers, and only valid ones
8821 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8824 (unless (and (markerp m)
8826 (buffer-live-p (marker-buffer m))
8827 (marker-position m))
8828 (error "Marker %s for bulk command is invalid" m)))
8829 org-agenda-bulk-marked-entries)
8831 ;; Prompt for the bulk command
8832 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
8833 (message (concat msg "[r]efile [$]arch [A]rch->sib [t]odo"
8834 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction "
8835 (when org-agenda-bulk-custom-functions
8836 (concat " Custom: ["
8837 (mapconcat (lambda(f) (char-to-string (car f)))
8838 org-agenda-bulk-custom-functions "")
8841 (let* ((action (read-char-exclusive))
8842 (org-log-refile (if org-log-refile 'time nil))
8843 (entries (reverse org-agenda-bulk-marked-entries))
8845 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8848 (let ((org-agenda-persistent-marks
8849 (not org-agenda-persistent-marks)))
8850 (org-agenda-bulk-action)
8854 (setq cmd '(org-agenda-archive)))
8857 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8859 ((member action '(?r ?w))
8860 (setq rfloc (org-refile-get-location
8862 (marker-buffer (car org-agenda-bulk-marked-entries))
8863 org-refile-allow-creating-parent-nodes))
8865 (setcar (nthcdr 3 rfloc)
8866 (move-marker (make-marker) (nth 3 rfloc)
8867 (or (get-file-buffer (nth 1 rfloc))
8868 (find-buffer-visiting (nth 1 rfloc))
8869 (error "This should not happen")))))
8871 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8875 (setq state (org-icompleting-read
8877 (with-current-buffer (marker-buffer (car entries))
8878 (mapcar 'list org-todo-keywords-1))))
8879 (setq cmd `(let ((org-inhibit-blocking t)
8880 (org-inhibit-logging 'note))
8881 (org-agenda-todo ,state))))
8883 ((memq action '(?- ?+))
8884 (setq tag (org-icompleting-read
8885 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8886 (with-current-buffer (marker-buffer (car entries))
8889 (if (stringp (car x)) x)) org-tag-alist)))))
8890 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8892 ((memq action '(?s ?d))
8893 (let* ((date (unless arg
8896 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8897 (ans (if arg nil org-read-date-final-answer))
8898 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8899 (setq cmd `(let* ((bound (fboundp 'read-string))
8900 (old (and bound (symbol-function 'read-string))))
8903 (fset 'read-string (lambda (&rest ignore) ,ans))
8906 (fset 'read-string old)
8907 (fmakunbound 'read-string)))))))
8910 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8911 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8912 (let ((days (read-number
8913 (format "Scatter tasks across how many %sdays: "
8914 (if arg "week" "")) 7)))
8916 `(let ((distance (1+ (random ,days))))
8918 (let ((dist distance)
8920 (calendar-day-of-week
8921 (calendar-gregorian-from-absolute (org-today)))))
8922 (dotimes (i (1+ dist))
8923 (while (member day-of-week org-agenda-weekend-days)
8926 (if (= day-of-week 7)
8927 (setq day-of-week 0)))
8929 (if (= day-of-week 7)
8930 (setq day-of-week 0)))))
8931 ;; silently fail when try to replan a sexp entry
8933 (let* ((date (calendar-gregorian-from-absolute
8934 (+ (org-today) distance)))
8935 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8937 (org-agenda-schedule nil time))
8940 ((assoc action org-agenda-bulk-custom-functions)
8941 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8945 (setq cmd (list (intern
8946 (org-icompleting-read "Function: "
8947 obarray 'fboundp t nil nil)))))
8949 (t (error "Invalid bulk action")))
8951 ;; Sort the markers, to make sure that parents are handled before children
8952 (setq entries (sort entries
8955 ((equal (marker-buffer a) (marker-buffer b))
8956 (< (marker-position a) (marker-position b)))
8958 (string< (buffer-name (marker-buffer a))
8959 (buffer-name (marker-buffer b))))))))
8961 ;; Now loop over all markers and apply cmd
8962 (while (setq e (pop entries))
8963 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8965 (progn (message "Skipping removed entry at %s" e)
8966 (setq cntskip (1+ cntskip)))
8968 (let (org-loop-over-headlines-in-active-region)
8970 (when (not org-agenda-persistent-marks)
8971 (setq org-agenda-bulk-marked-entries
8972 (delete e org-agenda-bulk-marked-entries)))
8973 (setq cnt (1+ cnt))))
8974 (when (not org-agenda-persistent-marks)
8975 (org-agenda-bulk-unmark-all))
8976 (when redo-at-end (org-agenda-redo))
8977 (message "Acted on %d entries%s%s"
8981 (format ", skipped %d (disappeared before their turn)"
8983 (if (not org-agenda-persistent-marks)
8984 "" " (kept marked)"))))))
8988 (defun org-agenda-show-the-flagging-note ()
8989 "Display the flagging note in the other window.
8990 When called a second time in direct sequence, offer to remove the FLAGGING
8991 tag and (if present) the flagging note."
8993 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8994 (win (selected-window))
8995 note heading newhead)
8997 (error "No linked entry at point"))
8998 (if (and (eq this-command last-command)
8999 (y-or-n-p "Unflag and remove any flagging note? "))
9001 (org-agenda-remove-flag hdmarker)
9002 (let ((win (get-buffer-window "*Flagging Note*")))
9003 (and win (delete-window win)))
9004 (message "Entry unflagged"))
9005 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
9007 (error "No flagging note"))
9009 (org-switch-to-buffer-other-window "*Flagging Note*")
9012 (goto-char (point-min))
9013 (while (re-search-forward "\\\\n" nil t)
9014 (replace-match "\n" t t))
9015 (goto-char (point-min))
9017 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
9019 (defun org-agenda-remove-flag (marker)
9020 "Remove the FLAGGED tag and any flagging note in the entry."
9022 (org-with-point-at marker
9023 (org-toggle-tag "FLAGGED" 'off)
9024 (org-entry-delete nil "THEFLAGGINGNOTE")
9025 (setq newhead (org-get-heading)))
9026 (org-agenda-change-all-lines newhead marker)
9027 (message "Entry unflagged")))
9029 (defun org-agenda-get-any-marker (&optional pos)
9030 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
9031 (get-text-property (or pos (point-at-bol)) 'org-marker)))
9033 ;;; Appointment reminders
9035 (defvar appt-time-msg-list)
9038 (defun org-agenda-to-appt (&optional refresh filter &rest args)
9039 "Activate appointments found in `org-agenda-files'.
9040 With a \\[universal-argument] prefix, refresh the list of
9043 If FILTER is t, interactively prompt the user for a regular
9044 expression, and filter out entries that don't match it.
9046 If FILTER is a string, use this string as a regular expression
9047 for filtering entries out.
9049 If FILTER is a function, filter out entries against which
9050 calling the function returns nil. This function takes one
9051 argument: an entry from `org-agenda-get-day-entries'.
9053 FILTER can also be an alist with the car of each cell being
9054 either 'headline or 'category. For example:
9056 '((headline \"IMPORTANT\")
9057 (category \"Work\"))
9059 will only add headlines containing IMPORTANT or headlines
9060 belonging to the \"Work\" category.
9062 ARGS are symbols indicating what kind of entries to consider.
9063 By default `org-agenda-to-appt' will use :deadline, :scheduled
9064 and :timestamp entries. See the docstring of `org-diary' for
9065 details and examples.
9067 If an entry as a APPT_WARNTIME property, its value will be used
9068 to override `appt-message-warning-time'."
9070 (if refresh (setq appt-time-msg-list nil))
9072 (setq filter (read-from-minibuffer "Regexp filter: ")))
9073 (let* ((cnt 0) ; count added events
9074 (scope (or args '(:deadline :scheduled :timestamp)))
9075 (org-agenda-new-buffers nil)
9076 (org-deadline-warning-days 0)
9077 ;; Do not use `org-today' here because appt only takes
9078 ;; time and without date as argument, so it may pass wrong
9079 ;; information otherwise
9080 (today (org-date-to-gregorian
9081 (time-to-days (current-time))))
9082 (org-agenda-restrict nil)
9083 (files (org-agenda-files 'unrestricted)) entries file
9084 (org-agenda-buffer nil))
9085 ;; Get all entries which may contain an appt
9086 (org-prepare-agenda-buffers files)
9087 (while (setq file (pop files))
9091 (apply 'org-agenda-get-day-entries
9092 file today scope)))))
9093 ;; Map thru entries and find if we should filter them out
9096 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
9097 (cat (get-text-property 1 'org-category x))
9098 (tod (get-text-property 1 'time-of-day x))
9099 (ok (or (null filter)
9100 (and (stringp filter) (string-match filter evt))
9101 (and (functionp filter) (funcall filter x))
9103 (let ((cat-filter (cadr (assoc 'category filter)))
9104 (evt-filter (cadr (assoc 'headline filter))))
9105 (or (and (stringp cat-filter)
9106 (string-match cat-filter cat))
9107 (and (stringp evt-filter)
9108 (string-match evt-filter evt)))))))
9109 (wrn (get-text-property 1 'warntime x)))
9110 ;; FIXME: Shall we remove text-properties for the appt text?
9111 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
9113 (setq tod (concat "00" (number-to-string tod))
9114 tod (when (string-match
9115 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
9116 (concat (match-string 1 tod) ":"
9117 (match-string 2 tod))))
9118 (if (version< emacs-version "23.3")
9120 (appt-add tod evt wrn))
9121 (setq cnt (1+ cnt))))) entries)
9122 (org-release-buffers org-agenda-new-buffers)
9124 (message "No event to add")
9125 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
9127 (defun org-agenda-todayp (date)
9128 "Does DATE mean today, when considering `org-extend-today-until'?"
9129 (let ((today (org-today))
9130 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
9134 (defun org-agenda-todo-yesterday (&optional arg)
9135 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
9137 (let* ((hour (third (decode-time
9138 (org-current-time))))
9139 (org-extend-today-until (1+ hour)))
9140 (org-agenda-todo arg)))
9142 (provide 'org-agenda)
9144 ;;; org-agenda.el ends here