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