Add version tag "24.1" for options introduced since Emacs 23.4 (and <= 24.1)
[org-mode.git] / lisp / org-agenda.el
blob67e06c06ace678473ab3eb6d1dab5b6107ecd05c
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
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (eval-when-compile
50 (require 'cl))
52 (declare-function diary-add-to-list "diary-lib"
53 (date string specifier &optional marker globcolor literal))
54 (declare-function calendar-absolute-from-iso "cal-iso" (date))
55 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
56 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
57 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
58 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
59 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-french-date-string "cal-french" (&optional date))
61 (declare-function calendar-goto-date "cal-move" (date))
62 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
63 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
64 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
65 (declare-function calendar-iso-from-absolute "cal-iso" (date))
66 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
67 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
68 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
69 (declare-function calendar-check-holidays "holidays" (date))
71 (declare-function org-datetree-find-date-create "org-datetree"
72 (date &optional keep-restriction))
73 (declare-function org-columns-quit "org-colview" ())
74 (declare-function diary-date-display-form "diary-lib" (&optional type))
75 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
76 (declare-function org-habit-insert-consistency-graphs
77 "org-habit" (&optional line))
78 (declare-function org-is-habit-p "org-habit" (&optional pom))
79 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
80 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
81 (declare-function org-pop-to-buffer-same-window "org-compat"
82 (&optional buffer-or-name norecord label))
84 (defvar calendar-mode-map)
85 (defvar org-clock-current-task) ; defined in org-clock.el
86 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
87 (defvar org-habit-show-habits)
88 (defvar org-habit-show-habits-only-for-today)
90 ;; Defined somewhere in this file, but used before definition.
91 (defvar org-agenda-buffer-name)
92 (defvar org-agenda-overriding-header)
93 (defvar org-agenda-title-append nil)
94 (defvar entry)
95 (defvar date)
96 (defvar org-agenda-undo-list)
97 (defvar org-agenda-pending-undo-list)
98 (defvar original-date) ; dynamically scoped, calendar.el does scope this
100 (defcustom org-agenda-confirm-kill 1
101 "When set, remote killing from the agenda buffer needs confirmation.
102 When t, a confirmation is always needed. When a number N, confirmation is
103 only needed when the text to be killed contains more than N non-white lines."
104 :group 'org-agenda
105 :type '(choice
106 (const :tag "Never" nil)
107 (const :tag "Always" t)
108 (integer :tag "When more than N lines")))
110 (defcustom org-agenda-compact-blocks nil
111 "Non-nil means make the block agenda more compact.
112 This is done globally by leaving out lines like the agenda span
113 name and week number or the separator lines."
114 :group 'org-agenda
115 :type 'boolean)
117 (defcustom org-agenda-block-separator ?=
118 "The separator between blocks in the agenda.
119 If this is a string, it will be used as the separator, with a newline added.
120 If it is a character, it will be repeated to fill the window width.
121 If nil the separator is disabled. In `org-agenda-custom-commands' this
122 addresses the separator between the current and the previous block."
123 :group 'org-agenda
124 :type '(choice
125 (const :tag "Disabled" nil)
126 (character)
127 (string)))
129 (defgroup org-agenda-export nil
130 "Options concerning exporting agenda views in Org-mode."
131 :tag "Org Agenda Export"
132 :group 'org-agenda)
134 (defcustom org-agenda-with-colors t
135 "Non-nil means use colors in agenda views."
136 :group 'org-agenda-export
137 :type 'boolean)
139 (defcustom org-agenda-exporter-settings nil
140 "Alist of variable/value pairs that should be active during agenda export.
141 This is a good place to set options for ps-print and for htmlize.
142 Note that the way this is implemented, the values will be evaluated
143 before assigned to the variables. So make sure to quote values you do
144 *not* want evaluated, for example
146 (setq org-agenda-exporter-settings
147 '((ps-print-color-p 'black-white)))"
148 :group 'org-agenda-export
149 :type '(repeat
150 (list
151 (variable)
152 (sexp :tag "Value"))))
154 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
155 "Hook run in temporary buffer before writing it to an export file.
156 A useful function is `org-agenda-add-entry-text'."
157 :group 'org-agenda-export
158 :type 'hook
159 :options '(org-agenda-add-entry-text))
161 (defcustom org-agenda-add-entry-text-maxlines 0
162 "Maximum number of entry text lines to be added to agenda.
163 This is only relevant when `org-agenda-add-entry-text' is part of
164 `org-agenda-before-write-hook', which it is by default.
165 When this is 0, nothing will happen. When it is greater than 0, it
166 specifies the maximum number of lines that will be added for each entry
167 that is listed in the agenda view.
169 Note that this variable is not used during display, only when exporting
170 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
171 and `org-agenda-entry-text-maxlines'."
172 :group 'org-agenda
173 :type 'integer)
175 (defcustom org-agenda-add-entry-text-descriptive-links t
176 "Non-nil means export org-links as descriptive links in agenda added text.
177 This variable applies to the text added to the agenda when
178 `org-agenda-add-entry-text-maxlines' is larger than 0.
179 When this variable nil, the URL will (also) be shown."
180 :group 'org-agenda
181 :type 'boolean)
183 (defcustom org-agenda-export-html-style ""
184 "The style specification for exported HTML Agenda files.
185 If this variable contains a string, it will replace the default <style>
186 section as produced by `htmlize'.
187 Since there are different ways of setting style information, this variable
188 needs to contain the full HTML structure to provide a style, including the
189 surrounding HTML tags. The style specifications should include definitions
190 the fonts used by the agenda, here is an example:
192 <style type=\"text/css\">
193 p { font-weight: normal; color: gray; }
194 .org-agenda-structure {
195 font-size: 110%;
196 color: #003399;
197 font-weight: 600;
199 .org-todo {
200 color: #cc6666;
201 font-weight: bold;
203 .org-agenda-done {
204 color: #339933;
206 .org-done {
207 color: #339933;
209 .title { text-align: center; }
210 .todo, .deadline { color: red; }
211 .done { color: green; }
212 </style>
214 or, if you want to keep the style in a file,
216 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
218 As the value of this option simply gets inserted into the HTML <head> header,
219 you can \"misuse\" it to also add other text to the header. However,
220 <style>...</style> is required, if not present the variable will be ignored."
221 :group 'org-agenda-export
222 :group 'org-export-html
223 :type 'string)
225 (defcustom org-agenda-persistent-filter nil
226 "When set, keep filters from one agenda view to the next."
227 :group 'org-agenda
228 :type 'boolean)
230 (defgroup org-agenda-custom-commands nil
231 "Options concerning agenda views in Org-mode."
232 :tag "Org Agenda Custom Commands"
233 :group 'org-agenda)
235 (defconst org-sorting-choice
236 '(choice
237 (const time-up) (const time-down)
238 (const category-keep) (const category-up) (const category-down)
239 (const tag-down) (const tag-up)
240 (const priority-up) (const priority-down)
241 (const todo-state-up) (const todo-state-down)
242 (const effort-up) (const effort-down)
243 (const habit-up) (const habit-down)
244 (const alpha-up) (const alpha-down)
245 (const user-defined-up) (const user-defined-down))
246 "Sorting choices.")
248 ;; Keep custom values for `org-agenda-filter-preset' compatible with
249 ;; the new variable `org-agenda-tag-filter-preset'.
250 (if (fboundp 'defvaralias)
251 (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
252 (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
254 (defconst org-agenda-custom-commands-local-options
255 `(repeat :tag "Local settings for this command. Remember to quote values"
256 (choice :tag "Setting"
257 (list :tag "Heading for this block"
258 (const org-agenda-overriding-header)
259 (string :tag "Headline"))
260 (list :tag "Files to be searched"
261 (const org-agenda-files)
262 (list
263 (const :format "" quote)
264 (repeat (file))))
265 (list :tag "Sorting strategy"
266 (const org-agenda-sorting-strategy)
267 (list
268 (const :format "" quote)
269 (repeat
270 ,org-sorting-choice)))
271 (list :tag "Prefix format"
272 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
273 (string))
274 (list :tag "Number of days in agenda"
275 (const org-agenda-span)
276 (choice (const :tag "Day" 'day)
277 (const :tag "Week" 'week)
278 (const :tag "Month" 'month)
279 (const :tag "Year" 'year)
280 (integer :tag "Custom")))
281 (list :tag "Fixed starting date"
282 (const org-agenda-start-day)
283 (string :value "2007-11-01"))
284 (list :tag "Start on day of week"
285 (const org-agenda-start-on-weekday)
286 (choice :value 1
287 (const :tag "Today" nil)
288 (integer :tag "Weekday No.")))
289 (list :tag "Include data from diary"
290 (const org-agenda-include-diary)
291 (boolean))
292 (list :tag "Deadline Warning days"
293 (const org-deadline-warning-days)
294 (integer :value 1))
295 (list :tag "Category filter preset"
296 (const org-agenda-category-filter-preset)
297 (list
298 (const :format "" quote)
299 (repeat
300 (string :tag "+category or -category"))))
301 (list :tag "Tags filter preset"
302 (const org-agenda-tag-filter-preset)
303 (list
304 (const :format "" quote)
305 (repeat
306 (string :tag "+tag or -tag"))))
307 (list :tag "Set daily/weekly entry types"
308 (const org-agenda-entry-types)
309 (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
310 (const :deadline)
311 (const :scheduled)
312 (const :timestamp)
313 (const :sexp)))
314 (list :tag "Standard skipping condition"
315 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
316 (const org-agenda-skip-function)
317 (list
318 (const :format "" quote)
319 (list
320 (choice
321 :tag "Skipping range"
322 (const :tag "Skip entry" org-agenda-skip-entry-if)
323 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
324 (repeat :inline t :tag "Conditions for skipping"
325 (choice
326 :tag "Condition type"
327 (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
328 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
329 (list :tag "TODO state is" :inline t
330 (const 'todo)
331 (choice
332 (const :tag "any not-done state" 'todo)
333 (const :tag "any done state" 'done)
334 (const :tag "any state" 'any)
335 (list :tag "Keyword list"
336 (const :format "" quote)
337 (repeat (string :tag "Keyword")))))
338 (list :tag "TODO state is not" :inline t
339 (const 'nottodo)
340 (choice
341 (const :tag "any not-done state" 'todo)
342 (const :tag "any done state" 'done)
343 (const :tag "any state" 'any)
344 (list :tag "Keyword list"
345 (const :format "" quote)
346 (repeat (string :tag "Keyword")))))
347 (const :tag "scheduled" 'scheduled)
348 (const :tag "not scheduled" 'notscheduled)
349 (const :tag "deadline" 'deadline)
350 (const :tag "no deadline" 'notdeadline)
351 (const :tag "timestamp" 'timestamp)
352 (const :tag "no timestamp" 'nottimestamp))))))
353 (list :tag "Non-standard skipping condition"
354 :value (org-agenda-skip-function)
355 (const org-agenda-skip-function)
356 (sexp :tag "Function or form (quoted!)"))
357 (list :tag "Any variable"
358 (variable :tag "Variable")
359 (sexp :tag "Value (sexp)"))))
360 "Selection of examples for agenda command settings.
361 This will be spliced into the custom type of
362 `org-agenda-custom-commands'.")
365 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
366 ((agenda "") (alltodo))))
367 "Custom commands for the agenda.
368 These commands will be offered on the splash screen displayed by the
369 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
371 (key desc type match settings files)
373 key The key (one or more characters as a string) to be associated
374 with the command.
375 desc A description of the command, when omitted or nil, a default
376 description is built using MATCH.
377 type The command type, any of the following symbols:
378 agenda The daily/weekly agenda.
379 todo Entries with a specific TODO keyword, in all agenda files.
380 search Entries containing search words entry or headline.
381 tags Tags/Property/TODO match in all agenda files.
382 tags-todo Tags/P/T match in all agenda files, TODO entries only.
383 todo-tree Sparse tree of specific TODO keyword in *current* file.
384 tags-tree Sparse tree with all tags matches in *current* file.
385 occur-tree Occur sparse tree for *current* file.
386 ... A user-defined function.
387 match What to search for:
388 - a single keyword for TODO keyword searches
389 - a tags match expression for tags searches
390 - a word search expression for text searches.
391 - a regular expression for occur searches
392 For all other commands, this should be the empty string.
393 settings A list of option settings, similar to that in a let form, so like
394 this: ((opt1 val1) (opt2 val2) ...). The values will be
395 evaluated at the moment of execution, so quote them when needed.
396 files A list of files file to write the produced agenda buffer to
397 with the command `org-store-agenda-views'.
398 If a file name ends in \".html\", an HTML version of the buffer
399 is written out. If it ends in \".ps\", a postscript version is
400 produced. Otherwise, only the plain text is written to the file.
402 You can also define a set of commands, to create a composite agenda buffer.
403 In this case, an entry looks like this:
405 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
407 where
409 desc A description string to be displayed in the dispatcher menu.
410 cmd An agenda command, similar to the above. However, tree commands
411 are no allowed, but instead you can get agenda and global todo list.
412 So valid commands for a set are:
413 (agenda \"\" settings)
414 (alltodo \"\" settings)
415 (stuck \"\" settings)
416 (todo \"match\" settings files)
417 (search \"match\" settings files)
418 (tags \"match\" settings files)
419 (tags-todo \"match\" settings files)
421 Each command can carry a list of options, and another set of options can be
422 given for the whole set of commands. Individual command options take
423 precedence over the general options.
425 When using several characters as key to a command, the first characters
426 are prefix commands. For the dispatcher to display useful information, you
427 should provide a description for the prefix, like
429 (setq org-agenda-custom-commands
430 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
431 (\"hl\" tags \"+HOME+Lisa\")
432 (\"hp\" tags \"+HOME+Peter\")
433 (\"hk\" tags \"+HOME+Kim\")))"
434 :group 'org-agenda-custom-commands
435 :type `(repeat
436 (choice :value ("x" "Describe command here" tags "" nil)
437 (list :tag "Single command"
438 (string :tag "Access Key(s) ")
439 (option (string :tag "Description"))
440 (choice
441 (const :tag "Agenda" agenda)
442 (const :tag "TODO list" alltodo)
443 (const :tag "Search words" search)
444 (const :tag "Stuck projects" stuck)
445 (const :tag "Tags/Property match (all agenda files)" tags)
446 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
447 (const :tag "TODO keyword search (all agenda files)" todo)
448 (const :tag "Tags sparse tree (current buffer)" tags-tree)
449 (const :tag "TODO keyword tree (current buffer)" todo-tree)
450 (const :tag "Occur tree (current buffer)" occur-tree)
451 (sexp :tag "Other, user-defined function"))
452 (string :tag "Match (only for some commands)")
453 ,org-agenda-custom-commands-local-options
454 (option (repeat :tag "Export" (file :tag "Export to"))))
455 (list :tag "Command series, all agenda files"
456 (string :tag "Access Key(s)")
457 (string :tag "Description ")
458 (repeat :tag "Component"
459 (choice
460 (list :tag "Agenda"
461 (const :format "" agenda)
462 (const :tag "" :format "" "")
463 ,org-agenda-custom-commands-local-options)
464 (list :tag "TODO list (all keywords)"
465 (const :format "" alltodo)
466 (const :tag "" :format "" "")
467 ,org-agenda-custom-commands-local-options)
468 (list :tag "Search words"
469 (const :format "" search)
470 (string :tag "Match")
471 ,org-agenda-custom-commands-local-options)
472 (list :tag "Stuck projects"
473 (const :format "" stuck)
474 (const :tag "" :format "" "")
475 ,org-agenda-custom-commands-local-options)
476 (list :tag "Tags search"
477 (const :format "" tags)
478 (string :tag "Match")
479 ,org-agenda-custom-commands-local-options)
480 (list :tag "Tags search, TODO entries only"
481 (const :format "" tags-todo)
482 (string :tag "Match")
483 ,org-agenda-custom-commands-local-options)
484 (list :tag "TODO keyword search"
485 (const :format "" todo)
486 (string :tag "Match")
487 ,org-agenda-custom-commands-local-options)
488 (list :tag "Other, user-defined function"
489 (symbol :tag "function")
490 (string :tag "Match")
491 ,org-agenda-custom-commands-local-options)))
493 (repeat :tag "Settings for entire command set"
494 (list (variable :tag "Any variable")
495 (sexp :tag "Value")))
496 (option (repeat :tag "Export" (file :tag "Export to"))))
497 (cons :tag "Prefix key documentation"
498 (string :tag "Access Key(s)")
499 (string :tag "Description ")))))
501 (defcustom org-agenda-query-register ?o
502 "The register holding the current query string.
503 The purpose of this is that if you construct a query string interactively,
504 you can then use it to define a custom command."
505 :group 'org-agenda-custom-commands
506 :type 'character)
508 (defcustom org-stuck-projects
509 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
510 "How to identify stuck projects.
511 This is a list of four items:
512 1. A tags/todo/property matcher string that is used to identify a project.
513 See the manual for a description of tag and property searches.
514 The entire tree below a headline matched by this is considered one project.
515 2. A list of TODO keywords identifying non-stuck projects.
516 If the project subtree contains any headline with one of these todo
517 keywords, the project is considered to be not stuck. If you specify
518 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
519 3. A list of tags identifying non-stuck projects.
520 If the project subtree contains any headline with one of these tags,
521 the project is considered to be not stuck. If you specify \"*\" as
522 a tag, any tag will mark the project unstuck. Note that this is about
523 the explicit presence of a tag somewhere in the subtree, inherited
524 tags to not count here. If inherited tags make a project not stuck,
525 use \"-TAG\" in the tags part of the matcher under (1.) above.
526 4. An arbitrary regular expression matching non-stuck projects.
528 If the project turns out to be not stuck, search continues also in the
529 subtree to see if any of the subtasks have project status.
531 See also the variable `org-tags-match-list-sublevels' which applies
532 to projects matched by this search as well.
534 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
535 or `C-c a #' to produce the list."
536 :group 'org-agenda-custom-commands
537 :type '(list
538 (string :tag "Tags/TODO match to identify a project")
539 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
540 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
541 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
543 (defcustom org-agenda-filter-effort-default-operator "<"
544 "The default operator for effort estimate filtering.
545 If you select an effort estimate limit without first pressing an operator,
546 this one will be used."
547 :group 'org-agenda-custom-commands
548 :type '(choice (const :tag "less or equal" "<")
549 (const :tag "greater or equal"">")
550 (const :tag "equal" "=")))
552 (defgroup org-agenda-skip nil
553 "Options concerning skipping parts of agenda files."
554 :tag "Org Agenda Skip"
555 :group 'org-agenda)
557 (defcustom org-agenda-skip-function-global nil
558 "Function to be called at each match during agenda construction.
559 If this function returns nil, the current match should not be skipped.
560 If the function decided to skip an agenda match, is must return the
561 buffer position from which the search should be continued.
562 This may also be a Lisp form, which will be evaluated.
564 This variable will be applied to every agenda match, including
565 tags/property searches and TODO lists. So try to make the test function
566 do its checking as efficiently as possible. To implement a skipping
567 condition just for specific agenda commands, use the variable
568 `org-agenda-skip-function' which can be set in the options section
569 of custom agenda commands."
570 :group 'org-agenda-skip
571 :type 'sexp)
573 (defgroup org-agenda-daily/weekly nil
574 "Options concerning the daily/weekly agenda."
575 :tag "Org Agenda Daily/Weekly"
576 :group 'org-agenda)
577 (defgroup org-agenda-todo-list nil
578 "Options concerning the global todo list agenda view."
579 :tag "Org Agenda Todo List"
580 :group 'org-agenda)
581 (defgroup org-agenda-match-view nil
582 "Options concerning the general tags/property/todo match agenda view."
583 :tag "Org Agenda Match View"
584 :group 'org-agenda)
585 (defgroup org-agenda-search-view nil
586 "Options concerning the general tags/property/todo match agenda view."
587 :tag "Org Agenda Match View"
588 :group 'org-agenda)
590 (defvar org-agenda-archives-mode nil
591 "Non-nil means the agenda will include archived items.
592 If this is the symbol `trees', trees in the selected agenda scope
593 that are marked with the ARCHIVE tag will be included anyway. When this is
594 t, also all archive files associated with the current selection of agenda
595 files will be included.")
597 (defcustom org-agenda-skip-comment-trees t
598 "Non-nil means skip trees that start with the COMMENT keyword.
599 When nil, these trees are also scanned by agenda commands."
600 :group 'org-agenda-skip
601 :type 'boolean)
603 (defcustom org-agenda-todo-list-sublevels t
604 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
605 When nil, the sublevels of a TODO entry are not checked, resulting in
606 potentially much shorter TODO lists."
607 :group 'org-agenda-skip
608 :group 'org-agenda-todo-list
609 :type 'boolean)
611 (defcustom org-agenda-todo-ignore-with-date nil
612 "Non-nil means don't show entries with a date in the global todo list.
613 You can use this if you prefer to mark mere appointments with a TODO keyword,
614 but don't want them to show up in the TODO list.
615 When this is set, it also covers deadlines and scheduled items, the settings
616 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
617 will be ignored.
618 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
619 :group 'org-agenda-skip
620 :group 'org-agenda-todo-list
621 :type 'boolean)
623 (defcustom org-agenda-todo-ignore-timestamp nil
624 "Non-nil means don't show entries with a timestamp.
625 This applies when creating the global todo list.
626 Valid values are:
628 past Don't show entries for today or in the past.
630 future Don't show entries with a timestamp in the future.
631 The idea behind this is that if it has a future
632 timestamp, you don't want to think about it until the
633 date.
635 all Don't show any entries with a timestamp in the global todo list.
636 The idea behind this is that by setting a timestamp, you
637 have already \"taken care\" of this item.
639 This variable can also have an integer as a value. If positive (N),
640 todos with a timestamp N or more days in the future will be ignored. If
641 negative (-N), todos with a timestamp N or more days in the past will be
642 ignored. If 0, todos with a timestamp either today or in the future will
643 be ignored. For example, a value of -1 will exclude todos with a
644 timestamp in the past (yesterday or earlier), while a value of 7 will
645 exclude todos with a timestamp a week or more in the future.
647 See also `org-agenda-todo-ignore-with-date'.
648 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
649 to make his option also apply to the tags-todo list."
650 :group 'org-agenda-skip
651 :group 'org-agenda-todo-list
652 :version "24.1"
653 :type '(choice
654 (const :tag "Ignore future timestamp todos" future)
655 (const :tag "Ignore past or present timestamp todos" past)
656 (const :tag "Ignore all timestamp todos" all)
657 (const :tag "Show timestamp todos" nil)
658 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
660 (defcustom org-agenda-todo-ignore-scheduled nil
661 "Non-nil means, ignore some scheduled TODO items when making TODO list.
662 This applies when creating the global todo list.
663 Valid values are:
665 past Don't show entries scheduled today or in the past.
667 future Don't show entries scheduled in the future.
668 The idea behind this is that by scheduling it, you don't want to
669 think about it until the scheduled date.
671 all Don't show any scheduled entries in the global todo list.
672 The idea behind this is that by scheduling it, you have already
673 \"taken care\" of this item.
675 t Same as `all', for backward compatibility.
677 This variable can also have an integer as a value. See
678 `org-agenda-todo-ignore-timestamp' for more details.
680 See also `org-agenda-todo-ignore-with-date'.
681 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
682 to make his option also apply to the tags-todo list."
683 :group 'org-agenda-skip
684 :group 'org-agenda-todo-list
685 :type '(choice
686 (const :tag "Ignore future-scheduled todos" future)
687 (const :tag "Ignore past- or present-scheduled todos" past)
688 (const :tag "Ignore all scheduled todos" all)
689 (const :tag "Ignore all scheduled todos (compatibility)" t)
690 (const :tag "Show scheduled todos" nil)
691 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
693 (defcustom org-agenda-todo-ignore-deadlines nil
694 "Non-nil means ignore some deadlined TODO items when making TODO list.
695 There are different motivations for using different values, please think
696 carefully when configuring this variable.
698 This applies when creating the global todo list.
699 Valid values are:
701 near Don't show near deadline entries. A deadline is near when it is
702 closer than `org-deadline-warning-days' days. The idea behind this
703 is that such items will appear in the agenda anyway.
705 far Don't show TODO entries where a deadline has been defined, but
706 the deadline is not near. This is useful if you don't want to
707 use the todo list to figure out what to do now.
709 past Don't show entries with a deadline timestamp for today or in the past.
711 future Don't show entries with a deadline timestamp in the future, not even
712 when they become `near' ones. Use it with caution.
714 all Ignore all TODO entries that do have a deadline.
716 t Same as `near', for backward compatibility.
718 This variable can also have an integer as a value. See
719 `org-agenda-todo-ignore-timestamp' for more details.
721 See also `org-agenda-todo-ignore-with-date'.
722 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
723 to make his option also apply to the tags-todo list."
724 :group 'org-agenda-skip
725 :group 'org-agenda-todo-list
726 :type '(choice
727 (const :tag "Ignore near deadlines" near)
728 (const :tag "Ignore near deadlines (compatibility)" t)
729 (const :tag "Ignore far deadlines" far)
730 (const :tag "Ignore all TODOs with a deadlines" all)
731 (const :tag "Show all TODOs, even if they have a deadline" nil)
732 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
734 (defcustom org-agenda-tags-todo-honor-ignore-options nil
735 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
736 The variables
737 `org-agenda-todo-ignore-with-date',
738 `org-agenda-todo-ignore-timestamp',
739 `org-agenda-todo-ignore-scheduled',
740 `org-agenda-todo-ignore-deadlines'
741 make the global TODO list skip entries that have time stamps of certain
742 kinds. If this option is set, the same options will also apply for the
743 tags-todo search, which is the general tags/property matcher
744 restricted to unfinished TODO entries only."
745 :group 'org-agenda-skip
746 :group 'org-agenda-todo-list
747 :group 'org-agenda-match-view
748 :type 'boolean)
750 (defcustom org-agenda-skip-scheduled-if-done nil
751 "Non-nil means don't show scheduled items in agenda when they are done.
752 This is relevant for the daily/weekly agenda, not for the TODO list. And
753 it applies only to the actual date of the scheduling. Warnings about
754 an item with a past scheduling dates are always turned off when the item
755 is DONE."
756 :group 'org-agenda-skip
757 :group 'org-agenda-daily/weekly
758 :type 'boolean)
760 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
761 "Non-nil means skip scheduling line if same entry shows because of deadline.
762 In the agenda of today, an entry can show up multiple times because
763 it is both scheduled and has a nearby deadline, and maybe a plain time
764 stamp as well.
765 When this variable is t, then only the deadline is shown and the fact that
766 the entry is scheduled today or was scheduled previously is not shown.
767 When this variable is nil, the entry will be shown several times. When
768 the variable is the symbol `not-today', then skip scheduled previously,
769 but not scheduled today."
770 :group 'org-agenda-skip
771 :group 'org-agenda-daily/weekly
772 :type '(choice
773 (const :tag "Never" nil)
774 (const :tag "Always" t)
775 (const :tag "Not when scheduled today" not-today)))
777 (defcustom org-agenda-skip-deadline-if-done nil
778 "Non-nil means don't show deadlines when the corresponding item is done.
779 When nil, the deadline is still shown and should give you a happy feeling.
780 This is relevant for the daily/weekly agenda. And it applied only to the
781 actually date of the deadline. Warnings about approaching and past-due
782 deadlines are always turned off when the item is DONE."
783 :group 'org-agenda-skip
784 :group 'org-agenda-daily/weekly
785 :type 'boolean)
787 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
788 "Non-nil means skip deadline prewarning when entry is also scheduled.
789 This will apply on all days where a prewarning for the deadline would
790 be shown, but not at the day when the entry is actually due. On that day,
791 the deadline will be shown anyway.
792 This variable may be set to nil, t, or a number which will then give
793 the number of days before the actual deadline when the prewarnings
794 should resume.
795 This can be used in a workflow where the first showing of the deadline will
796 trigger you to schedule it, and then you don't want to be reminded of it
797 because you will take care of it on the day when scheduled."
798 :group 'org-agenda-skip
799 :group 'org-agenda-daily/weekly
800 :version "24.1"
801 :type '(choice
802 (const :tag "Alwas show prewarning" nil)
803 (const :tag "Remove prewarning if entry is scheduled" t)
804 (integer :tag "Restart prewarning N days before deadline")))
806 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
807 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
808 When non-nil, after the search for timestamps has matched once in an
809 entry, the rest of the entry will not be searched."
810 :group 'org-agenda-skip
811 :type 'boolean)
813 (defcustom org-agenda-skip-timestamp-if-done nil
814 "Non-nil means don't select item by timestamp or -range if it is DONE."
815 :group 'org-agenda-skip
816 :group 'org-agenda-daily/weekly
817 :type 'boolean)
819 (defcustom org-agenda-dim-blocked-tasks t
820 "Non-nil means dim blocked tasks in the agenda display.
821 This causes some overhead during agenda construction, but if you
822 have turned on `org-enforce-todo-dependencies',
823 `org-enforce-todo-checkbox-dependencies', or any other blocking
824 mechanism, this will create useful feedback in the agenda.
826 Instead of t, this variable can also have the value `invisible'.
827 Then blocked tasks will be invisible and only become visible when
828 they become unblocked. An exemption to this behavior is when a task is
829 blocked because of unchecked checkboxes below it. Since checkboxes do
830 not show up in the agenda views, making this task invisible you remove any
831 trace from agenda views that there is something to do. Therefore, a task
832 that is blocked because of checkboxes will never be made invisible, it
833 will only be dimmed."
834 :group 'org-agenda-daily/weekly
835 :group 'org-agenda-todo-list
836 :type '(choice
837 (const :tag "Do not dim" nil)
838 (const :tag "Dim to a gray face" t)
839 (const :tag "Make invisible" invisible)))
841 (defcustom org-timeline-show-empty-dates 3
842 "Non-nil means `org-timeline' also shows dates without an entry.
843 When nil, only the days which actually have entries are shown.
844 When t, all days between the first and the last date are shown.
845 When an integer, show also empty dates, but if there is a gap of more than
846 N days, just insert a special line indicating the size of the gap."
847 :group 'org-agenda-skip
848 :type '(choice
849 (const :tag "None" nil)
850 (const :tag "All" t)
851 (integer :tag "at most")))
853 (defgroup org-agenda-startup nil
854 "Options concerning initial settings in the Agenda in Org Mode."
855 :tag "Org Agenda Startup"
856 :group 'org-agenda)
858 (defcustom org-agenda-menu-show-matcher t
859 "Non-nil means show the match string in the agenda dispatcher menu.
860 When nil, the matcher string is not shown, but is put into the help-echo
861 property so than moving the mouse over the command shows it.
862 Setting it to nil is good if matcher strings are very long and/or if
863 you want to use two-column display (see `org-agenda-menu-two-column')."
864 :group 'org-agenda
865 :version "24.1"
866 :type 'boolean)
868 (defcustom org-agenda-menu-two-column nil
869 "Non-nil means, use two columns to show custom commands in the dispatcher.
870 If you use this, you probably want to set `org-agenda-menu-show-matcher'
871 to nil."
872 :group 'org-agenda
873 :version "24.1"
874 :type 'boolean)
876 (defcustom org-finalize-agenda-hook nil
877 "Hook run just before displaying an agenda buffer."
878 :group 'org-agenda-startup
879 :type 'hook)
881 (defcustom org-agenda-mouse-1-follows-link nil
882 "Non-nil means mouse-1 on a link will follow the link in the agenda.
883 A longer mouse click will still set point. Does not work on XEmacs.
884 Needs to be set before org.el is loaded."
885 :group 'org-agenda-startup
886 :type 'boolean)
888 (defcustom org-agenda-start-with-follow-mode nil
889 "The initial value of follow mode in a newly created agenda window."
890 :group 'org-agenda-startup
891 :type 'boolean)
893 (defcustom org-agenda-follow-indirect nil
894 "Non-nil means `org-agenda-follow-mode' displays only the
895 current item's tree, in an indirect buffer."
896 :group 'org-agenda
897 :version "24.1"
898 :type 'boolean)
900 (defcustom org-agenda-show-outline-path t
901 "Non-nil means show outline path in echo area after line motion."
902 :group 'org-agenda-startup
903 :type 'boolean)
905 (defcustom org-agenda-start-with-entry-text-mode nil
906 "The initial value of entry-text-mode in a newly created agenda window."
907 :group 'org-agenda-startup
908 :type 'boolean)
910 (defcustom org-agenda-entry-text-maxlines 5
911 "Number of text lines to be added when `E' is pressed in the agenda.
913 Note that this variable only used during agenda display. Add add entry text
914 when exporting the agenda, configure the variable
915 `org-agenda-add-entry-ext-maxlines'."
916 :group 'org-agenda
917 :type 'integer)
919 (defcustom org-agenda-entry-text-exclude-regexps nil
920 "List of regular expressions to clean up entry text.
921 The complete matches of all regular expressions in this list will be
922 removed from entry text before it is shown in the agenda."
923 :group 'org-agenda
924 :type '(repeat (regexp)))
926 (defvar org-agenda-entry-text-cleanup-hook nil
927 "Hook that is run after basic cleanup of entry text to be shown in agenda.
928 This cleanup is done in a temporary buffer, so the function may inspect and
929 change the entire buffer.
930 Some default stuff like drawers and scheduling/deadline dates will already
931 have been removed when this is called, as will any matches for regular
932 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
934 (defvar org-agenda-include-inactive-timestamps nil
935 "Non-nil means include inactive time stamps in agenda and timeline.")
937 (defgroup org-agenda-windows nil
938 "Options concerning the windows used by the Agenda in Org Mode."
939 :tag "Org Agenda Windows"
940 :group 'org-agenda)
942 (defcustom org-agenda-window-setup 'reorganize-frame
943 "How the agenda buffer should be displayed.
944 Possible values for this option are:
946 current-window Show agenda in the current window, keeping all other windows.
947 other-window Use `switch-to-buffer-other-window' to display agenda.
948 reorganize-frame Show only two windows on the current frame, the current
949 window and the agenda.
950 other-frame Use `switch-to-buffer-other-frame' to display agenda.
951 Also, when exiting the agenda, kill that frame.
952 See also the variable `org-agenda-restore-windows-after-quit'."
953 :group 'org-agenda-windows
954 :type '(choice
955 (const current-window)
956 (const other-frame)
957 (const other-window)
958 (const reorganize-frame)))
960 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
961 "The min and max height of the agenda window as a fraction of frame height.
962 The value of the variable is a cons cell with two numbers between 0 and 1.
963 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
964 :group 'org-agenda-windows
965 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
967 (defcustom org-agenda-restore-windows-after-quit nil
968 "Non-nil means restore window configuration upon exiting agenda.
969 Before the window configuration is changed for displaying the agenda,
970 the current status is recorded. When the agenda is exited with
971 `q' or `x' and this option is set, the old state is restored. If
972 `org-agenda-window-setup' is `other-frame', the value of this
973 option will be ignored."
974 :group 'org-agenda-windows
975 :type 'boolean)
977 (defcustom org-agenda-ndays nil
978 "Number of days to include in overview display.
979 Should be 1 or 7.
980 Obsolete, see `org-agenda-span'."
981 :group 'org-agenda-daily/weekly
982 :type 'integer)
984 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
986 (defcustom org-agenda-span 'week
987 "Number of days to include in overview display.
988 Can be day, week, month, year, or any number of days.
989 Custom commands can set this variable in the options section."
990 :group 'org-agenda-daily/weekly
991 :type '(choice (const :tag "Day" day)
992 (const :tag "Week" week)
993 (const :tag "Month" month)
994 (const :tag "Year" year)
995 (integer :tag "Custom")))
997 (defcustom org-agenda-start-on-weekday 1
998 "Non-nil means start the overview always on the specified weekday.
999 0 denotes Sunday, 1 denotes Monday etc.
1000 When nil, always start on the current day.
1001 Custom commands can set this variable in the options section."
1002 :group 'org-agenda-daily/weekly
1003 :type '(choice (const :tag "Today" nil)
1004 (integer :tag "Weekday No.")))
1006 (defcustom org-agenda-show-all-dates t
1007 "Non-nil means `org-agenda' shows every day in the selected range.
1008 When nil, only the days which actually have entries are shown."
1009 :group 'org-agenda-daily/weekly
1010 :type 'boolean)
1012 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1013 "Format string for displaying dates in the agenda.
1014 Used by the daily/weekly agenda and by the timeline. This should be
1015 a format string understood by `format-time-string', or a function returning
1016 the formatted date as a string. The function must take a single argument,
1017 a calendar-style date list like (month day year)."
1018 :group 'org-agenda-daily/weekly
1019 :type '(choice
1020 (string :tag "Format string")
1021 (function :tag "Function")))
1023 (defun org-agenda-format-date-aligned (date)
1024 "Format a date string for display in the daily/weekly agenda, or timeline.
1025 This function makes sure that dates are aligned for easy reading."
1026 (require 'cal-iso)
1027 (let* ((dayname (calendar-day-name date))
1028 (day (cadr date))
1029 (day-of-week (calendar-day-of-week date))
1030 (month (car date))
1031 (monthname (calendar-month-name month))
1032 (year (nth 2 date))
1033 (iso-week (org-days-to-iso-week
1034 (calendar-absolute-from-gregorian date)))
1035 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1036 (1- year))
1037 ((and (= month 12) (<= iso-week 1))
1038 (1+ year))
1039 (t year)))
1040 (weekstring (if (= day-of-week 1)
1041 (format " W%02d" iso-week)
1042 "")))
1043 (format "%-10s %2d %s %4d%s"
1044 dayname day monthname year weekstring)))
1046 (defcustom org-agenda-time-leading-zero nil
1047 "Non-nil means use leading zero for military times in agenda.
1048 For example, 9:30am would become 09:30 rather than 9:30."
1049 :group 'org-agenda-daily/weekly
1050 :version "24.1"
1051 :type 'boolean)
1053 (defcustom org-agenda-timegrid-use-ampm nil
1054 "When set, show AM/PM style timestamps on the timegrid."
1055 :group 'org-agenda
1056 :version "24.1"
1057 :type 'boolean)
1059 (defun org-agenda-time-of-day-to-ampm (time)
1060 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1061 (let* ((hour-number (string-to-number (substring time 0 -3)))
1062 (minute (substring time -2))
1063 (ampm "am"))
1064 (cond
1065 ((equal hour-number 12)
1066 (setq ampm "pm"))
1067 ((> hour-number 12)
1068 (setq ampm "pm")
1069 (setq hour-number (- hour-number 12))))
1070 (concat
1071 (if org-agenda-time-leading-zero
1072 (format "%02d" hour-number)
1073 (format "%02s" (number-to-string hour-number)))
1074 ":" minute ampm)))
1076 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1077 "Conditionally convert TIME to AM/PM format
1078 based on `org-agenda-timegrid-use-ampm'"
1079 (if org-agenda-timegrid-use-ampm
1080 (org-agenda-time-of-day-to-ampm time)
1081 time))
1083 (defcustom org-agenda-weekend-days '(6 0)
1084 "Which days are weekend?
1085 These days get the special face `org-agenda-date-weekend' in the agenda
1086 and timeline buffers."
1087 :group 'org-agenda-daily/weekly
1088 :type '(set :greedy t
1089 (const :tag "Monday" 1)
1090 (const :tag "Tuesday" 2)
1091 (const :tag "Wednesday" 3)
1092 (const :tag "Thursday" 4)
1093 (const :tag "Friday" 5)
1094 (const :tag "Saturday" 6)
1095 (const :tag "Sunday" 0)))
1097 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1098 "Non-nil means jump to today when moving a past date forward in time.
1099 When using S-right in the agenda to move a a date forward, and the date
1100 stamp currently points to the past, the first key press will move it
1101 to today. WHen nil, just move one day forward even if the date stays
1102 in the past."
1103 :group 'org-agenda-daily/weekly
1104 :version "24.1"
1105 :type 'boolean)
1107 (defcustom org-agenda-include-diary nil
1108 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1109 Custom commands can set this variable in the options section."
1110 :group 'org-agenda-daily/weekly
1111 :type 'boolean)
1113 (defcustom org-agenda-include-deadlines t
1114 "If non-nil, include entries within their deadline warning period.
1115 Custom commands can set this variable in the options section."
1116 :group 'org-agenda-daily/weekly
1117 :version "24.1"
1118 :type 'boolean)
1120 (defcustom org-agenda-repeating-timestamp-show-all t
1121 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1122 When set to a list of strings, only show occurrences of repeating
1123 stamps for these TODO keywords. When nil, only one occurrence is
1124 shown, either today or the nearest into the future."
1125 :group 'org-agenda-daily/weekly
1126 :type '(choice
1127 (const :tag "Show repeating stamps" t)
1128 (repeat :tag "Show repeating stamps for these TODO keywords"
1129 (string :tag "TODO Keyword"))
1130 (const :tag "Don't show repeating stamps" nil)))
1132 (defcustom org-scheduled-past-days 10000
1133 "No. of days to continue listing scheduled items that are not marked DONE.
1134 When an item is scheduled on a date, it shows up in the agenda on this
1135 day and will be listed until it is marked done for the number of days
1136 given here."
1137 :group 'org-agenda-daily/weekly
1138 :type 'integer)
1140 (defcustom org-agenda-log-mode-items '(closed clock)
1141 "List of items that should be shown in agenda log mode.
1142 This list may contain the following symbols:
1144 closed Show entries that have been closed on that day.
1145 clock Show entries that have received clocked time on that day.
1146 state Show all logged state changes.
1147 Note that instead of changing this variable, you can also press `C-u l' in
1148 the agenda to display all available LOG items temporarily."
1149 :group 'org-agenda-daily/weekly
1150 :type '(set :greedy t (const closed) (const clock) (const state)))
1152 (defcustom org-agenda-clock-consistency-checks
1153 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1154 :gap-ok-around ("4:00")
1155 :default-face ((:background "DarkRed") (:foreground "white"))
1156 :overlap-face nil :gap-face nil :no-end-time-face nil
1157 :long-face nil :short-face nil)
1158 "This is a property list, with the following keys:
1160 :max-duration Mark clocking chunks that are longer than this time.
1161 This is a time string like \"HH:MM\", or the number
1162 of minutes as an integer.
1164 :min-duration Mark clocking chunks that are shorter that this.
1165 This is a time string like \"HH:MM\", or the number
1166 of minutes as an integer.
1168 :max-gap Mark gaps between clocking chunks that are longer than
1169 this duration. A number of minutes, or a string
1170 like \"HH:MM\".
1172 :gap-ok-around List of times during the day which are usually not working
1173 times. When a gap is detected, but the gap contains any
1174 of these times, the gap is *not* reported. For example,
1175 if this is (\"4:00\" \"13:00\") then gaps that contain
1176 4:00 in the morning (i.e. the night) and 13:00
1177 (i.e. a typical lunch time) do not cause a warning.
1178 You should have at least one time during the night in this
1179 list, or otherwise the first task each morning will trigger
1180 a warning because it follows a long gap.
1182 Furthermore, the following properties can be used to define faces for
1183 issue display.
1185 :default-face the default face, if the specific face is undefined
1186 :overlap-face face for overlapping clocks
1187 :gap-face face for gaps between clocks
1188 :no-end-time-face face for incomplete clocks
1189 :long-face face for clock intervals that are too long
1190 :short-face face for clock intervals that are too short"
1191 :group 'org-agenda-daily/weekly
1192 :group 'org-clock
1193 :version "24.1"
1194 :type 'plist)
1196 (defcustom org-agenda-log-mode-add-notes t
1197 "Non-nil means add first line of notes to log entries in agenda views.
1198 If a log item like a state change or a clock entry is associated with
1199 notes, the first line of these notes will be added to the entry in the
1200 agenda display."
1201 :group 'org-agenda-daily/weekly
1202 :type 'boolean)
1204 (defcustom org-agenda-start-with-log-mode nil
1205 "The initial value of log-mode in a newly created agenda window."
1206 :group 'org-agenda-startup
1207 :group 'org-agenda-daily/weekly
1208 :type 'boolean)
1210 (defcustom org-agenda-start-with-clockreport-mode nil
1211 "The initial value of clockreport-mode in a newly created agenda window."
1212 :group 'org-agenda-startup
1213 :group 'org-agenda-daily/weekly
1214 :type 'boolean)
1216 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1217 "Property list with parameters for the clocktable in clockreport mode.
1218 This is the display mode that shows a clock table in the daily/weekly
1219 agenda, the properties for this dynamic block can be set here.
1220 The usual clocktable parameters are allowed here, but you cannot set
1221 the properties :name, :tstart, :tend, :block, and :scope - these will
1222 be overwritten to make sure the content accurately reflects the
1223 current display in the agenda."
1224 :group 'org-agenda-daily/weekly
1225 :type 'plist)
1227 (defcustom org-agenda-search-view-always-boolean nil
1228 "Non-nil means the search string is interpreted as individual parts.
1230 The search string for search view can either be interpreted as a phrase,
1231 or as a list of snippets that define a boolean search for a number of
1232 strings.
1234 When this is non-nil, the string will be split on whitespace, and each
1235 snippet will be searched individually, and all must match in order to
1236 select an entry. A snippet is then a single string of non-white
1237 characters, or a string in double quotes, or a regexp in {} braces.
1238 If a snippet is preceded by \"-\", the snippet must *not* match.
1239 \"+\" is syntactic sugar for positive selection. Each snippet may
1240 be found as a full word or a partial word, but see the variable
1241 `org-agenda-search-view-force-full-words'.
1243 When this is nil, search will look for the entire search phrase as one,
1244 with each space character matching any amount of whitespace, including
1245 line breaks.
1247 Even when this is nil, you can still switch to Boolean search dynamically
1248 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1249 is a regexp marked with braces like \"{abc}\", this will also switch to
1250 boolean search."
1251 :group 'org-agenda-search-view
1252 :version "24.1"
1253 :type 'boolean)
1255 (if (fboundp 'defvaralias)
1256 (defvaralias 'org-agenda-search-view-search-words-only
1257 'org-agenda-search-view-always-boolean))
1259 (defcustom org-agenda-search-view-force-full-words nil
1260 "Non-nil means, search words must be matches as complete words.
1261 When nil, they may also match part of a word."
1262 :group 'org-agenda-search-view
1263 :version "24.1"
1264 :type 'boolean)
1266 (defgroup org-agenda-time-grid nil
1267 "Options concerning the time grid in the Org-mode Agenda."
1268 :tag "Org Agenda Time Grid"
1269 :group 'org-agenda)
1271 (defcustom org-agenda-search-headline-for-time t
1272 "Non-nil means search headline for a time-of-day.
1273 If the headline contains a time-of-day in one format or another, it will
1274 be used to sort the entry into the time sequence of items for a day.
1275 Some people have time stamps in the headline that refer to the creation
1276 time or so, and then this produces an unwanted side effect. If this is
1277 the case for your, use this variable to turn off searching the headline
1278 for a time."
1279 :group 'org-agenda-time-grid
1280 :type 'boolean)
1282 (defcustom org-agenda-use-time-grid t
1283 "Non-nil means show a time grid in the agenda schedule.
1284 A time grid is a set of lines for specific times (like every two hours between
1285 8:00 and 20:00). The items scheduled for a day at specific times are
1286 sorted in between these lines.
1287 For details about when the grid will be shown, and what it will look like, see
1288 the variable `org-agenda-time-grid'."
1289 :group 'org-agenda-time-grid
1290 :type 'boolean)
1292 (defcustom org-agenda-time-grid
1293 '((daily today require-timed)
1294 "----------------"
1295 (800 1000 1200 1400 1600 1800 2000))
1297 "The settings for time grid for agenda display.
1298 This is a list of three items. The first item is again a list. It contains
1299 symbols specifying conditions when the grid should be displayed:
1301 daily if the agenda shows a single day
1302 weekly if the agenda shows an entire week
1303 today show grid on current date, independent of daily/weekly display
1304 require-timed show grid only if at least one item has a time specification
1306 The second item is a string which will be placed behind the grid time.
1308 The third item is a list of integers, indicating the times that should have
1309 a grid line."
1310 :group 'org-agenda-time-grid
1311 :type
1312 '(list
1313 (set :greedy t :tag "Grid Display Options"
1314 (const :tag "Show grid in single day agenda display" daily)
1315 (const :tag "Show grid in weekly agenda display" weekly)
1316 (const :tag "Always show grid for today" today)
1317 (const :tag "Show grid only if any timed entries are present"
1318 require-timed)
1319 (const :tag "Skip grid times already present in an entry"
1320 remove-match))
1321 (string :tag "Grid String")
1322 (repeat :tag "Grid Times" (integer :tag "Time"))))
1324 (defcustom org-agenda-show-current-time-in-grid t
1325 "Non-nil means show the current time in the time grid."
1326 :group 'org-agenda-time-grid
1327 :version "24.1"
1328 :type 'boolean)
1330 (defcustom org-agenda-current-time-string
1331 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1332 "The string for the current time marker in the agenda."
1333 :group 'org-agenda-time-grid
1334 :version "24.1"
1335 :type 'string)
1337 (defgroup org-agenda-sorting nil
1338 "Options concerning sorting in the Org-mode Agenda."
1339 :tag "Org Agenda Sorting"
1340 :group 'org-agenda)
1342 (defcustom org-agenda-sorting-strategy
1343 '((agenda habit-down time-up priority-down category-keep)
1344 (todo priority-down category-keep)
1345 (tags priority-down category-keep)
1346 (search category-keep))
1347 "Sorting structure for the agenda items of a single day.
1348 This is a list of symbols which will be used in sequence to determine
1349 if an entry should be listed before another entry. The following
1350 symbols are recognized:
1352 time-up Put entries with time-of-day indications first, early first
1353 time-down Put entries with time-of-day indications first, late first
1354 category-keep Keep the default order of categories, corresponding to the
1355 sequence in `org-agenda-files'.
1356 category-up Sort alphabetically by category, A-Z.
1357 category-down Sort alphabetically by category, Z-A.
1358 tag-up Sort alphabetically by last tag, A-Z.
1359 tag-down Sort alphabetically by last tag, Z-A.
1360 priority-up Sort numerically by priority, high priority last.
1361 priority-down Sort numerically by priority, high priority first.
1362 todo-state-up Sort by todo state, tasks that are done last.
1363 todo-state-down Sort by todo state, tasks that are done first.
1364 effort-up Sort numerically by estimated effort, high effort last.
1365 effort-down Sort numerically by estimated effort, high effort first.
1366 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1367 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1368 habit-up Put entries that are habits first
1369 habit-down Put entries that are habits last
1370 alpha-up Sort headlines alphabetically
1371 alpha-down Sort headlines alphabetically, reversed
1373 The different possibilities will be tried in sequence, and testing stops
1374 if one comparison returns a \"not-equal\". For example, the default
1375 '(time-up category-keep priority-down)
1376 means: Pull out all entries having a specified time of day and sort them,
1377 in order to make a time schedule for the current day the first thing in the
1378 agenda listing for the day. Of the entries without a time indication, keep
1379 the grouped in categories, don't sort the categories, but keep them in
1380 the sequence given in `org-agenda-files'. Within each category sort by
1381 priority.
1383 Leaving out `category-keep' would mean that items will be sorted across
1384 categories by priority.
1386 Instead of a single list, this can also be a set of list for specific
1387 contents, with a context symbol in the car of the list, any of
1388 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1390 Custom commands can bind this variable in the options section."
1391 :group 'org-agenda-sorting
1392 :type `(choice
1393 (repeat :tag "General" ,org-sorting-choice)
1394 (list :tag "Individually"
1395 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1396 (repeat ,org-sorting-choice))
1397 (cons (const :tag "Strategy for TODO lists" todo)
1398 (repeat ,org-sorting-choice))
1399 (cons (const :tag "Strategy for Tags matches" tags)
1400 (repeat ,org-sorting-choice))
1401 (cons (const :tag "Strategy for search matches" search)
1402 (repeat ,org-sorting-choice)))))
1404 (defcustom org-agenda-cmp-user-defined nil
1405 "A function to define the comparison `user-defined'.
1406 This function must receive two arguments, agenda entry a and b.
1407 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1408 the user comparison, return nil.
1409 When this is defined, you can make `user-defined-up' and `user-defined-down'
1410 part of an agenda sorting strategy."
1411 :group 'org-agenda-sorting
1412 :type 'symbol)
1414 (defcustom org-sort-agenda-notime-is-late t
1415 "Non-nil means items without time are considered late.
1416 This is only relevant for sorting. When t, items which have no explicit
1417 time like 15:30 will be considered as 99:01, i.e. later than any items which
1418 do have a time. When nil, the default time is before 0:00. You can use this
1419 option to decide if the schedule for today should come before or after timeless
1420 agenda entries."
1421 :group 'org-agenda-sorting
1422 :type 'boolean)
1424 (defcustom org-sort-agenda-noeffort-is-high t
1425 "Non-nil means items without effort estimate are sorted as high effort.
1426 This also applies when filtering an agenda view with respect to the
1427 < or > effort operator. Then, tasks with no effort defined will be treated
1428 as tasks with high effort.
1429 When nil, such items are sorted as 0 minutes effort."
1430 :group 'org-agenda-sorting
1431 :type 'boolean)
1433 (defgroup org-agenda-line-format nil
1434 "Options concerning the entry prefix in the Org-mode agenda display."
1435 :tag "Org Agenda Line Format"
1436 :group 'org-agenda)
1438 (defcustom org-agenda-prefix-format
1439 '((agenda . " %i %-12:c%?-12t% s")
1440 (timeline . " % s")
1441 (todo . " %i %-12:c")
1442 (tags . " %i %-12:c")
1443 (search . " %i %-12:c"))
1444 "Format specifications for the prefix of items in the agenda views.
1445 An alist with five entries, each for the different agenda types. The
1446 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1447 The values are format strings.
1449 This format works similar to a printf format, with the following meaning:
1451 %c the category of the item, \"Diary\" for entries from the diary,
1452 or as given by the CATEGORY keyword or derived from the file name
1453 %e the effort required by the item
1454 %i the icon category of the item, see `org-agenda-category-icon-alist'
1455 %T the last tag of the item (ignore inherited tags, which come first)
1456 %t the HH:MM time-of-day specification if one applies to the entry
1457 %s Scheduling/Deadline information, a short string
1458 %(expression) Eval EXPRESSION and replace the control string
1459 by the result
1461 All specifiers work basically like the standard `%s' of printf, but may
1462 contain two additional characters: a question mark just after the `%'
1463 and a whitespace/punctuation character just before the final letter.
1465 If the first character after `%' is a question mark, the entire field
1466 will only be included if the corresponding value applies to the current
1467 entry. This is useful for fields which should have fixed width when
1468 present, but zero width when absent. For example, \"%?-12t\" will
1469 result in a 12 character time field if a time of the day is specified,
1470 but will completely disappear in entries which do not contain a time.
1472 If there is punctuation or whitespace character just before the final
1473 format letter, this character will be appended to the field value if
1474 the value is not empty. For example, the format \"%-12:c\" leads to
1475 \"Diary: \" if the category is \"Diary\". If the category were be
1476 empty, no additional colon would be inserted.
1478 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1479 which means:
1481 - Indent the line with two space characters
1482 - Give the category a 12 chars wide field, padded with whitespace on
1483 the right (because of `-'). Append a colon if there is a category
1484 (because of `:').
1485 - If there is a time-of-day, put it into a 12 chars wide field. If no
1486 time, don't put in an empty field, just skip it (because of '?').
1487 - Finally, put the scheduling information.
1489 See also the variables `org-agenda-remove-times-when-in-prefix' and
1490 `org-agenda-remove-tags'.
1492 Custom commands can set this variable in the options section."
1493 :type '(choice
1494 (string :tag "General format")
1495 (list :greedy t :tag "View dependent"
1496 (cons (const agenda) (string :tag "Format"))
1497 (cons (const timeline) (string :tag "Format"))
1498 (cons (const todo) (string :tag "Format"))
1499 (cons (const tags) (string :tag "Format"))
1500 (cons (const search) (string :tag "Format"))))
1501 :group 'org-agenda-line-format)
1503 (defvar org-prefix-format-compiled nil
1504 "The compiled version of the most recently used prefix format.
1505 See the variable `org-agenda-prefix-format'.")
1507 (defcustom org-agenda-todo-keyword-format "%-1s"
1508 "Format for the TODO keyword in agenda lines.
1509 Set this to something like \"%-12s\" if you want all TODO keywords
1510 to occupy a fixed space in the agenda display."
1511 :group 'org-agenda-line-format
1512 :type 'string)
1514 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1515 "Text preceding timerange entries in the agenda view.
1516 This is a list with two strings. The first applies when the range
1517 is entirely on one day. The second applies if the range spans several days.
1518 The strings may have two \"%d\" format specifiers which will be filled
1519 with the sequence number of the days, and the total number of days in the
1520 range, respectively."
1521 :group 'org-agenda-line-format
1522 :type '(list
1523 (string :tag "Deadline today ")
1524 (choice :tag "Deadline relative"
1525 (string :tag "Format string")
1526 (function))))
1528 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1529 "Text preceding scheduled items in the agenda view.
1530 This is a list with two strings. The first applies when the item is
1531 scheduled on the current day. The second applies when it has been scheduled
1532 previously, it may contain a %d indicating that this is the nth time that
1533 this item is scheduled, due to automatic rescheduling of unfinished items
1534 for the following day. So this number is one larger than the number of days
1535 that passed since this item was scheduled first."
1536 :group 'org-agenda-line-format
1537 :type '(list
1538 (string :tag "Scheduled today ")
1539 (string :tag "Scheduled previously")))
1541 (defcustom org-agenda-inactive-leader "["
1542 "Text preceding item pulled into the agenda by inactive time stamps.
1543 These entries are added to the agenda when pressing \"[\"."
1544 :group 'org-agenda-line-format
1545 :version "24.1"
1546 :type '(list
1547 (string :tag "Scheduled today ")
1548 (string :tag "Scheduled previously")))
1550 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
1551 "Text preceding deadline items in the agenda view.
1552 This is a list with two strings. The first applies when the item has its
1553 deadline on the current day. The second applies when it is in the past or
1554 in the future, it may contain %d to capture how many days away the deadline
1555 is (was)."
1556 :group 'org-agenda-line-format
1557 :type '(list
1558 (string :tag "Deadline today ")
1559 (choice :tag "Deadline relative"
1560 (string :tag "Format string")
1561 (function))))
1563 (defcustom org-agenda-remove-times-when-in-prefix t
1564 "Non-nil means remove duplicate time specifications in agenda items.
1565 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1566 time-of-day specification in a headline or diary entry is extracted and
1567 placed into the prefix. If this option is non-nil, the original specification
1568 \(a timestamp or -range, or just a plain time(range) specification like
1569 11:30-4pm) will be removed for agenda display. This makes the agenda less
1570 cluttered.
1571 The option can be t or nil. It may also be the symbol `beg', indicating
1572 that the time should only be removed when it is located at the beginning of
1573 the headline/diary entry."
1574 :group 'org-agenda-line-format
1575 :type '(choice
1576 (const :tag "Always" t)
1577 (const :tag "Never" nil)
1578 (const :tag "When at beginning of entry" beg)))
1580 (defcustom org-agenda-remove-timeranges-from-blocks nil
1581 "Non-nil means remove time ranges specifications in agenda
1582 items that span on several days."
1583 :group 'org-agenda-line-format
1584 :version "24.1"
1585 :type 'boolean)
1587 (defcustom org-agenda-default-appointment-duration nil
1588 "Default duration for appointments that only have a starting time.
1589 When nil, no duration is specified in such cases.
1590 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1591 :group 'org-agenda-line-format
1592 :type '(choice
1593 (integer :tag "Minutes")
1594 (const :tag "No default duration")))
1596 (defcustom org-agenda-show-inherited-tags t
1597 "Non-nil means show inherited tags in each agenda line."
1598 :group 'org-agenda-line-format
1599 :type 'boolean)
1601 (defcustom org-agenda-hide-tags-regexp nil
1602 "Regular expression used to filter away specific tags in agenda views.
1603 This means that these tags will be present, but not be shown in the agenda
1604 line. Secondary filtering will still work on the hidden tags.
1605 Nil means don't hide any tags."
1606 :group 'org-agenda-line-format
1607 :type '(choice
1608 (const :tag "Hide none" nil)
1609 (string :tag "Regexp ")))
1611 (defcustom org-agenda-remove-tags nil
1612 "Non-nil means remove the tags from the headline copy in the agenda.
1613 When this is the symbol `prefix', only remove tags when
1614 `org-agenda-prefix-format' contains a `%T' specifier."
1615 :group 'org-agenda-line-format
1616 :type '(choice
1617 (const :tag "Always" t)
1618 (const :tag "Never" nil)
1619 (const :tag "When prefix format contains %T" prefix)))
1621 (if (fboundp 'defvaralias)
1622 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1623 'org-agenda-remove-tags))
1625 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1626 "Shift tags in agenda items to this column.
1627 If this number is positive, it specifies the column. If it is negative,
1628 it means that the tags should be flushright to that column. For example,
1629 -80 works well for a normal 80 character screen."
1630 :group 'org-agenda-line-format
1631 :type 'integer)
1633 (if (fboundp 'defvaralias)
1634 (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1636 (defcustom org-agenda-fontify-priorities 'cookies
1637 "Non-nil means highlight low and high priorities in agenda.
1638 When t, the highest priority entries are bold, lowest priority italic.
1639 However, settings in `org-priority-faces' will overrule these faces.
1640 When this variable is the symbol `cookies', only fontify the
1641 cookies, not the entire task.
1642 This may also be an association list of priority faces, whose
1643 keys are the character values of `org-highest-priority',
1644 `org-default-priority', and `org-lowest-priority' (the default values
1645 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1646 color as a string, or a list like `(:background \"Red\")'.
1647 If it is a color, the variable `org-faces-easy-properties'
1648 determines if it is a foreground or a background color."
1649 :group 'org-agenda-line-format
1650 :type '(choice
1651 (const :tag "Never" nil)
1652 (const :tag "Defaults" t)
1653 (const :tag "Cookies only" cookies)
1654 (repeat :tag "Specify"
1655 (list (character :tag "Priority" :value ?A)
1656 (choice :tag "Face "
1657 (string :tag "Color")
1658 (sexp :tag "Face"))))))
1660 (defcustom org-agenda-day-face-function nil
1661 "Function called to determine what face should be used to display a day.
1662 The only argument passed to that function is the day. It should
1663 returns a face, or nil if does not want to specify a face and let
1664 the normal rules apply."
1665 :group 'org-agenda-line-format
1666 :version "24.1"
1667 :type 'function)
1669 (defcustom org-agenda-category-icon-alist nil
1670 "Alist of category icon to be displayed in agenda views.
1672 Each entry should have the following format:
1674 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1676 Where CATEGORY-REGEXP is a regexp matching the categories where
1677 the icon should be displayed.
1678 FILE-OR-DATA either a file path or a string containing image data.
1680 The other fields can be omitted safely if not needed:
1681 TYPE indicates the image type.
1682 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1683 image data.
1684 PROPS are additional image attributes to assign to the image,
1685 like, e.g. `:ascent center'.
1687 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1689 If you want to set the display properties yourself, just put a
1690 list as second element:
1692 (CATEGORY-REGEXP (MY PROPERTY LIST))
1694 For example, to display a 16px horizontal space for Emacs
1695 category, you can use:
1697 (\"Emacs\" '(space . (:width (16))))"
1698 :group 'org-agenda-line-format
1699 :version "24.1"
1700 :type '(alist :key-type (string :tag "Regexp matching category")
1701 :value-type (choice (list :tag "Icon"
1702 (string :tag "File or data")
1703 (symbol :tag "Type")
1704 (boolean :tag "Data?")
1705 (repeat :tag "Extra image properties" :inline t symbol))
1706 (list :tag "Display properties" sexp))))
1708 (defgroup org-agenda-column-view nil
1709 "Options concerning column view in the agenda."
1710 :tag "Org Agenda Column View"
1711 :group 'org-agenda)
1713 (defcustom org-agenda-columns-show-summaries t
1714 "Non-nil means show summaries for columns displayed in the agenda view."
1715 :group 'org-agenda-column-view
1716 :type 'boolean)
1718 (defcustom org-agenda-columns-compute-summary-properties t
1719 "Non-nil means recompute all summary properties before column view.
1720 When column view in the agenda is listing properties that have a summary
1721 operator, it can go to all relevant buffers and recompute the summaries
1722 there. This can mean overhead for the agenda column view, but is necessary
1723 to have thing up to date.
1724 As a special case, a CLOCKSUM property also makes sure that the clock
1725 computations are current."
1726 :group 'org-agenda-column-view
1727 :type 'boolean)
1729 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1730 "Non-nil means the duration of an appointment will add to day effort.
1731 The property to which appointment durations will be added is the one given
1732 in the option `org-effort-property'. If an appointment does not have
1733 an end time, `org-agenda-default-appointment-duration' will be used. If that
1734 is not set, an appointment without end time will not contribute to the time
1735 estimate."
1736 :group 'org-agenda-column-view
1737 :type 'boolean)
1739 (defcustom org-agenda-auto-exclude-function nil
1740 "A function called with a tag to decide if it is filtered on '/ RET'.
1741 The sole argument to the function, which is called once for each
1742 possible tag, is a string giving the name of the tag. The
1743 function should return either nil if the tag should be included
1744 as normal, or \"-<TAG>\" to exclude the tag.
1745 Note that for the purpose of tag filtering, only the lower-case version of
1746 all tags will be considered, so that this function will only ever see
1747 the lower-case version of all tags."
1748 :group 'org-agenda
1749 :type 'function)
1751 (defcustom org-agenda-bulk-custom-functions nil
1752 "Alist of characters and custom functions for bulk actions.
1753 For example, this value makes those two functions available:
1755 '((?R set-category)
1756 (?C bulk-cut))
1758 With selected entries in an agenda buffer, `B R' will call
1759 the custom function `set-category' on the selected entries.
1760 Note that functions in this alist don't need to be quoted."
1761 :type 'alist
1762 :version "24.1"
1763 :group 'org-agenda)
1765 (eval-when-compile
1766 (require 'cl))
1767 (require 'org)
1769 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1770 "Execute BODY with point at location given by `org-hd-marker' property.
1771 If STRING is non-nil, the text property will be fetched from position 0
1772 in that string. If STRING is nil, it will be fetched from the beginning
1773 of the current line."
1774 (org-with-gensyms (marker)
1775 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1776 'org-hd-marker ,string)))
1777 (with-current-buffer (marker-buffer ,marker)
1778 (save-excursion
1779 (goto-char ,marker)
1780 ,@body)))))
1781 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1783 (defun org-add-agenda-custom-command (entry)
1784 "Replace or add a command in `org-agenda-custom-commands'.
1785 This is mostly for hacking and trying a new command - once the command
1786 works you probably want to add it to `org-agenda-custom-commands' for good."
1787 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1788 (if ass
1789 (setcdr ass (cdr entry))
1790 (push entry org-agenda-custom-commands))))
1792 ;;; Define the org-agenda-mode
1794 (defvar org-agenda-mode-map (make-sparse-keymap)
1795 "Keymap for `org-agenda-mode'.")
1796 (if (fboundp 'defvaralias)
1797 (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1799 (defvar org-agenda-menu) ; defined later in this file.
1800 (defvar org-agenda-restrict) ; defined later in this file.
1801 (defvar org-agenda-follow-mode nil)
1802 (defvar org-agenda-entry-text-mode nil)
1803 (defvar org-agenda-clockreport-mode nil)
1804 (defvar org-agenda-show-log nil)
1805 (defvar org-agenda-redo-command nil)
1806 (defvar org-agenda-query-string nil)
1807 (defvar org-agenda-mode-hook nil
1808 "Hook for `org-agenda-mode', run after the mode is turned on.")
1809 (defvar org-agenda-type nil)
1810 (defvar org-agenda-force-single-file nil)
1811 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1813 (defun org-agenda-mode ()
1814 "Mode for time-sorted view on action items in Org-mode files.
1816 The following commands are available:
1818 \\{org-agenda-mode-map}"
1819 (interactive)
1820 (kill-all-local-variables)
1821 (setq org-agenda-undo-list nil
1822 org-agenda-pending-undo-list nil
1823 org-agenda-bulk-marked-entries nil)
1824 (setq major-mode 'org-agenda-mode)
1825 ;; Keep global-font-lock-mode from turning on font-lock-mode
1826 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1827 (setq mode-name "Org-Agenda")
1828 (use-local-map org-agenda-mode-map)
1829 (easy-menu-add org-agenda-menu)
1830 (if org-startup-truncated (setq truncate-lines t))
1831 (org-set-local 'line-move-visual nil)
1832 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1833 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1834 ;; Make sure properties are removed when copying text
1835 (when (boundp 'buffer-substring-filters)
1836 (org-set-local 'buffer-substring-filters
1837 (cons (lambda (x)
1838 (set-text-properties 0 (length x) nil x) x)
1839 buffer-substring-filters)))
1840 (unless org-agenda-keep-modes
1841 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1842 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1843 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1844 org-agenda-show-log org-agenda-start-with-log-mode))
1846 (easy-menu-change
1847 '("Agenda") "Agenda Files"
1848 (append
1849 (list
1850 (vector
1851 (if (get 'org-agenda-files 'org-restrict)
1852 "Restricted to single file"
1853 "Edit File List")
1854 '(org-edit-agenda-file-list)
1855 (not (get 'org-agenda-files 'org-restrict)))
1856 "--")
1857 (mapcar 'org-file-menu-entry (org-agenda-files))))
1858 (org-agenda-set-mode-name)
1859 (apply
1860 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1861 (list 'org-agenda-mode-hook)))
1863 (substitute-key-definition 'undo 'org-agenda-undo
1864 org-agenda-mode-map global-map)
1865 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1866 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1867 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1868 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1869 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1870 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
1871 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
1872 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
1873 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-remove-all-marks)
1874 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
1875 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
1876 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
1877 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
1878 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
1879 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
1880 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
1881 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
1882 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
1883 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
1884 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
1885 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
1886 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
1887 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
1888 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
1889 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
1890 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
1891 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
1892 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
1893 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
1894 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
1895 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
1896 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
1897 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
1898 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
1899 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
1900 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
1901 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
1902 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
1903 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
1904 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
1905 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
1906 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
1907 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
1908 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
1909 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
1911 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
1912 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
1913 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
1914 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1915 (while l (org-defkey org-agenda-mode-map
1916 (int-to-string (pop l)) 'digit-argument)))
1918 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
1919 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
1920 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
1921 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
1922 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
1923 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
1924 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
1925 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
1926 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
1927 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
1928 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
1929 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
1930 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
1931 'org-clock-modify-effort-estimate)
1932 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
1933 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
1934 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
1935 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
1936 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
1937 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
1938 (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
1939 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
1940 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
1941 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
1942 (substitute-key-definition 'next-line 'org-agenda-next-line
1943 org-agenda-mode-map global-map)
1944 (substitute-key-definition 'previous-line 'org-agenda-previous-line
1945 org-agenda-mode-map global-map)
1946 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
1947 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
1948 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
1949 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
1950 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
1951 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
1952 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
1953 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
1954 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
1955 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
1956 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
1957 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
1958 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
1959 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
1960 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
1961 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
1962 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
1963 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
1964 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
1965 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
1966 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
1967 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
1968 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
1969 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
1970 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
1971 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
1972 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
1973 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
1974 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
1975 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
1977 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
1978 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
1979 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
1980 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
1981 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
1982 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
1983 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
1984 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
1985 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
1986 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
1987 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
1989 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
1990 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
1991 (when org-agenda-mouse-1-follows-link
1992 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
1993 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
1994 '("Agenda"
1995 ("Agenda Files")
1996 "--"
1997 ("Agenda Dates"
1998 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
1999 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2000 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2001 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2002 "--"
2003 ("View"
2004 ["Day View" org-agenda-day-view
2005 :active (org-agenda-check-type nil 'agenda)
2006 :style radio :selected (eq org-agenda-current-span 'day)
2007 :keys "v d (or just d)"]
2008 ["Week View" org-agenda-week-view
2009 :active (org-agenda-check-type nil 'agenda)
2010 :style radio :selected (eq org-agenda-current-span 'week)
2011 :keys "v w (or just w)"]
2012 ["Month View" org-agenda-month-view
2013 :active (org-agenda-check-type nil 'agenda)
2014 :style radio :selected (eq org-agenda-current-span 'month)
2015 :keys "v m"]
2016 ["Year View" org-agenda-year-view
2017 :active (org-agenda-check-type nil 'agenda)
2018 :style radio :selected (eq org-agenda-current-span 'year)
2019 :keys "v y"]
2020 "--"
2021 ["Include Diary" org-agenda-toggle-diary
2022 :style toggle :selected org-agenda-include-diary
2023 :active (org-agenda-check-type nil 'agenda)]
2024 ["Include Deadlines" org-agenda-toggle-deadlines
2025 :style toggle :selected org-agenda-include-deadlines
2026 :active (org-agenda-check-type nil 'agenda)]
2027 ["Use Time Grid" org-agenda-toggle-time-grid
2028 :style toggle :selected org-agenda-use-time-grid
2029 :active (org-agenda-check-type nil 'agenda)]
2030 "--"
2031 ["Show clock report" org-agenda-clockreport-mode
2032 :style toggle :selected org-agenda-clockreport-mode
2033 :active (org-agenda-check-type nil 'agenda)]
2034 ["Show some entry text" org-agenda-entry-text-mode
2035 :style toggle :selected org-agenda-entry-text-mode
2036 :active t]
2037 "--"
2038 ["Show Logbook entries" org-agenda-log-mode
2039 :style toggle :selected org-agenda-show-log
2040 :active (org-agenda-check-type nil 'agenda 'timeline)
2041 :keys "v l (or just l)"]
2042 ["Include archived trees" org-agenda-archives-mode
2043 :style toggle :selected org-agenda-archives-mode :active t
2044 :keys "v a"]
2045 ["Include archive files" (org-agenda-archives-mode t)
2046 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2047 :keys "v A"]
2048 "--"
2049 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2050 ["Write view to file" org-agenda-write t]
2051 ["Rebuild buffer" org-agenda-redo t]
2052 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2053 "--"
2054 ["Show original entry" org-agenda-show t]
2055 ["Go To (other window)" org-agenda-goto t]
2056 ["Go To (this window)" org-agenda-switch-to t]
2057 ["Follow Mode" org-agenda-follow-mode
2058 :style toggle :selected org-agenda-follow-mode :active t]
2059 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2060 "--"
2061 ("TODO"
2062 ["Cycle TODO" org-agenda-todo t]
2063 ["Next TODO set" org-agenda-todo-nextset t]
2064 ["Previous TODO set" org-agenda-todo-previousset t]
2065 ["Add note" org-agenda-add-note t])
2066 ("Archive/Refile/Delete"
2067 ["Archive default" org-agenda-archive-default t]
2068 ["Archive default" org-agenda-archive-default-with-confirmation t]
2069 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2070 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2071 ["Archive subtree" org-agenda-archive t]
2072 "--"
2073 ["Refile" org-agenda-refile t]
2074 "--"
2075 ["Delete subtree" org-agenda-kill t])
2076 ("Bulk action"
2077 ["Mark entry" org-agenda-bulk-mark t]
2078 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2079 ["Unmark entry" org-agenda-bulk-unmark t]
2080 ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
2081 ["Act on all marked" org-agenda-bulk-action t]
2082 "--"
2083 ("Tags and Properties"
2084 ["Show all Tags" org-agenda-show-tags t]
2085 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2086 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2087 "--"
2088 ["Column View" org-columns t])
2089 ("Deadline/Schedule"
2090 ["Schedule" org-agenda-schedule t]
2091 ["Set Deadline" org-agenda-deadline t]
2092 "--"
2093 ["Mark item" org-agenda-action :active t :keys "k m"]
2094 ["Show mark item" org-agenda-action :active t :keys "k v"]
2095 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2096 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2097 "--"
2098 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2099 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2100 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2101 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2102 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2103 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2104 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2105 ("Clock and Effort"
2106 ["Clock in" org-agenda-clock-in t]
2107 ["Clock out" org-agenda-clock-out t]
2108 ["Clock cancel" org-agenda-clock-cancel t]
2109 ["Goto running clock" org-clock-goto t]
2110 "--"
2111 ["Set Effort" org-agenda-set-effort t]
2112 ["Change clocked effort" org-clock-modify-effort-estimate
2113 (org-clock-is-active)])
2114 ("Priority"
2115 ["Set Priority" org-agenda-priority t]
2116 ["Increase Priority" org-agenda-priority-up t]
2117 ["Decrease Priority" org-agenda-priority-down t]
2118 ["Show Priority" org-agenda-show-priority t])
2119 ("Calendar/Diary"
2120 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2121 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2122 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2123 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2124 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2125 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2126 "--"
2127 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2128 "--"
2129 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2130 "--"
2131 ("MobileOrg"
2132 ["Push Files and Views" org-mobile-push t]
2133 ["Get Captured and Flagged" org-mobile-pull t]
2134 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2135 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2136 "--"
2137 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2138 "--"
2139 ["Quit" org-agenda-quit t]
2140 ["Exit and Release Buffers" org-agenda-exit t]
2143 ;;; Agenda undo
2145 (defvar org-agenda-allow-remote-undo t
2146 "Non-nil means allow remote undo from the agenda buffer.")
2147 (defvar org-agenda-undo-list nil
2148 "List of undoable operations in the agenda since last refresh.")
2149 (defvar org-agenda-undo-has-started-in nil
2150 "Buffers that have already seen `undo-start' in the current undo sequence.")
2151 (defvar org-agenda-pending-undo-list nil
2152 "In a series of undo commands, this is the list of remaining undo items.")
2154 (defun org-agenda-undo ()
2155 "Undo a remote editing step in the agenda.
2156 This undoes changes both in the agenda buffer and in the remote buffer
2157 that have been changed along."
2158 (interactive)
2159 (or org-agenda-allow-remote-undo
2160 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2161 (if (not (eq this-command last-command))
2162 (setq org-agenda-undo-has-started-in nil
2163 org-agenda-pending-undo-list org-agenda-undo-list))
2164 (if (not org-agenda-pending-undo-list)
2165 (error "No further undo information"))
2166 (let* ((entry (pop org-agenda-pending-undo-list))
2167 buf line cmd rembuf)
2168 (setq cmd (pop entry) line (pop entry))
2169 (setq rembuf (nth 2 entry))
2170 (org-with-remote-undo rembuf
2171 (while (bufferp (setq buf (pop entry)))
2172 (if (pop entry)
2173 (with-current-buffer buf
2174 (let ((last-undo-buffer buf)
2175 (inhibit-read-only t))
2176 (unless (memq buf org-agenda-undo-has-started-in)
2177 (push buf org-agenda-undo-has-started-in)
2178 (make-local-variable 'pending-undo-list)
2179 (undo-start))
2180 (while (and pending-undo-list
2181 (listp pending-undo-list)
2182 (not (car pending-undo-list)))
2183 (pop pending-undo-list))
2184 (undo-more 1))))))
2185 (org-goto-line line)
2186 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2188 (defun org-verify-change-for-undo (l1 l2)
2189 "Verify that a real change occurred between the undo lists L1 and L2."
2190 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2191 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2192 (not (eq l1 l2)))
2194 ;;; Agenda dispatch
2196 (defvar org-agenda-restrict nil)
2197 (defvar org-agenda-restrict-begin (make-marker))
2198 (defvar org-agenda-restrict-end (make-marker))
2199 (defvar org-agenda-last-dispatch-buffer nil)
2200 (defvar org-agenda-overriding-restriction nil)
2202 ;;;###autoload
2203 (defun org-agenda (&optional arg keys restriction)
2204 "Dispatch agenda commands to collect entries to the agenda buffer.
2205 Prompts for a command to execute. Any prefix arg will be passed
2206 on to the selected command. The default selections are:
2208 a Call `org-agenda-list' to display the agenda for current day or week.
2209 t Call `org-todo-list' to display the global todo list.
2210 T Call `org-todo-list' to display the global todo list, select only
2211 entries with a specific TODO keyword (the user gets a prompt).
2212 m Call `org-tags-view' to display headlines with tags matching
2213 a condition (the user is prompted for the condition).
2214 M Like `m', but select only TODO entries, no ordinary headlines.
2215 L Create a timeline for the current buffer.
2216 e Export views to associated files.
2217 s Search entries for keywords.
2218 / Multi occur across all agenda files and also files listed
2219 in `org-agenda-text-search-extra-files'.
2220 < Restrict agenda commands to buffer, subtree, or region.
2221 Press several times to get the desired effect.
2222 > Remove a previous restriction.
2223 # List \"stuck\" projects.
2224 ! Configure what \"stuck\" means.
2225 C Configure custom agenda commands.
2227 More commands can be added by configuring the variable
2228 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2229 searches can be pre-defined in this way.
2231 If the current buffer is in Org-mode and visiting a file, you can also
2232 first press `<' once to indicate that the agenda should be temporarily
2233 \(until the next use of \\[org-agenda]) restricted to the current file.
2234 Pressing `<' twice means to restrict to the current subtree or region
2235 \(if active)."
2236 (interactive "P")
2237 (catch 'exit
2238 (let* ((prefix-descriptions nil)
2239 (org-agenda-window-setup (if (equal (buffer-name)
2240 org-agenda-buffer-name)
2241 'current-window
2242 org-agenda-window-setup))
2243 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2244 (org-agenda-custom-commands
2245 ;; normalize different versions
2246 (delq nil
2247 (mapcar
2248 (lambda (x)
2249 (cond ((stringp (cdr x))
2250 (push x prefix-descriptions)
2251 nil)
2252 ((stringp (nth 1 x)) x)
2253 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2254 (t (cons (car x) (cons "" (cdr x))))))
2255 org-agenda-custom-commands)))
2256 (buf (current-buffer))
2257 (bfn (buffer-file-name (buffer-base-buffer)))
2258 entry key type match lprops ans)
2259 ;; Turn off restriction unless there is an overriding one,
2260 (unless org-agenda-overriding-restriction
2261 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2262 ;; There is a request to keep the file list in place
2263 (put 'org-agenda-files 'org-restrict nil))
2264 (setq org-agenda-restrict nil)
2265 (move-marker org-agenda-restrict-begin nil)
2266 (move-marker org-agenda-restrict-end nil))
2267 ;; Delete old local properties
2268 (put 'org-agenda-redo-command 'org-lprops nil)
2269 ;; Delete previously set last-arguments
2270 (put 'org-agenda-redo-command 'last-args nil)
2271 ;; Remember where this call originated
2272 (setq org-agenda-last-dispatch-buffer (current-buffer))
2273 (unless keys
2274 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2275 keys (car ans)
2276 restriction (cdr ans)))
2277 ;; Establish the restriction, if any
2278 (when (and (not org-agenda-overriding-restriction) restriction)
2279 (put 'org-agenda-files 'org-restrict (list bfn))
2280 (cond
2281 ((eq restriction 'region)
2282 (setq org-agenda-restrict t)
2283 (move-marker org-agenda-restrict-begin (region-beginning))
2284 (move-marker org-agenda-restrict-end (region-end)))
2285 ((eq restriction 'subtree)
2286 (save-excursion
2287 (setq org-agenda-restrict t)
2288 (org-back-to-heading t)
2289 (move-marker org-agenda-restrict-begin (point))
2290 (move-marker org-agenda-restrict-end
2291 (progn (org-end-of-subtree t)))))))
2293 ;; For example the todo list should not need it (but does...)
2294 (cond
2295 ((setq entry (assoc keys org-agenda-custom-commands))
2296 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2297 (progn
2298 (setq type (nth 2 entry) match (eval (nth 3 entry))
2299 lprops (nth 4 entry))
2300 (put 'org-agenda-redo-command 'org-lprops lprops)
2301 (cond
2302 ((eq type 'agenda)
2303 (org-let lprops '(org-agenda-list current-prefix-arg)))
2304 ((eq type 'alltodo)
2305 (org-let lprops '(org-todo-list current-prefix-arg)))
2306 ((eq type 'search)
2307 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2308 ((eq type 'stuck)
2309 (org-let lprops '(org-agenda-list-stuck-projects
2310 current-prefix-arg)))
2311 ((eq type 'tags)
2312 (org-let lprops '(org-tags-view current-prefix-arg match)))
2313 ((eq type 'tags-todo)
2314 (org-let lprops '(org-tags-view '(4) match)))
2315 ((eq type 'todo)
2316 (org-let lprops '(org-todo-list match)))
2317 ((eq type 'tags-tree)
2318 (org-check-for-org-mode)
2319 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2320 ((eq type 'todo-tree)
2321 (org-check-for-org-mode)
2322 (org-let lprops
2323 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2324 (regexp-quote match) "\\>"))))
2325 ((eq type 'occur-tree)
2326 (org-check-for-org-mode)
2327 (org-let lprops '(org-occur match)))
2328 ((functionp type)
2329 (org-let lprops '(funcall type match)))
2330 ((fboundp type)
2331 (org-let lprops '(funcall type match)))
2332 (t (error "Invalid custom agenda command type %s" type))))
2333 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2334 ((equal keys "C")
2335 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2336 (customize-variable 'org-agenda-custom-commands))
2337 ((equal keys "a") (call-interactively 'org-agenda-list))
2338 ((equal keys "s") (call-interactively 'org-search-view))
2339 ((equal keys "t") (call-interactively 'org-todo-list))
2340 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2341 ((equal keys "m") (call-interactively 'org-tags-view))
2342 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2343 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2344 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2345 (org-add-hook
2346 'post-command-hook
2347 (lambda ()
2348 (unless (current-message)
2349 (let* ((m (org-agenda-get-any-marker))
2350 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2351 (when note
2352 (message (concat
2353 "FLAGGING-NOTE ([?] for more info): "
2354 (org-add-props
2355 (replace-regexp-in-string
2356 "\\\\n" "//"
2357 (copy-sequence note))
2358 nil 'face 'org-warning)))))))
2359 t t))
2360 ((equal keys "L")
2361 (unless (eq major-mode 'org-mode)
2362 (error "This is not an Org-mode file"))
2363 (unless restriction
2364 (put 'org-agenda-files 'org-restrict (list bfn))
2365 (org-call-with-arg 'org-timeline arg)))
2366 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2367 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2368 ((equal keys "!") (customize-variable 'org-stuck-projects))
2369 (t (error "Invalid agenda key"))))))
2371 (defun org-agenda-append-agenda ()
2372 "Append another agenda view to the current one.
2373 This function allows interactive building of block agendas.
2374 Agenda views are separated by `org-agenda-block-separator'."
2375 (interactive)
2376 (unless (string= (buffer-name) org-agenda-buffer-name)
2377 (error "Can only append from within agenda buffer"))
2378 (let ((org-agenda-multi t))
2379 (org-agenda)
2380 (widen)))
2382 (defun org-agenda-normalize-custom-commands (cmds)
2383 (delq nil
2384 (mapcar
2385 (lambda (x)
2386 (cond ((stringp (cdr x)) nil)
2387 ((stringp (nth 1 x)) x)
2388 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2389 (t (cons (car x) (cons "" (cdr x))))))
2390 cmds)))
2392 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2393 "The user interface for selecting an agenda command."
2394 (catch 'exit
2395 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2396 (restrict-ok (and bfn (eq major-mode 'org-mode)))
2397 (region-p (org-region-active-p))
2398 (custom org-agenda-custom-commands)
2399 (selstring "")
2400 restriction second-time
2401 c entry key type match prefixes rmheader header-end custom1 desc
2402 line lines left right n n1)
2403 (save-window-excursion
2404 (delete-other-windows)
2405 (org-switch-to-buffer-other-window " *Agenda Commands*")
2406 (erase-buffer)
2407 (insert (eval-when-compile
2408 (let ((header
2410 Press key for an agenda command: < Buffer, subtree/region restriction
2411 -------------------------------- > Remove restriction
2412 a Agenda for current week or day e Export agenda views
2413 t List of all TODO entries T Entries with special TODO kwd
2414 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2415 L Timeline for current buffer # List stuck projects (!=configure)
2416 s Search for keywords C Configure custom agenda commands
2417 / Multi-occur ? Find :FLAGGED: entries
2419 (start 0))
2420 (while (string-match
2421 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2422 header start)
2423 (setq start (match-end 0))
2424 (add-text-properties (match-beginning 2) (match-end 2)
2425 '(face bold) header))
2426 header)))
2427 (setq header-end (move-marker (make-marker) (point)))
2428 (while t
2429 (setq custom1 custom)
2430 (when (eq rmheader t)
2431 (org-goto-line 1)
2432 (re-search-forward ":" nil t)
2433 (delete-region (match-end 0) (point-at-eol))
2434 (forward-char 1)
2435 (looking-at "-+")
2436 (delete-region (match-end 0) (point-at-eol))
2437 (move-marker header-end (match-end 0)))
2438 (goto-char header-end)
2439 (delete-region (point) (point-max))
2441 ;; Produce all the lines that describe custom commands and prefixes
2442 (setq lines nil)
2443 (while (setq entry (pop custom1))
2444 (setq key (car entry) desc (nth 1 entry)
2445 type (nth 2 entry)
2446 match (nth 3 entry))
2447 (if (> (length key) 1)
2448 (add-to-list 'prefixes (string-to-char key))
2449 (setq line
2450 (format
2451 "%-4s%-14s"
2452 (org-add-props (copy-sequence key)
2453 '(face bold))
2454 (cond
2455 ((string-match "\\S-" desc) desc)
2456 ((eq type 'agenda) "Agenda for current week or day")
2457 ((eq type 'alltodo) "List of all TODO entries")
2458 ((eq type 'search) "Word search")
2459 ((eq type 'stuck) "List of stuck projects")
2460 ((eq type 'todo) "TODO keyword")
2461 ((eq type 'tags) "Tags query")
2462 ((eq type 'tags-todo) "Tags (TODO)")
2463 ((eq type 'tags-tree) "Tags tree")
2464 ((eq type 'todo-tree) "TODO kwd tree")
2465 ((eq type 'occur-tree) "Occur tree")
2466 ((functionp type) (if (symbolp type)
2467 (symbol-name type)
2468 "Lambda expression"))
2469 (t "???"))))
2470 (if org-agenda-menu-show-matcher
2471 (setq line
2472 (concat line ": "
2473 (cond
2474 ((stringp match)
2475 (setq match (copy-sequence match))
2476 (org-add-props match nil 'face 'org-warning))
2477 (match
2478 (format "set of %d commands" (length match)))
2479 (t ""))))
2480 (if (org-string-nw-p match)
2481 (add-text-properties
2482 0 (length line) (list 'help-echo
2483 (concat "Matcher: "match)) line)))
2484 (push line lines)))
2485 (setq lines (nreverse lines))
2486 (when prefixes
2487 (mapc (lambda (x)
2488 (push
2489 (format "%s %s"
2490 (org-add-props (char-to-string x)
2491 nil 'face 'bold)
2492 (or (cdr (assoc (concat selstring
2493 (char-to-string x))
2494 prefix-descriptions))
2495 "Prefix key"))
2496 lines))
2497 prefixes))
2499 ;; Check if we should display in two columns
2500 (if org-agenda-menu-two-column
2501 (progn
2502 (setq n (length lines)
2503 n1 (+ (/ n 2) (mod n 2))
2504 right (nthcdr n1 lines)
2505 left (copy-sequence lines))
2506 (setcdr (nthcdr (1- n1) left) nil))
2507 (setq left lines right nil))
2508 (while left
2509 (insert "\n" (pop left))
2510 (when right
2511 (if (< (current-column) 40)
2512 (move-to-column 40 t)
2513 (insert " "))
2514 (insert (pop right))))
2516 ;; Make the window the right size
2517 (goto-char (point-min))
2518 (if second-time
2519 (if (not (pos-visible-in-window-p (point-max)))
2520 (org-fit-window-to-buffer))
2521 (setq second-time t)
2522 (org-fit-window-to-buffer))
2524 ;; Ask for selection
2525 (message "Press key for agenda command%s:"
2526 (if (or restrict-ok org-agenda-overriding-restriction)
2527 (if org-agenda-overriding-restriction
2528 " (restriction lock active)"
2529 (if restriction
2530 (format " (restricted to %s)" restriction)
2531 " (unrestricted)"))
2532 ""))
2533 (setq c (read-char-exclusive))
2534 (message "")
2535 (cond
2536 ((assoc (char-to-string c) custom)
2537 (setq selstring (concat selstring (char-to-string c)))
2538 (throw 'exit (cons selstring restriction)))
2539 ((memq c prefixes)
2540 (setq selstring (concat selstring (char-to-string c))
2541 prefixes nil
2542 rmheader (or rmheader t)
2543 custom (delq nil (mapcar
2544 (lambda (x)
2545 (if (or (= (length (car x)) 1)
2546 (/= (string-to-char (car x)) c))
2548 (cons (substring (car x) 1) (cdr x))))
2549 custom))))
2550 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2551 (message "Restriction is only possible in Org-mode buffers")
2552 (ding) (sit-for 1))
2553 ((eq c ?1)
2554 (org-agenda-remove-restriction-lock 'noupdate)
2555 (setq restriction 'buffer))
2556 ((eq c ?0)
2557 (org-agenda-remove-restriction-lock 'noupdate)
2558 (setq restriction (if region-p 'region 'subtree)))
2559 ((eq c ?<)
2560 (org-agenda-remove-restriction-lock 'noupdate)
2561 (setq restriction
2562 (cond
2563 ((eq restriction 'buffer)
2564 (if region-p 'region 'subtree))
2565 ((memq restriction '(subtree region))
2566 nil)
2567 (t 'buffer))))
2568 ((eq c ?>)
2569 (org-agenda-remove-restriction-lock 'noupdate)
2570 (setq restriction nil))
2571 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2572 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2573 ((and (> (length selstring) 0) (eq c ?\d))
2574 (delete-window)
2575 (org-agenda-get-restriction-and-command prefix-descriptions))
2577 ((equal c ?q) (error "Abort"))
2578 (t (error "Invalid key %c" c))))))))
2580 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2581 (defvar org-agenda-last-arguments nil
2582 "The arguments of the previous call to `org-agenda'.")
2583 (defun org-agenda-run-series (name series)
2584 (org-let (nth 1 series) '(org-prepare-agenda name))
2585 (let* ((org-agenda-multi t)
2586 (redo (list 'org-agenda-run-series name (list 'quote series)))
2587 (org-agenda-overriding-arguments
2588 (or org-agenda-overriding-arguments
2589 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2590 (get 'org-agenda-redo-command 'last-args))))
2591 (cmds (car series))
2592 (gprops (nth 1 series))
2593 match ;; The byte compiler incorrectly complains about this. Keep it!
2594 cmd type lprops)
2595 (while (setq cmd (pop cmds))
2596 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2597 (cond
2598 ((eq type 'agenda)
2599 (org-let2 gprops lprops
2600 '(call-interactively 'org-agenda-list)))
2601 ((eq type 'alltodo)
2602 (org-let2 gprops lprops
2603 '(call-interactively 'org-todo-list)))
2604 ((eq type 'search)
2605 (org-let2 gprops lprops
2606 '(org-search-view current-prefix-arg match nil)))
2607 ((eq type 'stuck)
2608 (org-let2 gprops lprops
2609 '(call-interactively 'org-agenda-list-stuck-projects)))
2610 ((eq type 'tags)
2611 (org-let2 gprops lprops
2612 '(org-tags-view current-prefix-arg match)))
2613 ((eq type 'tags-todo)
2614 (org-let2 gprops lprops
2615 '(org-tags-view '(4) match)))
2616 ((eq type 'todo)
2617 (org-let2 gprops lprops
2618 '(org-todo-list match)))
2619 ((fboundp type)
2620 (org-let2 gprops lprops
2621 '(funcall type match)))
2622 (t (error "Invalid type in command series"))))
2623 (widen)
2624 (setq org-agenda-redo-command redo)
2625 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2626 (goto-char (point-min)))
2627 (org-fit-agenda-window)
2628 (org-let (nth 1 series) '(org-finalize-agenda)))
2630 ;;;###autoload
2631 (defmacro org-batch-agenda (cmd-key &rest parameters)
2632 "Run an agenda command in batch mode and send the result to STDOUT.
2633 If CMD-KEY is a string of length 1, it is used as a key in
2634 `org-agenda-custom-commands' and triggers this command. If it is a
2635 longer string it is used as a tags/todo match string.
2636 Parameters are alternating variable names and values that will be bound
2637 before running the agenda command."
2638 (org-eval-in-environment (org-make-parameter-alist parameters)
2639 (if (> (length cmd-key) 2)
2640 (org-tags-view nil cmd-key)
2641 (org-agenda nil cmd-key)))
2642 (set-buffer org-agenda-buffer-name)
2643 (princ (buffer-string)))
2644 (def-edebug-spec org-batch-agenda (form &rest sexp))
2646 (defvar org-agenda-info nil)
2648 ;;;###autoload
2649 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2650 "Run an agenda command in batch mode and send the result to STDOUT.
2651 If CMD-KEY is a string of length 1, it is used as a key in
2652 `org-agenda-custom-commands' and triggers this command. If it is a
2653 longer string it is used as a tags/todo match string.
2654 Parameters are alternating variable names and values that will be bound
2655 before running the agenda command.
2657 The output gives a line for each selected agenda item. Each
2658 item is a list of comma-separated values, like this:
2660 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2662 category The category of the item
2663 head The headline, without TODO kwd, TAGS and PRIORITY
2664 type The type of the agenda entry, can be
2665 todo selected in TODO match
2666 tagsmatch selected in tags match
2667 diary imported from diary
2668 deadline a deadline on given date
2669 scheduled scheduled on given date
2670 timestamp entry has timestamp on given date
2671 closed entry was closed on given date
2672 upcoming-deadline warning about deadline
2673 past-scheduled forwarded scheduled item
2674 block entry has date block including g. date
2675 todo The todo keyword, if any
2676 tags All tags including inherited ones, separated by colons
2677 date The relevant date, like 2007-2-14
2678 time The time, like 15:00-16:50
2679 extra Sting with extra planning info
2680 priority-l The priority letter if any was given
2681 priority-n The computed numerical priority
2682 agenda-day The day in the agenda where this is listed"
2683 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2684 (org-make-parameter-alist parameters))
2685 (if (> (length cmd-key) 2)
2686 (org-tags-view nil cmd-key)
2687 (org-agenda nil cmd-key)))
2688 (set-buffer org-agenda-buffer-name)
2689 (let* ((lines (org-split-string (buffer-string) "\n"))
2690 line)
2691 (while (setq line (pop lines))
2692 (catch 'next
2693 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2694 (setq org-agenda-info
2695 (org-fix-agenda-info (text-properties-at 0 line)))
2696 (princ
2697 (mapconcat 'org-agenda-export-csv-mapper
2698 '(org-category txt type todo tags date time extra
2699 priority-letter priority agenda-day)
2700 ","))
2701 (princ "\n")))))
2702 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2704 (defun org-fix-agenda-info (props)
2705 "Make sure all properties on an agenda item have a canonical form.
2706 This ensures the export commands can easily use it."
2707 (let (tmp re)
2708 (when (setq tmp (plist-get props 'tags))
2709 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2710 (when (setq tmp (plist-get props 'date))
2711 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2712 (let ((calendar-date-display-form '(year "-" month "-" day)))
2713 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2715 (setq tmp (calendar-date-string tmp)))
2716 (setq props (plist-put props 'date tmp)))
2717 (when (setq tmp (plist-get props 'day))
2718 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2719 (let ((calendar-date-display-form '(year "-" month "-" day)))
2720 (setq tmp (calendar-date-string tmp)))
2721 (setq props (plist-put props 'day tmp))
2722 (setq props (plist-put props 'agenda-day tmp)))
2723 (when (setq tmp (plist-get props 'txt))
2724 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2725 (plist-put props 'priority-letter (match-string 1 tmp))
2726 (setq tmp (replace-match "" t t tmp)))
2727 (when (and (setq re (plist-get props 'org-todo-regexp))
2728 (setq re (concat "\\`\\.*" re " ?"))
2729 (string-match re tmp))
2730 (plist-put props 'todo (match-string 1 tmp))
2731 (setq tmp (replace-match "" t t tmp)))
2732 (plist-put props 'txt tmp)))
2733 props)
2735 (defun org-agenda-export-csv-mapper (prop)
2736 (let ((res (plist-get org-agenda-info prop)))
2737 (setq res
2738 (cond
2739 ((not res) "")
2740 ((stringp res) res)
2741 (t (prin1-to-string res))))
2742 (while (string-match "," res)
2743 (setq res (replace-match ";" t t res)))
2744 (org-trim res)))
2747 ;;;###autoload
2748 (defun org-store-agenda-views (&rest parameters)
2749 (interactive)
2750 (eval (list 'org-batch-store-agenda-views)))
2752 ;;;###autoload
2753 (defmacro org-batch-store-agenda-views (&rest parameters)
2754 "Run all custom agenda commands that have a file argument."
2755 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2756 (pop-up-frames nil)
2757 (dir default-directory)
2758 (pars (org-make-parameter-alist parameters))
2759 cmd thiscmdkey files opts cmd-or-set)
2760 (save-window-excursion
2761 (while cmds
2762 (setq cmd (pop cmds)
2763 thiscmdkey (car cmd)
2764 cmd-or-set (nth 2 cmd)
2765 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2766 files (nth (if (listp cmd-or-set) 4 5) cmd))
2767 (if (stringp files) (setq files (list files)))
2768 (when files
2769 (org-eval-in-environment (append org-agenda-exporter-settings
2770 opts pars)
2771 (org-agenda nil thiscmdkey))
2772 (set-buffer org-agenda-buffer-name)
2773 (while files
2774 (org-eval-in-environment (append org-agenda-exporter-settings
2775 opts pars)
2776 (org-agenda-write (expand-file-name (pop files) dir) nil t)))
2777 (and (get-buffer org-agenda-buffer-name)
2778 (kill-buffer org-agenda-buffer-name)))))))
2779 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2781 (defun org-agenda-mark-header-line (pos)
2782 "Mark the line at POS as an agenda structure header."
2783 (save-excursion
2784 (goto-char pos)
2785 (put-text-property (point-at-bol) (point-at-eol)
2786 'org-agenda-structural-header t)
2787 (when org-agenda-title-append
2788 (put-text-property (point-at-bol) (point-at-eol)
2789 'org-agenda-title-append org-agenda-title-append))))
2791 (defvar org-mobile-creating-agendas)
2792 (defvar org-agenda-write-buffer-name "Agenda View")
2793 (defun org-agenda-write (file &optional open nosettings)
2794 "Write the current buffer (an agenda view) as a file.
2795 Depending on the extension of the file name, plain text (.txt),
2796 HTML (.html or .htm) or Postscript (.ps) is produced.
2797 If the extension is .ics, run icalendar export over all files used
2798 to construct the agenda and limit the export to entries listed in the
2799 agenda now.
2800 With prefix argument OPEN, open the new file immediately.
2801 If NOSETTINGS is given, do not scope the settings of
2802 `org-agenda-exporter-settings' into the export commands. This is used when
2803 the settings have already been scoped and we do not wish to overrule other,
2804 higher priority settings."
2805 (interactive "FWrite agenda to file: \nP")
2806 (if (not (file-writable-p file))
2807 (error "Cannot write agenda to file %s" file))
2808 (org-let (if nosettings nil org-agenda-exporter-settings)
2809 '(save-excursion
2810 (save-window-excursion
2811 (org-agenda-mark-filtered-text)
2812 (let ((bs (copy-sequence (buffer-string))) beg)
2813 (org-agenda-unmark-filtered-text)
2814 (with-temp-buffer
2815 (rename-buffer org-agenda-write-buffer-name t)
2816 (set-buffer-modified-p nil)
2817 (insert bs)
2818 (org-agenda-remove-marked-text 'org-filtered)
2819 (while (setq beg (text-property-any (point-min) (point-max)
2820 'org-filtered t))
2821 (delete-region
2822 beg (or (next-single-property-change beg 'org-filtered)
2823 (point-max))))
2824 (run-hooks 'org-agenda-before-write-hook)
2825 (cond
2826 ((org-bound-and-true-p org-mobile-creating-agendas)
2827 (org-mobile-write-agenda-for-mobile file))
2828 ((string-match "\\.html?\\'" file)
2829 (require 'htmlize)
2830 (set-buffer (htmlize-buffer (current-buffer)))
2832 (when (and org-agenda-export-html-style
2833 (string-match "<style>" org-agenda-export-html-style))
2834 ;; replace <style> section with org-agenda-export-html-style
2835 (goto-char (point-min))
2836 (kill-region (- (search-forward "<style") 6)
2837 (search-forward "</style>"))
2838 (insert org-agenda-export-html-style))
2839 (write-file file)
2840 (kill-buffer (current-buffer))
2841 (message "HTML written to %s" file))
2842 ((string-match "\\.ps\\'" file)
2843 (require 'ps-print)
2844 (ps-print-buffer-with-faces file)
2845 (message "Postscript written to %s" file))
2846 ((string-match "\\.pdf\\'" file)
2847 (require 'ps-print)
2848 (ps-print-buffer-with-faces
2849 (concat (file-name-sans-extension file) ".ps"))
2850 (call-process "ps2pdf" nil nil nil
2851 (expand-file-name
2852 (concat (file-name-sans-extension file) ".ps"))
2853 (expand-file-name file))
2854 (delete-file (concat (file-name-sans-extension file) ".ps"))
2855 (message "PDF written to %s" file))
2856 ((string-match "\\.ics\\'" file)
2857 (require 'org-icalendar)
2858 (let ((org-agenda-marker-table
2859 (org-create-marker-find-array
2860 (org-agenda-collect-markers)))
2861 (org-icalendar-verify-function 'org-check-agenda-marker-table)
2862 (org-combined-agenda-icalendar-file file))
2863 (apply 'org-export-icalendar 'combine
2864 (org-agenda-files nil 'ifmode))))
2866 (let ((bs (buffer-string)))
2867 (find-file file)
2868 (erase-buffer)
2869 (insert bs)
2870 (save-buffer 0)
2871 (kill-buffer (current-buffer))
2872 (message "Plain text written to %s" file))))))))
2873 (set-buffer org-agenda-buffer-name))
2874 (when open (org-open-file file)))
2876 (defvar org-agenda-tag-filter-overlays nil)
2877 (defvar org-agenda-cat-filter-overlays nil)
2879 (defun org-agenda-mark-filtered-text ()
2880 "Mark all text hidden by filtering with a text property."
2881 (let ((inhibit-read-only t))
2882 (mapc
2883 (lambda (o)
2884 (when (equal (overlay-buffer o) (current-buffer))
2885 (put-text-property
2886 (overlay-start o) (overlay-end o)
2887 'org-filtered t)))
2888 (append org-agenda-tag-filter-overlays
2889 org-agenda-cat-filter-overlays))))
2891 (defun org-agenda-unmark-filtered-text ()
2892 "Remove the filtering text property."
2893 (let ((inhibit-read-only t))
2894 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
2896 (defun org-agenda-remove-marked-text (property &optional value)
2897 "Delete all text marked with VALUE of PROPERTY.
2898 VALUE defaults to t."
2899 (let (beg)
2900 (setq value (or value t))
2901 (while (setq beg (text-property-any (point-min) (point-max)
2902 property value))
2903 (delete-region
2904 beg (or (next-single-property-change beg 'org-filtered)
2905 (point-max))))))
2907 (defun org-agenda-add-entry-text ()
2908 "Add entry text to agenda lines.
2909 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
2910 entry text following headings shown in the agenda.
2911 Drawers will be excluded, also the line with scheduling/deadline info."
2912 (when (and (> org-agenda-add-entry-text-maxlines 0)
2913 (not (org-bound-and-true-p org-mobile-creating-agendas)))
2914 (let (m txt)
2915 (goto-char (point-min))
2916 (while (not (eobp))
2917 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
2918 (beginning-of-line 2)
2919 (setq txt (org-agenda-get-some-entry-text
2920 m org-agenda-add-entry-text-maxlines " > "))
2921 (end-of-line 1)
2922 (if (string-match "\\S-" txt)
2923 (insert "\n" txt)
2924 (or (eobp) (forward-char 1))))))))
2926 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
2927 &rest keep)
2928 "Extract entry text from MARKER, at most N-LINES lines.
2929 This will ignore drawers etc, just get the text.
2930 If INDENT is given, prefix every line with this string. If KEEP is
2931 given, it is a list of symbols, defining stuff that should not be
2932 removed from the entry content. Currently only `planning' is allowed here."
2933 (let (txt drawer-re kwd-time-re ind)
2934 (save-excursion
2935 (with-current-buffer (marker-buffer marker)
2936 (if (not (eq major-mode 'org-mode))
2937 (setq txt "")
2938 (save-excursion
2939 (save-restriction
2940 (widen)
2941 (goto-char marker)
2942 (end-of-line 1)
2943 (setq txt (buffer-substring
2944 (min (1+ (point)) (point-max))
2945 (progn (outline-next-heading) (point)))
2946 drawer-re org-drawer-regexp
2947 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
2948 ".*\n?"))
2949 (with-temp-buffer
2950 (insert txt)
2951 (when org-agenda-add-entry-text-descriptive-links
2952 (goto-char (point-min))
2953 (while (org-activate-bracket-links (point-max))
2954 (add-text-properties (match-beginning 0) (match-end 0)
2955 '(face org-link))))
2956 (goto-char (point-min))
2957 (while (re-search-forward org-bracket-link-regexp (point-max) t)
2958 (set-text-properties (match-beginning 0) (match-end 0)
2959 nil))
2960 (goto-char (point-min))
2961 (while (re-search-forward drawer-re nil t)
2962 (delete-region
2963 (match-beginning 0)
2964 (progn (re-search-forward
2965 "^[ \t]*:END:.*\n?" nil 'move)
2966 (point))))
2967 (unless (member 'planning keep)
2968 (goto-char (point-min))
2969 (while (re-search-forward kwd-time-re nil t)
2970 (replace-match "")))
2971 (goto-char (point-min))
2972 (when org-agenda-entry-text-exclude-regexps
2973 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
2974 (while (setq re (pop re-list))
2975 (goto-char (point-min))
2976 (while (re-search-forward re nil t)
2977 (replace-match "")))))
2978 (goto-char (point-max))
2979 (skip-chars-backward " \t\n")
2980 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
2982 ;; find and remove min common indentation
2983 (goto-char (point-min))
2984 (untabify (point-min) (point-max))
2985 (setq ind (org-get-indentation))
2986 (while (not (eobp))
2987 (unless (looking-at "[ \t]*$")
2988 (setq ind (min ind (org-get-indentation))))
2989 (beginning-of-line 2))
2990 (goto-char (point-min))
2991 (while (not (eobp))
2992 (unless (looking-at "[ \t]*$")
2993 (move-to-column ind)
2994 (delete-region (point-at-bol) (point)))
2995 (beginning-of-line 2))
2997 (run-hooks 'org-agenda-entry-text-cleanup-hook)
2999 (goto-char (point-min))
3000 (when indent
3001 (while (and (not (eobp)) (re-search-forward "^" nil t))
3002 (replace-match indent t t)))
3003 (goto-char (point-min))
3004 (while (looking-at "[ \t]*\n") (replace-match ""))
3005 (goto-char (point-max))
3006 (when (> (org-current-line)
3007 n-lines)
3008 (org-goto-line (1+ n-lines))
3009 (backward-char 1))
3010 (setq txt (buffer-substring (point-min) (point)))))))))
3011 txt))
3013 (defun org-agenda-collect-markers ()
3014 "Collect the markers pointing to entries in the agenda buffer."
3015 (let (m markers)
3016 (save-excursion
3017 (goto-char (point-min))
3018 (while (not (eobp))
3019 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3020 (org-get-at-bol 'org-marker)))
3021 (push m markers))
3022 (beginning-of-line 2)))
3023 (nreverse markers)))
3025 (defun org-create-marker-find-array (marker-list)
3026 "Create a alist of files names with all marker positions in that file."
3027 (let (f tbl m a p)
3028 (while (setq m (pop marker-list))
3029 (setq p (marker-position m)
3030 f (buffer-file-name (or (buffer-base-buffer
3031 (marker-buffer m))
3032 (marker-buffer m))))
3033 (if (setq a (assoc f tbl))
3034 (push (marker-position m) (cdr a))
3035 (push (list f p) tbl)))
3036 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3037 tbl)))
3039 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3040 (defun org-check-agenda-marker-table ()
3041 "Check of the current entry is on the marker list."
3042 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3044 (and (setq a (assoc file org-agenda-marker-table))
3045 (save-match-data
3046 (save-excursion
3047 (org-back-to-heading t)
3048 (member (point) (cdr a)))))))
3050 (defun org-check-for-org-mode ()
3051 "Make sure current buffer is in org-mode. Error if not."
3052 (or (eq major-mode 'org-mode)
3053 (error "Cannot execute org-mode agenda command on buffer in %s"
3054 major-mode)))
3056 (defun org-fit-agenda-window ()
3057 "Fit the window to the buffer size."
3058 (and (memq org-agenda-window-setup '(reorganize-frame))
3059 (fboundp 'fit-window-to-buffer)
3060 (org-fit-window-to-buffer
3062 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3063 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3065 ;;; Agenda prepare and finalize
3067 (defvar org-agenda-multi nil) ; dynamically scoped
3068 (defvar org-agenda-buffer-name "*Org Agenda*")
3069 (defvar org-pre-agenda-window-conf nil)
3070 (defvar org-agenda-columns-active nil)
3071 (defvar org-agenda-name nil)
3072 (defvar org-agenda-tag-filter nil)
3073 (defvar org-agenda-category-filter nil)
3074 (defvar org-agenda-tag-filter-while-redo nil)
3075 (defvar org-agenda-tag-filter-preset nil
3076 "A preset of the tags filter used for secondary agenda filtering.
3077 This must be a list of strings, each string must be a single tag preceded
3078 by \"+\" or \"-\".
3079 This variable should not be set directly, but agenda custom commands can
3080 bind it in the options section. The preset filter is a global property of
3081 the entire agenda view. In a block agenda, it will not work reliably to
3082 define a filter for one of the individual blocks. You need to set it in
3083 the global options and expect it to be applied to the entire view.")
3085 (defvar org-agenda-category-filter-preset nil
3086 "A preset of the category filter used for secondary agenda filtering.
3087 This must be a list of strings, each string must be a single category
3088 preceded by \"+\" or \"-\".
3089 This variable should not be set directly, but agenda custom commands can
3090 bind it in the options section. The preset filter is a global property of
3091 the entire agenda view. In a block agenda, it will not work reliably to
3092 define a filter for one of the individual blocks. You need to set it in
3093 the global options and expect it to be applied to the entire view.")
3095 (defun org-prepare-agenda (&optional name)
3096 (setq org-todo-keywords-for-agenda nil)
3097 (setq org-done-keywords-for-agenda nil)
3098 (setq org-drawers-for-agenda nil)
3099 (unless org-agenda-persistent-filter
3100 (setq org-agenda-tag-filter nil
3101 org-agenda-category-filter nil))
3102 (put 'org-agenda-tag-filter :preset-filter org-agenda-tag-filter-preset)
3103 (put 'org-agenda-category-filter :preset-filter org-agenda-category-filter-preset)
3104 (if org-agenda-multi
3105 (progn
3106 (setq buffer-read-only nil)
3107 (goto-char (point-max))
3108 (unless (or (bobp) org-agenda-compact-blocks
3109 (not org-agenda-block-separator))
3110 (insert "\n"
3111 (if (stringp org-agenda-block-separator)
3112 org-agenda-block-separator
3113 (make-string (window-width) org-agenda-block-separator))
3114 "\n"))
3115 (narrow-to-region (point) (point-max)))
3116 (org-agenda-reset-markers)
3117 (setq org-agenda-contributing-files nil)
3118 (setq org-agenda-columns-active nil)
3119 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3120 (setq org-todo-keywords-for-agenda
3121 (org-uniquify org-todo-keywords-for-agenda))
3122 (setq org-done-keywords-for-agenda
3123 (org-uniquify org-done-keywords-for-agenda))
3124 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3125 (let* ((abuf (get-buffer-create org-agenda-buffer-name))
3126 (awin (get-buffer-window abuf)))
3127 (cond
3128 ((equal (current-buffer) abuf) nil)
3129 (awin (select-window awin))
3130 ((not (setq org-pre-agenda-window-conf (current-window-configuration))))
3131 ((equal org-agenda-window-setup 'current-window)
3132 (org-pop-to-buffer-same-window abuf))
3133 ((equal org-agenda-window-setup 'other-window)
3134 (org-switch-to-buffer-other-window abuf))
3135 ((equal org-agenda-window-setup 'other-frame)
3136 (switch-to-buffer-other-frame abuf))
3137 ((equal org-agenda-window-setup 'reorganize-frame)
3138 (delete-other-windows)
3139 (org-switch-to-buffer-other-window abuf)))
3140 ;; additional test in case agenda is invoked from within agenda
3141 ;; buffer via elisp link
3142 (unless (equal (current-buffer) abuf)
3143 (org-pop-to-buffer-same-window abuf)))
3144 (setq buffer-read-only nil)
3145 (let ((inhibit-read-only t)) (erase-buffer))
3146 (org-agenda-mode)
3147 (and name (not org-agenda-name)
3148 (org-set-local 'org-agenda-name name)))
3149 (setq buffer-read-only nil))
3151 (defun org-finalize-agenda ()
3152 "Finishing touch for the agenda buffer, called just before displaying it."
3153 (unless org-agenda-multi
3154 (save-excursion
3155 (let ((inhibit-read-only t))
3156 (goto-char (point-min))
3157 (while (org-activate-bracket-links (point-max))
3158 (add-text-properties (match-beginning 0) (match-end 0)
3159 '(face org-link)))
3160 (org-agenda-align-tags)
3161 (unless org-agenda-with-colors
3162 (remove-text-properties (point-min) (point-max) '(face nil))))
3163 (if (and (boundp 'org-agenda-overriding-columns-format)
3164 org-agenda-overriding-columns-format)
3165 (org-set-local 'org-agenda-overriding-columns-format
3166 org-agenda-overriding-columns-format))
3167 (if (and (boundp 'org-agenda-view-columns-initially)
3168 org-agenda-view-columns-initially)
3169 (org-agenda-columns))
3170 (when org-agenda-fontify-priorities
3171 (org-agenda-fontify-priorities))
3172 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3173 (org-agenda-dim-blocked-tasks))
3174 (org-agenda-mark-clocking-task)
3175 (when org-agenda-entry-text-mode
3176 (org-agenda-entry-text-hide)
3177 (org-agenda-entry-text-show))
3178 (if (functionp 'org-habit-insert-consistency-graphs)
3179 (org-habit-insert-consistency-graphs))
3180 (run-hooks 'org-finalize-agenda-hook)
3181 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3182 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3183 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3184 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3185 (org-agenda-filter-apply org-agenda-category-filter 'category))
3188 (defun org-agenda-mark-clocking-task ()
3189 "Mark the current clock entry in the agenda if it is present."
3190 (mapc (lambda (o)
3191 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3192 (delete-overlay o)))
3193 (overlays-in (point-min) (point-max)))
3194 (when (marker-buffer org-clock-hd-marker)
3195 (save-excursion
3196 (goto-char (point-min))
3197 (let (s ov)
3198 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3199 (goto-char s)
3200 (when (equal (org-get-at-bol 'org-hd-marker)
3201 org-clock-hd-marker)
3202 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3203 (overlay-put ov 'type 'org-agenda-clocking)
3204 (overlay-put ov 'face 'org-agenda-clocking)
3205 (overlay-put ov 'help-echo
3206 "The clock is running in this item")))))))
3208 (defun org-agenda-fontify-priorities ()
3209 "Make highest priority lines bold, and lowest italic."
3210 (interactive)
3211 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3212 (delete-overlay o)))
3213 (overlays-in (point-min) (point-max)))
3214 (save-excursion
3215 (let ((inhibit-read-only t)
3216 b e p ov h l)
3217 (goto-char (point-min))
3218 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3219 (setq h (or (get-char-property (point) 'org-highest-priority)
3220 org-highest-priority)
3221 l (or (get-char-property (point) 'org-lowest-priority)
3222 org-lowest-priority)
3223 p (string-to-char (match-string 1))
3224 b (match-beginning 0)
3225 e (if (eq org-agenda-fontify-priorities 'cookies)
3226 (match-end 0)
3227 (point-at-eol))
3228 ov (make-overlay b e))
3229 (overlay-put
3230 ov 'face
3231 (cond ((org-face-from-face-or-color
3232 'priority nil
3233 (cdr (assoc p org-priority-faces))))
3234 ((and (listp org-agenda-fontify-priorities)
3235 (org-face-from-face-or-color
3236 'priority nil
3237 (cdr (assoc p org-agenda-fontify-priorities)))))
3238 ((equal p l) 'italic)
3239 ((equal p h) 'bold)))
3240 (overlay-put ov 'org-type 'org-priority)))))
3242 (defun org-agenda-dim-blocked-tasks ()
3243 "Dim currently blocked TODO's in the agenda display."
3244 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3245 (delete-overlay o)))
3246 (overlays-in (point-min) (point-max)))
3247 (save-excursion
3248 (let ((inhibit-read-only t)
3249 (org-depend-tag-blocked nil)
3250 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3251 org-blocked-by-checkboxes
3252 invis1 b e p ov h l)
3253 (goto-char (point-min))
3254 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3255 (and pos (goto-char (1+ pos))))
3256 (setq org-blocked-by-checkboxes nil invis1 invis)
3257 (let ((marker (org-get-at-bol 'org-hd-marker)))
3258 (when (and marker
3259 (with-current-buffer (marker-buffer marker)
3260 (save-excursion (goto-char marker)
3261 (org-entry-blocked-p))))
3262 (if org-blocked-by-checkboxes (setq invis1 nil))
3263 (setq b (if invis1
3264 (max (point-min) (1- (point-at-bol)))
3265 (point-at-bol))
3266 e (point-at-eol)
3267 ov (make-overlay b e))
3268 (if invis1
3269 (overlay-put ov 'invisible t)
3270 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3271 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3273 (defvar org-agenda-skip-function nil
3274 "Function to be called at each match during agenda construction.
3275 If this function returns nil, the current match should not be skipped.
3276 Otherwise, the function must return a position from where the search
3277 should be continued.
3278 This may also be a Lisp form, it will be evaluated.
3279 Never set this variable using `setq' or so, because then it will apply
3280 to all future agenda commands. If you do want a global skipping condition,
3281 use the option `org-agenda-skip-function-global' instead.
3282 The correct usage for `org-agenda-skip-function' is to bind it with
3283 `let' to scope it dynamically into the agenda-constructing command.
3284 A good way to set it is through options in `org-agenda-custom-commands'.")
3286 (defun org-agenda-skip ()
3287 "Throw to `:skip' in places that should be skipped.
3288 Also moves point to the end of the skipped region, so that search can
3289 continue from there."
3290 (let ((p (point-at-bol)) to)
3291 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3292 (get-text-property p :org-archived)
3293 (org-end-of-subtree t)
3294 (throw :skip t))
3295 (and org-agenda-skip-comment-trees
3296 (get-text-property p :org-comment)
3297 (org-end-of-subtree t)
3298 (throw :skip t))
3299 (if (equal (char-after p) ?#) (throw :skip t))
3300 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3301 (org-agenda-skip-eval org-agenda-skip-function)))
3302 (goto-char to)
3303 (throw :skip t))))
3305 (defun org-agenda-skip-eval (form)
3306 "If FORM is a function or a list, call (or eval) is and return result.
3307 `save-excursion' and `save-match-data' are wrapped around the call, so point
3308 and match data are returned to the previous state no matter what these
3309 functions do."
3310 (let (fp)
3311 (and form
3312 (or (setq fp (functionp form))
3313 (consp form))
3314 (save-excursion
3315 (save-match-data
3316 (if fp
3317 (funcall form)
3318 (eval form)))))))
3320 (defvar org-agenda-markers nil
3321 "List of all currently active markers created by `org-agenda'.")
3322 (defvar org-agenda-last-marker-time (org-float-time)
3323 "Creation time of the last agenda marker.")
3325 (defun org-agenda-new-marker (&optional pos)
3326 "Return a new agenda marker.
3327 Org-mode keeps a list of these markers and resets them when they are
3328 no longer in use."
3329 (let ((m (copy-marker (or pos (point)))))
3330 (setq org-agenda-last-marker-time (org-float-time))
3331 (push m org-agenda-markers)
3334 (defun org-agenda-reset-markers ()
3335 "Reset markers created by `org-agenda'."
3336 (while org-agenda-markers
3337 (move-marker (pop org-agenda-markers) nil)))
3339 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3340 "Save relative positions of markers in region."
3341 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3342 org-agenda-markers))
3344 ;;; Entry text mode
3346 (defun org-agenda-entry-text-show-here ()
3347 "Add some text from the entry as context to the current line."
3348 (let (m txt o)
3349 (setq m (org-get-at-bol 'org-hd-marker))
3350 (unless (marker-buffer m)
3351 (error "No marker points to an entry here"))
3352 (setq txt (concat "\n" (org-no-properties
3353 (org-agenda-get-some-entry-text
3354 m org-agenda-entry-text-maxlines " > "))))
3355 (when (string-match "\\S-" txt)
3356 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3357 (overlay-put o 'evaporate t)
3358 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3359 (overlay-put o 'after-string txt))))
3361 (defun org-agenda-entry-text-show ()
3362 "Add entry context for all agenda lines."
3363 (interactive)
3364 (save-excursion
3365 (goto-char (point-max))
3366 (beginning-of-line 1)
3367 (while (not (bobp))
3368 (when (org-get-at-bol 'org-hd-marker)
3369 (org-agenda-entry-text-show-here))
3370 (beginning-of-line 0))))
3372 (defun org-agenda-entry-text-hide ()
3373 "Remove any shown entry context."
3374 (delq nil
3375 (mapcar (lambda (o)
3376 (if (eq (overlay-get o 'org-overlay-type)
3377 'agenda-entry-content)
3378 (progn (delete-overlay o) t)))
3379 (overlays-in (point-min) (point-max)))))
3381 (defun org-agenda-get-day-face (date)
3382 "Return the face DATE should be displayed with."
3383 (or (and (functionp org-agenda-day-face-function)
3384 (funcall org-agenda-day-face-function date))
3385 (cond ((org-agenda-todayp date)
3386 'org-agenda-date-today)
3387 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3388 'org-agenda-date-weekend)
3389 (t 'org-agenda-date))))
3391 ;;; Agenda timeline
3393 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3395 (defun org-timeline (&optional dotodo)
3396 "Show a time-sorted view of the entries in the current org file.
3397 Only entries with a time stamp of today or later will be listed. With
3398 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3399 under the current date.
3400 If the buffer contains an active region, only check the region for
3401 dates."
3402 (interactive "P")
3403 (org-compile-prefix-format 'timeline)
3404 (org-set-sorting-strategy 'timeline)
3405 (let* ((dopast t)
3406 (doclosed org-agenda-show-log)
3407 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3408 (current-buffer))))
3409 (date (calendar-current-date))
3410 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3411 (end (if (org-region-active-p) (region-end) (point-max)))
3412 (day-numbers (org-get-all-dates beg end 'no-ranges
3413 t doclosed ; always include today
3414 org-timeline-show-empty-dates))
3415 (org-deadline-warning-days 0)
3416 (org-agenda-only-exact-dates t)
3417 (today (org-today))
3418 (past t)
3419 args
3420 s e rtn d emptyp)
3421 (setq org-agenda-redo-command
3422 (list 'progn
3423 (list 'org-switch-to-buffer-other-window (current-buffer))
3424 (list 'org-timeline (list 'quote dotodo))))
3425 (if (not dopast)
3426 ;; Remove past dates from the list of dates.
3427 (setq day-numbers (delq nil (mapcar (lambda(x)
3428 (if (>= x today) x nil))
3429 day-numbers))))
3430 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3431 (if doclosed (push :closed args))
3432 (push :timestamp args)
3433 (push :deadline args)
3434 (push :scheduled args)
3435 (push :sexp args)
3436 (if dotodo (push :todo args))
3437 (insert "Timeline of file " entry "\n")
3438 (add-text-properties (point-min) (point)
3439 (list 'face 'org-agenda-structure))
3440 (org-agenda-mark-header-line (point-min))
3441 (while (setq d (pop day-numbers))
3442 (if (and (listp d) (eq (car d) :omitted))
3443 (progn
3444 (setq s (point))
3445 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3446 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3447 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3448 (if (and (>= d today)
3449 dopast
3450 past)
3451 (progn
3452 (setq past nil)
3453 (insert (make-string 79 ?-) "\n")))
3454 (setq date (calendar-gregorian-from-absolute d))
3455 (setq s (point))
3456 (setq rtn (and (not emptyp)
3457 (apply 'org-agenda-get-day-entries entry
3458 date args)))
3459 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3460 (progn
3461 (insert
3462 (if (stringp org-agenda-format-date)
3463 (format-time-string org-agenda-format-date
3464 (org-time-from-absolute date))
3465 (funcall org-agenda-format-date date))
3466 "\n")
3467 (put-text-property s (1- (point)) 'face
3468 (org-agenda-get-day-face date))
3469 (put-text-property s (1- (point)) 'org-date-line t)
3470 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3471 (if (equal d today)
3472 (put-text-property s (1- (point)) 'org-today t))
3473 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3474 (put-text-property s (1- (point)) 'day d)))))
3475 (goto-char (point-min))
3476 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3477 (point-min)))
3478 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3479 (org-finalize-agenda)
3480 (setq buffer-read-only t)))
3482 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3483 "Return a list of all relevant day numbers from BEG to END buffer positions.
3484 If NO-RANGES is non-nil, include only the start and end dates of a range,
3485 not every single day in the range. If FORCE-TODAY is non-nil, make
3486 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3487 inactive time stamps (those in square brackets) are included.
3488 When EMPTY is non-nil, also include days without any entries."
3489 (let ((re (concat
3490 (if pre-re pre-re "")
3491 (if inactive org-ts-regexp-both org-ts-regexp)))
3492 dates dates1 date day day1 day2 ts1 ts2 pos)
3493 (if force-today
3494 (setq dates (list (org-today))))
3495 (save-excursion
3496 (goto-char beg)
3497 (while (re-search-forward re end t)
3498 (setq day (time-to-days (org-time-string-to-time
3499 (substring (match-string 1) 0 10)
3500 (current-buffer) (match-beginning 0))))
3501 (or (memq day dates) (push day dates)))
3502 (unless no-ranges
3503 (goto-char beg)
3504 (while (re-search-forward org-tr-regexp end t)
3505 (setq pos (match-beginning 0))
3506 (setq ts1 (substring (match-string 1) 0 10)
3507 ts2 (substring (match-string 2) 0 10)
3508 day1 (time-to-days (org-time-string-to-time
3509 ts1 (current-buffer) pos))
3510 day2 (time-to-days (org-time-string-to-time
3511 ts2 (current-buffer) pos)))
3512 (while (< (setq day1 (1+ day1)) day2)
3513 (or (memq day1 dates) (push day1 dates)))))
3514 (setq dates (sort dates '<))
3515 (when empty
3516 (while (setq day (pop dates))
3517 (setq day2 (car dates))
3518 (push day dates1)
3519 (when (and day2 empty)
3520 (if (or (eq empty t)
3521 (and (numberp empty) (<= (- day2 day) empty)))
3522 (while (< (setq day (1+ day)) day2)
3523 (push (list day) dates1))
3524 (push (cons :omitted (- day2 day)) dates1))))
3525 (setq dates (nreverse dates1)))
3526 dates)))
3528 ;;; Agenda Daily/Weekly
3530 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3531 "Start day for the agenda view.
3532 Custom commands can set this variable in the options section.")
3533 (defvar org-starting-day nil) ; local variable in the agenda buffer
3534 (defvar org-agenda-current-span nil
3535 "The current span used in the agenda view.") ; local variable in the agenda buffer
3536 (defvar org-arg-loc nil) ; local variable
3538 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3539 "List of types searched for when creating the daily/weekly agenda.
3540 This variable is a list of symbols that controls the types of
3541 items that appear in the daily/weekly agenda. Allowed symbols in this
3542 list are are
3544 :timestamp List items containing a date stamp or date range matching
3545 the selected date. This includes sexp entries in
3546 angular brackets.
3548 :sexp List entries resulting from plain diary-like sexps.
3550 :deadline List deadline due on that date. When the date is today,
3551 also list any deadlines past due, or due within
3552 `org-deadline-warning-days'. `:deadline' must appear before
3553 `:scheduled' if the setting of
3554 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3555 any effect.
3557 :scheduled List all items which are scheduled for the given date.
3558 The diary for *today* also contains items which were
3559 scheduled earlier and are not yet marked DONE.
3561 By default, all four types are turned on.
3563 Never set this variable globally using `setq', because then it
3564 will apply to all future agenda commands. Instead, bind it with
3565 `let' to scope it dynamically into the agenda-constructing
3566 command. A good way to set it is through options in
3567 `org-agenda-custom-commands'. For a more flexible (though
3568 somewhat less efficient) way of determining what is included in
3569 the daily/weekly agenda, see `org-agenda-skip-function'.")
3571 ;;;###autoload
3572 (defun org-agenda-list (&optional arg start-day span)
3573 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3574 The view will be for the current day or week, but from the overview buffer
3575 you will be able to go to other days/weeks.
3577 With a numeric prefix argument in an interactive call, the agenda will
3578 span ARG days. Lisp programs should instead specify SPAN to change
3579 the number of days. SPAN defaults to `org-agenda-span'.
3581 START-DAY defaults to TODAY, or to the most recent match for the weekday
3582 given in `org-agenda-start-on-weekday'."
3583 (interactive "P")
3584 (if (and (integerp arg) (> arg 0))
3585 (setq span arg arg nil))
3586 (setq start-day (or start-day org-agenda-start-day))
3587 (if org-agenda-overriding-arguments
3588 (setq arg (car org-agenda-overriding-arguments)
3589 start-day (nth 1 org-agenda-overriding-arguments)
3590 span (nth 2 org-agenda-overriding-arguments)))
3591 (if (stringp start-day)
3592 ;; Convert to an absolute day number
3593 (setq start-day (time-to-days (org-read-date nil t start-day))))
3594 (setq org-agenda-last-arguments (list arg start-day span))
3595 (org-compile-prefix-format 'agenda)
3596 (org-set-sorting-strategy 'agenda)
3597 (let* ((span (org-agenda-ndays-to-span
3598 (or span org-agenda-ndays org-agenda-span)))
3599 (today (org-today))
3600 (sd (or start-day today))
3601 (ndays (org-agenda-span-to-ndays span sd))
3602 (org-agenda-start-on-weekday
3603 (if (eq ndays 7)
3604 org-agenda-start-on-weekday))
3605 (thefiles (org-agenda-files nil 'ifmode))
3606 (files thefiles)
3607 (start (if (or (null org-agenda-start-on-weekday)
3608 (< ndays 7))
3610 (let* ((nt (calendar-day-of-week
3611 (calendar-gregorian-from-absolute sd)))
3612 (n1 org-agenda-start-on-weekday)
3613 (d (- nt n1)))
3614 (- sd (+ (if (< d 0) 7 0) d)))))
3615 (day-numbers (list start))
3616 (day-cnt 0)
3617 (inhibit-redisplay (not debug-on-error))
3618 s e rtn rtnall file date d start-pos end-pos todayp
3619 clocktable-start clocktable-end filter)
3620 (setq org-agenda-redo-command
3621 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3622 (dotimes (n (1- ndays))
3623 (push (1+ (car day-numbers)) day-numbers))
3624 (setq day-numbers (nreverse day-numbers))
3625 (setq clocktable-start (car day-numbers)
3626 clocktable-end (1+ (or (org-last day-numbers) 0)))
3627 (org-prepare-agenda "Day/Week")
3628 (org-set-local 'org-starting-day (car day-numbers))
3629 (org-set-local 'org-arg-loc arg)
3630 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3631 (unless org-agenda-compact-blocks
3632 (let* ((d1 (car day-numbers))
3633 (d2 (org-last day-numbers))
3634 (w1 (org-days-to-iso-week d1))
3635 (w2 (org-days-to-iso-week d2)))
3636 (setq s (point))
3637 (if org-agenda-overriding-header
3638 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3639 nil 'face 'org-agenda-structure) "\n")
3640 (insert (org-agenda-span-name span)
3641 "-agenda"
3642 (if (< (- d2 d1) 350)
3643 (if (= w1 w2)
3644 (format " (W%02d)" w1)
3645 (format " (W%02d-W%02d)" w1 w2))
3647 ":\n")))
3648 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3649 'org-date-line t))
3650 (org-agenda-mark-header-line s))
3651 (while (setq d (pop day-numbers))
3652 (setq date (calendar-gregorian-from-absolute d)
3653 s (point))
3654 (if (or (setq todayp (= d today))
3655 (and (not start-pos) (= d sd)))
3656 (setq start-pos (point))
3657 (if (and start-pos (not end-pos))
3658 (setq end-pos (point))))
3659 (setq files thefiles
3660 rtnall nil)
3661 (while (setq file (pop files))
3662 (catch 'nextfile
3663 (org-check-agenda-file file)
3664 (let ((org-agenda-entry-types org-agenda-entry-types))
3665 (unless org-agenda-include-deadlines
3666 (setq org-agenda-entry-types
3667 (delq :deadline org-agenda-entry-types)))
3668 (cond
3669 ((memq org-agenda-show-log '(only clockcheck))
3670 (setq rtn (org-agenda-get-day-entries
3671 file date :closed)))
3672 (org-agenda-show-log
3673 (setq rtn (apply 'org-agenda-get-day-entries
3674 file date
3675 (append '(:closed) org-agenda-entry-types))))
3677 (setq rtn (apply 'org-agenda-get-day-entries
3678 file date
3679 org-agenda-entry-types)))))
3680 (setq rtnall (append rtnall rtn)))) ;; all entries
3681 (if org-agenda-include-diary
3682 (let ((org-agenda-search-headline-for-time t))
3683 (require 'diary-lib)
3684 (setq rtn (org-get-entries-from-diary date))
3685 (setq rtnall (append rtnall rtn))))
3686 (if (or rtnall org-agenda-show-all-dates)
3687 (progn
3688 (setq day-cnt (1+ day-cnt))
3689 (insert
3690 (if (stringp org-agenda-format-date)
3691 (format-time-string org-agenda-format-date
3692 (org-time-from-absolute date))
3693 (funcall org-agenda-format-date date))
3694 "\n")
3695 (put-text-property s (1- (point)) 'face
3696 (org-agenda-get-day-face date))
3697 (put-text-property s (1- (point)) 'org-date-line t)
3698 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3699 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3700 (when todayp
3701 (put-text-property s (1- (point)) 'org-today t))
3702 (if rtnall (insert ;; all entries
3703 (org-finalize-agenda-entries
3704 (org-agenda-add-time-grid-maybe
3705 rtnall ndays todayp))
3706 "\n"))
3707 (put-text-property s (1- (point)) 'day d)
3708 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3709 (when (and org-agenda-clockreport-mode clocktable-start)
3710 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3711 ;; the above line is to ensure the restricted range!
3712 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3713 tbl)
3714 (setq p (org-plist-delete p :block))
3715 (setq p (plist-put p :tstart clocktable-start))
3716 (setq p (plist-put p :tend clocktable-end))
3717 (setq p (plist-put p :scope 'agenda))
3718 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3719 (setq filter (or org-agenda-tag-filter-while-redo
3720 (get 'org-agenda-tag-filter :preset-filter))))
3721 (setq p (plist-put p :tags (mapconcat (lambda (x)
3722 (if (string-match "[<>=]" x)
3725 filter ""))))
3726 (setq tbl (apply 'org-get-clocktable p))
3727 (insert tbl)))
3728 (goto-char (point-min))
3729 (or org-agenda-multi (org-fit-agenda-window))
3730 (unless (and (pos-visible-in-window-p (point-min))
3731 (pos-visible-in-window-p (point-max)))
3732 (goto-char (1- (point-max)))
3733 (recenter -1)
3734 (if (not (pos-visible-in-window-p (or start-pos 1)))
3735 (progn
3736 (goto-char (or start-pos 1))
3737 (recenter 1))))
3738 (goto-char (or start-pos 1))
3739 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3740 (if (eq org-agenda-show-log 'clockcheck)
3741 (org-agenda-show-clocking-issues))
3742 (org-finalize-agenda)
3743 (setq buffer-read-only t)
3744 (message "")))
3746 (defun org-agenda-ndays-to-span (n)
3747 "Return a span symbol for a span of N days, or N if none matches."
3748 (cond ((symbolp n) n)
3749 ((= n 1) 'day)
3750 ((= n 7) 'week)
3751 (t n)))
3753 (defun org-agenda-span-to-ndays (span start-day)
3754 "Return ndays from SPAN starting at START-DAY."
3755 (cond ((numberp span) span)
3756 ((eq span 'day) 1)
3757 ((eq span 'week) 7)
3758 ((eq span 'month)
3759 (let ((date (calendar-gregorian-from-absolute start-day)))
3760 (calendar-last-day-of-month (car date) (caddr date))))
3761 ((eq span 'year)
3762 (let ((date (calendar-gregorian-from-absolute start-day)))
3763 (if (calendar-leap-year-p (caddr date)) 366 365)))))
3765 (defun org-agenda-span-name (span)
3766 "Return a SPAN name."
3767 (if (null span)
3769 (if (symbolp span)
3770 (capitalize (symbol-name span))
3771 (format "%d days" span))))
3773 ;;; Agenda word search
3775 (defvar org-agenda-search-history nil)
3776 (defvar org-todo-only nil)
3778 (defvar org-search-syntax-table nil
3779 "Special syntax table for org-mode search.
3780 In this table, we have single quotes not as word constituents, to
3781 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
3783 (defun org-search-syntax-table ()
3784 (unless org-search-syntax-table
3785 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
3786 (modify-syntax-entry ?' "." org-search-syntax-table)
3787 (modify-syntax-entry ?` "." org-search-syntax-table))
3788 org-search-syntax-table)
3790 (defvar org-agenda-last-search-view-search-was-boolean nil)
3792 ;;;###autoload
3793 (defun org-search-view (&optional todo-only string edit-at)
3794 "Show all entries that contain a phrase or words or regular expressions.
3796 With optional prefix argument TODO-ONLY, only consider entries that are
3797 TODO entries. The argument STRING can be used to pass a default search
3798 string into this function. If EDIT-AT is non-nil, it means that the
3799 user should get a chance to edit this string, with cursor at position
3800 EDIT-AT.
3802 The search string can be viewed either as a phrase that should be found as
3803 is, or it can be broken into a number of snippets, each of which must match
3804 in a Boolean way to select an entry. The default depends on the variable
3805 `org-agenda-search-view-always-boolean'.
3806 Even if this is turned off (the default) you can always switch to
3807 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
3809 The default is a direct search of the whole phrase, where each space in
3810 the search string can expand to an arbitrary amount of whitespace,
3811 including newlines.
3813 If using a Boolean search, the search string is split on whitespace and
3814 each snippet is searched separately, with logical AND to select an entry.
3815 Words prefixed with a minus must *not* occur in the entry. Words without
3816 a prefix or prefixed with a plus must occur in the entry. Matching is
3817 case-insensitive. Words are enclosed by word delimiters (i.e. they must
3818 match whole words, not parts of a word) if
3819 `org-agenda-search-view-force-full-words' is set (default is nil).
3821 Boolean search snippets enclosed by curly braces are interpreted as
3822 regular expressions that must or (when preceded with \"-\") must not
3823 match in the entry. Snippets enclosed into double quotes will be taken
3824 as a whole, to include whitespace.
3826 - If the search string starts with an asterisk, search only in headlines.
3827 - If (possibly after the leading star) the search string starts with an
3828 exclamation mark, this also means to look at TODO entries only, an effect
3829 that can also be achieved with a prefix argument.
3830 - If (possibly after star and exclamation mark) the search string starts
3831 with a colon, this will mean that the (non-regexp) snippets of the
3832 Boolean search must match as full words.
3834 This command searches the agenda files, and in addition the files listed
3835 in `org-agenda-text-search-extra-files'."
3836 (interactive "P")
3837 (org-compile-prefix-format 'search)
3838 (org-set-sorting-strategy 'search)
3839 (org-prepare-agenda "SEARCH")
3840 (let* ((props (list 'face nil
3841 'done-face 'org-agenda-done
3842 'org-not-done-regexp org-not-done-regexp
3843 'org-todo-regexp org-todo-regexp
3844 'org-complex-heading-regexp org-complex-heading-regexp
3845 'mouse-face 'highlight
3846 'help-echo (format "mouse-2 or RET jump to location")))
3847 (full-words org-agenda-search-view-force-full-words)
3848 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
3849 regexp rtn rtnall files file pos
3850 marker category org-category-pos tags c neg re boolean
3851 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
3852 (unless (and (not edit-at)
3853 (stringp string)
3854 (string-match "\\S-" string))
3855 (setq string (read-string
3856 (if org-agenda-search-view-always-boolean
3857 "[+-]Word/{Regexp} ...: "
3858 "Phrase, or [+-]Word/{Regexp} ...: ")
3859 (cond
3860 ((integerp edit-at) (cons string edit-at))
3861 (edit-at string))
3862 'org-agenda-search-history)))
3863 (org-set-local 'org-todo-only todo-only)
3864 (setq org-agenda-redo-command
3865 (list 'org-search-view (if todo-only t nil) string
3866 '(if current-prefix-arg 1 nil)))
3867 (setq org-agenda-query-string string)
3869 (if (equal (string-to-char string) ?*)
3870 (setq hdl-only t
3871 words (substring string 1))
3872 (setq words string))
3873 (when (equal (string-to-char words) ?!)
3874 (setq todo-only t
3875 words (substring words 1)))
3876 (when (equal (string-to-char words) ?:)
3877 (setq full-words t
3878 words (substring words 1)))
3879 (if (or org-agenda-search-view-always-boolean
3880 (member (string-to-char words) '(?- ?+ ?\{)))
3881 (setq boolean t))
3882 (setq words (org-split-string words))
3883 (let (www w)
3884 (while (setq w (pop words))
3885 (while (and (string-match "\\\\\\'" w) words)
3886 (setq w (concat (substring w 0 -1) " " (pop words))))
3887 (push w www))
3888 (setq words (nreverse www) www nil)
3889 (while (setq w (pop words))
3890 (when (and (string-match "\\`[-+]?{" w)
3891 (not (string-match "}\\'" w)))
3892 (while (and words (not (string-match "}\\'" (car words))))
3893 (setq w (concat w " " (pop words))))
3894 (setq w (concat w " " (pop words))))
3895 (push w www))
3896 (setq words (nreverse www)))
3897 (setq org-agenda-last-search-view-search-was-boolean boolean)
3898 (when boolean
3899 (let (wds w)
3900 (while (setq w (pop words))
3901 (if (or (equal (substring w 0 1) "\"")
3902 (and (> (length w) 1)
3903 (member (substring w 0 1) '("+" "-"))
3904 (equal (substring w 1 2) "\"")))
3905 (while (and words (not (equal (substring w -1) "\"")))
3906 (setq w (concat w " " (pop words)))))
3907 (and (string-match "\\`\\([-+]?\\)\"" w)
3908 (setq w (replace-match "\\1" nil nil w)))
3909 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
3910 (push w wds))
3911 (setq words (nreverse wds))))
3912 (if boolean
3913 (mapc (lambda (w)
3914 (setq c (string-to-char w))
3915 (if (equal c ?-)
3916 (setq neg t w (substring w 1))
3917 (if (equal c ?+)
3918 (setq neg nil w (substring w 1))
3919 (setq neg nil)))
3920 (if (string-match "\\`{.*}\\'" w)
3921 (setq re (substring w 1 -1))
3922 (if full-words
3923 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
3924 (setq re (regexp-quote (downcase w)))))
3925 (if neg (push re regexps-) (push re regexps+)))
3926 words)
3927 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
3928 regexps+))
3929 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
3930 (if (not regexps+)
3931 (setq regexp org-outline-regexp-bol)
3932 (setq regexp (pop regexps+))
3933 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
3934 regexp))))
3935 (setq files (org-agenda-files nil 'ifmode))
3936 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
3937 (pop org-agenda-text-search-extra-files)
3938 (setq files (org-add-archive-files files)))
3939 (setq files (append files org-agenda-text-search-extra-files)
3940 rtnall nil)
3941 (while (setq file (pop files))
3942 (setq ee nil)
3943 (catch 'nextfile
3944 (org-check-agenda-file file)
3945 (setq buffer (if (file-exists-p file)
3946 (org-get-agenda-file-buffer file)
3947 (error "No such file %s" file)))
3948 (if (not buffer)
3949 ;; If file does not exist, make sure an error message is sent
3950 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
3951 file))))
3952 (with-current-buffer buffer
3953 (with-syntax-table (org-search-syntax-table)
3954 (unless (eq major-mode 'org-mode)
3955 (error "Agenda file %s is not in `org-mode'" file))
3956 (let ((case-fold-search t))
3957 (save-excursion
3958 (save-restriction
3959 (if org-agenda-restrict
3960 (narrow-to-region org-agenda-restrict-begin
3961 org-agenda-restrict-end)
3962 (widen))
3963 (goto-char (point-min))
3964 (unless (or (org-at-heading-p)
3965 (outline-next-heading))
3966 (throw 'nextfile t))
3967 (goto-char (max (point-min) (1- (point))))
3968 (while (re-search-forward regexp nil t)
3969 (org-back-to-heading t)
3970 (skip-chars-forward "* ")
3971 (setq beg (point-at-bol)
3972 beg1 (point)
3973 end (progn (outline-next-heading) (point)))
3974 (catch :skip
3975 (goto-char beg)
3976 (org-agenda-skip)
3977 (setq str (buffer-substring-no-properties
3978 (point-at-bol)
3979 (if hdl-only (point-at-eol) end)))
3980 (mapc (lambda (wr) (when (string-match wr str)
3981 (goto-char (1- end))
3982 (throw :skip t)))
3983 regexps-)
3984 (mapc (lambda (wr) (unless (string-match wr str)
3985 (goto-char (1- end))
3986 (throw :skip t)))
3987 (if todo-only
3988 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
3989 regexps+)
3990 regexps+))
3991 (goto-char beg)
3992 (setq marker (org-agenda-new-marker (point))
3993 category (org-get-category)
3994 org-category-pos (get-text-property (point) 'org-category-position)
3995 tags (org-get-tags-at (point))
3996 txt (org-agenda-format-item
3998 (buffer-substring-no-properties
3999 beg1 (point-at-eol))
4000 category tags))
4001 (org-add-props txt props
4002 'org-marker marker 'org-hd-marker marker
4003 'org-todo-regexp org-todo-regexp
4004 'org-complex-heading-regexp org-complex-heading-regexp
4005 'priority 1000 'org-category category
4006 'org-category-position org-category-pos
4007 'type "search")
4008 (push txt ee)
4009 (goto-char (1- end))))))))))
4010 (setq rtn (nreverse ee))
4011 (setq rtnall (append rtnall rtn)))
4012 (if org-agenda-overriding-header
4013 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4014 nil 'face 'org-agenda-structure) "\n")
4015 (insert "Search words: ")
4016 (add-text-properties (point-min) (1- (point))
4017 (list 'face 'org-agenda-structure))
4018 (setq pos (point))
4019 (insert string "\n")
4020 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4021 (setq pos (point))
4022 (unless org-agenda-multi
4023 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4024 (add-text-properties pos (1- (point))
4025 (list 'face 'org-agenda-structure))))
4026 (org-agenda-mark-header-line (point-min))
4027 (when rtnall
4028 (insert (org-finalize-agenda-entries rtnall) "\n"))
4029 (goto-char (point-min))
4030 (or org-agenda-multi (org-fit-agenda-window))
4031 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4032 (org-finalize-agenda)
4033 (setq buffer-read-only t)))
4035 ;;; Agenda TODO list
4037 (defvar org-select-this-todo-keyword nil)
4038 (defvar org-last-arg nil)
4040 ;;;###autoload
4041 (defun org-todo-list (arg)
4042 "Show all (not done) TODO entries from all agenda file in a single list.
4043 The prefix arg can be used to select a specific TODO keyword and limit
4044 the list to these. When using \\[universal-argument], you will be prompted
4045 for a keyword. A numeric prefix directly selects the Nth keyword in
4046 `org-todo-keywords-1'."
4047 (interactive "P")
4048 (org-compile-prefix-format 'todo)
4049 (org-set-sorting-strategy 'todo)
4050 (org-prepare-agenda "TODO")
4051 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4052 (let* ((today (org-today))
4053 (date (calendar-gregorian-from-absolute today))
4054 (kwds org-todo-keywords-for-agenda)
4055 (completion-ignore-case t)
4056 (org-select-this-todo-keyword
4057 (if (stringp arg) arg
4058 (and arg (integerp arg) (> arg 0)
4059 (nth (1- arg) kwds))))
4060 rtn rtnall files file pos)
4061 (when (equal arg '(4))
4062 (setq org-select-this-todo-keyword
4063 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4064 (mapcar 'list kwds) nil nil)))
4065 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4066 (org-set-local 'org-last-arg arg)
4067 (setq org-agenda-redo-command
4068 '(org-todo-list (or current-prefix-arg org-last-arg)))
4069 (setq files (org-agenda-files nil 'ifmode)
4070 rtnall nil)
4071 (while (setq file (pop files))
4072 (catch 'nextfile
4073 (org-check-agenda-file file)
4074 (setq rtn (org-agenda-get-day-entries file date :todo))
4075 (setq rtnall (append rtnall rtn))))
4076 (if org-agenda-overriding-header
4077 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4078 nil 'face 'org-agenda-structure) "\n")
4079 (insert "Global list of TODO items of type: ")
4080 (add-text-properties (point-min) (1- (point))
4081 (list 'face 'org-agenda-structure
4082 'short-heading
4083 (concat "ToDo: "
4084 (or org-select-this-todo-keyword "ALL"))))
4085 (org-agenda-mark-header-line (point-min))
4086 (setq pos (point))
4087 (insert (or org-select-this-todo-keyword "ALL") "\n")
4088 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4089 (setq pos (point))
4090 (unless org-agenda-multi
4091 (insert "Available with `N r': (0)ALL")
4092 (let ((n 0) s)
4093 (mapc (lambda (x)
4094 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4095 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4096 (insert "\n "))
4097 (insert " " s))
4098 kwds))
4099 (insert "\n"))
4100 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4101 (org-agenda-mark-header-line (point-min))
4102 (when rtnall
4103 (insert (org-finalize-agenda-entries rtnall) "\n"))
4104 (goto-char (point-min))
4105 (or org-agenda-multi (org-fit-agenda-window))
4106 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4107 (org-finalize-agenda)
4108 (setq buffer-read-only t)))
4110 ;;; Agenda tags match
4112 ;;;###autoload
4113 (defun org-tags-view (&optional todo-only match)
4114 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4115 The prefix arg TODO-ONLY limits the search to TODO entries."
4116 (interactive "P")
4117 (org-compile-prefix-format 'tags)
4118 (org-set-sorting-strategy 'tags)
4119 (let* ((org-tags-match-list-sublevels
4120 org-tags-match-list-sublevels)
4121 (completion-ignore-case t)
4122 rtn rtnall files file pos matcher
4123 buffer)
4124 (when (and (stringp match) (not (string-match "\\S-" match)))
4125 (setq match nil))
4126 (setq matcher (org-make-tags-matcher match)
4127 match (car matcher) matcher (cdr matcher))
4128 (org-prepare-agenda (concat "TAGS " match))
4129 (setq org-agenda-query-string match)
4130 (setq org-agenda-redo-command
4131 (list 'org-tags-view (list 'quote todo-only)
4132 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4133 (setq files (org-agenda-files nil 'ifmode)
4134 rtnall nil)
4135 (while (setq file (pop files))
4136 (catch 'nextfile
4137 (org-check-agenda-file file)
4138 (setq buffer (if (file-exists-p file)
4139 (org-get-agenda-file-buffer file)
4140 (error "No such file %s" file)))
4141 (if (not buffer)
4142 ;; If file does not exist, error message to agenda
4143 (setq rtn (list
4144 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4145 rtnall (append rtnall rtn))
4146 (with-current-buffer buffer
4147 (unless (eq major-mode 'org-mode)
4148 (error "Agenda file %s is not in `org-mode'" file))
4149 (save-excursion
4150 (save-restriction
4151 (if org-agenda-restrict
4152 (narrow-to-region org-agenda-restrict-begin
4153 org-agenda-restrict-end)
4154 (widen))
4155 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4156 (setq rtnall (append rtnall rtn))))))))
4157 (if org-agenda-overriding-header
4158 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4159 nil 'face 'org-agenda-structure) "\n")
4160 (insert "Headlines with TAGS match: ")
4161 (add-text-properties (point-min) (1- (point))
4162 (list 'face 'org-agenda-structure
4163 'short-heading
4164 (concat "Match: " match)))
4165 (setq pos (point))
4166 (insert match "\n")
4167 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4168 (setq pos (point))
4169 (unless org-agenda-multi
4170 (insert "Press `C-u r' to search again with new search string\n"))
4171 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4172 (org-agenda-mark-header-line (point-min))
4173 (when rtnall
4174 (insert (org-finalize-agenda-entries rtnall) "\n"))
4175 (goto-char (point-min))
4176 (or org-agenda-multi (org-fit-agenda-window))
4177 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4178 (org-finalize-agenda)
4179 (setq buffer-read-only t)))
4181 ;;; Agenda Finding stuck projects
4183 (defvar org-agenda-skip-regexp nil
4184 "Regular expression used in skipping subtrees for the agenda.
4185 This is basically a temporary global variable that can be set and then
4186 used by user-defined selections using `org-agenda-skip-function'.")
4188 (defvar org-agenda-overriding-header nil
4189 "When set during agenda, todo and tags searches it replaces the header.
4190 This variable should not be set directly, but custom commands can bind it
4191 in the options section.")
4193 (defun org-agenda-skip-entry-when-regexp-matches ()
4194 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4195 If yes, it returns the end position of this entry, causing agenda commands
4196 to skip the entry but continuing the search in the subtree. This is a
4197 function that can be put into `org-agenda-skip-function' for the duration
4198 of a command."
4199 (let ((end (save-excursion (org-end-of-subtree t)))
4200 skip)
4201 (save-excursion
4202 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4203 (and skip end)))
4205 (defun org-agenda-skip-subtree-when-regexp-matches ()
4206 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4207 If yes, it returns the end position of this tree, causing agenda commands
4208 to skip this subtree. This is a function that can be put into
4209 `org-agenda-skip-function' for the duration of a command."
4210 (let ((end (save-excursion (org-end-of-subtree t)))
4211 skip)
4212 (save-excursion
4213 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4214 (and skip end)))
4216 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4217 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4218 If yes, it returns the end position of the current entry (NOT the tree),
4219 causing agenda commands to skip the entry but continuing the search in
4220 the subtree. This is a function that can be put into
4221 `org-agenda-skip-function' for the duration of a command. An important
4222 use of this function is for the stuck project list."
4223 (let ((end (save-excursion (org-end-of-subtree t)))
4224 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4225 skip)
4226 (save-excursion
4227 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4228 (and skip entry-end)))
4230 (defun org-agenda-skip-entry-if (&rest conditions)
4231 "Skip entry if any of CONDITIONS is true.
4232 See `org-agenda-skip-if' for details."
4233 (org-agenda-skip-if nil conditions))
4235 (defun org-agenda-skip-subtree-if (&rest conditions)
4236 "Skip entry if any of CONDITIONS is true.
4237 See `org-agenda-skip-if' for details."
4238 (org-agenda-skip-if t conditions))
4240 (defun org-agenda-skip-if (subtree conditions)
4241 "Checks current entity for CONDITIONS.
4242 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4243 the entry, i.e. the text before the next heading is checked.
4245 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4246 from different tests. Valid conditions are:
4248 scheduled Check if there is a scheduled cookie
4249 notscheduled Check if there is no scheduled cookie
4250 deadline Check if there is a deadline
4251 notdeadline Check if there is no deadline
4252 timestamp Check if there is a timestamp (also deadline or scheduled)
4253 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4254 regexp Check if regexp matches
4255 notregexp Check if regexp does not match.
4256 todo Check if TODO keyword matches
4257 nottodo Check if TODO keyword does not match
4259 The regexp is taken from the conditions list, it must come right after
4260 the `regexp' or `notregexp' element.
4262 `todo' and `nottodo' accept as an argument a list of todo
4263 keywords, which may include \"*\" to match any todo keyword.
4265 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4267 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4269 Instead of a list a keyword class may be given
4271 (org-agenda-skip-entry-if 'nottodo 'done)
4273 would skip entries that haven't been marked with any of \"DONE\"
4274 keywords. Possible classes are: `todo', `done', `any'.
4276 If any of these conditions is met, this function returns the end point of
4277 the entity, causing the search to continue from there. This is a function
4278 that can be put into `org-agenda-skip-function' for the duration of a command."
4279 (let (beg end m)
4280 (org-back-to-heading t)
4281 (setq beg (point)
4282 end (if subtree
4283 (progn (org-end-of-subtree t) (point))
4284 (progn (outline-next-heading) (1- (point)))))
4285 (goto-char beg)
4286 (and
4288 (and (memq 'scheduled conditions)
4289 (re-search-forward org-scheduled-time-regexp end t))
4290 (and (memq 'notscheduled conditions)
4291 (not (re-search-forward org-scheduled-time-regexp end t)))
4292 (and (memq 'deadline conditions)
4293 (re-search-forward org-deadline-time-regexp end t))
4294 (and (memq 'notdeadline conditions)
4295 (not (re-search-forward org-deadline-time-regexp end t)))
4296 (and (memq 'timestamp conditions)
4297 (re-search-forward org-ts-regexp end t))
4298 (and (memq 'nottimestamp conditions)
4299 (not (re-search-forward org-ts-regexp end t)))
4300 (and (setq m (memq 'regexp conditions))
4301 (stringp (nth 1 m))
4302 (re-search-forward (nth 1 m) end t))
4303 (and (setq m (memq 'notregexp conditions))
4304 (stringp (nth 1 m))
4305 (not (re-search-forward (nth 1 m) end t)))
4306 (and (or
4307 (setq m (memq 'todo conditions))
4308 (setq m (memq 'nottodo conditions)))
4309 (org-agenda-skip-if-todo m end)))
4310 end)))
4312 (defun org-agenda-skip-if-todo (args end)
4313 "Helper function for `org-agenda-skip-if', do not use it directly.
4314 ARGS is a list with first element either `todo' or `nottodo'.
4315 The remainder is either a list of TODO keywords, or a state symbol
4316 `todo' or `done' or `any'."
4317 (let ((kw (car args))
4318 (arg (cadr args))
4319 todo-wds todo-re)
4320 (setq todo-wds
4321 (org-uniquify
4322 (cond
4323 ((listp arg) ;; list of keywords
4324 (if (member "*" arg)
4325 (mapcar 'substring-no-properties org-todo-keywords-1)
4326 arg))
4327 ((symbolp arg) ;; keyword class name
4328 (cond
4329 ((eq arg 'todo)
4330 (org-delete-all org-done-keywords
4331 (mapcar 'substring-no-properties
4332 org-todo-keywords-1)))
4333 ((eq arg 'done) org-done-keywords)
4334 ((eq arg 'any)
4335 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4336 (setq todo-re
4337 (concat "^\\*+[ \t]+\\<\\("
4338 (mapconcat 'identity todo-wds "\\|")
4339 "\\)\\>"))
4340 (if (eq kw 'todo)
4341 (re-search-forward todo-re end t)
4342 (not (re-search-forward todo-re end t)))))
4344 ;;;###autoload
4345 (defun org-agenda-list-stuck-projects (&rest ignore)
4346 "Create agenda view for projects that are stuck.
4347 Stuck projects are project that have no next actions. For the definitions
4348 of what a project is and how to check if it stuck, customize the variable
4349 `org-stuck-projects'."
4350 (interactive)
4351 (let* ((org-agenda-skip-function
4352 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4353 ;; We could have used org-agenda-skip-if here.
4354 (org-agenda-overriding-header
4355 (or org-agenda-overriding-header "List of stuck projects: "))
4356 (matcher (nth 0 org-stuck-projects))
4357 (todo (nth 1 org-stuck-projects))
4358 (todo-wds (if (member "*" todo)
4359 (progn
4360 (org-prepare-agenda-buffers (org-agenda-files
4361 nil 'ifmode))
4362 (org-delete-all
4363 org-done-keywords-for-agenda
4364 (copy-sequence org-todo-keywords-for-agenda)))
4365 todo))
4366 (todo-re (concat "^\\*+[ \t]+\\("
4367 (mapconcat 'identity todo-wds "\\|")
4368 "\\)\\>"))
4369 (tags (nth 2 org-stuck-projects))
4370 (tags-re (if (member "*" tags)
4371 (concat org-outline-regexp-bol
4372 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4373 (if tags
4374 (concat org-outline-regexp-bol
4375 ".*:\\("
4376 (mapconcat 'identity tags "\\|")
4377 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4378 (gen-re (nth 3 org-stuck-projects))
4379 (re-list
4380 (delq nil
4381 (list
4382 (if todo todo-re)
4383 (if tags tags-re)
4384 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4385 gen-re)))))
4386 (setq org-agenda-skip-regexp
4387 (if re-list
4388 (mapconcat 'identity re-list "\\|")
4389 (error "No information how to identify unstuck projects")))
4390 (org-tags-view nil matcher)
4391 (with-current-buffer org-agenda-buffer-name
4392 (setq org-agenda-redo-command
4393 '(org-agenda-list-stuck-projects
4394 (or current-prefix-arg org-last-arg))))))
4396 ;;; Diary integration
4398 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4399 (defvar diary-list-entries-hook)
4400 (defvar diary-time-regexp)
4401 (defun org-get-entries-from-diary (date)
4402 "Get the (Emacs Calendar) diary entries for DATE."
4403 (require 'diary-lib)
4404 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4405 (diary-display-hook '(fancy-diary-display))
4406 (diary-display-function 'fancy-diary-display)
4407 (pop-up-frames nil)
4408 (diary-list-entries-hook
4409 (cons 'org-diary-default-entry diary-list-entries-hook))
4410 (diary-file-name-prefix-function nil) ; turn this feature off
4411 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4412 entries
4413 (org-disable-agenda-to-diary t))
4414 (save-excursion
4415 (save-window-excursion
4416 (funcall (if (fboundp 'diary-list-entries)
4417 'diary-list-entries 'list-diary-entries)
4418 date 1)))
4419 (if (not (get-buffer diary-fancy-buffer))
4420 (setq entries nil)
4421 (with-current-buffer diary-fancy-buffer
4422 (setq buffer-read-only nil)
4423 (if (zerop (buffer-size))
4424 ;; No entries
4425 (setq entries nil)
4426 ;; Omit the date and other unnecessary stuff
4427 (org-agenda-cleanup-fancy-diary)
4428 ;; Add prefix to each line and extend the text properties
4429 (if (zerop (buffer-size))
4430 (setq entries nil)
4431 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4432 (setq entries
4433 (with-temp-buffer
4434 (insert entries) (goto-char (point-min))
4435 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4436 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4437 (replace-match (concat "; " (match-string 1)))))
4438 (buffer-string)))))
4439 (set-buffer-modified-p nil)
4440 (kill-buffer diary-fancy-buffer)))
4441 (when entries
4442 (setq entries (org-split-string entries "\n"))
4443 (setq entries
4444 (mapcar
4445 (lambda (x)
4446 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4447 ;; Extend the text properties to the beginning of the line
4448 (org-add-props x (text-properties-at (1- (length x)) x)
4449 'type "diary" 'date date 'face 'org-agenda-diary))
4450 entries)))))
4452 (defvar org-agenda-cleanup-fancy-diary-hook nil
4453 "Hook run when the fancy diary buffer is cleaned up.")
4455 (defun org-agenda-cleanup-fancy-diary ()
4456 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4457 This gets rid of the date, the underline under the date, and
4458 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4459 date. It also removes lines that contain only whitespace."
4460 (goto-char (point-min))
4461 (if (looking-at ".*?:[ \t]*")
4462 (progn
4463 (replace-match "")
4464 (re-search-forward "\n=+$" nil t)
4465 (replace-match "")
4466 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4467 (re-search-forward "\n=+$" nil t)
4468 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4469 (goto-char (point-min))
4470 (while (re-search-forward "^ +\n" nil t)
4471 (replace-match ""))
4472 (goto-char (point-min))
4473 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4474 (replace-match ""))
4475 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4477 ;; Make sure entries from the diary have the right text properties.
4478 (eval-after-load "diary-lib"
4479 '(if (boundp 'diary-modify-entry-list-string-function)
4480 ;; We can rely on the hook, nothing to do
4482 ;; Hook not available, must use advice to make this work
4483 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4484 "Make the position visible."
4485 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4486 (stringp string)
4487 buffer-file-name)
4488 (setq string (org-modify-diary-entry-string string))))))
4490 (defun org-modify-diary-entry-string (string)
4491 "Add text properties to string, allowing org-mode to act on it."
4492 (org-add-props string nil
4493 'mouse-face 'highlight
4494 'help-echo (if buffer-file-name
4495 (format "mouse-2 or RET jump to diary file %s"
4496 (abbreviate-file-name buffer-file-name))
4498 'org-agenda-diary-link t
4499 'org-marker (org-agenda-new-marker (point-at-bol))))
4501 (defun org-diary-default-entry ()
4502 "Add a dummy entry to the diary.
4503 Needed to avoid empty dates which mess up holiday display."
4504 ;; Catch the error if dealing with the new add-to-diary-alist
4505 (when org-disable-agenda-to-diary
4506 (condition-case nil
4507 (org-add-to-diary-list original-date "Org-mode dummy" "")
4508 (error
4509 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4511 (defun org-add-to-diary-list (&rest args)
4512 (if (fboundp 'diary-add-to-list)
4513 (apply 'diary-add-to-list args)
4514 (apply 'add-to-diary-list args)))
4516 (defvar org-diary-last-run-time nil)
4518 ;;;###autoload
4519 (defun org-diary (&rest args)
4520 "Return diary information from org-files.
4521 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4522 It accesses org files and extracts information from those files to be
4523 listed in the diary. The function accepts arguments specifying what
4524 items should be listed. For a list of arguments allowed here, see the
4525 variable `org-agenda-entry-types'.
4527 The call in the diary file should look like this:
4529 &%%(org-diary) ~/path/to/some/orgfile.org
4531 Use a separate line for each org file to check. Or, if you omit the file name,
4532 all files listed in `org-agenda-files' will be checked automatically:
4534 &%%(org-diary)
4536 If you don't give any arguments (as in the example above), the default
4537 arguments (:deadline :scheduled :timestamp :sexp) are used.
4538 So the example above may also be written as
4540 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4542 The function expects the lisp variables `entry' and `date' to be provided
4543 by the caller, because this is how the calendar works. Don't use this
4544 function from a program - use `org-agenda-get-day-entries' instead."
4545 (when (> (- (org-float-time)
4546 org-agenda-last-marker-time)
4548 (org-agenda-reset-markers))
4549 (org-compile-prefix-format 'agenda)
4550 (org-set-sorting-strategy 'agenda)
4551 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4552 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4553 (list entry)
4554 (org-agenda-files t)))
4555 (time (org-float-time))
4556 file rtn results)
4557 (when (or (not org-diary-last-run-time)
4558 (> (- time
4559 org-diary-last-run-time)
4561 (org-prepare-agenda-buffers files))
4562 (setq org-diary-last-run-time time)
4563 ;; If this is called during org-agenda, don't return any entries to
4564 ;; the calendar. Org Agenda will list these entries itself.
4565 (if org-disable-agenda-to-diary (setq files nil))
4566 (while (setq file (pop files))
4567 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4568 (setq results (append results rtn)))
4569 (if results
4570 (concat (org-finalize-agenda-entries results) "\n"))))
4572 ;;; Agenda entry finders
4574 (defun org-agenda-get-day-entries (file date &rest args)
4575 "Does the work for `org-diary' and `org-agenda'.
4576 FILE is the path to a file to be checked for entries. DATE is date like
4577 the one returned by `calendar-current-date'. ARGS are symbols indicating
4578 which kind of entries should be extracted. For details about these, see
4579 the documentation of `org-diary'."
4580 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4581 (let* ((org-startup-folded nil)
4582 (org-startup-align-all-tables nil)
4583 (buffer (if (file-exists-p file)
4584 (org-get-agenda-file-buffer file)
4585 (error "No such file %s" file)))
4586 arg results rtn deadline-results)
4587 (if (not buffer)
4588 ;; If file does not exist, make sure an error message ends up in diary
4589 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4590 (with-current-buffer buffer
4591 (unless (eq major-mode 'org-mode)
4592 (error "Agenda file %s is not in `org-mode'" file))
4593 (let ((case-fold-search nil))
4594 (save-excursion
4595 (save-restriction
4596 (if org-agenda-restrict
4597 (narrow-to-region org-agenda-restrict-begin
4598 org-agenda-restrict-end)
4599 (widen))
4600 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4601 (while (setq arg (pop args))
4602 (cond
4603 ((and (eq arg :todo)
4604 (equal date (calendar-gregorian-from-absolute
4605 (org-today))))
4606 (setq rtn (org-agenda-get-todos))
4607 (setq results (append results rtn)))
4608 ((eq arg :timestamp)
4609 (setq rtn (org-agenda-get-blocks))
4610 (setq results (append results rtn))
4611 (setq rtn (org-agenda-get-timestamps))
4612 (setq results (append results rtn)))
4613 ((eq arg :sexp)
4614 (setq rtn (org-agenda-get-sexps))
4615 (setq results (append results rtn)))
4616 ((eq arg :scheduled)
4617 (setq rtn (org-agenda-get-scheduled deadline-results))
4618 (setq results (append results rtn)))
4619 ((eq arg :closed)
4620 (setq rtn (org-agenda-get-progress))
4621 (setq results (append results rtn)))
4622 ((eq arg :deadline)
4623 (setq rtn (org-agenda-get-deadlines))
4624 (setq deadline-results (copy-sequence rtn))
4625 (setq results (append results rtn))))))))
4626 results))))
4628 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4629 (defun org-agenda-get-todos ()
4630 "Return the TODO information for agenda display."
4631 (let* ((props (list 'face nil
4632 'done-face 'org-agenda-done
4633 'org-not-done-regexp org-not-done-regexp
4634 'org-todo-regexp org-todo-regexp
4635 'org-complex-heading-regexp org-complex-heading-regexp
4636 'mouse-face 'highlight
4637 'help-echo
4638 (format "mouse-2 or RET jump to org file %s"
4639 (abbreviate-file-name buffer-file-name))))
4640 (regexp (format org-heading-keyword-regexp-format
4641 (cond
4642 ((and org-select-this-todo-keyword
4643 (equal org-select-this-todo-keyword "*"))
4644 org-todo-regexp)
4645 (org-select-this-todo-keyword
4646 (concat "\\("
4647 (mapconcat 'identity
4648 (org-split-string
4649 org-select-this-todo-keyword
4650 "|")
4651 "\\|") "\\)"))
4652 (t org-not-done-regexp))))
4653 marker priority category org-category-pos tags todo-state
4654 ee txt beg end)
4655 (goto-char (point-min))
4656 (while (re-search-forward regexp nil t)
4657 (catch :skip
4658 (save-match-data
4659 (beginning-of-line)
4660 (org-agenda-skip)
4661 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4662 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4663 (goto-char (1+ beg))
4664 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4665 (throw :skip nil)))
4666 (goto-char (match-beginning 2))
4667 (setq marker (org-agenda-new-marker (match-beginning 0))
4668 category (org-get-category)
4669 org-category-pos (get-text-property (point) 'org-category-position)
4670 txt (org-trim
4671 (buffer-substring (match-beginning 2) (match-end 0)))
4672 tags (org-get-tags-at (point))
4673 txt (org-agenda-format-item "" txt category tags)
4674 priority (1+ (org-get-priority txt))
4675 todo-state (org-get-todo-state))
4676 (org-add-props txt props
4677 'org-marker marker 'org-hd-marker marker
4678 'priority priority 'org-category category
4679 'org-category-position org-category-pos
4680 'type "todo" 'todo-state todo-state)
4681 (push txt ee)
4682 (if org-agenda-todo-list-sublevels
4683 (goto-char (match-end 2))
4684 (org-end-of-subtree 'invisible))))
4685 (nreverse ee)))
4687 (defun org-agenda-todo-custom-ignore-p (time n)
4688 "Check whether timestamp is farther away then n number of days.
4689 This function is invoked if `org-agenda-todo-ignore-deadlines',
4690 `org-agenda-todo-ignore-scheduled' or
4691 `org-agenda-todo-ignore-timestamp' is set to an integer."
4692 (let ((days (org-days-to-time time)))
4693 (if (>= n 0)
4694 (>= days n)
4695 (<= days n))))
4697 ;;;###autoload
4698 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4699 (&optional end)
4700 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4701 (when (or org-agenda-todo-ignore-with-date
4702 org-agenda-todo-ignore-scheduled
4703 org-agenda-todo-ignore-deadlines
4704 org-agenda-todo-ignore-timestamp)
4705 (setq end (or end (save-excursion (outline-next-heading) (point))))
4706 (save-excursion
4707 (or (and org-agenda-todo-ignore-with-date
4708 (re-search-forward org-ts-regexp end t))
4709 (and org-agenda-todo-ignore-scheduled
4710 (re-search-forward org-scheduled-time-regexp end t)
4711 (cond
4712 ((eq org-agenda-todo-ignore-scheduled 'future)
4713 (> (org-days-to-time (match-string 1)) 0))
4714 ((eq org-agenda-todo-ignore-scheduled 'past)
4715 (<= (org-days-to-time (match-string 1)) 0))
4716 ((numberp org-agenda-todo-ignore-scheduled)
4717 (org-agenda-todo-custom-ignore-p
4718 (match-string 1) org-agenda-todo-ignore-scheduled))
4719 (t)))
4720 (and org-agenda-todo-ignore-deadlines
4721 (re-search-forward org-deadline-time-regexp end t)
4722 (cond
4723 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4724 ((eq org-agenda-todo-ignore-deadlines 'far)
4725 (not (org-deadline-close (match-string 1))))
4726 ((eq org-agenda-todo-ignore-deadlines 'future)
4727 (> (org-days-to-time (match-string 1)) 0))
4728 ((eq org-agenda-todo-ignore-deadlines 'past)
4729 (<= (org-days-to-time (match-string 1)) 0))
4730 ((numberp org-agenda-todo-ignore-deadlines)
4731 (org-agenda-todo-custom-ignore-p
4732 (match-string 1) org-agenda-todo-ignore-deadlines))
4733 (t (org-deadline-close (match-string 1)))))
4734 (and org-agenda-todo-ignore-timestamp
4735 (let ((buffer (current-buffer))
4736 (regexp
4737 (concat
4738 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
4739 (start (point)))
4740 ;; Copy current buffer into a temporary one
4741 (with-temp-buffer
4742 (insert-buffer-substring buffer start end)
4743 (goto-char (point-min))
4744 ;; Delete SCHEDULED and DEADLINE items
4745 (while (re-search-forward regexp end t)
4746 (delete-region (match-beginning 0) (match-end 0)))
4747 (goto-char (point-min))
4748 ;; No search for timestamp left
4749 (when (re-search-forward org-ts-regexp nil t)
4750 (cond
4751 ((eq org-agenda-todo-ignore-timestamp 'future)
4752 (> (org-days-to-time (match-string 1)) 0))
4753 ((eq org-agenda-todo-ignore-timestamp 'past)
4754 (<= (org-days-to-time (match-string 1)) 0))
4755 ((numberp org-agenda-todo-ignore-timestamp)
4756 (org-agenda-todo-custom-ignore-p
4757 (match-string 1) org-agenda-todo-ignore-timestamp))
4758 (t))))))))))
4760 (defconst org-agenda-no-heading-message
4761 "No heading for this item in buffer or region.")
4763 (defun org-agenda-get-timestamps ()
4764 "Return the date stamp information for agenda display."
4765 (let* ((props (list 'face 'org-agenda-calendar-event
4766 'org-not-done-regexp org-not-done-regexp
4767 'org-todo-regexp org-todo-regexp
4768 'org-complex-heading-regexp org-complex-heading-regexp
4769 'mouse-face 'highlight
4770 'help-echo
4771 (format "mouse-2 or RET jump to org file %s"
4772 (abbreviate-file-name buffer-file-name))))
4773 (d1 (calendar-absolute-from-gregorian date))
4774 (remove-re
4775 (concat
4776 (regexp-quote
4777 (format-time-string
4778 "<%Y-%m-%d"
4779 (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
4780 ".*?>"))
4781 (regexp
4782 (concat
4783 (if org-agenda-include-inactive-timestamps "[[<]" "<")
4784 (regexp-quote
4785 (substring
4786 (format-time-string
4787 (car org-time-stamp-formats)
4788 (apply 'encode-time ; DATE bound by calendar
4789 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
4790 1 11))
4791 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
4792 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
4793 marker hdmarker deadlinep scheduledp clockp closedp inactivep
4794 donep tmp priority category org-category-pos ee txt timestr tags
4795 b0 b3 e3 head todo-state end-of-match show-all)
4796 (goto-char (point-min))
4797 (while (setq end-of-match (re-search-forward regexp nil t))
4798 (setq b0 (match-beginning 0)
4799 b3 (match-beginning 3) e3 (match-end 3)
4800 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
4801 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
4802 (member todo-state
4803 org-agenda-repeating-timestamp-show-all)))
4804 (catch :skip
4805 (and (org-at-date-range-p) (throw :skip nil))
4806 (org-agenda-skip)
4807 (if (and (match-end 1)
4808 (not (= d1 (org-time-string-to-absolute
4809 (match-string 1) d1 nil show-all
4810 (current-buffer) b0))))
4811 (throw :skip nil))
4812 (if (and e3
4813 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
4814 (throw :skip nil))
4815 (setq tmp (buffer-substring (max (point-min)
4816 (- b0 org-ds-keyword-length))
4818 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
4819 inactivep (= (char-after b0) ?\[)
4820 deadlinep (string-match org-deadline-regexp tmp)
4821 scheduledp (string-match org-scheduled-regexp tmp)
4822 closedp (and org-agenda-include-inactive-timestamps
4823 (string-match org-closed-string tmp))
4824 clockp (and org-agenda-include-inactive-timestamps
4825 (or (string-match org-clock-string tmp)
4826 (string-match "]-+\\'" tmp)))
4827 donep (member todo-state org-done-keywords))
4828 (if (or scheduledp deadlinep closedp clockp
4829 (and donep org-agenda-skip-timestamp-if-done))
4830 (throw :skip t))
4831 (if (string-match ">" timestr)
4832 ;; substring should only run to end of time stamp
4833 (setq timestr (substring timestr 0 (match-end 0))))
4834 (setq marker (org-agenda-new-marker b0)
4835 category (org-get-category b0)
4836 org-category-pos (get-text-property b0 'org-category-position))
4837 (save-excursion
4838 (if (not (re-search-backward org-outline-regexp-bol nil t))
4839 (setq txt org-agenda-no-heading-message)
4840 (goto-char (match-beginning 0))
4841 (setq hdmarker (org-agenda-new-marker)
4842 tags (org-get-tags-at))
4843 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
4844 (setq head (or (match-string 1) ""))
4845 (setq txt (org-agenda-format-item
4846 (if inactivep org-agenda-inactive-leader nil)
4847 head category tags timestr
4848 remove-re)))
4849 (setq priority (org-get-priority txt))
4850 (org-add-props txt props
4851 'org-marker marker 'org-hd-marker hdmarker)
4852 (org-add-props txt nil 'priority priority
4853 'org-category category 'date date
4854 'org-category-position org-category-pos
4855 'todo-state todo-state
4856 'type "timestamp")
4857 (push txt ee))
4858 (if org-agenda-skip-additional-timestamps-same-entry
4859 (outline-next-heading)
4860 (goto-char end-of-match))))
4861 (nreverse ee)))
4863 (defun org-agenda-get-sexps ()
4864 "Return the sexp information for agenda display."
4865 (require 'diary-lib)
4866 (let* ((props (list 'face 'org-agenda-calendar-sexp
4867 'mouse-face 'highlight
4868 'help-echo
4869 (format "mouse-2 or RET jump to org file %s"
4870 (abbreviate-file-name buffer-file-name))))
4871 (regexp "^&?%%(")
4872 marker category org-category-pos ee txt tags entry
4873 result beg b sexp sexp-entry todo-state)
4874 (goto-char (point-min))
4875 (while (re-search-forward regexp nil t)
4876 (catch :skip
4877 (org-agenda-skip)
4878 (setq beg (match-beginning 0))
4879 (goto-char (1- (match-end 0)))
4880 (setq b (point))
4881 (forward-sexp 1)
4882 (setq sexp (buffer-substring b (point)))
4883 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
4884 (org-trim (match-string 1))
4885 ""))
4886 (setq result (org-diary-sexp-entry sexp sexp-entry date))
4887 (when result
4888 (setq marker (org-agenda-new-marker beg)
4889 category (org-get-category beg)
4890 org-category-pos (get-text-property beg 'org-category-position)
4891 todo-state (org-get-todo-state))
4893 (dolist (r (if (stringp result)
4894 (list result)
4895 result)) ;; we expect a list here
4896 (if (string-match "\\S-" r)
4897 (setq txt r)
4898 (setq txt "SEXP entry returned empty string"))
4900 (setq txt (org-agenda-format-item
4901 "" txt category tags 'time))
4902 (org-add-props txt props 'org-marker marker)
4903 (org-add-props txt nil
4904 'org-category category 'date date 'todo-state todo-state
4905 'org-category-position org-category-pos
4906 'type "sexp")
4907 (push txt ee)))))
4908 (nreverse ee)))
4910 ;; Calendar sanity: define some functions that are independent of
4911 ;; `calendar-date-style'.
4912 ;; Normally I would like to use ISO format when calling the diary functions,
4913 ;; but to make sure we still have Emacs 22 compatibility we bind
4914 ;; also `european-calendar-style' and use european format
4915 (defun org-anniversary (year month day &optional mark)
4916 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
4917 (org-no-warnings
4918 (let ((calendar-date-style 'european) (european-calendar-style t))
4919 (diary-anniversary day month year mark))))
4920 (defun org-cyclic (N year month day &optional mark)
4921 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
4922 (org-no-warnings
4923 (let ((calendar-date-style 'european) (european-calendar-style t))
4924 (diary-cyclic N day month year mark))))
4925 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
4926 "Like `diary-block', but with fixed (ISO) order of arguments."
4927 (org-no-warnings
4928 (let ((calendar-date-style 'european) (european-calendar-style t))
4929 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
4930 (defun org-date (year month day &optional mark)
4931 "Like `diary-date', but with fixed (ISO) order of arguments."
4932 (org-no-warnings
4933 (let ((calendar-date-style 'european) (european-calendar-style t))
4934 (diary-date day month year mark))))
4935 (defalias 'org-float 'diary-float)
4937 ;; Define the` org-class' function
4938 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
4939 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
4940 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
4941 SKIP-WEEKS is any number of ISO weeks in the block period for which the
4942 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
4943 `holidays', then any date that is known by the Emacs calendar to be a
4944 holiday will also be skipped."
4945 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
4946 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
4947 (d (calendar-absolute-from-gregorian date)))
4948 (and
4949 (<= date1 d)
4950 (<= d date2)
4951 (= (calendar-day-of-week date) dayname)
4952 (or (not skip-weeks)
4953 (progn
4954 (require 'cal-iso)
4955 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
4956 (not (and (memq 'holidays skip-weeks)
4957 (calendar-check-holidays date)))
4958 entry)))
4960 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
4961 "Like `org-class', but honor `calendar-date-style'.
4962 The order of the first 2 times 3 arguments depends on the variable
4963 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
4964 So for American calendars, give this as MONTH DAY YEAR, for European as
4965 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
4966 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
4967 is any number of ISO weeks in the block period for which the item should
4968 be skipped.
4970 This function is here only for backward compatibility and it is deprecated,
4971 please use `org-class' instead."
4972 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
4973 (date2 (org-order-calendar-date-args m2 d2 y2)))
4974 (org-class
4975 (nth 2 date1) (car date1) (nth 1 date1)
4976 (nth 2 date2) (car date2) (nth 1 date2)
4977 dayname skip-weeks)))
4978 (make-obsolete 'org-diary-class 'org-class "")
4980 (defalias 'org-get-closed 'org-agenda-get-progress)
4981 (defun org-agenda-get-progress ()
4982 "Return the logged TODO entries for agenda display."
4983 (let* ((props (list 'mouse-face 'highlight
4984 'org-not-done-regexp org-not-done-regexp
4985 'org-todo-regexp org-todo-regexp
4986 'org-complex-heading-regexp org-complex-heading-regexp
4987 'help-echo
4988 (format "mouse-2 or RET jump to org file %s"
4989 (abbreviate-file-name buffer-file-name))))
4990 (items (if (consp org-agenda-show-log)
4991 org-agenda-show-log
4992 (if (eq org-agenda-show-log 'clockcheck)
4993 '(clock)
4994 org-agenda-log-mode-items)))
4995 (parts
4996 (delq nil
4997 (list
4998 (if (memq 'closed items) (concat "\\<" org-closed-string))
4999 (if (memq 'clock items) (concat "\\<" org-clock-string))
5000 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5001 (parts-re (if parts (mapconcat 'identity parts "\\|")
5002 (error "`org-agenda-log-mode-items' is empty")))
5003 (regexp (concat
5004 "\\(" parts-re "\\)"
5005 " *\\["
5006 (regexp-quote
5007 (substring
5008 (format-time-string
5009 (car org-time-stamp-formats)
5010 (apply 'encode-time ; DATE bound by calendar
5011 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5012 1 11))))
5013 (org-agenda-search-headline-for-time nil)
5014 marker hdmarker priority category org-category-pos tags closedp
5015 statep clockp state ee txt extra timestr rest clocked)
5016 (goto-char (point-min))
5017 (while (re-search-forward regexp nil t)
5018 (catch :skip
5019 (org-agenda-skip)
5020 (setq marker (org-agenda-new-marker (match-beginning 0))
5021 closedp (equal (match-string 1) org-closed-string)
5022 statep (equal (string-to-char (match-string 1)) ?-)
5023 clockp (not (or closedp statep))
5024 state (and statep (match-string 2))
5025 category (org-get-category (match-beginning 0))
5026 org-category-pos (get-text-property (match-beginning 0) 'org-category-position)
5027 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5028 (when (string-match "\\]" timestr)
5029 ;; substring should only run to end of time stamp
5030 (setq rest (substring timestr (match-end 0))
5031 timestr (substring timestr 0 (match-end 0)))
5032 (if (and (not closedp) (not statep)
5033 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5034 rest))
5035 (progn (setq timestr (concat (substring timestr 0 -1)
5036 "-" (match-string 1 rest) "]"))
5037 (setq clocked (match-string 2 rest)))
5038 (setq clocked "-")))
5039 (save-excursion
5040 (setq extra
5041 (cond
5042 ((not org-agenda-log-mode-add-notes) nil)
5043 (statep
5044 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5045 (match-string 1)))
5046 (clockp
5047 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5048 (match-string 1)))))
5049 (if (not (re-search-backward org-outline-regexp-bol nil t))
5050 (setq txt org-agenda-no-heading-message)
5051 (goto-char (match-beginning 0))
5052 (setq hdmarker (org-agenda-new-marker)
5053 tags (org-get-tags-at))
5054 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5055 (setq txt (match-string 1))
5056 (when extra
5057 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5058 (setq txt (concat (substring txt 0 (match-beginning 1))
5059 " - " extra " " (match-string 2 txt)))
5060 (setq txt (concat txt " - " extra))))
5061 (setq txt (org-agenda-format-item
5062 (cond
5063 (closedp "Closed: ")
5064 (statep (concat "State: (" state ")"))
5065 (t (concat "Clocked: (" clocked ")")))
5066 txt category tags timestr)))
5067 (setq priority 100000)
5068 (org-add-props txt props
5069 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5070 'priority priority 'org-category category
5071 'org-category-position org-category-pos
5072 'type "closed" 'date date
5073 'undone-face 'org-warning 'done-face 'org-agenda-done)
5074 (push txt ee))
5075 (goto-char (point-at-eol))))
5076 (nreverse ee)))
5078 (defun org-agenda-show-clocking-issues ()
5079 "Add overlays, showing issues with clocking.
5080 See also the user option `org-agenda-clock-consistency-checks'."
5081 (interactive)
5082 (let* ((pl org-agenda-clock-consistency-checks)
5083 (re (concat "^[ \t]*"
5084 org-clock-string
5085 "[ \t]+"
5086 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5087 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5088 (tlstart 0.)
5089 (tlend 0.)
5090 (maxtime (org-hh:mm-string-to-minutes
5091 (or (plist-get pl :max-duration) "24:00")))
5092 (mintime (org-hh:mm-string-to-minutes
5093 (or (plist-get pl :min-duration) 0)))
5094 (maxgap (org-hh:mm-string-to-minutes
5095 ;; default 30:00 means never complain
5096 (or (plist-get pl :max-gap) "30:00")))
5097 (gapok (mapcar 'org-hh:mm-string-to-minutes
5098 (plist-get pl :gap-ok-around)))
5099 (def-face (or (plist-get pl :default-face)
5100 '((:background "DarkRed") (:foreground "white"))))
5101 issue face m te ts dt ov)
5102 (goto-char (point-min))
5103 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5104 (setq issue nil face def-face)
5105 (catch 'next
5106 (setq m (org-get-at-bol 'org-marker)
5107 te nil ts nil)
5108 (unless (and m (markerp m))
5109 (setq issue "No valid clock line") (throw 'next t))
5110 (org-with-point-at m
5111 (save-excursion
5112 (goto-char (point-at-bol))
5113 (unless (looking-at re)
5114 (error "No valid Clock line")
5115 (throw 'next t))
5116 (unless (match-end 3)
5117 (setq issue "No end time"
5118 face (or (plist-get pl :no-end-time-face) face))
5119 (throw 'next t))
5120 (setq ts (match-string 1)
5121 te (match-string 3)
5122 ts (org-float-time
5123 (apply 'encode-time (org-parse-time-string ts)))
5124 te (org-float-time
5125 (apply 'encode-time (org-parse-time-string te)))
5126 dt (- te ts))))
5127 (cond
5128 ((> dt (* 60 maxtime))
5129 ;; a very long clocking chunk
5130 (setq issue (format "Clocking interval is very long: %s"
5131 (org-minutes-to-hh:mm-string
5132 (floor (/ (float dt) 60.))))
5133 face (or (plist-get pl :long-face) face)))
5134 ((< dt (* 60 mintime))
5135 ;; a very short clocking chunk
5136 (setq issue (format "Clocking interval is very short: %s"
5137 (org-minutes-to-hh:mm-string
5138 (floor (/ (float dt) 60.))))
5139 face (or (plist-get pl :short-face) face)))
5140 ((and (> tlend 0) (< ts tlend))
5141 ;; Two clock entries are overlapping
5142 (setq issue (format "Clocking overlap: %d minutes"
5143 (/ (- tlend ts) 60))
5144 face (or (plist-get pl :overlap-face) face)))
5145 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5146 ;; There is a gap, lets see if we need to report it
5147 (unless (org-agenda-check-clock-gap tlend ts gapok)
5148 (setq issue (format "Clocking gap: %d minutes"
5149 (/ (- ts tlend) 60))
5150 face (or (plist-get pl :gap-face) face))))
5151 (t nil)))
5152 (setq tlend (or te tlend) tlstart (or ts tlstart))
5153 (when issue
5154 ;; OK, there was some issue, add an overlay to show the issue
5155 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5156 (overlay-put ov 'before-string
5157 (concat
5158 (org-add-props
5159 (format "%-43s" (concat " " issue))
5161 'face face)
5162 "\n"))
5163 (overlay-put ov 'evaporate t)))))
5165 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5166 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5167 (catch 'exit
5168 (unless ok-list
5169 ;; there are no OK times for gaps...
5170 (throw 'exit nil))
5171 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5172 ;; This is more than 24 hours, so it is OK.
5173 ;; because we have at least one OK time, that must be in the
5174 ;; 24 hour interval.
5175 (throw 'exit t))
5176 ;; We have a shorter gap.
5177 ;; Now we have to get the minute of the day when these times are
5178 (let* ((t1dec (decode-time (seconds-to-time t1)))
5179 (t2dec (decode-time (seconds-to-time t2)))
5180 ;; compute the minute on the day
5181 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5182 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5183 (when (< min2 min1)
5184 ;; if min2 is smaller than min1, this means it is on the next day.
5185 ;; Wrap it to after midnight.
5186 (setq min2 (+ min2 1440)))
5187 ;; Now check if any of the OK times is in the gap
5188 (mapc (lambda (x)
5189 ;; Wrap the time to after midnight if necessary
5190 (if (< x min1) (setq x (+ x 1440)))
5191 ;; Check if in interval
5192 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5193 ok-list)
5194 ;; Nope, this gap is not OK
5195 nil)))
5197 (defun org-agenda-get-deadlines ()
5198 "Return the deadline information for agenda display."
5199 (let* ((props (list 'mouse-face 'highlight
5200 'org-not-done-regexp org-not-done-regexp
5201 'org-todo-regexp org-todo-regexp
5202 'org-complex-heading-regexp org-complex-heading-regexp
5203 'help-echo
5204 (format "mouse-2 or RET jump to org file %s"
5205 (abbreviate-file-name buffer-file-name))))
5206 (regexp org-deadline-time-regexp)
5207 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5208 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5209 d2 diff dfrac wdays pos pos1 category org-category-pos
5210 tags suppress-prewarning ee txt head face s todo-state
5211 show-all upcomingp donep timestr)
5212 (goto-char (point-min))
5213 (while (re-search-forward regexp nil t)
5214 (setq suppress-prewarning nil)
5215 (catch :skip
5216 (org-agenda-skip)
5217 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5218 (save-match-data
5219 (string-match org-scheduled-time-regexp
5220 (buffer-substring (point-at-bol)
5221 (point-at-eol)))))
5222 (setq suppress-prewarning
5223 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5224 org-agenda-skip-deadline-prewarning-if-scheduled
5225 0)))
5226 (setq s (match-string 1)
5227 txt nil
5228 pos (1- (match-beginning 1))
5229 todo-state (save-match-data (org-get-todo-state))
5230 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5231 (member todo-state
5232 org-agenda-repeating-timestamp-show-all))
5233 d2 (org-time-string-to-absolute
5234 (match-string 1) d1 'past show-all
5235 (current-buffer) pos)
5236 diff (- d2 d1)
5237 wdays (if suppress-prewarning
5238 (let ((org-deadline-warning-days suppress-prewarning))
5239 (org-get-wdays s))
5240 (org-get-wdays s))
5241 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5242 upcomingp (and todayp (> diff 0)))
5243 ;; When to show a deadline in the calendar:
5244 ;; If the expiration is within wdays warning time.
5245 ;; Past-due deadlines are only shown on the current date
5246 (if (and (or (and (<= diff wdays)
5247 (and todayp (not org-agenda-only-exact-dates)))
5248 (= diff 0)))
5249 (save-excursion
5250 ;; (setq todo-state (org-get-todo-state))
5251 (setq donep (member todo-state org-done-keywords))
5252 (if (and donep
5253 (or org-agenda-skip-deadline-if-done
5254 (not (= diff 0))))
5255 (setq txt nil)
5256 (setq category (org-get-category)
5257 org-category-pos (get-text-property (point) 'org-category-position))
5258 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5259 (setq txt org-agenda-no-heading-message)
5260 (goto-char (match-end 0))
5261 (setq pos1 (match-beginning 0))
5262 (setq tags (org-get-tags-at pos1))
5263 (setq head (buffer-substring-no-properties
5264 (point)
5265 (progn (skip-chars-forward "^\r\n")
5266 (point))))
5267 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5268 (setq timestr
5269 (concat (substring s (match-beginning 1)) " "))
5270 (setq timestr 'time))
5271 (setq txt (org-agenda-format-item
5272 (if (= diff 0)
5273 (car org-agenda-deadline-leaders)
5274 (if (functionp
5275 (nth 1 org-agenda-deadline-leaders))
5276 (funcall
5277 (nth 1 org-agenda-deadline-leaders)
5278 diff date)
5279 (format (nth 1 org-agenda-deadline-leaders)
5280 diff)))
5281 head category tags
5282 (if (not (= diff 0)) nil timestr)))))
5283 (when txt
5284 (setq face (org-agenda-deadline-face dfrac))
5285 (org-add-props txt props
5286 'org-marker (org-agenda-new-marker pos)
5287 'org-hd-marker (org-agenda-new-marker pos1)
5288 'priority (+ (- diff)
5289 (org-get-priority txt))
5290 'org-category category
5291 'org-category-position org-category-pos
5292 'todo-state todo-state
5293 'type (if upcomingp "upcoming-deadline" "deadline")
5294 'date (if upcomingp date d2)
5295 'face (if donep 'org-agenda-done face)
5296 'undone-face face 'done-face 'org-agenda-done)
5297 (push txt ee))))))
5298 (nreverse ee)))
5300 (defun org-agenda-deadline-face (fraction)
5301 "Return the face to displaying a deadline item.
5302 FRACTION is what fraction of the head-warning time has passed."
5303 (let ((faces org-agenda-deadline-faces) f)
5304 (catch 'exit
5305 (while (setq f (pop faces))
5306 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5308 (defun org-agenda-get-scheduled (&optional deadline-results)
5309 "Return the scheduled information for agenda display."
5310 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5311 'org-todo-regexp org-todo-regexp
5312 'org-complex-heading-regexp org-complex-heading-regexp
5313 'done-face 'org-agenda-done
5314 'mouse-face 'highlight
5315 'help-echo
5316 (format "mouse-2 or RET jump to org file %s"
5317 (abbreviate-file-name buffer-file-name))))
5318 (regexp org-scheduled-time-regexp)
5319 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5320 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5322 (deadline-position-alist
5323 (mapcar (lambda (a) (and (setq mm (get-text-property
5324 0 'org-hd-marker a))
5325 (cons (marker-position mm) a)))
5326 deadline-results))
5327 d2 diff pos pos1 category org-category-pos tags donep
5328 ee txt head pastschedp todo-state face timestr s habitp show-all)
5329 (goto-char (point-min))
5330 (while (re-search-forward regexp nil t)
5331 (catch :skip
5332 (org-agenda-skip)
5333 (setq s (match-string 1)
5334 txt nil
5335 pos (1- (match-beginning 1))
5336 todo-state (save-match-data (org-get-todo-state))
5337 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5338 (member todo-state
5339 org-agenda-repeating-timestamp-show-all))
5340 d2 (org-time-string-to-absolute
5341 (match-string 1) d1 'past show-all
5342 (current-buffer) pos)
5343 diff (- d2 d1))
5344 (setq pastschedp (and todayp (< diff 0)))
5345 ;; When to show a scheduled item in the calendar:
5346 ;; If it is on or past the date.
5347 (when (or (and (< diff 0)
5348 (< (abs diff) org-scheduled-past-days)
5349 (and todayp (not org-agenda-only-exact-dates)))
5350 (= diff 0))
5351 (save-excursion
5352 (setq donep (member todo-state org-done-keywords))
5353 (if (and donep
5354 (or org-agenda-skip-scheduled-if-done
5355 (not (= diff 0))
5356 (and (functionp 'org-is-habit-p)
5357 (org-is-habit-p))))
5358 (setq txt nil)
5359 (setq habitp (and (functionp 'org-is-habit-p)
5360 (org-is-habit-p)))
5361 (setq category (org-get-category)
5362 org-category-pos (get-text-property (point) 'org-category-position))
5363 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5364 (setq txt org-agenda-no-heading-message)
5365 (goto-char (match-end 0))
5366 (setq pos1 (match-beginning 0))
5367 (if habitp
5368 (if (or (not org-habit-show-habits)
5369 (and (not todayp)
5370 org-habit-show-habits-only-for-today))
5371 (throw :skip nil))
5372 (if (and
5373 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5374 (and org-agenda-skip-scheduled-if-deadline-is-shown
5375 pastschedp))
5376 (setq mm (assoc pos1 deadline-position-alist)))
5377 (throw :skip nil)))
5378 (setq tags (org-get-tags-at))
5379 (setq head (buffer-substring-no-properties
5380 (point)
5381 (progn (skip-chars-forward "^\r\n") (point))))
5382 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5383 (setq timestr
5384 (concat (substring s (match-beginning 1)) " "))
5385 (setq timestr 'time))
5386 (setq txt (org-agenda-format-item
5387 (if (= diff 0)
5388 (car org-agenda-scheduled-leaders)
5389 (format (nth 1 org-agenda-scheduled-leaders)
5390 (- 1 diff)))
5391 head category tags
5392 (if (not (= diff 0)) nil timestr)
5393 nil habitp))))
5394 (when txt
5395 (setq face
5396 (cond
5397 ((and (not habitp) pastschedp)
5398 'org-scheduled-previously)
5399 (todayp 'org-scheduled-today)
5400 (t 'org-scheduled))
5401 habitp (and habitp (org-habit-parse-todo)))
5402 (org-add-props txt props
5403 'undone-face face
5404 'face (if donep 'org-agenda-done face)
5405 'org-marker (org-agenda-new-marker pos)
5406 'org-hd-marker (org-agenda-new-marker pos1)
5407 'type (if pastschedp "past-scheduled" "scheduled")
5408 'date (if pastschedp d2 date)
5409 'priority (if habitp
5410 (org-habit-get-priority habitp)
5411 (+ 94 (- 5 diff) (org-get-priority txt)))
5412 'org-category category
5413 'org-category-position org-category-pos
5414 'org-habit-p habitp
5415 'todo-state todo-state)
5416 (push txt ee))))))
5417 (nreverse ee)))
5419 (defun org-agenda-get-blocks ()
5420 "Return the date-range information for agenda display."
5421 (let* ((props (list 'face nil
5422 'org-not-done-regexp org-not-done-regexp
5423 'org-todo-regexp org-todo-regexp
5424 'org-complex-heading-regexp org-complex-heading-regexp
5425 'mouse-face 'highlight
5426 'help-echo
5427 (format "mouse-2 or RET jump to org file %s"
5428 (abbreviate-file-name buffer-file-name))))
5429 (regexp org-tr-regexp)
5430 (d0 (calendar-absolute-from-gregorian date))
5431 marker hdmarker ee txt d1 d2 s1 s2 category org-category-pos
5432 todo-state tags pos head donep)
5433 (goto-char (point-min))
5434 (while (re-search-forward regexp nil t)
5435 (catch :skip
5436 (org-agenda-skip)
5437 (setq pos (point))
5438 (let ((start-time (match-string 1))
5439 (end-time (match-string 2)))
5440 (setq s1 (match-string 1)
5441 s2 (match-string 2)
5442 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5443 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5444 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5445 ;; Only allow days between the limits, because the normal
5446 ;; date stamps will catch the limits.
5447 (save-excursion
5448 (setq todo-state (org-get-todo-state))
5449 (setq donep (member todo-state org-done-keywords))
5450 (if (and donep org-agenda-skip-timestamp-if-done)
5451 (throw :skip t))
5452 (setq marker (org-agenda-new-marker (point)))
5453 (setq category (org-get-category)
5454 org-category-pos (get-text-property (point) 'org-category-position))
5455 (if (not (re-search-backward org-outline-regexp-bol nil t))
5456 (setq txt org-agenda-no-heading-message)
5457 (goto-char (match-beginning 0))
5458 (setq hdmarker (org-agenda-new-marker (point)))
5459 (setq tags (org-get-tags-at))
5460 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5461 (setq head (match-string 1))
5462 (let ((remove-re
5463 (if org-agenda-remove-timeranges-from-blocks
5464 (concat
5465 "<" (regexp-quote s1) ".*?>"
5466 "--"
5467 "<" (regexp-quote s2) ".*?>")
5468 nil)))
5469 (setq txt (org-agenda-format-item
5470 (format
5471 (nth (if (= d1 d2) 0 1)
5472 org-agenda-timerange-leaders)
5473 (1+ (- d0 d1)) (1+ (- d2 d1)))
5474 head category tags
5475 (cond ((and (= d1 d0) (= d2 d0))
5476 (concat "<" start-time ">--<" end-time ">"))
5477 ((= d1 d0)
5478 (concat "<" start-time ">"))
5479 ((= d2 d0)
5480 (concat "<" end-time ">"))
5481 (t nil))
5482 remove-re))))
5483 (org-add-props txt props
5484 'org-marker marker 'org-hd-marker hdmarker
5485 'type "block" 'date date
5486 'todo-state todo-state
5487 'priority (org-get-priority txt) 'org-category category
5488 'org-category-position org-category-pos)
5489 (push txt ee))))
5490 (goto-char pos)))
5491 ;; Sort the entries by expiration date.
5492 (nreverse ee)))
5494 ;;; Agenda presentation and sorting
5496 (defvar org-prefix-has-time nil
5497 "A flag, set by `org-compile-prefix-format'.
5498 The flag is set if the currently compiled format contains a `%t'.")
5499 (defvar org-prefix-has-tag nil
5500 "A flag, set by `org-compile-prefix-format'.
5501 The flag is set if the currently compiled format contains a `%T'.")
5502 (defvar org-prefix-has-effort nil
5503 "A flag, set by `org-compile-prefix-format'.
5504 The flag is set if the currently compiled format contains a `%e'.")
5505 (defvar org-prefix-category-length nil
5506 "Used by `org-compile-prefix-format' to remember the category field width.")
5507 (defvar org-prefix-category-max-length nil
5508 "Used by `org-compile-prefix-format' to remember the category field width.")
5510 (defun org-agenda-get-category-icon (category)
5511 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5512 (dolist (entry org-agenda-category-icon-alist)
5513 (when (org-string-match-p (car entry) category)
5514 (if (listp (cadr entry))
5515 (return (cadr entry))
5516 (return (apply 'create-image (cdr entry)))))))
5518 (defun org-agenda-format-item (extra txt &optional category tags dotime
5519 remove-re habitp)
5520 "Format TXT to be inserted into the agenda buffer.
5521 In particular, it adds the prefix and corresponding text properties. EXTRA
5522 must be a string and replaces the `%s' specifier in the prefix format.
5523 CATEGORY (string, symbol or nil) may be used to overrule the default
5524 category taken from local variable or file name. It will replace the `%c'
5525 specifier in the format. DOTIME, when non-nil, indicates that a
5526 time-of-day should be extracted from TXT for sorting of this entry, and for
5527 the `%t' specifier in the format. When DOTIME is a string, this string is
5528 searched for a time before TXT is. TAGS can be the tags of the headline.
5529 Any match of REMOVE-RE will be removed from TXT."
5530 (save-match-data
5531 ;; Diary entries sometimes have extra whitespace at the beginning
5532 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5534 ;; Fix the tags part in txt
5535 (setq txt (org-agenda-fix-displayed-tags
5536 txt tags
5537 org-agenda-show-inherited-tags
5538 org-agenda-hide-tags-regexp))
5539 (let* ((category (or category
5540 (if (stringp org-category)
5541 org-category
5542 (and org-category (symbol-name org-category)))
5543 (if buffer-file-name
5544 (file-name-sans-extension
5545 (file-name-nondirectory buffer-file-name))
5546 "")))
5547 (category-icon (org-agenda-get-category-icon category))
5548 (category-icon (if category-icon
5549 (propertize " " 'display category-icon)
5550 ""))
5551 ;; time, tag, effort are needed for the eval of the prefix format
5552 (tag (if tags (nth (1- (length tags)) tags) ""))
5553 time effort neffort
5554 (ts (if dotime (concat
5555 (if (stringp dotime) dotime "")
5556 (and org-agenda-search-headline-for-time txt))))
5557 (time-of-day (and dotime (org-get-time-of-day ts)))
5558 stamp plain s0 s1 s2 rtn srp l
5559 duration thecategory)
5560 (and (eq major-mode 'org-mode) buffer-file-name
5561 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5562 (when (and dotime time-of-day)
5563 ;; Extract starting and ending time and move them to prefix
5564 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5565 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5566 (setq s0 (match-string 0 ts)
5567 srp (and stamp (match-end 3))
5568 s1 (match-string (if plain 1 2) ts)
5569 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5571 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5572 ;; them, we might want to remove them there to avoid duplication.
5573 ;; The user can turn this off with a variable.
5574 (if (and org-prefix-has-time
5575 org-agenda-remove-times-when-in-prefix (or stamp plain)
5576 (string-match (concat (regexp-quote s0) " *") txt)
5577 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5578 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5579 (= (match-beginning 0) 0)
5581 (setq txt (replace-match "" nil nil txt))))
5582 ;; Normalize the time(s) to 24 hour
5583 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5584 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5586 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5587 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5588 (setq s2
5589 (org-minutes-to-hh:mm-string
5590 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5592 ;; Compute the duration
5593 (when s2
5594 (setq duration (- (org-hh:mm-string-to-minutes s2)
5595 (org-hh:mm-string-to-minutes s1)))))
5597 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5598 txt)
5599 ;; Tags are in the string
5600 (if (or (eq org-agenda-remove-tags t)
5601 (and org-agenda-remove-tags
5602 org-prefix-has-tag))
5603 (setq txt (replace-match "" t t txt))
5604 (setq txt (replace-match
5605 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5606 (match-string 2 txt))
5607 t t txt))))
5608 (when (eq major-mode 'org-mode)
5609 (setq effort
5610 (condition-case nil
5611 (org-get-effort
5612 (or (get-text-property 0 'org-hd-marker txt)
5613 (get-text-property 0 'org-marker txt)))
5614 (error nil)))
5615 (when effort
5616 (setq neffort (org-duration-string-to-minutes effort)
5617 effort (setq effort (concat "[" effort "]")))))
5618 ;; prevent erroring out with %e format when there is no effort
5619 (or effort (setq effort ""))
5621 (when remove-re
5622 (while (string-match remove-re txt)
5623 (setq txt (replace-match "" t t txt))))
5625 ;; Set org-heading property on `txt' to mark the start of the
5626 ;; heading.
5627 (add-text-properties 0 (length txt) '(org-heading t) txt)
5629 ;; Prepare the variables needed in the eval of the compiled format
5630 (setq time (cond (s2 (concat
5631 (org-agenda-time-of-day-to-ampm-maybe s1)
5632 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5633 (if org-agenda-timegrid-use-ampm " ")))
5634 (s1 (concat
5635 (org-agenda-time-of-day-to-ampm-maybe s1)
5636 (if org-agenda-timegrid-use-ampm
5637 "........ "
5638 "......")))
5639 (t ""))
5640 extra (or (and (not habitp) extra) "")
5641 category (if (symbolp category) (symbol-name category) category)
5642 thecategory (copy-sequence category))
5643 (if (string-match org-bracket-link-regexp category)
5644 (progn
5645 (setq l (if (match-end 3)
5646 (- (match-end 3) (match-beginning 3))
5647 (- (match-end 1) (match-beginning 1))))
5648 (when (< l (or org-prefix-category-length 0))
5649 (setq category (copy-sequence category))
5650 (org-add-props category nil
5651 'extra-space (make-string
5652 (- org-prefix-category-length l 1) ?\ ))))
5653 (if (and org-prefix-category-max-length
5654 (>= (length category) org-prefix-category-max-length))
5655 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5656 ;; Evaluate the compiled format
5657 (setq rtn (concat (eval org-prefix-format-compiled) txt))
5659 ;; And finally add the text properties
5660 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5661 (org-add-props rtn nil
5662 'org-category (if thecategory (downcase thecategory) category)
5663 'tags (mapcar 'org-downcase-keep-props tags)
5664 'org-highest-priority org-highest-priority
5665 'org-lowest-priority org-lowest-priority
5666 'time-of-day time-of-day
5667 'duration duration
5668 'effort effort
5669 'effort-minutes neffort
5670 'txt txt
5671 'time time
5672 'extra extra
5673 'format org-prefix-format-compiled
5674 'dotime dotime))))
5676 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5677 "Remove tags string from TXT, and add a modified list of tags.
5678 The modified list may contain inherited tags, and tags matched by
5679 `org-agenda-hide-tags-regexp' will be removed."
5680 (when (or add-inherited hide-re)
5681 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5682 (setq txt (substring txt 0 (match-beginning 0))))
5683 (setq tags
5684 (delq nil
5685 (mapcar (lambda (tg)
5686 (if (or (and hide-re (string-match hide-re tg))
5687 (and (not add-inherited)
5688 (get-text-property 0 'inherited tg)))
5690 tg))
5691 tags)))
5692 (when tags
5693 (let ((have-i (get-text-property 0 'inherited (car tags)))
5695 (setq txt (concat txt " :"
5696 (mapconcat
5697 (lambda (x)
5698 (setq i (get-text-property 0 'inherited x))
5699 (if (and have-i (not i))
5700 (progn
5701 (setq have-i nil)
5702 (concat ":" x))
5704 tags ":")
5705 (if have-i "::" ":"))))))
5706 txt)
5708 (defun org-downcase-keep-props (s)
5709 (let ((props (text-properties-at 0 s)))
5710 (setq s (downcase s))
5711 (add-text-properties 0 (length s) props s)
5714 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
5715 (defvar org-agenda-sorting-strategy-selected nil)
5717 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
5718 (catch 'exit
5719 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
5720 ((and todayp (member 'today (car org-agenda-time-grid))))
5721 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
5722 ((member 'weekly (car org-agenda-time-grid)))
5723 (t (throw 'exit list)))
5724 (let* ((have (delq nil (mapcar
5725 (lambda (x) (get-text-property 1 'time-of-day x))
5726 list)))
5727 (string (nth 1 org-agenda-time-grid))
5728 (gridtimes (nth 2 org-agenda-time-grid))
5729 (req (car org-agenda-time-grid))
5730 (remove (member 'remove-match req))
5731 new time)
5732 (if (and (member 'require-timed req) (not have))
5733 ;; don't show empty grid
5734 (throw 'exit list))
5735 (while (setq time (pop gridtimes))
5736 (unless (and remove (member time have))
5737 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
5738 (push (org-agenda-format-item
5739 nil string "" nil
5740 (concat (substring time 0 -2) ":" (substring time -2)))
5741 new)
5742 (put-text-property
5743 2 (length (car new)) 'face 'org-time-grid (car new))))
5744 (when (and todayp org-agenda-show-current-time-in-grid)
5745 (push (org-agenda-format-item
5747 org-agenda-current-time-string
5748 "" nil
5749 (format-time-string "%H:%M "))
5750 new)
5751 (put-text-property
5752 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
5754 (if (member 'time-up org-agenda-sorting-strategy-selected)
5755 (append new list)
5756 (append list new)))))
5758 (defun org-compile-prefix-format (key)
5759 "Compile the prefix format into a Lisp form that can be evaluated.
5760 The resulting form is returned and stored in the variable
5761 `org-prefix-format-compiled'."
5762 (setq org-prefix-has-time nil org-prefix-has-tag nil
5763 org-prefix-category-length nil
5764 org-prefix-has-effort nil)
5765 (let ((s (cond
5766 ((stringp org-agenda-prefix-format)
5767 org-agenda-prefix-format)
5768 ((assq key org-agenda-prefix-format)
5769 (cdr (assq key org-agenda-prefix-format)))
5770 (t " %-12:c%?-12t% s")))
5771 (start 0)
5772 varform vars var e c f opt)
5773 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
5774 s start)
5775 (setq var (or (cdr (assoc (match-string 4 s)
5776 '(("c" . category) ("t" . time) ("s" . extra)
5777 ("i" . category-icon) ("T" . tag) ("e" . effort))))
5778 'eval)
5779 c (or (match-string 3 s) "")
5780 opt (match-beginning 1)
5781 start (1+ (match-beginning 0)))
5782 (if (equal var 'time) (setq org-prefix-has-time t))
5783 (if (equal var 'tag) (setq org-prefix-has-tag t))
5784 (if (equal var 'effort) (setq org-prefix-has-effort t))
5785 (setq f (concat "%" (match-string 2 s) "s"))
5786 (when (equal var 'category)
5787 (setq org-prefix-category-length
5788 (floor (abs (string-to-number (match-string 2 s)))))
5789 (setq org-prefix-category-max-length
5790 (let ((x (match-string 2 s)))
5791 (save-match-data
5792 (if (string-match "\\.[0-9]+" x)
5793 (string-to-number (substring (match-string 0 x) 1)))))))
5794 (if (eq var 'eval)
5795 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
5796 (if opt
5797 (setq varform
5798 `(if (equal "" ,var)
5800 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
5801 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
5802 (setq s (replace-match "%s" t nil s))
5803 (push varform vars))
5804 (setq vars (nreverse vars))
5805 (setq org-prefix-format-compiled `(format ,s ,@vars))))
5807 (defun org-set-sorting-strategy (key)
5808 (if (symbolp (car org-agenda-sorting-strategy))
5809 ;; the old format
5810 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
5811 (setq org-agenda-sorting-strategy-selected
5812 (or (cdr (assq key org-agenda-sorting-strategy))
5813 (cdr (assq 'agenda org-agenda-sorting-strategy))
5814 '(time-up category-keep priority-down)))))
5816 (defun org-get-time-of-day (s &optional string mod24)
5817 "Check string S for a time of day.
5818 If found, return it as a military time number between 0 and 2400.
5819 If not found, return nil.
5820 The optional STRING argument forces conversion into a 5 character wide string
5821 HH:MM."
5822 (save-match-data
5823 (when
5824 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
5825 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
5826 (let* ((h (string-to-number (match-string 1 s)))
5827 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
5828 (ampm (if (match-end 4) (downcase (match-string 4 s))))
5829 (am-p (equal ampm "am"))
5830 (h1 (cond ((not ampm) h)
5831 ((= h 12) (if am-p 0 12))
5832 (t (+ h (if am-p 0 12)))))
5833 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
5834 (mod h1 24) h1))
5835 (t0 (+ (* 100 h2) m))
5836 (t1 (concat (if (>= h1 24) "+" " ")
5837 (if (and org-agenda-time-leading-zero
5838 (< t0 1000)) "0" "")
5839 (if (< t0 100) "0" "")
5840 (if (< t0 10) "0" "")
5841 (int-to-string t0))))
5842 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
5844 (defvar org-agenda-before-sorting-filter-function nil
5845 "Function to be applied to agenda items prior to sorting.
5846 Prior to sorting also means just before they are inserted into the agenda.
5848 To aid sorting, you may revisit the original entries and add more text
5849 properties which will later be used by the sorting functions.
5851 The function should take a string argument, an agenda line.
5852 It has access to the text properties in that line, which contain among
5853 other things, the property `org-hd-marker' that points to the entry
5854 where the line comes from. Note that not all lines going into the agenda
5855 have this property, only most.
5857 The function should return the modified string. It is probably best
5858 to ONLY change text properties.
5860 You can also use this function as a filter, by returning nil for lines
5861 you don't want to have in the agenda at all. For this application, you
5862 could bind the variable in the options section of a custom command.")
5864 (defun org-finalize-agenda-entries (list &optional nosort)
5865 "Sort and concatenate the agenda items."
5866 (setq list (mapcar 'org-agenda-highlight-todo list))
5867 (if nosort
5868 list
5869 (when org-agenda-before-sorting-filter-function
5870 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
5871 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
5873 (defun org-agenda-highlight-todo (x)
5874 (let ((org-done-keywords org-done-keywords-for-agenda)
5875 (case-fold-search nil)
5877 (if (eq x 'line)
5878 (save-excursion
5879 (beginning-of-line 1)
5880 (setq re (org-get-at-bol 'org-todo-regexp))
5881 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
5882 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
5883 (add-text-properties (match-beginning 0) (match-end 1)
5884 (list 'face (org-get-todo-face 1)))
5885 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
5886 (delete-region (match-beginning 1) (1- (match-end 0)))
5887 (goto-char (match-beginning 1))
5888 (insert (format org-agenda-todo-keyword-format s)))))
5889 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
5890 (setq re (get-text-property 0 'org-todo-regexp x))
5891 (when (and re
5892 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
5893 x (or pl 0)) pl))
5894 (add-text-properties
5895 (or (match-end 1) (match-end 0)) (match-end 0)
5896 (list 'face (org-get-todo-face (match-string 2 x)))
5898 (when (match-end 1)
5899 (setq x (concat (substring x 0 (match-end 1))
5900 (format org-agenda-todo-keyword-format
5901 (match-string 2 x))
5902 (org-add-props " " (text-properties-at 0 x))
5903 (substring x (match-end 3)))))))
5904 x)))
5906 (defsubst org-cmp-priority (a b)
5907 "Compare the priorities of string A and B."
5908 (let ((pa (or (get-text-property 1 'priority a) 0))
5909 (pb (or (get-text-property 1 'priority b) 0)))
5910 (cond ((> pa pb) +1)
5911 ((< pa pb) -1)
5912 (t nil))))
5914 (defsubst org-cmp-effort (a b)
5915 "Compare the effort values of string A and B."
5916 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
5917 (ea (or (get-text-property 1 'effort-minutes a) def))
5918 (eb (or (get-text-property 1 'effort-minutes b) def)))
5919 (cond ((> ea eb) +1)
5920 ((< ea eb) -1)
5921 (t nil))))
5923 (defsubst org-cmp-category (a b)
5924 "Compare the string values of categories of strings A and B."
5925 (let ((ca (or (get-text-property 1 'org-category a) ""))
5926 (cb (or (get-text-property 1 'org-category b) "")))
5927 (cond ((string-lessp ca cb) -1)
5928 ((string-lessp cb ca) +1)
5929 (t nil))))
5931 (defsubst org-cmp-todo-state (a b)
5932 "Compare the todo states of strings A and B."
5933 (let* ((ma (or (get-text-property 1 'org-marker a)
5934 (get-text-property 1 'org-hd-marker a)))
5935 (mb (or (get-text-property 1 'org-marker b)
5936 (get-text-property 1 'org-hd-marker b)))
5937 (fa (and ma (marker-buffer ma)))
5938 (fb (and mb (marker-buffer mb)))
5939 (todo-kwds
5940 (or (and fa (with-current-buffer fa org-todo-keywords-1))
5941 (and fb (with-current-buffer fb org-todo-keywords-1))))
5942 (ta (or (get-text-property 1 'todo-state a) ""))
5943 (tb (or (get-text-property 1 'todo-state b) ""))
5944 (la (- (length (member ta todo-kwds))))
5945 (lb (- (length (member tb todo-kwds))))
5946 (donepa (member ta org-done-keywords-for-agenda))
5947 (donepb (member tb org-done-keywords-for-agenda)))
5948 (cond ((and donepa (not donepb)) -1)
5949 ((and (not donepa) donepb) +1)
5950 ((< la lb) -1)
5951 ((< lb la) +1)
5952 (t nil))))
5954 (defsubst org-cmp-alpha (a b)
5955 "Compare the headlines, alphabetically."
5956 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
5957 (plb (text-property-any 0 (length b) 'org-heading t b))
5958 (ta (and pla (substring a pla)))
5959 (tb (and plb (substring b plb))))
5960 (when pla
5961 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
5962 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
5963 (setq ta (substring ta (match-end 0))))
5964 (setq ta (downcase ta)))
5965 (when plb
5966 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
5967 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
5968 (setq tb (substring tb (match-end 0))))
5969 (setq tb (downcase tb)))
5970 (cond ((not ta) +1)
5971 ((not tb) -1)
5972 ((string-lessp ta tb) -1)
5973 ((string-lessp tb ta) +1)
5974 (t nil))))
5976 (defsubst org-cmp-tag (a b)
5977 "Compare the string values of the first tags of A and B."
5978 (let ((ta (car (last (get-text-property 1 'tags a))))
5979 (tb (car (last (get-text-property 1 'tags b)))))
5980 (cond ((not ta) +1)
5981 ((not tb) -1)
5982 ((string-lessp ta tb) -1)
5983 ((string-lessp tb ta) +1)
5984 (t nil))))
5986 (defsubst org-cmp-time (a b)
5987 "Compare the time-of-day values of strings A and B."
5988 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
5989 (ta (or (get-text-property 1 'time-of-day a) def))
5990 (tb (or (get-text-property 1 'time-of-day b) def)))
5991 (cond ((< ta tb) -1)
5992 ((< tb ta) +1)
5993 (t nil))))
5995 (defsubst org-cmp-habit-p (a b)
5996 "Compare the todo states of strings A and B."
5997 (let ((ha (get-text-property 1 'org-habit-p a))
5998 (hb (get-text-property 1 'org-habit-p b)))
5999 (cond ((and ha (not hb)) -1)
6000 ((and (not ha) hb) +1)
6001 (t nil))))
6003 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6005 (defun org-entries-lessp (a b)
6006 "Predicate for sorting agenda entries."
6007 ;; The following variables will be used when the form is evaluated.
6008 ;; So even though the compiler complains, keep them.
6009 (let* ((ss org-agenda-sorting-strategy-selected)
6010 (time-up (and (org-em 'time-up 'time-down ss)
6011 (org-cmp-time a b)))
6012 (time-down (if time-up (- time-up) nil))
6013 (priority-up (and (org-em 'priority-up 'priority-down ss)
6014 (org-cmp-priority a b)))
6015 (priority-down (if priority-up (- priority-up) nil))
6016 (effort-up (and (org-em 'effort-up 'effort-down ss)
6017 (org-cmp-effort a b)))
6018 (effort-down (if effort-up (- effort-up) nil))
6019 (category-up (and (or (org-em 'category-up 'category-down ss)
6020 (memq 'category-keep ss))
6021 (org-cmp-category a b)))
6022 (category-down (if category-up (- category-up) nil))
6023 (category-keep (if category-up +1 nil))
6024 (tag-up (and (org-em 'tag-up 'tag-down ss)
6025 (org-cmp-tag a b)))
6026 (tag-down (if tag-up (- tag-up) nil))
6027 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6028 (org-cmp-todo-state a b)))
6029 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6030 (habit-up (and (org-em 'habit-up 'habit-down ss)
6031 (org-cmp-habit-p a b)))
6032 (habit-down (if habit-up (- habit-up) nil))
6033 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6034 (org-cmp-alpha a b)))
6035 (alpha-down (if alpha-up (- alpha-up) nil))
6036 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6037 user-defined-up user-defined-down)
6038 (if (and need-user-cmp org-agenda-cmp-user-defined
6039 (functionp org-agenda-cmp-user-defined))
6040 (setq user-defined-up
6041 (funcall org-agenda-cmp-user-defined a b)
6042 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6043 (cdr (assoc
6044 (eval (cons 'or org-agenda-sorting-strategy-selected))
6045 '((-1 . t) (1 . nil) (nil . nil))))))
6047 ;;; Agenda restriction lock
6049 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6050 "Overlay to mark the headline to which agenda commands are restricted.")
6051 (overlay-put org-agenda-restriction-lock-overlay
6052 'face 'org-agenda-restriction-lock)
6053 (overlay-put org-agenda-restriction-lock-overlay
6054 'help-echo "Agendas are currently limited to this subtree.")
6055 (org-detach-overlay org-agenda-restriction-lock-overlay)
6057 (defun org-agenda-set-restriction-lock (&optional type)
6058 "Set restriction lock for agenda, to current subtree or file.
6059 Restriction will be the file if TYPE is `file', or if type is the
6060 universal prefix '(4), or if the cursor is before the first headline
6061 in the file. Otherwise, restriction will be to the current subtree."
6062 (interactive "P")
6063 (and (equal type '(4)) (setq type 'file))
6064 (setq type (cond
6065 (type type)
6066 ((org-at-heading-p) 'subtree)
6067 ((condition-case nil (org-back-to-heading t) (error nil))
6068 'subtree)
6069 (t 'file)))
6070 (if (eq type 'subtree)
6071 (progn
6072 (setq org-agenda-restrict t)
6073 (setq org-agenda-overriding-restriction 'subtree)
6074 (put 'org-agenda-files 'org-restrict
6075 (list (buffer-file-name (buffer-base-buffer))))
6076 (org-back-to-heading t)
6077 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6078 (move-marker org-agenda-restrict-begin (point))
6079 (move-marker org-agenda-restrict-end
6080 (save-excursion (org-end-of-subtree t)))
6081 (message "Locking agenda restriction to subtree"))
6082 (put 'org-agenda-files 'org-restrict
6083 (list (buffer-file-name (buffer-base-buffer))))
6084 (setq org-agenda-restrict nil)
6085 (setq org-agenda-overriding-restriction 'file)
6086 (move-marker org-agenda-restrict-begin nil)
6087 (move-marker org-agenda-restrict-end nil)
6088 (message "Locking agenda restriction to file"))
6089 (setq current-prefix-arg nil)
6090 (org-agenda-maybe-redo))
6092 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6093 "Remove the agenda restriction lock."
6094 (interactive "P")
6095 (org-detach-overlay org-agenda-restriction-lock-overlay)
6096 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6097 (setq org-agenda-overriding-restriction nil)
6098 (setq org-agenda-restrict nil)
6099 (put 'org-agenda-files 'org-restrict nil)
6100 (move-marker org-agenda-restrict-begin nil)
6101 (move-marker org-agenda-restrict-end nil)
6102 (setq current-prefix-arg nil)
6103 (message "Agenda restriction lock removed")
6104 (or noupdate (org-agenda-maybe-redo)))
6106 (defun org-agenda-maybe-redo ()
6107 "If there is any window showing the agenda view, update it."
6108 (let ((w (get-buffer-window org-agenda-buffer-name t))
6109 (w0 (selected-window)))
6110 (when w
6111 (select-window w)
6112 (org-agenda-redo)
6113 (select-window w0)
6114 (if org-agenda-overriding-restriction
6115 (message "Agenda view shifted to new %s restriction"
6116 org-agenda-overriding-restriction)
6117 (message "Agenda restriction lock removed")))))
6119 ;;; Agenda commands
6121 (defun org-agenda-check-type (error &rest types)
6122 "Check if agenda buffer is of allowed type.
6123 If ERROR is non-nil, throw an error, otherwise just return nil."
6124 (if (memq org-agenda-type types)
6126 (if error
6127 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6128 nil)))
6130 (defun org-agenda-quit ()
6131 "Exit agenda by removing the window or the buffer."
6132 (interactive)
6133 (if org-agenda-columns-active
6134 (org-columns-quit)
6135 (let ((buf (current-buffer)))
6136 (if (eq org-agenda-window-setup 'other-frame)
6137 (progn
6138 (kill-buffer buf)
6139 (org-agenda-reset-markers)
6140 (org-columns-remove-overlays)
6141 (setq org-agenda-archives-mode nil)
6142 (delete-frame))
6143 (and (not (eq org-agenda-window-setup 'current-window))
6144 (not (one-window-p))
6145 (delete-window))
6146 (kill-buffer buf)
6147 (org-agenda-reset-markers)
6148 (org-columns-remove-overlays)
6149 (setq org-agenda-archives-mode nil)))
6150 ;; Maybe restore the pre-agenda window configuration.
6151 (and org-agenda-restore-windows-after-quit
6152 (not (eq org-agenda-window-setup 'other-frame))
6153 org-pre-agenda-window-conf
6154 (set-window-configuration org-pre-agenda-window-conf))))
6156 (defun org-agenda-exit ()
6157 "Exit agenda by removing the window or the buffer.
6158 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6159 Org-mode buffers visited directly by the user will not be touched."
6160 (interactive)
6161 (org-release-buffers org-agenda-new-buffers)
6162 (setq org-agenda-new-buffers nil)
6163 (org-agenda-quit))
6165 (defun org-agenda-execute (arg)
6166 "Execute another agenda command, keeping same window.
6167 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6168 in the agenda."
6169 (interactive "P")
6170 (let ((org-agenda-window-setup 'current-window))
6171 (org-agenda arg)))
6173 (defun org-agenda-redo ()
6174 "Rebuild Agenda.
6175 When this is the global TODO list, a prefix argument will be interpreted."
6176 (interactive)
6177 (let* ((org-agenda-keep-modes t)
6178 (tag-filter org-agenda-tag-filter)
6179 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6180 (cat-filter org-agenda-category-filter)
6181 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6182 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6183 (cols org-agenda-columns-active)
6184 (line (org-current-line))
6185 (window-line (- line (org-current-line (window-start))))
6186 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6187 (put 'org-agenda-tag-filter :preset-filter nil)
6188 (put 'org-agenda-category-filter :preset-filter nil)
6189 (and cols (org-columns-quit))
6190 (message "Rebuilding agenda buffer...")
6191 (org-let lprops '(eval org-agenda-redo-command))
6192 (setq org-agenda-undo-list nil
6193 org-agenda-pending-undo-list nil)
6194 (message "Rebuilding agenda buffer...done")
6195 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6196 (put 'org-agenda-category-filter :preset-filter cat-preset)
6197 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6198 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6199 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6200 (org-goto-line line)
6201 (recenter window-line)))
6203 (defvar org-global-tags-completion-table nil)
6204 (defvar org-agenda-filtered-by-category nil)
6205 (defvar org-agenda-filter-form nil)
6207 (defun org-agenda-filter-by-category (strip)
6208 "Keep only those lines in the agenda buffer that have a specific category.
6209 The category is that of the current line."
6210 (interactive "P")
6211 (if org-agenda-filtered-by-category
6212 (org-agenda-filter-show-all-cat)
6213 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6214 (if cat (org-agenda-filter-apply
6215 (list (concat (if strip "-" "+") cat)) 'category)
6216 (error "No category at point")))))
6218 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6219 "Keep only those lines in the agenda buffer that have a specific tag.
6220 The tag is selected with its fast selection letter, as configured.
6221 With prefix argument STRIP, remove all lines that do have the tag.
6222 A lisp caller can specify CHAR. NARROW means that the new tag should be
6223 used to narrow the search - the interactive user can also press `-' or `+'
6224 to switch to narrowing."
6225 (interactive "P")
6226 (let* ((alist org-tag-alist-for-agenda)
6227 (tag-chars (mapconcat
6228 (lambda (x) (if (and (not (symbolp (car x)))
6229 (cdr x))
6230 (char-to-string (cdr x))
6231 ""))
6232 alist ""))
6233 (efforts (org-split-string
6234 (or (cdr (assoc (concat org-effort-property "_ALL")
6235 org-global-properties))
6236 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6237 "")))
6238 (effort-op org-agenda-filter-effort-default-operator)
6239 (effort-prompt "")
6240 (inhibit-read-only t)
6241 (current org-agenda-tag-filter)
6242 maybe-refresh a n tag)
6243 (unless char
6244 (message
6245 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6246 (if narrow "Narrow" "Filter") tag-chars
6247 (if org-agenda-auto-exclude-function "[RET], " ""))
6248 (setq char (read-char-exclusive)))
6249 (when (member char '(?+ ?-))
6250 ;; Narrowing down
6251 (cond ((equal char ?-) (setq strip t narrow t))
6252 ((equal char ?+) (setq strip nil narrow t)))
6253 (message
6254 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6255 (setq char (read-char-exclusive)))
6256 (when (member char '(?< ?> ?= ??))
6257 ;; An effort operator
6258 (setq effort-op (char-to-string char))
6259 (setq alist nil) ; to make sure it will be interpreted as effort.
6260 (unless (equal char ??)
6261 (loop for i from 0 to 9 do
6262 (setq effort-prompt
6263 (concat
6264 effort-prompt " ["
6265 (if (= i 9) "0" (int-to-string (1+ i)))
6266 "]" (nth i efforts))))
6267 (message "Effort%s: %s " effort-op effort-prompt)
6268 (setq char (read-char-exclusive))
6269 (when (or (< char ?0) (> char ?9))
6270 (error "Need 1-9,0 to select effort" ))))
6271 (when (equal char ?\t)
6272 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6273 (org-set-local 'org-global-tags-completion-table
6274 (org-global-tags-completion-table)))
6275 (let ((completion-ignore-case t))
6276 (setq tag (org-icompleting-read
6277 "Tag: " org-global-tags-completion-table))))
6278 (cond
6279 ((equal char ?\r)
6280 (org-agenda-filter-show-all-tag)
6281 (when org-agenda-auto-exclude-function
6282 (setq org-agenda-tag-filter '())
6283 (dolist (tag (org-agenda-get-represented-tags))
6284 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6285 (if modifier
6286 (push modifier org-agenda-tag-filter))))
6287 (if (not (null org-agenda-tag-filter))
6288 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6289 (setq maybe-refresh t))
6290 ((equal char ?/)
6291 (org-agenda-filter-show-all-tag)
6292 (when (get 'org-agenda-tag-filter :preset-filter)
6293 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6294 (setq maybe-refresh t))
6295 ((equal char ?. )
6296 (setq org-agenda-tag-filter
6297 (mapcar (lambda(tag) (concat "+" tag))
6298 (org-get-at-bol 'tags)))
6299 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6300 (setq maybe-refresh t))
6301 ((or (equal char ?\ )
6302 (setq a (rassoc char alist))
6303 (and (>= char ?0) (<= char ?9)
6304 (setq n (if (= char ?0) 9 (- char ?0 1))
6305 tag (concat effort-op (nth n efforts))
6306 a (cons tag nil)))
6307 (and (= char ??)
6308 (setq tag "?eff")
6309 a (cons tag nil))
6310 (and tag (setq a (cons tag nil))))
6311 (org-agenda-filter-show-all-tag)
6312 (setq tag (car a))
6313 (setq org-agenda-tag-filter
6314 (cons (concat (if strip "-" "+") tag)
6315 (if narrow current nil)))
6316 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6317 (setq maybe-refresh t))
6318 (t (error "Invalid tag selection character %c" char)))
6319 (when (and maybe-refresh
6320 (eq org-agenda-clockreport-mode 'with-filter))
6321 (org-agenda-redo))))
6323 (defun org-agenda-get-represented-tags ()
6324 "Get a list of all tags currently represented in the agenda."
6325 (let (p tags)
6326 (save-excursion
6327 (goto-char (point-min))
6328 (while (setq p (next-single-property-change (point) 'tags))
6329 (goto-char p)
6330 (mapc (lambda (x) (add-to-list 'tags x))
6331 (get-text-property (point) 'tags))))
6332 tags))
6334 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6335 "Refine the current filter. See `org-agenda-filter-by-tag'."
6336 (interactive "P")
6337 (org-agenda-filter-by-tag strip char 'refine))
6339 (defun org-agenda-filter-make-matcher ()
6340 "Create the form that tests a line for agenda filter."
6341 (let (f f1)
6342 ;; first compute the tag-filter matcher
6343 (dolist (x (delete-dups
6344 (append (get 'org-agenda-tag-filter
6345 :preset-filter) org-agenda-tag-filter)))
6346 (if (member x '("-" "+"))
6347 (setq f1 (if (equal x "-") 'tags '(not tags)))
6348 (if (string-match "[<=>?]" x)
6349 (setq f1 (org-agenda-filter-effort-form x))
6350 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6351 (if (equal (string-to-char x) ?-)
6352 (setq f1 (list 'not f1))))
6353 (push f1 f))
6354 ;; then compute the category-filter matcher
6355 (dolist (x (delete-dups
6356 (append (get 'org-agenda-category-filter
6357 :preset-filter) org-agenda-category-filter)))
6358 (setq f1 (list 'equal (substring x 1) 'cat))
6359 (push f1 f))
6360 (cons 'and (nreverse f))))
6362 (defun org-agenda-filter-effort-form (e)
6363 "Return the form to compare the effort of the current line with what E says.
6364 E looks like \"+<2:25\"."
6365 (let (op)
6366 (setq e (substring e 1))
6367 (setq op (string-to-char e) e (substring e 1))
6368 (setq op (cond ((equal op ?<) '<=)
6369 ((equal op ?>) '>=)
6370 ((equal op ??) op)
6371 (t '=)))
6372 (list 'org-agenda-compare-effort (list 'quote op)
6373 (org-duration-string-to-minutes e))))
6375 (defun org-agenda-compare-effort (op value)
6376 "Compare the effort of the current line with VALUE, using OP.
6377 If the line does not have an effort defined, return nil."
6378 (let ((eff (org-get-at-bol 'effort-minutes)))
6379 (if (equal op ??)
6380 (not eff)
6381 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6382 value))))
6384 (defun org-agenda-filter-apply (filter type)
6385 "Set FILTER as the new agenda filter and apply it."
6386 (let (tags cat)
6387 (if (eq type 'tag)
6388 (setq org-agenda-tag-filter filter)
6389 (setq org-agenda-category-filter filter
6390 org-agenda-filtered-by-category t))
6391 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6392 (org-agenda-set-mode-name)
6393 (save-excursion
6394 (goto-char (point-min))
6395 (while (not (eobp))
6396 (if (org-get-at-bol 'org-marker)
6397 (progn
6398 (setq tags (org-get-at-bol 'tags) ; used in eval
6399 cat (get-text-property (point) 'org-category))
6400 (if (not (eval org-agenda-filter-form))
6401 (org-agenda-filter-hide-line type))
6402 (beginning-of-line 2))
6403 (beginning-of-line 2))))
6404 (if (get-char-property (point) 'invisible)
6405 (org-agenda-previous-line))))
6407 (defun org-agenda-filter-hide-line (type)
6408 (let (ov)
6409 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6410 (point-at-eol)))
6411 (overlay-put ov 'invisible t)
6412 (overlay-put ov 'type type)
6413 (if (eq type 'tag)
6414 (push ov org-agenda-tag-filter-overlays)
6415 (push ov org-agenda-cat-filter-overlays))))
6417 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6418 (setq pos (or pos (point)))
6419 (save-excursion
6420 (dolist (ov (overlays-at pos))
6421 (when (and (overlay-get ov 'invisible)
6422 (eq (overlay-get ov 'type) 'tag))
6423 (goto-char pos)
6424 (if (< (overlay-start ov) (point-at-eol))
6425 (move-overlay ov (point-at-eol)
6426 (overlay-end ov)))))))
6428 (defun org-agenda-filter-show-all-tag nil
6429 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6430 (setq org-agenda-tag-filter-overlays nil
6431 org-agenda-tag-filter nil
6432 org-agenda-filter-form nil)
6433 (org-agenda-set-mode-name))
6435 (defun org-agenda-filter-show-all-cat nil
6436 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6437 (setq org-agenda-cat-filter-overlays nil
6438 org-agenda-filtered-by-category nil
6439 org-agenda-category-filter nil
6440 org-agenda-filter-form nil)
6441 (org-agenda-set-mode-name))
6443 (defun org-agenda-manipulate-query-add ()
6444 "Manipulate the query by adding a search term with positive selection.
6445 Positive selection means the term must be matched for selection of an entry."
6446 (interactive)
6447 (org-agenda-manipulate-query ?\[))
6448 (defun org-agenda-manipulate-query-subtract ()
6449 "Manipulate the query by adding a search term with negative selection.
6450 Negative selection means term must not be matched for selection of an entry."
6451 (interactive)
6452 (org-agenda-manipulate-query ?\]))
6453 (defun org-agenda-manipulate-query-add-re ()
6454 "Manipulate the query by adding a search regexp with positive selection.
6455 Positive selection means the regexp must match for selection of an entry."
6456 (interactive)
6457 (org-agenda-manipulate-query ?\{))
6458 (defun org-agenda-manipulate-query-subtract-re ()
6459 "Manipulate the query by adding a search regexp with negative selection.
6460 Negative selection means regexp must not match for selection of an entry."
6461 (interactive)
6462 (org-agenda-manipulate-query ?\}))
6463 (defun org-agenda-manipulate-query (char)
6464 (cond
6465 ((memq org-agenda-type '(timeline agenda))
6466 (let ((org-agenda-include-inactive-timestamps t))
6467 (org-agenda-redo))
6468 (message "Display now includes inactive timestamps as well"))
6469 ((eq org-agenda-type 'search)
6470 (org-add-to-string
6471 'org-agenda-query-string
6472 (if org-agenda-last-search-view-search-was-boolean
6473 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6474 (?\{ . " +{}") (?\} . " -{}"))))
6475 " "))
6476 (setq org-agenda-redo-command
6477 (list 'org-search-view
6478 org-todo-only
6479 org-agenda-query-string
6480 (+ (length org-agenda-query-string)
6481 (if (member char '(?\{ ?\})) 0 1))))
6482 (set-register org-agenda-query-register org-agenda-query-string)
6483 (org-agenda-redo))
6484 (t (error "Cannot manipulate query for %s-type agenda buffers"
6485 org-agenda-type))))
6487 (defun org-add-to-string (var string)
6488 (set var (concat (symbol-value var) string)))
6490 (defun org-agenda-goto-date (date)
6491 "Jump to DATE in agenda."
6492 (interactive (list (let ((org-read-date-prefer-future
6493 (eval org-agenda-jump-prefer-future)))
6494 (org-read-date))))
6495 (org-agenda-list nil date))
6497 (defun org-agenda-goto-today ()
6498 "Go to today."
6499 (interactive)
6500 (org-agenda-check-type t 'timeline 'agenda)
6501 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6502 (cond
6503 (tdpos (goto-char tdpos))
6504 ((eq org-agenda-type 'agenda)
6505 (let* ((sd (org-agenda-compute-starting-span
6506 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6507 (org-agenda-overriding-arguments org-agenda-last-arguments))
6508 (setf (nth 1 org-agenda-overriding-arguments) sd)
6509 (org-agenda-redo)
6510 (org-agenda-find-same-or-today-or-agenda)))
6511 (t (error "Cannot find today")))))
6513 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6514 (goto-char
6515 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6516 (text-property-any (point-min) (point-max) 'org-today t)
6517 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6518 (point-min))))
6520 (defun org-agenda-later (arg)
6521 "Go forward in time by thee current span.
6522 With prefix ARG, go forward that many times the current span."
6523 (interactive "p")
6524 (org-agenda-check-type t 'agenda)
6525 (let* ((span org-agenda-current-span)
6526 (sd org-starting-day)
6527 (greg (calendar-gregorian-from-absolute sd))
6528 (cnt (org-get-at-bol 'org-day-cnt))
6529 greg2)
6530 (cond
6531 ((eq span 'day)
6532 (setq sd (+ arg sd)))
6533 ((eq span 'week)
6534 (setq sd (+ (* 7 arg) sd)))
6535 ((eq span 'month)
6536 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6537 sd (calendar-absolute-from-gregorian greg2))
6538 (setcar greg2 (1+ (car greg2))))
6539 ((eq span 'year)
6540 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6541 sd (calendar-absolute-from-gregorian greg2))
6542 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6544 (setq sd (+ (* span arg) sd))))
6545 (let ((org-agenda-overriding-arguments
6546 (list (car org-agenda-last-arguments) sd span t)))
6547 (org-agenda-redo)
6548 (org-agenda-find-same-or-today-or-agenda cnt))))
6550 (defun org-agenda-earlier (arg)
6551 "Go backward in time by the current span.
6552 With prefix ARG, go backward that many times the current span."
6553 (interactive "p")
6554 (org-agenda-later (- arg)))
6556 (defun org-agenda-view-mode-dispatch ()
6557 "Call one of the view mode commands."
6558 (interactive)
6559 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6560 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6561 [a]rch-trees [A]rch-files clock[R]eport include[D]iary
6562 [E]ntryText")
6563 (let ((a (read-char-exclusive)))
6564 (case a
6565 (?\ (call-interactively 'org-agenda-reset-view))
6566 (?d (call-interactively 'org-agenda-day-view))
6567 (?w (call-interactively 'org-agenda-week-view))
6568 (?m (call-interactively 'org-agenda-month-view))
6569 (?y (call-interactively 'org-agenda-year-view))
6570 (?l (call-interactively 'org-agenda-log-mode))
6571 (?L (org-agenda-log-mode '(4)))
6572 (?c (org-agenda-log-mode 'clockcheck))
6573 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6574 (?a (call-interactively 'org-agenda-archives-mode))
6575 (?A (org-agenda-archives-mode 'files))
6576 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6577 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6578 (?G (call-interactively 'org-agenda-toggle-time-grid))
6579 (?D (call-interactively 'org-agenda-toggle-diary))
6580 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6581 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6582 (org-agenda-check-type t 'timeline 'agenda)
6583 (org-agenda-redo))
6584 (message "Display now includes inactive timestamps as well"))
6585 (?q (message "Abort"))
6586 (otherwise (error "Invalid key" )))))
6588 (defun org-agenda-reset-view ()
6589 "Switch to default view for agenda."
6590 (interactive)
6591 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
6592 (defun org-agenda-day-view (&optional day-of-year)
6593 "Switch to daily view for agenda.
6594 With argument DAY-OF-YEAR, switch to that day of the year."
6595 (interactive "P")
6596 (org-agenda-change-time-span 'day day-of-year))
6597 (defun org-agenda-week-view (&optional iso-week)
6598 "Switch to daily view for agenda.
6599 With argument ISO-WEEK, switch to the corresponding ISO week.
6600 If ISO-WEEK has more then 2 digits, only the last two encode the
6601 week. Any digits before this encode a year. So 200712 means
6602 week 12 of year 2007. Years in the range 1938-2037 can also be
6603 written as 2-digit years."
6604 (interactive "P")
6605 (org-agenda-change-time-span 'week iso-week))
6606 (defun org-agenda-month-view (&optional month)
6607 "Switch to monthly view for agenda.
6608 With argument MONTH, switch to that month."
6609 (interactive "P")
6610 (org-agenda-change-time-span 'month month))
6611 (defun org-agenda-year-view (&optional year)
6612 "Switch to yearly view for agenda.
6613 With argument YEAR, switch to that year.
6614 If MONTH has more then 2 digits, only the last two encode the
6615 month. Any digits before this encode a year. So 200712 means
6616 December year 2007. Years in the range 1938-2037 can also be
6617 written as 2-digit years."
6618 (interactive "P")
6619 (when year
6620 (setq year (org-small-year-to-year year)))
6621 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
6622 (org-agenda-change-time-span 'year year)
6623 (error "Abort")))
6625 (defun org-agenda-change-time-span (span &optional n)
6626 "Change the agenda view to SPAN.
6627 SPAN may be `day', `week', `month', `year'."
6628 (org-agenda-check-type t 'agenda)
6629 (if (and (not n) (equal org-agenda-current-span span))
6630 (error "Viewing span is already \"%s\"" span))
6631 (let* ((sd (or (org-get-at-bol 'day)
6632 org-starting-day))
6633 (sd (org-agenda-compute-starting-span sd span n))
6634 (org-agenda-overriding-arguments
6635 (or org-agenda-overriding-arguments
6636 (list (car org-agenda-last-arguments) sd span t))))
6637 (org-agenda-redo)
6638 (org-agenda-find-same-or-today-or-agenda))
6639 (org-agenda-set-mode-name)
6640 (message "Switched to %s view" span))
6642 (defun org-agenda-compute-starting-span (sd span &optional n)
6643 "Compute starting date for agenda.
6644 SPAN may be `day', `week', `month', `year'. The return value
6645 is a cons cell with the starting date and the number of days,
6646 so that the date SD will be in that range."
6647 (let* ((greg (calendar-gregorian-from-absolute sd))
6648 (dg (nth 1 greg))
6649 (mg (car greg))
6650 (yg (nth 2 greg)))
6651 (cond
6652 ((eq span 'day)
6653 (when n
6654 (setq sd (+ (calendar-absolute-from-gregorian
6655 (list mg 1 yg))
6656 n -1))))
6657 ((eq span 'week)
6658 (let* ((nt (calendar-day-of-week
6659 (calendar-gregorian-from-absolute sd)))
6660 (d (if org-agenda-start-on-weekday
6661 (- nt org-agenda-start-on-weekday)
6664 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
6665 (when n
6666 (require 'cal-iso)
6667 (when (> n 99)
6668 (setq y1 (org-small-year-to-year (/ n 100))
6669 n (mod n 100)))
6670 (setq sd
6671 (calendar-absolute-from-iso
6672 (list n 1
6673 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
6674 ((eq span 'month)
6675 (let (y1)
6676 (when (and n (> n 99))
6677 (setq y1 (org-small-year-to-year (/ n 100))
6678 n (mod n 100)))
6679 (setq sd (calendar-absolute-from-gregorian
6680 (list (or n mg) 1 (or y1 yg))))))
6681 ((eq span 'year)
6682 (setq sd (calendar-absolute-from-gregorian
6683 (list 1 1 (or n yg))))))
6684 sd))
6686 (defun org-agenda-next-date-line (&optional arg)
6687 "Jump to the next line indicating a date in agenda buffer."
6688 (interactive "p")
6689 (org-agenda-check-type t 'agenda 'timeline)
6690 (beginning-of-line 1)
6691 ;; This does not work if user makes date format that starts with a blank
6692 (if (looking-at "^\\S-") (forward-char 1))
6693 (if (not (re-search-forward "^\\S-" nil t arg))
6694 (progn
6695 (backward-char 1)
6696 (error "No next date after this line in this buffer")))
6697 (goto-char (match-beginning 0)))
6699 (defun org-agenda-previous-date-line (&optional arg)
6700 "Jump to the previous line indicating a date in agenda buffer."
6701 (interactive "p")
6702 (org-agenda-check-type t 'agenda 'timeline)
6703 (beginning-of-line 1)
6704 (if (not (re-search-backward "^\\S-" nil t arg))
6705 (error "No previous date before this line in this buffer")))
6707 ;; Initialize the highlight
6708 (defvar org-hl (make-overlay 1 1))
6709 (overlay-put org-hl 'face 'highlight)
6711 (defun org-highlight (begin end &optional buffer)
6712 "Highlight a region with overlay."
6713 (move-overlay org-hl begin end (or buffer (current-buffer))))
6715 (defun org-unhighlight ()
6716 "Detach overlay INDEX."
6717 (org-detach-overlay org-hl))
6719 ;; FIXME this is currently not used.
6720 (defun org-highlight-until-next-command (beg end &optional buffer)
6721 "Move the highlight overlay to BEG/END, remove it before the next command."
6722 (org-highlight beg end buffer)
6723 (add-hook 'pre-command-hook 'org-unhighlight-once))
6724 (defun org-unhighlight-once ()
6725 "Remove the highlight from its position, and this function from the hook."
6726 (remove-hook 'pre-command-hook 'org-unhighlight-once)
6727 (org-unhighlight))
6729 (defun org-agenda-follow-mode ()
6730 "Toggle follow mode in an agenda buffer."
6731 (interactive)
6732 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
6733 (org-agenda-set-mode-name)
6734 (org-agenda-do-context-action)
6735 (message "Follow mode is %s"
6736 (if org-agenda-follow-mode "on" "off")))
6738 (defun org-agenda-entry-text-mode (&optional arg)
6739 "Toggle entry text mode in an agenda buffer."
6740 (interactive "P")
6741 (setq org-agenda-entry-text-mode (or (integerp arg)
6742 (not org-agenda-entry-text-mode)))
6743 (org-agenda-entry-text-hide)
6744 (and org-agenda-entry-text-mode
6745 (let ((org-agenda-entry-text-maxlines
6746 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6747 (org-agenda-entry-text-show)))
6748 (org-agenda-set-mode-name)
6749 (message "Entry text mode is %s. Maximum number of lines is %d"
6750 (if org-agenda-entry-text-mode "on" "off")
6751 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6753 (defun org-agenda-clockreport-mode (&optional with-filter)
6754 "Toggle clocktable mode in an agenda buffer.
6755 With prefix arg WITH-FILTER, make the clocktable respect the current
6756 agenda filter."
6757 (interactive "P")
6758 (org-agenda-check-type t 'agenda)
6759 (if with-filter
6760 (setq org-agenda-clockreport-mode 'with-filter)
6761 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
6762 (org-agenda-set-mode-name)
6763 (org-agenda-redo)
6764 (message "Clocktable mode is %s"
6765 (if org-agenda-clockreport-mode "on" "off")))
6767 (defun org-agenda-log-mode (&optional special)
6768 "Toggle log mode in an agenda buffer.
6769 With argument SPECIAL, show all possible log items, not only the ones
6770 configured in `org-agenda-log-mode-items'.
6771 With a double `C-u' prefix arg, show *only* log items, nothing else."
6772 (interactive "P")
6773 (org-agenda-check-type t 'agenda 'timeline)
6774 (setq org-agenda-show-log
6775 (cond
6776 ((equal special '(16)) 'only)
6777 ((eq special 'clockcheck)
6778 (if (eq org-agenda-show-log 'clockcheck)
6779 nil 'clockcheck))
6780 (special '(closed clock state))
6781 (t (not org-agenda-show-log))))
6782 (org-agenda-set-mode-name)
6783 (org-agenda-redo)
6784 (message "Log mode is %s"
6785 (if org-agenda-show-log "on" "off")))
6787 (defun org-agenda-archives-mode (&optional with-files)
6788 "Toggle inclusion of items in trees marked with :ARCHIVE:.
6789 When called with a prefix argument, include all archive files as well."
6790 (interactive "P")
6791 (setq org-agenda-archives-mode
6792 (if with-files t (if org-agenda-archives-mode nil 'trees)))
6793 (org-agenda-set-mode-name)
6794 (org-agenda-redo)
6795 (message
6796 "%s"
6797 (cond
6798 ((eq org-agenda-archives-mode nil)
6799 "No archives are included")
6800 ((eq org-agenda-archives-mode 'trees)
6801 (format "Trees with :%s: tag are included" org-archive-tag))
6802 ((eq org-agenda-archives-mode t)
6803 (format "Trees with :%s: tag and all active archive files are included"
6804 org-archive-tag)))))
6806 (defun org-agenda-toggle-diary ()
6807 "Toggle diary inclusion in an agenda buffer."
6808 (interactive)
6809 (org-agenda-check-type t 'agenda)
6810 (setq org-agenda-include-diary (not org-agenda-include-diary))
6811 (org-agenda-redo)
6812 (org-agenda-set-mode-name)
6813 (message "Diary inclusion turned %s"
6814 (if org-agenda-include-diary "on" "off")))
6816 (defun org-agenda-toggle-deadlines ()
6817 "Toggle inclusion of entries with a deadline in an agenda buffer."
6818 (interactive)
6819 (org-agenda-check-type t 'agenda)
6820 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
6821 (org-agenda-redo)
6822 (org-agenda-set-mode-name)
6823 (message "Deadlines inclusion turned %s"
6824 (if org-agenda-include-deadlines "on" "off")))
6826 (defun org-agenda-toggle-time-grid ()
6827 "Toggle time grid in an agenda buffer."
6828 (interactive)
6829 (org-agenda-check-type t 'agenda)
6830 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
6831 (org-agenda-redo)
6832 (org-agenda-set-mode-name)
6833 (message "Time-grid turned %s"
6834 (if org-agenda-use-time-grid "on" "off")))
6836 (defun org-agenda-set-mode-name ()
6837 "Set the mode name to indicate all the small mode settings."
6838 (setq mode-name
6839 (list "Org-Agenda"
6840 (if (get 'org-agenda-files 'org-restrict) " []" "")
6842 '(:eval (org-agenda-span-name org-agenda-current-span))
6843 (if org-agenda-follow-mode " Follow" "")
6844 (if org-agenda-entry-text-mode " ETxt" "")
6845 (if org-agenda-include-diary " Diary" "")
6846 (if org-agenda-include-deadlines " Ddl" "")
6847 (if org-agenda-use-time-grid " Grid" "")
6848 (if (and (boundp 'org-habit-show-habits)
6849 org-habit-show-habits) " Habit" "")
6850 (cond
6851 ((consp org-agenda-show-log) " LogAll")
6852 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
6853 (org-agenda-show-log " Log")
6854 (t ""))
6855 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
6856 :preset-filter))
6857 '(:eval (org-propertize
6858 (concat " <"
6859 (mapconcat
6860 'identity
6861 (append
6862 (get 'org-agenda-category-filter :preset-filter)
6863 org-agenda-category-filter)
6865 ">")
6866 'face 'org-agenda-filter-category
6867 'help-echo "Category used in filtering"))
6869 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
6870 :preset-filter))
6871 '(:eval (org-propertize
6872 (concat " {"
6873 (mapconcat
6874 'identity
6875 (append
6876 (get 'org-agenda-tag-filter :preset-filter)
6877 org-agenda-tag-filter)
6879 "}")
6880 'face 'org-agenda-filter-tags
6881 'help-echo "Tags used in filtering"))
6883 (if org-agenda-archives-mode
6884 (if (eq org-agenda-archives-mode t)
6885 " Archives"
6886 (format " :%s:" org-archive-tag))
6888 (if org-agenda-clockreport-mode
6889 (if (eq org-agenda-clockreport-mode 'with-filter)
6890 " Clock{}" " Clock")
6891 "")))
6892 (force-mode-line-update))
6894 (defun org-agenda-post-command-hook ()
6895 (setq org-agenda-type
6896 (or (get-text-property (point) 'org-agenda-type)
6897 (get-text-property (max (point-min) (1- (point)))
6898 'org-agenda-type))))
6900 (defun org-agenda-next-line ()
6901 "Move cursor to the next line, and show if follow mode is active."
6902 (interactive)
6903 (call-interactively 'next-line)
6904 (org-agenda-do-context-action))
6906 (defun org-agenda-previous-line ()
6907 "Move cursor to the previous line, and show if follow-mode is active."
6908 (interactive)
6909 (call-interactively 'previous-line)
6910 (org-agenda-do-context-action))
6912 (defun org-agenda-do-context-action ()
6913 "Show outline path and, maybe, follow mode window."
6914 (let ((m (org-get-at-bol 'org-marker)))
6915 (when (and (markerp m) (marker-buffer m))
6916 (and org-agenda-follow-mode
6917 (if org-agenda-follow-indirect
6918 (org-agenda-tree-to-indirect-buffer)
6919 (org-agenda-show)))
6920 (and org-agenda-show-outline-path
6921 (org-with-point-at m (org-display-outline-path t))))))
6923 (defun org-agenda-show-priority ()
6924 "Show the priority of the current item.
6925 This priority is composed of the main priority given with the [#A] cookies,
6926 and by additional input from the age of a schedules or deadline entry."
6927 (interactive)
6928 (let* ((pri (org-get-at-bol 'priority)))
6929 (message "Priority is %d" (if pri pri -1000))))
6931 (defun org-agenda-show-tags ()
6932 "Show the tags applicable to the current item."
6933 (interactive)
6934 (let* ((tags (org-get-at-bol 'tags)))
6935 (if tags
6936 (message "Tags are :%s:"
6937 (org-no-properties (mapconcat 'identity tags ":")))
6938 (message "No tags associated with this line"))))
6940 (defun org-agenda-goto (&optional highlight)
6941 "Go to the Org-mode file which contains the item at point."
6942 (interactive)
6943 (let* ((marker (or (org-get-at-bol 'org-marker)
6944 (org-agenda-error)))
6945 (buffer (marker-buffer marker))
6946 (pos (marker-position marker)))
6947 (switch-to-buffer-other-window buffer)
6948 (widen)
6949 (push-mark)
6950 (goto-char pos)
6951 (when (eq major-mode 'org-mode)
6952 (org-show-context 'agenda)
6953 (save-excursion
6954 (and (outline-next-heading)
6955 (org-flag-heading nil)))) ; show the next heading
6956 (when (outline-invisible-p)
6957 (show-entry)) ; display invisible text
6958 (recenter (/ (window-height) 2))
6959 (run-hooks 'org-agenda-after-show-hook)
6960 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
6962 (defvar org-agenda-after-show-hook nil
6963 "Normal hook run after an item has been shown from the agenda.
6964 Point is in the buffer where the item originated.")
6966 (defun org-agenda-kill ()
6967 "Kill the entry or subtree belonging to the current agenda entry."
6968 (interactive)
6969 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
6970 (let* ((marker (or (org-get-at-bol 'org-marker)
6971 (org-agenda-error)))
6972 (buffer (marker-buffer marker))
6973 (pos (marker-position marker))
6974 (type (org-get-at-bol 'type))
6975 dbeg dend (n 0) conf)
6976 (org-with-remote-undo buffer
6977 (with-current-buffer buffer
6978 (save-excursion
6979 (goto-char pos)
6980 (if (and (eq major-mode 'org-mode) (not (member type '("sexp"))))
6981 (setq dbeg (progn (org-back-to-heading t) (point))
6982 dend (org-end-of-subtree t t))
6983 (setq dbeg (point-at-bol)
6984 dend (min (point-max) (1+ (point-at-eol)))))
6985 (goto-char dbeg)
6986 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
6987 (setq conf (or (eq t org-agenda-confirm-kill)
6988 (and (numberp org-agenda-confirm-kill)
6989 (> n org-agenda-confirm-kill))))
6990 (and conf
6991 (not (y-or-n-p
6992 (format "Delete entry with %d lines in buffer \"%s\"? "
6993 n (buffer-name buffer))))
6994 (error "Abort"))
6995 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
6996 (with-current-buffer buffer (delete-region dbeg dend))
6997 (message "Agenda item and source killed"))))
6999 (defvar org-archive-default-command)
7000 (defun org-agenda-archive-default ()
7001 "Archive the entry or subtree belonging to the current agenda entry."
7002 (interactive)
7003 (require 'org-archive)
7004 (org-agenda-archive-with org-archive-default-command))
7006 (defun org-agenda-archive-default-with-confirmation ()
7007 "Archive the entry or subtree belonging to the current agenda entry."
7008 (interactive)
7009 (require 'org-archive)
7010 (org-agenda-archive-with org-archive-default-command 'confirm))
7012 (defun org-agenda-archive ()
7013 "Archive the entry or subtree belonging to the current agenda entry."
7014 (interactive)
7015 (org-agenda-archive-with 'org-archive-subtree))
7017 (defun org-agenda-archive-to-archive-sibling ()
7018 "Move the entry to the archive sibling."
7019 (interactive)
7020 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7022 (defun org-agenda-archive-with (cmd &optional confirm)
7023 "Move the entry to the archive sibling."
7024 (interactive)
7025 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7026 (let* ((marker (or (org-get-at-bol 'org-marker)
7027 (org-agenda-error)))
7028 (buffer (marker-buffer marker))
7029 (pos (marker-position marker)))
7030 (org-with-remote-undo buffer
7031 (with-current-buffer buffer
7032 (if (eq major-mode 'org-mode)
7033 (if (and confirm
7034 (not (y-or-n-p "Archive this subtree or entry? ")))
7035 (error "Abort")
7036 (save-excursion
7037 (goto-char pos)
7038 (org-remove-subtree-entries-from-agenda)
7039 (org-back-to-heading t)
7040 (funcall cmd)))
7041 (error "Archiving works only in Org-mode files"))))))
7043 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7044 "Remove all lines in the agenda that correspond to a given subtree.
7045 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7046 If this information is not given, the function uses the tree at point."
7047 (let ((buf (or buf (current-buffer))) m p)
7048 (save-excursion
7049 (unless (and beg end)
7050 (org-back-to-heading t)
7051 (setq beg (point))
7052 (org-end-of-subtree t)
7053 (setq end (point)))
7054 (set-buffer (get-buffer org-agenda-buffer-name))
7055 (save-excursion
7056 (goto-char (point-max))
7057 (beginning-of-line 1)
7058 (while (not (bobp))
7059 (when (and (setq m (org-get-at-bol 'org-marker))
7060 (equal buf (marker-buffer m))
7061 (setq p (marker-position m))
7062 (>= p beg)
7063 (< p end))
7064 (let ((inhibit-read-only t))
7065 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7066 (beginning-of-line 0))))))
7068 (defun org-agenda-refile (&optional goto rfloc no-update)
7069 "Refile the item at point."
7070 (interactive "P")
7071 (if (equal goto '(16))
7072 (org-refile-goto-last-stored)
7073 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7074 (org-agenda-error)))
7075 (buffer (marker-buffer marker))
7076 (pos (marker-position marker))
7077 (rfloc (or rfloc
7078 (org-refile-get-location
7079 (if goto "Goto" "Refile to") buffer
7080 org-refile-allow-creating-parent-nodes))))
7081 (with-current-buffer buffer
7082 (save-excursion
7083 (save-restriction
7084 (widen)
7085 (goto-char marker)
7086 (org-remove-subtree-entries-from-agenda)
7087 (org-refile goto buffer rfloc)))))
7088 (unless no-update (org-agenda-redo))))
7090 (defun org-agenda-open-link (&optional arg)
7091 "Follow the link in the current line, if any.
7092 This looks for a link in the displayed line in the agenda. It also looks
7093 at the text of the entry itself."
7094 (interactive "P")
7095 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7096 (org-get-at-bol 'org-marker)))
7097 (buffer (and marker (marker-buffer marker)))
7098 (prefix (buffer-substring
7099 (point-at-bol) (point-at-eol))))
7100 (cond
7101 (buffer
7102 (with-current-buffer buffer
7103 (save-excursion
7104 (save-restriction
7105 (widen)
7106 (goto-char marker)
7107 (org-offer-links-in-entry arg prefix)))))
7108 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7109 (save-excursion
7110 (beginning-of-line 1)
7111 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7112 (org-open-link-from-string (match-string 1)))
7113 (t (error "No link to open here")))))
7115 (defun org-agenda-copy-local-variable (var)
7116 "Get a variable from a referenced buffer and install it here."
7117 (let ((m (org-get-at-bol 'org-marker)))
7118 (when (and m (buffer-live-p (marker-buffer m)))
7119 (org-set-local var (with-current-buffer (marker-buffer m)
7120 (symbol-value var))))))
7122 (defun org-agenda-switch-to (&optional delete-other-windows)
7123 "Go to the Org-mode file which contains the item at point."
7124 (interactive)
7125 (if (and org-return-follows-link
7126 (not (org-get-at-bol 'org-marker))
7127 (org-in-regexp org-bracket-link-regexp))
7128 (org-open-link-from-string (match-string 0))
7129 (let* ((marker (or (org-get-at-bol 'org-marker)
7130 (org-agenda-error)))
7131 (buffer (marker-buffer marker))
7132 (pos (marker-position marker)))
7133 (org-pop-to-buffer-same-window buffer)
7134 (and delete-other-windows (delete-other-windows))
7135 (widen)
7136 (goto-char pos)
7137 (when (eq major-mode 'org-mode)
7138 (org-show-context 'agenda)
7139 (save-excursion
7140 (and (outline-next-heading)
7141 (org-flag-heading nil))) ; show the next heading
7142 (when (outline-invisible-p)
7143 (show-entry)))))) ; display invisible text
7145 (defun org-agenda-goto-mouse (ev)
7146 "Go to the Org-mode file which contains the item at the mouse click."
7147 (interactive "e")
7148 (mouse-set-point ev)
7149 (org-agenda-goto))
7151 (defun org-agenda-show (&optional full-entry)
7152 "Display the Org-mode file which contains the item at point.
7153 With prefix argument FULL-ENTRY, make the entire entry visible
7154 if it was hidden in the outline."
7155 (interactive "P")
7156 (let ((win (selected-window)))
7157 (if full-entry
7158 (let ((org-show-entry-below t))
7159 (org-agenda-goto t))
7160 (org-agenda-goto t))
7161 (select-window win)))
7163 (defvar org-agenda-show-window nil)
7164 (defun org-agenda-show-and-scroll-up (&optional arg)
7165 "Display the Org-mode file which contains the item at point.
7166 When called repeatedly, scroll the window that is displaying the buffer.
7167 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7168 `show-subtree' to display the item, so that drawers and logbooks stay
7169 folded."
7170 (interactive "P")
7171 (let ((win (selected-window)))
7172 (if (and (window-live-p org-agenda-show-window)
7173 (eq this-command last-command))
7174 (progn
7175 (select-window org-agenda-show-window)
7176 (ignore-errors (scroll-up)))
7177 (org-agenda-goto t)
7178 (if arg (org-show-entry) (show-subtree))
7179 (setq org-agenda-show-window (selected-window)))
7180 (select-window win)))
7182 (defun org-agenda-show-scroll-down ()
7183 "Scroll down the window showing the agenda."
7184 (interactive)
7185 (let ((win (selected-window)))
7186 (when (window-live-p org-agenda-show-window)
7187 (select-window org-agenda-show-window)
7188 (ignore-errors (scroll-down))
7189 (select-window win))))
7191 (defun org-agenda-show-1 (&optional more)
7192 "Display the Org-mode file which contains the item at point.
7193 The prefix arg selects the amount of information to display:
7195 0 hide the subtree
7196 1 just show the entry according to defaults.
7197 2 show the children view
7198 3 show the subtree view
7199 4 show the entire subtree and any LOGBOOK drawers
7200 5 show the entire subtree and any drawers
7201 With prefix argument FULL-ENTRY, make the entire entry visible
7202 if it was hidden in the outline."
7203 (interactive "p")
7204 (let ((win (selected-window)))
7205 (org-agenda-goto t)
7206 (org-recenter-heading 1)
7207 (cond
7208 ((= more 0)
7209 (hide-subtree)
7210 (save-excursion
7211 (org-back-to-heading)
7212 (run-hook-with-args 'org-cycle-hook 'folded))
7213 (message "Remote: FOLDED"))
7214 ((and (org-called-interactively-p 'any) (= more 1))
7215 (message "Remote: show with default settings"))
7216 ((= more 2)
7217 (show-entry)
7218 (show-children)
7219 (save-excursion
7220 (org-back-to-heading)
7221 (run-hook-with-args 'org-cycle-hook 'children))
7222 (message "Remote: CHILDREN"))
7223 ((= more 3)
7224 (show-subtree)
7225 (save-excursion
7226 (org-back-to-heading)
7227 (run-hook-with-args 'org-cycle-hook 'subtree))
7228 (message "Remote: SUBTREE"))
7229 ((= more 4)
7230 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7231 (org-drawer-regexp
7232 (concat "^[ \t]*:\\("
7233 (mapconcat 'regexp-quote org-drawers "\\|")
7234 "\\):[ \t]*$")))
7235 (show-subtree)
7236 (save-excursion
7237 (org-back-to-heading)
7238 (org-cycle-hide-drawers 'subtree)))
7239 (message "Remote: SUBTREE AND LOGBOOK"))
7240 ((> more 4)
7241 (show-subtree)
7242 (message "Remote: SUBTREE AND ALL DRAWERS")))
7243 (select-window win)))
7245 (defun org-recenter-heading (n)
7246 (save-excursion
7247 (org-back-to-heading)
7248 (recenter n)))
7250 (defvar org-agenda-cycle-counter nil)
7251 (defun org-agenda-cycle-show (&optional n)
7252 "Show the current entry in another window, with default settings.
7253 Default settings are taken from `org-show-hierarchy-above' and siblings.
7254 When use repeatedly in immediate succession, the remote entry will cycle
7255 through visibility
7257 children -> subtree -> folded
7259 When called with a numeric prefix arg, that arg will be passed through to
7260 `org-agenda-show-1'. For the interpretation of that argument, see the
7261 docstring of `org-agenda-show-1'."
7262 (interactive "P")
7263 (if (integerp n)
7264 (setq org-agenda-cycle-counter n)
7265 (if (not (eq last-command this-command))
7266 (setq org-agenda-cycle-counter 1)
7267 (if (equal org-agenda-cycle-counter 0)
7268 (setq org-agenda-cycle-counter 2)
7269 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7270 (if (> org-agenda-cycle-counter 3)
7271 (setq org-agenda-cycle-counter 0)))))
7272 (org-agenda-show-1 org-agenda-cycle-counter))
7274 (defun org-agenda-recenter (arg)
7275 "Display the Org-mode file which contains the item at point and recenter."
7276 (interactive "P")
7277 (let ((win (selected-window)))
7278 (org-agenda-goto t)
7279 (recenter arg)
7280 (select-window win)))
7282 (defun org-agenda-show-mouse (ev)
7283 "Display the Org-mode file which contains the item at the mouse click."
7284 (interactive "e")
7285 (mouse-set-point ev)
7286 (org-agenda-show))
7288 (defun org-agenda-check-no-diary ()
7289 "Check if the entry is a diary link and abort if yes."
7290 (if (org-get-at-bol 'org-agenda-diary-link)
7291 (org-agenda-error)))
7293 (defun org-agenda-error ()
7294 (error "Command not allowed in this line"))
7296 (defun org-agenda-tree-to-indirect-buffer ()
7297 "Show the subtree corresponding to the current entry in an indirect buffer.
7298 This calls the command `org-tree-to-indirect-buffer' from the original
7299 Org-mode buffer.
7300 With numerical prefix arg ARG, go up to this level and then take that tree.
7301 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7302 use the dedicated frame)."
7303 (interactive)
7304 (if (and current-prefix-arg (listp current-prefix-arg))
7305 (org-agenda-do-tree-to-indirect-buffer)
7306 (let ((agenda-window (selected-window))
7307 (indirect-window (get-buffer-window org-last-indirect-buffer)))
7308 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7309 (unwind-protect
7310 (progn
7311 (unless indirect-window
7312 (setq indirect-window (split-window agenda-window)))
7313 (select-window indirect-window)
7314 (switch-to-buffer org-last-indirect-buffer :norecord)
7315 (fit-window-to-buffer indirect-window))
7316 (select-window agenda-window)))))
7318 (defun org-agenda-do-tree-to-indirect-buffer ()
7319 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7320 (org-agenda-check-no-diary)
7321 (let* ((marker (or (org-get-at-bol 'org-marker)
7322 (org-agenda-error)))
7323 (buffer (marker-buffer marker))
7324 (pos (marker-position marker)))
7325 (with-current-buffer buffer
7326 (save-excursion
7327 (goto-char pos)
7328 (call-interactively 'org-tree-to-indirect-buffer)))))
7330 (defvar org-last-heading-marker (make-marker)
7331 "Marker pointing to the headline that last changed its TODO state
7332 by a remote command from the agenda.")
7334 (defun org-agenda-todo-nextset ()
7335 "Switch TODO entry to next sequence."
7336 (interactive)
7337 (org-agenda-todo 'nextset))
7339 (defun org-agenda-todo-previousset ()
7340 "Switch TODO entry to previous sequence."
7341 (interactive)
7342 (org-agenda-todo 'previousset))
7344 (defun org-agenda-todo (&optional arg)
7345 "Cycle TODO state of line at point, also in Org-mode file.
7346 This changes the line at point, all other lines in the agenda referring to
7347 the same tree node, and the headline of the tree node in the Org-mode file."
7348 (interactive "P")
7349 (org-agenda-check-no-diary)
7350 (let* ((col (current-column))
7351 (marker (or (org-get-at-bol 'org-marker)
7352 (org-agenda-error)))
7353 (buffer (marker-buffer marker))
7354 (pos (marker-position marker))
7355 (hdmarker (org-get-at-bol 'org-hd-marker))
7356 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7357 (inhibit-read-only t)
7358 org-agenda-headline-snapshot-before-repeat newhead just-one)
7359 (org-with-remote-undo buffer
7360 (with-current-buffer buffer
7361 (widen)
7362 (goto-char pos)
7363 (org-show-context 'agenda)
7364 (save-excursion
7365 (and (outline-next-heading)
7366 (org-flag-heading nil))) ; show the next heading
7367 (let ((current-prefix-arg arg))
7368 (call-interactively 'org-todo))
7369 (and (bolp) (forward-char 1))
7370 (setq newhead (org-get-heading))
7371 (when (and (org-bound-and-true-p
7372 org-agenda-headline-snapshot-before-repeat)
7373 (not (equal org-agenda-headline-snapshot-before-repeat
7374 newhead))
7375 todayp)
7376 (setq newhead org-agenda-headline-snapshot-before-repeat
7377 just-one t))
7378 (save-excursion
7379 (org-back-to-heading)
7380 (move-marker org-last-heading-marker (point))))
7381 (beginning-of-line 1)
7382 (save-excursion
7383 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7384 (org-move-to-column col))))
7386 (defun org-agenda-add-note (&optional arg)
7387 "Add a time-stamped note to the entry at point."
7388 (interactive "P")
7389 (org-agenda-check-no-diary)
7390 (let* ((marker (or (org-get-at-bol 'org-marker)
7391 (org-agenda-error)))
7392 (buffer (marker-buffer marker))
7393 (pos (marker-position marker))
7394 (hdmarker (org-get-at-bol 'org-hd-marker))
7395 (inhibit-read-only t))
7396 (with-current-buffer buffer
7397 (widen)
7398 (goto-char pos)
7399 (org-show-context 'agenda)
7400 (save-excursion
7401 (and (outline-next-heading)
7402 (org-flag-heading nil))) ; show the next heading
7403 (org-add-note))))
7405 (defun org-agenda-change-all-lines (newhead hdmarker
7406 &optional fixface just-this)
7407 "Change all lines in the agenda buffer which match HDMARKER.
7408 The new content of the line will be NEWHEAD (as modified by
7409 `org-agenda-format-item'). HDMARKER is checked with
7410 `equal' against all `org-hd-marker' text properties in the file.
7411 If FIXFACE is non-nil, the face of each item is modified according to
7412 the new TODO state.
7413 If JUST-THIS is non-nil, change just the current line, not all.
7414 If FORCE-TAGS is non nil, the car of it returns the new tags."
7415 (let* ((inhibit-read-only t)
7416 (line (org-current-line))
7417 (thetags (with-current-buffer (marker-buffer hdmarker)
7418 (save-excursion (save-restriction (widen)
7419 (goto-char hdmarker)
7420 (org-get-tags-at)))))
7421 props m pl undone-face done-face finish new dotime cat tags)
7422 (save-excursion
7423 (goto-char (point-max))
7424 (beginning-of-line 1)
7425 (while (not finish)
7426 (setq finish (bobp))
7427 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7428 (or (not just-this) (= (org-current-line) line))
7429 (equal m hdmarker))
7430 (setq props (text-properties-at (point))
7431 dotime (org-get-at-bol 'dotime)
7432 cat (org-get-at-bol 'org-category)
7433 tags thetags
7435 (let ((org-prefix-format-compiled
7436 (or (get-text-property (point) 'format)
7437 org-prefix-format-compiled)))
7438 (with-current-buffer (marker-buffer hdmarker)
7439 (save-excursion
7440 (save-restriction
7441 (widen)
7442 (org-agenda-format-item (org-get-at-bol 'extra)
7443 newhead cat tags dotime)))))
7444 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7445 undone-face (org-get-at-bol 'undone-face)
7446 done-face (org-get-at-bol 'done-face))
7447 (beginning-of-line 1)
7448 (cond
7449 ((equal new "")
7450 (and (looking-at ".*\n?") (replace-match "")))
7451 ((looking-at ".*")
7452 (replace-match new t t)
7453 (beginning-of-line 1)
7454 (add-text-properties (point-at-bol) (point-at-eol) props)
7455 (when fixface
7456 (add-text-properties
7457 (point-at-bol) (point-at-eol)
7458 (list 'face
7459 (if org-last-todo-state-is-todo
7460 undone-face done-face))))
7461 (org-agenda-highlight-todo 'line)
7462 (beginning-of-line 1))
7463 (t (error "Line update did not work"))))
7464 (beginning-of-line 0)))
7465 (org-finalize-agenda)))
7467 (defun org-agenda-align-tags (&optional line)
7468 "Align all tags in agenda items to `org-agenda-tags-column'."
7469 (let ((inhibit-read-only t) l c)
7470 (save-excursion
7471 (goto-char (if line (point-at-bol) (point-min)))
7472 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7473 (if line (point-at-eol) nil) t)
7474 (add-text-properties
7475 (match-beginning 2) (match-end 2)
7476 (list 'face (delq nil (let ((prop (get-text-property
7477 (match-beginning 2) 'face)))
7478 (or (listp prop) (setq prop (list prop)))
7479 (if (memq 'org-tag prop)
7480 prop
7481 (cons 'org-tag prop))))))
7482 (setq l (- (match-end 2) (match-beginning 2))
7483 c (if (< org-agenda-tags-column 0)
7484 (- (abs org-agenda-tags-column) l)
7485 org-agenda-tags-column))
7486 (delete-region (match-beginning 1) (match-end 1))
7487 (goto-char (match-beginning 1))
7488 (insert (org-add-props
7489 (make-string (max 1 (- c (current-column))) ?\ )
7490 (plist-put (copy-sequence (text-properties-at (point)))
7491 'face nil))))
7492 (goto-char (point-min))
7493 (org-font-lock-add-tag-faces (point-max)))))
7495 (defun org-agenda-priority-up ()
7496 "Increase the priority of line at point, also in Org-mode file."
7497 (interactive)
7498 (org-agenda-priority 'up))
7500 (defun org-agenda-priority-down ()
7501 "Decrease the priority of line at point, also in Org-mode file."
7502 (interactive)
7503 (org-agenda-priority 'down))
7505 (defun org-agenda-priority (&optional force-direction)
7506 "Set the priority of line at point, also in Org-mode file.
7507 This changes the line at point, all other lines in the agenda referring to
7508 the same tree node, and the headline of the tree node in the Org-mode file."
7509 (interactive)
7510 (unless org-enable-priority-commands
7511 (error "Priority commands are disabled"))
7512 (org-agenda-check-no-diary)
7513 (let* ((marker (or (org-get-at-bol 'org-marker)
7514 (org-agenda-error)))
7515 (hdmarker (org-get-at-bol 'org-hd-marker))
7516 (buffer (marker-buffer hdmarker))
7517 (pos (marker-position hdmarker))
7518 (inhibit-read-only t)
7519 newhead)
7520 (org-with-remote-undo buffer
7521 (with-current-buffer buffer
7522 (widen)
7523 (goto-char pos)
7524 (org-show-context 'agenda)
7525 (save-excursion
7526 (and (outline-next-heading)
7527 (org-flag-heading nil))) ; show the next heading
7528 (funcall 'org-priority force-direction)
7529 (end-of-line 1)
7530 (setq newhead (org-get-heading)))
7531 (org-agenda-change-all-lines newhead hdmarker)
7532 (beginning-of-line 1))))
7534 ;; FIXME: should fix the tags property of the agenda line.
7535 (defun org-agenda-set-tags (&optional tag onoff)
7536 "Set tags for the current headline."
7537 (interactive)
7538 (org-agenda-check-no-diary)
7539 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7540 (call-interactively 'org-change-tag-in-region)
7541 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7542 (org-agenda-error)))
7543 (buffer (marker-buffer hdmarker))
7544 (pos (marker-position hdmarker))
7545 (inhibit-read-only t)
7546 newhead)
7547 (org-with-remote-undo buffer
7548 (with-current-buffer buffer
7549 (widen)
7550 (goto-char pos)
7551 (save-excursion
7552 (org-show-context 'agenda))
7553 (save-excursion
7554 (and (outline-next-heading)
7555 (org-flag-heading nil))) ; show the next heading
7556 (goto-char pos)
7557 (if tag
7558 (org-toggle-tag tag onoff)
7559 (call-interactively 'org-set-tags))
7560 (end-of-line 1)
7561 (setq newhead (org-get-heading)))
7562 (org-agenda-change-all-lines newhead hdmarker)
7563 (beginning-of-line 1)))))
7565 (defun org-agenda-set-property ()
7566 "Set a property for the current headline."
7567 (interactive)
7568 (org-agenda-check-no-diary)
7569 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7570 (org-agenda-error)))
7571 (buffer (marker-buffer hdmarker))
7572 (pos (marker-position hdmarker))
7573 (inhibit-read-only t)
7574 newhead)
7575 (org-with-remote-undo buffer
7576 (with-current-buffer buffer
7577 (widen)
7578 (goto-char pos)
7579 (save-excursion
7580 (org-show-context 'agenda))
7581 (save-excursion
7582 (and (outline-next-heading)
7583 (org-flag-heading nil))) ; show the next heading
7584 (goto-char pos)
7585 (call-interactively 'org-set-property)))))
7587 (defun org-agenda-set-effort ()
7588 "Set the effort property for the current headline."
7589 (interactive)
7590 (org-agenda-check-no-diary)
7591 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7592 (org-agenda-error)))
7593 (buffer (marker-buffer hdmarker))
7594 (pos (marker-position hdmarker))
7595 (inhibit-read-only t)
7596 newhead)
7597 (org-with-remote-undo buffer
7598 (with-current-buffer buffer
7599 (widen)
7600 (goto-char pos)
7601 (save-excursion
7602 (org-show-context 'agenda))
7603 (save-excursion
7604 (and (outline-next-heading)
7605 (org-flag-heading nil))) ; show the next heading
7606 (goto-char pos)
7607 (call-interactively 'org-set-effort)
7608 (end-of-line 1)
7609 (setq newhead (org-get-heading)))
7610 (org-agenda-change-all-lines newhead hdmarker))))
7612 (defun org-agenda-toggle-archive-tag ()
7613 "Toggle the archive tag for the current entry."
7614 (interactive)
7615 (org-agenda-check-no-diary)
7616 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7617 (org-agenda-error)))
7618 (buffer (marker-buffer hdmarker))
7619 (pos (marker-position hdmarker))
7620 (inhibit-read-only t)
7621 newhead)
7622 (org-with-remote-undo buffer
7623 (with-current-buffer buffer
7624 (widen)
7625 (goto-char pos)
7626 (org-show-context 'agenda)
7627 (save-excursion
7628 (and (outline-next-heading)
7629 (org-flag-heading nil))) ; show the next heading
7630 (call-interactively 'org-toggle-archive-tag)
7631 (end-of-line 1)
7632 (setq newhead (org-get-heading)))
7633 (org-agenda-change-all-lines newhead hdmarker)
7634 (beginning-of-line 1))))
7636 (defun org-agenda-do-date-later (arg)
7637 (interactive "P")
7638 (cond
7639 ((or (equal arg '(16))
7640 (memq last-command
7641 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7642 (setq this-command 'org-agenda-date-later-minutes)
7643 (org-agenda-date-later-minutes 1))
7644 ((or (equal arg '(4))
7645 (memq last-command
7646 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7647 (setq this-command 'org-agenda-date-later-hours)
7648 (org-agenda-date-later-hours 1))
7650 (org-agenda-date-later (prefix-numeric-value arg)))))
7652 (defun org-agenda-do-date-earlier (arg)
7653 (interactive "P")
7654 (cond
7655 ((or (equal arg '(16))
7656 (memq last-command
7657 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7658 (setq this-command 'org-agenda-date-earlier-minutes)
7659 (org-agenda-date-earlier-minutes 1))
7660 ((or (equal arg '(4))
7661 (memq last-command
7662 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7663 (setq this-command 'org-agenda-date-earlier-hours)
7664 (org-agenda-date-earlier-hours 1))
7666 (org-agenda-date-earlier (prefix-numeric-value arg)))))
7668 (defun org-agenda-date-later (arg &optional what)
7669 "Change the date of this item to ARG day(s) later."
7670 (interactive "p")
7671 (org-agenda-check-type t 'agenda 'timeline)
7672 (org-agenda-check-no-diary)
7673 (let* ((marker (or (org-get-at-bol 'org-marker)
7674 (org-agenda-error)))
7675 (buffer (marker-buffer marker))
7676 (pos (marker-position marker))
7677 cdate today)
7678 (org-with-remote-undo buffer
7679 (with-current-buffer buffer
7680 (widen)
7681 (goto-char pos)
7682 (if (not (org-at-timestamp-p))
7683 (error "Cannot find time stamp"))
7684 (when (and org-agenda-move-date-from-past-immediately-to-today
7685 (equal arg 1)
7686 (or (not what) (eq what 'day))
7687 (not (save-match-data (org-at-date-range-p))))
7688 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
7689 cdate (calendar-absolute-from-gregorian
7690 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
7691 today (org-today))
7692 (if (> today cdate)
7693 ;; immediately shift to today
7694 (setq arg (- today cdate))))
7695 (org-timestamp-change arg (or what 'day))
7696 (when (and (org-at-date-range-p)
7697 (re-search-backward org-tr-regexp-both (point-at-bol)))
7698 (let ((end org-last-changed-timestamp))
7699 (org-timestamp-change arg (or what 'day))
7700 (setq org-last-changed-timestamp
7701 (concat org-last-changed-timestamp "--" end)))))
7702 (org-agenda-show-new-time marker org-last-changed-timestamp))
7703 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7705 (defun org-agenda-date-earlier (arg &optional what)
7706 "Change the date of this item to ARG day(s) earlier."
7707 (interactive "p")
7708 (org-agenda-date-later (- arg) what))
7710 (defun org-agenda-date-later-minutes (arg)
7711 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7712 (interactive "p")
7713 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7714 (org-agenda-date-later arg 'minute))
7716 (defun org-agenda-date-earlier-minutes (arg)
7717 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7718 (interactive "p")
7719 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7720 (org-agenda-date-earlier arg 'minute))
7722 (defun org-agenda-date-later-hours (arg)
7723 "Change the time of this item, in hour steps."
7724 (interactive "p")
7725 (org-agenda-date-later arg 'hour))
7727 (defun org-agenda-date-earlier-hours (arg)
7728 "Change the time of this item, in hour steps."
7729 (interactive "p")
7730 (org-agenda-date-earlier arg 'hour))
7732 (defun org-agenda-show-new-time (marker stamp &optional prefix)
7733 "Show new date stamp via text properties."
7734 ;; We use text properties to make this undoable
7735 (let ((inhibit-read-only t)
7736 (buffer-invisibility-spec))
7737 (setq stamp (concat " " prefix " => " stamp))
7738 (save-excursion
7739 (goto-char (point-max))
7740 (while (not (bobp))
7741 (when (equal marker (org-get-at-bol 'org-marker))
7742 (org-move-to-column (- (window-width) (length stamp)) t)
7743 (org-agenda-fix-tags-filter-overlays-at (point))
7744 (if (featurep 'xemacs)
7745 ;; Use `duplicable' property to trigger undo recording
7746 (let ((ex (make-extent nil nil))
7747 (gl (make-glyph stamp)))
7748 (set-glyph-face gl 'secondary-selection)
7749 (set-extent-properties
7750 ex (list 'invisible t 'end-glyph gl 'duplicable t))
7751 (insert-extent ex (1- (point)) (point-at-eol)))
7752 (add-text-properties
7753 (1- (point)) (point-at-eol)
7754 (list 'display (org-add-props stamp nil
7755 'face 'secondary-selection))))
7756 (beginning-of-line 1))
7757 (beginning-of-line 0)))))
7759 (defun org-agenda-date-prompt (arg)
7760 "Change the date of this item. Date is prompted for, with default today.
7761 The prefix ARG is passed to the `org-time-stamp' command and can therefore
7762 be used to request time specification in the time stamp."
7763 (interactive "P")
7764 (org-agenda-check-type t 'agenda 'timeline)
7765 (org-agenda-check-no-diary)
7766 (let* ((marker (or (org-get-at-bol 'org-marker)
7767 (org-agenda-error)))
7768 (buffer (marker-buffer marker))
7769 (pos (marker-position marker)))
7770 (org-with-remote-undo buffer
7771 (with-current-buffer buffer
7772 (widen)
7773 (goto-char pos)
7774 (if (not (org-at-timestamp-p t))
7775 (error "Cannot find time stamp"))
7776 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
7777 (org-agenda-show-new-time marker org-last-changed-timestamp))
7778 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7780 (defun org-agenda-schedule (arg &optional time)
7781 "Schedule the item at point.
7782 ARG is passed through to `org-schedule'."
7783 (interactive "P")
7784 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
7785 (org-agenda-check-no-diary)
7786 (let* ((marker (or (org-get-at-bol 'org-marker)
7787 (org-agenda-error)))
7788 (type (marker-insertion-type marker))
7789 (buffer (marker-buffer marker))
7790 (pos (marker-position marker))
7791 (org-insert-labeled-timestamps-at-point nil)
7793 (set-marker-insertion-type marker t)
7794 (org-with-remote-undo buffer
7795 (with-current-buffer buffer
7796 (widen)
7797 (goto-char pos)
7798 (setq ts (org-schedule arg time)))
7799 (org-agenda-show-new-time marker ts "S"))
7800 (message "Item scheduled for %s" ts)))
7802 (defun org-agenda-deadline (arg &optional time)
7803 "Schedule the item at point.
7804 ARG is passed through to `org-deadline'."
7805 (interactive "P")
7806 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
7807 (org-agenda-check-no-diary)
7808 (let* ((marker (or (org-get-at-bol 'org-marker)
7809 (org-agenda-error)))
7810 (buffer (marker-buffer marker))
7811 (pos (marker-position marker))
7812 (org-insert-labeled-timestamps-at-point nil)
7814 (org-with-remote-undo buffer
7815 (with-current-buffer buffer
7816 (widen)
7817 (goto-char pos)
7818 (setq ts (org-deadline arg time)))
7819 (org-agenda-show-new-time marker ts "D"))
7820 (message "Deadline for this item set to %s" ts)))
7822 (defun org-agenda-action ()
7823 "Select entry for agenda action, or execute an agenda action.
7824 This command prompts for another letter. Valid inputs are:
7826 m Mark the entry at point for an agenda action
7827 s Schedule the marked entry to the date at the cursor
7828 d Set the deadline of the marked entry to the date at the cursor
7829 r Call `org-remember' with cursor date as the default date
7830 c Call `org-capture' with cursor date as the default date
7831 SPC Show marked entry in other window
7832 TAB Visit marked entry in other window
7834 The cursor may be at a date in the calendar, or in the Org agenda."
7835 (interactive)
7836 (let (ans)
7837 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
7838 (setq ans (read-char-exclusive))
7839 (cond
7840 ((equal ans ?m)
7841 ;; Mark this entry
7842 (if (eq major-mode 'org-agenda-mode)
7843 (let ((m (or (org-get-at-bol 'org-hd-marker)
7844 (org-get-at-bol 'org-marker))))
7845 (if m
7846 (progn
7847 (move-marker org-agenda-action-marker
7848 (marker-position m) (marker-buffer m))
7849 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
7850 (error "Don't know which entry to mark")))
7851 (error "This command works only in the agenda")))
7852 ((equal ans ?s)
7853 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
7854 ((equal ans ?d)
7855 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
7856 ((equal ans ?r)
7857 (org-agenda-do-action '(org-remember) t))
7858 ((equal ans ?c)
7859 (org-agenda-do-action '(org-capture) t))
7860 ((equal ans ?\ )
7861 (let ((cw (selected-window)))
7862 (org-switch-to-buffer-other-window
7863 (marker-buffer org-agenda-action-marker))
7864 (goto-char org-agenda-action-marker)
7865 (org-show-context 'agenda)
7866 (select-window cw)))
7867 ((equal ans ?\C-i)
7868 (org-switch-to-buffer-other-window
7869 (marker-buffer org-agenda-action-marker))
7870 (goto-char org-agenda-action-marker)
7871 (org-show-context 'agenda))
7872 (t (error "Invalid agenda action %c" ans)))))
7874 (defun org-agenda-do-action (form &optional current-buffer)
7875 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
7876 (let ((org-overriding-default-time (org-get-cursor-date)))
7877 (if current-buffer
7878 (eval form)
7879 (if (not (marker-buffer org-agenda-action-marker))
7880 (error "No entry has been selected for agenda action")
7881 (with-current-buffer (marker-buffer org-agenda-action-marker)
7882 (save-excursion
7883 (save-restriction
7884 (widen)
7885 (goto-char org-agenda-action-marker)
7886 (eval form))))))))
7888 (defun org-agenda-clock-in (&optional arg)
7889 "Start the clock on the currently selected item."
7890 (interactive "P")
7891 (org-agenda-check-no-diary)
7892 (if (equal arg '(4))
7893 (org-clock-in arg)
7894 (let* ((marker (or (org-get-at-bol 'org-marker)
7895 (org-agenda-error)))
7896 (hdmarker (or (org-get-at-bol 'org-hd-marker)
7897 marker))
7898 (pos (marker-position marker))
7899 newhead)
7900 (org-with-remote-undo (marker-buffer marker)
7901 (with-current-buffer (marker-buffer marker)
7902 (widen)
7903 (goto-char pos)
7904 (org-show-context 'agenda)
7905 (org-show-entry)
7906 (org-cycle-hide-drawers 'children)
7907 (org-clock-in arg)
7908 (setq newhead (org-get-heading)))
7909 (org-agenda-change-all-lines newhead hdmarker)))))
7911 (defun org-agenda-clock-out ()
7912 "Stop the currently running clock."
7913 (interactive)
7914 (unless (marker-buffer org-clock-marker)
7915 (error "No running clock"))
7916 (let ((marker (make-marker)) newhead)
7917 (org-with-remote-undo (marker-buffer org-clock-marker)
7918 (with-current-buffer (marker-buffer org-clock-marker)
7919 (save-excursion
7920 (save-restriction
7921 (widen)
7922 (goto-char org-clock-marker)
7923 (org-back-to-heading t)
7924 (move-marker marker (point))
7925 (org-clock-out)
7926 (setq newhead (org-get-heading))))))
7927 (org-agenda-change-all-lines newhead marker)
7928 (move-marker marker nil)))
7930 (defun org-agenda-clock-cancel (&optional arg)
7931 "Cancel the currently running clock."
7932 (interactive "P")
7933 (unless (marker-buffer org-clock-marker)
7934 (error "No running clock"))
7935 (org-with-remote-undo (marker-buffer org-clock-marker)
7936 (org-clock-cancel)))
7938 (defun org-agenda-clock-goto ()
7939 "Jump to the currently clocked in task within the agenda.
7940 If the currently clocked in task is not listed in the agenda
7941 buffer, display it in another window."
7942 (interactive)
7943 (let (pos)
7944 (mapc (lambda (o)
7945 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
7946 (setq pos (overlay-start o))))
7947 (overlays-in (point-min) (point-max)))
7948 (cond (pos (goto-char pos))
7949 ;; If the currently clocked entry is not in the agenda
7950 ;; buffer, we visit it in another window:
7951 (org-clock-current-task
7952 (org-switch-to-buffer-other-window (org-clock-goto)))
7953 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
7955 (defun org-agenda-diary-entry-in-org-file ()
7956 "Make a diary entry in the file `org-agenda-diary-file'."
7957 (let (d1 d2 char (text "") dp1 dp2)
7958 (if (equal (buffer-name) "*Calendar*")
7959 (setq d1 (calendar-cursor-to-date t)
7960 d2 (car calendar-mark-ring))
7961 (setq dp1 (get-text-property (point-at-bol) 'day))
7962 (unless dp1 (error "No date defined in current line"))
7963 (setq d1 (calendar-gregorian-from-absolute dp1)
7964 d2 (and (ignore-errors (mark))
7965 (save-excursion
7966 (goto-char (mark))
7967 (setq dp2 (get-text-property (point-at-bol) 'day)))
7968 (calendar-gregorian-from-absolute dp2))))
7969 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
7970 (setq char (read-char-exclusive))
7971 (cond
7972 ((equal char ?d)
7973 (setq text (read-string "Day entry: "))
7974 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
7975 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
7976 ((equal char ?a)
7977 (setq d1 (list (car d1) (nth 1 d1)
7978 (read-number (format "Reference year [%d]: " (nth 2 d1))
7979 (nth 2 d1))))
7980 (setq text (read-string "Anniversary (use %d to show years): "))
7981 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
7982 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
7983 ((equal char ?b)
7984 (setq text (read-string "Block entry: "))
7985 (unless (and d1 d2 (not (equal d1 d2)))
7986 (error "No block of days selected"))
7987 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
7988 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
7989 ((equal char ?j)
7990 (org-switch-to-buffer-other-window
7991 (find-file-noselect org-agenda-diary-file))
7992 (require 'org-datetree)
7993 (org-datetree-find-date-create d1)
7994 (org-reveal t))
7995 (t (error "Invalid selection character `%c'" char)))))
7997 (defcustom org-agenda-insert-diary-strategy 'date-tree
7998 "Where in `org-agenda-diary-file' should new entries be added?
7999 Valid values:
8001 date-tree in the date tree, as child of the date
8002 top-level as top-level entries at the end of the file."
8003 :group 'org-agenda
8004 :type '(choice
8005 (const :tag "in a date tree" date-tree)
8006 (const :tag "as top level at end of file" top-level)))
8008 (defcustom org-agenda-insert-diary-extract-time nil
8009 "Non-nil means extract any time specification from the diary entry."
8010 :group 'org-agenda
8011 :version "24.1"
8012 :type 'boolean)
8014 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8015 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8016 If TEXT is not empty, it will become the headline of the new entry, and
8017 the resulting entry will not be shown. When TEXT is empty, switch to
8018 `org-agenda-diary-file' and let the user finish the entry there."
8019 (let ((cw (current-window-configuration)))
8020 (org-switch-to-buffer-other-window
8021 (find-file-noselect org-agenda-diary-file))
8022 (widen)
8023 (goto-char (point-min))
8024 (cond
8025 ((eq type 'anniversary)
8026 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8027 (progn
8028 (or (org-at-heading-p t)
8029 (progn
8030 (outline-next-heading)
8031 (insert "* Anniversaries\n\n")
8032 (beginning-of-line -1)))))
8033 (outline-next-heading)
8034 (org-back-over-empty-lines)
8035 (backward-char 1)
8036 (insert "\n")
8037 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8038 (nth 2 d1) (car d1) (nth 1 d1) text)))
8039 ((eq type 'day)
8040 (let ((org-prefix-has-time t)
8041 (org-agenda-time-leading-zero t)
8042 fmt time time2)
8043 (if org-agenda-insert-diary-extract-time
8044 ;; Use org-agenda-format-item to parse text for a time-range and
8045 ;; remove it. FIXME: This is a hack, we should refactor
8046 ;; that function to make time extraction available separately
8047 (setq fmt (org-agenda-format-item nil text nil nil t)
8048 time (get-text-property 0 'time fmt)
8049 time2 (if (> (length time) 0)
8050 ;; split-string removes trailing ...... if
8051 ;; no end time given. First space
8052 ;; separates time from date.
8053 (concat " " (car (split-string time "\\.")))
8054 nil)
8055 text (get-text-property 0 'txt fmt)))
8056 (if (eq org-agenda-insert-diary-strategy 'top-level)
8057 (org-agenda-insert-diary-as-top-level text)
8058 (require 'org-datetree)
8059 (org-datetree-find-date-create d1)
8060 (org-agenda-insert-diary-make-new-entry text))
8061 (org-insert-time-stamp (org-time-from-absolute
8062 (calendar-absolute-from-gregorian d1))
8063 nil nil nil nil time2))
8064 (end-of-line 0))
8065 ((eq type 'block)
8066 (if (> (calendar-absolute-from-gregorian d1)
8067 (calendar-absolute-from-gregorian d2))
8068 (setq d1 (prog1 d2 (setq d2 d1))))
8069 (if (eq org-agenda-insert-diary-strategy 'top-level)
8070 (org-agenda-insert-diary-as-top-level text)
8071 (require 'org-datetree)
8072 (org-datetree-find-date-create d1)
8073 (org-agenda-insert-diary-make-new-entry text))
8074 (org-insert-time-stamp (org-time-from-absolute
8075 (calendar-absolute-from-gregorian d1)))
8076 (insert "--")
8077 (org-insert-time-stamp (org-time-from-absolute
8078 (calendar-absolute-from-gregorian d2)))
8079 (end-of-line 0)))
8080 (if (string-match "\\S-" text)
8081 (progn
8082 (set-window-configuration cw)
8083 (message "%s entry added to %s"
8084 (capitalize (symbol-name type))
8085 (abbreviate-file-name org-agenda-diary-file)))
8086 (org-reveal t)
8087 (message "Please finish entry here"))))
8089 (defun org-agenda-insert-diary-as-top-level (text)
8090 "Make new entry as a top-level entry at the end of the file.
8091 Add TEXT as headline, and position the cursor in the second line so that
8092 a timestamp can be added there."
8093 (widen)
8094 (goto-char (point-max))
8095 (or (bolp) (insert "\n"))
8096 (insert "* " text "\n")
8097 (if org-adapt-indentation (org-indent-to-column 2)))
8099 (defun org-agenda-insert-diary-make-new-entry (text)
8100 "Make new entry as last child of current entry.
8101 Add TEXT as headline, and position the cursor in the second line so that
8102 a timestamp can be added there."
8103 (let ((org-show-following-heading t)
8104 (org-show-siblings t)
8105 (org-show-hierarchy-above t)
8106 (org-show-entry-below t)
8107 col)
8108 (outline-next-heading)
8109 (org-back-over-empty-lines)
8110 (or (looking-at "[ \t]*$")
8111 (progn (insert "\n") (backward-char 1)))
8112 (org-insert-heading nil t)
8113 (org-do-demote)
8114 (setq col (current-column))
8115 (insert text "\n")
8116 (if org-adapt-indentation (org-indent-to-column col))
8117 (let ((org-show-following-heading t)
8118 (org-show-siblings t)
8119 (org-show-hierarchy-above t)
8120 (org-show-entry-below t))
8121 (org-show-context))))
8123 (defun org-agenda-diary-entry ()
8124 "Make a diary entry, like the `i' command from the calendar.
8125 All the standard commands work: block, weekly etc.
8126 When `org-agenda-diary-file' points to a file,
8127 `org-agenda-diary-entry-in-org-file' is called instead to create
8128 entries in that Org-mode file."
8129 (interactive)
8130 (org-agenda-check-type t 'agenda 'timeline)
8131 (if (not (eq org-agenda-diary-file 'diary-file))
8132 (org-agenda-diary-entry-in-org-file)
8133 (require 'diary-lib)
8134 (let* ((char (progn
8135 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8136 (read-char-exclusive)))
8137 (cmd (cdr (assoc char
8138 '((?d . insert-diary-entry)
8139 (?w . insert-weekly-diary-entry)
8140 (?m . insert-monthly-diary-entry)
8141 (?y . insert-yearly-diary-entry)
8142 (?a . insert-anniversary-diary-entry)
8143 (?b . insert-block-diary-entry)
8144 (?c . insert-cyclic-diary-entry)))))
8145 (oldf (symbol-function 'calendar-cursor-to-date))
8146 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8147 (point (point))
8148 (mark (or (mark t) (point))))
8149 (unless cmd
8150 (error "No command associated with <%c>" char))
8151 (unless (and (get-text-property point 'day)
8152 (or (not (equal ?b char))
8153 (get-text-property mark 'day)))
8154 (error "Don't know which date to use for diary entry"))
8155 ;; We implement this by hacking the `calendar-cursor-to-date' function
8156 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8157 (let ((calendar-mark-ring
8158 (list (calendar-gregorian-from-absolute
8159 (or (get-text-property mark 'day)
8160 (get-text-property point 'day))))))
8161 (unwind-protect
8162 (progn
8163 (fset 'calendar-cursor-to-date
8164 (lambda (&optional error dummy)
8165 (calendar-gregorian-from-absolute
8166 (get-text-property point 'day))))
8167 (call-interactively cmd))
8168 (fset 'calendar-cursor-to-date oldf))))))
8170 (defun org-agenda-execute-calendar-command (cmd)
8171 "Execute a calendar command from the agenda, with the date associated to
8172 the cursor position."
8173 (org-agenda-check-type t 'agenda 'timeline)
8174 (require 'diary-lib)
8175 (unless (get-text-property (point) 'day)
8176 (error "Don't know which date to use for calendar command"))
8177 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8178 (point (point))
8179 (date (calendar-gregorian-from-absolute
8180 (get-text-property point 'day)))
8181 ;; the following 2 vars are needed in the calendar
8182 (displayed-month (car date))
8183 (displayed-year (nth 2 date)))
8184 (unwind-protect
8185 (progn
8186 (fset 'calendar-cursor-to-date
8187 (lambda (&optional error dummy)
8188 (calendar-gregorian-from-absolute
8189 (get-text-property point 'day))))
8190 (call-interactively cmd))
8191 (fset 'calendar-cursor-to-date oldf))))
8193 (defun org-agenda-phases-of-moon ()
8194 "Display the phases of the moon for the 3 months around the cursor date."
8195 (interactive)
8196 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8198 (defun org-agenda-holidays ()
8199 "Display the holidays for the 3 months around the cursor date."
8200 (interactive)
8201 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8203 (defvar calendar-longitude)
8204 (defvar calendar-latitude)
8205 (defvar calendar-location-name)
8207 (defun org-agenda-sunrise-sunset (arg)
8208 "Display sunrise and sunset for the cursor date.
8209 Latitude and longitude can be specified with the variables
8210 `calendar-latitude' and `calendar-longitude'. When called with prefix
8211 argument, latitude and longitude will be prompted for."
8212 (interactive "P")
8213 (require 'solar)
8214 (let ((calendar-longitude (if arg nil calendar-longitude))
8215 (calendar-latitude (if arg nil calendar-latitude))
8216 (calendar-location-name
8217 (if arg "the given coordinates" calendar-location-name)))
8218 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8220 (defun org-agenda-goto-calendar ()
8221 "Open the Emacs calendar with the date at the cursor."
8222 (interactive)
8223 (org-agenda-check-type t 'agenda 'timeline)
8224 (let* ((day (or (get-text-property (point) 'day)
8225 (error "Don't know which date to open in calendar")))
8226 (date (calendar-gregorian-from-absolute day))
8227 (calendar-move-hook nil)
8228 (calendar-view-holidays-initially-flag nil)
8229 (calendar-view-diary-initially-flag nil))
8230 (calendar)
8231 (calendar-goto-date date)))
8233 ;;;###autoload
8234 (defun org-calendar-goto-agenda ()
8235 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8236 This is a command that has to be installed in `calendar-mode-map'."
8237 (interactive)
8238 (org-agenda-list nil (calendar-absolute-from-gregorian
8239 (calendar-cursor-to-date))
8240 nil))
8242 (defun org-agenda-convert-date ()
8243 (interactive)
8244 (org-agenda-check-type t 'agenda 'timeline)
8245 (let ((day (get-text-property (point) 'day))
8246 date s)
8247 (unless day
8248 (error "Don't know which date to convert"))
8249 (setq date (calendar-gregorian-from-absolute day))
8250 (setq s (concat
8251 "Gregorian: " (calendar-date-string date) "\n"
8252 "ISO: " (calendar-iso-date-string date) "\n"
8253 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8254 "Julian: " (calendar-julian-date-string date) "\n"
8255 "Astron. JD: " (calendar-astro-date-string date)
8256 " (Julian date number at noon UTC)\n"
8257 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8258 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8259 "French: " (calendar-french-date-string date) "\n"
8260 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8261 "Mayan: " (calendar-mayan-date-string date) "\n"
8262 "Coptic: " (calendar-coptic-date-string date) "\n"
8263 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8264 "Persian: " (calendar-persian-date-string date) "\n"
8265 "Chinese: " (calendar-chinese-date-string date) "\n"))
8266 (with-output-to-temp-buffer "*Dates*"
8267 (princ s))
8268 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8270 ;;; Bulk commands
8272 (defvar org-agenda-bulk-marked-entries nil
8273 "List of markers that refer to marked entries in the agenda.")
8275 (defun org-agenda-bulk-marked-p ()
8276 (eq (get-char-property (point-at-bol) 'type)
8277 'org-marked-entry-overlay))
8279 (defun org-agenda-bulk-mark (&optional arg)
8280 "Mark the entry at point for future bulk action."
8281 (interactive "p")
8282 (dotimes (i (max arg 1))
8283 (unless (org-get-at-bol 'org-agenda-diary-link)
8284 (let* ((m (org-get-at-bol 'org-hd-marker))
8286 (unless (org-agenda-bulk-marked-p)
8287 (unless m (error "Nothing to mark at point"))
8288 (push m org-agenda-bulk-marked-entries)
8289 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8290 (org-overlay-display ov "> "
8291 (org-get-todo-face "TODO")
8292 'evaporate)
8293 (overlay-put ov 'type 'org-marked-entry-overlay))
8294 (beginning-of-line 2)
8295 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8296 (beginning-of-line 2))
8297 (message "%d entries marked for bulk action"
8298 (length org-agenda-bulk-marked-entries))))))
8300 (defun org-agenda-bulk-mark-regexp (regexp)
8301 "Mark entries match REGEXP."
8302 (interactive "sMark entries matching regexp: ")
8303 (let (entries-marked)
8304 (save-excursion
8305 (goto-char (point-min))
8306 (goto-char (next-single-property-change (point) 'txt))
8307 (while (re-search-forward regexp nil t)
8308 (when (string-match regexp (get-text-property (point) 'txt))
8309 (setq entries-marked (+ entries-marked 1))
8310 (call-interactively 'org-agenda-bulk-mark))))
8311 (if (not entries-marked)
8312 (message "No entry matching this regexp."))))
8314 (defun org-agenda-bulk-unmark ()
8315 "Unmark the entry at point for future bulk action."
8316 (interactive)
8317 (when (org-agenda-bulk-marked-p)
8318 (org-agenda-bulk-remove-overlays
8319 (point-at-bol) (+ 2 (point-at-bol)))
8320 (setq org-agenda-bulk-marked-entries
8321 (delete (org-get-at-bol 'org-hd-marker)
8322 org-agenda-bulk-marked-entries)))
8323 (beginning-of-line 2)
8324 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8325 (beginning-of-line 2))
8326 (message "%d entries marked for bulk action"
8327 (length org-agenda-bulk-marked-entries)))
8329 (defun org-agenda-bulk-toggle ()
8330 "Toggle marking the entry at point for bulk action."
8331 (interactive)
8332 (if (org-agenda-bulk-marked-p)
8333 (org-agenda-bulk-unmark)
8334 (org-agenda-bulk-mark)))
8336 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8337 "Remove the mark overlays between BEG and END in the agenda buffer.
8338 BEG and END default to the buffer limits.
8340 This only removes the overlays, it does not remove the markers
8341 from the list in `org-agenda-bulk-marked-entries'."
8342 (interactive)
8343 (mapc (lambda (ov)
8344 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8345 (delete-overlay ov)))
8346 (overlays-in (or beg (point-min)) (or end (point-max)))))
8348 (defun org-agenda-bulk-remove-all-marks ()
8349 "Remove all marks in the agenda buffer.
8350 This will remove the markers, and the overlays."
8351 (interactive)
8352 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8353 (setq org-agenda-bulk-marked-entries nil)
8354 (org-agenda-bulk-remove-overlays (point-min) (point-max)))
8356 (defun org-agenda-bulk-action (&optional arg)
8357 "Execute an remote-editing action on all marked entries.
8358 The prefix arg is passed through to the command if possible."
8359 (interactive "P")
8360 ;; Make sure we have markers, and only valid ones
8361 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8362 (mapc
8363 (lambda (m)
8364 (unless (and (markerp m)
8365 (marker-buffer m)
8366 (buffer-live-p (marker-buffer m))
8367 (marker-position m))
8368 (error "Marker %s for bulk command is invalid" m)))
8369 org-agenda-bulk-marked-entries)
8371 ;; Prompt for the bulk command
8372 (message (concat "Bulk: [r]efile [$]arch [A]rch->sib [t]odo"
8373 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction"
8374 (when org-agenda-bulk-custom-functions
8375 (concat " Custom: ["
8376 (mapconcat (lambda(f) (char-to-string (car f)))
8377 org-agenda-bulk-custom-functions "")
8378 "]"))))
8379 (let* ((action (read-char-exclusive))
8380 (org-log-refile (if org-log-refile 'time nil))
8381 (entries (reverse org-agenda-bulk-marked-entries))
8382 redo-at-end
8383 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8384 (cond
8385 ((equal action ?$)
8386 (setq cmd '(org-agenda-archive)))
8388 ((equal action ?A)
8389 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8391 ((member action '(?r ?w))
8392 (setq rfloc (org-refile-get-location
8393 "Refile to"
8394 (marker-buffer (car org-agenda-bulk-marked-entries))
8395 org-refile-allow-creating-parent-nodes))
8396 (if (nth 3 rfloc)
8397 (setcar (nthcdr 3 rfloc)
8398 (move-marker (make-marker) (nth 3 rfloc)
8399 (or (get-file-buffer (nth 1 rfloc))
8400 (find-buffer-visiting (nth 1 rfloc))
8401 (error "This should not happen")))))
8403 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8404 redo-at-end t))
8406 ((equal action ?t)
8407 (setq state (org-icompleting-read
8408 "Todo state: "
8409 (with-current-buffer (marker-buffer (car entries))
8410 (mapcar 'list org-todo-keywords-1))))
8411 (setq cmd `(let ((org-inhibit-blocking t)
8412 (org-inhibit-logging 'note))
8413 (org-agenda-todo ,state))))
8415 ((memq action '(?- ?+))
8416 (setq tag (org-icompleting-read
8417 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8418 (with-current-buffer (marker-buffer (car entries))
8419 (delq nil
8420 (mapcar (lambda (x)
8421 (if (stringp (car x)) x)) org-tag-alist)))))
8422 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8424 ((memq action '(?s ?d))
8425 (let* ((date (unless arg
8426 (org-read-date
8427 nil nil nil
8428 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8429 (ans (if arg nil org-read-date-final-answer))
8430 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8431 (setq cmd `(let* ((bound (fboundp 'read-string))
8432 (old (and bound (symbol-function 'read-string))))
8433 (unwind-protect
8434 (progn
8435 (fset 'read-string (lambda (&rest ignore) ,ans))
8436 (eval '(,c1 arg)))
8437 (if bound
8438 (fset 'read-string old)
8439 (fmakunbound 'read-string)))))))
8441 ((equal action ?S)
8442 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8443 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8444 (let ((days (read-number
8445 (format "Scatter tasks across how many %sdays: "
8446 (if arg "week" "")) 7)))
8447 (setq cmd
8448 `(let ((distance (1+ (random ,days))))
8449 (if arg
8450 (let ((dist distance)
8451 (day-of-week
8452 (calendar-day-of-week
8453 (calendar-gregorian-from-absolute (org-today)))))
8454 (dotimes (i (1+ dist))
8455 (while (member day-of-week org-agenda-weekend-days)
8456 (incf distance)
8457 (incf day-of-week)
8458 (if (= day-of-week 7)
8459 (setq day-of-week 0)))
8460 (incf day-of-week)
8461 (if (= day-of-week 7)
8462 (setq day-of-week 0)))))
8463 ;; silently fail when try to replan a sexp entry
8464 (condition-case nil
8465 (let* ((date (calendar-gregorian-from-absolute
8466 (+ (org-today) distance)))
8467 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8468 (nth 2 date))))
8469 (org-agenda-schedule nil time))
8470 (error nil)))))))
8472 ((assoc action org-agenda-bulk-custom-functions)
8473 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8474 redo-at-end t))
8476 ((equal action ?f)
8477 (setq cmd (list (intern
8478 (org-icompleting-read "Function: "
8479 obarray 'fboundp t nil nil)))))
8481 (t (error "Invalid bulk action")))
8483 ;; Sort the markers, to make sure that parents are handled before children
8484 (setq entries (sort entries
8485 (lambda (a b)
8486 (cond
8487 ((equal (marker-buffer a) (marker-buffer b))
8488 (< (marker-position a) (marker-position b)))
8490 (string< (buffer-name (marker-buffer a))
8491 (buffer-name (marker-buffer b))))))))
8493 ;; Now loop over all markers and apply cmd
8494 (while (setq e (pop entries))
8495 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8496 (if (not pos)
8497 (progn (message "Skipping removed entry at %s" e)
8498 (setq cntskip (1+ cntskip)))
8499 (goto-char pos)
8500 (let (org-loop-over-headlines-in-active-region)
8501 (eval cmd))
8502 (setq org-agenda-bulk-marked-entries
8503 (delete e org-agenda-bulk-marked-entries))
8504 (setq cnt (1+ cnt))))
8505 (setq org-agenda-bulk-marked-entries nil)
8506 (org-agenda-bulk-remove-all-marks)
8507 (when redo-at-end (org-agenda-redo))
8508 (message "Acted on %d entries%s"
8510 (if (= cntskip 0)
8512 (format ", skipped %d (disappeared before their turn)"
8513 cntskip)))))
8515 ;;; Flagging notes
8517 (defun org-agenda-show-the-flagging-note ()
8518 "Display the flagging note in the other window.
8519 When called a second time in direct sequence, offer to remove the FLAGGING
8520 tag and (if present) the flagging note."
8521 (interactive)
8522 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8523 (win (selected-window))
8524 note heading newhead)
8525 (unless hdmarker
8526 (error "No linked entry at point"))
8527 (if (and (eq this-command last-command)
8528 (y-or-n-p "Unflag and remove any flagging note? "))
8529 (progn
8530 (org-agenda-remove-flag hdmarker)
8531 (let ((win (get-buffer-window "*Flagging Note*")))
8532 (and win (delete-window win)))
8533 (message "Entry unflagged"))
8534 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
8535 (unless note
8536 (error "No flagging note"))
8537 (org-kill-new note)
8538 (org-switch-to-buffer-other-window "*Flagging Note*")
8539 (erase-buffer)
8540 (insert note)
8541 (goto-char (point-min))
8542 (while (re-search-forward "\\\\n" nil t)
8543 (replace-match "\n" t t))
8544 (goto-char (point-min))
8545 (select-window win)
8546 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
8548 (defun org-agenda-remove-flag (marker)
8549 "Remove the FLAGGED tag and any flagging note in the entry."
8550 (let (newhead)
8551 (org-with-point-at marker
8552 (org-toggle-tag "FLAGGED" 'off)
8553 (org-entry-delete nil "THEFLAGGINGNOTE")
8554 (setq newhead (org-get-heading)))
8555 (org-agenda-change-all-lines newhead marker)
8556 (message "Entry unflagged")))
8558 (defun org-agenda-get-any-marker (&optional pos)
8559 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
8560 (get-text-property (or pos (point-at-bol)) 'org-marker)))
8562 ;;; Appointment reminders
8564 (defvar appt-time-msg-list)
8566 ;;;###autoload
8567 (defun org-agenda-to-appt (&optional refresh filter &rest args)
8568 "Activate appointments found in `org-agenda-files'.
8569 With a \\[universal-argument] prefix, refresh the list of
8570 appointments.
8572 If FILTER is t, interactively prompt the user for a regular
8573 expression, and filter out entries that don't match it.
8575 If FILTER is a string, use this string as a regular expression
8576 for filtering entries out.
8578 If FILTER is a function, filter out entries against which
8579 calling the function returns nil. This function takes one
8580 argument: an entry from `org-agenda-get-day-entries'.
8582 FILTER can also be an alist with the car of each cell being
8583 either 'headline or 'category. For example:
8585 '((headline \"IMPORTANT\")
8586 (category \"Work\"))
8588 will only add headlines containing IMPORTANT or headlines
8589 belonging to the \"Work\" category.
8591 ARGS are symbols indicating what kind of entries to consider.
8592 By default `org-agenda-to-appt' will use :deadline, :scheduled
8593 and :timestamp entries. See the docstring of `org-diary' for
8594 details and examples."
8595 (interactive "P")
8596 (if refresh (setq appt-time-msg-list nil))
8597 (if (eq filter t)
8598 (setq filter (read-from-minibuffer "Regexp filter: ")))
8599 (let* ((cnt 0) ; count added events
8600 (scope (or args '(:deadline :scheduled :timestamp)))
8601 (org-agenda-new-buffers nil)
8602 (org-deadline-warning-days 0)
8603 ;; Do not use `org-today' here because appt only takes
8604 ;; time and without date as argument, so it may pass wrong
8605 ;; information otherwise
8606 (today (org-date-to-gregorian
8607 (time-to-days (current-time))))
8608 (org-agenda-restrict nil)
8609 (files (org-agenda-files 'unrestricted)) entries file)
8610 ;; Get all entries which may contain an appt
8611 (org-prepare-agenda-buffers files)
8612 (while (setq file (pop files))
8613 (setq entries
8614 (delq nil
8615 (append entries
8616 (apply 'org-agenda-get-day-entries
8617 file today scope)))))
8618 ;; Map thru entries and find if we should filter them out
8619 (mapc
8620 (lambda(x)
8621 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
8622 (cat (get-text-property 1 'org-category x))
8623 (tod (get-text-property 1 'time-of-day x))
8624 (ok (or (null filter)
8625 (and (stringp filter) (string-match filter evt))
8626 (and (functionp filter) (funcall filter x))
8627 (and (listp filter)
8628 (let ((cat-filter (cadr (assoc 'category filter)))
8629 (evt-filter (cadr (assoc 'headline filter))))
8630 (or (and (stringp cat-filter)
8631 (string-match cat-filter cat))
8632 (and (stringp evt-filter)
8633 (string-match evt-filter evt))))))))
8634 ;; FIXME: Shall we remove text-properties for the appt text?
8635 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
8636 (when (and ok tod)
8637 (setq tod (concat "00" (number-to-string tod))
8638 tod (when (string-match
8639 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
8640 (concat (match-string 1 tod) ":"
8641 (match-string 2 tod))))
8642 (appt-add tod evt)
8643 (setq cnt (1+ cnt))))) entries)
8644 (org-release-buffers org-agenda-new-buffers)
8645 (if (eq cnt 0)
8646 (message "No event to add")
8647 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
8649 (defun org-agenda-todayp (date)
8650 "Does DATE mean today, when considering `org-extend-today-until'?"
8651 (let ((today (org-today))
8652 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
8653 date)))
8654 (eq date today)))
8656 (defun org-agenda-todo-yesterday (&optional arg)
8657 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
8658 (interactive "P")
8659 (let* ((hour (third (decode-time
8660 (org-current-time))))
8661 (org-extend-today-until (1+ hour)))
8662 (org-agenda-todo arg)))
8664 (provide 'org-agenda)
8666 ;;; org-agenda.el ends here