ox-ascii: Fix indentation in the first paragraph of a section
[org-mode.git] / lisp / org-agenda.el
blobfe322025987efafd0366a63ac3a11b905788611e
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (require 'org-macs)
50 (eval-when-compile
51 (require 'cl))
53 (declare-function diary-add-to-list "diary-lib"
54 (date string specifier &optional marker globcolor literal))
55 (declare-function calendar-absolute-from-iso "cal-iso" (date))
56 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
57 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
58 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
59 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
61 (declare-function calendar-french-date-string "cal-french" (&optional date))
62 (declare-function calendar-goto-date "cal-move" (date))
63 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
64 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
65 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
66 (declare-function calendar-iso-from-absolute "cal-iso" (date))
67 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
68 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
69 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
70 (declare-function calendar-check-holidays "holidays" (date))
72 (declare-function org-datetree-find-date-create "org-datetree"
73 (date &optional keep-restriction))
74 (declare-function org-columns-quit "org-colview" ())
75 (declare-function diary-date-display-form "diary-lib" (&optional type))
76 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
77 (declare-function org-habit-insert-consistency-graphs
78 "org-habit" (&optional line))
79 (declare-function org-is-habit-p "org-habit" (&optional pom))
80 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
81 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
82 (declare-function org-pop-to-buffer-same-window "org-compat"
83 (&optional buffer-or-name norecord label))
84 (declare-function org-agenda-columns "org-colview" ())
85 (declare-function org-add-archive-files "org-archive" (files))
86 (declare-function org-capture "org-capture" (&optional goto keys))
88 (defvar calendar-mode-map) ; defined in calendar.el
89 (defvar org-clock-current-task nil) ; defined in org-clock.el
90 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
91 (defvar org-habit-show-habits) ; defined in org-habit.el
92 (defvar org-habit-show-habits-only-for-today)
93 (defvar org-habit-show-all-today)
95 ;; Defined somewhere in this file, but used before definition.
96 (defvar org-agenda-buffer-name "*Org Agenda*")
97 (defvar org-agenda-overriding-header nil)
98 (defvar org-agenda-title-append nil)
99 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
100 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
101 (defvar original-date) ; dynamically scoped, calendar.el does scope this
103 (defvar org-agenda-undo-list nil
104 "List of undoable operations in the agenda since last refresh.")
105 (defvar org-agenda-pending-undo-list nil
106 "In a series of undo commands, this is the list of remaining undo items.")
108 (defcustom org-agenda-confirm-kill 1
109 "When set, remote killing from the agenda buffer needs confirmation.
110 When t, a confirmation is always needed. When a number N, confirmation is
111 only needed when the text to be killed contains more than N non-white lines."
112 :group 'org-agenda
113 :type '(choice
114 (const :tag "Never" nil)
115 (const :tag "Always" t)
116 (integer :tag "When more than N lines")))
118 (defcustom org-agenda-compact-blocks nil
119 "Non-nil means make the block agenda more compact.
120 This is done globally by leaving out lines like the agenda span
121 name and week number or the separator lines."
122 :group 'org-agenda
123 :type 'boolean)
125 (defcustom org-agenda-block-separator ?=
126 "The separator between blocks in the agenda.
127 If this is a string, it will be used as the separator, with a newline added.
128 If it is a character, it will be repeated to fill the window width.
129 If nil the separator is disabled. In `org-agenda-custom-commands' this
130 addresses the separator between the current and the previous block."
131 :group 'org-agenda
132 :type '(choice
133 (const :tag "Disabled" nil)
134 (character)
135 (string)))
137 (defgroup org-agenda-export nil
138 "Options concerning exporting agenda views in Org-mode."
139 :tag "Org Agenda Export"
140 :group 'org-agenda)
142 (defcustom org-agenda-with-colors t
143 "Non-nil means use colors in agenda views."
144 :group 'org-agenda-export
145 :type 'boolean)
147 (defcustom org-agenda-exporter-settings nil
148 "Alist of variable/value pairs that should be active during agenda export.
149 This is a good place to set options for ps-print and for htmlize.
150 Note that the way this is implemented, the values will be evaluated
151 before assigned to the variables. So make sure to quote values you do
152 *not* want evaluated, for example
154 (setq org-agenda-exporter-settings
155 '((ps-print-color-p 'black-white)))"
156 :group 'org-agenda-export
157 :type '(repeat
158 (list
159 (variable)
160 (sexp :tag "Value"))))
162 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
163 "Hook run in a temporary buffer before writing the agenda to an export file.
164 A useful function for this hook is `org-agenda-add-entry-text'."
165 :group 'org-agenda-export
166 :type 'hook
167 :options '(org-agenda-add-entry-text))
169 (defcustom org-agenda-add-entry-text-maxlines 0
170 "Maximum number of entry text lines to be added to agenda.
171 This is only relevant when `org-agenda-add-entry-text' is part of
172 `org-agenda-before-write-hook', which is the default.
173 When this is 0, nothing will happen. When it is greater than 0, it
174 specifies the maximum number of lines that will be added for each entry
175 that is listed in the agenda view.
177 Note that this variable is not used during display, only when exporting
178 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
179 and `org-agenda-entry-text-maxlines'."
180 :group 'org-agenda
181 :type 'integer)
183 (defcustom org-agenda-add-entry-text-descriptive-links t
184 "Non-nil means export org-links as descriptive links in agenda added text.
185 This variable applies to the text added to the agenda when
186 `org-agenda-add-entry-text-maxlines' is larger than 0.
187 When this variable nil, the URL will (also) be shown."
188 :group 'org-agenda
189 :type 'boolean)
191 (defcustom org-agenda-export-html-style nil
192 "The style specification for exported HTML Agenda files.
193 If this variable contains a string, it will replace the default <style>
194 section as produced by `htmlize'.
195 Since there are different ways of setting style information, this variable
196 needs to contain the full HTML structure to provide a style, including the
197 surrounding HTML tags. The style specifications should include definitions
198 the fonts used by the agenda, here is an example:
200 <style type=\"text/css\">
201 p { font-weight: normal; color: gray; }
202 .org-agenda-structure {
203 font-size: 110%;
204 color: #003399;
205 font-weight: 600;
207 .org-todo {
208 color: #cc6666;
209 font-weight: bold;
211 .org-agenda-done {
212 color: #339933;
214 .org-done {
215 color: #339933;
217 .title { text-align: center; }
218 .todo, .deadline { color: red; }
219 .done { color: green; }
220 </style>
222 or, if you want to keep the style in a file,
224 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
226 As the value of this option simply gets inserted into the HTML <head> header,
227 you can \"misuse\" it to also add other text to the header."
228 :group 'org-agenda-export
229 :group 'org-export-html
230 :type '(choice
231 (const nil)
232 (string)))
234 (defcustom org-agenda-persistent-filter nil
235 "When set, keep filters from one agenda view to the next."
236 :group 'org-agenda
237 :type 'boolean)
239 (defgroup org-agenda-custom-commands nil
240 "Options concerning agenda views in Org-mode."
241 :tag "Org Agenda Custom Commands"
242 :group 'org-agenda)
244 (defconst org-sorting-choice
245 '(choice
246 (const time-up) (const time-down)
247 (const timestamp-up) (const timestamp-down)
248 (const scheduled-up) (const scheduled-down)
249 (const deadline-up) (const deadline-down)
250 (const ts-up) (const ts-down)
251 (const tsia-up) (const tsia-down)
252 (const category-keep) (const category-up) (const category-down)
253 (const tag-down) (const tag-up)
254 (const priority-up) (const priority-down)
255 (const todo-state-up) (const todo-state-down)
256 (const effort-up) (const effort-down)
257 (const habit-up) (const habit-down)
258 (const alpha-up) (const alpha-down)
259 (const user-defined-up) (const user-defined-down))
260 "Sorting choices.")
262 ;; Keep custom values for `org-agenda-filter-preset' compatible with
263 ;; the new variable `org-agenda-tag-filter-preset'.
264 (org-defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
265 (org-defvaralias 'org-agenda-filter 'org-agenda-tag-filter)
267 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
268 "List of types searched for when creating the daily/weekly agenda.
269 This variable is a list of symbols that controls the types of
270 items that appear in the daily/weekly agenda. Allowed symbols in this
271 list are are
273 :timestamp List items containing a date stamp or date range matching
274 the selected date. This includes sexp entries in angular
275 brackets.
277 :sexp List entries resulting from plain diary-like sexps.
279 :deadline List deadline due on that date. When the date is today,
280 also list any deadlines past due, or due within
281 `org-deadline-warning-days'. `:deadline' must appear before
282 `:scheduled' if the setting of
283 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
284 any effect.
286 :deadline* Same as above, but only include the deadline if it has an
287 hour specification as [h]h:mm.
289 :scheduled List all items which are scheduled for the given date.
290 The diary for *today* also contains items which were
291 scheduled earlier and are not yet marked DONE.
293 :scheduled* Same as above, but only include the scheduled item if it
294 has an hour specification as [h]h:mm.
296 By default, all four non-starred types are turned on.
298 When :scheduled* or :deadline* are included, :schedule or :deadline
299 will be ignored.
301 Never set this variable globally using `setq', because then it
302 will apply to all future agenda commands. Instead, bind it with
303 `let' to scope it dynamically into the agenda-constructing
304 command. A good way to set it is through options in
305 `org-agenda-custom-commands'. For a more flexible (though
306 somewhat less efficient) way of determining what is included in
307 the daily/weekly agenda, see `org-agenda-skip-function'.")
309 (defconst org-agenda-custom-commands-local-options
310 `(repeat :tag "Local settings for this command. Remember to quote values"
311 (choice :tag "Setting"
312 (list :tag "Heading for this block"
313 (const org-agenda-overriding-header)
314 (string :tag "Headline"))
315 (list :tag "Files to be searched"
316 (const org-agenda-files)
317 (list
318 (const :format "" quote)
319 (repeat (file))))
320 (list :tag "Sorting strategy"
321 (const org-agenda-sorting-strategy)
322 (list
323 (const :format "" quote)
324 (repeat
325 ,org-sorting-choice)))
326 (list :tag "Prefix format"
327 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
328 (string))
329 (list :tag "Number of days in agenda"
330 (const org-agenda-span)
331 (choice (const :tag "Day" day)
332 (const :tag "Week" week)
333 (const :tag "Fortnight" fortnight)
334 (const :tag "Month" month)
335 (const :tag "Year" year)
336 (integer :tag "Custom")))
337 (list :tag "Fixed starting date"
338 (const org-agenda-start-day)
339 (string :value "2007-11-01"))
340 (list :tag "Start on day of week"
341 (const org-agenda-start-on-weekday)
342 (choice :value 1
343 (const :tag "Today" nil)
344 (integer :tag "Weekday No.")))
345 (list :tag "Include data from diary"
346 (const org-agenda-include-diary)
347 (boolean))
348 (list :tag "Deadline Warning days"
349 (const org-deadline-warning-days)
350 (integer :value 1))
351 (list :tag "Category filter preset"
352 (const org-agenda-category-filter-preset)
353 (list
354 (const :format "" quote)
355 (repeat
356 (string :tag "+category or -category"))))
357 (list :tag "Tags filter preset"
358 (const org-agenda-tag-filter-preset)
359 (list
360 (const :format "" quote)
361 (repeat
362 (string :tag "+tag or -tag"))))
363 (list :tag "Regexp filter preset"
364 (const org-agenda-regexp-filter-preset)
365 (list
366 (const :format "" quote)
367 (repeat
368 (string :tag "+regexp or -regexp"))))
369 (list :tag "Set daily/weekly entry types"
370 (const org-agenda-entry-types)
371 (list
372 (const :format "" quote)
373 (set :greedy t :value ,org-agenda-entry-types
374 (const :deadline)
375 (const :scheduled)
376 (const :deadline*)
377 (const :scheduled*)
378 (const :timestamp)
379 (const :sexp))))
380 (list :tag "Standard skipping condition"
381 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
382 (const org-agenda-skip-function)
383 (list
384 (const :format "" quote)
385 (list
386 (choice
387 :tag "Skipping range"
388 (const :tag "Skip entry" org-agenda-skip-entry-if)
389 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
390 (repeat :inline t :tag "Conditions for skipping"
391 (choice
392 :tag "Condition type"
393 (list :tag "Regexp matches" :inline t (const :format "" regexp) (regexp))
394 (list :tag "Regexp does not match" :inline t (const :format "" notregexp) (regexp))
395 (list :tag "TODO state is" :inline t
396 (const todo)
397 (choice
398 (const :tag "any not-done state" todo)
399 (const :tag "any done state" done)
400 (const :tag "any state" any)
401 (list :tag "Keyword list"
402 (const :format "" quote)
403 (repeat (string :tag "Keyword")))))
404 (list :tag "TODO state is not" :inline t
405 (const nottodo)
406 (choice
407 (const :tag "any not-done state" todo)
408 (const :tag "any done state" done)
409 (const :tag "any state" any)
410 (list :tag "Keyword list"
411 (const :format "" quote)
412 (repeat (string :tag "Keyword")))))
413 (const :tag "scheduled" scheduled)
414 (const :tag "not scheduled" notscheduled)
415 (const :tag "deadline" deadline)
416 (const :tag "no deadline" notdeadline)
417 (const :tag "timestamp" timestamp)
418 (const :tag "no timestamp" nottimestamp))))))
419 (list :tag "Non-standard skipping condition"
420 :value (org-agenda-skip-function)
421 (const org-agenda-skip-function)
422 (sexp :tag "Function or form (quoted!)"))
423 (list :tag "Any variable"
424 (variable :tag "Variable")
425 (sexp :tag "Value (sexp)"))))
426 "Selection of examples for agenda command settings.
427 This will be spliced into the custom type of
428 `org-agenda-custom-commands'.")
431 (defcustom org-agenda-custom-commands
432 '(("n" "Agenda and all TODO's" ((agenda "") (alltodo ""))))
433 "Custom commands for the agenda.
434 These commands will be offered on the splash screen displayed by the
435 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
437 (key desc type match settings files)
439 key The key (one or more characters as a string) to be associated
440 with the command.
441 desc A description of the command, when omitted or nil, a default
442 description is built using MATCH.
443 type The command type, any of the following symbols:
444 agenda The daily/weekly agenda.
445 todo Entries with a specific TODO keyword, in all agenda files.
446 search Entries containing search words entry or headline.
447 tags Tags/Property/TODO match in all agenda files.
448 tags-todo Tags/P/T match in all agenda files, TODO entries only.
449 todo-tree Sparse tree of specific TODO keyword in *current* file.
450 tags-tree Sparse tree with all tags matches in *current* file.
451 occur-tree Occur sparse tree for *current* file.
452 ... A user-defined function.
453 match What to search for:
454 - a single keyword for TODO keyword searches
455 - a tags match expression for tags searches
456 - a word search expression for text searches.
457 - a regular expression for occur searches
458 For all other commands, this should be the empty string.
459 settings A list of option settings, similar to that in a let form, so like
460 this: ((opt1 val1) (opt2 val2) ...). The values will be
461 evaluated at the moment of execution, so quote them when needed.
462 files A list of files file to write the produced agenda buffer to
463 with the command `org-store-agenda-views'.
464 If a file name ends in \".html\", an HTML version of the buffer
465 is written out. If it ends in \".ps\", a postscript version is
466 produced. Otherwise, only the plain text is written to the file.
468 You can also define a set of commands, to create a composite agenda buffer.
469 In this case, an entry looks like this:
471 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
473 where
475 desc A description string to be displayed in the dispatcher menu.
476 cmd An agenda command, similar to the above. However, tree commands
477 are not allowed, but instead you can get agenda and global todo list.
478 So valid commands for a set are:
479 (agenda \"\" settings)
480 (alltodo \"\" settings)
481 (stuck \"\" settings)
482 (todo \"match\" settings files)
483 (search \"match\" settings files)
484 (tags \"match\" settings files)
485 (tags-todo \"match\" settings files)
487 Each command can carry a list of options, and another set of options can be
488 given for the whole set of commands. Individual command options take
489 precedence over the general options.
491 When using several characters as key to a command, the first characters
492 are prefix commands. For the dispatcher to display useful information, you
493 should provide a description for the prefix, like
495 (setq org-agenda-custom-commands
496 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
497 (\"hl\" tags \"+HOME+Lisa\")
498 (\"hp\" tags \"+HOME+Peter\")
499 (\"hk\" tags \"+HOME+Kim\")))"
500 :group 'org-agenda-custom-commands
501 :type `(repeat
502 (choice :value ("x" "Describe command here" tags "" nil)
503 (list :tag "Single command"
504 (string :tag "Access Key(s) ")
505 (option (string :tag "Description"))
506 (choice
507 (const :tag "Agenda" agenda)
508 (const :tag "TODO list" alltodo)
509 (const :tag "Search words" search)
510 (const :tag "Stuck projects" stuck)
511 (const :tag "Tags/Property match (all agenda files)" tags)
512 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
513 (const :tag "TODO keyword search (all agenda files)" todo)
514 (const :tag "Tags sparse tree (current buffer)" tags-tree)
515 (const :tag "TODO keyword tree (current buffer)" todo-tree)
516 (const :tag "Occur tree (current buffer)" occur-tree)
517 (sexp :tag "Other, user-defined function"))
518 (string :tag "Match (only for some commands)")
519 ,org-agenda-custom-commands-local-options
520 (option (repeat :tag "Export" (file :tag "Export to"))))
521 (list :tag "Command series, all agenda files"
522 (string :tag "Access Key(s)")
523 (string :tag "Description ")
524 (repeat :tag "Component"
525 (choice
526 (list :tag "Agenda"
527 (const :format "" agenda)
528 (const :tag "" :format "" "")
529 ,org-agenda-custom-commands-local-options)
530 (list :tag "TODO list (all keywords)"
531 (const :format "" alltodo)
532 (const :tag "" :format "" "")
533 ,org-agenda-custom-commands-local-options)
534 (list :tag "Search words"
535 (const :format "" search)
536 (string :tag "Match")
537 ,org-agenda-custom-commands-local-options)
538 (list :tag "Stuck projects"
539 (const :format "" stuck)
540 (const :tag "" :format "" "")
541 ,org-agenda-custom-commands-local-options)
542 (list :tag "Tags search"
543 (const :format "" tags)
544 (string :tag "Match")
545 ,org-agenda-custom-commands-local-options)
546 (list :tag "Tags search, TODO entries only"
547 (const :format "" tags-todo)
548 (string :tag "Match")
549 ,org-agenda-custom-commands-local-options)
550 (list :tag "TODO keyword search"
551 (const :format "" todo)
552 (string :tag "Match")
553 ,org-agenda-custom-commands-local-options)
554 (list :tag "Other, user-defined function"
555 (symbol :tag "function")
556 (string :tag "Match")
557 ,org-agenda-custom-commands-local-options)))
559 (repeat :tag "Settings for entire command set"
560 (list (variable :tag "Any variable")
561 (sexp :tag "Value")))
562 (option (repeat :tag "Export" (file :tag "Export to"))))
563 (cons :tag "Prefix key documentation"
564 (string :tag "Access Key(s)")
565 (string :tag "Description ")))))
567 (defcustom org-agenda-query-register ?o
568 "The register holding the current query string.
569 The purpose of this is that if you construct a query string interactively,
570 you can then use it to define a custom command."
571 :group 'org-agenda-custom-commands
572 :type 'character)
574 (defcustom org-stuck-projects
575 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
576 "How to identify stuck projects.
577 This is a list of four items:
578 1. A tags/todo/property matcher string that is used to identify a project.
579 See the manual for a description of tag and property searches.
580 The entire tree below a headline matched by this is considered one project.
581 2. A list of TODO keywords identifying non-stuck projects.
582 If the project subtree contains any headline with one of these todo
583 keywords, the project is considered to be not stuck. If you specify
584 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
585 3. A list of tags identifying non-stuck projects.
586 If the project subtree contains any headline with one of these tags,
587 the project is considered to be not stuck. If you specify \"*\" as
588 a tag, any tag will mark the project unstuck. Note that this is about
589 the explicit presence of a tag somewhere in the subtree, inherited
590 tags do not count here. If inherited tags make a project not stuck,
591 use \"-TAG\" in the tags part of the matcher under (1.) above.
592 4. An arbitrary regular expression matching non-stuck projects.
594 If the project turns out to be not stuck, search continues also in the
595 subtree to see if any of the subtasks have project status.
597 See also the variable `org-tags-match-list-sublevels' which applies
598 to projects matched by this search as well.
600 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
601 or `C-c a #' to produce the list."
602 :group 'org-agenda-custom-commands
603 :type '(list
604 (string :tag "Tags/TODO match to identify a project")
605 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
606 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
607 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
609 (defcustom org-agenda-filter-effort-default-operator "<"
610 "The default operator for effort estimate filtering.
611 If you select an effort estimate limit without first pressing an operator,
612 this one will be used."
613 :group 'org-agenda-custom-commands
614 :type '(choice (const :tag "less or equal" "<")
615 (const :tag "greater or equal"">")
616 (const :tag "equal" "=")))
618 (defgroup org-agenda-skip nil
619 "Options concerning skipping parts of agenda files."
620 :tag "Org Agenda Skip"
621 :group 'org-agenda)
623 (defcustom org-agenda-skip-function-global nil
624 "Function to be called at each match during agenda construction.
625 If this function returns nil, the current match should not be skipped.
626 If the function decided to skip an agenda match, is must return the
627 buffer position from which the search should be continued.
628 This may also be a Lisp form, which will be evaluated.
630 This variable will be applied to every agenda match, including
631 tags/property searches and TODO lists. So try to make the test function
632 do its checking as efficiently as possible. To implement a skipping
633 condition just for specific agenda commands, use the variable
634 `org-agenda-skip-function' which can be set in the options section
635 of custom agenda commands."
636 :group 'org-agenda-skip
637 :type 'sexp)
639 (defgroup org-agenda-daily/weekly nil
640 "Options concerning the daily/weekly agenda."
641 :tag "Org Agenda Daily/Weekly"
642 :group 'org-agenda)
643 (defgroup org-agenda-todo-list nil
644 "Options concerning the global todo list agenda view."
645 :tag "Org Agenda Todo List"
646 :group 'org-agenda)
647 (defgroup org-agenda-match-view nil
648 "Options concerning the general tags/property/todo match agenda view."
649 :tag "Org Agenda Match View"
650 :group 'org-agenda)
651 (defgroup org-agenda-search-view nil
652 "Options concerning the search agenda view."
653 :tag "Org Agenda Search View"
654 :group 'org-agenda)
656 (defvar org-agenda-archives-mode nil
657 "Non-nil means the agenda will include archived items.
658 If this is the symbol `trees', trees in the selected agenda scope
659 that are marked with the ARCHIVE tag will be included anyway. When this is
660 t, also all archive files associated with the current selection of agenda
661 files will be included.")
663 (defcustom org-agenda-restriction-lock-highlight-subtree t
664 "Non-nil means highlight the whole subtree when restriction is active.
665 Otherwise only highlight the headline. Highlighting the whole subtree is
666 useful to ensure no edits happen beyond the restricted region."
667 :group 'org-agenda
668 :type 'boolean)
670 (defcustom org-agenda-skip-comment-trees t
671 "Non-nil means skip trees that start with the COMMENT keyword.
672 When nil, these trees are also scanned by agenda commands."
673 :group 'org-agenda-skip
674 :type 'boolean)
676 (defcustom org-agenda-todo-list-sublevels t
677 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
678 When nil, the sublevels of a TODO entry are not checked, resulting in
679 potentially much shorter TODO lists."
680 :group 'org-agenda-skip
681 :group 'org-agenda-todo-list
682 :type 'boolean)
684 (defcustom org-agenda-todo-ignore-with-date nil
685 "Non-nil means don't show entries with a date in the global todo list.
686 You can use this if you prefer to mark mere appointments with a TODO keyword,
687 but don't want them to show up in the TODO list.
688 When this is set, it also covers deadlines and scheduled items, the settings
689 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
690 will be ignored.
691 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
692 :group 'org-agenda-skip
693 :group 'org-agenda-todo-list
694 :type 'boolean)
696 (defcustom org-agenda-todo-ignore-timestamp nil
697 "Non-nil means don't show entries with a timestamp.
698 This applies when creating the global todo list.
699 Valid values are:
701 past Don't show entries for today or in the past.
703 future Don't show entries with a timestamp in the future.
704 The idea behind this is that if it has a future
705 timestamp, you don't want to think about it until the
706 date.
708 all Don't show any entries with a timestamp in the global todo list.
709 The idea behind this is that by setting a timestamp, you
710 have already \"taken care\" of this item.
712 This variable can also have an integer as a value. If positive (N),
713 todos with a timestamp N or more days in the future will be ignored. If
714 negative (-N), todos with a timestamp N or more days in the past will be
715 ignored. If 0, todos with a timestamp either today or in the future will
716 be ignored. For example, a value of -1 will exclude todos with a
717 timestamp in the past (yesterday or earlier), while a value of 7 will
718 exclude todos with a timestamp a week or more in the future.
720 See also `org-agenda-todo-ignore-with-date'.
721 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
722 to make his option also apply to the tags-todo list."
723 :group 'org-agenda-skip
724 :group 'org-agenda-todo-list
725 :version "24.1"
726 :type '(choice
727 (const :tag "Ignore future timestamp todos" future)
728 (const :tag "Ignore past or present timestamp todos" past)
729 (const :tag "Ignore all timestamp todos" all)
730 (const :tag "Show timestamp todos" nil)
731 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
733 (defcustom org-agenda-todo-ignore-scheduled nil
734 "Non-nil means, ignore some scheduled TODO items when making TODO list.
735 This applies when creating the global todo list.
736 Valid values are:
738 past Don't show entries scheduled today or in the past.
740 future Don't show entries scheduled in the future.
741 The idea behind this is that by scheduling it, you don't want to
742 think about it until the scheduled date.
744 all Don't show any scheduled entries in the global todo list.
745 The idea behind this is that by scheduling it, you have already
746 \"taken care\" of this item.
748 t Same as `all', for backward compatibility.
750 This variable can also have an integer as a value. See
751 `org-agenda-todo-ignore-timestamp' for more details.
753 See also `org-agenda-todo-ignore-with-date'.
754 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
755 to make his option also apply to the tags-todo list."
756 :group 'org-agenda-skip
757 :group 'org-agenda-todo-list
758 :type '(choice
759 (const :tag "Ignore future-scheduled todos" future)
760 (const :tag "Ignore past- or present-scheduled todos" past)
761 (const :tag "Ignore all scheduled todos" all)
762 (const :tag "Ignore all scheduled todos (compatibility)" t)
763 (const :tag "Show scheduled todos" nil)
764 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
766 (defcustom org-agenda-todo-ignore-deadlines nil
767 "Non-nil means ignore some deadline TODO items when making TODO list.
768 There are different motivations for using different values, please think
769 carefully when configuring this variable.
771 This applies when creating the global todo list.
772 Valid values are:
774 near Don't show near deadline entries. A deadline is near when it is
775 closer than `org-deadline-warning-days' days. The idea behind this
776 is that such items will appear in the agenda anyway.
778 far Don't show TODO entries where a deadline has been defined, but
779 the deadline is not near. This is useful if you don't want to
780 use the todo list to figure out what to do now.
782 past Don't show entries with a deadline timestamp for today or in the past.
784 future Don't show entries with a deadline timestamp in the future, not even
785 when they become `near' ones. Use it with caution.
787 all Ignore all TODO entries that do have a deadline.
789 t Same as `near', for backward compatibility.
791 This variable can also have an integer as a value. See
792 `org-agenda-todo-ignore-timestamp' for more details.
794 See also `org-agenda-todo-ignore-with-date'.
795 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
796 to make his option also apply to the tags-todo list."
797 :group 'org-agenda-skip
798 :group 'org-agenda-todo-list
799 :type '(choice
800 (const :tag "Ignore near deadlines" near)
801 (const :tag "Ignore near deadlines (compatibility)" t)
802 (const :tag "Ignore far deadlines" far)
803 (const :tag "Ignore all TODOs with a deadlines" all)
804 (const :tag "Show all TODOs, even if they have a deadline" nil)
805 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
807 (defcustom org-agenda-todo-ignore-time-comparison-use-seconds nil
808 "Time unit to use when possibly ignoring an agenda item.
810 See the docstring of various `org-agenda-todo-ignore-*' options.
811 The default is to compare time stamps using days. An item is thus
812 considered to be in the future if it is at least one day after today.
813 Non-nil means to compare time stamps using seconds. An item is then
814 considered future if it has a time value later than current time."
815 :group 'org-agenda-skip
816 :group 'org-agenda-todo-list
817 :version "24.4"
818 :package-version '(Org . "8.0")
819 :type '(choice
820 (const :tag "Compare time with days" nil)
821 (const :tag "Compare time with seconds" t)))
823 (defcustom org-agenda-tags-todo-honor-ignore-options nil
824 "Non-nil means honor todo-list ignores options also in tags-todo search.
825 The variables
826 `org-agenda-todo-ignore-with-date',
827 `org-agenda-todo-ignore-timestamp',
828 `org-agenda-todo-ignore-scheduled',
829 `org-agenda-todo-ignore-deadlines'
830 make the global TODO list skip entries that have time stamps of certain
831 kinds. If this option is set, the same options will also apply for the
832 tags-todo search, which is the general tags/property matcher
833 restricted to unfinished TODO entries only."
834 :group 'org-agenda-skip
835 :group 'org-agenda-todo-list
836 :group 'org-agenda-match-view
837 :type 'boolean)
839 (defcustom org-agenda-skip-scheduled-if-done nil
840 "Non-nil means don't show scheduled items in agenda when they are done.
841 This is relevant for the daily/weekly agenda, not for the TODO list. And
842 it applies only to the actual date of the scheduling. Warnings about
843 an item with a past scheduling dates are always turned off when the item
844 is DONE."
845 :group 'org-agenda-skip
846 :group 'org-agenda-daily/weekly
847 :type 'boolean)
849 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
850 "Non-nil means skip scheduling line if same entry shows because of deadline.
852 In the agenda of today, an entry can show up multiple times
853 because it is both scheduled and has a nearby deadline, and maybe
854 a plain time stamp as well.
856 When this variable is nil, the entry will be shown several times.
858 When set to t, then only the deadline is shown and the fact that
859 the entry is scheduled today or was scheduled previously is not
860 shown.
862 When set to the symbol `not-today', skip scheduled previously,
863 but not scheduled today.
865 When set to the symbol `repeated-after-deadline', skip scheduled
866 items if they are repeated beyond the current deadline."
867 :group 'org-agenda-skip
868 :group 'org-agenda-daily/weekly
869 :type '(choice
870 (const :tag "Never" nil)
871 (const :tag "Always" t)
872 (const :tag "Not when scheduled today" not-today)
873 (const :tag "When repeated past deadline" repeated-after-deadline)))
875 (defcustom org-agenda-skip-timestamp-if-deadline-is-shown nil
876 "Non-nil means skip timestamp line if same entry shows because of deadline.
877 In the agenda of today, an entry can show up multiple times
878 because it has both a plain timestamp and has a nearby deadline.
879 When this variable is t, then only the deadline is shown and the
880 fact that the entry has a timestamp for or including today is not
881 shown. When this variable is nil, the entry will be shown
882 several times."
883 :group 'org-agenda-skip
884 :group 'org-agenda-daily/weekly
885 :version "24.1"
886 :type '(choice
887 (const :tag "Never" nil)
888 (const :tag "Always" t)))
890 (defcustom org-agenda-skip-deadline-if-done nil
891 "Non-nil means don't show deadlines when the corresponding item is done.
892 When nil, the deadline is still shown and should give you a happy feeling.
893 This is relevant for the daily/weekly agenda. And it applied only to the
894 actually date of the deadline. Warnings about approaching and past-due
895 deadlines are always turned off when the item is DONE."
896 :group 'org-agenda-skip
897 :group 'org-agenda-daily/weekly
898 :type 'boolean)
900 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
901 "Non-nil means skip deadline prewarning when entry is also scheduled.
902 This will apply on all days where a prewarning for the deadline would
903 be shown, but not at the day when the entry is actually due. On that day,
904 the deadline will be shown anyway.
905 This variable may be set to nil, t, the symbol `pre-scheduled',
906 or a number which will then give the number of days before the actual
907 deadline when the prewarnings should resume. The symbol `pre-scheduled'
908 eliminates the deadline prewarning only prior to the scheduled date.
909 This can be used in a workflow where the first showing of the deadline will
910 trigger you to schedule it, and then you don't want to be reminded of it
911 because you will take care of it on the day when scheduled."
912 :group 'org-agenda-skip
913 :group 'org-agenda-daily/weekly
914 :version "24.1"
915 :type '(choice
916 (const :tag "Always show prewarning" nil)
917 (const :tag "Remove prewarning prior to scheduled date" pre-scheduled)
918 (const :tag "Remove prewarning if entry is scheduled" t)
919 (integer :tag "Restart prewarning N days before deadline")))
921 (defcustom org-agenda-skip-scheduled-delay-if-deadline nil
922 "Non-nil means skip scheduled delay when entry also has a deadline.
923 This variable may be set to nil, t, the symbol `post-deadline',
924 or a number which will then give the number of days after the actual
925 scheduled date when the delay should expire. The symbol `post-deadline'
926 eliminates the schedule delay when the date is posterior to the deadline."
927 :group 'org-agenda-skip
928 :group 'org-agenda-daily/weekly
929 :version "24.4"
930 :package-version '(Org . "8.0")
931 :type '(choice
932 (const :tag "Always honor delay" nil)
933 (const :tag "Ignore delay if posterior to the deadline" post-deadline)
934 (const :tag "Ignore delay if entry has a deadline" t)
935 (integer :tag "Honor delay up until N days after the scheduled date")))
937 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
938 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
939 When non-nil, after the search for timestamps has matched once in an
940 entry, the rest of the entry will not be searched."
941 :group 'org-agenda-skip
942 :type 'boolean)
944 (defcustom org-agenda-skip-timestamp-if-done nil
945 "Non-nil means don't select item by timestamp or -range if it is DONE."
946 :group 'org-agenda-skip
947 :group 'org-agenda-daily/weekly
948 :type 'boolean)
950 (defcustom org-agenda-dim-blocked-tasks t
951 "Non-nil means dim blocked tasks in the agenda display.
952 This causes some overhead during agenda construction, but if you
953 have turned on `org-enforce-todo-dependencies',
954 `org-enforce-todo-checkbox-dependencies', or any other blocking
955 mechanism, this will create useful feedback in the agenda.
957 Instead of t, this variable can also have the value `invisible'.
958 Then blocked tasks will be invisible and only become visible when
959 they become unblocked. An exemption to this behavior is when a task is
960 blocked because of unchecked checkboxes below it. Since checkboxes do
961 not show up in the agenda views, making this task invisible you remove any
962 trace from agenda views that there is something to do. Therefore, a task
963 that is blocked because of checkboxes will never be made invisible, it
964 will only be dimmed."
965 :group 'org-agenda-daily/weekly
966 :group 'org-agenda-todo-list
967 :version "24.3"
968 :type '(choice
969 (const :tag "Do not dim" nil)
970 (const :tag "Dim to a gray face" t)
971 (const :tag "Make invisible" invisible)))
973 (defcustom org-timeline-show-empty-dates 3
974 "Non-nil means `org-timeline' also shows dates without an entry.
975 When nil, only the days which actually have entries are shown.
976 When t, all days between the first and the last date are shown.
977 When an integer, show also empty dates, but if there is a gap of more than
978 N days, just insert a special line indicating the size of the gap."
979 :group 'org-agenda-skip
980 :type '(choice
981 (const :tag "None" nil)
982 (const :tag "All" t)
983 (integer :tag "at most")))
985 (defgroup org-agenda-startup nil
986 "Options concerning initial settings in the Agenda in Org Mode."
987 :tag "Org Agenda Startup"
988 :group 'org-agenda)
990 (defcustom org-agenda-menu-show-matcher t
991 "Non-nil means show the match string in the agenda dispatcher menu.
992 When nil, the matcher string is not shown, but is put into the help-echo
993 property so than moving the mouse over the command shows it.
994 Setting it to nil is good if matcher strings are very long and/or if
995 you want to use two-columns display (see `org-agenda-menu-two-columns')."
996 :group 'org-agenda
997 :version "24.1"
998 :type 'boolean)
1000 (define-obsolete-variable-alias 'org-agenda-menu-two-column 'org-agenda-menu-two-columns "24.3")
1002 (defcustom org-agenda-menu-two-columns nil
1003 "Non-nil means, use two columns to show custom commands in the dispatcher.
1004 If you use this, you probably want to set `org-agenda-menu-show-matcher'
1005 to nil."
1006 :group 'org-agenda
1007 :version "24.1"
1008 :type 'boolean)
1010 (define-obsolete-variable-alias 'org-finalize-agenda-hook 'org-agenda-finalize-hook "24.3")
1011 (defcustom org-agenda-finalize-hook nil
1012 "Hook run just before displaying an agenda buffer.
1013 The buffer is still writable when the hook is called.
1015 You can modify some of the buffer substrings but you should be
1016 extra careful not to modify the text properties of the agenda
1017 headlines as the agenda display heavily relies on them."
1018 :group 'org-agenda-startup
1019 :type 'hook)
1021 (defcustom org-agenda-mouse-1-follows-link nil
1022 "Non-nil means mouse-1 on a link will follow the link in the agenda.
1023 A longer mouse click will still set point. Does not work on XEmacs.
1024 Needs to be set before org.el is loaded."
1025 :group 'org-agenda-startup
1026 :type 'boolean)
1028 (defcustom org-agenda-start-with-follow-mode nil
1029 "The initial value of follow mode in a newly created agenda window."
1030 :group 'org-agenda-startup
1031 :type 'boolean)
1033 (defcustom org-agenda-follow-indirect nil
1034 "Non-nil means `org-agenda-follow-mode' displays only the
1035 current item's tree, in an indirect buffer."
1036 :group 'org-agenda
1037 :version "24.1"
1038 :type 'boolean)
1040 (defcustom org-agenda-show-outline-path t
1041 "Non-nil means show outline path in echo area after line motion."
1042 :group 'org-agenda-startup
1043 :type 'boolean)
1045 (defcustom org-agenda-start-with-entry-text-mode nil
1046 "The initial value of entry-text-mode in a newly created agenda window."
1047 :group 'org-agenda-startup
1048 :type 'boolean)
1050 (defcustom org-agenda-entry-text-maxlines 5
1051 "Number of text lines to be added when `E' is pressed in the agenda.
1053 Note that this variable only used during agenda display. Add add entry text
1054 when exporting the agenda, configure the variable
1055 `org-agenda-add-entry-ext-maxlines'."
1056 :group 'org-agenda
1057 :type 'integer)
1059 (defcustom org-agenda-entry-text-exclude-regexps nil
1060 "List of regular expressions to clean up entry text.
1061 The complete matches of all regular expressions in this list will be
1062 removed from entry text before it is shown in the agenda."
1063 :group 'org-agenda
1064 :type '(repeat (regexp)))
1066 (defcustom org-agenda-entry-text-leaders " > "
1067 "Text prepended to the entry text in agenda buffers."
1068 :version "24.4"
1069 :package-version '(Org . "8.0")
1070 :group 'org-agenda
1071 :type 'string)
1073 (defvar org-agenda-entry-text-cleanup-hook nil
1074 "Hook that is run after basic cleanup of entry text to be shown in agenda.
1075 This cleanup is done in a temporary buffer, so the function may inspect and
1076 change the entire buffer.
1077 Some default stuff like drawers and scheduling/deadline dates will already
1078 have been removed when this is called, as will any matches for regular
1079 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
1081 (defvar org-agenda-include-inactive-timestamps nil
1082 "Non-nil means include inactive time stamps in agenda and timeline.
1083 Dynamically scoped.")
1085 (defgroup org-agenda-windows nil
1086 "Options concerning the windows used by the Agenda in Org Mode."
1087 :tag "Org Agenda Windows"
1088 :group 'org-agenda)
1090 (defcustom org-agenda-window-setup 'reorganize-frame
1091 "How the agenda buffer should be displayed.
1092 Possible values for this option are:
1094 current-window Show agenda in the current window, keeping all other windows.
1095 other-window Use `switch-to-buffer-other-window' to display agenda.
1096 reorganize-frame Show only two windows on the current frame, the current
1097 window and the agenda.
1098 other-frame Use `switch-to-buffer-other-frame' to display agenda.
1099 Also, when exiting the agenda, kill that frame.
1100 See also the variable `org-agenda-restore-windows-after-quit'."
1101 :group 'org-agenda-windows
1102 :type '(choice
1103 (const current-window)
1104 (const other-frame)
1105 (const other-window)
1106 (const reorganize-frame)))
1108 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
1109 "The min and max height of the agenda window as a fraction of frame height.
1110 The value of the variable is a cons cell with two numbers between 0 and 1.
1111 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
1112 :group 'org-agenda-windows
1113 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
1115 (defcustom org-agenda-restore-windows-after-quit nil
1116 "Non-nil means restore window configuration upon exiting agenda.
1117 Before the window configuration is changed for displaying the agenda,
1118 the current status is recorded. When the agenda is exited with
1119 `q' or `x' and this option is set, the old state is restored. If
1120 `org-agenda-window-setup' is `other-frame', the value of this
1121 option will be ignored."
1122 :group 'org-agenda-windows
1123 :type 'boolean)
1125 (defcustom org-agenda-ndays nil
1126 "Number of days to include in overview display.
1127 Should be 1 or 7.
1128 Obsolete, see `org-agenda-span'."
1129 :group 'org-agenda-daily/weekly
1130 :type '(choice (const nil)
1131 (integer)))
1133 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
1135 (defcustom org-agenda-span 'week
1136 "Number of days to include in overview display.
1137 Can be day, week, month, year, or any number of days.
1138 Custom commands can set this variable in the options section."
1139 :group 'org-agenda-daily/weekly
1140 :type '(choice (const :tag "Day" day)
1141 (const :tag "Week" week)
1142 (const :tag "Fortnight" fortnight)
1143 (const :tag "Month" month)
1144 (const :tag "Year" year)
1145 (integer :tag "Custom")))
1147 (defcustom org-agenda-start-on-weekday 1
1148 "Non-nil means start the overview always on the specified weekday.
1149 0 denotes Sunday, 1 denotes Monday, etc.
1150 When nil, always start on the current day.
1151 Custom commands can set this variable in the options section."
1152 :group 'org-agenda-daily/weekly
1153 :type '(choice (const :tag "Today" nil)
1154 (integer :tag "Weekday No.")))
1156 (defcustom org-agenda-show-all-dates t
1157 "Non-nil means `org-agenda' shows every day in the selected range.
1158 When nil, only the days which actually have entries are shown."
1159 :group 'org-agenda-daily/weekly
1160 :type 'boolean)
1162 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1163 "Format string for displaying dates in the agenda.
1164 Used by the daily/weekly agenda and by the timeline. This should be
1165 a format string understood by `format-time-string', or a function returning
1166 the formatted date as a string. The function must take a single argument,
1167 a calendar-style date list like (month day year)."
1168 :group 'org-agenda-daily/weekly
1169 :type '(choice
1170 (string :tag "Format string")
1171 (function :tag "Function")))
1173 (defun org-agenda-format-date-aligned (date)
1174 "Format a DATE string for display in the daily/weekly agenda, or timeline.
1175 This function makes sure that dates are aligned for easy reading."
1176 (require 'cal-iso)
1177 (let* ((dayname (calendar-day-name date))
1178 (day (cadr date))
1179 (day-of-week (calendar-day-of-week date))
1180 (month (car date))
1181 (monthname (calendar-month-name month))
1182 (year (nth 2 date))
1183 (iso-week (org-days-to-iso-week
1184 (calendar-absolute-from-gregorian date)))
1185 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1186 (1- year))
1187 ((and (= month 12) (<= iso-week 1))
1188 (1+ year))
1189 (t year)))
1190 (weekstring (if (= day-of-week 1)
1191 (format " W%02d" iso-week)
1192 "")))
1193 (format "%-10s %2d %s %4d%s"
1194 dayname day monthname year weekstring)))
1196 (defcustom org-agenda-time-leading-zero nil
1197 "Non-nil means use leading zero for military times in agenda.
1198 For example, 9:30am would become 09:30 rather than 9:30."
1199 :group 'org-agenda-daily/weekly
1200 :version "24.1"
1201 :type 'boolean)
1203 (defcustom org-agenda-timegrid-use-ampm nil
1204 "When set, show AM/PM style timestamps on the timegrid."
1205 :group 'org-agenda
1206 :version "24.1"
1207 :type 'boolean)
1209 (defun org-agenda-time-of-day-to-ampm (time)
1210 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1211 (let* ((hour-number (string-to-number (substring time 0 -3)))
1212 (minute (substring time -2))
1213 (ampm "am"))
1214 (cond
1215 ((equal hour-number 12)
1216 (setq ampm "pm"))
1217 ((> hour-number 12)
1218 (setq ampm "pm")
1219 (setq hour-number (- hour-number 12))))
1220 (concat
1221 (if org-agenda-time-leading-zero
1222 (format "%02d" hour-number)
1223 (format "%02s" (number-to-string hour-number)))
1224 ":" minute ampm)))
1226 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1227 "Conditionally convert TIME to AM/PM format based on `org-agenda-timegrid-use-ampm'."
1228 (if org-agenda-timegrid-use-ampm
1229 (org-agenda-time-of-day-to-ampm time)
1230 time))
1232 (defcustom org-agenda-weekend-days '(6 0)
1233 "Which days are weekend?
1234 These days get the special face `org-agenda-date-weekend' in the agenda
1235 and timeline buffers."
1236 :group 'org-agenda-daily/weekly
1237 :type '(set :greedy t
1238 (const :tag "Monday" 1)
1239 (const :tag "Tuesday" 2)
1240 (const :tag "Wednesday" 3)
1241 (const :tag "Thursday" 4)
1242 (const :tag "Friday" 5)
1243 (const :tag "Saturday" 6)
1244 (const :tag "Sunday" 0)))
1246 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1247 "Non-nil means jump to today when moving a past date forward in time.
1248 When using S-right in the agenda to move a a date forward, and the date
1249 stamp currently points to the past, the first key press will move it
1250 to today. WHen nil, just move one day forward even if the date stays
1251 in the past."
1252 :group 'org-agenda-daily/weekly
1253 :version "24.1"
1254 :type 'boolean)
1256 (defcustom org-agenda-include-diary nil
1257 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1258 Custom commands can set this variable in the options section."
1259 :group 'org-agenda-daily/weekly
1260 :type 'boolean)
1262 (defcustom org-agenda-include-deadlines t
1263 "If non-nil, include entries within their deadline warning period.
1264 Custom commands can set this variable in the options section."
1265 :group 'org-agenda-daily/weekly
1266 :version "24.1"
1267 :type 'boolean)
1269 (defcustom org-agenda-repeating-timestamp-show-all t
1270 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1271 When set to a list of strings, only show occurrences of repeating
1272 stamps for these TODO keywords. When nil, only one occurrence is
1273 shown, either today or the nearest into the future."
1274 :group 'org-agenda-daily/weekly
1275 :type '(choice
1276 (const :tag "Show repeating stamps" t)
1277 (repeat :tag "Show repeating stamps for these TODO keywords"
1278 (string :tag "TODO Keyword"))
1279 (const :tag "Don't show repeating stamps" nil)))
1281 (defcustom org-scheduled-past-days 10000
1282 "Number of days to continue listing scheduled items not marked DONE.
1283 When an item is scheduled on a date, it shows up in the agenda on this
1284 day and will be listed until it is marked done for the number of days
1285 given here."
1286 :group 'org-agenda-daily/weekly
1287 :type 'integer)
1289 (defcustom org-agenda-log-mode-items '(closed clock)
1290 "List of items that should be shown in agenda log mode.
1291 This list may contain the following symbols:
1293 closed Show entries that have been closed on that day.
1294 clock Show entries that have received clocked time on that day.
1295 state Show all logged state changes.
1296 Note that instead of changing this variable, you can also press `C-u l' in
1297 the agenda to display all available LOG items temporarily."
1298 :group 'org-agenda-daily/weekly
1299 :type '(set :greedy t (const closed) (const clock) (const state)))
1301 (defcustom org-agenda-clock-consistency-checks
1302 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1303 :gap-ok-around ("4:00")
1304 :default-face ((:background "DarkRed") (:foreground "white"))
1305 :overlap-face nil :gap-face nil :no-end-time-face nil
1306 :long-face nil :short-face nil)
1307 "This is a property list, with the following keys:
1309 :max-duration Mark clocking chunks that are longer than this time.
1310 This is a time string like \"HH:MM\", or the number
1311 of minutes as an integer.
1313 :min-duration Mark clocking chunks that are shorter that this.
1314 This is a time string like \"HH:MM\", or the number
1315 of minutes as an integer.
1317 :max-gap Mark gaps between clocking chunks that are longer than
1318 this duration. A number of minutes, or a string
1319 like \"HH:MM\".
1321 :gap-ok-around List of times during the day which are usually not working
1322 times. When a gap is detected, but the gap contains any
1323 of these times, the gap is *not* reported. For example,
1324 if this is (\"4:00\" \"13:00\") then gaps that contain
1325 4:00 in the morning (i.e. the night) and 13:00
1326 (i.e. a typical lunch time) do not cause a warning.
1327 You should have at least one time during the night in this
1328 list, or otherwise the first task each morning will trigger
1329 a warning because it follows a long gap.
1331 Furthermore, the following properties can be used to define faces for
1332 issue display.
1334 :default-face the default face, if the specific face is undefined
1335 :overlap-face face for overlapping clocks
1336 :gap-face face for gaps between clocks
1337 :no-end-time-face face for incomplete clocks
1338 :long-face face for clock intervals that are too long
1339 :short-face face for clock intervals that are too short"
1340 :group 'org-agenda-daily/weekly
1341 :group 'org-clock
1342 :version "24.1"
1343 :type 'plist)
1345 (defcustom org-agenda-log-mode-add-notes t
1346 "Non-nil means add first line of notes to log entries in agenda views.
1347 If a log item like a state change or a clock entry is associated with
1348 notes, the first line of these notes will be added to the entry in the
1349 agenda display."
1350 :group 'org-agenda-daily/weekly
1351 :type 'boolean)
1353 (defcustom org-agenda-start-with-log-mode nil
1354 "The initial value of log-mode in a newly created agenda window.
1355 See `org-agenda-log-mode' and `org-agenda-log-mode-items' for further
1356 explanations on the possible values."
1357 :group 'org-agenda-startup
1358 :group 'org-agenda-daily/weekly
1359 :type '(choice (const :tag "Don't show log items" nil)
1360 (const :tag "Show only log items" only)
1361 (const :tag "Show all possible log items" clockcheck)
1362 (repeat :tag "Choose among possible values for `org-agenda-log-mode-items'"
1363 (choice (const :tag "Show closed log items" closed)
1364 (const :tag "Show clocked log items" clock)
1365 (const :tag "Show all logged state changes" state)))))
1367 (defcustom org-agenda-start-with-clockreport-mode nil
1368 "The initial value of clockreport-mode in a newly created agenda window."
1369 :group 'org-agenda-startup
1370 :group 'org-agenda-daily/weekly
1371 :type 'boolean)
1373 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1374 "Property list with parameters for the clocktable in clockreport mode.
1375 This is the display mode that shows a clock table in the daily/weekly
1376 agenda, the properties for this dynamic block can be set here.
1377 The usual clocktable parameters are allowed here, but you cannot set
1378 the properties :name, :tstart, :tend, :block, and :scope - these will
1379 be overwritten to make sure the content accurately reflects the
1380 current display in the agenda."
1381 :group 'org-agenda-daily/weekly
1382 :type 'plist)
1384 (defcustom org-agenda-search-view-always-boolean nil
1385 "Non-nil means the search string is interpreted as individual parts.
1387 The search string for search view can either be interpreted as a phrase,
1388 or as a list of snippets that define a boolean search for a number of
1389 strings.
1391 When this is non-nil, the string will be split on whitespace, and each
1392 snippet will be searched individually, and all must match in order to
1393 select an entry. A snippet is then a single string of non-white
1394 characters, or a string in double quotes, or a regexp in {} braces.
1395 If a snippet is preceded by \"-\", the snippet must *not* match.
1396 \"+\" is syntactic sugar for positive selection. Each snippet may
1397 be found as a full word or a partial word, but see the variable
1398 `org-agenda-search-view-force-full-words'.
1400 When this is nil, search will look for the entire search phrase as one,
1401 with each space character matching any amount of whitespace, including
1402 line breaks.
1404 Even when this is nil, you can still switch to Boolean search dynamically
1405 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1406 is a regexp marked with braces like \"{abc}\", this will also switch to
1407 boolean search."
1408 :group 'org-agenda-search-view
1409 :version "24.1"
1410 :type 'boolean)
1412 (org-defvaralias 'org-agenda-search-view-search-words-only
1413 'org-agenda-search-view-always-boolean)
1415 (defcustom org-agenda-search-view-force-full-words nil
1416 "Non-nil means, search words must be matches as complete words.
1417 When nil, they may also match part of a word."
1418 :group 'org-agenda-search-view
1419 :version "24.1"
1420 :type 'boolean)
1422 (defcustom org-agenda-search-view-max-outline-level 0
1423 "Maximum outline level to display in search view.
1424 E.g. when this is set to 1, the search view will only
1425 show headlines of level 1. When set to 0, the default
1426 value, don't limit agenda view by outline level."
1427 :group 'org-agenda-search-view
1428 :version "24.4"
1429 :package-version '(Org . "8.3")
1430 :type 'integer)
1432 (defgroup org-agenda-time-grid nil
1433 "Options concerning the time grid in the Org-mode Agenda."
1434 :tag "Org Agenda Time Grid"
1435 :group 'org-agenda)
1437 (defcustom org-agenda-search-headline-for-time t
1438 "Non-nil means search headline for a time-of-day.
1439 If the headline contains a time-of-day in one format or another, it will
1440 be used to sort the entry into the time sequence of items for a day.
1441 Some people have time stamps in the headline that refer to the creation
1442 time or so, and then this produces an unwanted side effect. If this is
1443 the case for your, use this variable to turn off searching the headline
1444 for a time."
1445 :group 'org-agenda-time-grid
1446 :type 'boolean)
1448 (defcustom org-agenda-use-time-grid t
1449 "Non-nil means show a time grid in the agenda schedule.
1450 A time grid is a set of lines for specific times (like every two hours between
1451 8:00 and 20:00). The items scheduled for a day at specific times are
1452 sorted in between these lines.
1453 For details about when the grid will be shown, and what it will look like, see
1454 the variable `org-agenda-time-grid'."
1455 :group 'org-agenda-time-grid
1456 :type 'boolean)
1458 (defcustom org-agenda-time-grid
1459 '((daily today require-timed)
1460 "----------------"
1461 (800 1000 1200 1400 1600 1800 2000))
1463 "The settings for time grid for agenda display.
1464 This is a list of three items. The first item is again a list. It contains
1465 symbols specifying conditions when the grid should be displayed:
1467 daily if the agenda shows a single day
1468 weekly if the agenda shows an entire week
1469 today show grid on current date, independent of daily/weekly display
1470 require-timed show grid only if at least one item has a time specification
1472 The second item is a string which will be placed behind the grid time.
1474 The third item is a list of integers, indicating the times that should have
1475 a grid line."
1476 :group 'org-agenda-time-grid
1477 :type
1478 '(list
1479 (set :greedy t :tag "Grid Display Options"
1480 (const :tag "Show grid in single day agenda display" daily)
1481 (const :tag "Show grid in weekly agenda display" weekly)
1482 (const :tag "Always show grid for today" today)
1483 (const :tag "Show grid only if any timed entries are present"
1484 require-timed)
1485 (const :tag "Skip grid times already present in an entry"
1486 remove-match))
1487 (string :tag "Grid String")
1488 (repeat :tag "Grid Times" (integer :tag "Time"))))
1490 (defcustom org-agenda-show-current-time-in-grid t
1491 "Non-nil means show the current time in the time grid."
1492 :group 'org-agenda-time-grid
1493 :version "24.1"
1494 :type 'boolean)
1496 (defcustom org-agenda-current-time-string
1497 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1498 "The string for the current time marker in the agenda."
1499 :group 'org-agenda-time-grid
1500 :version "24.1"
1501 :type 'string)
1503 (defgroup org-agenda-sorting nil
1504 "Options concerning sorting in the Org-mode Agenda."
1505 :tag "Org Agenda Sorting"
1506 :group 'org-agenda)
1508 (defcustom org-agenda-sorting-strategy
1509 '((agenda habit-down time-up priority-down category-keep)
1510 (todo priority-down category-keep)
1511 (tags priority-down category-keep)
1512 (search category-keep))
1513 "Sorting structure for the agenda items of a single day.
1514 This is a list of symbols which will be used in sequence to determine
1515 if an entry should be listed before another entry. The following
1516 symbols are recognized:
1518 time-up Put entries with time-of-day indications first, early first
1519 time-down Put entries with time-of-day indications first, late first
1520 timestamp-up Sort by any timestamp, early first
1521 timestamp-down Sort by any timestamp, late first
1522 scheduled-up Sort by scheduled timestamp, early first
1523 scheduled-down Sort by scheduled timestamp, late first
1524 deadline-up Sort by deadline timestamp, early first
1525 deadline-down Sort by deadline timestamp, late first
1526 ts-up Sort by active timestamp, early first
1527 ts-down Sort by active timestamp, late first
1528 tsia-up Sort by inactive timestamp, early first
1529 tsia-down Sort by inactive timestamp, late first
1530 category-keep Keep the default order of categories, corresponding to the
1531 sequence in `org-agenda-files'.
1532 category-up Sort alphabetically by category, A-Z.
1533 category-down Sort alphabetically by category, Z-A.
1534 tag-up Sort alphabetically by last tag, A-Z.
1535 tag-down Sort alphabetically by last tag, Z-A.
1536 priority-up Sort numerically by priority, high priority last.
1537 priority-down Sort numerically by priority, high priority first.
1538 todo-state-up Sort by todo state, tasks that are done last.
1539 todo-state-down Sort by todo state, tasks that are done first.
1540 effort-up Sort numerically by estimated effort, high effort last.
1541 effort-down Sort numerically by estimated effort, high effort first.
1542 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1543 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1544 habit-up Put entries that are habits first
1545 habit-down Put entries that are habits last
1546 alpha-up Sort headlines alphabetically
1547 alpha-down Sort headlines alphabetically, reversed
1549 The different possibilities will be tried in sequence, and testing stops
1550 if one comparison returns a \"not-equal\". For example, the default
1551 '(time-up category-keep priority-down)
1552 means: Pull out all entries having a specified time of day and sort them,
1553 in order to make a time schedule for the current day the first thing in the
1554 agenda listing for the day. Of the entries without a time indication, keep
1555 the grouped in categories, don't sort the categories, but keep them in
1556 the sequence given in `org-agenda-files'. Within each category sort by
1557 priority.
1559 Leaving out `category-keep' would mean that items will be sorted across
1560 categories by priority.
1562 Instead of a single list, this can also be a set of list for specific
1563 contents, with a context symbol in the car of the list, any of
1564 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1566 Custom commands can bind this variable in the options section."
1567 :group 'org-agenda-sorting
1568 :type `(choice
1569 (repeat :tag "General" ,org-sorting-choice)
1570 (list :tag "Individually"
1571 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1572 (repeat ,org-sorting-choice))
1573 (cons (const :tag "Strategy for TODO lists" todo)
1574 (repeat ,org-sorting-choice))
1575 (cons (const :tag "Strategy for Tags matches" tags)
1576 (repeat ,org-sorting-choice))
1577 (cons (const :tag "Strategy for search matches" search)
1578 (repeat ,org-sorting-choice)))))
1580 (defcustom org-agenda-cmp-user-defined nil
1581 "A function to define the comparison `user-defined'.
1582 This function must receive two arguments, agenda entry a and b.
1583 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1584 the user comparison, return nil.
1585 When this is defined, you can make `user-defined-up' and `user-defined-down'
1586 part of an agenda sorting strategy."
1587 :group 'org-agenda-sorting
1588 :type 'symbol)
1590 (defcustom org-sort-agenda-notime-is-late t
1591 "Non-nil means items without time are considered late.
1592 This is only relevant for sorting. When t, items which have no explicit
1593 time like 15:30 will be considered as 99:01, i.e. later than any items which
1594 do have a time. When nil, the default time is before 0:00. You can use this
1595 option to decide if the schedule for today should come before or after timeless
1596 agenda entries."
1597 :group 'org-agenda-sorting
1598 :type 'boolean)
1600 (defcustom org-sort-agenda-noeffort-is-high t
1601 "Non-nil means items without effort estimate are sorted as high effort.
1602 This also applies when filtering an agenda view with respect to the
1603 < or > effort operator. Then, tasks with no effort defined will be treated
1604 as tasks with high effort.
1605 When nil, such items are sorted as 0 minutes effort."
1606 :group 'org-agenda-sorting
1607 :type 'boolean)
1609 (defgroup org-agenda-line-format nil
1610 "Options concerning the entry prefix in the Org-mode agenda display."
1611 :tag "Org Agenda Line Format"
1612 :group 'org-agenda)
1614 (defcustom org-agenda-prefix-format
1615 '((agenda . " %i %-12:c%?-12t% s")
1616 (timeline . " % s")
1617 (todo . " %i %-12:c")
1618 (tags . " %i %-12:c")
1619 (search . " %i %-12:c"))
1620 "Format specifications for the prefix of items in the agenda views.
1621 An alist with five entries, each for the different agenda types. The
1622 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1623 The values are format strings.
1625 This format works similar to a printf format, with the following meaning:
1627 %c the category of the item, \"Diary\" for entries from the diary,
1628 or as given by the CATEGORY keyword or derived from the file name
1629 %e the effort required by the item
1630 %l the level of the item (insert X space(s) if item is of level X)
1631 %i the icon category of the item, see `org-agenda-category-icon-alist'
1632 %T the last tag of the item (ignore inherited tags, which come first)
1633 %t the HH:MM time-of-day specification if one applies to the entry
1634 %s Scheduling/Deadline information, a short string
1635 %b show breadcrumbs, i.e., the names of the higher levels
1636 %(expression) Eval EXPRESSION and replace the control string
1637 by the result
1639 All specifiers work basically like the standard `%s' of printf, but may
1640 contain two additional characters: a question mark just after the `%'
1641 and a whitespace/punctuation character just before the final letter.
1643 If the first character after `%' is a question mark, the entire field
1644 will only be included if the corresponding value applies to the current
1645 entry. This is useful for fields which should have fixed width when
1646 present, but zero width when absent. For example, \"%?-12t\" will
1647 result in a 12 character time field if a time of the day is specified,
1648 but will completely disappear in entries which do not contain a time.
1650 If there is punctuation or whitespace character just before the
1651 final format letter, this character will be appended to the field
1652 value if the value is not empty. For example, the format
1653 \"%-12:c\" leads to \"Diary: \" if the category is \"Diary\". If
1654 the category is empty, no additional colon is inserted.
1656 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1657 which means:
1659 - Indent the line with two space characters
1660 - Give the category a 12 chars wide field, padded with whitespace on
1661 the right (because of `-'). Append a colon if there is a category
1662 (because of `:').
1663 - If there is a time-of-day, put it into a 12 chars wide field. If no
1664 time, don't put in an empty field, just skip it (because of '?').
1665 - Finally, put the scheduling information.
1667 See also the variables `org-agenda-remove-times-when-in-prefix' and
1668 `org-agenda-remove-tags'.
1670 Custom commands can set this variable in the options section."
1671 :type '(choice
1672 (string :tag "General format")
1673 (list :greedy t :tag "View dependent"
1674 (cons (const agenda) (string :tag "Format"))
1675 (cons (const timeline) (string :tag "Format"))
1676 (cons (const todo) (string :tag "Format"))
1677 (cons (const tags) (string :tag "Format"))
1678 (cons (const search) (string :tag "Format"))))
1679 :group 'org-agenda-line-format)
1681 (defvar org-prefix-format-compiled nil
1682 "The compiled prefix format and associated variables.
1683 This is a list where first element is a list of variable bindings, and second
1684 element is the compiled format expression. See the variable
1685 `org-agenda-prefix-format'.")
1687 (defcustom org-agenda-todo-keyword-format "%-1s"
1688 "Format for the TODO keyword in agenda lines.
1689 Set this to something like \"%-12s\" if you want all TODO keywords
1690 to occupy a fixed space in the agenda display."
1691 :group 'org-agenda-line-format
1692 :type 'string)
1694 (defcustom org-agenda-diary-sexp-prefix nil
1695 "A regexp that matches part of a diary sexp entry
1696 which should be treated as scheduling/deadline information in
1697 `org-agenda'.
1699 For example, you can use this to extract the `diary-remind-message' from
1700 `diary-remind' entries."
1701 :group 'org-agenda-line-format
1702 :type '(choice (const :tag "None" nil) (regexp :tag "Regexp")))
1704 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1705 "Text preceding timerange entries in the agenda view.
1706 This is a list with two strings. The first applies when the range
1707 is entirely on one day. The second applies if the range spans several days.
1708 The strings may have two \"%d\" format specifiers which will be filled
1709 with the sequence number of the days, and the total number of days in the
1710 range, respectively."
1711 :group 'org-agenda-line-format
1712 :type '(list
1713 (string :tag "Deadline today ")
1714 (choice :tag "Deadline relative"
1715 (string :tag "Format string")
1716 (function))))
1718 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1719 "Text preceding scheduled items in the agenda view.
1720 This is a list with two strings. The first applies when the item is
1721 scheduled on the current day. The second applies when it has been scheduled
1722 previously, it may contain a %d indicating that this is the nth time that
1723 this item is scheduled, due to automatic rescheduling of unfinished items
1724 for the following day. So this number is one larger than the number of days
1725 that passed since this item was scheduled first."
1726 :group 'org-agenda-line-format
1727 :version "24.4"
1728 :package-version '(Org . "8.0")
1729 :type '(list
1730 (string :tag "Scheduled today ")
1731 (string :tag "Scheduled previously")))
1733 (defcustom org-agenda-inactive-leader "["
1734 "Text preceding item pulled into the agenda by inactive time stamps.
1735 These entries are added to the agenda when pressing \"[\"."
1736 :group 'org-agenda-line-format
1737 :version "24.1"
1738 :type 'string)
1740 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: " "%2d d. ago: ")
1741 "Text preceding deadline items in the agenda view.
1742 This is a list with three strings. The first applies when the item has its
1743 deadline on the current day. The second applies when the deadline is in the
1744 future, the third one when it is in the past. The strings may contain %d
1745 to capture the number of days."
1746 :group 'org-agenda-line-format
1747 :version "24.4"
1748 :package-version '(Org . "8.0")
1749 :type '(list
1750 (string :tag "Deadline today ")
1751 (string :tag "Deadline in the future ")
1752 (string :tag "Deadline in the past ")))
1754 (defcustom org-agenda-remove-times-when-in-prefix t
1755 "Non-nil means remove duplicate time specifications in agenda items.
1756 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1757 time-of-day specification in a headline or diary entry is extracted and
1758 placed into the prefix. If this option is non-nil, the original specification
1759 \(a timestamp or -range, or just a plain time(range) specification like
1760 11:30-4pm) will be removed for agenda display. This makes the agenda less
1761 cluttered.
1762 The option can be t or nil. It may also be the symbol `beg', indicating
1763 that the time should only be removed when it is located at the beginning of
1764 the headline/diary entry."
1765 :group 'org-agenda-line-format
1766 :type '(choice
1767 (const :tag "Always" t)
1768 (const :tag "Never" nil)
1769 (const :tag "When at beginning of entry" beg)))
1771 (defcustom org-agenda-remove-timeranges-from-blocks nil
1772 "Non-nil means remove time ranges specifications in agenda
1773 items that span on several days."
1774 :group 'org-agenda-line-format
1775 :version "24.1"
1776 :type 'boolean)
1778 (defcustom org-agenda-default-appointment-duration nil
1779 "Default duration for appointments that only have a starting time.
1780 When nil, no duration is specified in such cases.
1781 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1782 :group 'org-agenda-line-format
1783 :type '(choice
1784 (integer :tag "Minutes")
1785 (const :tag "No default duration")))
1787 (defcustom org-agenda-show-inherited-tags t
1788 "Non-nil means show inherited tags in each agenda line.
1790 When this option is set to 'always, it take precedences over
1791 `org-agenda-use-tag-inheritance' and inherited tags are shown
1792 in every agenda.
1794 When this option is set to t (the default), inherited tags are
1795 shown when they are available, i.e. when the value of
1796 `org-agenda-use-tag-inheritance' has been taken into account.
1798 This can be set to a list of agenda types in which the agenda
1799 must display the inherited tags. Available types are 'todo,
1800 'agenda, 'search and 'timeline.
1802 When set to nil, never show inherited tags in agenda lines."
1803 :group 'org-agenda-line-format
1804 :group 'org-agenda
1805 :version "24.3"
1806 :type '(choice
1807 (const :tag "Show inherited tags when available" t)
1808 (const :tag "Always show inherited tags" always)
1809 (repeat :tag "Show inherited tags only in selected agenda types"
1810 (symbol :tag "Agenda type"))))
1812 (defcustom org-agenda-use-tag-inheritance '(todo search timeline agenda)
1813 "List of agenda view types where to use tag inheritance.
1815 In tags/tags-todo/tags-tree agenda views, tag inheritance is
1816 controlled by `org-use-tag-inheritance'. In other agenda types,
1817 `org-use-tag-inheritance' is not used for the selection of the
1818 agenda entries. Still, you may want the agenda to be aware of
1819 the inherited tags anyway, e.g. for later tag filtering.
1821 Allowed value are 'todo, 'search, 'timeline and 'agenda.
1823 This variable has no effect if `org-agenda-show-inherited-tags'
1824 is set to 'always. In that case, the agenda is aware of those
1825 tags.
1827 The default value sets tags in every agenda type. Setting this
1828 option to nil will speed up non-tags agenda view a lot."
1829 :group 'org-agenda
1830 :version "24.3"
1831 :type '(choice
1832 (const :tag "Use tag inheritance in all agenda types" t)
1833 (repeat :tag "Use tag inheritance in selected agenda types"
1834 (symbol :tag "Agenda type"))))
1836 (defcustom org-agenda-hide-tags-regexp nil
1837 "Regular expression used to filter away specific tags in agenda views.
1838 This means that these tags will be present, but not be shown in the agenda
1839 line. Secondary filtering will still work on the hidden tags.
1840 Nil means don't hide any tags."
1841 :group 'org-agenda-line-format
1842 :type '(choice
1843 (const :tag "Hide none" nil)
1844 (string :tag "Regexp ")))
1846 (defcustom org-agenda-remove-tags nil
1847 "Non-nil means remove the tags from the headline copy in the agenda.
1848 When this is the symbol `prefix', only remove tags when
1849 `org-agenda-prefix-format' contains a `%T' specifier."
1850 :group 'org-agenda-line-format
1851 :type '(choice
1852 (const :tag "Always" t)
1853 (const :tag "Never" nil)
1854 (const :tag "When prefix format contains %T" prefix)))
1856 (org-defvaralias 'org-agenda-remove-tags-when-in-prefix
1857 'org-agenda-remove-tags)
1859 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1860 "Shift tags in agenda items to this column.
1861 If this number is positive, it specifies the column. If it is negative,
1862 it means that the tags should be flushright to that column. For example,
1863 -80 works well for a normal 80 character screen."
1864 :group 'org-agenda-line-format
1865 :type 'integer)
1867 (org-defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column)
1869 (defcustom org-agenda-fontify-priorities 'cookies
1870 "Non-nil means highlight low and high priorities in agenda.
1871 When t, the highest priority entries are bold, lowest priority italic.
1872 However, settings in `org-priority-faces' will overrule these faces.
1873 When this variable is the symbol `cookies', only fontify the
1874 cookies, not the entire task.
1875 This may also be an association list of priority faces, whose
1876 keys are the character values of `org-highest-priority',
1877 `org-default-priority', and `org-lowest-priority' (the default values
1878 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1879 color as a string, or a list like `(:background \"Red\")'.
1880 If it is a color, the variable `org-faces-easy-properties'
1881 determines if it is a foreground or a background color."
1882 :group 'org-agenda-line-format
1883 :type '(choice
1884 (const :tag "Never" nil)
1885 (const :tag "Defaults" t)
1886 (const :tag "Cookies only" cookies)
1887 (repeat :tag "Specify"
1888 (list (character :tag "Priority" :value ?A)
1889 (choice :tag "Face "
1890 (string :tag "Color")
1891 (sexp :tag "Face"))))))
1893 (defcustom org-agenda-day-face-function nil
1894 "Function called to determine what face should be used to display a day.
1895 The only argument passed to that function is the day. It should
1896 returns a face, or nil if does not want to specify a face and let
1897 the normal rules apply."
1898 :group 'org-agenda-line-format
1899 :version "24.1"
1900 :type '(choice (const nil) (function)))
1902 (defcustom org-agenda-category-icon-alist nil
1903 "Alist of category icon to be displayed in agenda views.
1905 Each entry should have the following format:
1907 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1909 Where CATEGORY-REGEXP is a regexp matching the categories where
1910 the icon should be displayed.
1911 FILE-OR-DATA either a file path or a string containing image data.
1913 The other fields can be omitted safely if not needed:
1914 TYPE indicates the image type.
1915 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1916 image data.
1917 PROPS are additional image attributes to assign to the image,
1918 like, e.g. `:ascent center'.
1920 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1922 If you want to set the display properties yourself, just put a
1923 list as second element:
1925 (CATEGORY-REGEXP (MY PROPERTY LIST))
1927 For example, to display a 16px horizontal space for Emacs
1928 category, you can use:
1930 (\"Emacs\" '(space . (:width (16))))"
1931 :group 'org-agenda-line-format
1932 :version "24.1"
1933 :type '(alist :key-type (string :tag "Regexp matching category")
1934 :value-type (choice (list :tag "Icon"
1935 (string :tag "File or data")
1936 (symbol :tag "Type")
1937 (boolean :tag "Data?")
1938 (repeat :tag "Extra image properties" :inline t symbol))
1939 (list :tag "Display properties" sexp))))
1941 (defgroup org-agenda-column-view nil
1942 "Options concerning column view in the agenda."
1943 :tag "Org Agenda Column View"
1944 :group 'org-agenda)
1946 (defcustom org-agenda-columns-show-summaries t
1947 "Non-nil means show summaries for columns displayed in the agenda view."
1948 :group 'org-agenda-column-view
1949 :type 'boolean)
1951 (defcustom org-agenda-columns-compute-summary-properties t
1952 "Non-nil means recompute all summary properties before column view.
1953 When column view in the agenda is listing properties that have a summary
1954 operator, it can go to all relevant buffers and recompute the summaries
1955 there. This can mean overhead for the agenda column view, but is necessary
1956 to have thing up to date.
1957 As a special case, a CLOCKSUM property also makes sure that the clock
1958 computations are current."
1959 :group 'org-agenda-column-view
1960 :type 'boolean)
1962 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1963 "Non-nil means the duration of an appointment will add to day effort.
1964 The property to which appointment durations will be added is the one given
1965 in the option `org-effort-property'. If an appointment does not have
1966 an end time, `org-agenda-default-appointment-duration' will be used. If that
1967 is not set, an appointment without end time will not contribute to the time
1968 estimate."
1969 :group 'org-agenda-column-view
1970 :type 'boolean)
1972 (defcustom org-agenda-auto-exclude-function nil
1973 "A function called with a tag to decide if it is filtered on '/ RET'.
1974 The sole argument to the function, which is called once for each
1975 possible tag, is a string giving the name of the tag. The
1976 function should return either nil if the tag should be included
1977 as normal, or \"-<TAG>\" to exclude the tag.
1978 Note that for the purpose of tag filtering, only the lower-case version of
1979 all tags will be considered, so that this function will only ever see
1980 the lower-case version of all tags."
1981 :group 'org-agenda
1982 :type '(choice (const nil) (function)))
1984 (defcustom org-agenda-bulk-custom-functions nil
1985 "Alist of characters and custom functions for bulk actions.
1986 For example, this value makes those two functions available:
1988 '((?R set-category)
1989 (?C bulk-cut))
1991 With selected entries in an agenda buffer, `B R' will call
1992 the custom function `set-category' on the selected entries.
1993 Note that functions in this alist don't need to be quoted."
1994 :type 'alist
1995 :version "24.1"
1996 :group 'org-agenda)
1998 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1999 "Execute BODY with point at location given by `org-hd-marker' property.
2000 If STRING is non-nil, the text property will be fetched from position 0
2001 in that string. If STRING is nil, it will be fetched from the beginning
2002 of the current line."
2003 (org-with-gensyms (marker)
2004 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
2005 'org-hd-marker ,string)))
2006 (with-current-buffer (marker-buffer ,marker)
2007 (save-excursion
2008 (goto-char ,marker)
2009 ,@body)))))
2010 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
2012 (defun org-add-agenda-custom-command (entry)
2013 "Replace or add a command in `org-agenda-custom-commands'.
2014 This is mostly for hacking and trying a new command - once the command
2015 works you probably want to add it to `org-agenda-custom-commands' for good."
2016 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
2017 (if ass
2018 (setcdr ass (cdr entry))
2019 (push entry org-agenda-custom-commands))))
2021 ;;; Define the org-agenda-mode
2023 (defvar org-agenda-mode-map (make-sparse-keymap)
2024 "Keymap for `org-agenda-mode'.")
2025 (org-defvaralias 'org-agenda-keymap 'org-agenda-mode-map)
2027 (defvar org-agenda-menu) ; defined later in this file.
2028 (defvar org-agenda-restrict nil) ; defined later in this file.
2029 (defvar org-agenda-follow-mode nil)
2030 (defvar org-agenda-entry-text-mode nil)
2031 (defvar org-agenda-clockreport-mode nil)
2032 (defvar org-agenda-show-log nil)
2033 (defvar org-agenda-redo-command nil)
2034 (defvar org-agenda-query-string nil)
2035 (defvar org-agenda-mode-hook nil
2036 "Hook run after `org-agenda-mode' is turned on.
2037 The buffer is still writable when this hook is called.")
2038 (defvar org-agenda-type nil)
2039 (defvar org-agenda-force-single-file nil)
2040 (defvar org-agenda-bulk-marked-entries nil
2041 "List of markers that refer to marked entries in the agenda.")
2043 ;;; Multiple agenda buffers support
2045 (defcustom org-agenda-sticky nil
2046 "Non-nil means agenda q key will bury agenda buffers.
2047 Agenda commands will then show existing buffer instead of generating new ones.
2048 When nil, `q' will kill the single agenda buffer."
2049 :group 'org-agenda
2050 :version "24.3"
2051 :type 'boolean)
2054 ;;;###autoload
2055 (defun org-toggle-sticky-agenda (&optional arg)
2056 "Toggle `org-agenda-sticky'."
2057 (interactive "P")
2058 (let ((new-value (if arg
2059 (> (prefix-numeric-value arg) 0)
2060 (not org-agenda-sticky))))
2061 (if (equal new-value org-agenda-sticky)
2062 (and (org-called-interactively-p 'interactive)
2063 (message "Sticky agenda was already %s"
2064 (if org-agenda-sticky "enabled" "disabled")))
2065 (setq org-agenda-sticky new-value)
2066 (org-agenda-kill-all-agenda-buffers)
2067 (and (org-called-interactively-p 'interactive)
2068 (message "Sticky agenda was %s"
2069 (if org-agenda-sticky "enabled" "disabled"))))))
2071 (defvar org-agenda-buffer nil
2072 "Agenda buffer currently being generated.")
2074 (defvar org-agenda-last-prefix-arg nil)
2075 (defvar org-agenda-this-buffer-name nil)
2076 (defvar org-agenda-doing-sticky-redo nil)
2077 (defvar org-agenda-this-buffer-is-sticky nil)
2079 (defconst org-agenda-local-vars
2080 '(org-agenda-this-buffer-name
2081 org-agenda-undo-list
2082 org-agenda-pending-undo-list
2083 org-agenda-follow-mode
2084 org-agenda-entry-text-mode
2085 org-agenda-clockreport-mode
2086 org-agenda-show-log
2087 org-agenda-redo-command
2088 org-agenda-query-string
2089 org-agenda-type
2090 org-agenda-bulk-marked-entries
2091 org-agenda-undo-has-started-in
2092 org-agenda-info
2093 org-agenda-pre-window-conf
2094 org-agenda-columns-active
2095 org-agenda-tag-filter-overlays
2096 org-agenda-tag-filter
2097 org-agenda-cat-filter-overlays
2098 org-agenda-category-filter
2099 org-agenda-re-filter-overlays
2100 org-agenda-regexp-filter
2101 org-agenda-markers
2102 org-agenda-last-search-view-search-was-boolean
2103 org-agenda-filtered-by-category
2104 org-agenda-filter-form
2105 org-agenda-cycle-counter
2106 org-agenda-last-prefix-arg)
2107 "Variables that must be local in agenda buffers to allow multiple buffers.")
2109 (defun org-agenda-mode ()
2110 "Mode for time-sorted view on action items in Org-mode files.
2112 The following commands are available:
2114 \\{org-agenda-mode-map}"
2115 (interactive)
2116 (cond (org-agenda-doing-sticky-redo
2117 ;; Refreshing sticky agenda-buffer
2119 ;; Preserve the value of `org-agenda-local-vars' variables,
2120 ;; while letting `kill-all-local-variables' kill the rest
2121 (let ((save (buffer-local-variables)))
2122 (kill-all-local-variables)
2123 (mapc 'make-local-variable org-agenda-local-vars)
2124 (dolist (elem save)
2125 (let ((var (car elem))
2126 (val (cdr elem)))
2127 (when (and val
2128 (member var org-agenda-local-vars))
2129 (set var val)))))
2130 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2131 (org-agenda-sticky
2132 ;; Creating a sticky Agenda buffer for the first time
2133 (kill-all-local-variables)
2134 (mapc 'make-local-variable org-agenda-local-vars)
2135 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
2137 ;; Creating a non-sticky agenda buffer
2138 (kill-all-local-variables)
2139 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
2140 (setq org-agenda-undo-list nil
2141 org-agenda-pending-undo-list nil
2142 org-agenda-bulk-marked-entries nil)
2143 (setq major-mode 'org-agenda-mode)
2144 ;; Keep global-font-lock-mode from turning on font-lock-mode
2145 (org-set-local 'font-lock-global-modes (list 'not major-mode))
2146 (setq mode-name "Org-Agenda")
2147 (setq indent-tabs-mode nil)
2148 (use-local-map org-agenda-mode-map)
2149 (easy-menu-add org-agenda-menu)
2150 (if org-startup-truncated (setq truncate-lines t))
2151 (org-set-local 'line-move-visual nil)
2152 (org-add-hook 'post-command-hook 'org-agenda-update-agenda-type nil 'local)
2153 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
2154 ;; Make sure properties are removed when copying text
2155 (org-add-hook 'filter-buffer-substring-functions
2156 (lambda (fun start end delete)
2157 (substring-no-properties (funcall fun start end delete)))
2158 nil t)
2159 (unless org-agenda-keep-modes
2160 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
2161 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
2162 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
2163 org-agenda-show-log org-agenda-start-with-log-mode))
2165 (easy-menu-change
2166 '("Agenda") "Agenda Files"
2167 (append
2168 (list
2169 (vector
2170 (if (get 'org-agenda-files 'org-restrict)
2171 "Restricted to single file"
2172 "Edit File List")
2173 '(org-edit-agenda-file-list)
2174 (not (get 'org-agenda-files 'org-restrict)))
2175 "--")
2176 (mapcar 'org-file-menu-entry (org-agenda-files))))
2177 (org-agenda-set-mode-name)
2178 (apply
2179 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
2180 (list 'org-agenda-mode-hook)))
2182 (substitute-key-definition 'undo 'org-agenda-undo
2183 org-agenda-mode-map global-map)
2184 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
2185 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
2186 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
2187 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
2188 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
2189 (org-defkey org-agenda-mode-map [(meta down)] 'org-agenda-drag-line-forward)
2190 (org-defkey org-agenda-mode-map [(meta up)] 'org-agenda-drag-line-backward)
2191 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
2192 (org-defkey org-agenda-mode-map "\M-m" 'org-agenda-bulk-toggle)
2193 (org-defkey org-agenda-mode-map "*" 'org-agenda-bulk-mark-all)
2194 (org-defkey org-agenda-mode-map "\M-*" 'org-agenda-bulk-toggle-all)
2195 (org-defkey org-agenda-mode-map "#" 'org-agenda-dim-blocked-tasks)
2196 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
2197 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
2198 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-unmark-all)
2199 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
2200 (org-defkey org-agenda-mode-map "k" 'org-agenda-capture)
2201 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
2202 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
2203 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
2204 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
2205 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
2206 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
2207 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
2208 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
2209 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
2210 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
2211 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
2212 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
2213 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
2214 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
2215 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
2216 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
2217 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
2218 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2219 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
2220 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
2221 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
2222 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
2223 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
2224 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
2225 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
2226 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
2227 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
2228 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
2229 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
2230 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
2231 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
2232 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
2233 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
2235 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
2236 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
2237 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
2238 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2239 (while l (org-defkey org-agenda-mode-map
2240 (int-to-string (pop l)) 'digit-argument)))
2242 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
2243 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2244 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2245 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2246 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2247 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2248 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2249 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2250 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2251 (org-defkey org-agenda-mode-map "g" (lambda () (interactive) (org-agenda-redo t)))
2252 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2253 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2254 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2255 'org-clock-modify-effort-estimate)
2256 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2257 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2258 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2259 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2260 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2261 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2262 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2263 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2264 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2265 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2266 (org-defkey org-agenda-mode-map "N" 'org-agenda-next-item)
2267 (org-defkey org-agenda-mode-map "P" 'org-agenda-previous-item)
2268 (substitute-key-definition 'next-line 'org-agenda-next-line
2269 org-agenda-mode-map global-map)
2270 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2271 org-agenda-mode-map global-map)
2272 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2273 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2274 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2275 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2276 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2277 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2278 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2279 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2280 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2281 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2282 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2283 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2284 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2285 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2286 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2287 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2288 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2289 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2290 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2291 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2292 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2293 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2294 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2295 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2296 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2297 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2298 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2299 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2300 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2301 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2303 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2304 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2305 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2306 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2307 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2308 (org-defkey org-agenda-mode-map "=" 'org-agenda-filter-by-regexp)
2309 (org-defkey org-agenda-mode-map "|" 'org-agenda-filter-remove-all)
2310 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2311 (org-defkey org-agenda-mode-map "~" 'org-agenda-limit-interactively)
2312 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2313 (org-defkey org-agenda-mode-map "^" 'org-agenda-filter-by-top-headline)
2314 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2315 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2316 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2317 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2319 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2320 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2321 (when org-agenda-mouse-1-follows-link
2322 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2323 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2324 '("Agenda"
2325 ("Agenda Files")
2326 "--"
2327 ("Agenda Dates"
2328 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2329 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2330 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2331 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2332 "--"
2333 ("View"
2334 ["Day View" org-agenda-day-view
2335 :active (org-agenda-check-type nil 'agenda)
2336 :style radio :selected (eq org-agenda-current-span 'day)
2337 :keys "v d (or just d)"]
2338 ["Week View" org-agenda-week-view
2339 :active (org-agenda-check-type nil 'agenda)
2340 :style radio :selected (eq org-agenda-current-span 'week)
2341 :keys "v w"]
2342 ["Fortnight View" org-agenda-fortnight-view
2343 :active (org-agenda-check-type nil 'agenda)
2344 :style radio :selected (eq org-agenda-current-span 'fortnight)
2345 :keys "v f"]
2346 ["Month View" org-agenda-month-view
2347 :active (org-agenda-check-type nil 'agenda)
2348 :style radio :selected (eq org-agenda-current-span 'month)
2349 :keys "v m"]
2350 ["Year View" org-agenda-year-view
2351 :active (org-agenda-check-type nil 'agenda)
2352 :style radio :selected (eq org-agenda-current-span 'year)
2353 :keys "v y"]
2354 "--"
2355 ["Include Diary" org-agenda-toggle-diary
2356 :style toggle :selected org-agenda-include-diary
2357 :active (org-agenda-check-type nil 'agenda)]
2358 ["Include Deadlines" org-agenda-toggle-deadlines
2359 :style toggle :selected org-agenda-include-deadlines
2360 :active (org-agenda-check-type nil 'agenda)]
2361 ["Use Time Grid" org-agenda-toggle-time-grid
2362 :style toggle :selected org-agenda-use-time-grid
2363 :active (org-agenda-check-type nil 'agenda)]
2364 "--"
2365 ["Show clock report" org-agenda-clockreport-mode
2366 :style toggle :selected org-agenda-clockreport-mode
2367 :active (org-agenda-check-type nil 'agenda)]
2368 ["Show some entry text" org-agenda-entry-text-mode
2369 :style toggle :selected org-agenda-entry-text-mode
2370 :active t]
2371 "--"
2372 ["Show Logbook entries" org-agenda-log-mode
2373 :style toggle :selected org-agenda-show-log
2374 :active (org-agenda-check-type nil 'agenda 'timeline)
2375 :keys "v l (or just l)"]
2376 ["Include archived trees" org-agenda-archives-mode
2377 :style toggle :selected org-agenda-archives-mode :active t
2378 :keys "v a"]
2379 ["Include archive files" (org-agenda-archives-mode t)
2380 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2381 :keys "v A"]
2382 "--"
2383 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2384 ["Write view to file" org-agenda-write t]
2385 ["Rebuild buffer" org-agenda-redo t]
2386 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2387 "--"
2388 ["Show original entry" org-agenda-show t]
2389 ["Go To (other window)" org-agenda-goto t]
2390 ["Go To (this window)" org-agenda-switch-to t]
2391 ["Capture with cursor date" org-agenda-capture t]
2392 ["Follow Mode" org-agenda-follow-mode
2393 :style toggle :selected org-agenda-follow-mode :active t]
2394 ;; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2395 "--"
2396 ("TODO"
2397 ["Cycle TODO" org-agenda-todo t]
2398 ["Next TODO set" org-agenda-todo-nextset t]
2399 ["Previous TODO set" org-agenda-todo-previousset t]
2400 ["Add note" org-agenda-add-note t])
2401 ("Archive/Refile/Delete"
2402 ["Archive default" org-agenda-archive-default t]
2403 ["Archive default" org-agenda-archive-default-with-confirmation t]
2404 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2405 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2406 ["Archive subtree" org-agenda-archive t]
2407 "--"
2408 ["Refile" org-agenda-refile t]
2409 "--"
2410 ["Delete subtree" org-agenda-kill t])
2411 ("Bulk action"
2412 ["Mark entry" org-agenda-bulk-mark t]
2413 ["Mark all" org-agenda-bulk-mark-all t]
2414 ["Unmark entry" org-agenda-bulk-unmark t]
2415 ["Unmark all" org-agenda-bulk-unmark-all :active t :keys "U"]
2416 ["Toggle mark" org-agenda-bulk-toggle t]
2417 ["Toggle all" org-agenda-bulk-toggle-all t]
2418 ["Mark regexp" org-agenda-bulk-mark-regexp t])
2419 ["Act on all marked" org-agenda-bulk-action t]
2420 "--"
2421 ("Tags and Properties"
2422 ["Show all Tags" org-agenda-show-tags t]
2423 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2424 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2425 "--"
2426 ["Column View" org-columns t])
2427 ("Deadline/Schedule"
2428 ["Schedule" org-agenda-schedule t]
2429 ["Set Deadline" org-agenda-deadline t]
2430 "--"
2431 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2432 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2433 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2434 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2435 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2436 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2437 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2438 ("Clock and Effort"
2439 ["Clock in" org-agenda-clock-in t]
2440 ["Clock out" org-agenda-clock-out t]
2441 ["Clock cancel" org-agenda-clock-cancel t]
2442 ["Goto running clock" org-clock-goto t]
2443 "--"
2444 ["Set Effort" org-agenda-set-effort t]
2445 ["Change clocked effort" org-clock-modify-effort-estimate
2446 (org-clock-is-active)])
2447 ("Priority"
2448 ["Set Priority" org-agenda-priority t]
2449 ["Increase Priority" org-agenda-priority-up t]
2450 ["Decrease Priority" org-agenda-priority-down t]
2451 ["Show Priority" org-show-priority t])
2452 ("Calendar/Diary"
2453 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2454 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2455 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2456 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2457 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2458 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2459 "--"
2460 ["Create iCalendar File" org-icalendar-combine-agenda-files t])
2461 "--"
2462 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2463 "--"
2464 ("MobileOrg"
2465 ["Push Files and Views" org-mobile-push t]
2466 ["Get Captured and Flagged" org-mobile-pull t]
2467 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2468 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2469 "--"
2470 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2471 "--"
2472 ["Quit" org-agenda-quit t]
2473 ["Exit and Release Buffers" org-agenda-exit t]
2476 ;;; Agenda undo
2478 (defvar org-agenda-allow-remote-undo t
2479 "Non-nil means allow remote undo from the agenda buffer.")
2480 (defvar org-agenda-undo-has-started-in nil
2481 "Buffers that have already seen `undo-start' in the current undo sequence.")
2483 (defun org-agenda-undo ()
2484 "Undo a remote editing step in the agenda.
2485 This undoes changes both in the agenda buffer and in the remote buffer
2486 that have been changed along."
2487 (interactive)
2488 (or org-agenda-allow-remote-undo
2489 (user-error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2490 (if (not (eq this-command last-command))
2491 (setq org-agenda-undo-has-started-in nil
2492 org-agenda-pending-undo-list org-agenda-undo-list))
2493 (if (not org-agenda-pending-undo-list)
2494 (user-error "No further undo information"))
2495 (let* ((entry (pop org-agenda-pending-undo-list))
2496 buf line cmd rembuf)
2497 (setq cmd (pop entry) line (pop entry))
2498 (setq rembuf (nth 2 entry))
2499 (org-with-remote-undo rembuf
2500 (while (bufferp (setq buf (pop entry)))
2501 (if (pop entry)
2502 (with-current-buffer buf
2503 (let ((last-undo-buffer buf)
2504 (inhibit-read-only t))
2505 (unless (memq buf org-agenda-undo-has-started-in)
2506 (push buf org-agenda-undo-has-started-in)
2507 (make-local-variable 'pending-undo-list)
2508 (undo-start))
2509 (while (and pending-undo-list
2510 (listp pending-undo-list)
2511 (not (car pending-undo-list)))
2512 (pop pending-undo-list))
2513 (undo-more 1))))))
2514 (org-goto-line line)
2515 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2517 (defun org-verify-change-for-undo (l1 l2)
2518 "Verify that a real change occurred between the undo lists L1 and L2."
2519 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2520 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2521 (not (eq l1 l2)))
2523 ;;; Agenda dispatch
2525 (defvar org-agenda-restrict-begin (make-marker))
2526 (defvar org-agenda-restrict-end (make-marker))
2527 (defvar org-agenda-last-dispatch-buffer nil)
2528 (defvar org-agenda-overriding-restriction nil)
2530 (defcustom org-agenda-custom-commands-contexts nil
2531 "Alist of custom agenda keys and contextual rules.
2533 For example, if you have a custom agenda command \"p\" and you
2534 want this command to be accessible only from plain text files,
2535 use this:
2537 '((\"p\" ((in-file . \"\\.txt\"))))
2539 Here are the available contexts definitions:
2541 in-file: command displayed only in matching files
2542 in-mode: command displayed only in matching modes
2543 not-in-file: command not displayed in matching files
2544 not-in-mode: command not displayed in matching modes
2545 in-buffer: command displayed only in matching buffers
2546 not-in-buffer: command not displayed in matching buffers
2547 [function]: a custom function taking no argument
2549 If you define several checks, the agenda command will be
2550 accessible if there is at least one valid check.
2552 You can also bind a key to another agenda custom command
2553 depending on contextual rules.
2555 '((\"p\" \"q\" ((in-file . \"\\.txt\"))))
2557 Here it means: in .txt files, use \"p\" as the key for the
2558 agenda command otherwise associated with \"q\". (The command
2559 originally associated with \"q\" is not displayed to avoid
2560 duplicates.)"
2561 :version "24.3"
2562 :group 'org-agenda-custom-commands
2563 :type '(repeat (list :tag "Rule"
2564 (string :tag " Agenda key")
2565 (string :tag "Replace by command")
2566 (repeat :tag "Available when"
2567 (choice
2568 (cons :tag "Condition"
2569 (choice
2570 (const :tag "In file" in-file)
2571 (const :tag "Not in file" not-in-file)
2572 (const :tag "In buffer" in-buffer)
2573 (const :tag "Not in buffer" not-in-buffer)
2574 (const :tag "In mode" in-mode)
2575 (const :tag "Not in mode" not-in-mode))
2576 (regexp))
2577 (function :tag "Custom function"))))))
2579 (defcustom org-agenda-max-entries nil
2580 "Maximum number of entries to display in an agenda.
2581 This can be nil (no limit) or an integer or an alist of agenda
2582 types with an associated number of entries to display in this
2583 type."
2584 :version "24.4"
2585 :package-version '(Org . "8.0")
2586 :group 'org-agenda-custom-commands
2587 :type '(choice (symbol :tag "No limit" nil)
2588 (integer :tag "Max number of entries")
2589 (repeat
2590 (cons (choice :tag "Agenda type"
2591 (const agenda)
2592 (const todo)
2593 (const tags)
2594 (const search)
2595 (const timeline))
2596 (integer :tag "Max number of entries")))))
2598 (defcustom org-agenda-max-todos nil
2599 "Maximum number of TODOs to display in an agenda.
2600 This can be nil (no limit) or an integer or an alist of agenda
2601 types with an associated number of entries to display in this
2602 type."
2603 :version "24.4"
2604 :package-version '(Org . "8.0")
2605 :group 'org-agenda-custom-commands
2606 :type '(choice (symbol :tag "No limit" nil)
2607 (integer :tag "Max number of TODOs")
2608 (repeat
2609 (cons (choice :tag "Agenda type"
2610 (const agenda)
2611 (const todo)
2612 (const tags)
2613 (const search)
2614 (const timeline))
2615 (integer :tag "Max number of TODOs")))))
2617 (defcustom org-agenda-max-tags nil
2618 "Maximum number of tagged entries to display in an agenda.
2619 This can be nil (no limit) or an integer or an alist of agenda
2620 types with an associated number of entries to display in this
2621 type."
2622 :version "24.4"
2623 :package-version '(Org . "8.0")
2624 :group 'org-agenda-custom-commands
2625 :type '(choice (symbol :tag "No limit" nil)
2626 (integer :tag "Max number of tagged entries")
2627 (repeat
2628 (cons (choice :tag "Agenda type"
2629 (const agenda)
2630 (const todo)
2631 (const tags)
2632 (const search)
2633 (const timeline))
2634 (integer :tag "Max number of tagged entries")))))
2636 (defcustom org-agenda-max-effort nil
2637 "Maximum cumulated effort duration for the agenda.
2638 This can be nil (no limit) or a number of minutes (as an integer)
2639 or an alist of agenda types with an associated number of minutes
2640 to limit entries to in this type."
2641 :version "24.4"
2642 :package-version '(Org . "8.0")
2643 :group 'org-agenda-custom-commands
2644 :type '(choice (symbol :tag "No limit" nil)
2645 (integer :tag "Max number of minutes")
2646 (repeat
2647 (cons (choice :tag "Agenda type"
2648 (const agenda)
2649 (const todo)
2650 (const tags)
2651 (const search)
2652 (const timeline))
2653 (integer :tag "Max number of minutes")))))
2655 (defvar org-keys nil)
2656 (defvar org-match nil)
2657 ;;;###autoload
2658 (defun org-agenda (&optional arg org-keys restriction)
2659 "Dispatch agenda commands to collect entries to the agenda buffer.
2660 Prompts for a command to execute. Any prefix arg will be passed
2661 on to the selected command. The default selections are:
2663 a Call `org-agenda-list' to display the agenda for current day or week.
2664 t Call `org-todo-list' to display the global todo list.
2665 T Call `org-todo-list' to display the global todo list, select only
2666 entries with a specific TODO keyword (the user gets a prompt).
2667 m Call `org-tags-view' to display headlines with tags matching
2668 a condition (the user is prompted for the condition).
2669 M Like `m', but select only TODO entries, no ordinary headlines.
2670 L Create a timeline for the current buffer.
2671 e Export views to associated files.
2672 s Search entries for keywords.
2673 S Search entries for keywords, only with TODO keywords.
2674 / Multi occur across all agenda files and also files listed
2675 in `org-agenda-text-search-extra-files'.
2676 < Restrict agenda commands to buffer, subtree, or region.
2677 Press several times to get the desired effect.
2678 > Remove a previous restriction.
2679 # List \"stuck\" projects.
2680 ! Configure what \"stuck\" means.
2681 C Configure custom agenda commands.
2683 More commands can be added by configuring the variable
2684 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2685 searches can be pre-defined in this way.
2687 If the current buffer is in Org-mode and visiting a file, you can also
2688 first press `<' once to indicate that the agenda should be temporarily
2689 \(until the next use of \\[org-agenda]) restricted to the current file.
2690 Pressing `<' twice means to restrict to the current subtree or region
2691 \(if active)."
2692 (interactive "P")
2693 (catch 'exit
2694 (let* ((prefix-descriptions nil)
2695 (org-agenda-buffer-name org-agenda-buffer-name)
2696 (org-agenda-window-setup (if (equal (buffer-name)
2697 org-agenda-buffer-name)
2698 'current-window
2699 org-agenda-window-setup))
2700 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2701 (org-agenda-custom-commands
2702 ;; normalize different versions
2703 (delq nil
2704 (mapcar
2705 (lambda (x)
2706 (cond ((stringp (cdr x))
2707 (push x prefix-descriptions)
2708 nil)
2709 ((stringp (nth 1 x)) x)
2710 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2711 (t (cons (car x) (cons "" (cdr x))))))
2712 org-agenda-custom-commands)))
2713 (org-agenda-custom-commands
2714 (org-contextualize-keys
2715 org-agenda-custom-commands org-agenda-custom-commands-contexts))
2716 (buf (current-buffer))
2717 (bfn (buffer-file-name (buffer-base-buffer)))
2718 entry key type org-match lprops ans)
2719 ;; Turn off restriction unless there is an overriding one,
2720 (unless org-agenda-overriding-restriction
2721 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2722 ;; There is a request to keep the file list in place
2723 (put 'org-agenda-files 'org-restrict nil))
2724 (setq org-agenda-restrict nil)
2725 (move-marker org-agenda-restrict-begin nil)
2726 (move-marker org-agenda-restrict-end nil))
2727 ;; Delete old local properties
2728 (put 'org-agenda-redo-command 'org-lprops nil)
2729 ;; Delete previously set last-arguments
2730 (put 'org-agenda-redo-command 'last-args nil)
2731 ;; Remember where this call originated
2732 (setq org-agenda-last-dispatch-buffer (current-buffer))
2733 (unless org-keys
2734 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2735 org-keys (car ans)
2736 restriction (cdr ans)))
2737 ;; If we have sticky agenda buffers, set a name for the buffer,
2738 ;; depending on the invoking keys. The user may still set this
2739 ;; as a command option, which will overwrite what we do here.
2740 (if org-agenda-sticky
2741 (setq org-agenda-buffer-name
2742 (format "*Org Agenda(%s)*" org-keys)))
2743 ;; Establish the restriction, if any
2744 (when (and (not org-agenda-overriding-restriction) restriction)
2745 (put 'org-agenda-files 'org-restrict (list bfn))
2746 (cond
2747 ((eq restriction 'region)
2748 (setq org-agenda-restrict (current-buffer))
2749 (move-marker org-agenda-restrict-begin (region-beginning))
2750 (move-marker org-agenda-restrict-end (region-end)))
2751 ((eq restriction 'subtree)
2752 (save-excursion
2753 (setq org-agenda-restrict (current-buffer))
2754 (org-back-to-heading t)
2755 (move-marker org-agenda-restrict-begin (point))
2756 (move-marker org-agenda-restrict-end
2757 (progn (org-end-of-subtree t)))))))
2759 ;; For example the todo list should not need it (but does...)
2760 (cond
2761 ((setq entry (assoc org-keys org-agenda-custom-commands))
2762 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2763 (progn
2764 (setq type (nth 2 entry) org-match (eval (nth 3 entry))
2765 lprops (nth 4 entry))
2766 (if org-agenda-sticky
2767 (setq org-agenda-buffer-name
2768 (or (and (stringp org-match) (format "*Org Agenda(%s:%s)*" org-keys org-match))
2769 (format "*Org Agenda(%s)*" org-keys))))
2770 (put 'org-agenda-redo-command 'org-lprops lprops)
2771 (cond
2772 ((eq type 'agenda)
2773 (org-let lprops '(org-agenda-list current-prefix-arg)))
2774 ((eq type 'agenda*)
2775 (org-let lprops '(org-agenda-list current-prefix-arg nil nil t)))
2776 ((eq type 'alltodo)
2777 (org-let lprops '(org-todo-list current-prefix-arg)))
2778 ((eq type 'search)
2779 (org-let lprops '(org-search-view current-prefix-arg org-match nil)))
2780 ((eq type 'stuck)
2781 (org-let lprops '(org-agenda-list-stuck-projects
2782 current-prefix-arg)))
2783 ((eq type 'tags)
2784 (org-let lprops '(org-tags-view current-prefix-arg org-match)))
2785 ((eq type 'tags-todo)
2786 (org-let lprops '(org-tags-view '(4) org-match)))
2787 ((eq type 'todo)
2788 (org-let lprops '(org-todo-list org-match)))
2789 ((eq type 'tags-tree)
2790 (org-check-for-org-mode)
2791 (org-let lprops '(org-match-sparse-tree current-prefix-arg org-match)))
2792 ((eq type 'todo-tree)
2793 (org-check-for-org-mode)
2794 (org-let lprops
2795 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2796 (regexp-quote org-match) "\\>"))))
2797 ((eq type 'occur-tree)
2798 (org-check-for-org-mode)
2799 (org-let lprops '(org-occur org-match)))
2800 ((functionp type)
2801 (org-let lprops '(funcall type org-match)))
2802 ((fboundp type)
2803 (org-let lprops '(funcall type org-match)))
2804 (t (user-error "Invalid custom agenda command type %s" type))))
2805 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2806 ((equal org-keys "C")
2807 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2808 (customize-variable 'org-agenda-custom-commands))
2809 ((equal org-keys "a") (call-interactively 'org-agenda-list))
2810 ((equal org-keys "s") (call-interactively 'org-search-view))
2811 ((equal org-keys "S") (org-call-with-arg 'org-search-view (or arg '(4))))
2812 ((equal org-keys "t") (call-interactively 'org-todo-list))
2813 ((equal org-keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2814 ((equal org-keys "m") (call-interactively 'org-tags-view))
2815 ((equal org-keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2816 ((equal org-keys "e") (call-interactively 'org-store-agenda-views))
2817 ((equal org-keys "?") (org-tags-view nil "+FLAGGED")
2818 (org-add-hook
2819 'post-command-hook
2820 (lambda ()
2821 (unless (current-message)
2822 (let* ((m (org-agenda-get-any-marker))
2823 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2824 (when note
2825 (message (concat
2826 "FLAGGING-NOTE ([?] for more info): "
2827 (org-add-props
2828 (replace-regexp-in-string
2829 "\\\\n" "//"
2830 (copy-sequence note))
2831 nil 'face 'org-warning)))))))
2832 t t))
2833 ((equal org-keys "L")
2834 (unless (derived-mode-p 'org-mode)
2835 (user-error "This is not an Org-mode file"))
2836 (unless restriction
2837 (put 'org-agenda-files 'org-restrict (list bfn))
2838 (org-call-with-arg 'org-timeline arg)))
2839 ((equal org-keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2840 ((equal org-keys "/") (call-interactively 'org-occur-in-agenda-files))
2841 ((equal org-keys "!") (customize-variable 'org-stuck-projects))
2842 (t (user-error "Invalid agenda key"))))))
2844 (defvar org-agenda-multi)
2846 (defun org-agenda-append-agenda ()
2847 "Append another agenda view to the current one.
2848 This function allows interactive building of block agendas.
2849 Agenda views are separated by `org-agenda-block-separator'."
2850 (interactive)
2851 (unless (derived-mode-p 'org-agenda-mode)
2852 (user-error "Can only append from within agenda buffer"))
2853 (let ((org-agenda-multi t))
2854 (org-agenda)
2855 (widen)
2856 (org-agenda-finalize)
2857 (setq buffer-read-only t)
2858 (org-agenda-fit-window-to-buffer)))
2860 (defun org-agenda-normalize-custom-commands (cmds)
2861 "Normalize custom commands CMDS."
2862 (delq nil
2863 (mapcar
2864 (lambda (x)
2865 (cond ((stringp (cdr x)) nil)
2866 ((stringp (nth 1 x)) x)
2867 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2868 (t (cons (car x) (cons "" (cdr x))))))
2869 cmds)))
2871 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2872 "The user interface for selecting an agenda command."
2873 (catch 'exit
2874 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2875 (restrict-ok (and bfn (derived-mode-p 'org-mode)))
2876 (region-p (org-region-active-p))
2877 (custom org-agenda-custom-commands)
2878 (selstring "")
2879 restriction second-time
2880 c entry key type match prefixes rmheader header-end custom1 desc
2881 line lines left right n n1)
2882 (save-window-excursion
2883 (delete-other-windows)
2884 (org-switch-to-buffer-other-window " *Agenda Commands*")
2885 (erase-buffer)
2886 (insert (eval-when-compile
2887 (let ((header
2888 "Press key for an agenda command: < Buffer, subtree/region restriction
2889 -------------------------------- > Remove restriction
2890 a Agenda for current week or day e Export agenda views
2891 t List of all TODO entries T Entries with special TODO kwd
2892 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2893 s Search for keywords S Like s, but only TODO entries
2894 L Timeline for current buffer # List stuck projects (!=configure)
2895 / Multi-occur C Configure custom agenda commands
2896 ? Find :FLAGGED: entries * Toggle sticky agenda views
2898 (start 0))
2899 (while (string-match
2900 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2901 header start)
2902 (setq start (match-end 0))
2903 (add-text-properties (match-beginning 2) (match-end 2)
2904 '(face bold) header))
2905 header)))
2906 (setq header-end (point-marker))
2907 (while t
2908 (setq custom1 custom)
2909 (when (eq rmheader t)
2910 (org-goto-line 1)
2911 (re-search-forward ":" nil t)
2912 (delete-region (match-end 0) (point-at-eol))
2913 (forward-char 1)
2914 (looking-at "-+")
2915 (delete-region (match-end 0) (point-at-eol))
2916 (move-marker header-end (match-end 0)))
2917 (goto-char header-end)
2918 (delete-region (point) (point-max))
2920 ;; Produce all the lines that describe custom commands and prefixes
2921 (setq lines nil)
2922 (while (setq entry (pop custom1))
2923 (setq key (car entry) desc (nth 1 entry)
2924 type (nth 2 entry)
2925 match (nth 3 entry))
2926 (if (> (length key) 1)
2927 (add-to-list 'prefixes (string-to-char key))
2928 (setq line
2929 (format
2930 "%-4s%-14s"
2931 (org-add-props (copy-sequence key)
2932 '(face bold))
2933 (cond
2934 ((string-match "\\S-" desc) desc)
2935 ((eq type 'agenda) "Agenda for current week or day")
2936 ((eq type 'agenda*) "Appointments for current week or day")
2937 ((eq type 'alltodo) "List of all TODO entries")
2938 ((eq type 'search) "Word search")
2939 ((eq type 'stuck) "List of stuck projects")
2940 ((eq type 'todo) "TODO keyword")
2941 ((eq type 'tags) "Tags query")
2942 ((eq type 'tags-todo) "Tags (TODO)")
2943 ((eq type 'tags-tree) "Tags tree")
2944 ((eq type 'todo-tree) "TODO kwd tree")
2945 ((eq type 'occur-tree) "Occur tree")
2946 ((functionp type) (if (symbolp type)
2947 (symbol-name type)
2948 "Lambda expression"))
2949 (t "???"))))
2950 (if org-agenda-menu-show-matcher
2951 (setq line
2952 (concat line ": "
2953 (cond
2954 ((stringp match)
2955 (setq match (copy-sequence match))
2956 (org-add-props match nil 'face 'org-warning))
2957 ((listp type)
2958 (format "set of %d commands" (length type))))))
2959 (if (org-string-nw-p match)
2960 (add-text-properties
2961 0 (length line) (list 'help-echo
2962 (concat "Matcher: " match)) line)))
2963 (push line lines)))
2964 (setq lines (nreverse lines))
2965 (when prefixes
2966 (mapc (lambda (x)
2967 (push
2968 (format "%s %s"
2969 (org-add-props (char-to-string x)
2970 nil 'face 'bold)
2971 (or (cdr (assoc (concat selstring
2972 (char-to-string x))
2973 prefix-descriptions))
2974 "Prefix key"))
2975 lines))
2976 prefixes))
2978 ;; Check if we should display in two columns
2979 (if org-agenda-menu-two-columns
2980 (progn
2981 (setq n (length lines)
2982 n1 (+ (/ n 2) (mod n 2))
2983 right (nthcdr n1 lines)
2984 left (copy-sequence lines))
2985 (setcdr (nthcdr (1- n1) left) nil))
2986 (setq left lines right nil))
2987 (while left
2988 (insert "\n" (pop left))
2989 (when right
2990 (if (< (current-column) 40)
2991 (move-to-column 40 t)
2992 (insert " "))
2993 (insert (pop right))))
2995 ;; Make the window the right size
2996 (goto-char (point-min))
2997 (if second-time
2998 (if (not (pos-visible-in-window-p (point-max)))
2999 (org-fit-window-to-buffer))
3000 (setq second-time t)
3001 (org-fit-window-to-buffer))
3003 ;; Ask for selection
3004 (message "Press key for agenda command%s:"
3005 (if (or restrict-ok org-agenda-overriding-restriction)
3006 (if org-agenda-overriding-restriction
3007 " (restriction lock active)"
3008 (if restriction
3009 (format " (restricted to %s)" restriction)
3010 " (unrestricted)"))
3011 ""))
3012 (setq c (read-char-exclusive))
3013 (message "")
3014 (cond
3015 ((assoc (char-to-string c) custom)
3016 (setq selstring (concat selstring (char-to-string c)))
3017 (throw 'exit (cons selstring restriction)))
3018 ((memq c prefixes)
3019 (setq selstring (concat selstring (char-to-string c))
3020 prefixes nil
3021 rmheader (or rmheader t)
3022 custom (delq nil (mapcar
3023 (lambda (x)
3024 (if (or (= (length (car x)) 1)
3025 (/= (string-to-char (car x)) c))
3027 (cons (substring (car x) 1) (cdr x))))
3028 custom))))
3029 ((eq c ?*)
3030 (call-interactively 'org-toggle-sticky-agenda)
3031 (sit-for 2))
3032 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
3033 (message "Restriction is only possible in Org-mode buffers")
3034 (ding) (sit-for 1))
3035 ((eq c ?1)
3036 (org-agenda-remove-restriction-lock 'noupdate)
3037 (setq restriction 'buffer))
3038 ((eq c ?0)
3039 (org-agenda-remove-restriction-lock 'noupdate)
3040 (setq restriction (if region-p 'region 'subtree)))
3041 ((eq c ?<)
3042 (org-agenda-remove-restriction-lock 'noupdate)
3043 (setq restriction
3044 (cond
3045 ((eq restriction 'buffer)
3046 (if region-p 'region 'subtree))
3047 ((memq restriction '(subtree region))
3048 nil)
3049 (t 'buffer))))
3050 ((eq c ?>)
3051 (org-agenda-remove-restriction-lock 'noupdate)
3052 (setq restriction nil))
3053 ((and (equal selstring "") (memq c '(?s ?S ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
3054 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
3055 ((and (> (length selstring) 0) (eq c ?\d))
3056 (delete-window)
3057 (org-agenda-get-restriction-and-command prefix-descriptions))
3059 ((equal c ?q) (error "Abort"))
3060 (t (user-error "Invalid key %c" c))))))))
3062 (defun org-agenda-fit-window-to-buffer ()
3063 "Fit the window to the buffer size."
3064 (and (memq org-agenda-window-setup '(reorganize-frame))
3065 (fboundp 'fit-window-to-buffer)
3066 (org-fit-window-to-buffer
3068 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3069 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3071 (defvar org-cmd nil)
3072 (defvar org-agenda-overriding-cmd nil)
3073 (defvar org-agenda-overriding-arguments nil)
3074 (defvar org-agenda-overriding-cmd-arguments nil)
3075 (defun org-agenda-run-series (name series)
3076 "Run agenda NAME as a SERIES of agenda commands."
3077 (org-let (nth 1 series) '(org-agenda-prepare name))
3078 ;; We need to reset agenda markers here, because when constructing a
3079 ;; block agenda, the individual blocks do not do that.
3080 (org-agenda-reset-markers)
3081 (let* ((org-agenda-multi t)
3082 (redo (list 'org-agenda-run-series name (list 'quote series)))
3083 (cmds (car series))
3084 (gprops (nth 1 series))
3085 match ;; The byte compiler incorrectly complains about this. Keep it!
3086 org-cmd type lprops)
3087 (while (setq org-cmd (pop cmds))
3088 (setq type (car org-cmd)
3089 match (eval (nth 1 org-cmd))
3090 lprops (nth 2 org-cmd))
3091 (let ((org-agenda-overriding-arguments
3092 (if (eq org-agenda-overriding-cmd org-cmd)
3093 (or org-agenda-overriding-arguments
3094 org-agenda-overriding-cmd-arguments))))
3095 (cond
3096 ((eq type 'agenda)
3097 (org-let2 gprops lprops
3098 '(call-interactively 'org-agenda-list)))
3099 ((eq type 'agenda*)
3100 (org-let2 gprops lprops
3101 '(funcall 'org-agenda-list nil nil t)))
3102 ((eq type 'alltodo)
3103 (org-let2 gprops lprops
3104 '(call-interactively 'org-todo-list)))
3105 ((eq type 'search)
3106 (org-let2 gprops lprops
3107 '(org-search-view current-prefix-arg match nil)))
3108 ((eq type 'stuck)
3109 (org-let2 gprops lprops
3110 '(call-interactively 'org-agenda-list-stuck-projects)))
3111 ((eq type 'tags)
3112 (org-let2 gprops lprops
3113 '(org-tags-view current-prefix-arg match)))
3114 ((eq type 'tags-todo)
3115 (org-let2 gprops lprops
3116 '(org-tags-view '(4) match)))
3117 ((eq type 'todo)
3118 (org-let2 gprops lprops
3119 '(org-todo-list match)))
3120 ((fboundp type)
3121 (org-let2 gprops lprops
3122 '(funcall type match)))
3123 (t (error "Invalid type in command series")))))
3124 (widen)
3125 (let ((inhibit-read-only t))
3126 (add-text-properties (point-min) (point-max)
3127 `(org-series t org-series-redo-cmd ,redo)))
3128 (setq org-agenda-redo-command redo)
3129 (goto-char (point-min)))
3130 (org-agenda-fit-window-to-buffer)
3131 (org-let (nth 1 series) '(org-agenda-finalize)))
3133 ;;;###autoload
3134 (defmacro org-batch-agenda (cmd-key &rest parameters)
3135 "Run an agenda command in batch mode and send the result to STDOUT.
3136 If CMD-KEY is a string of length 1, it is used as a key in
3137 `org-agenda-custom-commands' and triggers this command. If it is a
3138 longer string it is used as a tags/todo match string.
3139 Parameters are alternating variable names and values that will be bound
3140 before running the agenda command."
3141 (org-eval-in-environment (org-make-parameter-alist parameters)
3142 (let (org-agenda-sticky)
3143 (if (> (length cmd-key) 2)
3144 (org-tags-view nil cmd-key)
3145 (org-agenda nil cmd-key))))
3146 (set-buffer org-agenda-buffer-name)
3147 (princ (buffer-string)))
3149 (defvar org-agenda-info nil)
3151 ;;;###autoload
3152 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
3153 "Run an agenda command in batch mode and send the result to STDOUT.
3154 If CMD-KEY is a string of length 1, it is used as a key in
3155 `org-agenda-custom-commands' and triggers this command. If it is a
3156 longer string it is used as a tags/todo match string.
3157 Parameters are alternating variable names and values that will be bound
3158 before running the agenda command.
3160 The output gives a line for each selected agenda item. Each
3161 item is a list of comma-separated values, like this:
3163 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
3165 category The category of the item
3166 head The headline, without TODO kwd, TAGS and PRIORITY
3167 type The type of the agenda entry, can be
3168 todo selected in TODO match
3169 tagsmatch selected in tags match
3170 diary imported from diary
3171 deadline a deadline on given date
3172 scheduled scheduled on given date
3173 timestamp entry has timestamp on given date
3174 closed entry was closed on given date
3175 upcoming-deadline warning about deadline
3176 past-scheduled forwarded scheduled item
3177 block entry has date block including g. date
3178 todo The todo keyword, if any
3179 tags All tags including inherited ones, separated by colons
3180 date The relevant date, like 2007-2-14
3181 time The time, like 15:00-16:50
3182 extra Sting with extra planning info
3183 priority-l The priority letter if any was given
3184 priority-n The computed numerical priority
3185 agenda-day The day in the agenda where this is listed"
3186 (org-eval-in-environment (append '((org-agenda-remove-tags t))
3187 (org-make-parameter-alist parameters))
3188 (if (> (length cmd-key) 2)
3189 (org-tags-view nil cmd-key)
3190 (org-agenda nil cmd-key)))
3191 (set-buffer org-agenda-buffer-name)
3192 (let* ((lines (org-split-string (buffer-string) "\n"))
3193 line)
3194 (while (setq line (pop lines))
3195 (catch 'next
3196 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
3197 (setq org-agenda-info
3198 (org-fix-agenda-info (text-properties-at 0 line)))
3199 (princ
3200 (mapconcat 'org-agenda-export-csv-mapper
3201 '(org-category txt type todo tags date time extra
3202 priority-letter priority agenda-day)
3203 ","))
3204 (princ "\n")))))
3206 (defun org-fix-agenda-info (props)
3207 "Make sure all properties on an agenda item have a canonical form.
3208 This ensures the export commands can easily use it."
3209 (let (tmp re)
3210 (when (setq tmp (plist-get props 'tags))
3211 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
3212 (when (setq tmp (plist-get props 'date))
3213 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3214 (let ((calendar-date-display-form '(year "-" month "-" day)))
3215 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
3217 (setq tmp (calendar-date-string tmp)))
3218 (setq props (plist-put props 'date tmp)))
3219 (when (setq tmp (plist-get props 'day))
3220 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
3221 (let ((calendar-date-display-form '(year "-" month "-" day)))
3222 (setq tmp (calendar-date-string tmp)))
3223 (setq props (plist-put props 'day tmp))
3224 (setq props (plist-put props 'agenda-day tmp)))
3225 (when (setq tmp (plist-get props 'txt))
3226 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
3227 (plist-put props 'priority-letter (match-string 1 tmp))
3228 (setq tmp (replace-match "" t t tmp)))
3229 (when (and (setq re (plist-get props 'org-todo-regexp))
3230 (setq re (concat "\\`\\.*" re " ?"))
3231 (string-match re tmp))
3232 (plist-put props 'todo (match-string 1 tmp))
3233 (setq tmp (replace-match "" t t tmp)))
3234 (plist-put props 'txt tmp)))
3235 props)
3237 (defun org-agenda-export-csv-mapper (prop)
3238 (let ((res (plist-get org-agenda-info prop)))
3239 (setq res
3240 (cond
3241 ((not res) "")
3242 ((stringp res) res)
3243 (t (prin1-to-string res))))
3244 (while (string-match "," res)
3245 (setq res (replace-match ";" t t res)))
3246 (org-trim res)))
3248 ;;;###autoload
3249 (defun org-store-agenda-views (&rest parameters)
3250 "Store agenda views."
3251 (interactive)
3252 (eval (list 'org-batch-store-agenda-views)))
3254 ;;;###autoload
3255 (defmacro org-batch-store-agenda-views (&rest parameters)
3256 "Run all custom agenda commands that have a file argument."
3257 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
3258 (pop-up-frames nil)
3259 (dir default-directory)
3260 (pars (org-make-parameter-alist parameters))
3261 cmd thiscmdkey thiscmdcmd match files opts cmd-or-set bufname)
3262 (save-window-excursion
3263 (while cmds
3264 (setq cmd (pop cmds)
3265 thiscmdkey (car cmd)
3266 thiscmdcmd (cdr cmd)
3267 match (nth 2 thiscmdcmd)
3268 bufname (if org-agenda-sticky
3269 (or (and (stringp match)
3270 (format "*Org Agenda(%s:%s)*" thiscmdkey match))
3271 (format "*Org Agenda(%s)*" thiscmdkey))
3272 org-agenda-buffer-name)
3273 cmd-or-set (nth 2 cmd)
3274 opts (nth (if (listp cmd-or-set) 3 4) cmd)
3275 files (nth (if (listp cmd-or-set) 4 5) cmd))
3276 (if (stringp files) (setq files (list files)))
3277 (when files
3278 (org-eval-in-environment (append org-agenda-exporter-settings
3279 opts pars)
3280 (org-agenda nil thiscmdkey))
3281 (set-buffer bufname)
3282 (while files
3283 (org-eval-in-environment (append org-agenda-exporter-settings
3284 opts pars)
3285 (org-agenda-write (expand-file-name (pop files) dir) nil t bufname)))
3286 (and (get-buffer bufname)
3287 (kill-buffer bufname)))))))
3289 (defvar org-agenda-current-span nil
3290 "The current span used in the agenda view.") ; local variable in the agenda buffer
3291 (defun org-agenda-mark-header-line (pos)
3292 "Mark the line at POS as an agenda structure header."
3293 (save-excursion
3294 (goto-char pos)
3295 (put-text-property (point-at-bol) (point-at-eol)
3296 'org-agenda-structural-header t)
3297 (when org-agenda-title-append
3298 (put-text-property (point-at-bol) (point-at-eol)
3299 'org-agenda-title-append org-agenda-title-append))))
3301 (defvar org-mobile-creating-agendas) ; defined in org-mobile.el
3302 (defvar org-agenda-write-buffer-name "Agenda View")
3303 (defun org-agenda-write (file &optional open nosettings agenda-bufname)
3304 "Write the current buffer (an agenda view) as a file.
3305 Depending on the extension of the file name, plain text (.txt),
3306 HTML (.html or .htm), PDF (.pdf) or Postscript (.ps) is produced.
3307 If the extension is .ics, run icalendar export over all files used
3308 to construct the agenda and limit the export to entries listed in the
3309 agenda now.
3310 If the extension is .org, collect all subtrees corresponding to the
3311 agenda entries and add them in an .org file.
3312 With prefix argument OPEN, open the new file immediately.
3313 If NOSETTINGS is given, do not scope the settings of
3314 `org-agenda-exporter-settings' into the export commands. This is used when
3315 the settings have already been scoped and we do not wish to overrule other,
3316 higher priority settings.
3317 If AGENDA-BUFFER-NAME, use this as the buffer name for the agenda to write."
3318 (interactive "FWrite agenda to file: \nP")
3319 (if (or (not (file-writable-p file))
3320 (and (file-exists-p file)
3321 (if (org-called-interactively-p 'any)
3322 (not (y-or-n-p (format "Overwrite existing file %s? " file))))))
3323 (user-error "Cannot write agenda to file %s" file))
3324 (org-let (if nosettings nil org-agenda-exporter-settings)
3325 '(save-excursion
3326 (save-window-excursion
3327 (org-agenda-mark-filtered-text)
3328 (let ((bs (copy-sequence (buffer-string))) beg content)
3329 (org-agenda-unmark-filtered-text)
3330 (with-temp-buffer
3331 (rename-buffer org-agenda-write-buffer-name t)
3332 (set-buffer-modified-p nil)
3333 (insert bs)
3334 (org-agenda-remove-marked-text 'org-filtered)
3335 (while (setq beg (text-property-any (point-min) (point-max)
3336 'org-filtered t))
3337 (delete-region
3338 beg (or (next-single-property-change beg 'org-filtered)
3339 (point-max))))
3340 (run-hooks 'org-agenda-before-write-hook)
3341 (cond
3342 ((org-bound-and-true-p org-mobile-creating-agendas)
3343 (org-mobile-write-agenda-for-mobile file))
3344 ((string-match "\\.org\\'" file)
3345 (let (content p m message-log-max)
3346 (goto-char (point-min))
3347 (while (setq p (next-single-property-change (point) 'org-hd-marker nil))
3348 (goto-char p)
3349 (setq m (get-text-property (point) 'org-hd-marker))
3350 (when m
3351 (push (save-excursion
3352 (set-buffer (marker-buffer m))
3353 (goto-char m)
3354 (org-copy-subtree 1 nil t t)
3355 org-subtree-clip)
3356 content)))
3357 (find-file file)
3358 (erase-buffer)
3359 (mapcar (lambda (s) (org-paste-subtree 1 s)) (reverse content))
3360 (write-file file)
3361 (kill-buffer (current-buffer))
3362 (message "Org file written to %s" file)))
3363 ((string-match "\\.html?\\'" file)
3364 (require 'htmlize)
3365 (set-buffer (htmlize-buffer (current-buffer)))
3366 (when org-agenda-export-html-style
3367 ;; replace <style> section with org-agenda-export-html-style
3368 (goto-char (point-min))
3369 (kill-region (- (search-forward "<style") 6)
3370 (search-forward "</style>"))
3371 (insert org-agenda-export-html-style))
3372 (write-file file)
3373 (kill-buffer (current-buffer))
3374 (message "HTML written to %s" file))
3375 ((string-match "\\.ps\\'" file)
3376 (require 'ps-print)
3377 (ps-print-buffer-with-faces file)
3378 (message "Postscript written to %s" file))
3379 ((string-match "\\.pdf\\'" file)
3380 (require 'ps-print)
3381 (ps-print-buffer-with-faces
3382 (concat (file-name-sans-extension file) ".ps"))
3383 (call-process "ps2pdf" nil nil nil
3384 (expand-file-name
3385 (concat (file-name-sans-extension file) ".ps"))
3386 (expand-file-name file))
3387 (delete-file (concat (file-name-sans-extension file) ".ps"))
3388 (message "PDF written to %s" file))
3389 ((string-match "\\.ics\\'" file)
3390 (require 'ox-icalendar)
3391 (org-icalendar-export-current-agenda (expand-file-name file)))
3393 (let ((bs (buffer-string)))
3394 (find-file file)
3395 (erase-buffer)
3396 (insert bs)
3397 (save-buffer 0)
3398 (kill-buffer (current-buffer))
3399 (message "Plain text written to %s" file))))))))
3400 (set-buffer (or agenda-bufname
3401 (and (org-called-interactively-p 'any) (buffer-name))
3402 org-agenda-buffer-name)))
3403 (when open (org-open-file file)))
3405 (defvar org-agenda-tag-filter-overlays nil)
3406 (defvar org-agenda-cat-filter-overlays nil)
3407 (defvar org-agenda-re-filter-overlays nil)
3409 (defun org-agenda-mark-filtered-text ()
3410 "Mark all text hidden by filtering with a text property."
3411 (let ((inhibit-read-only t))
3412 (mapc
3413 (lambda (o)
3414 (when (equal (overlay-buffer o) (current-buffer))
3415 (put-text-property
3416 (overlay-start o) (overlay-end o)
3417 'org-filtered t)))
3418 (append org-agenda-tag-filter-overlays
3419 org-agenda-cat-filter-overlays
3420 org-agenda-re-filter-overlays))))
3422 (defun org-agenda-unmark-filtered-text ()
3423 "Remove the filtering text property."
3424 (let ((inhibit-read-only t))
3425 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
3427 (defun org-agenda-remove-marked-text (property &optional value)
3428 "Delete all text marked with VALUE of PROPERTY.
3429 VALUE defaults to t."
3430 (let (beg)
3431 (setq value (or value t))
3432 (while (setq beg (text-property-any (point-min) (point-max)
3433 property value))
3434 (delete-region
3435 beg (or (next-single-property-change beg 'org-filtered)
3436 (point-max))))))
3438 (defun org-agenda-add-entry-text ()
3439 "Add entry text to agenda lines.
3440 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3441 entry text following headings shown in the agenda.
3442 Drawers will be excluded, also the line with scheduling/deadline info."
3443 (when (and (> org-agenda-add-entry-text-maxlines 0)
3444 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3445 (let (m txt)
3446 (goto-char (point-min))
3447 (while (not (eobp))
3448 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3449 (beginning-of-line 2)
3450 (setq txt (org-agenda-get-some-entry-text
3451 m org-agenda-add-entry-text-maxlines " > "))
3452 (end-of-line 1)
3453 (if (string-match "\\S-" txt)
3454 (insert "\n" txt)
3455 (or (eobp) (forward-char 1))))))))
3457 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3458 &rest keep)
3459 "Extract entry text from MARKER, at most N-LINES lines.
3460 This will ignore drawers etc, just get the text.
3461 If INDENT is given, prefix every line with this string. If KEEP is
3462 given, it is a list of symbols, defining stuff that should not be
3463 removed from the entry content. Currently only `planning' is allowed here."
3464 (let (txt drawer-re kwd-time-re ind)
3465 (save-excursion
3466 (with-current-buffer (marker-buffer marker)
3467 (if (not (derived-mode-p 'org-mode))
3468 (setq txt "")
3469 (save-excursion
3470 (save-restriction
3471 (widen)
3472 (goto-char marker)
3473 (end-of-line 1)
3474 (setq txt (buffer-substring
3475 (min (1+ (point)) (point-max))
3476 (progn (outline-next-heading) (point)))
3477 drawer-re org-drawer-regexp
3478 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3479 ".*\n?"))
3480 (with-temp-buffer
3481 (insert txt)
3482 (when org-agenda-add-entry-text-descriptive-links
3483 (goto-char (point-min))
3484 (while (org-activate-bracket-links (point-max))
3485 (add-text-properties (match-beginning 0) (match-end 0)
3486 '(face org-link))))
3487 (goto-char (point-min))
3488 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3489 (set-text-properties (match-beginning 0) (match-end 0)
3490 nil))
3491 (goto-char (point-min))
3492 (while (re-search-forward drawer-re nil t)
3493 (delete-region
3494 (match-beginning 0)
3495 (progn (re-search-forward
3496 "^[ \t]*:END:.*\n?" nil 'move)
3497 (point))))
3498 (unless (member 'planning keep)
3499 (goto-char (point-min))
3500 (while (re-search-forward kwd-time-re nil t)
3501 (replace-match "")))
3502 (goto-char (point-min))
3503 (when org-agenda-entry-text-exclude-regexps
3504 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3505 (while (setq re (pop re-list))
3506 (goto-char (point-min))
3507 (while (re-search-forward re nil t)
3508 (replace-match "")))))
3509 (goto-char (point-max))
3510 (skip-chars-backward " \t\n")
3511 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3513 ;; find and remove min common indentation
3514 (goto-char (point-min))
3515 (untabify (point-min) (point-max))
3516 (setq ind (org-get-indentation))
3517 (while (not (eobp))
3518 (unless (looking-at "[ \t]*$")
3519 (setq ind (min ind (org-get-indentation))))
3520 (beginning-of-line 2))
3521 (goto-char (point-min))
3522 (while (not (eobp))
3523 (unless (looking-at "[ \t]*$")
3524 (move-to-column ind)
3525 (delete-region (point-at-bol) (point)))
3526 (beginning-of-line 2))
3528 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3530 (goto-char (point-min))
3531 (when indent
3532 (while (and (not (eobp)) (re-search-forward "^" nil t))
3533 (replace-match indent t t)))
3534 (goto-char (point-min))
3535 (while (looking-at "[ \t]*\n") (replace-match ""))
3536 (goto-char (point-max))
3537 (when (> (org-current-line)
3538 n-lines)
3539 (org-goto-line (1+ n-lines))
3540 (backward-char 1))
3541 (setq txt (buffer-substring (point-min) (point)))))))))
3542 txt))
3544 (defun org-check-for-org-mode ()
3545 "Make sure current buffer is in org-mode. Error if not."
3546 (or (derived-mode-p 'org-mode)
3547 (error "Cannot execute org-mode agenda command on buffer in %s"
3548 major-mode)))
3550 ;;; Agenda prepare and finalize
3552 (defvar org-agenda-multi nil) ; dynamically scoped
3553 (defvar org-agenda-pre-window-conf nil)
3554 (defvar org-agenda-columns-active nil)
3555 (defvar org-agenda-name nil)
3556 (defvar org-agenda-tag-filter nil)
3557 (defvar org-agenda-category-filter nil)
3558 (defvar org-agenda-regexp-filter nil)
3559 (defvar org-agenda-top-headline-filter nil)
3560 (defvar org-agenda-tag-filter-while-redo nil)
3561 (defvar org-agenda-tag-filter-preset nil
3562 "A preset of the tags filter used for secondary agenda filtering.
3563 This must be a list of strings, each string must be a single tag preceded
3564 by \"+\" or \"-\".
3565 This variable should not be set directly, but agenda custom commands can
3566 bind it in the options section. The preset filter is a global property of
3567 the entire agenda view. In a block agenda, it will not work reliably to
3568 define a filter for one of the individual blocks. You need to set it in
3569 the global options and expect it to be applied to the entire view.")
3571 (defvar org-agenda-category-filter-preset nil
3572 "A preset of the category filter used for secondary agenda filtering.
3573 This must be a list of strings, each string must be a single category
3574 preceded by \"+\" or \"-\".
3575 This variable should not be set directly, but agenda custom commands can
3576 bind it in the options section. The preset filter is a global property of
3577 the entire agenda view. In a block agenda, it will not work reliably to
3578 define a filter for one of the individual blocks. You need to set it in
3579 the global options and expect it to be applied to the entire view.")
3581 (defvar org-agenda-regexp-filter-preset nil
3582 "A preset of the regexp filter used for secondary agenda filtering.
3583 This must be a list of strings, each string must be a single regexp
3584 preceded by \"+\" or \"-\".
3585 This variable should not be set directly, but agenda custom commands can
3586 bind it in the options section. The preset filter is a global property of
3587 the entire agenda view. In a block agenda, it will not work reliably to
3588 define a filter for one of the individual blocks. You need to set it in
3589 the global options and expect it to be applied to the entire view.")
3591 (defun org-agenda-use-sticky-p ()
3592 "Return non-nil if an agenda buffer named
3593 `org-agenda-buffer-name' exists and should be shown instead of
3594 generating a new one."
3595 (and
3596 ;; turned off by user
3597 org-agenda-sticky
3598 ;; For multi-agenda buffer already exists
3599 (not org-agenda-multi)
3600 ;; buffer found
3601 (get-buffer org-agenda-buffer-name)
3602 ;; C-u parameter is same as last call
3603 (with-current-buffer (get-buffer org-agenda-buffer-name)
3604 (and
3605 (equal current-prefix-arg
3606 org-agenda-last-prefix-arg)
3607 ;; In case user turned stickiness on, while having existing
3608 ;; Agenda buffer active, don't reuse that buffer, because it
3609 ;; does not have org variables local
3610 org-agenda-this-buffer-is-sticky))))
3612 (defun org-agenda-prepare-window (abuf)
3613 "Setup agenda buffer in the window."
3614 (let* ((awin (get-buffer-window abuf))
3615 wconf)
3616 (cond
3617 ((equal (current-buffer) abuf) nil)
3618 (awin (select-window awin))
3619 ((not (setq wconf (current-window-configuration))))
3620 ((equal org-agenda-window-setup 'current-window)
3621 (org-pop-to-buffer-same-window abuf))
3622 ((equal org-agenda-window-setup 'other-window)
3623 (org-switch-to-buffer-other-window abuf))
3624 ((equal org-agenda-window-setup 'other-frame)
3625 (switch-to-buffer-other-frame abuf))
3626 ((equal org-agenda-window-setup 'reorganize-frame)
3627 (delete-other-windows)
3628 (org-switch-to-buffer-other-window abuf)))
3629 ;; additional test in case agenda is invoked from within agenda
3630 ;; buffer via elisp link
3631 (unless (equal (current-buffer) abuf)
3632 (org-pop-to-buffer-same-window abuf))
3633 (setq org-agenda-pre-window-conf
3634 (or org-agenda-pre-window-conf wconf))))
3636 (defun org-agenda-prepare (&optional name)
3637 (if (org-agenda-use-sticky-p)
3638 (progn
3639 ;; Popup existing buffer
3640 (org-agenda-prepare-window (get-buffer org-agenda-buffer-name))
3641 (message "Sticky Agenda buffer, use `r' to refresh")
3642 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
3643 (throw 'exit "Sticky Agenda buffer, use `r' to refresh"))
3644 (setq org-todo-keywords-for-agenda nil)
3645 (setq org-drawers-for-agenda nil)
3646 (unless org-agenda-persistent-filter
3647 (setq org-agenda-tag-filter nil
3648 org-agenda-category-filter nil
3649 org-agenda-regexp-filter nil))
3650 (put 'org-agenda-tag-filter :preset-filter
3651 org-agenda-tag-filter-preset)
3652 (put 'org-agenda-category-filter :preset-filter
3653 org-agenda-category-filter-preset)
3654 (put 'org-agenda-regexp-filter :preset-filter
3655 org-agenda-regexp-filter-preset)
3656 (if org-agenda-multi
3657 (progn
3658 (setq buffer-read-only nil)
3659 (goto-char (point-max))
3660 (unless (or (bobp) org-agenda-compact-blocks
3661 (not org-agenda-block-separator))
3662 (insert "\n"
3663 (if (stringp org-agenda-block-separator)
3664 org-agenda-block-separator
3665 (make-string (window-width) org-agenda-block-separator))
3666 "\n"))
3667 (narrow-to-region (point) (point-max)))
3668 (setq org-done-keywords-for-agenda nil)
3670 ;; Setting any org variables that are in org-agenda-local-vars
3671 ;; list need to be done after the prepare call
3672 (org-agenda-prepare-window (get-buffer-create org-agenda-buffer-name))
3673 (setq buffer-read-only nil)
3674 (org-agenda-reset-markers)
3675 (let ((inhibit-read-only t)) (erase-buffer))
3676 (org-agenda-mode)
3677 (setq org-agenda-buffer (current-buffer))
3678 (setq org-agenda-contributing-files nil)
3679 (setq org-agenda-columns-active nil)
3680 (org-agenda-prepare-buffers (org-agenda-files nil 'ifmode))
3681 (setq org-todo-keywords-for-agenda
3682 (org-uniquify org-todo-keywords-for-agenda))
3683 (setq org-done-keywords-for-agenda
3684 (org-uniquify org-done-keywords-for-agenda))
3685 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3686 (setq org-agenda-last-prefix-arg current-prefix-arg)
3687 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3688 (and name (not org-agenda-name)
3689 (org-set-local 'org-agenda-name name)))
3690 (setq buffer-read-only nil)))
3692 (defvar org-agenda-overriding-columns-format) ; From org-colview.el
3693 (defun org-agenda-finalize ()
3694 "Finishing touch for the agenda buffer, called just before displaying it."
3695 (unless org-agenda-multi
3696 (save-excursion
3697 (let ((inhibit-read-only t))
3698 (goto-char (point-min))
3699 (save-excursion
3700 (while (org-activate-bracket-links (point-max))
3701 (add-text-properties (match-beginning 0) (match-end 0)
3702 '(face org-link))))
3703 (save-excursion
3704 (while (org-activate-plain-links (point-max))
3705 (add-text-properties (match-beginning 0) (match-end 0)
3706 '(face org-link))))
3707 (unless (eq org-agenda-remove-tags t)
3708 (org-agenda-align-tags))
3709 (unless org-agenda-with-colors
3710 (remove-text-properties (point-min) (point-max) '(face nil)))
3711 (if (and (boundp 'org-agenda-overriding-columns-format)
3712 org-agenda-overriding-columns-format)
3713 (org-set-local 'org-agenda-overriding-columns-format
3714 org-agenda-overriding-columns-format))
3715 (if (and (boundp 'org-agenda-view-columns-initially)
3716 org-agenda-view-columns-initially)
3717 (org-agenda-columns))
3718 (when org-agenda-fontify-priorities
3719 (org-agenda-fontify-priorities))
3720 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3721 (org-agenda-dim-blocked-tasks))
3722 (org-agenda-mark-clocking-task)
3723 (when org-agenda-entry-text-mode
3724 (org-agenda-entry-text-hide)
3725 (org-agenda-entry-text-show))
3726 (if (and (functionp 'org-habit-insert-consistency-graphs)
3727 (save-excursion (next-single-property-change (point-min) 'org-habit-p)))
3728 (org-habit-insert-consistency-graphs))
3729 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3730 (unless (or (eq org-agenda-show-inherited-tags 'always)
3731 (and (listp org-agenda-show-inherited-tags)
3732 (memq org-agenda-type org-agenda-show-inherited-tags))
3733 (and (eq org-agenda-show-inherited-tags t)
3734 (or (eq org-agenda-use-tag-inheritance t)
3735 (and (listp org-agenda-use-tag-inheritance)
3736 (not (memq org-agenda-type
3737 org-agenda-use-tag-inheritance))))))
3738 (let (mrk)
3739 (save-excursion
3740 (goto-char (point-min))
3741 (while (equal (forward-line) 0)
3742 (when (setq mrk (or (get-text-property (point) 'org-hd-marker)
3743 (get-text-property (point) 'org-hd-marker)))
3744 (put-text-property (point-at-bol) (point-at-eol)
3745 'tags (org-with-point-at mrk
3746 (delete-dups
3747 (mapcar 'downcase (org-get-tags-at))))))))))
3748 (run-hooks 'org-agenda-finalize-hook)
3749 (when org-agenda-top-headline-filter
3750 (org-agenda-filter-top-headline-apply
3751 org-agenda-top-headline-filter))
3752 (when org-agenda-tag-filter
3753 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3754 (when (get 'org-agenda-tag-filter :preset-filter)
3755 (org-agenda-filter-apply
3756 (get 'org-agenda-tag-filter :preset-filter) 'tag))
3757 (when org-agenda-category-filter
3758 (org-agenda-filter-apply org-agenda-category-filter 'category))
3759 (when (get 'org-agenda-category-filter :preset-filter)
3760 (org-agenda-filter-apply
3761 (get 'org-agenda-category-filter :preset-filter) 'category))
3762 (when org-agenda-regexp-filter
3763 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
3764 (when (get 'org-agenda-regexp-filter :preset-filter)
3765 (org-agenda-filter-apply
3766 (get 'org-agenda-regexp-filter :preset-filter) 'regexp))
3767 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)))))
3769 (defun org-agenda-mark-clocking-task ()
3770 "Mark the current clock entry in the agenda if it is present."
3771 ;; We need to widen when `org-agenda-finalize' is called from
3772 ;; `org-agenda-change-all-lines' (e.g. in `org-agenda-clock-in')
3773 (when org-clock-current-task
3774 (save-restriction
3775 (widen)
3776 (org-agenda-unmark-clocking-task)
3777 (when (marker-buffer org-clock-hd-marker)
3778 (save-excursion
3779 (goto-char (point-min))
3780 (let (s ov)
3781 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3782 (goto-char s)
3783 (when (equal (org-get-at-bol 'org-hd-marker)
3784 org-clock-hd-marker)
3785 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3786 (overlay-put ov 'type 'org-agenda-clocking)
3787 (overlay-put ov 'face 'org-agenda-clocking)
3788 (overlay-put ov 'help-echo
3789 "The clock is running in this item")))))))))
3791 (defun org-agenda-unmark-clocking-task ()
3792 "Unmark the current clocking task."
3793 (mapc (lambda (o)
3794 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3795 (delete-overlay o)))
3796 (overlays-in (point-min) (point-max))))
3798 (defun org-agenda-fontify-priorities ()
3799 "Make highest priority lines bold, and lowest italic."
3800 (interactive)
3801 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3802 (delete-overlay o)))
3803 (overlays-in (point-min) (point-max)))
3804 (save-excursion
3805 (let (b e p ov h l)
3806 (goto-char (point-min))
3807 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3808 (setq h (or (get-char-property (point) 'org-highest-priority)
3809 org-highest-priority)
3810 l (or (get-char-property (point) 'org-lowest-priority)
3811 org-lowest-priority)
3812 p (string-to-char (match-string 1))
3813 b (match-beginning 0)
3814 e (if (eq org-agenda-fontify-priorities 'cookies)
3815 (match-end 0)
3816 (point-at-eol))
3817 ov (make-overlay b e))
3818 (overlay-put
3819 ov 'face
3820 (cons (cond ((org-face-from-face-or-color
3821 'priority nil
3822 (cdr (assoc p org-priority-faces))))
3823 ((and (listp org-agenda-fontify-priorities)
3824 (org-face-from-face-or-color
3825 'priority nil
3826 (cdr (assoc p org-agenda-fontify-priorities)))))
3827 ((equal p l) 'italic)
3828 ((equal p h) 'bold))
3829 'org-priority))
3830 (overlay-put ov 'org-type 'org-priority)))))
3832 (defvar org-depend-tag-blocked)
3834 (defun org-agenda-dim-blocked-tasks (&optional invisible)
3835 "Dim currently blocked TODO's in the agenda display.
3836 When INVISIBLE is non-nil, hide currently blocked TODO instead of
3837 dimming them."
3838 (interactive "P")
3839 (when (org-called-interactively-p 'interactive)
3840 (message "Dim or hide blocked tasks..."))
3841 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3842 (delete-overlay o)))
3843 (overlays-in (point-min) (point-max)))
3844 (save-excursion
3845 (let ((inhibit-read-only t)
3846 (org-depend-tag-blocked nil)
3847 (invis (or (not (null invisible))
3848 (eq org-agenda-dim-blocked-tasks 'invisible)))
3849 org-blocked-by-checkboxes
3850 invis1 b e p ov h l)
3851 (goto-char (point-min))
3852 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3853 (and pos (goto-char (1+ pos))))
3854 (setq org-blocked-by-checkboxes nil invis1 invis)
3855 (let ((marker (org-get-at-bol 'org-hd-marker)))
3856 (when (and marker
3857 (with-current-buffer (marker-buffer marker)
3858 (save-excursion (goto-char marker)
3859 (org-entry-blocked-p))))
3860 (if org-blocked-by-checkboxes (setq invis1 nil))
3861 (setq b (if invis1
3862 (max (point-min) (1- (point-at-bol)))
3863 (point-at-bol))
3864 e (point-at-eol)
3865 ov (make-overlay b e))
3866 (if invis1
3867 (progn (overlay-put ov 'invisible t)
3868 (overlay-put ov 'intangible t))
3869 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3870 (overlay-put ov 'org-type 'org-blocked-todo))))))
3871 (when (org-called-interactively-p 'interactive)
3872 (message "Dim or hide blocked tasks...done")))
3874 (defvar org-agenda-skip-function nil
3875 "Function to be called at each match during agenda construction.
3876 If this function returns nil, the current match should not be skipped.
3877 Otherwise, the function must return a position from where the search
3878 should be continued.
3879 This may also be a Lisp form, it will be evaluated.
3880 Never set this variable using `setq' or so, because then it will apply
3881 to all future agenda commands. If you do want a global skipping condition,
3882 use the option `org-agenda-skip-function-global' instead.
3883 The correct usage for `org-agenda-skip-function' is to bind it with
3884 `let' to scope it dynamically into the agenda-constructing command.
3885 A good way to set it is through options in `org-agenda-custom-commands'.")
3887 (defun org-agenda-skip ()
3888 "Throw to `:skip' in places that should be skipped.
3889 Also moves point to the end of the skipped region, so that search can
3890 continue from there."
3891 (let ((p (point-at-bol)) to)
3892 (when (or
3893 (save-excursion (goto-char p) (looking-at comment-start-skip))
3894 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3895 (get-text-property p :org-archived)
3896 (org-end-of-subtree t))
3897 (and org-agenda-skip-comment-trees
3898 (get-text-property p :org-comment)
3899 (org-end-of-subtree t))
3900 (and (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3901 (org-agenda-skip-eval org-agenda-skip-function)))
3902 (goto-char to))
3903 (org-in-src-block-p t))
3904 (throw :skip t))))
3906 (defun org-agenda-skip-eval (form)
3907 "If FORM is a function or a list, call (or eval) it and return the result.
3908 `save-excursion' and `save-match-data' are wrapped around the call, so point
3909 and match data are returned to the previous state no matter what these
3910 functions do."
3911 (let (fp)
3912 (and form
3913 (or (setq fp (functionp form))
3914 (consp form))
3915 (save-excursion
3916 (save-match-data
3917 (if fp
3918 (funcall form)
3919 (eval form)))))))
3921 (defvar org-agenda-markers nil
3922 "List of all currently active markers created by `org-agenda'.")
3923 (defvar org-agenda-last-marker-time (org-float-time)
3924 "Creation time of the last agenda marker.")
3926 (defun org-agenda-new-marker (&optional pos)
3927 "Return a new agenda marker.
3928 Org-mode keeps a list of these markers and resets them when they are
3929 no longer in use."
3930 (let ((m (copy-marker (or pos (point)))))
3931 (setq org-agenda-last-marker-time (org-float-time))
3932 (if org-agenda-buffer
3933 (with-current-buffer org-agenda-buffer
3934 (push m org-agenda-markers))
3935 (push m org-agenda-markers))
3938 (defun org-agenda-reset-markers ()
3939 "Reset markers created by `org-agenda'."
3940 (while org-agenda-markers
3941 (move-marker (pop org-agenda-markers) nil)))
3943 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3944 "Save relative positions of markers in region.
3945 This check for agenda markers in all agenda buffers currently active."
3946 (dolist (buf (buffer-list))
3947 (with-current-buffer buf
3948 (when (eq major-mode 'org-agenda-mode)
3949 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3950 org-agenda-markers)))))
3952 ;;; Entry text mode
3954 (defun org-agenda-entry-text-show-here ()
3955 "Add some text from the entry as context to the current line."
3956 (let (m txt o)
3957 (setq m (org-get-at-bol 'org-hd-marker))
3958 (unless (marker-buffer m)
3959 (error "No marker points to an entry here"))
3960 (setq txt (concat "\n" (org-no-properties
3961 (org-agenda-get-some-entry-text
3962 m org-agenda-entry-text-maxlines
3963 org-agenda-entry-text-leaders))))
3964 (when (string-match "\\S-" txt)
3965 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3966 (overlay-put o 'evaporate t)
3967 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3968 (overlay-put o 'after-string txt))))
3970 (defun org-agenda-entry-text-show ()
3971 "Add entry context for all agenda lines."
3972 (interactive)
3973 (save-excursion
3974 (goto-char (point-max))
3975 (beginning-of-line 1)
3976 (while (not (bobp))
3977 (when (org-get-at-bol 'org-hd-marker)
3978 (org-agenda-entry-text-show-here))
3979 (beginning-of-line 0))))
3981 (defun org-agenda-entry-text-hide ()
3982 "Remove any shown entry context."
3983 (delq nil
3984 (mapcar (lambda (o)
3985 (if (eq (overlay-get o 'org-overlay-type)
3986 'agenda-entry-content)
3987 (progn (delete-overlay o) t)))
3988 (overlays-in (point-min) (point-max)))))
3990 (defun org-agenda-get-day-face (date)
3991 "Return the face DATE should be displayed with."
3992 (or (and (functionp org-agenda-day-face-function)
3993 (funcall org-agenda-day-face-function date))
3994 (cond ((org-agenda-todayp date)
3995 'org-agenda-date-today)
3996 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3997 'org-agenda-date-weekend)
3998 (t 'org-agenda-date))))
4000 ;;; Agenda timeline
4002 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
4003 (defvar org-agenda-show-log-scoped) ;; dynamically scope in `org-timeline' or `org-agenda-list'
4005 (defun org-timeline (&optional dotodo)
4006 "Show a time-sorted view of the entries in the current org file.
4007 Only entries with a time stamp of today or later will be listed. With
4008 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
4009 under the current date.
4010 If the buffer contains an active region, only check the region for
4011 dates."
4012 (interactive "P")
4013 (let* ((dopast t)
4014 (org-agenda-show-log-scoped org-agenda-show-log)
4015 (org-agenda-show-log org-agenda-show-log-scoped)
4016 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
4017 (current-buffer))))
4018 (date (calendar-current-date))
4019 (beg (if (org-region-active-p) (region-beginning) (point-min)))
4020 (end (if (org-region-active-p) (region-end) (point-max)))
4021 (day-numbers (org-get-all-dates
4022 beg end 'no-ranges
4023 t org-agenda-show-log-scoped ; always include today
4024 org-timeline-show-empty-dates))
4025 (org-deadline-warning-days 0)
4026 (org-agenda-only-exact-dates t)
4027 (today (org-today))
4028 (past t)
4029 args
4030 s e rtn d emptyp)
4031 (setq org-agenda-redo-command
4032 (list 'let
4033 (list (list 'org-agenda-show-log 'org-agenda-show-log))
4034 (list 'org-switch-to-buffer-other-window (current-buffer))
4035 (list 'org-timeline (list 'quote dotodo))))
4036 (put 'org-agenda-redo-command 'org-lprops nil)
4037 (if (not dopast)
4038 ;; Remove past dates from the list of dates.
4039 (setq day-numbers (delq nil (mapcar (lambda(x)
4040 (if (>= x today) x nil))
4041 day-numbers))))
4042 (org-agenda-prepare (concat "Timeline " (file-name-nondirectory entry)))
4043 (org-compile-prefix-format 'timeline)
4044 (org-set-sorting-strategy 'timeline)
4045 (if org-agenda-show-log-scoped (push :closed args))
4046 (push :timestamp args)
4047 (push :deadline args)
4048 (push :scheduled args)
4049 (push :sexp args)
4050 (if dotodo (push :todo args))
4051 (insert "Timeline of file " entry "\n")
4052 (add-text-properties (point-min) (point)
4053 (list 'face 'org-agenda-structure))
4054 (org-agenda-mark-header-line (point-min))
4055 (while (setq d (pop day-numbers))
4056 (if (and (listp d) (eq (car d) :omitted))
4057 (progn
4058 (setq s (point))
4059 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
4060 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
4061 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
4062 (if (and (>= d today)
4063 dopast
4064 past)
4065 (progn
4066 (setq past nil)
4067 (insert (make-string 79 ?-) "\n")))
4068 (setq date (calendar-gregorian-from-absolute d))
4069 (setq s (point))
4070 (setq rtn (and (not emptyp)
4071 (apply 'org-agenda-get-day-entries entry
4072 date args)))
4073 (if (or rtn (equal d today) org-timeline-show-empty-dates)
4074 (progn
4075 (insert
4076 (if (stringp org-agenda-format-date)
4077 (format-time-string org-agenda-format-date
4078 (org-time-from-absolute date))
4079 (funcall org-agenda-format-date date))
4080 "\n")
4081 (put-text-property s (1- (point)) 'face
4082 (org-agenda-get-day-face date))
4083 (put-text-property s (1- (point)) 'org-date-line t)
4084 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4085 (if (equal d today)
4086 (put-text-property s (1- (point)) 'org-today t))
4087 (and rtn (insert (org-agenda-finalize-entries rtn 'timeline) "\n"))
4088 (put-text-property s (1- (point)) 'day d)))))
4089 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
4090 (point-min)))
4091 (add-text-properties
4092 (point-min) (point-max)
4093 `(org-agenda-type timeline org-redo-cmd ,org-agenda-redo-command))
4094 (org-agenda-finalize)
4095 (setq buffer-read-only t)))
4097 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
4098 "Return a list of all relevant day numbers from BEG to END buffer positions.
4099 If NO-RANGES is non-nil, include only the start and end dates of a range,
4100 not every single day in the range. If FORCE-TODAY is non-nil, make
4101 sure that TODAY is included in the list. If INACTIVE is non-nil, also
4102 inactive time stamps (those in square brackets) are included.
4103 When EMPTY is non-nil, also include days without any entries."
4104 (let ((re (concat
4105 (if pre-re pre-re "")
4106 (if inactive org-ts-regexp-both org-ts-regexp)))
4107 dates dates1 date day day1 day2 ts1 ts2 pos)
4108 (if force-today
4109 (setq dates (list (org-today))))
4110 (save-excursion
4111 (goto-char beg)
4112 (while (re-search-forward re end t)
4113 (setq day (time-to-days (org-time-string-to-time
4114 (substring (match-string 1) 0 10)
4115 (current-buffer) (match-beginning 0))))
4116 (or (memq day dates) (push day dates)))
4117 (unless no-ranges
4118 (goto-char beg)
4119 (while (re-search-forward org-tr-regexp end t)
4120 (setq pos (match-beginning 0))
4121 (setq ts1 (substring (match-string 1) 0 10)
4122 ts2 (substring (match-string 2) 0 10)
4123 day1 (time-to-days (org-time-string-to-time
4124 ts1 (current-buffer) pos))
4125 day2 (time-to-days (org-time-string-to-time
4126 ts2 (current-buffer) pos)))
4127 (while (< (setq day1 (1+ day1)) day2)
4128 (or (memq day1 dates) (push day1 dates)))))
4129 (setq dates (sort dates '<))
4130 (when empty
4131 (while (setq day (pop dates))
4132 (setq day2 (car dates))
4133 (push day dates1)
4134 (when (and day2 empty)
4135 (if (or (eq empty t)
4136 (and (numberp empty) (<= (- day2 day) empty)))
4137 (while (< (setq day (1+ day)) day2)
4138 (push (list day) dates1))
4139 (push (cons :omitted (- day2 day)) dates1))))
4140 (setq dates (nreverse dates1)))
4141 dates)))
4143 ;;; Agenda Daily/Weekly
4145 (defvar org-agenda-start-day nil ; dynamically scoped parameter
4146 "Start day for the agenda view.
4147 Custom commands can set this variable in the options section.
4148 This is usually a string like \"2007-11-01\", \"+2d\" or any other
4149 input allowed when reading a date through the Org calendar.
4150 See the docstring of `org-read-date' for details.")
4151 (defvar org-starting-day nil) ; local variable in the agenda buffer
4152 (defvar org-arg-loc nil) ; local variable
4154 (defvar org-agenda-buffer-tmp-name nil)
4155 ;;;###autoload
4156 (defun org-agenda-list (&optional arg start-day span with-hour)
4157 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
4158 The view will be for the current day or week, but from the overview buffer
4159 you will be able to go to other days/weeks.
4161 With a numeric prefix argument in an interactive call, the agenda will
4162 span ARG days. Lisp programs should instead specify SPAN to change
4163 the number of days. SPAN defaults to `org-agenda-span'.
4165 START-DAY defaults to TODAY, or to the most recent match for the weekday
4166 given in `org-agenda-start-on-weekday'.
4168 When WITH-HOUR is non-nil, only include scheduled and deadline
4169 items if they have an hour specification like [h]h:mm."
4170 (interactive "P")
4171 (if org-agenda-overriding-arguments
4172 (setq arg (car org-agenda-overriding-arguments)
4173 start-day (nth 1 org-agenda-overriding-arguments)
4174 span (nth 2 org-agenda-overriding-arguments)))
4175 (if (and (integerp arg) (> arg 0))
4176 (setq span arg arg nil))
4177 (catch 'exit
4178 (setq org-agenda-buffer-name
4179 (or org-agenda-buffer-tmp-name
4180 (if org-agenda-sticky
4181 (cond ((and org-keys (stringp org-match))
4182 (format "*Org Agenda(%s:%s)*" org-keys org-match))
4183 (org-keys
4184 (format "*Org Agenda(%s)*" org-keys))
4185 (t "*Org Agenda(a)*")))
4186 org-agenda-buffer-name))
4187 (org-agenda-prepare "Day/Week")
4188 (setq start-day (or start-day org-agenda-start-day))
4189 (if (stringp start-day)
4190 ;; Convert to an absolute day number
4191 (setq start-day (time-to-days (org-read-date nil t start-day))))
4192 (org-compile-prefix-format 'agenda)
4193 (org-set-sorting-strategy 'agenda)
4194 (let* ((span (org-agenda-ndays-to-span
4195 (or span org-agenda-ndays org-agenda-span)))
4196 (today (org-today))
4197 (sd (or start-day today))
4198 (ndays (org-agenda-span-to-ndays span sd))
4199 (org-agenda-start-on-weekday
4200 (if (or (eq ndays 7) (eq ndays 14))
4201 org-agenda-start-on-weekday))
4202 (thefiles (org-agenda-files nil 'ifmode))
4203 (files thefiles)
4204 (start (if (or (null org-agenda-start-on-weekday)
4205 (< ndays 7))
4207 (let* ((nt (calendar-day-of-week
4208 (calendar-gregorian-from-absolute sd)))
4209 (n1 org-agenda-start-on-weekday)
4210 (d (- nt n1)))
4211 (- sd (+ (if (< d 0) 7 0) d)))))
4212 (day-numbers (list start))
4213 (day-cnt 0)
4214 (inhibit-redisplay (not debug-on-error))
4215 (org-agenda-show-log-scoped org-agenda-show-log)
4216 s e rtn rtnall file date d start-pos end-pos todayp
4217 clocktable-start clocktable-end filter)
4218 (setq org-agenda-redo-command
4219 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span) with-hour))
4220 (dotimes (n (1- ndays))
4221 (push (1+ (car day-numbers)) day-numbers))
4222 (setq day-numbers (nreverse day-numbers))
4223 (setq clocktable-start (car day-numbers)
4224 clocktable-end (1+ (or (org-last day-numbers) 0)))
4225 (org-set-local 'org-starting-day (car day-numbers))
4226 (org-set-local 'org-arg-loc arg)
4227 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
4228 (unless org-agenda-compact-blocks
4229 (let* ((d1 (car day-numbers))
4230 (d2 (org-last day-numbers))
4231 (w1 (org-days-to-iso-week d1))
4232 (w2 (org-days-to-iso-week d2)))
4233 (setq s (point))
4234 (if org-agenda-overriding-header
4235 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4236 nil 'face 'org-agenda-structure) "\n")
4237 (insert (org-agenda-span-name span)
4238 "-agenda"
4239 (if (< (- d2 d1) 350)
4240 (if (= w1 w2)
4241 (format " (W%02d)" w1)
4242 (format " (W%02d-W%02d)" w1 w2))
4244 ":\n")))
4245 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
4246 'org-date-line t))
4247 (org-agenda-mark-header-line s))
4248 (while (setq d (pop day-numbers))
4249 (setq date (calendar-gregorian-from-absolute d)
4250 s (point))
4251 (if (or (setq todayp (= d today))
4252 (and (not start-pos) (= d sd)))
4253 (setq start-pos (point))
4254 (if (and start-pos (not end-pos))
4255 (setq end-pos (point))))
4256 (setq files thefiles
4257 rtnall nil)
4258 (while (setq file (pop files))
4259 (catch 'nextfile
4260 (org-check-agenda-file file)
4261 (let ((org-agenda-entry-types org-agenda-entry-types))
4262 ;; Starred types override non-starred equivalents
4263 (when (member :deadline* org-agenda-entry-types)
4264 (setq org-agenda-entry-types
4265 (delq :deadline org-agenda-entry-types)))
4266 (when (member :scheduled* org-agenda-entry-types)
4267 (setq org-agenda-entry-types
4268 (delq :scheduled org-agenda-entry-types)))
4269 ;; Honor with-hour
4270 (when with-hour
4271 (when (member :deadline org-agenda-entry-types)
4272 (setq org-agenda-entry-types
4273 (delq :deadline org-agenda-entry-types))
4274 (push :deadline* org-agenda-entry-types))
4275 (when (member :scheduled org-agenda-entry-types)
4276 (setq org-agenda-entry-types
4277 (delq :scheduled org-agenda-entry-types))
4278 (push :scheduled* org-agenda-entry-types)))
4279 (unless org-agenda-include-deadlines
4280 (setq org-agenda-entry-types
4281 (delq :deadline* (delq :deadline org-agenda-entry-types))))
4282 (cond
4283 ((memq org-agenda-show-log-scoped '(only clockcheck))
4284 (setq rtn (org-agenda-get-day-entries
4285 file date :closed)))
4286 (org-agenda-show-log-scoped
4287 (setq rtn (apply 'org-agenda-get-day-entries
4288 file date
4289 (append '(:closed) org-agenda-entry-types))))
4291 (setq rtn (apply 'org-agenda-get-day-entries
4292 file date
4293 org-agenda-entry-types)))))
4294 (setq rtnall (append rtnall rtn)))) ;; all entries
4295 (if org-agenda-include-diary
4296 (let ((org-agenda-search-headline-for-time t))
4297 (require 'diary-lib)
4298 (setq rtn (org-get-entries-from-diary date))
4299 (setq rtnall (append rtnall rtn))))
4300 (if (or rtnall org-agenda-show-all-dates)
4301 (progn
4302 (setq day-cnt (1+ day-cnt))
4303 (insert
4304 (if (stringp org-agenda-format-date)
4305 (format-time-string org-agenda-format-date
4306 (org-time-from-absolute date))
4307 (funcall org-agenda-format-date date))
4308 "\n")
4309 (put-text-property s (1- (point)) 'face
4310 (org-agenda-get-day-face date))
4311 (put-text-property s (1- (point)) 'org-date-line t)
4312 (put-text-property s (1- (point)) 'org-agenda-date-header t)
4313 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
4314 (when todayp
4315 (put-text-property s (1- (point)) 'org-today t))
4316 (setq rtnall
4317 (org-agenda-add-time-grid-maybe rtnall ndays todayp))
4318 (if rtnall (insert ;; all entries
4319 (org-agenda-finalize-entries rtnall 'agenda)
4320 "\n"))
4321 (put-text-property s (1- (point)) 'day d)
4322 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
4323 (when (and org-agenda-clockreport-mode clocktable-start)
4324 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
4325 ;; the above line is to ensure the restricted range!
4326 (p (copy-sequence org-agenda-clockreport-parameter-plist))
4327 tbl)
4328 (setq p (org-plist-delete p :block))
4329 (setq p (plist-put p :tstart clocktable-start))
4330 (setq p (plist-put p :tend clocktable-end))
4331 (setq p (plist-put p :scope 'agenda))
4332 (when (and (eq org-agenda-clockreport-mode 'with-filter)
4333 (setq filter (or org-agenda-tag-filter-while-redo
4334 (get 'org-agenda-tag-filter :preset-filter))))
4335 (setq p (plist-put p :tags (mapconcat (lambda (x)
4336 (if (string-match "[<>=]" x)
4339 filter ""))))
4340 (setq tbl (apply 'org-clock-get-clocktable p))
4341 (insert tbl)))
4342 (goto-char (point-min))
4343 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4344 (unless (and (pos-visible-in-window-p (point-min))
4345 (pos-visible-in-window-p (point-max)))
4346 (goto-char (1- (point-max)))
4347 (recenter -1)
4348 (if (not (pos-visible-in-window-p (or start-pos 1)))
4349 (progn
4350 (goto-char (or start-pos 1))
4351 (recenter 1))))
4352 (goto-char (or start-pos 1))
4353 (add-text-properties (point-min) (point-max)
4354 `(org-agenda-type agenda
4355 org-last-args (,arg ,start-day ,span)
4356 org-redo-cmd ,org-agenda-redo-command
4357 org-series-cmd ,org-cmd))
4358 (if (eq org-agenda-show-log-scoped 'clockcheck)
4359 (org-agenda-show-clocking-issues))
4360 (org-agenda-finalize)
4361 (setq buffer-read-only t)
4362 (message ""))))
4364 (defun org-agenda-ndays-to-span (n)
4365 "Return a span symbol for a span of N days, or N if none matches."
4366 (cond ((symbolp n) n)
4367 ((= n 1) 'day)
4368 ((= n 7) 'week)
4369 ((= n 14) 'fortnight)
4370 (t n)))
4372 (defun org-agenda-span-to-ndays (span &optional start-day)
4373 "Return ndays from SPAN, possibly starting at START-DAY.
4374 START-DAY is an absolute time value."
4375 (cond ((numberp span) span)
4376 ((eq span 'day) 1)
4377 ((eq span 'week) 7)
4378 ((eq span 'fortnight) 14)
4379 ((eq span 'month)
4380 (let ((date (calendar-gregorian-from-absolute start-day)))
4381 (calendar-last-day-of-month (car date) (caddr date))))
4382 ((eq span 'year)
4383 (let ((date (calendar-gregorian-from-absolute start-day)))
4384 (if (calendar-leap-year-p (caddr date)) 366 365)))))
4386 (defun org-agenda-span-name (span)
4387 "Return a SPAN name."
4388 (if (null span)
4390 (if (symbolp span)
4391 (capitalize (symbol-name span))
4392 (format "%d days" span))))
4394 ;;; Agenda word search
4396 (defvar org-agenda-search-history nil)
4398 (defvar org-search-syntax-table nil
4399 "Special syntax table for org-mode search.
4400 In this table, we have single quotes not as word constituents, to
4401 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
4403 (defvar org-mode-syntax-table) ; From org.el
4404 (defun org-search-syntax-table ()
4405 (unless org-search-syntax-table
4406 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
4407 (modify-syntax-entry ?' "." org-search-syntax-table)
4408 (modify-syntax-entry ?` "." org-search-syntax-table))
4409 org-search-syntax-table)
4411 (defvar org-agenda-last-search-view-search-was-boolean nil)
4413 ;;;###autoload
4414 (defun org-search-view (&optional todo-only string edit-at)
4415 "Show all entries that contain a phrase or words or regular expressions.
4417 With optional prefix argument TODO-ONLY, only consider entries that are
4418 TODO entries. The argument STRING can be used to pass a default search
4419 string into this function. If EDIT-AT is non-nil, it means that the
4420 user should get a chance to edit this string, with cursor at position
4421 EDIT-AT.
4423 The search string can be viewed either as a phrase that should be found as
4424 is, or it can be broken into a number of snippets, each of which must match
4425 in a Boolean way to select an entry. The default depends on the variable
4426 `org-agenda-search-view-always-boolean'.
4427 Even if this is turned off (the default) you can always switch to
4428 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
4430 The default is a direct search of the whole phrase, where each space in
4431 the search string can expand to an arbitrary amount of whitespace,
4432 including newlines.
4434 If using a Boolean search, the search string is split on whitespace and
4435 each snippet is searched separately, with logical AND to select an entry.
4436 Words prefixed with a minus must *not* occur in the entry. Words without
4437 a prefix or prefixed with a plus must occur in the entry. Matching is
4438 case-insensitive. Words are enclosed by word delimiters (i.e. they must
4439 match whole words, not parts of a word) if
4440 `org-agenda-search-view-force-full-words' is set (default is nil).
4442 Boolean search snippets enclosed by curly braces are interpreted as
4443 regular expressions that must or (when preceded with \"-\") must not
4444 match in the entry. Snippets enclosed into double quotes will be taken
4445 as a whole, to include whitespace.
4447 - If the search string starts with an asterisk, search only in headlines.
4448 - If (possibly after the leading star) the search string starts with an
4449 exclamation mark, this also means to look at TODO entries only, an effect
4450 that can also be achieved with a prefix argument.
4451 - If (possibly after star and exclamation mark) the search string starts
4452 with a colon, this will mean that the (non-regexp) snippets of the
4453 Boolean search must match as full words.
4455 This command searches the agenda files, and in addition the files listed
4456 in `org-agenda-text-search-extra-files'."
4457 (interactive "P")
4458 (if org-agenda-overriding-arguments
4459 (setq todo-only (car org-agenda-overriding-arguments)
4460 string (nth 1 org-agenda-overriding-arguments)
4461 edit-at (nth 2 org-agenda-overriding-arguments)))
4462 (let* ((props (list 'face nil
4463 'done-face 'org-agenda-done
4464 'org-not-done-regexp org-not-done-regexp
4465 'org-todo-regexp org-todo-regexp
4466 'org-complex-heading-regexp org-complex-heading-regexp
4467 'mouse-face 'highlight
4468 'help-echo (format "mouse-2 or RET jump to location")))
4469 (full-words org-agenda-search-view-force-full-words)
4470 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
4471 regexp rtn rtnall files file pos inherited-tags
4472 marker category category-pos level tags c neg re boolean
4473 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
4474 (unless (and (not edit-at)
4475 (stringp string)
4476 (string-match "\\S-" string))
4477 (setq string (read-string
4478 (if org-agenda-search-view-always-boolean
4479 "[+-]Word/{Regexp} ...: "
4480 "Phrase or [+-]Word/{Regexp} ...: ")
4481 (cond
4482 ((integerp edit-at) (cons string edit-at))
4483 (edit-at string))
4484 'org-agenda-search-history)))
4485 (catch 'exit
4486 (if org-agenda-sticky
4487 (setq org-agenda-buffer-name
4488 (if (stringp string)
4489 (format "*Org Agenda(%s:%s)*"
4490 (or org-keys (or (and todo-only "S") "s")) string)
4491 (format "*Org Agenda(%s)*" (or (and todo-only "S") "s")))))
4492 (org-agenda-prepare "SEARCH")
4493 (org-compile-prefix-format 'search)
4494 (org-set-sorting-strategy 'search)
4495 (setq org-agenda-redo-command
4496 (list 'org-search-view (if todo-only t nil)
4497 (list 'if 'current-prefix-arg nil string)))
4498 (setq org-agenda-query-string string)
4499 (if (equal (string-to-char string) ?*)
4500 (setq hdl-only t
4501 words (substring string 1))
4502 (setq words string))
4503 (when (equal (string-to-char words) ?!)
4504 (setq todo-only t
4505 words (substring words 1)))
4506 (when (equal (string-to-char words) ?:)
4507 (setq full-words t
4508 words (substring words 1)))
4509 (if (or org-agenda-search-view-always-boolean
4510 (member (string-to-char words) '(?- ?+ ?\{)))
4511 (setq boolean t))
4512 (setq words (org-split-string words))
4513 (let (www w)
4514 (while (setq w (pop words))
4515 (while (and (string-match "\\\\\\'" w) words)
4516 (setq w (concat (substring w 0 -1) " " (pop words))))
4517 (push w www))
4518 (setq words (nreverse www) www nil)
4519 (while (setq w (pop words))
4520 (when (and (string-match "\\`[-+]?{" w)
4521 (not (string-match "}\\'" w)))
4522 (while (and words (not (string-match "}\\'" (car words))))
4523 (setq w (concat w " " (pop words))))
4524 (setq w (concat w " " (pop words))))
4525 (push w www))
4526 (setq words (nreverse www)))
4527 (setq org-agenda-last-search-view-search-was-boolean boolean)
4528 (when boolean
4529 (let (wds w)
4530 (while (setq w (pop words))
4531 (if (or (equal (substring w 0 1) "\"")
4532 (and (> (length w) 1)
4533 (member (substring w 0 1) '("+" "-"))
4534 (equal (substring w 1 2) "\"")))
4535 (while (and words (not (equal (substring w -1) "\"")))
4536 (setq w (concat w " " (pop words)))))
4537 (and (string-match "\\`\\([-+]?\\)\"" w)
4538 (setq w (replace-match "\\1" nil nil w)))
4539 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4540 (push w wds))
4541 (setq words (nreverse wds))))
4542 (if boolean
4543 (mapc (lambda (w)
4544 (setq c (string-to-char w))
4545 (if (equal c ?-)
4546 (setq neg t w (substring w 1))
4547 (if (equal c ?+)
4548 (setq neg nil w (substring w 1))
4549 (setq neg nil)))
4550 (if (string-match "\\`{.*}\\'" w)
4551 (setq re (substring w 1 -1))
4552 (if full-words
4553 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4554 (setq re (regexp-quote (downcase w)))))
4555 (if neg (push re regexps-) (push re regexps+)))
4556 words)
4557 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4558 regexps+))
4559 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4560 (if (not regexps+)
4561 (setq regexp org-outline-regexp-bol)
4562 (setq regexp (pop regexps+))
4563 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4564 regexp))))
4565 (setq files (org-agenda-files nil 'ifmode))
4566 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4567 (pop org-agenda-text-search-extra-files)
4568 (setq files (org-add-archive-files files)))
4569 (setq files (append files org-agenda-text-search-extra-files)
4570 rtnall nil)
4571 (while (setq file (pop files))
4572 (setq ee nil)
4573 (catch 'nextfile
4574 (org-check-agenda-file file)
4575 (setq buffer (if (file-exists-p file)
4576 (org-get-agenda-file-buffer file)
4577 (error "No such file %s" file)))
4578 (if (not buffer)
4579 ;; If file does not exist, make sure an error message is sent
4580 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4581 file))))
4582 (with-current-buffer buffer
4583 (with-syntax-table (org-search-syntax-table)
4584 (unless (derived-mode-p 'org-mode)
4585 (error "Agenda file %s is not in `org-mode'" file))
4586 (let ((case-fold-search t))
4587 (save-excursion
4588 (save-restriction
4589 (if (eq buffer org-agenda-restrict)
4590 (narrow-to-region org-agenda-restrict-begin
4591 org-agenda-restrict-end)
4592 (widen))
4593 (goto-char (point-min))
4594 (unless (or (org-at-heading-p)
4595 (outline-next-heading))
4596 (throw 'nextfile t))
4597 (goto-char (max (point-min) (1- (point))))
4598 (while (re-search-forward regexp nil t)
4599 (org-back-to-heading t)
4600 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4601 (> (org-reduced-level (org-outline-level))
4602 org-agenda-search-view-max-outline-level)
4603 (forward-line -1)
4604 (outline-back-to-heading t)))
4605 (skip-chars-forward "* ")
4606 (setq beg (point-at-bol)
4607 beg1 (point)
4608 end (progn
4609 (outline-next-heading)
4610 (while (and (not (zerop org-agenda-search-view-max-outline-level))
4611 (> (org-reduced-level (org-outline-level))
4612 org-agenda-search-view-max-outline-level)
4613 (forward-line 1)
4614 (outline-next-heading)))
4615 (point)))
4617 (catch :skip
4618 (goto-char beg)
4619 (org-agenda-skip)
4620 (setq str (buffer-substring-no-properties
4621 (point-at-bol)
4622 (if hdl-only (point-at-eol) end)))
4623 (mapc (lambda (wr) (when (string-match wr str)
4624 (goto-char (1- end))
4625 (throw :skip t)))
4626 regexps-)
4627 (mapc (lambda (wr) (unless (string-match wr str)
4628 (goto-char (1- end))
4629 (throw :skip t)))
4630 (if todo-only
4631 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4632 regexps+)
4633 regexps+))
4634 (goto-char beg)
4635 (setq marker (org-agenda-new-marker (point))
4636 category (org-get-category)
4637 level (make-string (org-reduced-level (org-outline-level)) ? )
4638 category-pos (get-text-property (point) 'org-category-position)
4639 inherited-tags
4640 (or (eq org-agenda-show-inherited-tags 'always)
4641 (and (listp org-agenda-show-inherited-tags)
4642 (memq 'todo org-agenda-show-inherited-tags))
4643 (and (eq org-agenda-show-inherited-tags t)
4644 (or (eq org-agenda-use-tag-inheritance t)
4645 (memq 'todo org-agenda-use-tag-inheritance))))
4646 tags (org-get-tags-at nil (not inherited-tags))
4647 txt (org-agenda-format-item
4649 (buffer-substring-no-properties
4650 beg1 (point-at-eol))
4651 level category tags t))
4652 (org-add-props txt props
4653 'org-marker marker 'org-hd-marker marker
4654 'org-todo-regexp org-todo-regexp
4655 'level level
4656 'org-complex-heading-regexp org-complex-heading-regexp
4657 'priority 1000 'org-category category
4658 'org-category-position category-pos
4659 'type "search")
4660 (push txt ee)
4661 (goto-char (1- end))))))))))
4662 (setq rtn (nreverse ee))
4663 (setq rtnall (append rtnall rtn)))
4664 (if org-agenda-overriding-header
4665 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4666 nil 'face 'org-agenda-structure) "\n")
4667 (insert "Search words: ")
4668 (add-text-properties (point-min) (1- (point))
4669 (list 'face 'org-agenda-structure))
4670 (setq pos (point))
4671 (insert string "\n")
4672 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4673 (setq pos (point))
4674 (unless org-agenda-multi
4675 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4676 (add-text-properties pos (1- (point))
4677 (list 'face 'org-agenda-structure))))
4678 (org-agenda-mark-header-line (point-min))
4679 (when rtnall
4680 (insert (org-agenda-finalize-entries rtnall 'search) "\n"))
4681 (goto-char (point-min))
4682 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4683 (add-text-properties (point-min) (point-max)
4684 `(org-agenda-type search
4685 org-last-args (,todo-only ,string ,edit-at)
4686 org-redo-cmd ,org-agenda-redo-command
4687 org-series-cmd ,org-cmd))
4688 (org-agenda-finalize)
4689 (setq buffer-read-only t))))
4691 ;;; Agenda TODO list
4693 (defun org-agenda-propertize-selected-todo-keywords (keywords)
4694 "Use `org-todo-keyword-faces' for the selected todo KEYWORDS."
4695 (concat
4696 (if (or (equal keywords "ALL") (not keywords))
4697 (propertize "ALL" 'face 'warning)
4698 (mapconcat
4699 (lambda (kw)
4700 (propertize kw 'face (org-get-todo-face kw)))
4701 (org-split-string keywords "|")
4702 "|"))
4703 "\n"))
4705 (defvar org-select-this-todo-keyword nil)
4706 (defvar org-last-arg nil)
4708 ;;;###autoload
4709 (defun org-todo-list (&optional arg)
4710 "Show all (not done) TODO entries from all agenda file in a single list.
4711 The prefix arg can be used to select a specific TODO keyword and limit
4712 the list to these. When using \\[universal-argument], you will be prompted
4713 for a keyword. A numeric prefix directly selects the Nth keyword in
4714 `org-todo-keywords-1'."
4715 (interactive "P")
4716 (if org-agenda-overriding-arguments
4717 (setq arg org-agenda-overriding-arguments))
4718 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4719 (let* ((today (org-today))
4720 (date (calendar-gregorian-from-absolute today))
4721 (kwds org-todo-keywords-for-agenda)
4722 (completion-ignore-case t)
4723 (org-select-this-todo-keyword
4724 (if (stringp arg) arg
4725 (and arg (integerp arg) (> arg 0)
4726 (nth (1- arg) kwds))))
4727 rtn rtnall files file pos)
4728 (when (equal arg '(4))
4729 (setq org-select-this-todo-keyword
4730 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4731 (mapcar 'list kwds) nil nil)))
4732 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4733 (catch 'exit
4734 (if org-agenda-sticky
4735 (setq org-agenda-buffer-name
4736 (if (stringp org-select-this-todo-keyword)
4737 (format "*Org Agenda(%s:%s)*" (or org-keys "t")
4738 org-select-this-todo-keyword)
4739 (format "*Org Agenda(%s)*" (or org-keys "t")))))
4740 (org-agenda-prepare "TODO")
4741 (org-compile-prefix-format 'todo)
4742 (org-set-sorting-strategy 'todo)
4743 (setq org-agenda-redo-command
4744 `(org-todo-list (or (and (numberp current-prefix-arg)
4745 current-prefix-arg)
4746 ,org-select-this-todo-keyword
4747 current-prefix-arg ,arg)))
4748 (setq files (org-agenda-files nil 'ifmode)
4749 rtnall nil)
4750 (while (setq file (pop files))
4751 (catch 'nextfile
4752 (org-check-agenda-file file)
4753 (setq rtn (org-agenda-get-day-entries file date :todo))
4754 (setq rtnall (append rtnall rtn))))
4755 (if org-agenda-overriding-header
4756 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4757 nil 'face 'org-agenda-structure) "\n")
4758 (insert "Global list of TODO items of type: ")
4759 (add-text-properties (point-min) (1- (point))
4760 (list 'face 'org-agenda-structure
4761 'short-heading
4762 (concat "ToDo: "
4763 (or org-select-this-todo-keyword "ALL"))))
4764 (org-agenda-mark-header-line (point-min))
4765 (insert (org-agenda-propertize-selected-todo-keywords
4766 org-select-this-todo-keyword))
4767 (setq pos (point))
4768 (unless org-agenda-multi
4769 (insert "Available with `N r': (0)[ALL]")
4770 (let ((n 0) s)
4771 (mapc (lambda (x)
4772 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4773 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4774 (insert "\n "))
4775 (insert " " s))
4776 kwds))
4777 (insert "\n"))
4778 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4779 (org-agenda-mark-header-line (point-min))
4780 (when rtnall
4781 (insert (org-agenda-finalize-entries rtnall 'todo) "\n"))
4782 (goto-char (point-min))
4783 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4784 (add-text-properties (point-min) (point-max)
4785 `(org-agenda-type todo
4786 org-last-args ,arg
4787 org-redo-cmd ,org-agenda-redo-command
4788 org-series-cmd ,org-cmd))
4789 (org-agenda-finalize)
4790 (setq buffer-read-only t))))
4792 ;;; Agenda tags match
4794 ;;;###autoload
4795 (defun org-tags-view (&optional todo-only match)
4796 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4797 The prefix arg TODO-ONLY limits the search to TODO entries."
4798 (interactive "P")
4799 (if org-agenda-overriding-arguments
4800 (setq todo-only (car org-agenda-overriding-arguments)
4801 match (nth 1 org-agenda-overriding-arguments)))
4802 (let* ((org-tags-match-list-sublevels
4803 org-tags-match-list-sublevels)
4804 (completion-ignore-case t)
4805 rtn rtnall files file pos matcher
4806 buffer)
4807 (when (and (stringp match) (not (string-match "\\S-" match)))
4808 (setq match nil))
4809 (catch 'exit
4810 (if org-agenda-sticky
4811 (setq org-agenda-buffer-name
4812 (if (stringp match)
4813 (format "*Org Agenda(%s:%s)*"
4814 (or org-keys (or (and todo-only "M") "m")) match)
4815 (format "*Org Agenda(%s)*" (or (and todo-only "M") "m")))))
4816 ;; Prepare agendas (and `org-tag-alist-for-agenda') before
4817 ;; expanding tags within `org-make-tags-matcher'
4818 (org-agenda-prepare (concat "TAGS " match))
4819 (setq matcher (org-make-tags-matcher match)
4820 match (car matcher) matcher (cdr matcher))
4821 (org-compile-prefix-format 'tags)
4822 (org-set-sorting-strategy 'tags)
4823 (setq org-agenda-query-string match)
4824 (setq org-agenda-redo-command
4825 (list 'org-tags-view `(quote ,todo-only)
4826 (list 'if 'current-prefix-arg nil `(quote ,org-agenda-query-string))))
4827 (setq files (org-agenda-files nil 'ifmode)
4828 rtnall nil)
4829 (while (setq file (pop files))
4830 (catch 'nextfile
4831 (org-check-agenda-file file)
4832 (setq buffer (if (file-exists-p file)
4833 (org-get-agenda-file-buffer file)
4834 (error "No such file %s" file)))
4835 (if (not buffer)
4836 ;; If file does not exist, error message to agenda
4837 (setq rtn (list
4838 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4839 rtnall (append rtnall rtn))
4840 (with-current-buffer buffer
4841 (unless (derived-mode-p 'org-mode)
4842 (error "Agenda file %s is not in `org-mode'" file))
4843 (save-excursion
4844 (save-restriction
4845 (if (eq buffer org-agenda-restrict)
4846 (narrow-to-region org-agenda-restrict-begin
4847 org-agenda-restrict-end)
4848 (widen))
4849 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4850 (setq rtnall (append rtnall rtn))))))))
4851 (if org-agenda-overriding-header
4852 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4853 nil 'face 'org-agenda-structure) "\n")
4854 (insert "Headlines with TAGS match: ")
4855 (add-text-properties (point-min) (1- (point))
4856 (list 'face 'org-agenda-structure
4857 'short-heading
4858 (concat "Match: " match)))
4859 (setq pos (point))
4860 (insert match "\n")
4861 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4862 (setq pos (point))
4863 (unless org-agenda-multi
4864 (insert "Press `C-u r' to search again with new search string\n"))
4865 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4866 (org-agenda-mark-header-line (point-min))
4867 (when rtnall
4868 (insert (org-agenda-finalize-entries rtnall 'tags) "\n"))
4869 (goto-char (point-min))
4870 (or org-agenda-multi (org-agenda-fit-window-to-buffer))
4871 (add-text-properties (point-min) (point-max)
4872 `(org-agenda-type tags
4873 org-last-args (,todo-only ,match)
4874 org-redo-cmd ,org-agenda-redo-command
4875 org-series-cmd ,org-cmd))
4876 (org-agenda-finalize)
4877 (setq buffer-read-only t))))
4879 ;;; Agenda Finding stuck projects
4881 (defvar org-agenda-skip-regexp nil
4882 "Regular expression used in skipping subtrees for the agenda.
4883 This is basically a temporary global variable that can be set and then
4884 used by user-defined selections using `org-agenda-skip-function'.")
4886 (defvar org-agenda-overriding-header nil
4887 "When set during agenda, todo and tags searches it replaces the header.
4888 This variable should not be set directly, but custom commands can bind it
4889 in the options section.")
4891 (defun org-agenda-skip-entry-when-regexp-matches ()
4892 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4893 If yes, it returns the end position of this entry, causing agenda commands
4894 to skip the entry but continuing the search in the subtree. This is a
4895 function that can be put into `org-agenda-skip-function' for the duration
4896 of a command."
4897 (let ((end (save-excursion (org-end-of-subtree t)))
4898 skip)
4899 (save-excursion
4900 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4901 (and skip end)))
4903 (defun org-agenda-skip-subtree-when-regexp-matches ()
4904 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4905 If yes, it returns the end position of this tree, causing agenda commands
4906 to skip this subtree. This is a function that can be put into
4907 `org-agenda-skip-function' for the duration of a command."
4908 (let ((end (save-excursion (org-end-of-subtree t)))
4909 skip)
4910 (save-excursion
4911 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4912 (and skip end)))
4914 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4915 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4916 If yes, it returns the end position of the current entry (NOT the tree),
4917 causing agenda commands to skip the entry but continuing the search in
4918 the subtree. This is a function that can be put into
4919 `org-agenda-skip-function' for the duration of a command. An important
4920 use of this function is for the stuck project list."
4921 (let ((end (save-excursion (org-end-of-subtree t)))
4922 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4923 skip)
4924 (save-excursion
4925 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4926 (and skip entry-end)))
4928 (defun org-agenda-skip-entry-if (&rest conditions)
4929 "Skip entry if any of CONDITIONS is true.
4930 See `org-agenda-skip-if' for details."
4931 (org-agenda-skip-if nil conditions))
4933 (defun org-agenda-skip-subtree-if (&rest conditions)
4934 "Skip subtree if any of CONDITIONS is true.
4935 See `org-agenda-skip-if' for details."
4936 (org-agenda-skip-if t conditions))
4938 (defun org-agenda-skip-if (subtree conditions)
4939 "Checks current entity for CONDITIONS.
4940 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4941 the entry (i.e. the text before the next heading) is checked.
4943 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4944 from different tests. Valid conditions are:
4946 scheduled Check if there is a scheduled cookie
4947 notscheduled Check if there is no scheduled cookie
4948 deadline Check if there is a deadline
4949 notdeadline Check if there is no deadline
4950 timestamp Check if there is a timestamp (also deadline or scheduled)
4951 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4952 regexp Check if regexp matches
4953 notregexp Check if regexp does not match.
4954 todo Check if TODO keyword matches
4955 nottodo Check if TODO keyword does not match
4957 The regexp is taken from the conditions list, it must come right after
4958 the `regexp' or `notregexp' element.
4960 `todo' and `nottodo' accept as an argument a list of todo
4961 keywords, which may include \"*\" to match any todo keyword.
4963 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4965 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4967 Instead of a list, a keyword class may be given. For example:
4969 (org-agenda-skip-entry-if 'nottodo 'done)
4971 would skip entries that haven't been marked with any of \"DONE\"
4972 keywords. Possible classes are: `todo', `done', `any'.
4974 If any of these conditions is met, this function returns the end point of
4975 the entity, causing the search to continue from there. This is a function
4976 that can be put into `org-agenda-skip-function' for the duration of a command."
4977 (let (beg end m)
4978 (org-back-to-heading t)
4979 (setq beg (point)
4980 end (if subtree
4981 (progn (org-end-of-subtree t) (point))
4982 (progn (outline-next-heading) (1- (point)))))
4983 (goto-char beg)
4984 (and
4986 (and (memq 'scheduled conditions)
4987 (re-search-forward org-scheduled-time-regexp end t))
4988 (and (memq 'notscheduled conditions)
4989 (not (re-search-forward org-scheduled-time-regexp end t)))
4990 (and (memq 'deadline conditions)
4991 (re-search-forward org-deadline-time-regexp end t))
4992 (and (memq 'notdeadline conditions)
4993 (not (re-search-forward org-deadline-time-regexp end t)))
4994 (and (memq 'timestamp conditions)
4995 (re-search-forward org-ts-regexp end t))
4996 (and (memq 'nottimestamp conditions)
4997 (not (re-search-forward org-ts-regexp end t)))
4998 (and (setq m (memq 'regexp conditions))
4999 (stringp (nth 1 m))
5000 (re-search-forward (nth 1 m) end t))
5001 (and (setq m (memq 'notregexp conditions))
5002 (stringp (nth 1 m))
5003 (not (re-search-forward (nth 1 m) end t)))
5004 (and (or
5005 (setq m (memq 'nottodo conditions))
5006 (setq m (memq 'todo-unblocked conditions))
5007 (setq m (memq 'nottodo-unblocked conditions))
5008 (setq m (memq 'todo conditions)))
5009 (org-agenda-skip-if-todo m end)))
5010 end)))
5012 (defun org-agenda-skip-if-todo (args end)
5013 "Helper function for `org-agenda-skip-if', do not use it directly.
5014 ARGS is a list with first element either `todo', `nottodo',
5015 `todo-unblocked' or `nottodo-unblocked'. The remainder is either
5016 a list of TODO keywords, or a state symbol `todo' or `done' or
5017 `any'."
5018 (let ((kw (car args))
5019 (arg (cadr args))
5020 todo-wds todo-re)
5021 (setq todo-wds
5022 (org-uniquify
5023 (cond
5024 ((listp arg) ;; list of keywords
5025 (if (member "*" arg)
5026 (mapcar 'substring-no-properties org-todo-keywords-1)
5027 arg))
5028 ((symbolp arg) ;; keyword class name
5029 (cond
5030 ((eq arg 'todo)
5031 (org-delete-all org-done-keywords
5032 (mapcar 'substring-no-properties
5033 org-todo-keywords-1)))
5034 ((eq arg 'done) org-done-keywords)
5035 ((eq arg 'any)
5036 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
5037 (setq todo-re
5038 (concat "^\\*+[ \t]+\\<\\("
5039 (mapconcat 'identity todo-wds "\\|")
5040 "\\)\\>"))
5041 (cond
5042 ((eq kw 'todo) (re-search-forward todo-re end t))
5043 ((eq kw 'nottodo) (not (re-search-forward todo-re end t)))
5044 ((eq kw 'todo-unblocked)
5045 (catch 'unblocked
5046 (while (re-search-forward todo-re end t)
5047 (or (org-entry-blocked-p) (throw 'unblocked t)))
5048 nil))
5049 ((eq kw 'nottodo-unblocked)
5050 (catch 'unblocked
5051 (while (re-search-forward todo-re end t)
5052 (or (org-entry-blocked-p) (throw 'unblocked nil)))
5056 ;;;###autoload
5057 (defun org-agenda-list-stuck-projects (&rest ignore)
5058 "Create agenda view for projects that are stuck.
5059 Stuck projects are project that have no next actions. For the definitions
5060 of what a project is and how to check if it stuck, customize the variable
5061 `org-stuck-projects'."
5062 (interactive)
5063 (let* ((org-agenda-skip-function
5064 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
5065 ;; We could have used org-agenda-skip-if here.
5066 (org-agenda-overriding-header
5067 (or org-agenda-overriding-header "List of stuck projects: "))
5068 (matcher (nth 0 org-stuck-projects))
5069 (todo (nth 1 org-stuck-projects))
5070 (todo-wds (if (member "*" todo)
5071 (progn
5072 (org-agenda-prepare-buffers (org-agenda-files
5073 nil 'ifmode))
5074 (org-delete-all
5075 org-done-keywords-for-agenda
5076 (copy-sequence org-todo-keywords-for-agenda)))
5077 todo))
5078 (todo-re (concat "^\\*+[ \t]+\\("
5079 (mapconcat 'identity todo-wds "\\|")
5080 "\\)\\>"))
5081 (tags (nth 2 org-stuck-projects))
5082 (tags-re (if (member "*" tags)
5083 (concat org-outline-regexp-bol
5084 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
5085 (if tags
5086 (concat org-outline-regexp-bol
5087 ".*:\\("
5088 (mapconcat 'identity tags "\\|")
5089 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
5090 (gen-re (nth 3 org-stuck-projects))
5091 (re-list
5092 (delq nil
5093 (list
5094 (if todo todo-re)
5095 (if tags tags-re)
5096 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
5097 gen-re)))))
5098 (setq org-agenda-skip-regexp
5099 (if re-list
5100 (mapconcat 'identity re-list "\\|")
5101 (error "No information how to identify unstuck projects")))
5102 (org-tags-view nil matcher)
5103 (setq org-agenda-buffer-name (buffer-name))
5104 (with-current-buffer org-agenda-buffer-name
5105 (setq org-agenda-redo-command
5106 `(org-agenda-list-stuck-projects ,current-prefix-arg)))))
5108 ;;; Diary integration
5110 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
5111 (defvar diary-list-entries-hook)
5112 (defvar diary-time-regexp)
5113 (defun org-get-entries-from-diary (date)
5114 "Get the (Emacs Calendar) diary entries for DATE."
5115 (require 'diary-lib)
5116 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
5117 (diary-display-hook '(fancy-diary-display))
5118 (diary-display-function 'fancy-diary-display)
5119 (pop-up-frames nil)
5120 (diary-list-entries-hook
5121 (cons 'org-diary-default-entry diary-list-entries-hook))
5122 (diary-file-name-prefix nil) ; turn this feature off
5123 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
5124 entries
5125 (org-disable-agenda-to-diary t))
5126 (save-excursion
5127 (save-window-excursion
5128 (funcall (if (fboundp 'diary-list-entries)
5129 'diary-list-entries 'list-diary-entries)
5130 date 1)))
5131 (if (not (get-buffer diary-fancy-buffer))
5132 (setq entries nil)
5133 (with-current-buffer diary-fancy-buffer
5134 (setq buffer-read-only nil)
5135 (if (zerop (buffer-size))
5136 ;; No entries
5137 (setq entries nil)
5138 ;; Omit the date and other unnecessary stuff
5139 (org-agenda-cleanup-fancy-diary)
5140 ;; Add prefix to each line and extend the text properties
5141 (if (zerop (buffer-size))
5142 (setq entries nil)
5143 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
5144 (setq entries
5145 (with-temp-buffer
5146 (insert entries) (goto-char (point-min))
5147 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
5148 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
5149 (replace-match (concat "; " (match-string 1)))))
5150 (buffer-string)))))
5151 (set-buffer-modified-p nil)
5152 (kill-buffer diary-fancy-buffer)))
5153 (when entries
5154 (setq entries (org-split-string entries "\n"))
5155 (setq entries
5156 (mapcar
5157 (lambda (x)
5158 (setq x (org-agenda-format-item "" x nil "Diary" nil 'time))
5159 ;; Extend the text properties to the beginning of the line
5160 (org-add-props x (text-properties-at (1- (length x)) x)
5161 'type "diary" 'date date 'face 'org-agenda-diary))
5162 entries)))))
5164 (defvar org-agenda-cleanup-fancy-diary-hook nil
5165 "Hook run when the fancy diary buffer is cleaned up.")
5167 (defun org-agenda-cleanup-fancy-diary ()
5168 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
5169 This gets rid of the date, the underline under the date, and
5170 the dummy entry installed by `org-mode' to ensure non-empty diary for each
5171 date. It also removes lines that contain only whitespace."
5172 (goto-char (point-min))
5173 (if (looking-at ".*?:[ \t]*")
5174 (progn
5175 (replace-match "")
5176 (re-search-forward "\n=+$" nil t)
5177 (replace-match "")
5178 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
5179 (re-search-forward "\n=+$" nil t)
5180 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
5181 (goto-char (point-min))
5182 (while (re-search-forward "^ +\n" nil t)
5183 (replace-match ""))
5184 (goto-char (point-min))
5185 (if (re-search-forward "^Org-mode dummy\n?" nil t)
5186 (replace-match ""))
5187 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
5189 ;; Make sure entries from the diary have the right text properties.
5190 (eval-after-load "diary-lib"
5191 '(if (boundp 'diary-modify-entry-list-string-function)
5192 ;; We can rely on the hook, nothing to do
5194 ;; Hook not available, must use advice to make this work
5195 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
5196 "Make the position visible."
5197 (if (and org-disable-agenda-to-diary ;; called from org-agenda
5198 (stringp string)
5199 buffer-file-name)
5200 (setq string (org-modify-diary-entry-string string))))))
5202 (defun org-modify-diary-entry-string (string)
5203 "Add text properties to string, allowing org-mode to act on it."
5204 (org-add-props string nil
5205 'mouse-face 'highlight
5206 'help-echo (if buffer-file-name
5207 (format "mouse-2 or RET jump to diary file %s"
5208 (abbreviate-file-name buffer-file-name))
5210 'org-agenda-diary-link t
5211 'org-marker (org-agenda-new-marker (point-at-bol))))
5213 (defun org-diary-default-entry ()
5214 "Add a dummy entry to the diary.
5215 Needed to avoid empty dates which mess up holiday display."
5216 ;; Catch the error if dealing with the new add-to-diary-alist
5217 (when org-disable-agenda-to-diary
5218 (condition-case nil
5219 (org-add-to-diary-list original-date "Org-mode dummy" "")
5220 (error
5221 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
5223 (defun org-add-to-diary-list (&rest args)
5224 (if (fboundp 'diary-add-to-list)
5225 (apply 'diary-add-to-list args)
5226 (apply 'add-to-diary-list args)))
5228 (defvar org-diary-last-run-time nil)
5230 ;;;###autoload
5231 (defun org-diary (&rest args)
5232 "Return diary information from org files.
5233 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
5234 It accesses org files and extracts information from those files to be
5235 listed in the diary. The function accepts arguments specifying what
5236 items should be listed. For a list of arguments allowed here, see the
5237 variable `org-agenda-entry-types'.
5239 The call in the diary file should look like this:
5241 &%%(org-diary) ~/path/to/some/orgfile.org
5243 Use a separate line for each org file to check. Or, if you omit the file name,
5244 all files listed in `org-agenda-files' will be checked automatically:
5246 &%%(org-diary)
5248 If you don't give any arguments (as in the example above), the default value
5249 of `org-agenda-entry-types' is used: (:deadline :scheduled :timestamp :sexp).
5250 So the example above may also be written as
5252 &%%(org-diary :deadline :timestamp :sexp :scheduled)
5254 The function expects the lisp variables `entry' and `date' to be provided
5255 by the caller, because this is how the calendar works. Don't use this
5256 function from a program - use `org-agenda-get-day-entries' instead."
5257 (when (> (- (org-float-time)
5258 org-agenda-last-marker-time)
5260 ;; I am not sure if this works with sticky agendas, because the marker
5261 ;; list is then no longer a global variable.
5262 (org-agenda-reset-markers))
5263 (org-compile-prefix-format 'agenda)
5264 (org-set-sorting-strategy 'agenda)
5265 (setq args (or args org-agenda-entry-types))
5266 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
5267 (list entry)
5268 (org-agenda-files t)))
5269 (time (org-float-time))
5270 file rtn results)
5271 (when (or (not org-diary-last-run-time)
5272 (> (- time
5273 org-diary-last-run-time)
5275 (org-agenda-prepare-buffers files))
5276 (setq org-diary-last-run-time time)
5277 ;; If this is called during org-agenda, don't return any entries to
5278 ;; the calendar. Org Agenda will list these entries itself.
5279 (if org-disable-agenda-to-diary (setq files nil))
5280 (while (setq file (pop files))
5281 (setq rtn (apply 'org-agenda-get-day-entries file date args))
5282 (setq results (append results rtn)))
5283 (when results
5284 (setq results
5285 (mapcar (lambda (i) (replace-regexp-in-string
5286 org-bracket-link-regexp "\\3" i)) results))
5287 (concat (org-agenda-finalize-entries results) "\n"))))
5289 ;;; Agenda entry finders
5291 (defun org-agenda-get-day-entries (file date &rest args)
5292 "Does the work for `org-diary' and `org-agenda'.
5293 FILE is the path to a file to be checked for entries. DATE is date like
5294 the one returned by `calendar-current-date'. ARGS are symbols indicating
5295 which kind of entries should be extracted. For details about these, see
5296 the documentation of `org-diary'."
5297 (setq args (or args org-agenda-entry-types))
5298 (let* ((org-startup-folded nil)
5299 (org-startup-align-all-tables nil)
5300 (buffer (if (file-exists-p file)
5301 (org-get-agenda-file-buffer file)
5302 (error "No such file %s" file)))
5303 arg results rtn deadline-results)
5304 (if (not buffer)
5305 ;; If file does not exist, make sure an error message ends up in diary
5306 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
5307 (with-current-buffer buffer
5308 (unless (derived-mode-p 'org-mode)
5309 (error "Agenda file %s is not in `org-mode'" file))
5310 (setq org-agenda-buffer (or org-agenda-buffer buffer))
5311 (let ((case-fold-search nil))
5312 (save-excursion
5313 (save-restriction
5314 (if (eq buffer org-agenda-restrict)
5315 (narrow-to-region org-agenda-restrict-begin
5316 org-agenda-restrict-end)
5317 (widen))
5318 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
5319 (while (setq arg (pop args))
5320 (cond
5321 ((and (eq arg :todo)
5322 (equal date (calendar-gregorian-from-absolute
5323 (org-today))))
5324 (setq rtn (org-agenda-get-todos))
5325 (setq results (append results rtn)))
5326 ((eq arg :timestamp)
5327 (setq rtn (org-agenda-get-blocks))
5328 (setq results (append results rtn))
5329 (setq rtn (org-agenda-get-timestamps deadline-results))
5330 (setq results (append results rtn)))
5331 ((eq arg :sexp)
5332 (setq rtn (org-agenda-get-sexps))
5333 (setq results (append results rtn)))
5334 ((eq arg :scheduled)
5335 (setq rtn (org-agenda-get-scheduled deadline-results))
5336 (setq results (append results rtn)))
5337 ((eq arg :scheduled*)
5338 (setq rtn (org-agenda-get-scheduled deadline-results t))
5339 (setq results (append results rtn)))
5340 ((eq arg :closed)
5341 (setq rtn (org-agenda-get-progress))
5342 (setq results (append results rtn)))
5343 ((eq arg :deadline)
5344 (setq rtn (org-agenda-get-deadlines))
5345 (setq deadline-results (copy-sequence rtn))
5346 (setq results (append results rtn)))
5347 ((eq arg :deadline*)
5348 (setq rtn (org-agenda-get-deadlines t))
5349 (setq deadline-results (copy-sequence rtn))
5350 (setq results (append results rtn))))))))
5351 results))))
5353 (defsubst org-em (x y list)
5354 "Is X or Y a member of LIST?"
5355 (or (memq x list) (memq y list)))
5357 (defvar org-heading-keyword-regexp-format) ; defined in org.el
5358 (defvar org-agenda-sorting-strategy-selected nil)
5360 (defun org-agenda-get-todos ()
5361 "Return the TODO information for agenda display."
5362 (let* ((props (list 'face nil
5363 'done-face 'org-agenda-done
5364 'org-not-done-regexp org-not-done-regexp
5365 'org-todo-regexp org-todo-regexp
5366 'org-complex-heading-regexp org-complex-heading-regexp
5367 'mouse-face 'highlight
5368 'help-echo
5369 (format "mouse-2 or RET jump to org file %s"
5370 (abbreviate-file-name buffer-file-name))))
5371 (regexp (format org-heading-keyword-regexp-format
5372 (cond
5373 ((and org-select-this-todo-keyword
5374 (equal org-select-this-todo-keyword "*"))
5375 org-todo-regexp)
5376 (org-select-this-todo-keyword
5377 (concat "\\("
5378 (mapconcat 'identity
5379 (org-split-string
5380 org-select-this-todo-keyword
5381 "|")
5382 "\\|") "\\)"))
5383 (t org-not-done-regexp))))
5384 marker priority category category-pos level tags todo-state ts-date ts-date-type
5385 ee txt beg end inherited-tags todo-state-end-pos)
5386 (goto-char (point-min))
5387 (while (re-search-forward regexp nil t)
5388 (catch :skip
5389 (save-match-data
5390 (beginning-of-line)
5391 (org-agenda-skip)
5392 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
5393 (unless (and (setq todo-state (org-get-todo-state))
5394 (setq todo-state-end-pos (match-end 2)))
5395 (goto-char end)
5396 (throw :skip nil))
5397 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
5398 (goto-char (1+ beg))
5399 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
5400 (throw :skip nil)))
5401 (goto-char (match-beginning 2))
5402 (setq marker (org-agenda-new-marker (match-beginning 0))
5403 category (org-get-category)
5404 ts-date (let (ts)
5405 (save-match-data
5406 (cond ((org-em 'scheduled-up 'scheduled-down
5407 org-agenda-sorting-strategy-selected)
5408 (setq ts (org-entry-get (point) "SCHEDULED")
5409 ts-date-type " scheduled"))
5410 ((org-em 'deadline-up 'deadline-down
5411 org-agenda-sorting-strategy-selected)
5412 (setq ts (org-entry-get (point) "DEADLINE")
5413 ts-date-type " deadline"))
5414 ((org-em 'ts-up 'ts-down
5415 org-agenda-sorting-strategy-selected)
5416 (setq ts (org-entry-get (point) "TIMESTAMP")
5417 ts-date-type " timestamp"))
5418 ((org-em 'tsia-up 'tsia-down
5419 org-agenda-sorting-strategy-selected)
5420 (setq ts (org-entry-get (point) "TIMESTAMP_IA")
5421 ts-date-type " timestamp_ia"))
5422 ((org-em 'timestamp-up 'timestamp-down
5423 org-agenda-sorting-strategy-selected)
5424 (setq ts (or (org-entry-get (point) "SCHEDULED")
5425 (org-entry-get (point) "DEADLINE")
5426 (org-entry-get (point) "TIMESTAMP")
5427 (org-entry-get (point) "TIMESTAMP_IA"))
5428 ts-date-type ""))
5429 (t (setq ts-date-type "")))
5430 (when ts (ignore-errors (org-time-string-to-absolute ts)))))
5431 category-pos (get-text-property (point) 'org-category-position)
5432 txt (org-trim
5433 (buffer-substring (match-beginning 2) (match-end 0)))
5434 inherited-tags
5435 (or (eq org-agenda-show-inherited-tags 'always)
5436 (and (listp org-agenda-show-inherited-tags)
5437 (memq 'todo org-agenda-show-inherited-tags))
5438 (and (eq org-agenda-show-inherited-tags t)
5439 (or (eq org-agenda-use-tag-inheritance t)
5440 (memq 'todo org-agenda-use-tag-inheritance))))
5441 tags (org-get-tags-at nil (not inherited-tags))
5442 level (make-string (org-reduced-level (org-outline-level)) ? )
5443 txt (org-agenda-format-item "" txt level category tags t)
5444 priority (1+ (org-get-priority txt)))
5445 (org-add-props txt props
5446 'org-marker marker 'org-hd-marker marker
5447 'priority priority 'org-category category
5448 'level level
5449 'ts-date ts-date
5450 'org-category-position category-pos
5451 'type (concat "todo" ts-date-type) 'todo-state todo-state)
5452 (push txt ee)
5453 (if org-agenda-todo-list-sublevels
5454 (goto-char todo-state-end-pos)
5455 (org-end-of-subtree 'invisible))))
5456 (nreverse ee)))
5458 (defun org-agenda-todo-custom-ignore-p (time n)
5459 "Check whether timestamp is farther away than n number of days.
5460 This function is invoked if `org-agenda-todo-ignore-deadlines',
5461 `org-agenda-todo-ignore-scheduled' or
5462 `org-agenda-todo-ignore-timestamp' is set to an integer."
5463 (let ((days (org-time-stamp-to-now
5464 time org-agenda-todo-ignore-time-comparison-use-seconds)))
5465 (if (>= n 0)
5466 (>= days n)
5467 (<= days n))))
5469 ;;;###autoload
5470 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
5471 (&optional end)
5472 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
5473 (when (or org-agenda-todo-ignore-with-date
5474 org-agenda-todo-ignore-scheduled
5475 org-agenda-todo-ignore-deadlines
5476 org-agenda-todo-ignore-timestamp)
5477 (setq end (or end (save-excursion (outline-next-heading) (point))))
5478 (save-excursion
5479 (or (and org-agenda-todo-ignore-with-date
5480 (re-search-forward org-ts-regexp end t))
5481 (and org-agenda-todo-ignore-scheduled
5482 (re-search-forward org-scheduled-time-regexp end t)
5483 (cond
5484 ((eq org-agenda-todo-ignore-scheduled 'future)
5485 (> (org-time-stamp-to-now
5486 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5487 ((eq org-agenda-todo-ignore-scheduled 'past)
5488 (<= (org-time-stamp-to-now
5489 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5490 ((numberp org-agenda-todo-ignore-scheduled)
5491 (org-agenda-todo-custom-ignore-p
5492 (match-string 1) org-agenda-todo-ignore-scheduled))
5493 (t)))
5494 (and org-agenda-todo-ignore-deadlines
5495 (re-search-forward org-deadline-time-regexp end t)
5496 (cond
5497 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
5498 ((eq org-agenda-todo-ignore-deadlines 'far)
5499 (not (org-deadline-close (match-string 1))))
5500 ((eq org-agenda-todo-ignore-deadlines 'future)
5501 (> (org-time-stamp-to-now
5502 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5503 ((eq org-agenda-todo-ignore-deadlines 'past)
5504 (<= (org-time-stamp-to-now
5505 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5506 ((numberp org-agenda-todo-ignore-deadlines)
5507 (org-agenda-todo-custom-ignore-p
5508 (match-string 1) org-agenda-todo-ignore-deadlines))
5509 (t (org-deadline-close (match-string 1)))))
5510 (and org-agenda-todo-ignore-timestamp
5511 (let ((buffer (current-buffer))
5512 (regexp
5513 (concat
5514 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
5515 (start (point)))
5516 ;; Copy current buffer into a temporary one
5517 (with-temp-buffer
5518 (insert-buffer-substring buffer start end)
5519 (goto-char (point-min))
5520 ;; Delete SCHEDULED and DEADLINE items
5521 (while (re-search-forward regexp end t)
5522 (delete-region (match-beginning 0) (match-end 0)))
5523 (goto-char (point-min))
5524 ;; No search for timestamp left
5525 (when (re-search-forward org-ts-regexp nil t)
5526 (cond
5527 ((eq org-agenda-todo-ignore-timestamp 'future)
5528 (> (org-time-stamp-to-now
5529 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5530 ((eq org-agenda-todo-ignore-timestamp 'past)
5531 (<= (org-time-stamp-to-now
5532 (match-string 1) org-agenda-todo-ignore-time-comparison-use-seconds) 0))
5533 ((numberp org-agenda-todo-ignore-timestamp)
5534 (org-agenda-todo-custom-ignore-p
5535 (match-string 1) org-agenda-todo-ignore-timestamp))
5536 (t))))))))))
5538 (defun org-agenda-get-timestamps (&optional deadline-results)
5539 "Return the date stamp information for agenda display."
5540 (let* ((props (list 'face 'org-agenda-calendar-event
5541 'org-not-done-regexp org-not-done-regexp
5542 'org-todo-regexp org-todo-regexp
5543 'org-complex-heading-regexp org-complex-heading-regexp
5544 'mouse-face 'highlight
5545 'help-echo
5546 (format "mouse-2 or RET jump to org file %s"
5547 (abbreviate-file-name buffer-file-name))))
5548 (d1 (calendar-absolute-from-gregorian date))
5550 (deadline-position-alist
5551 (mapcar (lambda (a) (and (setq mm (get-text-property
5552 0 'org-hd-marker a))
5553 (cons (marker-position mm) a)))
5554 deadline-results))
5555 (remove-re org-ts-regexp)
5556 (regexp
5557 (concat
5558 (if org-agenda-include-inactive-timestamps "[[<]" "<")
5559 (regexp-quote
5560 (substring
5561 (format-time-string
5562 (car org-time-stamp-formats)
5563 (apply 'encode-time ; DATE bound by calendar
5564 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5565 1 11))
5566 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[hdwmy]>\\)"
5567 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
5568 marker hdmarker deadlinep scheduledp clockp closedp inactivep
5569 donep tmp priority category category-pos level ee txt timestr tags
5570 b0 b3 e3 head todo-state end-of-match show-all warntime habitp
5571 inherited-tags ts-date)
5572 (goto-char (point-min))
5573 (while (setq end-of-match (re-search-forward regexp nil t))
5574 (setq b0 (match-beginning 0)
5575 b3 (match-beginning 3) e3 (match-end 3)
5576 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
5577 habitp (and (functionp 'org-is-habit-p) (save-match-data (org-is-habit-p)))
5578 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5579 (member todo-state
5580 org-agenda-repeating-timestamp-show-all)))
5581 (catch :skip
5582 (and (org-at-date-range-p) (throw :skip nil))
5583 (org-agenda-skip)
5584 (if (and (match-end 1)
5585 (not (= d1 (org-time-string-to-absolute
5586 (match-string 1) d1 nil show-all
5587 (current-buffer) b0))))
5588 (throw :skip nil))
5589 (if (and e3
5590 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
5591 (throw :skip nil))
5592 (setq tmp (buffer-substring (max (point-min)
5593 (- b0 org-ds-keyword-length))
5595 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
5596 inactivep (= (char-after b0) ?\[)
5597 deadlinep (string-match org-deadline-regexp tmp)
5598 scheduledp (string-match org-scheduled-regexp tmp)
5599 closedp (and org-agenda-include-inactive-timestamps
5600 (string-match org-closed-string tmp))
5601 clockp (and org-agenda-include-inactive-timestamps
5602 (or (string-match org-clock-string tmp)
5603 (string-match "]-+\\'" tmp)))
5604 warntime (get-text-property (point) 'org-appt-warntime)
5605 donep (member todo-state org-done-keywords))
5606 (if (or scheduledp deadlinep closedp clockp
5607 (and donep org-agenda-skip-timestamp-if-done))
5608 (throw :skip t))
5609 (if (string-match ">" timestr)
5610 ;; substring should only run to end of time stamp
5611 (setq timestr (substring timestr 0 (match-end 0))))
5612 (setq marker (org-agenda-new-marker b0)
5613 category (org-get-category b0)
5614 category-pos (get-text-property b0 'org-category-position))
5615 (save-excursion
5616 (if (not (re-search-backward org-outline-regexp-bol nil t))
5617 (throw :skip nil)
5618 (goto-char (match-beginning 0))
5619 (if (and (eq t org-agenda-skip-timestamp-if-deadline-is-shown)
5620 (assoc (point) deadline-position-alist))
5621 (throw :skip nil))
5622 (setq hdmarker (org-agenda-new-marker)
5623 inherited-tags
5624 (or (eq org-agenda-show-inherited-tags 'always)
5625 (and (listp org-agenda-show-inherited-tags)
5626 (memq 'agenda org-agenda-show-inherited-tags))
5627 (and (eq org-agenda-show-inherited-tags t)
5628 (or (eq org-agenda-use-tag-inheritance t)
5629 (memq 'agenda org-agenda-use-tag-inheritance))))
5630 tags (org-get-tags-at nil (not inherited-tags))
5631 level (make-string (org-reduced-level (org-outline-level)) ? ))
5632 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5633 (setq head (or (match-string 1) ""))
5634 (setq txt (org-agenda-format-item
5635 (if inactivep org-agenda-inactive-leader nil)
5636 head level category tags timestr
5637 remove-re habitp)))
5638 (setq priority (org-get-priority txt))
5639 (org-add-props txt props 'priority priority
5640 'org-marker marker 'org-hd-marker hdmarker
5641 'org-category category 'date date
5642 'level level
5643 'ts-date
5644 (ignore-errors (org-time-string-to-absolute timestr))
5645 'org-category-position category-pos
5646 'todo-state todo-state
5647 'warntime warntime
5648 'type "timestamp")
5649 (push txt ee))
5650 (if org-agenda-skip-additional-timestamps-same-entry
5651 (outline-next-heading)
5652 (goto-char end-of-match))))
5653 (nreverse ee)))
5655 (defun org-agenda-get-sexps ()
5656 "Return the sexp information for agenda display."
5657 (require 'diary-lib)
5658 (let* ((props (list 'face 'org-agenda-calendar-sexp
5659 'mouse-face 'highlight
5660 'help-echo
5661 (format "mouse-2 or RET jump to org file %s"
5662 (abbreviate-file-name buffer-file-name))))
5663 (regexp "^&?%%(")
5664 marker category extra category-pos level ee txt tags entry
5665 result beg b sexp sexp-entry todo-state warntime inherited-tags)
5666 (goto-char (point-min))
5667 (while (re-search-forward regexp nil t)
5668 (catch :skip
5669 (org-agenda-skip)
5670 (setq beg (match-beginning 0))
5671 (goto-char (1- (match-end 0)))
5672 (setq b (point))
5673 (forward-sexp 1)
5674 (setq sexp (buffer-substring b (point)))
5675 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5676 (org-trim (match-string 1))
5677 ""))
5678 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5679 (when result
5680 (setq marker (org-agenda-new-marker beg)
5681 level (make-string (org-reduced-level (org-outline-level)) ? )
5682 category (org-get-category beg)
5683 category-pos (get-text-property beg 'org-category-position)
5684 inherited-tags
5685 (or (eq org-agenda-show-inherited-tags 'always)
5686 (and (listp org-agenda-show-inherited-tags)
5687 (memq 'agenda org-agenda-show-inherited-tags))
5688 (and (eq org-agenda-show-inherited-tags t)
5689 (or (eq org-agenda-use-tag-inheritance t)
5690 (memq 'agenda org-agenda-use-tag-inheritance))))
5691 tags (org-get-tags-at nil (not inherited-tags))
5692 todo-state (org-get-todo-state)
5693 warntime (get-text-property (point) 'org-appt-warntime)
5694 extra nil)
5696 (dolist (r (if (stringp result)
5697 (list result)
5698 result)) ;; we expect a list here
5699 (when (and org-agenda-diary-sexp-prefix
5700 (string-match org-agenda-diary-sexp-prefix r))
5701 (setq extra (match-string 0 r)
5702 r (replace-match "" nil nil r)))
5703 (if (string-match "\\S-" r)
5704 (setq txt r)
5705 (setq txt "SEXP entry returned empty string"))
5706 (setq txt (org-agenda-format-item extra txt level category tags 'time))
5707 (org-add-props txt props 'org-marker marker
5708 'org-category category 'date date 'todo-state todo-state
5709 'org-category-position category-pos 'tags tags
5710 'level level
5711 'type "sexp" 'warntime warntime)
5712 (push txt ee)))))
5713 (nreverse ee)))
5715 ;; Calendar sanity: define some functions that are independent of
5716 ;; `calendar-date-style'.
5717 ;; Normally I would like to use ISO format when calling the diary functions,
5718 ;; but to make sure we still have Emacs 22 compatibility we bind
5719 ;; also `european-calendar-style' and use european format
5720 (defun org-anniversary (year month day &optional mark)
5721 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5722 (org-no-warnings
5723 (let ((calendar-date-style 'european) (european-calendar-style t))
5724 (diary-anniversary day month year mark))))
5725 (defun org-cyclic (N year month day &optional mark)
5726 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5727 (org-no-warnings
5728 (let ((calendar-date-style 'european) (european-calendar-style t))
5729 (diary-cyclic N day month year mark))))
5730 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5731 "Like `diary-block', but with fixed (ISO) order of arguments."
5732 (org-no-warnings
5733 (let ((calendar-date-style 'european) (european-calendar-style t))
5734 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5735 (defun org-date (year month day &optional mark)
5736 "Like `diary-date', but with fixed (ISO) order of arguments."
5737 (org-no-warnings
5738 (let ((calendar-date-style 'european) (european-calendar-style t))
5739 (diary-date day month year mark))))
5741 ;; Define the` org-class' function
5742 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5743 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5744 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5745 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5746 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5747 `holidays', then any date that is known by the Emacs calendar to be a
5748 holiday will also be skipped. If SKIP-WEEKS arguments are holiday strings,
5749 then those holidays will be skipped."
5750 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5751 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5752 (d (calendar-absolute-from-gregorian date))
5753 (h (when skip-weeks (calendar-check-holidays date))))
5754 (and
5755 (<= date1 d)
5756 (<= d date2)
5757 (= (calendar-day-of-week date) dayname)
5758 (or (not skip-weeks)
5759 (progn
5760 (require 'cal-iso)
5761 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5762 (not (or (and h (memq 'holidays skip-weeks))
5763 (delq nil (mapcar (lambda(g) (member g skip-weeks)) h))))
5764 entry)))
5766 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5767 "Like `org-class', but honor `calendar-date-style'.
5768 The order of the first 2 times 3 arguments depends on the variable
5769 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5770 So for American calendars, give this as MONTH DAY YEAR, for European as
5771 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5772 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5773 is any number of ISO weeks in the block period for which the item should
5774 be skipped.
5776 This function is here only for backward compatibility and it is deprecated,
5777 please use `org-class' instead."
5778 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5779 (date2 (org-order-calendar-date-args m2 d2 y2)))
5780 (org-class
5781 (nth 2 date1) (car date1) (nth 1 date1)
5782 (nth 2 date2) (car date2) (nth 1 date2)
5783 dayname skip-weeks)))
5784 (make-obsolete 'org-diary-class 'org-class "")
5786 (defalias 'org-get-closed 'org-agenda-get-progress)
5787 (defun org-agenda-get-progress ()
5788 "Return the logged TODO entries for agenda display."
5789 (let* ((props (list 'mouse-face 'highlight
5790 'org-not-done-regexp org-not-done-regexp
5791 'org-todo-regexp org-todo-regexp
5792 'org-complex-heading-regexp org-complex-heading-regexp
5793 'help-echo
5794 (format "mouse-2 or RET jump to org file %s"
5795 (abbreviate-file-name buffer-file-name))))
5796 (items (if (consp org-agenda-show-log-scoped)
5797 org-agenda-show-log-scoped
5798 (if (eq org-agenda-show-log-scoped 'clockcheck)
5799 '(clock)
5800 org-agenda-log-mode-items)))
5801 (parts
5802 (delq nil
5803 (list
5804 (if (memq 'closed items) (concat "\\<" org-closed-string))
5805 (if (memq 'clock items) (concat "\\<" org-clock-string))
5806 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5807 (parts-re (if parts (mapconcat 'identity parts "\\|")
5808 (error "`org-agenda-log-mode-items' is empty")))
5809 (regexp (concat
5810 "\\(" parts-re "\\)"
5811 " *\\["
5812 (regexp-quote
5813 (substring
5814 (format-time-string
5815 (car org-time-stamp-formats)
5816 (apply 'encode-time ; DATE bound by calendar
5817 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5818 1 11))))
5819 (org-agenda-search-headline-for-time nil)
5820 marker hdmarker priority category category-pos level tags closedp
5821 statep clockp state ee txt extra timestr rest clocked inherited-tags)
5822 (goto-char (point-min))
5823 (while (re-search-forward regexp nil t)
5824 (catch :skip
5825 (org-agenda-skip)
5826 (setq marker (org-agenda-new-marker (match-beginning 0))
5827 closedp (equal (match-string 1) org-closed-string)
5828 statep (equal (string-to-char (match-string 1)) ?-)
5829 clockp (not (or closedp statep))
5830 state (and statep (match-string 2))
5831 category (org-get-category (match-beginning 0))
5832 category-pos (get-text-property (match-beginning 0) 'org-category-position)
5833 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5834 (when (string-match "\\]" timestr)
5835 ;; substring should only run to end of time stamp
5836 (setq rest (substring timestr (match-end 0))
5837 timestr (substring timestr 0 (match-end 0)))
5838 (if (and (not closedp) (not statep)
5839 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5840 rest))
5841 (progn (setq timestr (concat (substring timestr 0 -1)
5842 "-" (match-string 1 rest) "]"))
5843 (setq clocked (match-string 2 rest)))
5844 (setq clocked "-")))
5845 (save-excursion
5846 (setq extra
5847 (cond
5848 ((not org-agenda-log-mode-add-notes) nil)
5849 (statep
5850 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5851 (match-string 1)))
5852 (clockp
5853 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5854 (match-string 1)))))
5855 (if (not (re-search-backward org-outline-regexp-bol nil t))
5856 (throw :skip nil)
5857 (goto-char (match-beginning 0))
5858 (setq hdmarker (org-agenda-new-marker)
5859 inherited-tags
5860 (or (eq org-agenda-show-inherited-tags 'always)
5861 (and (listp org-agenda-show-inherited-tags)
5862 (memq 'todo org-agenda-show-inherited-tags))
5863 (and (eq org-agenda-show-inherited-tags t)
5864 (or (eq org-agenda-use-tag-inheritance t)
5865 (memq 'todo org-agenda-use-tag-inheritance))))
5866 tags (org-get-tags-at nil (not inherited-tags))
5867 level (make-string (org-reduced-level (org-outline-level)) ? ))
5868 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5869 (setq txt (match-string 1))
5870 (when extra
5871 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5872 (setq txt (concat (substring txt 0 (match-beginning 1))
5873 " - " extra " " (match-string 2 txt)))
5874 (setq txt (concat txt " - " extra))))
5875 (setq txt (org-agenda-format-item
5876 (cond
5877 (closedp "Closed: ")
5878 (statep (concat "State: (" state ")"))
5879 (t (concat "Clocked: (" clocked ")")))
5880 txt level category tags timestr)))
5881 (setq priority 100000)
5882 (org-add-props txt props
5883 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5884 'priority priority 'org-category category
5885 'org-category-position category-pos
5886 'level level
5887 'type "closed" 'date date
5888 'undone-face 'org-warning 'done-face 'org-agenda-done)
5889 (push txt ee))
5890 (goto-char (point-at-eol))))
5891 (nreverse ee)))
5893 (defun org-agenda-show-clocking-issues ()
5894 "Add overlays, showing issues with clocking.
5895 See also the user option `org-agenda-clock-consistency-checks'."
5896 (interactive)
5897 (let* ((org-time-clocksum-use-effort-durations nil)
5898 (pl org-agenda-clock-consistency-checks)
5899 (re (concat "^[ \t]*"
5900 org-clock-string
5901 "[ \t]+"
5902 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5903 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5904 (tlstart 0.)
5905 (tlend 0.)
5906 (maxtime (org-hh:mm-string-to-minutes
5907 (or (plist-get pl :max-duration) "24:00")))
5908 (mintime (org-hh:mm-string-to-minutes
5909 (or (plist-get pl :min-duration) 0)))
5910 (maxgap (org-hh:mm-string-to-minutes
5911 ;; default 30:00 means never complain
5912 (or (plist-get pl :max-gap) "30:00")))
5913 (gapok (mapcar 'org-hh:mm-string-to-minutes
5914 (plist-get pl :gap-ok-around)))
5915 (def-face (or (plist-get pl :default-face)
5916 '((:background "DarkRed") (:foreground "white"))))
5917 issue face m te ts dt ov)
5918 (goto-char (point-min))
5919 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5920 (setq issue nil face def-face)
5921 (catch 'next
5922 (setq m (org-get-at-bol 'org-marker)
5923 te nil ts nil)
5924 (unless (and m (markerp m))
5925 (setq issue "No valid clock line") (throw 'next t))
5926 (org-with-point-at m
5927 (save-excursion
5928 (goto-char (point-at-bol))
5929 (unless (looking-at re)
5930 (error "No valid Clock line")
5931 (throw 'next t))
5932 (unless (match-end 3)
5933 (setq issue "No end time"
5934 face (or (plist-get pl :no-end-time-face) face))
5935 (throw 'next t))
5936 (setq ts (match-string 1)
5937 te (match-string 3)
5938 ts (org-float-time
5939 (apply 'encode-time (org-parse-time-string ts)))
5940 te (org-float-time
5941 (apply 'encode-time (org-parse-time-string te)))
5942 dt (- te ts))))
5943 (cond
5944 ((> dt (* 60 maxtime))
5945 ;; a very long clocking chunk
5946 (setq issue (format "Clocking interval is very long: %s"
5947 (org-minutes-to-clocksum-string
5948 (floor (/ (float dt) 60.))))
5949 face (or (plist-get pl :long-face) face)))
5950 ((< dt (* 60 mintime))
5951 ;; a very short clocking chunk
5952 (setq issue (format "Clocking interval is very short: %s"
5953 (org-minutes-to-clocksum-string
5954 (floor (/ (float dt) 60.))))
5955 face (or (plist-get pl :short-face) face)))
5956 ((and (> tlend 0) (< ts tlend))
5957 ;; Two clock entries are overlapping
5958 (setq issue (format "Clocking overlap: %d minutes"
5959 (/ (- tlend ts) 60))
5960 face (or (plist-get pl :overlap-face) face)))
5961 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5962 ;; There is a gap, lets see if we need to report it
5963 (unless (org-agenda-check-clock-gap tlend ts gapok)
5964 (setq issue (format "Clocking gap: %d minutes"
5965 (/ (- ts tlend) 60))
5966 face (or (plist-get pl :gap-face) face))))
5967 (t nil)))
5968 (setq tlend (or te tlend) tlstart (or ts tlstart))
5969 (when issue
5970 ;; OK, there was some issue, add an overlay to show the issue
5971 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5972 (overlay-put ov 'before-string
5973 (concat
5974 (org-add-props
5975 (format "%-43s" (concat " " issue))
5977 'face face)
5978 "\n"))
5979 (overlay-put ov 'evaporate t)))))
5981 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5982 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5983 (catch 'exit
5984 (unless ok-list
5985 ;; there are no OK times for gaps...
5986 (throw 'exit nil))
5987 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5988 ;; This is more than 24 hours, so it is OK.
5989 ;; because we have at least one OK time, that must be in the
5990 ;; 24 hour interval.
5991 (throw 'exit t))
5992 ;; We have a shorter gap.
5993 ;; Now we have to get the minute of the day when these times are
5994 (let* ((t1dec (decode-time (seconds-to-time t1)))
5995 (t2dec (decode-time (seconds-to-time t2)))
5996 ;; compute the minute on the day
5997 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5998 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5999 (when (< min2 min1)
6000 ;; if min2 is smaller than min1, this means it is on the next day.
6001 ;; Wrap it to after midnight.
6002 (setq min2 (+ min2 1440)))
6003 ;; Now check if any of the OK times is in the gap
6004 (mapc (lambda (x)
6005 ;; Wrap the time to after midnight if necessary
6006 (if (< x min1) (setq x (+ x 1440)))
6007 ;; Check if in interval
6008 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
6009 ok-list)
6010 ;; Nope, this gap is not OK
6011 nil)))
6013 (defun org-agenda-get-deadlines (&optional with-hour)
6014 "Return the deadline information for agenda display.
6015 When WITH-HOUR is non-nil, only return deadlines with an hour
6016 specification like [h]h:mm."
6017 (let* ((props (list 'mouse-face 'highlight
6018 'org-not-done-regexp org-not-done-regexp
6019 'org-todo-regexp org-todo-regexp
6020 'org-complex-heading-regexp org-complex-heading-regexp
6021 'help-echo
6022 (format "mouse-2 or RET jump to org file %s"
6023 (abbreviate-file-name buffer-file-name))))
6024 (regexp (if with-hour
6025 org-deadline-time-hour-regexp
6026 org-deadline-time-regexp))
6027 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6028 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6029 (dl0 (car org-agenda-deadline-leaders))
6030 (dl1 (nth 1 org-agenda-deadline-leaders))
6031 (dl2 (or (nth 2 org-agenda-deadline-leaders) dl1))
6032 d2 diff dfrac wdays pos pos1 category category-pos level
6033 tags suppress-prewarning ee txt head face s todo-state
6034 show-all upcomingp donep timestr warntime inherited-tags ts-date)
6035 (goto-char (point-min))
6036 (while (re-search-forward regexp nil t)
6037 (catch :skip
6038 (org-agenda-skip)
6039 (setq s (match-string 1)
6040 txt nil
6041 pos (1- (match-beginning 1))
6042 todo-state (save-match-data (org-get-todo-state))
6043 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6044 (member todo-state
6045 org-agenda-repeating-timestamp-show-all))
6046 d2 (org-time-string-to-absolute
6047 s d1 'past show-all (current-buffer) pos)
6048 diff (- d2 d1))
6049 (setq suppress-prewarning
6050 (let ((ds (and org-agenda-skip-deadline-prewarning-if-scheduled
6051 (let ((item (buffer-substring (point-at-bol)
6052 (point-at-eol))))
6053 (save-match-data
6054 (and (string-match
6055 org-scheduled-time-regexp item)
6056 (match-string 1 item)))))))
6057 (cond
6058 ((not ds) nil)
6059 ;; The current item has a scheduled date (in ds), so
6060 ;; evaluate its prewarning lead time.
6061 ((integerp org-agenda-skip-deadline-prewarning-if-scheduled)
6062 ;; Use global prewarning-restart lead time.
6063 org-agenda-skip-deadline-prewarning-if-scheduled)
6064 ((eq org-agenda-skip-deadline-prewarning-if-scheduled
6065 'pre-scheduled)
6066 ;; Set prewarning to no earlier than scheduled.
6067 (min (- d2 (org-time-string-to-absolute
6068 ds d1 'past show-all (current-buffer) pos))
6069 org-deadline-warning-days))
6070 ;; Set prewarning to deadline.
6071 (t 0))))
6072 (setq wdays (if suppress-prewarning
6073 (let ((org-deadline-warning-days suppress-prewarning))
6074 (org-get-wdays s))
6075 (org-get-wdays s))
6076 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
6077 upcomingp (and todayp (> diff 0)))
6078 ;; When to show a deadline in the calendar:
6079 ;; If the expiration is within wdays warning time.
6080 ;; Past-due deadlines are only shown on the current date
6081 (if (and (or (and (<= diff wdays)
6082 (and todayp (not org-agenda-only-exact-dates)))
6083 (= diff 0)))
6084 (save-excursion
6085 ;; (setq todo-state (org-get-todo-state))
6086 (setq donep (member todo-state org-done-keywords))
6087 (if (and donep
6088 (or org-agenda-skip-deadline-if-done
6089 (not (= diff 0))))
6090 (setq txt nil)
6091 (setq category (org-get-category)
6092 warntime (get-text-property (point) 'org-appt-warntime)
6093 category-pos (get-text-property (point) 'org-category-position))
6094 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6095 (throw :skip nil)
6096 (goto-char (match-end 0))
6097 (setq pos1 (match-beginning 0))
6098 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6099 (setq inherited-tags
6100 (or (eq org-agenda-show-inherited-tags 'always)
6101 (and (listp org-agenda-show-inherited-tags)
6102 (memq 'agenda org-agenda-show-inherited-tags))
6103 (and (eq org-agenda-show-inherited-tags t)
6104 (or (eq org-agenda-use-tag-inheritance t)
6105 (memq 'agenda org-agenda-use-tag-inheritance))))
6106 tags (org-get-tags-at pos1 (not inherited-tags)))
6107 (setq head (buffer-substring
6108 (point)
6109 (progn (skip-chars-forward "^\r\n")
6110 (point))))
6111 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6112 (setq timestr
6113 (concat (substring s (match-beginning 1)) " "))
6114 (setq timestr 'time))
6115 (setq txt (org-agenda-format-item
6116 (cond ((= diff 0) dl0)
6117 ((> diff 0)
6118 (if (functionp dl1)
6119 (funcall dl1 diff date)
6120 (format dl1 diff)))
6122 (if (functionp dl2)
6123 (funcall dl2 diff date)
6124 (format dl2 (if (string= dl2 dl1)
6125 diff (abs diff))))))
6126 head level category tags
6127 (if (not (= diff 0)) nil timestr)))))
6128 (when txt
6129 (setq face (org-agenda-deadline-face dfrac))
6130 (org-add-props txt props
6131 'org-marker (org-agenda-new-marker pos)
6132 'warntime warntime
6133 'level level
6134 'ts-date d2
6135 'org-hd-marker (org-agenda-new-marker pos1)
6136 'priority (+ (- diff)
6137 (org-get-priority txt))
6138 'org-category category
6139 'org-category-position category-pos
6140 'todo-state todo-state
6141 'type (if upcomingp "upcoming-deadline" "deadline")
6142 'date (if upcomingp date d2)
6143 'face (if donep 'org-agenda-done face)
6144 'undone-face face 'done-face 'org-agenda-done)
6145 (push txt ee))))))
6146 (nreverse ee)))
6148 (defun org-agenda-deadline-face (fraction)
6149 "Return the face to displaying a deadline item.
6150 FRACTION is what fraction of the head-warning time has passed."
6151 (let ((faces org-agenda-deadline-faces) f)
6152 (catch 'exit
6153 (while (setq f (pop faces))
6154 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
6156 (defun org-agenda-get-scheduled (&optional deadline-results with-hour)
6157 "Return the scheduled information for agenda display.
6158 When WITH-HOUR is non-nil, only return scheduled items with
6159 an hour specification like [h]h:mm."
6160 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
6161 'org-todo-regexp org-todo-regexp
6162 'org-complex-heading-regexp org-complex-heading-regexp
6163 'done-face 'org-agenda-done
6164 'mouse-face 'highlight
6165 'help-echo
6166 (format "mouse-2 or RET jump to org file %s"
6167 (abbreviate-file-name buffer-file-name))))
6168 (regexp (if with-hour
6169 org-scheduled-time-hour-regexp
6170 org-scheduled-time-regexp))
6171 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
6172 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
6174 (deadline-position-alist
6175 (mapcar (lambda (a) (and (setq mm (get-text-property
6176 0 'org-hd-marker a))
6177 (cons (marker-position mm) a)))
6178 deadline-results))
6179 d2 diff pos pos1 category category-pos level tags donep
6180 ee txt head pastschedp todo-state face timestr s habitp show-all
6181 did-habit-check-p warntime inherited-tags ts-date suppress-delay
6182 ddays)
6183 (goto-char (point-min))
6184 (while (re-search-forward regexp nil t)
6185 (catch :skip
6186 (org-agenda-skip)
6187 (setq s (match-string 1)
6188 txt nil
6189 pos (1- (match-beginning 1))
6190 todo-state (save-match-data (org-get-todo-state))
6191 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
6192 (member todo-state
6193 org-agenda-repeating-timestamp-show-all))
6194 d2 (org-time-string-to-absolute
6195 s d1 'past show-all (current-buffer) pos)
6196 diff (- d2 d1)
6197 warntime (get-text-property (point) 'org-appt-warntime))
6198 (setq pastschedp (and todayp (< diff 0)))
6199 (setq did-habit-check-p nil)
6200 (setq suppress-delay
6201 (let ((ds (and org-agenda-skip-scheduled-delay-if-deadline
6202 (let ((item (buffer-substring (point-at-bol) (point-at-eol))))
6203 (save-match-data
6204 (and (string-match
6205 org-deadline-time-regexp item)
6206 (match-string 1 item)))))))
6207 (cond
6208 ((not ds) nil)
6209 ;; The current item has a deadline date (in ds), so
6210 ;; evaluate its delay time.
6211 ((integerp org-agenda-skip-scheduled-delay-if-deadline)
6212 ;; Use global delay time.
6213 (- org-agenda-skip-scheduled-delay-if-deadline))
6214 ((eq org-agenda-skip-scheduled-delay-if-deadline
6215 'post-deadline)
6216 ;; Set delay to no later than deadline.
6217 (min (- d2 (org-time-string-to-absolute
6218 ds d1 'past show-all (current-buffer) pos))
6219 org-scheduled-delay-days))
6220 (t 0))))
6221 (setq ddays (if suppress-delay
6222 (let ((org-scheduled-delay-days suppress-delay))
6223 (org-get-wdays s t t))
6224 (org-get-wdays s t)))
6225 ;; Use a delay of 0 when there is a repeater and the delay is
6226 ;; of the form --3d
6227 (when (and (save-match-data (string-match "--[0-9]+[hdwmy]" s))
6228 (< (org-time-string-to-absolute s)
6229 (org-time-string-to-absolute
6230 s d2 'past nil (current-buffer) pos)))
6231 (setq ddays 0))
6232 ;; When to show a scheduled item in the calendar:
6233 ;; If it is on or past the date.
6234 (when (or (and (> ddays 0) (= diff (- ddays)))
6235 (and (zerop ddays) (= diff 0))
6236 (and (< (+ diff ddays) 0)
6237 (< (abs diff) org-scheduled-past-days)
6238 (and todayp (not org-agenda-only-exact-dates)))
6239 ;; org-is-habit-p uses org-entry-get, which is expansive
6240 ;; so we go extra mile to only call it once
6241 (and todayp
6242 (boundp 'org-habit-show-all-today)
6243 org-habit-show-all-today
6244 (setq did-habit-check-p t)
6245 (setq habitp (and (functionp 'org-is-habit-p)
6246 (org-is-habit-p)))))
6247 (save-excursion
6248 (setq donep (member todo-state org-done-keywords))
6249 (if (and donep
6250 (or org-agenda-skip-scheduled-if-done
6251 (not (= diff 0))
6252 (and (functionp 'org-is-habit-p)
6253 (org-is-habit-p))))
6254 (setq txt nil)
6255 (setq habitp (if did-habit-check-p habitp
6256 (and (functionp 'org-is-habit-p)
6257 (org-is-habit-p))))
6258 (setq category (org-get-category)
6259 category-pos (get-text-property (point) 'org-category-position))
6260 (if (and (eq org-agenda-skip-scheduled-if-deadline-is-shown
6261 'repeated-after-deadline)
6262 (org-get-deadline-time (point))
6263 (<= 0 (- d2 (time-to-days (org-get-deadline-time (point))))))
6264 (throw :skip nil))
6265 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
6266 (throw :skip nil)
6267 (goto-char (match-end 0))
6268 (setq pos1 (match-beginning 0))
6269 (if habitp
6270 (if (or (not org-habit-show-habits)
6271 (and (not todayp)
6272 (boundp 'org-habit-show-habits-only-for-today)
6273 org-habit-show-habits-only-for-today))
6274 (throw :skip nil))
6275 (if (and
6276 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
6277 (and (eq org-agenda-skip-scheduled-if-deadline-is-shown 'not-today)
6278 pastschedp))
6279 (setq mm (assoc pos1 deadline-position-alist)))
6280 (throw :skip nil)))
6281 (setq inherited-tags
6282 (or (eq org-agenda-show-inherited-tags 'always)
6283 (and (listp org-agenda-show-inherited-tags)
6284 (memq 'agenda org-agenda-show-inherited-tags))
6285 (and (eq org-agenda-show-inherited-tags t)
6286 (or (eq org-agenda-use-tag-inheritance t)
6287 (memq 'agenda org-agenda-use-tag-inheritance))))
6289 tags (org-get-tags-at nil (not inherited-tags)))
6290 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6291 (setq head (buffer-substring
6292 (point)
6293 (progn (skip-chars-forward "^\r\n") (point))))
6294 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
6295 (setq timestr
6296 (concat (substring s (match-beginning 1)) " "))
6297 (setq timestr 'time))
6298 (setq txt (org-agenda-format-item
6299 (if (= diff 0)
6300 (car org-agenda-scheduled-leaders)
6301 (format (nth 1 org-agenda-scheduled-leaders)
6302 (- 1 diff)))
6303 head level category tags
6304 (if (not (= diff 0)) nil timestr)
6305 nil habitp))))
6306 (when txt
6307 (setq face
6308 (cond
6309 ((and (not habitp) pastschedp)
6310 'org-scheduled-previously)
6311 (todayp 'org-scheduled-today)
6312 (t 'org-scheduled))
6313 habitp (and habitp (org-habit-parse-todo)))
6314 (org-add-props txt props
6315 'undone-face face
6316 'face (if donep 'org-agenda-done face)
6317 'org-marker (org-agenda-new-marker pos)
6318 'org-hd-marker (org-agenda-new-marker pos1)
6319 'type (if pastschedp "past-scheduled" "scheduled")
6320 'date (if pastschedp d2 date)
6321 'ts-date d2
6322 'warntime warntime
6323 'level level
6324 'priority (if habitp
6325 (org-habit-get-priority habitp)
6326 (+ 94 (- 5 diff) (org-get-priority txt)))
6327 'org-category category
6328 'category-position category-pos
6329 'org-habit-p habitp
6330 'todo-state todo-state)
6331 (push txt ee))))))
6332 (nreverse ee)))
6334 (defun org-agenda-get-blocks ()
6335 "Return the date-range information for agenda display."
6336 (let* ((props (list 'face nil
6337 'org-not-done-regexp org-not-done-regexp
6338 'org-todo-regexp org-todo-regexp
6339 'org-complex-heading-regexp org-complex-heading-regexp
6340 'mouse-face 'highlight
6341 'help-echo
6342 (format "mouse-2 or RET jump to org file %s"
6343 (abbreviate-file-name buffer-file-name))))
6344 (regexp org-tr-regexp)
6345 (d0 (calendar-absolute-from-gregorian date))
6346 marker hdmarker ee txt d1 d2 s1 s2 category category-pos
6347 level todo-state tags pos head donep inherited-tags)
6348 (goto-char (point-min))
6349 (while (re-search-forward regexp nil t)
6350 (catch :skip
6351 (org-agenda-skip)
6352 (setq pos (point))
6353 (let ((start-time (match-string 1))
6354 (end-time (match-string 2)))
6355 (setq s1 (match-string 1)
6356 s2 (match-string 2)
6357 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
6358 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
6359 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
6360 ;; Only allow days between the limits, because the normal
6361 ;; date stamps will catch the limits.
6362 (save-excursion
6363 (setq todo-state (org-get-todo-state))
6364 (setq donep (member todo-state org-done-keywords))
6365 (if (and donep org-agenda-skip-timestamp-if-done)
6366 (throw :skip t))
6367 (setq marker (org-agenda-new-marker (point)))
6368 (setq category (org-get-category)
6369 category-pos (get-text-property (point) 'org-category-position))
6370 (if (not (re-search-backward org-outline-regexp-bol nil t))
6371 (throw :skip nil)
6372 (goto-char (match-beginning 0))
6373 (setq hdmarker (org-agenda-new-marker (point))
6374 inherited-tags
6375 (or (eq org-agenda-show-inherited-tags 'always)
6376 (and (listp org-agenda-show-inherited-tags)
6377 (memq 'agenda org-agenda-show-inherited-tags))
6378 (and (eq org-agenda-show-inherited-tags t)
6379 (or (eq org-agenda-use-tag-inheritance t)
6380 (memq 'agenda org-agenda-use-tag-inheritance))))
6382 tags (org-get-tags-at nil (not inherited-tags)))
6383 (setq level (make-string (org-reduced-level (org-outline-level)) ? ))
6384 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
6385 (setq head (match-string 1))
6386 (let ((remove-re
6387 (if org-agenda-remove-timeranges-from-blocks
6388 (concat
6389 "<" (regexp-quote s1) ".*?>"
6390 "--"
6391 "<" (regexp-quote s2) ".*?>")
6392 nil)))
6393 (setq txt (org-agenda-format-item
6394 (format
6395 (nth (if (= d1 d2) 0 1)
6396 org-agenda-timerange-leaders)
6397 (1+ (- d0 d1)) (1+ (- d2 d1)))
6398 head level category tags
6399 (cond ((and (= d1 d0) (= d2 d0))
6400 (concat "<" start-time ">--<" end-time ">"))
6401 ((= d1 d0)
6402 (concat "<" start-time ">"))
6403 ((= d2 d0)
6404 (concat "<" end-time ">")))
6405 remove-re))))
6406 (org-add-props txt props
6407 'org-marker marker 'org-hd-marker hdmarker
6408 'type "block" 'date date
6409 'level level
6410 'todo-state todo-state
6411 'priority (org-get-priority txt) 'org-category category
6412 'org-category-position category-pos)
6413 (push txt ee))))
6414 (goto-char pos)))
6415 ;; Sort the entries by expiration date.
6416 (nreverse ee)))
6418 ;;; Agenda presentation and sorting
6420 (defvar org-prefix-has-time nil
6421 "A flag, set by `org-compile-prefix-format'.
6422 The flag is set if the currently compiled format contains a `%t'.")
6423 (defvar org-prefix-has-tag nil
6424 "A flag, set by `org-compile-prefix-format'.
6425 The flag is set if the currently compiled format contains a `%T'.")
6426 (defvar org-prefix-has-effort nil
6427 "A flag, set by `org-compile-prefix-format'.
6428 The flag is set if the currently compiled format contains a `%e'.")
6429 (defvar org-prefix-has-breadcrumbs nil
6430 "A flag, set by `org-compile-prefix-format'.
6431 The flag is set if the currently compiled format contains a `%b'.")
6432 (defvar org-prefix-category-length nil
6433 "Used by `org-compile-prefix-format' to remember the category field width.")
6434 (defvar org-prefix-category-max-length nil
6435 "Used by `org-compile-prefix-format' to remember the category field width.")
6437 (defun org-agenda-get-category-icon (category)
6438 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
6439 (dolist (entry org-agenda-category-icon-alist)
6440 (when (org-string-match-p (car entry) category)
6441 (if (listp (cadr entry))
6442 (return (cadr entry))
6443 (return (apply 'create-image (cdr entry)))))))
6445 (defun org-agenda-format-item (extra txt &optional level category tags dotime
6446 remove-re habitp)
6447 "Format TXT to be inserted into the agenda buffer.
6448 In particular, add the prefix and corresponding text properties.
6450 EXTRA must be a string to replace the `%s' specifier in the prefix format.
6451 LEVEL may be a string to replace the `%l' specifier.
6452 CATEGORY (a string, a symbol or nil) may be used to overrule the default
6453 category taken from local variable or file name. It will replace the `%c'
6454 specifier in the format.
6455 DOTIME, when non-nil, indicates that a time-of-day should be extracted from
6456 TXT for sorting of this entry, and for the `%t' specifier in the format.
6457 When DOTIME is a string, this string is searched for a time before TXT is.
6458 TAGS can be the tags of the headline.
6459 Any match of REMOVE-RE will be removed from TXT."
6460 ;; We keep the org-prefix-* variable values along with a compiled
6461 ;; formatter, so that multiple agendas existing at the same time do
6462 ;; not step on each other toes.
6464 ;; It was inconvenient to make these variables buffer local in
6465 ;; Agenda buffers, because this function expects to be called with
6466 ;; the buffer where item comes from being current, and not agenda
6467 ;; buffer
6468 (let* ((bindings (car org-prefix-format-compiled))
6469 (formatter (cadr org-prefix-format-compiled)))
6470 (loop for (var value) in bindings
6471 do (set var value))
6472 (save-match-data
6473 ;; Diary entries sometimes have extra whitespace at the beginning
6474 (setq txt (org-trim txt))
6476 ;; Fix the tags part in txt
6477 (setq txt (org-agenda-fix-displayed-tags
6478 txt tags
6479 org-agenda-show-inherited-tags
6480 org-agenda-hide-tags-regexp))
6482 (let* ((category (or category
6483 (if (stringp org-category)
6484 org-category
6485 (and org-category (symbol-name org-category)))
6486 (if buffer-file-name
6487 (file-name-sans-extension
6488 (file-name-nondirectory buffer-file-name))
6489 "")))
6490 (category-icon (org-agenda-get-category-icon category))
6491 (category-icon (if category-icon
6492 (propertize " " 'display category-icon)
6493 ""))
6494 ;; time, tag, effort are needed for the eval of the prefix format
6495 (tag (if tags (nth (1- (length tags)) tags) ""))
6496 time effort neffort
6497 (ts (if dotime (concat
6498 (if (stringp dotime) dotime "")
6499 (and org-agenda-search-headline-for-time txt))))
6500 (time-of-day (and dotime (org-get-time-of-day ts)))
6501 stamp plain s0 s1 s2 rtn srp l
6502 duration thecategory breadcrumbs)
6503 (and (derived-mode-p 'org-mode) buffer-file-name
6504 (add-to-list 'org-agenda-contributing-files buffer-file-name))
6505 (when (and dotime time-of-day)
6506 ;; Extract starting and ending time and move them to prefix
6507 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
6508 (setq plain (string-match org-plain-time-of-day-regexp ts)))
6509 (setq s0 (match-string 0 ts)
6510 srp (and stamp (match-end 3))
6511 s1 (match-string (if plain 1 2) ts)
6512 s2 (match-string (if plain 8 (if srp 4 6)) ts))
6514 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
6515 ;; them, we might want to remove them there to avoid duplication.
6516 ;; The user can turn this off with a variable.
6517 (if (and org-prefix-has-time
6518 org-agenda-remove-times-when-in-prefix (or stamp plain)
6519 (string-match (concat (regexp-quote s0) " *") txt)
6520 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
6521 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
6522 (= (match-beginning 0) 0)
6524 (setq txt (replace-match "" nil nil txt))))
6525 ;; Normalize the time(s) to 24 hour
6526 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
6527 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
6529 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
6530 (let (org-time-clocksum-use-effort-durations)
6531 (when (and s1 (not s2) org-agenda-default-appointment-duration)
6532 (setq s2
6533 (org-minutes-to-clocksum-string
6534 (+ (org-hh:mm-string-to-minutes s1)
6535 org-agenda-default-appointment-duration)))))
6537 ;; Compute the duration
6538 (when s2
6539 (setq duration (- (org-hh:mm-string-to-minutes s2)
6540 (org-hh:mm-string-to-minutes s1)))))
6542 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
6543 txt)
6544 ;; Tags are in the string
6545 (if (or (eq org-agenda-remove-tags t)
6546 (and org-agenda-remove-tags
6547 org-prefix-has-tag))
6548 (setq txt (replace-match "" t t txt))
6549 (setq txt (replace-match
6550 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
6551 (match-string 2 txt))
6552 t t txt))))
6553 (when (derived-mode-p 'org-mode)
6554 (setq effort (ignore-errors (get-text-property 0 'org-effort txt))))
6556 ;; org-agenda-add-time-grid-maybe calls us with *Agenda* as
6557 ;; current buffer, so move this check outside of above
6558 (if effort
6559 (setq neffort (org-duration-string-to-minutes effort)
6560 effort (setq effort (concat "[" effort "]")))
6561 ;; prevent erroring out with %e format when there is no effort
6562 (setq effort ""))
6564 (when remove-re
6565 (while (string-match remove-re txt)
6566 (setq txt (replace-match "" t t txt))))
6568 ;; Set org-heading property on `txt' to mark the start of the
6569 ;; heading.
6570 (add-text-properties 0 (length txt) '(org-heading t) txt)
6572 ;; Prepare the variables needed in the eval of the compiled format
6573 (if org-prefix-has-breadcrumbs
6574 (setq breadcrumbs (org-with-point-at (org-get-at-bol 'org-marker)
6575 (let ((s (org-display-outline-path nil nil "->" t)))
6576 (if (eq "" s) "" (concat s "->"))))))
6577 (setq time (cond (s2 (concat
6578 (org-agenda-time-of-day-to-ampm-maybe s1)
6579 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
6580 (if org-agenda-timegrid-use-ampm " ")))
6581 (s1 (concat
6582 (org-agenda-time-of-day-to-ampm-maybe s1)
6583 (if org-agenda-timegrid-use-ampm
6584 "........ "
6585 "......")))
6586 (t ""))
6587 extra (or (and (not habitp) extra) "")
6588 category (if (symbolp category) (symbol-name category) category)
6589 thecategory (copy-sequence category)
6590 level (or level ""))
6591 (if (string-match org-bracket-link-regexp category)
6592 (progn
6593 (setq l (if (match-end 3)
6594 (- (match-end 3) (match-beginning 3))
6595 (- (match-end 1) (match-beginning 1))))
6596 (when (< l (or org-prefix-category-length 0))
6597 (setq category (copy-sequence category))
6598 (org-add-props category nil
6599 'extra-space (make-string
6600 (- org-prefix-category-length l 1) ?\ ))))
6601 (if (and org-prefix-category-max-length
6602 (>= (length category) org-prefix-category-max-length))
6603 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
6604 ;; Evaluate the compiled format
6605 (setq rtn (concat (eval formatter) txt))
6607 ;; And finally add the text properties
6608 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
6609 (org-add-props rtn nil
6610 'org-category (if thecategory (downcase thecategory) category)
6611 'tags (mapcar 'org-downcase-keep-props tags)
6612 'org-highest-priority org-highest-priority
6613 'org-lowest-priority org-lowest-priority
6614 'time-of-day time-of-day
6615 'duration duration
6616 'effort effort
6617 'effort-minutes neffort
6618 'breadcrumbs breadcrumbs
6619 'txt txt
6620 'level level
6621 'time time
6622 'extra extra
6623 'format org-prefix-format-compiled
6624 'dotime dotime)))))
6626 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
6627 "Remove tags string from TXT, and add a modified list of tags.
6628 The modified list may contain inherited tags, and tags matched by
6629 `org-agenda-hide-tags-regexp' will be removed."
6630 (when (or add-inherited hide-re)
6631 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
6632 (setq txt (substring txt 0 (match-beginning 0))))
6633 (setq tags
6634 (delq nil
6635 (mapcar (lambda (tg)
6636 (if (or (and hide-re (string-match hide-re tg))
6637 (and (not add-inherited)
6638 (get-text-property 0 'inherited tg)))
6640 tg))
6641 tags)))
6642 (when tags
6643 (let ((have-i (get-text-property 0 'inherited (car tags)))
6645 (setq txt (concat txt " :"
6646 (mapconcat
6647 (lambda (x)
6648 (setq i (get-text-property 0 'inherited x))
6649 (if (and have-i (not i))
6650 (progn
6651 (setq have-i nil)
6652 (concat ":" x))
6654 tags ":")
6655 (if have-i "::" ":"))))))
6656 txt)
6658 (defun org-downcase-keep-props (s)
6659 (let ((props (text-properties-at 0 s)))
6660 (setq s (downcase s))
6661 (add-text-properties 0 (length s) props s)
6664 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
6666 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
6667 "Add a time-grid for agenda items which need it.
6669 LIST is the list of agenda items formatted by `org-agenda-list'.
6670 NDAYS is the span of the current agenda view.
6671 TODAYP is `t' when the current agenda view is on today."
6672 (catch 'exit
6673 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
6674 ((and todayp (member 'today (car org-agenda-time-grid))))
6675 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
6676 ((member 'weekly (car org-agenda-time-grid)))
6677 (t (throw 'exit list)))
6678 (let* ((have (delq nil (mapcar
6679 (lambda (x) (get-text-property 1 'time-of-day x))
6680 list)))
6681 (string (nth 1 org-agenda-time-grid))
6682 (gridtimes (nth 2 org-agenda-time-grid))
6683 (req (car org-agenda-time-grid))
6684 (remove (member 'remove-match req))
6685 new time)
6686 (if (and (member 'require-timed req) (not have))
6687 ;; don't show empty grid
6688 (throw 'exit list))
6689 (while (setq time (pop gridtimes))
6690 (unless (and remove (member time have))
6691 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
6692 (push (org-agenda-format-item
6693 nil string nil "" nil
6694 (concat (substring time 0 -2) ":" (substring time -2)))
6695 new)
6696 (put-text-property
6697 2 (length (car new)) 'face 'org-time-grid (car new))))
6698 (when (and todayp org-agenda-show-current-time-in-grid)
6699 (push (org-agenda-format-item
6700 nil org-agenda-current-time-string nil "" nil
6701 (format-time-string "%H:%M "))
6702 new)
6703 (put-text-property
6704 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
6706 (if (member 'time-up org-agenda-sorting-strategy-selected)
6707 (append new list)
6708 (append list new)))))
6710 (defun org-compile-prefix-format (key)
6711 "Compile the prefix format into a Lisp form that can be evaluated.
6712 The resulting form and associated variable bindings is returned
6713 and stored in the variable `org-prefix-format-compiled'."
6714 (setq org-prefix-has-time nil
6715 org-prefix-has-tag nil
6716 org-prefix-category-length nil
6717 org-prefix-has-effort nil
6718 org-prefix-has-breadcrumbs nil)
6719 (let ((s (cond
6720 ((stringp org-agenda-prefix-format)
6721 org-agenda-prefix-format)
6722 ((assq key org-agenda-prefix-format)
6723 (cdr (assq key org-agenda-prefix-format)))
6724 (t " %-12:c%?-12t% s")))
6725 (start 0)
6726 varform vars var e c f opt)
6727 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([cltseib]\\|(.+)\\)"
6728 s start)
6729 (setq var (or (cdr (assoc (match-string 4 s)
6730 '(("c" . category) ("t" . time) ("l" . level) ("s" . extra)
6731 ("i" . category-icon) ("T" . tag) ("e" . effort) ("b" . breadcrumbs))))
6732 'eval)
6733 c (or (match-string 3 s) "")
6734 opt (match-beginning 1)
6735 start (1+ (match-beginning 0)))
6736 (if (equal var 'time) (setq org-prefix-has-time t))
6737 (if (equal var 'tag) (setq org-prefix-has-tag t))
6738 (if (equal var 'effort) (setq org-prefix-has-effort t))
6739 (if (equal var 'breadcrumbs) (setq org-prefix-has-breadcrumbs t))
6740 (setq f (concat "%" (match-string 2 s) "s"))
6741 (when (equal var 'category)
6742 (setq org-prefix-category-length
6743 (floor (abs (string-to-number (match-string 2 s)))))
6744 (setq org-prefix-category-max-length
6745 (let ((x (match-string 2 s)))
6746 (save-match-data
6747 (if (string-match "\\.[0-9]+" x)
6748 (string-to-number (substring (match-string 0 x) 1)))))))
6749 (if (eq var 'eval)
6750 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
6751 (if opt
6752 (setq varform
6753 `(if (equal "" ,var)
6755 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
6756 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
6757 (setq s (replace-match "%s" t nil s))
6758 (push varform vars))
6759 (setq vars (nreverse vars))
6760 (with-current-buffer (or org-agenda-buffer (current-buffer))
6761 (setq org-prefix-format-compiled
6762 (list
6763 `((org-prefix-has-time ,org-prefix-has-time)
6764 (org-prefix-has-tag ,org-prefix-has-tag)
6765 (org-prefix-category-length ,org-prefix-category-length)
6766 (org-prefix-has-effort ,org-prefix-has-effort)
6767 (org-prefix-has-breadcrumbs ,org-prefix-has-breadcrumbs))
6768 `(format ,s ,@vars))))))
6770 (defun org-set-sorting-strategy (key)
6771 (if (symbolp (car org-agenda-sorting-strategy))
6772 ;; the old format
6773 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
6774 (setq org-agenda-sorting-strategy-selected
6775 (or (cdr (assq key org-agenda-sorting-strategy))
6776 (cdr (assq 'agenda org-agenda-sorting-strategy))
6777 '(time-up category-keep priority-down)))))
6779 (defun org-get-time-of-day (s &optional string mod24)
6780 "Check string S for a time of day.
6781 If found, return it as a military time number between 0 and 2400.
6782 If not found, return nil.
6783 The optional STRING argument forces conversion into a 5 character wide string
6784 HH:MM."
6785 (save-match-data
6786 (when
6787 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
6788 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
6789 (let* ((h (string-to-number (match-string 1 s)))
6790 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
6791 (ampm (if (match-end 4) (downcase (match-string 4 s))))
6792 (am-p (equal ampm "am"))
6793 (h1 (cond ((not ampm) h)
6794 ((= h 12) (if am-p 0 12))
6795 (t (+ h (if am-p 0 12)))))
6796 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
6797 (mod h1 24) h1))
6798 (t0 (+ (* 100 h2) m))
6799 (t1 (concat (if (>= h1 24) "+" " ")
6800 (if (and org-agenda-time-leading-zero
6801 (< t0 1000)) "0" "")
6802 (if (< t0 100) "0" "")
6803 (if (< t0 10) "0" "")
6804 (int-to-string t0))))
6805 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6807 (defvar org-agenda-before-sorting-filter-function nil
6808 "Function to be applied to agenda items prior to sorting.
6809 Prior to sorting also means just before they are inserted into the agenda.
6811 To aid sorting, you may revisit the original entries and add more text
6812 properties which will later be used by the sorting functions.
6814 The function should take a string argument, an agenda line.
6815 It has access to the text properties in that line, which contain among
6816 other things, the property `org-hd-marker' that points to the entry
6817 where the line comes from. Note that not all lines going into the agenda
6818 have this property, only most.
6820 The function should return the modified string. It is probably best
6821 to ONLY change text properties.
6823 You can also use this function as a filter, by returning nil for lines
6824 you don't want to have in the agenda at all. For this application, you
6825 could bind the variable in the options section of a custom command.")
6827 (defun org-agenda-finalize-entries (list &optional type)
6828 "Sort, limit and concatenate the LIST of agenda items.
6829 The optional argument TYPE tells the agenda type."
6830 (let ((max-effort (cond ((listp org-agenda-max-effort)
6831 (cdr (assoc type org-agenda-max-effort)))
6832 (t org-agenda-max-effort)))
6833 (max-todo (cond ((listp org-agenda-max-todos)
6834 (cdr (assoc type org-agenda-max-todos)))
6835 (t org-agenda-max-todos)))
6836 (max-tags (cond ((listp org-agenda-max-tags)
6837 (cdr (assoc type org-agenda-max-tags)))
6838 (t org-agenda-max-tags)))
6839 (max-entries (cond ((listp org-agenda-max-entries)
6840 (cdr (assoc type org-agenda-max-entries)))
6841 (t org-agenda-max-entries))) l)
6842 (when org-agenda-before-sorting-filter-function
6843 (setq list
6844 (delq nil
6845 (mapcar
6846 org-agenda-before-sorting-filter-function list))))
6847 (setq list (mapcar 'org-agenda-highlight-todo list)
6848 list (mapcar 'identity (sort list 'org-entries-lessp)))
6849 (when max-effort
6850 (setq list (org-agenda-limit-entries
6851 list 'effort-minutes max-effort 'identity)))
6852 (when max-todo
6853 (setq list (org-agenda-limit-entries list 'todo-state max-todo)))
6854 (when max-tags
6855 (setq list (org-agenda-limit-entries list 'tags max-tags)))
6856 (when max-entries
6857 (setq list (org-agenda-limit-entries list 'org-hd-marker max-entries)))
6858 (mapconcat 'identity list "\n")))
6860 (defun org-agenda-limit-entries (list prop limit &optional fn)
6861 "Limit the number of agenda entries."
6862 (let ((include (and limit (< limit 0))))
6863 (if limit
6864 (let ((fun (or fn (lambda (p) (if p 1))))
6865 (lim 0))
6866 (delq nil
6867 (mapcar
6868 (lambda (e)
6869 (let ((pval (funcall fun (get-text-property 1 prop e))))
6870 (if pval (setq lim (+ lim pval)))
6871 (cond ((and pval (<= lim (abs limit))) e)
6872 ((and include (not pval)) e))))
6873 list)))
6874 list)))
6876 (defun org-agenda-limit-interactively ()
6877 "In agenda, interactively limit entries to various maximums."
6878 (interactive)
6879 (let* ((max (read-char "Number of [e]ntries [t]odos [T]ags [E]ffort? "))
6880 (num (string-to-number (read-from-minibuffer "How many? "))))
6881 (cond ((equal max ?e)
6882 (let ((org-agenda-max-entries num)) (org-agenda-redo)))
6883 ((equal max ?t)
6884 (let ((org-agenda-max-todos num)) (org-agenda-redo)))
6885 ((equal max ?T)
6886 (let ((org-agenda-max-tags num)) (org-agenda-redo)))
6887 ((equal max ?E)
6888 (let ((org-agenda-max-effort num)) (org-agenda-redo)))))
6889 (org-agenda-fit-window-to-buffer))
6891 (defun org-agenda-highlight-todo (x)
6892 (let ((org-done-keywords org-done-keywords-for-agenda)
6893 (case-fold-search nil)
6895 (if (eq x 'line)
6896 (save-excursion
6897 (beginning-of-line 1)
6898 (setq re (org-get-at-bol 'org-todo-regexp))
6899 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6900 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6901 (add-text-properties (match-beginning 0) (match-end 1)
6902 (list 'face (org-get-todo-face 1)))
6903 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6904 (delete-region (match-beginning 1) (1- (match-end 0)))
6905 (goto-char (match-beginning 1))
6906 (insert (format org-agenda-todo-keyword-format s)))))
6907 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6908 (setq re (get-text-property 0 'org-todo-regexp x))
6909 (when (and re
6910 ;; Test `pl' because if there's no heading content,
6911 ;; there's no point matching to highlight. Note
6912 ;; that if we didn't test `pl' first, and there
6913 ;; happened to be no keyword from `org-todo-regexp'
6914 ;; on this heading line, then the `equal' comparison
6915 ;; afterwards would spuriously succeed in the case
6916 ;; where `pl' is nil -- causing an args-out-of-range
6917 ;; error when we try to add text properties to text
6918 ;; that isn't there.
6920 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6921 x pl) pl))
6922 (add-text-properties
6923 (or (match-end 1) (match-end 0)) (match-end 0)
6924 (list 'face (org-get-todo-face (match-string 2 x)))
6926 (when (match-end 1)
6927 (setq x (concat (substring x 0 (match-end 1))
6928 (format org-agenda-todo-keyword-format
6929 (match-string 2 x))
6930 (org-add-props " " (text-properties-at 0 x))
6931 (substring x (match-end 3)))))))
6932 x)))
6934 (defsubst org-cmp-priority (a b)
6935 "Compare the priorities of string A and B."
6936 (let ((pa (or (get-text-property 1 'priority a) 0))
6937 (pb (or (get-text-property 1 'priority b) 0)))
6938 (cond ((> pa pb) +1)
6939 ((< pa pb) -1))))
6941 (defsubst org-cmp-effort (a b)
6942 "Compare the effort values of string A and B."
6943 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6944 (ea (or (get-text-property 1 'effort-minutes a) def))
6945 (eb (or (get-text-property 1 'effort-minutes b) def)))
6946 (cond ((> ea eb) +1)
6947 ((< ea eb) -1))))
6949 (defsubst org-cmp-category (a b)
6950 "Compare the string values of categories of strings A and B."
6951 (let ((ca (or (get-text-property 1 'org-category a) ""))
6952 (cb (or (get-text-property 1 'org-category b) "")))
6953 (cond ((string-lessp ca cb) -1)
6954 ((string-lessp cb ca) +1))))
6956 (defsubst org-cmp-todo-state (a b)
6957 "Compare the todo states of strings A and B."
6958 (let* ((ma (or (get-text-property 1 'org-marker a)
6959 (get-text-property 1 'org-hd-marker a)))
6960 (mb (or (get-text-property 1 'org-marker b)
6961 (get-text-property 1 'org-hd-marker b)))
6962 (fa (and ma (marker-buffer ma)))
6963 (fb (and mb (marker-buffer mb)))
6964 (todo-kwds
6965 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6966 (and fb (with-current-buffer fb org-todo-keywords-1))))
6967 (ta (or (get-text-property 1 'todo-state a) ""))
6968 (tb (or (get-text-property 1 'todo-state b) ""))
6969 (la (- (length (member ta todo-kwds))))
6970 (lb (- (length (member tb todo-kwds))))
6971 (donepa (member ta org-done-keywords-for-agenda))
6972 (donepb (member tb org-done-keywords-for-agenda)))
6973 (cond ((and donepa (not donepb)) -1)
6974 ((and (not donepa) donepb) +1)
6975 ((< la lb) -1)
6976 ((< lb la) +1))))
6978 (defsubst org-cmp-alpha (a b)
6979 "Compare the headlines, alphabetically."
6980 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6981 (plb (text-property-any 0 (length b) 'org-heading t b))
6982 (ta (and pla (substring a pla)))
6983 (tb (and plb (substring b plb))))
6984 (when pla
6985 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6986 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6987 (setq ta (substring ta (match-end 0))))
6988 (setq ta (downcase ta)))
6989 (when plb
6990 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6991 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6992 (setq tb (substring tb (match-end 0))))
6993 (setq tb (downcase tb)))
6994 (cond ((not ta) +1)
6995 ((not tb) -1)
6996 ((string-lessp ta tb) -1)
6997 ((string-lessp tb ta) +1))))
6999 (defsubst org-cmp-tag (a b)
7000 "Compare the string values of the first tags of A and B."
7001 (let ((ta (car (last (get-text-property 1 'tags a))))
7002 (tb (car (last (get-text-property 1 'tags b)))))
7003 (cond ((not ta) +1)
7004 ((not tb) -1)
7005 ((string-lessp ta tb) -1)
7006 ((string-lessp tb ta) +1))))
7008 (defsubst org-cmp-time (a b)
7009 "Compare the time-of-day values of strings A and B."
7010 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
7011 (ta (or (get-text-property 1 'time-of-day a) def))
7012 (tb (or (get-text-property 1 'time-of-day b) def)))
7013 (cond ((< ta tb) -1)
7014 ((< tb ta) +1))))
7016 (defsubst org-cmp-ts (a b &optional type)
7017 "Compare the timestamps values of entries A and B.
7018 When TYPE is \"scheduled\", \"deadline\", \"timestamp\" or
7019 \"timestamp_ia\", compare within each of these type. When TYPE
7020 is the empty string, compare all timestamps without respect of
7021 their type."
7022 (let* ((def (if org-sort-agenda-notime-is-late most-positive-fixnum -1))
7023 (ta (or (and (string-match type (or (get-text-property 1 'type a) ""))
7024 (get-text-property 1 'ts-date a)) def))
7025 (tb (or (and (string-match type (or (get-text-property 1 'type b) ""))
7026 (get-text-property 1 'ts-date b)) def)))
7027 (cond ((< ta tb) -1)
7028 ((< tb ta) +1))))
7030 (defsubst org-cmp-habit-p (a b)
7031 "Compare the todo states of strings A and B."
7032 (let ((ha (get-text-property 1 'org-habit-p a))
7033 (hb (get-text-property 1 'org-habit-p b)))
7034 (cond ((and ha (not hb)) -1)
7035 ((and (not ha) hb) +1))))
7037 (defun org-entries-lessp (a b)
7038 "Predicate for sorting agenda entries."
7039 ;; The following variables will be used when the form is evaluated.
7040 ;; So even though the compiler complains, keep them.
7041 (let* ((ss org-agenda-sorting-strategy-selected)
7042 (timestamp-up (and (org-em 'timestamp-up 'timestamp-down ss)
7043 (org-cmp-ts a b "")))
7044 (timestamp-down (if timestamp-up (- timestamp-up) nil))
7045 (scheduled-up (and (org-em 'scheduled-up 'scheduled-down ss)
7046 (org-cmp-ts a b "scheduled")))
7047 (scheduled-down (if scheduled-up (- scheduled-up) nil))
7048 (deadline-up (and (org-em 'deadline-up 'deadline-down ss)
7049 (org-cmp-ts a b "deadline")))
7050 (deadline-down (if deadline-up (- deadline-up) nil))
7051 (tsia-up (and (org-em 'tsia-up 'tsia-down ss)
7052 (org-cmp-ts a b "iatimestamp_ia")))
7053 (tsia-down (if tsia-up (- tsia-up) nil))
7054 (ts-up (and (org-em 'ts-up 'ts-down ss)
7055 (org-cmp-ts a b "timestamp")))
7056 (ts-down (if ts-up (- ts-up) nil))
7057 (time-up (and (org-em 'time-up 'time-down ss)
7058 (org-cmp-time a b)))
7059 (time-down (if time-up (- time-up) nil))
7060 (priority-up (and (org-em 'priority-up 'priority-down ss)
7061 (org-cmp-priority a b)))
7062 (priority-down (if priority-up (- priority-up) nil))
7063 (effort-up (and (org-em 'effort-up 'effort-down ss)
7064 (org-cmp-effort a b)))
7065 (effort-down (if effort-up (- effort-up) nil))
7066 (category-up (and (or (org-em 'category-up 'category-down ss)
7067 (memq 'category-keep ss))
7068 (org-cmp-category a b)))
7069 (category-down (if category-up (- category-up) nil))
7070 (category-keep (if category-up +1 nil))
7071 (tag-up (and (org-em 'tag-up 'tag-down ss)
7072 (org-cmp-tag a b)))
7073 (tag-down (if tag-up (- tag-up) nil))
7074 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
7075 (org-cmp-todo-state a b)))
7076 (todo-state-down (if todo-state-up (- todo-state-up) nil))
7077 (habit-up (and (org-em 'habit-up 'habit-down ss)
7078 (org-cmp-habit-p a b)))
7079 (habit-down (if habit-up (- habit-up) nil))
7080 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
7081 (org-cmp-alpha a b)))
7082 (alpha-down (if alpha-up (- alpha-up) nil))
7083 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
7084 user-defined-up user-defined-down)
7085 (if (and need-user-cmp org-agenda-cmp-user-defined
7086 (functionp org-agenda-cmp-user-defined))
7087 (setq user-defined-up
7088 (funcall org-agenda-cmp-user-defined a b)
7089 user-defined-down (if user-defined-up (- user-defined-up) nil)))
7090 (cdr (assoc
7091 (eval (cons 'or org-agenda-sorting-strategy-selected))
7092 '((-1 . t) (1 . nil) (nil . nil))))))
7094 ;;; Agenda restriction lock
7096 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
7097 "Overlay to mark the headline to which agenda commands are restricted.")
7098 (overlay-put org-agenda-restriction-lock-overlay
7099 'face 'org-agenda-restriction-lock)
7100 (overlay-put org-agenda-restriction-lock-overlay
7101 'help-echo "Agendas are currently limited to this subtree.")
7102 (org-detach-overlay org-agenda-restriction-lock-overlay)
7104 ;;;###autoload
7105 (defun org-agenda-set-restriction-lock (&optional type)
7106 "Set restriction lock for agenda, to current subtree or file.
7107 Restriction will be the file if TYPE is `file', or if type is the
7108 universal prefix '(4), or if the cursor is before the first headline
7109 in the file. Otherwise, restriction will be to the current subtree."
7110 (interactive "P")
7111 (and (equal type '(4)) (setq type 'file))
7112 (setq type (cond
7113 (type type)
7114 ((org-at-heading-p) 'subtree)
7115 ((condition-case nil (org-back-to-heading t) (error nil))
7116 'subtree)
7117 (t 'file)))
7118 (if (eq type 'subtree)
7119 (progn
7120 (setq org-agenda-restrict (current-buffer))
7121 (setq org-agenda-overriding-restriction 'subtree)
7122 (put 'org-agenda-files 'org-restrict
7123 (list (buffer-file-name (buffer-base-buffer))))
7124 (org-back-to-heading t)
7125 (move-overlay org-agenda-restriction-lock-overlay
7126 (point)
7127 (if org-agenda-restriction-lock-highlight-subtree
7128 (save-excursion (org-end-of-subtree t t) (point))
7129 (point-at-eol)))
7130 (move-marker org-agenda-restrict-begin (point))
7131 (move-marker org-agenda-restrict-end
7132 (save-excursion (org-end-of-subtree t t)))
7133 (message "Locking agenda restriction to subtree"))
7134 (put 'org-agenda-files 'org-restrict
7135 (list (buffer-file-name (buffer-base-buffer))))
7136 (setq org-agenda-restrict nil)
7137 (setq org-agenda-overriding-restriction 'file)
7138 (move-marker org-agenda-restrict-begin nil)
7139 (move-marker org-agenda-restrict-end nil)
7140 (message "Locking agenda restriction to file"))
7141 (setq current-prefix-arg nil)
7142 (org-agenda-maybe-redo))
7144 (defun org-agenda-remove-restriction-lock (&optional noupdate)
7145 "Remove the agenda restriction lock."
7146 (interactive "P")
7147 (org-detach-overlay org-agenda-restriction-lock-overlay)
7148 (org-detach-overlay org-speedbar-restriction-lock-overlay)
7149 (setq org-agenda-overriding-restriction nil)
7150 (setq org-agenda-restrict nil)
7151 (put 'org-agenda-files 'org-restrict nil)
7152 (move-marker org-agenda-restrict-begin nil)
7153 (move-marker org-agenda-restrict-end nil)
7154 (setq current-prefix-arg nil)
7155 (message "Agenda restriction lock removed")
7156 (or noupdate (org-agenda-maybe-redo)))
7158 (defun org-agenda-maybe-redo ()
7159 "If there is any window showing the agenda view, update it."
7160 (let ((w (get-buffer-window org-agenda-buffer-name t))
7161 (w0 (selected-window)))
7162 (when w
7163 (select-window w)
7164 (org-agenda-redo)
7165 (select-window w0)
7166 (if org-agenda-overriding-restriction
7167 (message "Agenda view shifted to new %s restriction"
7168 org-agenda-overriding-restriction)
7169 (message "Agenda restriction lock removed")))))
7171 ;;; Agenda commands
7173 (defun org-agenda-check-type (error &rest types)
7174 "Check if agenda buffer is of allowed type.
7175 If ERROR is non-nil, throw an error, otherwise just return nil.
7176 Allowed types are 'agenda 'timeline 'todo 'tags 'search."
7177 (if (not org-agenda-type)
7178 (error "No Org agenda currently displayed")
7179 (if (memq org-agenda-type types)
7181 (if error
7182 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
7183 nil))))
7185 (defun org-agenda-Quit ()
7186 "Exit the agenda and kill buffers loaded by `org-agenda'.
7187 Also restore the window configuration."
7188 (interactive)
7189 (if org-agenda-columns-active
7190 (org-columns-quit)
7191 (let ((buf (current-buffer)))
7192 (if (eq org-agenda-window-setup 'other-frame)
7193 (progn
7194 (org-agenda-reset-markers)
7195 (kill-buffer buf)
7196 (org-columns-remove-overlays)
7197 (setq org-agenda-archives-mode nil)
7198 (delete-frame))
7199 (and (not (eq org-agenda-window-setup 'current-window))
7200 (not (one-window-p))
7201 (delete-window))
7202 (org-agenda-reset-markers)
7203 (kill-buffer buf)
7204 (org-columns-remove-overlays)
7205 (setq org-agenda-archives-mode nil)))
7206 (setq org-agenda-buffer nil)
7207 ;; Maybe restore the pre-agenda window configuration.
7208 (and org-agenda-restore-windows-after-quit
7209 (not (eq org-agenda-window-setup 'other-frame))
7210 org-agenda-pre-window-conf
7211 (set-window-configuration org-agenda-pre-window-conf)
7212 (setq org-agenda-pre-window-conf nil))))
7214 (defun org-agenda-quit ()
7215 "Exit the agenda and restore the window configuration.
7216 When `org-agenda-sticky' is non-nil, only bury the agenda."
7217 (interactive)
7218 (if (and (eq org-indirect-buffer-display 'other-window)
7219 org-last-indirect-buffer)
7220 (let ((org-last-indirect-window
7221 (get-buffer-window org-last-indirect-buffer)))
7222 (if org-last-indirect-window
7223 (delete-window org-last-indirect-window))))
7224 (if org-agenda-columns-active
7225 (org-columns-quit)
7226 (if org-agenda-sticky
7227 (let ((buf (current-buffer)))
7228 (if (eq org-agenda-window-setup 'other-frame)
7229 (progn
7230 (delete-frame))
7231 (and (not (eq org-agenda-window-setup 'current-window))
7232 (not (one-window-p))
7233 (delete-window)))
7234 (with-current-buffer buf
7235 (bury-buffer)
7236 ;; Maybe restore the pre-agenda window configuration.
7237 (and org-agenda-restore-windows-after-quit
7238 (not (eq org-agenda-window-setup 'other-frame))
7239 org-agenda-pre-window-conf
7240 (set-window-configuration org-agenda-pre-window-conf)
7241 (setq org-agenda-pre-window-conf nil))))
7242 (org-agenda-Quit))))
7244 (defun org-agenda-exit ()
7245 "Exit the agenda and restore the window configuration.
7246 Also kill Org-mode buffers loaded by `org-agenda'. Org-mode
7247 buffers visited directly by the user will not be touched."
7248 (interactive)
7249 (org-release-buffers org-agenda-new-buffers)
7250 (setq org-agenda-new-buffers nil)
7251 (org-agenda-Quit))
7253 (defun org-agenda-kill-all-agenda-buffers ()
7254 "Kill all buffers in `org-agenda-mode'.
7255 This is used when toggling sticky agendas.
7256 You can also explicitly invoke it with `C-c a C-k'."
7257 (interactive)
7258 (let (blist)
7259 (dolist (buf (buffer-list))
7260 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
7261 (push buf blist)))
7262 (mapc 'kill-buffer blist)))
7264 (defun org-agenda-execute (arg)
7265 "Execute another agenda command, keeping same window.
7266 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
7267 in the agenda."
7268 (interactive "P")
7269 (let ((org-agenda-window-setup 'current-window))
7270 (org-agenda arg)))
7272 (defun org-agenda-redo (&optional all)
7273 "Rebuild possibly ALL agenda view(s) in the current buffer."
7274 (interactive "P")
7275 (let* ((p (or (and (looking-at "\\'") (1- (point))) (point)))
7276 (cpa (unless (eq all t) current-prefix-arg))
7277 (org-agenda-doing-sticky-redo org-agenda-sticky)
7278 (org-agenda-sticky nil)
7279 (org-agenda-buffer-name (or org-agenda-this-buffer-name
7280 org-agenda-buffer-name))
7281 (org-agenda-keep-modes t)
7282 (tag-filter org-agenda-tag-filter)
7283 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
7284 (top-hl-filter org-agenda-top-headline-filter)
7285 (cat-filter org-agenda-category-filter)
7286 (cat-preset (get 'org-agenda-category-filter :preset-filter))
7287 (re-filter org-agenda-regexp-filter)
7288 (re-preset (get 'org-agenda-regexp-filter :preset-filter))
7289 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
7290 (cols org-agenda-columns-active)
7291 (line (org-current-line))
7292 (window-line (- line (org-current-line (window-start))))
7293 (lprops (get 'org-agenda-redo-command 'org-lprops))
7294 (redo-cmd (get-text-property p 'org-redo-cmd))
7295 (last-args (get-text-property p 'org-last-args))
7296 (org-agenda-overriding-cmd (get-text-property p 'org-series-cmd))
7297 (org-agenda-overriding-cmd-arguments
7298 (unless (eq all t)
7299 (cond ((listp last-args)
7300 (cons (or cpa (car last-args)) (cdr last-args)))
7301 ((stringp last-args)
7302 last-args))))
7303 (series-redo-cmd (get-text-property p 'org-series-redo-cmd)))
7304 (put 'org-agenda-tag-filter :preset-filter nil)
7305 (put 'org-agenda-category-filter :preset-filter nil)
7306 (put 'org-agenda-regexp-filter :preset-filter nil)
7307 (and cols (org-columns-quit))
7308 (message "Rebuilding agenda buffer...")
7309 (if series-redo-cmd
7310 (eval series-redo-cmd)
7311 (org-let lprops redo-cmd))
7312 (setq org-agenda-undo-list nil
7313 org-agenda-pending-undo-list nil
7314 org-agenda-tag-filter tag-filter
7315 org-agenda-category-filter cat-filter
7316 org-agenda-regexp-filter re-filter
7317 org-agenda-top-headline-filter top-hl-filter)
7318 (message "Rebuilding agenda buffer...done")
7319 (put 'org-agenda-tag-filter :preset-filter tag-preset)
7320 (put 'org-agenda-category-filter :preset-filter cat-preset)
7321 (put 'org-agenda-regexp-filter :preset-filter re-preset)
7322 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
7323 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
7324 (and (or re-filter re-preset) (org-agenda-filter-apply re-filter 'regexp))
7325 (and top-hl-filter (org-agenda-filter-top-headline-apply top-hl-filter))
7326 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
7327 (org-goto-line line)
7328 (recenter window-line)))
7330 (defvar org-global-tags-completion-table nil)
7331 (defvar org-agenda-filter-form nil)
7332 (defvar org-agenda-filtered-by-category nil)
7334 (defun org-agenda-filter-by-category (strip)
7335 "Keep only those lines in the agenda buffer that have a specific category.
7336 The category is that of the current line."
7337 (interactive "P")
7338 (if (and org-agenda-filtered-by-category
7339 org-agenda-category-filter)
7340 (org-agenda-filter-show-all-cat)
7341 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
7342 (cond
7343 ((and cat strip)
7344 (org-agenda-filter-apply
7345 (push (concat "-" cat) org-agenda-category-filter) 'category))
7346 ((and cat)
7347 (org-agenda-filter-apply
7348 (setq org-agenda-category-filter
7349 (list (concat "+" cat))) 'category))
7350 ((error "No category at point"))))))
7352 (defun org-find-top-headline (&optional pos)
7353 "Find the topmost parent headline and return it."
7354 (save-excursion
7355 (with-current-buffer (if pos (marker-buffer pos) (current-buffer))
7356 (if pos (goto-char pos))
7357 ;; Skip up to the topmost parent
7358 (while (ignore-errors (outline-up-heading 1) t))
7359 (ignore-errors
7360 (nth 4 (org-heading-components))))))
7362 (defvar org-agenda-filtered-by-top-headline nil)
7363 (defun org-agenda-filter-by-top-headline (strip)
7364 "Keep only those lines that are descendants from the same top headline.
7365 The top headline is that of the current line."
7366 (interactive "P")
7367 (if org-agenda-filtered-by-top-headline
7368 (progn
7369 (setq org-agenda-filtered-by-top-headline nil
7370 org-agenda-top-headline-filter nil)
7371 (org-agenda-filter-show-all-cat))
7372 (let ((cat (org-find-top-headline (org-get-at-bol 'org-hd-marker))))
7373 (if cat (org-agenda-filter-top-headline-apply cat strip)
7374 (error "No top-level category at point")))))
7376 (defvar org-agenda-regexp-filter nil)
7377 (defun org-agenda-filter-by-regexp (strip)
7378 "Filter agenda entries by a regular expression.
7379 Regexp filters are cumulative.
7380 With no prefix argument, keep entries matching the regexp.
7381 With one prefix argument, filter out entries matching the regexp.
7382 With two prefix arguments, remove the regexp filters."
7383 (interactive "P")
7384 (if (not (equal strip '(16)))
7385 (let ((flt (concat (if (equal strip '(4)) "-" "+")
7386 (read-from-minibuffer
7387 (if (equal strip '(4))
7388 "Filter out entries matching regexp: "
7389 "Narrow to entries matching regexp: ")))))
7390 (push flt org-agenda-regexp-filter)
7391 (org-agenda-filter-apply org-agenda-regexp-filter 'regexp))
7392 (org-agenda-filter-show-all-re)
7393 (message "Regexp filter removed")))
7395 (defun org-agenda-filter-remove-all ()
7396 "Remove all filters from the current agenda buffer."
7397 (interactive)
7398 (when org-agenda-tag-filter
7399 (org-agenda-filter-show-all-tag))
7400 (when org-agenda-category-filter
7401 (org-agenda-filter-show-all-cat))
7402 (when org-agenda-regexp-filter
7403 (org-agenda-filter-show-all-re)))
7405 (defun org-agenda-filter-by-tag (strip &optional char narrow)
7406 "Keep only those lines in the agenda buffer that have a specific tag.
7407 The tag is selected with its fast selection letter, as configured.
7408 With prefix argument STRIP, remove all lines that do have the tag.
7409 A lisp caller can specify CHAR. NARROW means that the new tag should be
7410 used to narrow the search - the interactive user can also press `-' or `+'
7411 to switch to narrowing."
7412 (interactive "P")
7413 (let* ((alist org-tag-alist-for-agenda)
7414 (tag-chars (mapconcat
7415 (lambda (x) (if (and (not (symbolp (car x)))
7416 (cdr x))
7417 (char-to-string (cdr x))
7418 ""))
7419 alist ""))
7420 (efforts (org-split-string
7421 (or (cdr (assoc (concat org-effort-property "_ALL")
7422 org-global-properties))
7423 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
7424 "")))
7425 (effort-op org-agenda-filter-effort-default-operator)
7426 (effort-prompt "")
7427 (inhibit-read-only t)
7428 (current org-agenda-tag-filter)
7429 maybe-refresh a n tag)
7430 (unless char
7431 (message
7432 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
7433 (if narrow "Narrow" "Filter") tag-chars
7434 (if org-agenda-auto-exclude-function "[RET], " ""))
7435 (setq char (read-char-exclusive)))
7436 (when (member char '(?+ ?-))
7437 ;; Narrowing down
7438 (cond ((equal char ?-) (setq strip t narrow t))
7439 ((equal char ?+) (setq strip nil narrow t)))
7440 (message
7441 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
7442 (setq char (read-char-exclusive)))
7443 (when (member char '(?< ?> ?= ??))
7444 ;; An effort operator
7445 (setq effort-op (char-to-string char))
7446 (setq alist nil) ; to make sure it will be interpreted as effort.
7447 (unless (equal char ??)
7448 (loop for i from 0 to 9 do
7449 (setq effort-prompt
7450 (concat
7451 effort-prompt " ["
7452 (if (= i 9) "0" (int-to-string (1+ i)))
7453 "]" (nth i efforts))))
7454 (message "Effort%s: %s " effort-op effort-prompt)
7455 (setq char (read-char-exclusive))
7456 (when (or (< char ?0) (> char ?9))
7457 (error "Need 1-9,0 to select effort"))))
7458 (when (equal char ?\t)
7459 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
7460 (org-set-local 'org-global-tags-completion-table
7461 (org-global-tags-completion-table)))
7462 (let ((completion-ignore-case t))
7463 (setq tag (org-icompleting-read
7464 "Tag: " org-global-tags-completion-table))))
7465 (cond
7466 ((equal char ?\r)
7467 (org-agenda-filter-show-all-tag)
7468 (when org-agenda-auto-exclude-function
7469 (setq org-agenda-tag-filter nil)
7470 (dolist (tag (org-agenda-get-represented-tags))
7471 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
7472 (if modifier
7473 (push modifier org-agenda-tag-filter))))
7474 (if (not (null org-agenda-tag-filter))
7475 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
7476 (setq maybe-refresh t))
7477 ((equal char ?/)
7478 (org-agenda-filter-show-all-tag)
7479 (when (get 'org-agenda-tag-filter :preset-filter)
7480 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
7481 (setq maybe-refresh t))
7482 ((equal char ?. )
7483 (setq org-agenda-tag-filter
7484 (mapcar (lambda(tag) (concat "+" tag))
7485 (org-get-at-bol 'tags)))
7486 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7487 (setq maybe-refresh t))
7488 ((or (equal char ?\ )
7489 (setq a (rassoc char alist))
7490 (and (>= char ?0) (<= char ?9)
7491 (setq n (if (= char ?0) 9 (- char ?0 1))
7492 tag (concat effort-op (nth n efforts))
7493 a (cons tag nil)))
7494 (and (= char ??)
7495 (setq tag "?eff")
7496 a (cons tag nil))
7497 (and tag (setq a (cons tag nil))))
7498 (org-agenda-filter-show-all-tag)
7499 (setq tag (car a))
7500 (setq org-agenda-tag-filter
7501 (cons (concat (if strip "-" "+") tag)
7502 (if narrow current nil)))
7503 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
7504 (setq maybe-refresh t))
7505 (t (error "Invalid tag selection character %c" char)))
7506 (when (and maybe-refresh
7507 (eq org-agenda-clockreport-mode 'with-filter))
7508 (org-agenda-redo))))
7510 (defun org-agenda-get-represented-tags ()
7511 "Get a list of all tags currently represented in the agenda."
7512 (let (p tags)
7513 (save-excursion
7514 (goto-char (point-min))
7515 (while (setq p (next-single-property-change (point) 'tags))
7516 (goto-char p)
7517 (mapc (lambda (x) (add-to-list 'tags x))
7518 (get-text-property (point) 'tags))))
7519 tags))
7521 (defun org-agenda-filter-by-tag-refine (strip &optional char)
7522 "Refine the current filter. See `org-agenda-filter-by-tag'."
7523 (interactive "P")
7524 (org-agenda-filter-by-tag strip char 'refine))
7526 (defun org-agenda-filter-make-matcher (filter type)
7527 "Create the form that tests a line for agenda filter."
7528 (let (f f1)
7529 (cond
7530 ;; Tag filter
7531 ((eq type 'tag)
7532 (setq filter
7533 (delete-dups
7534 (append (get 'org-agenda-tag-filter :preset-filter)
7535 filter)))
7536 (dolist (x filter)
7537 (let ((nfilter (org-agenda-filter-expand-tags filter)) nf nf1
7538 (ffunc
7539 (lambda (nf0 nf01 fltr notgroup op)
7540 (dolist (x fltr)
7541 (if (member x '("-" "+"))
7542 (setq nf01 (if (equal x "-") 'tags '(not tags)))
7543 (if (string-match "[<=>?]" x)
7544 (setq nf01 (org-agenda-filter-effort-form x))
7545 (setq nf01 (list 'member (downcase (substring x 1))
7546 'tags)))
7547 (when (equal (string-to-char x) ?-)
7548 (setq nf01 (list 'not nf01))
7549 (when (not notgroup) (setq op 'and))))
7550 (push nf01 nf0))
7551 (if notgroup
7552 (push (cons 'and nf0) f)
7553 (push (cons (or op 'or) nf0) f)))))
7554 (cond ((equal filter '("+"))
7555 (setq f (list (list 'not 'tags))))
7556 ((equal nfilter filter)
7557 (funcall ffunc f1 f filter t nil))
7558 (t (funcall ffunc nf1 nf nfilter nil nil))))))
7559 ;; Category filter
7560 ((eq type 'category)
7561 (setq filter
7562 (delete-dups
7563 (append (get 'org-agenda-category-filter :preset-filter)
7564 filter)))
7565 (dolist (x filter)
7566 (if (equal "-" (substring x 0 1))
7567 (setq f1 (list 'not (list 'equal (substring x 1) 'cat)))
7568 (setq f1 (list 'equal (substring x 1) 'cat)))
7569 (push f1 f)))
7570 ;; Regexp filter
7571 ((eq type 'regexp)
7572 (setq filter
7573 (delete-dups
7574 (append (get 'org-agenda-regexp-filter :preset-filter)
7575 filter)))
7576 (dolist (x filter)
7577 (if (equal "-" (substring x 0 1))
7578 (setq f1 (list 'not (list 'string-match (substring x 1) 'txt)))
7579 (setq f1 (list 'string-match (substring x 1) 'txt)))
7580 (push f1 f))))
7581 (cons 'and (nreverse f))))
7583 (defun org-agenda-filter-effort-form (e)
7584 "Return the form to compare the effort of the current line with what E says.
7585 E looks like \"+<2:25\"."
7586 (let (op)
7587 (setq e (substring e 1))
7588 (setq op (string-to-char e) e (substring e 1))
7589 (setq op (cond ((equal op ?<) '<=)
7590 ((equal op ?>) '>=)
7591 ((equal op ??) op)
7592 (t '=)))
7593 (list 'org-agenda-compare-effort (list 'quote op)
7594 (org-duration-string-to-minutes e))))
7596 (defun org-agenda-compare-effort (op value)
7597 "Compare the effort of the current line with VALUE, using OP.
7598 If the line does not have an effort defined, return nil."
7599 (let ((eff (org-get-at-bol 'effort-minutes)))
7600 (if (equal op ??)
7601 (not eff)
7602 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
7603 value))))
7605 (defun org-agenda-filter-expand-tags (filter &optional no-operator)
7606 "Expand group tags in FILTER for the agenda.
7607 When NO-OPERATOR is non-nil, do not add the + operator to returned tags."
7608 (if org-group-tags
7609 (let ((case-fold-search t) rtn)
7610 (mapc
7611 (lambda (f)
7612 (let (f0 dir)
7613 (if (string-match "^\\([+-]\\)\\(.+\\)" f)
7614 (setq dir (match-string 1 f) f0 (match-string 2 f))
7615 (setq dir (if no-operator "" "+") f0 f))
7616 (setq rtn (append (mapcar (lambda(f1) (concat dir f1))
7617 (org-tags-expand f0 t t))
7618 rtn))))
7619 filter)
7620 (reverse rtn))
7621 filter))
7623 (defun org-agenda-filter-apply (filter type)
7624 "Set FILTER as the new agenda filter and apply it."
7625 ;; Deactivate `org-agenda-entry-text-mode' when filtering
7626 (if org-agenda-entry-text-mode (org-agenda-entry-text-mode))
7627 (let (tags cat txt)
7628 (setq org-agenda-filter-form
7629 (org-agenda-filter-make-matcher filter type))
7630 (if (and (eq type 'category)
7631 (not (equal (substring (car filter) 0 1) "-")))
7632 ;; Only set `org-agenda-filtered-by-category' to t
7633 ;; when a unique category is used as the filter
7634 (setq org-agenda-filtered-by-category t))
7635 (org-agenda-set-mode-name)
7636 (save-excursion
7637 (goto-char (point-min))
7638 (while (not (eobp))
7639 (if (org-get-at-bol 'org-marker)
7640 (progn
7641 (setq tags ; used in eval
7642 (apply 'append
7643 (mapcar (lambda (f)
7644 (org-agenda-filter-expand-tags (list f) t))
7645 (org-get-at-bol 'tags)))
7646 cat (get-text-property (point) 'org-category)
7647 txt (get-text-property (point) 'txt))
7648 (if (not (eval org-agenda-filter-form))
7649 (org-agenda-filter-hide-line type))
7650 (beginning-of-line 2))
7651 (beginning-of-line 2))))
7652 (if (get-char-property (point) 'invisible)
7653 (ignore-errors (org-agenda-previous-line)))))
7655 (defun org-agenda-filter-top-headline-apply (hl &optional negative)
7656 "Filter by top headline HL."
7657 (org-agenda-set-mode-name)
7658 (save-excursion
7659 (goto-char (point-min))
7660 (while (not (eobp))
7661 (let* ((pos (org-get-at-bol 'org-hd-marker))
7662 (tophl (and pos (org-find-top-headline pos))))
7663 (if (and tophl (funcall (if negative 'identity 'not)
7664 (string= hl tophl)))
7665 (org-agenda-filter-hide-line 'category)))
7666 (beginning-of-line 2)))
7667 (if (get-char-property (point) 'invisible)
7668 (org-agenda-previous-line))
7669 (setq org-agenda-top-headline-filter hl
7670 org-agenda-filtered-by-top-headline t))
7672 (defun org-agenda-filter-hide-line (type)
7673 "Hide lines with TYPE in the agenda buffer."
7674 (let* ((b (max (point-min) (1- (point-at-bol))))
7675 (e (point-at-eol))
7676 (ov (make-overlay b e)))
7677 (overlay-put ov 'invisible t)
7678 (overlay-put ov 'intangible t)
7679 (overlay-put ov 'type type)
7680 (cond ((eq type 'tag) (push ov org-agenda-tag-filter-overlays))
7681 ((eq type 'category) (push ov org-agenda-cat-filter-overlays))
7682 ((eq type 'regexp) (push ov org-agenda-re-filter-overlays)))))
7684 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
7685 (setq pos (or pos (point)))
7686 (save-excursion
7687 (dolist (ov (overlays-at pos))
7688 (when (and (overlay-get ov 'invisible)
7689 (eq (overlay-get ov 'type) 'tag))
7690 (goto-char pos)
7691 (if (< (overlay-start ov) (point-at-eol))
7692 (move-overlay ov (point-at-eol)
7693 (overlay-end ov)))))))
7695 (defun org-agenda-filter-show-all-tag nil
7696 "Remove tag filter overlays from the agenda buffer."
7697 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
7698 (setq org-agenda-tag-filter-overlays nil
7699 org-agenda-tag-filter nil
7700 org-agenda-filter-form nil)
7701 (org-agenda-set-mode-name))
7703 (defun org-agenda-filter-show-all-re nil
7704 "Remove regexp filter overlays from the agenda buffer."
7705 (mapc 'delete-overlay org-agenda-re-filter-overlays)
7706 (setq org-agenda-re-filter-overlays nil
7707 org-agenda-regexp-filter nil
7708 org-agenda-filter-form nil)
7709 (org-agenda-set-mode-name))
7711 (defun org-agenda-filter-show-all-cat nil
7712 "Remove category filter overlays from the agenda buffer."
7713 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
7714 (setq org-agenda-cat-filter-overlays nil
7715 org-agenda-filtered-by-category nil
7716 org-agenda-category-filter nil
7717 org-agenda-filter-form nil)
7718 (org-agenda-set-mode-name))
7720 (defun org-agenda-manipulate-query-add ()
7721 "Manipulate the query by adding a search term with positive selection.
7722 Positive selection means the term must be matched for selection of an entry."
7723 (interactive)
7724 (org-agenda-manipulate-query ?\[))
7725 (defun org-agenda-manipulate-query-subtract ()
7726 "Manipulate the query by adding a search term with negative selection.
7727 Negative selection means term must not be matched for selection of an entry."
7728 (interactive)
7729 (org-agenda-manipulate-query ?\]))
7730 (defun org-agenda-manipulate-query-add-re ()
7731 "Manipulate the query by adding a search regexp with positive selection.
7732 Positive selection means the regexp must match for selection of an entry."
7733 (interactive)
7734 (org-agenda-manipulate-query ?\{))
7735 (defun org-agenda-manipulate-query-subtract-re ()
7736 "Manipulate the query by adding a search regexp with negative selection.
7737 Negative selection means regexp must not match for selection of an entry."
7738 (interactive)
7739 (org-agenda-manipulate-query ?\}))
7740 (defun org-agenda-manipulate-query (char)
7741 (cond
7742 ((memq org-agenda-type '(timeline agenda))
7743 (let ((org-agenda-include-inactive-timestamps t))
7744 (org-agenda-redo))
7745 (message "Display now includes inactive timestamps as well"))
7746 ((eq org-agenda-type 'search)
7747 (org-add-to-string
7748 'org-agenda-query-string
7749 (if org-agenda-last-search-view-search-was-boolean
7750 (cdr (assoc char '((?\[ . " +") (?\] . " -")
7751 (?\{ . " +{}") (?\} . " -{}"))))
7752 " "))
7753 (setq org-agenda-redo-command
7754 (list 'org-search-view
7755 (car (get-text-property (min (1- (point-max)) (point))
7756 'org-last-args))
7757 org-agenda-query-string
7758 (+ (length org-agenda-query-string)
7759 (if (member char '(?\{ ?\})) 0 1))))
7760 (set-register org-agenda-query-register org-agenda-query-string)
7761 (let ((org-agenda-overriding-arguments
7762 (cdr org-agenda-redo-command)))
7763 (org-agenda-redo)))
7764 (t (error "Cannot manipulate query for %s-type agenda buffers"
7765 org-agenda-type))))
7767 (defun org-add-to-string (var string)
7768 (set var (concat (symbol-value var) string)))
7770 (defun org-agenda-goto-date (span)
7771 "Jump to DATE in agenda."
7772 (interactive "P")
7773 (let* ((org-read-date-prefer-future
7774 (eval org-agenda-jump-prefer-future))
7775 (date (org-read-date))
7776 (day (time-to-days (org-time-string-to-time date)))
7777 (org-agenda-sticky-orig org-agenda-sticky)
7778 (org-agenda-buffer-tmp-name (buffer-name))
7779 (args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7780 (0-arg (or current-prefix-arg (car args)))
7781 (2-arg (nth 2 args))
7782 (with-hour-p (nth 4 org-agenda-redo-command))
7783 (newcmd (list 'org-agenda-list 0-arg date
7784 (org-agenda-span-to-ndays
7785 2-arg (org-time-string-to-absolute date))
7786 with-hour-p))
7787 (newargs (cdr newcmd))
7788 (inhibit-read-only t)
7789 org-agenda-sticky)
7790 (if (not (org-agenda-check-type t 'agenda))
7791 (error "Not available in non-agenda views")
7792 (add-text-properties (point-min) (point-max)
7793 `(org-redo-cmd ,newcmd org-last-args ,newargs))
7794 (org-agenda-redo)
7795 (goto-char (point-min))
7796 (while (not (or (= (or (get-text-property (point) 'day) 0) day)
7797 (save-excursion (move-beginning-of-line 2) (eobp))))
7798 (move-beginning-of-line 2))
7799 (setq org-agenda-sticky org-agenda-sticky-orig
7800 org-agenda-this-buffer-is-sticky org-agenda-sticky))))
7802 (defun org-agenda-goto-today ()
7803 "Go to today."
7804 (interactive)
7805 (org-agenda-check-type t 'timeline 'agenda)
7806 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7807 (curspan (nth 2 args))
7808 (tdpos (text-property-any (point-min) (point-max) 'org-today t)))
7809 (cond
7810 (tdpos (goto-char tdpos))
7811 ((eq org-agenda-type 'agenda)
7812 (let* ((sd (org-agenda-compute-starting-span
7813 (org-today) (or curspan org-agenda-ndays org-agenda-span)))
7814 (org-agenda-overriding-arguments args))
7815 (setf (nth 1 org-agenda-overriding-arguments) sd)
7816 (org-agenda-redo)
7817 (org-agenda-find-same-or-today-or-agenda)))
7818 (t (error "Cannot find today")))))
7820 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
7821 (goto-char
7822 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
7823 (text-property-any (point-min) (point-max) 'org-today t)
7824 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
7825 (and (get-text-property (min (1- (point-max)) (point)) 'org-series)
7826 (org-agenda-goto-block-beginning))
7827 (point-min))))
7829 (defun org-agenda-goto-block-beginning ()
7830 "Go the agenda block beginning."
7831 (interactive)
7832 (if (not (derived-mode-p 'org-agenda-mode))
7833 (error "Cannot execute this command outside of org-agenda-mode buffers")
7834 (let (dest)
7835 (save-excursion
7836 (unless (looking-at "\\'")
7837 (forward-char))
7838 (let* ((prop 'org-agenda-structural-header)
7839 (p (previous-single-property-change (point) prop))
7840 (n (next-single-property-change (or (and (looking-at "\\`") 1)
7841 (1- (point))) prop)))
7842 (setq dest (cond ((eq n (point-at-eol)) (1- n)) (p (1- p))))))
7843 (if (not dest)
7844 (error "Cannot find the beginning of the blog")
7845 (goto-char dest)
7846 (move-beginning-of-line 1)))))
7848 (defun org-agenda-later (arg)
7849 "Go forward in time by the current span.
7850 With prefix ARG, go forward that many times the current span."
7851 (interactive "p")
7852 (org-agenda-check-type t 'agenda)
7853 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7854 (span (or (nth 2 args) org-agenda-current-span))
7855 (sd (or (nth 1 args) (org-get-at-bol 'day) org-starting-day))
7856 (greg (calendar-gregorian-from-absolute sd))
7857 (cnt (org-get-at-bol 'org-day-cnt))
7858 greg2)
7859 (cond
7860 ((numberp span)
7861 (setq sd (+ (* span arg) sd)))
7862 ((eq span 'day)
7863 (setq sd (+ arg sd)))
7864 ((eq span 'week)
7865 (setq sd (+ (* 7 arg) sd)))
7866 ((eq span 'fortnight)
7867 (setq sd (+ (* 14 arg) sd)))
7868 ((eq span 'month)
7869 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
7870 sd (calendar-absolute-from-gregorian greg2))
7871 (setcar greg2 (1+ (car greg2))))
7872 ((eq span 'year)
7873 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
7874 sd (calendar-absolute-from-gregorian greg2))
7875 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
7877 (setq sd (+ (* span arg) sd))))
7878 (let ((org-agenda-overriding-cmd
7879 ;; `cmd' may have been set by `org-agenda-run-series' which
7880 ;; uses `org-agenda-overriding-cmd' to decide whether
7881 ;; overriding is allowed for `cmd'
7882 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7883 (org-agenda-overriding-arguments
7884 (list (car args) sd span)))
7885 (org-agenda-redo)
7886 (org-agenda-find-same-or-today-or-agenda cnt))))
7888 (defun org-agenda-earlier (arg)
7889 "Go backward in time by the current span.
7890 With prefix ARG, go backward that many times the current span."
7891 (interactive "p")
7892 (org-agenda-later (- arg)))
7894 (defun org-agenda-view-mode-dispatch ()
7895 "Call one of the view mode commands."
7896 (interactive)
7897 (message "View: [d]ay [w]eek for[t]night [m]onth [y]ear [SPC]reset [q]uit/abort
7898 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
7899 [a]rch-trees [A]rch-files clock[R]eport include[D]iary [E]ntryText")
7900 (let ((a (read-char-exclusive)))
7901 (case a
7902 (?\ (call-interactively 'org-agenda-reset-view))
7903 (?d (call-interactively 'org-agenda-day-view))
7904 (?w (call-interactively 'org-agenda-week-view))
7905 (?t (call-interactively 'org-agenda-fortnight-view))
7906 (?m (call-interactively 'org-agenda-month-view))
7907 (?y (call-interactively 'org-agenda-year-view))
7908 (?l (call-interactively 'org-agenda-log-mode))
7909 (?L (org-agenda-log-mode '(4)))
7910 (?c (org-agenda-log-mode 'clockcheck))
7911 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
7912 (?a (call-interactively 'org-agenda-archives-mode))
7913 (?A (org-agenda-archives-mode 'files))
7914 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
7915 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
7916 (?G (call-interactively 'org-agenda-toggle-time-grid))
7917 (?D (call-interactively 'org-agenda-toggle-diary))
7918 (?\! (call-interactively 'org-agenda-toggle-deadlines))
7919 (?\[ (let ((org-agenda-include-inactive-timestamps t))
7920 (org-agenda-check-type t 'timeline 'agenda)
7921 (org-agenda-redo))
7922 (message "Display now includes inactive timestamps as well"))
7923 (?q (message "Abort"))
7924 (otherwise (error "Invalid key" )))))
7926 (defun org-agenda-reset-view ()
7927 "Switch to default view for agenda."
7928 (interactive)
7929 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
7930 (defun org-agenda-day-view (&optional day-of-month)
7931 "Switch to daily view for agenda.
7932 With argument DAY-OF-MONTH, switch to that day of the month."
7933 (interactive "P")
7934 (org-agenda-change-time-span 'day day-of-month))
7935 (defun org-agenda-week-view (&optional iso-week)
7936 "Switch to daily view for agenda.
7937 With argument ISO-WEEK, switch to the corresponding ISO week.
7938 If ISO-WEEK has more then 2 digits, only the last two encode the
7939 week. Any digits before this encode a year. So 200712 means
7940 week 12 of year 2007. Years in the range 1938-2037 can also be
7941 written as 2-digit years."
7942 (interactive "P")
7943 (org-agenda-change-time-span 'week iso-week))
7944 (defun org-agenda-fortnight-view (&optional iso-week)
7945 "Switch to daily view for agenda.
7946 With argument ISO-WEEK, switch to the corresponding ISO week.
7947 If ISO-WEEK has more then 2 digits, only the last two encode the
7948 week. Any digits before this encode a year. So 200712 means
7949 week 12 of year 2007. Years in the range 1938-2037 can also be
7950 written as 2-digit years."
7951 (interactive "P")
7952 (org-agenda-change-time-span 'fortnight iso-week))
7953 (defun org-agenda-month-view (&optional month)
7954 "Switch to monthly view for agenda.
7955 With argument MONTH, switch to that month."
7956 (interactive "P")
7957 (org-agenda-change-time-span 'month month))
7958 (defun org-agenda-year-view (&optional year)
7959 "Switch to yearly view for agenda.
7960 With argument YEAR, switch to that year.
7961 If MONTH has more then 2 digits, only the last two encode the
7962 month. Any digits before this encode a year. So 200712 means
7963 December year 2007. Years in the range 1938-2037 can also be
7964 written as 2-digit years."
7965 (interactive "P")
7966 (when year
7967 (setq year (org-small-year-to-year year)))
7968 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
7969 (org-agenda-change-time-span 'year year)
7970 (error "Abort")))
7972 (defun org-agenda-change-time-span (span &optional n)
7973 "Change the agenda view to SPAN.
7974 SPAN may be `day', `week', `fortnight', `month', `year'."
7975 (org-agenda-check-type t 'agenda)
7976 (let* ((args (get-text-property (min (1- (point-max)) (point)) 'org-last-args))
7977 (curspan (nth 2 args)))
7978 (if (and (not n) (equal curspan span))
7979 (error "Viewing span is already \"%s\"" span))
7980 (let* ((sd (or (org-get-at-bol 'day)
7981 (nth 1 args)
7982 org-starting-day))
7983 (sd (org-agenda-compute-starting-span sd span n))
7984 (org-agenda-overriding-cmd
7985 (get-text-property (min (1- (point-max)) (point)) 'org-series-cmd))
7986 (org-agenda-overriding-arguments
7987 (list (car args) sd span)))
7988 (org-agenda-redo)
7989 (org-agenda-find-same-or-today-or-agenda))
7990 (org-agenda-set-mode-name)
7991 (message "Switched to %s view" span)))
7993 (defun org-agenda-compute-starting-span (sd span &optional n)
7994 "Compute starting date for agenda.
7995 SPAN may be `day', `week', `fortnight', `month', `year'. The return value
7996 is a cons cell with the starting date and the number of days,
7997 so that the date SD will be in that range."
7998 (let* ((greg (calendar-gregorian-from-absolute sd))
7999 (dg (nth 1 greg))
8000 (mg (car greg))
8001 (yg (nth 2 greg)))
8002 (cond
8003 ((eq span 'day)
8004 (when n
8005 (setq sd (+ (calendar-absolute-from-gregorian
8006 (list mg 1 yg))
8007 n -1))))
8008 ((or (eq span 'week) (eq span 'fortnight))
8009 (let* ((nt (calendar-day-of-week
8010 (calendar-gregorian-from-absolute sd)))
8011 (d (if org-agenda-start-on-weekday
8012 (- nt org-agenda-start-on-weekday)
8015 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
8016 (when n
8017 (require 'cal-iso)
8018 (when (> n 99)
8019 (setq y1 (org-small-year-to-year (/ n 100))
8020 n (mod n 100)))
8021 (setq sd
8022 (calendar-absolute-from-iso
8023 (list n 1
8024 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
8025 ((eq span 'month)
8026 (let (y1)
8027 (when (and n (> n 99))
8028 (setq y1 (org-small-year-to-year (/ n 100))
8029 n (mod n 100)))
8030 (setq sd (calendar-absolute-from-gregorian
8031 (list (or n mg) 1 (or y1 yg))))))
8032 ((eq span 'year)
8033 (setq sd (calendar-absolute-from-gregorian
8034 (list 1 1 (or n yg))))))
8035 sd))
8037 (defun org-agenda-next-date-line (&optional arg)
8038 "Jump to the next line indicating a date in agenda buffer."
8039 (interactive "p")
8040 (org-agenda-check-type t 'agenda 'timeline)
8041 (beginning-of-line 1)
8042 ;; This does not work if user makes date format that starts with a blank
8043 (if (looking-at "^\\S-") (forward-char 1))
8044 (if (not (re-search-forward "^\\S-" nil t arg))
8045 (progn
8046 (backward-char 1)
8047 (error "No next date after this line in this buffer")))
8048 (goto-char (match-beginning 0)))
8050 (defun org-agenda-previous-date-line (&optional arg)
8051 "Jump to the previous line indicating a date in agenda buffer."
8052 (interactive "p")
8053 (org-agenda-check-type t 'agenda 'timeline)
8054 (beginning-of-line 1)
8055 (if (not (re-search-backward "^\\S-" nil t arg))
8056 (error "No previous date before this line in this buffer")))
8058 ;; Initialize the highlight
8059 (defvar org-hl (make-overlay 1 1))
8060 (overlay-put org-hl 'face 'highlight)
8062 (defun org-highlight (begin end &optional buffer)
8063 "Highlight a region with overlay."
8064 (move-overlay org-hl begin end (or buffer (current-buffer))))
8066 (defun org-unhighlight ()
8067 "Detach overlay INDEX."
8068 (org-detach-overlay org-hl))
8070 (defun org-unhighlight-once ()
8071 "Remove the highlight from its position, and this function from the hook."
8072 (remove-hook 'pre-command-hook 'org-unhighlight-once)
8073 (org-unhighlight))
8075 (defvar org-agenda-pre-follow-window-conf nil)
8076 (defun org-agenda-follow-mode ()
8077 "Toggle follow mode in an agenda buffer."
8078 (interactive)
8079 (unless org-agenda-follow-mode
8080 (setq org-agenda-pre-follow-window-conf
8081 (current-window-configuration)))
8082 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
8083 (unless org-agenda-follow-mode
8084 (set-window-configuration org-agenda-pre-follow-window-conf))
8085 (org-agenda-set-mode-name)
8086 (org-agenda-do-context-action)
8087 (message "Follow mode is %s"
8088 (if org-agenda-follow-mode "on" "off")))
8090 (defun org-agenda-entry-text-mode (&optional arg)
8091 "Toggle entry text mode in an agenda buffer."
8092 (interactive "P")
8093 (if (or org-agenda-tag-filter
8094 org-agenda-category-filter
8095 org-agenda-regexp-filter
8096 org-agenda-top-headline-filter)
8097 (user-error "Can't show entry text in filtered views")
8098 (setq org-agenda-entry-text-mode (or (integerp arg)
8099 (not org-agenda-entry-text-mode)))
8100 (org-agenda-entry-text-hide)
8101 (and org-agenda-entry-text-mode
8102 (let ((org-agenda-entry-text-maxlines
8103 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
8104 (org-agenda-entry-text-show)))
8105 (org-agenda-set-mode-name)
8106 (message "Entry text mode is %s%s"
8107 (if org-agenda-entry-text-mode "on" "off")
8108 (if (not org-agenda-entry-text-mode) ""
8109 (format " (maximum number of lines is %d)"
8110 (if (integerp arg) arg org-agenda-entry-text-maxlines))))))
8112 (defun org-agenda-clockreport-mode (&optional with-filter)
8113 "Toggle clocktable mode in an agenda buffer.
8114 With prefix arg WITH-FILTER, make the clocktable respect the current
8115 agenda filter."
8116 (interactive "P")
8117 (org-agenda-check-type t 'agenda)
8118 (if with-filter
8119 (setq org-agenda-clockreport-mode 'with-filter)
8120 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
8121 (org-agenda-set-mode-name)
8122 (org-agenda-redo)
8123 (message "Clocktable mode is %s"
8124 (if org-agenda-clockreport-mode "on" "off")))
8126 (defun org-agenda-log-mode (&optional special)
8127 "Toggle log mode in an agenda buffer.
8128 With argument SPECIAL, show all possible log items, not only the ones
8129 configured in `org-agenda-log-mode-items'.
8130 With a double `C-u' prefix arg, show *only* log items, nothing else."
8131 (interactive "P")
8132 (org-agenda-check-type t 'agenda 'timeline)
8133 (setq org-agenda-show-log
8134 (cond
8135 ((equal special '(16)) 'only)
8136 ((eq special 'clockcheck)
8137 (if (eq org-agenda-show-log 'clockcheck)
8138 nil 'clockcheck))
8139 (special '(closed clock state))
8140 (t (not org-agenda-show-log))))
8141 (org-agenda-set-mode-name)
8142 (org-agenda-redo)
8143 (message "Log mode is %s"
8144 (if org-agenda-show-log "on" "off")))
8146 (defun org-agenda-archives-mode (&optional with-files)
8147 "Toggle inclusion of items in trees marked with :ARCHIVE:.
8148 When called with a prefix argument, include all archive files as well."
8149 (interactive "P")
8150 (setq org-agenda-archives-mode
8151 (if with-files t (if org-agenda-archives-mode nil 'trees)))
8152 (org-agenda-set-mode-name)
8153 (org-agenda-redo)
8154 (message
8155 "%s"
8156 (cond
8157 ((eq org-agenda-archives-mode nil)
8158 "No archives are included")
8159 ((eq org-agenda-archives-mode 'trees)
8160 (format "Trees with :%s: tag are included" org-archive-tag))
8161 ((eq org-agenda-archives-mode t)
8162 (format "Trees with :%s: tag and all active archive files are included"
8163 org-archive-tag)))))
8165 (defun org-agenda-toggle-diary ()
8166 "Toggle diary inclusion in an agenda buffer."
8167 (interactive)
8168 (org-agenda-check-type t 'agenda)
8169 (setq org-agenda-include-diary (not org-agenda-include-diary))
8170 (org-agenda-redo)
8171 (org-agenda-set-mode-name)
8172 (message "Diary inclusion turned %s"
8173 (if org-agenda-include-diary "on" "off")))
8175 (defun org-agenda-toggle-deadlines ()
8176 "Toggle inclusion of entries with a deadline in an agenda buffer."
8177 (interactive)
8178 (org-agenda-check-type t 'agenda)
8179 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
8180 (org-agenda-redo)
8181 (org-agenda-set-mode-name)
8182 (message "Deadlines inclusion turned %s"
8183 (if org-agenda-include-deadlines "on" "off")))
8185 (defun org-agenda-toggle-time-grid ()
8186 "Toggle time grid in an agenda buffer."
8187 (interactive)
8188 (org-agenda-check-type t 'agenda)
8189 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
8190 (org-agenda-redo)
8191 (org-agenda-set-mode-name)
8192 (message "Time-grid turned %s"
8193 (if org-agenda-use-time-grid "on" "off")))
8195 (defun org-agenda-set-mode-name ()
8196 "Set the mode name to indicate all the small mode settings."
8197 (setq mode-name
8198 (list "Org-Agenda"
8199 (if (get 'org-agenda-files 'org-restrict) " []" "")
8201 '(:eval (org-agenda-span-name org-agenda-current-span))
8202 (if org-agenda-follow-mode " Follow" "")
8203 (if org-agenda-entry-text-mode " ETxt" "")
8204 (if org-agenda-include-diary " Diary" "")
8205 (if org-agenda-include-deadlines " Ddl" "")
8206 (if org-agenda-use-time-grid " Grid" "")
8207 (if (and (boundp 'org-habit-show-habits)
8208 org-habit-show-habits) " Habit" "")
8209 (cond
8210 ((consp org-agenda-show-log) " LogAll")
8211 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
8212 (org-agenda-show-log " Log")
8213 (t ""))
8214 (if (or org-agenda-category-filter
8215 (get 'org-agenda-category-filter :preset-filter))
8216 '(:eval (org-propertize
8217 (concat " <"
8218 (mapconcat
8219 'identity
8220 (append
8221 (get 'org-agenda-category-filter :preset-filter)
8222 org-agenda-category-filter)
8224 ">")
8225 'face 'org-agenda-filter-category
8226 'help-echo "Category used in filtering")) "")
8227 (if (or org-agenda-tag-filter
8228 (get 'org-agenda-tag-filter :preset-filter))
8229 '(:eval (org-propertize
8230 (concat " {"
8231 (mapconcat
8232 'identity
8233 (append
8234 (get 'org-agenda-tag-filter :preset-filter)
8235 org-agenda-tag-filter)
8237 "}")
8238 'face 'org-agenda-filter-tags
8239 'help-echo "Tags used in filtering")) "")
8240 (if (or org-agenda-regexp-filter
8241 (get 'org-agenda-regexp-filter :preset-filter))
8242 '(:eval (org-propertize
8243 (concat " ["
8244 (mapconcat
8245 'identity
8246 (append
8247 (get 'org-agenda-regexp-filter :preset-filter)
8248 org-agenda-regexp-filter)
8250 "]")
8251 'face 'org-agenda-filter-regexp
8252 'help-echo "Regexp used in filtering")) "")
8253 (if org-agenda-archives-mode
8254 (if (eq org-agenda-archives-mode t)
8255 " Archives"
8256 (format " :%s:" org-archive-tag))
8258 (if org-agenda-clockreport-mode
8259 (if (eq org-agenda-clockreport-mode 'with-filter)
8260 " Clock{}" " Clock")
8261 "")))
8262 (force-mode-line-update))
8264 (define-obsolete-function-alias
8265 'org-agenda-post-command-hook 'org-agenda-update-agenda-type "24.3")
8267 (defun org-agenda-update-agenda-type ()
8268 "Update the agenda type after each command."
8269 (setq org-agenda-type
8270 (or (get-text-property (point) 'org-agenda-type)
8271 (get-text-property (max (point-min) (1- (point))) 'org-agenda-type))))
8273 (defun org-agenda-next-line ()
8274 "Move cursor to the next line, and show if follow mode is active."
8275 (interactive)
8276 (call-interactively 'next-line)
8277 (org-agenda-do-context-action))
8279 (defun org-agenda-previous-line ()
8280 "Move cursor to the previous line, and show if follow-mode is active."
8281 (interactive)
8282 (call-interactively 'previous-line)
8283 (org-agenda-do-context-action))
8285 (defun org-agenda-next-item (n)
8286 "Move cursor to next agenda item."
8287 (interactive "p")
8288 (let ((col (current-column)))
8289 (dotimes (c n)
8290 (when (next-single-property-change (point-at-eol) 'org-marker)
8291 (move-end-of-line 1)
8292 (goto-char (next-single-property-change (point) 'org-marker))))
8293 (org-move-to-column col))
8294 (org-agenda-do-context-action))
8296 (defun org-agenda-previous-item (n)
8297 "Move cursor to next agenda item."
8298 (interactive "p")
8299 (dotimes (c n)
8300 (let ((col (current-column))
8301 (goto (save-excursion
8302 (move-end-of-line 0)
8303 (previous-single-property-change (point) 'org-marker))))
8304 (if goto (goto-char goto))
8305 (org-move-to-column col)))
8306 (org-agenda-do-context-action))
8308 (defun org-agenda-do-context-action ()
8309 "Show outline path and, maybe, follow mode window."
8310 (let ((m (org-get-at-bol 'org-marker)))
8311 (when (and (markerp m) (marker-buffer m))
8312 (and org-agenda-follow-mode
8313 (if org-agenda-follow-indirect
8314 (org-agenda-tree-to-indirect-buffer nil)
8315 (org-agenda-show)))
8316 (and org-agenda-show-outline-path
8317 (org-with-point-at m (org-display-outline-path t))))))
8319 (defun org-agenda-show-tags ()
8320 "Show the tags applicable to the current item."
8321 (interactive)
8322 (let* ((tags (org-get-at-bol 'tags)))
8323 (if tags
8324 (message "Tags are :%s:"
8325 (org-no-properties (mapconcat 'identity tags ":")))
8326 (message "No tags associated with this line"))))
8328 (defun org-agenda-goto (&optional highlight)
8329 "Go to the Org-mode file which contains the item at point."
8330 (interactive)
8331 (let* ((marker (or (org-get-at-bol 'org-marker)
8332 (org-agenda-error)))
8333 (buffer (marker-buffer marker))
8334 (pos (marker-position marker)))
8335 (switch-to-buffer-other-window buffer)
8336 (widen)
8337 (push-mark)
8338 (goto-char pos)
8339 (when (derived-mode-p 'org-mode)
8340 (org-show-context 'agenda)
8341 (save-excursion
8342 (and (outline-next-heading)
8343 (org-flag-heading nil)))) ; show the next heading
8344 (when (outline-invisible-p)
8345 (show-entry)) ; display invisible text
8346 (recenter (/ (window-height) 2))
8347 (run-hooks 'org-agenda-after-show-hook)
8348 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
8350 (defvar org-agenda-after-show-hook nil
8351 "Normal hook run after an item has been shown from the agenda.
8352 Point is in the buffer where the item originated.")
8354 (defun org-agenda-kill ()
8355 "Kill the entry or subtree belonging to the current agenda entry."
8356 (interactive)
8357 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8358 (let* ((bufname-orig (buffer-name))
8359 (marker (or (org-get-at-bol 'org-marker)
8360 (org-agenda-error)))
8361 (buffer (marker-buffer marker))
8362 (pos (marker-position marker))
8363 (type (org-get-at-bol 'type))
8364 dbeg dend (n 0) conf)
8365 (org-with-remote-undo buffer
8366 (with-current-buffer buffer
8367 (save-excursion
8368 (goto-char pos)
8369 (if (and (derived-mode-p 'org-mode) (not (member type '("sexp"))))
8370 (setq dbeg (progn (org-back-to-heading t) (point))
8371 dend (org-end-of-subtree t t))
8372 (setq dbeg (point-at-bol)
8373 dend (min (point-max) (1+ (point-at-eol)))))
8374 (goto-char dbeg)
8375 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
8376 (setq conf (or (eq t org-agenda-confirm-kill)
8377 (and (numberp org-agenda-confirm-kill)
8378 (> n org-agenda-confirm-kill))))
8379 (and conf
8380 (not (y-or-n-p
8381 (format "Delete entry with %d lines in buffer \"%s\"? "
8382 n (buffer-name buffer))))
8383 (error "Abort"))
8384 (let ((org-agenda-buffer-name bufname-orig))
8385 (org-remove-subtree-entries-from-agenda buffer dbeg dend))
8386 (with-current-buffer buffer (delete-region dbeg dend))
8387 (message "Agenda item and source killed"))))
8389 (defvar org-archive-default-command) ; defined in org-archive.el
8390 (defun org-agenda-archive-default ()
8391 "Archive the entry or subtree belonging to the current agenda entry."
8392 (interactive)
8393 (require 'org-archive)
8394 (org-agenda-archive-with org-archive-default-command))
8396 (defun org-agenda-archive-default-with-confirmation ()
8397 "Archive the entry or subtree belonging to the current agenda entry."
8398 (interactive)
8399 (require 'org-archive)
8400 (org-agenda-archive-with org-archive-default-command 'confirm))
8402 (defun org-agenda-archive ()
8403 "Archive the entry or subtree belonging to the current agenda entry."
8404 (interactive)
8405 (org-agenda-archive-with 'org-archive-subtree))
8407 (defun org-agenda-archive-to-archive-sibling ()
8408 "Move the entry to the archive sibling."
8409 (interactive)
8410 (org-agenda-archive-with 'org-archive-to-archive-sibling))
8412 (defun org-agenda-archive-with (cmd &optional confirm)
8413 "Move the entry to the archive sibling."
8414 (interactive)
8415 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
8416 (let* ((bufname-orig (buffer-name))
8417 (marker (or (org-get-at-bol 'org-marker)
8418 (org-agenda-error)))
8419 (buffer (marker-buffer marker))
8420 (pos (marker-position marker)))
8421 (org-with-remote-undo buffer
8422 (with-current-buffer buffer
8423 (if (derived-mode-p 'org-mode)
8424 (if (and confirm
8425 (not (y-or-n-p "Archive this subtree or entry? ")))
8426 (error "Abort")
8427 (save-window-excursion
8428 (goto-char pos)
8429 (let ((org-agenda-buffer-name bufname-orig))
8430 (org-remove-subtree-entries-from-agenda))
8431 (org-back-to-heading t)
8432 (funcall cmd)))
8433 (error "Archiving works only in Org-mode files"))))))
8435 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
8436 "Remove all lines in the agenda that correspond to a given subtree.
8437 The subtree is the one in buffer BUF, starting at BEG and ending at END.
8438 If this information is not given, the function uses the tree at point."
8439 (let ((buf (or buf (current-buffer))) m p)
8440 (save-excursion
8441 (unless (and beg end)
8442 (org-back-to-heading t)
8443 (setq beg (point))
8444 (org-end-of-subtree t)
8445 (setq end (point)))
8446 (set-buffer (get-buffer org-agenda-buffer-name))
8447 (save-excursion
8448 (goto-char (point-max))
8449 (beginning-of-line 1)
8450 (while (not (bobp))
8451 (when (and (setq m (org-get-at-bol 'org-marker))
8452 (equal buf (marker-buffer m))
8453 (setq p (marker-position m))
8454 (>= p beg)
8455 (< p end))
8456 (let ((inhibit-read-only t))
8457 (delete-region (point-at-bol) (1+ (point-at-eol)))))
8458 (beginning-of-line 0))))))
8460 (defun org-agenda-refile (&optional goto rfloc no-update)
8461 "Refile the item at point.
8463 When GOTO is 0 or '(64), clear the refile cache.
8464 When GOTO is '(16), go to the location of the last refiled item.
8465 RFLOC can be a refile location obtained in a different way.
8466 When NO-UPDATE is non-nil, don't redo the agenda buffer."
8467 (interactive "P")
8468 (cond
8469 ((member goto '(0 (64)))
8470 (org-refile-cache-clear))
8471 ((equal goto '(16))
8472 (org-refile-goto-last-stored))
8474 (let* ((buffer-orig (buffer-name))
8475 (marker (or (org-get-at-bol 'org-hd-marker)
8476 (org-agenda-error)))
8477 (buffer (marker-buffer marker))
8478 (pos (marker-position marker))
8479 (rfloc (or rfloc
8480 (org-refile-get-location
8481 (if goto "Goto" "Refile to") buffer
8482 org-refile-allow-creating-parent-nodes))))
8483 (with-current-buffer buffer
8484 (save-excursion
8485 (save-restriction
8486 (widen)
8487 (goto-char marker)
8488 (let ((org-agenda-buffer-name buffer-orig))
8489 (org-remove-subtree-entries-from-agenda))
8490 (org-refile goto buffer rfloc)))))
8491 (unless no-update (org-agenda-redo)))))
8493 (defun org-agenda-open-link (&optional arg)
8494 "Open the link(s) in the current entry, if any.
8495 This looks for a link in the displayed line in the agenda.
8496 It also looks at the text of the entry itself."
8497 (interactive "P")
8498 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
8499 (org-get-at-bol 'org-marker)))
8500 (buffer (and marker (marker-buffer marker)))
8501 (prefix (buffer-substring (point-at-bol) (point-at-eol)))
8502 (lkall (and buffer (org-offer-links-in-entry
8503 buffer marker arg prefix)))
8504 (lk0 (car lkall))
8505 (lk (if (stringp lk0) (list lk0) lk0))
8506 (lkend (cdr lkall))
8507 trg)
8508 (cond
8509 ((and buffer lk)
8510 (mapcar (lambda(l)
8511 (with-current-buffer buffer
8512 (setq trg (and (string-match org-bracket-link-regexp l)
8513 (match-string 1 l)))
8514 (if (or (not trg) (string-match org-any-link-re trg))
8515 (save-excursion
8516 (save-restriction
8517 (widen)
8518 (goto-char marker)
8519 (when (search-forward l nil lkend)
8520 (goto-char (match-beginning 0))
8521 (org-open-at-point))))
8522 ;; This is an internal link, widen the buffer
8523 (switch-to-buffer-other-window buffer)
8524 (widen)
8525 (goto-char marker)
8526 (when (search-forward l nil lkend)
8527 (goto-char (match-beginning 0))
8528 (org-open-at-point)))))
8529 lk))
8530 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
8531 (save-excursion
8532 (beginning-of-line 1)
8533 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
8534 (org-open-link-from-string (match-string 1)))
8535 (t (message "No link to open here")))))
8537 (defun org-agenda-copy-local-variable (var)
8538 "Get a variable from a referenced buffer and install it here."
8539 (let ((m (org-get-at-bol 'org-marker)))
8540 (when (and m (buffer-live-p (marker-buffer m)))
8541 (org-set-local var (with-current-buffer (marker-buffer m)
8542 (symbol-value var))))))
8544 (defun org-agenda-switch-to (&optional delete-other-windows)
8545 "Go to the Org-mode file which contains the item at point."
8546 (interactive)
8547 (if (and org-return-follows-link
8548 (not (org-get-at-bol 'org-marker))
8549 (org-in-regexp org-bracket-link-regexp))
8550 (org-open-link-from-string (match-string 0))
8551 (let* ((marker (or (org-get-at-bol 'org-marker)
8552 (org-agenda-error)))
8553 (buffer (marker-buffer marker))
8554 (pos (marker-position marker)))
8555 (org-pop-to-buffer-same-window buffer)
8556 (and delete-other-windows (delete-other-windows))
8557 (widen)
8558 (goto-char pos)
8559 (when (derived-mode-p 'org-mode)
8560 (org-show-context 'agenda)
8561 (save-excursion
8562 (and (outline-next-heading)
8563 (org-flag-heading nil))) ; show the next heading
8564 (when (outline-invisible-p)
8565 (show-entry)) ; display invisible text
8566 (run-hooks 'org-agenda-after-show-hook)))))
8568 (defun org-agenda-goto-mouse (ev)
8569 "Go to the Org-mode file which contains the item at the mouse click."
8570 (interactive "e")
8571 (mouse-set-point ev)
8572 (org-agenda-goto))
8574 (defun org-agenda-show (&optional full-entry)
8575 "Display the Org-mode file which contains the item at point.
8576 With prefix argument FULL-ENTRY, make the entire entry visible
8577 if it was hidden in the outline."
8578 (interactive "P")
8579 (let ((win (selected-window)))
8580 (if full-entry
8581 (let ((org-show-entry-below t))
8582 (org-agenda-goto t))
8583 (org-agenda-goto t))
8584 (select-window win)))
8586 (defvar org-agenda-show-window nil)
8587 (defun org-agenda-show-and-scroll-up (&optional arg)
8588 "Display the Org-mode file which contains the item at point.
8589 When called repeatedly, scroll the window that is displaying the buffer.
8590 With a \\[universal-argument] prefix, use `org-show-entry' instead of
8591 `show-subtree' to display the item, so that drawers and logbooks stay
8592 folded."
8593 (interactive "P")
8594 (let ((win (selected-window)))
8595 (if (and (window-live-p org-agenda-show-window)
8596 (eq this-command last-command))
8597 (progn
8598 (select-window org-agenda-show-window)
8599 (ignore-errors (scroll-up)))
8600 (org-agenda-goto t)
8601 (if arg (org-show-entry) (show-subtree))
8602 (setq org-agenda-show-window (selected-window)))
8603 (select-window win)))
8605 (defun org-agenda-show-scroll-down ()
8606 "Scroll down the window showing the agenda."
8607 (interactive)
8608 (let ((win (selected-window)))
8609 (when (window-live-p org-agenda-show-window)
8610 (select-window org-agenda-show-window)
8611 (ignore-errors (scroll-down))
8612 (select-window win))))
8614 (defun org-agenda-show-1 (&optional more)
8615 "Display the Org-mode file which contains the item at point.
8616 The prefix arg selects the amount of information to display:
8618 0 hide the subtree
8619 1 just show the entry according to defaults.
8620 2 show the children view
8621 3 show the subtree view
8622 4 show the entire subtree and any LOGBOOK drawers
8623 5 show the entire subtree and any drawers
8624 With prefix argument FULL-ENTRY, make the entire entry visible
8625 if it was hidden in the outline."
8626 (interactive "p")
8627 (let ((win (selected-window)))
8628 (org-agenda-goto t)
8629 (org-recenter-heading 1)
8630 (cond
8631 ((= more 0)
8632 (hide-subtree)
8633 (save-excursion
8634 (org-back-to-heading)
8635 (run-hook-with-args 'org-cycle-hook 'folded))
8636 (message "Remote: FOLDED"))
8637 ((and (org-called-interactively-p 'any) (= more 1))
8638 (message "Remote: show with default settings"))
8639 ((= more 2)
8640 (show-entry)
8641 (show-children)
8642 (save-excursion
8643 (org-back-to-heading)
8644 (run-hook-with-args 'org-cycle-hook 'children))
8645 (message "Remote: CHILDREN"))
8646 ((= more 3)
8647 (show-subtree)
8648 (save-excursion
8649 (org-back-to-heading)
8650 (run-hook-with-args 'org-cycle-hook 'subtree))
8651 (message "Remote: SUBTREE"))
8652 ((= more 4)
8653 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
8654 (org-drawer-regexp
8655 (concat "^[ \t]*:\\("
8656 (mapconcat 'regexp-quote org-drawers "\\|")
8657 "\\):[ \t]*$")))
8658 (show-subtree)
8659 (save-excursion
8660 (org-back-to-heading)
8661 (org-cycle-hide-drawers 'subtree)))
8662 (message "Remote: SUBTREE AND LOGBOOK"))
8663 ((> more 4)
8664 (show-subtree)
8665 (message "Remote: SUBTREE AND ALL DRAWERS")))
8666 (select-window win)))
8668 (defun org-recenter-heading (n)
8669 (save-excursion
8670 (org-back-to-heading)
8671 (recenter n)))
8673 (defvar org-agenda-cycle-counter nil)
8674 (defun org-agenda-cycle-show (&optional n)
8675 "Show the current entry in another window, with default settings.
8676 Default settings are taken from `org-show-hierarchy-above' and siblings.
8677 When use repeatedly in immediate succession, the remote entry will cycle
8678 through visibility
8680 children -> subtree -> folded
8682 When called with a numeric prefix arg, that arg will be passed through to
8683 `org-agenda-show-1'. For the interpretation of that argument, see the
8684 docstring of `org-agenda-show-1'."
8685 (interactive "P")
8686 (if (integerp n)
8687 (setq org-agenda-cycle-counter n)
8688 (if (not (eq last-command this-command))
8689 (setq org-agenda-cycle-counter 1)
8690 (if (equal org-agenda-cycle-counter 0)
8691 (setq org-agenda-cycle-counter 2)
8692 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
8693 (if (> org-agenda-cycle-counter 3)
8694 (setq org-agenda-cycle-counter 0)))))
8695 (org-agenda-show-1 org-agenda-cycle-counter))
8697 (defun org-agenda-recenter (arg)
8698 "Display the Org-mode file which contains the item at point and recenter."
8699 (interactive "P")
8700 (let ((win (selected-window)))
8701 (org-agenda-goto t)
8702 (recenter arg)
8703 (select-window win)))
8705 (defun org-agenda-show-mouse (ev)
8706 "Display the Org-mode file which contains the item at the mouse click."
8707 (interactive "e")
8708 (mouse-set-point ev)
8709 (org-agenda-show))
8711 (defun org-agenda-check-no-diary ()
8712 "Check if the entry is a diary link and abort if yes."
8713 (if (org-get-at-bol 'org-agenda-diary-link)
8714 (org-agenda-error)))
8716 (defun org-agenda-error ()
8717 (error "Command not allowed in this line"))
8719 (defun org-agenda-tree-to-indirect-buffer (arg)
8720 "Show the subtree corresponding to the current entry in an indirect buffer.
8721 This calls the command `org-tree-to-indirect-buffer' from the original buffer.
8723 With a numerical prefix ARG, go up to this level and then take that tree.
8724 With a negative numeric ARG, go up by this number of levels.
8725 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
8726 use the dedicated frame)."
8727 (interactive "P")
8728 (if current-prefix-arg
8729 (org-agenda-do-tree-to-indirect-buffer arg)
8730 (let ((agenda-buffer (buffer-name))
8731 (agenda-window (selected-window))
8732 (indirect-window
8733 (and org-last-indirect-buffer
8734 (get-buffer-window org-last-indirect-buffer))))
8735 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer arg))
8736 (unless (or (eq org-indirect-buffer-display 'new-frame)
8737 (eq org-indirect-buffer-display 'dedicated-frame))
8738 (unwind-protect
8739 (unless (and indirect-window (window-live-p indirect-window))
8740 (setq indirect-window (split-window agenda-window)))
8741 (and indirect-window (select-window indirect-window))
8742 (switch-to-buffer org-last-indirect-buffer :norecord)
8743 (fit-window-to-buffer indirect-window)))
8744 (select-window (get-buffer-window agenda-buffer)))))
8746 (defun org-agenda-do-tree-to-indirect-buffer (arg)
8747 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
8748 (org-agenda-check-no-diary)
8749 (let* ((marker (or (org-get-at-bol 'org-marker)
8750 (org-agenda-error)))
8751 (buffer (marker-buffer marker))
8752 (pos (marker-position marker)))
8753 (with-current-buffer buffer
8754 (save-excursion
8755 (goto-char pos)
8756 (funcall 'org-tree-to-indirect-buffer arg)))))
8758 (defvar org-last-heading-marker (make-marker)
8759 "Marker pointing to the headline that last changed its TODO state
8760 by a remote command from the agenda.")
8762 (defun org-agenda-todo-nextset ()
8763 "Switch TODO entry to next sequence."
8764 (interactive)
8765 (org-agenda-todo 'nextset))
8767 (defun org-agenda-todo-previousset ()
8768 "Switch TODO entry to previous sequence."
8769 (interactive)
8770 (org-agenda-todo 'previousset))
8772 (defun org-agenda-todo (&optional arg)
8773 "Cycle TODO state of line at point, also in Org-mode file.
8774 This changes the line at point, all other lines in the agenda referring to
8775 the same tree node, and the headline of the tree node in the Org-mode file."
8776 (interactive "P")
8777 (org-agenda-check-no-diary)
8778 (let* ((col (current-column))
8779 (marker (or (org-get-at-bol 'org-marker)
8780 (org-agenda-error)))
8781 (buffer (marker-buffer marker))
8782 (pos (marker-position marker))
8783 (hdmarker (org-get-at-bol 'org-hd-marker))
8784 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
8785 (inhibit-read-only t)
8786 org-agenda-headline-snapshot-before-repeat newhead just-one)
8787 (org-with-remote-undo buffer
8788 (with-current-buffer buffer
8789 (widen)
8790 (goto-char pos)
8791 (org-show-context 'agenda)
8792 (save-excursion
8793 (and (outline-next-heading)
8794 (org-flag-heading nil))) ; show the next heading
8795 (let ((current-prefix-arg arg))
8796 (call-interactively 'org-todo))
8797 (and (bolp) (forward-char 1))
8798 (setq newhead (org-get-heading))
8799 (when (and (org-bound-and-true-p
8800 org-agenda-headline-snapshot-before-repeat)
8801 (not (equal org-agenda-headline-snapshot-before-repeat
8802 newhead))
8803 todayp)
8804 (setq newhead org-agenda-headline-snapshot-before-repeat
8805 just-one t))
8806 (save-excursion
8807 (org-back-to-heading)
8808 (move-marker org-last-heading-marker (point))))
8809 (beginning-of-line 1)
8810 (save-window-excursion
8811 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
8812 (when (org-bound-and-true-p org-clock-out-when-done)
8813 (string-match (concat "^" (regexp-opt org-done-keywords-for-agenda))
8814 newhead)
8815 (org-agenda-unmark-clocking-task))
8816 (org-move-to-column col))))
8818 (defun org-agenda-add-note (&optional arg)
8819 "Add a time-stamped note to the entry at point."
8820 (interactive "P")
8821 (org-agenda-check-no-diary)
8822 (let* ((marker (or (org-get-at-bol 'org-marker)
8823 (org-agenda-error)))
8824 (buffer (marker-buffer marker))
8825 (pos (marker-position marker))
8826 (hdmarker (org-get-at-bol 'org-hd-marker))
8827 (inhibit-read-only t))
8828 (with-current-buffer buffer
8829 (widen)
8830 (goto-char pos)
8831 (org-show-context 'agenda)
8832 (save-excursion
8833 (and (outline-next-heading)
8834 (org-flag-heading nil))) ; show the next heading
8835 (org-add-note))))
8837 (defun org-agenda-change-all-lines (newhead hdmarker
8838 &optional fixface just-this)
8839 "Change all lines in the agenda buffer which match HDMARKER.
8840 The new content of the line will be NEWHEAD (as modified by
8841 `org-agenda-format-item'). HDMARKER is checked with
8842 `equal' against all `org-hd-marker' text properties in the file.
8843 If FIXFACE is non-nil, the face of each item is modified according to
8844 the new TODO state.
8845 If JUST-THIS is non-nil, change just the current line, not all.
8846 If FORCE-TAGS is non nil, the car of it returns the new tags."
8847 (let* ((inhibit-read-only t)
8848 (line (org-current-line))
8849 (org-agenda-buffer (current-buffer))
8850 (thetags (with-current-buffer (marker-buffer hdmarker)
8851 (save-excursion (save-restriction (widen)
8852 (goto-char hdmarker)
8853 (org-get-tags-at)))))
8854 props m pl undone-face done-face finish new dotime level cat tags)
8855 (save-excursion
8856 (goto-char (point-max))
8857 (beginning-of-line 1)
8858 (while (not finish)
8859 (setq finish (bobp))
8860 (when (and (setq m (org-get-at-bol 'org-hd-marker))
8861 (or (not just-this) (= (org-current-line) line))
8862 (equal m hdmarker))
8863 (setq props (text-properties-at (point))
8864 dotime (org-get-at-bol 'dotime)
8865 cat (org-get-at-bol 'org-category)
8866 level (org-get-at-bol 'level)
8867 tags thetags
8869 (let ((org-prefix-format-compiled
8870 (or (get-text-property (min (1- (point-max)) (point)) 'format)
8871 org-prefix-format-compiled))
8872 (extra (org-get-at-bol 'extra)))
8873 (with-current-buffer (marker-buffer hdmarker)
8874 (save-excursion
8875 (save-restriction
8876 (widen)
8877 (org-agenda-format-item extra newhead level cat tags dotime)))))
8878 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
8879 undone-face (org-get-at-bol 'undone-face)
8880 done-face (org-get-at-bol 'done-face))
8881 (beginning-of-line 1)
8882 (cond
8883 ((equal new "")
8884 (and (looking-at ".*\n?") (replace-match "")))
8885 ((looking-at ".*")
8886 (replace-match new t t)
8887 (beginning-of-line 1)
8888 (add-text-properties (point-at-bol) (point-at-eol) props)
8889 (when fixface
8890 (add-text-properties
8891 (point-at-bol) (point-at-eol)
8892 (list 'face
8893 (if org-last-todo-state-is-todo
8894 undone-face done-face))))
8895 (org-agenda-highlight-todo 'line)
8896 (beginning-of-line 1))
8897 (t (error "Line update did not work")))
8898 (save-restriction
8899 (narrow-to-region (point-at-bol) (point-at-eol))
8900 (org-agenda-finalize)))
8901 (beginning-of-line 0)))))
8903 (defun org-agenda-align-tags (&optional line)
8904 "Align all tags in agenda items to `org-agenda-tags-column'."
8905 (let ((inhibit-read-only t) l c)
8906 (save-excursion
8907 (goto-char (if line (point-at-bol) (point-min)))
8908 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
8909 (if line (point-at-eol) nil) t)
8910 (add-text-properties
8911 (match-beginning 2) (match-end 2)
8912 (list 'face (delq nil (let ((prop (get-text-property
8913 (match-beginning 2) 'face)))
8914 (or (listp prop) (setq prop (list prop)))
8915 (if (memq 'org-tag prop)
8916 prop
8917 (cons 'org-tag prop))))))
8918 (setq l (- (match-end 2) (match-beginning 2))
8919 c (if (< org-agenda-tags-column 0)
8920 (- (abs org-agenda-tags-column) l)
8921 org-agenda-tags-column))
8922 (delete-region (match-beginning 1) (match-end 1))
8923 (goto-char (match-beginning 1))
8924 (insert (org-add-props
8925 (make-string (max 1 (- c (current-column))) ?\ )
8926 (plist-put (copy-sequence (text-properties-at (point)))
8927 'face nil))))
8928 (goto-char (point-min))
8929 (org-font-lock-add-tag-faces (point-max)))))
8931 (defun org-agenda-priority-up ()
8932 "Increase the priority of line at point, also in Org-mode file."
8933 (interactive)
8934 (org-agenda-priority 'up))
8936 (defun org-agenda-priority-down ()
8937 "Decrease the priority of line at point, also in Org-mode file."
8938 (interactive)
8939 (org-agenda-priority 'down))
8941 (defun org-agenda-priority (&optional force-direction)
8942 "Set the priority of line at point, also in Org-mode file.
8943 This changes the line at point, all other lines in the agenda referring to
8944 the same tree node, and the headline of the tree node in the Org-mode file.
8945 Called with a universal prefix arg, show the priority instead of setting it."
8946 (interactive "P")
8947 (if (equal force-direction '(4))
8948 (org-show-priority)
8949 (unless org-enable-priority-commands
8950 (error "Priority commands are disabled"))
8951 (org-agenda-check-no-diary)
8952 (let* ((col (current-column))
8953 (marker (or (org-get-at-bol 'org-marker)
8954 (org-agenda-error)))
8955 (hdmarker (org-get-at-bol 'org-hd-marker))
8956 (buffer (marker-buffer hdmarker))
8957 (pos (marker-position hdmarker))
8958 (inhibit-read-only t)
8959 newhead)
8960 (org-with-remote-undo buffer
8961 (with-current-buffer buffer
8962 (widen)
8963 (goto-char pos)
8964 (org-show-context 'agenda)
8965 (save-excursion
8966 (and (outline-next-heading)
8967 (org-flag-heading nil))) ; show the next heading
8968 (funcall 'org-priority force-direction)
8969 (end-of-line 1)
8970 (setq newhead (org-get-heading)))
8971 (org-agenda-change-all-lines newhead hdmarker)
8972 (org-move-to-column col)))))
8974 ;; FIXME: should fix the tags property of the agenda line.
8975 (defun org-agenda-set-tags (&optional tag onoff)
8976 "Set tags for the current headline."
8977 (interactive)
8978 (org-agenda-check-no-diary)
8979 (if (and (org-region-active-p) (org-called-interactively-p 'any))
8980 (call-interactively 'org-change-tag-in-region)
8981 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
8982 (org-agenda-error)))
8983 (buffer (marker-buffer hdmarker))
8984 (pos (marker-position hdmarker))
8985 (inhibit-read-only t)
8986 newhead)
8987 (org-with-remote-undo buffer
8988 (with-current-buffer buffer
8989 (widen)
8990 (goto-char pos)
8991 (save-excursion
8992 (org-show-context 'agenda))
8993 (save-excursion
8994 (and (outline-next-heading)
8995 (org-flag-heading nil))) ; show the next heading
8996 (goto-char pos)
8997 (if tag
8998 (org-toggle-tag tag onoff)
8999 (call-interactively 'org-set-tags))
9000 (end-of-line 1)
9001 (setq newhead (org-get-heading)))
9002 (org-agenda-change-all-lines newhead hdmarker)
9003 (beginning-of-line 1)))))
9005 (defun org-agenda-set-property ()
9006 "Set a property for the current headline."
9007 (interactive)
9008 (org-agenda-check-no-diary)
9009 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9010 (org-agenda-error)))
9011 (buffer (marker-buffer hdmarker))
9012 (pos (marker-position hdmarker))
9013 (inhibit-read-only t)
9014 newhead)
9015 (org-with-remote-undo buffer
9016 (with-current-buffer buffer
9017 (widen)
9018 (goto-char pos)
9019 (save-excursion
9020 (org-show-context 'agenda))
9021 (save-excursion
9022 (and (outline-next-heading)
9023 (org-flag-heading nil))) ; show the next heading
9024 (goto-char pos)
9025 (call-interactively 'org-set-property)))))
9027 (defun org-agenda-set-effort ()
9028 "Set the effort property for the current headline."
9029 (interactive)
9030 (org-agenda-check-no-diary)
9031 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9032 (org-agenda-error)))
9033 (buffer (marker-buffer hdmarker))
9034 (pos (marker-position hdmarker))
9035 (inhibit-read-only t)
9036 newhead)
9037 (org-with-remote-undo buffer
9038 (with-current-buffer buffer
9039 (widen)
9040 (goto-char pos)
9041 (save-excursion
9042 (org-show-context 'agenda))
9043 (save-excursion
9044 (and (outline-next-heading)
9045 (org-flag-heading nil))) ; show the next heading
9046 (goto-char pos)
9047 (call-interactively 'org-set-effort)
9048 (end-of-line 1)
9049 (setq newhead (org-get-heading)))
9050 (org-agenda-change-all-lines newhead hdmarker))))
9052 (defun org-agenda-toggle-archive-tag ()
9053 "Toggle the archive tag for the current entry."
9054 (interactive)
9055 (org-agenda-check-no-diary)
9056 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
9057 (org-agenda-error)))
9058 (buffer (marker-buffer hdmarker))
9059 (pos (marker-position hdmarker))
9060 (inhibit-read-only t)
9061 newhead)
9062 (org-with-remote-undo buffer
9063 (with-current-buffer buffer
9064 (widen)
9065 (goto-char pos)
9066 (org-show-context 'agenda)
9067 (save-excursion
9068 (and (outline-next-heading)
9069 (org-flag-heading nil))) ; show the next heading
9070 (call-interactively 'org-toggle-archive-tag)
9071 (end-of-line 1)
9072 (setq newhead (org-get-heading)))
9073 (org-agenda-change-all-lines newhead hdmarker)
9074 (beginning-of-line 1))))
9076 (defun org-agenda-do-date-later (arg)
9077 (interactive "P")
9078 (cond
9079 ((or (equal arg '(16))
9080 (memq last-command
9081 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9082 (setq this-command 'org-agenda-date-later-minutes)
9083 (org-agenda-date-later-minutes 1))
9084 ((or (equal arg '(4))
9085 (memq last-command
9086 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9087 (setq this-command 'org-agenda-date-later-hours)
9088 (org-agenda-date-later-hours 1))
9090 (org-agenda-date-later (prefix-numeric-value arg)))))
9092 (defun org-agenda-do-date-earlier (arg)
9093 (interactive "P")
9094 (cond
9095 ((or (equal arg '(16))
9096 (memq last-command
9097 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
9098 (setq this-command 'org-agenda-date-earlier-minutes)
9099 (org-agenda-date-earlier-minutes 1))
9100 ((or (equal arg '(4))
9101 (memq last-command
9102 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
9103 (setq this-command 'org-agenda-date-earlier-hours)
9104 (org-agenda-date-earlier-hours 1))
9106 (org-agenda-date-earlier (prefix-numeric-value arg)))))
9108 (defun org-agenda-date-later (arg &optional what)
9109 "Change the date of this item to ARG day(s) later."
9110 (interactive "p")
9111 (org-agenda-check-type t 'agenda 'timeline)
9112 (org-agenda-check-no-diary)
9113 (let* ((marker (or (org-get-at-bol 'org-marker)
9114 (org-agenda-error)))
9115 (buffer (marker-buffer marker))
9116 (pos (marker-position marker))
9117 cdate today)
9118 (org-with-remote-undo buffer
9119 (with-current-buffer buffer
9120 (widen)
9121 (goto-char pos)
9122 (if (not (org-at-timestamp-p))
9123 (error "Cannot find time stamp"))
9124 (when (and org-agenda-move-date-from-past-immediately-to-today
9125 (equal arg 1)
9126 (or (not what) (eq what 'day))
9127 (not (save-match-data (org-at-date-range-p))))
9128 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
9129 cdate (calendar-absolute-from-gregorian
9130 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
9131 today (org-today))
9132 (if (> today cdate)
9133 ;; immediately shift to today
9134 (setq arg (- today cdate))))
9135 (org-timestamp-change arg (or what 'day))
9136 (when (and (org-at-date-range-p)
9137 (re-search-backward org-tr-regexp-both (point-at-bol)))
9138 (let ((end org-last-changed-timestamp))
9139 (org-timestamp-change arg (or what 'day))
9140 (setq org-last-changed-timestamp
9141 (concat org-last-changed-timestamp "--" end)))))
9142 (org-agenda-show-new-time marker org-last-changed-timestamp))
9143 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9145 (defun org-agenda-date-earlier (arg &optional what)
9146 "Change the date of this item to ARG day(s) earlier."
9147 (interactive "p")
9148 (org-agenda-date-later (- arg) what))
9150 (defun org-agenda-date-later-minutes (arg)
9151 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9152 (interactive "p")
9153 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9154 (org-agenda-date-later arg 'minute))
9156 (defun org-agenda-date-earlier-minutes (arg)
9157 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
9158 (interactive "p")
9159 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
9160 (org-agenda-date-earlier arg 'minute))
9162 (defun org-agenda-date-later-hours (arg)
9163 "Change the time of this item, in hour steps."
9164 (interactive "p")
9165 (org-agenda-date-later arg 'hour))
9167 (defun org-agenda-date-earlier-hours (arg)
9168 "Change the time of this item, in hour steps."
9169 (interactive "p")
9170 (org-agenda-date-earlier arg 'hour))
9172 (defun org-agenda-show-new-time (marker stamp &optional prefix)
9173 "Show new date stamp via text properties."
9174 ;; We use text properties to make this undoable
9175 (let ((inhibit-read-only t))
9176 (setq stamp (concat prefix " => " stamp " "))
9177 (save-excursion
9178 (goto-char (point-max))
9179 (while (not (bobp))
9180 (when (equal marker (org-get-at-bol 'org-marker))
9181 (remove-text-properties (point-at-bol) (point-at-eol) '(display))
9182 (org-move-to-column (- (window-width) (length stamp)) t)
9184 (org-agenda-fix-tags-filter-overlays-at (point))
9185 (if (featurep 'xemacs)
9186 ;; Use `duplicable' property to trigger undo recording
9187 (let ((ex (make-extent nil nil))
9188 (gl (make-glyph stamp)))
9189 (set-glyph-face gl 'secondary-selection)
9190 (set-extent-properties
9191 ex (list 'invisible t 'end-glyph gl 'duplicable t))
9192 (insert-extent ex (1- (point)) (point-at-eol)))
9193 (add-text-properties
9194 (1- (point)) (point-at-eol)
9195 (list 'display (org-add-props stamp nil
9196 'face 'secondary-selection))))
9197 (beginning-of-line 1))
9198 (beginning-of-line 0)))))
9200 (defun org-agenda-date-prompt (arg)
9201 "Change the date of this item. Date is prompted for, with default today.
9202 The prefix ARG is passed to the `org-time-stamp' command and can therefore
9203 be used to request time specification in the time stamp."
9204 (interactive "P")
9205 (org-agenda-check-type t 'agenda 'timeline)
9206 (org-agenda-check-no-diary)
9207 (let* ((marker (or (org-get-at-bol 'org-marker)
9208 (org-agenda-error)))
9209 (buffer (marker-buffer marker))
9210 (pos (marker-position marker)))
9211 (org-with-remote-undo buffer
9212 (with-current-buffer buffer
9213 (widen)
9214 (goto-char pos)
9215 (if (not (org-at-timestamp-p t))
9216 (error "Cannot find time stamp"))
9217 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
9218 (org-agenda-show-new-time marker org-last-changed-timestamp))
9219 (message "Time stamp changed to %s" org-last-changed-timestamp)))
9221 (defun org-agenda-schedule (arg &optional time)
9222 "Schedule the item at point.
9223 ARG is passed through to `org-schedule'."
9224 (interactive "P")
9225 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9226 (org-agenda-check-no-diary)
9227 (let* ((marker (or (org-get-at-bol 'org-marker)
9228 (org-agenda-error)))
9229 (type (marker-insertion-type marker))
9230 (buffer (marker-buffer marker))
9231 (pos (marker-position marker))
9232 (org-insert-labeled-timestamps-at-point nil)
9234 (set-marker-insertion-type marker t)
9235 (org-with-remote-undo buffer
9236 (with-current-buffer buffer
9237 (widen)
9238 (goto-char pos)
9239 (setq ts (org-schedule arg time)))
9240 (org-agenda-show-new-time marker ts " S"))
9241 (message "%s" ts)))
9243 (defun org-agenda-deadline (arg &optional time)
9244 "Schedule the item at point.
9245 ARG is passed through to `org-deadline'."
9246 (interactive "P")
9247 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
9248 (org-agenda-check-no-diary)
9249 (let* ((marker (or (org-get-at-bol 'org-marker)
9250 (org-agenda-error)))
9251 (buffer (marker-buffer marker))
9252 (pos (marker-position marker))
9253 (org-insert-labeled-timestamps-at-point nil)
9255 (org-with-remote-undo buffer
9256 (with-current-buffer buffer
9257 (widen)
9258 (goto-char pos)
9259 (setq ts (org-deadline arg time)))
9260 (org-agenda-show-new-time marker ts " D"))
9261 (message "%s" ts)))
9263 (defun org-agenda-clock-in (&optional arg)
9264 "Start the clock on the currently selected item."
9265 (interactive "P")
9266 (org-agenda-check-no-diary)
9267 (if (equal arg '(4))
9268 (org-clock-in arg)
9269 (let* ((marker (or (org-get-at-bol 'org-marker)
9270 (org-agenda-error)))
9271 (hdmarker (or (org-get-at-bol 'org-hd-marker) marker))
9272 (pos (marker-position marker))
9273 (col (current-column))
9274 newhead)
9275 (org-with-remote-undo (marker-buffer marker)
9276 (with-current-buffer (marker-buffer marker)
9277 (widen)
9278 (goto-char pos)
9279 (org-show-context 'agenda)
9280 (org-show-entry)
9281 (org-cycle-hide-drawers 'children)
9282 (org-clock-in arg)
9283 (setq newhead (org-get-heading)))
9284 (org-agenda-change-all-lines newhead hdmarker))
9285 (org-move-to-column col))))
9287 (defun org-agenda-clock-out ()
9288 "Stop the currently running clock."
9289 (interactive)
9290 (unless (marker-buffer org-clock-marker)
9291 (error "No running clock"))
9292 (let ((marker (make-marker)) (col (current-column)) newhead)
9293 (org-with-remote-undo (marker-buffer org-clock-marker)
9294 (with-current-buffer (marker-buffer org-clock-marker)
9295 (save-excursion
9296 (save-restriction
9297 (widen)
9298 (goto-char org-clock-marker)
9299 (org-back-to-heading t)
9300 (move-marker marker (point))
9301 (org-clock-out)
9302 (setq newhead (org-get-heading))))))
9303 (org-agenda-change-all-lines newhead marker)
9304 (move-marker marker nil)
9305 (org-move-to-column col)
9306 (org-agenda-unmark-clocking-task)))
9308 (defun org-agenda-clock-cancel (&optional arg)
9309 "Cancel the currently running clock."
9310 (interactive "P")
9311 (unless (marker-buffer org-clock-marker)
9312 (user-error "No running clock"))
9313 (org-with-remote-undo (marker-buffer org-clock-marker)
9314 (org-clock-cancel)))
9316 (defun org-agenda-clock-goto ()
9317 "Jump to the currently clocked in task within the agenda.
9318 If the currently clocked in task is not listed in the agenda
9319 buffer, display it in another window."
9320 (interactive)
9321 (let (pos)
9322 (mapc (lambda (o)
9323 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
9324 (setq pos (overlay-start o))))
9325 (overlays-in (point-min) (point-max)))
9326 (cond (pos (goto-char pos))
9327 ;; If the currently clocked entry is not in the agenda
9328 ;; buffer, we visit it in another window:
9329 (org-clock-current-task
9330 (org-switch-to-buffer-other-window (org-clock-goto)))
9331 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
9333 (defun org-agenda-diary-entry-in-org-file ()
9334 "Make a diary entry in the file `org-agenda-diary-file'."
9335 (let (d1 d2 char (text "") dp1 dp2)
9336 (if (equal (buffer-name) "*Calendar*")
9337 (setq d1 (calendar-cursor-to-date t)
9338 d2 (car calendar-mark-ring))
9339 (setq dp1 (get-text-property (point-at-bol) 'day))
9340 (unless dp1 (user-error "No date defined in current line"))
9341 (setq d1 (calendar-gregorian-from-absolute dp1)
9342 d2 (and (ignore-errors (mark))
9343 (save-excursion
9344 (goto-char (mark))
9345 (setq dp2 (get-text-property (point-at-bol) 'day)))
9346 (calendar-gregorian-from-absolute dp2))))
9347 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
9348 (setq char (read-char-exclusive))
9349 (cond
9350 ((equal char ?d)
9351 (setq text (read-string "Day entry: "))
9352 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
9353 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9354 ((equal char ?a)
9355 (setq d1 (list (car d1) (nth 1 d1)
9356 (read-number (format "Reference year [%d]: " (nth 2 d1))
9357 (nth 2 d1))))
9358 (setq text (read-string "Anniversary (use %d to show years): "))
9359 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
9360 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9361 ((equal char ?b)
9362 (setq text (read-string "Block entry: "))
9363 (unless (and d1 d2 (not (equal d1 d2)))
9364 (user-error "No block of days selected"))
9365 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
9366 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
9367 ((equal char ?j)
9368 (org-switch-to-buffer-other-window
9369 (find-file-noselect org-agenda-diary-file))
9370 (require 'org-datetree)
9371 (org-datetree-find-date-create d1)
9372 (org-reveal t))
9373 (t (user-error "Invalid selection character `%c'" char)))))
9375 (defcustom org-agenda-insert-diary-strategy 'date-tree
9376 "Where in `org-agenda-diary-file' should new entries be added?
9377 Valid values:
9379 date-tree in the date tree, as child of the date
9380 top-level as top-level entries at the end of the file."
9381 :group 'org-agenda
9382 :type '(choice
9383 (const :tag "in a date tree" date-tree)
9384 (const :tag "as top level at end of file" top-level)))
9386 (defcustom org-agenda-insert-diary-extract-time nil
9387 "Non-nil means extract any time specification from the diary entry."
9388 :group 'org-agenda
9389 :version "24.1"
9390 :type 'boolean)
9392 (defcustom org-agenda-bulk-mark-char ">"
9393 "A single-character string to be used as the bulk mark."
9394 :group 'org-agenda
9395 :version "24.1"
9396 :type 'string)
9398 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
9399 "Add a diary entry with TYPE to `org-agenda-diary-file'.
9400 If TEXT is not empty, it will become the headline of the new entry, and
9401 the resulting entry will not be shown. When TEXT is empty, switch to
9402 `org-agenda-diary-file' and let the user finish the entry there."
9403 (let ((cw (current-window-configuration)))
9404 (org-switch-to-buffer-other-window
9405 (find-file-noselect org-agenda-diary-file))
9406 (widen)
9407 (goto-char (point-min))
9408 (cond
9409 ((eq type 'anniversary)
9410 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
9411 (progn
9412 (or (org-at-heading-p t)
9413 (progn
9414 (outline-next-heading)
9415 (insert "* Anniversaries\n\n")
9416 (beginning-of-line -1)))))
9417 (outline-next-heading)
9418 (org-back-over-empty-lines)
9419 (backward-char 1)
9420 (insert "\n")
9421 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
9422 (nth 2 d1) (car d1) (nth 1 d1) text)))
9423 ((eq type 'day)
9424 (let ((org-prefix-has-time t)
9425 (org-agenda-time-leading-zero t)
9426 fmt time time2)
9427 (if org-agenda-insert-diary-extract-time
9428 ;; Use org-agenda-format-item to parse text for a time-range and
9429 ;; remove it. FIXME: This is a hack, we should refactor
9430 ;; that function to make time extraction available separately
9431 (setq fmt (org-agenda-format-item nil text nil nil nil t)
9432 time (get-text-property 0 'time fmt)
9433 time2 (if (> (length time) 0)
9434 ;; split-string removes trailing ...... if
9435 ;; no end time given. First space
9436 ;; separates time from date.
9437 (concat " " (car (split-string time "\\.")))
9438 nil)
9439 text (get-text-property 0 'txt fmt)))
9440 (if (eq org-agenda-insert-diary-strategy 'top-level)
9441 (org-agenda-insert-diary-as-top-level text)
9442 (require 'org-datetree)
9443 (org-datetree-find-date-create d1)
9444 (org-agenda-insert-diary-make-new-entry text))
9445 (org-insert-time-stamp (org-time-from-absolute
9446 (calendar-absolute-from-gregorian d1))
9447 nil nil nil nil time2))
9448 (end-of-line 0))
9449 ((eq type 'block)
9450 (if (> (calendar-absolute-from-gregorian d1)
9451 (calendar-absolute-from-gregorian d2))
9452 (setq d1 (prog1 d2 (setq d2 d1))))
9453 (if (eq org-agenda-insert-diary-strategy 'top-level)
9454 (org-agenda-insert-diary-as-top-level text)
9455 (require 'org-datetree)
9456 (org-datetree-find-date-create d1)
9457 (org-agenda-insert-diary-make-new-entry text))
9458 (org-insert-time-stamp (org-time-from-absolute
9459 (calendar-absolute-from-gregorian d1)))
9460 (insert "--")
9461 (org-insert-time-stamp (org-time-from-absolute
9462 (calendar-absolute-from-gregorian d2)))
9463 (end-of-line 0)))
9464 (if (string-match "\\S-" text)
9465 (progn
9466 (set-window-configuration cw)
9467 (message "%s entry added to %s"
9468 (capitalize (symbol-name type))
9469 (abbreviate-file-name org-agenda-diary-file)))
9470 (org-reveal t)
9471 (message "Please finish entry here"))))
9473 (defun org-agenda-insert-diary-as-top-level (text)
9474 "Make new entry as a top-level entry at the end of the file.
9475 Add TEXT as headline, and position the cursor in the second line so that
9476 a timestamp can be added there."
9477 (widen)
9478 (goto-char (point-max))
9479 (or (bolp) (insert "\n"))
9480 (insert "* " text "\n")
9481 (if org-adapt-indentation (org-indent-to-column 2)))
9483 (defun org-agenda-insert-diary-make-new-entry (text)
9484 "Make new entry as last child of current entry.
9485 Add TEXT as headline, and position the cursor in the second line so that
9486 a timestamp can be added there."
9487 (let ((org-show-following-heading t)
9488 (org-show-siblings t)
9489 (org-show-hierarchy-above t)
9490 (org-show-entry-below t)
9491 col)
9492 (outline-next-heading)
9493 (org-back-over-empty-lines)
9494 (or (looking-at "[ \t]*$")
9495 (progn (insert "\n") (backward-char 1)))
9496 (org-insert-heading nil t)
9497 (org-do-demote)
9498 (setq col (current-column))
9499 (insert text "\n")
9500 (if org-adapt-indentation (org-indent-to-column col))
9501 (let ((org-show-following-heading t)
9502 (org-show-siblings t)
9503 (org-show-hierarchy-above t)
9504 (org-show-entry-below t))
9505 (org-show-context))))
9507 (defun org-agenda-diary-entry ()
9508 "Make a diary entry, like the `i' command from the calendar.
9509 All the standard commands work: block, weekly etc.
9510 When `org-agenda-diary-file' points to a file,
9511 `org-agenda-diary-entry-in-org-file' is called instead to create
9512 entries in that Org-mode file."
9513 (interactive)
9514 (if (not (eq org-agenda-diary-file 'diary-file))
9515 (org-agenda-diary-entry-in-org-file)
9516 (require 'diary-lib)
9517 (let* ((char (progn
9518 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
9519 (read-char-exclusive)))
9520 (cmd (cdr (assoc char
9521 '((?d . insert-diary-entry)
9522 (?w . insert-weekly-diary-entry)
9523 (?m . insert-monthly-diary-entry)
9524 (?y . insert-yearly-diary-entry)
9525 (?a . insert-anniversary-diary-entry)
9526 (?b . insert-block-diary-entry)
9527 (?c . insert-cyclic-diary-entry)))))
9528 (oldf (symbol-function 'calendar-cursor-to-date))
9529 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
9530 (point (point))
9531 (mark (or (mark t) (point))))
9532 (unless cmd
9533 (user-error "No command associated with <%c>" char))
9534 (unless (and (get-text-property point 'day)
9535 (or (not (equal ?b char))
9536 (get-text-property mark 'day)))
9537 (user-error "Don't know which date to use for diary entry"))
9538 ;; We implement this by hacking the `calendar-cursor-to-date' function
9539 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
9540 (let ((calendar-mark-ring
9541 (list (calendar-gregorian-from-absolute
9542 (or (get-text-property mark 'day)
9543 (get-text-property point 'day))))))
9544 (unwind-protect
9545 (progn
9546 (fset 'calendar-cursor-to-date
9547 (lambda (&optional error dummy)
9548 (calendar-gregorian-from-absolute
9549 (get-text-property point 'day))))
9550 (call-interactively cmd))
9551 (fset 'calendar-cursor-to-date oldf))))))
9553 (defun org-agenda-execute-calendar-command (cmd)
9554 "Execute a calendar command from the agenda with date from cursor."
9555 (org-agenda-check-type t 'agenda 'timeline)
9556 (require 'diary-lib)
9557 (unless (get-text-property (min (1- (point-max)) (point)) 'day)
9558 (user-error "Don't know which date to use for the calendar command"))
9559 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
9560 (point (point))
9561 (date (calendar-gregorian-from-absolute
9562 (get-text-property point 'day)))
9563 ;; the following 2 vars are needed in the calendar
9564 (displayed-month (car date))
9565 (displayed-year (nth 2 date)))
9566 (unwind-protect
9567 (progn
9568 (fset 'calendar-cursor-to-date
9569 (lambda (&optional error dummy)
9570 (calendar-gregorian-from-absolute
9571 (get-text-property point 'day))))
9572 (call-interactively cmd))
9573 (fset 'calendar-cursor-to-date oldf))))
9575 (defun org-agenda-phases-of-moon ()
9576 "Display the phases of the moon for the 3 months around the cursor date."
9577 (interactive)
9578 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
9580 (defun org-agenda-holidays ()
9581 "Display the holidays for the 3 months around the cursor date."
9582 (interactive)
9583 (org-agenda-execute-calendar-command 'list-calendar-holidays))
9585 (defvar calendar-longitude) ; defined in calendar.el
9586 (defvar calendar-latitude) ; defined in calendar.el
9587 (defvar calendar-location-name) ; defined in calendar.el
9589 (defun org-agenda-sunrise-sunset (arg)
9590 "Display sunrise and sunset for the cursor date.
9591 Latitude and longitude can be specified with the variables
9592 `calendar-latitude' and `calendar-longitude'. When called with prefix
9593 argument, latitude and longitude will be prompted for."
9594 (interactive "P")
9595 (require 'solar)
9596 (let ((calendar-longitude (if arg nil calendar-longitude))
9597 (calendar-latitude (if arg nil calendar-latitude))
9598 (calendar-location-name
9599 (if arg "the given coordinates" calendar-location-name)))
9600 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
9602 (defun org-agenda-goto-calendar ()
9603 "Open the Emacs calendar with the date at the cursor."
9604 (interactive)
9605 (org-agenda-check-type t 'agenda 'timeline)
9606 (let* ((day (or (get-text-property (min (1- (point-max)) (point)) 'day)
9607 (user-error "Don't know which date to open in calendar")))
9608 (date (calendar-gregorian-from-absolute day))
9609 (calendar-move-hook nil)
9610 (calendar-view-holidays-initially-flag nil)
9611 (calendar-view-diary-initially-flag nil))
9612 (calendar)
9613 (calendar-goto-date date)))
9615 ;;;###autoload
9616 (defun org-calendar-goto-agenda ()
9617 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
9618 This is a command that has to be installed in `calendar-mode-map'."
9619 (interactive)
9620 (org-agenda-list nil (calendar-absolute-from-gregorian
9621 (calendar-cursor-to-date))
9622 nil))
9624 (defun org-agenda-convert-date ()
9625 (interactive)
9626 (org-agenda-check-type t 'agenda 'timeline)
9627 (let ((day (get-text-property (min (1- (point-max)) (point)) 'day))
9628 date s)
9629 (unless day
9630 (user-error "Don't know which date to convert"))
9631 (setq date (calendar-gregorian-from-absolute day))
9632 (setq s (concat
9633 "Gregorian: " (calendar-date-string date) "\n"
9634 "ISO: " (calendar-iso-date-string date) "\n"
9635 "Day of Yr: " (calendar-day-of-year-string date) "\n"
9636 "Julian: " (calendar-julian-date-string date) "\n"
9637 "Astron. JD: " (calendar-astro-date-string date)
9638 " (Julian date number at noon UTC)\n"
9639 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
9640 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
9641 "French: " (calendar-french-date-string date) "\n"
9642 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
9643 "Mayan: " (calendar-mayan-date-string date) "\n"
9644 "Coptic: " (calendar-coptic-date-string date) "\n"
9645 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
9646 "Persian: " (calendar-persian-date-string date) "\n"
9647 "Chinese: " (calendar-chinese-date-string date) "\n"))
9648 (with-output-to-temp-buffer "*Dates*"
9649 (princ s))
9650 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
9652 ;;; Bulk commands
9654 (defun org-agenda-bulk-marked-p ()
9655 (eq (get-char-property (point-at-bol) 'type)
9656 'org-marked-entry-overlay))
9658 (defun org-agenda-bulk-mark (&optional arg)
9659 "Mark the entry at point for future bulk action."
9660 (interactive "p")
9661 (dotimes (i (or arg 1))
9662 (unless (org-get-at-bol 'org-agenda-diary-link)
9663 (let* ((m (org-get-at-bol 'org-hd-marker))
9665 (unless (org-agenda-bulk-marked-p)
9666 (unless m (user-error "Nothing to mark at point"))
9667 (push m org-agenda-bulk-marked-entries)
9668 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
9669 (org-overlay-display ov (concat org-agenda-bulk-mark-char " ")
9670 (org-get-todo-face "TODO")
9671 'evaporate)
9672 (overlay-put ov 'type 'org-marked-entry-overlay))
9673 (end-of-line 1)
9674 (or (ignore-errors
9675 (goto-char (next-single-property-change (point) 'txt)))
9676 (beginning-of-line 2))
9677 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9678 (beginning-of-line 2))
9679 (message "%d entries marked for bulk action"
9680 (length org-agenda-bulk-marked-entries))))))
9682 (defun org-agenda-bulk-mark-all ()
9683 "Mark all entries for future agenda bulk action."
9684 (interactive)
9685 (org-agenda-bulk-mark-regexp "."))
9687 (defun org-agenda-bulk-mark-regexp (regexp)
9688 "Mark entries matching REGEXP for future agenda bulk action."
9689 (interactive "sMark entries matching regexp: ")
9690 (let ((entries-marked 0) txt-at-point)
9691 (save-excursion
9692 (goto-char (point-min))
9693 (goto-char (next-single-property-change (point) 'txt))
9694 (while (and (re-search-forward regexp nil t)
9695 (setq txt-at-point (get-text-property (point) 'txt)))
9696 (when (string-match regexp txt-at-point)
9697 (setq entries-marked (1+ entries-marked))
9698 (call-interactively 'org-agenda-bulk-mark))))
9699 (if (not entries-marked)
9700 (message "No entry matching this regexp."))))
9702 (defun org-agenda-bulk-unmark (&optional arg)
9703 "Unmark the entry at point for future bulk action."
9704 (interactive "P")
9705 (if arg
9706 (org-agenda-bulk-unmark-all)
9707 (cond ((org-agenda-bulk-marked-p)
9708 (org-agenda-bulk-remove-overlays
9709 (point-at-bol) (+ 2 (point-at-bol)))
9710 (setq org-agenda-bulk-marked-entries
9711 (delete (org-get-at-bol 'org-hd-marker)
9712 org-agenda-bulk-marked-entries))
9713 (end-of-line 1)
9714 (or (ignore-errors
9715 (goto-char (next-single-property-change (point) 'txt)))
9716 (beginning-of-line 2))
9717 (while (and (get-char-property (point) 'invisible) (not (eobp)))
9718 (beginning-of-line 2))
9719 (message "%d entries left marked for bulk action"
9720 (length org-agenda-bulk-marked-entries)))
9721 (t (message "No entry to unmark here")))))
9723 (defun org-agenda-bulk-toggle-all ()
9724 "Toggle all marks for bulk action."
9725 (interactive)
9726 (save-excursion
9727 (goto-char (point-min))
9728 (while (ignore-errors
9729 (goto-char (next-single-property-change (point) 'txt)))
9730 (org-agenda-bulk-toggle))))
9732 (defun org-agenda-bulk-toggle ()
9733 "Toggle the mark at point for bulk action."
9734 (interactive)
9735 (if (org-agenda-bulk-marked-p)
9736 (org-agenda-bulk-unmark)
9737 (org-agenda-bulk-mark)))
9739 (defun org-agenda-bulk-remove-overlays (&optional beg end)
9740 "Remove the mark overlays between BEG and END in the agenda buffer.
9741 BEG and END default to the buffer limits.
9743 This only removes the overlays, it does not remove the markers
9744 from the list in `org-agenda-bulk-marked-entries'."
9745 (interactive)
9746 (mapc (lambda (ov)
9747 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
9748 (delete-overlay ov)))
9749 (overlays-in (or beg (point-min)) (or end (point-max)))))
9751 (defun org-agenda-bulk-unmark-all ()
9752 "Remove all marks in the agenda buffer.
9753 This will remove the markers and the overlays."
9754 (interactive)
9755 (if (null org-agenda-bulk-marked-entries)
9756 (message "No entry to unmark")
9757 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
9758 (setq org-agenda-bulk-marked-entries nil)
9759 (org-agenda-bulk-remove-overlays (point-min) (point-max))))
9761 (defcustom org-agenda-persistent-marks nil
9762 "Non-nil means marked items will stay marked after a bulk action.
9763 You can toggle this interactively by typing `p' when prompted for a
9764 bulk action."
9765 :group 'org-agenda
9766 :version "24.1"
9767 :type 'boolean)
9769 (defun org-agenda-bulk-action (&optional arg)
9770 "Execute an remote-editing action on all marked entries.
9771 The prefix arg is passed through to the command if possible."
9772 (interactive "P")
9773 ;; Make sure we have markers, and only valid ones
9774 (unless org-agenda-bulk-marked-entries (user-error "No entries are marked"))
9775 (mapc
9776 (lambda (m)
9777 (unless (and (markerp m)
9778 (marker-buffer m)
9779 (buffer-live-p (marker-buffer m))
9780 (marker-position m))
9781 (user-error "Marker %s for bulk command is invalid" m)))
9782 org-agenda-bulk-marked-entries)
9784 ;; Prompt for the bulk command
9785 (let* ((msg (if org-agenda-persistent-marks "Bulk (persistent): " "Bulk: ")))
9786 (message (concat msg "[$]arch [A]rch->sib [t]odo [+/-]tag [s]chd [d]eadline [r]efile "
9787 "[S]catter [f]unction "
9788 (when org-agenda-bulk-custom-functions
9789 (concat " Custom: ["
9790 (mapconcat (lambda(f) (char-to-string (car f)))
9791 org-agenda-bulk-custom-functions "")
9792 "]"))))
9793 (catch 'exit
9794 (let* ((action (read-char-exclusive))
9795 (org-log-refile (if org-log-refile 'time nil))
9796 (entries (reverse org-agenda-bulk-marked-entries))
9797 (org-overriding-default-time
9798 (if (get-text-property (point) 'org-agenda-date-header)
9799 (org-get-cursor-date)))
9800 redo-at-end
9801 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
9802 (cond
9803 ((equal action ?p)
9804 (let ((org-agenda-persistent-marks
9805 (not org-agenda-persistent-marks)))
9806 (org-agenda-bulk-action)
9807 (throw 'exit nil)))
9809 ((equal action ?$)
9810 (setq cmd '(org-agenda-archive)))
9812 ((equal action ?A)
9813 (setq cmd '(org-agenda-archive-to-archive-sibling)))
9815 ((member action '(?r ?w))
9816 (setq rfloc (org-refile-get-location
9817 "Refile to"
9818 (marker-buffer (car entries))
9819 org-refile-allow-creating-parent-nodes))
9820 (if (nth 3 rfloc)
9821 (setcar (nthcdr 3 rfloc)
9822 (move-marker (make-marker) (nth 3 rfloc)
9823 (or (get-file-buffer (nth 1 rfloc))
9824 (find-buffer-visiting (nth 1 rfloc))
9825 (error "This should not happen")))))
9827 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
9828 redo-at-end t))
9830 ((equal action ?t)
9831 (setq state (org-icompleting-read
9832 "Todo state: "
9833 (with-current-buffer (marker-buffer (car entries))
9834 (mapcar 'list org-todo-keywords-1))))
9835 (setq cmd `(let ((org-inhibit-blocking t)
9836 (org-inhibit-logging 'note))
9837 (org-agenda-todo ,state))))
9839 ((memq action '(?- ?+))
9840 (setq tag (org-icompleting-read
9841 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
9842 (with-current-buffer (marker-buffer (car entries))
9843 (delq nil
9844 (mapcar (lambda (x)
9845 (if (stringp (car x)) x)) org-tag-alist)))))
9846 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
9848 ((memq action '(?s ?d))
9849 (let* ((time
9850 (unless arg
9851 (org-read-date
9852 nil nil nil
9853 (if (eq action ?s) "(Re)Schedule to" "(Re)Set Deadline to")
9854 org-overriding-default-time)))
9855 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
9856 (setq cmd `(eval '(,c1 arg ,time)))))
9858 ((equal action ?S)
9859 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
9860 (user-error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
9861 (let ((days (read-number
9862 (format "Scatter tasks across how many %sdays: "
9863 (if arg "week" "")) 7)))
9864 (setq cmd
9865 `(let ((distance (1+ (random ,days))))
9866 (if arg
9867 (let ((dist distance)
9868 (day-of-week
9869 (calendar-day-of-week
9870 (calendar-gregorian-from-absolute (org-today)))))
9871 (dotimes (i (1+ dist))
9872 (while (member day-of-week org-agenda-weekend-days)
9873 (incf distance)
9874 (incf day-of-week)
9875 (if (= day-of-week 7)
9876 (setq day-of-week 0)))
9877 (incf day-of-week)
9878 (if (= day-of-week 7)
9879 (setq day-of-week 0)))))
9880 ;; silently fail when try to replan a sexp entry
9881 (condition-case nil
9882 (let* ((date (calendar-gregorian-from-absolute
9883 (+ (org-today) distance)))
9884 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
9885 (nth 2 date))))
9886 (org-agenda-schedule nil time))
9887 (error nil)))))))
9889 ((assoc action org-agenda-bulk-custom-functions)
9890 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
9891 redo-at-end t))
9893 ((equal action ?f)
9894 (setq cmd (list (intern
9895 (org-icompleting-read "Function: "
9896 obarray 'fboundp t nil nil)))))
9898 (t (user-error "Invalid bulk action")))
9900 ;; Sort the markers, to make sure that parents are handled before children
9901 (setq entries (sort entries
9902 (lambda (a b)
9903 (cond
9904 ((equal (marker-buffer a) (marker-buffer b))
9905 (< (marker-position a) (marker-position b)))
9907 (string< (buffer-name (marker-buffer a))
9908 (buffer-name (marker-buffer b))))))))
9910 ;; Now loop over all markers and apply cmd
9911 (while (setq e (pop entries))
9912 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
9913 (if (not pos)
9914 (progn (message "Skipping removed entry at %s" e)
9915 (setq cntskip (1+ cntskip)))
9916 (goto-char pos)
9917 (let (org-loop-over-headlines-in-active-region)
9918 (eval cmd))
9919 (setq cnt (1+ cnt))))
9920 (when redo-at-end (org-agenda-redo))
9921 (unless org-agenda-persistent-marks
9922 (org-agenda-bulk-unmark-all))
9923 (message "Acted on %d entries%s%s"
9925 (if (= cntskip 0)
9927 (format ", skipped %d (disappeared before their turn)"
9928 cntskip))
9929 (if (not org-agenda-persistent-marks)
9930 "" " (kept marked)"))))))
9932 (defun org-agenda-capture (&optional with-time)
9933 "Call `org-capture' with the date at point.
9934 With a `C-1' prefix, use the HH:MM value at point (if any) or the
9935 current HH:MM time."
9936 (interactive "P")
9937 (if (not (eq major-mode 'org-agenda-mode))
9938 (user-error "You cannot do this outside of agenda buffers")
9939 (let ((org-overriding-default-time
9940 (org-get-cursor-date (equal with-time 1))))
9941 (call-interactively 'org-capture))))
9943 ;;; Dragging agenda lines forward/backward
9945 (defun org-agenda-reapply-filters ()
9946 "Re-apply all agenda filters."
9947 (mapcar
9948 (lambda(f) (when (car f) (org-agenda-filter-apply (car f) (cadr f))))
9949 `((,org-agenda-tag-filter tag)
9950 (,org-agenda-category-filter category)
9951 (,org-agenda-regexp-filter regexp)
9952 (,(get 'org-agenda-tag-filter :preset-filter) tag)
9953 (,(get 'org-agenda-category-filter :preset-filter) category)
9954 (,(get 'org-agenda-regexp-filter :preset-filter) regexp))))
9956 (defun org-agenda-drag-line-forward (arg &optional backward)
9957 "Drag an agenda line forward by ARG lines.
9958 When the optional argument `backward' is non-nil, move backward."
9959 (interactive "p")
9960 (let ((inhibit-read-only t) lst line)
9961 (if (or (not (get-text-property (point) 'txt))
9962 (save-excursion
9963 (dotimes (n arg)
9964 (move-beginning-of-line (if backward 0 2))
9965 (push (not (get-text-property (point) 'txt)) lst))
9966 (delq nil lst)))
9967 (message "Cannot move line forward")
9968 (let ((end (save-excursion (move-beginning-of-line 2) (point))))
9969 (move-beginning-of-line 1)
9970 (setq line (buffer-substring (point) end))
9971 (delete-region (point) end)
9972 (move-beginning-of-line (funcall (if backward '1- '1+) arg))
9973 (insert line)
9974 (org-agenda-reapply-filters)
9975 (org-agenda-mark-clocking-task)
9976 (move-beginning-of-line 0)))))
9978 (defun org-agenda-drag-line-backward (arg)
9979 "Drag an agenda line backward by ARG lines."
9980 (interactive "p")
9981 (org-agenda-drag-line-forward arg t))
9983 ;;; Flagging notes
9985 (defun org-agenda-show-the-flagging-note ()
9986 "Display the flagging note in the other window.
9987 When called a second time in direct sequence, offer to remove the FLAGGING
9988 tag and (if present) the flagging note."
9989 (interactive)
9990 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
9991 (win (selected-window))
9992 note heading newhead)
9993 (unless hdmarker
9994 (user-error "No linked entry at point"))
9995 (if (and (eq this-command last-command)
9996 (y-or-n-p "Unflag and remove any flagging note? "))
9997 (progn
9998 (org-agenda-remove-flag hdmarker)
9999 (let ((win (get-buffer-window "*Flagging Note*")))
10000 (and win (delete-window win)))
10001 (message "Entry unflagged"))
10002 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
10003 (unless note
10004 (user-error "No flagging note"))
10005 (org-kill-new note)
10006 (org-switch-to-buffer-other-window "*Flagging Note*")
10007 (erase-buffer)
10008 (insert note)
10009 (goto-char (point-min))
10010 (while (re-search-forward "\\\\n" nil t)
10011 (replace-match "\n" t t))
10012 (goto-char (point-min))
10013 (select-window win)
10014 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
10016 (defun org-agenda-remove-flag (marker)
10017 "Remove the FLAGGED tag and any flagging note in the entry."
10018 (let (newhead)
10019 (org-with-point-at marker
10020 (org-toggle-tag "FLAGGED" 'off)
10021 (org-entry-delete nil "THEFLAGGINGNOTE")
10022 (setq newhead (org-get-heading)))
10023 (org-agenda-change-all-lines newhead marker)
10024 (message "Entry unflagged")))
10026 (defun org-agenda-get-any-marker (&optional pos)
10027 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
10028 (get-text-property (or pos (point-at-bol)) 'org-marker)))
10030 ;;; Appointment reminders
10032 (defvar appt-time-msg-list) ; defined in appt.el
10034 ;;;###autoload
10035 (defun org-agenda-to-appt (&optional refresh filter &rest args)
10036 "Activate appointments found in `org-agenda-files'.
10037 With a \\[universal-argument] prefix, refresh the list of
10038 appointments.
10040 If FILTER is t, interactively prompt the user for a regular
10041 expression, and filter out entries that don't match it.
10043 If FILTER is a string, use this string as a regular expression
10044 for filtering entries out.
10046 If FILTER is a function, filter out entries against which
10047 calling the function returns nil. This function takes one
10048 argument: an entry from `org-agenda-get-day-entries'.
10050 FILTER can also be an alist with the car of each cell being
10051 either 'headline or 'category. For example:
10053 '((headline \"IMPORTANT\")
10054 (category \"Work\"))
10056 will only add headlines containing IMPORTANT or headlines
10057 belonging to the \"Work\" category.
10059 ARGS are symbols indicating what kind of entries to consider.
10060 By default `org-agenda-to-appt' will use :deadline*, :scheduled*
10061 \(i.e., deadlines and scheduled items with a hh:mm specification)
10062 and :timestamp entries. See the docstring of `org-diary' for
10063 details and examples.
10065 If an entry has a APPT_WARNTIME property, its value will be used
10066 to override `appt-message-warning-time'."
10067 (interactive "P")
10068 (if refresh (setq appt-time-msg-list nil))
10069 (if (eq filter t)
10070 (setq filter (read-from-minibuffer "Regexp filter: ")))
10071 (let* ((cnt 0) ; count added events
10072 (scope (or args '(:deadline* :scheduled* :timestamp)))
10073 (org-agenda-new-buffers nil)
10074 (org-deadline-warning-days 0)
10075 ;; Do not use `org-today' here because appt only takes
10076 ;; time and without date as argument, so it may pass wrong
10077 ;; information otherwise
10078 (today (org-date-to-gregorian
10079 (time-to-days (current-time))))
10080 (org-agenda-restrict nil)
10081 (files (org-agenda-files 'unrestricted)) entries file
10082 (org-agenda-buffer nil))
10083 ;; Get all entries which may contain an appt
10084 (org-agenda-prepare-buffers files)
10085 (while (setq file (pop files))
10086 (setq entries
10087 (delq nil
10088 (append entries
10089 (apply 'org-agenda-get-day-entries
10090 file today scope)))))
10091 ;; Map thru entries and find if we should filter them out
10092 (mapc
10093 (lambda(x)
10094 (let* ((evt (org-trim
10095 (replace-regexp-in-string
10096 org-bracket-link-regexp "\\3"
10097 (or (get-text-property 1 'txt x) ""))))
10098 (cat (get-text-property 1 'org-category x))
10099 (tod (get-text-property 1 'time-of-day x))
10100 (ok (or (null filter)
10101 (and (stringp filter) (string-match filter evt))
10102 (and (functionp filter) (funcall filter x))
10103 (and (listp filter)
10104 (let ((cat-filter (cadr (assoc 'category filter)))
10105 (evt-filter (cadr (assoc 'headline filter))))
10106 (or (and (stringp cat-filter)
10107 (string-match cat-filter cat))
10108 (and (stringp evt-filter)
10109 (string-match evt-filter evt)))))))
10110 (wrn (get-text-property 1 'warntime x)))
10111 ;; FIXME: Shall we remove text-properties for the appt text?
10112 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
10113 (when (and ok tod)
10114 (setq tod (concat "00" (number-to-string tod))
10115 tod (when (string-match
10116 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
10117 (concat (match-string 1 tod) ":"
10118 (match-string 2 tod))))
10119 (if (version< emacs-version "23.3")
10120 (appt-add tod evt)
10121 (appt-add tod evt wrn))
10122 (setq cnt (1+ cnt))))) entries)
10123 (org-release-buffers org-agenda-new-buffers)
10124 (if (eq cnt 0)
10125 (message "No event to add")
10126 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
10128 (defun org-agenda-todayp (date)
10129 "Does DATE mean today, when considering `org-extend-today-until'?"
10130 (let ((today (org-today))
10131 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
10132 date)))
10133 (eq date today)))
10135 (defun org-agenda-todo-yesterday (&optional arg)
10136 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday."
10137 (interactive "P")
10138 (let* ((hour (third (decode-time
10139 (org-current-time))))
10140 (org-extend-today-until (1+ hour)))
10141 (org-agenda-todo arg)))
10143 (provide 'org-agenda)
10145 ;;; org-agenda.el ends here