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