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