Change default value of `org-agenda-skip-additional-timestamps-same-entry'
[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-show-outline-path t
876   "Non-nil means show outline path in echo area after line motion."
877   :group 'org-agenda-startup
878   :type 'boolean)
879
880 (defcustom org-agenda-start-with-entry-text-mode nil
881   "The initial value of entry-text-mode in a newly created agenda window."
882   :group 'org-agenda-startup
883   :type 'boolean)
884
885 (defcustom org-agenda-entry-text-maxlines 5
886   "Number of text lines to be added when `E' is pressed in the agenda.
887
888 Note that this variable only used during agenda display.  Add add entry text
889 when exporting the agenda, configure the variable
890 `org-agenda-add-entry-ext-maxlines'."
891   :group 'org-agenda
892   :type 'integer)
893
894 (defcustom org-agenda-entry-text-exclude-regexps nil
895   "List of regular expressions to clean up entry text.
896 The complete matches of all regular expressions in this list will be
897 removed from entry text before it is shown in the agenda."
898   :group 'org-agenda
899   :type '(repeat (regexp)))
900
901 (defvar org-agenda-entry-text-cleanup-hook nil
902   "Hook that is run after basic cleanup of entry text to be shown in agenda.
903 This cleanup is done in a temporary buffer, so the function may inspect and
904 change the entire buffer.
905 Some default stuff like drawers and scheduling/deadline dates will already
906 have been removed when this is called, as will any matches for regular
907 expressions listed in `org-agenda-entry-text-exclude-regexps'.")
908
909 (defvar org-agenda-include-inactive-timestamps nil
910   "Non-nil means include inactive time stamps in agenda and timeline.")
911
912 (defgroup org-agenda-windows nil
913   "Options concerning the windows used by the Agenda in Org Mode."
914   :tag "Org Agenda Windows"
915   :group 'org-agenda)
916
917 (defcustom org-agenda-window-setup 'reorganize-frame
918   "How the agenda buffer should be displayed.
919 Possible values for this option are:
920
921 current-window    Show agenda in the current window, keeping all other windows.
922 other-window      Use `switch-to-buffer-other-window' to display agenda.
923 reorganize-frame  Show only two windows on the current frame, the current
924                   window and the agenda.
925 other-frame       Use `switch-to-buffer-other-frame' to display agenda.
926                   Also, when exiting the agenda, kill that frame.
927 See also the variable `org-agenda-restore-windows-after-quit'."
928   :group 'org-agenda-windows
929   :type '(choice
930           (const current-window)
931           (const other-frame)
932           (const other-window)
933           (const reorganize-frame)))
934
935 (defcustom org-agenda-window-frame-fractions '(0.5 . 0.75)
936   "The min and max height of the agenda window as a fraction of frame height.
937 The value of the variable is a cons cell with two numbers between 0 and 1.
938 It only matters if `org-agenda-window-setup' is `reorganize-frame'."
939   :group 'org-agenda-windows
940   :type '(cons (number :tag "Minimum") (number :tag "Maximum")))
941
942 (defcustom org-agenda-restore-windows-after-quit nil
943   "Non-nil means restore window configuration upon exiting agenda.
944 Before the window configuration is changed for displaying the agenda,
945 the current status is recorded.  When the agenda is exited with
946 `q' or `x' and this option is set, the old state is restored.  If
947 `org-agenda-window-setup' is `other-frame', the value of this
948 option will be ignored."
949   :group 'org-agenda-windows
950   :type 'boolean)
951
952 (defcustom org-agenda-ndays nil
953    "Number of days to include in overview display.
954 Should be 1 or 7.
955 Obsolete, see `org-agenda-span'."
956    :group 'org-agenda-daily/weekly
957    :type 'integer)
958
959 (make-obsolete-variable 'org-agenda-ndays 'org-agenda-span "24.1")
960
961 (defcustom org-agenda-span 'week
962   "Number of days to include in overview display.
963 Can be day, week, month, year, or any number of days.
964 Custom commands can set this variable in the options section."
965   :group 'org-agenda-daily/weekly
966   :type '(choice (const :tag "Day" day)
967                  (const :tag "Week" week)
968                  (const :tag "Month" month)
969                  (const :tag "Year" year)
970                  (integer :tag "Custom")))
971
972 (defcustom org-agenda-start-on-weekday 1
973   "Non-nil means start the overview always on the specified weekday.
974 0 denotes Sunday, 1 denotes Monday etc.
975 When nil, always start on the current day.
976 Custom commands can set this variable in the options section."
977   :group 'org-agenda-daily/weekly
978   :type '(choice (const :tag "Today" nil)
979                  (integer :tag "Weekday No.")))
980
981 (defcustom org-agenda-show-all-dates t
982   "Non-nil means `org-agenda' shows every day in the selected range.
983 When nil, only the days which actually have entries are shown."
984   :group 'org-agenda-daily/weekly
985   :type 'boolean)
986
987 (defcustom org-agenda-format-date 'org-agenda-format-date-aligned
988   "Format string for displaying dates in the agenda.
989 Used by the daily/weekly agenda and by the timeline.  This should be
990 a format string understood by `format-time-string', or a function returning
991 the formatted date as a string.  The function must take a single argument,
992 a calendar-style date list like (month day year)."
993   :group 'org-agenda-daily/weekly
994   :type '(choice
995           (string :tag "Format string")
996           (function :tag "Function")))
997
998 (defun org-agenda-format-date-aligned (date)
999   "Format a date string for display in the daily/weekly agenda, or timeline.
1000 This function makes sure that dates are aligned for easy reading."
1001   (require 'cal-iso)
1002   (let* ((dayname (calendar-day-name date))
1003          (day (cadr date))
1004          (day-of-week (calendar-day-of-week date))
1005          (month (car date))
1006          (monthname (calendar-month-name month))
1007          (year (nth 2 date))
1008          (iso-week (org-days-to-iso-week
1009                     (calendar-absolute-from-gregorian date)))
1010          (weekyear (cond ((and (= month 1) (>= iso-week 52))
1011                           (1- year))
1012                          ((and (= month 12) (<= iso-week 1))
1013                           (1+ year))
1014                          (t year)))
1015          (weekstring (if (= day-of-week 1)
1016                          (format " W%02d" iso-week)
1017                        "")))
1018     (format "%-10s %2d %s %4d%s"
1019             dayname day monthname year weekstring)))
1020
1021 (defcustom org-agenda-time-leading-zero nil
1022   "Non-nil means use leading zero for military times in agenda.
1023 For example, 9:30am would become 09:30 rather than  9:30."
1024   :group 'org-agenda-daily/weekly
1025   :type 'boolean)
1026
1027 (defcustom org-agenda-timegrid-use-ampm nil
1028   "When set, show AM/PM style timestamps on the timegrid."
1029   :group 'org-agenda
1030   :type 'boolean)
1031
1032 (defun org-agenda-time-of-day-to-ampm (time)
1033   "Convert TIME of a string like '13:45' to an AM/PM style time string."
1034   (let* ((hour-number (string-to-number (substring time 0 -3)))
1035          (minute (substring time -2))
1036          (ampm "am"))
1037     (cond
1038      ((equal hour-number 12)
1039       (setq ampm "pm"))
1040      ((> hour-number 12)
1041       (setq ampm "pm")
1042       (setq hour-number (- hour-number 12))))
1043     (concat
1044      (if org-agenda-time-leading-zero
1045          (format "%02d" hour-number)
1046        (format "%02s" (number-to-string hour-number)))
1047      ":" minute ampm)))
1048
1049 (defun org-agenda-time-of-day-to-ampm-maybe (time)
1050   "Conditionally convert TIME to AM/PM format
1051 based on `org-agenda-timegrid-use-ampm'"
1052   (if org-agenda-timegrid-use-ampm
1053       (org-agenda-time-of-day-to-ampm time)
1054     time))
1055
1056 (defcustom org-agenda-weekend-days '(6 0)
1057   "Which days are weekend?
1058 These days get the special face `org-agenda-date-weekend' in the agenda
1059 and timeline buffers."
1060   :group 'org-agenda-daily/weekly
1061   :type '(set :greedy t
1062               (const :tag "Monday" 1)
1063               (const :tag "Tuesday" 2)
1064               (const :tag "Wednesday" 3)
1065               (const :tag "Thursday" 4)
1066               (const :tag "Friday" 5)
1067               (const :tag "Saturday" 6)
1068               (const :tag "Sunday" 0)))
1069
1070 (defcustom org-agenda-include-diary nil
1071   "If non-nil, include in the agenda entries from the Emacs Calendar's diary.
1072 Custom commands can set this variable in the options section."
1073   :group 'org-agenda-daily/weekly
1074   :type 'boolean)
1075
1076 (defcustom org-agenda-include-deadlines t
1077   "If non-nil, include entries within their deadline warning period.
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-repeating-timestamp-show-all t
1083   "Non-nil means show all occurrences of a repeating stamp in the agenda.
1084 When set to a list of strings, only show occurrences of repeating
1085 stamps for these TODO keywords.  When nil, only one occurrence is
1086 shown, either today or the nearest into the future."
1087   :group 'org-agenda-daily/weekly
1088   :type '(choice
1089           (const :tag "Show repeating stamps" t)
1090           (repeat :tag "Show repeating stamps for these TODO keywords"
1091                   (string :tag "TODO Keyword"))
1092           (const :tag "Don't show repeating stamps" nil)))
1093
1094 (defcustom org-scheduled-past-days 10000
1095   "No. of days to continue listing scheduled items that are not marked DONE.
1096 When an item is scheduled on a date, it shows up in the agenda on this
1097 day and will be listed until it is marked done for the number of days
1098 given here."
1099   :group 'org-agenda-daily/weekly
1100   :type 'integer)
1101
1102 (defcustom org-agenda-log-mode-items '(closed clock)
1103   "List of items that should be shown in agenda log mode.
1104 This list may contain the following symbols:
1105
1106   closed    Show entries that have been closed on that day.
1107   clock     Show entries that have received clocked time on that day.
1108   state     Show all logged state changes.
1109 Note that instead of changing this variable, you can also press `C-u l' in
1110 the agenda to display all available LOG items temporarily."
1111   :group 'org-agenda-daily/weekly
1112   :type '(set :greedy t (const closed) (const clock) (const state)))
1113
1114 (defcustom org-agenda-clock-consistency-checks
1115   '(:max-duration "10:00" :min-duration 0 :max-gap "0:05"
1116                   :gap-ok-around ("4:00")
1117                   :default-face ((:background "DarkRed") (:foreground "white"))
1118                   :overlap-face nil :gap-face nil :no-end-time-face nil
1119                   :long-face nil :short-face nil)
1120   "This is a property list, with the following keys:
1121
1122 :max-duration    Mark clocking chunks that are longer than this time.
1123                  This is a time string like \"HH:MM\", or the number
1124                  of minutes as an integer.
1125
1126 :min-duration    Mark clocking chunks that are shorter that this.
1127                  This is a time string like \"HH:MM\", or the number
1128                  of minutes as an integer.
1129
1130 :max-gap         Mark gaps between clocking chunks that are longer than
1131                  this duration.  A number of minutes, or a string
1132                  like \"HH:MM\".
1133
1134 :gap-ok-around   List of times during the day which are usually not working
1135                  times.  When a gap is detected, but the gap contains any
1136                  of these times, the gap is *not* reported.  For example,
1137                  if this is (\"4:00\" \"13:00\") then gaps that contain
1138                  4:00 in the morning (i.e. the night) and 13:00
1139                  (i.e. a typical lunch time) do not cause a warning.
1140                  You should have at least one time during the night in this
1141                  list, or otherwise the first task each morning will trigger
1142                  a warning because it follows a long gap.
1143
1144 Furthermore, the following properties can be used to define faces for
1145 issue display.
1146
1147 :default-face         the default face, if the specific face is undefined
1148 :overlap-face         face for overlapping clocks
1149 :gap-face             face for gaps between clocks
1150 :no-end-time-face     face for incomplete clocks
1151 :long-face            face for clock intervals that are too long
1152 :short-face           face for clock intervals that are too short"
1153   :group 'org-agenda-daily/weekly
1154   :group 'org-clock
1155   :type 'plist)
1156
1157 (defcustom org-agenda-log-mode-add-notes t
1158   "Non-nil means add first line of notes to log entries in agenda views.
1159 If a log item like a state change or a clock entry is associated with
1160 notes, the first line of these notes will be added to the entry in the
1161 agenda display."
1162   :group 'org-agenda-daily/weekly
1163   :type 'boolean)
1164
1165 (defcustom org-agenda-start-with-log-mode nil
1166   "The initial value of log-mode in a newly created agenda window."
1167   :group 'org-agenda-startup
1168   :group 'org-agenda-daily/weekly
1169   :type 'boolean)
1170
1171 (defcustom org-agenda-start-with-clockreport-mode nil
1172   "The initial value of clockreport-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-clockreport-parameter-plist '(:link t :maxlevel 2)
1178   "Property list with parameters for the clocktable in clockreport mode.
1179 This is the display mode that shows a clock table in the daily/weekly
1180 agenda, the properties for this dynamic block can be set here.
1181 The usual clocktable parameters are allowed here, but you cannot set
1182 the properties :name, :tstart, :tend, :block, and :scope - these will
1183 be overwritten to make sure the content accurately reflects the
1184 current display in the agenda."
1185   :group 'org-agenda-daily/weekly
1186   :type 'plist)
1187
1188 (defcustom org-agenda-search-view-always-boolean nil
1189   "Non-nil means the search string is interpreted as individual parts.
1190
1191 The search string for search view can either be interpreted as a phrase,
1192 or as a list of snippets that define a boolean search for a number of
1193 strings.
1194
1195 When this is non-nil, the string will be split on whitespace, and each
1196 snippet will be searched individually, and all must match in order to
1197 select an entry.  A snippet is then a single string of non-white
1198 characters, or a string in double quotes, or a regexp in {} braces.
1199 If a snippet is preceded by \"-\", the snippet must *not* match.
1200 \"+\" is syntactic sugar for positive selection.  Each snippet may
1201 be found as a full word or a partial word, but see the variable
1202 `org-agenda-search-view-force-full-words'.
1203
1204 When this is nil, search will look for the entire search phrase as one,
1205 with each space character matching any amount of whitespace, including
1206 line breaks.
1207
1208 Even when this is nil, you can still switch to Boolean search dynamically
1209 by preceding the first snippet with \"+\" or \"-\".  If the first snippet
1210 is a regexp marked with braces like \"{abc}\", this will also switch to
1211 boolean search."
1212   :group 'org-agenda-search-view
1213   :type 'boolean)
1214
1215 (if (fboundp 'defvaralias)
1216     (defvaralias 'org-agenda-search-view-search-words-only
1217       'org-agenda-search-view-always-boolean))
1218
1219 (defcustom org-agenda-search-view-force-full-words nil
1220   "Non-nil means, search words must be matches as complete words.
1221 When nil, they may also match part of a word."
1222   :group 'org-agenda-search-view
1223   :type 'boolean)
1224
1225 (defgroup org-agenda-time-grid nil
1226   "Options concerning the time grid in the Org-mode Agenda."
1227   :tag "Org Agenda Time Grid"
1228   :group 'org-agenda)
1229
1230 (defcustom org-agenda-search-headline-for-time t
1231   "Non-nil means search headline for a time-of-day.
1232 If the headline contains a time-of-day in one format or another, it will
1233 be used to sort the entry into the time sequence of items for a day.
1234 Some people have time stamps in the headline that refer to the creation
1235 time or so, and then this produces an unwanted side effect.  If this is
1236 the case for your, use this variable to turn off searching the headline
1237 for a time."
1238   :group 'org-agenda-time-grid
1239   :type 'boolean)
1240
1241 (defcustom org-agenda-use-time-grid t
1242   "Non-nil means show a time grid in the agenda schedule.
1243 A time grid is a set of lines for specific times (like every two hours between
1244 8:00 and 20:00).  The items scheduled for a day at specific times are
1245 sorted in between these lines.
1246 For details about when the grid will be shown, and what it will look like, see
1247 the variable `org-agenda-time-grid'."
1248   :group 'org-agenda-time-grid
1249   :type 'boolean)
1250
1251 (defcustom org-agenda-time-grid
1252   '((daily today require-timed)
1253     "----------------"
1254     (800 1000 1200 1400 1600 1800 2000))
1255
1256   "The settings for time grid for agenda display.
1257 This is a list of three items.  The first item is again a list.  It contains
1258 symbols specifying conditions when the grid should be displayed:
1259
1260  daily         if the agenda shows a single day
1261  weekly        if the agenda shows an entire week
1262  today         show grid on current date, independent of daily/weekly display
1263  require-timed show grid only if at least one item has a time specification
1264
1265 The second item is a string which will be placed behind the grid time.
1266
1267 The third item is a list of integers, indicating the times that should have
1268 a grid line."
1269   :group 'org-agenda-time-grid
1270   :type
1271   '(list
1272     (set :greedy t :tag "Grid Display Options"
1273          (const :tag "Show grid in single day agenda display" daily)
1274          (const :tag "Show grid in weekly agenda display" weekly)
1275          (const :tag "Always show grid for today" today)
1276          (const :tag "Show grid only if any timed entries are present"
1277                 require-timed)
1278          (const :tag "Skip grid times already present in an entry"
1279                 remove-match))
1280     (string :tag "Grid String")
1281     (repeat :tag "Grid Times" (integer :tag "Time"))))
1282
1283 (defcustom org-agenda-show-current-time-in-grid t
1284   "Non-nil means show the current time in the time grid."
1285   :group 'org-agenda-time-grid
1286   :type 'boolean)
1287
1288 (defcustom org-agenda-current-time-string
1289   "now - - - - - - - - - - - - - - - - - - - - - - - - -"
1290   "The string for the current time marker in the agenda."
1291   :group 'org-agenda-time-grid
1292   :type 'string)
1293
1294 (defgroup org-agenda-sorting nil
1295   "Options concerning sorting in the Org-mode Agenda."
1296   :tag "Org Agenda Sorting"
1297   :group 'org-agenda)
1298
1299 (defcustom org-agenda-sorting-strategy
1300   '((agenda habit-down time-up priority-down category-keep)
1301     (todo   priority-down category-keep)
1302     (tags   priority-down category-keep)
1303     (search category-keep))
1304   "Sorting structure for the agenda items of a single day.
1305 This is a list of symbols which will be used in sequence to determine
1306 if an entry should be listed before another entry.  The following
1307 symbols are recognized:
1308
1309 time-up            Put entries with time-of-day indications first, early first
1310 time-down          Put entries with time-of-day indications first, late first
1311 category-keep      Keep the default order of categories, corresponding to the
1312                    sequence in `org-agenda-files'.
1313 category-up        Sort alphabetically by category, A-Z.
1314 category-down      Sort alphabetically by category, Z-A.
1315 tag-up             Sort alphabetically by last tag, A-Z.
1316 tag-down           Sort alphabetically by last tag, Z-A.
1317 priority-up        Sort numerically by priority, high priority last.
1318 priority-down      Sort numerically by priority, high priority first.
1319 todo-state-up      Sort by todo state, tasks that are done last.
1320 todo-state-down    Sort by todo state, tasks that are done first.
1321 effort-up          Sort numerically by estimated effort, high effort last.
1322 effort-down        Sort numerically by estimated effort, high effort first.
1323 user-defined-up    Sort according to `org-agenda-cmp-user-defined', high last.
1324 user-defined-down  Sort according to `org-agenda-cmp-user-defined', high first.
1325 habit-up           Put entries that are habits first
1326 habit-down         Put entries that are habits last
1327 alpha-up           Sort headlines alphabetically
1328 alpha-down         Sort headlines alphabetically, reversed
1329
1330 The different possibilities will be tried in sequence, and testing stops
1331 if one comparison returns a \"not-equal\".  For example, the default
1332     '(time-up category-keep priority-down)
1333 means: Pull out all entries having a specified time of day and sort them,
1334 in order to make a time schedule for the current day the first thing in the
1335 agenda listing for the day.  Of the entries without a time indication, keep
1336 the grouped in categories, don't sort the categories, but keep them in
1337 the sequence given in `org-agenda-files'.  Within each category sort by
1338 priority.
1339
1340 Leaving out `category-keep' would mean that items will be sorted across
1341 categories by priority.
1342
1343 Instead of a single list, this can also be a set of list for specific
1344 contents, with a context symbol in the car of the list, any of
1345 `agenda', `todo', `tags', `search' for the corresponding agenda views.
1346
1347 Custom commands can bind this variable in the options section."
1348   :group 'org-agenda-sorting
1349   :type `(choice
1350           (repeat :tag "General" ,org-sorting-choice)
1351           (list :tag "Individually"
1352                 (cons (const :tag "Strategy for Weekly/Daily agenda" agenda)
1353                       (repeat ,org-sorting-choice))
1354                 (cons (const :tag "Strategy for TODO lists" todo)
1355                       (repeat ,org-sorting-choice))
1356                 (cons (const :tag "Strategy for Tags matches" tags)
1357                       (repeat ,org-sorting-choice))
1358                 (cons (const :tag "Strategy for search matches" search)
1359                       (repeat ,org-sorting-choice)))))
1360
1361 (defcustom org-agenda-cmp-user-defined nil
1362   "A function to define the comparison `user-defined'.
1363 This function must receive two arguments, agenda entry a and b.
1364 If a>b, return +1.  If a<b, return -1.  If they are equal as seen by
1365 the user comparison, return nil.
1366 When this is defined, you can make `user-defined-up' and `user-defined-down'
1367 part of an agenda sorting strategy."
1368   :group 'org-agenda-sorting
1369   :type 'symbol)
1370
1371 (defcustom org-sort-agenda-notime-is-late t
1372   "Non-nil means items without time are considered late.
1373 This is only relevant for sorting.  When t, items which have no explicit
1374 time like 15:30 will be considered as 99:01, i.e. later than any items which
1375 do have a time.  When nil, the default time is before 0:00.  You can use this
1376 option to decide if the schedule for today should come before or after timeless
1377 agenda entries."
1378   :group 'org-agenda-sorting
1379   :type 'boolean)
1380
1381 (defcustom org-sort-agenda-noeffort-is-high t
1382   "Non-nil means items without effort estimate are sorted as high effort.
1383 This also applies when filtering an agenda view with respect to the
1384 < or > effort operator.  Then, tasks with no effort defined will be treated
1385 as tasks with high effort.
1386 When nil, such items are sorted as 0 minutes effort."
1387   :group 'org-agenda-sorting
1388   :type 'boolean)
1389
1390 (defgroup org-agenda-line-format nil
1391   "Options concerning the entry prefix in the Org-mode agenda display."
1392   :tag "Org Agenda Line Format"
1393   :group 'org-agenda)
1394
1395 (defcustom org-agenda-prefix-format
1396   '((agenda  . " %i %-12:c%?-12t% s")
1397     (timeline  . "  % s")
1398     (todo  . " %i %-12:c")
1399     (tags  . " %i %-12:c")
1400     (search . " %i %-12:c"))
1401   "Format specifications for the prefix of items in the agenda views.
1402 An alist with five entries, each for the different agenda types.  The
1403 keys of the sublists are `agenda', `timeline', `todo', `search' and `tags'.
1404 The values are format strings.
1405
1406 This format works similar to a printf format, with the following meaning:
1407
1408   %c   the category of the item, \"Diary\" for entries from the diary,
1409        or as given by the CATEGORY keyword or derived from the file name
1410   %e   the effort required by the item
1411   %i   the icon category of the item, see `org-agenda-category-icon-alist'
1412   %T   the last tag of the item (ignore inherited tags, which come first)
1413   %t   the HH:MM time-of-day specification if one applies to the entry
1414   %s   Scheduling/Deadline information, a short string
1415   %(expression) Eval EXPRESSION and replace the control string
1416                 by the result
1417
1418 All specifiers work basically like the standard `%s' of printf, but may
1419 contain two additional characters:  a question mark just after the `%'
1420 and a whitespace/punctuation character just before the final letter.
1421
1422 If the first character after `%' is a question mark, the entire field
1423 will only be included if the corresponding value applies to the current
1424 entry.  This is useful for fields which should have fixed width when
1425 present, but zero width when absent.  For example, \"%?-12t\" will
1426 result in a 12 character time field if a time of the day is specified,
1427 but will completely disappear in entries which do not contain a time.
1428
1429 If there is punctuation or whitespace character just before the final
1430 format letter, this character will be appended to the field value if
1431 the value is not empty.  For example, the format \"%-12:c\" leads to
1432 \"Diary: \" if the category is \"Diary\".  If the category were be
1433 empty, no additional colon would be inserted.
1434
1435 The default value for the agenda sublist is \"  %-12:c%?-12t% s\",
1436 which means:
1437
1438 - Indent the line with two space characters
1439 - Give the category a 12 chars wide field, padded with whitespace on
1440   the right (because of `-').  Append a colon if there is a category
1441   (because of `:').
1442 - If there is a time-of-day, put it into a 12 chars wide field.  If no
1443   time, don't put in an empty field, just skip it (because of '?').
1444 - Finally, put the scheduling information.
1445
1446 See also the variables `org-agenda-remove-times-when-in-prefix' and
1447 `org-agenda-remove-tags'.
1448
1449 Custom commands can set this variable in the options section."
1450   :type '(choice
1451           (string :tag "General format")
1452           (list :greedy t :tag "View dependent"
1453                 (cons  (const agenda) (string :tag "Format"))
1454                 (cons  (const timeline) (string :tag "Format"))
1455                 (cons  (const todo) (string :tag "Format"))
1456                 (cons  (const tags) (string :tag "Format"))
1457                 (cons  (const search) (string :tag "Format"))))
1458   :group 'org-agenda-line-format)
1459
1460 (defvar org-prefix-format-compiled nil
1461   "The compiled version of the most recently used prefix format.
1462 See the variable `org-agenda-prefix-format'.")
1463
1464 (defcustom org-agenda-todo-keyword-format "%-1s"
1465   "Format for the TODO keyword in agenda lines.
1466 Set this to something like \"%-12s\" if you want all TODO keywords
1467 to occupy a fixed space in the agenda display."
1468   :group 'org-agenda-line-format
1469   :type 'string)
1470
1471 (defcustom org-agenda-timerange-leaders '("" "(%d/%d): ")
1472   "Text preceding timerange entries in the agenda view.
1473 This is a list with two strings.  The first applies when the range
1474 is entirely on one day.  The second applies if the range spans several days.
1475 The strings may have two \"%d\" format specifiers which will be filled
1476 with the sequence number of the days, and the total number of days in the
1477 range, respectively."
1478   :group 'org-agenda-line-format
1479   :type '(list
1480           (string :tag "Deadline today   ")
1481           (choice :tag "Deadline relative"
1482                   (string :tag "Format string")
1483                   (function))))
1484
1485 (defcustom org-agenda-scheduled-leaders '("Scheduled: " "Sched.%2dx: ")
1486   "Text preceding scheduled items in the agenda view.
1487 This is a list with two strings.  The first applies when the item is
1488 scheduled on the current day.  The second applies when it has been scheduled
1489 previously, it may contain a %d indicating that this is the nth time that
1490 this item is scheduled, due to automatic rescheduling of unfinished items
1491 for the following day.  So this number is one larger than the number of days
1492 that passed since this item was scheduled first."
1493   :group 'org-agenda-line-format
1494   :type '(list
1495           (string :tag "Scheduled today     ")
1496           (string :tag "Scheduled previously")))
1497
1498 (defcustom org-agenda-inactive-leader "["
1499   "Text preceding item pulled into the agenda by inactive time stamps.
1500 These entries are added to the agenda when pressing \"[\"."
1501   :group 'org-agenda-line-format
1502   :type '(list
1503           (string :tag "Scheduled today     ")
1504           (string :tag "Scheduled previously")))
1505
1506 (defcustom org-agenda-deadline-leaders '("Deadline:  " "In %3d d.: ")
1507   "Text preceding deadline items in the agenda view.
1508 This is a list with two strings.  The first applies when the item has its
1509 deadline on the current day.  The second applies when it is in the past or
1510 in the future, it may contain %d to capture how many days away the deadline
1511 is (was)."
1512   :group 'org-agenda-line-format
1513   :type '(list
1514           (string :tag "Deadline today   ")
1515           (choice :tag "Deadline relative"
1516                   (string :tag "Format string")
1517                   (function))))
1518
1519 (defcustom org-agenda-remove-times-when-in-prefix t
1520   "Non-nil means remove duplicate time specifications in agenda items.
1521 When the format `org-agenda-prefix-format' contains a `%t' specifier, a
1522 time-of-day specification in a headline or diary entry is extracted and
1523 placed into the prefix.  If this option is non-nil, the original specification
1524 \(a timestamp or -range, or just a plain time(range) specification like
1525 11:30-4pm) will be removed for agenda display.  This makes the agenda less
1526 cluttered.
1527 The option can be t or nil.  It may also be the symbol `beg', indicating
1528 that the time should only be removed when it is located at the beginning of
1529 the headline/diary entry."
1530   :group 'org-agenda-line-format
1531   :type '(choice
1532           (const :tag "Always" t)
1533           (const :tag "Never" nil)
1534           (const :tag "When at beginning of entry" beg)))
1535
1536 (defcustom org-agenda-remove-timeranges-from-blocks nil
1537   "Non-nil means remove time ranges specifications in agenda
1538 items that span on several days."
1539   :group 'org-agenda-line-format
1540   :type 'boolean)
1541
1542 (defcustom org-agenda-default-appointment-duration nil
1543   "Default duration for appointments that only have a starting time.
1544 When nil, no duration is specified in such cases.
1545 When non-nil, this must be the number of minutes, e.g. 60 for one hour."
1546   :group 'org-agenda-line-format
1547   :type '(choice
1548           (integer :tag "Minutes")
1549           (const :tag "No default duration")))
1550
1551 (defcustom org-agenda-show-inherited-tags t
1552   "Non-nil means show inherited tags in each agenda line."
1553   :group 'org-agenda-line-format
1554   :type 'boolean)
1555
1556 (defcustom org-agenda-hide-tags-regexp nil
1557   "Regular expression used to filter away specific tags in agenda views.
1558 This means that these tags will be present, but not be shown in the agenda
1559 line.  Secondary filtering will still work on the hidden tags.
1560 Nil means don't hide any tags."
1561   :group 'org-agenda-line-format
1562   :type '(choice
1563           (const  :tag "Hide none" nil)
1564           (string :tag "Regexp   ")))
1565
1566 (defcustom org-agenda-remove-tags nil
1567   "Non-nil means remove the tags from the headline copy in the agenda.
1568 When this is the symbol `prefix', only remove tags when
1569 `org-agenda-prefix-format' contains a `%T' specifier."
1570   :group 'org-agenda-line-format
1571   :type '(choice
1572           (const :tag "Always" t)
1573           (const :tag "Never" nil)
1574           (const :tag "When prefix format contains %T" prefix)))
1575
1576 (if (fboundp 'defvaralias)
1577     (defvaralias 'org-agenda-remove-tags-when-in-prefix
1578       'org-agenda-remove-tags))
1579
1580 (defcustom org-agenda-tags-column (if (featurep 'xemacs) -79 -80)
1581   "Shift tags in agenda items to this column.
1582 If this number is positive, it specifies the column.  If it is negative,
1583 it means that the tags should be flushright to that column.  For example,
1584 -80 works well for a normal 80 character screen."
1585   :group 'org-agenda-line-format
1586   :type 'integer)
1587
1588 (if (fboundp 'defvaralias)
1589     (defvaralias 'org-agenda-align-tags-to-column 'org-agenda-tags-column))
1590
1591 (defcustom org-agenda-fontify-priorities 'cookies
1592   "Non-nil means highlight low and high priorities in agenda.
1593 When t, the highest priority entries are bold, lowest priority italic.
1594 However, settings in `org-priority-faces' will overrule these faces.
1595 When this variable is the symbol `cookies', only fontify the
1596 cookies, not the entire task.
1597 This may also be an association list of priority faces, whose
1598 keys are the character values of `org-highest-priority',
1599 `org-default-priority', and `org-lowest-priority' (the default values
1600 are ?A, ?B, and ?C, respectively).  The face may be a named face, a
1601 color as a string, or a list like `(:background \"Red\")'.
1602 If it is a color, the variable `org-faces-easy-properties'
1603 determines if it is a foreground or a background color."
1604   :group 'org-agenda-line-format
1605   :type '(choice
1606           (const :tag "Never" nil)
1607           (const :tag "Defaults" t)
1608           (const :tag "Cookies only" cookies)
1609           (repeat :tag "Specify"
1610                   (list (character :tag "Priority" :value ?A)
1611                         (choice    :tag "Face    "
1612                                    (string :tag "Color")
1613                                    (sexp :tag "Face"))))))
1614
1615 (defcustom org-agenda-day-face-function nil
1616   "Function called to determine what face should be used to display a day.
1617 The only argument passed to that function is the day. It should
1618 returns a face, or nil if does not want to specify a face and let
1619 the normal rules apply."
1620   :group 'org-agenda-line-format
1621   :type 'function)
1622
1623 (defcustom org-agenda-category-icon-alist nil
1624   "Alist of category icon to be displayed in agenda views.
1625
1626 Each entry should have the following format:
1627
1628   (CATEGORY-REGEXP FILE-OR-DATA TYPE DATA-P PROPS)
1629
1630 Where CATEGORY-REGEXP is a regexp matching the categories where
1631 the icon should be displayed.
1632 FILE-OR-DATA either a file path or a string containing image data.
1633
1634 The other fields can be omited safely if not needed:
1635 TYPE indicates the image type.
1636 DATA-P is a boolean indicating whether the FILE-OR-DATA string is
1637 image data.
1638 PROPS are additional image attributes to assign to the image,
1639 like, e.g. `:ascent center'.
1640
1641    (\"Org\" \"/path/to/icon.png\" nil nil :ascent center)
1642
1643 If you want to set the display properties yourself, just put a
1644 list as second element:
1645
1646   (CATEGORY-REGEXP (MY PROPERTY LIST))
1647
1648 For example, to display a 16px horizontal space for Emacs
1649 category, you can use:
1650
1651   (\"Emacs\" '(space . (:width (16))))"
1652   :group 'org-agenda-line-format
1653   :type '(alist :key-type (string :tag "Regexp matching category")
1654                 :value-type (choice (list :tag "Icon"
1655                                           (string :tag "File or data")
1656                                           (symbol :tag "Type")
1657                                           (boolean :tag "Data?")
1658                                           (repeat :tag "Extra image properties" :inline t symbol))
1659                                     (list :tag "Display properties" sexp))))
1660
1661 (defgroup org-agenda-column-view nil
1662   "Options concerning column view in the agenda."
1663   :tag "Org Agenda Column View"
1664   :group 'org-agenda)
1665
1666 (defcustom org-agenda-columns-show-summaries t
1667   "Non-nil means show summaries for columns displayed in the agenda view."
1668   :group 'org-agenda-column-view
1669   :type 'boolean)
1670
1671 (defcustom org-agenda-columns-compute-summary-properties t
1672   "Non-nil means recompute all summary properties before column view.
1673 When column view in the agenda is listing properties that have a summary
1674 operator, it can go to all relevant buffers and recompute the summaries
1675 there.  This can mean overhead for the agenda column view, but is necessary
1676 to have thing up to date.
1677 As a special case, a CLOCKSUM property also makes sure that the clock
1678 computations are current."
1679   :group 'org-agenda-column-view
1680   :type 'boolean)
1681
1682 (defcustom org-agenda-columns-add-appointments-to-effort-sum nil
1683   "Non-nil means the duration of an appointment will add to day effort.
1684 The property to which appointment durations will be added is the one given
1685 in the option `org-effort-property'.  If an appointment does not have
1686 an end time, `org-agenda-default-appointment-duration' will be used.  If that
1687 is not set, an appointment without end time will not contribute to the time
1688 estimate."
1689   :group 'org-agenda-column-view
1690   :type 'boolean)
1691
1692 (defcustom org-agenda-auto-exclude-function nil
1693   "A function called with a tag to decide if it is filtered on '/ RET'.
1694 The sole argument to the function, which is called once for each
1695 possible tag, is a string giving the name of the tag.  The
1696 function should return either nil if the tag should be included
1697 as normal, or \"-<TAG>\" to exclude the tag.
1698 Note that for the purpose of tag filtering, only the lower-case version of
1699 all tags will be considered, so that this function will only ever see
1700 the lower-case version of all tags."
1701   :group 'org-agenda
1702   :type 'function)
1703
1704 (defcustom org-agenda-bulk-custom-functions nil
1705   "Alist of characters and custom functions for bulk actions.
1706 For example, this value makes those two functions available:
1707
1708   '((?R set-category)
1709     (?C bulk-cut))
1710
1711 With selected entries in an agenda buffer, `B R' will call
1712 the custom function `set-category' on the selected entries.
1713 Note that functions in this alist don't need to be quoted."
1714   :type 'alist
1715   :group 'org-agenda)
1716
1717 (eval-when-compile
1718   (require 'cl))
1719 (require 'org)
1720
1721 (defmacro org-agenda-with-point-at-orig-entry (string &rest body)
1722   "Execute BODY with point at location given by `org-hd-marker' property.
1723 If STRING is non-nil, the text property will be fetched from position 0
1724 in that string.  If STRING is nil, it will be fetched from the beginning
1725 of the current line."
1726   (org-with-gensyms (marker)
1727     `(let ((,marker (get-text-property (if string 0 (point-at-bol))
1728                                        'org-hd-marker string)))
1729        (with-current-buffer (marker-buffer ,marker)
1730          (save-excursion
1731            (goto-char ,marker)
1732            ,@body)))))
1733 (def-edebug-spec org-agenda-with-point-at-orig-entry (form body))
1734
1735 (defun org-add-agenda-custom-command (entry)
1736   "Replace or add a command in `org-agenda-custom-commands'.
1737 This is mostly for hacking and trying a new command - once the command
1738 works you probably want to add it to `org-agenda-custom-commands' for good."
1739   (let ((ass (assoc (car entry) org-agenda-custom-commands)))
1740     (if ass
1741         (setcdr ass (cdr entry))
1742       (push entry org-agenda-custom-commands))))
1743
1744 ;;; Define the Org-agenda-mode
1745
1746 (defvar org-agenda-mode-map (make-sparse-keymap)
1747   "Keymap for `org-agenda-mode'.")
1748 (if (fboundp 'defvaralias)
1749     (defvaralias 'org-agenda-keymap 'org-agenda-mode-map))
1750
1751 (defvar org-agenda-menu) ; defined later in this file.
1752 (defvar org-agenda-restrict) ; defined later in this file.
1753 (defvar org-agenda-follow-mode nil)
1754 (defvar org-agenda-entry-text-mode nil)
1755 (defvar org-agenda-clockreport-mode nil)
1756 (defvar org-agenda-show-log nil)
1757 (defvar org-agenda-redo-command nil)
1758 (defvar org-agenda-query-string nil)
1759 (defvar org-agenda-mode-hook nil
1760   "Hook for `org-agenda-mode', run after the mode is turned on.")
1761 (defvar org-agenda-type nil)
1762 (defvar org-agenda-force-single-file nil)
1763 (defvar org-agenda-bulk-marked-entries) ;; Defined further down in this file
1764
1765 (defun org-agenda-mode ()
1766   "Mode for time-sorted view on action items in Org-mode files.
1767
1768 The following commands are available:
1769
1770 \\{org-agenda-mode-map}"
1771   (interactive)
1772   (kill-all-local-variables)
1773   (setq org-agenda-undo-list nil
1774         org-agenda-pending-undo-list nil
1775         org-agenda-bulk-marked-entries nil)
1776   (setq major-mode 'org-agenda-mode)
1777   ;; Keep global-font-lock-mode from turning on font-lock-mode
1778   (org-set-local 'font-lock-global-modes (list 'not major-mode))
1779   (setq mode-name "Org-Agenda")
1780   (use-local-map org-agenda-mode-map)
1781   (easy-menu-add org-agenda-menu)
1782   (if org-startup-truncated (setq truncate-lines t))
1783   (org-set-local 'line-move-visual nil)
1784   (org-add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
1785   (org-add-hook 'pre-command-hook 'org-unhighlight nil 'local)
1786   ;; Make sure properties are removed when copying text
1787   (when (boundp 'buffer-substring-filters)
1788     (org-set-local 'buffer-substring-filters
1789                    (cons (lambda (x)
1790                            (set-text-properties 0 (length x) nil x) x)
1791                          buffer-substring-filters)))
1792   (unless org-agenda-keep-modes
1793     (setq org-agenda-follow-mode org-agenda-start-with-follow-mode
1794           org-agenda-entry-text-mode org-agenda-start-with-entry-text-mode
1795           org-agenda-clockreport-mode org-agenda-start-with-clockreport-mode
1796           org-agenda-show-log org-agenda-start-with-log-mode))
1797
1798   (easy-menu-change
1799    '("Agenda") "Agenda Files"
1800    (append
1801     (list
1802      (vector
1803       (if (get 'org-agenda-files 'org-restrict)
1804           "Restricted to single file"
1805         "Edit File List")
1806       '(org-edit-agenda-file-list)
1807       (not (get 'org-agenda-files 'org-restrict)))
1808      "--")
1809     (mapcar 'org-file-menu-entry (org-agenda-files))))
1810   (org-agenda-set-mode-name)
1811   (apply
1812    (if (fboundp 'run-mode-hooks) 'run-mode-hooks 'run-hooks)
1813    (list 'org-agenda-mode-hook)))
1814
1815 (substitute-key-definition 'undo 'org-agenda-undo
1816                            org-agenda-mode-map global-map)
1817 (org-defkey org-agenda-mode-map "\C-i"     'org-agenda-goto)
1818 (org-defkey org-agenda-mode-map [(tab)]    'org-agenda-goto)
1819 (org-defkey org-agenda-mode-map "\C-m"     'org-agenda-switch-to)
1820 (org-defkey org-agenda-mode-map "\C-k"     'org-agenda-kill)
1821 (org-defkey org-agenda-mode-map "\C-c\C-w" 'org-agenda-refile)
1822 (org-defkey org-agenda-mode-map "m"        'org-agenda-bulk-mark)
1823 (org-defkey org-agenda-mode-map "%"        'org-agenda-bulk-mark-regexp)
1824 (org-defkey org-agenda-mode-map "u"        'org-agenda-bulk-unmark)
1825 (org-defkey org-agenda-mode-map "U"        'org-agenda-bulk-remove-all-marks)
1826 (org-defkey org-agenda-mode-map "A"        'org-agenda-append-agenda)
1827 (org-defkey org-agenda-mode-map "B"        'org-agenda-bulk-action)
1828 (org-defkey org-agenda-mode-map "\C-c\C-x!" 'org-reload)
1829 (org-defkey org-agenda-mode-map "\C-c\C-x\C-a" 'org-agenda-archive-default)
1830 (org-defkey org-agenda-mode-map "\C-c\C-xa"    'org-agenda-toggle-archive-tag)
1831 (org-defkey org-agenda-mode-map "\C-c\C-xA"    'org-agenda-archive-to-archive-sibling)
1832 (org-defkey org-agenda-mode-map "\C-c\C-x\C-s" 'org-agenda-archive)
1833 (org-defkey org-agenda-mode-map "\C-c$"        'org-agenda-archive)
1834 (org-defkey org-agenda-mode-map "$"        'org-agenda-archive)
1835 (org-defkey org-agenda-mode-map "\C-c\C-o" 'org-agenda-open-link)
1836 (org-defkey org-agenda-mode-map " "        'org-agenda-show-and-scroll-up)
1837 (org-defkey org-agenda-mode-map [backspace] 'org-agenda-show-scroll-down)
1838 (org-defkey org-agenda-mode-map "\d" 'org-agenda-show-scroll-down)
1839 (org-defkey org-agenda-mode-map [(control shift right)] 'org-agenda-todo-nextset)
1840 (org-defkey org-agenda-mode-map [(control shift left)]  'org-agenda-todo-previousset)
1841 (org-defkey org-agenda-mode-map "\C-c\C-xb" 'org-agenda-tree-to-indirect-buffer)
1842 (org-defkey org-agenda-mode-map "o"        'delete-other-windows)
1843 (org-defkey org-agenda-mode-map "L"        'org-agenda-recenter)
1844 (org-defkey org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
1845 (org-defkey org-agenda-mode-map "t"        'org-agenda-todo)
1846 (org-defkey org-agenda-mode-map "a"        'org-agenda-archive-default-with-confirmation)
1847 (org-defkey org-agenda-mode-map ":"        'org-agenda-set-tags)
1848 (org-defkey org-agenda-mode-map "\C-c\C-q" 'org-agenda-set-tags)
1849 (org-defkey org-agenda-mode-map "."        'org-agenda-goto-today)
1850 (org-defkey org-agenda-mode-map "j"        'org-agenda-goto-date)
1851 (org-defkey org-agenda-mode-map "d"        'org-agenda-day-view)
1852 (org-defkey org-agenda-mode-map "w"        'org-agenda-week-view)
1853 (org-defkey org-agenda-mode-map "y"        'org-agenda-year-view)
1854 (org-defkey org-agenda-mode-map "\C-c\C-z" 'org-agenda-add-note)
1855 (org-defkey org-agenda-mode-map "z"        'org-agenda-add-note)
1856 (org-defkey org-agenda-mode-map "k"        'org-agenda-action)
1857 (org-defkey org-agenda-mode-map "\C-c\C-x\C-k" 'org-agenda-action)
1858 (org-defkey org-agenda-mode-map [(shift right)] 'org-agenda-do-date-later)
1859 (org-defkey org-agenda-mode-map [(shift left)] 'org-agenda-do-date-earlier)
1860 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (right)] 'org-agenda-do-date-later)
1861 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (left)] 'org-agenda-do-date-earlier)
1862
1863 (org-defkey org-agenda-mode-map ">" 'org-agenda-date-prompt)
1864 (org-defkey org-agenda-mode-map "\C-c\C-s" 'org-agenda-schedule)
1865 (org-defkey org-agenda-mode-map "\C-c\C-d" 'org-agenda-deadline)
1866 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1867   (while l (org-defkey org-agenda-mode-map
1868              (int-to-string (pop l)) 'digit-argument)))
1869
1870 (org-defkey org-agenda-mode-map "F" 'org-agenda-follow-mode)
1871 (org-defkey org-agenda-mode-map "R" 'org-agenda-clockreport-mode)
1872 (org-defkey org-agenda-mode-map "E" 'org-agenda-entry-text-mode)
1873 (org-defkey org-agenda-mode-map "l" 'org-agenda-log-mode)
1874 (org-defkey org-agenda-mode-map "v" 'org-agenda-view-mode-dispatch)
1875 (org-defkey org-agenda-mode-map "D" 'org-agenda-toggle-diary)
1876 (org-defkey org-agenda-mode-map "!" 'org-agenda-toggle-deadlines)
1877 (org-defkey org-agenda-mode-map "G" 'org-agenda-toggle-time-grid)
1878 (org-defkey org-agenda-mode-map "r" 'org-agenda-redo)
1879 (org-defkey org-agenda-mode-map "g" 'org-agenda-redo)
1880 (org-defkey org-agenda-mode-map "e" 'org-agenda-set-effort)
1881 (org-defkey org-agenda-mode-map "\C-c\C-xe" 'org-agenda-set-effort)
1882 (org-defkey org-agenda-mode-map "\C-c\C-x\C-e"
1883             'org-clock-modify-effort-estimate)
1884 (org-defkey org-agenda-mode-map "\C-c\C-xp" 'org-agenda-set-property)
1885 (org-defkey org-agenda-mode-map "q" 'org-agenda-quit)
1886 (org-defkey org-agenda-mode-map "x" 'org-agenda-exit)
1887 (org-defkey org-agenda-mode-map "\C-x\C-w" 'org-write-agenda)
1888 (org-defkey org-agenda-mode-map "\C-x\C-s" 'org-save-all-org-buffers)
1889 (org-defkey org-agenda-mode-map "s" 'org-save-all-org-buffers)
1890 (org-defkey org-agenda-mode-map "P" 'org-agenda-show-priority)
1891 (org-defkey org-agenda-mode-map "T" 'org-agenda-show-tags)
1892 (org-defkey org-agenda-mode-map "n" 'org-agenda-next-line)
1893 (org-defkey org-agenda-mode-map "p" 'org-agenda-previous-line)
1894 (substitute-key-definition 'next-line 'org-agenda-next-line
1895                            org-agenda-mode-map global-map)
1896 (substitute-key-definition 'previous-line 'org-agenda-previous-line
1897                            org-agenda-mode-map global-map)
1898 (org-defkey org-agenda-mode-map "\C-c\C-a" 'org-attach)
1899 (org-defkey org-agenda-mode-map "\C-c\C-n" 'org-agenda-next-date-line)
1900 (org-defkey org-agenda-mode-map "\C-c\C-p" 'org-agenda-previous-date-line)
1901 (org-defkey org-agenda-mode-map "," 'org-agenda-priority)
1902 (org-defkey org-agenda-mode-map "\C-c," 'org-agenda-priority)
1903 (org-defkey org-agenda-mode-map "i" 'org-agenda-diary-entry)
1904 (org-defkey org-agenda-mode-map "c" 'org-agenda-goto-calendar)
1905 (org-defkey org-agenda-mode-map "C" 'org-agenda-convert-date)
1906 (org-defkey org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
1907 (org-defkey org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
1908 (org-defkey org-agenda-mode-map "h" 'org-agenda-holidays)
1909 (org-defkey org-agenda-mode-map "H" 'org-agenda-holidays)
1910 (org-defkey org-agenda-mode-map "\C-c\C-x\C-i" 'org-agenda-clock-in)
1911 (org-defkey org-agenda-mode-map "I" 'org-agenda-clock-in)
1912 (org-defkey org-agenda-mode-map "\C-c\C-x\C-o" 'org-agenda-clock-out)
1913 (org-defkey org-agenda-mode-map "O" 'org-agenda-clock-out)
1914 (org-defkey org-agenda-mode-map "\C-c\C-x\C-x" 'org-agenda-clock-cancel)
1915 (org-defkey org-agenda-mode-map "X" 'org-agenda-clock-cancel)
1916 (org-defkey org-agenda-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
1917 (org-defkey org-agenda-mode-map "J" 'org-agenda-clock-goto)
1918 (org-defkey org-agenda-mode-map "+" 'org-agenda-priority-up)
1919 (org-defkey org-agenda-mode-map "-" 'org-agenda-priority-down)
1920 (org-defkey org-agenda-mode-map [(shift up)] 'org-agenda-priority-up)
1921 (org-defkey org-agenda-mode-map [(shift down)] 'org-agenda-priority-down)
1922 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (up)] 'org-agenda-priority-up)
1923 (org-defkey org-agenda-mode-map [?\C-c ?\C-x (down)] 'org-agenda-priority-down)
1924 (org-defkey org-agenda-mode-map "f" 'org-agenda-later)
1925 (org-defkey org-agenda-mode-map "b" 'org-agenda-earlier)
1926 (org-defkey org-agenda-mode-map "\C-c\C-x\C-c" 'org-agenda-columns)
1927 (org-defkey org-agenda-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
1928
1929 (org-defkey org-agenda-mode-map "[" 'org-agenda-manipulate-query-add)
1930 (org-defkey org-agenda-mode-map "]" 'org-agenda-manipulate-query-subtract)
1931 (org-defkey org-agenda-mode-map "{" 'org-agenda-manipulate-query-add-re)
1932 (org-defkey org-agenda-mode-map "}" 'org-agenda-manipulate-query-subtract-re)
1933 (org-defkey org-agenda-mode-map "/" 'org-agenda-filter-by-tag)
1934 (org-defkey org-agenda-mode-map "\\" 'org-agenda-filter-by-tag-refine)
1935 (org-defkey org-agenda-mode-map ";" 'org-timer-set-timer)
1936 (define-key org-agenda-mode-map "?" 'org-agenda-show-the-flagging-note)
1937 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mg"    'org-mobile-pull)
1938 (org-defkey org-agenda-mode-map "\C-c\C-x\C-mp"    'org-mobile-push)
1939
1940 (org-defkey org-agenda-mode-map [mouse-2] 'org-agenda-goto-mouse)
1941 (org-defkey org-agenda-mode-map [mouse-3] 'org-agenda-show-mouse)
1942 (when org-agenda-mouse-1-follows-link
1943   (org-defkey org-agenda-mode-map [follow-link] 'mouse-face))
1944 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
1945   '("Agenda"
1946     ("Agenda Files")
1947     "--"
1948     ("Agenda Dates"
1949      ["Goto Today" org-agenda-goto-today (org-agenda-check-type nil 'agenda 'timeline)]
1950      ["Next Dates" org-agenda-later (org-agenda-check-type nil 'agenda)]
1951      ["Previous Dates" org-agenda-earlier (org-agenda-check-type nil 'agenda)]
1952      ["Jump to date" org-agenda-goto-date (org-agenda-check-type nil 'agenda)])
1953     "--"
1954     ("View"
1955      ["Day View" org-agenda-day-view
1956       :active (org-agenda-check-type nil 'agenda)
1957       :style radio :selected (eq org-agenda-current-span 'day)
1958       :keys "v d  (or just d)"]
1959      ["Week View" org-agenda-week-view
1960       :active (org-agenda-check-type nil 'agenda)
1961       :style radio :selected (eq org-agenda-current-span 'week)
1962       :keys "v w  (or just w)"]
1963      ["Month View" org-agenda-month-view
1964       :active (org-agenda-check-type nil 'agenda)
1965       :style radio :selected (eq org-agenda-current-span 'month)
1966       :keys "v m"]
1967      ["Year View" org-agenda-year-view
1968       :active (org-agenda-check-type nil 'agenda)
1969       :style radio :selected (eq org-agenda-current-span 'year)
1970       :keys "v y"]
1971      "--"
1972      ["Include Diary" org-agenda-toggle-diary
1973       :style toggle :selected org-agenda-include-diary
1974       :active (org-agenda-check-type nil 'agenda)]
1975      ["Include Deadlines" org-agenda-toggle-deadlines
1976       :style toggle :selected org-agenda-include-deadlines
1977       :active (org-agenda-check-type nil 'agenda)]
1978      ["Use Time Grid" org-agenda-toggle-time-grid
1979       :style toggle :selected org-agenda-use-time-grid
1980       :active (org-agenda-check-type nil 'agenda)]
1981      "--"
1982      ["Show clock report" org-agenda-clockreport-mode
1983       :style toggle :selected org-agenda-clockreport-mode
1984       :active (org-agenda-check-type nil 'agenda)]
1985      ["Show some entry text" org-agenda-entry-text-mode
1986       :style toggle :selected org-agenda-entry-text-mode
1987       :active t]
1988     "--"
1989      ["Show Logbook entries" org-agenda-log-mode
1990       :style toggle :selected org-agenda-show-log
1991       :active (org-agenda-check-type nil 'agenda 'timeline)
1992       :keys "v l (or just l)"]
1993      ["Include archived trees" org-agenda-archives-mode
1994       :style toggle :selected org-agenda-archives-mode :active t
1995       :keys "v a"]
1996      ["Include archive files" (org-agenda-archives-mode t)
1997       :style toggle :selected (eq org-agenda-archives-mode t) :active t
1998       :keys "v A"]
1999      "--"
2000      ["Remove Restriction" org-agenda-remove-restriction-lock org-agenda-restrict])
2001     ["Write view to file" org-write-agenda t]
2002     ["Rebuild buffer" org-agenda-redo t]
2003     ["Save all Org-mode Buffers" org-save-all-org-buffers t]
2004     "--"
2005     ["Show original entry" org-agenda-show t]
2006     ["Go To (other window)" org-agenda-goto t]
2007     ["Go To (this window)" org-agenda-switch-to t]
2008     ["Follow Mode" org-agenda-follow-mode
2009      :style toggle :selected org-agenda-follow-mode :active t]
2010 ;    ["Tree to indirect frame" org-agenda-tree-to-indirect-buffer t]
2011     "--"
2012     ("TODO"
2013      ["Cycle TODO" org-agenda-todo t]
2014      ["Next TODO set" org-agenda-todo-nextset t]
2015      ["Previous TODO set" org-agenda-todo-previousset t]
2016      ["Add note" org-agenda-add-note t])
2017     ("Archive/Refile/Delete"
2018      ["Archive default" org-agenda-archive-default t]
2019      ["Archive default" org-agenda-archive-default-with-confirmation t]
2020      ["Toggle ARCHIVE tag" org-agenda-toggle-archive-tag t]
2021      ["Move to archive sibling" org-agenda-archive-to-archive-sibling t]
2022      ["Archive subtree" org-agenda-archive t]
2023      "--"
2024      ["Refile" org-agenda-refile t]
2025      "--"
2026      ["Delete subtree" org-agenda-kill t])
2027     ("Bulk action"
2028      ["Mark entry" org-agenda-bulk-mark t]
2029      ["Mark matching regexp" org-agenda-bulk-mark-regexp t]
2030      ["Unmark entry" org-agenda-bulk-unmark t]
2031      ["Unmark all entries" org-agenda-bulk-remove-all-marks :active t :keys "C-u s"])
2032      ["Act on all marked" org-agenda-bulk-action t]
2033     "--"
2034     ("Tags and Properties"
2035      ["Show all Tags" org-agenda-show-tags t]
2036      ["Set Tags current line" org-agenda-set-tags (not (org-region-active-p))]
2037      ["Change tag in region" org-agenda-set-tags (org-region-active-p)]
2038      "--"
2039      ["Column View" org-columns t])
2040     ("Deadline/Schedule"
2041      ["Schedule" org-agenda-schedule t]
2042      ["Set Deadline" org-agenda-deadline t]
2043      "--"
2044      ["Mark item" org-agenda-action :active t :keys "k m"]
2045      ["Show mark item" org-agenda-action :active t :keys "k v"]
2046      ["Schedule marked item" org-agenda-action :active t :keys "k s"]
2047      ["Set Deadline for marked item" org-agenda-action :active t :keys "k d"]
2048      "--"
2049      ["Change Date +1 day" org-agenda-date-later (org-agenda-check-type nil 'agenda 'timeline)]
2050      ["Change Date -1 day" org-agenda-date-earlier (org-agenda-check-type nil 'agenda 'timeline)]
2051      ["Change Time +1 hour" org-agenda-do-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-right"]
2052      ["Change Time -1 hour" org-agenda-do-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u S-left"]
2053      ["Change Time +  min" org-agenda-date-later :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-right"]
2054      ["Change Time -  min" org-agenda-date-earlier :active (org-agenda-check-type nil 'agenda 'timeline) :keys "C-u C-u S-left"]
2055      ["Change Date to ..." org-agenda-date-prompt (org-agenda-check-type nil 'agenda 'timeline)])
2056     ("Clock and Effort"
2057      ["Clock in" org-agenda-clock-in t]
2058      ["Clock out" org-agenda-clock-out t]
2059      ["Clock cancel" org-agenda-clock-cancel t]
2060      ["Goto running clock" org-clock-goto t]
2061      "--"
2062      ["Set Effort" org-agenda-set-effort t]
2063      ["Change clocked effort" org-clock-modify-effort-estimate
2064       (org-clock-is-active)])
2065     ("Priority"
2066      ["Set Priority" org-agenda-priority t]
2067      ["Increase Priority" org-agenda-priority-up t]
2068      ["Decrease Priority" org-agenda-priority-down t]
2069      ["Show Priority" org-agenda-show-priority t])
2070     ("Calendar/Diary"
2071      ["New Diary Entry" org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline)]
2072      ["Goto Calendar" org-agenda-goto-calendar (org-agenda-check-type nil 'agenda 'timeline)]
2073      ["Phases of the Moon" org-agenda-phases-of-moon (org-agenda-check-type nil 'agenda 'timeline)]
2074      ["Sunrise/Sunset" org-agenda-sunrise-sunset (org-agenda-check-type nil 'agenda 'timeline)]
2075      ["Holidays" org-agenda-holidays (org-agenda-check-type nil 'agenda 'timeline)]
2076      ["Convert" org-agenda-convert-date (org-agenda-check-type nil 'agenda 'timeline)]
2077      "--"
2078      ["Create iCalendar File" org-export-icalendar-combine-agenda-files t])
2079     "--"
2080     ["Undo Remote Editing" org-agenda-undo org-agenda-undo-list]
2081     "--"
2082     ("MobileOrg"
2083      ["Push Files and Views" org-mobile-push t]
2084      ["Get Captured and Flagged" org-mobile-pull t]
2085      ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
2086      ["Show note / unflag" org-agenda-show-the-flagging-note t]
2087      "--"
2088      ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
2089     "--"
2090     ["Quit" org-agenda-quit t]
2091     ["Exit and Release Buffers" org-agenda-exit t]
2092     ))
2093
2094 ;;; Agenda undo
2095
2096 (defvar org-agenda-allow-remote-undo t
2097   "Non-nil means allow remote undo from the agenda buffer.")
2098 (defvar org-agenda-undo-list nil
2099   "List of undoable operations in the agenda since last refresh.")
2100 (defvar org-agenda-undo-has-started-in nil
2101   "Buffers that have already seen `undo-start' in the current undo sequence.")
2102 (defvar org-agenda-pending-undo-list nil
2103   "In a series of undo commands, this is the list of remaining undo items.")
2104
2105 (defun org-agenda-undo ()
2106   "Undo a remote editing step in the agenda.
2107 This undoes changes both in the agenda buffer and in the remote buffer
2108 that have been changed along."
2109   (interactive)
2110   (or org-agenda-allow-remote-undo
2111       (error "Check the variable `org-agenda-allow-remote-undo' to activate remote undo"))
2112   (if (not (eq this-command last-command))
2113       (setq org-agenda-undo-has-started-in nil
2114             org-agenda-pending-undo-list org-agenda-undo-list))
2115   (if (not org-agenda-pending-undo-list)
2116       (error "No further undo information"))
2117   (let* ((entry (pop org-agenda-pending-undo-list))
2118          buf line cmd rembuf)
2119     (setq cmd (pop entry) line (pop entry))
2120     (setq rembuf (nth 2 entry))
2121     (org-with-remote-undo rembuf
2122       (while (bufferp (setq buf (pop entry)))
2123         (if (pop entry)
2124             (with-current-buffer buf
2125               (let ((last-undo-buffer buf)
2126                     (inhibit-read-only t))
2127                 (unless (memq buf org-agenda-undo-has-started-in)
2128                   (push buf org-agenda-undo-has-started-in)
2129                   (make-local-variable 'pending-undo-list)
2130                   (undo-start))
2131                 (while (and pending-undo-list
2132                             (listp pending-undo-list)
2133                             (not (car pending-undo-list)))
2134                   (pop pending-undo-list))
2135                 (undo-more 1))))))
2136     (org-goto-line line)
2137     (message "`%s' undone (buffer %s)" cmd (buffer-name rembuf))))
2138
2139 (defun org-verify-change-for-undo (l1 l2)
2140   "Verify that a real change occurred between the undo lists L1 and L2."
2141   (while (and l1 (listp l1) (null (car l1))) (pop l1))
2142   (while (and l2 (listp l2) (null (car l2))) (pop l2))
2143   (not (eq l1 l2)))
2144
2145 ;;; Agenda dispatch
2146
2147 (defvar org-agenda-restrict nil)
2148 (defvar org-agenda-restrict-begin (make-marker))
2149 (defvar org-agenda-restrict-end (make-marker))
2150 (defvar org-agenda-last-dispatch-buffer nil)
2151 (defvar org-agenda-overriding-restriction nil)
2152
2153 ;;;###autoload
2154 (defun org-agenda (&optional arg keys restriction)
2155   "Dispatch agenda commands to collect entries to the agenda buffer.
2156 Prompts for a command to execute.  Any prefix arg will be passed
2157 on to the selected command.  The default selections are:
2158
2159 a     Call `org-agenda-list' to display the agenda for current day or week.
2160 t     Call `org-todo-list' to display the global todo list.
2161 T     Call `org-todo-list' to display the global todo list, select only
2162       entries with a specific TODO keyword (the user gets a prompt).
2163 m     Call `org-tags-view' to display headlines with tags matching
2164       a condition  (the user is prompted for the condition).
2165 M     Like `m', but select only TODO entries, no ordinary headlines.
2166 L     Create a timeline for the current buffer.
2167 e     Export views to associated files.
2168 s     Search entries for keywords.
2169 /     Multi occur across all agenda files and also files listed
2170       in `org-agenda-text-search-extra-files'.
2171 <     Restrict agenda commands to buffer, subtree, or region.
2172       Press several times to get the desired effect.
2173 >     Remove a previous restriction.
2174 #     List \"stuck\" projects.
2175 !     Configure what \"stuck\" means.
2176 C     Configure custom agenda commands.
2177
2178 More commands can be added by configuring the variable
2179 `org-agenda-custom-commands'.  In particular, specific tags and TODO keyword
2180 searches can be pre-defined in this way.
2181
2182 If the current buffer is in Org-mode and visiting a file, you can also
2183 first press `<' once to indicate that the agenda should be temporarily
2184 \(until the next use of \\[org-agenda]) restricted to the current file.
2185 Pressing `<' twice means to restrict to the current subtree or region
2186 \(if active)."
2187   (interactive "P")
2188   (catch 'exit
2189     (let* ((prefix-descriptions nil)
2190            (org-agenda-window-setup (if (equal (buffer-name)
2191                                                org-agenda-buffer-name)
2192                                         'current-window
2193                                       org-agenda-window-setup))
2194            (org-agenda-custom-commands-orig org-agenda-custom-commands)
2195            (org-agenda-custom-commands
2196             ;; normalize different versions
2197             (delq nil
2198                   (mapcar
2199                    (lambda (x)
2200                      (cond ((stringp (cdr x))
2201                             (push x prefix-descriptions)
2202                             nil)
2203                            ((stringp (nth 1 x)) x)
2204                            ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2205                            (t (cons (car x) (cons "" (cdr x))))))
2206                    org-agenda-custom-commands)))
2207            (buf (current-buffer))
2208            (bfn (buffer-file-name (buffer-base-buffer)))
2209            entry key type match lprops ans)
2210       ;; Turn off restriction unless there is an overriding one,
2211       (unless org-agenda-overriding-restriction
2212         (unless (org-bound-and-true-p org-agenda-keep-restricted-file-list)
2213           ;; There is a request to keep the file list in place
2214           (put 'org-agenda-files 'org-restrict nil))
2215         (setq org-agenda-restrict nil)
2216         (move-marker org-agenda-restrict-begin nil)
2217         (move-marker org-agenda-restrict-end nil))
2218       ;; Delete old local properties
2219       (put 'org-agenda-redo-command 'org-lprops nil)
2220       ;; Delete previously set last-arguments
2221       (put 'org-agenda-redo-command 'last-args nil)
2222       ;; Remember where this call originated
2223       (setq org-agenda-last-dispatch-buffer (current-buffer))
2224       (unless keys
2225         (setq ans (org-agenda-get-restriction-and-command prefix-descriptions)
2226               keys (car ans)
2227               restriction (cdr ans)))
2228       ;; Establish the restriction, if any
2229       (when (and (not org-agenda-overriding-restriction) restriction)
2230         (put 'org-agenda-files 'org-restrict (list bfn))
2231         (cond
2232          ((eq restriction 'region)
2233           (setq org-agenda-restrict t)
2234           (move-marker org-agenda-restrict-begin (region-beginning))
2235           (move-marker org-agenda-restrict-end (region-end)))
2236          ((eq restriction 'subtree)
2237           (save-excursion
2238             (setq org-agenda-restrict t)
2239             (org-back-to-heading t)
2240             (move-marker org-agenda-restrict-begin (point))
2241             (move-marker org-agenda-restrict-end
2242                          (progn (org-end-of-subtree t)))))))
2243
2244       ;; For example the todo list should not need it (but does...)
2245       (cond
2246        ((setq entry (assoc keys org-agenda-custom-commands))
2247         (if (or (symbolp (nth 2 entry)) (functionp (nth 2 entry)))
2248             (progn
2249               (setq type (nth 2 entry) match (eval (nth 3 entry))
2250                     lprops (nth 4 entry))
2251               (put 'org-agenda-redo-command 'org-lprops lprops)
2252               (cond
2253                ((eq type 'agenda)
2254                 (org-let lprops '(org-agenda-list current-prefix-arg)))
2255                ((eq type 'alltodo)
2256                 (org-let lprops '(org-todo-list current-prefix-arg)))
2257                ((eq type 'search)
2258                 (org-let lprops '(org-search-view current-prefix-arg match nil)))
2259                ((eq type 'stuck)
2260                 (org-let lprops '(org-agenda-list-stuck-projects
2261                                   current-prefix-arg)))
2262                ((eq type 'tags)
2263                 (org-let lprops '(org-tags-view current-prefix-arg match)))
2264                ((eq type 'tags-todo)
2265                 (org-let lprops '(org-tags-view '(4) match)))
2266                ((eq type 'todo)
2267                 (org-let lprops '(org-todo-list match)))
2268                ((eq type 'tags-tree)
2269                 (org-check-for-org-mode)
2270                 (org-let lprops '(org-match-sparse-tree current-prefix-arg match)))
2271                ((eq type 'todo-tree)
2272                 (org-check-for-org-mode)
2273                 (org-let lprops
2274                   '(org-occur (concat "^" org-outline-regexp "[ \t]*"
2275                                       (regexp-quote match) "\\>"))))
2276                ((eq type 'occur-tree)
2277                 (org-check-for-org-mode)
2278                 (org-let lprops '(org-occur match)))
2279                ((functionp type)
2280                 (org-let lprops '(funcall type match)))
2281                ((fboundp type)
2282                 (org-let lprops '(funcall type match)))
2283                (t (error "Invalid custom agenda command type %s" type))))
2284           (org-agenda-run-series (nth 1 entry) (cddr entry))))
2285        ((equal keys "C")
2286         (setq org-agenda-custom-commands org-agenda-custom-commands-orig)
2287         (customize-variable 'org-agenda-custom-commands))
2288        ((equal keys "a") (call-interactively 'org-agenda-list))
2289        ((equal keys "s") (call-interactively 'org-search-view))
2290        ((equal keys "t") (call-interactively 'org-todo-list))
2291        ((equal keys "T") (org-call-with-arg 'org-todo-list (or arg '(4))))
2292        ((equal keys "m") (call-interactively 'org-tags-view))
2293        ((equal keys "M") (org-call-with-arg 'org-tags-view (or arg '(4))))
2294        ((equal keys "e") (call-interactively 'org-store-agenda-views))
2295        ((equal keys "?") (org-tags-view nil "+FLAGGED")
2296         (org-add-hook
2297          'post-command-hook
2298          (lambda ()
2299            (unless (current-message)
2300              (let* ((m (org-agenda-get-any-marker))
2301                     (note (and m (org-entry-get m "THEFLAGGINGNOTE"))))
2302                (when note
2303                  (message (concat
2304                            "FLAGGING-NOTE ([?] for more info): "
2305                            (org-add-props
2306                                (replace-regexp-in-string
2307                                 "\\\\n" "//"
2308                                 (copy-sequence note))
2309                                nil 'face 'org-warning)))))))
2310          t t))
2311        ((equal keys "L")
2312         (unless (org-mode-p)
2313           (error "This is not an Org-mode file"))
2314         (unless restriction
2315           (put 'org-agenda-files 'org-restrict (list bfn))
2316           (org-call-with-arg 'org-timeline arg)))
2317        ((equal keys "#") (call-interactively 'org-agenda-list-stuck-projects))
2318        ((equal keys "/") (call-interactively 'org-occur-in-agenda-files))
2319        ((equal keys "!") (customize-variable 'org-stuck-projects))
2320        (t (error "Invalid agenda key"))))))
2321
2322 (defun org-agenda-append-agenda ()
2323   "Append another agenda view to the current one.
2324 This function allows interactive building of block agendas.
2325 Agenda views are separated by `org-agenda-block-separator'."
2326   (interactive)
2327   (unless (string= (buffer-name) org-agenda-buffer-name)
2328     (error "Can only append from within agenda buffer"))
2329   (let ((org-agenda-multi t))
2330     (org-agenda)
2331     (widen)))
2332
2333 (defun org-agenda-normalize-custom-commands (cmds)
2334   (delq nil
2335         (mapcar
2336          (lambda (x)
2337            (cond ((stringp (cdr x)) nil)
2338                  ((stringp (nth 1 x)) x)
2339                  ((not (nth 1 x)) (cons (car x) (cons "" (cddr x))))
2340                  (t (cons (car x) (cons "" (cdr x))))))
2341          cmds)))
2342
2343 (defun org-agenda-get-restriction-and-command (prefix-descriptions)
2344   "The user interface for selecting an agenda command."
2345   (catch 'exit
2346     (let* ((bfn (buffer-file-name (buffer-base-buffer)))
2347            (restrict-ok (and bfn (org-mode-p)))
2348            (region-p (org-region-active-p))
2349            (custom org-agenda-custom-commands)
2350            (selstring "")
2351            restriction second-time
2352            c entry key type match prefixes rmheader header-end custom1 desc
2353            line lines left right n n1)
2354       (save-window-excursion
2355         (delete-other-windows)
2356         (org-switch-to-buffer-other-window " *Agenda Commands*")
2357         (erase-buffer)
2358         (insert (eval-when-compile
2359                   (let ((header
2360 "
2361 Press key for an agenda command:        <   Buffer, subtree/region restriction
2362 --------------------------------        >   Remove restriction
2363 a   Agenda for current week or day      e   Export agenda views
2364 t   List of all TODO entries            T   Entries with special TODO kwd
2365 m   Match a TAGS/PROP/TODO query        M   Like m, but only TODO entries
2366 L   Timeline for current buffer         #   List stuck projects (!=configure)
2367 s   Search for keywords                 C   Configure custom agenda commands
2368 /   Multi-occur                         ?   Find :FLAGGED: entries
2369 ")
2370                         (start 0))
2371                     (while (string-match
2372                             "\\(^\\|   \\|(\\)\\(\\S-\\)\\( \\|=\\)"
2373                             header start)
2374                       (setq start (match-end 0))
2375                       (add-text-properties (match-beginning 2) (match-end 2)
2376                                            '(face bold) header))
2377                     header)))
2378         (setq header-end (move-marker (make-marker) (point)))
2379         (while t
2380           (setq custom1 custom)
2381           (when (eq rmheader t)
2382             (org-goto-line 1)
2383             (re-search-forward ":" nil t)
2384             (delete-region (match-end 0) (point-at-eol))
2385             (forward-char 1)
2386             (looking-at "-+")
2387             (delete-region (match-end 0) (point-at-eol))
2388             (move-marker header-end (match-end 0)))
2389           (goto-char header-end)
2390           (delete-region (point) (point-max))
2391
2392           ;; Produce all the lines that describe custom commands and prefixes
2393           (setq lines nil)
2394           (while (setq entry (pop custom1))
2395             (setq key (car entry) desc (nth 1 entry)
2396                   type (nth 2 entry)
2397                   match (nth 3 entry))
2398             (if (> (length key) 1)
2399                 (add-to-list 'prefixes (string-to-char key))
2400               (setq line
2401                     (format
2402                      "%-4s%-14s"
2403                      (org-add-props (copy-sequence key)
2404                          '(face bold))
2405                      (cond
2406                       ((string-match "\\S-" desc) desc)
2407                       ((eq type 'agenda) "Agenda for current week or day")
2408                       ((eq type 'alltodo) "List of all TODO entries")
2409                       ((eq type 'search) "Word search")
2410                       ((eq type 'stuck) "List of stuck projects")
2411                       ((eq type 'todo) "TODO keyword")
2412                       ((eq type 'tags) "Tags query")
2413                       ((eq type 'tags-todo) "Tags (TODO)")
2414                       ((eq type 'tags-tree) "Tags tree")
2415                       ((eq type 'todo-tree) "TODO kwd tree")
2416                       ((eq type 'occur-tree) "Occur tree")
2417                       ((functionp type) (if (symbolp type)
2418                                             (symbol-name type)
2419                                           "Lambda expression"))
2420                       (t "???"))))
2421               (if org-agenda-menu-show-matcher
2422                   (setq line
2423                         (concat line ": "
2424                                 (cond
2425                                  ((stringp match)
2426                                   (setq match (copy-sequence match))
2427                                   (org-add-props match nil 'face 'org-warning))
2428                                  (match
2429                                   (format "set of %d commands" (length match)))
2430                                  (t ""))))
2431                 (if (org-string-nw-p match)
2432                     (add-text-properties
2433                      0 (length line) (list 'help-echo
2434                                            (concat "Matcher: "match)) line)))
2435               (push line lines)))
2436           (setq lines (nreverse lines))
2437           (when prefixes
2438             (mapc (lambda (x)
2439                     (push
2440                      (format "%s   %s"
2441                              (org-add-props (char-to-string x)
2442                                  nil 'face 'bold)
2443                              (or (cdr (assoc (concat selstring
2444                                                      (char-to-string x))
2445                                              prefix-descriptions))
2446                                  "Prefix key"))
2447                      lines))
2448                   prefixes))
2449
2450           ;; Check if we should display in two columns
2451           (if org-agenda-menu-two-column
2452               (progn
2453                 (setq n (length lines)
2454                       n1 (+ (/ n 2) (mod n 2))
2455                       right (nthcdr n1 lines)
2456                       left (copy-sequence lines))
2457                 (setcdr (nthcdr (1- n1) left) nil))
2458             (setq left lines right nil))
2459           (while left
2460             (insert "\n" (pop left))
2461             (when right
2462               (if (< (current-column) 40)
2463                   (move-to-column 40 t)
2464                 (insert "   "))
2465               (insert (pop right))))
2466
2467           ;; Make the window the right size
2468           (goto-char (point-min))
2469           (if second-time
2470               (if (not (pos-visible-in-window-p (point-max)))
2471                   (org-fit-window-to-buffer))
2472             (setq second-time t)
2473             (org-fit-window-to-buffer))
2474
2475           ;; Ask for selection
2476           (message "Press key for agenda command%s:"
2477                    (if (or restrict-ok org-agenda-overriding-restriction)
2478                        (if org-agenda-overriding-restriction
2479                            " (restriction lock active)"
2480                          (if restriction
2481                              (format " (restricted to %s)" restriction)
2482                            " (unrestricted)"))
2483                      ""))
2484           (setq c (read-char-exclusive))
2485           (message "")
2486           (cond
2487            ((assoc (char-to-string c) custom)
2488             (setq selstring (concat selstring (char-to-string c)))
2489             (throw 'exit (cons selstring restriction)))
2490            ((memq c prefixes)
2491             (setq selstring (concat selstring (char-to-string c))
2492                   prefixes nil
2493                   rmheader (or rmheader t)
2494                   custom (delq nil (mapcar
2495                                     (lambda (x)
2496                                       (if (or (= (length (car x)) 1)
2497                                               (/= (string-to-char (car x)) c))
2498                                           nil
2499                                         (cons (substring (car x) 1) (cdr x))))
2500                                     custom))))
2501            ((and (not restrict-ok) (memq c '(?1 ?0 ?<)))
2502             (message "Restriction is only possible in Org-mode buffers")
2503             (ding) (sit-for 1))
2504            ((eq c ?1)
2505             (org-agenda-remove-restriction-lock 'noupdate)
2506             (setq restriction 'buffer))
2507            ((eq c ?0)
2508             (org-agenda-remove-restriction-lock 'noupdate)
2509             (setq restriction (if region-p 'region 'subtree)))
2510            ((eq c ?<)
2511             (org-agenda-remove-restriction-lock 'noupdate)
2512             (setq restriction
2513                   (cond
2514                    ((eq restriction 'buffer)
2515                     (if region-p 'region 'subtree))
2516                    ((memq restriction '(subtree region))
2517                     nil)
2518                    (t 'buffer))))
2519            ((eq c ?>)
2520             (org-agenda-remove-restriction-lock 'noupdate)
2521             (setq restriction nil))
2522            ((and (equal selstring "") (memq c '(?s ?a ?t ?m ?L ?C ?e ?T ?M ?# ?! ?/ ??)))
2523             (throw 'exit (cons (setq selstring (char-to-string c)) restriction)))
2524            ((and (> (length selstring) 0) (eq c ?\d))
2525             (delete-window)
2526             (org-agenda-get-restriction-and-command prefix-descriptions))
2527
2528            ((equal c ?q) (error "Abort"))
2529            (t (error "Invalid key %c" c))))))))
2530
2531 (defvar org-agenda-overriding-arguments nil) ; dynamically scoped parameter
2532 (defvar org-agenda-last-arguments nil
2533   "The arguments of the previous call to `org-agenda'.")
2534 (defun org-agenda-run-series (name series)
2535   (org-let (nth 1 series) '(org-prepare-agenda name))
2536   (let* ((org-agenda-multi t)
2537          (redo (list 'org-agenda-run-series name (list 'quote series)))
2538          (org-agenda-overriding-arguments
2539           (or org-agenda-overriding-arguments
2540               (unless (null (delq nil (get 'org-agenda-redo-command 'last-args)))
2541                 (get 'org-agenda-redo-command 'last-args))))
2542          (cmds (car series))
2543          (gprops (nth 1 series))
2544          match ;; The byte compiler incorrectly complains about this.  Keep it!
2545          cmd type lprops)
2546     (while (setq cmd (pop cmds))
2547       (setq type (car cmd) match (eval (nth 1 cmd)) lprops (nth 2 cmd))
2548       (cond
2549        ((eq type 'agenda)
2550         (org-let2 gprops lprops
2551           '(call-interactively 'org-agenda-list)))
2552        ((eq type 'alltodo)
2553         (org-let2 gprops lprops
2554           '(call-interactively 'org-todo-list)))
2555        ((eq type 'search)
2556         (org-let2 gprops lprops
2557                   '(org-search-view current-prefix-arg match nil)))
2558        ((eq type 'stuck)
2559         (org-let2 gprops lprops
2560           '(call-interactively 'org-agenda-list-stuck-projects)))
2561        ((eq type 'tags)
2562         (org-let2 gprops lprops
2563                   '(org-tags-view current-prefix-arg match)))
2564        ((eq type 'tags-todo)
2565         (org-let2 gprops lprops
2566                   '(org-tags-view '(4) match)))
2567        ((eq type 'todo)
2568         (org-let2 gprops lprops
2569                   '(org-todo-list match)))
2570        ((fboundp type)
2571         (org-let2 gprops lprops
2572           '(funcall type match)))
2573        (t (error "Invalid type in command series"))))
2574     (widen)
2575     (setq org-agenda-redo-command redo)
2576     (put 'org-agenda-redo-command 'last-args org-agenda-last-arguments)
2577     (goto-char (point-min)))
2578   (org-fit-agenda-window)
2579   (org-let (nth 1 series) '(org-finalize-agenda)))
2580
2581 ;;;###autoload
2582 (defmacro org-batch-agenda (cmd-key &rest parameters)
2583   "Run an agenda command in batch mode and send the result to STDOUT.
2584 If CMD-KEY is a string of length 1, it is used as a key in
2585 `org-agenda-custom-commands' and triggers this command.  If it is a
2586 longer string it is used as a tags/todo match string.
2587 Parameters are alternating variable names and values that will be bound
2588 before running the agenda command."
2589   (org-eval-in-environment (org-make-parameter-alist parameters)
2590     (if (> (length cmd-key) 2)
2591         (org-tags-view nil cmd-key)
2592       (org-agenda nil cmd-key)))
2593   (set-buffer org-agenda-buffer-name)
2594   (princ (org-encode-for-stdout (buffer-string))))
2595 (def-edebug-spec org-batch-agenda (form &rest sexp))
2596
2597 ;(defun org-encode-for-stdout (string)
2598 ;  (if (fboundp 'encode-coding-string)
2599 ;      (encode-coding-string string buffer-file-coding-system)
2600 ;    string))
2601
2602 (defun org-encode-for-stdout (string)
2603   string)
2604
2605 (defvar org-agenda-info nil)
2606
2607 ;;;###autoload
2608 (defmacro org-batch-agenda-csv (cmd-key &rest parameters)
2609   "Run an agenda command in batch mode and send the result to STDOUT.
2610 If CMD-KEY is a string of length 1, it is used as a key in
2611 `org-agenda-custom-commands' and triggers this command.  If it is a
2612 longer string it is used as a tags/todo match string.
2613 Parameters are alternating variable names and values that will be bound
2614 before running the agenda command.
2615
2616 The output gives a line for each selected agenda item.  Each
2617 item is a list of comma-separated values, like this:
2618
2619 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
2620
2621 category     The category of the item
2622 head         The headline, without TODO kwd, TAGS and PRIORITY
2623 type         The type of the agenda entry, can be
2624                 todo               selected in TODO match
2625                 tagsmatch          selected in tags match
2626                 diary              imported from diary
2627                 deadline           a deadline on given date
2628                 scheduled          scheduled on given date
2629                 timestamp          entry has timestamp on given date
2630                 closed             entry was closed on given date
2631                 upcoming-deadline  warning about deadline
2632                 past-scheduled     forwarded scheduled item
2633                 block              entry has date block including g. date
2634 todo         The todo keyword, if any
2635 tags         All tags including inherited ones, separated by colons
2636 date         The relevant date, like 2007-2-14
2637 time         The time, like 15:00-16:50
2638 extra        Sting with extra planning info
2639 priority-l   The priority letter if any was given
2640 priority-n   The computed numerical priority
2641 agenda-day   The day in the agenda where this is listed"
2642   (org-eval-in-environment (append '((org-agenda-remove-tags t))
2643                                    (org-make-parameter-alist parameters))
2644     (if (> (length cmd-key) 2)
2645         (org-tags-view nil cmd-key)
2646       (org-agenda nil cmd-key)))
2647   (set-buffer org-agenda-buffer-name)
2648   (let* ((lines (org-split-string (buffer-string) "\n"))
2649          line)
2650     (while (setq line (pop lines))
2651       (catch 'next
2652         (if (not (get-text-property 0 'org-category line)) (throw 'next nil))
2653         (setq org-agenda-info
2654               (org-fix-agenda-info (text-properties-at 0 line)))
2655         (princ
2656          (org-encode-for-stdout
2657           (mapconcat 'org-agenda-export-csv-mapper
2658                      '(org-category txt type todo tags date time extra
2659                                     priority-letter priority agenda-day)
2660                      ",")))
2661         (princ "\n")))))
2662 (def-edebug-spec org-batch-agenda-csv (form &rest sexp))
2663
2664 (defun org-fix-agenda-info (props)
2665   "Make sure all properties on an agenda item have a canonical form.
2666 This ensures the export commands can easily use it."
2667   (let (tmp re)
2668     (when (setq tmp (plist-get props 'tags))
2669       (setq props (plist-put props 'tags (mapconcat 'identity tmp ":"))))
2670     (when (setq tmp (plist-get props 'date))
2671       (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2672       (let ((calendar-date-display-form '(year "-" month "-" day)))
2673         '((format "%4d, %9s %2s, %4s" dayname monthname day year))
2674
2675         (setq tmp (calendar-date-string tmp)))
2676       (setq props (plist-put props 'date tmp)))
2677     (when (setq tmp (plist-get props 'day))
2678       (if (integerp tmp) (setq tmp (calendar-gregorian-from-absolute tmp)))
2679       (let ((calendar-date-display-form '(year "-" month "-" day)))
2680         (setq tmp (calendar-date-string tmp)))
2681       (setq props (plist-put props 'day tmp))
2682       (setq props (plist-put props 'agenda-day tmp)))
2683     (when (setq tmp (plist-get props 'txt))
2684       (when (string-match "\\[#\\([A-Z0-9]\\)\\] ?" tmp)
2685         (plist-put props 'priority-letter (match-string 1 tmp))
2686         (setq tmp (replace-match "" t t tmp)))
2687       (when (and (setq re (plist-get props 'org-todo-regexp))
2688                  (setq re (concat "\\`\\.*" re " ?"))
2689                  (string-match re tmp))
2690         (plist-put props 'todo (match-string 1 tmp))
2691         (setq tmp (replace-match "" t t tmp)))
2692       (plist-put props 'txt tmp)))
2693   props)
2694
2695 (defun org-agenda-export-csv-mapper (prop)
2696   (let ((res (plist-get org-agenda-info prop)))
2697     (setq res
2698           (cond
2699            ((not res) "")
2700            ((stringp res) res)
2701            (t (prin1-to-string res))))
2702     (while (string-match "," res)
2703       (setq res (replace-match ";" t t res)))
2704     (org-trim res)))
2705
2706
2707 ;;;###autoload
2708 (defun org-store-agenda-views (&rest parameters)
2709   (interactive)
2710   (eval (list 'org-batch-store-agenda-views)))
2711
2712 ;;;###autoload
2713 (defmacro org-batch-store-agenda-views (&rest parameters)
2714   "Run all custom agenda commands that have a file argument."
2715   (let ((cmds (org-agenda-normalize-custom-commands org-agenda-custom-commands))
2716         (pop-up-frames nil)
2717         (dir default-directory)
2718         (pars (org-make-parameter-alist parameters))
2719         cmd thiscmdkey files opts cmd-or-set)
2720     (save-window-excursion
2721       (while cmds
2722         (setq cmd (pop cmds)
2723               thiscmdkey (car cmd)
2724               cmd-or-set (nth 2 cmd)
2725               opts (nth (if (listp cmd-or-set) 3 4) cmd)
2726               files (nth (if (listp cmd-or-set) 4 5) cmd))
2727         (if (stringp files) (setq files (list files)))
2728         (when files
2729           (org-eval-in-environment (append org-agenda-exporter-settings
2730                                            opts pars)
2731             (org-agenda nil thiscmdkey))
2732           (set-buffer org-agenda-buffer-name)
2733           (while files
2734             (org-eval-in-environment (append org-agenda-exporter-settings
2735                                              opts pars)
2736               (org-write-agenda (expand-file-name (pop files) dir) nil t)))
2737           (and (get-buffer org-agenda-buffer-name)
2738                (kill-buffer org-agenda-buffer-name)))))))
2739 (def-edebug-spec org-batch-store-agenda-views (&rest sexp))
2740
2741 (defun org-agenda-mark-header-line (pos)
2742   "Mark the line at POS as an agenda structure header."
2743   (save-excursion
2744     (goto-char pos)
2745     (put-text-property (point-at-bol) (point-at-eol)
2746                        'org-agenda-structural-header t)
2747     (when org-agenda-title-append
2748       (put-text-property (point-at-bol) (point-at-eol)
2749                          'org-agenda-title-append org-agenda-title-append))))
2750
2751 (defvar org-mobile-creating-agendas)
2752 (defun org-write-agenda (file &optional open nosettings)
2753   "Write the current buffer (an agenda view) as a file.
2754 Depending on the extension of the file name, plain text (.txt),
2755 HTML (.html or .htm) or Postscript (.ps) is produced.
2756 If the extension is .ics, run icalendar export over all files used
2757 to construct the agenda and limit the export to entries listed in the
2758 agenda now.
2759 With prefix argument OPEN, open the new file immediately.
2760 If NOSETTINGS is given, do not scope the settings of
2761 `org-agenda-exporter-settings' into the export commands.  This is used when
2762 the settings have already been scoped and we do not wish to overrule other,
2763 higher priority settings."
2764   (interactive "FWrite agenda to file: \nP")
2765   (if (not (file-writable-p file))
2766       (error "Cannot write agenda to file %s" file))
2767   (org-let (if nosettings nil org-agenda-exporter-settings)
2768     '(save-excursion
2769        (save-window-excursion
2770          (org-agenda-mark-filtered-text)
2771          (let ((bs (copy-sequence (buffer-string))) beg)
2772            (org-agenda-unmark-filtered-text)
2773            (with-temp-buffer
2774              (rename-buffer "Agenda View" t)
2775              (set-buffer-modified-p nil)
2776              (insert bs)
2777              (org-agenda-remove-marked-text 'org-filtered)
2778              (while (setq beg (text-property-any (point-min) (point-max)
2779                                                  'org-filtered t))
2780                (delete-region
2781                 beg (or (next-single-property-change beg 'org-filtered)
2782                         (point-max))))
2783              (run-hooks 'org-agenda-before-write-hook)
2784              (cond
2785               ((org-bound-and-true-p org-mobile-creating-agendas)
2786                (org-mobile-write-agenda-for-mobile file))
2787               ((string-match "\\.html?\\'" file)
2788                (require 'htmlize)
2789                (set-buffer (htmlize-buffer (current-buffer)))
2790
2791                (when (and org-agenda-export-html-style
2792                           (string-match "<style>" org-agenda-export-html-style))
2793                  ;; replace <style> section with org-agenda-export-html-style
2794                  (goto-char (point-min))
2795                  (kill-region (- (search-forward "<style") 6)
2796                               (search-forward "</style>"))
2797                  (insert org-agenda-export-html-style))
2798                (write-file file)
2799                (kill-buffer (current-buffer))
2800                (message "HTML written to %s" file))
2801               ((string-match "\\.ps\\'" file)
2802                (require 'ps-print)
2803                (ps-print-buffer-with-faces file)
2804                (message "Postscript written to %s" file))
2805               ((string-match "\\.pdf\\'" file)
2806                (require 'ps-print)
2807                (ps-print-buffer-with-faces
2808                 (concat (file-name-sans-extension file) ".ps"))
2809                (call-process "ps2pdf" nil nil nil
2810                              (expand-file-name
2811                               (concat (file-name-sans-extension file) ".ps"))
2812                              (expand-file-name file))
2813                (delete-file (concat (file-name-sans-extension file) ".ps"))
2814                (message "PDF written to %s" file))
2815               ((string-match "\\.ics\\'" file)
2816                (require 'org-icalendar)
2817                (let ((org-agenda-marker-table
2818                       (org-create-marker-find-array
2819                        (org-agenda-collect-markers)))
2820                      (org-icalendar-verify-function 'org-check-agenda-marker-table)
2821                      (org-combined-agenda-icalendar-file file))
2822                  (apply 'org-export-icalendar 'combine
2823                         (org-agenda-files nil 'ifmode))))
2824               (t
2825                (let ((bs (buffer-string)))
2826                  (find-file file)
2827                  (erase-buffer)
2828                  (insert bs)
2829                  (save-buffer 0)
2830                  (kill-buffer (current-buffer))
2831                  (message "Plain text written to %s" file))))))))
2832     (set-buffer org-agenda-buffer-name))
2833   (when open (org-open-file file)))
2834
2835 (defvar org-agenda-filter-overlays nil)
2836
2837 (defun org-agenda-mark-filtered-text ()
2838   "Mark all text hidden by filtering with a text property."
2839   (let ((inhibit-read-only t))
2840     (mapc
2841      (lambda (o)
2842        (when (equal (overlay-buffer o) (current-buffer))
2843          (put-text-property
2844           (overlay-start o) (overlay-end o)
2845           'org-filtered t)))
2846      org-agenda-filter-overlays)))
2847
2848 (defun org-agenda-unmark-filtered-text ()
2849   "Remove the filtering text property."
2850   (let ((inhibit-read-only t))
2851     (remove-text-properties (point-min) (point-max) '(org-filtered t))))
2852
2853 (defun org-agenda-remove-marked-text (property &optional value)
2854   "Delete all text marked with VALUE of PROPERTY.
2855 VALUE defaults to t."
2856   (let (beg)
2857     (setq value (or value t))
2858     (while (setq beg (text-property-any (point-min) (point-max)
2859                                         property value))
2860       (delete-region
2861        beg (or (next-single-property-change beg 'org-filtered)
2862                (point-max))))))
2863
2864 (defun org-agenda-add-entry-text ()
2865   "Add entry text to agenda lines.
2866 This will add a maximum of `org-agenda-add-entry-text-maxlines' lines of the
2867 entry text following headings shown in the agenda.
2868 Drawers will be excluded, also the line with scheduling/deadline info."
2869   (when (and (> org-agenda-add-entry-text-maxlines 0)
2870              (not (org-bound-and-true-p org-mobile-creating-agendas)))
2871     (let (m txt)
2872       (goto-char (point-min))
2873       (while (not (eobp))
2874         (if (not (setq m (org-get-at-bol 'org-hd-marker)))
2875             (beginning-of-line 2)
2876           (setq txt (org-agenda-get-some-entry-text
2877                      m org-agenda-add-entry-text-maxlines "    > "))
2878           (end-of-line 1)
2879           (if (string-match "\\S-" txt)
2880               (insert "\n" txt)
2881             (or (eobp) (forward-char 1))))))))
2882
2883 (defun org-agenda-get-some-entry-text (marker n-lines &optional indent
2884                                               &rest keep)
2885   "Extract entry text from MARKER, at most N-LINES lines.
2886 This will ignore drawers etc, just get the text.
2887 If INDENT is given, prefix every line with this string.  If KEEP is
2888 given, it is a list of symbols, defining stuff that should not be
2889 removed from the entry content.  Currently only `planning' is allowed here."
2890   (let (txt drawer-re kwd-time-re ind)
2891     (save-excursion
2892       (with-current-buffer (marker-buffer marker)
2893         (if (not (org-mode-p))
2894             (setq txt "")
2895           (save-excursion
2896             (save-restriction
2897               (widen)
2898               (goto-char marker)
2899               (end-of-line 1)
2900               (setq txt (buffer-substring
2901                          (min (1+ (point)) (point-max))
2902                          (progn (outline-next-heading) (point)))
2903                     drawer-re org-drawer-regexp
2904                     kwd-time-re (concat "^[ \t]*" org-keyword-time-regexp
2905                                         ".*\n?"))
2906               (with-temp-buffer
2907                 (insert txt)
2908                 (when org-agenda-add-entry-text-descriptive-links
2909                   (goto-char (point-min))
2910                   (while (org-activate-bracket-links (point-max))
2911                     (add-text-properties (match-beginning 0) (match-end 0)
2912                                          '(face org-link))))
2913                 (goto-char (point-min))
2914                 (while (re-search-forward org-bracket-link-regexp (point-max) t)
2915                   (set-text-properties (match-beginning 0) (match-end 0)
2916                                        nil))
2917                 (goto-char (point-min))
2918                 (while (re-search-forward drawer-re nil t)
2919                   (delete-region
2920                    (match-beginning 0)
2921                    (progn (re-search-forward
2922                            "^[ \t]*:END:.*\n?" nil 'move)
2923                           (point))))
2924                 (unless (member 'planning keep)
2925                   (goto-char (point-min))
2926                   (while (re-search-forward kwd-time-re nil t)
2927                     (replace-match "")))
2928                 (goto-char (point-min))
2929                 (when org-agenda-entry-text-exclude-regexps
2930                   (let ((re-list org-agenda-entry-text-exclude-regexps) re)
2931                     (while (setq re (pop re-list))
2932                       (goto-char (point-min))
2933                       (while (re-search-forward re nil t)
2934                         (replace-match "")))))
2935                 (goto-char (point-max))
2936                 (skip-chars-backward " \t\n")
2937                 (if (looking-at "[ \t\n]+\\'") (replace-match ""))
2938
2939                 ;; find and remove min common indentation
2940                 (goto-char (point-min))
2941                 (untabify (point-min) (point-max))
2942                 (setq ind (org-get-indentation))
2943                 (while (not (eobp))
2944                   (unless (looking-at "[ \t]*$")
2945                     (setq ind (min ind (org-get-indentation))))
2946                   (beginning-of-line 2))
2947                 (goto-char (point-min))
2948                 (while (not (eobp))
2949                   (unless (looking-at "[ \t]*$")
2950                     (move-to-column ind)
2951                     (delete-region (point-at-bol) (point)))
2952                   (beginning-of-line 2))
2953
2954                 (run-hooks 'org-agenda-entry-text-cleanup-hook)
2955
2956                 (goto-char (point-min))
2957                 (when indent
2958                   (while (and (not (eobp)) (re-search-forward "^" nil t))
2959                     (replace-match indent t t)))
2960                 (goto-char (point-min))
2961                 (while (looking-at "[ \t]*\n") (replace-match ""))
2962                 (goto-char (point-max))
2963                 (when (> (org-current-line)
2964                          n-lines)
2965                   (org-goto-line (1+ n-lines))
2966                   (backward-char 1))
2967                 (setq txt (buffer-substring (point-min) (point)))))))))
2968     txt))
2969
2970 (defun org-agenda-collect-markers ()
2971   "Collect the markers pointing to entries in the agenda buffer."
2972   (let (m markers)
2973     (save-excursion
2974       (goto-char (point-min))
2975       (while (not (eobp))
2976         (when (setq m (or (org-get-at-bol 'org-hd-marker)
2977                           (org-get-at-bol 'org-marker)))
2978           (push m markers))
2979         (beginning-of-line 2)))
2980     (nreverse markers)))
2981
2982 (defun org-create-marker-find-array (marker-list)
2983   "Create a alist of files names with all marker positions in that file."
2984   (let (f tbl m a p)
2985     (while (setq m (pop marker-list))
2986       (setq p (marker-position m)
2987             f (buffer-file-name (or (buffer-base-buffer
2988                                      (marker-buffer m))
2989                                     (marker-buffer m))))
2990       (if (setq a (assoc f tbl))
2991           (push (marker-position m) (cdr a))
2992         (push (list f p) tbl)))
2993     (mapcar (lambda (x) (setcdr x (sort (copy-sequence (cdr x)) '<)) x)
2994             tbl)))
2995
2996 (defvar org-agenda-marker-table nil) ; dynamically scoped parameter
2997 (defun org-check-agenda-marker-table ()
2998   "Check of the current entry is on the marker list."
2999   (let ((file (buffer-file-name (or (buffer-base-buffer) (current-buffer))))
3000         a)
3001     (and (setq a (assoc file org-agenda-marker-table))
3002          (save-match-data
3003            (save-excursion
3004              (org-back-to-heading t)
3005              (member (point) (cdr a)))))))
3006
3007 (defun org-check-for-org-mode ()
3008   "Make sure current buffer is in org-mode.  Error if not."
3009   (or (org-mode-p)
3010       (error "Cannot execute org-mode agenda command on buffer in %s"
3011              major-mode)))
3012
3013 (defun org-fit-agenda-window ()
3014   "Fit the window to the buffer size."
3015   (and (memq org-agenda-window-setup '(reorganize-frame))
3016        (fboundp 'fit-window-to-buffer)
3017        (org-fit-window-to-buffer
3018         nil
3019         (floor (* (frame-height) (cdr org-agenda-window-frame-fractions)))
3020         (floor (* (frame-height) (car org-agenda-window-frame-fractions))))))
3021
3022 ;;; Agenda prepare and finalize
3023
3024 (defvar org-agenda-multi nil)  ; dynamically scoped
3025 (defvar org-agenda-buffer-name "*Org Agenda*")
3026 (defvar org-pre-agenda-window-conf nil)
3027 (defvar org-agenda-columns-active nil)
3028 (defvar org-agenda-name nil)
3029 (defvar org-agenda-filter nil)
3030 (defvar org-agenda-filter-while-redo nil)
3031 (defvar org-agenda-filter-preset nil
3032   "A preset of the tags filter used for secondary agenda filtering.
3033 This must be a list of strings, each string must be a single tag preceded
3034 by \"+\" or \"-\".
3035 This variable should not be set directly, but agenda custom commands can
3036 bind it in the options section.  The preset filter is a global property of
3037 the entire agenda view.  In a block agenda, it will not work reliably to
3038 define a filter for one of the individual blocks.  You need to set it in
3039 the global options and expect it to be applied to the entire view.")
3040
3041 (defun org-prepare-agenda (&optional name)
3042   (setq org-todo-keywords-for-agenda nil)
3043   (setq org-done-keywords-for-agenda nil)
3044   (setq org-drawers-for-agenda nil)
3045   (unless org-agenda-persistent-filter
3046     (setq org-agenda-filter nil))
3047   (put 'org-agenda-filter :preset-filter org-agenda-filter-preset)
3048   (if org-agenda-multi
3049       (progn
3050         (setq buffer-read-only nil)
3051         (goto-char (point-max))
3052         (unless (or (bobp) org-agenda-compact-blocks
3053                     (not org-agenda-block-separator))
3054           (insert "\n"
3055                   (if (stringp org-agenda-block-separator)
3056                       org-agenda-block-separator
3057                     (make-string (window-width) org-agenda-block-separator))
3058                   "\n"))
3059         (narrow-to-region (point) (point-max)))
3060     (org-agenda-reset-markers)
3061     (setq org-agenda-contributing-files nil)
3062     (setq org-agenda-columns-active nil)
3063     (org-prepare-agenda-buffers (org-agenda-files nil 'ifmode))
3064     (setq org-todo-keywords-for-agenda
3065           (org-uniquify org-todo-keywords-for-agenda))
3066     (setq org-done-keywords-for-agenda
3067           (org-uniquify org-done-keywords-for-agenda))
3068     (setq org-drawers-for-agenda (org-uniquify org-drawers-for-agenda))
3069     (let* ((abuf (get-buffer-create org-agenda-buffer-name))
3070            (awin (get-buffer-window abuf)))
3071       (cond
3072        ((equal (current-buffer) abuf) nil)
3073        (awin (select-window awin))
3074        ((not (setq org-pre-agenda-window-conf (current-window-configuration))))
3075        ((equal org-agenda-window-setup 'current-window)
3076         (org-pop-to-buffer-same-window abuf))
3077        ((equal org-agenda-window-setup 'other-window)
3078         (org-switch-to-buffer-other-window abuf))
3079        ((equal org-agenda-window-setup 'other-frame)
3080         (switch-to-buffer-other-frame abuf))
3081        ((equal org-agenda-window-setup 'reorganize-frame)
3082         (delete-other-windows)
3083         (org-switch-to-buffer-other-window abuf)))
3084       ;; additional test in case agenda is invoked from within agenda
3085       ;; buffer via elisp link
3086       (unless (equal (current-buffer) abuf)
3087         (org-pop-to-buffer-same-window abuf)))
3088     (setq buffer-read-only nil)
3089     (let ((inhibit-read-only t)) (erase-buffer))
3090     (org-agenda-mode)
3091     (and name (not org-agenda-name)
3092          (org-set-local 'org-agenda-name name)))
3093   (setq buffer-read-only nil))
3094
3095 (defun org-finalize-agenda ()
3096   "Finishing touch for the agenda buffer, called just before displaying it."
3097   (unless org-agenda-multi
3098     (save-excursion
3099       (let ((inhibit-read-only t))
3100         (goto-char (point-min))
3101         (while (org-activate-bracket-links (point-max))
3102           (add-text-properties (match-beginning 0) (match-end 0)
3103                                '(face org-link)))
3104         (org-agenda-align-tags)
3105         (unless org-agenda-with-colors
3106           (remove-text-properties (point-min) (point-max) '(face nil))))
3107       (if (and (boundp 'org-agenda-overriding-columns-format)
3108                org-agenda-overriding-columns-format)
3109           (org-set-local 'org-agenda-overriding-columns-format
3110                          org-agenda-overriding-columns-format))
3111       (if (and (boundp 'org-agenda-view-columns-initially)
3112                org-agenda-view-columns-initially)
3113           (org-agenda-columns))
3114       (when org-agenda-fontify-priorities
3115         (org-agenda-fontify-priorities))
3116       (when (and org-agenda-dim-blocked-tasks org-blocker-hook)
3117         (org-agenda-dim-blocked-tasks))
3118       (org-agenda-mark-clocking-task)
3119       (when org-agenda-entry-text-mode
3120         (org-agenda-entry-text-hide)
3121         (org-agenda-entry-text-show))
3122       (if (functionp 'org-habit-insert-consistency-graphs)
3123           (org-habit-insert-consistency-graphs))
3124       (run-hooks 'org-finalize-agenda-hook)
3125       (setq org-agenda-type (org-get-at-bol 'org-agenda-type))
3126       (when (or org-agenda-filter (get 'org-agenda-filter :preset-filter))
3127         (org-agenda-filter-apply org-agenda-filter))
3128       )))
3129
3130 (defun org-agenda-mark-clocking-task ()
3131   "Mark the current clock entry in the agenda if it is present."
3132   (mapc (lambda (o)
3133           (if (eq (overlay-get o 'type) 'org-agenda-clocking)
3134               (delete-overlay o)))
3135         (overlays-in (point-min) (point-max)))
3136   (when (marker-buffer org-clock-hd-marker)
3137     (save-excursion
3138       (goto-char (point-min))
3139       (let (s ov)
3140         (while (setq s (next-single-property-change (point) 'org-hd-marker))
3141           (goto-char s)
3142           (when (equal (org-get-at-bol 'org-hd-marker)
3143                        org-clock-hd-marker)
3144             (setq ov (make-overlay (point-at-bol) (1+ (point-at-eol))))
3145             (overlay-put ov 'type 'org-agenda-clocking)
3146             (overlay-put ov 'face 'org-agenda-clocking)
3147             (overlay-put ov 'help-echo
3148                              "The clock is running in this item")))))))
3149
3150 (defun org-agenda-fontify-priorities ()
3151   "Make highest priority lines bold, and lowest italic."
3152   (interactive)
3153   (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-priority)
3154                         (delete-overlay o)))
3155         (overlays-in (point-min) (point-max)))
3156   (save-excursion
3157     (let ((inhibit-read-only t)
3158           b e p ov h l)
3159       (goto-char (point-min))
3160       (while (re-search-forward "\\[#\\(.\\)\\]" nil t)
3161         (setq h (or (get-char-property (point) 'org-highest-priority)
3162                     org-highest-priority)
3163               l (or (get-char-property (point) 'org-lowest-priority)
3164                     org-lowest-priority)
3165               p (string-to-char (match-string 1))
3166               b (match-beginning 0)
3167               e (if (eq org-agenda-fontify-priorities 'cookies)
3168                     (match-end 0)
3169                   (point-at-eol))
3170               ov (make-overlay b e))
3171         (overlay-put
3172          ov 'face
3173          (cond ((org-face-from-face-or-color
3174                  'priority nil
3175                  (cdr (assoc p org-priority-faces))))
3176                ((and (listp org-agenda-fontify-priorities)
3177                      (org-face-from-face-or-color
3178                       'priority nil
3179                       (cdr (assoc p org-agenda-fontify-priorities)))))
3180                ((equal p l) 'italic)
3181                ((equal p h) 'bold)))
3182         (overlay-put ov 'org-type 'org-priority)))))
3183
3184 (defun org-agenda-dim-blocked-tasks ()
3185   "Dim currently blocked TODO's in the agenda display."
3186   (mapc (lambda (o) (if (eq (overlay-get o 'org-type) 'org-blocked-todo)
3187                         (delete-overlay o)))
3188         (overlays-in (point-min) (point-max)))
3189   (save-excursion
3190     (let ((inhibit-read-only t)
3191           (org-depend-tag-blocked nil)
3192           (invis (eq org-agenda-dim-blocked-tasks 'invisible))
3193           org-blocked-by-checkboxes
3194           invis1 b e p ov h l)
3195       (goto-char (point-min))
3196       (while (let ((pos (next-single-property-change (point) 'todo-state)))
3197                (and pos (goto-char (1+ pos))))
3198         (setq org-blocked-by-checkboxes nil invis1 invis)
3199         (let ((marker (org-get-at-bol 'org-hd-marker)))
3200           (when (and marker
3201                      (with-current-buffer (marker-buffer marker)
3202                        (save-excursion (goto-char marker)
3203                                        (org-entry-blocked-p))))
3204             (if org-blocked-by-checkboxes (setq invis1 nil))
3205             (setq b (if invis1
3206                         (max (point-min) (1- (point-at-bol)))
3207                       (point-at-bol))
3208                   e (point-at-eol)
3209                   ov (make-overlay b e))
3210             (if invis1
3211                 (overlay-put ov 'invisible t)
3212               (overlay-put ov 'face 'org-agenda-dimmed-todo-face))
3213             (overlay-put ov 'org-type 'org-blocked-todo)))))))
3214
3215 (defvar org-agenda-skip-function nil
3216   "Function to be called at each match during agenda construction.
3217 If this function returns nil, the current match should not be skipped.
3218 Otherwise, the function must return a position from where the search
3219 should be continued.
3220 This may also be a Lisp form, it will be evaluated.
3221 Never set this variable using `setq' or so, because then it will apply
3222 to all future agenda commands.  If you do want a global skipping condition,
3223 use the option `org-agenda-skip-function-global' instead.
3224 The correct usage for `org-agenda-skip-function' is to bind it with
3225 `let' to scope it dynamically into the agenda-constructing command.
3226 A good way to set it is through options in `org-agenda-custom-commands'.")
3227
3228 (defun org-agenda-skip ()
3229   "Throw to `:skip' in places that should be skipped.
3230 Also moves point to the end of the skipped region, so that search can
3231 continue from there."
3232   (let ((p (point-at-bol)) to)
3233     (and org-agenda-skip-archived-trees (not org-agenda-archives-mode)
3234          (get-text-property p :org-archived)
3235          (org-end-of-subtree t)
3236          (throw :skip t))
3237     (and org-agenda-skip-comment-trees
3238          (get-text-property p :org-comment)
3239          (org-end-of-subtree t)
3240          (throw :skip t))
3241     (if (equal (char-after p) ?#) (throw :skip t))
3242     (when (setq to (or (org-agenda-skip-eval org-agenda-skip-function-global)
3243                        (org-agenda-skip-eval org-agenda-skip-function)))
3244       (goto-char to)
3245       (throw :skip t))))
3246
3247 (defun org-agenda-skip-eval (form)
3248   "If FORM is a function or a list, call (or eval) is and return result.
3249 `save-excursion' and `save-match-data' are wrapped around the call, so point
3250 and match data are returned to the previous state no matter what these
3251 functions do."
3252   (let (fp)
3253     (and form
3254          (or (setq fp (functionp form))
3255              (consp form))
3256          (save-excursion
3257            (save-match-data
3258              (if fp
3259                  (funcall form)
3260                (eval form)))))))
3261
3262 (defvar org-agenda-markers nil
3263   "List of all currently active markers created by `org-agenda'.")
3264 (defvar org-agenda-last-marker-time (org-float-time)
3265   "Creation time of the last agenda marker.")
3266
3267 (defun org-agenda-new-marker (&optional pos)
3268   "Return a new agenda marker.
3269 Org-mode keeps a list of these markers and resets them when they are
3270 no longer in use."
3271   (let ((m (copy-marker (or pos (point)))))
3272     (setq org-agenda-last-marker-time (org-float-time))
3273     (push m org-agenda-markers)
3274     m))
3275
3276 (defun org-agenda-reset-markers ()
3277   "Reset markers created by `org-agenda'."
3278   (while org-agenda-markers
3279     (move-marker (pop org-agenda-markers) nil)))
3280
3281 (defun org-agenda-save-markers-for-cut-and-paste (beg end)
3282   "Save relative positions of markers in region."
3283   (mapc (lambda (m) (org-check-and-save-marker m beg end))
3284         org-agenda-markers))
3285
3286 ;;; Entry text mode
3287
3288 (defun org-agenda-entry-text-show-here ()
3289   "Add some text from the entry as context to the current line."
3290   (let (m txt o)
3291     (setq m (org-get-at-bol 'org-hd-marker))
3292     (unless (marker-buffer m)
3293       (error "No marker points to an entry here"))
3294     (setq txt (concat "\n" (org-no-properties
3295                             (org-agenda-get-some-entry-text
3296                              m org-agenda-entry-text-maxlines "    > "))))
3297     (when (string-match "\\S-" txt)
3298       (setq o (make-overlay (point-at-bol) (point-at-eol)))
3299       (overlay-put o 'evaporate t)
3300       (overlay-put o 'org-overlay-type 'agenda-entry-content)
3301       (overlay-put o 'after-string txt))))
3302
3303 (defun org-agenda-entry-text-show ()
3304   "Add entry context for all agenda lines."
3305   (interactive)
3306   (save-excursion
3307     (goto-char (point-max))
3308     (beginning-of-line 1)
3309     (while (not (bobp))
3310       (when (org-get-at-bol 'org-hd-marker)
3311         (org-agenda-entry-text-show-here))
3312       (beginning-of-line 0))))
3313
3314 (defun org-agenda-entry-text-hide ()
3315   "Remove any shown entry context."
3316   (delq nil
3317         (mapcar (lambda (o)
3318                   (if (eq (overlay-get o 'org-overlay-type)
3319                           'agenda-entry-content)
3320                       (progn (delete-overlay o) t)))
3321                 (overlays-in (point-min) (point-max)))))
3322
3323 (defun org-agenda-get-day-face (date)
3324   "Return the face DATE should be displayed with."
3325   (or (and (functionp org-agenda-day-face-function)
3326            (funcall org-agenda-day-face-function date))
3327       (cond ((org-agenda-todayp date)
3328              'org-agenda-date-today)
3329             ((member (calendar-day-of-week date) org-agenda-weekend-days)
3330              'org-agenda-date-weekend)
3331             (t 'org-agenda-date))))
3332
3333 ;;; Agenda timeline
3334
3335 (defvar org-agenda-only-exact-dates nil) ; dynamically scoped
3336
3337 (defun org-timeline (&optional dotodo)
3338   "Show a time-sorted view of the entries in the current org file.
3339 Only entries with a time stamp of today or later will be listed.  With
3340 \\[universal-argument] prefix, all unfinished TODO items will also be shown,
3341 under the current date.
3342 If the buffer contains an active region, only check the region for
3343 dates."
3344   (interactive "P")
3345   (org-compile-prefix-format 'timeline)
3346   (org-set-sorting-strategy 'timeline)
3347   (let* ((dopast t)
3348          (doclosed org-agenda-show-log)
3349          (entry (buffer-file-name (or (buffer-base-buffer (current-buffer))
3350                                       (current-buffer))))
3351          (date (calendar-current-date))
3352          (beg (if (org-region-active-p) (region-beginning) (point-min)))
3353          (end (if (org-region-active-p) (region-end) (point-max)))
3354          (day-numbers (org-get-all-dates beg end 'no-ranges
3355                                          t doclosed ; always include today
3356                                          org-timeline-show-empty-dates))
3357          (org-deadline-warning-days 0)
3358          (org-agenda-only-exact-dates t)
3359          (today (org-today))
3360          (past t)
3361          args
3362          s e rtn d emptyp)
3363     (setq org-agenda-redo-command
3364           (list 'progn
3365                 (list 'org-switch-to-buffer-other-window (current-buffer))
3366                 (list 'org-timeline (list 'quote dotodo))))
3367     (if (not dopast)
3368         ;; Remove past dates from the list of dates.
3369         (setq day-numbers (delq nil (mapcar (lambda(x)
3370                                               (if (>= x today) x nil))
3371                                             day-numbers))))
3372     (org-prepare-agenda (concat "Timeline " (file-name-nondirectory entry)))
3373     (if doclosed (push :closed args))
3374     (push :timestamp args)
3375     (push :deadline args)
3376     (push :scheduled args)
3377     (push :sexp args)
3378     (if dotodo (push :todo args))
3379     (insert "Timeline of file " entry "\n")
3380     (add-text-properties (point-min) (point)
3381                          (list 'face 'org-agenda-structure))
3382     (org-agenda-mark-header-line (point-min))
3383     (while (setq d (pop day-numbers))
3384       (if (and (listp d) (eq (car d) :omitted))
3385           (progn
3386             (setq s (point))
3387             (insert (format "\n[... %d empty days omitted]\n\n" (cdr d)))
3388             (put-text-property s (1- (point)) 'face 'org-agenda-structure))
3389         (if (listp d) (setq d (car d) emptyp t) (setq emptyp nil))
3390         (if (and (>= d today)
3391                  dopast
3392                  past)
3393             (progn
3394               (setq past nil)
3395               (insert (make-string 79 ?-) "\