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