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