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