Clean up local variable stuff and document sticky agenda buffers
[org-mode.git] / lisp / org-agenda.el
blob26787eec421518f0adf5d04c5a134fb856306142
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
3 ;; Copyright (C) 2004-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
29 ;; The functions `org-batch-agenda', `org-batch-agenda-csv', and
30 ;; `org-batch-store-agenda-views' are implemented as macros to provide
31 ;; a convenient way for extracting agenda information from the command
32 ;; line. The Lisp does not evaluate parameters of a macro call; thus
33 ;; it is not necessary to quote the parameters passed to one of those
34 ;; functions. E.g. you can write:
36 ;; emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
38 ;; To export an agenda spanning 7 days. If `org-batch-agenda' would
39 ;; have been implemented as a regular function you'd have to quote the
40 ;; symbol org-agenda-span. Moreover: To use a symbol as parameter
41 ;; value you would have to double quote the symbol.
43 ;; This is a hack, but it works even when running Org byte-compiled.
46 ;;; Code:
48 (require 'org)
49 (eval-when-compile
50 (require 'cl))
52 (declare-function diary-add-to-list "diary-lib"
53 (date string specifier &optional marker globcolor literal))
54 (declare-function calendar-absolute-from-iso "cal-iso" (date))
55 (declare-function calendar-astro-date-string "cal-julian" (&optional date))
56 (declare-function calendar-bahai-date-string "cal-bahai" (&optional date))
57 (declare-function calendar-chinese-date-string "cal-china" (&optional date))
58 (declare-function calendar-coptic-date-string "cal-coptic" (&optional date))
59 (declare-function calendar-ethiopic-date-string "cal-coptic" (&optional date))
60 (declare-function calendar-french-date-string "cal-french" (&optional date))
61 (declare-function calendar-goto-date "cal-move" (date))
62 (declare-function calendar-hebrew-date-string "cal-hebrew" (&optional date))
63 (declare-function calendar-islamic-date-string "cal-islam" (&optional date))
64 (declare-function calendar-iso-date-string "cal-iso" (&optional date))
65 (declare-function calendar-iso-from-absolute "cal-iso" (date))
66 (declare-function calendar-julian-date-string "cal-julian" (&optional date))
67 (declare-function calendar-mayan-date-string "cal-mayan" (&optional date))
68 (declare-function calendar-persian-date-string "cal-persia" (&optional date))
69 (declare-function calendar-check-holidays "holidays" (date))
71 (declare-function org-datetree-find-date-create "org-datetree"
72 (date &optional keep-restriction))
73 (declare-function org-columns-quit "org-colview" ())
74 (declare-function diary-date-display-form "diary-lib" (&optional type))
75 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
76 (declare-function org-habit-insert-consistency-graphs
77 "org-habit" (&optional line))
78 (declare-function org-is-habit-p "org-habit" (&optional pom))
79 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
80 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
81 (declare-function org-pop-to-buffer-same-window "org-compat"
82 (&optional buffer-or-name norecord label))
84 (defvar calendar-mode-map)
85 (defvar org-clock-current-task) ; defined in org-clock.el
86 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
87 (defvar org-habit-show-habits)
88 (defvar org-habit-show-habits-only-for-today)
90 ;; Defined somewhere in this file, but used before definition.
91 (defvar org-agenda-buffer-name)
92 (defvar org-agenda-overriding-header)
93 (defvar org-agenda-title-append nil)
94 (defvar entry)
95 (defvar date)
96 (defvar org-agenda-undo-list)
97 (defvar org-agenda-pending-undo-list)
98 (defvar original-date) ; dynamically scoped, calendar.el does scope this
100 (defcustom org-agenda-confirm-kill 1
101 "When set, remote killing from the agenda buffer needs confirmation.
102 When t, a confirmation is always needed. When a number N, confirmation is
103 only needed when the text to be killed contains more than N non-white lines."
104 :group 'org-agenda
105 :type '(choice
106 (const :tag "Never" nil)
107 (const :tag "Always" t)
108 (integer :tag "When more than N lines")))
110 (defcustom org-agenda-compact-blocks nil
111 "Non-nil means make the block agenda more compact.
112 This is done globally by leaving out lines like the agenda span
113 name and week number or the separator lines."
114 :group 'org-agenda
115 :type 'boolean)
117 (defcustom org-agenda-block-separator ?=
118 "The separator between blocks in the agenda.
119 If this is a string, it will be used as the separator, with a newline added.
120 If it is a character, it will be repeated to fill the window width.
121 If nil the separator is disabled. In `org-agenda-custom-commands' this
122 addresses the separator between the current and the previous block."
123 :group 'org-agenda
124 :type '(choice
125 (const :tag "Disabled" nil)
126 (character)
127 (string)))
129 (defgroup org-agenda-export nil
130 "Options concerning exporting agenda views in Org-mode."
131 :tag "Org Agenda Export"
132 :group 'org-agenda)
134 (defcustom org-agenda-with-colors t
135 "Non-nil means use colors in agenda views."
136 :group 'org-agenda-export
137 :type 'boolean)
139 (defcustom org-agenda-exporter-settings nil
140 "Alist of variable/value pairs that should be active during agenda export.
141 This is a good place to set options for ps-print and for htmlize.
142 Note that the way this is implemented, the values will be evaluated
143 before assigned to the variables. So make sure to quote values you do
144 *not* want evaluated, for example
146 (setq org-agenda-exporter-settings
147 '((ps-print-color-p 'black-white)))"
148 :group 'org-agenda-export
149 :type '(repeat
150 (list
151 (variable)
152 (sexp :tag "Value"))))
154 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
155 "Hook run in temporary buffer before writing it to an export file.
156 A useful function is `org-agenda-add-entry-text'."
157 :group 'org-agenda-export
158 :type 'hook
159 :options '(org-agenda-add-entry-text))
161 (defcustom org-agenda-add-entry-text-maxlines 0
162 "Maximum number of entry text lines to be added to agenda.
163 This is only relevant when `org-agenda-add-entry-text' is part of
164 `org-agenda-before-write-hook', which it is by default.
165 When this is 0, nothing will happen. When it is greater than 0, it
166 specifies the maximum number of lines that will be added for each entry
167 that is listed in the agenda view.
169 Note that this variable is not used during display, only when exporting
170 the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
171 and `org-agenda-entry-text-maxlines'."
172 :group 'org-agenda
173 :type 'integer)
175 (defcustom org-agenda-add-entry-text-descriptive-links t
176 "Non-nil means export org-links as descriptive links in agenda added text.
177 This variable applies to the text added to the agenda when
178 `org-agenda-add-entry-text-maxlines' is larger than 0.
179 When this variable nil, the URL will (also) be shown."
180 :group 'org-agenda
181 :type 'boolean)
183 (defcustom org-agenda-export-html-style ""
184 "The style specification for exported HTML Agenda files.
185 If this variable contains a string, it will replace the default <style>
186 section as produced by `htmlize'.
187 Since there are different ways of setting style information, this variable
188 needs to contain the full HTML structure to provide a style, including the
189 surrounding HTML tags. The style specifications should include definitions
190 the fonts used by the agenda, here is an example:
192 <style type=\"text/css\">
193 p { font-weight: normal; color: gray; }
194 .org-agenda-structure {
195 font-size: 110%;
196 color: #003399;
197 font-weight: 600;
199 .org-todo {
200 color: #cc6666;
201 font-weight: bold;
203 .org-agenda-done {
204 color: #339933;
206 .org-done {
207 color: #339933;
209 .title { text-align: center; }
210 .todo, .deadline { color: red; }
211 .done { color: green; }
212 </style>
214 or, if you want to keep the style in a file,
216 <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
218 As the value of this option simply gets inserted into the HTML <head> header,
219 you can \"misuse\" it to also add other text to the header. However,
220 <style>...</style> is required, if not present the variable will be ignored."
221 :group 'org-agenda-export
222 :group 'org-export-html
223 :type 'string)
225 (defcustom org-agenda-persistent-filter nil
226 "When set, keep filters from one agenda view to the next."
227 :group 'org-agenda
228 :type 'boolean)
230 (defgroup org-agenda-custom-commands nil
231 "Options concerning agenda views in Org-mode."
232 :tag "Org Agenda Custom Commands"
233 :group 'org-agenda)
235 (defconst org-sorting-choice
236 '(choice
237 (const time-up) (const time-down)
238 (const category-keep) (const category-up) (const category-down)
239 (const tag-down) (const tag-up)
240 (const priority-up) (const priority-down)
241 (const todo-state-up) (const todo-state-down)
242 (const effort-up) (const effort-down)
243 (const habit-up) (const habit-down)
244 (const alpha-up) (const alpha-down)
245 (const user-defined-up) (const user-defined-down))
246 "Sorting choices.")
248 ;; Keep custom values for `org-agenda-filter-preset' compatible with
249 ;; the new variable `org-agenda-tag-filter-preset'.
250 (if (fboundp 'defvaralias)
251 (defvaralias 'org-agenda-filter-preset 'org-agenda-tag-filter-preset)
252 (defvaralias 'org-agenda-filter 'org-agenda-tag-filter))
254 (defconst org-agenda-custom-commands-local-options
255 `(repeat :tag "Local settings for this command. Remember to quote values"
256 (choice :tag "Setting"
257 (list :tag "Heading for this block"
258 (const org-agenda-overriding-header)
259 (string :tag "Headline"))
260 (list :tag "Files to be searched"
261 (const org-agenda-files)
262 (list
263 (const :format "" quote)
264 (repeat (file))))
265 (list :tag "Sorting strategy"
266 (const org-agenda-sorting-strategy)
267 (list
268 (const :format "" quote)
269 (repeat
270 ,org-sorting-choice)))
271 (list :tag "Prefix format"
272 (const org-agenda-prefix-format :value " %-12:c%?-12t% s")
273 (string))
274 (list :tag "Number of days in agenda"
275 (const org-agenda-span)
276 (choice (const :tag "Day" 'day)
277 (const :tag "Week" 'week)
278 (const :tag "Month" 'month)
279 (const :tag "Year" 'year)
280 (integer :tag "Custom")))
281 (list :tag "Fixed starting date"
282 (const org-agenda-start-day)
283 (string :value "2007-11-01"))
284 (list :tag "Start on day of week"
285 (const org-agenda-start-on-weekday)
286 (choice :value 1
287 (const :tag "Today" nil)
288 (integer :tag "Weekday No.")))
289 (list :tag "Include data from diary"
290 (const org-agenda-include-diary)
291 (boolean))
292 (list :tag "Deadline Warning days"
293 (const org-deadline-warning-days)
294 (integer :value 1))
295 (list :tag "Category filter preset"
296 (const org-agenda-category-filter-preset)
297 (list
298 (const :format "" quote)
299 (repeat
300 (string :tag "+category or -category"))))
301 (list :tag "Tags filter preset"
302 (const org-agenda-tag-filter-preset)
303 (list
304 (const :format "" quote)
305 (repeat
306 (string :tag "+tag or -tag"))))
307 (list :tag "Set daily/weekly entry types"
308 (const org-agenda-entry-types)
309 (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
310 (const :deadline)
311 (const :scheduled)
312 (const :timestamp)
313 (const :sexp)))
314 (list :tag "Standard skipping condition"
315 :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
316 (const org-agenda-skip-function)
317 (list
318 (const :format "" quote)
319 (list
320 (choice
321 :tag "Skipping range"
322 (const :tag "Skip entry" org-agenda-skip-entry-if)
323 (const :tag "Skip subtree" org-agenda-skip-subtree-if))
324 (repeat :inline t :tag "Conditions for skipping"
325 (choice
326 :tag "Condition type"
327 (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
328 (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
329 (list :tag "TODO state is" :inline t
330 (const 'todo)
331 (choice
332 (const :tag "any not-done state" 'todo)
333 (const :tag "any done state" 'done)
334 (const :tag "any state" 'any)
335 (list :tag "Keyword list"
336 (const :format "" quote)
337 (repeat (string :tag "Keyword")))))
338 (list :tag "TODO state is not" :inline t
339 (const 'nottodo)
340 (choice
341 (const :tag "any not-done state" 'todo)
342 (const :tag "any done state" 'done)
343 (const :tag "any state" 'any)
344 (list :tag "Keyword list"
345 (const :format "" quote)
346 (repeat (string :tag "Keyword")))))
347 (const :tag "scheduled" 'scheduled)
348 (const :tag "not scheduled" 'notscheduled)
349 (const :tag "deadline" 'deadline)
350 (const :tag "no deadline" 'notdeadline)
351 (const :tag "timestamp" 'timestamp)
352 (const :tag "no timestamp" 'nottimestamp))))))
353 (list :tag "Non-standard skipping condition"
354 :value (org-agenda-skip-function)
355 (const org-agenda-skip-function)
356 (sexp :tag "Function or form (quoted!)"))
357 (list :tag "Any variable"
358 (variable :tag "Variable")
359 (sexp :tag "Value (sexp)"))))
360 "Selection of examples for agenda command settings.
361 This will be spliced into the custom type of
362 `org-agenda-custom-commands'.")
365 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
366 ((agenda "") (alltodo))))
367 "Custom commands for the agenda.
368 These commands will be offered on the splash screen displayed by the
369 agenda dispatcher \\[org-agenda]. Each entry is a list like this:
371 (key desc type match settings files)
373 key The key (one or more characters as a string) to be associated
374 with the command.
375 desc A description of the command, when omitted or nil, a default
376 description is built using MATCH.
377 type The command type, any of the following symbols:
378 agenda The daily/weekly agenda.
379 todo Entries with a specific TODO keyword, in all agenda files.
380 search Entries containing search words entry or headline.
381 tags Tags/Property/TODO match in all agenda files.
382 tags-todo Tags/P/T match in all agenda files, TODO entries only.
383 todo-tree Sparse tree of specific TODO keyword in *current* file.
384 tags-tree Sparse tree with all tags matches in *current* file.
385 occur-tree Occur sparse tree for *current* file.
386 ... A user-defined function.
387 match What to search for:
388 - a single keyword for TODO keyword searches
389 - a tags match expression for tags searches
390 - a word search expression for text searches.
391 - a regular expression for occur searches
392 For all other commands, this should be the empty string.
393 settings A list of option settings, similar to that in a let form, so like
394 this: ((opt1 val1) (opt2 val2) ...). The values will be
395 evaluated at the moment of execution, so quote them when needed.
396 files A list of files file to write the produced agenda buffer to
397 with the command `org-store-agenda-views'.
398 If a file name ends in \".html\", an HTML version of the buffer
399 is written out. If it ends in \".ps\", a postscript version is
400 produced. Otherwise, only the plain text is written to the file.
402 You can also define a set of commands, to create a composite agenda buffer.
403 In this case, an entry looks like this:
405 (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
407 where
409 desc A description string to be displayed in the dispatcher menu.
410 cmd An agenda command, similar to the above. However, tree commands
411 are not allowed, but instead you can get agenda and global todo list.
412 So valid commands for a set are:
413 (agenda \"\" settings)
414 (alltodo \"\" settings)
415 (stuck \"\" settings)
416 (todo \"match\" settings files)
417 (search \"match\" settings files)
418 (tags \"match\" settings files)
419 (tags-todo \"match\" settings files)
421 Each command can carry a list of options, and another set of options can be
422 given for the whole set of commands. Individual command options take
423 precedence over the general options.
425 When using several characters as key to a command, the first characters
426 are prefix commands. For the dispatcher to display useful information, you
427 should provide a description for the prefix, like
429 (setq org-agenda-custom-commands
430 '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
431 (\"hl\" tags \"+HOME+Lisa\")
432 (\"hp\" tags \"+HOME+Peter\")
433 (\"hk\" tags \"+HOME+Kim\")))"
434 :group 'org-agenda-custom-commands
435 :type `(repeat
436 (choice :value ("x" "Describe command here" tags "" nil)
437 (list :tag "Single command"
438 (string :tag "Access Key(s) ")
439 (option (string :tag "Description"))
440 (choice
441 (const :tag "Agenda" agenda)
442 (const :tag "TODO list" alltodo)
443 (const :tag "Search words" search)
444 (const :tag "Stuck projects" stuck)
445 (const :tag "Tags/Property match (all agenda files)" tags)
446 (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
447 (const :tag "TODO keyword search (all agenda files)" todo)
448 (const :tag "Tags sparse tree (current buffer)" tags-tree)
449 (const :tag "TODO keyword tree (current buffer)" todo-tree)
450 (const :tag "Occur tree (current buffer)" occur-tree)
451 (sexp :tag "Other, user-defined function"))
452 (string :tag "Match (only for some commands)")
453 ,org-agenda-custom-commands-local-options
454 (option (repeat :tag "Export" (file :tag "Export to"))))
455 (list :tag "Command series, all agenda files"
456 (string :tag "Access Key(s)")
457 (string :tag "Description ")
458 (repeat :tag "Component"
459 (choice
460 (list :tag "Agenda"
461 (const :format "" agenda)
462 (const :tag "" :format "" "")
463 ,org-agenda-custom-commands-local-options)
464 (list :tag "TODO list (all keywords)"
465 (const :format "" alltodo)
466 (const :tag "" :format "" "")
467 ,org-agenda-custom-commands-local-options)
468 (list :tag "Search words"
469 (const :format "" search)
470 (string :tag "Match")
471 ,org-agenda-custom-commands-local-options)
472 (list :tag "Stuck projects"
473 (const :format "" stuck)
474 (const :tag "" :format "" "")
475 ,org-agenda-custom-commands-local-options)
476 (list :tag "Tags search"
477 (const :format "" tags)
478 (string :tag "Match")
479 ,org-agenda-custom-commands-local-options)
480 (list :tag "Tags search, TODO entries only"
481 (const :format "" tags-todo)
482 (string :tag "Match")
483 ,org-agenda-custom-commands-local-options)
484 (list :tag "TODO keyword search"
485 (const :format "" todo)
486 (string :tag "Match")
487 ,org-agenda-custom-commands-local-options)
488 (list :tag "Other, user-defined function"
489 (symbol :tag "function")
490 (string :tag "Match")
491 ,org-agenda-custom-commands-local-options)))
493 (repeat :tag "Settings for entire command set"
494 (list (variable :tag "Any variable")
495 (sexp :tag "Value")))
496 (option (repeat :tag "Export" (file :tag "Export to"))))
497 (cons :tag "Prefix key documentation"
498 (string :tag "Access Key(s)")
499 (string :tag "Description ")))))
501 (defcustom org-agenda-query-register ?o
502 "The register holding the current query string.
503 The purpose of this is that if you construct a query string interactively,
504 you can then use it to define a custom command."
505 :group 'org-agenda-custom-commands
506 :type 'character)
508 (defcustom org-stuck-projects
509 '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
510 "How to identify stuck projects.
511 This is a list of four items:
512 1. A tags/todo/property matcher string that is used to identify a project.
513 See the manual for a description of tag and property searches.
514 The entire tree below a headline matched by this is considered one project.
515 2. A list of TODO keywords identifying non-stuck projects.
516 If the project subtree contains any headline with one of these todo
517 keywords, the project is considered to be not stuck. If you specify
518 \"*\" as a keyword, any TODO keyword will mark the project unstuck.
519 3. A list of tags identifying non-stuck projects.
520 If the project subtree contains any headline with one of these tags,
521 the project is considered to be not stuck. If you specify \"*\" as
522 a tag, any tag will mark the project unstuck. Note that this is about
523 the explicit presence of a tag somewhere in the subtree, inherited
524 tags to not count here. If inherited tags make a project not stuck,
525 use \"-TAG\" in the tags part of the matcher under (1.) above.
526 4. An arbitrary regular expression matching non-stuck projects.
528 If the project turns out to be not stuck, search continues also in the
529 subtree to see if any of the subtasks have project status.
531 See also the variable `org-tags-match-list-sublevels' which applies
532 to projects matched by this search as well.
534 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
535 or `C-c a #' to produce the list."
536 :group 'org-agenda-custom-commands
537 :type '(list
538 (string :tag "Tags/TODO match to identify a project")
539 (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
540 (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
541 (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
543 (defcustom org-agenda-filter-effort-default-operator "<"
544 "The default operator for effort estimate filtering.
545 If you select an effort estimate limit without first pressing an operator,
546 this one will be used."
547 :group 'org-agenda-custom-commands
548 :type '(choice (const :tag "less or equal" "<")
549 (const :tag "greater or equal"">")
550 (const :tag "equal" "=")))
552 (defgroup org-agenda-skip nil
553 "Options concerning skipping parts of agenda files."
554 :tag "Org Agenda Skip"
555 :group 'org-agenda)
557 (defcustom org-agenda-skip-function-global nil
558 "Function to be called at each match during agenda construction.
559 If this function returns nil, the current match should not be skipped.
560 If the function decided to skip an agenda match, is must return the
561 buffer position from which the search should be continued.
562 This may also be a Lisp form, which will be evaluated.
564 This variable will be applied to every agenda match, including
565 tags/property searches and TODO lists. So try to make the test function
566 do its checking as efficiently as possible. To implement a skipping
567 condition just for specific agenda commands, use the variable
568 `org-agenda-skip-function' which can be set in the options section
569 of custom agenda commands."
570 :group 'org-agenda-skip
571 :type 'sexp)
573 (defgroup org-agenda-daily/weekly nil
574 "Options concerning the daily/weekly agenda."
575 :tag "Org Agenda Daily/Weekly"
576 :group 'org-agenda)
577 (defgroup org-agenda-todo-list nil
578 "Options concerning the global todo list agenda view."
579 :tag "Org Agenda Todo List"
580 :group 'org-agenda)
581 (defgroup org-agenda-match-view nil
582 "Options concerning the general tags/property/todo match agenda view."
583 :tag "Org Agenda Match View"
584 :group 'org-agenda)
585 (defgroup org-agenda-search-view nil
586 "Options concerning the general tags/property/todo match agenda view."
587 :tag "Org Agenda Match View"
588 :group 'org-agenda)
590 (defvar org-agenda-archives-mode nil
591 "Non-nil means the agenda will include archived items.
592 If this is the symbol `trees', trees in the selected agenda scope
593 that are marked with the ARCHIVE tag will be included anyway. When this is
594 t, also all archive files associated with the current selection of agenda
595 files will be included.")
597 (defcustom org-agenda-skip-comment-trees t
598 "Non-nil means skip trees that start with the COMMENT keyword.
599 When nil, these trees are also scanned by agenda commands."
600 :group 'org-agenda-skip
601 :type 'boolean)
603 (defcustom org-agenda-todo-list-sublevels t
604 "Non-nil means check also the sublevels of a TODO entry for TODO entries.
605 When nil, the sublevels of a TODO entry are not checked, resulting in
606 potentially much shorter TODO lists."
607 :group 'org-agenda-skip
608 :group 'org-agenda-todo-list
609 :type 'boolean)
611 (defcustom org-agenda-todo-ignore-with-date nil
612 "Non-nil means don't show entries with a date in the global todo list.
613 You can use this if you prefer to mark mere appointments with a TODO keyword,
614 but don't want them to show up in the TODO list.
615 When this is set, it also covers deadlines and scheduled items, the settings
616 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
617 will be ignored.
618 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
619 :group 'org-agenda-skip
620 :group 'org-agenda-todo-list
621 :type 'boolean)
623 (defcustom org-agenda-todo-ignore-timestamp nil
624 "Non-nil means don't show entries with a timestamp.
625 This applies when creating the global todo list.
626 Valid values are:
628 past Don't show entries for today or in the past.
630 future Don't show entries with a timestamp in the future.
631 The idea behind this is that if it has a future
632 timestamp, you don't want to think about it until the
633 date.
635 all Don't show any entries with a timestamp in the global todo list.
636 The idea behind this is that by setting a timestamp, you
637 have already \"taken care\" of this item.
639 This variable can also have an integer as a value. If positive (N),
640 todos with a timestamp N or more days in the future will be ignored. If
641 negative (-N), todos with a timestamp N or more days in the past will be
642 ignored. If 0, todos with a timestamp either today or in the future will
643 be ignored. For example, a value of -1 will exclude todos with a
644 timestamp in the past (yesterday or earlier), while a value of 7 will
645 exclude todos with a timestamp a week or more in the future.
647 See also `org-agenda-todo-ignore-with-date'.
648 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
649 to make his option also apply to the tags-todo list."
650 :group 'org-agenda-skip
651 :group 'org-agenda-todo-list
652 :version "24.1"
653 :type '(choice
654 (const :tag "Ignore future timestamp todos" future)
655 (const :tag "Ignore past or present timestamp todos" past)
656 (const :tag "Ignore all timestamp todos" all)
657 (const :tag "Show timestamp todos" nil)
658 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
660 (defcustom org-agenda-todo-ignore-scheduled nil
661 "Non-nil means, ignore some scheduled TODO items when making TODO list.
662 This applies when creating the global todo list.
663 Valid values are:
665 past Don't show entries scheduled today or in the past.
667 future Don't show entries scheduled in the future.
668 The idea behind this is that by scheduling it, you don't want to
669 think about it until the scheduled date.
671 all Don't show any scheduled entries in the global todo list.
672 The idea behind this is that by scheduling it, you have already
673 \"taken care\" of this item.
675 t Same as `all', for backward compatibility.
677 This variable can also have an integer as a value. See
678 `org-agenda-todo-ignore-timestamp' for more details.
680 See also `org-agenda-todo-ignore-with-date'.
681 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
682 to make his option also apply to the tags-todo list."
683 :group 'org-agenda-skip
684 :group 'org-agenda-todo-list
685 :type '(choice
686 (const :tag "Ignore future-scheduled todos" future)
687 (const :tag "Ignore past- or present-scheduled todos" past)
688 (const :tag "Ignore all scheduled todos" all)
689 (const :tag "Ignore all scheduled todos (compatibility)" t)
690 (const :tag "Show scheduled todos" nil)
691 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
693 (defcustom org-agenda-todo-ignore-deadlines nil
694 "Non-nil means ignore some deadlined TODO items when making TODO list.
695 There are different motivations for using different values, please think
696 carefully when configuring this variable.
698 This applies when creating the global todo list.
699 Valid values are:
701 near Don't show near deadline entries. A deadline is near when it is
702 closer than `org-deadline-warning-days' days. The idea behind this
703 is that such items will appear in the agenda anyway.
705 far Don't show TODO entries where a deadline has been defined, but
706 the deadline is not near. This is useful if you don't want to
707 use the todo list to figure out what to do now.
709 past Don't show entries with a deadline timestamp for today or in the past.
711 future Don't show entries with a deadline timestamp in the future, not even
712 when they become `near' ones. Use it with caution.
714 all Ignore all TODO entries that do have a deadline.
716 t Same as `near', for backward compatibility.
718 This variable can also have an integer as a value. See
719 `org-agenda-todo-ignore-timestamp' for more details.
721 See also `org-agenda-todo-ignore-with-date'.
722 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
723 to make his option also apply to the tags-todo list."
724 :group 'org-agenda-skip
725 :group 'org-agenda-todo-list
726 :type '(choice
727 (const :tag "Ignore near deadlines" near)
728 (const :tag "Ignore near deadlines (compatibility)" t)
729 (const :tag "Ignore far deadlines" far)
730 (const :tag "Ignore all TODOs with a deadlines" all)
731 (const :tag "Show all TODOs, even if they have a deadline" nil)
732 (integer :tag "Ignore if N or more days in past(-) or future(+).")))
734 (defcustom org-agenda-tags-todo-honor-ignore-options nil
735 "Non-nil means honor todo-list ...ignore options also in tags-todo search.
736 The variables
737 `org-agenda-todo-ignore-with-date',
738 `org-agenda-todo-ignore-timestamp',
739 `org-agenda-todo-ignore-scheduled',
740 `org-agenda-todo-ignore-deadlines'
741 make the global TODO list skip entries that have time stamps of certain
742 kinds. If this option is set, the same options will also apply for the
743 tags-todo search, which is the general tags/property matcher
744 restricted to unfinished TODO entries only."
745 :group 'org-agenda-skip
746 :group 'org-agenda-todo-list
747 :group 'org-agenda-match-view
748 :type 'boolean)
750 (defcustom org-agenda-skip-scheduled-if-done nil
751 "Non-nil means don't show scheduled items in agenda when they are done.
752 This is relevant for the daily/weekly agenda, not for the TODO list. And
753 it applies only to the actual date of the scheduling. Warnings about
754 an item with a past scheduling dates are always turned off when the item
755 is DONE."
756 :group 'org-agenda-skip
757 :group 'org-agenda-daily/weekly
758 :type 'boolean)
760 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
761 "Non-nil means skip scheduling line if same entry shows because of deadline.
762 In the agenda of today, an entry can show up multiple times because
763 it is both scheduled and has a nearby deadline, and maybe a plain time
764 stamp as well.
765 When this variable is t, then only the deadline is shown and the fact that
766 the entry is scheduled today or was scheduled previously is not shown.
767 When this variable is nil, the entry will be shown several times. When
768 the variable is the symbol `not-today', then skip scheduled previously,
769 but not scheduled today."
770 :group 'org-agenda-skip
771 :group 'org-agenda-daily/weekly
772 :type '(choice
773 (const :tag "Never" nil)
774 (const :tag "Always" t)
775 (const :tag "Not when scheduled today" not-today)))
777 (defcustom org-agenda-skip-deadline-if-done nil
778 "Non-nil means don't show deadlines when the corresponding item is done.
779 When nil, the deadline is still shown and should give you a happy feeling.
780 This is relevant for the daily/weekly agenda. And it applied only to the
781 actually date of the deadline. Warnings about approaching and past-due
782 deadlines are always turned off when the item is DONE."
783 :group 'org-agenda-skip
784 :group 'org-agenda-daily/weekly
785 :type 'boolean)
787 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
788 "Non-nil means skip deadline prewarning when entry is also scheduled.
789 This will apply on all days where a prewarning for the deadline would
790 be shown, but not at the day when the entry is actually due. On that day,
791 the deadline will be shown anyway.
792 This variable may be set to nil, t, or a number which will then give
793 the number of days before the actual deadline when the prewarnings
794 should resume.
795 This can be used in a workflow where the first showing of the deadline will
796 trigger you to schedule it, and then you don't want to be reminded of it
797 because you will take care of it on the day when scheduled."
798 :group 'org-agenda-skip
799 :group 'org-agenda-daily/weekly
800 :version "24.1"
801 :type '(choice
802 (const :tag "Alwas show prewarning" nil)
803 (const :tag "Remove prewarning if entry is scheduled" t)
804 (integer :tag "Restart prewarning N days before deadline")))
806 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
807 "When nil, multiple same-day timestamps in entry make multiple agenda lines.
808 When non-nil, after the search for timestamps has matched once in an
809 entry, the rest of the entry will not be searched."
810 :group 'org-agenda-skip
811 :type 'boolean)
813 (defcustom org-agenda-skip-timestamp-if-done nil
814 "Non-nil means don't select item by timestamp or -range if it is DONE."
815 :group 'org-agenda-skip
816 :group 'org-agenda-daily/weekly
817 :type 'boolean)
819 (defcustom org-agenda-dim-blocked-tasks t
820 "Non-nil means dim blocked tasks in the agenda display.
821 This causes some overhead during agenda construction, but if you
822 have turned on `org-enforce-todo-dependencies',
823 `org-enforce-todo-checkbox-dependencies', or any other blocking
824 mechanism, this will create useful feedback in the agenda.
826 Instead of t, this variable can also have the value `invisible'.
827 Then blocked tasks will be invisible and only become visible when
828 they become unblocked. An exemption to this behavior is when a task is
829 blocked because of unchecked checkboxes below it. Since checkboxes do
830 not show up in the agenda views, making this task invisible you remove any
831 trace from agenda views that there is something to do. Therefore, a task
832 that is blocked because of checkboxes will never be made invisible, it
833 will only be dimmed."
834 :group 'org-agenda-daily/weekly
835 :group 'org-agenda-todo-list
836 :type '(choice
837 (const :tag "Do not dim" nil)
838 (const :tag "Dim to a gray face" t)
839 (const :tag "Make invisible" invisible)))
841 (defcustom org-timeline-show-empty-dates 3
842 "Non-nil means `org-timeline' also shows dates without an entry.
843 When nil, only the days which actually have entries are shown.
844 When t, all days between the first and the last date are shown.
845 When an integer, show also empty dates, but if there is a gap of more than
846 N days, just insert a special line indicating the size of the gap."
847 :group 'org-agenda-skip
848 :type '(choice
849 (const :tag "None" nil)
850 (const :tag "All" t)
851 (integer :tag "at most")))
853 (defgroup org-agenda-startup nil
854 "Options concerning initial settings in the Agenda in Org Mode."
855 :tag "Org Agenda Startup"
856 :group 'org-agenda)
858 (defcustom org-agenda-menu-show-matcher t
859 "Non-nil means show the match string in the agenda dispatcher menu.
860 When nil, the matcher string is not shown, but is put into the help-echo
861 property so than moving the mouse over the command shows it.
862 Setting it to nil is good if matcher strings are very long and/or if
863 you want to use two-column display (see `org-agenda-menu-two-column')."
864 :group 'org-agenda
865 :version "24.1"
866 :type 'boolean)
868 (defcustom org-agenda-menu-two-column nil
869 "Non-nil means, use two columns to show custom commands in the dispatcher.
870 If you use this, you probably want to set `org-agenda-menu-show-matcher'
871 to nil."
872 :group 'org-agenda
873 :version "24.1"
874 :type 'boolean)
876 (defcustom org-finalize-agenda-hook nil
877 "Hook run just before displaying an agenda buffer."
878 :group 'org-agenda-startup
879 :type 'hook)
881 (defcustom org-agenda-mouse-1-follows-link nil
882 "Non-nil means mouse-1 on a link will follow the link in the agenda.
883 A longer mouse click will still set point. Does not work on XEmacs.
884 Needs to be set before org.el is loaded."
885 :group 'org-agenda-startup
886 :type 'boolean)
888 (defcustom org-agenda-start-with-follow-mode nil
889 "The initial value of follow mode in a newly created agenda window."
890 :group 'org-agenda-startup
891 :type 'boolean)
893 (defcustom org-agenda-follow-indirect nil
894 "Non-nil means `org-agenda-follow-mode' displays only the
895 current item's tree, in an indirect buffer."
896 :group 'org-agenda
897 :version "24.1"
898 :type 'boolean)
900 (defcustom org-agenda-show-outline-path t
901 "Non-nil means show outline path in echo area after line motion."
902 :group 'org-agenda-startup
903 :type 'boolean)
905 (defcustom org-agenda-start-with-entry-text-mode nil
906 "The initial value of entry-text-mode in a newly created agenda window."
907 :group 'org-agenda-startup
908 :type 'boolean)
910 (defcustom org-agenda-entry-text-maxlines 5
911 "Number of text lines to be added when `E' is pressed in the agenda.
913 Note that this variable only used during agenda display. Add add entry text
914 when exporting the agenda, configure the variable
915 `org-agenda-add-entry-ext-maxlines'."
916 :group 'org-agenda
917 :type 'integer)
919 (defcustom org-agenda-entry-text-exclude-regexps nil
920 "List of regular expressions to clean up entry text.
921 The complete matches of all regular expressions in this list will be
922 removed from entry text before it is shown in the agenda."
923 :group 'org-agenda
924 :type '(repeat (regexp)))
926 (defvar org-agenda-entry-text-cleanup-hook nil
927 "Hook that is run after basic cleanup of entry text to be shown in agenda.
928 This cleanup is done in a temporary buffer, so the function may inspect and
929 change the entire buffer.
930 Some default stuff like drawers and scheduling/deadline dates will already
931 have been removed when this is called, as will any matches for regular
932 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
934 (defvar org-agenda-include-inactive-timestamps nil
935 "Non-nil means include inactive time stamps in agenda and timeline.
936 Dynamically scoped.")
938 (defgroup org-agenda-windows nil
939 "Options concerning the windows used by the Agenda in Org Mode."
940 :tag "Org Agenda Windows"
941 :group 'org-agenda)
943 (defcustom org-agenda-window-setup 'reorganize-frame
944 "How the agenda buffer should be displayed.
945 Possible values for this option are:
947 current-window Show agenda in the current window, keeping all other windows.
948 other-window Use `switch-to-buffer-other-window' to display agenda.
949 reorganize-frame Show only two windows on the current frame, the current
950 window and the agenda.
951 other-frame Use `switch-to-buffer-other-frame' to display agenda.
952 Also, when exiting the agenda, kill that frame.
953 See also the variable `org-agenda-restore-windows-after-quit'."
954 :group 'org-agenda-windows
955 :type '(choice
956 (const current-window)
957 (const other-frame)
958 (const other-window)
959 (const reorganize-frame)))
961 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
962 "The min and max height of the agenda window as a fraction of frame height.
963 The value of the variable is a cons cell with two numbers between 0 and 1.
964 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
965 :group 'org-agenda-windows
966 :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
968 (defcustom org-agenda-restore-windows-after-quit nil
969 "Non-nil means restore window configuration upon exiting agenda.
970 Before the window configuration is changed for displaying the agenda,
971 the current status is recorded. When the agenda is exited with
972 `q' or `x' and this option is set, the old state is restored. If
973 `org-agenda-window-setup' is `other-frame', the value of this
974 option will be ignored."
975 :group 'org-agenda-windows
976 :type 'boolean)
978 (defcustom org-agenda-ndays nil
979 "Number of days to include in overview display.
980 Should be 1 or 7.
981 Obsolete, see `org-agenda-span'."
982 :group 'org-agenda-daily/weekly
983 :type 'integer)
985 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
987 (defcustom org-agenda-span 'week
988 "Number of days to include in overview display.
989 Can be day, week, month, year, or any number of days.
990 Custom commands can set this variable in the options section."
991 :group 'org-agenda-daily/weekly
992 :type '(choice (const :tag "Day" day)
993 (const :tag "Week" week)
994 (const :tag "Month" month)
995 (const :tag "Year" year)
996 (integer :tag "Custom")))
998 (defcustom org-agenda-start-on-weekday 1
999 "Non-nil means start the overview always on the specified weekday.
1000 0 denotes Sunday, 1 denotes Monday etc.
1001 When nil, always start on the current day.
1002 Custom commands can set this variable in the options section."
1003 :group 'org-agenda-daily/weekly
1004 :type '(choice (const :tag "Today" nil)
1005 (integer :tag "Weekday No.")))
1007 (defcustom org-agenda-show-all-dates t
1008 "Non-nil means `org-agenda' shows every day in the selected range.
1009 When nil, only the days which actually have entries are shown."
1010 :group 'org-agenda-daily/weekly
1011 :type 'boolean)
1013 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
1014 "Format string for displaying dates in the agenda.
1015 Used by the daily/weekly agenda and by the timeline. This should be
1016 a format string understood by `format-time-string', or a function returning
1017 the formatted date as a string. The function must take a single argument,
1018 a calendar-style date list like (month day year)."
1019 :group 'org-agenda-daily/weekly
1020 :type '(choice
1021 (string :tag "Format string")
1022 (function :tag "Function")))
1024 (defun org-agenda-format-date-aligned (date)
1025 "Format a date string for display in the daily/weekly agenda, or timeline.
1026 This function makes sure that dates are aligned for easy reading."
1027 (require 'cal-iso)
1028 (let* ((dayname (calendar-day-name date))
1029 (day (cadr date))
1030 (day-of-week (calendar-day-of-week date))
1031 (month (car date))
1032 (monthname (calendar-month-name month))
1033 (year (nth 2 date))
1034 (iso-week (org-days-to-iso-week
1035 (calendar-absolute-from-gregorian date)))
1036 (weekyear (cond ((and (= month 1) (>= iso-week 52))
1037 (1- year))
1038 ((and (= month 12) (<= iso-week 1))
1039 (1+ year))
1040 (t year)))
1041 (weekstring (if (= day-of-week 1)
1042 (format " W%02d" iso-week)
1043 "")))
1044 (format "%-10s %2d %s %4d%s"
1045 dayname day monthname year weekstring)))
1047 (defcustom org-agenda-time-leading-zero nil
1048 "Non-nil means use leading zero for military times in agenda.
1049 For example, 9:30am would become 09:30 rather than 9:30."
1050 :group 'org-agenda-daily/weekly
1051 :version "24.1"
1052 :type 'boolean)
1054 (defcustom org-agenda-timegrid-use-ampm nil
1055 "When set, show AM/PM style timestamps on the timegrid."
1056 :group 'org-agenda
1057 :version "24.1"
1058 :type 'boolean)
1060 (defun org-agenda-time-of-day-to-ampm (time)
1061 "Convert TIME of a string like '13:45' to an AM/PM style time string."
1062 (let* ((hour-number (string-to-number (substring time 0 -3)))
1063 (minute (substring time -2))
1064 (ampm "am"))
1065 (cond
1066 ((equal hour-number 12)
1067 (setq ampm "pm"))
1068 ((> hour-number 12)
1069 (setq ampm "pm")
1070 (setq hour-number (- hour-number 12))))
1071 (concat
1072 (if org-agenda-time-leading-zero
1073 (format "%02d" hour-number)
1074 (format "%02s" (number-to-string hour-number)))
1075 ":" minute ampm)))
1077 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1078 "Conditionally convert TIME to AM/PM format
1079 based on `org-agenda-timegrid-use-ampm'"
1080 (if org-agenda-timegrid-use-ampm
1081 (org-agenda-time-of-day-to-ampm time)
1082 time))
1084 (defcustom org-agenda-weekend-days '(6 0)
1085 "Which days are weekend?
1086 These days get the special face `org-agenda-date-weekend' in the agenda
1087 and timeline buffers."
1088 :group 'org-agenda-daily/weekly
1089 :type '(set :greedy t
1090 (const :tag "Monday" 1)
1091 (const :tag "Tuesday" 2)
1092 (const :tag "Wednesday" 3)
1093 (const :tag "Thursday" 4)
1094 (const :tag "Friday" 5)
1095 (const :tag "Saturday" 6)
1096 (const :tag "Sunday" 0)))
1098 (defcustom org-agenda-move-date-from-past-immediately-to-today t
1099 "Non-nil means jump to today when moving a past date forward in time.
1100 When using S-right in the agenda to move a a date forward, and the date
1101 stamp currently points to the past, the first key press will move it
1102 to today. WHen nil, just move one day forward even if the date stays
1103 in the past."
1104 :group 'org-agenda-daily/weekly
1105 :version "24.1"
1106 :type 'boolean)
1108 (defcustom org-agenda-include-diary nil
1109 "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1110 Custom commands can set this variable in the options section."
1111 :group 'org-agenda-daily/weekly
1112 :type 'boolean)
1114 (defcustom org-agenda-include-deadlines t
1115 "If non-nil, include entries within their deadline warning period.
1116 Custom commands can set this variable in the options section."
1117 :group 'org-agenda-daily/weekly
1118 :version "24.1"
1119 :type 'boolean)
1121 (defcustom org-agenda-repeating-timestamp-show-all t
1122 "Non-nil means show all occurrences of a repeating stamp in the agenda.
1123 When set to a list of strings, only show occurrences of repeating
1124 stamps for these TODO keywords. When nil, only one occurrence is
1125 shown, either today or the nearest into the future."
1126 :group 'org-agenda-daily/weekly
1127 :type '(choice
1128 (const :tag "Show repeating stamps" t)
1129 (repeat :tag "Show repeating stamps for these TODO keywords"
1130 (string :tag "TODO Keyword"))
1131 (const :tag "Don't show repeating stamps" nil)))
1133 (defcustom org-scheduled-past-days 10000
1134 "No. of days to continue listing scheduled items that are not marked DONE.
1135 When an item is scheduled on a date, it shows up in the agenda on this
1136 day and will be listed until it is marked done for the number of days
1137 given here."
1138 :group 'org-agenda-daily/weekly
1139 :type 'integer)
1141 (defcustom org-agenda-log-mode-items '(closed clock)
1142 "List of items that should be shown in agenda log mode.
1143 This list may contain the following symbols:
1145 closed Show entries that have been closed on that day.
1146 clock Show entries that have received clocked time on that day.
1147 state Show all logged state changes.
1148 Note that instead of changing this variable, you can also press `C-u l' in
1149 the agenda to display all available LOG items temporarily."
1150 :group 'org-agenda-daily/weekly
1151 :type '(set :greedy t (const closed) (const clock) (const state)))
1153 (defcustom org-agenda-clock-consistency-checks
1154 '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1155 :gap-ok-around ("4:00")
1156 :default-face ((:background "DarkRed") (:foreground "white"))
1157 :overlap-face nil :gap-face nil :no-end-time-face nil
1158 :long-face nil :short-face nil)
1159 "This is a property list, with the following keys:
1161 :max-duration Mark clocking chunks that are longer than this time.
1162 This is a time string like \"HH:MM\", or the number
1163 of minutes as an integer.
1165 :min-duration Mark clocking chunks that are shorter that this.
1166 This is a time string like \"HH:MM\", or the number
1167 of minutes as an integer.
1169 :max-gap Mark gaps between clocking chunks that are longer than
1170 this duration. A number of minutes, or a string
1171 like \"HH:MM\".
1173 :gap-ok-around List of times during the day which are usually not working
1174 times. When a gap is detected, but the gap contains any
1175 of these times, the gap is *not* reported. For example,
1176 if this is (\"4:00\" \"13:00\") then gaps that contain
1177 4:00 in the morning (i.e. the night) and 13:00
1178 (i.e. a typical lunch time) do not cause a warning.
1179 You should have at least one time during the night in this
1180 list, or otherwise the first task each morning will trigger
1181 a warning because it follows a long gap.
1183 Furthermore, the following properties can be used to define faces for
1184 issue display.
1186 :default-face the default face, if the specific face is undefined
1187 :overlap-face face for overlapping clocks
1188 :gap-face face for gaps between clocks
1189 :no-end-time-face face for incomplete clocks
1190 :long-face face for clock intervals that are too long
1191 :short-face face for clock intervals that are too short"
1192 :group 'org-agenda-daily/weekly
1193 :group 'org-clock
1194 :version "24.1"
1195 :type 'plist)
1197 (defcustom org-agenda-log-mode-add-notes t
1198 "Non-nil means add first line of notes to log entries in agenda views.
1199 If a log item like a state change or a clock entry is associated with
1200 notes, the first line of these notes will be added to the entry in the
1201 agenda display."
1202 :group 'org-agenda-daily/weekly
1203 :type 'boolean)
1205 (defcustom org-agenda-start-with-log-mode nil
1206 "The initial value of log-mode in a newly created agenda window."
1207 :group 'org-agenda-startup
1208 :group 'org-agenda-daily/weekly
1209 :type 'boolean)
1211 (defcustom org-agenda-start-with-clockreport-mode nil
1212 "The initial value of clockreport-mode in a newly created agenda window."
1213 :group 'org-agenda-startup
1214 :group 'org-agenda-daily/weekly
1215 :type 'boolean)
1217 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1218 "Property list with parameters for the clocktable in clockreport mode.
1219 This is the display mode that shows a clock table in the daily/weekly
1220 agenda, the properties for this dynamic block can be set here.
1221 The usual clocktable parameters are allowed here, but you cannot set
1222 the properties :name, :tstart, :tend, :block, and :scope - these will
1223 be overwritten to make sure the content accurately reflects the
1224 current display in the agenda."
1225 :group 'org-agenda-daily/weekly
1226 :type 'plist)
1228 (defcustom org-agenda-search-view-always-boolean nil
1229 "Non-nil means the search string is interpreted as individual parts.
1231 The search string for search view can either be interpreted as a phrase,
1232 or as a list of snippets that define a boolean search for a number of
1233 strings.
1235 When this is non-nil, the string will be split on whitespace, and each
1236 snippet will be searched individually, and all must match in order to
1237 select an entry. A snippet is then a single string of non-white
1238 characters, or a string in double quotes, or a regexp in {} braces.
1239 If a snippet is preceded by \"-\", the snippet must *not* match.
1240 \"+\" is syntactic sugar for positive selection. Each snippet may
1241 be found as a full word or a partial word, but see the variable
1242 `org-agenda-search-view-force-full-words'.
1244 When this is nil, search will look for the entire search phrase as one,
1245 with each space character matching any amount of whitespace, including
1246 line breaks.
1248 Even when this is nil, you can still switch to Boolean search dynamically
1249 by preceding the first snippet with \"+\" or \"-\". If the first snippet
1250 is a regexp marked with braces like \"{abc}\", this will also switch to
1251 boolean search."
1252 :group 'org-agenda-search-view
1253 :version "24.1"
1254 :type 'boolean)
1256 (if (fboundp 'defvaralias)
1257 (defvaralias 'org-agenda-search-view-search-words-only
1258 'org-agenda-search-view-always-boolean))
1260 (defcustom org-agenda-search-view-force-full-words nil
1261 "Non-nil means, search words must be matches as complete words.
1262 When nil, they may also match part of a word."
1263 :group 'org-agenda-search-view
1264 :version "24.1"
1265 :type 'boolean)
1267 (defgroup org-agenda-time-grid nil
1268 "Options concerning the time grid in the Org-mode Agenda."
1269 :tag "Org Agenda Time Grid"
1270 :group 'org-agenda)
1272 (defcustom org-agenda-search-headline-for-time t
1273 "Non-nil means search headline for a time-of-day.
1274 If the headline contains a time-of-day in one format or another, it will
1275 be used to sort the entry into the time sequence of items for a day.
1276 Some people have time stamps in the headline that refer to the creation
1277 time or so, and then this produces an unwanted side effect. If this is
1278 the case for your, use this variable to turn off searching the headline
1279 for a time."
1280 :group 'org-agenda-time-grid
1281 :type 'boolean)
1283 (defcustom org-agenda-use-time-grid t
1284 "Non-nil means show a time grid in the agenda schedule.
1285 A time grid is a set of lines for specific times (like every two hours between
1286 8:00 and 20:00). The items scheduled for a day at specific times are
1287 sorted in between these lines.
1288 For details about when the grid will be shown, and what it will look like, see
1289 the variable `org-agenda-time-grid'."
1290 :group 'org-agenda-time-grid
1291 :type 'boolean)
1293 (defcustom org-agenda-time-grid
1294 '((daily today require-timed)
1295 "----------------"
1296 (800 1000 1200 1400 1600 1800 2000))
1298 "The settings for time grid for agenda display.
1299 This is a list of three items. The first item is again a list. It contains
1300 symbols specifying conditions when the grid should be displayed:
1302 daily if the agenda shows a single day
1303 weekly if the agenda shows an entire week
1304 today show grid on current date, independent of daily/weekly display
1305 require-timed show grid only if at least one item has a time specification
1307 The second item is a string which will be placed behind the grid time.
1309 The third item is a list of integers, indicating the times that should have
1310 a grid line."
1311 :group 'org-agenda-time-grid
1312 :type
1313 '(list
1314 (set :greedy t :tag "Grid Display Options"
1315 (const :tag "Show grid in single day agenda display" daily)
1316 (const :tag "Show grid in weekly agenda display" weekly)
1317 (const :tag "Always show grid for today" today)
1318 (const :tag "Show grid only if any timed entries are present"
1319 require-timed)
1320 (const :tag "Skip grid times already present in an entry"
1321 remove-match))
1322 (string :tag "Grid String")
1323 (repeat :tag "Grid Times" (integer :tag "Time"))))
1325 (defcustom org-agenda-show-current-time-in-grid t
1326 "Non-nil means show the current time in the time grid."
1327 :group 'org-agenda-time-grid
1328 :version "24.1"
1329 :type 'boolean)
1331 (defcustom org-agenda-current-time-string
1332 "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1333 "The string for the current time marker in the agenda."
1334 :group 'org-agenda-time-grid
1335 :version "24.1"
1336 :type 'string)
1338 (defgroup org-agenda-sorting nil
1339 "Options concerning sorting in the Org-mode Agenda."
1340 :tag "Org Agenda Sorting"
1341 :group 'org-agenda)
1343 (defcustom org-agenda-sorting-strategy
1344 '((agenda habit-down time-up priority-down category-keep)
1345 (todo priority-down category-keep)
1346 (tags priority-down category-keep)
1347 (search category-keep))
1348 "Sorting structure for the agenda items of a single day.
1349 This is a list of symbols which will be used in sequence to determine
1350 if an entry should be listed before another entry. The following
1351 symbols are recognized:
1353 time-up Put entries with time-of-day indications first, early first
1354 time-down Put entries with time-of-day indications first, late first
1355 category-keep Keep the default order of categories, corresponding to the
1356 sequence in `org-agenda-files'.
1357 category-up Sort alphabetically by category, A-Z.
1358 category-down Sort alphabetically by category, Z-A.
1359 tag-up Sort alphabetically by last tag, A-Z.
1360 tag-down Sort alphabetically by last tag, Z-A.
1361 priority-up Sort numerically by priority, high priority last.
1362 priority-down Sort numerically by priority, high priority first.
1363 todo-state-up Sort by todo state, tasks that are done last.
1364 todo-state-down Sort by todo state, tasks that are done first.
1365 effort-up Sort numerically by estimated effort, high effort last.
1366 effort-down Sort numerically by estimated effort, high effort first.
1367 user-defined-up Sort according to `org-agenda-cmp-user-defined', high last.
1368 user-defined-down Sort according to `org-agenda-cmp-user-defined', high first.
1369 habit-up Put entries that are habits first
1370 habit-down Put entries that are habits last
1371 alpha-up Sort headlines alphabetically
1372 alpha-down Sort headlines alphabetically, reversed
1374 The different possibilities will be tried in sequence, and testing stops
1375 if one comparison returns a \"not-equal\". For example, the default
1376 '(time-up category-keep priority-down)
1377 means: Pull out all entries having a specified time of day and sort them,
1378 in order to make a time schedule for the current day the first thing in the
1379 agenda listing for the day. Of the entries without a time indication, keep
1380 the grouped in categories, don't sort the categories, but keep them in
1381 the sequence given in `org-agenda-files'. Within each category sort by
1382 priority.
1384 Leaving out `category-keep' would mean that items will be sorted across
1385 categories by priority.
1387 Instead of a single list, this can also be a set of list for specific
1388 contents, with a context symbol in the car of the list, any of
1389 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1391 Custom commands can bind this variable in the options section."
1392 :group 'org-agenda-sorting
1393 :type `(choice
1394 (repeat :tag "General" ,org-sorting-choice)
1395 (list :tag "Individually"
1396 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1397 (repeat ,org-sorting-choice))
1398 (cons (const :tag "Strategy for TODO lists" todo)
1399 (repeat ,org-sorting-choice))
1400 (cons (const :tag "Strategy for Tags matches" tags)
1401 (repeat ,org-sorting-choice))
1402 (cons (const :tag "Strategy for search matches" search)
1403 (repeat ,org-sorting-choice)))))
1405 (defcustom org-agenda-cmp-user-defined nil
1406 "A function to define the comparison `user-defined'.
1407 This function must receive two arguments, agenda entry a and b.
1408 If a>b, return +1. If a<b, return -1. If they are equal as seen by
1409 the user comparison, return nil.
1410 When this is defined, you can make `user-defined-up' and `user-defined-down'
1411 part of an agenda sorting strategy."
1412 :group 'org-agenda-sorting
1413 :type 'symbol)
1415 (defcustom org-sort-agenda-notime-is-late t
1416 "Non-nil means items without time are considered late.
1417 This is only relevant for sorting. When t, items which have no explicit
1418 time like 15:30 will be considered as 99:01, i.e. later than any items which
1419 do have a time. When nil, the default time is before 0:00. You can use this
1420 option to decide if the schedule for today should come before or after timeless
1421 agenda entries."
1422 :group 'org-agenda-sorting
1423 :type 'boolean)
1425 (defcustom org-sort-agenda-noeffort-is-high t
1426 "Non-nil means items without effort estimate are sorted as high effort.
1427 This also applies when filtering an agenda view with respect to the
1428 < or > effort operator. Then, tasks with no effort defined will be treated
1429 as tasks with high effort.
1430 When nil, such items are sorted as 0 minutes effort."
1431 :group 'org-agenda-sorting
1432 :type 'boolean)
1434 (defgroup org-agenda-line-format nil
1435 "Options concerning the entry prefix in the Org-mode agenda display."
1436 :tag "Org Agenda Line Format"
1437 :group 'org-agenda)
1439 (defcustom org-agenda-prefix-format
1440 '((agenda . " %i %-12:c%?-12t% s")
1441 (timeline . " % s")
1442 (todo . " %i %-12:c")
1443 (tags . " %i %-12:c")
1444 (search . " %i %-12:c"))
1445 "Format specifications for the prefix of items in the agenda views.
1446 An alist with five entries, each for the different agenda types. The
1447 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1448 The values are format strings.
1450 This format works similar to a printf format, with the following meaning:
1452 %c the category of the item, \"Diary\" for entries from the diary,
1453 or as given by the CATEGORY keyword or derived from the file name
1454 %e the effort required by the item
1455 %i the icon category of the item, see `org-agenda-category-icon-alist'
1456 %T the last tag of the item (ignore inherited tags, which come first)
1457 %t the HH:MM time-of-day specification if one applies to the entry
1458 %s Scheduling/Deadline information, a short string
1459 %(expression) Eval EXPRESSION and replace the control string
1460 by the result
1462 All specifiers work basically like the standard `%s' of printf, but may
1463 contain two additional characters: a question mark just after the `%'
1464 and a whitespace/punctuation character just before the final letter.
1466 If the first character after `%' is a question mark, the entire field
1467 will only be included if the corresponding value applies to the current
1468 entry. This is useful for fields which should have fixed width when
1469 present, but zero width when absent. For example, \"%?-12t\" will
1470 result in a 12 character time field if a time of the day is specified,
1471 but will completely disappear in entries which do not contain a time.
1473 If there is punctuation or whitespace character just before the final
1474 format letter, this character will be appended to the field value if
1475 the value is not empty. For example, the format \"%-12:c\" leads to
1476 \"Diary: \" if the category is \"Diary\". If the category were be
1477 empty, no additional colon would be inserted.
1479 The default value for the agenda sublist is \" %-12:c%?-12t% s\",
1480 which means:
1482 - Indent the line with two space characters
1483 - Give the category a 12 chars wide field, padded with whitespace on
1484 the right (because of `-'). Append a colon if there is a category
1485 (because of `:').
1486 - If there is a time-of-day, put it into a 12 chars wide field. If no
1487 time, don't put in an empty field, just skip it (because of '?').
1488 - Finally, put the scheduling information.
1490 See also the variables `org-agenda-remove-times-when-in-prefix' and
1491 `org-agenda-remove-tags'.
1493 Custom commands can set this variable in the options section."
1494 :type '(choice
1495 (string :tag "General format")
1496 (list :greedy t :tag "View dependent"
1497 (cons (const agenda) (string :tag "Format"))
1498 (cons (const timeline) (string :tag "Format"))
1499 (cons (const todo) (string :tag "Format"))
1500 (cons (const tags) (string :tag "Format"))
1501 (cons (const search) (string :tag "Format"))))
1502 :group 'org-agenda-line-format)
1504 (defvar org-prefix-format-compiled nil
1505 "The compiled prefix format and associated variables.
1506 This is a list where first element is a list of variable bindings, and second
1507 element is the compiled format expression. See the variable
1508 `org-agenda-prefix-format'.")
1510 (defcustom org-agenda-todo-keyword-format "%-1s"
1511 "Format for the TODO keyword in agenda lines.
1512 Set this to something like \"%-12s\" if you want all TODO keywords
1513 to occupy a fixed space in the agenda display."
1514 :group 'org-agenda-line-format
1515 :type 'string)
1517 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1518 "Text preceding timerange entries in the agenda view.
1519 This is a list with two strings. The first applies when the range
1520 is entirely on one day. The second applies if the range spans several days.
1521 The strings may have two \"%d\" format specifiers which will be filled
1522 with the sequence number of the days, and the total number of days in the
1523 range, respectively."
1524 :group 'org-agenda-line-format
1525 :type '(list
1526 (string :tag "Deadline today ")
1527 (choice :tag "Deadline relative"
1528 (string :tag "Format string")
1529 (function))))
1531 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1532 "Text preceding scheduled items in the agenda view.
1533 This is a list with two strings. The first applies when the item is
1534 scheduled on the current day. The second applies when it has been scheduled
1535 previously, it may contain a %d indicating that this is the nth time that
1536 this item is scheduled, due to automatic rescheduling of unfinished items
1537 for the following day. So this number is one larger than the number of days
1538 that passed since this item was scheduled first."
1539 :group 'org-agenda-line-format
1540 :type '(list
1541 (string :tag "Scheduled today ")
1542 (string :tag "Scheduled previously")))
1544 (defcustom org-agenda-inactive-leader "["
1545 "Text preceding item pulled into the agenda by inactive time stamps.
1546 These entries are added to the agenda when pressing \"[\"."
1547 :group 'org-agenda-line-format
1548 :version "24.1"
1549 :type '(list
1550 (string :tag "Scheduled today ")
1551 (string :tag "Scheduled previously")))
1553 (defcustom org-agenda-deadline-leaders '("Deadline: " "In %3d d.: ")
1554 "Text preceding deadline items in the agenda view.
1555 This is a list with two strings. The first applies when the item has its
1556 deadline on the current day. The second applies when it is in the past or
1557 in the future, it may contain %d to capture how many days away the deadline
1558 is (was)."
1559 :group 'org-agenda-line-format
1560 :type '(list
1561 (string :tag "Deadline today ")
1562 (choice :tag "Deadline relative"
1563 (string :tag "Format string")
1564 (function))))
1566 (defcustom org-agenda-remove-times-when-in-prefix t
1567 "Non-nil means remove duplicate time specifications in agenda items.
1568 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1569 time-of-day specification in a headline or diary entry is extracted and
1570 placed into the prefix. If this option is non-nil, the original specification
1571 \(a timestamp or -range, or just a plain time(range) specification like
1572 11:30-4pm) will be removed for agenda display. This makes the agenda less
1573 cluttered.
1574 The option can be t or nil. It may also be the symbol `beg', indicating
1575 that the time should only be removed when it is located at the beginning of
1576 the headline/diary entry."
1577 :group 'org-agenda-line-format
1578 :type '(choice
1579 (const :tag "Always" t)
1580 (const :tag "Never" nil)
1581 (const :tag "When at beginning of entry" beg)))
1583 (defcustom org-agenda-remove-timeranges-from-blocks nil
1584 "Non-nil means remove time ranges specifications in agenda
1585 items that span on several days."
1586 :group 'org-agenda-line-format
1587 :version "24.1"
1588 :type 'boolean)
1590 (defcustom org-agenda-default-appointment-duration nil
1591 "Default duration for appointments that only have a starting time.
1592 When nil, no duration is specified in such cases.
1593 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1594 :group 'org-agenda-line-format
1595 :type '(choice
1596 (integer :tag "Minutes")
1597 (const :tag "No default duration")))
1599 (defcustom org-agenda-show-inherited-tags t
1600 "Non-nil means show inherited tags in each agenda line."
1601 :group 'org-agenda-line-format
1602 :type 'boolean)
1604 (defcustom org-agenda-hide-tags-regexp nil
1605 "Regular expression used to filter away specific tags in agenda views.
1606 This means that these tags will be present, but not be shown in the agenda
1607 line. Secondary filtering will still work on the hidden tags.
1608 Nil means don't hide any tags."
1609 :group 'org-agenda-line-format
1610 :type '(choice
1611 (const :tag "Hide none" nil)
1612 (string :tag "Regexp ")))
1614 (defcustom org-agenda-remove-tags nil
1615 "Non-nil means remove the tags from the headline copy in the agenda.
1616 When this is the symbol `prefix', only remove tags when
1617 `org-agenda-prefix-format' contains a `%T' specifier."
1618 :group 'org-agenda-line-format
1619 :type '(choice
1620 (const :tag "Always" t)
1621 (const :tag "Never" nil)
1622 (const :tag "When prefix format contains %T" prefix)))
1624 (if (fboundp 'defvaralias)
1625 (defvaralias 'org-agenda-remove-tags-when-in-prefix
1626 'org-agenda-remove-tags))
1628 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1629 "Shift tags in agenda items to this column.
1630 If this number is positive, it specifies the column. If it is negative,
1631 it means that the tags should be flushright to that column. For example,
1632 -80 works well for a normal 80 character screen."
1633 :group 'org-agenda-line-format
1634 :type 'integer)
1636 (if (fboundp 'defvaralias)
1637 (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1639 (defcustom org-agenda-fontify-priorities 'cookies
1640 "Non-nil means highlight low and high priorities in agenda.
1641 When t, the highest priority entries are bold, lowest priority italic.
1642 However, settings in `org-priority-faces' will overrule these faces.
1643 When this variable is the symbol `cookies', only fontify the
1644 cookies, not the entire task.
1645 This may also be an association list of priority faces, whose
1646 keys are the character values of `org-highest-priority',
1647 `org-default-priority', and `org-lowest-priority' (the default values
1648 are ?A, ?B, and ?C, respectively). The face may be a named face, a
1649 color as a string, or a list like `(:background \"Red\")'.
1650 If it is a color, the variable `org-faces-easy-properties'
1651 determines if it is a foreground or a background color."
1652 :group 'org-agenda-line-format
1653 :type '(choice
1654 (const :tag "Never" nil)
1655 (const :tag "Defaults" t)
1656 (const :tag "Cookies only" cookies)
1657 (repeat :tag "Specify"
1658 (list (character :tag "Priority" :value ?A)
1659 (choice :tag "Face "
1660 (string :tag "Color")
1661 (sexp :tag "Face"))))))
1663 (defcustom org-agenda-day-face-function nil
1664 "Function called to determine what face should be used to display a day.
1665 The only argument passed to that function is the day. It should
1666 returns a face, or nil if does not want to specify a face and let
1667 the normal rules apply."
1668 :group 'org-agenda-line-format
1669 :version "24.1"
1670 :type 'function)
1672 (defcustom org-agenda-category-icon-alist nil
1673 "Alist of category icon to be displayed in agenda views.
1675 Each entry should have the following format:
1677 (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1679 Where CATEGORY-REGEXP is a regexp matching the categories where
1680 the icon should be displayed.
1681 FILE-OR-DATA either a file path or a string containing image data.
1683 The other fields can be omitted safely if not needed:
1684 TYPE indicates the image type.
1685 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1686 image data.
1687 PROPS are additional image attributes to assign to the image,
1688 like, e.g. `:ascent center'.
1690 (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1692 If you want to set the display properties yourself, just put a
1693 list as second element:
1695 (CATEGORY-REGEXP (MY PROPERTY LIST))
1697 For example, to display a 16px horizontal space for Emacs
1698 category, you can use:
1700 (\"Emacs\" '(space . (:width (16))))"
1701 :group 'org-agenda-line-format
1702 :version "24.1"
1703 :type '(alist :key-type (string :tag "Regexp matching category")
1704 :value-type (choice (list :tag "Icon"
1705 (string :tag "File or data")
1706 (symbol :tag "Type")
1707 (boolean :tag "Data?")
1708 (repeat :tag "Extra image properties" :inline t symbol))
1709 (list :tag "Display properties" sexp))))
1711 (defgroup org-agenda-column-view nil
1712 "Options concerning column view in the agenda."
1713 :tag "Org Agenda Column View"
1714 :group 'org-agenda)
1716 (defcustom org-agenda-columns-show-summaries t
1717 "Non-nil means show summaries for columns displayed in the agenda view."
1718 :group 'org-agenda-column-view
1719 :type 'boolean)
1721 (defcustom org-agenda-columns-compute-summary-properties t
1722 "Non-nil means recompute all summary properties before column view.
1723 When column view in the agenda is listing properties that have a summary
1724 operator, it can go to all relevant buffers and recompute the summaries
1725 there. This can mean overhead for the agenda column view, but is necessary
1726 to have thing up to date.
1727 As a special case, a CLOCKSUM property also makes sure that the clock
1728 computations are current."
1729 :group 'org-agenda-column-view
1730 :type 'boolean)
1732 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1733 "Non-nil means the duration of an appointment will add to day effort.
1734 The property to which appointment durations will be added is the one given
1735 in the option `org-effort-property'. If an appointment does not have
1736 an end time, `org-agenda-default-appointment-duration' will be used. If that
1737 is not set, an appointment without end time will not contribute to the time
1738 estimate."
1739 :group 'org-agenda-column-view
1740 :type 'boolean)
1742 (defcustom org-agenda-auto-exclude-function nil
1743 "A function called with a tag to decide if it is filtered on '/ RET'.
1744 The sole argument to the function, which is called once for each
1745 possible tag, is a string giving the name of the tag. The
1746 function should return either nil if the tag should be included
1747 as normal, or \"-<TAG>\" to exclude the tag.
1748 Note that for the purpose of tag filtering, only the lower-case version of
1749 all tags will be considered, so that this function will only ever see
1750 the lower-case version of all tags."
1751 :group 'org-agenda
1752 :type 'function)
1754 (defcustom org-agenda-bulk-custom-functions nil
1755 "Alist of characters and custom functions for bulk actions.
1756 For example, this value makes those two functions available:
1758 '((?R set-category)
1759 (?C bulk-cut))
1761 With selected entries in an agenda buffer, `B R' will call
1762 the custom function `set-category' on the selected entries.
1763 Note that functions in this alist don't need to be quoted."
1764 :type 'alist
1765 :version "24.1"
1766 :group 'org-agenda)
1768 (eval-when-compile
1769 (require 'cl))
1770 (require 'org)
1772 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1773 "Execute BODY with point at location given by `org-hd-marker' property.
1774 If STRING is non-nil, the text property will be fetched from position 0
1775 in that string. If STRING is nil, it will be fetched from the beginning
1776 of the current line."
1777 (org-with-gensyms (marker)
1778 `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1779 'org-hd-marker ,string)))
1780 (with-current-buffer (marker-buffer ,marker)
1781 (save-excursion
1782 (goto-char ,marker)
1783 ,@body)))))
1784 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1786 (defun org-add-agenda-custom-command (entry)
1787 "Replace or add a command in `org-agenda-custom-commands'.
1788 This is mostly for hacking and trying a new command - once the command
1789 works you probably want to add it to `org-agenda-custom-commands' for good."
1790 (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1791 (if ass
1792 (setcdr ass (cdr entry))
1793 (push entry org-agenda-custom-commands))))
1795 ;;; Define the org-agenda-mode
1797 (defvar org-agenda-mode-map (make-sparse-keymap)
1798 "Keymap for `org-agenda-mode'.")
1799 (if (fboundp 'defvaralias)
1800 (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1802 (defvar org-agenda-menu) ; defined later in this file.
1803 (defvar org-agenda-restrict) ; defined later in this file.
1804 (defvar org-agenda-follow-mode nil)
1805 (defvar org-agenda-entry-text-mode nil)
1806 (defvar org-agenda-clockreport-mode nil)
1807 (defvar org-agenda-show-log nil)
1808 (defvar org-agenda-redo-command nil)
1809 (defvar org-agenda-query-string nil)
1810 (defvar org-agenda-mode-hook nil
1811 "Hook for `org-agenda-mode', run after the mode is turned on.")
1812 (defvar org-agenda-type nil)
1813 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1816 ;;; Multiple agenda buffers support
1818 (defcustom org-agenda-sticky nil
1819 "Non-nil means agenda q key will bury agenda buffers.
1820 Agenda commands will then show existing buffer instead of generating new ones.
1821 When nil, `q' will kill the single agenda buffer."
1822 :group 'org-agenda
1823 :type 'boolean)
1825 (defvar org-agenda-buffer nil
1826 "Agenda buffer currently being generated.")
1828 (defun org-toggle-sticky-agenda (&optional arg)
1829 "Toggle `org-agenda-sticky'."
1830 (interactive)
1831 (setq org-agenda-sticky (or arg (not org-agenda-sticky)))
1832 (org-agenda-kill-all-agenda-buffers)
1833 (message "Sticky agenda was %s" (if org-agenda-sticky "enabled" "disabled")))
1835 (defvar org-agenda-last-prefix-arg nil)
1836 (defvar org-agenda-this-buffer-name nil)
1837 (defvar org-agenda-doing-sticky-redo nil)
1838 (defvar org-agenda-this-buffer-is-sticky nil)
1840 (defconst org-agenda-local-vars
1841 '(org-agenda-this-buffer-name
1842 org-agenda-undo-list
1843 org-agenda-pending-undo-list
1844 org-agenda-follow-mode
1845 org-agenda-entry-text-mode
1846 org-agenda-clockreport-mode
1847 org-agenda-show-log
1848 org-agenda-redo-command
1849 org-agenda-query-string
1850 org-agenda-type
1851 org-agenda-bulk-marked-entries
1852 org-agenda-undo-has-started-in
1853 org-agenda-last-arguments
1854 org-agenda-info
1855 org-agenda-tag-filter-overlays
1856 org-agenda-cat-filter-overlays
1857 org-pre-agenda-window-conf
1858 org-agenda-columns-active
1859 org-agenda-tag-filter
1860 org-agenda-category-filter
1861 org-agenda-markers
1862 org-agenda-last-search-view-search-was-boolean
1863 org-agenda-filtered-by-category
1864 org-agenda-filter-form
1865 org-agenda-show-window
1866 org-agenda-cycle-counter
1867 org-agenda-last-prefix-arg)
1868 "Variables that must be local in agenda buffers to allow multiple buffers.")
1870 (defun org-agenda-mode ()
1871 "Mode for time-sorted view on action items in Org-mode files.
1873 The following commands are available:
1875 \\{org-agenda-mode-map}"
1876 (interactive)
1877 (cond (org-agenda-doing-sticky-redo
1878 ;; Refreshing sticky agenda-buffer
1880 ;; Preserve the value of `org-agenda-local-vars' variables,
1881 ;; while letting `kill-all-local-variables' kill the rest
1882 (let ((save (buffer-local-variables)))
1883 (kill-all-local-variables)
1884 (mapc 'make-local-variable org-agenda-local-vars)
1885 (dolist (elem save)
1886 (let ((var (car elem))
1887 (val (cdr elem)))
1888 (when (and val
1889 (member var org-agenda-local-vars))
1890 (set var val)))))
1891 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1892 (org-agenda-sticky
1893 ;; Creating a sticky Agenda buffer for the first time
1894 (kill-all-local-variables)
1895 (mapc 'make-local-variable org-agenda-local-vars)
1896 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) t))
1898 ;; Creating a non-sticky agenda buffer
1899 (kill-all-local-variables)
1900 (set (make-local-variable 'org-agenda-this-buffer-is-sticky) nil)))
1901 (setq org-agenda-undo-list nil
1902 org-agenda-pending-undo-list nil
1903 org-agenda-bulk-marked-entries nil)
1904 (setq major-mode 'org-agenda-mode)
1905 ;; Keep global-font-lock-mode from turning on font-lock-mode
1906 (org-set-local 'font-lock-global-modes (list 'not major-mode))
1907 (setq mode-name "Org-Agenda")
1908 (use-local-map org-agenda-mode-map)
1909 (easy-menu-add org-agenda-menu)
1910 (if org-startup-truncated (setq truncate-lines t))
1911 (org-set-local 'line-move-visual nil)
1912 (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1913 (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1914 ;; Make sure properties are removed when copying text
1915 (when (boundp 'buffer-substring-filters)
1916 (org-set-local 'buffer-substring-filters
1917 (cons (lambda (x)
1918 (set-text-properties 0 (length x) nil x) x)
1919 buffer-substring-filters)))
1920 (unless org-agenda-keep-modes
1921 (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1922 org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1923 org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1924 org-agenda-show-log org-agenda-start-with-log-mode))
1926 (easy-menu-change
1927 '("Agenda") "Agenda Files"
1928 (append
1929 (list
1930 (vector
1931 (if (get 'org-agenda-files 'org-restrict)
1932 "Restricted to single file"
1933 "Edit File List")
1934 '(org-edit-agenda-file-list)
1935 (not (get 'org-agenda-files 'org-restrict)))
1936 "--")
1937 (mapcar 'org-file-menu-entry (org-agenda-files))))
1938 (org-agenda-set-mode-name)
1939 (apply
1940 (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1941 (list 'org-agenda-mode-hook)))
1943 (substitute-key-definition 'undo 'org-agenda-undo
1944 org-agenda-mode-map global-map)
1945 (org-defkey org-agenda-mode-map "\C-i" 'org-agenda-goto)
1946 (org-defkey org-agenda-mode-map [(tab)] 'org-agenda-goto)
1947 (org-defkey org-agenda-mode-map "\C-m" 'org-agenda-switch-to)
1948 (org-defkey org-agenda-mode-map "\C-k" 'org-agenda-kill)
1949 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1950 (org-defkey org-agenda-mode-map "m" 'org-agenda-bulk-mark)
1951 (org-defkey org-agenda-mode-map "%" 'org-agenda-bulk-mark-regexp)
1952 (org-defkey org-agenda-mode-map "u" 'org-agenda-bulk-unmark)
1953 (org-defkey org-agenda-mode-map "U" 'org-agenda-bulk-remove-all-marks)
1954 (org-defkey org-agenda-mode-map "A" 'org-agenda-append-agenda)
1955 (org-defkey org-agenda-mode-map "B" 'org-agenda-bulk-action)
1956 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
1957 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
1958 (org-defkey org-agenda-mode-map "\C-c\C-xa" 'org-agenda-toggle-archive-tag)
1959 (org-defkey org-agenda-mode-map "\C-c\C-xA" 'org-agenda-archive-to-archive-sibling)
1960 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
1961 (org-defkey org-agenda-mode-map "\C-c$" 'org-agenda-archive)
1962 (org-defkey org-agenda-mode-map "$" 'org-agenda-archive)
1963 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
1964 (org-defkey org-agenda-mode-map " " 'org-agenda-show-and-scroll-up)
1965 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
1966 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
1967 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
1968 (org-defkey org-agenda-mode-map [(control shift left)] 'org-agenda-todo-previousset)
1969 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
1970 (org-defkey org-agenda-mode-map "o" 'delete-other-windows)
1971 (org-defkey org-agenda-mode-map "L" 'org-agenda-recenter)
1972 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
1973 (org-defkey org-agenda-mode-map "t" 'org-agenda-todo)
1974 (org-defkey org-agenda-mode-map "a" 'org-agenda-archive-default-with-confirmation)
1975 (org-defkey org-agenda-mode-map ":" 'org-agenda-set-tags)
1976 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
1977 (org-defkey org-agenda-mode-map "." 'org-agenda-goto-today)
1978 (org-defkey org-agenda-mode-map "j" 'org-agenda-goto-date)
1979 (org-defkey org-agenda-mode-map "d" 'org-agenda-day-view)
1980 (org-defkey org-agenda-mode-map "w" 'org-agenda-week-view)
1981 (org-defkey org-agenda-mode-map "y" 'org-agenda-year-view)
1982 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
1983 (org-defkey org-agenda-mode-map "z" 'org-agenda-add-note)
1984 (org-defkey org-agenda-mode-map "k" 'org-agenda-action)
1985 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
1986 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
1987 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
1988 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
1989 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
1991 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
1992 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
1993 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
1994 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1995 (while l (org-defkey org-agenda-mode-map
1996 (int-to-string (pop l)) 'digit-argument)))
1998 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
1999 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
2000 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
2001 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
2002 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
2003 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
2004 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
2005 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
2006 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
2007 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
2008 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
2009 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
2010 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
2011 'org-clock-modify-effort-estimate)
2012 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
2013 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
2014 (org-defkey org-agenda-mode-map "Q" 'org-agenda-Quit)
2015 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
2016 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-agenda-write)
2017 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
2018 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
2019 (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
2020 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
2021 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
2022 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
2023 (substitute-key-definition 'next-line 'org-agenda-next-line
2024 org-agenda-mode-map global-map)
2025 (substitute-key-definition 'previous-line 'org-agenda-previous-line
2026 org-agenda-mode-map global-map)
2027 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
2028 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
2029 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
2030 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
2031 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
2032 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
2033 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2034 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
2035 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2036 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2037 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
2038 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
2039 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
2040 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
2041 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
2042 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
2043 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
2044 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
2045 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
2046 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
2047 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
2048 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
2049 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
2050 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
2051 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
2052 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
2053 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
2054 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
2055 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
2056 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
2058 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
2059 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
2060 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
2061 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
2062 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
2063 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
2064 (org-defkey org-agenda-mode-map "<" 'org-agenda-filter-by-category)
2065 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
2066 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
2067 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
2068 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
2070 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
2071 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
2072 (when org-agenda-mouse-1-follows-link
2073 (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
2074 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2075 '("Agenda"
2076 ("Agenda Files")
2077 "--"
2078 ("Agenda Dates"
2079 ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
2080 ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
2081 ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
2082 ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
2083 "--"
2084 ("View"
2085 ["Day View" org-agenda-day-view
2086 :active (org-agenda-check-type nil 'agenda)
2087 :style radio :selected (eq org-agenda-current-span 'day)
2088 :keys "v d (or just d)"]
2089 ["Week View" org-agenda-week-view
2090 :active (org-agenda-check-type nil 'agenda)
2091 :style radio :selected (eq org-agenda-current-span 'week)
2092 :keys "v w (or just w)"]
2093 ["Month View" org-agenda-month-view
2094 :active (org-agenda-check-type nil 'agenda)
2095 :style radio :selected (eq org-agenda-current-span 'month)
2096 :keys "v m"]
2097 ["Year View" org-agenda-year-view
2098 :active (org-agenda-check-type nil 'agenda)
2099 :style radio :selected (eq org-agenda-current-span 'year)
2100 :keys "v y"]
2101 "--"
2102 ["Include Diary" org-agenda-toggle-diary
2103 :style toggle :selected org-agenda-include-diary
2104 :active (org-agenda-check-type nil 'agenda)]
2105 ["Include Deadlines" org-agenda-toggle-deadlines
2106 :style toggle :selected org-agenda-include-deadlines
2107 :active (org-agenda-check-type nil 'agenda)]
2108 ["Use Time Grid" org-agenda-toggle-time-grid
2109 :style toggle :selected org-agenda-use-time-grid
2110 :active (org-agenda-check-type nil 'agenda)]
2111 "--"
2112 ["Show clock report" org-agenda-clockreport-mode
2113 :style toggle :selected org-agenda-clockreport-mode
2114 :active (org-agenda-check-type nil 'agenda)]
2115 ["Show some entry text" org-agenda-entry-text-mode
2116 :style toggle :selected org-agenda-entry-text-mode
2117 :active t]
2118 "--"
2119 ["Show Logbook entries" org-agenda-log-mode
2120 :style toggle :selected org-agenda-show-log
2121 :active (org-agenda-check-type nil 'agenda 'timeline)
2122 :keys "v l (or just l)"]
2123 ["Include archived trees" org-agenda-archives-mode
2124 :style toggle :selected org-agenda-archives-mode :active t
2125 :keys "v a"]
2126 ["Include archive files" (org-agenda-archives-mode t)
2127 :style toggle :selected (eq org-agenda-archives-mode t) :active t
2128 :keys "v A"]
2129 "--"
2130 ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2131 ["Write view to file" org-agenda-write t]
2132 ["Rebuild buffer" org-agenda-redo t]
2133 ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2134 "--"
2135 ["Show original entry" org-agenda-show t]
2136 ["Go To (other window)" org-agenda-goto t]
2137 ["Go To (this window)" org-agenda-switch-to t]
2138 ["Follow Mode" org-agenda-follow-mode
2139 :style toggle :selected org-agenda-follow-mode :active t]
2140 ; ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2141 "--"
2142 ("TODO"
2143 ["Cycle TODO" org-agenda-todo t]
2144 ["Next TODO set" org-agenda-todo-nextset t]
2145 ["Previous TODO set" org-agenda-todo-previousset t]
2146 ["Add note" org-agenda-add-note t])
2147 ("Archive/Refile/Delete"
2148 ["Archive default" org-agenda-archive-default t]
2149 ["Archive default" org-agenda-archive-default-with-confirmation t]
2150 ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2151 ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2152 ["Archive subtree" org-agenda-archive t]
2153 "--"
2154 ["Refile" org-agenda-refile t]
2155 "--"
2156 ["Delete subtree" org-agenda-kill t])
2157 ("Bulk action"
2158 ["Mark entry" org-agenda-bulk-mark t]
2159 ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2160 ["Unmark entry" org-agenda-bulk-unmark t]
2161 ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
2162 ["Act on all marked" org-agenda-bulk-action t]
2163 "--"
2164 ("Tags and Properties"
2165 ["Show all Tags" org-agenda-show-tags t]
2166 ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2167 ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2168 "--"
2169 ["Column View" org-columns t])
2170 ("Deadline/Schedule"
2171 ["Schedule" org-agenda-schedule t]
2172 ["Set Deadline" org-agenda-deadline t]
2173 "--"
2174 ["Mark item" org-agenda-action :active t :keys "k m"]
2175 ["Show mark item" org-agenda-action :active t :keys "k v"]
2176 ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2177 ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2178 "--"
2179 ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2180 ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2181 ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2182 ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2183 ["Change Time + min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2184 ["Change Time - min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2185 ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2186 ("Clock and Effort"
2187 ["Clock in" org-agenda-clock-in t]
2188 ["Clock out" org-agenda-clock-out t]
2189 ["Clock cancel" org-agenda-clock-cancel t]
2190 ["Goto running clock" org-clock-goto t]
2191 "--"
2192 ["Set Effort" org-agenda-set-effort t]
2193 ["Change clocked effort" org-clock-modify-effort-estimate
2194 (org-clock-is-active)])
2195 ("Priority"
2196 ["Set Priority" org-agenda-priority t]
2197 ["Increase Priority" org-agenda-priority-up t]
2198 ["Decrease Priority" org-agenda-priority-down t]
2199 ["Show Priority" org-agenda-show-priority t])
2200 ("Calendar/Diary"
2201 ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2202 ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2203 ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2204 ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2205 ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2206 ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2207 "--"
2208 ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2209 "--"
2210 ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2211 "--"
2212 ("MobileOrg"
2213 ["Push Files and Views" org-mobile-push t]
2214 ["Get Captured and Flagged" org-mobile-pull t]
2215 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2216 ["Show note / unflag" org-agenda-show-the-flagging-note t]
2217 "--"
2218 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2219 "--"
2220 ["Quit" org-agenda-quit t]
2221 ["Exit and Release Buffers" org-agenda-exit t]
2224 ;;; Agenda undo
2226 (defvar org-agenda-allow-remote-undo t
2227 "Non-nil means allow remote undo from the agenda buffer.")
2228 (defvar org-agenda-undo-list nil
2229 "List of undoable operations in the agenda since last refresh.")
2230 (defvar org-agenda-undo-has-started-in nil
2231 "Buffers that have already seen `undo-start' in the current undo sequence.")
2232 (defvar org-agenda-pending-undo-list nil
2233 "In a series of undo commands, this is the list of remaining undo items.")
2235 (defun org-agenda-undo ()
2236 "Undo a remote editing step in the agenda.
2237 This undoes changes both in the agenda buffer and in the remote buffer
2238 that have been changed along."
2239 (interactive)
2240 (or org-agenda-allow-remote-undo
2241 (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2242 (if (not (eq this-command last-command))
2243 (setq org-agenda-undo-has-started-in nil
2244 org-agenda-pending-undo-list org-agenda-undo-list))
2245 (if (not org-agenda-pending-undo-list)
2246 (error "No further undo information"))
2247 (let* ((entry (pop org-agenda-pending-undo-list))
2248 buf line cmd rembuf)
2249 (setq cmd (pop entry) line (pop entry))
2250 (setq rembuf (nth 2 entry))
2251 (org-with-remote-undo rembuf
2252 (while (bufferp (setq buf (pop entry)))
2253 (if (pop entry)
2254 (with-current-buffer buf
2255 (let ((last-undo-buffer buf)
2256 (inhibit-read-only t))
2257 (unless (memq buf org-agenda-undo-has-started-in)
2258 (push buf org-agenda-undo-has-started-in)
2259 (make-local-variable 'pending-undo-list)
2260 (undo-start))
2261 (while (and pending-undo-list
2262 (listp pending-undo-list)
2263 (not (car pending-undo-list)))
2264 (pop pending-undo-list))
2265 (undo-more 1))))))
2266 (org-goto-line line)
2267 (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2269 (defun org-verify-change-for-undo (l1 l2)
2270 "Verify that a real change occurred between the undo lists L1 and L2."
2271 (while (and l1 (listp l1) (null (car l1))) (pop l1))
2272 (while (and l2 (listp l2) (null (car l2))) (pop l2))
2273 (not (eq l1 l2)))
2275 ;;; Agenda dispatch
2277 (defvar org-agenda-restrict nil)
2278 (defvar org-agenda-restrict-begin (make-marker))
2279 (defvar org-agenda-restrict-end (make-marker))
2280 (defvar org-agenda-last-dispatch-buffer nil)
2281 (defvar org-agenda-overriding-restriction nil)
2283 ;;;###autoload
2284 (defun org-agenda (&optional arg keys restriction)
2285 "Dispatch agenda commands to collect entries to the agenda buffer.
2286 Prompts for a command to execute. Any prefix arg will be passed
2287 on to the selected command. The default selections are:
2289 a Call `org-agenda-list' to display the agenda for current day or week.
2290 t Call `org-todo-list' to display the global todo list.
2291 T Call `org-todo-list' to display the global todo list, select only
2292 entries with a specific TODO keyword (the user gets a prompt).
2293 m Call `org-tags-view' to display headlines with tags matching
2294 a condition (the user is prompted for the condition).
2295 M Like `m', but select only TODO entries, no ordinary headlines.
2296 L Create a timeline for the current buffer.
2297 e Export views to associated files.
2298 s Search entries for keywords.
2299 / Multi occur across all agenda files and also files listed
2300 in `org-agenda-text-search-extra-files'.
2301 < Restrict agenda commands to buffer, subtree, or region.
2302 Press several times to get the desired effect.
2303 > Remove a previous restriction.
2304 # List \"stuck\" projects.
2305 ! Configure what \"stuck\" means.
2306 C Configure custom agenda commands.
2308 More commands can be added by configuring the variable
2309 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
2310 searches can be pre-defined in this way.
2312 If the current buffer is in Org-mode and visiting a file, you can also
2313 first press `<' once to indicate that the agenda should be temporarily
2314 \(until the next use of \\[org-agenda]) restricted to the current file.
2315 Pressing `<' twice means to restrict to the current subtree or region
2316 \(if active)."
2317 (interactive "P")
2318 (catch 'exit
2319 (let* ((prefix-descriptions nil)
2320 (org-agenda-buffer-name org-agenda-buffer-name)
2321 (org-agenda-window-setup (if (equal (buffer-name)
2322 org-agenda-buffer-name)
2323 'current-window
2324 org-agenda-window-setup))
2325 (org-agenda-custom-commands-orig org-agenda-custom-commands)
2326 (org-agenda-custom-commands
2327 ;; normalize different versions
2328 (delq nil
2329 (mapcar
2330 (lambda (x)
2331 (cond ((stringp (cdr x))
2332 (push x prefix-descriptions)
2333 nil)
2334 ((stringp (nth 1 x)) x)
2335 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2336 (t (cons (car x) (cons "" (cdr x))))))
2337 org-agenda-custom-commands)))
2338 (buf (current-buffer))
2339 (bfn (buffer-file-name (buffer-base-buffer)))
2340 entry key type match lprops ans)
2341 ;; Turn off restriction unless there is an overriding one,
2342 (unless org-agenda-overriding-restriction
2343 (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2344 ;; There is a request to keep the file list in place
2345 (put 'org-agenda-files 'org-restrict nil))
2346 (setq org-agenda-restrict nil)
2347 (move-marker org-agenda-restrict-begin nil)
2348 (move-marker org-agenda-restrict-end nil))
2349 ;; Delete old local properties
2350 (put 'org-agenda-redo-command 'org-lprops nil)
2351 ;; Delete previously set last-arguments
2352 (put 'org-agenda-redo-command 'last-args nil)
2353 ;; Remember where this call originated
2354 (setq org-agenda-last-dispatch-buffer (current-buffer))
2355 (unless keys
2356 (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2357 keys (car ans)
2358 restriction (cdr ans)))
2359 ;; If we have sticky agenda buffers, set a name for the buffer,
2360 ;; depending on the invoking keys. The user may still set this
2361 ;; as a command option, which will overwrite what we do here.
2362 (if org-agenda-sticky
2363 (setq org-agenda-buffer-name (format "*Org Agenda(%s)*" keys)))
2364 ;; Establish the restriction, if any
2365 (when (and (not org-agenda-overriding-restriction) restriction)
2366 (put 'org-agenda-files 'org-restrict (list bfn))
2367 (cond
2368 ((eq restriction 'region)
2369 (setq org-agenda-restrict t)
2370 (move-marker org-agenda-restrict-begin (region-beginning))
2371 (move-marker org-agenda-restrict-end (region-end)))
2372 ((eq restriction 'subtree)
2373 (save-excursion
2374 (setq org-agenda-restrict t)
2375 (org-back-to-heading t)
2376 (move-marker org-agenda-restrict-begin (point))
2377 (move-marker org-agenda-restrict-end
2378 (progn (org-end-of-subtree t)))))))
2380 ;; For example the todo list should not need it (but does...)
2381 (cond
2382 ((setq entry (assoc keys org-agenda-custom-commands))
2383 (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2384 (progn
2385 (setq type (nth 2 entry) match (eval (nth 3 entry))
2386 lprops (nth 4 entry))
2387 (put 'org-agenda-redo-command 'org-lprops lprops)
2388 (cond
2389 ((eq type 'agenda)
2390 (org-let lprops '(org-agenda-list current-prefix-arg)))
2391 ((eq type 'alltodo)
2392 (org-let lprops '(org-todo-list current-prefix-arg)))
2393 ((eq type 'search)
2394 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2395 ((eq type 'stuck)
2396 (org-let lprops '(org-agenda-list-stuck-projects
2397 current-prefix-arg)))
2398 ((eq type 'tags)
2399 (org-let lprops '(org-tags-view current-prefix-arg match)))
2400 ((eq type 'tags-todo)
2401 (org-let lprops '(org-tags-view '(4) match)))
2402 ((eq type 'todo)
2403 (org-let lprops '(org-todo-list match)))
2404 ((eq type 'tags-tree)
2405 (org-check-for-org-mode)
2406 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2407 ((eq type 'todo-tree)
2408 (org-check-for-org-mode)
2409 (org-let lprops
2410 '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2411 (regexp-quote match) "\\>"))))
2412 ((eq type 'occur-tree)
2413 (org-check-for-org-mode)
2414 (org-let lprops '(org-occur match)))
2415 ((functionp type)
2416 (org-let lprops '(funcall type match)))
2417 ((fboundp type)
2418 (org-let lprops '(funcall type match)))
2419 (t (error "Invalid custom agenda command type %s" type))))
2420 (org-agenda-run-series (nth 1 entry) (cddr entry))))
2421 ((equal keys "C")
2422 (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2423 (customize-variable 'org-agenda-custom-commands))
2424 ((equal keys "a") (call-interactively 'org-agenda-list))
2425 ((equal keys "s") (call-interactively 'org-search-view))
2426 ((equal keys "t") (call-interactively 'org-todo-list))
2427 ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2428 ((equal keys "m") (call-interactively 'org-tags-view))
2429 ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2430 ((equal keys "e") (call-interactively 'org-store-agenda-views))
2431 ((equal keys "?") (org-tags-view nil "+FLAGGED")
2432 (org-add-hook
2433 'post-command-hook
2434 (lambda ()
2435 (unless (current-message)
2436 (let* ((m (org-agenda-get-any-marker))
2437 (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2438 (when note
2439 (message (concat
2440 "FLAGGING-NOTE ([?] for more info): "
2441 (org-add-props
2442 (replace-regexp-in-string
2443 "\\\\n" "//"
2444 (copy-sequence note))
2445 nil 'face 'org-warning)))))))
2446 t t))
2447 ((equal keys "L")
2448 (unless (eq major-mode 'org-mode)
2449 (error "This is not an Org-mode file"))
2450 (unless restriction
2451 (put 'org-agenda-files 'org-restrict (list bfn))
2452 (org-call-with-arg 'org-timeline arg)))
2453 ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2454 ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2455 ((equal keys "!") (customize-variable 'org-stuck-projects))
2456 (t (error "Invalid agenda key"))))))
2458 (defun org-agenda-append-agenda ()
2459 "Append another agenda view to the current one.
2460 This function allows interactive building of block agendas.
2461 Agenda views are separated by `org-agenda-block-separator'."
2462 (interactive)
2463 (unless (string= (buffer-name) org-agenda-buffer-name)
2464 (error "Can only append from within agenda buffer"))
2465 (let ((org-agenda-multi t))
2466 (org-agenda)
2467 (widen)))
2469 (defun org-agenda-normalize-custom-commands (cmds)
2470 (delq nil
2471 (mapcar
2472 (lambda (x)
2473 (cond ((stringp (cdr x)) nil)
2474 ((stringp (nth 1 x)) x)
2475 ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2476 (t (cons (car x) (cons "" (cdr x))))))
2477 cmds)))
2479 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2480 "The user interface for selecting an agenda command."
2481 (catch 'exit
2482 (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2483 (restrict-ok (and bfn (eq major-mode 'org-mode)))
2484 (region-p (org-region-active-p))
2485 (custom org-agenda-custom-commands)
2486 (selstring "")
2487 restriction second-time
2488 c entry key type match prefixes rmheader header-end custom1 desc
2489 line lines left right n n1)
2490 (save-window-excursion
2491 (delete-other-windows)
2492 (org-switch-to-buffer-other-window " *Agenda Commands*")
2493 (erase-buffer)
2494 (insert (eval-when-compile
2495 (let ((header
2496 "Press key for an agenda command: < Buffer, subtree/region restriction
2497 -------------------------------- > Remove restriction
2498 a Agenda for current week or day e Export agenda views
2499 t List of all TODO entries T Entries with special TODO kwd
2500 m Match a TAGS/PROP/TODO query M Like m, but only TODO entries
2501 L Timeline for current buffer # List stuck projects (!=configure)
2502 s Search for keywords * Toggle sticky agenda views
2503 / Multi-occur ? Find :FLAGGED: entries
2504 C Configure custom agenda commands
2506 (start 0))
2507 (while (string-match
2508 "\\(^\\| \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2509 header start)
2510 (setq start (match-end 0))
2511 (add-text-properties (match-beginning 2) (match-end 2)
2512 '(face bold) header))
2513 header)))
2514 (setq header-end (move-marker (make-marker) (point)))
2515 (while t
2516 (setq custom1 custom)
2517 (when (eq rmheader t)
2518 (org-goto-line 1)
2519 (re-search-forward ":" nil t)
2520 (delete-region (match-end 0) (point-at-eol))
2521 (forward-char 1)
2522 (looking-at "-+")
2523 (delete-region (match-end 0) (point-at-eol))
2524 (move-marker header-end (match-end 0)))
2525 (goto-char header-end)
2526 (delete-region (point) (point-max))
2528 ;; Produce all the lines that describe custom commands and prefixes
2529 (setq lines nil)
2530 (while (setq entry (pop custom1))
2531 (setq key (car entry) desc (nth 1 entry)
2532 type (nth 2 entry)
2533 match (nth 3 entry))
2534 (if (> (length key) 1)
2535 (add-to-list 'prefixes (string-to-char key))
2536 (setq line
2537 (format
2538 "%-4s%-14s"
2539 (org-add-props (copy-sequence key)
2540 '(face bold))
2541 (cond
2542 ((string-match "\\S-" desc) desc)
2543 ((eq type 'agenda) "Agenda for current week or day")
2544 ((eq type 'alltodo) "List of all TODO entries")
2545 ((eq type 'search) "Word search")
2546 ((eq type 'stuck) "List of stuck projects")
2547 ((eq type 'todo) "TODO keyword")
2548 ((eq type 'tags) "Tags query")
2549 ((eq type 'tags-todo) "Tags (TODO)")
2550 ((eq type 'tags-tree) "Tags tree")
2551 ((eq type 'todo-tree) "TODO kwd tree")
2552 ((eq type 'occur-tree) "Occur tree")
2553 ((functionp type) (if (symbolp type)
2554 (symbol-name type)
2555 "Lambda expression"))
2556 (t "???"))))
2557 (if org-agenda-menu-show-matcher
2558 (setq line
2559 (concat line ": "
2560 (cond
2561 ((stringp match)
2562 (setq match (copy-sequence match))
2563 (org-add-props match nil 'face 'org-warning))
2564 (match
2565 (format "set of %d commands" (length match)))
2566 (t ""))))
2567 (if (org-string-nw-p match)
2568 (add-text-properties
2569 0 (length line) (list 'help-echo
2570 (concat "Matcher: "match)) line)))
2571 (push line lines)))
2572 (setq lines (nreverse lines))
2573 (when prefixes
2574 (mapc (lambda (x)
2575 (push
2576 (format "%s %s"
2577 (org-add-props (char-to-string x)
2578 nil 'face 'bold)
2579 (or (cdr (assoc (concat selstring
2580 (char-to-string x))
2581 prefix-descriptions))
2582 "Prefix key"))
2583 lines))
2584 prefixes))
2586 ;; Check if we should display in two columns
2587 (if org-agenda-menu-two-column
2588 (progn
2589 (setq n (length lines)
2590 n1 (+ (/ n 2) (mod n 2))
2591 right (nthcdr n1 lines)
2592 left (copy-sequence lines))
2593 (setcdr (nthcdr (1- n1) left) nil))
2594 (setq left lines right nil))
2595 (while left
2596 (insert "\n" (pop left))
2597 (when right
2598 (if (< (current-column) 40)
2599 (move-to-column 40 t)
2600 (insert " "))
2601 (insert (pop right))))
2603 ;; Make the window the right size
2604 (goto-char (point-min))
2605 (if second-time
2606 (if (not (pos-visible-in-window-p (point-max)))
2607 (org-fit-window-to-buffer))
2608 (setq second-time t)
2609 (org-fit-window-to-buffer))
2611 ;; Ask for selection
2612 (message "Press key for agenda command%s:"
2613 (if (or restrict-ok org-agenda-overriding-restriction)
2614 (if org-agenda-overriding-restriction
2615 " (restriction lock active)"
2616 (if restriction
2617 (format " (restricted to %s)" restriction)
2618 " (unrestricted)"))
2619 ""))
2620 (setq c (read-char-exclusive))
2621 (message "")
2622 (cond
2623 ((assoc (char-to-string c) custom)
2624 (setq selstring (concat selstring (char-to-string c)))
2625 (throw 'exit (cons selstring restriction)))
2626 ((memq c prefixes)
2627 (setq selstring (concat selstring (char-to-string c))
2628 prefixes nil
2629 rmheader (or rmheader t)
2630 custom (delq nil (mapcar
2631 (lambda (x)
2632 (if (or (= (length (car x)) 1)
2633 (/= (string-to-char (car x)) c))
2635 (cons (substring (car x) 1) (cdr x))))
2636 custom))))
2637 ((eq c ?*)
2638 (org-toggle-sticky-agenda)
2639 (sit-for 2))
2640 ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2641 (message "Restriction is only possible in Org-mode buffers")
2642 (ding) (sit-for 1))
2643 ((eq c ?1)
2644 (org-agenda-remove-restriction-lock 'noupdate)
2645 (setq restriction 'buffer))
2646 ((eq c ?0)
2647 (org-agenda-remove-restriction-lock 'noupdate)
2648 (setq restriction (if region-p 'region 'subtree)))
2649 ((eq c ?<)
2650 (org-agenda-remove-restriction-lock 'noupdate)
2651 (setq restriction
2652 (cond
2653 ((eq restriction 'buffer)
2654 (if region-p 'region 'subtree))
2655 ((memq restriction '(subtree region))
2656 nil)
2657 (t 'buffer))))
2658 ((eq c ?>)
2659 (org-agenda-remove-restriction-lock 'noupdate)
2660 (setq restriction nil))
2661 ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2662 (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2663 ((and (> (length selstring) 0) (eq c ?\d))
2664 (delete-window)
2665 (org-agenda-get-restriction-and-command prefix-descriptions))
2667 ((equal c ?q) (error "Abort"))
2668 (t (error "Invalid key %c" c))))))))
2670 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2671 (defvar org-agenda-last-arguments nil
2672 "The arguments of the previous call to `org-agenda'.")
2673 (defun org-agenda-run-series (name series)
2674 (org-let (nth 1 series) '(org-prepare-agenda name))
2675 ;; We need to reset agenda markers heree, because when constructing a
2676 ;; block agenda, the individual blocks do not do that.
2677 (org-agenda-reset-markers)
2678 (let* ((org-agenda-multi t)
2679 (redo (list 'org-agenda-run-series name (list 'quote series)))
2680 (org-agenda-overriding-arguments
2681 (or org-agenda-overriding-arguments
2682 (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2683 (get 'org-agenda-redo-command 'last-args))))
2684 (cmds (car series))
2685 (gprops (nth 1 series))
2686 match ;; The byte compiler incorrectly complains about this. Keep it!
2687 cmd type lprops)
2688 (while (setq cmd (pop cmds))
2689 (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2690 (cond
2691 ((eq type 'agenda)
2692 (org-let2 gprops lprops
2693 '(call-interactively 'org-agenda-list)))
2694 ((eq type 'alltodo)
2695 (org-let2 gprops lprops
2696 '(call-interactively 'org-todo-list)))
2697 ((eq type 'search)
2698 (org-let2 gprops lprops
2699 '(org-search-view current-prefix-arg match nil)))
2700 ((eq type 'stuck)
2701 (org-let2 gprops lprops
2702 '(call-interactively 'org-agenda-list-stuck-projects)))
2703 ((eq type 'tags)
2704 (org-let2 gprops lprops
2705 '(org-tags-view current-prefix-arg match)))
2706 ((eq type 'tags-todo)
2707 (org-let2 gprops lprops
2708 '(org-tags-view '(4) match)))
2709 ((eq type 'todo)
2710 (org-let2 gprops lprops
2711 '(org-todo-list match)))
2712 ((fboundp type)
2713 (org-let2 gprops lprops
2714 '(funcall type match)))
2715 (t (error "Invalid type in command series"))))
2716 (widen)
2717 (setq org-agenda-redo-command redo)
2718 (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2719 (goto-char (point-min)))
2720 (org-fit-agenda-window)
2721 (org-let (nth 1 series) '(org-finalize-agenda)))
2723 ;;;###autoload
2724 (defmacro org-batch-agenda (cmd-key &rest parameters)
2725 "Run an agenda command in batch mode and send the result to STDOUT.
2726 If CMD-KEY is a string of length 1, it is used as a key in
2727 `org-agenda-custom-commands' and triggers this command. If it is a
2728 longer string it is used as a tags/todo match string.
2729 Parameters are alternating variable names and values that will be bound
2730 before running the agenda command."
2731 (org-eval-in-environment (org-make-parameter-alist parameters)
2732 (if (> (length cmd-key) 2)
2733 (org-tags-view nil cmd-key)
2734 (org-agenda nil cmd-key)))
2735 (set-buffer org-agenda-buffer-name)
2736 (princ (buffer-string)))
2737 (def-edebug-spec org-batch-agenda (form &rest sexp))
2739 (defvar org-agenda-info nil)
2741 ;;;###autoload
2742 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2743 "Run an agenda command in batch mode and send the result to STDOUT.
2744 If CMD-KEY is a string of length 1, it is used as a key in
2745 `org-agenda-custom-commands' and triggers this command. If it is a
2746 longer string it is used as a tags/todo match string.
2747 Parameters are alternating variable names and values that will be bound
2748 before running the agenda command.
2750 The output gives a line for each selected agenda item. Each
2751 item is a list of comma-separated values, like this:
2753 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2755 category The category of the item
2756 head The headline, without TODO kwd, TAGS and PRIORITY
2757 type The type of the agenda entry, can be
2758 todo selected in TODO match
2759 tagsmatch selected in tags match
2760 diary imported from diary
2761 deadline a deadline on given date
2762 scheduled scheduled on given date
2763 timestamp entry has timestamp on given date
2764 closed entry was closed on given date
2765 upcoming-deadline warning about deadline
2766 past-scheduled forwarded scheduled item
2767 block entry has date block including g. date
2768 todo The todo keyword, if any
2769 tags All tags including inherited ones, separated by colons
2770 date The relevant date, like 2007-2-14
2771 time The time, like 15:00-16:50
2772 extra Sting with extra planning info
2773 priority-l The priority letter if any was given
2774 priority-n The computed numerical priority
2775 agenda-day The day in the agenda where this is listed"
2776 (org-eval-in-environment (append '((org-agenda-remove-tags t))
2777 (org-make-parameter-alist parameters))
2778 (if (> (length cmd-key) 2)
2779 (org-tags-view nil cmd-key)
2780 (org-agenda nil cmd-key)))
2781 (set-buffer org-agenda-buffer-name)
2782 (let* ((lines (org-split-string (buffer-string) "\n"))
2783 line)
2784 (while (setq line (pop lines))
2785 (catch 'next
2786 (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2787 (setq org-agenda-info
2788 (org-fix-agenda-info (text-properties-at 0 line)))
2789 (princ
2790 (mapconcat 'org-agenda-export-csv-mapper
2791 '(org-category txt type todo tags date time extra
2792 priority-letter priority agenda-day)
2793 ","))
2794 (princ "\n")))))
2795 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2797 (defun org-fix-agenda-info (props)
2798 "Make sure all properties on an agenda item have a canonical form.
2799 This ensures the export commands can easily use it."
2800 (let (tmp re)
2801 (when (setq tmp (plist-get props 'tags))
2802 (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2803 (when (setq tmp (plist-get props 'date))
2804 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2805 (let ((calendar-date-display-form '(year "-" month "-" day)))
2806 '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2808 (setq tmp (calendar-date-string tmp)))
2809 (setq props (plist-put props 'date tmp)))
2810 (when (setq tmp (plist-get props 'day))
2811 (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2812 (let ((calendar-date-display-form '(year "-" month "-" day)))
2813 (setq tmp (calendar-date-string tmp)))
2814 (setq props (plist-put props 'day tmp))
2815 (setq props (plist-put props 'agenda-day tmp)))
2816 (when (setq tmp (plist-get props 'txt))
2817 (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2818 (plist-put props 'priority-letter (match-string 1 tmp))
2819 (setq tmp (replace-match "" t t tmp)))
2820 (when (and (setq re (plist-get props 'org-todo-regexp))
2821 (setq re (concat "\\`\\.*" re " ?"))
2822 (string-match re tmp))
2823 (plist-put props 'todo (match-string 1 tmp))
2824 (setq tmp (replace-match "" t t tmp)))
2825 (plist-put props 'txt tmp)))
2826 props)
2828 (defun org-agenda-export-csv-mapper (prop)
2829 (let ((res (plist-get org-agenda-info prop)))
2830 (setq res
2831 (cond
2832 ((not res) "")
2833 ((stringp res) res)
2834 (t (prin1-to-string res))))
2835 (while (string-match "," res)
2836 (setq res (replace-match ";" t t res))) ;
2837 (org-trim res)))
2840 ;;;###autoload
2841 (defun org-store-agenda-views (&rest parameters)
2842 (interactive)
2843 (eval (list 'org-batch-store-agenda-views)))
2845 ;;;###autoload
2846 (defmacro org-batch-store-agenda-views (&rest parameters)
2847 "Run all custom agenda commands that have a file argument."
2848 (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2849 (pop-up-frames nil)
2850 (dir default-directory)
2851 (pars (org-make-parameter-alist parameters))
2852 cmd thiscmdkey files opts cmd-or-set)
2853 (save-window-excursion
2854 (while cmds
2855 (setq cmd (pop cmds)
2856 thiscmdkey (car cmd)
2857 cmd-or-set (nth 2 cmd)
2858 opts (nth (if (listp cmd-or-set) 3 4) cmd)
2859 files (nth (if (listp cmd-or-set) 4 5) cmd))
2860 (if (stringp files) (setq files (list files)))
2861 (when files
2862 (org-eval-in-environment (append org-agenda-exporter-settings
2863 opts pars)
2864 (org-agenda nil thiscmdkey))
2865 (set-buffer org-agenda-buffer-name)
2866 (while files
2867 (org-eval-in-environment (append org-agenda-exporter-settings
2868 opts pars)
2869 (org-agenda-write (expand-file-name (pop files) dir) nil t)))
2870 (and (get-buffer org-agenda-buffer-name)
2871 (kill-buffer org-agenda-buffer-name)))))))
2872 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2874 (defun org-agenda-mark-header-line (pos)
2875 "Mark the line at POS as an agenda structure header."
2876 (save-excursion
2877 (goto-char pos)
2878 (put-text-property (point-at-bol) (point-at-eol)
2879 'org-agenda-structural-header t)
2880 (when org-agenda-title-append
2881 (put-text-property (point-at-bol) (point-at-eol)
2882 'org-agenda-title-append org-agenda-title-append))))
2884 (defvar org-mobile-creating-agendas)
2885 (defvar org-agenda-write-buffer-name "Agenda View")
2886 (defun org-agenda-write (file &optional open nosettings)
2887 "Write the current buffer (an agenda view) as a file.
2888 Depending on the extension of the file name, plain text (.txt),
2889 HTML (.html or .htm) or Postscript (.ps) is produced.
2890 If the extension is .ics, run icalendar export over all files used
2891 to construct the agenda and limit the export to entries listed in the
2892 agenda now.
2893 With prefix argument OPEN, open the new file immediately.
2894 If NOSETTINGS is given, do not scope the settings of
2895 `org-agenda-exporter-settings' into the export commands. This is used when
2896 the settings have already been scoped and we do not wish to overrule other,
2897 higher priority settings."
2898 (interactive "FWrite agenda to file: \nP")
2899 (if (not (file-writable-p file))
2900 (error "Cannot write agenda to file %s" file))
2901 (org-let (if nosettings nil org-agenda-exporter-settings)
2902 '(save-excursion
2903 (save-window-excursion
2904 (org-agenda-mark-filtered-text)
2905 (let ((bs (copy-sequence (buffer-string))) beg)
2906 (org-agenda-unmark-filtered-text)
2907 (with-temp-buffer
2908 (rename-buffer org-agenda-write-buffer-name t)
2909 (set-buffer-modified-p nil)
2910 (insert bs)
2911 (org-agenda-remove-marked-text 'org-filtered)
2912 (while (setq beg (text-property-any (point-min) (point-max)
2913 'org-filtered t))
2914 (delete-region
2915 beg (or (next-single-property-change beg 'org-filtered)
2916 (point-max))))
2917 (run-hooks 'org-agenda-before-write-hook)
2918 (cond
2919 ((org-bound-and-true-p org-mobile-creating-agendas)
2920 (org-mobile-write-agenda-for-mobile file))
2921 ((string-match "\\.html?\\'" file)
2922 (require 'htmlize)
2923 (set-buffer (htmlize-buffer (current-buffer)))
2925 (when (and org-agenda-export-html-style
2926 (string-match "<style>" org-agenda-export-html-style))
2927 ;; replace <style> section with org-agenda-export-html-style
2928 (goto-char (point-min))
2929 (kill-region (- (search-forward "<style") 6)
2930 (search-forward "</style>"))
2931 (insert org-agenda-export-html-style))
2932 (write-file file)
2933 (kill-buffer (current-buffer))
2934 (message "HTML written to %s" file))
2935 ((string-match "\\.ps\\'" file)
2936 (require 'ps-print)
2937 (ps-print-buffer-with-faces file)
2938 (message "Postscript written to %s" file))
2939 ((string-match "\\.pdf\\'" file)
2940 (require 'ps-print)
2941 (ps-print-buffer-with-faces
2942 (concat (file-name-sans-extension file) ".ps"))
2943 (call-process "ps2pdf" nil nil nil
2944 (expand-file-name
2945 (concat (file-name-sans-extension file) ".ps"))
2946 (expand-file-name file))
2947 (delete-file (concat (file-name-sans-extension file) ".ps"))
2948 (message "PDF written to %s" file))
2949 ((string-match "\\.ics\\'" file)
2950 (require 'org-icalendar)
2951 (let ((org-agenda-marker-table
2952 (org-create-marker-find-array
2953 (org-agenda-collect-markers)))
2954 (org-icalendar-verify-function 'org-check-agenda-marker-table)
2955 (org-combined-agenda-icalendar-file file))
2956 (apply 'org-export-icalendar 'combine
2957 (org-agenda-files nil 'ifmode))))
2959 (let ((bs (buffer-string)))
2960 (find-file file)
2961 (erase-buffer)
2962 (insert bs)
2963 (save-buffer 0)
2964 (kill-buffer (current-buffer))
2965 (message "Plain text written to %s" file))))))))
2966 (set-buffer org-agenda-buffer-name))
2967 (when open (org-open-file file)))
2969 (defvar org-agenda-tag-filter-overlays nil)
2970 (defvar org-agenda-cat-filter-overlays nil)
2972 (defun org-agenda-mark-filtered-text ()
2973 "Mark all text hidden by filtering with a text property."
2974 (let ((inhibit-read-only t))
2975 (mapc
2976 (lambda (o)
2977 (when (equal (overlay-buffer o) (current-buffer))
2978 (put-text-property
2979 (overlay-start o) (overlay-end o)
2980 'org-filtered t)))
2981 (append org-agenda-tag-filter-overlays
2982 org-agenda-cat-filter-overlays))))
2984 (defun org-agenda-unmark-filtered-text ()
2985 "Remove the filtering text property."
2986 (let ((inhibit-read-only t))
2987 (remove-text-properties (point-min) (point-max) '(org-filtered t))))
2989 (defun org-agenda-remove-marked-text (property &optional value)
2990 "Delete all text marked with VALUE of PROPERTY.
2991 VALUE defaults to t."
2992 (let (beg)
2993 (setq value (or value t))
2994 (while (setq beg (text-property-any (point-min) (point-max)
2995 property value))
2996 (delete-region
2997 beg (or (next-single-property-change beg 'org-filtered)
2998 (point-max))))))
3000 (defun org-agenda-add-entry-text ()
3001 "Add entry text to agenda lines.
3002 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
3003 entry text following headings shown in the agenda.
3004 Drawers will be excluded, also the line with scheduling/deadline info."
3005 (when (and (> org-agenda-add-entry-text-maxlines 0)
3006 (not (org-bound-and-true-p org-mobile-creating-agendas)))
3007 (let (m txt)
3008 (goto-char (point-min))
3009 (while (not (eobp))
3010 (if (not (setq m (org-get-at-bol 'org-hd-marker)))
3011 (beginning-of-line 2)
3012 (setq txt (org-agenda-get-some-entry-text
3013 m org-agenda-add-entry-text-maxlines " > "))
3014 (end-of-line 1)
3015 (if (string-match "\\S-" txt)
3016 (insert "\n" txt)
3017 (or (eobp) (forward-char 1))))))))
3019 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
3020 &rest keep)
3021 "Extract entry text from MARKER, at most N-LINES lines.
3022 This will ignore drawers etc, just get the text.
3023 If INDENT is given, prefix every line with this string. If KEEP is
3024 given, it is a list of symbols, defining stuff that should not be
3025 removed from the entry content. Currently only `planning' is allowed here."
3026 (let (txt drawer-re kwd-time-re ind)
3027 (save-excursion
3028 (with-current-buffer (marker-buffer marker)
3029 (if (not (eq major-mode 'org-mode))
3030 (setq txt "")
3031 (save-excursion
3032 (save-restriction
3033 (widen)
3034 (goto-char marker)
3035 (end-of-line 1)
3036 (setq txt (buffer-substring
3037 (min (1+ (point)) (point-max))
3038 (progn (outline-next-heading) (point)))
3039 drawer-re org-drawer-regexp
3040 kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
3041 ".*\n?"))
3042 (with-temp-buffer
3043 (insert txt)
3044 (when org-agenda-add-entry-text-descriptive-links
3045 (goto-char (point-min))
3046 (while (org-activate-bracket-links (point-max))
3047 (add-text-properties (match-beginning 0) (match-end 0)
3048 '(face org-link))))
3049 (goto-char (point-min))
3050 (while (re-search-forward org-bracket-link-regexp (point-max) t)
3051 (set-text-properties (match-beginning 0) (match-end 0)
3052 nil))
3053 (goto-char (point-min))
3054 (while (re-search-forward drawer-re nil t)
3055 (delete-region
3056 (match-beginning 0)
3057 (progn (re-search-forward
3058 "^[ \t]*:END:.*\n?" nil 'move)
3059 (point))))
3060 (unless (member 'planning keep)
3061 (goto-char (point-min))
3062 (while (re-search-forward kwd-time-re nil t)
3063 (replace-match "")))
3064 (goto-char (point-min))
3065 (when org-agenda-entry-text-exclude-regexps
3066 (let ((re-list org-agenda-entry-text-exclude-regexps) re)
3067 (while (setq re (pop re-list))
3068 (goto-char (point-min))
3069 (while (re-search-forward re nil t)
3070 (replace-match "")))))
3071 (goto-char (point-max))
3072 (skip-chars-backward " \t\n")
3073 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
3075 ;; find and remove min common indentation
3076 (goto-char (point-min))
3077 (untabify (point-min) (point-max))
3078 (setq ind (org-get-indentation))
3079 (while (not (eobp))
3080 (unless (looking-at "[ \t]*$")
3081 (setq ind (min ind (org-get-indentation))))
3082 (beginning-of-line 2))
3083 (goto-char (point-min))
3084 (while (not (eobp))
3085 (unless (looking-at "[ \t]*$")
3086 (move-to-column ind)
3087 (delete-region (point-at-bol) (point)))
3088 (beginning-of-line 2))
3090 (run-hooks 'org-agenda-entry-text-cleanup-hook)
3092 (goto-char (point-min))
3093 (when indent
3094 (while (and (not (eobp)) (re-search-forward "^" nil t))
3095 (replace-match indent t t)))
3096 (goto-char (point-min))
3097 (while (looking-at "[ \t]*\n") (replace-match ""))
3098 (goto-char (point-max))
3099 (when (> (org-current-line)
3100 n-lines)
3101 (org-goto-line (1+ n-lines))
3102 (backward-char 1))
3103 (setq txt (buffer-substring (point-min) (point)))))))))
3104 txt))
3106 (defun org-agenda-collect-markers ()
3107 "Collect the markers pointing to entries in the agenda buffer."
3108 (let (m markers)
3109 (save-excursion
3110 (goto-char (point-min))
3111 (while (not (eobp))
3112 (when (setq m (or (org-get-at-bol 'org-hd-marker)
3113 (org-get-at-bol 'org-marker)))
3114 (push m markers))
3115 (beginning-of-line 2)))
3116 (nreverse markers)))
3118 (defun org-create-marker-find-array (marker-list)
3119 "Create a alist of files names with all marker positions in that file."
3120 (let (f tbl m a p)
3121 (while (setq m (pop marker-list))
3122 (setq p (marker-position m)
3123 f (buffer-file-name (or (buffer-base-buffer
3124 (marker-buffer m))
3125 (marker-buffer m))))
3126 (if (setq a (assoc f tbl))
3127 (push (marker-position m) (cdr a))
3128 (push (list f p) tbl)))
3129 (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3130 tbl)))
3132 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3133 (defun org-check-agenda-marker-table ()
3134 "Check of the current entry is on the marker list."
3135 (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3137 (and (setq a (assoc file org-agenda-marker-table))
3138 (save-match-data
3139 (save-excursion
3140 (org-back-to-heading t)
3141 (member (point) (cdr a)))))))
3143 (defun org-check-for-org-mode ()
3144 "Make sure current buffer is in org-mode. Error if not."
3145 (or (eq major-mode 'org-mode)
3146 (error "Cannot execute org-mode agenda command on buffer in %s"
3147 major-mode)))
3149 (defun org-fit-agenda-window ()
3150 "Fit the window to the buffer size."
3151 (and (memq org-agenda-window-setup '(reorganize-frame))
3152 (fboundp 'fit-window-to-buffer)
3153 (org-fit-window-to-buffer
3155 (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3156 (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3158 ;;; Agenda prepare and finalize
3160 (defvar org-agenda-multi nil) ; dynamically scoped
3161 (defvar org-agenda-buffer-name "*Org Agenda*")
3162 (defvar org-pre-agenda-window-conf nil)
3163 (defvar org-agenda-columns-active nil)
3164 (defvar org-agenda-name nil)
3165 (defvar org-agenda-tag-filter nil)
3166 (defvar org-agenda-category-filter nil)
3167 (defvar org-agenda-tag-filter-while-redo nil) ; dynamically scoped
3168 (defvar org-agenda-tag-filter-preset nil
3169 "A preset of the tags filter used for secondary agenda filtering.
3170 This must be a list of strings, each string must be a single tag preceded
3171 by \"+\" or \"-\".
3172 This variable should not be set directly, but agenda custom commands can
3173 bind it in the options section. The preset filter is a global property of
3174 the entire agenda view. In a block agenda, it will not work reliably to
3175 define a filter for one of the individual blocks. You need to set it in
3176 the global options and expect it to be applied to the entire view.")
3178 (defvar org-agenda-category-filter-preset nil
3179 "A preset of the category filter used for secondary agenda filtering.
3180 This must be a list of strings, each string must be a single category
3181 preceded by \"+\" or \"-\".
3182 This variable should not be set directly, but agenda custom commands can
3183 bind it in the options section. The preset filter is a global property of
3184 the entire agenda view. In a block agenda, it will not work reliably to
3185 define a filter for one of the individual blocks. You need to set it in
3186 the global options and expect it to be applied to the entire view.")
3189 (defun org-agenda-use-sticky-p ()
3190 "Return non-NIL if existing agenda buffer named
3191 `org-agenda-buffer-name' exists, and should be shown instead of
3192 generating a new one"
3193 (and
3194 ;; turned off by user
3195 org-agenda-sticky
3196 ;; For multi-agenda buffer already exists
3197 (not org-agenda-multi)
3198 ;; buffer found
3199 (get-buffer org-agenda-buffer-name)
3200 ;; C-u parameter is same as last call
3201 (with-current-buffer (get-buffer org-agenda-buffer-name)
3202 (and
3203 (equal current-prefix-arg
3204 org-agenda-last-prefix-arg)
3205 ;; In case user turned stickiness on, while having existing
3206 ;; Agenda buffer active, don't reuse that buffer, because it
3207 ;; does not have org variables local
3208 org-agenda-this-buffer-is-sticky))))
3210 (defun org-prepare-agenda-window (abuf)
3211 "Setup agenda buffer in the window"
3212 (let* ((awin (get-buffer-window abuf))
3213 wconf)
3214 (cond
3215 ((equal (current-buffer) abuf) nil)
3216 (awin (select-window awin))
3217 ((not (setq wconf (current-window-configuration))))
3218 ((equal org-agenda-window-setup 'current-window)
3219 (org-pop-to-buffer-same-window abuf))
3220 ((equal org-agenda-window-setup 'other-window)
3221 (org-switch-to-buffer-other-window abuf))
3222 ((equal org-agenda-window-setup 'other-frame)
3223 (switch-to-buffer-other-frame abuf))
3224 ((equal org-agenda-window-setup 'reorganize-frame)
3225 (delete-other-windows)
3226 (org-switch-to-buffer-other-window abuf)))
3227 ;; additional test in case agenda is invoked from within agenda
3228 ;; buffer via elisp link
3229 (unless (equal (current-buffer) abuf)
3230 (org-pop-to-buffer-same-window abuf))
3231 (setq org-pre-agenda-window-conf wconf)))
3233 (defun org-prepare-agenda (&optional name)
3234 (if (org-agenda-use-sticky-p)
3235 (progn
3236 ;; Popup existing buffer
3237 (org-prepare-agenda-window (get-buffer org-agenda-buffer-name))
3238 (message "Sticky Agenda buffer, use `r' to refresh")
3239 (throw 'exit nil))
3240 (setq org-todo-keywords-for-agenda nil)
3241 (setq org-done-keywords-for-agenda nil)
3242 (setq org-drawers-for-agenda nil)
3243 (unless org-agenda-persistent-filter
3244 (setq org-agenda-tag-filter nil
3245 org-agenda-category-filter nil))
3246 (put 'org-agenda-tag-filter :preset-filter org-agenda-tag-filter-preset)
3247 (put 'org-agenda-category-filter :preset-filter
3248 org-agenda-category-filter-preset)
3249 (if org-agenda-multi
3250 (progn
3251 (setq buffer-read-only nil)
3252 (goto-char (point-max))
3253 (unless (or (bobp) org-agenda-compact-blocks
3254 (not org-agenda-block-separator))
3255 (insert "\n"
3256 (if (stringp org-agenda-block-separator)
3257 org-agenda-block-separator
3258 (make-string (window-width) org-agenda-block-separator))
3259 "\n"))
3260 (narrow-to-region (point) (point-max)))
3262 ;; any org variables need to be set after being in agenda buffer
3263 ;; since they are now buffer local
3264 (org-prepare-agenda-window (get-buffer-create org-agenda-buffer-name))
3265 (setq buffer-read-only nil)
3266 (org-agenda-reset-markers)
3267 (let ((inhibit-read-only t)) (erase-buffer))
3268 (org-agenda-mode)
3269 (setq org-agenda-buffer (current-buffer))
3270 (setq org-agenda-contributing-files nil)
3271 (setq org-agenda-columns-active nil)
3272 (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3273 (setq org-todo-keywords-for-agenda
3274 (org-uniquify org-todo-keywords-for-agenda))
3275 (setq org-done-keywords-for-agenda
3276 (org-uniquify org-done-keywords-for-agenda))
3277 (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3278 (setq org-agenda-last-prefix-arg current-prefix-arg)
3279 (setq org-agenda-this-buffer-name org-agenda-buffer-name)
3280 (and name (not org-agenda-name)
3281 (org-set-local 'org-agenda-name name)))
3282 (setq buffer-read-only nil)))
3284 (defun org-finalize-agenda ()
3285 "Finishing touch for the agenda buffer, called just before displaying it."
3286 (unless org-agenda-multi
3287 (save-excursion
3288 (let ((inhibit-read-only t))
3289 (goto-char (point-min))
3290 (while (org-activate-bracket-links (point-max))
3291 (add-text-properties (match-beginning 0) (match-end 0)
3292 '(face org-link)))
3293 (org-agenda-align-tags)
3294 (unless org-agenda-with-colors
3295 (remove-text-properties (point-min) (point-max) '(face nil))))
3296 (if (and (boundp 'org-agenda-overriding-columns-format)
3297 org-agenda-overriding-columns-format)
3298 (org-set-local 'org-agenda-overriding-columns-format
3299 org-agenda-overriding-columns-format))
3300 (if (and (boundp 'org-agenda-view-columns-initially)
3301 org-agenda-view-columns-initially)
3302 (org-agenda-columns))
3303 (when org-agenda-fontify-priorities
3304 (org-agenda-fontify-priorities))
3305 (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3306 (org-agenda-dim-blocked-tasks))
3307 (org-agenda-mark-clocking-task)
3308 (when org-agenda-entry-text-mode
3309 (org-agenda-entry-text-hide)
3310 (org-agenda-entry-text-show))
3311 (if (functionp 'org-habit-insert-consistency-graphs)
3312 (org-habit-insert-consistency-graphs))
3313 (run-hooks 'org-finalize-agenda-hook)
3314 (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3315 (when (or org-agenda-tag-filter (get 'org-agenda-tag-filter :preset-filter))
3316 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
3317 (when (or org-agenda-category-filter (get 'org-agenda-category-filter :preset-filter))
3318 (org-agenda-filter-apply org-agenda-category-filter 'category))
3319 (org-add-hook 'kill-buffer-hook 'org-agenda-reset-markers 'append 'local)
3322 (defun org-agenda-mark-clocking-task ()
3323 "Mark the current clock entry in the agenda if it is present."
3324 (mapc (lambda (o)
3325 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3326 (delete-overlay o)))
3327 (overlays-in (point-min) (point-max)))
3328 (when (marker-buffer org-clock-hd-marker)
3329 (save-excursion
3330 (goto-char (point-min))
3331 (let (s ov)
3332 (while (setq s (next-single-property-change (point) 'org-hd-marker))
3333 (goto-char s)
3334 (when (equal (org-get-at-bol 'org-hd-marker)
3335 org-clock-hd-marker)
3336 (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3337 (overlay-put ov 'type 'org-agenda-clocking)
3338 (overlay-put ov 'face 'org-agenda-clocking)
3339 (overlay-put ov 'help-echo
3340 "The clock is running in this item")))))))
3342 (defun org-agenda-fontify-priorities ()
3343 "Make highest priority lines bold, and lowest italic."
3344 (interactive)
3345 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3346 (delete-overlay o)))
3347 (overlays-in (point-min) (point-max)))
3348 (save-excursion
3349 (let ((inhibit-read-only t)
3350 b e p ov h l)
3351 (goto-char (point-min))
3352 (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3353 (setq h (or (get-char-property (point) 'org-highest-priority)
3354 org-highest-priority)
3355 l (or (get-char-property (point) 'org-lowest-priority)
3356 org-lowest-priority)
3357 p (string-to-char (match-string 1))
3358 b (match-beginning 0)
3359 e (if (eq org-agenda-fontify-priorities 'cookies)
3360 (match-end 0)
3361 (point-at-eol))
3362 ov (make-overlay b e))
3363 (overlay-put
3364 ov 'face
3365 (cond ((org-face-from-face-or-color
3366 'priority nil
3367 (cdr (assoc p org-priority-faces))))
3368 ((and (listp org-agenda-fontify-priorities)
3369 (org-face-from-face-or-color
3370 'priority nil
3371 (cdr (assoc p org-agenda-fontify-priorities)))))
3372 ((equal p l) 'italic)
3373 ((equal p h) 'bold)))
3374 (overlay-put ov 'org-type 'org-priority)))))
3376 (defun org-agenda-dim-blocked-tasks ()
3377 "Dim currently blocked TODO's in the agenda display."
3378 (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3379 (delete-overlay o)))
3380 (overlays-in (point-min) (point-max)))
3381 (save-excursion
3382 (let ((inhibit-read-only t)
3383 (org-depend-tag-blocked nil)
3384 (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3385 org-blocked-by-checkboxes
3386 invis1 b e p ov h l)
3387 (goto-char (point-min))
3388 (while (let ((pos (next-single-property-change (point) 'todo-state)))
3389 (and pos (goto-char (1+ pos))))
3390 (setq org-blocked-by-checkboxes nil invis1 invis)
3391 (let ((marker (org-get-at-bol 'org-hd-marker)))
3392 (when (and marker
3393 (with-current-buffer (marker-buffer marker)
3394 (save-excursion (goto-char marker)
3395 (org-entry-blocked-p))))
3396 (if org-blocked-by-checkboxes (setq invis1 nil))
3397 (setq b (if invis1
3398 (max (point-min) (1- (point-at-bol)))
3399 (point-at-bol))
3400 e (point-at-eol)
3401 ov (make-overlay b e))
3402 (if invis1
3403 (overlay-put ov 'invisible t)
3404 (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3405 (overlay-put ov 'org-type 'org-blocked-todo)))))))
3407 (defvar org-agenda-skip-function nil
3408 "Function to be called at each match during agenda construction.
3409 If this function returns nil, the current match should not be skipped.
3410 Otherwise, the function must return a position from where the search
3411 should be continued.
3412 This may also be a Lisp form, it will be evaluated.
3413 Never set this variable using `setq' or so, because then it will apply
3414 to all future agenda commands. If you do want a global skipping condition,
3415 use the option `org-agenda-skip-function-global' instead.
3416 The correct usage for `org-agenda-skip-function' is to bind it with
3417 `let' to scope it dynamically into the agenda-constructing command.
3418 A good way to set it is through options in `org-agenda-custom-commands'.")
3420 (defun org-agenda-skip ()
3421 "Throw to `:skip' in places that should be skipped.
3422 Also moves point to the end of the skipped region, so that search can
3423 continue from there."
3424 (let ((p (point-at-bol)) to)
3425 (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3426 (get-text-property p :org-archived)
3427 (org-end-of-subtree t)
3428 (throw :skip t))
3429 (and org-agenda-skip-comment-trees
3430 (get-text-property p :org-comment)
3431 (org-end-of-subtree t)
3432 (throw :skip t))
3433 (if (equal (char-after p) ?#) (throw :skip t))
3434 (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3435 (org-agenda-skip-eval org-agenda-skip-function)))
3436 (goto-char to)
3437 (throw :skip t))))
3439 (defun org-agenda-skip-eval (form)
3440 "If FORM is a function or a list, call (or eval) is and return result.
3441 `save-excursion' and `save-match-data' are wrapped around the call, so point
3442 and match data are returned to the previous state no matter what these
3443 functions do."
3444 (let (fp)
3445 (and form
3446 (or (setq fp (functionp form))
3447 (consp form))
3448 (save-excursion
3449 (save-match-data
3450 (if fp
3451 (funcall form)
3452 (eval form)))))))
3454 (defvar org-agenda-markers nil
3455 "List of all currently active markers created by `org-agenda'.")
3456 (defvar org-agenda-last-marker-time (org-float-time)
3457 "Creation time of the last agenda marker.")
3459 (defun org-agenda-new-marker (&optional pos)
3460 "Return a new agenda marker.
3461 Org-mode keeps a list of these markers and resets them when they are
3462 no longer in use."
3463 (let ((m (copy-marker (or pos (point)))))
3464 (setq org-agenda-last-marker-time (org-float-time))
3465 (with-current-buffer org-agenda-buffer
3466 (push m org-agenda-markers))
3469 (defun org-agenda-reset-markers ()
3470 "Reset markers created by `org-agenda'."
3471 (while org-agenda-markers
3472 (move-marker (pop org-agenda-markers) nil)))
3474 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3475 "Save relative positions of markers in region.
3476 This check for agenda markers in all agenda buffers currently active."
3477 (dolist (buf (buffer-list))
3478 (with-current-buffer buf
3479 (when (eq major-mode 'org-agenda-mode)
3480 (mapc (lambda (m) (org-check-and-save-marker m beg end))
3481 org-agenda-markers)))))
3483 ;;; Entry text mode
3485 (defun org-agenda-entry-text-show-here ()
3486 "Add some text from the entry as context to the current line."
3487 (let (m txt o)
3488 (setq m (org-get-at-bol 'org-hd-marker))
3489 (unless (marker-buffer m)
3490 (error "No marker points to an entry here"))
3491 (setq txt (concat "\n" (org-no-properties
3492 (org-agenda-get-some-entry-text
3493 m org-agenda-entry-text-maxlines " > "))))
3494 (when (string-match "\\S-" txt)
3495 (setq o (make-overlay (point-at-bol) (point-at-eol)))
3496 (overlay-put o 'evaporate t)
3497 (overlay-put o 'org-overlay-type 'agenda-entry-content)
3498 (overlay-put o 'after-string txt))))
3500 (defun org-agenda-entry-text-show ()
3501 "Add entry context for all agenda lines."
3502 (interactive)
3503 (save-excursion
3504 (goto-char (point-max))
3505 (beginning-of-line 1)
3506 (while (not (bobp))
3507 (when (org-get-at-bol 'org-hd-marker)
3508 (org-agenda-entry-text-show-here))
3509 (beginning-of-line 0))))
3511 (defun org-agenda-entry-text-hide ()
3512 "Remove any shown entry context."
3513 (delq nil
3514 (mapcar (lambda (o)
3515 (if (eq (overlay-get o 'org-overlay-type)
3516 'agenda-entry-content)
3517 (progn (delete-overlay o) t)))
3518 (overlays-in (point-min) (point-max)))))
3520 (defun org-agenda-get-day-face (date)
3521 "Return the face DATE should be displayed with."
3522 (or (and (functionp org-agenda-day-face-function)
3523 (funcall org-agenda-day-face-function date))
3524 (cond ((org-agenda-todayp date)
3525 'org-agenda-date-today)
3526 ((member (calendar-day-of-week date) org-agenda-weekend-days)
3527 'org-agenda-date-weekend)
3528 (t 'org-agenda-date))))
3530 ;;; Agenda timeline
3532 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3534 (defun org-timeline (&optional dotodo)
3535 "Show a time-sorted view of the entries in the current org file.
3536 Only entries with a time stamp of today or later will be listed. With
3537 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3538 under the current date.
3539 If the buffer contains an active region, only check the region for
3540 dates."
3541 (interactive "P")
3542 (let* ((dopast t)
3543 (org-agenda-show-log-scoped org-agenda-show-log)
3544 (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3545 (current-buffer))))
3546 (date (calendar-current-date))
3547 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3548 (end (if (org-region-active-p) (region-end) (point-max)))
3549 (day-numbers (org-get-all-dates
3550 beg end 'no-ranges
3551 t org-agenda-show-log-scoped ; always include today
3552 org-timeline-show-empty-dates))
3553 (org-deadline-warning-days 0)
3554 (org-agenda-only-exact-dates t)
3555 (today (org-today))
3556 (past t)
3557 args
3558 s e rtn d emptyp)
3559 (setq org-agenda-redo-command
3560 (list 'progn
3561 (list 'org-switch-to-buffer-other-window (current-buffer))
3562 (list 'org-timeline (list 'quote dotodo))))
3563 (if (not dopast)
3564 ;; Remove past dates from the list of dates.
3565 (setq day-numbers (delq nil (mapcar (lambda(x)
3566 (if (>= x today) x nil))
3567 day-numbers))))
3568 (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3569 (org-compile-prefix-format 'timeline)
3570 (org-set-sorting-strategy 'timeline)
3571 (if org-agenda-show-log-scoped (push :closed args))
3572 (push :timestamp args)
3573 (push :deadline args)
3574 (push :scheduled args)
3575 (push :sexp args)
3576 (if dotodo (push :todo args))
3577 (insert "Timeline of file " entry "\n")
3578 (add-text-properties (point-min) (point)
3579 (list 'face 'org-agenda-structure))
3580 (org-agenda-mark-header-line (point-min))
3581 (while (setq d (pop day-numbers))
3582 (if (and (listp d) (eq (car d) :omitted))
3583 (progn
3584 (setq s (point))
3585 (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3586 (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3587 (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3588 (if (and (>= d today)
3589 dopast
3590 past)
3591 (progn
3592 (setq past nil)
3593 (insert (make-string 79 ?-) "\n")))
3594 (setq date (calendar-gregorian-from-absolute d))
3595 (setq s (point))
3596 (setq rtn (and (not emptyp)
3597 (apply 'org-agenda-get-day-entries entry
3598 date args)))
3599 (if (or rtn (equal d today) org-timeline-show-empty-dates)
3600 (progn
3601 (insert
3602 (if (stringp org-agenda-format-date)
3603 (format-time-string org-agenda-format-date
3604 (org-time-from-absolute date))
3605 (funcall org-agenda-format-date date))
3606 "\n")
3607 (put-text-property s (1- (point)) 'face
3608 (org-agenda-get-day-face date))
3609 (put-text-property s (1- (point)) 'org-date-line t)
3610 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3611 (if (equal d today)
3612 (put-text-property s (1- (point)) 'org-today t))
3613 (and rtn (insert (org-finalize-agenda-entries rtn) "\n"))
3614 (put-text-property s (1- (point)) 'day d)))))
3615 (goto-char (point-min))
3616 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3617 (point-min)))
3618 (add-text-properties (point-min) (point-max) '(org-agenda-type timeline))
3619 (org-finalize-agenda)
3620 (setq buffer-read-only t)))
3622 (defun org-get-all-dates (beg end &optional no-ranges force-today inactive empty pre-re)
3623 "Return a list of all relevant day numbers from BEG to END buffer positions.
3624 If NO-RANGES is non-nil, include only the start and end dates of a range,
3625 not every single day in the range. If FORCE-TODAY is non-nil, make
3626 sure that TODAY is included in the list. If INACTIVE is non-nil, also
3627 inactive time stamps (those in square brackets) are included.
3628 When EMPTY is non-nil, also include days without any entries."
3629 (let ((re (concat
3630 (if pre-re pre-re "")
3631 (if inactive org-ts-regexp-both org-ts-regexp)))
3632 dates dates1 date day day1 day2 ts1 ts2 pos)
3633 (if force-today
3634 (setq dates (list (org-today))))
3635 (save-excursion
3636 (goto-char beg)
3637 (while (re-search-forward re end t)
3638 (setq day (time-to-days (org-time-string-to-time
3639 (substring (match-string 1) 0 10)
3640 (current-buffer) (match-beginning 0))))
3641 (or (memq day dates) (push day dates)))
3642 (unless no-ranges
3643 (goto-char beg)
3644 (while (re-search-forward org-tr-regexp end t)
3645 (setq pos (match-beginning 0))
3646 (setq ts1 (substring (match-string 1) 0 10)
3647 ts2 (substring (match-string 2) 0 10)
3648 day1 (time-to-days (org-time-string-to-time
3649 ts1 (current-buffer) pos))
3650 day2 (time-to-days (org-time-string-to-time
3651 ts2 (current-buffer) pos)))
3652 (while (< (setq day1 (1+ day1)) day2)
3653 (or (memq day1 dates) (push day1 dates)))))
3654 (setq dates (sort dates '<))
3655 (when empty
3656 (while (setq day (pop dates))
3657 (setq day2 (car dates))
3658 (push day dates1)
3659 (when (and day2 empty)
3660 (if (or (eq empty t)
3661 (and (numberp empty) (<= (- day2 day) empty)))
3662 (while (< (setq day (1+ day)) day2)
3663 (push (list day) dates1))
3664 (push (cons :omitted (- day2 day)) dates1))))
3665 (setq dates (nreverse dates1)))
3666 dates)))
3668 ;;; Agenda Daily/Weekly
3670 (defvar org-agenda-start-day nil ; dynamically scoped parameter
3671 "Start day for the agenda view.
3672 Custom commands can set this variable in the options section.")
3673 (defvar org-starting-day nil) ; local variable in the agenda buffer
3674 (defvar org-agenda-current-span nil
3675 "The current span used in the agenda view.") ; local variable in the agenda buffer
3676 (defvar org-arg-loc nil) ; local variable
3678 (defvar org-agenda-entry-types '(:deadline :scheduled :timestamp :sexp)
3679 "List of types searched for when creating the daily/weekly agenda.
3680 This variable is a list of symbols that controls the types of
3681 items that appear in the daily/weekly agenda. Allowed symbols in this
3682 list are are
3684 :timestamp List items containing a date stamp or date range matching
3685 the selected date. This includes sexp entries in
3686 angular brackets.
3688 :sexp List entries resulting from plain diary-like sexps.
3690 :deadline List deadline due on that date. When the date is today,
3691 also list any deadlines past due, or due within
3692 `org-deadline-warning-days'. `:deadline' must appear before
3693 `:scheduled' if the setting of
3694 `org-agenda-skip-scheduled-if-deadline-is-shown' is to have
3695 any effect.
3697 :scheduled List all items which are scheduled for the given date.
3698 The diary for *today* also contains items which were
3699 scheduled earlier and are not yet marked DONE.
3701 By default, all four types are turned on.
3703 Never set this variable globally using `setq', because then it
3704 will apply to all future agenda commands. Instead, bind it with
3705 `let' to scope it dynamically into the agenda-constructing
3706 command. A good way to set it is through options in
3707 `org-agenda-custom-commands'. For a more flexible (though
3708 somewhat less efficient) way of determining what is included in
3709 the daily/weekly agenda, see `org-agenda-skip-function'.")
3711 ;;;###autoload
3712 (defun org-agenda-list (&optional arg start-day span)
3713 "Produce a daily/weekly view from all files in variable `org-agenda-files'.
3714 The view will be for the current day or week, but from the overview buffer
3715 you will be able to go to other days/weeks.
3717 With a numeric prefix argument in an interactive call, the agenda will
3718 span ARG days. Lisp programs should instead specify SPAN to change
3719 the number of days. SPAN defaults to `org-agenda-span'.
3721 START-DAY defaults to TODAY, or to the most recent match for the weekday
3722 given in `org-agenda-start-on-weekday'."
3723 (interactive "P")
3724 (if (and (integerp arg) (> arg 0))
3725 (setq span arg arg nil))
3726 (org-prepare-agenda "Day/Week")
3727 (setq start-day (or start-day org-agenda-start-day))
3728 (if org-agenda-overriding-arguments
3729 (setq arg (car org-agenda-overriding-arguments)
3730 start-day (nth 1 org-agenda-overriding-arguments)
3731 span (nth 2 org-agenda-overriding-arguments)))
3732 (if (stringp start-day)
3733 ;; Convert to an absolute day number
3734 (setq start-day (time-to-days (org-read-date nil t start-day))))
3735 (setq org-agenda-last-arguments (list arg start-day span))
3736 (org-compile-prefix-format 'agenda)
3737 (org-set-sorting-strategy 'agenda)
3738 (let* ((span (org-agenda-ndays-to-span
3739 (or span org-agenda-ndays org-agenda-span)))
3740 (today (org-today))
3741 (sd (or start-day today))
3742 (ndays (org-agenda-span-to-ndays span sd))
3743 (org-agenda-start-on-weekday
3744 (if (eq ndays 7)
3745 org-agenda-start-on-weekday))
3746 (thefiles (org-agenda-files nil 'ifmode))
3747 (files thefiles)
3748 (start (if (or (null org-agenda-start-on-weekday)
3749 (< ndays 7))
3751 (let* ((nt (calendar-day-of-week
3752 (calendar-gregorian-from-absolute sd)))
3753 (n1 org-agenda-start-on-weekday)
3754 (d (- nt n1)))
3755 (- sd (+ (if (< d 0) 7 0) d)))))
3756 (day-numbers (list start))
3757 (day-cnt 0)
3758 (inhibit-redisplay (not debug-on-error))
3759 (org-agenda-show-log-scoped org-agenda-show-log)
3760 s e rtn rtnall file date d start-pos end-pos todayp
3761 clocktable-start clocktable-end filter)
3762 (setq org-agenda-redo-command
3763 (list 'org-agenda-list (list 'quote arg) start-day (list 'quote span)))
3764 (dotimes (n (1- ndays))
3765 (push (1+ (car day-numbers)) day-numbers))
3766 (setq day-numbers (nreverse day-numbers))
3767 (setq clocktable-start (car day-numbers)
3768 clocktable-end (1+ (or (org-last day-numbers) 0)))
3769 (org-set-local 'org-starting-day (car day-numbers))
3770 (org-set-local 'org-arg-loc arg)
3771 (org-set-local 'org-agenda-current-span (org-agenda-ndays-to-span span))
3772 (unless org-agenda-compact-blocks
3773 (let* ((d1 (car day-numbers))
3774 (d2 (org-last day-numbers))
3775 (w1 (org-days-to-iso-week d1))
3776 (w2 (org-days-to-iso-week d2)))
3777 (setq s (point))
3778 (if org-agenda-overriding-header
3779 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
3780 nil 'face 'org-agenda-structure) "\n")
3781 (insert (org-agenda-span-name span)
3782 "-agenda"
3783 (if (< (- d2 d1) 350)
3784 (if (= w1 w2)
3785 (format " (W%02d)" w1)
3786 (format " (W%02d-W%02d)" w1 w2))
3788 ":\n")))
3789 (add-text-properties s (1- (point)) (list 'face 'org-agenda-structure
3790 'org-date-line t))
3791 (org-agenda-mark-header-line s))
3792 (while (setq d (pop day-numbers))
3793 (setq date (calendar-gregorian-from-absolute d)
3794 s (point))
3795 (if (or (setq todayp (= d today))
3796 (and (not start-pos) (= d sd)))
3797 (setq start-pos (point))
3798 (if (and start-pos (not end-pos))
3799 (setq end-pos (point))))
3800 (setq files thefiles
3801 rtnall nil)
3802 (while (setq file (pop files))
3803 (catch 'nextfile
3804 (org-check-agenda-file file)
3805 (let ((org-agenda-entry-types org-agenda-entry-types))
3806 (unless org-agenda-include-deadlines
3807 (setq org-agenda-entry-types
3808 (delq :deadline org-agenda-entry-types)))
3809 (cond
3810 ((memq org-agenda-show-log-scoped '(only clockcheck))
3811 (setq rtn (org-agenda-get-day-entries
3812 file date :closed)))
3813 (org-agenda-show-log-scoped
3814 (setq rtn (apply 'org-agenda-get-day-entries
3815 file date
3816 (append '(:closed) org-agenda-entry-types))))
3818 (setq rtn (apply 'org-agenda-get-day-entries
3819 file date
3820 org-agenda-entry-types)))))
3821 (setq rtnall (append rtnall rtn)))) ;; all entries
3822 (if org-agenda-include-diary
3823 (let ((org-agenda-search-headline-for-time t))
3824 (require 'diary-lib)
3825 (setq rtn (org-get-entries-from-diary date))
3826 (setq rtnall (append rtnall rtn))))
3827 (if (or rtnall org-agenda-show-all-dates)
3828 (progn
3829 (setq day-cnt (1+ day-cnt))
3830 (insert
3831 (if (stringp org-agenda-format-date)
3832 (format-time-string org-agenda-format-date
3833 (org-time-from-absolute date))
3834 (funcall org-agenda-format-date date))
3835 "\n")
3836 (put-text-property s (1- (point)) 'face
3837 (org-agenda-get-day-face date))
3838 (put-text-property s (1- (point)) 'org-date-line t)
3839 (put-text-property s (1- (point)) 'org-agenda-date-header t)
3840 (put-text-property s (1- (point)) 'org-day-cnt day-cnt)
3841 (when todayp
3842 (put-text-property s (1- (point)) 'org-today t))
3843 (if rtnall (insert ;; all entries
3844 (org-finalize-agenda-entries
3845 (org-agenda-add-time-grid-maybe
3846 rtnall ndays todayp))
3847 "\n"))
3848 (put-text-property s (1- (point)) 'day d)
3849 (put-text-property s (1- (point)) 'org-day-cnt day-cnt))))
3850 (when (and org-agenda-clockreport-mode clocktable-start)
3851 (let ((org-agenda-files (org-agenda-files nil 'ifmode))
3852 ;; the above line is to ensure the restricted range!
3853 (p (copy-sequence org-agenda-clockreport-parameter-plist))
3854 tbl)
3855 (setq p (org-plist-delete p :block))
3856 (setq p (plist-put p :tstart clocktable-start))
3857 (setq p (plist-put p :tend clocktable-end))
3858 (setq p (plist-put p :scope 'agenda))
3859 (when (and (eq org-agenda-clockreport-mode 'with-filter)
3860 (setq filter (or org-agenda-tag-filter-while-redo
3861 (get 'org-agenda-tag-filter :preset-filter))))
3862 (setq p (plist-put p :tags (mapconcat (lambda (x)
3863 (if (string-match "[<>=]" x)
3866 filter ""))))
3867 (setq tbl (apply 'org-get-clocktable p))
3868 (insert tbl)))
3869 (goto-char (point-min))
3870 (or org-agenda-multi (org-fit-agenda-window))
3871 (unless (and (pos-visible-in-window-p (point-min))
3872 (pos-visible-in-window-p (point-max)))
3873 (goto-char (1- (point-max)))
3874 (recenter -1)
3875 (if (not (pos-visible-in-window-p (or start-pos 1)))
3876 (progn
3877 (goto-char (or start-pos 1))
3878 (recenter 1))))
3879 (goto-char (or start-pos 1))
3880 (add-text-properties (point-min) (point-max) '(org-agenda-type agenda))
3881 (if (eq org-agenda-show-log-scoped 'clockcheck)
3882 (org-agenda-show-clocking-issues))
3883 (org-finalize-agenda)
3884 (setq buffer-read-only t)
3885 (message "")))
3887 (defun org-agenda-ndays-to-span (n)
3888 "Return a span symbol for a span of N days, or N if none matches."
3889 (cond ((symbolp n) n)
3890 ((= n 1) 'day)
3891 ((= n 7) 'week)
3892 (t n)))
3894 (defun org-agenda-span-to-ndays (span start-day)
3895 "Return ndays from SPAN starting at START-DAY."
3896 (cond ((numberp span) span)
3897 ((eq span 'day) 1)
3898 ((eq span 'week) 7)
3899 ((eq span 'month)
3900 (let ((date (calendar-gregorian-from-absolute start-day)))
3901 (calendar-last-day-of-month (car date) (caddr date))))
3902 ((eq span 'year)
3903 (let ((date (calendar-gregorian-from-absolute start-day)))
3904 (if (calendar-leap-year-p (caddr date)) 366 365)))))
3906 (defun org-agenda-span-name (span)
3907 "Return a SPAN name."
3908 (if (null span)
3910 (if (symbolp span)
3911 (capitalize (symbol-name span))
3912 (format "%d days" span))))
3914 ;;; Agenda word search
3916 (defvar org-agenda-search-history nil)
3917 (defvar org-todo-only nil)
3919 (defvar org-search-syntax-table nil
3920 "Special syntax table for org-mode search.
3921 In this table, we have single quotes not as word constituents, to
3922 that when \"+Ameli\" is searched as a work, it will also match \"Ameli's\"")
3924 (defun org-search-syntax-table ()
3925 (unless org-search-syntax-table
3926 (setq org-search-syntax-table (copy-syntax-table org-mode-syntax-table))
3927 (modify-syntax-entry ?' "." org-search-syntax-table)
3928 (modify-syntax-entry ?` "." org-search-syntax-table))
3929 org-search-syntax-table)
3931 (defvar org-agenda-last-search-view-search-was-boolean nil)
3933 ;;;###autoload
3934 (defun org-search-view (&optional todo-only string edit-at)
3935 "Show all entries that contain a phrase or words or regular expressions.
3937 With optional prefix argument TODO-ONLY, only consider entries that are
3938 TODO entries. The argument STRING can be used to pass a default search
3939 string into this function. If EDIT-AT is non-nil, it means that the
3940 user should get a chance to edit this string, with cursor at position
3941 EDIT-AT.
3943 The search string can be viewed either as a phrase that should be found as
3944 is, or it can be broken into a number of snippets, each of which must match
3945 in a Boolean way to select an entry. The default depends on the variable
3946 `org-agenda-search-view-always-boolean'.
3947 Even if this is turned off (the default) you can always switch to
3948 Boolean search dynamically by preceding the first word with \"+\" or \"-\".
3950 The default is a direct search of the whole phrase, where each space in
3951 the search string can expand to an arbitrary amount of whitespace,
3952 including newlines.
3954 If using a Boolean search, the search string is split on whitespace and
3955 each snippet is searched separately, with logical AND to select an entry.
3956 Words prefixed with a minus must *not* occur in the entry. Words without
3957 a prefix or prefixed with a plus must occur in the entry. Matching is
3958 case-insensitive. Words are enclosed by word delimiters (i.e. they must
3959 match whole words, not parts of a word) if
3960 `org-agenda-search-view-force-full-words' is set (default is nil).
3962 Boolean search snippets enclosed by curly braces are interpreted as
3963 regular expressions that must or (when preceded with \"-\") must not
3964 match in the entry. Snippets enclosed into double quotes will be taken
3965 as a whole, to include whitespace.
3967 - If the search string starts with an asterisk, search only in headlines.
3968 - If (possibly after the leading star) the search string starts with an
3969 exclamation mark, this also means to look at TODO entries only, an effect
3970 that can also be achieved with a prefix argument.
3971 - If (possibly after star and exclamation mark) the search string starts
3972 with a colon, this will mean that the (non-regexp) snippets of the
3973 Boolean search must match as full words.
3975 This command searches the agenda files, and in addition the files listed
3976 in `org-agenda-text-search-extra-files'."
3977 (interactive "P")
3978 (org-prepare-agenda "SEARCH")
3979 (org-compile-prefix-format 'search)
3980 (org-set-sorting-strategy 'search)
3981 (let* ((props (list 'face nil
3982 'done-face 'org-agenda-done
3983 'org-not-done-regexp org-not-done-regexp
3984 'org-todo-regexp org-todo-regexp
3985 'org-complex-heading-regexp org-complex-heading-regexp
3986 'mouse-face 'highlight
3987 'help-echo (format "mouse-2 or RET jump to location")))
3988 (full-words org-agenda-search-view-force-full-words)
3989 (org-agenda-text-search-extra-files org-agenda-text-search-extra-files)
3990 regexp rtn rtnall files file pos
3991 marker category org-category-pos tags c neg re boolean
3992 ee txt beg end words regexps+ regexps- hdl-only buffer beg1 str)
3993 (unless (and (not edit-at)
3994 (stringp string)
3995 (string-match "\\S-" string))
3996 (setq string (read-string
3997 (if org-agenda-search-view-always-boolean
3998 "[+-]Word/{Regexp} ...: "
3999 "Phrase, or [+-]Word/{Regexp} ...: ")
4000 (cond
4001 ((integerp edit-at) (cons string edit-at))
4002 (edit-at string))
4003 'org-agenda-search-history)))
4004 (org-set-local 'org-todo-only todo-only)
4005 (setq org-agenda-redo-command
4006 (list 'org-search-view (if todo-only t nil) string
4007 '(if current-prefix-arg 1 nil)))
4008 (setq org-agenda-query-string string)
4010 (if (equal (string-to-char string) ?*)
4011 (setq hdl-only t
4012 words (substring string 1))
4013 (setq words string))
4014 (when (equal (string-to-char words) ?!)
4015 (setq todo-only t
4016 words (substring words 1)))
4017 (when (equal (string-to-char words) ?:)
4018 (setq full-words t
4019 words (substring words 1)))
4020 (if (or org-agenda-search-view-always-boolean
4021 (member (string-to-char words) '(?- ?+ ?\{)))
4022 (setq boolean t))
4023 (setq words (org-split-string words))
4024 (let (www w)
4025 (while (setq w (pop words))
4026 (while (and (string-match "\\\\\\'" w) words)
4027 (setq w (concat (substring w 0 -1) " " (pop words))))
4028 (push w www))
4029 (setq words (nreverse www) www nil)
4030 (while (setq w (pop words))
4031 (when (and (string-match "\\`[-+]?{" w)
4032 (not (string-match "}\\'" w)))
4033 (while (and words (not (string-match "}\\'" (car words))))
4034 (setq w (concat w " " (pop words))))
4035 (setq w (concat w " " (pop words))))
4036 (push w www))
4037 (setq words (nreverse www)))
4038 (setq org-agenda-last-search-view-search-was-boolean boolean)
4039 (when boolean
4040 (let (wds w)
4041 (while (setq w (pop words))
4042 (if (or (equal (substring w 0 1) "\"")
4043 (and (> (length w) 1)
4044 (member (substring w 0 1) '("+" "-"))
4045 (equal (substring w 1 2) "\"")))
4046 (while (and words (not (equal (substring w -1) "\"")))
4047 (setq w (concat w " " (pop words)))))
4048 (and (string-match "\\`\\([-+]?\\)\"" w)
4049 (setq w (replace-match "\\1" nil nil w)))
4050 (and (equal (substring w -1) "\"") (setq w (substring w 0 -1)))
4051 (push w wds))
4052 (setq words (nreverse wds))))
4053 (if boolean
4054 (mapc (lambda (w)
4055 (setq c (string-to-char w))
4056 (if (equal c ?-)
4057 (setq neg t w (substring w 1))
4058 (if (equal c ?+)
4059 (setq neg nil w (substring w 1))
4060 (setq neg nil)))
4061 (if (string-match "\\`{.*}\\'" w)
4062 (setq re (substring w 1 -1))
4063 (if full-words
4064 (setq re (concat "\\<" (regexp-quote (downcase w)) "\\>"))
4065 (setq re (regexp-quote (downcase w)))))
4066 (if neg (push re regexps-) (push re regexps+)))
4067 words)
4068 (push (mapconcat (lambda (w) (regexp-quote w)) words "\\s-+")
4069 regexps+))
4070 (setq regexps+ (sort regexps+ (lambda (a b) (> (length a) (length b)))))
4071 (if (not regexps+)
4072 (setq regexp org-outline-regexp-bol)
4073 (setq regexp (pop regexps+))
4074 (if hdl-only (setq regexp (concat org-outline-regexp-bol ".*?"
4075 regexp))))
4076 (setq files (org-agenda-files nil 'ifmode))
4077 (when (eq (car org-agenda-text-search-extra-files) 'agenda-archives)
4078 (pop org-agenda-text-search-extra-files)
4079 (setq files (org-add-archive-files files)))
4080 (setq files (append files org-agenda-text-search-extra-files)
4081 rtnall nil)
4082 (while (setq file (pop files))
4083 (setq ee nil)
4084 (catch 'nextfile
4085 (org-check-agenda-file file)
4086 (setq buffer (if (file-exists-p file)
4087 (org-get-agenda-file-buffer file)
4088 (error "No such file %s" file)))
4089 (if (not buffer)
4090 ;; If file does not exist, make sure an error message is sent
4091 (setq rtn (list (format "ORG-AGENDA-ERROR: No such org-file %s"
4092 file))))
4093 (with-current-buffer buffer
4094 (with-syntax-table (org-search-syntax-table)
4095 (unless (eq major-mode 'org-mode)
4096 (error "Agenda file %s is not in `org-mode'" file))
4097 (let ((case-fold-search t))
4098 (save-excursion
4099 (save-restriction
4100 (if org-agenda-restrict
4101 (narrow-to-region org-agenda-restrict-begin
4102 org-agenda-restrict-end)
4103 (widen))
4104 (goto-char (point-min))
4105 (unless (or (org-at-heading-p)
4106 (outline-next-heading))
4107 (throw 'nextfile t))
4108 (goto-char (max (point-min) (1- (point))))
4109 (while (re-search-forward regexp nil t)
4110 (org-back-to-heading t)
4111 (skip-chars-forward "* ")
4112 (setq beg (point-at-bol)
4113 beg1 (point)
4114 end (progn (outline-next-heading) (point)))
4115 (catch :skip
4116 (goto-char beg)
4117 (org-agenda-skip)
4118 (setq str (buffer-substring-no-properties
4119 (point-at-bol)
4120 (if hdl-only (point-at-eol) end)))
4121 (mapc (lambda (wr) (when (string-match wr str)
4122 (goto-char (1- end))
4123 (throw :skip t)))
4124 regexps-)
4125 (mapc (lambda (wr) (unless (string-match wr str)
4126 (goto-char (1- end))
4127 (throw :skip t)))
4128 (if todo-only
4129 (cons (concat "^\*+[ \t]+" org-not-done-regexp)
4130 regexps+)
4131 regexps+))
4132 (goto-char beg)
4133 (setq marker (org-agenda-new-marker (point))
4134 category (org-get-category)
4135 org-category-pos (get-text-property (point) 'org-category-position)
4136 tags (org-get-tags-at (point))
4137 txt (org-agenda-format-item
4139 (buffer-substring-no-properties
4140 beg1 (point-at-eol))
4141 category tags))
4142 (org-add-props txt props
4143 'org-marker marker 'org-hd-marker marker
4144 'org-todo-regexp org-todo-regexp
4145 'org-complex-heading-regexp org-complex-heading-regexp
4146 'priority 1000 'org-category category
4147 'org-category-position org-category-pos
4148 'type "search")
4149 (push txt ee)
4150 (goto-char (1- end))))))))))
4151 (setq rtn (nreverse ee))
4152 (setq rtnall (append rtnall rtn)))
4153 (if org-agenda-overriding-header
4154 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4155 nil 'face 'org-agenda-structure) "\n")
4156 (insert "Search words: ")
4157 (add-text-properties (point-min) (1- (point))
4158 (list 'face 'org-agenda-structure))
4159 (setq pos (point))
4160 (insert string "\n")
4161 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4162 (setq pos (point))
4163 (unless org-agenda-multi
4164 (insert "Press `[', `]' to add/sub word, `{', `}' to add/sub regexp, `C-u r' to edit\n")
4165 (add-text-properties pos (1- (point))
4166 (list 'face 'org-agenda-structure))))
4167 (org-agenda-mark-header-line (point-min))
4168 (when rtnall
4169 (insert (org-finalize-agenda-entries rtnall) "\n"))
4170 (goto-char (point-min))
4171 (or org-agenda-multi (org-fit-agenda-window))
4172 (add-text-properties (point-min) (point-max) '(org-agenda-type search))
4173 (org-finalize-agenda)
4174 (setq buffer-read-only t)))
4176 ;;; Agenda TODO list
4178 (defvar org-select-this-todo-keyword nil)
4179 (defvar org-last-arg nil)
4181 ;;;###autoload
4182 (defun org-todo-list (arg)
4183 "Show all (not done) TODO entries from all agenda file in a single list.
4184 The prefix arg can be used to select a specific TODO keyword and limit
4185 the list to these. When using \\[universal-argument], you will be prompted
4186 for a keyword. A numeric prefix directly selects the Nth keyword in
4187 `org-todo-keywords-1'."
4188 (interactive "P")
4189 (org-prepare-agenda "TODO")
4190 (org-compile-prefix-format 'todo)
4191 (org-set-sorting-strategy 'todo)
4192 (if (and (stringp arg) (not (string-match "\\S-" arg))) (setq arg nil))
4193 (let* ((today (org-today))
4194 (date (calendar-gregorian-from-absolute today))
4195 (kwds org-todo-keywords-for-agenda)
4196 (completion-ignore-case t)
4197 (org-select-this-todo-keyword
4198 (if (stringp arg) arg
4199 (and arg (integerp arg) (> arg 0)
4200 (nth (1- arg) kwds))))
4201 rtn rtnall files file pos)
4202 (when (equal arg '(4))
4203 (setq org-select-this-todo-keyword
4204 (org-icompleting-read "Keyword (or KWD1|K2D2|...): "
4205 (mapcar 'list kwds) nil nil)))
4206 (and (equal 0 arg) (setq org-select-this-todo-keyword nil))
4207 (org-set-local 'org-last-arg arg)
4208 (setq org-agenda-redo-command
4209 '(org-todo-list (or current-prefix-arg org-last-arg)))
4210 (setq files (org-agenda-files nil 'ifmode)
4211 rtnall nil)
4212 (while (setq file (pop files))
4213 (catch 'nextfile
4214 (org-check-agenda-file file)
4215 (setq rtn (org-agenda-get-day-entries file date :todo))
4216 (setq rtnall (append rtnall rtn))))
4217 (if org-agenda-overriding-header
4218 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4219 nil 'face 'org-agenda-structure) "\n")
4220 (insert "Global list of TODO items of type: ")
4221 (add-text-properties (point-min) (1- (point))
4222 (list 'face 'org-agenda-structure
4223 'short-heading
4224 (concat "ToDo: "
4225 (or org-select-this-todo-keyword "ALL"))))
4226 (org-agenda-mark-header-line (point-min))
4227 (setq pos (point))
4228 (insert (or org-select-this-todo-keyword "ALL") "\n")
4229 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4230 (setq pos (point))
4231 (unless org-agenda-multi
4232 (insert "Available with `N r': (0)ALL")
4233 (let ((n 0) s)
4234 (mapc (lambda (x)
4235 (setq s (format "(%d)%s" (setq n (1+ n)) x))
4236 (if (> (+ (current-column) (string-width s) 1) (frame-width))
4237 (insert "\n "))
4238 (insert " " s))
4239 kwds))
4240 (insert "\n"))
4241 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4242 (org-agenda-mark-header-line (point-min))
4243 (when rtnall
4244 (insert (org-finalize-agenda-entries rtnall) "\n"))
4245 (goto-char (point-min))
4246 (or org-agenda-multi (org-fit-agenda-window))
4247 (add-text-properties (point-min) (point-max) '(org-agenda-type todo))
4248 (org-finalize-agenda)
4249 (setq buffer-read-only t)))
4251 ;;; Agenda tags match
4253 ;;;###autoload
4254 (defun org-tags-view (&optional todo-only match)
4255 "Show all headlines for all `org-agenda-files' matching a TAGS criterion.
4256 The prefix arg TODO-ONLY limits the search to TODO entries."
4257 (interactive "P")
4258 (let* ((org-tags-match-list-sublevels
4259 org-tags-match-list-sublevels)
4260 (completion-ignore-case t)
4261 rtn rtnall files file pos matcher
4262 buffer)
4263 (when (and (stringp match) (not (string-match "\\S-" match)))
4264 (setq match nil))
4265 (setq matcher (org-make-tags-matcher match)
4266 match (car matcher) matcher (cdr matcher))
4267 (org-prepare-agenda (concat "TAGS " match))
4268 (org-compile-prefix-format 'tags)
4269 (org-set-sorting-strategy 'tags)
4270 (setq org-agenda-query-string match)
4271 (setq org-agenda-redo-command
4272 (list 'org-tags-view (list 'quote todo-only)
4273 (list 'if 'current-prefix-arg nil 'org-agenda-query-string)))
4274 (setq files (org-agenda-files nil 'ifmode)
4275 rtnall nil)
4276 (while (setq file (pop files))
4277 (catch 'nextfile
4278 (org-check-agenda-file file)
4279 (setq buffer (if (file-exists-p file)
4280 (org-get-agenda-file-buffer file)
4281 (error "No such file %s" file)))
4282 (if (not buffer)
4283 ;; If file does not exist, error message to agenda
4284 (setq rtn (list
4285 (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4286 rtnall (append rtnall rtn))
4287 (with-current-buffer buffer
4288 (unless (eq major-mode 'org-mode)
4289 (error "Agenda file %s is not in `org-mode'" file))
4290 (save-excursion
4291 (save-restriction
4292 (if org-agenda-restrict
4293 (narrow-to-region org-agenda-restrict-begin
4294 org-agenda-restrict-end)
4295 (widen))
4296 (setq rtn (org-scan-tags 'agenda matcher todo-only))
4297 (setq rtnall (append rtnall rtn))))))))
4298 (if org-agenda-overriding-header
4299 (insert (org-add-props (copy-sequence org-agenda-overriding-header)
4300 nil 'face 'org-agenda-structure) "\n")
4301 (insert "Headlines with TAGS match: ")
4302 (add-text-properties (point-min) (1- (point))
4303 (list 'face 'org-agenda-structure
4304 'short-heading
4305 (concat "Match: " match)))
4306 (setq pos (point))
4307 (insert match "\n")
4308 (add-text-properties pos (1- (point)) (list 'face 'org-warning))
4309 (setq pos (point))
4310 (unless org-agenda-multi
4311 (insert "Press `C-u r' to search again with new search string\n"))
4312 (add-text-properties pos (1- (point)) (list 'face 'org-agenda-structure)))
4313 (org-agenda-mark-header-line (point-min))
4314 (when rtnall
4315 (insert (org-finalize-agenda-entries rtnall) "\n"))
4316 (goto-char (point-min))
4317 (or org-agenda-multi (org-fit-agenda-window))
4318 (add-text-properties (point-min) (point-max) '(org-agenda-type tags))
4319 (org-finalize-agenda)
4320 (setq buffer-read-only t)))
4322 ;;; Agenda Finding stuck projects
4324 (defvar org-agenda-skip-regexp nil
4325 "Regular expression used in skipping subtrees for the agenda.
4326 This is basically a temporary global variable that can be set and then
4327 used by user-defined selections using `org-agenda-skip-function'.")
4329 (defvar org-agenda-overriding-header nil
4330 "When set during agenda, todo and tags searches it replaces the header.
4331 This variable should not be set directly, but custom commands can bind it
4332 in the options section.")
4334 (defun org-agenda-skip-entry-when-regexp-matches ()
4335 "Check if the current entry contains match for `org-agenda-skip-regexp'.
4336 If yes, it returns the end position of this entry, causing agenda commands
4337 to skip the entry but continuing the search in the subtree. This is a
4338 function that can be put into `org-agenda-skip-function' for the duration
4339 of a command."
4340 (let ((end (save-excursion (org-end-of-subtree t)))
4341 skip)
4342 (save-excursion
4343 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4344 (and skip end)))
4346 (defun org-agenda-skip-subtree-when-regexp-matches ()
4347 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4348 If yes, it returns the end position of this tree, causing agenda commands
4349 to skip this subtree. This is a function that can be put into
4350 `org-agenda-skip-function' for the duration of a command."
4351 (let ((end (save-excursion (org-end-of-subtree t)))
4352 skip)
4353 (save-excursion
4354 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4355 (and skip end)))
4357 (defun org-agenda-skip-entry-when-regexp-matches-in-subtree ()
4358 "Check if the current subtree contains match for `org-agenda-skip-regexp'.
4359 If yes, it returns the end position of the current entry (NOT the tree),
4360 causing agenda commands to skip the entry but continuing the search in
4361 the subtree. This is a function that can be put into
4362 `org-agenda-skip-function' for the duration of a command. An important
4363 use of this function is for the stuck project list."
4364 (let ((end (save-excursion (org-end-of-subtree t)))
4365 (entry-end (save-excursion (outline-next-heading) (1- (point))))
4366 skip)
4367 (save-excursion
4368 (setq skip (re-search-forward org-agenda-skip-regexp end t)))
4369 (and skip entry-end)))
4371 (defun org-agenda-skip-entry-if (&rest conditions)
4372 "Skip entry if any of CONDITIONS is true.
4373 See `org-agenda-skip-if' for details."
4374 (org-agenda-skip-if nil conditions))
4376 (defun org-agenda-skip-subtree-if (&rest conditions)
4377 "Skip entry if any of CONDITIONS is true.
4378 See `org-agenda-skip-if' for details."
4379 (org-agenda-skip-if t conditions))
4381 (defun org-agenda-skip-if (subtree conditions)
4382 "Checks current entity for CONDITIONS.
4383 If SUBTREE is non-nil, the entire subtree is checked. Otherwise, only
4384 the entry, i.e. the text before the next heading is checked.
4386 CONDITIONS is a list of symbols, boolean OR is used to combine the results
4387 from different tests. Valid conditions are:
4389 scheduled Check if there is a scheduled cookie
4390 notscheduled Check if there is no scheduled cookie
4391 deadline Check if there is a deadline
4392 notdeadline Check if there is no deadline
4393 timestamp Check if there is a timestamp (also deadline or scheduled)
4394 nottimestamp Check if there is no timestamp (also deadline or scheduled)
4395 regexp Check if regexp matches
4396 notregexp Check if regexp does not match.
4397 todo Check if TODO keyword matches
4398 nottodo Check if TODO keyword does not match
4400 The regexp is taken from the conditions list, it must come right after
4401 the `regexp' or `notregexp' element.
4403 `todo' and `nottodo' accept as an argument a list of todo
4404 keywords, which may include \"*\" to match any todo keyword.
4406 (org-agenda-skip-entry-if 'todo '(\"TODO\" \"WAITING\"))
4408 would skip all entries with \"TODO\" or \"WAITING\" keywords.
4410 Instead of a list a keyword class may be given
4412 (org-agenda-skip-entry-if 'nottodo 'done)
4414 would skip entries that haven't been marked with any of \"DONE\"
4415 keywords. Possible classes are: `todo', `done', `any'.
4417 If any of these conditions is met, this function returns the end point of
4418 the entity, causing the search to continue from there. This is a function
4419 that can be put into `org-agenda-skip-function' for the duration of a command."
4420 (let (beg end m)
4421 (org-back-to-heading t)
4422 (setq beg (point)
4423 end (if subtree
4424 (progn (org-end-of-subtree t) (point))
4425 (progn (outline-next-heading) (1- (point)))))
4426 (goto-char beg)
4427 (and
4429 (and (memq 'scheduled conditions)
4430 (re-search-forward org-scheduled-time-regexp end t))
4431 (and (memq 'notscheduled conditions)
4432 (not (re-search-forward org-scheduled-time-regexp end t)))
4433 (and (memq 'deadline conditions)
4434 (re-search-forward org-deadline-time-regexp end t))
4435 (and (memq 'notdeadline conditions)
4436 (not (re-search-forward org-deadline-time-regexp end t)))
4437 (and (memq 'timestamp conditions)
4438 (re-search-forward org-ts-regexp end t))
4439 (and (memq 'nottimestamp conditions)
4440 (not (re-search-forward org-ts-regexp end t)))
4441 (and (setq m (memq 'regexp conditions))
4442 (stringp (nth 1 m))
4443 (re-search-forward (nth 1 m) end t))
4444 (and (setq m (memq 'notregexp conditions))
4445 (stringp (nth 1 m))
4446 (not (re-search-forward (nth 1 m) end t)))
4447 (and (or
4448 (setq m (memq 'todo conditions))
4449 (setq m (memq 'nottodo conditions)))
4450 (org-agenda-skip-if-todo m end)))
4451 end)))
4453 (defun org-agenda-skip-if-todo (args end)
4454 "Helper function for `org-agenda-skip-if', do not use it directly.
4455 ARGS is a list with first element either `todo' or `nottodo'.
4456 The remainder is either a list of TODO keywords, or a state symbol
4457 `todo' or `done' or `any'."
4458 (let ((kw (car args))
4459 (arg (cadr args))
4460 todo-wds todo-re)
4461 (setq todo-wds
4462 (org-uniquify
4463 (cond
4464 ((listp arg) ;; list of keywords
4465 (if (member "*" arg)
4466 (mapcar 'substring-no-properties org-todo-keywords-1)
4467 arg))
4468 ((symbolp arg) ;; keyword class name
4469 (cond
4470 ((eq arg 'todo)
4471 (org-delete-all org-done-keywords
4472 (mapcar 'substring-no-properties
4473 org-todo-keywords-1)))
4474 ((eq arg 'done) org-done-keywords)
4475 ((eq arg 'any)
4476 (mapcar 'substring-no-properties org-todo-keywords-1)))))))
4477 (setq todo-re
4478 (concat "^\\*+[ \t]+\\<\\("
4479 (mapconcat 'identity todo-wds "\\|")
4480 "\\)\\>"))
4481 (if (eq kw 'todo)
4482 (re-search-forward todo-re end t)
4483 (not (re-search-forward todo-re end t)))))
4485 ;;;###autoload
4486 (defun org-agenda-list-stuck-projects (&rest ignore)
4487 "Create agenda view for projects that are stuck.
4488 Stuck projects are project that have no next actions. For the definitions
4489 of what a project is and how to check if it stuck, customize the variable
4490 `org-stuck-projects'."
4491 (interactive)
4492 (let* ((org-agenda-skip-function
4493 'org-agenda-skip-entry-when-regexp-matches-in-subtree)
4494 ;; We could have used org-agenda-skip-if here.
4495 (org-agenda-overriding-header
4496 (or org-agenda-overriding-header "List of stuck projects: "))
4497 (matcher (nth 0 org-stuck-projects))
4498 (todo (nth 1 org-stuck-projects))
4499 (todo-wds (if (member "*" todo)
4500 (progn
4501 (org-prepare-agenda-buffers (org-agenda-files
4502 nil 'ifmode))
4503 (org-delete-all
4504 org-done-keywords-for-agenda
4505 (copy-sequence org-todo-keywords-for-agenda)))
4506 todo))
4507 (todo-re (concat "^\\*+[ \t]+\\("
4508 (mapconcat 'identity todo-wds "\\|")
4509 "\\)\\>"))
4510 (tags (nth 2 org-stuck-projects))
4511 (tags-re (if (member "*" tags)
4512 (concat org-outline-regexp-bol
4513 (org-re ".*:[[:alnum:]_@#%]+:[ \t]*$"))
4514 (if tags
4515 (concat org-outline-regexp-bol
4516 ".*:\\("
4517 (mapconcat 'identity tags "\\|")
4518 (org-re "\\):[[:alnum:]_@#%:]*[ \t]*$")))))
4519 (gen-re (nth 3 org-stuck-projects))
4520 (re-list
4521 (delq nil
4522 (list
4523 (if todo todo-re)
4524 (if tags tags-re)
4525 (and gen-re (stringp gen-re) (string-match "\\S-" gen-re)
4526 gen-re)))))
4527 (setq org-agenda-skip-regexp
4528 (if re-list
4529 (mapconcat 'identity re-list "\\|")
4530 (error "No information how to identify unstuck projects")))
4531 (org-tags-view nil matcher)
4532 (with-current-buffer org-agenda-buffer-name
4533 (setq org-agenda-redo-command
4534 '(org-agenda-list-stuck-projects
4535 (or current-prefix-arg org-last-arg))))))
4537 ;;; Diary integration
4539 (defvar org-disable-agenda-to-diary nil) ;Dynamically-scoped param.
4540 (defvar diary-list-entries-hook)
4541 (defvar diary-time-regexp)
4542 (defun org-get-entries-from-diary (date)
4543 "Get the (Emacs Calendar) diary entries for DATE."
4544 (require 'diary-lib)
4545 (let* ((diary-fancy-buffer "*temporary-fancy-diary-buffer*")
4546 (diary-display-hook '(fancy-diary-display))
4547 (diary-display-function 'fancy-diary-display)
4548 (pop-up-frames nil)
4549 (diary-list-entries-hook
4550 (cons 'org-diary-default-entry diary-list-entries-hook))
4551 (diary-file-name-prefix-function nil) ; turn this feature off
4552 (diary-modify-entry-list-string-function 'org-modify-diary-entry-string)
4553 entries
4554 (org-disable-agenda-to-diary t))
4555 (save-excursion
4556 (save-window-excursion
4557 (funcall (if (fboundp 'diary-list-entries)
4558 'diary-list-entries 'list-diary-entries)
4559 date 1)))
4560 (if (not (get-buffer diary-fancy-buffer))
4561 (setq entries nil)
4562 (with-current-buffer diary-fancy-buffer
4563 (setq buffer-read-only nil)
4564 (if (zerop (buffer-size))
4565 ;; No entries
4566 (setq entries nil)
4567 ;; Omit the date and other unnecessary stuff
4568 (org-agenda-cleanup-fancy-diary)
4569 ;; Add prefix to each line and extend the text properties
4570 (if (zerop (buffer-size))
4571 (setq entries nil)
4572 (setq entries (buffer-substring (point-min) (- (point-max) 1)))
4573 (setq entries
4574 (with-temp-buffer
4575 (insert entries) (goto-char (point-min))
4576 (while (re-search-forward "\n[ \t]+\\(.+\\)$" nil t)
4577 (unless (save-match-data (string-match diary-time-regexp (match-string 1)))
4578 (replace-match (concat "; " (match-string 1)))))
4579 (buffer-string)))))
4580 (set-buffer-modified-p nil)
4581 (kill-buffer diary-fancy-buffer)))
4582 (when entries
4583 (setq entries (org-split-string entries "\n"))
4584 (setq entries
4585 (mapcar
4586 (lambda (x)
4587 (setq x (org-agenda-format-item "" x "Diary" nil 'time))
4588 ;; Extend the text properties to the beginning of the line
4589 (org-add-props x (text-properties-at (1- (length x)) x)
4590 'type "diary" 'date date 'face 'org-agenda-diary))
4591 entries)))))
4593 (defvar org-agenda-cleanup-fancy-diary-hook nil
4594 "Hook run when the fancy diary buffer is cleaned up.")
4596 (defun org-agenda-cleanup-fancy-diary ()
4597 "Remove unwanted stuff in buffer created by `fancy-diary-display'.
4598 This gets rid of the date, the underline under the date, and
4599 the dummy entry installed by `org-mode' to ensure non-empty diary for each
4600 date. It also removes lines that contain only whitespace."
4601 (goto-char (point-min))
4602 (if (looking-at ".*?:[ \t]*")
4603 (progn
4604 (replace-match "")
4605 (re-search-forward "\n=+$" nil t)
4606 (replace-match "")
4607 (while (re-search-backward "^ +\n?" nil t) (replace-match "")))
4608 (re-search-forward "\n=+$" nil t)
4609 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
4610 (goto-char (point-min))
4611 (while (re-search-forward "^ +\n" nil t)
4612 (replace-match ""))
4613 (goto-char (point-min))
4614 (if (re-search-forward "^Org-mode dummy\n?" nil t)
4615 (replace-match ""))
4616 (run-hooks 'org-agenda-cleanup-fancy-diary-hook))
4618 ;; Make sure entries from the diary have the right text properties.
4619 (eval-after-load "diary-lib"
4620 '(if (boundp 'diary-modify-entry-list-string-function)
4621 ;; We can rely on the hook, nothing to do
4623 ;; Hook not available, must use advice to make this work
4624 (defadvice add-to-diary-list (before org-mark-diary-entry activate)
4625 "Make the position visible."
4626 (if (and org-disable-agenda-to-diary ;; called from org-agenda
4627 (stringp string)
4628 buffer-file-name)
4629 (setq string (org-modify-diary-entry-string string))))))
4631 (defun org-modify-diary-entry-string (string)
4632 "Add text properties to string, allowing org-mode to act on it."
4633 (org-add-props string nil
4634 'mouse-face 'highlight
4635 'help-echo (if buffer-file-name
4636 (format "mouse-2 or RET jump to diary file %s"
4637 (abbreviate-file-name buffer-file-name))
4639 'org-agenda-diary-link t
4640 'org-marker (org-agenda-new-marker (point-at-bol))))
4642 (defun org-diary-default-entry ()
4643 "Add a dummy entry to the diary.
4644 Needed to avoid empty dates which mess up holiday display."
4645 ;; Catch the error if dealing with the new add-to-diary-alist
4646 (when org-disable-agenda-to-diary
4647 (condition-case nil
4648 (org-add-to-diary-list original-date "Org-mode dummy" "")
4649 (error
4650 (org-add-to-diary-list original-date "Org-mode dummy" "" nil)))))
4652 (defun org-add-to-diary-list (&rest args)
4653 (if (fboundp 'diary-add-to-list)
4654 (apply 'diary-add-to-list args)
4655 (apply 'add-to-diary-list args)))
4657 (defvar org-diary-last-run-time nil)
4659 ;;;###autoload
4660 (defun org-diary (&rest args)
4661 "Return diary information from org-files.
4662 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
4663 It accesses org files and extracts information from those files to be
4664 listed in the diary. The function accepts arguments specifying what
4665 items should be listed. For a list of arguments allowed here, see the
4666 variable `org-agenda-entry-types'.
4668 The call in the diary file should look like this:
4670 &%%(org-diary) ~/path/to/some/orgfile.org
4672 Use a separate line for each org file to check. Or, if you omit the file name,
4673 all files listed in `org-agenda-files' will be checked automatically:
4675 &%%(org-diary)
4677 If you don't give any arguments (as in the example above), the default
4678 arguments (:deadline :scheduled :timestamp :sexp) are used.
4679 So the example above may also be written as
4681 &%%(org-diary :deadline :timestamp :sexp :scheduled)
4683 The function expects the lisp variables `entry' and `date' to be provided
4684 by the caller, because this is how the calendar works. Don't use this
4685 function from a program - use `org-agenda-get-day-entries' instead."
4686 (when (> (- (org-float-time)
4687 org-agenda-last-marker-time)
4689 ;; I am not sure if this works with sticky agendas, because the marker
4690 ;; list is then no longer a global variable.
4691 (org-agenda-reset-markers))
4692 (org-compile-prefix-format 'agenda)
4693 (org-set-sorting-strategy 'agenda)
4694 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4695 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
4696 (list entry)
4697 (org-agenda-files t)))
4698 (time (org-float-time))
4699 file rtn results)
4700 (when (or (not org-diary-last-run-time)
4701 (> (- time
4702 org-diary-last-run-time)
4704 (org-prepare-agenda-buffers files))
4705 (setq org-diary-last-run-time time)
4706 ;; If this is called during org-agenda, don't return any entries to
4707 ;; the calendar. Org Agenda will list these entries itself.
4708 (if org-disable-agenda-to-diary (setq files nil))
4709 (while (setq file (pop files))
4710 (setq rtn (apply 'org-agenda-get-day-entries file date args))
4711 (setq results (append results rtn)))
4712 (if results
4713 (concat (org-finalize-agenda-entries results) "\n"))))
4715 ;;; Agenda entry finders
4717 (defun org-agenda-get-day-entries (file date &rest args)
4718 "Does the work for `org-diary' and `org-agenda'.
4719 FILE is the path to a file to be checked for entries. DATE is date like
4720 the one returned by `calendar-current-date'. ARGS are symbols indicating
4721 which kind of entries should be extracted. For details about these, see
4722 the documentation of `org-diary'."
4723 (setq args (or args '(:deadline :scheduled :timestamp :sexp)))
4724 (let* ((org-startup-folded nil)
4725 (org-startup-align-all-tables nil)
4726 (buffer (if (file-exists-p file)
4727 (org-get-agenda-file-buffer file)
4728 (error "No such file %s" file)))
4729 arg results rtn deadline-results)
4730 (if (not buffer)
4731 ;; If file does not exist, make sure an error message ends up in diary
4732 (list (format "ORG-AGENDA-ERROR: No such org-file %s" file))
4733 (with-current-buffer buffer
4734 (unless (eq major-mode 'org-mode)
4735 (error "Agenda file %s is not in `org-mode'" file))
4736 (let ((case-fold-search nil))
4737 (save-excursion
4738 (save-restriction
4739 (if org-agenda-restrict
4740 (narrow-to-region org-agenda-restrict-begin
4741 org-agenda-restrict-end)
4742 (widen))
4743 ;; The way we repeatedly append to `results' makes it O(n^2) :-(
4744 (while (setq arg (pop args))
4745 (cond
4746 ((and (eq arg :todo)
4747 (equal date (calendar-gregorian-from-absolute
4748 (org-today))))
4749 (setq rtn (org-agenda-get-todos))
4750 (setq results (append results rtn)))
4751 ((eq arg :timestamp)
4752 (setq rtn (org-agenda-get-blocks))
4753 (setq results (append results rtn))
4754 (setq rtn (org-agenda-get-timestamps))
4755 (setq results (append results rtn)))
4756 ((eq arg :sexp)
4757 (setq rtn (org-agenda-get-sexps))
4758 (setq results (append results rtn)))
4759 ((eq arg :scheduled)
4760 (setq rtn (org-agenda-get-scheduled deadline-results))
4761 (setq results (append results rtn)))
4762 ((eq arg :closed)
4763 (setq rtn (org-agenda-get-progress))
4764 (setq results (append results rtn)))
4765 ((eq arg :deadline)
4766 (setq rtn (org-agenda-get-deadlines))
4767 (setq deadline-results (copy-sequence rtn))
4768 (setq results (append results rtn))))))))
4769 results))))
4771 (defvar org-heading-keyword-regexp-format) ; defined in org.el
4772 (defun org-agenda-get-todos ()
4773 "Return the TODO information for agenda display."
4774 (let* ((props (list 'face nil
4775 'done-face 'org-agenda-done
4776 'org-not-done-regexp org-not-done-regexp
4777 'org-todo-regexp org-todo-regexp
4778 'org-complex-heading-regexp org-complex-heading-regexp
4779 'mouse-face 'highlight
4780 'help-echo
4781 (format "mouse-2 or RET jump to org file %s"
4782 (abbreviate-file-name buffer-file-name))))
4783 (regexp (format org-heading-keyword-regexp-format
4784 (cond
4785 ((and org-select-this-todo-keyword
4786 (equal org-select-this-todo-keyword "*"))
4787 org-todo-regexp)
4788 (org-select-this-todo-keyword
4789 (concat "\\("
4790 (mapconcat 'identity
4791 (org-split-string
4792 org-select-this-todo-keyword
4793 "|")
4794 "\\|") "\\)"))
4795 (t org-not-done-regexp))))
4796 marker priority category org-category-pos tags todo-state
4797 ee txt beg end)
4798 (goto-char (point-min))
4799 (while (re-search-forward regexp nil t)
4800 (catch :skip
4801 (save-match-data
4802 (beginning-of-line)
4803 (org-agenda-skip)
4804 (setq beg (point) end (save-excursion (outline-next-heading) (point)))
4805 (when (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item end)
4806 (goto-char (1+ beg))
4807 (or org-agenda-todo-list-sublevels (org-end-of-subtree 'invisible))
4808 (throw :skip nil)))
4809 (goto-char (match-beginning 2))
4810 (setq marker (org-agenda-new-marker (match-beginning 0))
4811 category (org-get-category)
4812 org-category-pos (get-text-property (point) 'org-category-position)
4813 txt (org-trim
4814 (buffer-substring (match-beginning 2) (match-end 0)))
4815 tags (org-get-tags-at (point))
4816 txt (org-agenda-format-item "" txt category tags)
4817 priority (1+ (org-get-priority txt))
4818 todo-state (org-get-todo-state))
4819 (org-add-props txt props
4820 'org-marker marker 'org-hd-marker marker
4821 'priority priority 'org-category category
4822 'org-category-position org-category-pos
4823 'type "todo" 'todo-state todo-state)
4824 (push txt ee)
4825 (if org-agenda-todo-list-sublevels
4826 (goto-char (match-end 2))
4827 (org-end-of-subtree 'invisible))))
4828 (nreverse ee)))
4830 (defun org-agenda-todo-custom-ignore-p (time n)
4831 "Check whether timestamp is farther away then n number of days.
4832 This function is invoked if `org-agenda-todo-ignore-deadlines',
4833 `org-agenda-todo-ignore-scheduled' or
4834 `org-agenda-todo-ignore-timestamp' is set to an integer."
4835 (let ((days (org-days-to-time time)))
4836 (if (>= n 0)
4837 (>= days n)
4838 (<= days n))))
4840 ;;;###autoload
4841 (defun org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4842 (&optional end)
4843 "Do we have a reason to ignore this TODO entry because it has a time stamp?"
4844 (when (or org-agenda-todo-ignore-with-date
4845 org-agenda-todo-ignore-scheduled
4846 org-agenda-todo-ignore-deadlines
4847 org-agenda-todo-ignore-timestamp)
4848 (setq end (or end (save-excursion (outline-next-heading) (point))))
4849 (save-excursion
4850 (or (and org-agenda-todo-ignore-with-date
4851 (re-search-forward org-ts-regexp end t))
4852 (and org-agenda-todo-ignore-scheduled
4853 (re-search-forward org-scheduled-time-regexp end t)
4854 (cond
4855 ((eq org-agenda-todo-ignore-scheduled 'future)
4856 (> (org-days-to-time (match-string 1)) 0))
4857 ((eq org-agenda-todo-ignore-scheduled 'past)
4858 (<= (org-days-to-time (match-string 1)) 0))
4859 ((numberp org-agenda-todo-ignore-scheduled)
4860 (org-agenda-todo-custom-ignore-p
4861 (match-string 1) org-agenda-todo-ignore-scheduled))
4862 (t)))
4863 (and org-agenda-todo-ignore-deadlines
4864 (re-search-forward org-deadline-time-regexp end t)
4865 (cond
4866 ((memq org-agenda-todo-ignore-deadlines '(t all)) t)
4867 ((eq org-agenda-todo-ignore-deadlines 'far)
4868 (not (org-deadline-close (match-string 1))))
4869 ((eq org-agenda-todo-ignore-deadlines 'future)
4870 (> (org-days-to-time (match-string 1)) 0))
4871 ((eq org-agenda-todo-ignore-deadlines 'past)
4872 (<= (org-days-to-time (match-string 1)) 0))
4873 ((numberp org-agenda-todo-ignore-deadlines)
4874 (org-agenda-todo-custom-ignore-p
4875 (match-string 1) org-agenda-todo-ignore-deadlines))
4876 (t (org-deadline-close (match-string 1)))))
4877 (and org-agenda-todo-ignore-timestamp
4878 (let ((buffer (current-buffer))
4879 (regexp
4880 (concat
4881 org-scheduled-time-regexp "\\|" org-deadline-time-regexp))
4882 (start (point)))
4883 ;; Copy current buffer into a temporary one
4884 (with-temp-buffer
4885 (insert-buffer-substring buffer start end)
4886 (goto-char (point-min))
4887 ;; Delete SCHEDULED and DEADLINE items
4888 (while (re-search-forward regexp end t)
4889 (delete-region (match-beginning 0) (match-end 0)))
4890 (goto-char (point-min))
4891 ;; No search for timestamp left
4892 (when (re-search-forward org-ts-regexp nil t)
4893 (cond
4894 ((eq org-agenda-todo-ignore-timestamp 'future)
4895 (> (org-days-to-time (match-string 1)) 0))
4896 ((eq org-agenda-todo-ignore-timestamp 'past)
4897 (<= (org-days-to-time (match-string 1)) 0))
4898 ((numberp org-agenda-todo-ignore-timestamp)
4899 (org-agenda-todo-custom-ignore-p
4900 (match-string 1) org-agenda-todo-ignore-timestamp))
4901 (t))))))))))
4903 (defconst org-agenda-no-heading-message
4904 "No heading for this item in buffer or region.")
4906 (defun org-agenda-get-timestamps ()
4907 "Return the date stamp information for agenda display."
4908 (let* ((props (list 'face 'org-agenda-calendar-event
4909 'org-not-done-regexp org-not-done-regexp
4910 'org-todo-regexp org-todo-regexp
4911 'org-complex-heading-regexp org-complex-heading-regexp
4912 'mouse-face 'highlight
4913 'help-echo
4914 (format "mouse-2 or RET jump to org file %s"
4915 (abbreviate-file-name buffer-file-name))))
4916 (d1 (calendar-absolute-from-gregorian date))
4917 (remove-re
4918 (concat
4919 (regexp-quote
4920 (format-time-string
4921 "<%Y-%m-%d"
4922 (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
4923 ".*?>"))
4924 (regexp
4925 (concat
4926 (if org-agenda-include-inactive-timestamps "[[<]" "<")
4927 (regexp-quote
4928 (substring
4929 (format-time-string
4930 (car org-time-stamp-formats)
4931 (apply 'encode-time ; DATE bound by calendar
4932 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
4933 1 11))
4934 "\\|\\(<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
4935 "\\|\\(<%%\\(([^>\n]+)\\)>\\)"))
4936 marker hdmarker deadlinep scheduledp clockp closedp inactivep
4937 donep tmp priority category org-category-pos ee txt timestr tags
4938 b0 b3 e3 head todo-state end-of-match show-all)
4939 (goto-char (point-min))
4940 (while (setq end-of-match (re-search-forward regexp nil t))
4941 (setq b0 (match-beginning 0)
4942 b3 (match-beginning 3) e3 (match-end 3)
4943 todo-state (save-match-data (ignore-errors (org-get-todo-state)))
4944 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
4945 (member todo-state
4946 org-agenda-repeating-timestamp-show-all)))
4947 (catch :skip
4948 (and (org-at-date-range-p) (throw :skip nil))
4949 (org-agenda-skip)
4950 (if (and (match-end 1)
4951 (not (= d1 (org-time-string-to-absolute
4952 (match-string 1) d1 nil show-all
4953 (current-buffer) b0))))
4954 (throw :skip nil))
4955 (if (and e3
4956 (not (org-diary-sexp-entry (buffer-substring b3 e3) "" date)))
4957 (throw :skip nil))
4958 (setq tmp (buffer-substring (max (point-min)
4959 (- b0 org-ds-keyword-length))
4961 timestr (if b3 "" (buffer-substring b0 (point-at-eol)))
4962 inactivep (= (char-after b0) ?\[)
4963 deadlinep (string-match org-deadline-regexp tmp)
4964 scheduledp (string-match org-scheduled-regexp tmp)
4965 closedp (and org-agenda-include-inactive-timestamps
4966 (string-match org-closed-string tmp))
4967 clockp (and org-agenda-include-inactive-timestamps
4968 (or (string-match org-clock-string tmp)
4969 (string-match "]-+\\'" tmp)))
4970 donep (member todo-state org-done-keywords))
4971 (if (or scheduledp deadlinep closedp clockp
4972 (and donep org-agenda-skip-timestamp-if-done))
4973 (throw :skip t))
4974 (if (string-match ">" timestr)
4975 ;; substring should only run to end of time stamp
4976 (setq timestr (substring timestr 0 (match-end 0))))
4977 (setq marker (org-agenda-new-marker b0)
4978 category (org-get-category b0)
4979 org-category-pos (get-text-property b0 'org-category-position))
4980 (save-excursion
4981 (if (not (re-search-backward org-outline-regexp-bol nil t))
4982 (setq txt org-agenda-no-heading-message)
4983 (goto-char (match-beginning 0))
4984 (setq hdmarker (org-agenda-new-marker)
4985 tags (org-get-tags-at))
4986 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
4987 (setq head (or (match-string 1) ""))
4988 (setq txt (org-agenda-format-item
4989 (if inactivep org-agenda-inactive-leader nil)
4990 head category tags timestr
4991 remove-re)))
4992 (setq priority (org-get-priority txt))
4993 (org-add-props txt props
4994 'org-marker marker 'org-hd-marker hdmarker)
4995 (org-add-props txt nil 'priority priority
4996 'org-category category 'date date
4997 'org-category-position org-category-pos
4998 'todo-state todo-state
4999 'type "timestamp")
5000 (push txt ee))
5001 (if org-agenda-skip-additional-timestamps-same-entry
5002 (outline-next-heading)
5003 (goto-char end-of-match))))
5004 (nreverse ee)))
5006 (defun org-agenda-get-sexps ()
5007 "Return the sexp information for agenda display."
5008 (require 'diary-lib)
5009 (let* ((props (list 'face 'org-agenda-calendar-sexp
5010 'mouse-face 'highlight
5011 'help-echo
5012 (format "mouse-2 or RET jump to org file %s"
5013 (abbreviate-file-name buffer-file-name))))
5014 (regexp "^&?%%(")
5015 marker category org-category-pos ee txt tags entry
5016 result beg b sexp sexp-entry todo-state)
5017 (goto-char (point-min))
5018 (while (re-search-forward regexp nil t)
5019 (catch :skip
5020 (org-agenda-skip)
5021 (setq beg (match-beginning 0))
5022 (goto-char (1- (match-end 0)))
5023 (setq b (point))
5024 (forward-sexp 1)
5025 (setq sexp (buffer-substring b (point)))
5026 (setq sexp-entry (if (looking-at "[ \t]*\\(\\S-.*\\)")
5027 (org-trim (match-string 1))
5028 ""))
5029 (setq result (org-diary-sexp-entry sexp sexp-entry date))
5030 (when result
5031 (setq marker (org-agenda-new-marker beg)
5032 category (org-get-category beg)
5033 org-category-pos (get-text-property beg 'org-category-position)
5034 todo-state (org-get-todo-state))
5036 (dolist (r (if (stringp result)
5037 (list result)
5038 result)) ;; we expect a list here
5039 (if (string-match "\\S-" r)
5040 (setq txt r)
5041 (setq txt "SEXP entry returned empty string"))
5043 (setq txt (org-agenda-format-item
5044 "" txt category tags 'time))
5045 (org-add-props txt props 'org-marker marker)
5046 (org-add-props txt nil
5047 'org-category category 'date date 'todo-state todo-state
5048 'org-category-position org-category-pos
5049 'type "sexp")
5050 (push txt ee)))))
5051 (nreverse ee)))
5053 ;; Calendar sanity: define some functions that are independent of
5054 ;; `calendar-date-style'.
5055 ;; Normally I would like to use ISO format when calling the diary functions,
5056 ;; but to make sure we still have Emacs 22 compatibility we bind
5057 ;; also `european-calendar-style' and use european format
5058 (defun org-anniversary (year month day &optional mark)
5059 "Like `diary-anniversary', but with fixed (ISO) order of arguments."
5060 (org-no-warnings
5061 (let ((calendar-date-style 'european) (european-calendar-style t))
5062 (diary-anniversary day month year mark))))
5063 (defun org-cyclic (N year month day &optional mark)
5064 "Like `diary-cyclic', but with fixed (ISO) order of arguments."
5065 (org-no-warnings
5066 (let ((calendar-date-style 'european) (european-calendar-style t))
5067 (diary-cyclic N day month year mark))))
5068 (defun org-block (Y1 M1 D1 Y2 M2 D2 &optional mark)
5069 "Like `diary-block', but with fixed (ISO) order of arguments."
5070 (org-no-warnings
5071 (let ((calendar-date-style 'european) (european-calendar-style t))
5072 (diary-block D1 M1 Y1 D2 M2 Y2 mark))))
5073 (defun org-date (year month day &optional mark)
5074 "Like `diary-date', but with fixed (ISO) order of arguments."
5075 (org-no-warnings
5076 (let ((calendar-date-style 'european) (european-calendar-style t))
5077 (diary-date day month year mark))))
5078 (defalias 'org-float 'diary-float)
5080 ;; Define the` org-class' function
5081 (defun org-class (y1 m1 d1 y2 m2 d2 dayname &rest skip-weeks)
5082 "Entry applies if date is between dates on DAYNAME, but skips SKIP-WEEKS.
5083 DAYNAME is a number between 0 (Sunday) and 6 (Saturday).
5084 SKIP-WEEKS is any number of ISO weeks in the block period for which the
5085 item should be skipped. If any of the SKIP-WEEKS arguments is the symbol
5086 `holidays', then any date that is known by the Emacs calendar to be a
5087 holiday will also be skipped."
5088 (let* ((date1 (calendar-absolute-from-gregorian (list m1 d1 y1)))
5089 (date2 (calendar-absolute-from-gregorian (list m2 d2 y2)))
5090 (d (calendar-absolute-from-gregorian date)))
5091 (and
5092 (<= date1 d)
5093 (<= d date2)
5094 (= (calendar-day-of-week date) dayname)
5095 (or (not skip-weeks)
5096 (progn
5097 (require 'cal-iso)
5098 (not (member (car (calendar-iso-from-absolute d)) skip-weeks))))
5099 (not (and (memq 'holidays skip-weeks)
5100 (calendar-check-holidays date)))
5101 entry)))
5103 (defun org-diary-class (m1 d1 y1 m2 d2 y2 dayname &rest skip-weeks)
5104 "Like `org-class', but honor `calendar-date-style'.
5105 The order of the first 2 times 3 arguments depends on the variable
5106 `calendar-date-style' or, if that is not defined, on `european-calendar-style'.
5107 So for American calendars, give this as MONTH DAY YEAR, for European as
5108 DAY MONTH YEAR, and for ISO as YEAR MONTH DAY.
5109 DAYNAME is a number between 0 (Sunday) and 6 (Saturday). SKIP-WEEKS
5110 is any number of ISO weeks in the block period for which the item should
5111 be skipped.
5113 This function is here only for backward compatibility and it is deprecated,
5114 please use `org-class' instead."
5115 (let* ((date1 (org-order-calendar-date-args m1 d1 y1))
5116 (date2 (org-order-calendar-date-args m2 d2 y2)))
5117 (org-class
5118 (nth 2 date1) (car date1) (nth 1 date1)
5119 (nth 2 date2) (car date2) (nth 1 date2)
5120 dayname skip-weeks)))
5121 (make-obsolete 'org-diary-class 'org-class "")
5123 (defalias 'org-get-closed 'org-agenda-get-progress)
5124 (defun org-agenda-get-progress ()
5125 "Return the logged TODO entries for agenda display."
5126 (let* ((props (list 'mouse-face 'highlight
5127 'org-not-done-regexp org-not-done-regexp
5128 'org-todo-regexp org-todo-regexp
5129 'org-complex-heading-regexp org-complex-heading-regexp
5130 'help-echo
5131 (format "mouse-2 or RET jump to org file %s"
5132 (abbreviate-file-name buffer-file-name))))
5133 (items (if (consp org-agenda-show-log-scoped)
5134 org-agenda-show-log-scoped
5135 (if (eq org-agenda-show-log-scoped 'clockcheck)
5136 '(clock)
5137 org-agenda-log-mode-items)))
5138 (parts
5139 (delq nil
5140 (list
5141 (if (memq 'closed items) (concat "\\<" org-closed-string))
5142 (if (memq 'clock items) (concat "\\<" org-clock-string))
5143 (if (memq 'state items) "- State \"\\([a-zA-Z0-9]+\\)\".*?"))))
5144 (parts-re (if parts (mapconcat 'identity parts "\\|")
5145 (error "`org-agenda-log-mode-items' is empty")))
5146 (regexp (concat
5147 "\\(" parts-re "\\)"
5148 " *\\["
5149 (regexp-quote
5150 (substring
5151 (format-time-string
5152 (car org-time-stamp-formats)
5153 (apply 'encode-time ; DATE bound by calendar
5154 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
5155 1 11))))
5156 (org-agenda-search-headline-for-time nil)
5157 marker hdmarker priority category org-category-pos tags closedp
5158 statep clockp state ee txt extra timestr rest clocked)
5159 (goto-char (point-min))
5160 (while (re-search-forward regexp nil t)
5161 (catch :skip
5162 (org-agenda-skip)
5163 (setq marker (org-agenda-new-marker (match-beginning 0))
5164 closedp (equal (match-string 1) org-closed-string)
5165 statep (equal (string-to-char (match-string 1)) ?-)
5166 clockp (not (or closedp statep))
5167 state (and statep (match-string 2))
5168 category (org-get-category (match-beginning 0))
5169 org-category-pos (get-text-property (match-beginning 0) 'org-category-position)
5170 timestr (buffer-substring (match-beginning 0) (point-at-eol)))
5171 (when (string-match "\\]" timestr)
5172 ;; substring should only run to end of time stamp
5173 (setq rest (substring timestr (match-end 0))
5174 timestr (substring timestr 0 (match-end 0)))
5175 (if (and (not closedp) (not statep)
5176 (string-match "\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)\\].*?\\([0-9]\\{1,2\\}:[0-9]\\{2\\}\\)"
5177 rest))
5178 (progn (setq timestr (concat (substring timestr 0 -1)
5179 "-" (match-string 1 rest) "]"))
5180 (setq clocked (match-string 2 rest)))
5181 (setq clocked "-")))
5182 (save-excursion
5183 (setq extra
5184 (cond
5185 ((not org-agenda-log-mode-add-notes) nil)
5186 (statep
5187 (and (looking-at ".*\\\\\n[ \t]*\\([^-\n \t].*?\\)[ \t]*$")
5188 (match-string 1)))
5189 (clockp
5190 (and (looking-at ".*\n[ \t]*-[ \t]+\\([^-\n \t].*?\\)[ \t]*$")
5191 (match-string 1)))))
5192 (if (not (re-search-backward org-outline-regexp-bol nil t))
5193 (setq txt org-agenda-no-heading-message)
5194 (goto-char (match-beginning 0))
5195 (setq hdmarker (org-agenda-new-marker)
5196 tags (org-get-tags-at))
5197 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5198 (setq txt (match-string 1))
5199 (when extra
5200 (if (string-match "\\([ \t]+\\)\\(:[^ \n\t]*?:\\)[ \t]*$" txt)
5201 (setq txt (concat (substring txt 0 (match-beginning 1))
5202 " - " extra " " (match-string 2 txt)))
5203 (setq txt (concat txt " - " extra))))
5204 (setq txt (org-agenda-format-item
5205 (cond
5206 (closedp "Closed: ")
5207 (statep (concat "State: (" state ")"))
5208 (t (concat "Clocked: (" clocked ")")))
5209 txt category tags timestr)))
5210 (setq priority 100000)
5211 (org-add-props txt props
5212 'org-marker marker 'org-hd-marker hdmarker 'face 'org-agenda-done
5213 'priority priority 'org-category category
5214 'org-category-position org-category-pos
5215 'type "closed" 'date date
5216 'undone-face 'org-warning 'done-face 'org-agenda-done)
5217 (push txt ee))
5218 (goto-char (point-at-eol))))
5219 (nreverse ee)))
5221 (defun org-agenda-show-clocking-issues ()
5222 "Add overlays, showing issues with clocking.
5223 See also the user option `org-agenda-clock-consistency-checks'."
5224 (interactive)
5225 (let* ((pl org-agenda-clock-consistency-checks)
5226 (re (concat "^[ \t]*"
5227 org-clock-string
5228 "[ \t]+"
5229 "\\(\\[.*?\\]\\)" ; group 1 is first stamp
5230 "\\(-\\{1,3\\}\\(\\[.*?\\]\\)\\)?")) ; group 3 is second
5231 (tlstart 0.)
5232 (tlend 0.)
5233 (maxtime (org-hh:mm-string-to-minutes
5234 (or (plist-get pl :max-duration) "24:00")))
5235 (mintime (org-hh:mm-string-to-minutes
5236 (or (plist-get pl :min-duration) 0)))
5237 (maxgap (org-hh:mm-string-to-minutes
5238 ;; default 30:00 means never complain
5239 (or (plist-get pl :max-gap) "30:00")))
5240 (gapok (mapcar 'org-hh:mm-string-to-minutes
5241 (plist-get pl :gap-ok-around)))
5242 (def-face (or (plist-get pl :default-face)
5243 '((:background "DarkRed") (:foreground "white"))))
5244 issue face m te ts dt ov)
5245 (goto-char (point-min))
5246 (while (re-search-forward " Clocked: +(-\\|\\([0-9]+:[0-9]+\\))" nil t)
5247 (setq issue nil face def-face)
5248 (catch 'next
5249 (setq m (org-get-at-bol 'org-marker)
5250 te nil ts nil)
5251 (unless (and m (markerp m))
5252 (setq issue "No valid clock line") (throw 'next t))
5253 (org-with-point-at m
5254 (save-excursion
5255 (goto-char (point-at-bol))
5256 (unless (looking-at re)
5257 (error "No valid Clock line")
5258 (throw 'next t))
5259 (unless (match-end 3)
5260 (setq issue "No end time"
5261 face (or (plist-get pl :no-end-time-face) face))
5262 (throw 'next t))
5263 (setq ts (match-string 1)
5264 te (match-string 3)
5265 ts (org-float-time
5266 (apply 'encode-time (org-parse-time-string ts)))
5267 te (org-float-time
5268 (apply 'encode-time (org-parse-time-string te)))
5269 dt (- te ts))))
5270 (cond
5271 ((> dt (* 60 maxtime))
5272 ;; a very long clocking chunk
5273 (setq issue (format "Clocking interval is very long: %s"
5274 (org-minutes-to-hh:mm-string
5275 (floor (/ (float dt) 60.))))
5276 face (or (plist-get pl :long-face) face)))
5277 ((< dt (* 60 mintime))
5278 ;; a very short clocking chunk
5279 (setq issue (format "Clocking interval is very short: %s"
5280 (org-minutes-to-hh:mm-string
5281 (floor (/ (float dt) 60.))))
5282 face (or (plist-get pl :short-face) face)))
5283 ((and (> tlend 0) (< ts tlend))
5284 ;; Two clock entries are overlapping
5285 (setq issue (format "Clocking overlap: %d minutes"
5286 (/ (- tlend ts) 60))
5287 face (or (plist-get pl :overlap-face) face)))
5288 ((and (> tlend 0) (> ts (+ tlend (* 60 maxgap))))
5289 ;; There is a gap, lets see if we need to report it
5290 (unless (org-agenda-check-clock-gap tlend ts gapok)
5291 (setq issue (format "Clocking gap: %d minutes"
5292 (/ (- ts tlend) 60))
5293 face (or (plist-get pl :gap-face) face))))
5294 (t nil)))
5295 (setq tlend (or te tlend) tlstart (or ts tlstart))
5296 (when issue
5297 ;; OK, there was some issue, add an overlay to show the issue
5298 (setq ov (make-overlay (point-at-bol) (point-at-eol)))
5299 (overlay-put ov 'before-string
5300 (concat
5301 (org-add-props
5302 (format "%-43s" (concat " " issue))
5304 'face face)
5305 "\n"))
5306 (overlay-put ov 'evaporate t)))))
5308 (defun org-agenda-check-clock-gap (t1 t2 ok-list)
5309 "Check if gap T1 -> T2 contains one of the OK-LIST time-of-day values."
5310 (catch 'exit
5311 (unless ok-list
5312 ;; there are no OK times for gaps...
5313 (throw 'exit nil))
5314 (if (> (- (/ t2 36000) (/ t1 36000)) 24)
5315 ;; This is more than 24 hours, so it is OK.
5316 ;; because we have at least one OK time, that must be in the
5317 ;; 24 hour interval.
5318 (throw 'exit t))
5319 ;; We have a shorter gap.
5320 ;; Now we have to get the minute of the day when these times are
5321 (let* ((t1dec (decode-time (seconds-to-time t1)))
5322 (t2dec (decode-time (seconds-to-time t2)))
5323 ;; compute the minute on the day
5324 (min1 (+ (nth 1 t1dec) (* 60 (nth 2 t1dec))))
5325 (min2 (+ (nth 1 t2dec) (* 60 (nth 2 t2dec)))))
5326 (when (< min2 min1)
5327 ;; if min2 is smaller than min1, this means it is on the next day.
5328 ;; Wrap it to after midnight.
5329 (setq min2 (+ min2 1440)))
5330 ;; Now check if any of the OK times is in the gap
5331 (mapc (lambda (x)
5332 ;; Wrap the time to after midnight if necessary
5333 (if (< x min1) (setq x (+ x 1440)))
5334 ;; Check if in interval
5335 (and (<= min1 x) (>= min2 x) (throw 'exit t)))
5336 ok-list)
5337 ;; Nope, this gap is not OK
5338 nil)))
5340 (defun org-agenda-get-deadlines ()
5341 "Return the deadline information for agenda display."
5342 (let* ((props (list 'mouse-face 'highlight
5343 'org-not-done-regexp org-not-done-regexp
5344 'org-todo-regexp org-todo-regexp
5345 'org-complex-heading-regexp org-complex-heading-regexp
5346 'help-echo
5347 (format "mouse-2 or RET jump to org file %s"
5348 (abbreviate-file-name buffer-file-name))))
5349 (regexp org-deadline-time-regexp)
5350 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5351 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5352 d2 diff dfrac wdays pos pos1 category org-category-pos
5353 tags suppress-prewarning ee txt head face s todo-state
5354 show-all upcomingp donep timestr)
5355 (goto-char (point-min))
5356 (while (re-search-forward regexp nil t)
5357 (setq suppress-prewarning nil)
5358 (catch :skip
5359 (org-agenda-skip)
5360 (when (and org-agenda-skip-deadline-prewarning-if-scheduled
5361 (save-match-data
5362 (string-match org-scheduled-time-regexp
5363 (buffer-substring (point-at-bol)
5364 (point-at-eol)))))
5365 (setq suppress-prewarning
5366 (if (integerp org-agenda-skip-deadline-prewarning-if-scheduled)
5367 org-agenda-skip-deadline-prewarning-if-scheduled
5368 0)))
5369 (setq s (match-string 1)
5370 txt nil
5371 pos (1- (match-beginning 1))
5372 todo-state (save-match-data (org-get-todo-state))
5373 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5374 (member todo-state
5375 org-agenda-repeating-timestamp-show-all))
5376 d2 (org-time-string-to-absolute
5377 (match-string 1) d1 'past show-all
5378 (current-buffer) pos)
5379 diff (- d2 d1)
5380 wdays (if suppress-prewarning
5381 (let ((org-deadline-warning-days suppress-prewarning))
5382 (org-get-wdays s))
5383 (org-get-wdays s))
5384 dfrac (- 1 (/ (* 1.0 diff) (max wdays 1)))
5385 upcomingp (and todayp (> diff 0)))
5386 ;; When to show a deadline in the calendar:
5387 ;; If the expiration is within wdays warning time.
5388 ;; Past-due deadlines are only shown on the current date
5389 (if (and (or (and (<= diff wdays)
5390 (and todayp (not org-agenda-only-exact-dates)))
5391 (= diff 0)))
5392 (save-excursion
5393 ;; (setq todo-state (org-get-todo-state))
5394 (setq donep (member todo-state org-done-keywords))
5395 (if (and donep
5396 (or org-agenda-skip-deadline-if-done
5397 (not (= diff 0))))
5398 (setq txt nil)
5399 (setq category (org-get-category)
5400 org-category-pos (get-text-property (point) 'org-category-position))
5401 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5402 (setq txt org-agenda-no-heading-message)
5403 (goto-char (match-end 0))
5404 (setq pos1 (match-beginning 0))
5405 (setq tags (org-get-tags-at pos1))
5406 (setq head (buffer-substring-no-properties
5407 (point)
5408 (progn (skip-chars-forward "^\r\n")
5409 (point))))
5410 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5411 (setq timestr
5412 (concat (substring s (match-beginning 1)) " "))
5413 (setq timestr 'time))
5414 (setq txt (org-agenda-format-item
5415 (if (= diff 0)
5416 (car org-agenda-deadline-leaders)
5417 (if (functionp
5418 (nth 1 org-agenda-deadline-leaders))
5419 (funcall
5420 (nth 1 org-agenda-deadline-leaders)
5421 diff date)
5422 (format (nth 1 org-agenda-deadline-leaders)
5423 diff)))
5424 head category tags
5425 (if (not (= diff 0)) nil timestr)))))
5426 (when txt
5427 (setq face (org-agenda-deadline-face dfrac))
5428 (org-add-props txt props
5429 'org-marker (org-agenda-new-marker pos)
5430 'org-hd-marker (org-agenda-new-marker pos1)
5431 'priority (+ (- diff)
5432 (org-get-priority txt))
5433 'org-category category
5434 'org-category-position org-category-pos
5435 'todo-state todo-state
5436 'type (if upcomingp "upcoming-deadline" "deadline")
5437 'date (if upcomingp date d2)
5438 'face (if donep 'org-agenda-done face)
5439 'undone-face face 'done-face 'org-agenda-done)
5440 (push txt ee))))))
5441 (nreverse ee)))
5443 (defun org-agenda-deadline-face (fraction)
5444 "Return the face to displaying a deadline item.
5445 FRACTION is what fraction of the head-warning time has passed."
5446 (let ((faces org-agenda-deadline-faces) f)
5447 (catch 'exit
5448 (while (setq f (pop faces))
5449 (if (>= fraction (car f)) (throw 'exit (cdr f)))))))
5451 (defun org-agenda-get-scheduled (&optional deadline-results)
5452 "Return the scheduled information for agenda display."
5453 (let* ((props (list 'org-not-done-regexp org-not-done-regexp
5454 'org-todo-regexp org-todo-regexp
5455 'org-complex-heading-regexp org-complex-heading-regexp
5456 'done-face 'org-agenda-done
5457 'mouse-face 'highlight
5458 'help-echo
5459 (format "mouse-2 or RET jump to org file %s"
5460 (abbreviate-file-name buffer-file-name))))
5461 (regexp org-scheduled-time-regexp)
5462 (todayp (org-agenda-todayp date)) ; DATE bound by calendar
5463 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
5465 (deadline-position-alist
5466 (mapcar (lambda (a) (and (setq mm (get-text-property
5467 0 'org-hd-marker a))
5468 (cons (marker-position mm) a)))
5469 deadline-results))
5470 d2 diff pos pos1 category org-category-pos tags donep
5471 ee txt head pastschedp todo-state face timestr s habitp show-all)
5472 (goto-char (point-min))
5473 (while (re-search-forward regexp nil t)
5474 (catch :skip
5475 (org-agenda-skip)
5476 (setq s (match-string 1)
5477 txt nil
5478 pos (1- (match-beginning 1))
5479 todo-state (save-match-data (org-get-todo-state))
5480 show-all (or (eq org-agenda-repeating-timestamp-show-all t)
5481 (member todo-state
5482 org-agenda-repeating-timestamp-show-all))
5483 d2 (org-time-string-to-absolute
5484 (match-string 1) d1 'past show-all
5485 (current-buffer) pos)
5486 diff (- d2 d1))
5487 (setq pastschedp (and todayp (< diff 0)))
5488 ;; When to show a scheduled item in the calendar:
5489 ;; If it is on or past the date.
5490 (when (or (and (< diff 0)
5491 (< (abs diff) org-scheduled-past-days)
5492 (and todayp (not org-agenda-only-exact-dates)))
5493 (= diff 0))
5494 (save-excursion
5495 (setq donep (member todo-state org-done-keywords))
5496 (if (and donep
5497 (or org-agenda-skip-scheduled-if-done
5498 (not (= diff 0))
5499 (and (functionp 'org-is-habit-p)
5500 (org-is-habit-p))))
5501 (setq txt nil)
5502 (setq habitp (and (functionp 'org-is-habit-p)
5503 (org-is-habit-p)))
5504 (setq category (org-get-category)
5505 org-category-pos (get-text-property (point) 'org-category-position))
5506 (if (not (re-search-backward "^\\*+[ \t]+" nil t))
5507 (setq txt org-agenda-no-heading-message)
5508 (goto-char (match-end 0))
5509 (setq pos1 (match-beginning 0))
5510 (if habitp
5511 (if (or (not org-habit-show-habits)
5512 (and (not todayp)
5513 org-habit-show-habits-only-for-today))
5514 (throw :skip nil))
5515 (if (and
5516 (or (eq t org-agenda-skip-scheduled-if-deadline-is-shown)
5517 (and org-agenda-skip-scheduled-if-deadline-is-shown
5518 pastschedp))
5519 (setq mm (assoc pos1 deadline-position-alist)))
5520 (throw :skip nil)))
5521 (setq tags (org-get-tags-at))
5522 (setq head (buffer-substring-no-properties
5523 (point)
5524 (progn (skip-chars-forward "^\r\n") (point))))
5525 (if (string-match " \\([012]?[0-9]:[0-9][0-9]\\)" s)
5526 (setq timestr
5527 (concat (substring s (match-beginning 1)) " "))
5528 (setq timestr 'time))
5529 (setq txt (org-agenda-format-item
5530 (if (= diff 0)
5531 (car org-agenda-scheduled-leaders)
5532 (format (nth 1 org-agenda-scheduled-leaders)
5533 (- 1 diff)))
5534 head category tags
5535 (if (not (= diff 0)) nil timestr)
5536 nil habitp))))
5537 (when txt
5538 (setq face
5539 (cond
5540 ((and (not habitp) pastschedp)
5541 'org-scheduled-previously)
5542 (todayp 'org-scheduled-today)
5543 (t 'org-scheduled))
5544 habitp (and habitp (org-habit-parse-todo)))
5545 (org-add-props txt props
5546 'undone-face face
5547 'face (if donep 'org-agenda-done face)
5548 'org-marker (org-agenda-new-marker pos)
5549 'org-hd-marker (org-agenda-new-marker pos1)
5550 'type (if pastschedp "past-scheduled" "scheduled")
5551 'date (if pastschedp d2 date)
5552 'priority (if habitp
5553 (org-habit-get-priority habitp)
5554 (+ 94 (- 5 diff) (org-get-priority txt)))
5555 'org-category category
5556 'org-category-position org-category-pos
5557 'org-habit-p habitp
5558 'todo-state todo-state)
5559 (push txt ee))))))
5560 (nreverse ee)))
5562 (defun org-agenda-get-blocks ()
5563 "Return the date-range information for agenda display."
5564 (let* ((props (list 'face nil
5565 'org-not-done-regexp org-not-done-regexp
5566 'org-todo-regexp org-todo-regexp
5567 'org-complex-heading-regexp org-complex-heading-regexp
5568 'mouse-face 'highlight
5569 'help-echo
5570 (format "mouse-2 or RET jump to org file %s"
5571 (abbreviate-file-name buffer-file-name))))
5572 (regexp org-tr-regexp)
5573 (d0 (calendar-absolute-from-gregorian date))
5574 marker hdmarker ee txt d1 d2 s1 s2 category org-category-pos
5575 todo-state tags pos head donep)
5576 (goto-char (point-min))
5577 (while (re-search-forward regexp nil t)
5578 (catch :skip
5579 (org-agenda-skip)
5580 (setq pos (point))
5581 (let ((start-time (match-string 1))
5582 (end-time (match-string 2)))
5583 (setq s1 (match-string 1)
5584 s2 (match-string 2)
5585 d1 (time-to-days (org-time-string-to-time s1 (current-buffer) pos))
5586 d2 (time-to-days (org-time-string-to-time s2 (current-buffer) pos)))
5587 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
5588 ;; Only allow days between the limits, because the normal
5589 ;; date stamps will catch the limits.
5590 (save-excursion
5591 (setq todo-state (org-get-todo-state))
5592 (setq donep (member todo-state org-done-keywords))
5593 (if (and donep org-agenda-skip-timestamp-if-done)
5594 (throw :skip t))
5595 (setq marker (org-agenda-new-marker (point)))
5596 (setq category (org-get-category)
5597 org-category-pos (get-text-property (point) 'org-category-position))
5598 (if (not (re-search-backward org-outline-regexp-bol nil t))
5599 (setq txt org-agenda-no-heading-message)
5600 (goto-char (match-beginning 0))
5601 (setq hdmarker (org-agenda-new-marker (point)))
5602 (setq tags (org-get-tags-at))
5603 (looking-at "\\*+[ \t]+\\([^\r\n]+\\)")
5604 (setq head (match-string 1))
5605 (let ((remove-re
5606 (if org-agenda-remove-timeranges-from-blocks
5607 (concat
5608 "<" (regexp-quote s1) ".*?>"
5609 "--"
5610 "<" (regexp-quote s2) ".*?>")
5611 nil)))
5612 (setq txt (org-agenda-format-item
5613 (format
5614 (nth (if (= d1 d2) 0 1)
5615 org-agenda-timerange-leaders)
5616 (1+ (- d0 d1)) (1+ (- d2 d1)))
5617 head category tags
5618 (cond ((and (= d1 d0) (= d2 d0))
5619 (concat "<" start-time ">--<" end-time ">"))
5620 ((= d1 d0)
5621 (concat "<" start-time ">"))
5622 ((= d2 d0)
5623 (concat "<" end-time ">"))
5624 (t nil))
5625 remove-re))))
5626 (org-add-props txt props
5627 'org-marker marker 'org-hd-marker hdmarker
5628 'type "block" 'date date
5629 'todo-state todo-state
5630 'priority (org-get-priority txt) 'org-category category
5631 'org-category-position org-category-pos)
5632 (push txt ee))))
5633 (goto-char pos)))
5634 ;; Sort the entries by expiration date.
5635 (nreverse ee)))
5637 ;;; Agenda presentation and sorting
5639 (defvar org-prefix-has-time nil
5640 "A flag, set by `org-compile-prefix-format'.
5641 The flag is set if the currently compiled format contains a `%t'.")
5642 (defvar org-prefix-has-tag nil
5643 "A flag, set by `org-compile-prefix-format'.
5644 The flag is set if the currently compiled format contains a `%T'.")
5645 (defvar org-prefix-has-effort nil
5646 "A flag, set by `org-compile-prefix-format'.
5647 The flag is set if the currently compiled format contains a `%e'.")
5648 (defvar org-prefix-category-length nil
5649 "Used by `org-compile-prefix-format' to remember the category field width.")
5650 (defvar org-prefix-category-max-length nil
5651 "Used by `org-compile-prefix-format' to remember the category field width.")
5653 (defun org-agenda-get-category-icon (category)
5654 "Return an image for CATEGORY according to `org-agenda-category-icon-alist'."
5655 (dolist (entry org-agenda-category-icon-alist)
5656 (when (org-string-match-p (car entry) category)
5657 (if (listp (cadr entry))
5658 (return (cadr entry))
5659 (return (apply 'create-image (cdr entry)))))))
5661 (defun org-agenda-format-item (extra txt &optional category tags dotime
5662 remove-re habitp)
5663 "Format TXT to be inserted into the agenda buffer.
5664 In particular, it adds the prefix and corresponding text properties. EXTRA
5665 must be a string and replaces the `%s' specifier in the prefix format.
5666 CATEGORY (string, symbol or nil) may be used to overrule the default
5667 category taken from local variable or file name. It will replace the `%c'
5668 specifier in the format. DOTIME, when non-nil, indicates that a
5669 time-of-day should be extracted from TXT for sorting of this entry, and for
5670 the `%t' specifier in the format. When DOTIME is a string, this string is
5671 searched for a time before TXT is. TAGS can be the tags of the headline.
5672 Any match of REMOVE-RE will be removed from TXT."
5673 ;; We keep the org-prefix-* variable values along with a compiled
5674 ;; formatter, so that multiple agendas existing at the same time, do
5675 ;; not step on each other toes.
5677 ;; It was inconvenient to make these variables buffer local in
5678 ;; Agenda buffers, because this function expects to be called with
5679 ;; the buffer where item comes from being current, and not agenda
5680 ;; buffer
5681 (let* ((bindings (car org-prefix-format-compiled))
5682 (formatter (cadr org-prefix-format-compiled)))
5683 (loop for (var value) in bindings
5684 do (set var value))
5685 (save-match-data
5686 ;; Diary entries sometimes have extra whitespace at the beginning
5687 (if (string-match "^ +" txt) (setq txt (replace-match "" nil nil txt)))
5689 ;; Fix the tags part in txt
5690 (setq txt (org-agenda-fix-displayed-tags
5691 txt tags
5692 org-agenda-show-inherited-tags
5693 org-agenda-hide-tags-regexp))
5694 (let* ((category (or category
5695 (if (stringp org-category)
5696 org-category
5697 (and org-category (symbol-name org-category)))
5698 (if buffer-file-name
5699 (file-name-sans-extension
5700 (file-name-nondirectory buffer-file-name))
5701 "")))
5702 (category-icon (org-agenda-get-category-icon category))
5703 (category-icon (if category-icon
5704 (propertize " " 'display category-icon)
5705 ""))
5706 ;; time, tag, effort are needed for the eval of the prefix format
5707 (tag (if tags (nth (1- (length tags)) tags) ""))
5708 time effort neffort
5709 (ts (if dotime (concat
5710 (if (stringp dotime) dotime "")
5711 (and org-agenda-search-headline-for-time txt))))
5712 (time-of-day (and dotime (org-get-time-of-day ts)))
5713 stamp plain s0 s1 s2 rtn srp l
5714 duration thecategory)
5715 (and (eq major-mode 'org-mode) buffer-file-name
5716 (add-to-list 'org-agenda-contributing-files buffer-file-name))
5717 (when (and dotime time-of-day)
5718 ;; Extract starting and ending time and move them to prefix
5719 (when (or (setq stamp (string-match org-stamp-time-of-day-regexp ts))
5720 (setq plain (string-match org-plain-time-of-day-regexp ts)))
5721 (setq s0 (match-string 0 ts)
5722 srp (and stamp (match-end 3))
5723 s1 (match-string (if plain 1 2) ts)
5724 s2 (match-string (if plain 8 (if srp 4 6)) ts))
5726 ;; If the times are in TXT (not in DOTIMES), and the prefix will list
5727 ;; them, we might want to remove them there to avoid duplication.
5728 ;; The user can turn this off with a variable.
5729 (if (and org-prefix-has-time
5730 org-agenda-remove-times-when-in-prefix (or stamp plain)
5731 (string-match (concat (regexp-quote s0) " *") txt)
5732 (not (equal ?\] (string-to-char (substring txt (match-end 0)))))
5733 (if (eq org-agenda-remove-times-when-in-prefix 'beg)
5734 (= (match-beginning 0) 0)
5736 (setq txt (replace-match "" nil nil txt))))
5737 ;; Normalize the time(s) to 24 hour
5738 (if s1 (setq s1 (org-get-time-of-day s1 'string t)))
5739 (if s2 (setq s2 (org-get-time-of-day s2 'string t)))
5741 ;; Try to set s2 if s1 and `org-agenda-default-appointment-duration' are set
5742 (when (and s1 (not s2) org-agenda-default-appointment-duration)
5743 (setq s2
5744 (org-minutes-to-hh:mm-string
5745 (+ (org-hh:mm-string-to-minutes s1) org-agenda-default-appointment-duration))))
5747 ;; Compute the duration
5748 (when s2
5749 (setq duration (- (org-hh:mm-string-to-minutes s2)
5750 (org-hh:mm-string-to-minutes s1)))))
5752 (when (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
5753 txt)
5754 ;; Tags are in the string
5755 (if (or (eq org-agenda-remove-tags t)
5756 (and org-agenda-remove-tags
5757 org-prefix-has-tag))
5758 (setq txt (replace-match "" t t txt))
5759 (setq txt (replace-match
5760 (concat (make-string (max (- 50 (length txt)) 1) ?\ )
5761 (match-string 2 txt))
5762 t t txt))))
5763 (when (eq major-mode 'org-mode)
5764 (setq effort
5765 (condition-case nil
5766 (org-get-effort
5767 (or (get-text-property 0 'org-hd-marker txt)
5768 (get-text-property 0 'org-marker txt)))
5769 (error nil)))
5770 (when effort
5771 (setq neffort (org-duration-string-to-minutes effort)
5772 effort (setq effort (concat "[" effort "]")))))
5773 ;; prevent erroring out with %e format when there is no effort
5774 (or effort (setq effort ""))
5776 (when remove-re
5777 (while (string-match remove-re txt)
5778 (setq txt (replace-match "" t t txt))))
5780 ;; Set org-heading property on `txt' to mark the start of the
5781 ;; heading.
5782 (add-text-properties 0 (length txt) '(org-heading t) txt)
5784 ;; Prepare the variables needed in the eval of the compiled format
5785 (setq time (cond (s2 (concat
5786 (org-agenda-time-of-day-to-ampm-maybe s1)
5787 "-" (org-agenda-time-of-day-to-ampm-maybe s2)
5788 (if org-agenda-timegrid-use-ampm " ")))
5789 (s1 (concat
5790 (org-agenda-time-of-day-to-ampm-maybe s1)
5791 (if org-agenda-timegrid-use-ampm
5792 "........ "
5793 "......")))
5794 (t ""))
5795 extra (or (and (not habitp) extra) "")
5796 category (if (symbolp category) (symbol-name category) category)
5797 thecategory (copy-sequence category))
5798 (if (string-match org-bracket-link-regexp category)
5799 (progn
5800 (setq l (if (match-end 3)
5801 (- (match-end 3) (match-beginning 3))
5802 (- (match-end 1) (match-beginning 1))))
5803 (when (< l (or org-prefix-category-length 0))
5804 (setq category (copy-sequence category))
5805 (org-add-props category nil
5806 'extra-space (make-string
5807 (- org-prefix-category-length l 1) ?\ ))))
5808 (if (and org-prefix-category-max-length
5809 (>= (length category) org-prefix-category-max-length))
5810 (setq category (substring category 0 (1- org-prefix-category-max-length)))))
5811 ;; Evaluate the compiled format
5812 (setq rtn (concat (eval formatter) txt))
5814 ;; And finally add the text properties
5815 (remove-text-properties 0 (length rtn) '(line-prefix t wrap-prefix t) rtn)
5816 (org-add-props rtn nil
5817 'org-category (if thecategory (downcase thecategory) category)
5818 'tags (mapcar 'org-downcase-keep-props tags)
5819 'org-highest-priority org-highest-priority
5820 'org-lowest-priority org-lowest-priority
5821 'time-of-day time-of-day
5822 'duration duration
5823 'effort effort
5824 'effort-minutes neffort
5825 'txt txt
5826 'time time
5827 'extra extra
5828 'format org-prefix-format-compiled
5829 'dotime dotime)))))
5831 (defun org-agenda-fix-displayed-tags (txt tags add-inherited hide-re)
5832 "Remove tags string from TXT, and add a modified list of tags.
5833 The modified list may contain inherited tags, and tags matched by
5834 `org-agenda-hide-tags-regexp' will be removed."
5835 (when (or add-inherited hide-re)
5836 (if (string-match (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$") txt)
5837 (setq txt (substring txt 0 (match-beginning 0))))
5838 (setq tags
5839 (delq nil
5840 (mapcar (lambda (tg)
5841 (if (or (and hide-re (string-match hide-re tg))
5842 (and (not add-inherited)
5843 (get-text-property 0 'inherited tg)))
5845 tg))
5846 tags)))
5847 (when tags
5848 (let ((have-i (get-text-property 0 'inherited (car tags)))
5850 (setq txt (concat txt " :"
5851 (mapconcat
5852 (lambda (x)
5853 (setq i (get-text-property 0 'inherited x))
5854 (if (and have-i (not i))
5855 (progn
5856 (setq have-i nil)
5857 (concat ":" x))
5859 tags ":")
5860 (if have-i "::" ":"))))))
5861 txt)
5863 (defun org-downcase-keep-props (s)
5864 (let ((props (text-properties-at 0 s)))
5865 (setq s (downcase s))
5866 (add-text-properties 0 (length s) props s)
5869 (defvar org-agenda-sorting-strategy) ;; because the def is in a let form
5870 (defvar org-agenda-sorting-strategy-selected nil)
5872 (defun org-agenda-add-time-grid-maybe (list ndays todayp)
5873 (catch 'exit
5874 (cond ((not org-agenda-use-time-grid) (throw 'exit list))
5875 ((and todayp (member 'today (car org-agenda-time-grid))))
5876 ((and (= ndays 1) (member 'daily (car org-agenda-time-grid))))
5877 ((member 'weekly (car org-agenda-time-grid)))
5878 (t (throw 'exit list)))
5879 (let* ((have (delq nil (mapcar
5880 (lambda (x) (get-text-property 1 'time-of-day x))
5881 list)))
5882 (string (nth 1 org-agenda-time-grid))
5883 (gridtimes (nth 2 org-agenda-time-grid))
5884 (req (car org-agenda-time-grid))
5885 (remove (member 'remove-match req))
5886 new time)
5887 (if (and (member 'require-timed req) (not have))
5888 ;; don't show empty grid
5889 (throw 'exit list))
5890 (while (setq time (pop gridtimes))
5891 (unless (and remove (member time have))
5892 (setq time (replace-regexp-in-string " " "0" (format "%04s" time)))
5893 (push (org-agenda-format-item
5894 nil string "" nil
5895 (concat (substring time 0 -2) ":" (substring time -2)))
5896 new)
5897 (put-text-property
5898 2 (length (car new)) 'face 'org-time-grid (car new))))
5899 (when (and todayp org-agenda-show-current-time-in-grid)
5900 (push (org-agenda-format-item
5902 org-agenda-current-time-string
5903 "" nil
5904 (format-time-string "%H:%M "))
5905 new)
5906 (put-text-property
5907 2 (length (car new)) 'face 'org-agenda-current-time (car new)))
5909 (if (member 'time-up org-agenda-sorting-strategy-selected)
5910 (append new list)
5911 (append list new)))))
5913 (defun org-compile-prefix-format (key)
5914 "Compile the prefix format into a Lisp form that can be evaluated.
5915 The resulting form and associated variable bindings is returned
5916 and stored in the variable `org-prefix-format-compiled'."
5917 (setq org-prefix-has-time nil org-prefix-has-tag nil
5918 org-prefix-category-length nil
5919 org-prefix-has-effort nil)
5920 (let ((s (cond
5921 ((stringp org-agenda-prefix-format)
5922 org-agenda-prefix-format)
5923 ((assq key org-agenda-prefix-format)
5924 (cdr (assq key org-agenda-prefix-format)))
5925 (t " %-12:c%?-12t% s")))
5926 (start 0)
5927 varform vars var e c f opt)
5928 (while (string-match "%\\(\\?\\)?\\([-+]?[0-9.]*\\)\\([ .;,:!?=|/<>]?\\)\\([ctsei]\\|(.+)\\)"
5929 s start)
5930 (setq var (or (cdr (assoc (match-string 4 s)
5931 '(("c" . category) ("t" . time) ("s" . extra)
5932 ("i" . category-icon) ("T" . tag) ("e" . effort))))
5933 'eval)
5934 c (or (match-string 3 s) "")
5935 opt (match-beginning 1)
5936 start (1+ (match-beginning 0)))
5937 (if (equal var 'time) (setq org-prefix-has-time t))
5938 (if (equal var 'tag) (setq org-prefix-has-tag t))
5939 (if (equal var 'effort) (setq org-prefix-has-effort t))
5940 (setq f (concat "%" (match-string 2 s) "s"))
5941 (when (equal var 'category)
5942 (setq org-prefix-category-length
5943 (floor (abs (string-to-number (match-string 2 s)))))
5944 (setq org-prefix-category-max-length
5945 (let ((x (match-string 2 s)))
5946 (save-match-data
5947 (if (string-match "\\.[0-9]+" x)
5948 (string-to-number (substring (match-string 0 x) 1)))))))
5949 (if (eq var 'eval)
5950 (setq varform `(format ,f (org-eval ,(read (match-string 4 s)))))
5951 (if opt
5952 (setq varform
5953 `(if (equal "" ,var)
5955 (format ,f (if (equal "" ,var) "" (concat ,var ,c)))))
5956 (setq varform `(format ,f (if (equal ,var "") "" (concat ,var ,c (get-text-property 0 'extra-space ,var)))))))
5957 (setq s (replace-match "%s" t nil s))
5958 (push varform vars))
5959 (setq vars (nreverse vars))
5960 (with-current-buffer org-agenda-buffer
5961 (setq org-prefix-format-compiled
5962 (list
5963 `((org-prefix-has-time ,org-prefix-has-time)
5964 (org-prefix-has-tag ,org-prefix-has-tag)
5965 (org-prefix-category-length ,org-prefix-category-length)
5966 (org-prefix-has-effort ,org-prefix-has-effort))
5967 `(format ,s ,@vars))))))
5969 (defun org-set-sorting-strategy (key)
5970 (if (symbolp (car org-agenda-sorting-strategy))
5971 ;; the old format
5972 (setq org-agenda-sorting-strategy-selected org-agenda-sorting-strategy)
5973 (setq org-agenda-sorting-strategy-selected
5974 (or (cdr (assq key org-agenda-sorting-strategy))
5975 (cdr (assq 'agenda org-agenda-sorting-strategy))
5976 '(time-up category-keep priority-down)))))
5978 (defun org-get-time-of-day (s &optional string mod24)
5979 "Check string S for a time of day.
5980 If found, return it as a military time number between 0 and 2400.
5981 If not found, return nil.
5982 The optional STRING argument forces conversion into a 5 character wide string
5983 HH:MM."
5984 (save-match-data
5985 (when
5986 (or (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)\\([AaPp][Mm]\\)?\\> *" s)
5987 (string-match "\\<\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\([AaPp][Mm]\\)\\> *" s))
5988 (let* ((h (string-to-number (match-string 1 s)))
5989 (m (if (match-end 3) (string-to-number (match-string 3 s)) 0))
5990 (ampm (if (match-end 4) (downcase (match-string 4 s))))
5991 (am-p (equal ampm "am"))
5992 (h1 (cond ((not ampm) h)
5993 ((= h 12) (if am-p 0 12))
5994 (t (+ h (if am-p 0 12)))))
5995 (h2 (if (and string mod24 (not (and (= m 0) (= h1 24))))
5996 (mod h1 24) h1))
5997 (t0 (+ (* 100 h2) m))
5998 (t1 (concat (if (>= h1 24) "+" " ")
5999 (if (and org-agenda-time-leading-zero
6000 (< t0 1000)) "0" "")
6001 (if (< t0 100) "0" "")
6002 (if (< t0 10) "0" "")
6003 (int-to-string t0))))
6004 (if string (concat (substring t1 -4 -2) ":" (substring t1 -2)) t0)))))
6006 (defvar org-agenda-before-sorting-filter-function nil
6007 "Function to be applied to agenda items prior to sorting.
6008 Prior to sorting also means just before they are inserted into the agenda.
6010 To aid sorting, you may revisit the original entries and add more text
6011 properties which will later be used by the sorting functions.
6013 The function should take a string argument, an agenda line.
6014 It has access to the text properties in that line, which contain among
6015 other things, the property `org-hd-marker' that points to the entry
6016 where the line comes from. Note that not all lines going into the agenda
6017 have this property, only most.
6019 The function should return the modified string. It is probably best
6020 to ONLY change text properties.
6022 You can also use this function as a filter, by returning nil for lines
6023 you don't want to have in the agenda at all. For this application, you
6024 could bind the variable in the options section of a custom command.")
6026 (defun org-finalize-agenda-entries (list &optional nosort)
6027 "Sort and concatenate the agenda items."
6028 (setq list (mapcar 'org-agenda-highlight-todo list))
6029 (if nosort
6030 list
6031 (when org-agenda-before-sorting-filter-function
6032 (setq list (delq nil (mapcar org-agenda-before-sorting-filter-function list))))
6033 (mapconcat 'identity (sort list 'org-entries-lessp) "\n")))
6035 (defun org-agenda-highlight-todo (x)
6036 (let ((org-done-keywords org-done-keywords-for-agenda)
6037 (case-fold-search nil)
6039 (if (eq x 'line)
6040 (save-excursion
6041 (beginning-of-line 1)
6042 (setq re (org-get-at-bol 'org-todo-regexp))
6043 (goto-char (or (text-property-any (point-at-bol) (point-at-eol) 'org-heading t) (point)))
6044 (when (looking-at (concat "[ \t]*\\.*\\(" re "\\) +"))
6045 (add-text-properties (match-beginning 0) (match-end 1)
6046 (list 'face (org-get-todo-face 1)))
6047 (let ((s (buffer-substring (match-beginning 1) (match-end 1))))
6048 (delete-region (match-beginning 1) (1- (match-end 0)))
6049 (goto-char (match-beginning 1))
6050 (insert (format org-agenda-todo-keyword-format s)))))
6051 (let ((pl (text-property-any 0 (length x) 'org-heading t x)))
6052 (setq re (get-text-property 0 'org-todo-regexp x))
6053 (when (and re
6054 ;; Test `pl' because if there's no heading content,
6055 ;; there's no point matching to highlight. Note
6056 ;; that if we didn't test `pl' first, and there
6057 ;; happened to be no keyword from `org-todo-regexp'
6058 ;; on this heading line, then the `equal' comparison
6059 ;; afterwards would spuriously succeed in the case
6060 ;; where `pl' is nil -- causing an args-out-of-range
6061 ;; error when we try to add text properties to text
6062 ;; that isn't there.
6064 (equal (string-match (concat "\\(\\.*\\)" re "\\( +\\)")
6065 x pl) pl))
6066 (add-text-properties
6067 (or (match-end 1) (match-end 0)) (match-end 0)
6068 (list 'face (org-get-todo-face (match-string 2 x)))
6070 (when (match-end 1)
6071 (setq x (concat (substring x 0 (match-end 1))
6072 (format org-agenda-todo-keyword-format
6073 (match-string 2 x))
6074 (org-add-props " " (text-properties-at 0 x))
6075 (substring x (match-end 3)))))))
6076 x)))
6078 (defsubst org-cmp-priority (a b)
6079 "Compare the priorities of string A and B."
6080 (let ((pa (or (get-text-property 1 'priority a) 0))
6081 (pb (or (get-text-property 1 'priority b) 0)))
6082 (cond ((> pa pb) +1)
6083 ((< pa pb) -1)
6084 (t nil))))
6086 (defsubst org-cmp-effort (a b)
6087 "Compare the effort values of string A and B."
6088 (let* ((def (if org-sort-agenda-noeffort-is-high 32767 -1))
6089 (ea (or (get-text-property 1 'effort-minutes a) def))
6090 (eb (or (get-text-property 1 'effort-minutes b) def)))
6091 (cond ((> ea eb) +1)
6092 ((< ea eb) -1)
6093 (t nil))))
6095 (defsubst org-cmp-category (a b)
6096 "Compare the string values of categories of strings A and B."
6097 (let ((ca (or (get-text-property 1 'org-category a) ""))
6098 (cb (or (get-text-property 1 'org-category b) "")))
6099 (cond ((string-lessp ca cb) -1)
6100 ((string-lessp cb ca) +1)
6101 (t nil))))
6103 (defsubst org-cmp-todo-state (a b)
6104 "Compare the todo states of strings A and B."
6105 (let* ((ma (or (get-text-property 1 'org-marker a)
6106 (get-text-property 1 'org-hd-marker a)))
6107 (mb (or (get-text-property 1 'org-marker b)
6108 (get-text-property 1 'org-hd-marker b)))
6109 (fa (and ma (marker-buffer ma)))
6110 (fb (and mb (marker-buffer mb)))
6111 (todo-kwds
6112 (or (and fa (with-current-buffer fa org-todo-keywords-1))
6113 (and fb (with-current-buffer fb org-todo-keywords-1))))
6114 (ta (or (get-text-property 1 'todo-state a) ""))
6115 (tb (or (get-text-property 1 'todo-state b) ""))
6116 (la (- (length (member ta todo-kwds))))
6117 (lb (- (length (member tb todo-kwds))))
6118 (donepa (member ta org-done-keywords-for-agenda))
6119 (donepb (member tb org-done-keywords-for-agenda)))
6120 (cond ((and donepa (not donepb)) -1)
6121 ((and (not donepa) donepb) +1)
6122 ((< la lb) -1)
6123 ((< lb la) +1)
6124 (t nil))))
6126 (defsubst org-cmp-alpha (a b)
6127 "Compare the headlines, alphabetically."
6128 (let* ((pla (text-property-any 0 (length a) 'org-heading t a))
6129 (plb (text-property-any 0 (length b) 'org-heading t b))
6130 (ta (and pla (substring a pla)))
6131 (tb (and plb (substring b plb))))
6132 (when pla
6133 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp a) "")
6134 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") ta)
6135 (setq ta (substring ta (match-end 0))))
6136 (setq ta (downcase ta)))
6137 (when plb
6138 (if (string-match (concat "\\`[ \t]*" (or (get-text-property 0 'org-todo-regexp b) "")
6139 "\\([ \t]*\\[[a-zA-Z0-9]\\]\\)? *") tb)
6140 (setq tb (substring tb (match-end 0))))
6141 (setq tb (downcase tb)))
6142 (cond ((not ta) +1)
6143 ((not tb) -1)
6144 ((string-lessp ta tb) -1)
6145 ((string-lessp tb ta) +1)
6146 (t nil))))
6148 (defsubst org-cmp-tag (a b)
6149 "Compare the string values of the first tags of A and B."
6150 (let ((ta (car (last (get-text-property 1 'tags a))))
6151 (tb (car (last (get-text-property 1 'tags b)))))
6152 (cond ((not ta) +1)
6153 ((not tb) -1)
6154 ((string-lessp ta tb) -1)
6155 ((string-lessp tb ta) +1)
6156 (t nil))))
6158 (defsubst org-cmp-time (a b)
6159 "Compare the time-of-day values of strings A and B."
6160 (let* ((def (if org-sort-agenda-notime-is-late 9901 -1))
6161 (ta (or (get-text-property 1 'time-of-day a) def))
6162 (tb (or (get-text-property 1 'time-of-day b) def)))
6163 (cond ((< ta tb) -1)
6164 ((< tb ta) +1)
6165 (t nil))))
6167 (defsubst org-cmp-habit-p (a b)
6168 "Compare the todo states of strings A and B."
6169 (let ((ha (get-text-property 1 'org-habit-p a))
6170 (hb (get-text-property 1 'org-habit-p b)))
6171 (cond ((and ha (not hb)) -1)
6172 ((and (not ha) hb) +1)
6173 (t nil))))
6175 (defsubst org-em (x y list) (or (memq x list) (memq y list)))
6177 (defun org-entries-lessp (a b)
6178 "Predicate for sorting agenda entries."
6179 ;; The following variables will be used when the form is evaluated.
6180 ;; So even though the compiler complains, keep them.
6181 (let* ((ss org-agenda-sorting-strategy-selected)
6182 (time-up (and (org-em 'time-up 'time-down ss)
6183 (org-cmp-time a b)))
6184 (time-down (if time-up (- time-up) nil))
6185 (priority-up (and (org-em 'priority-up 'priority-down ss)
6186 (org-cmp-priority a b)))
6187 (priority-down (if priority-up (- priority-up) nil))
6188 (effort-up (and (org-em 'effort-up 'effort-down ss)
6189 (org-cmp-effort a b)))
6190 (effort-down (if effort-up (- effort-up) nil))
6191 (category-up (and (or (org-em 'category-up 'category-down ss)
6192 (memq 'category-keep ss))
6193 (org-cmp-category a b)))
6194 (category-down (if category-up (- category-up) nil))
6195 (category-keep (if category-up +1 nil))
6196 (tag-up (and (org-em 'tag-up 'tag-down ss)
6197 (org-cmp-tag a b)))
6198 (tag-down (if tag-up (- tag-up) nil))
6199 (todo-state-up (and (org-em 'todo-state-up 'todo-state-down ss)
6200 (org-cmp-todo-state a b)))
6201 (todo-state-down (if todo-state-up (- todo-state-up) nil))
6202 (habit-up (and (org-em 'habit-up 'habit-down ss)
6203 (org-cmp-habit-p a b)))
6204 (habit-down (if habit-up (- habit-up) nil))
6205 (alpha-up (and (org-em 'alpha-up 'alpha-down ss)
6206 (org-cmp-alpha a b)))
6207 (alpha-down (if alpha-up (- alpha-up) nil))
6208 (need-user-cmp (org-em 'user-defined-up 'user-defined-down ss))
6209 user-defined-up user-defined-down)
6210 (if (and need-user-cmp org-agenda-cmp-user-defined
6211 (functionp org-agenda-cmp-user-defined))
6212 (setq user-defined-up
6213 (funcall org-agenda-cmp-user-defined a b)
6214 user-defined-down (if user-defined-up (- user-defined-up) nil)))
6215 (cdr (assoc
6216 (eval (cons 'or org-agenda-sorting-strategy-selected))
6217 '((-1 . t) (1 . nil) (nil . nil))))))
6219 ;;; Agenda restriction lock
6221 (defvar org-agenda-restriction-lock-overlay (make-overlay 1 1)
6222 "Overlay to mark the headline to which agenda commands are restricted.")
6223 (overlay-put org-agenda-restriction-lock-overlay
6224 'face 'org-agenda-restriction-lock)
6225 (overlay-put org-agenda-restriction-lock-overlay
6226 'help-echo "Agendas are currently limited to this subtree.")
6227 (org-detach-overlay org-agenda-restriction-lock-overlay)
6229 (defun org-agenda-set-restriction-lock (&optional type)
6230 "Set restriction lock for agenda, to current subtree or file.
6231 Restriction will be the file if TYPE is `file', or if type is the
6232 universal prefix '(4), or if the cursor is before the first headline
6233 in the file. Otherwise, restriction will be to the current subtree."
6234 (interactive "P")
6235 (and (equal type '(4)) (setq type 'file))
6236 (setq type (cond
6237 (type type)
6238 ((org-at-heading-p) 'subtree)
6239 ((condition-case nil (org-back-to-heading t) (error nil))
6240 'subtree)
6241 (t 'file)))
6242 (if (eq type 'subtree)
6243 (progn
6244 (setq org-agenda-restrict t)
6245 (setq org-agenda-overriding-restriction 'subtree)
6246 (put 'org-agenda-files 'org-restrict
6247 (list (buffer-file-name (buffer-base-buffer))))
6248 (org-back-to-heading t)
6249 (move-overlay org-agenda-restriction-lock-overlay (point) (point-at-eol))
6250 (move-marker org-agenda-restrict-begin (point))
6251 (move-marker org-agenda-restrict-end
6252 (save-excursion (org-end-of-subtree t)))
6253 (message "Locking agenda restriction to subtree"))
6254 (put 'org-agenda-files 'org-restrict
6255 (list (buffer-file-name (buffer-base-buffer))))
6256 (setq org-agenda-restrict nil)
6257 (setq org-agenda-overriding-restriction 'file)
6258 (move-marker org-agenda-restrict-begin nil)
6259 (move-marker org-agenda-restrict-end nil)
6260 (message "Locking agenda restriction to file"))
6261 (setq current-prefix-arg nil)
6262 (org-agenda-maybe-redo))
6264 (defun org-agenda-remove-restriction-lock (&optional noupdate)
6265 "Remove the agenda restriction lock."
6266 (interactive "P")
6267 (org-detach-overlay org-agenda-restriction-lock-overlay)
6268 (org-detach-overlay org-speedbar-restriction-lock-overlay)
6269 (setq org-agenda-overriding-restriction nil)
6270 (setq org-agenda-restrict nil)
6271 (put 'org-agenda-files 'org-restrict nil)
6272 (move-marker org-agenda-restrict-begin nil)
6273 (move-marker org-agenda-restrict-end nil)
6274 (setq current-prefix-arg nil)
6275 (message "Agenda restriction lock removed")
6276 (or noupdate (org-agenda-maybe-redo)))
6278 (defun org-agenda-maybe-redo ()
6279 "If there is any window showing the agenda view, update it."
6280 (let ((w (get-buffer-window org-agenda-buffer-name t))
6281 (w0 (selected-window)))
6282 (when w
6283 (select-window w)
6284 (org-agenda-redo)
6285 (select-window w0)
6286 (if org-agenda-overriding-restriction
6287 (message "Agenda view shifted to new %s restriction"
6288 org-agenda-overriding-restriction)
6289 (message "Agenda restriction lock removed")))))
6291 ;;; Agenda commands
6293 (defun org-agenda-check-type (error &rest types)
6294 "Check if agenda buffer is of allowed type.
6295 If ERROR is non-nil, throw an error, otherwise just return nil."
6296 (if (memq org-agenda-type types)
6298 (if error
6299 (error "Not allowed in %s-type agenda buffers" org-agenda-type)
6300 nil)))
6302 (defun org-agenda-Quit (&optional arg)
6303 "Exit agenda by removing the window or the buffer"
6304 (interactive)
6305 (if org-agenda-columns-active
6306 (org-columns-quit)
6307 (let ((buf (current-buffer)))
6308 (if (eq org-agenda-window-setup 'other-frame)
6309 (progn
6310 (org-agenda-reset-markers)
6311 (kill-buffer buf)
6312 (org-columns-remove-overlays)
6313 (setq org-agenda-archives-mode nil)
6314 (delete-frame))
6315 (and (not (eq org-agenda-window-setup 'current-window))
6316 (not (one-window-p))
6317 (delete-window))
6318 (org-agenda-reset-markers)
6319 (kill-buffer buf)
6320 (org-columns-remove-overlays)
6321 (setq org-agenda-archives-mode nil)))
6322 ;; Maybe restore the pre-agenda window configuration.
6323 (and org-agenda-restore-windows-after-quit
6324 (not (eq org-agenda-window-setup 'other-frame))
6325 org-pre-agenda-window-conf
6326 (set-window-configuration org-pre-agenda-window-conf))))
6328 (defun org-agenda-quit ()
6329 "Exit agenda by killing agenda buffer or burying it when
6330 `org-agenda-sticky' is non-NIL"
6331 (interactive)
6332 (if org-agenda-columns-active
6333 (org-columns-quit)
6334 (if org-agenda-sticky
6335 (let ((buf (current-buffer)))
6336 (if (eq org-agenda-window-setup 'other-frame)
6337 (progn
6338 (delete-frame))
6339 (and (not (eq org-agenda-window-setup 'current-window))
6340 (not (one-window-p))
6341 (delete-window)))
6342 (with-current-buffer buf
6343 (bury-buffer)))
6344 (org-agenda-Quit))))
6346 (defun org-agenda-exit ()
6347 "Exit agenda by removing the window or the buffer.
6348 Also kill all Org-mode buffers which have been loaded by `org-agenda'.
6349 Org-mode buffers visited directly by the user will not be touched."
6350 (interactive)
6351 (org-release-buffers org-agenda-new-buffers)
6352 (setq org-agenda-new-buffers nil)
6353 (org-agenda-Quit))
6355 (defun org-agenda-kill-all-agenda-buffers ()
6356 "Kill all buffers in `org-agena-mode'.
6357 This is used when toggling sticky agendas. You can also explicitly invoke it
6358 with `C-c a C-k'."
6359 (interactive)
6360 (let (blist)
6361 (dolist (buf (buffer-list))
6362 (when (with-current-buffer buf (eq major-mode 'org-agenda-mode))
6363 (push buf blist)))
6364 (mapc 'kill-buffer blist)))
6366 (defun org-agenda-execute (arg)
6367 "Execute another agenda command, keeping same window.
6368 So this is just a shortcut for \\<global-map>`\\[org-agenda]', available
6369 in the agenda."
6370 (interactive "P")
6371 (let ((org-agenda-window-setup 'current-window))
6372 (org-agenda arg)))
6374 (defun org-agenda-redo ()
6375 "Rebuild Agenda.
6376 When this is the global TODO list, a prefix argument will be interpreted."
6377 (interactive)
6378 (let* ((org-agenda-doing-sticky-redo org-agenda-sticky)
6379 (org-agenda-sticky nil)
6380 (org-agenda-buffer-name (or org-agenda-this-buffer-name
6381 org-agenda-buffer-name))
6382 (org-agenda-keep-modes t)
6383 (tag-filter org-agenda-tag-filter)
6384 (tag-preset (get 'org-agenda-tag-filter :preset-filter))
6385 (cat-filter org-agenda-category-filter)
6386 (cat-preset (get 'org-agenda-category-filter :preset-filter))
6387 (org-agenda-tag-filter-while-redo (or tag-filter tag-preset))
6388 (cols org-agenda-columns-active)
6389 (line (org-current-line))
6390 (window-line (- line (org-current-line (window-start))))
6391 (lprops (get 'org-agenda-redo-command 'org-lprops)))
6392 (put 'org-agenda-tag-filter :preset-filter nil)
6393 (put 'org-agenda-category-filter :preset-filter nil)
6394 (and cols (org-columns-quit))
6395 (message "Rebuilding agenda buffer...")
6396 (org-let lprops '(eval org-agenda-redo-command))
6397 (setq org-agenda-undo-list nil
6398 org-agenda-pending-undo-list nil)
6399 (message "Rebuilding agenda buffer...done")
6400 (put 'org-agenda-tag-filter :preset-filter tag-preset)
6401 (put 'org-agenda-category-filter :preset-filter cat-preset)
6402 (and (or tag-filter tag-preset) (org-agenda-filter-apply tag-filter 'tag))
6403 (and (or cat-filter cat-preset) (org-agenda-filter-apply cat-filter 'category))
6404 (and cols (org-called-interactively-p 'any) (org-agenda-columns))
6405 (org-goto-line line)
6406 (recenter window-line)))
6408 (defvar org-global-tags-completion-table nil)
6409 (defvar org-agenda-filtered-by-category nil)
6410 (defvar org-agenda-filter-form nil)
6412 (defun org-agenda-filter-by-category (strip)
6413 "Keep only those lines in the agenda buffer that have a specific category.
6414 The category is that of the current line."
6415 (interactive "P")
6416 (if org-agenda-filtered-by-category
6417 (org-agenda-filter-show-all-cat)
6418 (let ((cat (org-no-properties (get-text-property (point) 'org-category))))
6419 (if cat (org-agenda-filter-apply
6420 (list (concat (if strip "-" "+") cat)) 'category)
6421 (error "No category at point")))))
6423 (defun org-agenda-filter-by-tag (strip &optional char narrow)
6424 "Keep only those lines in the agenda buffer that have a specific tag.
6425 The tag is selected with its fast selection letter, as configured.
6426 With prefix argument STRIP, remove all lines that do have the tag.
6427 A lisp caller can specify CHAR. NARROW means that the new tag should be
6428 used to narrow the search - the interactive user can also press `-' or `+'
6429 to switch to narrowing."
6430 (interactive "P")
6431 (let* ((alist org-tag-alist-for-agenda)
6432 (tag-chars (mapconcat
6433 (lambda (x) (if (and (not (symbolp (car x)))
6434 (cdr x))
6435 (char-to-string (cdr x))
6436 ""))
6437 alist ""))
6438 (efforts (org-split-string
6439 (or (cdr (assoc (concat org-effort-property "_ALL")
6440 org-global-properties))
6441 "0 0:10 0:30 1:00 2:00 3:00 4:00 5:00 6:00 7:00 8:00"
6442 "")))
6443 (effort-op org-agenda-filter-effort-default-operator)
6444 (effort-prompt "")
6445 (inhibit-read-only t)
6446 (current org-agenda-tag-filter)
6447 maybe-refresh a n tag)
6448 (unless char
6449 (message
6450 "%s by tag [%s ], [TAB], %s[/]:off, [+-]:narrow, [>=<?]:effort: "
6451 (if narrow "Narrow" "Filter") tag-chars
6452 (if org-agenda-auto-exclude-function "[RET], " ""))
6453 (setq char (read-char-exclusive)))
6454 (when (member char '(?+ ?-))
6455 ;; Narrowing down
6456 (cond ((equal char ?-) (setq strip t narrow t))
6457 ((equal char ?+) (setq strip nil narrow t)))
6458 (message
6459 "Narrow by tag [%s ], [TAB], [/]:off, [>=<]:effort: " tag-chars)
6460 (setq char (read-char-exclusive)))
6461 (when (member char '(?< ?> ?= ??))
6462 ;; An effort operator
6463 (setq effort-op (char-to-string char))
6464 (setq alist nil) ; to make sure it will be interpreted as effort.
6465 (unless (equal char ??)
6466 (loop for i from 0 to 9 do
6467 (setq effort-prompt
6468 (concat
6469 effort-prompt " ["
6470 (if (= i 9) "0" (int-to-string (1+ i)))
6471 "]" (nth i efforts))))
6472 (message "Effort%s: %s " effort-op effort-prompt)
6473 (setq char (read-char-exclusive))
6474 (when (or (< char ?0) (> char ?9))
6475 (error "Need 1-9,0 to select effort"))))
6476 (when (equal char ?\t)
6477 (unless (local-variable-p 'org-global-tags-completion-table (current-buffer))
6478 (org-set-local 'org-global-tags-completion-table
6479 (org-global-tags-completion-table)))
6480 (let ((completion-ignore-case t))
6481 (setq tag (org-icompleting-read
6482 "Tag: " org-global-tags-completion-table))))
6483 (cond
6484 ((equal char ?\r)
6485 (org-agenda-filter-show-all-tag)
6486 (when org-agenda-auto-exclude-function
6487 (setq org-agenda-tag-filter '())
6488 (dolist (tag (org-agenda-get-represented-tags))
6489 (let ((modifier (funcall org-agenda-auto-exclude-function tag)))
6490 (if modifier
6491 (push modifier org-agenda-tag-filter))))
6492 (if (not (null org-agenda-tag-filter))
6493 (org-agenda-filter-apply org-agenda-tag-filter 'tag)))
6494 (setq maybe-refresh t))
6495 ((equal char ?/)
6496 (org-agenda-filter-show-all-tag)
6497 (when (get 'org-agenda-tag-filter :preset-filter)
6498 (org-agenda-filter-apply org-agenda-tag-filter 'tag))
6499 (setq maybe-refresh t))
6500 ((equal char ?. )
6501 (setq org-agenda-tag-filter
6502 (mapcar (lambda(tag) (concat "+" tag))
6503 (org-get-at-bol 'tags)))
6504 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6505 (setq maybe-refresh t))
6506 ((or (equal char ?\ )
6507 (setq a (rassoc char alist))
6508 (and (>= char ?0) (<= char ?9)
6509 (setq n (if (= char ?0) 9 (- char ?0 1))
6510 tag (concat effort-op (nth n efforts))
6511 a (cons tag nil)))
6512 (and (= char ??)
6513 (setq tag "?eff")
6514 a (cons tag nil))
6515 (and tag (setq a (cons tag nil))))
6516 (org-agenda-filter-show-all-tag)
6517 (setq tag (car a))
6518 (setq org-agenda-tag-filter
6519 (cons (concat (if strip "-" "+") tag)
6520 (if narrow current nil)))
6521 (org-agenda-filter-apply org-agenda-tag-filter 'tag)
6522 (setq maybe-refresh t))
6523 (t (error "Invalid tag selection character %c" char)))
6524 (when (and maybe-refresh
6525 (eq org-agenda-clockreport-mode 'with-filter))
6526 (org-agenda-redo))))
6528 (defun org-agenda-get-represented-tags ()
6529 "Get a list of all tags currently represented in the agenda."
6530 (let (p tags)
6531 (save-excursion
6532 (goto-char (point-min))
6533 (while (setq p (next-single-property-change (point) 'tags))
6534 (goto-char p)
6535 (mapc (lambda (x) (add-to-list 'tags x))
6536 (get-text-property (point) 'tags))))
6537 tags))
6539 (defun org-agenda-filter-by-tag-refine (strip &optional char)
6540 "Refine the current filter. See `org-agenda-filter-by-tag'."
6541 (interactive "P")
6542 (org-agenda-filter-by-tag strip char 'refine))
6544 (defun org-agenda-filter-make-matcher ()
6545 "Create the form that tests a line for agenda filter."
6546 (let (f f1)
6547 ;; first compute the tag-filter matcher
6548 (dolist (x (delete-dups
6549 (append (get 'org-agenda-tag-filter
6550 :preset-filter) org-agenda-tag-filter)))
6551 (if (member x '("-" "+"))
6552 (setq f1 (if (equal x "-") 'tags '(not tags)))
6553 (if (string-match "[<=>?]" x)
6554 (setq f1 (org-agenda-filter-effort-form x))
6555 (setq f1 (list 'member (downcase (substring x 1)) 'tags)))
6556 (if (equal (string-to-char x) ?-)
6557 (setq f1 (list 'not f1))))
6558 (push f1 f))
6559 ;; then compute the category-filter matcher
6560 (dolist (x (delete-dups
6561 (append (get 'org-agenda-category-filter
6562 :preset-filter) org-agenda-category-filter)))
6563 (setq f1 (list 'equal (substring x 1) 'cat))
6564 (push f1 f))
6565 (cons 'and (nreverse f))))
6567 (defun org-agenda-filter-effort-form (e)
6568 "Return the form to compare the effort of the current line with what E says.
6569 E looks like \"+<2:25\"."
6570 (let (op)
6571 (setq e (substring e 1))
6572 (setq op (string-to-char e) e (substring e 1))
6573 (setq op (cond ((equal op ?<) '<=)
6574 ((equal op ?>) '>=)
6575 ((equal op ??) op)
6576 (t '=)))
6577 (list 'org-agenda-compare-effort (list 'quote op)
6578 (org-duration-string-to-minutes e))))
6580 (defun org-agenda-compare-effort (op value)
6581 "Compare the effort of the current line with VALUE, using OP.
6582 If the line does not have an effort defined, return nil."
6583 (let ((eff (org-get-at-bol 'effort-minutes)))
6584 (if (equal op ??)
6585 (not eff)
6586 (funcall op (or eff (if org-sort-agenda-noeffort-is-high 32767 0))
6587 value))))
6589 (defun org-agenda-filter-apply (filter type)
6590 "Set FILTER as the new agenda filter and apply it."
6591 (let (tags cat)
6592 (if (eq type 'tag)
6593 (setq org-agenda-tag-filter filter)
6594 (setq org-agenda-category-filter filter
6595 org-agenda-filtered-by-category t))
6596 (setq org-agenda-filter-form (org-agenda-filter-make-matcher))
6597 (org-agenda-set-mode-name)
6598 (save-excursion
6599 (goto-char (point-min))
6600 (while (not (eobp))
6601 (if (org-get-at-bol 'org-marker)
6602 (progn
6603 (setq tags (org-get-at-bol 'tags) ; used in eval
6604 cat (get-text-property (point) 'org-category))
6605 (if (not (eval org-agenda-filter-form))
6606 (org-agenda-filter-hide-line type))
6607 (beginning-of-line 2))
6608 (beginning-of-line 2))))
6609 (if (get-char-property (point) 'invisible)
6610 (org-agenda-previous-line))))
6612 (defun org-agenda-filter-hide-line (type)
6613 (let (ov)
6614 (setq ov (make-overlay (max (point-min) (1- (point-at-bol)))
6615 (point-at-eol)))
6616 (overlay-put ov 'invisible t)
6617 (overlay-put ov 'type type)
6618 (if (eq type 'tag)
6619 (push ov org-agenda-tag-filter-overlays)
6620 (push ov org-agenda-cat-filter-overlays))))
6622 (defun org-agenda-fix-tags-filter-overlays-at (&optional pos)
6623 (setq pos (or pos (point)))
6624 (save-excursion
6625 (dolist (ov (overlays-at pos))
6626 (when (and (overlay-get ov 'invisible)
6627 (eq (overlay-get ov 'type) 'tag))
6628 (goto-char pos)
6629 (if (< (overlay-start ov) (point-at-eol))
6630 (move-overlay ov (point-at-eol)
6631 (overlay-end ov)))))))
6633 (defun org-agenda-filter-show-all-tag nil
6634 (mapc 'delete-overlay org-agenda-tag-filter-overlays)
6635 (setq org-agenda-tag-filter-overlays nil
6636 org-agenda-tag-filter nil
6637 org-agenda-filter-form nil)
6638 (org-agenda-set-mode-name))
6640 (defun org-agenda-filter-show-all-cat nil
6641 (mapc 'delete-overlay org-agenda-cat-filter-overlays)
6642 (setq org-agenda-cat-filter-overlays nil
6643 org-agenda-filtered-by-category nil
6644 org-agenda-category-filter nil
6645 org-agenda-filter-form nil)
6646 (org-agenda-set-mode-name))
6648 (defun org-agenda-manipulate-query-add ()
6649 "Manipulate the query by adding a search term with positive selection.
6650 Positive selection means the term must be matched for selection of an entry."
6651 (interactive)
6652 (org-agenda-manipulate-query ?\[))
6653 (defun org-agenda-manipulate-query-subtract ()
6654 "Manipulate the query by adding a search term with negative selection.
6655 Negative selection means term must not be matched for selection of an entry."
6656 (interactive)
6657 (org-agenda-manipulate-query ?\]))
6658 (defun org-agenda-manipulate-query-add-re ()
6659 "Manipulate the query by adding a search regexp with positive selection.
6660 Positive selection means the regexp must match for selection of an entry."
6661 (interactive)
6662 (org-agenda-manipulate-query ?\{))
6663 (defun org-agenda-manipulate-query-subtract-re ()
6664 "Manipulate the query by adding a search regexp with negative selection.
6665 Negative selection means regexp must not match for selection of an entry."
6666 (interactive)
6667 (org-agenda-manipulate-query ?\}))
6668 (defun org-agenda-manipulate-query (char)
6669 (cond
6670 ((memq org-agenda-type '(timeline agenda))
6671 (let ((org-agenda-include-inactive-timestamps t))
6672 (org-agenda-redo))
6673 (message "Display now includes inactive timestamps as well"))
6674 ((eq org-agenda-type 'search)
6675 (org-add-to-string
6676 'org-agenda-query-string
6677 (if org-agenda-last-search-view-search-was-boolean
6678 (cdr (assoc char '((?\[ . " +") (?\] . " -")
6679 (?\{ . " +{}") (?\} . " -{}"))))
6680 " "))
6681 (setq org-agenda-redo-command
6682 (list 'org-search-view
6683 org-todo-only
6684 org-agenda-query-string
6685 (+ (length org-agenda-query-string)
6686 (if (member char '(?\{ ?\})) 0 1))))
6687 (set-register org-agenda-query-register org-agenda-query-string)
6688 (org-agenda-redo))
6689 (t (error "Cannot manipulate query for %s-type agenda buffers"
6690 org-agenda-type))))
6692 (defun org-add-to-string (var string)
6693 (set var (concat (symbol-value var) string)))
6695 (defun org-agenda-goto-date (date)
6696 "Jump to DATE in agenda."
6697 (interactive (list (let ((org-read-date-prefer-future
6698 (eval org-agenda-jump-prefer-future)))
6699 (org-read-date))))
6700 (org-agenda-list nil date))
6702 (defun org-agenda-goto-today ()
6703 "Go to today."
6704 (interactive)
6705 (org-agenda-check-type t 'timeline 'agenda)
6706 (let ((tdpos (text-property-any (point-min) (point-max) 'org-today t)))
6707 (cond
6708 (tdpos (goto-char tdpos))
6709 ((eq org-agenda-type 'agenda)
6710 (let* ((sd (org-agenda-compute-starting-span
6711 (org-today) (or org-agenda-current-span org-agenda-ndays org-agenda-span)))
6712 (org-agenda-overriding-arguments org-agenda-last-arguments))
6713 (setf (nth 1 org-agenda-overriding-arguments) sd)
6714 (org-agenda-redo)
6715 (org-agenda-find-same-or-today-or-agenda)))
6716 (t (error "Cannot find today")))))
6718 (defun org-agenda-find-same-or-today-or-agenda (&optional cnt)
6719 (goto-char
6720 (or (and cnt (text-property-any (point-min) (point-max) 'org-day-cnt cnt))
6721 (text-property-any (point-min) (point-max) 'org-today t)
6722 (text-property-any (point-min) (point-max) 'org-agenda-type 'agenda)
6723 (point-min))))
6725 (defun org-agenda-later (arg)
6726 "Go forward in time by thee current span.
6727 With prefix ARG, go forward that many times the current span."
6728 (interactive "p")
6729 (org-agenda-check-type t 'agenda)
6730 (let* ((span org-agenda-current-span)
6731 (sd org-starting-day)
6732 (greg (calendar-gregorian-from-absolute sd))
6733 (cnt (org-get-at-bol 'org-day-cnt))
6734 greg2)
6735 (cond
6736 ((eq span 'day)
6737 (setq sd (+ arg sd)))
6738 ((eq span 'week)
6739 (setq sd (+ (* 7 arg) sd)))
6740 ((eq span 'month)
6741 (setq greg2 (list (+ (car greg) arg) (nth 1 greg) (nth 2 greg))
6742 sd (calendar-absolute-from-gregorian greg2))
6743 (setcar greg2 (1+ (car greg2))))
6744 ((eq span 'year)
6745 (setq greg2 (list (car greg) (nth 1 greg) (+ arg (nth 2 greg)))
6746 sd (calendar-absolute-from-gregorian greg2))
6747 (setcar (nthcdr 2 greg2) (1+ (nth 2 greg2))))
6749 (setq sd (+ (* span arg) sd))))
6750 (let ((org-agenda-overriding-arguments
6751 (list (car org-agenda-last-arguments) sd span t)))
6752 (org-agenda-redo)
6753 (org-agenda-find-same-or-today-or-agenda cnt))))
6755 (defun org-agenda-earlier (arg)
6756 "Go backward in time by the current span.
6757 With prefix ARG, go backward that many times the current span."
6758 (interactive "p")
6759 (org-agenda-later (- arg)))
6761 (defun org-agenda-view-mode-dispatch ()
6762 "Call one of the view mode commands."
6763 (interactive)
6764 (message "View: [d]ay [w]eek [m]onth [y]ear [SPC]reset [q]uit/abort
6765 time[G]rid [[]inactive [f]ollow [l]og [L]og-all [c]lockcheck
6766 [a]rch-trees [A]rch-files clock[R]eport include[D]iary
6767 [E]ntryText")
6768 (let ((a (read-char-exclusive)))
6769 (case a
6770 (?\ (call-interactively 'org-agenda-reset-view))
6771 (?d (call-interactively 'org-agenda-day-view))
6772 (?w (call-interactively 'org-agenda-week-view))
6773 (?m (call-interactively 'org-agenda-month-view))
6774 (?y (call-interactively 'org-agenda-year-view))
6775 (?l (call-interactively 'org-agenda-log-mode))
6776 (?L (org-agenda-log-mode '(4)))
6777 (?c (org-agenda-log-mode 'clockcheck))
6778 ((?F ?f) (call-interactively 'org-agenda-follow-mode))
6779 (?a (call-interactively 'org-agenda-archives-mode))
6780 (?A (org-agenda-archives-mode 'files))
6781 ((?R ?r) (call-interactively 'org-agenda-clockreport-mode))
6782 ((?E ?e) (call-interactively 'org-agenda-entry-text-mode))
6783 (?G (call-interactively 'org-agenda-toggle-time-grid))
6784 (?D (call-interactively 'org-agenda-toggle-diary))
6785 (?\! (call-interactively 'org-agenda-toggle-deadlines))
6786 (?\[ (let ((org-agenda-include-inactive-timestamps t))
6787 (org-agenda-check-type t 'timeline 'agenda)
6788 (org-agenda-redo))
6789 (message "Display now includes inactive timestamps as well"))
6790 (?q (message "Abort"))
6791 (otherwise (error "Invalid key" )))))
6793 (defun org-agenda-reset-view ()
6794 "Switch to default view for agenda."
6795 (interactive)
6796 (org-agenda-change-time-span (or org-agenda-ndays org-agenda-span)))
6797 (defun org-agenda-day-view (&optional day-of-year)
6798 "Switch to daily view for agenda.
6799 With argument DAY-OF-YEAR, switch to that day of the year."
6800 (interactive "P")
6801 (org-agenda-change-time-span 'day day-of-year))
6802 (defun org-agenda-week-view (&optional iso-week)
6803 "Switch to daily view for agenda.
6804 With argument ISO-WEEK, switch to the corresponding ISO week.
6805 If ISO-WEEK has more then 2 digits, only the last two encode the
6806 week. Any digits before this encode a year. So 200712 means
6807 week 12 of year 2007. Years in the range 1938-2037 can also be
6808 written as 2-digit years."
6809 (interactive "P")
6810 (org-agenda-change-time-span 'week iso-week))
6811 (defun org-agenda-month-view (&optional month)
6812 "Switch to monthly view for agenda.
6813 With argument MONTH, switch to that month."
6814 (interactive "P")
6815 (org-agenda-change-time-span 'month month))
6816 (defun org-agenda-year-view (&optional year)
6817 "Switch to yearly view for agenda.
6818 With argument YEAR, switch to that year.
6819 If MONTH has more then 2 digits, only the last two encode the
6820 month. Any digits before this encode a year. So 200712 means
6821 December year 2007. Years in the range 1938-2037 can also be
6822 written as 2-digit years."
6823 (interactive "P")
6824 (when year
6825 (setq year (org-small-year-to-year year)))
6826 (if (y-or-n-p "Are you sure you want to compute the agenda for an entire year? ")
6827 (org-agenda-change-time-span 'year year)
6828 (error "Abort")))
6830 (defun org-agenda-change-time-span (span &optional n)
6831 "Change the agenda view to SPAN.
6832 SPAN may be `day', `week', `month', `year'."
6833 (org-agenda-check-type t 'agenda)
6834 (if (and (not n) (equal org-agenda-current-span span))
6835 (error "Viewing span is already \"%s\"" span))
6836 (let* ((sd (or (org-get-at-bol 'day)
6837 org-starting-day))
6838 (sd (org-agenda-compute-starting-span sd span n))
6839 (org-agenda-overriding-arguments
6840 (or org-agenda-overriding-arguments
6841 (list (car org-agenda-last-arguments) sd span t))))
6842 (org-agenda-redo)
6843 (org-agenda-find-same-or-today-or-agenda))
6844 (org-agenda-set-mode-name)
6845 (message "Switched to %s view" span))
6847 (defun org-agenda-compute-starting-span (sd span &optional n)
6848 "Compute starting date for agenda.
6849 SPAN may be `day', `week', `month', `year'. The return value
6850 is a cons cell with the starting date and the number of days,
6851 so that the date SD will be in that range."
6852 (let* ((greg (calendar-gregorian-from-absolute sd))
6853 (dg (nth 1 greg))
6854 (mg (car greg))
6855 (yg (nth 2 greg)))
6856 (cond
6857 ((eq span 'day)
6858 (when n
6859 (setq sd (+ (calendar-absolute-from-gregorian
6860 (list mg 1 yg))
6861 n -1))))
6862 ((eq span 'week)
6863 (let* ((nt (calendar-day-of-week
6864 (calendar-gregorian-from-absolute sd)))
6865 (d (if org-agenda-start-on-weekday
6866 (- nt org-agenda-start-on-weekday)
6869 (setq sd (- sd (+ (if (< d 0) 7 0) d)))
6870 (when n
6871 (require 'cal-iso)
6872 (when (> n 99)
6873 (setq y1 (org-small-year-to-year (/ n 100))
6874 n (mod n 100)))
6875 (setq sd
6876 (calendar-absolute-from-iso
6877 (list n 1
6878 (or y1 (nth 2 (calendar-iso-from-absolute sd)))))))))
6879 ((eq span 'month)
6880 (let (y1)
6881 (when (and n (> n 99))
6882 (setq y1 (org-small-year-to-year (/ n 100))
6883 n (mod n 100)))
6884 (setq sd (calendar-absolute-from-gregorian
6885 (list (or n mg) 1 (or y1 yg))))))
6886 ((eq span 'year)
6887 (setq sd (calendar-absolute-from-gregorian
6888 (list 1 1 (or n yg))))))
6889 sd))
6891 (defun org-agenda-next-date-line (&optional arg)
6892 "Jump to the next line indicating a date in agenda buffer."
6893 (interactive "p")
6894 (org-agenda-check-type t 'agenda 'timeline)
6895 (beginning-of-line 1)
6896 ;; This does not work if user makes date format that starts with a blank
6897 (if (looking-at "^\\S-") (forward-char 1))
6898 (if (not (re-search-forward "^\\S-" nil t arg))
6899 (progn
6900 (backward-char 1)
6901 (error "No next date after this line in this buffer")))
6902 (goto-char (match-beginning 0)))
6904 (defun org-agenda-previous-date-line (&optional arg)
6905 "Jump to the previous line indicating a date in agenda buffer."
6906 (interactive "p")
6907 (org-agenda-check-type t 'agenda 'timeline)
6908 (beginning-of-line 1)
6909 (if (not (re-search-backward "^\\S-" nil t arg))
6910 (error "No previous date before this line in this buffer")))
6912 ;; Initialize the highlight
6913 (defvar org-hl (make-overlay 1 1))
6914 (overlay-put org-hl 'face 'highlight)
6916 (defun org-highlight (begin end &optional buffer)
6917 "Highlight a region with overlay."
6918 (move-overlay org-hl begin end (or buffer (current-buffer))))
6920 (defun org-unhighlight ()
6921 "Detach overlay INDEX."
6922 (org-detach-overlay org-hl))
6924 ;; FIXME this is currently not used.
6925 (defun org-highlight-until-next-command (beg end &optional buffer)
6926 "Move the highlight overlay to BEG/END, remove it before the next command."
6927 (org-highlight beg end buffer)
6928 (add-hook 'pre-command-hook 'org-unhighlight-once))
6929 (defun org-unhighlight-once ()
6930 "Remove the highlight from its position, and this function from the hook."
6931 (remove-hook 'pre-command-hook 'org-unhighlight-once)
6932 (org-unhighlight))
6934 (defun org-agenda-follow-mode ()
6935 "Toggle follow mode in an agenda buffer."
6936 (interactive)
6937 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
6938 (org-agenda-set-mode-name)
6939 (org-agenda-do-context-action)
6940 (message "Follow mode is %s"
6941 (if org-agenda-follow-mode "on" "off")))
6943 (defun org-agenda-entry-text-mode (&optional arg)
6944 "Toggle entry text mode in an agenda buffer."
6945 (interactive "P")
6946 (setq org-agenda-entry-text-mode (or (integerp arg)
6947 (not org-agenda-entry-text-mode)))
6948 (org-agenda-entry-text-hide)
6949 (and org-agenda-entry-text-mode
6950 (let ((org-agenda-entry-text-maxlines
6951 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6952 (org-agenda-entry-text-show)))
6953 (org-agenda-set-mode-name)
6954 (message "Entry text mode is %s. Maximum number of lines is %d"
6955 (if org-agenda-entry-text-mode "on" "off")
6956 (if (integerp arg) arg org-agenda-entry-text-maxlines)))
6958 (defun org-agenda-clockreport-mode (&optional with-filter)
6959 "Toggle clocktable mode in an agenda buffer.
6960 With prefix arg WITH-FILTER, make the clocktable respect the current
6961 agenda filter."
6962 (interactive "P")
6963 (org-agenda-check-type t 'agenda)
6964 (if with-filter
6965 (setq org-agenda-clockreport-mode 'with-filter)
6966 (setq org-agenda-clockreport-mode (not org-agenda-clockreport-mode)))
6967 (org-agenda-set-mode-name)
6968 (org-agenda-redo)
6969 (message "Clocktable mode is %s"
6970 (if org-agenda-clockreport-mode "on" "off")))
6972 (defun org-agenda-log-mode (&optional special)
6973 "Toggle log mode in an agenda buffer.
6974 With argument SPECIAL, show all possible log items, not only the ones
6975 configured in `org-agenda-log-mode-items'.
6976 With a double `C-u' prefix arg, show *only* log items, nothing else."
6977 (interactive "P")
6978 (org-agenda-check-type t 'agenda 'timeline)
6979 (setq org-agenda-show-log
6980 (cond
6981 ((equal special '(16)) 'only)
6982 ((eq special 'clockcheck)
6983 (if (eq org-agenda-show-log 'clockcheck)
6984 nil 'clockcheck))
6985 (special '(closed clock state))
6986 (t (not org-agenda-show-log))))
6987 (org-agenda-set-mode-name)
6988 (org-agenda-redo)
6989 (message "Log mode is %s"
6990 (if org-agenda-show-log "on" "off")))
6992 (defun org-agenda-archives-mode (&optional with-files)
6993 "Toggle inclusion of items in trees marked with :ARCHIVE:.
6994 When called with a prefix argument, include all archive files as well."
6995 (interactive "P")
6996 (setq org-agenda-archives-mode
6997 (if with-files t (if org-agenda-archives-mode nil 'trees)))
6998 (org-agenda-set-mode-name)
6999 (org-agenda-redo)
7000 (message
7001 "%s"
7002 (cond
7003 ((eq org-agenda-archives-mode nil)
7004 "No archives are included")
7005 ((eq org-agenda-archives-mode 'trees)
7006 (format "Trees with :%s: tag are included" org-archive-tag))
7007 ((eq org-agenda-archives-mode t)
7008 (format "Trees with :%s: tag and all active archive files are included"
7009 org-archive-tag)))))
7011 (defun org-agenda-toggle-diary ()
7012 "Toggle diary inclusion in an agenda buffer."
7013 (interactive)
7014 (org-agenda-check-type t 'agenda)
7015 (setq org-agenda-include-diary (not org-agenda-include-diary))
7016 (org-agenda-redo)
7017 (org-agenda-set-mode-name)
7018 (message "Diary inclusion turned %s"
7019 (if org-agenda-include-diary "on" "off")))
7021 (defun org-agenda-toggle-deadlines ()
7022 "Toggle inclusion of entries with a deadline in an agenda buffer."
7023 (interactive)
7024 (org-agenda-check-type t 'agenda)
7025 (setq org-agenda-include-deadlines (not org-agenda-include-deadlines))
7026 (org-agenda-redo)
7027 (org-agenda-set-mode-name)
7028 (message "Deadlines inclusion turned %s"
7029 (if org-agenda-include-deadlines "on" "off")))
7031 (defun org-agenda-toggle-time-grid ()
7032 "Toggle time grid in an agenda buffer."
7033 (interactive)
7034 (org-agenda-check-type t 'agenda)
7035 (setq org-agenda-use-time-grid (not org-agenda-use-time-grid))
7036 (org-agenda-redo)
7037 (org-agenda-set-mode-name)
7038 (message "Time-grid turned %s"
7039 (if org-agenda-use-time-grid "on" "off")))
7041 (defun org-agenda-set-mode-name ()
7042 "Set the mode name to indicate all the small mode settings."
7043 (setq mode-name
7044 (list "Org-Agenda"
7045 (if (get 'org-agenda-files 'org-restrict) " []" "")
7047 '(:eval (org-agenda-span-name org-agenda-current-span))
7048 (if org-agenda-follow-mode " Follow" "")
7049 (if org-agenda-entry-text-mode " ETxt" "")
7050 (if org-agenda-include-diary " Diary" "")
7051 (if org-agenda-include-deadlines " Ddl" "")
7052 (if org-agenda-use-time-grid " Grid" "")
7053 (if (and (boundp 'org-habit-show-habits)
7054 org-habit-show-habits) " Habit" "")
7055 (cond
7056 ((consp org-agenda-show-log) " LogAll")
7057 ((eq org-agenda-show-log 'clockcheck) " ClkCk")
7058 (org-agenda-show-log " Log")
7059 (t ""))
7060 (if (or org-agenda-category-filter (get 'org-agenda-category-filter
7061 :preset-filter))
7062 '(:eval (org-propertize
7063 (concat " <"
7064 (mapconcat
7065 'identity
7066 (append
7067 (get 'org-agenda-category-filter :preset-filter)
7068 org-agenda-category-filter)
7070 ">")
7071 'face 'org-agenda-filter-category
7072 'help-echo "Category used in filtering"))
7074 (if (or org-agenda-tag-filter (get 'org-agenda-tag-filter
7075 :preset-filter))
7076 '(:eval (org-propertize
7077 (concat " {"
7078 (mapconcat
7079 'identity
7080 (append
7081 (get 'org-agenda-tag-filter :preset-filter)
7082 org-agenda-tag-filter)
7084 "}")
7085 'face 'org-agenda-filter-tags
7086 'help-echo "Tags used in filtering"))
7088 (if org-agenda-archives-mode
7089 (if (eq org-agenda-archives-mode t)
7090 " Archives"
7091 (format " :%s:" org-archive-tag))
7093 (if org-agenda-clockreport-mode
7094 (if (eq org-agenda-clockreport-mode 'with-filter)
7095 " Clock{}" " Clock")
7096 "")))
7097 (force-mode-line-update))
7099 (defun org-agenda-post-command-hook ()
7100 (setq org-agenda-type
7101 (or (get-text-property (point) 'org-agenda-type)
7102 (get-text-property (max (point-min) (1- (point)))
7103 'org-agenda-type))))
7105 (defun org-agenda-next-line ()
7106 "Move cursor to the next line, and show if follow mode is active."
7107 (interactive)
7108 (call-interactively 'next-line)
7109 (org-agenda-do-context-action))
7111 (defun org-agenda-previous-line ()
7112 "Move cursor to the previous line, and show if follow-mode is active."
7113 (interactive)
7114 (call-interactively 'previous-line)
7115 (org-agenda-do-context-action))
7117 (defun org-agenda-do-context-action ()
7118 "Show outline path and, maybe, follow mode window."
7119 (let ((m (org-get-at-bol 'org-marker)))
7120 (when (and (markerp m) (marker-buffer m))
7121 (and org-agenda-follow-mode
7122 (if org-agenda-follow-indirect
7123 (org-agenda-tree-to-indirect-buffer)
7124 (org-agenda-show)))
7125 (and org-agenda-show-outline-path
7126 (org-with-point-at m (org-display-outline-path t))))))
7128 (defun org-agenda-show-priority ()
7129 "Show the priority of the current item.
7130 This priority is composed of the main priority given with the [#A] cookies,
7131 and by additional input from the age of a schedules or deadline entry."
7132 (interactive)
7133 (let* ((pri (org-get-at-bol 'priority)))
7134 (message "Priority is %d" (if pri pri -1000))))
7136 (defun org-agenda-show-tags ()
7137 "Show the tags applicable to the current item."
7138 (interactive)
7139 (let* ((tags (org-get-at-bol 'tags)))
7140 (if tags
7141 (message "Tags are :%s:"
7142 (org-no-properties (mapconcat 'identity tags ":")))
7143 (message "No tags associated with this line"))))
7145 (defun org-agenda-goto (&optional highlight)
7146 "Go to the Org-mode file which contains the item at point."
7147 (interactive)
7148 (let* ((marker (or (org-get-at-bol 'org-marker)
7149 (org-agenda-error)))
7150 (buffer (marker-buffer marker))
7151 (pos (marker-position marker)))
7152 (switch-to-buffer-other-window buffer)
7153 (widen)
7154 (push-mark)
7155 (goto-char pos)
7156 (when (eq major-mode 'org-mode)
7157 (org-show-context 'agenda)
7158 (save-excursion
7159 (and (outline-next-heading)
7160 (org-flag-heading nil)))) ; show the next heading
7161 (when (outline-invisible-p)
7162 (show-entry)) ; display invisible text
7163 (recenter (/ (window-height) 2))
7164 (run-hooks 'org-agenda-after-show-hook)
7165 (and highlight (org-highlight (point-at-bol) (point-at-eol)))))
7167 (defvar org-agenda-after-show-hook nil
7168 "Normal hook run after an item has been shown from the agenda.
7169 Point is in the buffer where the item originated.")
7171 (defun org-agenda-kill ()
7172 "Kill the entry or subtree belonging to the current agenda entry."
7173 (interactive)
7174 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7175 (let* ((marker (or (org-get-at-bol 'org-marker)
7176 (org-agenda-error)))
7177 (buffer (marker-buffer marker))
7178 (pos (marker-position marker))
7179 (type (org-get-at-bol 'type))
7180 dbeg dend (n 0) conf)
7181 (org-with-remote-undo buffer
7182 (with-current-buffer buffer
7183 (save-excursion
7184 (goto-char pos)
7185 (if (and (eq major-mode 'org-mode) (not (member type '("sexp"))))
7186 (setq dbeg (progn (org-back-to-heading t) (point))
7187 dend (org-end-of-subtree t t))
7188 (setq dbeg (point-at-bol)
7189 dend (min (point-max) (1+ (point-at-eol)))))
7190 (goto-char dbeg)
7191 (while (re-search-forward "^[ \t]*\\S-" dend t) (setq n (1+ n)))))
7192 (setq conf (or (eq t org-agenda-confirm-kill)
7193 (and (numberp org-agenda-confirm-kill)
7194 (> n org-agenda-confirm-kill))))
7195 (and conf
7196 (not (y-or-n-p
7197 (format "Delete entry with %d lines in buffer \"%s\"? "
7198 n (buffer-name buffer))))
7199 (error "Abort"))
7200 (org-remove-subtree-entries-from-agenda buffer dbeg dend)
7201 (with-current-buffer buffer (delete-region dbeg dend))
7202 (message "Agenda item and source killed"))))
7204 (defvar org-archive-default-command)
7205 (defun org-agenda-archive-default ()
7206 "Archive the entry or subtree belonging to the current agenda entry."
7207 (interactive)
7208 (require 'org-archive)
7209 (org-agenda-archive-with org-archive-default-command))
7211 (defun org-agenda-archive-default-with-confirmation ()
7212 "Archive the entry or subtree belonging to the current agenda entry."
7213 (interactive)
7214 (require 'org-archive)
7215 (org-agenda-archive-with org-archive-default-command 'confirm))
7217 (defun org-agenda-archive ()
7218 "Archive the entry or subtree belonging to the current agenda entry."
7219 (interactive)
7220 (org-agenda-archive-with 'org-archive-subtree))
7222 (defun org-agenda-archive-to-archive-sibling ()
7223 "Move the entry to the archive sibling."
7224 (interactive)
7225 (org-agenda-archive-with 'org-archive-to-archive-sibling))
7227 (defun org-agenda-archive-with (cmd &optional confirm)
7228 "Move the entry to the archive sibling."
7229 (interactive)
7230 (or (eq major-mode 'org-agenda-mode) (error "Not in agenda"))
7231 (let* ((marker (or (org-get-at-bol 'org-marker)
7232 (org-agenda-error)))
7233 (buffer (marker-buffer marker))
7234 (pos (marker-position marker)))
7235 (org-with-remote-undo buffer
7236 (with-current-buffer buffer
7237 (if (eq major-mode 'org-mode)
7238 (if (and confirm
7239 (not (y-or-n-p "Archive this subtree or entry? ")))
7240 (error "Abort")
7241 (save-excursion
7242 (goto-char pos)
7243 (org-remove-subtree-entries-from-agenda)
7244 (org-back-to-heading t)
7245 (funcall cmd)))
7246 (error "Archiving works only in Org-mode files"))))))
7248 (defun org-remove-subtree-entries-from-agenda (&optional buf beg end)
7249 "Remove all lines in the agenda that correspond to a given subtree.
7250 The subtree is the one in buffer BUF, starting at BEG and ending at END.
7251 If this information is not given, the function uses the tree at point."
7252 (let ((buf (or buf (current-buffer))) m p)
7253 (save-excursion
7254 (unless (and beg end)
7255 (org-back-to-heading t)
7256 (setq beg (point))
7257 (org-end-of-subtree t)
7258 (setq end (point)))
7259 (set-buffer (get-buffer org-agenda-buffer-name))
7260 (save-excursion
7261 (goto-char (point-max))
7262 (beginning-of-line 1)
7263 (while (not (bobp))
7264 (when (and (setq m (org-get-at-bol 'org-marker))
7265 (equal buf (marker-buffer m))
7266 (setq p (marker-position m))
7267 (>= p beg)
7268 (< p end))
7269 (let ((inhibit-read-only t))
7270 (delete-region (point-at-bol) (1+ (point-at-eol)))))
7271 (beginning-of-line 0))))))
7273 (defun org-agenda-refile (&optional goto rfloc no-update)
7274 "Refile the item at point."
7275 (interactive "P")
7276 (if (equal goto '(16))
7277 (org-refile-goto-last-stored)
7278 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7279 (org-agenda-error)))
7280 (buffer (marker-buffer marker))
7281 (pos (marker-position marker))
7282 (rfloc (or rfloc
7283 (org-refile-get-location
7284 (if goto "Goto" "Refile to") buffer
7285 org-refile-allow-creating-parent-nodes))))
7286 (with-current-buffer buffer
7287 (save-excursion
7288 (save-restriction
7289 (widen)
7290 (goto-char marker)
7291 (org-remove-subtree-entries-from-agenda)
7292 (org-refile goto buffer rfloc)))))
7293 (unless no-update (org-agenda-redo))))
7295 (defun org-agenda-open-link (&optional arg)
7296 "Follow the link in the current line, if any.
7297 This looks for a link in the displayed line in the agenda. It also looks
7298 at the text of the entry itself."
7299 (interactive "P")
7300 (let* ((marker (or (org-get-at-bol 'org-hd-marker)
7301 (org-get-at-bol 'org-marker)))
7302 (buffer (and marker (marker-buffer marker)))
7303 (prefix (buffer-substring
7304 (point-at-bol) (point-at-eol))))
7305 (cond
7306 (buffer
7307 (with-current-buffer buffer
7308 (save-excursion
7309 (save-restriction
7310 (widen)
7311 (goto-char marker)
7312 (org-offer-links-in-entry arg prefix)))))
7313 ((or (org-in-regexp (concat "\\(" org-bracket-link-regexp "\\)"))
7314 (save-excursion
7315 (beginning-of-line 1)
7316 (looking-at (concat ".*?\\(" org-bracket-link-regexp "\\)"))))
7317 (org-open-link-from-string (match-string 1)))
7318 (t (error "No link to open here")))))
7320 (defun org-agenda-copy-local-variable (var)
7321 "Get a variable from a referenced buffer and install it here."
7322 (let ((m (org-get-at-bol 'org-marker)))
7323 (when (and m (buffer-live-p (marker-buffer m)))
7324 (org-set-local var (with-current-buffer (marker-buffer m)
7325 (symbol-value var))))))
7327 (defun org-agenda-switch-to (&optional delete-other-windows)
7328 "Go to the Org-mode file which contains the item at point."
7329 (interactive)
7330 (if (and org-return-follows-link
7331 (not (org-get-at-bol 'org-marker))
7332 (org-in-regexp org-bracket-link-regexp))
7333 (org-open-link-from-string (match-string 0))
7334 (let* ((marker (or (org-get-at-bol 'org-marker)
7335 (org-agenda-error)))
7336 (buffer (marker-buffer marker))
7337 (pos (marker-position marker)))
7338 (org-pop-to-buffer-same-window buffer)
7339 (and delete-other-windows (delete-other-windows))
7340 (widen)
7341 (goto-char pos)
7342 (when (eq major-mode 'org-mode)
7343 (org-show-context 'agenda)
7344 (save-excursion
7345 (and (outline-next-heading)
7346 (org-flag-heading nil))) ; show the next heading
7347 (when (outline-invisible-p)
7348 (show-entry)))))) ; display invisible text
7350 (defun org-agenda-goto-mouse (ev)
7351 "Go to the Org-mode file which contains the item at the mouse click."
7352 (interactive "e")
7353 (mouse-set-point ev)
7354 (org-agenda-goto))
7356 (defun org-agenda-show (&optional full-entry)
7357 "Display the Org-mode file which contains the item at point.
7358 With prefix argument FULL-ENTRY, make the entire entry visible
7359 if it was hidden in the outline."
7360 (interactive "P")
7361 (let ((win (selected-window)))
7362 (if full-entry
7363 (let ((org-show-entry-below t))
7364 (org-agenda-goto t))
7365 (org-agenda-goto t))
7366 (select-window win)))
7368 (defvar org-agenda-show-window nil)
7369 (defun org-agenda-show-and-scroll-up (&optional arg)
7370 "Display the Org-mode file which contains the item at point.
7371 When called repeatedly, scroll the window that is displaying the buffer.
7372 With a \\[universal-argument] prefix, use `org-show-entry' instead of
7373 `show-subtree' to display the item, so that drawers and logbooks stay
7374 folded."
7375 (interactive "P")
7376 (let ((win (selected-window)))
7377 (if (and (window-live-p org-agenda-show-window)
7378 (eq this-command last-command))
7379 (progn
7380 (select-window org-agenda-show-window)
7381 (ignore-errors (scroll-up)))
7382 (org-agenda-goto t)
7383 (if arg (org-show-entry) (show-subtree))
7384 (setq org-agenda-show-window (selected-window)))
7385 (select-window win)))
7387 (defun org-agenda-show-scroll-down ()
7388 "Scroll down the window showing the agenda."
7389 (interactive)
7390 (let ((win (selected-window)))
7391 (when (window-live-p org-agenda-show-window)
7392 (select-window org-agenda-show-window)
7393 (ignore-errors (scroll-down))
7394 (select-window win))))
7396 (defun org-agenda-show-1 (&optional more)
7397 "Display the Org-mode file which contains the item at point.
7398 The prefix arg selects the amount of information to display:
7400 0 hide the subtree
7401 1 just show the entry according to defaults.
7402 2 show the children view
7403 3 show the subtree view
7404 4 show the entire subtree and any LOGBOOK drawers
7405 5 show the entire subtree and any drawers
7406 With prefix argument FULL-ENTRY, make the entire entry visible
7407 if it was hidden in the outline."
7408 (interactive "p")
7409 (let ((win (selected-window)))
7410 (org-agenda-goto t)
7411 (org-recenter-heading 1)
7412 (cond
7413 ((= more 0)
7414 (hide-subtree)
7415 (save-excursion
7416 (org-back-to-heading)
7417 (run-hook-with-args 'org-cycle-hook 'folded))
7418 (message "Remote: FOLDED"))
7419 ((and (org-called-interactively-p 'any) (= more 1))
7420 (message "Remote: show with default settings"))
7421 ((= more 2)
7422 (show-entry)
7423 (show-children)
7424 (save-excursion
7425 (org-back-to-heading)
7426 (run-hook-with-args 'org-cycle-hook 'children))
7427 (message "Remote: CHILDREN"))
7428 ((= more 3)
7429 (show-subtree)
7430 (save-excursion
7431 (org-back-to-heading)
7432 (run-hook-with-args 'org-cycle-hook 'subtree))
7433 (message "Remote: SUBTREE"))
7434 ((= more 4)
7435 (let* ((org-drawers (delete "LOGBOOK" (copy-sequence org-drawers)))
7436 (org-drawer-regexp
7437 (concat "^[ \t]*:\\("
7438 (mapconcat 'regexp-quote org-drawers "\\|")
7439 "\\):[ \t]*$")))
7440 (show-subtree)
7441 (save-excursion
7442 (org-back-to-heading)
7443 (org-cycle-hide-drawers 'subtree)))
7444 (message "Remote: SUBTREE AND LOGBOOK"))
7445 ((> more 4)
7446 (show-subtree)
7447 (message "Remote: SUBTREE AND ALL DRAWERS")))
7448 (select-window win)))
7450 (defun org-recenter-heading (n)
7451 (save-excursion
7452 (org-back-to-heading)
7453 (recenter n)))
7455 (defvar org-agenda-cycle-counter nil)
7456 (defun org-agenda-cycle-show (&optional n)
7457 "Show the current entry in another window, with default settings.
7458 Default settings are taken from `org-show-hierarchy-above' and siblings.
7459 When use repeatedly in immediate succession, the remote entry will cycle
7460 through visibility
7462 children -> subtree -> folded
7464 When called with a numeric prefix arg, that arg will be passed through to
7465 `org-agenda-show-1'. For the interpretation of that argument, see the
7466 docstring of `org-agenda-show-1'."
7467 (interactive "P")
7468 (if (integerp n)
7469 (setq org-agenda-cycle-counter n)
7470 (if (not (eq last-command this-command))
7471 (setq org-agenda-cycle-counter 1)
7472 (if (equal org-agenda-cycle-counter 0)
7473 (setq org-agenda-cycle-counter 2)
7474 (setq org-agenda-cycle-counter (1+ org-agenda-cycle-counter))
7475 (if (> org-agenda-cycle-counter 3)
7476 (setq org-agenda-cycle-counter 0)))))
7477 (org-agenda-show-1 org-agenda-cycle-counter))
7479 (defun org-agenda-recenter (arg)
7480 "Display the Org-mode file which contains the item at point and recenter."
7481 (interactive "P")
7482 (let ((win (selected-window)))
7483 (org-agenda-goto t)
7484 (recenter arg)
7485 (select-window win)))
7487 (defun org-agenda-show-mouse (ev)
7488 "Display the Org-mode file which contains the item at the mouse click."
7489 (interactive "e")
7490 (mouse-set-point ev)
7491 (org-agenda-show))
7493 (defun org-agenda-check-no-diary ()
7494 "Check if the entry is a diary link and abort if yes."
7495 (if (org-get-at-bol 'org-agenda-diary-link)
7496 (org-agenda-error)))
7498 (defun org-agenda-error ()
7499 (error "Command not allowed in this line"))
7501 (defun org-agenda-tree-to-indirect-buffer ()
7502 "Show the subtree corresponding to the current entry in an indirect buffer.
7503 This calls the command `org-tree-to-indirect-buffer' from the original
7504 Org-mode buffer.
7505 With numerical prefix arg ARG, go up to this level and then take that tree.
7506 With a \\[universal-argument] prefix, make a separate frame for this tree (i.e. don't
7507 use the dedicated frame)."
7508 (interactive)
7509 (if (and current-prefix-arg (listp current-prefix-arg))
7510 (org-agenda-do-tree-to-indirect-buffer)
7511 (let ((agenda-window (selected-window))
7512 (indirect-window (and org-last-indirect-buffer (get-buffer-window org-last-indirect-buffer))))
7513 (save-window-excursion (org-agenda-do-tree-to-indirect-buffer))
7514 (unwind-protect
7515 (progn
7516 (unless (and indirect-window (window-live-p indirect-window))
7517 (setq indirect-window (split-window agenda-window)))
7518 (select-window indirect-window)
7519 (switch-to-buffer org-last-indirect-buffer :norecord)
7520 (fit-window-to-buffer indirect-window))
7521 (select-window agenda-window)))))
7523 (defun org-agenda-do-tree-to-indirect-buffer ()
7524 "Same as `org-agenda-tree-to-indirect-buffer' without saving window."
7525 (org-agenda-check-no-diary)
7526 (let* ((marker (or (org-get-at-bol 'org-marker)
7527 (org-agenda-error)))
7528 (buffer (marker-buffer marker))
7529 (pos (marker-position marker)))
7530 (with-current-buffer buffer
7531 (save-excursion
7532 (goto-char pos)
7533 (call-interactively 'org-tree-to-indirect-buffer)))))
7535 (defvar org-last-heading-marker (make-marker)
7536 "Marker pointing to the headline that last changed its TODO state
7537 by a remote command from the agenda.")
7539 (defun org-agenda-todo-nextset ()
7540 "Switch TODO entry to next sequence."
7541 (interactive)
7542 (org-agenda-todo 'nextset))
7544 (defun org-agenda-todo-previousset ()
7545 "Switch TODO entry to previous sequence."
7546 (interactive)
7547 (org-agenda-todo 'previousset))
7549 (defun org-agenda-todo (&optional arg)
7550 "Cycle TODO state of line at point, also in Org-mode file.
7551 This changes the line at point, all other lines in the agenda referring to
7552 the same tree node, and the headline of the tree node in the Org-mode file."
7553 (interactive "P")
7554 (org-agenda-check-no-diary)
7555 (let* ((col (current-column))
7556 (marker (or (org-get-at-bol 'org-marker)
7557 (org-agenda-error)))
7558 (buffer (marker-buffer marker))
7559 (pos (marker-position marker))
7560 (hdmarker (org-get-at-bol 'org-hd-marker))
7561 (todayp (org-agenda-todayp (org-get-at-bol 'day)))
7562 (inhibit-read-only t)
7563 org-agenda-headline-snapshot-before-repeat newhead just-one)
7564 (org-with-remote-undo buffer
7565 (with-current-buffer buffer
7566 (widen)
7567 (goto-char pos)
7568 (org-show-context 'agenda)
7569 (save-excursion
7570 (and (outline-next-heading)
7571 (org-flag-heading nil))) ; show the next heading
7572 (let ((current-prefix-arg arg))
7573 (call-interactively 'org-todo))
7574 (and (bolp) (forward-char 1))
7575 (setq newhead (org-get-heading))
7576 (when (and (org-bound-and-true-p
7577 org-agenda-headline-snapshot-before-repeat)
7578 (not (equal org-agenda-headline-snapshot-before-repeat
7579 newhead))
7580 todayp)
7581 (setq newhead org-agenda-headline-snapshot-before-repeat
7582 just-one t))
7583 (save-excursion
7584 (org-back-to-heading)
7585 (move-marker org-last-heading-marker (point))))
7586 (beginning-of-line 1)
7587 (save-excursion
7588 (org-agenda-change-all-lines newhead hdmarker 'fixface just-one))
7589 (org-move-to-column col))))
7591 (defun org-agenda-add-note (&optional arg)
7592 "Add a time-stamped note to the entry at point."
7593 (interactive "P")
7594 (org-agenda-check-no-diary)
7595 (let* ((marker (or (org-get-at-bol 'org-marker)
7596 (org-agenda-error)))
7597 (buffer (marker-buffer marker))
7598 (pos (marker-position marker))
7599 (hdmarker (org-get-at-bol 'org-hd-marker))
7600 (inhibit-read-only t))
7601 (with-current-buffer buffer
7602 (widen)
7603 (goto-char pos)
7604 (org-show-context 'agenda)
7605 (save-excursion
7606 (and (outline-next-heading)
7607 (org-flag-heading nil))) ; show the next heading
7608 (org-add-note))))
7610 (defun org-agenda-change-all-lines (newhead hdmarker
7611 &optional fixface just-this)
7612 "Change all lines in the agenda buffer which match HDMARKER.
7613 The new content of the line will be NEWHEAD (as modified by
7614 `org-agenda-format-item'). HDMARKER is checked with
7615 `equal' against all `org-hd-marker' text properties in the file.
7616 If FIXFACE is non-nil, the face of each item is modified according to
7617 the new TODO state.
7618 If JUST-THIS is non-nil, change just the current line, not all.
7619 If FORCE-TAGS is non nil, the car of it returns the new tags."
7620 (let* ((inhibit-read-only t)
7621 (line (org-current-line))
7622 (org-agenda-buffer (current-buffer))
7623 (thetags (with-current-buffer (marker-buffer hdmarker)
7624 (save-excursion (save-restriction (widen)
7625 (goto-char hdmarker)
7626 (org-get-tags-at)))))
7627 props m pl undone-face done-face finish new dotime cat tags)
7628 (save-excursion
7629 (goto-char (point-max))
7630 (beginning-of-line 1)
7631 (while (not finish)
7632 (setq finish (bobp))
7633 (when (and (setq m (org-get-at-bol 'org-hd-marker))
7634 (or (not just-this) (= (org-current-line) line))
7635 (equal m hdmarker))
7636 (setq props (text-properties-at (point))
7637 dotime (org-get-at-bol 'dotime)
7638 cat (org-get-at-bol 'org-category)
7639 tags thetags
7641 (let ((org-prefix-format-compiled
7642 (or (get-text-property (point) 'format)
7643 org-prefix-format-compiled)))
7644 (with-current-buffer (marker-buffer hdmarker)
7645 (save-excursion
7646 (save-restriction
7647 (widen)
7648 (org-agenda-format-item (org-get-at-bol 'extra)
7649 newhead cat tags dotime)))))
7650 pl (text-property-any (point-at-bol) (point-at-eol) 'org-heading t)
7651 undone-face (org-get-at-bol 'undone-face)
7652 done-face (org-get-at-bol 'done-face))
7653 (beginning-of-line 1)
7654 (cond
7655 ((equal new "")
7656 (and (looking-at ".*\n?") (replace-match "")))
7657 ((looking-at ".*")
7658 (replace-match new t t)
7659 (beginning-of-line 1)
7660 (add-text-properties (point-at-bol) (point-at-eol) props)
7661 (when fixface
7662 (add-text-properties
7663 (point-at-bol) (point-at-eol)
7664 (list 'face
7665 (if org-last-todo-state-is-todo
7666 undone-face done-face))))
7667 (org-agenda-highlight-todo 'line)
7668 (beginning-of-line 1))
7669 (t (error "Line update did not work"))))
7670 (beginning-of-line 0)))
7671 (org-finalize-agenda)))
7673 (defun org-agenda-align-tags (&optional line)
7674 "Align all tags in agenda items to `org-agenda-tags-column'."
7675 (let ((inhibit-read-only t) l c)
7676 (save-excursion
7677 (goto-char (if line (point-at-bol) (point-min)))
7678 (while (re-search-forward (org-re "\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$")
7679 (if line (point-at-eol) nil) t)
7680 (add-text-properties
7681 (match-beginning 2) (match-end 2)
7682 (list 'face (delq nil (let ((prop (get-text-property
7683 (match-beginning 2) 'face)))
7684 (or (listp prop) (setq prop (list prop)))
7685 (if (memq 'org-tag prop)
7686 prop
7687 (cons 'org-tag prop))))))
7688 (setq l (- (match-end 2) (match-beginning 2))
7689 c (if (< org-agenda-tags-column 0)
7690 (- (abs org-agenda-tags-column) l)
7691 org-agenda-tags-column))
7692 (delete-region (match-beginning 1) (match-end 1))
7693 (goto-char (match-beginning 1))
7694 (insert (org-add-props
7695 (make-string (max 1 (- c (current-column))) ?\ )
7696 (plist-put (copy-sequence (text-properties-at (point)))
7697 'face nil))))
7698 (goto-char (point-min))
7699 (org-font-lock-add-tag-faces (point-max)))))
7701 (defun org-agenda-priority-up ()
7702 "Increase the priority of line at point, also in Org-mode file."
7703 (interactive)
7704 (org-agenda-priority 'up))
7706 (defun org-agenda-priority-down ()
7707 "Decrease the priority of line at point, also in Org-mode file."
7708 (interactive)
7709 (org-agenda-priority 'down))
7711 (defun org-agenda-priority (&optional force-direction)
7712 "Set the priority of line at point, also in Org-mode file.
7713 This changes the line at point, all other lines in the agenda referring to
7714 the same tree node, and the headline of the tree node in the Org-mode file."
7715 (interactive)
7716 (unless org-enable-priority-commands
7717 (error "Priority commands are disabled"))
7718 (org-agenda-check-no-diary)
7719 (let* ((marker (or (org-get-at-bol 'org-marker)
7720 (org-agenda-error)))
7721 (hdmarker (org-get-at-bol 'org-hd-marker))
7722 (buffer (marker-buffer hdmarker))
7723 (pos (marker-position hdmarker))
7724 (inhibit-read-only t)
7725 newhead)
7726 (org-with-remote-undo buffer
7727 (with-current-buffer buffer
7728 (widen)
7729 (goto-char pos)
7730 (org-show-context 'agenda)
7731 (save-excursion
7732 (and (outline-next-heading)
7733 (org-flag-heading nil))) ; show the next heading
7734 (funcall 'org-priority force-direction)
7735 (end-of-line 1)
7736 (setq newhead (org-get-heading)))
7737 (org-agenda-change-all-lines newhead hdmarker)
7738 (beginning-of-line 1))))
7740 ;; FIXME: should fix the tags property of the agenda line.
7741 (defun org-agenda-set-tags (&optional tag onoff)
7742 "Set tags for the current headline."
7743 (interactive)
7744 (org-agenda-check-no-diary)
7745 (if (and (org-region-active-p) (org-called-interactively-p 'any))
7746 (call-interactively 'org-change-tag-in-region)
7747 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7748 (org-agenda-error)))
7749 (buffer (marker-buffer hdmarker))
7750 (pos (marker-position hdmarker))
7751 (inhibit-read-only t)
7752 newhead)
7753 (org-with-remote-undo buffer
7754 (with-current-buffer buffer
7755 (widen)
7756 (goto-char pos)
7757 (save-excursion
7758 (org-show-context 'agenda))
7759 (save-excursion
7760 (and (outline-next-heading)
7761 (org-flag-heading nil))) ; show the next heading
7762 (goto-char pos)
7763 (if tag
7764 (org-toggle-tag tag onoff)
7765 (call-interactively 'org-set-tags))
7766 (end-of-line 1)
7767 (setq newhead (org-get-heading)))
7768 (org-agenda-change-all-lines newhead hdmarker)
7769 (beginning-of-line 1)))))
7771 (defun org-agenda-set-property ()
7772 "Set a property for the current headline."
7773 (interactive)
7774 (org-agenda-check-no-diary)
7775 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7776 (org-agenda-error)))
7777 (buffer (marker-buffer hdmarker))
7778 (pos (marker-position hdmarker))
7779 (inhibit-read-only t)
7780 newhead)
7781 (org-with-remote-undo buffer
7782 (with-current-buffer buffer
7783 (widen)
7784 (goto-char pos)
7785 (save-excursion
7786 (org-show-context 'agenda))
7787 (save-excursion
7788 (and (outline-next-heading)
7789 (org-flag-heading nil))) ; show the next heading
7790 (goto-char pos)
7791 (call-interactively 'org-set-property)))))
7793 (defun org-agenda-set-effort ()
7794 "Set the effort property for the current headline."
7795 (interactive)
7796 (org-agenda-check-no-diary)
7797 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7798 (org-agenda-error)))
7799 (buffer (marker-buffer hdmarker))
7800 (pos (marker-position hdmarker))
7801 (inhibit-read-only t)
7802 newhead)
7803 (org-with-remote-undo buffer
7804 (with-current-buffer buffer
7805 (widen)
7806 (goto-char pos)
7807 (save-excursion
7808 (org-show-context 'agenda))
7809 (save-excursion
7810 (and (outline-next-heading)
7811 (org-flag-heading nil))) ; show the next heading
7812 (goto-char pos)
7813 (call-interactively 'org-set-effort)
7814 (end-of-line 1)
7815 (setq newhead (org-get-heading)))
7816 (org-agenda-change-all-lines newhead hdmarker))))
7818 (defun org-agenda-toggle-archive-tag ()
7819 "Toggle the archive tag for the current entry."
7820 (interactive)
7821 (org-agenda-check-no-diary)
7822 (let* ((hdmarker (or (org-get-at-bol 'org-hd-marker)
7823 (org-agenda-error)))
7824 (buffer (marker-buffer hdmarker))
7825 (pos (marker-position hdmarker))
7826 (inhibit-read-only t)
7827 newhead)
7828 (org-with-remote-undo buffer
7829 (with-current-buffer buffer
7830 (widen)
7831 (goto-char pos)
7832 (org-show-context 'agenda)
7833 (save-excursion
7834 (and (outline-next-heading)
7835 (org-flag-heading nil))) ; show the next heading
7836 (call-interactively 'org-toggle-archive-tag)
7837 (end-of-line 1)
7838 (setq newhead (org-get-heading)))
7839 (org-agenda-change-all-lines newhead hdmarker)
7840 (beginning-of-line 1))))
7842 (defun org-agenda-do-date-later (arg)
7843 (interactive "P")
7844 (cond
7845 ((or (equal arg '(16))
7846 (memq last-command
7847 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7848 (setq this-command 'org-agenda-date-later-minutes)
7849 (org-agenda-date-later-minutes 1))
7850 ((or (equal arg '(4))
7851 (memq last-command
7852 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7853 (setq this-command 'org-agenda-date-later-hours)
7854 (org-agenda-date-later-hours 1))
7856 (org-agenda-date-later (prefix-numeric-value arg)))))
7858 (defun org-agenda-do-date-earlier (arg)
7859 (interactive "P")
7860 (cond
7861 ((or (equal arg '(16))
7862 (memq last-command
7863 '(org-agenda-date-later-minutes org-agenda-date-earlier-minutes)))
7864 (setq this-command 'org-agenda-date-earlier-minutes)
7865 (org-agenda-date-earlier-minutes 1))
7866 ((or (equal arg '(4))
7867 (memq last-command
7868 '(org-agenda-date-later-hours org-agenda-date-earlier-hours)))
7869 (setq this-command 'org-agenda-date-earlier-hours)
7870 (org-agenda-date-earlier-hours 1))
7872 (org-agenda-date-earlier (prefix-numeric-value arg)))))
7874 (defun org-agenda-date-later (arg &optional what)
7875 "Change the date of this item to ARG day(s) later."
7876 (interactive "p")
7877 (org-agenda-check-type t 'agenda 'timeline)
7878 (org-agenda-check-no-diary)
7879 (let* ((marker (or (org-get-at-bol 'org-marker)
7880 (org-agenda-error)))
7881 (buffer (marker-buffer marker))
7882 (pos (marker-position marker))
7883 cdate today)
7884 (org-with-remote-undo buffer
7885 (with-current-buffer buffer
7886 (widen)
7887 (goto-char pos)
7888 (if (not (org-at-timestamp-p))
7889 (error "Cannot find time stamp"))
7890 (when (and org-agenda-move-date-from-past-immediately-to-today
7891 (equal arg 1)
7892 (or (not what) (eq what 'day))
7893 (not (save-match-data (org-at-date-range-p))))
7894 (setq cdate (org-parse-time-string (match-string 0) 'nodefault)
7895 cdate (calendar-absolute-from-gregorian
7896 (list (nth 4 cdate) (nth 3 cdate) (nth 5 cdate)))
7897 today (org-today))
7898 (if (> today cdate)
7899 ;; immediately shift to today
7900 (setq arg (- today cdate))))
7901 (org-timestamp-change arg (or what 'day))
7902 (when (and (org-at-date-range-p)
7903 (re-search-backward org-tr-regexp-both (point-at-bol)))
7904 (let ((end org-last-changed-timestamp))
7905 (org-timestamp-change arg (or what 'day))
7906 (setq org-last-changed-timestamp
7907 (concat org-last-changed-timestamp "--" end)))))
7908 (org-agenda-show-new-time marker org-last-changed-timestamp))
7909 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7911 (defun org-agenda-date-earlier (arg &optional what)
7912 "Change the date of this item to ARG day(s) earlier."
7913 (interactive "p")
7914 (org-agenda-date-later (- arg) what))
7916 (defun org-agenda-date-later-minutes (arg)
7917 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7918 (interactive "p")
7919 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7920 (org-agenda-date-later arg 'minute))
7922 (defun org-agenda-date-earlier-minutes (arg)
7923 "Change the time of this item, in units of `org-time-stamp-rounding-minutes'."
7924 (interactive "p")
7925 (setq arg (* arg (cadr org-time-stamp-rounding-minutes)))
7926 (org-agenda-date-earlier arg 'minute))
7928 (defun org-agenda-date-later-hours (arg)
7929 "Change the time of this item, in hour steps."
7930 (interactive "p")
7931 (org-agenda-date-later arg 'hour))
7933 (defun org-agenda-date-earlier-hours (arg)
7934 "Change the time of this item, in hour steps."
7935 (interactive "p")
7936 (org-agenda-date-earlier arg 'hour))
7938 (defun org-agenda-show-new-time (marker stamp &optional prefix)
7939 "Show new date stamp via text properties."
7940 ;; We use text properties to make this undoable
7941 (let ((inhibit-read-only t)
7942 (buffer-invisibility-spec))
7943 (setq stamp (concat " " prefix " => " stamp))
7944 (save-excursion
7945 (goto-char (point-max))
7946 (while (not (bobp))
7947 (when (equal marker (org-get-at-bol 'org-marker))
7948 (org-move-to-column (- (window-width) (length stamp)) t)
7949 (org-agenda-fix-tags-filter-overlays-at (point))
7950 (if (featurep 'xemacs)
7951 ;; Use `duplicable' property to trigger undo recording
7952 (let ((ex (make-extent nil nil))
7953 (gl (make-glyph stamp)))
7954 (set-glyph-face gl 'secondary-selection)
7955 (set-extent-properties
7956 ex (list 'invisible t 'end-glyph gl 'duplicable t))
7957 (insert-extent ex (1- (point)) (point-at-eol)))
7958 (add-text-properties
7959 (1- (point)) (point-at-eol)
7960 (list 'display (org-add-props stamp nil
7961 'face 'secondary-selection))))
7962 (beginning-of-line 1))
7963 (beginning-of-line 0)))))
7965 (defun org-agenda-date-prompt (arg)
7966 "Change the date of this item. Date is prompted for, with default today.
7967 The prefix ARG is passed to the `org-time-stamp' command and can therefore
7968 be used to request time specification in the time stamp."
7969 (interactive "P")
7970 (org-agenda-check-type t 'agenda 'timeline)
7971 (org-agenda-check-no-diary)
7972 (let* ((marker (or (org-get-at-bol 'org-marker)
7973 (org-agenda-error)))
7974 (buffer (marker-buffer marker))
7975 (pos (marker-position marker)))
7976 (org-with-remote-undo buffer
7977 (with-current-buffer buffer
7978 (widen)
7979 (goto-char pos)
7980 (if (not (org-at-timestamp-p t))
7981 (error "Cannot find time stamp"))
7982 (org-time-stamp arg (equal (char-after (match-beginning 0)) ?\[)))
7983 (org-agenda-show-new-time marker org-last-changed-timestamp))
7984 (message "Time stamp changed to %s" org-last-changed-timestamp)))
7986 (defun org-agenda-schedule (arg &optional time)
7987 "Schedule the item at point.
7988 ARG is passed through to `org-schedule'."
7989 (interactive "P")
7990 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
7991 (org-agenda-check-no-diary)
7992 (let* ((marker (or (org-get-at-bol 'org-marker)
7993 (org-agenda-error)))
7994 (type (marker-insertion-type marker))
7995 (buffer (marker-buffer marker))
7996 (pos (marker-position marker))
7997 (org-insert-labeled-timestamps-at-point nil)
7999 (set-marker-insertion-type marker t)
8000 (org-with-remote-undo buffer
8001 (with-current-buffer buffer
8002 (widen)
8003 (goto-char pos)
8004 (setq ts (org-schedule arg time)))
8005 (org-agenda-show-new-time marker ts "S"))
8006 (message "Item scheduled for %s" ts)))
8008 (defun org-agenda-deadline (arg &optional time)
8009 "Schedule the item at point.
8010 ARG is passed through to `org-deadline'."
8011 (interactive "P")
8012 (org-agenda-check-type t 'agenda 'timeline 'todo 'tags 'search)
8013 (org-agenda-check-no-diary)
8014 (let* ((marker (or (org-get-at-bol 'org-marker)
8015 (org-agenda-error)))
8016 (buffer (marker-buffer marker))
8017 (pos (marker-position marker))
8018 (org-insert-labeled-timestamps-at-point nil)
8020 (org-with-remote-undo buffer
8021 (with-current-buffer buffer
8022 (widen)
8023 (goto-char pos)
8024 (setq ts (org-deadline arg time)))
8025 (org-agenda-show-new-time marker ts "D"))
8026 (message "Deadline for this item set to %s" ts)))
8028 (defun org-agenda-action ()
8029 "Select entry for agenda action, or execute an agenda action.
8030 This command prompts for another letter. Valid inputs are:
8032 m Mark the entry at point for an agenda action
8033 s Schedule the marked entry to the date at the cursor
8034 d Set the deadline of the marked entry to the date at the cursor
8035 r Call `org-remember' with cursor date as the default date
8036 c Call `org-capture' with cursor date as the default date
8037 SPC Show marked entry in other window
8038 TAB Visit marked entry in other window
8040 The cursor may be at a date in the calendar, or in the Org agenda."
8041 (interactive)
8042 (let (ans)
8043 (message "Select action: [m]ark | [s]chedule [d]eadline [r]emember [c]apture [ ]show")
8044 (setq ans (read-char-exclusive))
8045 (cond
8046 ((equal ans ?m)
8047 ;; Mark this entry
8048 (if (eq major-mode 'org-agenda-mode)
8049 (let ((m (or (org-get-at-bol 'org-hd-marker)
8050 (org-get-at-bol 'org-marker))))
8051 (if m
8052 (progn
8053 (move-marker org-agenda-action-marker
8054 (marker-position m) (marker-buffer m))
8055 (message "Entry marked for action; press `k' at desired date in agenda or calendar"))
8056 (error "Don't know which entry to mark")))
8057 (error "This command works only in the agenda")))
8058 ((equal ans ?s)
8059 (org-agenda-do-action '(org-schedule nil org-overriding-default-time)))
8060 ((equal ans ?d)
8061 (org-agenda-do-action '(org-deadline nil org-overriding-default-time)))
8062 ((equal ans ?r)
8063 (org-agenda-do-action '(org-remember) t))
8064 ((equal ans ?c)
8065 (org-agenda-do-action '(org-capture) t))
8066 ((equal ans ?\ )
8067 (let ((cw (selected-window)))
8068 (org-switch-to-buffer-other-window
8069 (marker-buffer org-agenda-action-marker))
8070 (goto-char org-agenda-action-marker)
8071 (org-show-context 'agenda)
8072 (select-window cw)))
8073 ((equal ans ?\C-i)
8074 (org-switch-to-buffer-other-window
8075 (marker-buffer org-agenda-action-marker))
8076 (goto-char org-agenda-action-marker)
8077 (org-show-context 'agenda))
8078 (t (error "Invalid agenda action %c" ans)))))
8080 (defun org-agenda-do-action (form &optional current-buffer)
8081 "Evaluate FORM at the entry pointed to by `org-agenda-action-marker'."
8082 (let ((org-overriding-default-time (org-get-cursor-date)))
8083 (if current-buffer
8084 (eval form)
8085 (if (not (marker-buffer org-agenda-action-marker))
8086 (error "No entry has been selected for agenda action")
8087 (with-current-buffer (marker-buffer org-agenda-action-marker)
8088 (save-excursion
8089 (save-restriction
8090 (widen)
8091 (goto-char org-agenda-action-marker)
8092 (eval form))))))))
8094 (defun org-agenda-clock-in (&optional arg)
8095 "Start the clock on the currently selected item."
8096 (interactive "P")
8097 (org-agenda-check-no-diary)
8098 (if (equal arg '(4))
8099 (org-clock-in arg)
8100 (let* ((marker (or (org-get-at-bol 'org-marker)
8101 (org-agenda-error)))
8102 (hdmarker (or (org-get-at-bol 'org-hd-marker)
8103 marker))
8104 (pos (marker-position marker))
8105 newhead)
8106 (org-with-remote-undo (marker-buffer marker)
8107 (with-current-buffer (marker-buffer marker)
8108 (widen)
8109 (goto-char pos)
8110 (org-show-context 'agenda)
8111 (org-show-entry)
8112 (org-cycle-hide-drawers 'children)
8113 (org-clock-in arg)
8114 (setq newhead (org-get-heading)))
8115 (org-agenda-change-all-lines newhead hdmarker)))))
8117 (defun org-agenda-clock-out ()
8118 "Stop the currently running clock."
8119 (interactive)
8120 (unless (marker-buffer org-clock-marker)
8121 (error "No running clock"))
8122 (let ((marker (make-marker)) newhead)
8123 (org-with-remote-undo (marker-buffer org-clock-marker)
8124 (with-current-buffer (marker-buffer org-clock-marker)
8125 (save-excursion
8126 (save-restriction
8127 (widen)
8128 (goto-char org-clock-marker)
8129 (org-back-to-heading t)
8130 (move-marker marker (point))
8131 (org-clock-out)
8132 (setq newhead (org-get-heading))))))
8133 (org-agenda-change-all-lines newhead marker)
8134 (move-marker marker nil)))
8136 (defun org-agenda-clock-cancel (&optional arg)
8137 "Cancel the currently running clock."
8138 (interactive "P")
8139 (unless (marker-buffer org-clock-marker)
8140 (error "No running clock"))
8141 (org-with-remote-undo (marker-buffer org-clock-marker)
8142 (org-clock-cancel)))
8144 (defun org-agenda-clock-goto ()
8145 "Jump to the currently clocked in task within the agenda.
8146 If the currently clocked in task is not listed in the agenda
8147 buffer, display it in another window."
8148 (interactive)
8149 (let (pos)
8150 (mapc (lambda (o)
8151 (if (eq (overlay-get o 'type) 'org-agenda-clocking)
8152 (setq pos (overlay-start o))))
8153 (overlays-in (point-min) (point-max)))
8154 (cond (pos (goto-char pos))
8155 ;; If the currently clocked entry is not in the agenda
8156 ;; buffer, we visit it in another window:
8157 (org-clock-current-task
8158 (org-switch-to-buffer-other-window (org-clock-goto)))
8159 (t (message "No running clock, use `C-c C-x C-j' to jump to the most recent one")))))
8161 (defun org-agenda-diary-entry-in-org-file ()
8162 "Make a diary entry in the file `org-agenda-diary-file'."
8163 (let (d1 d2 char (text "") dp1 dp2)
8164 (if (equal (buffer-name) "*Calendar*")
8165 (setq d1 (calendar-cursor-to-date t)
8166 d2 (car calendar-mark-ring))
8167 (setq dp1 (get-text-property (point-at-bol) 'day))
8168 (unless dp1 (error "No date defined in current line"))
8169 (setq d1 (calendar-gregorian-from-absolute dp1)
8170 d2 (and (ignore-errors (mark))
8171 (save-excursion
8172 (goto-char (mark))
8173 (setq dp2 (get-text-property (point-at-bol) 'day)))
8174 (calendar-gregorian-from-absolute dp2))))
8175 (message "Diary entry: [d]ay [a]nniversary [b]lock [j]ump to date tree")
8176 (setq char (read-char-exclusive))
8177 (cond
8178 ((equal char ?d)
8179 (setq text (read-string "Day entry: "))
8180 (org-agenda-add-entry-to-org-agenda-diary-file 'day text d1)
8181 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8182 ((equal char ?a)
8183 (setq d1 (list (car d1) (nth 1 d1)
8184 (read-number (format "Reference year [%d]: " (nth 2 d1))
8185 (nth 2 d1))))
8186 (setq text (read-string "Anniversary (use %d to show years): "))
8187 (org-agenda-add-entry-to-org-agenda-diary-file 'anniversary text d1)
8188 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8189 ((equal char ?b)
8190 (setq text (read-string "Block entry: "))
8191 (unless (and d1 d2 (not (equal d1 d2)))
8192 (error "No block of days selected"))
8193 (org-agenda-add-entry-to-org-agenda-diary-file 'block text d1 d2)
8194 (and (equal (buffer-name) org-agenda-buffer-name) (org-agenda-redo)))
8195 ((equal char ?j)
8196 (org-switch-to-buffer-other-window
8197 (find-file-noselect org-agenda-diary-file))
8198 (require 'org-datetree)
8199 (org-datetree-find-date-create d1)
8200 (org-reveal t))
8201 (t (error "Invalid selection character `%c'" char)))))
8203 (defcustom org-agenda-insert-diary-strategy 'date-tree
8204 "Where in `org-agenda-diary-file' should new entries be added?
8205 Valid values:
8207 date-tree in the date tree, as child of the date
8208 top-level as top-level entries at the end of the file."
8209 :group 'org-agenda
8210 :type '(choice
8211 (const :tag "in a date tree" date-tree)
8212 (const :tag "as top level at end of file" top-level)))
8214 (defcustom org-agenda-insert-diary-extract-time nil
8215 "Non-nil means extract any time specification from the diary entry."
8216 :group 'org-agenda
8217 :version "24.1"
8218 :type 'boolean)
8220 (defun org-agenda-add-entry-to-org-agenda-diary-file (type text &optional d1 d2)
8221 "Add a diary entry with TYPE to `org-agenda-diary-file'.
8222 If TEXT is not empty, it will become the headline of the new entry, and
8223 the resulting entry will not be shown. When TEXT is empty, switch to
8224 `org-agenda-diary-file' and let the user finish the entry there."
8225 (let ((cw (current-window-configuration)))
8226 (org-switch-to-buffer-other-window
8227 (find-file-noselect org-agenda-diary-file))
8228 (widen)
8229 (goto-char (point-min))
8230 (cond
8231 ((eq type 'anniversary)
8232 (or (re-search-forward "^*[ \t]+Anniversaries" nil t)
8233 (progn
8234 (or (org-at-heading-p t)
8235 (progn
8236 (outline-next-heading)
8237 (insert "* Anniversaries\n\n")
8238 (beginning-of-line -1)))))
8239 (outline-next-heading)
8240 (org-back-over-empty-lines)
8241 (backward-char 1)
8242 (insert "\n")
8243 (insert (format "%%%%(org-anniversary %d %2d %2d) %s"
8244 (nth 2 d1) (car d1) (nth 1 d1) text)))
8245 ((eq type 'day)
8246 (let ((org-prefix-has-time t)
8247 (org-agenda-time-leading-zero t)
8248 fmt time time2)
8249 (if org-agenda-insert-diary-extract-time
8250 ;; Use org-agenda-format-item to parse text for a time-range and
8251 ;; remove it. FIXME: This is a hack, we should refactor
8252 ;; that function to make time extraction available separately
8253 (setq fmt (org-agenda-format-item nil text nil nil t)
8254 time (get-text-property 0 'time fmt)
8255 time2 (if (> (length time) 0)
8256 ;; split-string removes trailing ...... if
8257 ;; no end time given. First space
8258 ;; separates time from date.
8259 (concat " " (car (split-string time "\\.")))
8260 nil)
8261 text (get-text-property 0 'txt fmt)))
8262 (if (eq org-agenda-insert-diary-strategy 'top-level)
8263 (org-agenda-insert-diary-as-top-level text)
8264 (require 'org-datetree)
8265 (org-datetree-find-date-create d1)
8266 (org-agenda-insert-diary-make-new-entry text))
8267 (org-insert-time-stamp (org-time-from-absolute
8268 (calendar-absolute-from-gregorian d1))
8269 nil nil nil nil time2))
8270 (end-of-line 0))
8271 ((eq type 'block)
8272 (if (> (calendar-absolute-from-gregorian d1)
8273 (calendar-absolute-from-gregorian d2))
8274 (setq d1 (prog1 d2 (setq d2 d1))))
8275 (if (eq org-agenda-insert-diary-strategy 'top-level)
8276 (org-agenda-insert-diary-as-top-level text)
8277 (require 'org-datetree)
8278 (org-datetree-find-date-create d1)
8279 (org-agenda-insert-diary-make-new-entry text))
8280 (org-insert-time-stamp (org-time-from-absolute
8281 (calendar-absolute-from-gregorian d1)))
8282 (insert "--")
8283 (org-insert-time-stamp (org-time-from-absolute
8284 (calendar-absolute-from-gregorian d2)))
8285 (end-of-line 0)))
8286 (if (string-match "\\S-" text)
8287 (progn
8288 (set-window-configuration cw)
8289 (message "%s entry added to %s"
8290 (capitalize (symbol-name type))
8291 (abbreviate-file-name org-agenda-diary-file)))
8292 (org-reveal t)
8293 (message "Please finish entry here"))))
8295 (defun org-agenda-insert-diary-as-top-level (text)
8296 "Make new entry as a top-level entry at the end of the file.
8297 Add TEXT as headline, and position the cursor in the second line so that
8298 a timestamp can be added there."
8299 (widen)
8300 (goto-char (point-max))
8301 (or (bolp) (insert "\n"))
8302 (insert "* " text "\n")
8303 (if org-adapt-indentation (org-indent-to-column 2)))
8305 (defun org-agenda-insert-diary-make-new-entry (text)
8306 "Make new entry as last child of current entry.
8307 Add TEXT as headline, and position the cursor in the second line so that
8308 a timestamp can be added there."
8309 (let ((org-show-following-heading t)
8310 (org-show-siblings t)
8311 (org-show-hierarchy-above t)
8312 (org-show-entry-below t)
8313 col)
8314 (outline-next-heading)
8315 (org-back-over-empty-lines)
8316 (or (looking-at "[ \t]*$")
8317 (progn (insert "\n") (backward-char 1)))
8318 (org-insert-heading nil t)
8319 (org-do-demote)
8320 (setq col (current-column))
8321 (insert text "\n")
8322 (if org-adapt-indentation (org-indent-to-column col))
8323 (let ((org-show-following-heading t)
8324 (org-show-siblings t)
8325 (org-show-hierarchy-above t)
8326 (org-show-entry-below t))
8327 (org-show-context))))
8329 (defun org-agenda-diary-entry ()
8330 "Make a diary entry, like the `i' command from the calendar.
8331 All the standard commands work: block, weekly etc.
8332 When `org-agenda-diary-file' points to a file,
8333 `org-agenda-diary-entry-in-org-file' is called instead to create
8334 entries in that Org-mode file."
8335 (interactive)
8336 (org-agenda-check-type t 'agenda 'timeline)
8337 (if (not (eq org-agenda-diary-file 'diary-file))
8338 (org-agenda-diary-entry-in-org-file)
8339 (require 'diary-lib)
8340 (let* ((char (progn
8341 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
8342 (read-char-exclusive)))
8343 (cmd (cdr (assoc char
8344 '((?d . insert-diary-entry)
8345 (?w . insert-weekly-diary-entry)
8346 (?m . insert-monthly-diary-entry)
8347 (?y . insert-yearly-diary-entry)
8348 (?a . insert-anniversary-diary-entry)
8349 (?b . insert-block-diary-entry)
8350 (?c . insert-cyclic-diary-entry)))))
8351 (oldf (symbol-function 'calendar-cursor-to-date))
8352 ;; (buf (get-file-buffer (substitute-in-file-name diary-file)))
8353 (point (point))
8354 (mark (or (mark t) (point))))
8355 (unless cmd
8356 (error "No command associated with <%c>" char))
8357 (unless (and (get-text-property point 'day)
8358 (or (not (equal ?b char))
8359 (get-text-property mark 'day)))
8360 (error "Don't know which date to use for diary entry"))
8361 ;; We implement this by hacking the `calendar-cursor-to-date' function
8362 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
8363 (let ((calendar-mark-ring
8364 (list (calendar-gregorian-from-absolute
8365 (or (get-text-property mark 'day)
8366 (get-text-property point 'day))))))
8367 (unwind-protect
8368 (progn
8369 (fset 'calendar-cursor-to-date
8370 (lambda (&optional error dummy)
8371 (calendar-gregorian-from-absolute
8372 (get-text-property point 'day))))
8373 (call-interactively cmd))
8374 (fset 'calendar-cursor-to-date oldf))))))
8376 (defun org-agenda-execute-calendar-command (cmd)
8377 "Execute a calendar command from the agenda, with the date associated to
8378 the cursor position."
8379 (org-agenda-check-type t 'agenda 'timeline)
8380 (require 'diary-lib)
8381 (unless (get-text-property (point) 'day)
8382 (error "Don't know which date to use for calendar command"))
8383 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
8384 (point (point))
8385 (date (calendar-gregorian-from-absolute
8386 (get-text-property point 'day)))
8387 ;; the following 2 vars are needed in the calendar
8388 (displayed-month (car date))
8389 (displayed-year (nth 2 date)))
8390 (unwind-protect
8391 (progn
8392 (fset 'calendar-cursor-to-date
8393 (lambda (&optional error dummy)
8394 (calendar-gregorian-from-absolute
8395 (get-text-property point 'day))))
8396 (call-interactively cmd))
8397 (fset 'calendar-cursor-to-date oldf))))
8399 (defun org-agenda-phases-of-moon ()
8400 "Display the phases of the moon for the 3 months around the cursor date."
8401 (interactive)
8402 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
8404 (defun org-agenda-holidays ()
8405 "Display the holidays for the 3 months around the cursor date."
8406 (interactive)
8407 (org-agenda-execute-calendar-command 'list-calendar-holidays))
8409 (defvar calendar-longitude)
8410 (defvar calendar-latitude)
8411 (defvar calendar-location-name)
8413 (defun org-agenda-sunrise-sunset (arg)
8414 "Display sunrise and sunset for the cursor date.
8415 Latitude and longitude can be specified with the variables
8416 `calendar-latitude' and `calendar-longitude'. When called with prefix
8417 argument, latitude and longitude will be prompted for."
8418 (interactive "P")
8419 (require 'solar)
8420 (let ((calendar-longitude (if arg nil calendar-longitude))
8421 (calendar-latitude (if arg nil calendar-latitude))
8422 (calendar-location-name
8423 (if arg "the given coordinates" calendar-location-name)))
8424 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
8426 (defun org-agenda-goto-calendar ()
8427 "Open the Emacs calendar with the date at the cursor."
8428 (interactive)
8429 (org-agenda-check-type t 'agenda 'timeline)
8430 (let* ((day (or (get-text-property (point) 'day)
8431 (error "Don't know which date to open in calendar")))
8432 (date (calendar-gregorian-from-absolute day))
8433 (calendar-move-hook nil)
8434 (calendar-view-holidays-initially-flag nil)
8435 (calendar-view-diary-initially-flag nil))
8436 (calendar)
8437 (calendar-goto-date date)))
8439 ;;;###autoload
8440 (defun org-calendar-goto-agenda ()
8441 "Compute the Org-mode agenda for the calendar date displayed at the cursor.
8442 This is a command that has to be installed in `calendar-mode-map'."
8443 (interactive)
8444 (org-agenda-list nil (calendar-absolute-from-gregorian
8445 (calendar-cursor-to-date))
8446 nil))
8448 (defun org-agenda-convert-date ()
8449 (interactive)
8450 (org-agenda-check-type t 'agenda 'timeline)
8451 (let ((day (get-text-property (point) 'day))
8452 date s)
8453 (unless day
8454 (error "Don't know which date to convert"))
8455 (setq date (calendar-gregorian-from-absolute day))
8456 (setq s (concat
8457 "Gregorian: " (calendar-date-string date) "\n"
8458 "ISO: " (calendar-iso-date-string date) "\n"
8459 "Day of Yr: " (calendar-day-of-year-string date) "\n"
8460 "Julian: " (calendar-julian-date-string date) "\n"
8461 "Astron. JD: " (calendar-astro-date-string date)
8462 " (Julian date number at noon UTC)\n"
8463 "Hebrew: " (calendar-hebrew-date-string date) " (until sunset)\n"
8464 "Islamic: " (calendar-islamic-date-string date) " (until sunset)\n"
8465 "French: " (calendar-french-date-string date) "\n"
8466 "Baha'i: " (calendar-bahai-date-string date) " (until sunset)\n"
8467 "Mayan: " (calendar-mayan-date-string date) "\n"
8468 "Coptic: " (calendar-coptic-date-string date) "\n"
8469 "Ethiopic: " (calendar-ethiopic-date-string date) "\n"
8470 "Persian: " (calendar-persian-date-string date) "\n"
8471 "Chinese: " (calendar-chinese-date-string date) "\n"))
8472 (with-output-to-temp-buffer "*Dates*"
8473 (princ s))
8474 (org-fit-window-to-buffer (get-buffer-window "*Dates*"))))
8476 ;;; Bulk commands
8478 (defvar org-agenda-bulk-marked-entries nil
8479 "List of markers that refer to marked entries in the agenda.")
8481 (defun org-agenda-bulk-marked-p ()
8482 (eq (get-char-property (point-at-bol) 'type)
8483 'org-marked-entry-overlay))
8485 (defun org-agenda-bulk-mark (&optional arg)
8486 "Mark the entry at point for future bulk action."
8487 (interactive "p")
8488 (dotimes (i (max arg 1))
8489 (unless (org-get-at-bol 'org-agenda-diary-link)
8490 (let* ((m (org-get-at-bol 'org-hd-marker))
8492 (unless (org-agenda-bulk-marked-p)
8493 (unless m (error "Nothing to mark at point"))
8494 (push m org-agenda-bulk-marked-entries)
8495 (setq ov (make-overlay (point-at-bol) (+ 2 (point-at-bol))))
8496 (org-overlay-display ov "> "
8497 (org-get-todo-face "TODO")
8498 'evaporate)
8499 (overlay-put ov 'type 'org-marked-entry-overlay))
8500 (beginning-of-line 2)
8501 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8502 (beginning-of-line 2))
8503 (message "%d entries marked for bulk action"
8504 (length org-agenda-bulk-marked-entries))))))
8506 (defun org-agenda-bulk-mark-regexp (regexp)
8507 "Mark entries match REGEXP."
8508 (interactive "sMark entries matching regexp: ")
8509 (let (entries-marked)
8510 (save-excursion
8511 (goto-char (point-min))
8512 (goto-char (next-single-property-change (point) 'txt))
8513 (while (re-search-forward regexp nil t)
8514 (when (string-match regexp (get-text-property (point) 'txt))
8515 (setq entries-marked (+ entries-marked 1))
8516 (call-interactively 'org-agenda-bulk-mark))))
8517 (if (not entries-marked)
8518 (message "No entry matching this regexp."))))
8520 (defun org-agenda-bulk-unmark ()
8521 "Unmark the entry at point for future bulk action."
8522 (interactive)
8523 (when (org-agenda-bulk-marked-p)
8524 (org-agenda-bulk-remove-overlays
8525 (point-at-bol) (+ 2 (point-at-bol)))
8526 (setq org-agenda-bulk-marked-entries
8527 (delete (org-get-at-bol 'org-hd-marker)
8528 org-agenda-bulk-marked-entries)))
8529 (beginning-of-line 2)
8530 (while (and (get-char-property (point) 'invisible) (not (eobp)))
8531 (beginning-of-line 2))
8532 (message "%d entries marked for bulk action"
8533 (length org-agenda-bulk-marked-entries)))
8535 (defun org-agenda-bulk-toggle ()
8536 "Toggle marking the entry at point for bulk action."
8537 (interactive)
8538 (if (org-agenda-bulk-marked-p)
8539 (org-agenda-bulk-unmark)
8540 (org-agenda-bulk-mark)))
8542 (defun org-agenda-bulk-remove-overlays (&optional beg end)
8543 "Remove the mark overlays between BEG and END in the agenda buffer.
8544 BEG and END default to the buffer limits.
8546 This only removes the overlays, it does not remove the markers
8547 from the list in `org-agenda-bulk-marked-entries'."
8548 (interactive)
8549 (mapc (lambda (ov)
8550 (and (eq (overlay-get ov 'type) 'org-marked-entry-overlay)
8551 (delete-overlay ov)))
8552 (overlays-in (or beg (point-min)) (or end (point-max)))))
8554 (defun org-agenda-bulk-remove-all-marks ()
8555 "Remove all marks in the agenda buffer.
8556 This will remove the markers, and the overlays."
8557 (interactive)
8558 (mapc (lambda (m) (move-marker m nil)) org-agenda-bulk-marked-entries)
8559 (setq org-agenda-bulk-marked-entries nil)
8560 (org-agenda-bulk-remove-overlays (point-min) (point-max)))
8562 (defun org-agenda-bulk-action (&optional arg)
8563 "Execute an remote-editing action on all marked entries.
8564 The prefix arg is passed through to the command if possible."
8565 (interactive "P")
8566 ;; Make sure we have markers, and only valid ones
8567 (unless org-agenda-bulk-marked-entries (error "No entries are marked"))
8568 (mapc
8569 (lambda (m)
8570 (unless (and (markerp m)
8571 (marker-buffer m)
8572 (buffer-live-p (marker-buffer m))
8573 (marker-position m))
8574 (error "Marker %s for bulk command is invalid" m)))
8575 org-agenda-bulk-marked-entries)
8577 ;; Prompt for the bulk command
8578 (message (concat "Bulk: [r]efile [$]arch [A]rch->sib [t]odo"
8579 " [+/-]tag [s]chd [S]catter [d]eadline [f]unction"
8580 (when org-agenda-bulk-custom-functions
8581 (concat " Custom: ["
8582 (mapconcat (lambda(f) (char-to-string (car f)))
8583 org-agenda-bulk-custom-functions "")
8584 "]"))))
8585 (let* ((action (read-char-exclusive))
8586 (org-log-refile (if org-log-refile 'time nil))
8587 (entries (reverse org-agenda-bulk-marked-entries))
8588 redo-at-end
8589 cmd rfloc state e tag pos (cnt 0) (cntskip 0))
8590 (cond
8591 ((equal action ?$)
8592 (setq cmd '(org-agenda-archive)))
8594 ((equal action ?A)
8595 (setq cmd '(org-agenda-archive-to-archive-sibling)))
8597 ((member action '(?r ?w))
8598 (setq rfloc (org-refile-get-location
8599 "Refile to"
8600 (marker-buffer (car org-agenda-bulk-marked-entries))
8601 org-refile-allow-creating-parent-nodes))
8602 (if (nth 3 rfloc)
8603 (setcar (nthcdr 3 rfloc)
8604 (move-marker (make-marker) (nth 3 rfloc)
8605 (or (get-file-buffer (nth 1 rfloc))
8606 (find-buffer-visiting (nth 1 rfloc))
8607 (error "This should not happen")))))
8609 (setq cmd (list 'org-agenda-refile nil (list 'quote rfloc) t)
8610 redo-at-end t))
8612 ((equal action ?t)
8613 (setq state (org-icompleting-read
8614 "Todo state: "
8615 (with-current-buffer (marker-buffer (car entries))
8616 (mapcar 'list org-todo-keywords-1))))
8617 (setq cmd `(let ((org-inhibit-blocking t)
8618 (org-inhibit-logging 'note))
8619 (org-agenda-todo ,state))))
8621 ((memq action '(?- ?+))
8622 (setq tag (org-icompleting-read
8623 (format "Tag to %s: " (if (eq action ?+) "add" "remove"))
8624 (with-current-buffer (marker-buffer (car entries))
8625 (delq nil
8626 (mapcar (lambda (x)
8627 (if (stringp (car x)) x)) org-tag-alist)))))
8628 (setq cmd `(org-agenda-set-tags ,tag ,(if (eq action ?+) ''on ''off))))
8630 ((memq action '(?s ?d))
8631 (let* ((date (unless arg
8632 (org-read-date
8633 nil nil nil
8634 (if (eq action ?s) "(Re)Schedule to" "Set Deadline to"))))
8635 (ans (if arg nil org-read-date-final-answer))
8636 (c1 (if (eq action ?s) 'org-agenda-schedule 'org-agenda-deadline)))
8637 (setq cmd `(let* ((bound (fboundp 'read-string))
8638 (old (and bound (symbol-function 'read-string))))
8639 (unwind-protect
8640 (progn
8641 (fset 'read-string (lambda (&rest ignore) ,ans))
8642 (eval '(,c1 arg)))
8643 (if bound
8644 (fset 'read-string old)
8645 (fmakunbound 'read-string)))))))
8647 ((equal action ?S)
8648 (if (not (org-agenda-check-type nil 'agenda 'timeline 'todo))
8649 (error "Can't scatter tasks in \"%s\" agenda view" org-agenda-type)
8650 (let ((days (read-number
8651 (format "Scatter tasks across how many %sdays: "
8652 (if arg "week" "")) 7)))
8653 (setq cmd
8654 `(let ((distance (1+ (random ,days))))
8655 (if arg
8656 (let ((dist distance)
8657 (day-of-week
8658 (calendar-day-of-week
8659 (calendar-gregorian-from-absolute (org-today)))))
8660 (dotimes (i (1+ dist))
8661 (while (member day-of-week org-agenda-weekend-days)
8662 (incf distance)
8663 (incf day-of-week)
8664 (if (= day-of-week 7)
8665 (setq day-of-week 0)))
8666 (incf day-of-week)
8667 (if (= day-of-week 7)
8668 (setq day-of-week 0)))))
8669 ;; silently fail when try to replan a sexp entry
8670 (condition-case nil
8671 (let* ((date (calendar-gregorian-from-absolute
8672 (+ (org-today) distance)))
8673 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date)
8674 (nth 2 date))))
8675 (org-agenda-schedule nil time))
8676 (error nil)))))))
8678 ((assoc action org-agenda-bulk-custom-functions)
8679 (setq cmd (list (cadr (assoc action org-agenda-bulk-custom-functions)))
8680 redo-at-end t))
8682 ((equal action ?f)
8683 (setq cmd (list (intern
8684 (org-icompleting-read "Function: "
8685 obarray 'fboundp t nil nil)))))
8687 (t (error "Invalid bulk action")))
8689 ;; Sort the markers, to make sure that parents are handled before children
8690 (setq entries (sort entries
8691 (lambda (a b)
8692 (cond
8693 ((equal (marker-buffer a) (marker-buffer b))
8694 (< (marker-position a) (marker-position b)))
8696 (string< (buffer-name (marker-buffer a))
8697 (buffer-name (marker-buffer b))))))))
8699 ;; Now loop over all markers and apply cmd
8700 (while (setq e (pop entries))
8701 (setq pos (text-property-any (point-min) (point-max) 'org-hd-marker e))
8702 (if (not pos)
8703 (progn (message "Skipping removed entry at %s" e)
8704 (setq cntskip (1+ cntskip)))
8705 (goto-char pos)
8706 (let (org-loop-over-headlines-in-active-region)
8707 (eval cmd))
8708 (setq org-agenda-bulk-marked-entries
8709 (delete e org-agenda-bulk-marked-entries))
8710 (setq cnt (1+ cnt))))
8711 (setq org-agenda-bulk-marked-entries nil)
8712 (org-agenda-bulk-remove-all-marks)
8713 (when redo-at-end (org-agenda-redo))
8714 (message "Acted on %d entries%s"
8716 (if (= cntskip 0)
8718 (format ", skipped %d (disappeared before their turn)"
8719 cntskip)))))
8721 ;;; Flagging notes
8723 (defun org-agenda-show-the-flagging-note ()
8724 "Display the flagging note in the other window.
8725 When called a second time in direct sequence, offer to remove the FLAGGING
8726 tag and (if present) the flagging note."
8727 (interactive)
8728 (let ((hdmarker (org-get-at-bol 'org-hd-marker))
8729 (win (selected-window))
8730 note heading newhead)
8731 (unless hdmarker
8732 (error "No linked entry at point"))
8733 (if (and (eq this-command last-command)
8734 (y-or-n-p "Unflag and remove any flagging note? "))
8735 (progn
8736 (org-agenda-remove-flag hdmarker)
8737 (let ((win (get-buffer-window "*Flagging Note*")))
8738 (and win (delete-window win)))
8739 (message "Entry unflagged"))
8740 (setq note (org-entry-get hdmarker "THEFLAGGINGNOTE"))
8741 (unless note
8742 (error "No flagging note"))
8743 (org-kill-new note)
8744 (org-switch-to-buffer-other-window "*Flagging Note*")
8745 (erase-buffer)
8746 (insert note)
8747 (goto-char (point-min))
8748 (while (re-search-forward "\\\\n" nil t)
8749 (replace-match "\n" t t))
8750 (goto-char (point-min))
8751 (select-window win)
8752 (message "Flagging note pushed to kill ring. Press [?] again to remove tag and note"))))
8754 (defun org-agenda-remove-flag (marker)
8755 "Remove the FLAGGED tag and any flagging note in the entry."
8756 (let (newhead)
8757 (org-with-point-at marker
8758 (org-toggle-tag "FLAGGED" 'off)
8759 (org-entry-delete nil "THEFLAGGINGNOTE")
8760 (setq newhead (org-get-heading)))
8761 (org-agenda-change-all-lines newhead marker)
8762 (message "Entry unflagged")))
8764 (defun org-agenda-get-any-marker (&optional pos)
8765 (or (get-text-property (or pos (point-at-bol)) 'org-hd-marker)
8766 (get-text-property (or pos (point-at-bol)) 'org-marker)))
8768 ;;; Appointment reminders
8770 (defvar appt-time-msg-list)
8772 ;;;###autoload
8773 (defun org-agenda-to-appt (&optional refresh filter &rest args)
8774 "Activate appointments found in `org-agenda-files'.
8775 With a \\[universal-argument] prefix, refresh the list of
8776 appointments.
8778 If FILTER is t, interactively prompt the user for a regular
8779 expression, and filter out entries that don't match it.
8781 If FILTER is a string, use this string as a regular expression
8782 for filtering entries out.
8784 If FILTER is a function, filter out entries against which
8785 calling the function returns nil. This function takes one
8786 argument: an entry from `org-agenda-get-day-entries'.
8788 FILTER can also be an alist with the car of each cell being
8789 either 'headline or 'category. For example:
8791 '((headline \"IMPORTANT\")
8792 (category \"Work\"))
8794 will only add headlines containing IMPORTANT or headlines
8795 belonging to the \"Work\" category.
8797 ARGS are symbols indicating what kind of entries to consider.
8798 By default `org-agenda-to-appt' will use :deadline, :scheduled
8799 and :timestamp entries. See the docstring of `org-diary' for
8800 details and examples."
8801 (interactive "P")
8802 (if refresh (setq appt-time-msg-list nil))
8803 (if (eq filter t)
8804 (setq filter (read-from-minibuffer "Regexp filter: ")))
8805 (let* ((cnt 0) ; count added events
8806 (scope (or args '(:deadline :scheduled :timestamp)))
8807 (org-agenda-new-buffers nil)
8808 (org-deadline-warning-days 0)
8809 ;; Do not use `org-today' here because appt only takes
8810 ;; time and without date as argument, so it may pass wrong
8811 ;; information otherwise
8812 (today (org-date-to-gregorian
8813 (time-to-days (current-time))))
8814 (org-agenda-restrict nil)
8815 (files (org-agenda-files 'unrestricted)) entries file)
8816 ;; Get all entries which may contain an appt
8817 (org-prepare-agenda-buffers files)
8818 (while (setq file (pop files))
8819 (setq entries
8820 (delq nil
8821 (append entries
8822 (apply 'org-agenda-get-day-entries
8823 file today scope)))))
8824 ;; Map thru entries and find if we should filter them out
8825 (mapc
8826 (lambda(x)
8827 (let* ((evt (org-trim (or (get-text-property 1 'txt x) "")))
8828 (cat (get-text-property 1 'org-category x))
8829 (tod (get-text-property 1 'time-of-day x))
8830 (ok (or (null filter)
8831 (and (stringp filter) (string-match filter evt))
8832 (and (functionp filter) (funcall filter x))
8833 (and (listp filter)
8834 (let ((cat-filter (cadr (assoc 'category filter)))
8835 (evt-filter (cadr (assoc 'headline filter))))
8836 (or (and (stringp cat-filter)
8837 (string-match cat-filter cat))
8838 (and (stringp evt-filter)
8839 (string-match evt-filter evt))))))))
8840 ;; FIXME: Shall we remove text-properties for the appt text?
8841 ;; (setq evt (set-text-properties 0 (length evt) nil evt))
8842 (when (and ok tod)
8843 (setq tod (concat "00" (number-to-string tod))
8844 tod (when (string-match
8845 "\\([0-9]\\{1,2\\}\\)\\([0-9]\\{2\\}\\)\\'" tod)
8846 (concat (match-string 1 tod) ":"
8847 (match-string 2 tod))))
8848 (appt-add tod evt)
8849 (setq cnt (1+ cnt))))) entries)
8850 (org-release-buffers org-agenda-new-buffers)
8851 (if (eq cnt 0)
8852 (message "No event to add")
8853 (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
8855 (defun org-agenda-todayp (date)
8856 "Does DATE mean today, when considering `org-extend-today-until'?"
8857 (let ((today (org-today))
8858 (date (if (and date (listp date)) (calendar-absolute-from-gregorian date)
8859 date)))
8860 (eq date today)))
8862 (defun org-agenda-todo-yesterday (&optional arg)
8863 "Like `org-agenda-todo' but the time of change will be 23:59 of yesterday"
8864 (interactive "P")
8865 (let* ((hour (third (decode-time
8866 (org-current-time))))
8867 (org-extend-today-until (1+ hour)))
8868 (org-agenda-todo arg)))
8870 (provide 'org-agenda)
8872 ;;; org-agenda.el ends here