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