Add indirect agenda follow mode
[org-mode.git] / lisp / org-agenda.el
1 ;;; org-agenda.el --- Dynamic task and appointment lists for Org
2
3 ;; Copyright (C) 2004-2011 Free Software Foundation, Inc.
4
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.
10 ;;
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.
15
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.
20
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 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
24 ;;
25 ;;; Commentary:
26
27 ;; This file contains the code for creating and using the Agenda for Org-mode.
28 ;;
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 conveniant 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:
35 ;;
36 ;;   emacs -batch -l ~/.emacs -eval '(org-batch-agenda "a" org-agenda-span 7)'
37 ;;
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.
42 ;;
43 ;; This is a hack, but it works even when running Org byte-compiled.
44 ;;
45
46 ;;; Code:
47
48 (require 'org)
49 (eval-when-compile
50   (require 'cl))
51
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 org-datetree-find-date-create "org-datetree"
70                   (date &optional keep-restriction))
71 (declare-function org-columns-quit              "org-colview" ())
72 (declare-function diary-date-display-form       "diary-lib"  (&optional type))
73 (declare-function org-mobile-write-agenda-for-mobile "org-mobile" (file))
74 (declare-function org-habit-insert-consistency-graphs
75                   "org-habit" (&optional line))
76 (declare-function org-is-habit-p "org-habit" (&optional pom))
77 (declare-function org-habit-parse-todo "org-habit" (&optional pom))
78 (declare-function org-habit-get-priority "org-habit" (habit &optional moment))
79 (declare-function org-pop-to-buffer-same-window "org-compat"
80                   (&optional buffer-or-name norecord label))
81
82 (defvar calendar-mode-map)
83 (defvar org-clock-current-task) ; defined in org-clock.el
84 (defvar org-mobile-force-id-on-agenda-items) ; defined in org-mobile.el
85 (defvar org-habit-show-habits)
86 (defvar org-habit-show-habits-only-for-today)
87
88 ;; Defined somewhere in this file, but used before definition.
89 (defvar org-agenda-buffer-name)
90 (defvar org-agenda-overriding-header)
91 (defvar org-agenda-title-append nil)
92 (defvar entry)
93 (defvar date)
94 (defvar org-agenda-undo-list)
95 (defvar org-agenda-pending-undo-list)
96 (defvar original-date) ; dynamically scoped, calendar.el does scope this
97
98 (defcustom org-agenda-confirm-kill 1
99   "When set, remote killing from the agenda buffer needs confirmation.
100 When t, a confirmation is always needed.  When a number N, confirmation is
101 only needed when the text to be killed contains more than N non-white lines."
102   :group 'org-agenda
103   :type '(choice
104           (const :tag "Never" nil)
105           (const :tag "Always" t)
106           (integer :tag "When more than N lines")))
107
108 (defcustom org-agenda-compact-blocks nil
109   "Non-nil means make the block agenda more compact.
110 This is done globally by leaving out lines like the agenda span
111 name and week number or the separator lines."
112   :group 'org-agenda
113   :type 'boolean)
114
115 (defcustom org-agenda-block-separator ?=
116   "The separator between blocks in the agenda.
117 If this is a string, it will be used as the separator, with a newline added.
118 If it is a character, it will be repeated to fill the window width.
119 If nil the separator is disabled.  In `org-agenda-custom-commands' this
120 addresses the separator between the current and the previous block."
121   :group 'org-agenda
122   :type '(choice
123           (const :tag "Disabled" nil)
124           (character)
125           (string)))
126
127 (defgroup org-agenda-export nil
128  "Options concerning exporting agenda views in Org-mode."
129  :tag "Org Agenda Export"
130  :group 'org-agenda)
131
132 (defcustom org-agenda-with-colors t
133   "Non-nil means use colors in agenda views."
134   :group 'org-agenda-export
135   :type 'boolean)
136
137 (defcustom org-agenda-exporter-settings nil
138   "Alist of variable/value pairs that should be active during agenda export.
139 This is a good place to set options for ps-print and for htmlize.
140 Note that the way this is implemented, the values will be evaluated
141 before assigned to the variables.  So make sure to quote values you do
142 *not* want evaluated, for example
143
144    (setq org-agenda-exporter-settings
145          '((ps-print-color-p 'black-white)))"
146   :group 'org-agenda-export
147   :type '(repeat
148           (list
149            (variable)
150            (sexp :tag "Value"))))
151
152 (defcustom org-agenda-before-write-hook '(org-agenda-add-entry-text)
153   "Hook run in temporary buffer before writing it to an export file.
154 A useful function is `org-agenda-add-entry-text'."
155   :group 'org-agenda-export
156   :type 'hook
157   :options '(org-agenda-add-entry-text))
158
159 (defcustom org-agenda-add-entry-text-maxlines 0
160   "Maximum number of entry text lines to be added to agenda.
161 This is only relevant when `org-agenda-add-entry-text' is part of
162 `org-agenda-before-write-hook', which it is by default.
163 When this is 0, nothing will happen.  When it is greater than 0, it
164 specifies the maximum number of lines that will be added for each entry
165 that is listed in the agenda view.
166
167 Note that this variable is not used during display, only when exporting
168 the agenda.  For agenda display, see the variables `org-agenda-entry-text-mode'
169 and `org-agenda-entry-text-maxlines'."
170   :group 'org-agenda
171   :type 'integer)
172
173 (defcustom org-agenda-add-entry-text-descriptive-links t
174   "Non-nil means export org-links as descriptive links in agenda added text.
175 This variable applies to the text added to the agenda when
176 `org-agenda-add-entry-text-maxlines' is larger than 0.
177 When this variable nil, the URL will (also) be shown."
178   :group 'org-agenda
179   :type 'boolean)
180
181 (defcustom org-agenda-export-html-style ""
182   "The style specification for exported HTML Agenda files.
183 If this variable contains a string, it will replace the default <style>
184 section as produced by `htmlize'.
185 Since there are different ways of setting style information, this variable
186 needs to contain the full HTML structure to provide a style, including the
187 surrounding HTML tags.  The style specifications should include definitions
188 the fonts used by the agenda, here is an example:
189
190    <style type=\"text/css\">
191        p { font-weight: normal; color: gray; }
192        .org-agenda-structure {
193           font-size: 110%;
194           color: #003399;
195           font-weight: 600;
196        }
197        .org-todo {
198           color: #cc6666;
199           font-weight: bold;
200        }
201        .org-agenda-done {
202           color: #339933;
203        }
204        .org-done {
205           color: #339933;
206        }
207        .title { text-align: center; }
208        .todo, .deadline { color: red; }
209        .done { color: green; }
210     </style>
211
212 or, if you want to keep the style in a file,
213
214    <link rel=\"stylesheet\" type=\"text/css\" href=\"mystyles.css\">
215
216 As the value of this option simply gets inserted into the HTML <head> header,
217 you can \"misuse\" it to also add other text to the header.  However,
218 <style>...</style> is required, if not present the variable will be ignored."
219   :group 'org-agenda-export
220   :group 'org-export-html
221   :type 'string)
222
223 (defcustom org-agenda-persistent-filter nil
224   "When set, keep filters from one agenda view to the next."
225   :group 'org-agenda
226   :type 'boolean)
227
228 (defgroup org-agenda-custom-commands nil
229  "Options concerning agenda views in Org-mode."
230  :tag "Org Agenda Custom Commands"
231  :group 'org-agenda)
232
233 (defconst org-sorting-choice
234   '(choice
235     (const time-up) (const time-down)
236     (const category-keep) (const category-up) (const category-down)
237     (const tag-down) (const tag-up)
238     (const priority-up) (const priority-down)
239     (const todo-state-up) (const todo-state-down)
240     (const effort-up) (const effort-down)
241     (const habit-up) (const habit-down)
242     (const alpha-up) (const alpha-down)
243     (const user-defined-up) (const user-defined-down))
244   "Sorting choices.")
245
246 (defconst org-agenda-custom-commands-local-options
247   `(repeat :tag "Local settings for this command. Remember to quote values"
248            (choice :tag "Setting"
249             (list :tag "Heading for this block"
250                   (const org-agenda-overriding-header)
251                   (string :tag "Headline"))
252             (list :tag "Files to be searched"
253                   (const org-agenda-files)
254                   (list
255                    (const :format "" quote)
256                    (repeat (file))))
257             (list :tag "Sorting strategy"
258                   (const org-agenda-sorting-strategy)
259                   (list
260                    (const :format "" quote)
261                    (repeat
262                     ,org-sorting-choice)))
263             (list :tag "Prefix format"
264                   (const org-agenda-prefix-format :value "  %-12:c%?-12t% s")
265                   (string))
266             (list :tag "Number of days in agenda"
267                   (const org-agenda-span)
268                   (choice (const :tag "Day" 'day)
269                           (const :tag "Week" 'week)
270                           (const :tag "Month" 'month)
271                           (const :tag "Year" 'year)
272                           (integer :tag "Custom")))
273             (list :tag "Fixed starting date"
274                   (const org-agenda-start-day)
275                   (string :value "2007-11-01"))
276             (list :tag "Start on day of week"
277                   (const org-agenda-start-on-weekday)
278                   (choice :value 1
279                           (const :tag "Today" nil)
280                           (integer :tag "Weekday No.")))
281             (list :tag "Include data from diary"
282                   (const org-agenda-include-diary)
283                   (boolean))
284             (list :tag "Deadline Warning days"
285                   (const org-deadline-warning-days)
286                   (integer :value 1))
287             (list :tag "Tags filter preset"
288                   (const org-agenda-filter-preset)
289                   (list
290                    (const :format "" quote)
291                    (repeat
292                     (string :tag "+tag or -tag"))))
293             (list :tag "Set daily/weekly entry types"
294                   (const org-agenda-entry-types)
295                   (set :greedy t :value (:deadline :scheduled :timestamp :sexp)
296                        (const :deadline)
297                        (const :scheduled)
298                        (const :timestamp)
299                        (const :sexp)))
300             (list :tag "Standard skipping condition"
301                   :value (org-agenda-skip-function '(org-agenda-skip-entry-if))
302                   (const org-agenda-skip-function)
303                   (list
304                    (const :format "" quote)
305                    (list
306                     (choice
307                      :tag "Skipping range"
308                      (const :tag "Skip entry" org-agenda-skip-entry-if)
309                      (const :tag "Skip subtree" org-agenda-skip-subtree-if))
310                     (repeat :inline t :tag "Conditions for skipping"
311                             (choice
312                              :tag "Condition type"
313                              (list :tag "Regexp matches" :inline t (const :format "" 'regexp) (regexp))
314                              (list :tag "Regexp does not match" :inline t (const :format "" 'notregexp) (regexp))
315                              (list :tag "TODO state is" :inline t
316                                    (const 'todo)
317                                    (choice
318                                     (const :tag "any not-done state" 'todo)
319                                     (const :tag "any done state" 'done)
320                                     (const :tag "any state" 'any)
321                                     (list :tag "Keyword list"
322                                           (const :format "" quote)
323                                           (repeat (string :tag "Keyword")))))
324                              (list :tag "TODO state is not" :inline t
325                                    (const 'nottodo)
326                                    (choice
327                                     (const :tag "any not-done state" 'todo)
328                                     (const :tag "any done state" 'done)
329                                     (const :tag "any state" 'any)
330                                     (list :tag "Keyword list"
331                                           (const :format "" quote)
332                                           (repeat (string :tag "Keyword")))))
333                              (const :tag "scheduled" 'scheduled)
334                              (const :tag "not scheduled" 'notscheduled)
335                              (const :tag "deadline" 'deadline)
336                              (const :tag "no deadline" 'notdeadline)
337                              (const :tag "timestamp" 'timestamp)
338                              (const :tag "no timestamp" 'nottimestamp))))))
339             (list :tag "Non-standard skipping condition"
340                   :value (org-agenda-skip-function)
341                   (const org-agenda-skip-function)
342                   (sexp :tag "Function or form (quoted!)"))
343             (list :tag "Any variable"
344                   (variable :tag "Variable")
345                   (sexp :tag "Value (sexp)"))))
346   "Selection of examples for agenda command settings.
347 This will be spliced into the custom type of
348 `org-agenda-custom-commands'.")
349
350
351 (defcustom org-agenda-custom-commands '(("n" "Agenda and all TODO's"
352                                          ((agenda "") (alltodo))))
353   "Custom commands for the agenda.
354 These commands will be offered on the splash screen displayed by the
355 agenda dispatcher \\[org-agenda].  Each entry is a list like this:
356
357    (key desc type match settings files)
358
359 key      The key (one or more characters as a string) to be associated
360          with the command.
361 desc     A description of the command, when omitted or nil, a default
362          description is built using MATCH.
363 type     The command type, any of the following symbols:
364           agenda      The daily/weekly agenda.
365           todo        Entries with a specific TODO keyword, in all agenda files.
366           search      Entries containing search words entry or headline.
367           tags        Tags/Property/TODO match in all agenda files.
368           tags-todo   Tags/P/T match in all agenda files, TODO entries only.
369           todo-tree   Sparse tree of specific TODO keyword in *current* file.
370           tags-tree   Sparse tree with all tags matches in *current* file.
371           occur-tree  Occur sparse tree for *current* file.
372           ...         A user-defined function.
373 match    What to search for:
374           - a single keyword for TODO keyword searches
375           - a tags match expression for tags searches
376           - a word search expression for text searches.
377           - a regular expression for occur searches
378           For all other commands, this should be the empty string.
379 settings  A list of option settings, similar to that in a let form, so like
380           this: ((opt1 val1) (opt2 val2) ...).   The values will be
381           evaluated at the moment of execution, so quote them when needed.
382 files     A list of files file to write the produced agenda buffer to
383           with the command `org-store-agenda-views'.
384           If a file name ends in \".html\", an HTML version of the buffer
385           is written out.  If it ends in \".ps\", a postscript version is
386           produced.  Otherwise, only the plain text is written to the file.
387
388 You can also define a set of commands, to create a composite agenda buffer.
389 In this case, an entry looks like this:
390
391   (key desc (cmd1 cmd2 ...) general-settings-for-whole-set files)
392
393 where
394
395 desc   A description string to be displayed in the dispatcher menu.
396 cmd    An agenda command, similar to the above.  However, tree commands
397        are no allowed, but instead you can get agenda and global todo list.
398        So valid commands for a set are:
399        (agenda \"\" settings)
400        (alltodo \"\" settings)
401        (stuck \"\" settings)
402        (todo \"match\" settings files)
403        (search \"match\" settings files)
404        (tags \"match\" settings files)
405        (tags-todo \"match\" settings files)
406
407 Each command can carry a list of options, and another set of options can be
408 given for the whole set of commands.  Individual command options take
409 precedence over the general options.
410
411 When using several characters as key to a command, the first characters
412 are prefix commands.  For the dispatcher to display useful information, you
413 should provide a description for the prefix, like
414
415  (setq org-agenda-custom-commands
416    '((\"h\" . \"HOME + Name tag searches\") ; describe prefix \"h\"
417      (\"hl\" tags \"+HOME+Lisa\")
418      (\"hp\" tags \"+HOME+Peter\")
419      (\"hk\" tags \"+HOME+Kim\")))"
420   :group 'org-agenda-custom-commands
421   :type `(repeat
422           (choice :value ("x" "Describe command here" tags "" nil)
423            (list :tag "Single command"
424                  (string :tag "Access Key(s) ")
425                  (option (string :tag "Description"))
426                  (choice
427                   (const :tag "Agenda" agenda)
428                   (const :tag "TODO list" alltodo)
429                   (const :tag "Search words" search)
430                   (const :tag "Stuck projects" stuck)
431                   (const :tag "Tags/Property match (all agenda files)" tags)
432                   (const :tag "Tags/Property match of TODO entries (all agenda files)" tags-todo)
433                   (const :tag "TODO keyword search (all agenda files)" todo)
434                   (const :tag "Tags sparse tree (current buffer)" tags-tree)
435                   (const :tag "TODO keyword tree (current buffer)" todo-tree)
436                   (const :tag "Occur tree (current buffer)" occur-tree)
437                   (sexp :tag "Other, user-defined function"))
438                  (string :tag "Match (only for some commands)")
439                  ,org-agenda-custom-commands-local-options
440                  (option (repeat :tag "Export" (file :tag "Export to"))))
441            (list :tag "Command series, all agenda files"
442                  (string :tag "Access Key(s)")
443                  (string :tag "Description  ")
444                  (repeat :tag "Component"
445                   (choice
446                    (list :tag "Agenda"
447                          (const :format "" agenda)
448                          (const :tag "" :format "" "")
449                          ,org-agenda-custom-commands-local-options)
450                    (list :tag "TODO list (all keywords)"
451                          (const :format "" alltodo)
452                          (const :tag "" :format "" "")
453                          ,org-agenda-custom-commands-local-options)
454                    (list :tag "Search words"
455                          (const :format "" search)
456                          (string :tag "Match")
457                          ,org-agenda-custom-commands-local-options)
458                    (list :tag "Stuck projects"
459                          (const :format "" stuck)
460                          (const :tag "" :format "" "")
461                          ,org-agenda-custom-commands-local-options)
462                    (list :tag "Tags search"
463                          (const :format "" tags)
464                          (string :tag "Match")
465                          ,org-agenda-custom-commands-local-options)
466                    (list :tag "Tags search, TODO entries only"
467                          (const :format "" tags-todo)
468                          (string :tag "Match")
469                          ,org-agenda-custom-commands-local-options)
470                    (list :tag "TODO keyword search"
471                          (const :format "" todo)
472                          (string :tag "Match")
473                          ,org-agenda-custom-commands-local-options)
474                    (list :tag "Other, user-defined function"
475                          (symbol :tag "function")
476                          (string :tag "Match")
477                          ,org-agenda-custom-commands-local-options)))
478
479                  (repeat :tag "Settings for entire command set"
480                          (list (variable :tag "Any variable")
481                                (sexp :tag "Value")))
482                  (option (repeat :tag "Export" (file :tag "Export to"))))
483            (cons :tag "Prefix key documentation"
484                  (string :tag "Access Key(s)")
485                  (string :tag "Description  ")))))
486
487 (defcustom org-agenda-query-register ?o
488   "The register holding the current query string.
489 The purpose of this is that if you construct a query string interactively,
490 you can then use it to define a custom command."
491   :group 'org-agenda-custom-commands
492   :type 'character)
493
494 (defcustom org-stuck-projects
495   '("+LEVEL=2/-DONE" ("TODO" "NEXT" "NEXTACTION") nil "")
496   "How to identify stuck projects.
497 This is a list of four items:
498 1. A tags/todo/property matcher string that is used to identify a project.
499    See the manual for a description of tag and property searches.
500    The entire tree below a headline matched by this is considered one project.
501 2. A list of TODO keywords identifying non-stuck projects.
502    If the project subtree contains any headline with one of these todo
503    keywords, the project is considered to be not stuck.  If you specify
504    \"*\" as a keyword, any TODO keyword will mark the project unstuck.
505 3. A list of tags identifying non-stuck projects.
506    If the project subtree contains any headline with one of these tags,
507    the project is considered to be not stuck.  If you specify \"*\" as
508    a tag, any tag will mark the project unstuck.  Note that this is about
509    the explicit presence of a tag somewhere in the subtree, inherited
510    tags to not count here.  If inherited tags make a project not stuck,
511    use \"-TAG\" in the tags part of the matcher under (1.) above.
512 4. An arbitrary regular expression matching non-stuck projects.
513
514 If the project turns out to be not stuck, search continues also in the
515 subtree to see if any of the subtasks have project status.
516
517 See also the variable `org-tags-match-list-sublevels' which applies
518 to projects matched by this search as well.
519
520 After defining this variable, you may use \\[org-agenda-list-stuck-projects]
521 or `C-c a #' to produce the list."
522   :group 'org-agenda-custom-commands
523   :type '(list
524           (string :tag "Tags/TODO match to identify a project")
525           (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
526           (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
527           (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
528
529 (defcustom org-agenda-filter-effort-default-operator "<"
530   "The default operator for effort estimate filtering.
531 If you select an effort estimate limit without first pressing an operator,
532 this one will be used."
533   :group 'org-agenda-custom-commands
534   :type '(choice (const :tag "less or equal" "<")
535                  (const :tag "greater or equal"">")
536                  (const :tag "equal" "=")))
537
538 (defgroup org-agenda-skip nil
539  "Options concerning skipping parts of agenda files."
540  :tag "Org Agenda Skip"
541  :group 'org-agenda)
542
543 (defcustom org-agenda-skip-function-global nil
544   "Function to be called at each match during agenda construction.
545 If this function returns nil, the current match should not be skipped.
546 If the function decided to skip an agenda match, is must return the
547 buffer position from which the search should be continued.
548 This may also be a Lisp form, which will be evaluated.
549
550 This variable will be applied to every agenda match, including
551 tags/property searches and TODO lists.  So try to make the test function
552 do its checking as efficiently as possible.  To implement a skipping
553 condition just for specific agenda commands, use the variable
554 `org-agenda-skip-function' which can be set in the options section
555 of custom agenda commands."
556   :group 'org-agenda-skip
557   :type 'sexp)
558
559 (defgroup org-agenda-daily/weekly nil
560   "Options concerning the daily/weekly agenda."
561   :tag "Org Agenda Daily/Weekly"
562   :group 'org-agenda)
563 (defgroup org-agenda-todo-list nil
564   "Options concerning the global todo list agenda view."
565   :tag "Org Agenda Todo List"
566   :group 'org-agenda)
567 (defgroup org-agenda-match-view nil
568   "Options concerning the general tags/property/todo match agenda view."
569   :tag "Org Agenda Match View"
570   :group 'org-agenda)
571 (defgroup org-agenda-search-view nil
572   "Options concerning the general tags/property/todo match agenda view."
573   :tag "Org Agenda Match View"
574   :group 'org-agenda)
575
576 (defvar org-agenda-archives-mode nil
577   "Non-nil means the agenda will include archived items.
578 If this is the symbol `trees', trees in the selected agenda scope
579 that are marked with the ARCHIVE tag will be included anyway.  When this is
580 t, also all archive files associated with the current selection of agenda
581 files will be included.")
582
583 (defcustom org-agenda-skip-comment-trees t
584   "Non-nil means skip trees that start with the COMMENT keyword.
585 When nil, these trees are also scanned by agenda commands."
586   :group 'org-agenda-skip
587   :type 'boolean)
588
589 (defcustom org-agenda-todo-list-sublevels t
590   "Non-nil means check also the sublevels of a TODO entry for TODO entries.
591 When nil, the sublevels of a TODO entry are not checked, resulting in
592 potentially much shorter TODO lists."
593   :group 'org-agenda-skip
594   :group 'org-agenda-todo-list
595   :type 'boolean)
596
597 (defcustom org-agenda-todo-ignore-with-date nil
598   "Non-nil means don't show entries with a date in the global todo list.
599 You can use this if you prefer to mark mere appointments with a TODO keyword,
600 but don't want them to show up in the TODO list.
601 When this is set, it also covers deadlines and scheduled items, the settings
602 of `org-agenda-todo-ignore-scheduled' and `org-agenda-todo-ignore-deadlines'
603 will be ignored.
604 See also the variable `org-agenda-tags-todo-honor-ignore-options'."
605   :group 'org-agenda-skip
606   :group 'org-agenda-todo-list
607   :type 'boolean)
608
609 (defcustom org-agenda-todo-ignore-timestamp nil
610   "Non-nil means don't show entries with a timestamp.
611 This applies when creating the global todo list.
612 Valid values are:
613
614 past     Don't show entries for today or in the past.
615
616 future   Don't show entries with a timestamp in the future.
617          The idea behind this is that if it has a future
618          timestamp, you don't want to think about it until the
619          date.
620
621 all      Don't show any entries with a timestamp in the global todo list.
622          The idea behind this is that by setting a timestamp, you
623          have already \"taken care\" of this item.
624
625 This variable can also have an integer as a value. If positive (N),
626 todos with a timestamp N or more days in the future will be ignored. If
627 negative (-N), todos with a timestamp N or more days in the past will be
628 ignored. If 0, todos with a timestamp either today or in the future will
629 be ignored. For example, a value of -1 will exclude todos with a
630 timestamp in the past (yesterday or earlier), while a value of 7 will
631 exclude todos with a timestamp a week or more in the future.
632
633 See also `org-agenda-todo-ignore-with-date'.
634 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
635 to make his option also apply to the tags-todo list."
636   :group 'org-agenda-skip
637   :group 'org-agenda-todo-list
638   :type '(choice
639           (const :tag "Ignore future timestamp todos" future)
640           (const :tag "Ignore past or present timestamp todos" past)
641           (const :tag "Ignore all timestamp todos" all)
642           (const :tag "Show timestamp todos" nil)
643           (integer :tag "Ignore if N or more days in past(-) or future(+).")))
644
645 (defcustom org-agenda-todo-ignore-scheduled nil
646   "Non-nil means, ignore some scheduled TODO items when making TODO list.
647 This applies when creating the global todo list.
648 Valid values are:
649
650 past     Don't show entries scheduled today or in the past.
651
652 future   Don't show entries scheduled in the future.
653          The idea behind this is that by scheduling it, you don't want to
654          think about it until the scheduled date.
655
656 all      Don't show any scheduled entries in the global todo list.
657          The idea behind this is that by scheduling it, you have already
658          \"taken care\" of this item.
659
660 t        Same as `all', for backward compatibility.
661
662 This variable can also have an integer as a value. See
663 `org-agenda-todo-ignore-timestamp' for more details.
664
665 See also `org-agenda-todo-ignore-with-date'.
666 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
667 to make his option also apply to the tags-todo list."
668   :group 'org-agenda-skip
669   :group 'org-agenda-todo-list
670   :type '(choice
671           (const :tag "Ignore future-scheduled todos" future)
672           (const :tag "Ignore past- or present-scheduled todos" past)
673           (const :tag "Ignore all scheduled todos" all)
674           (const :tag "Ignore all scheduled todos (compatibility)" t)
675           (const :tag "Show scheduled todos" nil)
676           (integer :tag "Ignore if N or more days in past(-) or future(+).")))
677
678 (defcustom org-agenda-todo-ignore-deadlines nil
679   "Non-nil means ignore some deadlined TODO items when making TODO list.
680 There are different motivations for using different values, please think
681 carefully when configuring this variable.
682
683 This applies when creating the global todo list.
684 Valid values are:
685
686 near    Don't show near deadline entries.  A deadline is near when it is
687         closer than `org-deadline-warning-days' days.  The idea behind this
688         is that such items will appear in the agenda anyway.
689
690 far     Don't show TODO entries where a deadline has been defined, but
691         the deadline is not near.  This is useful if you don't want to
692         use the todo list to figure out what to do now.
693
694 past    Don't show entries with a deadline timestamp for today or in the past.
695
696 future  Don't show entries with a deadline timestamp in the future, not even
697         when they become `near' ones.  Use it with caution.
698
699 all     Ignore all TODO entries that do have a deadline.
700
701 t       Same as `near', for backward compatibility.
702
703 This variable can also have an integer as a value. See
704 `org-agenda-todo-ignore-timestamp' for more details.
705
706 See also `org-agenda-todo-ignore-with-date'.
707 See also the variable `org-agenda-tags-todo-honor-ignore-options' if you want
708 to make his option also apply to the tags-todo list."
709   :group 'org-agenda-skip
710   :group 'org-agenda-todo-list
711   :type '(choice
712           (const :tag "Ignore near deadlines" near)
713           (const :tag "Ignore near deadlines (compatibility)" t)
714           (const :tag "Ignore far deadlines" far)
715           (const :tag "Ignore all TODOs with a deadlines" all)
716           (const :tag "Show all TODOs, even if they have a deadline" nil)
717           (integer :tag "Ignore if N or more days in past(-) or future(+).")))
718
719 (defcustom org-agenda-tags-todo-honor-ignore-options nil
720   "Non-nil means honor todo-list ...ignore options also in tags-todo search.
721 The variables
722    `org-agenda-todo-ignore-with-date',
723    `org-agenda-todo-ignore-timestamp',
724    `org-agenda-todo-ignore-scheduled',
725    `org-agenda-todo-ignore-deadlines'
726 make the global TODO list skip entries that have time stamps of certain
727 kinds.  If this option is set, the same options will also apply for the
728 tags-todo search, which is the general tags/property matcher
729 restricted to unfinished TODO entries only."
730   :group 'org-agenda-skip
731   :group 'org-agenda-todo-list
732   :group 'org-agenda-match-view
733   :type 'boolean)
734
735 (defcustom org-agenda-skip-scheduled-if-done nil
736   "Non-nil means don't show scheduled items in agenda when they are done.
737 This is relevant for the daily/weekly agenda, not for the TODO list.  And
738 it applies only to the actual date of the scheduling.  Warnings about
739 an item with a past scheduling dates are always turned off when the item
740 is DONE."
741   :group 'org-agenda-skip
742   :group 'org-agenda-daily/weekly
743   :type 'boolean)
744
745 (defcustom org-agenda-skip-scheduled-if-deadline-is-shown nil
746   "Non-nil means skip scheduling line if same entry shows because of deadline.
747 In the agenda of today, an entry can show up multiple times because
748 it is both scheduled and has a nearby deadline, and maybe a plain time
749 stamp as well.
750 When this variable is t, then only the deadline is shown and the fact that
751 the entry is scheduled today or was scheduled previously is not shown.
752 When this variable is nil, the entry will be shown several times.  When
753 the variable is the symbol `not-today', then skip scheduled previously,
754 but not scheduled today."
755   :group 'org-agenda-skip
756   :group 'org-agenda-daily/weekly
757   :type '(choice
758           (const :tag "Never" nil)
759           (const :tag "Always" t)
760           (const :tag "Not when scheduled today" not-today)))
761
762 (defcustom org-agenda-skip-deadline-if-done nil
763   "Non-nil means don't show deadlines when the corresponding item is done.
764 When nil, the deadline is still shown and should give you a happy feeling.
765 This is relevant for the daily/weekly agenda.  And it applied only to the
766 actually date of the deadline.  Warnings about approaching and past-due
767 deadlines are always turned off when the item is DONE."
768   :group 'org-agenda-skip
769   :group 'org-agenda-daily/weekly
770   :type 'boolean)
771
772 (defcustom org-agenda-skip-deadline-prewarning-if-scheduled nil
773   "Non-nil means skip deadline prewarning when entry is also scheduled.
774 This will apply on all days where a prewarning for the deadline would
775 be shown, but not at the day when the entry is actually due.  On that day,
776 the deadline will be shown anyway.
777 This variable may be set to nil, t, or a number which will then give
778 the number of days before the actual deadline when the prewarnings
779 should resume.
780 This can be used in a workflow where the first showing of the deadline will
781 trigger you to schedule it, and then you don't want to be reminded of it
782 because you will take care of it on the day when scheduled."
783   :group 'org-agenda-skip
784   :group 'org-agenda-daily/weekly
785   :type '(choice
786           (const :tag "Alwas show prewarning" nil)
787           (const :tag "Remove prewarning if entry is scheduled" t)
788           (integer :tag "Restart prewarning N days before deadline")))
789
790 (defcustom org-agenda-skip-additional-timestamps-same-entry nil
791   "When nil, multiple same-day timestamps in entry make multiple agenda lines.
792 When non-nil, after the search for timestamps has matched once in an
793 entry, the rest of the entry will not be searched."
794   :group 'org-agenda-skip
795   :type 'boolean)
796
797 (defcustom org-agenda-skip-timestamp-if-done nil
798   "Non-nil means don't select item by timestamp or -range if it is DONE."
799   :group 'org-agenda-skip
800   :group 'org-agenda-daily/weekly
801   :type 'boolean)
802
803 (defcustom org-agenda-dim-blocked-tasks t
804   "Non-nil means dim blocked tasks in the agenda display.
805 This causes some overhead during agenda construction, but if you
806 have turned on `org-enforce-todo-dependencies',
807 `org-enforce-todo-checkbox-dependencies', or any other blocking
808 mechanism, this will create useful feedback in the agenda.
809
810 Instead of t, this variable can also have the value `invisible'.
811 Then blocked tasks will be invisible and only become visible when
812 they become unblocked.  An exemption to this behavior is when a task is
813 blocked because of unchecked checkboxes below it.  Since checkboxes do
814 not show up in the agenda views, making this task invisible you remove any
815 trace from agenda views that there is something to do.  Therefore, a task
816 that is blocked because of checkboxes will never be made invisible, it
817 will only be dimmed."
818   :group 'org-agenda-daily/weekly
819   :group 'org-agenda-todo-list
820   :type '(choice
821           (const :tag "Do not dim" nil)
822           (const :tag "Dim to a grey face" t)
823           (const :tag "Make invisible" invisible)))
824
825 (defcustom org-timeline-show-empty-dates 3
826   "Non-nil means `org-timeline' also shows dates without an entry.
827 When nil, only the days which actually have entries are shown.
828 When t, all days between the first and the last date are shown.
829 When an integer, show also empty dates, but if there is a gap of more than
830 N days, just insert a special line indicating the size of the gap."
831   :group 'org-agenda-skip
832   :type '(choice
833           (const :tag "None" nil)
834           (const :tag "All" t)
835           (integer :tag "at most")))
836
837 (defgroup org-agenda-startup nil
838   "Options concerning initial settings in the Agenda in Org Mode."
839   :tag "Org Agenda Startup"
840   :group 'org-agenda)
841
842 (defcustom org-agenda-menu-show-matcher t
843   "Non-nil means show the match string in the agenda dispatcher menu.
844 When nil, the matcher string is not shown, but is put into the help-echo
845 property so than moving the mouse over the command shows it.
846 Setting it to nil is good if matcher strings are very long and/or if
847 you want to use two-column display (see `org-agenda-menu-two-column')."
848   :group 'org-agenda
849   :type 'boolean)
850
851 (defcustom org-agenda-menu-two-column nil
852   "Non-nil means, use two columns to show custom commands in the dispatcher.
853 If you use this, you probably want to set `org-agenda-menu-show-matcher'
854 to nil."
855   :group 'org-agenda
856   :type 'boolean)
857
858 (defcustom org-finalize-agenda-hook nil
859   "Hook run just before displaying an agenda buffer."
860   :group 'org-agenda-startup
861   :type 'hook)
862
863 (defcustom org-agenda-mouse-1-follows-link nil
864   "Non-nil means mouse-1 on a link will follow the link in the agenda.
865 A longer mouse click will still set point.  Does not work on XEmacs.
866 Needs to be set before org.el is loaded."
867   :group 'org-agenda-startup
868   :type 'boolean)
869
870 (defcustom org-agenda-start-with-follow-mode nil
871   "The initial value of follow mode in a newly created agenda window."
872   :group 'org-agenda-startup
873   :type 'boolean)
874
875 (defcustom org-agenda-follow-indirect nil
876   "Non-nil means `org-agenda-follow-mode' displays only the
877 current item's tree, in an indirect buffer."
878   :group 'org-agenda
879   :type 'boolean)
880
881 (defcustom org-agenda-show-outline-path t
882   "Non-nil means show outline path in echo area after line motion."
883   :group 'org-agenda-startup
884   :type 'boolean)
885
886 (defcustom org-agenda-start-with-entry-text-mode nil
887   "The initial value of entry-text-mode in a newly created agenda window."
888   :group 'org-agenda-startup
889   :type 'boolean)
890
891 (defcustom org-agenda-entry-text-maxlines 5
892   "Number of text lines to be added when `E' is pressed in the agenda.
893
894 Note that this variable only used during agenda display.  Add add entry text
895 when exporting the agenda, configure the variable
896 `org-agenda-add-entry-ext-maxlines'."
897   :group 'org-agenda
898   :type 'integer)
899
900 (defcustom org-agenda-entry-text-exclude-regexps nil
901   "List of regular expressions to clean up entry text.
902 The complete matches of all regular expressions in this list will be
903 removed from entry text before it is shown in the agenda."
904   :group 'org-agenda
905   :type '(repeat (regexp)))
906
907 (defvar org-agenda-entry-text-cleanup-hook nil
908   "Hook that is run after basic cleanup of entry text to be shown in agenda.
909 This cleanup is done in a temporary buffer, so the function may inspect and
910 change the entire buffer.
911 Some default stuff like drawers and scheduling/deadline dates will already
912 have been removed when this is called, as will any matches for regular
913 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
914
915 (defvar org-agenda-include-inactive-timestamps nil
916   "Non-nil means include inactive time stamps in agenda and timeline.")
917
918 (defgroup org-agenda-windows nil
919   "Options concerning the windows used by the Agenda in Org Mode."
920   :tag "Org Agenda Windows"
921   :group 'org-agenda)
922
923 (defcustom org-agenda-window-setup 'reorganize-frame
924   "How the agenda buffer should be displayed.
925 Possible values for this option are:
926
927 current-window    Show agenda in the current window, keeping all other windows.
928 other-window      Use `switch-to-buffer-other-window' to display agenda.
929 reorganize-frame  Show only two windows on the current frame, the current
930                   window and the agenda.
931 other-frame       Use `switch-to-buffer-other-frame' to display agenda.
932                   Also, when exiting the agenda, kill that frame.
933 See also the variable `org-agenda-restore-windows-after-quit'."
934   :group 'org-agenda-windows
935   :type '(choice
936           (const current-window)
937           (const other-frame)
938           (const other-window)
939           (const reorganize-frame)))
940
941 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
942   "The min and max height of the agenda window as a fraction of frame height.
943 The value of the variable is a cons cell with two numbers between 0 and 1.
944 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
945   :group 'org-agenda-windows
946   :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
947
948 (defcustom org-agenda-restore-windows-after-quit nil
949   "Non-nil means restore window configuration upon exiting agenda.
950 Before the window configuration is changed for displaying the agenda,
951 the current status is recorded.  When the agenda is exited with
952 `q' or `x' and this option is set, the old state is restored.  If
953 `org-agenda-window-setup' is `other-frame', the value of this
954 option will be ignored."
955   :group 'org-agenda-windows
956   :type 'boolean)
957
958 (defcustom org-agenda-ndays nil
959    "Number of days to include in overview display.
960 Should be 1 or 7.
961 Obsolete, see `org-agenda-span'."
962    :group 'org-agenda-daily/weekly
963    :type 'integer)
964
965 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
966
967 (defcustom org-agenda-span 'week
968   "Number of days to include in overview display.
969 Can be day, week, month, year, or any number of days.
970 Custom commands can set this variable in the options section."
971   :group 'org-agenda-daily/weekly
972   :type '(choice (const :tag "Day" day)
973                  (const :tag "Week" week)
974                  (const :tag "Month" month)
975                  (const :tag "Year" year)
976                  (integer :tag "Custom")))
977
978 (defcustom org-agenda-start-on-weekday 1
979   "Non-nil means start the overview always on the specified weekday.
980 0 denotes Sunday, 1 denotes Monday etc.
981 When nil, always start on the current day.
982 Custom commands can set this variable in the options section."
983   :group 'org-agenda-daily/weekly
984   :type '(choice (const :tag "Today" nil)
985                  (integer :tag "Weekday No.")))
986
987 (defcustom org-agenda-show-all-dates t
988   "Non-nil means `org-agenda' shows every day in the selected range.
989 When nil, only the days which actually have entries are shown."
990   :group 'org-agenda-daily/weekly
991   :type 'boolean)
992
993 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
994   "Format string for displaying dates in the agenda.
995 Used by the daily/weekly agenda and by the timeline.  This should be
996 a format string understood by `format-time-string', or a function returning
997 the formatted date as a string.  The function must take a single argument,
998 a calendar-style date list like (month day year)."
999   :group 'org-agenda-daily/weekly
1000   :type '(choice
1001           (string :tag "Format string")
1002           (function :tag "Function")))
1003
1004 (defun org-agenda-format-date-aligned (date)
1005   "Format a date string for display in the daily/weekly agenda, or timeline.
1006 This function makes sure that dates are aligned for easy reading."
1007   (require 'cal-iso)
1008   (let* ((dayname (calendar-day-name date))
1009          (day (cadr date))
1010          (day-of-week (calendar-day-of-week date))
1011          (month (car date))
1012          (monthname (calendar-month-name month))
1013          (year (nth 2 date))
1014          (iso-week (org-days-to-iso-week
1015                     (calendar-absolute-from-gregorian date)))
1016          (weekyear (cond ((and (= month 1) (>= iso-week 52))
1017                           (1- year))
1018                          ((and (= month 12) (<= iso-week 1))
1019                           (1+ year))
1020                          (t year)))
1021          (weekstring (if (= day-of-week 1)
1022                          (format " W%02d" iso-week)
1023                        "")))
1024     (format "%-10s %2d %s %4d%s"
1025             dayname day monthname year weekstring)))
1026
1027 (defcustom org-agenda-time-leading-zero nil
1028   "Non-nil means use leading zero for military times in agenda.
1029 For example, 9:30am would become 09:30 rather than  9:30."
1030   :group 'org-agenda-daily/weekly
1031   :type 'boolean)
1032
1033 (defcustom org-agenda-timegrid-use-ampm nil
1034   "When set, show AM/PM style timestamps on the timegrid."
1035   :group 'org-agenda
1036   :type 'boolean)
1037
1038 (defun org-agenda-time-of-day-to-ampm (time)
1039   "Convert TIME of a string like '13:45' to an AM/PM style time string."
1040   (let* ((hour-number (string-to-number (substring time 0 -3)))
1041          (minute (substring time -2))
1042          (ampm "am"))
1043     (cond
1044      ((equal hour-number 12)
1045       (setq ampm "pm"))
1046      ((> hour-number 12)
1047       (setq ampm "pm")
1048       (setq hour-number (- hour-number 12))))
1049     (concat
1050      (if org-agenda-time-leading-zero
1051          (format "%02d" hour-number)
1052        (format "%02s" (number-to-string hour-number)))
1053      ":" minute ampm)))
1054
1055 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1056   "Conditionally convert TIME to AM/PM format
1057 based on `org-agenda-timegrid-use-ampm'"
1058   (if org-agenda-timegrid-use-ampm
1059       (org-agenda-time-of-day-to-ampm time)
1060     time))
1061
1062 (defcustom org-agenda-weekend-days '(6 0)
1063   "Which days are weekend?
1064 These days get the special face `org-agenda-date-weekend' in the agenda
1065 and timeline buffers."
1066   :group 'org-agenda-daily/weekly
1067   :type '(set :greedy t
1068               (const :tag "Monday" 1)
1069               (const :tag "Tuesday" 2)
1070               (const :tag "Wednesday" 3)
1071               (const :tag "Thursday" 4)
1072               (const :tag "Friday" 5)
1073               (const :tag "Saturday" 6)
1074               (const :tag "Sunday" 0)))
1075
1076 (defcustom org-agenda-include-diary nil
1077   "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1078 Custom commands can set this variable in the options section."
1079   :group 'org-agenda-daily/weekly
1080   :type 'boolean)
1081
1082 (defcustom org-agenda-include-deadlines t
1083   "If non-nil, include entries within their deadline warning period.
1084 Custom commands can set this variable in the options section."
1085   :group 'org-agenda-daily/weekly
1086   :type 'boolean)
1087
1088 (defcustom org-agenda-repeating-timestamp-show-all t
1089   "Non-nil means show all occurrences of a repeating stamp in the agenda.
1090 When set to a list of strings, only show occurrences of repeating
1091 stamps for these TODO keywords.  When nil, only one occurrence is
1092 shown, either today or the nearest into the future."
1093   :group 'org-agenda-daily/weekly
1094   :type '(choice
1095           (const :tag "Show repeating stamps" t)
1096           (repeat :tag "Show repeating stamps for these TODO keywords"
1097                   (string :tag "TODO Keyword"))
1098           (const :tag "Don't show repeating stamps" nil)))
1099
1100 (defcustom org-scheduled-past-days 10000
1101   "No. of days to continue listing scheduled items that are not marked DONE.
1102 When an item is scheduled on a date, it shows up in the agenda on this
1103 day and will be listed until it is marked done for the number of days
1104 given here."
1105   :group 'org-agenda-daily/weekly
1106   :type 'integer)
1107
1108 (defcustom org-agenda-log-mode-items '(closed clock)
1109   "List of items that should be shown in agenda log mode.
1110 This list may contain the following symbols:
1111
1112   closed    Show entries that have been closed on that day.
1113   clock     Show entries that have received clocked time on that day.
1114   state     Show all logged state changes.
1115 Note that instead of changing this variable, you can also press `C-u l' in
1116 the agenda to display all available LOG items temporarily."
1117   :group 'org-agenda-daily/weekly
1118   :type '(set :greedy t (const closed) (const clock) (const state)))
1119
1120 (defcustom org-agenda-clock-consistency-checks
1121   '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1122                   :gap-ok-around ("4:00")
1123                   :default-face ((:background "DarkRed") (:foreground "white"))
1124                   :overlap-face nil :gap-face nil :no-end-time-face nil
1125                   :long-face nil :short-face nil)
1126   "This is a property list, with the following keys:
1127
1128 :max-duration    Mark clocking chunks that are longer than this time.
1129                  This is a time string like \"HH:MM\", or the number
1130                  of minutes as an integer.
1131
1132 :min-duration    Mark clocking chunks that are shorter that this.
1133                  This is a time string like \"HH:MM\", or the number
1134                  of minutes as an integer.
1135
1136 :max-gap         Mark gaps between clocking chunks that are longer than
1137                  this duration.  A number of minutes, or a string
1138                  like \"HH:MM\".
1139
1140 :gap-ok-around   List of times during the day which are usually not working
1141                  times.  When a gap is detected, but the gap contains any
1142                  of these times, the gap is *not* reported.  For example,
1143                  if this is (\"4:00\" \"13:00\") then gaps that contain
1144                  4:00 in the morning (i.e. the night) and 13:00
1145                  (i.e. a typical lunch time) do not cause a warning.
1146                  You should have at least one time during the night in this
1147                  list, or otherwise the first task each morning will trigger
1148                  a warning because it follows a long gap.
1149
1150 Furthermore, the following properties can be used to define faces for
1151 issue display.
1152
1153 :default-face         the default face, if the specific face is undefined
1154 :overlap-face         face for overlapping clocks
1155 :gap-face             face for gaps between clocks
1156 :no-end-time-face     face for incomplete clocks
1157 :long-face            face for clock intervals that are too long
1158 :short-face           face for clock intervals that are too short"
1159   :group 'org-agenda-daily/weekly
1160   :group 'org-clock
1161   :type 'plist)
1162
1163 (defcustom org-agenda-log-mode-add-notes t
1164   "Non-nil means add first line of notes to log entries in agenda views.
1165 If a log item like a state change or a clock entry is associated with
1166 notes, the first line of these notes will be added to the entry in the
1167 agenda display."
1168   :group 'org-agenda-daily/weekly
1169   :type 'boolean)
1170
1171 (defcustom org-agenda-start-with-log-mode nil
1172   "The initial value of log-mode in a newly created agenda window."
1173   :group 'org-agenda-startup
1174   :group 'org-agenda-daily/weekly
1175   :type 'boolean)
1176
1177 (defcustom org-agenda-start-with-clockreport-mode nil
1178   "The initial value of clockreport-mode in a newly created agenda window."
1179   :group 'org-agenda-startup
1180   :group 'org-agenda-daily/weekly
1181   :type 'boolean)
1182
1183 (defcustom org-agenda-clockreport-parameter-plist '(:link t :maxlevel 2)
1184   "Property list with parameters for the clocktable in clockreport mode.
1185 This is the display mode that shows a clock table in the daily/weekly
1186 agenda, the properties for this dynamic block can be set here.
1187 The usual clocktable parameters are allowed here, but you cannot set
1188 the properties :name, :tstart, :tend, :block, and :scope - these will
1189 be overwritten to make sure the content accurately reflects the
1190 current display in the agenda."
1191   :group 'org-agenda-daily/weekly
1192   :type 'plist)
1193
1194 (defcustom org-agenda-search-view-always-boolean nil
1195   "Non-nil means the search string is interpreted as individual parts.
1196
1197 The search string for search view can either be interpreted as a phrase,
1198 or as a list of snippets that define a boolean search for a number of
1199 strings.
1200
1201 When this is non-nil, the string will be split on whitespace, and each
1202 snippet will be searched individually, and all must match in order to
1203 select an entry.  A snippet is then a single string of non-white
1204 characters, or a string in double quotes, or a regexp in {} braces.
1205 If a snippet is preceded by \"-\", the snippet must *not* match.
1206 \"+\" is syntactic sugar for positive selection.  Each snippet may
1207 be found as a full word or a partial word, but see the variable
1208 `org-agenda-search-view-force-full-words'.
1209
1210 When this is nil, search will look for the entire search phrase as one,
1211 with each space character matching any amount of whitespace, including
1212 line breaks.
1213
1214 Even when this is nil, you can still switch to Boolean search dynamically
1215 by preceding the first snippet with \"+\" or \"-\".  If the first snippet
1216 is a regexp marked with braces like \"{abc}\", this will also switch to
1217 boolean search."
1218   :group 'org-agenda-search-view
1219   :type 'boolean)
1220
1221 (if (fboundp 'defvaralias)
1222     (defvaralias 'org-agenda-search-view-search-words-only
1223       'org-agenda-search-view-always-boolean))
1224
1225 (defcustom org-agenda-search-view-force-full-words nil
1226   "Non-nil means, search words must be matches as complete words.
1227 When nil, they may also match part of a word."
1228   :group 'org-agenda-search-view
1229   :type 'boolean)
1230
1231 (defgroup org-agenda-time-grid nil
1232   "Options concerning the time grid in the Org-mode Agenda."
1233   :tag "Org Agenda Time Grid"
1234   :group 'org-agenda)
1235
1236 (defcustom org-agenda-search-headline-for-time t
1237   "Non-nil means search headline for a time-of-day.
1238 If the headline contains a time-of-day in one format or another, it will
1239 be used to sort the entry into the time sequence of items for a day.
1240 Some people have time stamps in the headline that refer to the creation
1241 time or so, and then this produces an unwanted side effect.  If this is
1242 the case for your, use this variable to turn off searching the headline
1243 for a time."
1244   :group 'org-agenda-time-grid
1245   :type 'boolean)
1246
1247 (defcustom org-agenda-use-time-grid t
1248   "Non-nil means show a time grid in the agenda schedule.
1249 A time grid is a set of lines for specific times (like every two hours between
1250 8:00 and 20:00).  The items scheduled for a day at specific times are
1251 sorted in between these lines.
1252 For details about when the grid will be shown, and what it will look like, see
1253 the variable `org-agenda-time-grid'."
1254   :group 'org-agenda-time-grid
1255   :type 'boolean)
1256
1257 (defcustom org-agenda-time-grid
1258   '((daily today require-timed)
1259     "----------------"
1260     (800 1000 1200 1400 1600 1800 2000))
1261
1262   "The settings for time grid for agenda display.
1263 This is a list of three items.  The first item is again a list.  It contains
1264 symbols specifying conditions when the grid should be displayed:
1265
1266  daily         if the agenda shows a single day
1267  weekly        if the agenda shows an entire week
1268  today         show grid on current date, independent of daily/weekly display
1269  require-timed show grid only if at least one item has a time specification
1270
1271 The second item is a string which will be placed behind the grid time.
1272
1273 The third item is a list of integers, indicating the times that should have
1274 a grid line."
1275   :group 'org-agenda-time-grid
1276   :type
1277   '(list
1278     (set :greedy t :tag "Grid Display Options"
1279          (const :tag "Show grid in single day agenda display" daily)
1280          (const :tag "Show grid in weekly agenda display" weekly)
1281          (const :tag "Always show grid for today" today)
1282          (const :tag "Show grid only if any timed entries are present"
1283                 require-timed)
1284          (const :tag "Skip grid times already present in an entry"
1285                 remove-match))
1286     (string :tag "Grid String")
1287     (repeat :tag "Grid Times" (integer :tag "Time"))))
1288
1289 (defcustom org-agenda-show-current-time-in-grid t
1290   "Non-nil means show the current time in the time grid."
1291   :group 'org-agenda-time-grid
1292   :type 'boolean)
1293
1294 (defcustom org-agenda-current-time-string
1295   "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1296   "The string for the current time marker in the agenda."
1297   :group 'org-agenda-time-grid
1298   :type 'string)
1299
1300 (defgroup org-agenda-sorting nil
1301   "Options concerning sorting in the Org-mode Agenda."
1302   :tag "Org Agenda Sorting"
1303   :group 'org-agenda)
1304
1305 (defcustom org-agenda-sorting-strategy
1306   '((agenda habit-down time-up priority-down category-keep)
1307     (todo   priority-down category-keep)
1308     (tags   priority-down category-keep)
1309     (search category-keep))
1310   "Sorting structure for the agenda items of a single day.
1311 This is a list of symbols which will be used in sequence to determine
1312 if an entry should be listed before another entry.  The following
1313 symbols are recognized:
1314
1315 time-up            Put entries with time-of-day indications first, early first
1316 time-down          Put entries with time-of-day indications first, late first
1317 category-keep      Keep the default order of categories, corresponding to the
1318                    sequence in `org-agenda-files'.
1319 category-up        Sort alphabetically by category, A-Z.
1320 category-down      Sort alphabetically by category, Z-A.
1321 tag-up             Sort alphabetically by last tag, A-Z.
1322 tag-down           Sort alphabetically by last tag, Z-A.
1323 priority-up        Sort numerically by priority, high priority last.
1324 priority-down      Sort numerically by priority, high priority first.
1325 todo-state-up      Sort by todo state, tasks that are done last.
1326 todo-state-down    Sort by todo state, tasks that are done first.
1327 effort-up          Sort numerically by estimated effort, high effort last.
1328 effort-down        Sort numerically by estimated effort, high effort first.
1329 user-defined-up    Sort according to `org-agenda-cmp-user-defined', high last.
1330 user-defined-down  Sort according to `org-agenda-cmp-user-defined', high first.
1331 habit-up           Put entries that are habits first
1332 habit-down         Put entries that are habits last
1333 alpha-up           Sort headlines alphabetically
1334 alpha-down         Sort headlines alphabetically, reversed
1335
1336 The different possibilities will be tried in sequence, and testing stops
1337 if one comparison returns a \"not-equal\".  For example, the default
1338     '(time-up category-keep priority-down)
1339 means: Pull out all entries having a specified time of day and sort them,
1340 in order to make a time schedule for the current day the first thing in the
1341 agenda listing for the day.  Of the entries without a time indication, keep
1342 the grouped in categories, don't sort the categories, but keep them in
1343 the sequence given in `org-agenda-files'.  Within each category sort by
1344 priority.
1345
1346 Leaving out `category-keep' would mean that items will be sorted across
1347 categories by priority.
1348
1349 Instead of a single list, this can also be a set of list for specific
1350 contents, with a context symbol in the car of the list, any of
1351 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1352
1353 Custom commands can bind this variable in the options section."
1354   :group 'org-agenda-sorting
1355   :type `(choice
1356           (repeat :tag "General" ,org-sorting-choice)
1357           (list :tag "Individually"
1358                 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1359                       (repeat ,org-sorting-choice))
1360                 (cons (const :tag "Strategy for TODO lists" todo)
1361                       (repeat ,org-sorting-choice))
1362                 (cons (const :tag "Strategy for Tags matches" tags)
1363                       (repeat ,org-sorting-choice))
1364                 (cons (const :tag "Strategy for search matches" search)
1365                       (repeat ,org-sorting-choice)))))
1366
1367 (defcustom org-agenda-cmp-user-defined nil
1368   "A function to define the comparison `user-defined'.
1369 This function must receive two arguments, agenda entry a and b.
1370 If a>b, return +1.  If a<b, return -1.  If they are equal as seen by
1371 the user comparison, return nil.
1372 When this is defined, you can make `user-defined-up' and `user-defined-down'
1373 part of an agenda sorting strategy."
1374   :group 'org-agenda-sorting
1375   :type 'symbol)
1376
1377 (defcustom org-sort-agenda-notime-is-late t
1378   "Non-nil means items without time are considered late.
1379 This is only relevant for sorting.  When t, items which have no explicit
1380 time like 15:30 will be considered as 99:01, i.e. later than any items which
1381 do have a time.  When nil, the default time is before 0:00.  You can use this
1382 option to decide if the schedule for today should come before or after timeless
1383 agenda entries."
1384   :group 'org-agenda-sorting
1385   :type 'boolean)
1386
1387 (defcustom org-sort-agenda-noeffort-is-high t
1388   "Non-nil means items without effort estimate are sorted as high effort.
1389 This also applies when filtering an agenda view with respect to the
1390 < or > effort operator.  Then, tasks with no effort defined will be treated
1391 as tasks with high effort.
1392 When nil, such items are sorted as 0 minutes effort."
1393   :group 'org-agenda-sorting
1394   :type 'boolean)
1395
1396 (defgroup org-agenda-line-format nil
1397   "Options concerning the entry prefix in the Org-mode agenda display."
1398   :tag "Org Agenda Line Format"
1399   :group 'org-agenda)
1400
1401 (defcustom org-agenda-prefix-format
1402   '((agenda  . " %i %-12:c%?-12t% s")
1403     (timeline  . "  % s")
1404     (todo  . " %i %-12:c")
1405     (tags  . " %i %-12:c")
1406     (search . " %i %-12:c"))
1407   "Format specifications for the prefix of items in the agenda views.
1408 An alist with five entries, each for the different agenda types.  The
1409 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1410 The values are format strings.
1411
1412 This format works similar to a printf format, with the following meaning:
1413
1414   %c   the category of the item, \"Diary\" for entries from the diary,
1415        or as given by the CATEGORY keyword or derived from the file name
1416   %e   the effort required by the item
1417   %i   the icon category of the item, see `org-agenda-category-icon-alist'
1418   %T   the last tag of the item (ignore inherited tags, which come first)
1419   %t   the HH:MM time-of-day specification if one applies to the entry
1420   %s   Scheduling/Deadline information, a short string
1421   %(expression) Eval EXPRESSION and replace the control string
1422                 by the result
1423
1424 All specifiers work basically like the standard `%s' of printf, but may
1425 contain two additional characters:  a question mark just after the `%'
1426 and a whitespace/punctuation character just before the final letter.
1427
1428 If the first character after `%' is a question mark, the entire field
1429 will only be included if the corresponding value applies to the current
1430 entry.  This is useful for fields which should have fixed width when
1431 present, but zero width when absent.  For example, \"%?-12t\" will
1432 result in a 12 character time field if a time of the day is specified,
1433 but will completely disappear in entries which do not contain a time.
1434
1435 If there is punctuation or whitespace character just before the final
1436 format letter, this character will be appended to the field value if
1437 the value is not empty.  For example, the format \"%-12:c\" leads to
1438 \"Diary: \" if the category is \"Diary\".  If the category were be
1439 empty, no additional colon would be inserted.
1440
1441 The default value for the agenda sublist is \"  %-12:c%?-12t% s\",
1442 which means:
1443
1444 - Indent the line with two space characters
1445 - Give the category a 12 chars wide field, padded with whitespace on
1446   the right (because of `-').  Append a colon if there is a category
1447   (because of `:').
1448 - If there is a time-of-day, put it into a 12 chars wide field.  If no
1449   time, don't put in an empty field, just skip it (because of '?').
1450 - Finally, put the scheduling information.
1451
1452 See also the variables `org-agenda-remove-times-when-in-prefix' and
1453 `org-agenda-remove-tags'.
1454
1455 Custom commands can set this variable in the options section."
1456   :type '(choice
1457           (string :tag "General format")
1458           (list :greedy t :tag "View dependent"
1459                 (cons  (const agenda) (string :tag "Format"))
1460                 (cons  (const timeline) (string :tag "Format"))
1461                 (cons  (const todo) (string :tag "Format"))
1462                 (cons  (const tags) (string :tag "Format"))
1463                 (cons  (const search) (string :tag "Format"))))
1464   :group 'org-agenda-line-format)
1465
1466 (defvar org-prefix-format-compiled nil
1467   "The compiled version of the most recently used prefix format.
1468 See the variable `org-agenda-prefix-format'.")
1469
1470 (defcustom org-agenda-todo-keyword-format "%-1s"
1471   "Format for the TODO keyword in agenda lines.
1472 Set this to something like \"%-12s\" if you want all TODO keywords
1473 to occupy a fixed space in the agenda display."
1474   :group 'org-agenda-line-format
1475   :type 'string)
1476
1477 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1478   "Text preceding timerange entries in the agenda view.
1479 This is a list with two strings.  The first applies when the range
1480 is entirely on one day.  The second applies if the range spans several days.
1481 The strings may have two \"%d\" format specifiers which will be filled
1482 with the sequence number of the days, and the total number of days in the
1483 range, respectively."
1484   :group 'org-agenda-line-format
1485   :type '(list
1486           (string :tag "Deadline today   ")
1487           (choice :tag "Deadline relative"
1488                   (string :tag "Format string")
1489                   (function))))
1490
1491 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1492   "Text preceding scheduled items in the agenda view.
1493 This is a list with two strings.  The first applies when the item is
1494 scheduled on the current day.  The second applies when it has been scheduled
1495 previously, it may contain a %d indicating that this is the nth time that
1496 this item is scheduled, due to automatic rescheduling of unfinished items
1497 for the following day.  So this number is one larger than the number of days
1498 that passed since this item was scheduled first."
1499   :group 'org-agenda-line-format
1500   :type '(list
1501           (string :tag "Scheduled today     ")
1502           (string :tag "Scheduled previously")))
1503
1504 (defcustom org-agenda-inactive-leader "["
1505   "Text preceding item pulled into the agenda by inactive time stamps.
1506 These entries are added to the agenda when pressing \"[\"."
1507   :group 'org-agenda-line-format
1508   :type '(list
1509           (string :tag "Scheduled today     ")
1510           (string :tag "Scheduled previously")))
1511
1512 (defcustom org-agenda-deadline-leaders '("Deadline:  " "In %3d d.: ")
1513   "Text preceding deadline items in the agenda view.
1514 This is a list with two strings.  The first applies when the item has its
1515 deadline on the current day.  The second applies when it is in the past or
1516 in the future, it may contain %d to capture how many days away the deadline
1517 is (was)."
1518   :group 'org-agenda-line-format
1519   :type '(list
1520           (string :tag "Deadline today   ")
1521           (choice :tag "Deadline relative"
1522                   (string :tag "Format string")
1523                   (function))))
1524
1525 (defcustom org-agenda-remove-times-when-in-prefix t
1526   "Non-nil means remove duplicate time specifications in agenda items.
1527 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1528 time-of-day specification in a headline or diary entry is extracted and
1529 placed into the prefix.  If this option is non-nil, the original specification
1530 \(a timestamp or -range, or just a plain time(range) specification like
1531 11:30-4pm) will be removed for agenda display.  This makes the agenda less
1532 cluttered.
1533 The option can be t or nil.  It may also be the symbol `beg', indicating
1534 that the time should only be removed when it is located at the beginning of
1535 the headline/diary entry."
1536   :group 'org-agenda-line-format
1537   :type '(choice
1538           (const :tag "Always" t)
1539           (const :tag "Never" nil)
1540           (const :tag "When at beginning of entry" beg)))
1541
1542 (defcustom org-agenda-remove-timeranges-from-blocks nil
1543   "Non-nil means remove time ranges specifications in agenda
1544 items that span on several days."
1545   :group 'org-agenda-line-format
1546   :type 'boolean)
1547
1548 (defcustom org-agenda-default-appointment-duration nil
1549   "Default duration for appointments that only have a starting time.
1550 When nil, no duration is specified in such cases.
1551 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1552   :group 'org-agenda-line-format
1553   :type '(choice
1554           (integer :tag "Minutes")
1555           (const :tag "No default duration")))
1556
1557 (defcustom org-agenda-show-inherited-tags t
1558   "Non-nil means show inherited tags in each agenda line."
1559   :group 'org-agenda-line-format
1560   :type 'boolean)
1561
1562 (defcustom org-agenda-hide-tags-regexp nil
1563   "Regular expression used to filter away specific tags in agenda views.
1564 This means that these tags will be present, but not be shown in the agenda
1565 line.  Secondary filtering will still work on the hidden tags.
1566 Nil means don't hide any tags."
1567   :group 'org-agenda-line-format
1568   :type '(choice
1569           (const  :tag "Hide none" nil)
1570           (string :tag "Regexp   ")))
1571
1572 (defcustom org-agenda-remove-tags nil
1573   "Non-nil means remove the tags from the headline copy in the agenda.
1574 When this is the symbol `prefix', only remove tags when
1575 `org-agenda-prefix-format' contains a `%T' specifier."
1576   :group 'org-agenda-line-format
1577   :type '(choice
1578           (const :tag "Always" t)
1579           (const :tag "Never" nil)
1580           (const :tag "When prefix format contains %T" prefix)))
1581
1582 (if (fboundp 'defvaralias)
1583     (defvaralias 'org-agenda-remove-tags-when-in-prefix
1584       'org-agenda-remove-tags))
1585
1586 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1587   "Shift tags in agenda items to this column.
1588 If this number is positive, it specifies the column.  If it is negative,
1589 it means that the tags should be flushright to that column.  For example,
1590 -80 works well for a normal 80 character screen."
1591   :group 'org-agenda-line-format
1592   :type 'integer)
1593
1594 (if (fboundp 'defvaralias)
1595     (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1596
1597 (defcustom org-agenda-fontify-priorities 'cookies
1598   "Non-nil means highlight low and high priorities in agenda.
1599 When t, the highest priority entries are bold, lowest priority italic.
1600 However, settings in `org-priority-faces' will overrule these faces.
1601 When this variable is the symbol `cookies', only fontify the
1602 cookies, not the entire task.
1603 This may also be an association list of priority faces, whose
1604 keys are the character values of `org-highest-priority',
1605 `org-default-priority', and `org-lowest-priority' (the default values
1606 are ?A, ?B, and ?C, respectively).  The face may be a named face, a
1607 color as a string, or a list like `(:background \"Red\")'.
1608 If it is a color, the variable `org-faces-easy-properties'
1609 determines if it is a foreground or a background color."
1610   :group 'org-agenda-line-format
1611   :type '(choice
1612           (const :tag "Never" nil)
1613           (const :tag "Defaults" t)
1614           (const :tag "Cookies only" cookies)
1615           (repeat :tag "Specify"
1616                   (list (character :tag "Priority" :value ?A)
1617                         (choice    :tag "Face    "
1618                                    (string :tag "Color")
1619                                    (sexp :tag "Face"))))))
1620
1621 (defcustom org-agenda-day-face-function nil
1622   "Function called to determine what face should be used to display a day.
1623 The only argument passed to that function is the day. It should
1624 returns a face, or nil if does not want to specify a face and let
1625 the normal rules apply."
1626   :group 'org-agenda-line-format
1627   :type 'function)
1628
1629 (defcustom org-agenda-category-icon-alist nil
1630   "Alist of category icon to be displayed in agenda views.
1631
1632 Each entry should have the following format:
1633
1634   (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1635
1636 Where CATEGORY-REGEXP is a regexp matching the categories where
1637 the icon should be displayed.
1638 FILE-OR-DATA either a file path or a string containing image data.
1639
1640 The other fields can be omited safely if not needed:
1641 TYPE indicates the image type.
1642 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1643 image data.
1644 PROPS are additional image attributes to assign to the image,
1645 like, e.g. `:ascent center'.
1646
1647    (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1648
1649 If you want to set the display properties yourself, just put a
1650 list as second element:
1651
1652   (CATEGORY-REGEXP (MY PROPERTY LIST))
1653
1654 For example, to display a 16px horizontal space for Emacs
1655 category, you can use:
1656
1657   (\"Emacs\" '(space . (:width (16))))"
1658   :group 'org-agenda-line-format
1659   :type '(alist :key-type (string :tag "Regexp matching category")
1660                 :value-type (choice (list :tag "Icon"
1661                                           (string :tag "File or data")
1662                                           (symbol :tag "Type")
1663                                           (boolean :tag "Data?")
1664                                           (repeat :tag "Extra image properties" :inline t symbol))
1665                                     (list :tag "Display properties" sexp))))
1666
1667 (defgroup org-agenda-column-view nil
1668   "Options concerning column view in the agenda."
1669   :tag "Org Agenda Column View"
1670   :group 'org-agenda)
1671
1672 (defcustom org-agenda-columns-show-summaries t
1673   "Non-nil means show summaries for columns displayed in the agenda view."
1674   :group 'org-agenda-column-view
1675   :type 'boolean)
1676
1677 (defcustom org-agenda-columns-compute-summary-properties t
1678   "Non-nil means recompute all summary properties before column view.
1679 When column view in the agenda is listing properties that have a summary
1680 operator, it can go to all relevant buffers and recompute the summaries
1681 there.  This can mean overhead for the agenda column view, but is necessary
1682 to have thing up to date.
1683 As a special case, a CLOCKSUM property also makes sure that the clock
1684 computations are current."
1685   :group 'org-agenda-column-view
1686   :type 'boolean)
1687
1688 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1689   "Non-nil means the duration of an appointment will add to day effort.
1690 The property to which appointment durations will be added is the one given
1691 in the option `org-effort-property'.  If an appointment does not have
1692 an end time, `org-agenda-default-appointment-duration' will be used.  If that
1693 is not set, an appointment without end time will not contribute to the time
1694 estimate."
1695   :group 'org-agenda-column-view
1696   :type 'boolean)
1697
1698 (defcustom org-agenda-auto-exclude-function nil
1699   "A function called with a tag to decide if it is filtered on '/ RET'.
1700 The sole argument to the function, which is called once for each
1701 possible tag, is a string giving the name of the tag.  The
1702 function should return either nil if the tag should be included
1703 as normal, or \"-<TAG>\" to exclude the tag.
1704 Note that for the purpose of tag filtering, only the lower-case version of
1705 all tags will be considered, so that this function will only ever see
1706 the lower-case version of all tags."
1707   :group 'org-agenda
1708   :type 'function)
1709
1710 (defcustom org-agenda-bulk-custom-functions nil
1711   "Alist of characters and custom functions for bulk actions.
1712 For example, this value makes those two functions available:
1713
1714   '((?R set-category)
1715     (?C bulk-cut))
1716
1717 With selected entries in an agenda buffer, `B R' will call
1718 the custom function `set-category' on the selected entries.
1719 Note that functions in this alist don't need to be quoted."
1720   :type 'alist
1721   :group 'org-agenda)
1722
1723 (eval-when-compile
1724   (require 'cl))
1725 (require 'org)
1726
1727 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1728   "Execute BODY with point at location given by `org-hd-marker' property.
1729 If STRING is non-nil, the text property will be fetched from position 0
1730 in that string.  If STRING is nil, it will be fetched from the beginning
1731 of the current line."
1732   (org-with-gensyms (marker)
1733     `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1734                                        'org-hd-marker string)))
1735        (with-current-buffer (marker-buffer ,marker)
1736          (save-excursion
1737            (goto-char ,marker)
1738            ,@body)))))
1739 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1740
1741 (defun org-add-agenda-custom-command (entry)
1742   "Replace or add a command in `org-agenda-custom-commands'.
1743 This is mostly for hacking and trying a new command - once the command
1744 works you probably want to add it to `org-agenda-custom-commands' for good."
1745   (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1746     (if ass
1747         (setcdr ass (cdr entry))
1748       (push entry org-agenda-custom-commands))))
1749
1750 ;;; Define the Org-agenda-mode
1751
1752 (defvar org-agenda-mode-map (make-sparse-keymap)
1753   "Keymap for `org-agenda-mode'.")
1754 (if (fboundp 'defvaralias)
1755     (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1756
1757 (defvar org-agenda-menu) ; defined later in this file.
1758 (defvar org-agenda-restrict) ; defined later in this file.
1759 (defvar org-agenda-follow-mode nil)
1760 (defvar org-agenda-entry-text-mode nil)
1761 (defvar org-agenda-clockreport-mode nil)
1762 (defvar org-agenda-show-log nil)
1763 (defvar org-agenda-redo-command nil)
1764 (defvar org-agenda-query-string nil)
1765 (defvar org-agenda-mode-hook nil
1766   "Hook for `org-agenda-mode', run after the mode is turned on.")
1767 (defvar org-agenda-type nil)
1768 (defvar org-agenda-force-single-file nil)
1769 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1770
1771 (defun org-agenda-mode ()
1772   "Mode for time-sorted view on action items in Org-mode files.
1773
1774 The following commands are available:
1775
1776 \\{org-agenda-mode-map}"
1777   (interactive)
1778   (kill-all-local-variables)
1779   (setq org-agenda-undo-list nil
1780         org-agenda-pending-undo-list nil
1781         org-agenda-bulk-marked-entries nil)
1782   (setq major-mode 'org-agenda-mode)
1783   ;; Keep global-font-lock-mode from turning on font-lock-mode
1784   (org-set-local 'font-lock-global-modes (list 'not major-mode))
1785   (setq mode-name "Org-Agenda")
1786   (use-local-map org-agenda-mode-map)
1787   (easy-menu-add org-agenda-menu)
1788   (if org-startup-truncated (setq truncate-lines t))
1789   (org-set-local 'line-move-visual nil)
1790   (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1791   (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1792   ;; Make sure properties are removed when copying text
1793   (when (boundp 'buffer-substring-filters)
1794     (org-set-local 'buffer-substring-filters
1795                    (cons (lambda (x)
1796                            (set-text-properties 0 (length x) nil x) x)
1797                          buffer-substring-filters)))
1798   (unless org-agenda-keep-modes
1799     (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1800           org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1801           org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1802           org-agenda-show-log org-agenda-start-with-log-mode))
1803
1804   (easy-menu-change
1805    '("Agenda") "Agenda Files"
1806    (append
1807     (list
1808      (vector
1809       (if (get 'org-agenda-files 'org-restrict)
1810           "Restricted to single file"
1811         "Edit File List")
1812       '(org-edit-agenda-file-list)
1813       (not (get 'org-agenda-files 'org-restrict)))
1814      "--")
1815     (mapcar 'org-file-menu-entry (org-agenda-files))))
1816   (org-agenda-set-mode-name)
1817   (apply
1818    (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1819    (list 'org-agenda-mode-hook)))
1820
1821 (substitute-key-definition 'undo 'org-agenda-undo
1822                            org-agenda-mode-map global-map)
1823 (org-defkey org-agenda-mode-map "\C-i"     'org-agenda-goto)
1824 (org-defkey org-agenda-mode-map [(tab)]    'org-agenda-goto)
1825 (org-defkey org-agenda-mode-map "\C-m"     'org-agenda-switch-to)
1826 (org-defkey org-agenda-mode-map "\C-k"     'org-agenda-kill)
1827 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1828 (org-defkey org-agenda-mode-map "m"        'org-agenda-bulk-mark)
1829 (org-defkey org-agenda-mode-map "%"        'org-agenda-bulk-mark-regexp)
1830 (org-defkey org-agenda-mode-map "u"        'org-agenda-bulk-unmark)
1831 (org-defkey org-agenda-mode-map "U"        'org-agenda-bulk-remove-all-marks)
1832 (org-defkey org-agenda-mode-map "A"        'org-agenda-append-agenda)
1833 (org-defkey org-agenda-mode-map "B"        'org-agenda-bulk-action)
1834 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
1835 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
1836 (org-defkey org-agenda-mode-map "\C-c\C-xa"    'org-agenda-toggle-archive-tag)
1837 (org-defkey org-agenda-mode-map "\C-c\C-xA"    'org-agenda-archive-to-archive-sibling)
1838 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
1839 (org-defkey org-agenda-mode-map "\C-c$"        'org-agenda-archive)
1840 (org-defkey org-agenda-mode-map "$"        'org-agenda-archive)
1841 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
1842 (org-defkey org-agenda-mode-map " "        'org-agenda-show-and-scroll-up)
1843 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
1844 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
1845 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
1846 (org-defkey org-agenda-mode-map [(control shift left)]  'org-agenda-todo-previousset)
1847 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
1848 (org-defkey org-agenda-mode-map "o"        'delete-other-windows)
1849 (org-defkey org-agenda-mode-map "L"        'org-agenda-recenter)
1850 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
1851 (org-defkey org-agenda-mode-map "t"        'org-agenda-todo)
1852 (org-defkey org-agenda-mode-map "a"        'org-agenda-archive-default-with-confirmation)
1853 (org-defkey org-agenda-mode-map ":"        'org-agenda-set-tags)
1854 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
1855 (org-defkey org-agenda-mode-map "."        'org-agenda-goto-today)
1856 (org-defkey org-agenda-mode-map "j"        'org-agenda-goto-date)
1857 (org-defkey org-agenda-mode-map "d"        'org-agenda-day-view)
1858 (org-defkey org-agenda-mode-map "w"        'org-agenda-week-view)
1859 (org-defkey org-agenda-mode-map "y"        'org-agenda-year-view)
1860 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
1861 (org-defkey org-agenda-mode-map "z"        'org-agenda-add-note)
1862 (org-defkey org-agenda-mode-map "k"        'org-agenda-action)
1863 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
1864 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
1865 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
1866 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
1867 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
1868
1869 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
1870 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
1871 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
1872 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1873   (while l (org-defkey org-agenda-mode-map
1874              (int-to-string (pop l)) 'digit-argument)))
1875
1876 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
1877 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
1878 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
1879 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
1880 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
1881 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
1882 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
1883 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
1884 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
1885 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
1886 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
1887 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
1888 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
1889             'org-clock-modify-effort-estimate)
1890 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
1891 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
1892 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
1893 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-write-agenda)
1894 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
1895 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
1896 (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
1897 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
1898 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
1899 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
1900 (substitute-key-definition 'next-line 'org-agenda-next-line
1901                            org-agenda-mode-map global-map)
1902 (substitute-key-definition 'previous-line 'org-agenda-previous-line
1903                            org-agenda-mode-map global-map)
1904 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
1905 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
1906 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
1907 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
1908 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
1909 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
1910 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
1911 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
1912 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
1913 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
1914 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
1915 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
1916 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
1917 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
1918 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
1919 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
1920 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
1921 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
1922 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
1923 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
1924 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
1925 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
1926 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
1927 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
1928 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
1929 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
1930 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
1931 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
1932 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
1933 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
1934
1935 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
1936 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
1937 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
1938 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
1939 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
1940 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
1941 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
1942 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
1943 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg"    'org-mobile-pull)
1944 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp"    'org-mobile-push)
1945
1946 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
1947 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
1948 (when org-agenda-mouse-1-follows-link
1949   (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
1950 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
1951   '("Agenda"
1952     ("Agenda Files")
1953     "--"
1954     ("Agenda Dates"
1955      ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
1956      ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
1957      ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
1958      ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
1959     "--"
1960     ("View"
1961      ["Day View" org-agenda-day-view
1962       :active (org-agenda-check-type nil 'agenda)
1963       :style radio :selected (eq org-agenda-current-span 'day)
1964       :keys "v d  (or just d)"]
1965      ["Week View" org-agenda-week-view
1966       :active (org-agenda-check-type nil 'agenda)
1967       :style radio :selected (eq org-agenda-current-span 'week)
1968       :keys "v w  (or just w)"]
1969      ["Month View" org-agenda-month-view
1970       :active (org-agenda-check-type nil 'agenda)
1971       :style radio :selected (eq org-agenda-current-span 'month)
1972       :keys "v m"]
1973      ["Year View" org-agenda-year-view
1974       :active (org-agenda-check-type nil 'agenda)
1975       :style radio :selected (eq org-agenda-current-span 'year)
1976       :keys "v y"]
1977      "--"
1978      ["Include Diary" org-agenda-toggle-diary
1979       :style toggle :selected org-agenda-include-diary
1980       :active (org-agenda-check-type nil 'agenda)]
1981      ["Include Deadlines" org-agenda-toggle-deadlines
1982       :style toggle :selected org-agenda-include-deadlines
1983       :active (org-agenda-check-type nil 'agenda)]
1984      ["Use Time Grid" org-agenda-toggle-time-grid
1985       :style toggle :selected org-agenda-use-time-grid
1986       :active (org-agenda-check-type nil 'agenda)]
1987      "--"
1988      ["Show clock report" org-agenda-clockreport-mode
1989       :style toggle :selected org-agenda-clockreport-mode
1990       :active (org-agenda-check-type nil 'agenda)]
1991      ["Show some entry text" org-agenda-entry-text-mode
1992       :style toggle :selected org-agenda-entry-text-mode
1993       :active t]
1994     "--"
1995      ["Show Logbook entries" org-agenda-log-mode
1996       :style toggle :selected org-agenda-show-log
1997       :active (org-agenda-check-type nil 'agenda 'timeline)
1998       :keys "v l (or just l)"]
1999      ["Include archived trees" org-agenda-archives-mode
2000       :style toggle :selected org-agenda-archives-mode :active t
2001       :keys "v a"]
2002      ["Include archive files" (org-agenda-archives-mode t)
2003       :style toggle :selected (eq org-agenda-archives-mode t) :active t
2004       :keys "v A"]
2005      "--"
2006      ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2007     ["Write view to file" org-write-agenda t]
2008     ["Rebuild buffer" org-agenda-redo t]
2009     ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2010     "--"
2011     ["Show original entry" org-agenda-show t]
2012     ["Go To (other window)" org-agenda-goto t]
2013     ["Go To (this window)" org-agenda-switch-to t]
2014     ["Follow Mode" org-agenda-follow-mode
2015      :style toggle :selected org-agenda-follow-mode :active t]
2016 ;    ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2017     "--"
2018     ("TODO"
2019      ["Cycle TODO" org-agenda-todo t]
2020      ["Next TODO set" org-agenda-todo-nextset t]
2021      ["Previous TODO set" org-agenda-todo-previousset t]
2022      ["Add note" org-agenda-add-note t])
2023     ("Archive/Refile/Delete"
2024      ["Archive default" org-agenda-archive-default t]
2025      ["Archive default" org-agenda-archive-default-with-confirmation t]
2026      ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2027      ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2028      ["Archive subtree" org-agenda-archive t]
2029      "--"
2030      ["Refile" org-agenda-refile t]
2031      "--"
2032      ["Delete subtree" org-agenda-kill t])
2033     ("Bulk action"
2034      ["Mark entry" org-agenda-bulk-mark t]
2035      ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2036      ["Unmark entry" org-agenda-bulk-unmark t]
2037      ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
2038      ["Act on all marked" org-agenda-bulk-action t]
2039     "--"
2040     ("Tags and Properties"
2041      ["Show all Tags" org-agenda-show-tags t]
2042      ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2043      ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2044      "--"
2045      ["Column View" org-columns t])
2046     ("Deadline/Schedule"
2047      ["Schedule" org-agenda-schedule t]
2048      ["Set Deadline" org-agenda-deadline t]
2049      "--"
2050      ["Mark item" org-agenda-action :active t :keys "k m"]
2051      ["Show mark item" org-agenda-action :active t :keys "k v"]
2052      ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2053      ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2054      "--"
2055      ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2056      ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2057      ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2058      ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2059      ["Change Time +  min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2060      ["Change Time -  min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2061      ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2062     ("Clock and Effort"
2063      ["Clock in" org-agenda-clock-in t]
2064      ["Clock out" org-agenda-clock-out t]
2065      ["Clock cancel" org-agenda-clock-cancel t]
2066      ["Goto running clock" org-clock-goto t]
2067      "--"
2068      ["Set Effort" org-agenda-set-effort t]
2069      ["Change clocked effort" org-clock-modify-effort-estimate
2070       (org-clock-is-active)])
2071     ("Priority"
2072      ["Set Priority" org-agenda-priority t]
2073      ["Increase Priority" org-agenda-priority-up t]
2074      ["Decrease Priority" org-agenda-priority-down t]
2075      ["Show Priority" org-agenda-show-priority t])
2076     ("Calendar/Diary"
2077      ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2078      ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2079      ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2080      ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2081      ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2082      ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2083      "--"
2084      ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2085     "--"
2086     ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2087     "--"
2088     ("MobileOrg"
2089      ["Push Files and Views" org-mobile-push t]
2090      ["Get Captured and Flagged" org-mobile-pull t]
2091      ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2092      ["Show note / unflag" org-agenda-show-the-flagging-note t]
2093      "--"
2094      ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2095     "--"
2096     ["Quit" org-agenda-quit t]
2097     ["Exit and Release Buffers" org-agenda-exit t]
2098     ))
2099
2100 ;;; Agenda undo
2101
2102 (defvar org-agenda-allow-remote-undo t
2103   "Non-nil means allow remote undo from the agenda buffer.")
2104 (defvar org-agenda-undo-list nil
2105   "List of undoable operations in the agenda since last refresh.")
2106 (defvar org-agenda-undo-has-started-in nil
2107   "Buffers that have already seen `undo-start' in the current undo sequence.")
2108 (defvar org-agenda-pending-undo-list nil
2109   "In a series of undo commands, this is the list of remaining undo items.")
2110
2111 (defun org-agenda-undo ()
2112   "Undo a remote editing step in the agenda.
2113 This undoes changes both in the agenda buffer and in the remote buffer
2114 that have been changed along."
2115   (interactive)
2116   (or org-agenda-allow-remote-undo
2117       (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2118   (if (not (eq this-command last-command))
2119       (setq org-agenda-undo-has-started-in nil
2120             org-agenda-pending-undo-list org-agenda-undo-list))
2121   (if (not org-agenda-pending-undo-list)
2122       (error "No further undo information"))
2123   (let* ((entry (pop org-agenda-pending-undo-list))
2124          buf line cmd rembuf)
2125     (setq cmd (pop entry) line (pop entry))
2126     (setq rembuf (nth 2 entry))
2127     (org-with-remote-undo rembuf
2128       (while (bufferp (setq buf (pop entry)))
2129         (if (pop entry)
2130             (with-current-buffer buf
2131               (let ((last-undo-buffer buf)
2132                     (inhibit-read-only t))
2133                 (unless (memq buf org-agenda-undo-has-started-in)
2134                   (push buf org-agenda-undo-has-started-in)
2135                   (make-local-variable 'pending-undo-list)
2136                   (undo-start))
2137                 (while (and pending-undo-list
2138                             (listp pending-undo-list)
2139                             (not (car pending-undo-list)))
2140                   (pop pending-undo-list))
2141                 (undo-more 1))))))
2142     (org-goto-line line)
2143     (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2144
2145 (defun org-verify-change-for-undo (l1 l2)
2146   "Verify that a real change occurred between the undo lists L1 and L2."
2147   (while (and l1 (listp l1) (null (car l1))) (pop l1))
2148   (while (and l2 (listp l2) (null (car l2))) (pop l2))
2149   (not (eq l1 l2)))
2150
2151 ;;; Agenda dispatch
2152
2153 (defvar org-agenda-restrict nil)
2154 (defvar org-agenda-restrict-begin (make-marker))
2155 (defvar org-agenda-restrict-end (make-marker))
2156 (defvar org-agenda-last-dispatch-buffer nil)
2157 (defvar org-agenda-overriding-restriction nil)
2158
2159 ;;;###autoload
2160 (defun org-agenda (&optional arg keys restriction)
2161   "Dispatch agenda commands to collect entries to the agenda buffer.
2162 Prompts for a command to execute.  Any prefix arg will be passed
2163 on to the selected command.  The default selections are:
2164
2165 a     Call `org-agenda-list' to display the agenda for current day or week.
2166 t     Call `org-todo-list' to display the global todo list.
2167 T     Call `org-todo-list' to display the global todo list, select only
2168       entries with a specific TODO keyword (the user gets a prompt).
2169 m     Call `org-tags-view' to display headlines with tags matching
2170       a condition  (the user is prompted for the condition).
2171 M     Like `m', but select only TODO entries, no ordinary headlines.
2172 L     Create a timeline for the current buffer.
2173 e     Export views to associated files.
2174 s     Search entries for keywords.
2175 /     Multi occur across all agenda files and also files listed
2176       in `org-agenda-text-search-extra-files'.
2177 <     Restrict agenda commands to buffer, subtree, or region.
2178       Press several times to get the desired effect.
2179 >     Remove a previous restriction.
2180 #     List \"stuck\" projects.
2181 !     Configure what \"stuck\" means.
2182 C     Configure custom agenda commands.
2183
2184 More commands can be added by configuring the variable
2185 `org-agenda-custom-commands'.  In particular, specific tags and TODO keyword
2186 searches can be pre-defined in this way.
2187
2188 If the current buffer is in Org-mode and visiting a file, you can also
2189 first press `<' once to indicate that the agenda should be temporarily
2190 \(until the next use of \\[org-agenda]) restricted to the current file.
2191 Pressing `<' twice means to restrict to the current subtree or region
2192 \(if active)."
2193   (interactive "P")
2194   (catch 'exit
2195     (let* ((prefix-descriptions nil)
2196            (org-agenda-window-setup (if (equal (buffer-name)
2197                                                org-agenda-buffer-name)
2198                                         'current-window
2199                                       org-agenda-window-setup))
2200            (org-agenda-custom-commands-orig org-agenda-custom-commands)
2201            (org-agenda-custom-commands
2202             ;; normalize different versions
2203             (delq nil
2204                   (mapcar
2205                    (lambda (x)
2206                      (cond ((stringp (cdr x))
2207                             (push x prefix-descriptions)
2208                             nil)
2209                            ((stringp (nth 1 x)) x)
2210                            ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2211                            (t (cons (car x) (cons "" (cdr x))))))
2212                    org-agenda-custom-commands)))
2213            (buf (current-buffer))
2214            (bfn (buffer-file-name (buffer-base-buffer)))
2215            entry key type match lprops ans)
2216       ;; Turn off restriction unless there is an overriding one,
2217       (unless org-agenda-overriding-restriction
2218         (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2219           ;; There is a request to keep the file list in place
2220           (put 'org-agenda-files 'org-restrict nil))
2221         (setq org-agenda-restrict nil)
2222         (move-marker org-agenda-restrict-begin nil)
2223         (move-marker org-agenda-restrict-end nil))
2224       ;; Delete old local properties
2225       (put 'org-agenda-redo-command 'org-lprops nil)
2226       ;; Delete previously set last-arguments
2227       (put 'org-agenda-redo-command 'last-args nil)
2228       ;; Remember where this call originated
2229       (setq org-agenda-last-dispatch-buffer (current-buffer))
2230       (unless keys
2231         (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2232               keys (car ans)
2233               restriction (cdr ans)))
2234       ;; Establish the restriction, if any
2235       (when (and (not org-agenda-overriding-restriction) restriction)
2236         (put 'org-agenda-files 'org-restrict (list bfn))
2237         (cond
2238          ((eq restriction 'region)
2239           (setq org-agenda-restrict t)
2240           (move-marker org-agenda-restrict-begin (region-beginning))
2241           (move-marker org-agenda-restrict-end (region-end)))
2242          ((eq restriction 'subtree)
2243           (save-excursion
2244             (setq org-agenda-restrict t)
2245             (org-back-to-heading t)
2246             (move-marker org-agenda-restrict-begin (point))
2247             (move-marker org-agenda-restrict-end
2248                          (progn (org-end-of-subtree t)))))))
2249
2250       ;; For example the todo list should not need it (but does...)
2251       (cond
2252        ((setq entry (assoc keys org-agenda-custom-commands))
2253         (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2254             (progn
2255               (setq type (nth 2 entry) match (eval (nth 3 entry))
2256                     lprops (nth 4 entry))
2257               (put 'org-agenda-redo-command 'org-lprops lprops)
2258               (cond
2259                ((eq type 'agenda)
2260                 (org-let lprops '(org-agenda-list current-prefix-arg)))
2261                ((eq type 'alltodo)
2262                 (org-let lprops '(org-todo-list current-prefix-arg)))
2263                ((eq type 'search)
2264                 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2265                ((eq type 'stuck)
2266                 (org-let lprops '(org-agenda-list-stuck-projects
2267                                   current-prefix-arg)))
2268                ((eq type 'tags)
2269                 (org-let lprops '(org-tags-view current-prefix-arg match)))
2270                ((eq type 'tags-todo)
2271                 (org-let lprops '(org-tags-view '(4) match)))
2272                ((eq type 'todo)
2273                 (org-let lprops '(org-todo-list match)))
2274                ((eq type 'tags-tree)
2275                 (org-check-for-org-mode)
2276                 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2277                ((eq type 'todo-tree)
2278                 (org-check-for-org-mode)
2279                 (org-let lprops
2280                   '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2281                                       (regexp-quote match) "\\>"))))
2282                ((eq type 'occur-tree)
2283                 (org-check-for-org-mode)
2284                 (org-let lprops '(org-occur match)))
2285                ((functionp type)
2286                 (org-let lprops '(funcall type match)))
2287                ((fboundp type)
2288                 (org-let lprops '(funcall type match)))
2289                (t (error "Invalid custom agenda command type %s" type))))
2290           (org-agenda-run-series (nth 1 entry) (cddr entry))))
2291        ((equal keys "C")
2292         (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2293         (customize-variable 'org-agenda-custom-commands))
2294        ((equal keys "a") (call-interactively 'org-agenda-list))
2295        ((equal keys "s") (call-interactively 'org-search-view))
2296        ((equal keys "t") (call-interactively 'org-todo-list))
2297        ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2298        ((equal keys "m") (call-interactively 'org-tags-view))
2299        ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2300        ((equal keys "e") (call-interactively 'org-store-agenda-views))
2301        ((equal keys "?") (org-tags-view nil "+FLAGGED")
2302         (org-add-hook
2303          'post-command-hook
2304          (lambda ()
2305            (unless (current-message)
2306              (let* ((m (org-agenda-get-any-marker))
2307                     (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2308                (when note
2309                  (message (concat
2310                            "FLAGGING-NOTE ([?] for more info): "
2311                            (org-add-props
2312                                (replace-regexp-in-string
2313                                 "\\\\n" "//"
2314                                 (copy-sequence note))
2315                                nil 'face 'org-warning)))))))
2316          t t))
2317        ((equal keys "L")
2318         (unless (org-mode-p)
2319           (error "This is not an Org-mode file"))
2320         (unless restriction
2321           (put 'org-agenda-files 'org-restrict (list bfn))
2322           (org-call-with-arg 'org-timeline arg)))
2323        ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2324        ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2325        ((equal keys "!") (customize-variable 'org-stuck-projects))
2326        (t (error "Invalid agenda key"))))))
2327
2328 (defun org-agenda-append-agenda ()
2329   "Append another agenda view to the current one.
2330 This function allows interactive building of block agendas.
2331 Agenda views are separated by `org-agenda-block-separator'."
2332   (interactive)
2333   (unless (string= (buffer-name) org-agenda-buffer-name)
2334     (error "Can only append from within agenda buffer"))
2335   (let ((org-agenda-multi t))
2336     (org-agenda)
2337     (widen)))
2338
2339 (defun org-agenda-normalize-custom-commands (cmds)
2340   (delq nil
2341         (mapcar
2342          (lambda (x)
2343            (cond ((stringp (cdr x)) nil)
2344                  ((stringp (nth 1 x)) x)
2345                  ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2346                  (t (cons (car x) (cons "" (cdr x))))))
2347          cmds)))
2348
2349 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2350   "The user interface for selecting an agenda command."
2351   (catch 'exit
2352     (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2353            (restrict-ok (and bfn (org-mode-p)))
2354            (region-p (org-region-active-p))
2355            (custom org-agenda-custom-commands)
2356            (selstring "")
2357            restriction second-time
2358            c entry key type match prefixes rmheader header-end custom1 desc
2359            line lines left right n n1)
2360       (save-window-excursion
2361         (delete-other-windows)
2362         (org-switch-to-buffer-other-window " *Agenda Commands*")
2363         (erase-buffer)
2364         (insert (eval-when-compile
2365                   (let ((header
2366 "
2367 Press key for an agenda command:        <   Buffer, subtree/region restriction
2368 --------------------------------        >   Remove restriction
2369 a   Agenda for current week or day      e   Export agenda views
2370 t   List of all TODO entries            T   Entries with special TODO kwd
2371 m   Match a TAGS/PROP/TODO query        M   Like m, but only TODO entries
2372 L   Timeline for current buffer         #   List stuck projects (!=configure)
2373 s   Search for keywords                 C   Configure custom agenda commands
2374 /   Multi-occur                         ?   Find :FLAGGED: entries
2375 ")
2376                         (start 0))
2377                     (while (string-match
2378                             "\\(^\\|   \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2379                             header start)
2380                       (setq start (match-end 0))
2381                       (add-text-properties (match-beginning 2) (match-end 2)
2382                                            '(face bold) header))
2383                     header)))
2384         (setq header-end (move-marker (make-marker) (point)))
2385         (while t
2386           (setq custom1 custom)
2387           (when (eq rmheader t)
2388             (org-goto-line 1)
2389             (re-search-forward ":" nil t)
2390             (delete-region (match-end 0) (point-at-eol))
2391             (forward-char 1)
2392             (looking-at "-+")
2393             (delete-region (match-end 0) (point-at-eol))
2394             (move-marker header-end (match-end 0)))
2395           (goto-char header-end)
2396           (delete-region (point) (point-max))
2397
2398           ;; Produce all the lines that describe custom commands and prefixes
2399           (setq lines nil)
2400           (while (setq entry (pop custom1))
2401             (setq key (car entry) desc (nth 1 entry)
2402                   type (nth 2 entry)
2403                   match (nth 3 entry))
2404             (if (> (length key) 1)
2405                 (add-to-list 'prefixes (string-to-char key))
2406               (setq line
2407                     (format
2408                      "%-4s%-14s"
2409                      (org-add-props (copy-sequence key)
2410                          '(face bold))
2411                      (cond
2412                       ((string-match "\\S-" desc) desc)
2413                       ((eq type 'agenda) "Agenda for current week or day")
2414                       ((eq type 'alltodo) "List of all TODO entries")
2415                       ((eq type 'search) "Word search")
2416                       ((eq type 'stuck) "List of stuck projects")
2417                       ((eq type 'todo) "TODO keyword")
2418                       ((eq type 'tags) "Tags query")
2419                       ((eq type 'tags-todo) "Tags (TODO)")
2420                       ((eq type 'tags-tree) "Tags tree")
2421                       ((eq type 'todo-tree) "TODO kwd tree")
2422                       ((eq type 'occur-tree) "Occur tree")
2423                       ((functionp type) (if (symbolp type)
2424                                             (symbol-name type)
2425                                           "Lambda expression"))
2426                       (t "???"))))
2427               (if org-agenda-menu-show-matcher
2428                   (setq line
2429                         (concat line ": "
2430                                 (cond
2431                                  ((stringp match)
2432                                   (setq match (copy-sequence match))
2433                                   (org-add-props match nil 'face 'org-warning))
2434                                  (match
2435                                   (format "set of %d commands" (length match)))
2436                                  (t ""))))
2437                 (if (org-string-nw-p match)
2438                     (add-text-properties
2439                      0 (length line) (list 'help-echo
2440                                            (concat "Matcher: "match)) line)))
2441               (push line lines)))
2442           (setq lines (nreverse lines))
2443           (when prefixes
2444             (mapc (lambda (x)
2445                     (push
2446                      (format "%s   %s"
2447                              (org-add-props (char-to-string x)
2448                                  nil 'face 'bold)
2449                              (or (cdr (assoc (concat selstring
2450                                                      (char-to-string x))
2451                                              prefix-descriptions))
2452                                  "Prefix key"))
2453                      lines))
2454                   prefixes))
2455
2456           ;; Check if we should display in two columns
2457           (if org-agenda-menu-two-column
2458               (progn
2459                 (setq n (length lines)
2460                       n1 (+ (/ n 2) (mod n 2))
2461                       right (nthcdr n1 lines)
2462                       left (copy-sequence lines))
2463                 (setcdr (nthcdr (1- n1) left) nil))
2464             (setq left lines right nil))
2465           (while left
2466             (insert "\n" (pop left))
2467             (when right
2468               (if (< (current-column) 40)
2469                   (move-to-column 40 t)
2470                 (insert "   "))
2471               (insert (pop right))))
2472
2473           ;; Make the window the right size
2474           (goto-char (point-min))
2475           (if second-time
2476               (if (not (pos-visible-in-window-p (point-max)))
2477                   (org-fit-window-to-buffer))
2478             (setq second-time t)
2479             (org-fit-window-to-buffer))
2480
2481           ;; Ask for selection
2482           (message "Press key for agenda command%s:"
2483                    (if (or restrict-ok org-agenda-overriding-restriction)
2484                        (if org-agenda-overriding-restriction
2485                            " (restriction lock active)"
2486                          (if restriction
2487                              (format " (restricted to %s)" restriction)
2488                            " (unrestricted)"))
2489                      ""))
2490           (setq c (read-char-exclusive))
2491           (message "")
2492           (cond
2493            ((assoc (char-to-string c) custom)
2494             (setq selstring (concat selstring (char-to-string c)))
2495             (throw 'exit (cons selstring restriction)))
2496            ((memq c prefixes)
2497             (setq selstring (concat selstring (char-to-string c))
2498                   prefixes nil
2499                   rmheader (or rmheader t)
2500                   custom (delq nil (mapcar
2501                                     (lambda (x)
2502                                       (if (or (= (length (car x)) 1)
2503                                               (/= (string-to-char (car x)) c))
2504                                           nil
2505                                         (cons (substring (car x) 1) (cdr x))))
2506                                     custom))))
2507            ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2508             (message "Restriction is only possible in Org-mode buffers")
2509             (ding) (sit-for 1))
2510            ((eq c ?1)
2511             (org-agenda-remove-restriction-lock 'noupdate)
2512             (setq restriction 'buffer))
2513            ((eq c ?0)
2514             (org-agenda-remove-restriction-lock 'noupdate)
2515             (setq restriction (if region-p 'region 'subtree)))
2516            ((eq c ?<)
2517             (org-agenda-remove-restriction-lock 'noupdate)
2518             (setq restriction
2519                   (cond
2520                    ((eq restriction 'buffer)
2521                     (if region-p 'region 'subtree))
2522                    ((memq restriction '(subtree region))
2523                     nil)
2524                    (t 'buffer))))
2525            ((eq c ?>)
2526             (org-agenda-remove-restriction-lock 'noupdate)
2527             (setq restriction nil))
2528            ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2529             (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2530            ((and (> (length selstring) 0) (eq c ?\d))
2531             (delete-window)
2532             (org-agenda-get-restriction-and-command prefix-descriptions))
2533
2534            ((equal c ?q) (error "Abort"))
2535            (t (error "Invalid key %c" c))))))))
2536
2537 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2538 (defvar org-agenda-last-arguments nil
2539   "The arguments of the previous call to `org-agenda'.")
2540 (defun org-agenda-run-series (name series)
2541   (org-let (nth 1 series) '(org-prepare-agenda name))
2542   (let* ((org-agenda-multi t)
2543          (redo (list 'org-agenda-run-series name (list 'quote series)))
2544          (org-agenda-overriding-arguments
2545           (or org-agenda-overriding-arguments
2546               (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2547                 (get 'org-agenda-redo-command 'last-args))))
2548          (cmds (car series))
2549          (gprops (nth 1 series))
2550          match ;; The byte compiler incorrectly complains about this.  Keep it!
2551          cmd type lprops)
2552     (while (setq cmd (pop cmds))
2553       (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2554       (cond
2555        ((eq type 'agenda)
2556         (org-let2 gprops lprops
2557           '(call-interactively 'org-agenda-list)))
2558        ((eq type 'alltodo)
2559         (org-let2 gprops lprops
2560           '(call-interactively 'org-todo-list)))
2561        ((eq type 'search)
2562         (org-let2 gprops lprops
2563                   '(org-search-view current-prefix-arg match nil)))
2564        ((eq type 'stuck)
2565         (org-let2 gprops lprops
2566           '(call-interactively 'org-agenda-list-stuck-projects)))
2567        ((eq type 'tags)
2568         (org-let2 gprops lprops
2569                   '(org-tags-view current-prefix-arg match)))
2570        ((eq type 'tags-todo)
2571         (org-let2 gprops lprops
2572                   '(org-tags-view '(4) match)))
2573        ((eq type 'todo)
2574         (org-let2 gprops lprops
2575                   '(org-todo-list match)))
2576        ((fboundp type)
2577         (org-let2 gprops lprops
2578           '(funcall type match)))
2579        (t (error "Invalid type in command series"))))
2580     (widen)
2581     (setq org-agenda-redo-command redo)
2582     (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2583     (goto-char (point-min)))
2584   (org-fit-agenda-window)
2585   (org-let (nth 1 series) '(org-finalize-agenda)))
2586
2587 ;;;###autoload
2588 (defmacro org-batch-agenda (cmd-key &rest parameters)
2589   "Run an agenda command in batch mode and send the result to STDOUT.
2590 If CMD-KEY is a string of length 1, it is used as a key in
2591 `org-agenda-custom-commands' and triggers this command.  If it is a
2592 longer string it is used as a tags/todo match string.
2593 Parameters are alternating variable names and values that will be bound
2594 before running the agenda command."
2595   (org-eval-in-environment (org-make-parameter-alist parameters)
2596     (if (> (length cmd-key) 2)
2597         (org-tags-view nil cmd-key)
2598       (org-agenda nil cmd-key)))
2599   (set-buffer org-agenda-buffer-name)
2600   (princ (org-encode-for-stdout (buffer-string))))
2601 (def-edebug-spec org-batch-agenda (form &rest sexp))
2602
2603 ;(defun org-encode-for-stdout (string)
2604 ;  (if (fboundp 'encode-coding-string)
2605 ;      (encode-coding-string string buffer-file-coding-system)
2606 ;    string))
2607
2608 (defun org-encode-for-stdout (string)
2609   string)
2610
2611 (defvar org-agenda-info nil)
2612
2613 ;;;###autoload
2614 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2615   "Run an agenda command in batch mode and send the result to STDOUT.
2616 If CMD-KEY is a string of length 1, it is used as a key in
2617 `org-agenda-custom-commands' and triggers this command.  If it is a
2618 longer string it is used as a tags/todo match string.
2619 Parameters are alternating variable names and values that will be bound
2620 before running the agenda command.
2621
2622 The output gives a line for each selected agenda item.  Each
2623 item is a list of comma-separated values, like this:
2624
2625 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2626
2627 category     The category of the item
2628 head         The headline, without TODO kwd, TAGS and PRIORITY
2629 type         The type of the agenda entry, can be
2630                 todo               selected in TODO match
2631                 tagsmatch          selected in tags match
2632                 diary              imported from diary
2633                 deadline           a deadline on given date
2634                 scheduled          scheduled on given date
2635                 timestamp          entry has timestamp on given date
2636                 closed             entry was closed on given date
2637                 upcoming-deadline  warning about deadline
2638                 past-scheduled     forwarded scheduled item
2639                 block              entry has date block including g. date
2640 todo         The todo keyword, if any
2641 tags         All tags including inherited ones, separated by colons
2642 date         The relevant date, like 2007-2-14
2643 time         The time, like 15:00-16:50
2644 extra        Sting with extra planning info
2645 priority-l   The priority letter if any was given
2646 priority-n   The computed numerical priority
2647 agenda-day   The day in the agenda where this is listed"
2648   (org-eval-in-environment (append '((org-agenda-remove-tags t))
2649                                    (org-make-parameter-alist parameters))
2650     (if (> (length cmd-key) 2)
2651         (org-tags-view nil cmd-key)
2652       (org-agenda nil cmd-key)))
2653   (set-buffer org-agenda-buffer-name)
2654   (let* ((lines (org-split-string (buffer-string) "\n"))
2655          line)
2656     (while (setq line (pop lines))
2657       (catch 'next
2658         (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2659         (setq org-agenda-info
2660               (org-fix-agenda-info (text-properties-at 0 line)))
2661         (princ
2662          (org-encode-for-stdout
2663           (mapconcat 'org-agenda-export-csv-mapper
2664                      '(org-category txt type todo tags date time extra
2665                                     priority-letter priority agenda-day)
2666                      ",")))
2667         (princ "\n")))))
2668 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2669
2670 (defun org-fix-agenda-info (props)
2671   "Make sure all properties on an agenda item have a canonical form.
2672 This ensures the export commands can easily use it."
2673   (let (tmp re)
2674     (when (setq tmp (plist-get props 'tags))
2675       (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2676     (when (setq tmp (plist-get props 'date))
2677       (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2678       (let ((calendar-date-display-form '(year "-" month "-" day)))
2679         '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2680
2681         (setq tmp (calendar-date-string tmp)))
2682       (setq props (plist-put props 'date tmp)))
2683     (when (setq tmp (plist-get props 'day))
2684       (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2685       (let ((calendar-date-display-form '(year "-" month "-" day)))
2686         (setq tmp (calendar-date-string tmp)))
2687       (setq props (plist-put props 'day tmp))
2688       (setq props (plist-put props 'agenda-day tmp)))
2689     (when (setq tmp (plist-get props 'txt))
2690       (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2691         (plist-put props 'priority-letter (match-string 1 tmp))
2692         (setq tmp (replace-match "" t t tmp)))
2693       (when (and (setq re (plist-get props 'org-todo-regexp))
2694                  (setq re (concat "\\`\\.*" re " ?"))
2695                  (string-match re tmp))
2696         (plist-put props 'todo (match-string 1 tmp))
2697         (setq tmp (replace-match "" t t tmp)))
2698       (plist-put props 'txt tmp)))
2699   props)
2700
2701 (defun org-agenda-export-csv-mapper (prop)
2702   (let ((res (plist-get org-agenda-info prop)))
2703     (setq res
2704           (cond
2705            ((not res) "")
2706            ((stringp res) res)
2707            (t (prin1-to-string res))))
2708     (while (string-match "," res)
2709       (setq res (replace-match ";" t t res)))
2710     (org-trim res)))
2711
2712
2713 ;;;###autoload
2714 (defun org-store-agenda-views (&rest parameters)
2715   (interactive)
2716   (eval (list 'org-batch-store-agenda-views)))
2717
2718 ;;;###autoload
2719 (defmacro org-batch-store-agenda-views (&rest parameters)
2720   "Run all custom agenda commands that have a file argument."
2721   (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2722         (pop-up-frames nil)
2723         (dir default-directory)
2724         (pars (org-make-parameter-alist parameters))
2725         cmd thiscmdkey files opts cmd-or-set)
2726     (save-window-excursion
2727       (while cmds
2728         (setq cmd (pop cmds)
2729               thiscmdkey (car cmd)
2730               cmd-or-set (nth 2 cmd)
2731               opts (nth (if (listp cmd-or-set) 3 4) cmd)
2732               files (nth (if (listp cmd-or-set) 4 5) cmd))
2733         (if (stringp files) (setq files (list files)))
2734         (when files
2735           (org-eval-in-environment (append org-agenda-exporter-settings
2736                                            opts pars)
2737             (org-agenda nil thiscmdkey))
2738           (set-buffer org-agenda-buffer-name)
2739           (while files
2740             (org-eval-in-environment (append org-agenda-exporter-settings
2741                                              opts pars)
2742               (org-write-agenda (expand-file-name (pop files) dir) nil t)))
2743           (and (get-buffer org-agenda-buffer-name)
2744                (kill-buffer org-agenda-buffer-name)))))))
2745 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2746
2747 (defun org-agenda-mark-header-line (pos)
2748   "Mark the line at POS as an agenda structure header."
2749   (save-excursion
2750     (goto-char pos)
2751     (put-text-property (point-at-bol) (point-at-eol)
2752                        'org-agenda-structural-header t)
2753     (when org-agenda-title-append
2754       (put-text-property (point-at-bol) (point-at-eol)
2755                          'org-agenda-title-append org-agenda-title-append))))
2756
2757 (defvar org-mobile-creating-agendas)
2758 (defun org-write-agenda (file &optional open nosettings)
2759   "Write the current buffer (an agenda view) as a file.
2760 Depending on the extension of the file name, plain text (.txt),
2761 HTML (.html or .htm) or Postscript (.ps) is produced.
2762 If the extension is .ics, run icalendar export over all files used
2763 to construct the agenda and limit the export to entries listed in the
2764 agenda now.
2765 With prefix argument OPEN, open the new file immediately.
2766 If NOSETTINGS is given, do not scope the settings of
2767 `org-agenda-exporter-settings' into the export commands.  This is used when
2768 the settings have already been scoped and we do not wish to overrule other,
2769 higher priority settings."
2770   (interactive "FWrite agenda to file: \nP")
2771   (if (not (file-writable-p file))
2772       (error "Cannot write agenda to file %s" file))
2773   (org-let (if nosettings nil org-agenda-exporter-settings)
2774     '(save-excursion
2775        (save-window-excursion
2776          (org-agenda-mark-filtered-text)
2777          (let ((bs (copy-sequence (buffer-string))) beg)
2778            (org-agenda-unmark-filtered-text)
2779            (with-temp-buffer
2780              (rename-buffer "Agenda View" t)
2781              (set-buffer-modified-p nil)
2782              (insert bs)
2783              (org-agenda-remove-marked-text 'org-filtered)
2784              (while (setq beg (text-property-any (point-min) (point-max)
2785                                                  'org-filtered t))
2786                (delete-region
2787                 beg (or (next-single-property-change beg 'org-filtered)
2788                         (point-max))))
2789              (run-hooks 'org-agenda-before-write-hook)
2790              (cond
2791               ((org-bound-and-true-p org-mobile-creating-agendas)
2792                (org-mobile-write-agenda-for-mobile file))
2793               ((string-match "\\.html?\\'" file)
2794                (require 'htmlize)
2795                (set-buffer (htmlize-buffer (current-buffer)))
2796
2797                (when (and org-agenda-export-html-style
2798                           (string-match "<style>" org-agenda-export-html-style))
2799                  ;; replace <style> section with org-agenda-export-html-style
2800                  (goto-char (point-min))
2801                  (kill-region (- (search-forward "<style") 6)
2802                               (search-forward "</style>"))
2803                  (insert org-agenda-export-html-style))
2804                (write-file file)
2805                (kill-buffer (current-buffer))
2806                (message "HTML written to %s" file))
2807               ((string-match "\\.ps\\'" file)
2808                (require 'ps-print)
2809                (ps-print-buffer-with-faces file)
2810                (message "Postscript written to %s" file))
2811               ((string-match "\\.pdf\\'" file)
2812                (require 'ps-print)
2813                (ps-print-buffer-with-faces
2814                 (concat (file-name-sans-extension file) ".ps"))
2815                (call-process "ps2pdf" nil nil nil
2816                              (expand-file-name
2817                               (concat (file-name-sans-extension file) ".ps"))
2818                              (expand-file-name file))
2819                (delete-file (concat (file-name-sans-extension file) ".ps"))
2820                (message "PDF written to %s" file))
2821               ((string-match "\\.ics\\'" file)
2822                (require 'org-icalendar)
2823                (let ((org-agenda-marker-table
2824                       (org-create-marker-find-array
2825                        (org-agenda-collect-markers)))
2826                      (org-icalendar-verify-function 'org-check-agenda-marker-table)
2827                      (org-combined-agenda-icalendar-file file))
2828                  (apply 'org-export-icalendar 'combine
2829                         (org-agenda-files nil 'ifmode))))
2830               (t
2831                (let ((bs (buffer-string)))
2832                  (find-file file)
2833                  (erase-buffer)
2834                  (insert bs)
2835                  (save-buffer 0)
2836                  (kill-buffer (current-buffer))
2837                  (message "Plain text written to %s" file))))))))
2838     (set-buffer org-agenda-buffer-name))
2839   (when open (org-open-file file)))
2840
2841 (defvar org-agenda-filter-overlays nil)
2842
2843 (defun org-agenda-mark-filtered-text ()
2844   "Mark all text hidden by filtering with a text property."
2845   (let ((inhibit-read-only t))
2846     (mapc
2847      (lambda (o)
2848        (when (equal (overlay-buffer o) (current-buffer))
2849          (put-text-property
2850           (overlay-start o) (overlay-end o)
2851           'org-filtered t)))
2852      org-agenda-filter-overlays)))
2853
2854 (defun org-agenda-unmark-filtered-text ()
2855   "Remove the filtering text property."
2856   (let ((inhibit-read-only t))
2857     (remove-text-properties (point-min) (point-max) '(org-filtered t))))
2858
2859 (defun org-agenda-remove-marked-text (property &optional value)
2860   "Delete all text marked with VALUE of PROPERTY.
2861 VALUE defaults to t."
2862   (let (beg)
2863     (setq value (or value t))
2864     (while (setq beg (text-property-any (point-min) (point-max)
2865                                         property value))
2866       (delete-region
2867        beg (or (next-single-property-change beg 'org-filtered)
2868                (point-max))))))
2869
2870 (defun org-agenda-add-entry-text ()
2871   "Add entry text to agenda lines.
2872 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
2873 entry text following headings shown in the agenda.
2874 Drawers will be excluded, also the line with scheduling/deadline info."
2875   (when (and (> org-agenda-add-entry-text-maxlines 0)
2876              (not (org-bound-and-true-p org-mobile-creating-agendas)))
2877     (let (m txt)
2878       (goto-char (point-min))
2879       (while (not (eobp))
2880         (if (not (setq m (org-get-at-bol 'org-hd-marker)))
2881             (beginning-of-line 2)
2882           (setq txt (org-agenda-get-some-entry-text
2883                      m org-agenda-add-entry-text-maxlines "    > "))
2884           (end-of-line 1)
2885           (if (string-match "\\S-" txt)
2886               (insert "\n" txt)
2887             (or (eobp) (forward-char 1))))))))
2888
2889 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
2890                                               &rest keep)
2891   "Extract entry text from MARKER, at most N-LINES lines.
2892 This will ignore drawers etc, just get the text.
2893 If INDENT is given, prefix every line with this string.  If KEEP is
2894 given, it is a list of symbols, defining stuff that should not be
2895 removed from the entry content.  Currently only `planning' is allowed here."
2896   (let (txt drawer-re kwd-time-re ind)
2897     (save-excursion
2898       (with-current-buffer (marker-buffer marker)
2899         (if (not (org-mode-p))
2900             (setq txt "")
2901           (save-excursion
2902             (save-restriction
2903               (widen)
2904               (goto-char marker)
2905               (end-of-line 1)
2906               (setq txt (buffer-substring
2907                          (min (1+ (point)) (point-max))
2908                          (progn (outline-next-heading) (point)))
2909                     drawer-re org-drawer-regexp
2910                     kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
2911                                         ".*\n?"))
2912               (with-temp-buffer
2913                 (insert txt)
2914                 (when org-agenda-add-entry-text-descriptive-links
2915                   (goto-char (point-min))
2916                   (while (org-activate-bracket-links (point-max))
2917                     (add-text-properties (match-beginning 0) (match-end 0)
2918                                          '(face org-link))))
2919                 (goto-char (point-min))
2920                 (while (re-search-forward org-bracket-link-regexp (point-max) t)
2921                   (set-text-properties (match-beginning 0) (match-end 0)
2922                                        nil))
2923                 (goto-char (point-min))
2924                 (while (re-search-forward drawer-re nil t)
2925                   (delete-region
2926                    (match-beginning 0)
2927                    (progn (re-search-forward
2928                            "^[ \t]*:END:.*\n?" nil 'move)
2929                           (point))))
2930                 (unless (member 'planning keep)
2931                   (goto-char (point-min))
2932                   (while (re-search-forward kwd-time-re nil t)
2933                     (replace-match "")))
2934                 (goto-char (point-min))
2935                 (when org-agenda-entry-text-exclude-regexps
2936                   (let ((re-list org-agenda-entry-text-exclude-regexps) re)
2937                     (while (setq re (pop re-list))
2938                       (goto-char (point-min))
2939                       (while (re-search-forward re nil t)
2940                         (replace-match "")))))
2941                 (goto-char (point-max))
2942                 (skip-chars-backward " \t\n")
2943                 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
2944
2945                 ;; find and remove min common indentation
2946                 (goto-char (point-min))
2947                 (untabify (point-min) (point-max))
2948                 (setq ind (org-get-indentation))
2949                 (while (not (eobp))
2950                   (unless (looking-at "[ \t]*$")
2951                     (setq ind (min ind (org-get-indentation))))
2952                   (beginning-of-line 2))
2953                 (goto-char (point-min))
2954                 (while (not (eobp))
2955                   (unless (looking-at "[ \t]*$")
2956                     (move-to-column ind)
2957                     (delete-region (point-at-bol) (point)))
2958                   (beginning-of-line 2))
2959
2960                 (run-hooks 'org-agenda-entry-text-cleanup-hook)
2961
2962                 (goto-char (point-min))
2963                 (when indent
2964                   (while (and (not (eobp)) (re-search-forward "^" nil t))
2965                     (replace-match indent t t)))
2966                 (goto-char (point-min))
2967                 (while (looking-at "[ \t]*\n") (replace-match ""))
2968                 (goto-char (point-max))
2969                 (when (> (org-current-line)
2970                          n-lines)
2971                   (org-goto-line (1+ n-lines))
2972                   (backward-char 1))
2973                 (setq txt (buffer-substring (point-min) (point)))))))))
2974     txt))
2975
2976 (defun org-agenda-collect-markers ()
2977   "Collect the markers pointing to entries in the agenda buffer."
2978   (let (m markers)
2979     (save-excursion
2980       (goto-char (point-min))
2981       (while (not (eobp))
2982         (when (setq m (or (org-get-at-bol 'org-hd-marker)
2983                           (org-get-at-bol 'org-marker)))
2984           (push m markers))
2985         (beginning-of-line 2)))
2986     (nreverse markers)))
2987
2988 (defun org-create-marker-find-array (marker-list)
2989   "Create a alist of files names with all marker positions in that file."
2990   (let (f tbl m a p)
2991     (while (setq m (pop marker-list))
2992       (setq p (marker-position m)
2993             f (buffer-file-name (or (buffer-base-buffer
2994                                      (marker-buffer m))
2995                                     (marker-buffer m))))
2996       (if (setq a (assoc f tbl))
2997           (push (marker-position m) (cdr a))
2998         (push (list f p) tbl)))
2999     (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
3000             tbl)))
3001
3002 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
3003 (defun org-check-agenda-marker-table ()
3004   "Check of the current entry is on the marker list."
3005   (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3006         a)
3007     (and (setq a (assoc file org-agenda-marker-table))
3008          (save-match-data
3009            (save-excursion
3010              (org-back-to-heading t)
3011              (member (point) (cdr a)))))))
3012
3013 (defun org-check-for-org-mode ()
3014   "Make sure current buffer is in org-mode.  Error if not."
3015   (or (org-mode-p)
3016       (error "Cannot execute org-mode agenda command on buffer in %s"
3017              major-mode)))
3018
3019 (defun org-fit-agenda-window ()
3020   "Fit the window to the buffer size."
3021   (and (memq org-agenda-window-setup '(reorganize-frame))
3022        (fboundp 'fit-window-to-buffer)
3023        (org-fit-window-to-buffer
3024         nil
3025         (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3026         (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3027
3028 ;;; Agenda prepare and finalize
3029
3030 (defvar org-agenda-multi nil)  ; dynamically scoped
3031 (defvar org-agenda-buffer-name "*Org Agenda*")
3032 (defvar org-pre-agenda-window-conf nil)
3033 (defvar org-agenda-columns-active nil)
3034 (defvar org-agenda-name nil)
3035 (defvar org-agenda-filter nil)
3036 (defvar org-agenda-filter-while-redo nil)
3037 (defvar org-agenda-filter-preset nil
3038   "A preset of the tags filter used for secondary agenda filtering.
3039 This must be a list of strings, each string must be a single tag preceded
3040 by \"+\" or \"-\".
3041 This variable should not be set directly, but agenda custom commands can
3042 bind it in the options section.  The preset filter is a global property of
3043 the entire agenda view.  In a block agenda, it will not work reliably to
3044 define a filter for one of the individual blocks.  You need to set it in
3045 the global options and expect it to be applied to the entire view.")
3046
3047 (defun org-prepare-agenda (&optional name)
3048   (setq org-todo-keywords-for-agenda nil)
3049   (setq org-done-keywords-for-agenda nil)
3050   (setq org-drawers-for-agenda nil)
3051   (unless org-agenda-persistent-filter
3052     (setq org-agenda-filter nil))
3053   (put 'org-agenda-filter :preset-filter org-agenda-filter-preset)
3054   (if org-agenda-multi
3055       (progn
3056         (setq buffer-read-only nil)
3057         (goto-char (point-max))
3058         (unless (or (bobp) org-agenda-compact-blocks
3059                     (not org-agenda-block-separator))
3060           (insert "\n"
3061                   (if (stringp org-agenda-block-separator)
3062                       org-agenda-block-separator
3063                     (make-string (window-width) org-agenda-block-separator))
3064                   "\n"))
3065         (narrow-to-region (point) (point-max)))
3066     (org-agenda-reset-markers)
3067     (setq org-agenda-contributing-files nil)
3068     (setq org-agenda-columns-active nil)
3069     (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3070     (setq org-todo-keywords-for-agenda
3071           (org-uniquify org-todo-keywords-for-agenda))
3072     (setq org-done-keywords-for-agenda
3073           (org-uniquify org-done-keywords-for-agenda))
3074     (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3075     (let* ((abuf (get-buffer-create org-agenda-buffer-name))
3076            (awin (get-buffer-window abuf)))
3077       (cond
3078        ((equal (current-buffer) abuf) nil)
3079        (awin (select-window awin))
3080        ((not (setq org-pre-agenda-window-conf (current-window-configuration))))
3081        ((equal org-agenda-window-setup 'current-window)
3082         (org-pop-to-buffer-same-window abuf))
3083        ((equal org-agenda-window-setup 'other-window)
3084         (org-switch-to-buffer-other-window abuf))
3085        ((equal org-agenda-window-setup 'other-frame)
3086         (switch-to-buffer-other-frame abuf))
3087        ((equal org-agenda-window-setup 'reorganize-frame)
3088         (delete-other-windows)
3089         (org-switch-to-buffer-other-window abuf)))
3090       ;; additional test in case agenda is invoked from within agenda
3091       ;; buffer via elisp link
3092       (unless (equal (current-buffer) abuf)
3093         (org-pop-to-buffer-same-window abuf)))
3094     (setq buffer-read-only nil)
3095     (let ((inhibit-read-only t)) (erase-buffer))
3096     (org-agenda-mode)
3097     (and name (not org-agenda-name)
3098          (org-set-local 'org-agenda-name name)))
3099   (setq buffer-read-only nil))
3100
3101 (defun org-finalize-agenda ()
3102   "Finishing touch for the agenda buffer, called just before displaying it."
3103   (unless org-agenda-multi
3104     (save-excursion
3105       (let ((inhibit-read-only t))
3106         (goto-char (point-min))
3107         (while (org-activate-bracket-links (point-max))
3108           (add-text-properties (match-beginning 0) (match-end 0)
3109                                '(face org-link)))
3110         (org-agenda-align-tags)
3111         (unless org-agenda-with-colors
3112           (remove-text-properties (point-min) (point-max) '(face nil))))
3113       (if (and (boundp 'org-agenda-overriding-columns-format)
3114                org-agenda-overriding-columns-format)
3115           (org-set-local 'org-agenda-overriding-columns-format
3116                          org-agenda-overriding-columns-format))
3117       (if (and (boundp 'org-agenda-view-columns-initially)
3118                org-agenda-view-columns-initially)
3119           (org-agenda-columns))
3120       (when org-agenda-fontify-priorities
3121         (org-agenda-fontify-priorities))
3122       (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3123         (org-agenda-dim-blocked-tasks))
3124       (org-agenda-mark-clocking-task)
3125       (when org-agenda-entry-text-mode
3126         (org-agenda-entry-text-hide)
3127         (org-agenda-entry-text-show))
3128       (if (functionp 'org-habit-insert-consistency-graphs)
3129           (org-habit-insert-consistency-graphs))
3130       (run-hooks 'org-finalize-agenda-hook)
3131       (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3132       (when (or org-agenda-filter (get 'org-agenda-filter :preset-filter))
3133         (org-agenda-filter-apply org-agenda-filter))
3134       )))
3135
3136 (defun org-agenda-mark-clocking-task ()
3137   "Mark the current clock entry in the agenda if it is present."
3138   (mapc (lambda (o)
3139           (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3140               (delete-overlay o)))
3141         (overlays-in (point-min) (point-max)))
3142   (when (marker-buffer org-clock-hd-marker)
3143     (save-excursion
3144       (goto-char (point-min))
3145       (let (s ov)
3146         (while (setq s (next-single-property-change (point) 'org-hd-marker))
3147           (goto-char s)
3148           (when (equal (org-get-at-bol 'org-hd-marker)
3149                        org-clock-hd-marker)
3150             (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3151             (overlay-put ov 'type 'org-agenda-clocking)
3152             (overlay-put ov 'face 'org-agenda-clocking)
3153             (overlay-put ov 'help-echo
3154                              "The clock is running in this item")))))))
3155
3156 (defun org-agenda-fontify-priorities ()
3157   "Make highest priority lines bold, and lowest italic."
3158   (interactive)
3159   (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3160                         (delete-overlay o)))
3161         (overlays-in (point-min) (point-max)))
3162   (save-excursion
3163     (let ((inhibit-read-only t)
3164           b e p ov h l)
3165       (goto-char (point-min))
3166       (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3167         (setq h (or (get-char-property (point) 'org-highest-priority)
3168                     org-highest-priority)
3169               l (or (get-char-property (point) 'org-lowest-priority)
3170                     org-lowest-priority)
3171               p (string-to-char (match-string 1))
3172               b (match-beginning 0)
3173               e (if (eq org-agenda-fontify-priorities 'cookies)
3174                     (match-end 0)
3175                   (point-at-eol))
3176               ov (make-overlay b e))
3177         (overlay-put
3178          ov 'face
3179          (cond ((org-face-from-face-or-color
3180                  'priority nil
3181                  (cdr (assoc p org-priority-faces))))
3182                ((and (listp org-agenda-fontify-priorities)
3183                      (org-face-from-face-or-color
3184                       'priority nil
3185                       (cdr (assoc p org-agenda-fontify-priorities)))))
3186                ((equal p l) 'italic)
3187                ((equal p h) 'bold)))
3188         (overlay-put ov 'org-type 'org-priority)))))
3189
3190 (defun org-agenda-dim-blocked-tasks ()
3191   "Dim currently blocked TODO's in the agenda display."
3192   (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3193                         (delete-overlay o)))
3194         (overlays-in (point-min) (point-max)))
3195   (save-excursion
3196     (let ((inhibit-read-only t)
3197           (org-depend-tag-blocked nil)
3198           (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3199           org-blocked-by-checkboxes
3200           invis1 b e p ov h l)
3201       (goto-char (point-min))
3202       (while (let ((pos (next-single-property-change (point) 'todo-state)))
3203                (and pos (goto-char (1+ pos))))
3204         (setq org-blocked-by-checkboxes nil invis1 invis)
3205         (let ((marker (org-get-at-bol 'org-hd-marker)))
3206           (when (and marker
3207                      (with-current-buffer (marker-buffer marker)
3208                        (save-excursion (goto-char marker)
3209                                        (org-entry-blocked-p))))
3210             (if org-blocked-by-checkboxes (setq invis1 nil))
3211             (setq b (if invis1
3212                         (max (point-min) (1- (point-at-bol)))
3213                       (point-at-bol))
3214                   e (point-at-eol)
3215                   ov (make-overlay b e))
3216             (if invis1
3217                 (overlay-put ov 'invisible t)
3218               (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3219             (overlay-put ov 'org-type 'org-blocked-todo)))))))
3220
3221 (defvar org-agenda-skip-function nil
3222   "Function to be called at each match during agenda construction.
3223 If this function returns nil, the current match should not be skipped.
3224 Otherwise, the function must return a position from where the search
3225 should be continued.
3226 This may also be a Lisp form, it will be evaluated.
3227 Never set this variable using `setq' or so, because then it will apply
3228 to all future agenda commands.  If you do want a global skipping condition,
3229 use the option `org-agenda-skip-function-global' instead.
3230 The correct usage for `org-agenda-skip-function' is to bind it with
3231 `let' to scope it dynamically into the agenda-constructing command.
3232 A good way to set it is through options in `org-agenda-custom-commands'.")
3233
3234 (defun org-agenda-skip ()
3235   "Throw to `:skip' in places that should be skipped.
3236 Also moves point to the end of the skipped region, so that search can
3237 continue from there."
3238   (let ((p (point-at-bol)) to)
3239     (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3240          (get-text-property p :org-archived)
3241          (org-end-of-subtree t)
3242          (throw :skip t))
3243     (and org-agenda-skip-comment-trees
3244          (get-text-property p :org-comment)
3245          (org-end-of-subtree t)
3246          (throw :skip t))
3247     (if (equal (char-after p) ?#) (throw :skip t))
3248     (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3249                        (org-agenda-skip-eval org-agenda-skip-function)))
3250       (goto-char to)
3251       (throw :skip t))))
3252
3253 (defun org-agenda-skip-eval (form)
3254   "If FORM is a function or a list, call (or eval) is and return result.
3255 `save-excursion' and `save-match-data' are wrapped around the call, so point
3256 and match data are returned to the previous state no matter what these
3257 functions do."
3258   (let (fp)
3259     (and form
3260          (or (setq fp (functionp form))
3261              (consp form))
3262          (save-excursion
3263            (save-match-data
3264              (if fp
3265                  (funcall form)
3266                (eval form)))))))
3267
3268 (defvar org-agenda-markers nil
3269   "List of all currently active markers created by `org-agenda'.")
3270 (defvar org-agenda-last-marker-time (org-float-time)
3271   "Creation time of the last agenda marker.")
3272
3273 (defun org-agenda-new-marker (&optional pos)
3274   "Return a new agenda marker.
3275 Org-mode keeps a list of these markers and resets them when they are
3276 no longer in use."
3277   (let ((m (copy-marker (or pos (point)))))
3278     (setq org-agenda-last-marker-time (org-float-time))
3279     (push m org-agenda-markers)
3280     m))
3281
3282 (defun org-agenda-reset-markers ()
3283   "Reset markers created by `org-agenda'."
3284   (while org-agenda-markers
3285     (move-marker (pop org-agenda-markers) nil)))
3286
3287 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3288   "Save relative positions of markers in region."
3289   (mapc (lambda (m) (org-check-and-save-marker m beg end))
3290         org-agenda-markers))
3291
3292 ;;; Entry text mode
3293
3294 (defun org-agenda-entry-text-show-here ()
3295   "Add some text from the entry as context to the current line."
3296   (let (m txt o)
3297     (setq m (org-get-at-bol 'org-hd-marker))
3298     (unless (marker-buffer m)
3299       (error "No marker points to an entry here"))
3300     (setq txt (concat "\n" (org-no-properties
3301                             (org-agenda-get-some-entry-text
3302                              m org-agenda-entry-text-maxlines "    > "))))
3303     (when (string-match "\\S-" txt)
3304       (setq o (make-overlay (point-at-bol) (point-at-eol)))
3305       (overlay-put o 'evaporate t)
3306       (overlay-put o 'org-overlay-type 'agenda-entry-content)
3307       (overlay-put o 'after-string txt))))
3308
3309 (defun org-agenda-entry-text-show ()
3310   "Add entry context for all agenda lines."
3311   (interactive)
3312   (save-excursion
3313     (goto-char (point-max))
3314     (beginning-of-line 1)
3315     (while (not (bobp))
3316       (when (org-get-at-bol 'org-hd-marker)
3317         (org-agenda-entry-text-show-here))
3318       (beginning-of-line 0))))
3319
3320 (defun org-agenda-entry-text-hide ()
3321   "Remove any shown entry context."
3322   (delq nil
3323         (mapcar (lambda (o)
3324                   (if (eq (overlay-get o 'org-overlay-type)
3325                           'agenda-entry-content)
3326                       (progn (delete-overlay o) t)))
3327                 (overlays-in (point-min) (point-max)))))
3328
3329 (defun org-agenda-get-day-face (date)
3330   "Return the face DATE should be displayed with."
3331   (or (and (functionp org-agenda-day-face-function)
3332            (funcall org-agenda-day-face-function date))
3333       (cond ((org-agenda-todayp date)
3334              'org-agenda-date-today)
3335             ((member (calendar-day-of-week date) org-agenda-weekend-days)
3336              'org-agenda-date-weekend)
3337             (t 'org-agenda-date))))
3338
3339 ;;; Agenda timeline
3340
3341 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3342
3343 (defun org-timeline (&optional dotodo)
3344   "Show a time-sorted view of the entries in the current org file.
3345 Only entries with a time stamp of today or later will be listed.  With
3346 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3347 under the current date.
3348 If the buffer contains an active region, only check the region for
3349 dates."
3350   (interactive "P")
3351   (org-compile-prefix-format 'timeline)
3352   (org-set-sorting-strategy 'timeline)
3353   (let* ((dopast t)
3354          (doclosed org-agenda-show-log)
3355          (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3356                                       (current-buffer))))
3357          (date (calendar-current-date))
3358          (beg (if (org-region-active-p) (region-beginning) (point-min)))
3359          (end (if (org-region-active-p) (region-end) (point-max)))
3360          (day-numbers (org-get-all-dates beg end 'no-ranges
3361                                          t doclosed ; always include today
3362                                          org-timeline-show-empty-dates))
3363          (org-deadline-warning-days 0)
3364          (org-agenda-only-exact-dates t)
3365          (today (org-today))
3366          (past t)
3367          args
3368          s e rtn d emptyp)
3369     (setq org-agenda-redo-command
3370           (list 'progn
3371                 (list 'org-switch-to-buffer-other-window (current-buffer))
3372                 (list 'org-timeline (list 'quote dotodo))))
3373     (if (not dopast)
3374         ;; Remove past dates from the list of dates.
3375         (setq day-numbers (delq nil (mapcar (lambda(x)
3376                                               (if (>= x today) x nil))
3377        &nb