1 ;; org.el --- Outline-based notes management and organizer
2 ;; Carstens outline-mode for keeping track of everything.
3 ;; Copyright (c) 2004, 2005 Free Software Foundation
5 ;; Author: Carsten Dominik <dominik at science dot uva dot nl>
6 ;; Keywords: outlines, hypermedia, calendar
7 ;; Homepage: http://www.astro.uva.nl/~dominik/Tools/org/
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
31 ;; project planning with a fast and effective plain-text system.
33 ;; Org-mode develops organizational tasks around a NOTES file that contains
34 ;; information about projects as plain text. Org-mode is implemented on
35 ;; top of outline-mode - ideal to keep the content of large files well
36 ;; structured. It supports ToDo items, deadlines and time stamps, which
37 ;; magically appear in the diary listing of the Emacs calendar. Tables are
38 ;; easily created with a built-in table editor. Plain text URL-like links
39 ;; connect to websites, emails (VM,RMAIL,WANDERLUST), Usenet messages (Gnus),
40 ;; BBDB entries, and any files related to the projects. For printing and
41 ;; sharing of notes, an Org-mode file (or a part of it) can be exported as
42 ;; a structured ASCII file, or as HTML.
46 ;; The instruction below assume that you have downloaded Org-mode from the
47 ;; web. If Org-mode is part of the Emacs distribution or an XEmacs package,
48 ;; you only need to add to .emacs the last three lines of Lisp code listed
49 ;; below, i.e. the `auto-mode-alist' modification and the global key bindings.
51 ;; Byte-compile org.el and put it on your load path. Then copy the
52 ;; following lines into .emacs. The last two lines define *global*
53 ;; keys for the commands `org-store-link' and `org-agenda' - please
54 ;; choose suitable keys yourself.
56 ;; (autoload 'org-mode "org" "Org mode" t)
57 ;; (autoload 'org-diary "org" "Diary entries from Org mode")
58 ;; (autoload 'org-agenda "org" "Multi-file agenda from Org mode" t)
59 ;; (autoload 'org-store-link "org" "Store a link to the current location" t)
60 ;; (autoload 'orgtbl-mode "org" "Org tables as a minor mode" t)
61 ;; (autoload 'turn-on-orgtbl "org" "Org tables as a minor mode")
62 ;; (add-to-list 'auto-mode-alist '("\\.org$" . org-mode))
63 ;; (define-key global-map "\C-cl" 'org-store-link)
64 ;; (define-key global-map "\C-ca" 'org-agenda)
66 ;; This will put all files with extension ".org" into Org-mode. As an
67 ;; alternative, make the first line of a file look like this:
69 ;; MY PROJECTS -*- mode: org; -*-
71 ;; which will select Org-mode for this buffer no matter what the file's
76 ;; The documentation of Org-mode can be found in the TeXInfo file.
77 ;; This distribution also contains a PDF version of it. At the homepage
78 ;; of Org-mode, you can read online the same text online as HTML.
83 ;; - Agenda entries from the diary are linked to the diary file, so
84 ;; adding and editing diary entries can be done directly from the agenda.
85 ;; - Many calendar/diary commands available directly from agenda.
86 ;; - Field copying in tables with S-RET does increment.
87 ;; - C-c C-x C-v extracts the visible part of the buffer for printing.
88 ;; - Moving subtrees up and down preserves the whitespace at the tree end.
91 ;; - Table editor optimized to need fewer realignments, and to keep
92 ;; table shape when typing in fields.
93 ;; - A new minor mode, orgtbl-mode, introduces the Org-mode table editor
94 ;; into arbitrary major modes.
95 ;; - Fixed bug with realignment in XEmacs.
96 ;; - Startup options can be set with special #+STARTUP line.
97 ;; - Heading following a match in org-occur can be suppressed.
100 ;; - Copyright transfer to the FSF.
101 ;; - Effect of C-u and C-u C-u in org-timeline swapped.
102 ;; - Timeline now always contains today, and `.' jumps to it.
104 ;; - cut and paste of regtangular regions in tables
105 ;; - command to convert org-mode table to table.el table and back
106 ;; - command to treat several cells like a paragraph and fill it
107 ;; - command to convert a buffer region to a table
108 ;; - import/export tables as tab-separated files (exchange with Excel)
110 ;; - Sorting mechanism for agenda items rewritten from scratch.
111 ;; - Sorting fully configurable.
112 ;; - Entries specifying a time are sorted together.
113 ;; - Completion also covers option keywords after `#-'.
117 ;; - New reference card, thanks to Philip Rooke for creating it.
118 ;; - Single file agenda renamed to "Timeline". It no longer shows
119 ;; warnings about upcoming deadlines/overdue scheduled items.
120 ;; That functionality is now limited to the (multifile) agenda.
121 ;; - When reading a date, the calendar can be manipulated with keys.
122 ;; - Link support for RMAIL and Wanderlust (from planner.el, untested)
123 ;; - Minor bug fixes and documentation improvements.
126 ;; - Multifile Agenda shows current entries from many different files.
127 ;; - TeXInfo documentation (thanks to Christian Egli for the conversion).
128 ;; - Additional applications for TODO keywords, see documentation.
129 ;; Different files may have different TODO keywords etc.
130 ;; - Priorities for TODO items.
131 ;; - The browser mode used by `org-remember-handler' is improved.
132 ;; - Images get inlined in HTML export (thanks to Carsten Wimmer).
133 ;; - File links can contain line numbers, like file:/usr/etc/config:255
134 ;; - Minor bug fixes.
137 ;; - TODO entries can have additional states besides TODO and DONE.
138 ;; See new variable `org-todo-keywords'.
139 ;; - TODO keywords can be interpreted as categories. See variable
140 ;; `org-todo-interpretation'.
141 ;; - M-TAB completion on TODO keywords, TeX symbols, and normal words.
142 ;; - All keywords (like TODO, DEADLINE etc) are configurable.
143 ;; - Cursor positioning optimized after pro/demotion and TODO cycling.
144 ;; - Emphasizing in HTML works now for *bold*, /italic/ and _underline_.
145 ;; - New commands to kill, copy and yank entire subtrees. Yanking
146 ;; modifies the level of the tree before insertion.
147 ;; - New command `org-goto' (C-c C-j) to quickly move to other locations
148 ;; in the buffer without affecting outline visibility.
149 ;; - Hooks for John Wiegley's remember.el.
150 ;; - `org-read-date' pops up calendar for date selection with the mouse.
151 ;; See variable `org-popup-calendar-for-date-prompt'.
154 ;; - TODO items can be SCHEDULED to a certain date.
155 ;; - Expired DEADLINEs are ignored if in an entry marked DONE.
156 ;; - From the diary or time-sorted view (C-c C-r), C-c C-t can be used to
157 ;; change the TODO state of an item remotely.
158 ;; - Horizontal computations in table editor. See `org-table-eval-formula'.
159 ;; - Fixed bug with summing tables (command `org-table-sum', `C-c +').
160 ;; - Calendar window follows the timestamp when a timestamp is changed.
161 ;; New variable `org-calendar-follow-timestamp-change'.
162 ;; - Time-sorted view (`org-diary-view', C-c C-r) now uses the prefix
163 ;; argument to force inclusion of unscheduled TODO items.
164 ;; - New variable `org-confirm-shell-links' to turn of safety query.
165 ;; - New variable `org-open-non-existing-files'.
168 ;; - A time-sorted view on all time stamps can be created with C-c C-r.
169 ;; - Timestamps and Deadlines can be shown in the Emacs diary.
170 ;; - Date ranges introduced.
171 ;; - Time-string formats are no longer configurable.
172 ;; - Vertical lines in tables can be made invisible with `C-c |'.
173 ;; - New "link" type to execute shell commands, like "shell:ls *.org"
174 ;; - Upon export, "myfile.org" becomes "myfile.html" or "myfile.txt",
175 ;; instead of "myfile.org.html" or "myfile.org.txt".
176 ;; - When the cursor is in the white space at the beginning of a line,
177 ;; TAB removes the whitespace before indenting again.
180 ;; - Windows (NT/2000) support.
181 ;; - Works with both Emacs and XEmacs.
182 ;; - Fully automatic table editor.
183 ;; - New link types into Gnus, VM and BBDB.
184 ;; - Other link system changes
185 ;; - Time stamps are treated as links to the calendar.
186 ;; - Easy creation of links with global command `org-store-link'.
187 ;; - Insertion of links with `C-c C-l' works differently now.
188 ;; - Space characters allowed as part of a link.
189 ;; - Options in `org-file-apps' extended. The command may now be
190 ;; symbol 'emacs', or a lisp form.
191 ;; Please re-read the manual section about links.
192 ;; - Timestamp changes
193 ;; - `org-deadline' now prompts for a date.
194 ;; - A line can now contain several timestamps. Updating of a
195 ;; timestamp only happens if the cursor is at the timestamp.
196 ;; - Changed the time-stamp-format to ISO, to make sure it will
197 ;; always work (non-English month names had caused problems
198 ;; with `parse-time-string'.). Changing the time stamp format
199 ;; is not recommended.
200 ;; - Picture mode enhancements have been removed from org.el
203 ;; - Some option name changes, not backward compatible.
204 ;; - ASCII exporter upgrade: Table of contents.
205 ;; - HTML exporter upgrade: fixed-width regions, better
206 ;; sub/superscripts, many TeX symbols supported.
207 ;; - Calendar support.
210 ;; - HTML exporter upgrade, in particular table of contents
217 (eval-when-compile (require 'cl))
222 ;;; Customization variables
224 (defvar org-version "3.05"
225 "The version number of the file org.el.")
226 (defun org-version ()
228 (message "Org-mode version %s" org-version))
230 ;; The following two constants are for compatibility with different
231 ;; Emacs versions (Emacs versus XEmacs) and with different versions of
232 ;; outline.el. All the compatibility code in org.el is based on these two
234 (defconst org-xemacs-p (featurep 'xemacs)
235 "Are we running xemacs?")
236 (defconst org-noutline-p (featurep 'noutline)
237 "Are we using the new outline mode?")
240 "Outline-based notes management and organizer "
246 (defgroup org-startup nil
247 "Options concerning startup of Org-mode."
251 (defcustom org-startup-folded t
252 "Non-nil means, entering Org-mode will switch to OVERVIEW.
253 This can also be configured on a per-file basis by adding one of
254 the following lines anywhere in the buffer:
262 (defcustom org-startup-truncated t
263 "Non-nil means, entering Org-mode will set `truncate-lines'.
264 This is useful since some lines containing links can be very long and
265 uninteresting. Also tables look terrible when wrapped."
269 (defcustom org-startup-with-deadline-check nil
270 "Non-nil means, entering Org-mode will run the deadline check.
271 This means, if you start editing an org file, you will get an
272 immediate reminder of any due deadlines.
273 This can also be configured on a per-file basis by adding one of
274 the following lines anywhere in the buffer:
282 (defcustom org-insert-mode-line-in-empty-file nil
283 "Non-nil means insert the first line setting Org-mode in empty files.
284 When the function `org-mode' is called interactively in an empty, this
285 normally means that the file name does not automatically trigger Org-mode.
286 To ensure that the file will always be in Org-mode in the future, a
287 line enforcing Org-mode can be inserted into the buffer."
291 (defgroup org-keywords nil
292 "Options concerning TODO items in Org-mode."
296 (defcustom org-todo-keywords '("TODO" "DONE")
297 "List of TODO entry keywords.\\<org-mode-map>
298 By default, this is '(\"TODO\" \"DONE\"). The last entry in the list is
299 considered to mean that the entry is \"done\". All the other mean that
300 action is required, and will make the entry show up in todo lists, diaries
302 The command \\[org-todo] cycles an entry through these states, and an
303 additional state where no keyword is present. For details about this
304 cycling, see also the variable `org-todo-interpretation'
305 Changes become only effective after restarting Emacs."
307 :type '(repeat (string :tag "Keyword")))
309 (defcustom org-todo-interpretation 'sequence
310 "Controls how TODO keywords are interpreted.\\<org-mode-map>
311 Possible values are `sequence' and `type'.
312 This variable is only relevant if `org-todo-keywords' contains more than two
313 states. There are two ways how these keywords can be used:
315 - As a sequence in the process of working on a TODO item, for example
316 (setq org-todo-keywords '(\"TODO\" \"STARTED\" \"VERIFY\" \"DONE\")
317 org-todo-interpretation 'sequence)
319 - As different types of TODO items, for example
320 (setq org-todo-keywords '(\"URGENT\" \"RELAXED\" \"REMIND\" \"FOR_TOM\" \"DONE\")
321 org-todo-interpretation 'type)
323 When the states are interpreted as a sequence, \\[org-todo] always cycles
324 to the next state, in order to walk through all different states. So with
325 \\[org-todo], you turn an empty entry into the state TODO. When you started
326 working on the item, you use \\[org-todo] again to switch it to \"STARTED\",
327 later to VERIFY and finally to DONE.
329 When the states are interpreted as types, \\[org-todo] still cycles through
330 when it is called several times in direct succession, in order to initially
331 select the type. However, if not called immediately after a previous
332 \\[org-todo], it switches from each type directly to DONE. So with the
333 above example, you could use `\\[org-todo] \\[org-todo]' to label an entry
334 RELAXED. If you later return to this entry and press \\[org-todo] again,
335 RELAXED will not be changed REMIND, but directly to DONE.
337 You can create a large number of types. To initially select a
338 type, it is then best to use C-u \\[org-todo] in order to specify the
339 type with completion. Of course, you can also type the keyword
340 directly into the buffer. M-TAB completes TODO keywords at the
341 beginning of a headline."
343 :type '(choice (const sequence)
346 (defcustom org-default-priority ?B
347 "The default priority of TODO items.
348 This is the priority an item get if no explicit priority is given."
352 (defcustom org-lowest-priority ?C
353 "The lowest priority of TODO items. A character like ?A, ?B etc."
357 (defcustom org-deadline-string "DEADLINE:"
358 "String to mark deadline entries.
359 A deadline is this string, followed by a time stamp. Should be a word,
360 terminated by a colon. You can insert a schedule keyword and
361 a timestamp with \\[org-deadline].
362 Changes become only effective after restarting Emacs."
366 (defcustom org-scheduled-string "SCHEDULED:"
367 "String to mark scheduled TODO entries.
368 A schedule is this string, followed by a time stamp. Should be a word,
369 terminated by a colon. You can insert a schedule keyword and
370 a timestamp with \\[org-schedule].
371 Changes become only effective after restarting Emacs."
375 (defcustom org-comment-string "COMMENT"
376 "Entries starting with this keyword will never be exported.
377 An entry can be toggled between COMMENT and normal with
378 \\[org-toggle-comment].
379 Changes become only effective after restarting Emacs."
383 (defcustom org-after-todo-state-change-hook nil
384 "Hook which is run after the state of a TODO item was changed.
385 The new state (a string with a todo keyword, or nil) is available in the
386 lisp variable `state'."
390 ;; Variables for pre-computed regular expressions, all buffer local
391 (defvar org-todo-kwd-priority-p nil
392 "Do TODO items have priorities?")
393 (make-variable-buffer-local 'org-todo-kwd-priority-p)
394 (defvar org-todo-kwd-max-priority nil
395 "Maximum priority of TODO items")
396 (make-variable-buffer-local 'org-todo-kwd-max-priority)
397 (defvar org-ds-keyword-length 12
398 "Maximum length of the Deadline and SCHEDULED keywords.")
399 (make-variable-buffer-local 'org-ds-keyword-length)
400 (defvar org-done-string nil
401 "The last string in `org-todo-keywords', indicating an item is DONE.")
402 (make-variable-buffer-local 'org-done-string)
403 (defvar org-todo-regexp nil
404 "Matches any of the TODO state keywords.")
405 (make-variable-buffer-local 'org-todo-regexp)
406 (defvar org-not-done-regexp nil
407 "Matches any of the TODO state keywords except the last one.")
408 (make-variable-buffer-local 'org-not-done-regexp)
409 (defvar org-todo-line-regexp nil
410 "Matches a headline and puts TODO state into group 2 if present.")
411 (make-variable-buffer-local 'org-todo-line-regexp)
412 (defvar orb-nl-done-regexp nil
413 "Matches newline followed by a headline with the DONE keyword.")
414 (make-variable-buffer-local 'orb-nl-done-regexp)
415 (defvar org-looking-at-done-regexp nil
416 "Matches the DONE keyword a point.")
417 (make-variable-buffer-local 'org-looking-at-done-regexp)
418 (defvar org-deadline-regexp nil
419 "Matches the DEADLINE keyword.")
420 (make-variable-buffer-local 'org-deadline-regexp)
421 (defvar org-deadline-time-regexp nil
422 "Matches the DEADLINE keyword together with a time stamp.")
423 (make-variable-buffer-local 'org-deadline-time-regexp)
424 (defvar org-deadline-line-regexp nil
425 "Matches the DEADLINE keyword and the rest of the line.")
426 (make-variable-buffer-local 'org-deadline-line-regexp)
427 (defvar org-scheduled-regexp nil
428 "Matches the SCHEDULED keyword.")
429 (make-variable-buffer-local 'org-scheduled-regexp)
430 (defvar org-scheduled-time-regexp nil
431 "Matches the SCHEDULED keyword together with a time stamp.")
432 (make-variable-buffer-local 'org-scheduled-time-regexp)
434 (defun org-set-regexps-and-options ()
435 "Precompute regular expressions for current buffer."
436 (when (eq major-mode 'org-mode)
437 (let ((re (org-make-options-regexp
438 '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO" "STARTUP")))
440 kwds int key value cat)
444 (goto-char (point-min))
445 (while (re-search-forward re nil t)
446 (setq key (match-string 1) value (match-string 2))
448 ((equal key "CATEGORY")
449 (setq cat (intern (car (org-split-string value splitre)))))
450 ((equal key "SEQ_TODO")
452 kwds (append kwds (org-split-string value splitre))))
453 ((equal key "PRI_TODO")
455 kwds (append kwds (org-split-string value splitre))))
456 ((equal key "TYP_TODO")
458 kwds (append kwds (org-split-string value splitre))))
459 ((equal key "STARTUP")
460 (let ((opts (org-split-string value splitre))
461 (set '(("fold" org-startup-folded t)
462 ("nofold" org-startup-folded nil)
463 ("dlcheck" org-startup-with-deadline-check t)
464 ("nodlcheck" org-startup-with-deadline-check nil)))
466 (while (setq l (assoc (pop opts) set))
467 (setq var (nth 1 l) val (nth 2 l))
468 (set (make-local-variable var) val)))))
470 (and cat (set (make-local-variable 'org-category) cat))
471 (and kwds (set (make-local-variable 'org-todo-keywords) kwds))
472 (and int (set (make-local-variable 'org-todo-interpretation) int)))
473 ;; Compute the regular expressions and other local variables
474 (setq org-todo-kwd-priority-p (equal org-todo-interpretation 'priority)
475 org-todo-kwd-max-priority (1- (length org-todo-keywords))
476 org-ds-keyword-length (+ 2 (max (length org-deadline-string)
477 (length org-scheduled-string)))
479 (nth (1- (length org-todo-keywords)) org-todo-keywords)
481 (concat "\\<\\(" (mapconcat 'regexp-quote org-todo-keywords
485 (mapconcat 'regexp-quote
486 (nreverse (cdr (reverse org-todo-keywords)))
490 (concat "^\\(\\*+\\)[ \t]*\\("
491 (mapconcat 'regexp-quote org-todo-keywords "\\|")
494 (concat "[\r\n]\\*+[ \t]+" org-done-string "\\>")
495 org-looking-at-done-regexp (concat "^" org-done-string "\\>")
496 org-deadline-regexp (concat "\\<" org-deadline-string)
497 org-deadline-time-regexp
498 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
499 org-deadline-line-regexp
500 (concat "\\<\\(" org-deadline-string "\\).*")
502 (concat "\\<" org-scheduled-string)
503 org-scheduled-time-regexp
504 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
505 (org-set-font-lock-defaults)))
507 (defgroup org-time nil
508 "Options concerning time stamps and deadlines in Org-mode."
512 (defcustom org-deadline-warning-days 30
513 "No. of days before expiration during which a deadline becomes active.
514 This variable governs the display in the org file."
518 (defcustom org-popup-calendar-for-date-prompt t
519 "Non-nil means, pop up a calendar when prompting for a date.
520 In the calendar, the date can be selected with mouse-1. However, the
521 minibuffer will also be active, and you can simply enter the date as well.
522 When nil, only the minibuffer will be available."
526 (defcustom org-calendar-follow-timestamp-change t
527 "Non-nil means, make the calendar window follow timestamp changes.
528 When a timestamp is modified and the calendar window is visible, it will be
529 moved to the new date."
533 (defgroup org-agenda nil
534 "Options concerning agenda display Org-mode."
538 (defcustom org-agenda-files nil
539 "A list of org files for agenda/diary display.
540 Entries are added to this list with \\[org-add-file] and removed with
541 \\[org-remove-file]. You can also use customize to edit the list."
543 :type '(repeat file))
545 (defcustom org-select-timeline-window t
546 "Non-nil means, after creating a timeline, move cursor into Timeline window.
547 When nil, cursor will remain in the current window."
551 (defcustom org-select-agenda-window t
552 "Non-nil means, after creating an agenda, move cursor into Agenda window.
553 When nil, cursor will remain in the current window."
557 (defcustom org-fit-agenda-window t
558 "Non-nil means, change windo size of agenda to fit content."
562 (defcustom org-agenda-show-all-dates t
563 "Non-nil means, `org-agenda' shows every day in the selected range.
564 When nil, only the days which actually have entries are shown."
568 ;; FIXME: First day of month works only for current month because it would
569 ;; require a variable ndays treatment.
570 (defcustom org-agenda-start-on-weekday 1
571 "Non-nil means, start the overview always on the specified weekday.
572 0 Denotes Sunday, 1 denotes Monday etc.
573 When nil, always start on the current day."
575 :type '(choice (const :tag "Today" nil)
576 (const :tag "First day of month" t)
577 (number :tag "Weekday No.")))
579 (defcustom org-agenda-ndays 7
580 "Number of days to include in overview display."
584 (defcustom org-agenda-include-all-todo t
585 "Non-nil means, the multifile agenda will always contain all TODO entries.
586 When nil, date-less entries will only be shown if `org-agenda' is called
587 with a prefix argument.
588 When non-nil, the TODO entries will be listed at the top of the agenda, before
589 the entries for specific days."
593 (defcustom org-agenda-include-diary nil
594 "Non-nil means, when preparing the agenda, also get the
595 entries from the emacs calendars diary."
600 (defcustom org-agenda-sorting-strategy '(time-up category-keep priority-down)
601 "Sorting structure for the agenda items of a single day.
602 This is a list of symbols which will be used in sequence to determine
603 if an entry should be listed before another entry. The following
604 symbols are recognized.
606 time-up Put entries with time-of-day indications first, early first
607 time-down Put entries with time-of-day indications first, late first
608 category-keep Keep the default order of categories, corresponding to the
609 sequence in `org-agenda-files'.
610 category-up Sort alphabetically by category, A-Z.
611 category-down Sort alphabetically by category, Z-A.
612 priority-up Sort numerically by priority, high priority last.
613 priority-down Sort numerically by priority, high priority first.
615 The different possibilities will be tried in sequence, and testing stops
616 if one comparison returns a \"not-equal\". For example, the default
617 '(time-up category-keep priority-down)
618 means: Pull out all entries having a specified time of day and sort them,
619 in order to make a time schedule for the current day the first thing in the
620 agenda listing for the day. Of the entries without a time indication, keep
621 the grouped in categories, don't sort the categories, but keep them in
622 the sequence given in `org-agenda-files'. Within each category sort by
625 Leaving out the `category-keep' would mean that items will be sorted across
626 categories by priority."
632 (const category-keep)
634 (const category-down)
636 (const priority-down))))
638 (defcustom org-sort-agenda-notime-is-late t
639 "Non-nil means, items without time are considered late.
640 This is only relevant for sorting. When t, items which have no explicit
641 time like 15:30 will be considered as 24:01, i.e. later than any items which
642 do have a time. When nil, the default time is before 0:00."
646 (defvar org-category nil
647 "Variable used by org files to set a category for agenda display.
648 Such files should use a file variable to set it, for example
650 -*- mode: org; org-category: \"ELisp\"
652 If the file does not specify a category, the file's base name
655 (defgroup org-structure nil
656 "Options concerning structure editing in Org-mode."
660 (defcustom org-adapt-indentation t
661 "Non-nil means, adapt indentation when promoting and demoting.
662 When this is set and the *entire* text in an entry is indented, the
663 indentation is increased by one space in a demotion command, and
664 decreased by one in a promotion command. If any line in the entry
665 body starts at column 0, indentation is not changed at all."
666 :group 'org-structure
669 (defcustom org-cycle-emulate-tab t
670 "Where should `org-cycle' emulate TAB.
672 white Only in completely white lines
673 t Everywhere except in headlines"
674 :group 'org-structure
675 :type '(choice (const :tag "Never" nil)
676 (const :tag "Only in completely white lines" white)
677 (const :tag "Everywhere except in headlines" t)
680 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
681 "Formats for `format-time-string' which are used for time stamps.
682 It is not recommended to change this constant.")
684 (defcustom org-show-following-heading t
685 "Non-nil means, show heading following match in `org-occur'.
686 When doing an `org-occur' it is useful to show the headline which
687 follows the match, even if they do not match the regexp. This makes it
688 easier to edit directly inside the sparse tree. However, if you use
689 org-occur mainly as an overview, the following headlines are
690 unnecessary clutter."
691 :group 'org-structure
696 (defgroup org-link nil
697 "Options concerning links in Org-mode."
701 (defcustom org-allow-space-in-links t
702 "Non-nil means, file names in links may contain space characters.
703 When nil, it becomes possible to put several links into a line."
707 (defcustom org-line-numbers-in-file-links t
708 "Non-nil means, file links from `org-store-link' contain line numbers.
709 The line number will be added to the file name with :NNN and interpreted
710 by the command `org-open-at-point'.
711 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
712 negates this setting for the duration of the command."
716 (defcustom org-keep-stored-link-after-insertion nil
717 "Non-nil means, keep link in list for entire session.
719 The command `org-store-link' adds a link pointing to the current
720 location to an internal list. These links accumulate during a session.
721 The command `org-insert-link' can be used to insert links into any
722 Org-mode file (offering completion for all stored links). When this
723 option is nil, every link which has been inserted once using `C-c C-l'
724 will be removed from the list, to make completing the unused links
729 (defcustom org-link-frame-setup
730 '((vm . vm-visit-folder-other-frame)
731 (gnus . gnus-other-frame)
732 (file . find-file-other-window))
733 "Setup the frame configuration for following links.
734 When following a link with Emacs, it may often be useful to display
735 this link in another window or frame. This variable can be used to
736 set this up for the different types of links.
739 vm-visit-folder-other-frame
745 find-file-other-window
746 find-file-other-frame
747 For the calendar, use the variable `calendar-setup'.
748 For BBDB, it is currently only possible to display the matches in
754 (const vm-visit-folder)
755 (const vm-visit-folder-other-window)
756 (const vm-visit-folder-other-frame)))
760 (const gnus-other-frame)))
764 (const find-file-other-window)
765 (const find-file-other-frame)))))
767 (defcustom org-usenet-links-prefer-google nil
768 "Non-nil means, `org-store-link' will create web links to google groups.
769 When nil, Gnus will be used for such links.
770 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
771 negates this setting for the duration of the command."
775 (defcustom org-open-non-existing-files nil
776 "Non-nil means, `org-open-file' will open non-existing file.
777 When nil, an error will be generated."
781 (defcustom org-confirm-shell-links t
782 "Non-nil means, ask for confirmation before executing shell links.
783 The default is true, to keep new users from shooting into their own foot."
787 (defconst org-file-apps-defaults-linux
801 ("mpeg" . "plaympeg %s")
802 ("mp3" . "plaympeg %s")
804 ("pdf" . "acroread %s")
805 ("doc" . "soffice %s")
806 ("ppt" . "soffice %s")
807 ("pps" . "soffice %s")
808 ("html" . "netscape -remote openURL(%s,new-window)")
809 ("htm" . "netscape -remote openURL(%s,new-window)")
810 ("xs" . "soffice %s"))
811 "Default file applications on a UNIX/LINUX system.
812 See `org-file-apps'.")
814 (defconst org-file-apps-defaults-macosx
822 "Default file applications on a MacOS X system.
823 The system \"open\" is known as a default, but we use X11 applications
824 for some files for which the OS does not have a good default.
825 See `org-file-apps'.")
827 (defconst org-file-apps-defaults-windowsnt
828 '((t . (w32-shell-execute "open" file)))
829 "Default file applications on a Windows NT system.
830 The system \"open\" is used for most files.
831 See `org-file-apps'.")
833 (defcustom org-file-apps
841 "External applications for opening `file:path' items in a document.
842 Org-mode uses system defaults for different file types, but
843 you can use this variable to set the application for a given file
844 extension. The entries in this list are cons cells with a file extension
845 and the corresponding command. Possible values for the command are:
846 `emacs' The file will be visited by the current Emacs process.
847 `default' Use the default application for this file type.
848 string A command to be executed by a shell. %s will be replaced
849 by the path to the file.
850 sexp A lisp form which will be evaluated. The file path will
851 be available in the lisp variable `file'.
852 For more examples, see the system specific constants
853 `org-file-apps-defaults-macosx'
854 `org-file-apps-defaults-windowsnt'
855 `org-file-apps-defaults-linux'."
858 (cons (string :tag "Extension")
860 (const :tag "Visit with Emacs" 'emacs)
861 (const :tag "Use system default" 'default)
862 (string :tag "Command")
863 (sexp :tag "Lisp form")))))
866 (defgroup org-remember nil
867 "Options concerning interaction with remember.el."
871 (defcustom org-directory "~/org"
872 "Directory with org files.
873 This directory will be used as default to prompt for org files.
874 Used by the hooks for remember.el."
878 (defcustom org-default-notes-file "~/.notes"
879 "Default target for storing notes.
880 Used by the hooks for remember.el. This can be a string, or nil to mean
881 the value of `remember-data-file'."
884 (const :tag "Default from remember-data-file" nil)
887 (defcustom org-reverse-note-order nil
888 "Non-nil means, store new notes at the beginning of a file or entry.
889 When nil, new notes will be filed to the end of a file or entry."
892 (const :tag "Reverse always" t)
893 (const :tag "Reverse never" nil)
894 (repeat :tag "By file name regexp"
895 (cons regexp boolean))))
897 (defgroup org-table nil
898 "Options concerning tables in Org-mode."
902 (defcustom org-enable-table-editor 'optimized
903 "Non-nil means, lines starting with \"|\" are handled by the table editor.
904 When nil, such lines will be treated like ordinary lines.
906 When equal to the symbol `optimized', the table editor will be optimized to
908 - Use automatic overwrite mode in front of whitespace in table fields.
909 This make the structure of the table stay in tact as long as the edited
910 field does not exceed the column width.
911 - Minimize the number of realigns. Normally, the table is aligned each time
912 TAB or RET are pressed to move to another field. With optimization this
913 happens only if changes to a field might have changed the column width.
914 Optimization requires replacing the functions `self-insert-command',
915 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
916 slight (in fact: unnoticable) speed impact for normal typing. Org-mode is
917 very good at guessing when a re-align will be necessary, but you can always
918 force one with `C-c C-c'.
920 If you would like to use the optimized version in Org-mode, but the un-optimized
921 version in OrgTbl-mode, see the variable `orgtbl-optimized'.
923 This variable can be used to turn on and off the table editor during a session,
924 but in order to toggle optimization, a restart is required."
927 (const :tag "off" nil)
929 (const :tag "on, optimized" optimized)))
931 (defcustom org-table-default-size "5x2"
932 "The default size for newly created tables, Columns x Rows."
936 (defcustom org-table-automatic-realign t
937 "Non-nil means, automatically re-align table when pressing TAB or RETURN.
938 When nil, aligning is only done with \\[org-table-align], or after column
943 (defcustom org-table-spaces-around-separators '(1 . 1)
944 "The number of spaces to be placed before and after separators."
946 :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
948 (defcustom org-table-spaces-around-invisible-separators '(1 . 2)
949 "The number of spaces to be placed before and after separators.
950 This option applies when the column separators have been made invisible."
952 :type '(cons (number :tag "Before \"|\"") (number :tag " After \"|\"")))
954 (defcustom org-table-number-regexp "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$"
955 "Regular expression for recognizing numbers in table columns.
956 If a table column contains mostly numbers, it will be aligned to the
957 right. If not, it will be aligned to the left.
959 The default value of this option is a regular expression which allows
960 anything which looks remotely like a number as used in scientific
961 context. For example, all of the following will be considered a
963 12 12.2 2.4e-08 2x10^12 4.034+-0.02 2.7(10) >3.5
965 Other options offered by the customize interface are more restrictive."
968 (const :tag "Positive Integers"
970 (const :tag "Integers"
972 (const :tag "Floating Point Numbers"
973 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.[0-9]*\\)$")
974 (const :tag "Floating Point Number or Integer"
975 "^[-+]?\\([0-9]*\\.[0-9]+\\|[0-9]+\\.?[0-9]*\\)$")
976 (const :tag "Exponential, Floating point, Integer"
977 "^[-+]?[0-9.]+\\([eEdD][-+0-9]+\\)?$")
978 (const :tag "Very General Number-Like"
979 "^[<>]?[-+^.0-9]*[0-9][-+^.0-9eEdDx()%]*$")
980 (string :tag "Regexp:")))
982 (defcustom org-table-number-fraction 0.5
983 "Fraction of numbers in a column required to make the column align right.
984 In a column all non-white fields are considered. If at least this
985 fraction of fields is matched by `org-table-number-fraction',
986 alignment to the right border applies."
990 (defcustom org-export-highlight-first-table-line t
991 "Non-nil means, highlight the first table line.
992 In HTML export, this means use <th> instead of <td>.
993 In tables created with table.el, this applies to the first table line.
994 In Org-mode tables, all lines before the first horizontal separator
995 line will be formatted with <th> tags."
999 (defcustom org-table-copy-increment t
1000 "Non-nil means, increment when copying current field with \\[org-table-copy-down]."
1004 (defcustom org-table-tab-recognizes-table.el t
1005 "Non-nil means, TAB will automatically notice a table.el table.
1006 When it sees such a table, it moves point into it and - if necessary -
1007 calls `table-recognize-table'."
1011 (defcustom org-export-prefer-native-exporter-for-tables nil
1012 "Non-nil means, always export tables created with table.el natively.
1013 Natively means, use the HTML code generator in table.el.
1014 When nil, Org-mode's own HTML generator is used when possible (i.e. if
1015 the table does not use row- or column-spanning). This has the
1016 advantage, that the automatic HTML conversions for math symbols and
1017 sub/superscripts can be applied. Org-mode's HTML generator is also
1022 (defcustom org-enable-fixed-width-editor t
1023 "Non-nil means, lines starting with \":\" are treated as fixed-width.
1024 This currently only means, they are never auto-wrapped.
1025 When nil, such lines will be treated like ordinary lines."
1029 (defgroup org-export nil
1030 "Options for exporting org-listings."
1034 (defcustom org-export-language-setup
1035 '(("en" "Author" "Date" "Table of Contents")
1036 ("da" "Ophavsmand" "Dato" "Indhold")
1037 ("de" "Autor" "Datum" "Inhaltsverzeichnis")
1038 ("es" "Autor" "Fecha" "\xccndice")
1039 ("fr" "Auteur" "Date" "Table des Mati\xe8res")
1040 ("it" "Autore" "Data" "Indice")
1041 ("nl" "Auteur" "Datum" "Inhoudsopgave")
1042 ("nn" "Forfattar" "Dato" "Innhold") ;; nn = Norsk (nynorsk)
1043 ("sv" "F\xf6rfattarens" "Datum" "Inneh\xe5ll"))
1044 "Terms used in export text, translated to different languages.
1045 Use the variable `org-export-default-language' to set the language,
1046 or use the +OPTION lines for a per-file setting."
1050 (string :tag "HTML language tag")
1051 (string :tag "Author")
1052 (string :tag "Date")
1053 (string :tag "Table of Contents"))))
1055 (defcustom org-export-default-language "en"
1056 "The default language of HTML export, as a string.
1057 This should have an association in `org-export-language-setup'"
1061 (defcustom org-export-headline-levels 3
1062 "The last level which is still exported as a headline.
1063 Inferior levels will produce itemize lists when exported.
1064 Note that a numeric prefix argument to an exporter function overrides
1067 This option can also be set with the +OPTIONS line, e.g. \"H:2\"."
1071 (defcustom org-export-with-section-numbers t
1072 "Non-nil means, add section numbers to headlines when exporting.
1074 This option can also be set with the +OPTIONS line, e.g. \"num:t\"."
1078 (defcustom org-export-with-toc t
1079 "Non-nil means, create a table of contents in exported files.
1080 The TOC contains headlines with levels up to`org-export-headline-levels'.
1082 Headlines which contain any TODO items will be marked with \"(*)\" in
1083 ASCII export, and with red color in HTML output.
1085 In HTML output, the TOC will be clickable.
1087 This option can also be set with the +OPTIONS line, e.g. \"toc:nil\"."
1091 (defcustom org-export-preserve-breaks nil
1092 "Non-nil means, preserve all line breaks when exporting.
1093 Normally, in HTML output paragraphs will be reformatted. In ASCII
1094 export, line breaks will always be preserved, regardless of this variable.
1096 This option can also be set with the +OPTIONS line, e.g. \"\\n:t\"."
1100 (defcustom org-export-html-inline-images t
1101 "Non-nil means, inline images into exported HTML pages.
1102 The link will still be to the original location of the image file.
1103 So if you are moving the page, lets say to your public HTML site,
1104 you will have to move the image and maybe change the link."
1108 (defcustom org-export-html-expand t
1109 "Non-nil means, for HTML export, treat @<...> as HTML tag.
1110 When nil, these tags will be exported as plain text and therefore
1111 not be interpreted by a browser.
1113 This option can also be set with the +OPTIONS line, e.g. \"@:nil\"."
1117 (defcustom org-export-with-fixed-width t
1118 "Non-nil means, lines starting with \":\" will be in fixed width font.
1119 This can be used to have preformatted text, fragments of code etc. For
1121 : ;; Some Lisp examples
1124 will be looking just like this in also HTML. In ASCII export, this option
1127 This option can also be set with the +OPTIONS line, e.g. \"::nil\"."
1131 (defcustom org-export-with-tables t
1132 "Non-nil means, lines starting with \"|\" define a table
1135 | Name | Address | Birthday |
1136 |-------------+----------+-----------|
1137 | Arthur Dent | England | 29.2.2100 |
1139 In ASCII export, this option has no effect.
1141 This option can also be set with the +OPTIONS line, e.g. \"|:nil\"."
1145 (defcustom org-export-html-table-tag
1146 "<table border=1 cellspacing=0 cellpadding=6>"
1147 "The HTML tag used to start a table.
1148 This must be a <table> tag, but you may change the options like
1149 borders and spacing."
1153 (defcustom org-export-with-emphasize t
1154 "Non-nil means, interprete *word*, /word/, and _word_ as emphasized text.
1155 If the export target supports emphasizing text, the word will be
1156 typeset in bold, italic, or underlined, respectively. Works only for
1157 single words, but you can say: I *really* *mean* *this*.
1158 In ASCII export, this option has no effect.
1160 This option can also be set with the +OPTIONS line, e.g. \"*:nil\"."
1164 (defcustom org-match-sexp-depth 3
1165 "Number of stacked braces for sub/superscript matching.
1166 This has to be set before loading org.el to be effective."
1170 ;; FIXME: Should () parens be removed as well in sub/superscripts?
1171 (defcustom org-export-with-sub-superscripts t
1172 "Non-nil means, interprete \"_\" and \"^\" for export.
1173 When this option is turned on, you can use TeX-like syntax for sub- and
1174 superscripts. Several characters after \"_\" or \"^\" will be
1175 considered as a single item - so grouping with {} is normally not
1176 needed. For example, the following things will be parsed as single
1177 sub- or superscripts.
1179 10^24 or 10^tau several digits will be considered 1 item
1180 10^-12 or 10^-tau a leading sign with digits or a word
1181 x^2-y^3 will be read as x^2 - y^3, because items are
1182 terminated by almost any nonword/nondigit char.
1183 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
1185 Still, ambiguity is possible - so when in doubt use {} to enclose the
1187 In ASCII export, this option has no effect.
1189 This option can also be set with the +OPTIONS line, e.g. \"^:nil\"."
1193 (defcustom org-export-with-TeX-macros t
1194 "Non-nil means, interprete simple TeX-like macros when exporting.
1195 For example, HTML export converts \\alpha to α and \\AA to Å.
1196 No only real TeX macros will work here, but the standard HTML entities
1197 for math can be used as macro names as well. For a list of supported
1198 names in HTML export, see the constant `org-html-entities'.
1199 In ASCII export, this option has no effect.
1201 This option can also be set with the +OPTIONS line, e.g. \"TeX:nil\"."
1205 (defcustom org-export-html-with-timestamp nil
1206 "Non-nil means, write `org-export-html-html-helper-timestamp'
1207 into the exported html text. Otherwise, the buffer will just be saved
1212 (defcustom org-export-html-html-helper-timestamp
1213 "<br><br><hr><p><!-- hhmts start --> <!-- hhmts end -->\n"
1214 "The HTML tag used as timestamp delimiter for HTML-helper-mode."
1218 (defcustom org-export-ascii-show-new-buffer t
1219 "Non-nil means, popup buffer containing the exported ASCII text.
1220 Otherwise the buffer will just be saved to a file and stay hidden."
1224 (defcustom org-export-html-show-new-buffer nil
1225 "Non-nil means, popup buffer containing the exported html text.
1226 Otherwise, the buffer will just be saved to a file and stay hidden."
1231 (defgroup org-faces nil
1232 "Faces for highlighting in Org-mode."
1236 (defface org-level-1-face ;; font-lock-function-name-face
1237 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1238 (((class color) (background light)) (:foreground "Blue"))
1239 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1240 (t (:inverse-video t :bold t)))
1241 "Face used for level 1 headlines."
1244 (defface org-level-2-face ;; font-lock-variable-name-face
1245 '((((type tty) (class color)) (:foreground "yellow" :weight light))
1246 (((class color) (background light)) (:foreground "DarkGoldenrod"))
1247 (((class color) (background dark)) (:foreground "LightGoldenrod"))
1248 (t (:bold t :italic t)))
1249 "Face used for level 2 headlines."
1252 (defface org-level-3-face ;; font-lock-keyword-face
1253 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
1254 (((class color) (background light)) (:foreground "Purple"))
1255 (((class color) (background dark)) (:foreground "Cyan"))
1257 "Face used for level 3 headlines."
1260 (defface org-level-4-face ;; font-lock-comment-face
1261 '((((type tty pc) (class color) (background light)) (:foreground "red"))
1262 (((type tty pc) (class color) (background dark)) (:foreground "red1"))
1263 (((class color) (background light)) (:foreground "Firebrick"))
1264 (((class color) (background dark)) (:foreground "chocolate1"))
1265 (t (:bold t :italic t)))
1266 "Face used for level 4 headlines."
1269 (defface org-level-5-face ;; font-lock-type-face
1270 '((((type tty) (class color)) (:foreground "green"))
1271 (((class color) (background light)) (:foreground "ForestGreen"))
1272 (((class color) (background dark)) (:foreground "PaleGreen"))
1273 (t (:bold t :underline t)))
1274 "Face used for level 5 headlines."
1277 (defface org-level-6-face ;; font-lock-constant-face
1278 '((((type tty) (class color)) (:foreground "magenta"))
1279 (((class color) (background light)) (:foreground "CadetBlue"))
1280 (((class color) (background dark)) (:foreground "Aquamarine"))
1281 (t (:bold t :underline t)))
1282 "Face used for level 6 headlines."
1285 (defface org-level-7-face ;; font-lock-builtin-face
1286 '((((type tty) (class color)) (:foreground "blue" :weight light))
1287 (((class color) (background light)) (:foreground "Orchid"))
1288 (((class color) (background dark)) (:foreground "LightSteelBlue"))
1290 "Face used for level 7 headlines."
1293 (defface org-level-8-face ;; font-lock-string-face
1294 '((((type tty) (class color)) (:foreground "green"))
1295 (((class color) (background light)) (:foreground "RosyBrown"))
1296 (((class color) (background dark)) (:foreground "LightSalmon"))
1298 "Face used for level 8 headlines."
1301 (defface org-warning-face ;; font-lock-warning-face
1302 '((((type tty) (class color)) (:foreground "red"))
1303 (((class color) (background light)) (:foreground "Red" :bold t))
1304 (((class color) (background dark)) (:foreground "Pink" :bold t))
1305 (t (:inverse-video t :bold t)))
1306 "Face for deadlines and TODO keyords."
1309 (defcustom org-fontify-done-headline nil
1310 "Non-nil means, change the face of a headline if it is marked DONE.
1311 Normally, only the TODO/DONE keyword indicates the state of a headline.
1312 When this is non-nil, the headline after the keyword is set to the
1313 `org-headline-done-face' as an additional indication."
1317 (defface org-headline-done-face ;; font-lock-string-face
1318 '((((type tty) (class color)) (:foreground "green"))
1319 (((class color) (background light)) (:foreground "RosyBrown"))
1320 (((class color) (background dark)) (:foreground "LightSalmon"))
1322 "Face used to indicate that a headline is DONE. See also the variable
1323 `org-fontify-done-headline'."
1326 ;; Inheritance does not yet work for xemacs. So we just copy...
1328 (defface org-deadline-announce-face
1329 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1330 (((class color) (background light)) (:foreground "Blue"))
1331 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1332 (t (:inverse-video t :bold t)))
1333 "Face for upcoming deadlines."
1336 (defface org-scheduled-today-face
1337 '((((type tty) (class color)) (:foreground "green"))
1338 (((class color) (background light)) (:foreground "DarkGreen"))
1339 (((class color) (background dark)) (:foreground "PaleGreen"))
1340 (t (:bold t :underline t)))
1341 "Face for items scheduled for a certain day."
1344 (defface org-scheduled-previously-face
1345 '((((type tty pc) (class color) (background light)) (:foreground "red"))
1346 (((type tty pc) (class color) (background dark)) (:foreground "red1"))
1347 (((class color) (background light)) (:foreground "Firebrick"))
1348 (((class color) (background dark)) (:foreground "chocolate1"))
1349 (t (:bold t :italic t)))
1350 "Face for items scheduled previously, and not yet done."
1353 (defface org-link-face
1354 '((((type tty) (class color)) (:foreground "cyan" :weight bold))
1355 (((class color) (background light)) (:foreground "Purple"))
1356 (((class color) (background dark)) (:foreground "Cyan"))
1361 (defface org-done-face ;; font-lock-type-face
1362 '((((type tty) (class color)) (:foreground "green"))
1363 (((class color) (background light)) (:foreground "ForestGreen" :bold t))
1364 (((class color) (background dark)) (:foreground "PaleGreen" :bold t))
1365 (t (:bold t :underline t)))
1366 "Face used for DONE."
1369 (defface org-table-face ;; font-lock-function-name-face
1370 '((((type tty) (class color)) (:foreground "blue" :weight bold))
1371 (((class color) (background light)) (:foreground "Blue"))
1372 (((class color) (background dark)) (:foreground "LightSkyBlue"))
1373 (t (:inverse-video t :bold t)))
1374 "Face used for tables."
1377 (defvar org-level-faces
1388 (defvar org-n-levels (length org-level-faces))
1390 ;; Tell the compiler about dynamically scoped variables,
1391 ;; and variables from other packages
1393 (defvar zmacs-regions)
1394 (defvar original-date)
1395 (defvar org-transient-mark-mode)
1396 (defvar org-old-auto-fill-inhibit-regexp)
1397 (defvar orgtbl-mode-menu)
1398 (defvar org-html-entities)
1399 (defvar org-goto-start-pos)
1400 (defvar org-cursor-color)
1401 (defvar org-time-was-given)
1402 (defvar org-ts-what)
1404 (defvar levels-open)
1415 (defvar starting-day)
1416 (defvar include-all-loc)
1417 (defvar vm-message-pointer)
1418 (defvar vm-folder-directory)
1419 (defvar wl-summary-buffer-elmo-folder)
1420 (defvar wl-summary-buffer-folder-name)
1421 (defvar gnus-group-name)
1422 (defvar gnus-article-current)
1423 (defvar w3m-current-url)
1424 (defvar org-selected-point)
1425 (defvar calendar-mode-map)
1426 (defvar remember-save-after-remembering)
1427 (defvar remember-data-file))
1432 (defvar org-mode-map (copy-keymap outline-mode-map)
1433 "Keymap for Org-mode.")
1435 (defvar org-struct-menu)
1436 (defvar org-org-menu)
1439 (defun org-mode (&optional arg)
1440 "Outline-based notes management and organizer, alias
1441 \"Carstens outline-mode for keeping track of everything.\"
1443 Org-mode develops organizational tasks around a NOTES file which
1444 contains information about projects as plain text. Org-mode is
1445 implemented on top of outline-mode, which is ideal to keep the content
1446 of large files well structured. It supports ToDo items, deadlines and
1447 time stamps, which magically appear in the diary listing of the Emacs
1448 calendar. Tables are easily created with a built-in table editor.
1449 Plain text URL-like links connect to websites, emails (VM), Usenet
1450 messages (Gnus), BBDB entries, and any files related to the project.
1451 For printing and sharing of notes, an Org-mode file (or a part of it)
1452 can be exported as a well-structured ASCII or HTML file.
1454 The following commands are available:
1459 (setq major-mode 'org-mode)
1460 (setq mode-name "Org")
1461 (use-local-map org-mode-map)
1462 (easy-menu-add org-org-menu)
1463 (org-install-agenda-files-menu)
1464 (setq outline-regexp "\\*+")
1465 (if org-startup-truncated (setq truncate-lines t))
1466 (org-set-regexps-and-options)
1467 (set (make-local-variable 'font-lock-unfontify-region-function)
1468 'org-unfontify-region)
1469 ;; Activate before-change-function
1470 (set (make-local-variable 'org-table-may-need-update) t)
1471 (make-local-hook 'before-change-functions) ;; needed for XEmacs
1472 (add-hook 'before-change-functions 'org-before-change-function nil
1474 ;; Inhibit auto-fill for headers, tables and fixed-width lines.
1475 (set (make-local-variable 'auto-fill-inhibit-regexp)
1477 (if (or org-enable-table-editor org-enable-fixed-width-editor)
1480 (if org-enable-table-editor "|" "")
1481 (if org-enable-fixed-width-editor ":" "")
1483 ;; Hook, and startup actions
1485 (and org-insert-mode-line-in-empty-file
1486 (= (point-min) (point-max))))
1488 (goto-char (point-min))
1489 (insert " -*- mode: org -*-\n\n")))
1490 (run-hooks 'org-mode-hook)
1491 (if org-startup-with-deadline-check
1492 (call-interactively 'org-check-deadlines)
1493 (if org-startup-folded (org-cycle t))))
1497 (defvar org-mouse-map (make-sparse-keymap))
1498 (define-key org-mouse-map
1499 (if org-xemacs-p [button2] [mouse-2]) 'org-open-at-mouse)
1500 (define-key org-mouse-map
1501 (if org-xemacs-p [button3] [mouse-3]) 'org-find-file-at-mouse)
1503 (require 'font-lock)
1505 (defconst org-link-regexp
1506 (if org-allow-space-in-links
1507 "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^\t\n\r]+[^ \t\n\r]\\)"
1508 "\\(https?\\|ftp\\|mailto\\|file\\|news\\|bbdb\\|vm\\|wl\\|rmail\\|gnus\\|shell\\):\\([^ \t\n\r]+\\)"
1510 "Regular expression for matching links.")
1511 (defconst org-ts-lengths
1512 (cons (length (format-time-string (car org-time-stamp-formats)))
1513 (length (format-time-string (cdr org-time-stamp-formats))))
1514 "This holds the lengths of the two different time formats.")
1515 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}[^\r\n>]*\\)>"
1516 "Regular expression for fast time stamp matching.")
1517 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\([^0-9>\r\n]*\\)\\(\\([0-9]\\{2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
1518 "Regular expression matching time strings for analysis.")
1519 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 ">")
1520 "Regular expression matching time stamps, with groups.")
1521 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
1522 "Regular expression matching a time stamp range.")
1523 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
1524 org-ts-regexp "\\)?")
1525 "Regular expression matching a time stamp or time stamp range.")
1527 (defun org-activate-links (limit)
1528 "Run through the buffer and add overlays to links."
1529 (if (re-search-forward org-link-regexp limit t)
1531 (add-text-properties (match-beginning 0) (match-end 0)
1532 (list 'mouse-face 'highlight
1533 'keymap org-mouse-map))
1536 (defun org-activate-dates (limit)
1537 "Run through the buffer and add overlays to links."
1538 (if (re-search-forward org-tsr-regexp limit t)
1540 (add-text-properties (match-beginning 0) (match-end 0)
1541 (list 'mouse-face 'highlight
1542 'keymap org-mouse-map))
1546 (defun org-font-lock-level ()
1548 (org-back-to-heading t)
1549 (- (match-end 0) (match-beginning 0))))
1551 (defun org-set-font-lock-defaults ()
1552 (let ((org-font-lock-extra-keywords
1554 '(org-activate-links (0 'org-link-face))
1555 '(org-activate-dates (0 'org-link-face))
1556 (list (concat "^\\*+[ \t]*" org-not-done-regexp) '(1 'org-warning-face t))
1557 (list (concat "\\[#[A-Z]\\]") '(0 'org-warning-face t))
1558 (list (concat "\\<" org-deadline-string) '(0 'org-warning-face t))
1559 (list (concat "\\<" org-scheduled-string) '(0 'org-warning-face t))
1560 ;; '("\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
1562 ;; '("\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
1564 ;; '("\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
1566 '("\\<FIXME\\>" (0 'org-warning-face t))
1567 (list (concat "^\\*+[ \t]*\\<\\(" org-comment-string "\\)\\>")
1568 '(1 'org-warning-face t))
1569 '("^#.*" (0 'font-lock-comment-face t))
1570 (if org-fontify-done-headline
1571 (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\(.*\\)\\>")
1572 '(1 'org-done-face t) '(2 'org-headline-done-face t))
1573 (list (concat "^[*]+ +\\<\\(" org-done-string "\\)\\>")
1574 '(1 'org-done-face t)))
1575 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
1576 (1 'org-table-face t))
1577 '("^[ \t]*\\(:.*\\)" (1 'org-table-face t)))))
1578 (set (make-local-variable 'org-font-lock-keywords)
1580 (if org-noutline-p ; FIXME: I am not sure if eval will work
1581 ; on XEmacs if noutline is ever ported
1582 '((eval . (list "^\\(\\*+\\).*"
1584 (% (- (match-end 1) (match-beginning 1) 1)
1588 '(("^\\(\\(\\*+\\)[^\r\n]*\\)[\n\r]"
1589 (1 (nth (% (- (match-end 2) (match-beginning 2) 1)
1593 org-font-lock-extra-keywords))
1594 (set (make-local-variable 'font-lock-defaults)
1595 '(org-font-lock-keywords t nil nil backward-paragraph))
1596 (kill-local-variable 'font-lock-keywords) nil))
1598 (defvar org-font-lock-keywords nil)
1600 (defun org-unfontify-region (beg end &optional maybe_loudly)
1601 "Remove fontification and activation overlays from links."
1602 (font-lock-default-unfontify-region beg end)
1603 (let* ((modified (buffer-modified-p)) ;; FIXME: Why did I add this???
1604 (buffer-undo-list t)
1605 (inhibit-read-only t) (inhibit-point-motion-hooks t)
1606 (inhibit-modification-hooks t)
1607 deactivate-mark buffer-file-name buffer-file-truename)
1608 (remove-text-properties beg end '(mouse-face nil keymap nil))))
1610 ;;; Visibility cycling
1612 (defvar org-cycle-global-status nil)
1613 (defvar org-cycle-subtree-status nil)
1614 (defun org-cycle (&optional arg)
1615 "Visibility cycling for Org-mode.
1617 - When this function is called with a prefix argument, rotate the entire
1618 buffer through 3 states (global cycling)
1619 1. OVERVIEW: Show only top-level headlines.
1620 2. CONTENTS: Show all headlines of all levels, but no body text.
1621 3. SHOW ALL: Show everything.
1623 - When point is at the beginning of a headline, rotate the subtree started
1624 by this line through 3 different states (local cycling)
1625 1. FOLDED: Only the main headline is shown.
1626 2. CHILDREN: The main headline and the direct children are shown. From
1627 this state, you can move to one of the children and
1629 3. SUBTREE: Show the entire subtree, including body text.
1631 - When there is a numeric prefix, go ARG levels up and do a `show-subtree',
1632 keeping cursor position.
1634 - When point is not at the beginning of a headline, execute
1635 `indent-relative', like TAB normally does. See the option
1636 `org-cycle-emulate-tab' for details.
1638 - Special case: if point is the the beginning of the buffer and there is
1639 no headline in line 1, this function will act as if called with prefix arg."
1642 (if (or (and (bobp) (not (looking-at outline-regexp)))
1644 ;; special case: use global cycling
1649 ((org-at-table-p 'any)
1650 ;; Enter the table or move to the next field in the table
1651 (or (org-table-recognize-table.el)
1653 (org-table-justify-field-maybe)
1654 (org-table-next-field))))
1656 ((eq arg t) ;; Global cycling
1659 ((and (eq last-command this-command)
1660 (eq org-cycle-global-status 'overview))
1661 ;; We just created the overview - now do table of contents
1662 ;; This can be slow in very large buffers, so indicate action
1663 (message "CONTENTS...")
1665 ;; Visit all headings and show their offspring
1666 (goto-char (point-max))
1668 (while (and (progn (condition-case nil
1669 (outline-previous-visible-heading 1)
1670 (error (goto-char (point-min))))
1672 (looking-at outline-regexp))
1674 (if (bobp) (throw 'exit nil))))
1675 (message "CONTENTS...done"))
1676 (setq org-cycle-global-status 'contents))
1678 ((and (eq last-command this-command)
1679 (eq org-cycle-global-status 'contents))
1680 ;; We just showed the table of contents - now show everything
1682 (message "SHOW ALL")
1683 (setq org-cycle-global-status 'all))
1686 ;; Default action: go to overview
1688 (message "OVERVIEW")
1689 (setq org-cycle-global-status 'overview))))
1692 ;; Show-subtree, ARG levels up from here.
1694 (org-back-to-heading)
1695 (outline-up-heading arg)
1698 ((save-excursion (beginning-of-line 1) (looking-at outline-regexp))
1699 ;; At a heading: rotate between three different views
1700 (org-back-to-heading)
1701 (let ((goal-column 0) beg eoh eol eos nxh)
1702 ;; First, some boundaries
1704 (org-back-to-heading) (setq beg (point))
1706 (beginning-of-line 2)
1707 (while (and (not (eobp)) ;; this is like `next-line'
1708 (get-char-property (1- (point)) 'invisible))
1709 (beginning-of-line 2)) (setq eol (point)))
1710 (outline-end-of-heading) (setq eoh (point))
1711 (outline-end-of-subtree) (setq eos (point))
1712 (outline-next-heading) (setq nxh (point)))
1713 ;; Find out what to do next and set `this-command'
1716 ;; Nothing is hidden behind this heading
1717 (message "EMPTY ENTRY")
1718 (setq org-cycle-subtree-status nil))
1720 ;; Entire subtree is hidden in one line: open it
1723 (message "CHILDREN")
1724 (setq org-cycle-subtree-status 'children))
1725 ((and (eq last-command this-command)
1726 (eq org-cycle-subtree-status 'children))
1727 ;; We just showed the children, now show everything.
1730 (setq org-cycle-subtree-status 'subtree))
1732 ;; Default action: hide the subtree.
1735 (setq org-cycle-subtree-status 'folded)))))
1738 (buffer-read-only (org-back-to-heading))
1739 ((if (and (eq org-cycle-emulate-tab 'white)
1740 (save-excursion (beginning-of-line 1) (looking-at "[ \t]+$")))
1742 (eq org-cycle-emulate-tab t))
1743 (if (and (looking-at "[ \n\r\t]")
1744 (string-match "^[ \t]*$" (buffer-substring
1745 (point-at-bol) (point))))
1747 (beginning-of-line 1)
1748 (and (looking-at "[ \t]+") (replace-match ""))))
1752 (org-back-to-heading)
1755 (defvar org-goto-window-configuration nil)
1756 (defvar org-goto-marker nil)
1757 (defvar org-goto-map (make-sparse-keymap))
1758 (let ((cmds '(isearch-forward isearch-backward)) cmd)
1759 (while (setq cmd (pop cmds))
1760 (substitute-key-definition cmd cmd org-goto-map global-map)))
1761 (define-key org-goto-map [(return)] 'org-goto-ret)
1762 (define-key org-goto-map [(left)] 'org-goto-left)
1763 (define-key org-goto-map [(right)] 'org-goto-right)
1764 (define-key org-goto-map [(?q)] 'org-goto-quit)
1765 (define-key org-goto-map [(control ?g)] 'org-goto-quit)
1766 (define-key org-goto-map [(tab)] 'org-cycle)
1767 (define-key org-goto-map [(down)] 'outline-next-visible-heading)
1768 (define-key org-goto-map [(up)] 'outline-previous-visible-heading)
1769 (define-key org-goto-map "n" 'outline-next-visible-heading)
1770 (define-key org-goto-map "p" 'outline-previous-visible-heading)
1771 (define-key org-goto-map "f" 'outline-forward-same-level)
1772 (define-key org-goto-map "b" 'outline-backward-same-level)
1773 (define-key org-goto-map "u" 'outline-up-heading)
1774 (define-key org-goto-map "\C-c\C-n" 'outline-next-visible-heading)
1775 (define-key org-goto-map "\C-c\C-p" 'outline-previous-visible-heading)
1776 (define-key org-goto-map "\C-c\C-f" 'outline-forward-same-level)
1777 (define-key org-goto-map "\C-c\C-b" 'outline-backward-same-level)
1778 (define-key org-goto-map "\C-c\C-u" 'outline-up-heading)
1779 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
1780 (while l (define-key org-goto-map (int-to-string (pop l)) 'digit-argument)))
1782 (defconst org-goto-help
1783 "Select a location to jump to, press RET
1784 \[Up]/[Down]=next/prev headline TAB=cycle visibility RET=select [Q]uit")
1787 "Go to a different location of the document, keeping current visibility.
1789 When you want to go to a different location in a document, the fastest way
1790 is often to fold the entire buffer and then dive into the tree. This
1791 method has the disadvantage, than the previous location will be folded, and
1792 that can be unwanted.
1794 This command works around this by showing a copy of the current buffer in
1795 overview mode. You can dive into the tree in that copy, to find the
1796 location you want to reach. When pressing RET, the command returns to the
1797 original buffer in which the visibility is still unchanged. It then jumps
1798 to the new location, making it and the headline hierarchy above it visible."
1800 (let* ((org-goto-start-pos (point))
1802 (org-get-location (current-buffer) org-goto-help)))
1805 (goto-char selected-point)
1806 (if (org-invisible-p) (org-show-hierarchy-above)))
1809 (defun org-get-location (buf help)
1810 "Let the user select a location in the Org-mode buffer BUF.
1811 This function uses a recursive edit. It returns the selected position
1813 (let (org-selected-point)
1815 (save-window-excursion
1816 (delete-other-windows)
1817 (switch-to-buffer (get-buffer-create "*org-goto*"))
1818 (with-output-to-temp-buffer "*Help*"
1820 (shrink-window-if-larger-than-buffer (get-buffer-window "*Help*"))
1821 (setq buffer-read-only nil)
1824 (let ((org-startup-truncated t)
1825 (org-startup-folded t)
1826 (org-startup-with-deadline-check nil))
1828 (setq buffer-read-only t)
1829 (if (boundp 'org-goto-start-pos)
1830 (goto-char org-goto-start-pos)
1831 (goto-char (point-min)))
1832 (org-beginning-of-line)
1833 (message "Select location and press RET")
1834 ;; now we make sure that during selection, ony very few keys work
1835 ;; and that it is impossible to switch to another window.
1836 (let ((gm (current-global-map))
1837 (overriding-local-map org-goto-map))
1840 (use-global-map org-goto-map)
1842 (use-global-map gm)))))
1843 (kill-buffer "*org-goto*")
1844 org-selected-point))
1846 ;; FIXME: It may not be a good idea to temper with the prefix argument...
1847 (defun org-goto-ret (&optional arg)
1848 "Finish org-goto by going to the new location."
1850 (setq org-selected-point (point)
1851 current-prefix-arg arg)
1854 (defun org-goto-left (&optional arg)
1855 "Finish org-goto by going to the new location."
1857 (if (org-on-heading-p)
1859 (beginning-of-line 1)
1860 (setq org-selected-point (point)
1861 current-prefix-arg (- (match-end 0) (match-beginning 0)))
1863 (error "Not on a heading")))
1865 (defun org-goto-right (&optional arg)
1866 "Finish org-goto by going to the new location."
1868 (if (org-on-heading-p)
1870 (outline-end-of-subtree)
1871 (or (eobp) (forward-char 1))
1872 (setq org-selected-point (point)
1873 current-prefix-arg (- (match-end 0) (match-beginning 0)))
1875 (error "Not on a heading")))
1877 (defun org-goto-quit ()
1878 "Finish org-goto without cursor motion."
1880 (setq org-selected-point nil)
1883 ;;; Promotion, Demotion, Inserting new headlines
1885 (defvar org-ignore-region nil
1886 "To temporary disable the active region.")
1888 (defun org-insert-heading (arg)
1889 "Insert a new heading with same depth at point."
1891 (let* ((head (save-excursion
1893 (org-back-to-heading)
1894 (error (outline-next-heading)))
1895 (prog1 (match-string 0)
1896 (funcall outline-level)))))
1897 (unless (bolp) (newline))
1900 (save-excursion (newline-and-indent)))
1901 (unless (equal (char-before) ?\ )
1903 (run-hooks 'org-insert-heading-hook)))
1905 (defun org-promote-subtree (&optional arg)
1906 "Promote the entire subtree.
1907 See also `org-promote'."
1909 (org-map-tree 'org-promote))
1911 (defun org-demote-subtree (&optional arg)
1912 "Demote the entire subtree. See `org-demote'.
1913 See also `org-promote'."
1915 (org-map-tree 'org-demote))
1917 (defun org-do-promote (&optional arg)
1918 "Promote the current heading higher up the tree.
1919 If the region is active in transient-mark-mode, promote all headings
1923 (if (org-region-active-p)
1924 (org-map-region 'org-promote (region-beginning) (region-end))
1926 (org-fix-position-after-promote))
1928 (defun org-do-demote (&optional arg)
1929 "Demote the current heading lower down the tree.
1930 If the region is active in transient-mark-mode, demote all headings
1934 (if (org-region-active-p)
1935 (org-map-region 'org-demote (region-beginning) (region-end))
1937 (org-fix-position-after-promote))
1939 (defun org-fix-position-after-promote ()
1940 "Make sure that after pro/demotion cursor position is right."
1941 (and (equal (char-after) ?\ )
1942 (equal (char-before) ?*)
1945 (defun org-promote ()
1946 "Promote the current heading higher up the tree.
1947 If the region is active in transient-mark-mode, promote all headings
1949 (org-back-to-heading t)
1950 (let* ((level (save-match-data (funcall outline-level)))
1951 (up-head (make-string (1- level) ?*)))
1952 (if (= level 1) (error "Cannot promote to level 0. UNDO to recover."))
1953 (replace-match up-head nil t)
1954 (if org-adapt-indentation
1955 (org-fixup-indentation "^ " "" "^ ?\\S-"))))
1957 (defun org-demote ()
1958 "Demote the current heading lower down the tree.
1959 If the region is active in transient-mark-mode, demote all headings
1961 (org-back-to-heading t)
1962 (let* ((level (save-match-data (funcall outline-level)))
1963 (down-head (make-string (1+ level) ?*)))
1964 (replace-match down-head nil t)
1965 (if org-adapt-indentation
1966 (org-fixup-indentation "^ " " " "^\\S-"))))
1968 (defun org-map-tree (fun)
1969 "Call FUN for every heading underneath the current one."
1970 (org-back-to-heading)
1971 (let ((level (outline-level)))
1975 (outline-next-heading)
1976 (> (funcall outline-level) level))
1980 (defun org-map-region (fun beg end)
1981 "Call FUN for every heading between BEG and END."
1982 (let ((org-ignore-region t))
1984 (setq end (copy-marker end))
1986 ;; (if (fboundp 'deactivate-mark) (deactivate-mark))
1987 ;; (if (fboundp 'zmacs-deactivate-region) (zmacs-deactivate-region))
1988 (if (and (re-search-forward (concat "^" outline-regexp) nil t)
1992 (outline-next-heading)
1997 (defun org-fixup-indentation (from to prohibit)
1998 "Change the indentation in the current entry by re-replacing FROM with TO.
1999 However, if the regexp PROHIBIT matches at all, don't do anything.
2000 This is being used to change indentation along with the length of the
2001 heading marker. But if there are any lines which are not indented, nothing
2004 (let ((end (save-excursion (outline-next-heading)
2006 (unless (save-excursion (re-search-forward prohibit end t))
2007 (while (re-search-forward from end t)
2009 (beginning-of-line 2)))
2010 (move-marker end nil))))
2012 ;;; Vertical tree motion, cutting and pasting of subtrees
2014 (defun org-move-subtree-up (&optional arg)
2015 "Move the current subtree up past ARG headlines of the same level."
2017 (org-move-subtree-down (- (prefix-numeric-value arg))))
2019 (defun org-move-subtree-down (&optional arg)
2020 "Move the current subtree down past ARG headlines of the same level."
2022 (setq arg (prefix-numeric-value arg))
2023 (let ((movfunc (if (> arg 0) 'outline-get-next-sibling
2024 'outline-get-last-sibling))
2025 (ins-point (make-marker))
2029 (org-back-to-heading)
2032 (save-excursion (outline-end-of-heading)
2033 (setq folded (org-invisible-p)))
2034 (outline-end-of-subtree))
2035 (outline-next-heading)
2037 ;; Find insertion point, with error handling
2040 (or (and (funcall movfunc) (looking-at outline-regexp))
2041 (progn (goto-char beg)
2042 (error "Cannot move past superior level or buffer limit")))
2043 (setq cnt (1- cnt)))
2045 ;; Moving forward - still need to move over subtree
2046 (progn (outline-end-of-subtree)
2047 (outline-next-heading)
2048 (if (not (or (looking-at (concat "^" outline-regexp))
2051 (move-marker ins-point (point))
2052 (setq txt (buffer-substring beg end))
2053 (delete-region beg end)
2055 (goto-char ins-point)
2056 (if folded (hide-subtree))
2057 (move-marker ins-point nil)))
2059 (defvar org-subtree-clip ""
2060 "Clipboard for cut and paste of subtrees.
2061 This is actually only a copy of the kill, because we use the normal kill
2062 ring. We need it to check if the kill was created by `org-copy-subtree'.")
2064 (defvar org-subtree-clip-folded nil
2065 "Was the last copied suptree folded?
2066 This is used to fold the tree back after pasting.")
2068 (defun org-cut-subtree (&optional arg)
2069 "Cut the current subtree into the clipboard.
2070 This is a short-hand for marking the subtree and then cutting it."
2072 (org-copy-subtree arg 'cut))
2074 (defun org-copy-subtree (&optional arg cut)
2075 "Cut the current subtree into the clipboard.
2076 This is a short-hand for marking the subtree and then copying it.
2077 If CUT is non nil, actually cur the subtree."
2079 (let (beg end folded)
2080 (org-back-to-heading)
2083 (save-excursion (outline-end-of-heading)
2084 (setq folded (org-invisible-p)))
2085 (outline-end-of-subtree))
2086 (if (equal (char-after) ?\n) (forward-char 1))
2090 (setq org-subtree-clip-folded folded)
2091 (if cut (kill-region beg end) (copy-region-as-kill beg end))
2092 (setq org-subtree-clip (current-kill 0))
2093 (message "%s: Subtree with %d characters"
2094 (if cut "Cut" "Copied")
2095 (length org-subtree-clip)))))
2097 (defun org-paste-subtree (&optional level tree)
2098 "Paste the clipboard as a subtree, with modification of headline level.
2099 The entire subtree is promoted or demoted in order to match a new headline
2100 level. By default, the new level is derived from the visible headings
2101 before and after the insertion point, and taken to be the inferior headline
2102 level of the two. So if the previous visible heading is level 3 and the
2103 next is level 4 (or vice versa), level 4 will be used for insertion.
2104 This makes sure that the subtree remains an independent subtree and does
2105 not swallow low level entries.
2107 You can also force a different level, either by using a numeric prefix
2108 argument, or by inserting the heading marker by hand. For example, if the
2109 cursor is after \"*****\", then the tree will be shifted to level 5.
2111 If you want to insert the tree as is, just use \\[yank].
2113 If optional TREE is given, use this text instead of the kill ring."
2115 (unless (org-kill-is-subtree-p tree)
2117 (substitute-command-keys
2118 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
2119 (let* ((txt (or tree (current-kill 0)))
2120 (^re (concat "^\\(" outline-regexp "\\)"))
2121 (re (concat "\\(" outline-regexp "\\)"))
2122 (^re_ (concat "\\(" outline-regexp "\\)[ \t]*"))
2124 (old-level (if (string-match ^re txt)
2125 (- (match-end 0) (match-beginning 0))
2127 (force-level (cond (level (prefix-numeric-value level))
2129 ^re_ (buffer-substring (point-at-bol) (point)))
2130 (- (match-end 0) (match-beginning 0)))
2132 (prevous-level (save-excursion
2133 (outline-previous-visible-heading 1)
2135 (- (match-end 0) (match-beginning 0))
2137 (next-level (save-excursion
2138 (outline-next-visible-heading 1)
2140 (- (match-end 0) (match-beginning 0))
2142 (new-level (or force-level (max prevous-level next-level)))
2143 (shift (if (or (= old-level -1)
2145 (= old-level new-level))
2147 (- new-level old-level)))
2149 (delta (if (> shift 0) -1 1))
2150 (func (if (> shift 0) 'org-demote 'org-promote))
2152 ;; Remove the forces level indicator
2154 (delete-region (point-at-bol) (point)))
2155 ;; Make sure we start at the beginning of an empty line
2156 (if (not (bolp)) (insert "\n"))
2157 (if (not (looking-at "[ \t]*$"))
2158 (progn (insert "\n") (backward-char 1)))
2164 ;; Shift if necessary
2166 (message "Pasted at level %d, without shift" new-level)
2168 (narrow-to-region beg end)
2169 (while (not (= shift 0))
2170 (org-map-region func (point-min) (point-max))
2171 (setq shift (+ delta shift)))
2172 (goto-char (point-min))
2173 (message "Pasted at level %d, with shift by %d levels"
2175 (if (and (eq org-subtree-clip (current-kill 0))
2176 org-subtree-clip-folded)
2177 ;; The tree was folded before it was killed/copied
2180 (defun org-kill-is-subtree-p (&optional txt)
2181 "Check if the current kill is an outline subtree, or a set of trees.
2182 Returns nil if kill does not start with a headline, or if the first
2183 headline level is not the largest headline level in the tree.
2184 So this will actually acceept several entries of equal levels as well,
2185 which is OK for `org-paste-subtree'.
2186 If optional TXT is given, check this string instead of the current kill."
2187 (let* ((kill (or txt (current-kill 0) ""))
2188 (start-level (and (string-match (concat "\\`" outline-regexp) kill)
2189 (- (match-end 0) (match-beginning 0))))
2190 (re (concat "^" outline-regexp))
2192 (if (not start-level)
2193 nil ;; does not even start with a heading
2195 (while (setq start (string-match re kill (1+ start)))
2196 (if (< (- (match-end 0) (match-beginning 0)) start-level)
2202 (defun org-complete (&optional arg)
2203 "Perform completion on word at point.
2204 At the beginning of a headline, this completes TODO keywords as given in
2205 `org-todo-keywords'.
2206 If the current word is preceeded by a backslash, completes the TeX symbols
2207 that are supported for HTML support.
2208 If the current word is preceeded by \"#+\", completes special words for
2209 setting file options.
2210 At all other locations, this simply calls `ispell-complete-word'."
2213 (let* ((end (point))
2214 (beg (save-excursion
2215 (if (equal (char-before (point)) ?\ ) (backward-char 1))
2216 (skip-chars-backward "a-zA-Z0-9_:")
2218 (texp (equal (char-before beg) ?\\))
2219 (opt (equal (buffer-substring (max (point-at-bol) (- beg 2))
2222 (pattern (buffer-substring-no-properties beg end))
2223 (completion-ignore-case opt)
2229 (string-match "^#\\+\\(\\([A-Z_]+:?\\).*\\)" x)
2230 (cons (match-string 2 x) (match-string 1 x)))
2231 (org-split-string (org-get-current-options) "\n")))
2235 ((string-match "\\`\\*+[ \t]*\\'"
2236 (buffer-substring (point-at-bol) beg))
2238 (mapcar 'list org-todo-keywords))
2239 (t (progn (ispell-complete-word arg) (throw 'exit nil)))))
2240 (completion (try-completion pattern table)))
2241 (cond ((eq completion t)
2242 (if (equal type :opt)
2243 (insert (substring (cdr (assoc (upcase pattern) table))
2244 (length pattern)))))
2246 (message "Can't find completion for \"%s\"" pattern)
2248 ((not (string= pattern completion))
2249 (delete-region beg end)
2250 (if (string-match " +$" completion)
2251 (setq completion (replace-match "" t t completion)))
2253 (if (get-buffer-window "*Completions*")
2254 (delete-window (get-buffer-window "*Completions*")))
2255 (if (and (eq type :todo)
2256 (assoc completion table))
2258 (if (and (equal type :opt) (assoc completion table))
2259 (message (substitute-command-keys
2260 "Press \\[org-complete] again to insert example settings"))))
2262 (message "Making completion list...")
2263 (let ((list (sort (all-completions pattern table) 'string<)))
2264 (with-output-to-temp-buffer "*Completions*"
2265 (display-completion-list list)))
2266 (message "Making completion list...%s" "done"))))))
2268 ;;; Comments, TODO and DEADLINE
2270 (defun org-toggle-comment ()
2271 "Change the COMMENT state of an entry."
2274 (org-back-to-heading)
2275 (if (looking-at (concat outline-regexp
2276 "\\( +\\<" org-comment-string "\\>\\)"))
2277 (replace-match "" t t nil 1)
2278 (if (looking-at outline-regexp)
2280 (goto-char (match-end 0))
2281 (insert " " org-comment-string))))))
2283 (defun org-todo (&optional arg)
2284 "Change the TODO state of an item.
2285 The state of an item is given by a keyword at the start of the heading,
2287 *** TODO Write paper
2290 The different keywords are specified in the variable `org-todo-keywords'. By
2291 default the available states are \"TODO\" and \"DONE\".
2292 So for this example: when the item starts with TODO, it is changed to DONE.
2293 When it starts with DONE, the DONE is removed. And when neither TODO nor
2294 DONE are present, add TODO at the beginning of the heading.
2296 With prefix arg, use completion to determined the new state. With numeric
2297 prefix arg, switch to that state."
2300 (org-back-to-heading)
2301 (if (looking-at outline-regexp) (goto-char (match-end 0)))
2302 (or (looking-at (concat " +" org-todo-regexp " *"))
2304 (let* ((this (match-string 1))
2305 (completion-ignore-case t)
2306 (member (member this org-todo-keywords))
2310 ;; Read a state with completion
2311 (completing-read "State: " (mapcar (lambda(x) (list x))
2315 ;; user requests a specific state
2316 (nth (1- (prefix-numeric-value arg))
2318 ((null member) (car org-todo-keywords))
2319 ((null tail) nil) ;; -> first entry
2320 ((eq org-todo-interpretation 'sequence)
2322 ((memq org-todo-interpretation '(type priority))
2323 (if (eq this-command last-command)
2325 (if (> (length tail) 0) org-done-string nil)))
2327 (next (if state (concat " " state " ") " ")))
2328 (replace-match next t t)
2329 (run-hooks 'org-after-todo-state-change-hook)))
2330 ;; Fixup cursor location if close to the keyword
2331 (if (and (outline-on-heading-p)
2333 (save-excursion (goto-char (point-at-bol))
2334 (looking-at org-todo-line-regexp))
2335 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
2337 (goto-char (or (match-end 2) (match-end 1)))
2340 (defun org-show-todo-tree (arg)
2341 "Make a compact tree which shows all headlines marked with TODO.
2342 The tree will show the lines where the regexp matches, and all higher
2343 headlines above the match."
2345 (let ((case-fold-search nil)
2346 (kwd-re (if arg org-todo-regexp org-not-done-regexp)))
2347 (message "%d TODO entries found"
2348 (org-occur (concat "^" outline-regexp " +" kwd-re )))))
2350 (defun org-deadline ()
2351 "Insert the DEADLINE: string to make a deadline.
2352 A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
2353 to modify it to the correct date."
2356 org-deadline-string " "
2357 (format-time-string (car org-time-stamp-formats)
2358 (org-read-date nil 'to-time)))
2359 (message (substitute-command-keys
2360 "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
2362 (defun org-schedule ()
2363 "Insert the SCHEDULED: string to schedule a TODO item.
2364 A timestamp is also inserted - use \\[org-timestamp-up] and \\[org-timestamp-down]
2365 to modify it to the correct date."
2368 org-scheduled-string " "
2369 (format-time-string (car org-time-stamp-formats)
2370 (org-read-date nil 'to-time)))
2371 (message (substitute-command-keys
2372 "Use \\[org-timestamp-up-day] and \\[org-timestamp-down-day] to change the date.")))
2375 (defun org-occur (regexp &optional callback)
2376 "Make a compact tree which shows all matches of REGEXP.
2377 The tree will show the lines where the regexp matches, and all higher
2378 headlines above the match. It will also show the heading after the match,
2379 to make sure editing the matching entry is easy.
2380 if CALLBACK is non-nil, it is a function which is called to confirm
2381 that the match should indeed be shown."
2382 (interactive "sRegexp: ")
2383 (setq regexp (org-check-occur-regexp regexp))
2386 (goto-char (point-min))
2388 (while (re-search-forward regexp nil t)
2389 (when (or (not callback)
2392 (org-show-hierarchy-above))))
2394 (message "%d match(es) for regexp %s" cnt regexp))
2397 (defun org-show-hierarchy-above ()
2398 "Make sure point and the headings hierarchy above is visible."
2399 (if (org-on-heading-p t)
2400 (org-flag-heading nil) ; only show the heading
2401 (org-show-hidden-entry)) ; show entire entry
2403 (and org-show-following-heading
2404 (outline-next-heading)
2405 (org-flag-heading nil))) ; show the next heading
2406 (save-excursion ; show all higher headings
2407 (while (condition-case nil
2408 (progn (org-up-heading-all 1) t)
2410 (org-flag-heading nil))))
2414 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z]\\)\\] ?\\)"
2415 "Regular expression matching the priority indicator.")
2417 (defun org-priority-up ()
2418 "Increase the priority of the current item."
2422 (defun org-priority-down ()
2423 "Decrease the priority of the current item."
2425 (org-priority 'down))
2427 (defun org-priority (&optional action)
2428 "Change the priority of an item by ARG.
2429 ACTION can be set, up, or down."
2431 (setq action (or action 'set))
2432 (let (current new news have remove)
2434 (org-back-to-heading)
2435 (if (looking-at org-priority-regexp)
2436 (setq current (string-to-char (match-string 2))
2438 (setq current org-default-priority))
2441 (message (format "Priority A-%c, SPC to remove: " org-lowest-priority))
2442 (setq new (read-char-exclusive))
2443 (if (equal new ?\ ) (setq remove t)))
2445 (setq new (1- current)))
2447 (setq new (1+ current)))
2448 (t (error "Invalid action")))
2449 (setq new (min (max ?A (upcase new)) org-lowest-priority))
2450 (setq news (format "%c" new))
2453 (replace-match "" t t nil 1)
2454 (replace-match news t t nil 2))
2455 (looking-at org-todo-line-regexp)
2458 (goto-char (match-end 2))
2459 (insert " [#" news "]"))
2460 (goto-char (match-beginning 3))
2461 (insert "[#" news "] "))))
2463 (message "Priority removed")
2464 (message "Priority of current item set to %s" news))))
2467 (defun org-get-priority (s)
2468 "Find priority cookie and return priority."
2470 (if (not (string-match org-priority-regexp s))
2471 (* 1000 (- org-lowest-priority org-default-priority))
2472 (* 1000 (- org-lowest-priority
2473 (string-to-char (match-string 2 s)))))))
2477 (defvar org-last-changed-timestamp nil)
2479 (defun org-time-stamp (arg)
2480 "Prompt for a date/time and insert a time stamp.
2481 If the user specifies a time like HH:MM, or if this command is called
2482 with a prefix argument, the time stamp will contain date and time.
2483 Otherwise, only the date will be included. All parts of a date not
2484 specified by the user will be filled in from the current date/time.
2485 So if you press just return without typing anything, the time stamp
2486 will represent the current date/time. If there is already a timestamp
2487 at the cursor, it will be modified."
2489 (let ((fmt (if arg (cdr org-time-stamp-formats)
2490 (car org-time-stamp-formats)))
2491 (org-time-was-given nil)
2494 ((and (org-at-timestamp-p)
2495 (eq last-command 'org-time-stamp)
2496 (eq this-command 'org-time-stamp))
2498 (setq time (let ((this-command this-command))
2499 (org-read-date arg 'totime)))
2500 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
2501 (insert (format-time-string fmt time)))
2502 ((org-at-timestamp-p)
2503 (setq time (let ((this-command this-command))
2504 (org-read-date arg 'totime)))
2505 (and (org-at-timestamp-p) (replace-match
2506 (setq org-last-changed-timestamp
2507 (format-time-string fmt time))
2509 (message "Timestamp updated"))
2511 (setq time (let ((this-command this-command))
2512 (org-read-date arg 'totime)))
2513 (if org-time-was-given (setq fmt (cdr org-time-stamp-formats)))
2514 (insert (format-time-string fmt time))))))
2516 ;;; FIXME: Make the function take "Fri" as "next friday"
2517 (defun org-read-date (&optional with-time to-time)
2518 "Read a date and make things smooth for the user.
2519 The prompt will suggest to enter an ISO date, but you can also enter anything
2520 which will at least partially be understood by `parse-time-string'.
2521 Unrecognized parts of the date will default to the current day, month ,year,
2522 hour and minute. For example,
2523 3-2-5 --> 2003-02-05
2524 feb 15 --> currentyear-02-15
2525 sep 12 9 --> 2009-09-12
2526 12:45 --> today 12:45
2527 22 sept 0:34 --> currentyear-09-22 0:34
2528 12 --> currentyear-currentmonth-12
2530 The function understands only English month and weekday abbreviations,
2531 but this can be configured with the variables `parse-time-months' and
2532 `parse-time-weekdays'.
2534 While prompting, a calendar is popped up - you can also select the
2535 date with the mouse (button 1). The calendar shows a period of three
2536 month. To scroll it to other months, use the keys `>' and `<'.
2537 If you don't like the calendar, turn it off with
2538 \(setq org-popup-calendar-for-date-prompt nil).
2540 With optional argument TO-TIME, the date will immediately be converted
2541 to an internal time.
2542 With an optional argument WITH-TIME, the prompt will suggest to also
2543 insert a time. Note that when WITH-TIME is not set, you can still
2544 enter a time, and this function will inform the calling routine about
2545 this change. The calling routine may then choose to change the format
2546 used to insert the time stamp into the buffer to include the time."
2547 (let* ((default-time
2548 ;; Default time is either today, or, when entering a range,
2552 (concat org-ts-regexp "--\\=")
2556 (mapcar (lambda(x) (or x 0)) ;; FIXME: Problem with timezone?
2557 (parse-time-string (match-string 1))))
2559 (timestr (format-time-string
2560 (if with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") default-time))
2561 (prompt (format "YYYY-MM-DD [%s]: " timestr))
2563 second minute hour day month year tl)
2565 (if org-popup-calendar-for-date-prompt
2566 ;; Also show a calendar for date selection
2567 ;; Copied (with modifications) from planner.el by John Wiegley
2569 (save-window-excursion
2571 (calendar-forward-day (- (time-to-days default-time)
2572 (calendar-absolute-from-gregorian
2573 (calendar-current-date))))
2574 (let* ((old-map (current-local-map))
2575 (map (copy-keymap calendar-mode-map))
2576 (minibuffer-local-map (copy-keymap minibuffer-local-map)))
2577 (define-key map (kbd "RET") 'org-calendar-select)
2578 (define-key map (if org-xemacs-p [button1] [mouse-1])
2579 'org-calendar-select)
2580 (define-key minibuffer-local-map [(meta shift left)]
2581 (lambda () (interactive)
2582 (org-eval-in-calendar '(calendar-backward-month 1))))
2583 (define-key minibuffer-local-map [(meta shift right)]
2584 (lambda () (interactive)
2585 (org-eval-in-calendar '(calendar-forward-month 1))))
2586 (define-key minibuffer-local-map [(shift up)]
2587 (lambda () (interactive)
2588 (org-eval-in-calendar '(calendar-backward-week 1))))
2589 (define-key minibuffer-local-map [(shift down)]
2590 (lambda () (interactive)
2591 (org-eval-in-calendar '(calendar-forward-week 1))))
2592 (define-key minibuffer-local-map [(shift left)]
2593 (lambda () (interactive)
2594 (org-eval-in-calendar '(calendar-backward-day 1))))
2595 (define-key minibuffer-local-map [(shift right)]
2596 (lambda () (interactive)
2597 (org-eval-in-calendar '(calendar-forward-day 1))))
2598 (define-key minibuffer-local-map ">"
2599 (lambda () (interactive)
2600 (org-eval-in-calendar '(scroll-calendar-left 1))))
2601 (define-key minibuffer-local-map "<"
2602 (lambda () (interactive)
2603 (org-eval-in-calendar '(scroll-calendar-right 1))))
2607 (setq ans (read-string prompt "" nil nil))
2608 (setq ans (or ans1 ans2 ans)))
2609 (use-local-map old-map)))))
2610 ;; Naked prompt only
2611 (setq ans (read-string prompt "" nil timestr)))
2614 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
2616 (setq year (if (match-end 2)
2617 (string-to-number (match-string 2 ans))
2618 (string-to-number (format-time-string "%Y")))
2619 month (string-to-number (match-string 3 ans))
2620 day (string-to-number (match-string 4 ans)))
2621 (if (< year 100) (setq year (+ 2000 year)))
2622 (setq ans (replace-match (format "%04d-%02d-%02d" year month day)
2624 (setq tl (parse-time-string ans)
2625 year (or (nth 5 tl) (string-to-number (format-time-string "%Y")))
2626 month (or (nth 4 tl) (string-to-number (format-time-string "%m")))
2627 day (or (nth 3 tl) (string-to-number (format-time-string "%d")))
2628 hour (or (nth 2 tl) (string-to-number (format-time-string "%H")))
2629 minute (or (nth 1 tl) (string-to-number (format-time-string "%M")))
2630 second (or (nth 0 tl) 0))
2631 (if (and (boundp 'org-time-was-given)
2633 (setq org-time-was-given t))
2634 (if (< year 100) (setq year (+ 2000 year)))
2636 (encode-time second minute hour day month year)
2637 (if (or (nth 1 tl) (nth 2 tl))
2638 (format "%04d-%02d-%02d %02d:%02d" year month day hour minute)
2639 (format "%04d-%02d-%02d" year month day)))))
2641 (defun org-eval-in-calendar (form)
2642 "Eval FORM in the calendar window and return to current window.
2643 Also, store the cursor date in variable ans2."
2644 (let ((sw (selected-window)))
2645 (select-window (get-buffer-window "*Calendar*"))
2647 (when (calendar-cursor-to-date)
2648 (let* ((date (calendar-cursor-to-date))
2649 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
2650 (setq ans2 (format-time-string "%Y-%m-%d" time))))
2651 (select-window sw)))
2653 (defun org-calendar-select ()
2654 "Return to `org-read-date' with the date currently selected.
2655 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
2657 (when (calendar-cursor-to-date)
2658 (let* ((date (calendar-cursor-to-date))
2659 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
2660 (setq ans1 (format-time-string "%Y-%m-%d" time)))
2661 (if (active-minibuffer-window) (exit-minibuffer))))
2663 (defun org-check-deadlines (ndays)
2664 "Check if there are any deadlines due or past due.
2665 A deadline is considered due if it happens within `org-deadline-warning-days'
2666 days from todays date. If the deadline appears in an entry marked DONE,
2667 it is not shown. The prefix arg NDAYS can be used to test that many
2668 days. If the prefix are is a raw C-u prefix, all deadlines are shown."
2670 (let* ((org-warn-days
2672 ((equal ndays '(4)) 100000)
2673 (ndays (prefix-numeric-value ndays))
2674 (t org-deadline-warning-days)))
2675 (case-fold-search nil)
2676 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
2679 (and (let ((d1 (time-to-days (current-time)))
2681 (org-time-string-to-time (match-string 1)))))
2682 (< (- d2 d1) org-warn-days))
2683 (not (org-entry-is-done-p))))))
2684 (message "%d deadlines past-due or due within %d days"
2685 (org-occur regexp callback)
2688 (defun org-evaluate-time-range (&optional to-buffer)
2689 "Evaluate a time range by computing the difference between start and end.
2690 Normally the result is just printed in the echo area, but with prefix arg
2691 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
2692 If the time range is actually in a table, the result is inserted into the
2694 For time difference computation, a year is assumed to be exactly 365
2695 days in order to avoid rounding problems."
2698 (unless (org-at-date-range-p)
2699 (goto-char (point-at-bol))
2700 (re-search-forward org-tr-regexp (point-at-eol) t))
2701 (if (not (org-at-date-range-p))
2702 (error "Not at a time-stamp range, and none found in current line.")))
2703 (let* ((ts1 (match-string 1))
2704 (ts2 (match-string 2))
2705 (match-end (match-end 0))
2706 (time1 (org-time-string-to-time ts1))
2707 (time2 (org-time-string-to-time ts2))
2708 (t1 (time-to-seconds time1))
2709 (t2 (time-to-seconds time2))
2710 (diff (abs (- t2 t1)))
2711 (negative (< (- t2 t1) 0))
2712 (ys (floor (* 365 24 60 60)))
2715 (fy "%dy %dd %02d:%02d")
2716 (fd "%dd %02d:%02d")
2719 (setq y (floor (/ diff ys)) diff (mod diff ys)
2720 d (floor (/ diff ds)) diff (mod diff ds)
2721 h (floor (/ diff hs)) diff (mod diff hs)
2722 m (floor (/ diff 60)))
2725 (goto-char match-end)
2726 (when (and (org-at-table-p) (looking-at " *|"))
2728 (goto-char (match-end 0)))
2730 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
2732 (if negative (insert " -"))
2733 (if (> y 0) (insert " " (format fy y d h m))
2734 (if (> d 0) (insert " " (format fd d h m))
2735 (insert " " (format fh h m))))
2736 (if align (org-table-align))
2737 (message "Time difference inserted"))
2738 (message (org-make-tdiff-string y d h m)))))
2740 (defun org-make-tdiff-string (y d h m)
2743 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
2745 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
2747 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
2749 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
2751 (apply 'format fmt (nreverse l))))
2753 (defun org-time-string-to-time (s)
2754 (apply 'encode-time (org-parse-time-string s)))
2756 (defun org-parse-time-string (s)
2757 "Parse the standard Org-mode time string.
2758 This should be a lot faster than the normal parse-time-string."
2759 (if (string-match org-ts-regexp1 s)
2761 (string-to-number (or (match-string 8 s) "0"))
2762 (string-to-number (or (match-string 7 s) "0"))
2763 (string-to-number (match-string 4 s))
2764 (string-to-number (match-string 3 s))
2765 (string-to-number (match-string 2 s))
2769 (defun org-timestamp-up (&optional arg)
2770 "Increase the date item at the cursor by one.
2771 If the cursor is on the year, change the year. If it is on the month or
2772 the day, change that.
2773 With prefix ARG, change by that many units."
2775 (org-timestamp-change (prefix-numeric-value arg)))
2777 (defun org-timestamp-down (&optional arg)
2778 "Decrease the date item at the cursor by one.
2779 If the cursor is on the year, change the year. If it is on the month or
2780 the day, change that.
2781 With prefix ARG, change by that many units."
2783 (org-timestamp-change (- (prefix-numeric-value arg))))
2785 (defun org-timestamp-up-day (&optional arg)
2786 "Increase the date in the time stamp by one day.
2787 With prefix ARG, change that many days."
2789 (org-timestamp-change (prefix-numeric-value arg) 'day))
2791 (defun org-timestamp-down-day (&optional arg)
2792 "Increase the date in the time stamp by one day.
2793 With prefix ARG, change that many days."
2795 (org-timestamp-change (- (prefix-numeric-value arg)) 'day))
2797 (defsubst org-pos-in-match-range (pos n)
2798 (and (match-beginning n)
2799 (<= (match-beginning n) pos)
2800 (>= (match-end n) pos)))
2802 (defun org-at-timestamp-p ()
2803 "Determine if the the cursor is in or at a timestamp."
2805 (let* ((tsr org-ts-regexp2)
2807 (ans (or (looking-at tsr)
2809 (skip-chars-backward "^<\n\r\t")
2810 (if (> (point) 1) (backward-char 1))
2811 (and (looking-at tsr)
2812 (> (- (match-end 0) pos) -1))))))
2813 (and (boundp 'org-ts-what)
2816 ((org-pos-in-match-range pos 2) 'year)
2817 ((org-pos-in-match-range pos 3) 'month)
2818 ((org-pos-in-match-range pos 7) 'hour)
2819 ((org-pos-in-match-range pos 8) 'minute)
2820 ((or (org-pos-in-match-range pos 4)
2821 (org-pos-in-match-range pos 5)) 'day)
2825 (defun org-timestamp-change (n &optional what)
2826 "Change the date in the time stamp at point.
2827 The date will be changed by N times WHAT. WHAT can be `day', `month',
2828 `year', `minute', `second'. If WHAT is not given, the cursor position
2829 in the timestamp determines what will be changed."
2830 (let ((fmt (car org-time-stamp-formats))
2834 (if (not (org-at-timestamp-p))
2835 (error "Not at a timestamp"))
2836 (setq org-ts-what (or what org-ts-what))
2837 (setq fmt (if (<= (abs (- (cdr org-ts-lengths)
2838 (- (match-end 0) (match-beginning 0))))
2840 (cdr org-time-stamp-formats)
2841 (car org-time-stamp-formats)))
2842 (setq ts (match-string 0))
2844 (setq time0 (org-parse-time-string ts))
2848 (list (or (car time0) 0))
2849 (list (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0)))
2850 (list (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0)))
2851 (list (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0)))
2852 (list (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0)))
2853 (list (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0)))
2855 (if (eq what 'calendar)
2859 (set-buffer "*Calendar*")
2860 (calendar-cursor-to-date)))))
2861 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
2862 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
2863 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
2864 (setcar time0 (or (car time0) 0))
2865 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
2866 (setcar (nthcdr 2 time0) (or (nth 1 time0) 0))
2867 (setq time (apply 'encode-time time0))))
2868 (insert (setq org-last-changed-timestamp (format-time-string fmt time)))
2870 ;; Try to recenter the calendar window, if any
2871 (if (and org-calendar-follow-timestamp-change
2872 (get-buffer-window "*Calendar*" t)
2873 (memq org-ts-what '(day month year)))
2874 (org-recenter-calendar (time-to-days time)))))
2876 (defun org-recenter-calendar (date)
2877 "If the calendar is visible, recenter it to DATE."
2878 (let* ((win (selected-window))
2879 (cwin (get-buffer-window "*Calendar*" t)))
2881 (select-window cwin)
2882 (calendar-goto-date (if (listp date) date
2883 (calendar-gregorian-from-absolute date)))
2884 (select-window win))))
2886 (defun org-goto-calendar (&optional arg)
2887 "Go to the Emacs calendar at the current date.
2888 If there is a time stamp in the current line, go to that date.
2889 A prefix ARG can be used force the current date."
2891 (let ((tsr org-ts-regexp) diff)
2892 (if (or (org-at-timestamp-p)
2894 (beginning-of-line 1)
2895 (looking-at (concat ".*" tsr))))
2896 (let ((d1 (time-to-days (current-time)))
2898 (org-time-string-to-time (match-string 1)))))
2899 (setq diff (- d2 d1))))
2901 (calendar-goto-today)
2902 (if (and diff (not arg)) (calendar-forward-day diff))))
2904 (defun org-date-from-calendar ()
2905 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
2906 If there is already a time stamp at the cursor position, update it."
2908 (org-timestamp-change 0 'calendar))
2910 ;;; Agenda, and Diary Integration
2914 (defvar org-agenda-mode-map (make-sparse-keymap)
2915 "Keymap for org-agenda-mode.")
2917 (defvar org-agenda-menu)
2918 (defvar org-agenda-follow-mode nil)
2919 (defvar org-agenda-buffer-name "*Org Agenda*")
2920 (defvar org-agenda-redo-command nil)
2923 (defun org-agenda-mode ()
2924 "Mode for time-sorted view on action items in Org-mode files.
2926 The following commands are available:
2928 \\{org-agenda-mode-map}"
2930 (kill-all-local-variables)
2931 (setq major-mode 'org-agenda-mode)
2932 (setq mode-name "Org-Agenda")
2933 (use-local-map org-agenda-mode-map)
2934 (easy-menu-add org-agenda-menu)
2935 (if org-startup-truncated (setq truncate-lines t))
2936 (add-hook 'post-command-hook 'org-agenda-post-command-hook nil 'local)
2937 (setq org-agenda-follow-mode nil)
2939 '("Agenda") "Agenda Files"
2942 ["Edit file list" (customize-variable 'org-agenda-files) t]
2944 (mapcar 'org-file-menu-entry org-agenda-files)))
2945 (org-agenda-set-mode-name)
2946 (run-hooks 'org-agenda-mode-hook))
2948 (define-key org-agenda-mode-map [(tab)] 'org-agenda-goto)
2949 (define-key org-agenda-mode-map [(return)] 'org-agenda-switch-to)
2950 (define-key org-agenda-mode-map " " 'org-agenda-show)
2951 (define-key org-agenda-mode-map "\C-c\C-t" 'org-agenda-todo)
2952 (define-key org-agenda-mode-map "o" 'delete-other-windows)
2953 (define-key org-agenda-mode-map "l" 'org-agenda-recenter)
2954 (define-key org-agenda-mode-map "t" 'org-agenda-todo)
2955 (define-key org-agenda-mode-map "." 'org-agenda-goto-today)
2956 (define-key org-agenda-mode-map "w" 'org-agenda-week-view)
2957 (define-key org-agenda-mode-map [(shift right)] 'org-agenda-date-later)
2958 (define-key org-agenda-mode-map [(shift left)] 'org-agenda-date-earlier)
2960 (define-key org-agenda-mode-map ">" 'org-agenda-date-today)
2961 (let ((l '(1 2 3 4 5 6 7 8 9 0)))
2962 (while l (define-key org-agenda-mode-map
2963 (int-to-string (pop l)) 'digit-argument)))
2965 (define-key org-agenda-mode-map "f" 'org-agenda-follow-mode)
2966 (define-key org-agenda-mode-map "d" 'org-agenda-toggle-diary)
2967 (define-key org-agenda-mode-map "r" 'org-agenda-redo)
2968 (define-key org-agenda-mode-map "q" 'org-agenda-quit)
2969 (define-key org-agenda-mode-map "x" 'org-agenda-exit)
2970 (define-key org-agenda-mode-map "P" 'org-agenda-show-priority)
2971 (define-key org-agenda-mode-map "p" 'org-agenda-priority)
2972 (define-key org-agenda-mode-map "," 'org-agenda-priority)
2973 (define-key org-agenda-mode-map "i" 'org-agenda-diary-entry)
2974 (define-key org-agenda-mode-map "c" 'org-agenda-goto-calendar)
2975 (define-key org-agenda-mode-map "C" 'org-agenda-convert-date)
2976 (define-key org-agenda-mode-map "m" 'org-agenda-phases-of-moon)
2977 (define-key org-agenda-mode-map "M" 'org-agenda-phases-of-moon)
2978 (define-key org-agenda-mode-map "s" 'org-agenda-sunrise-sunset)
2979 (define-key org-agenda-mode-map "S" 'org-agenda-sunrise-sunset)
2980 (define-key org-agenda-mode-map "h" 'org-agenda-holidays)
2981 (define-key org-agenda-mode-map "H" 'org-agenda-holidays)
2982 (define-key org-agenda-mode-map "+" 'org-agenda-priority-up)
2983 (define-key org-agenda-mode-map "-" 'org-agenda-priority-down)
2984 (define-key org-agenda-mode-map [(right)] 'org-agenda-later)
2985 (define-key org-agenda-mode-map [(left)] 'org-agenda-earlier)
2987 (defvar org-agenda-keymap (copy-keymap org-agenda-mode-map)
2988 "Local keymap for agenda entries from Org-mode.")
2990 (define-key org-agenda-keymap
2991 (if org-xemacs-p [(button2)] [(mouse-2)]) 'org-agenda-goto-mouse)
2992 (define-key org-agenda-keymap
2993 (if org-xemacs-p [(button3)] [(mouse-3)]) 'org-agenda-show-mouse)
2995 (easy-menu-define org-agenda-menu org-agenda-mode-map "Agenda menu"
2999 ["Show" org-agenda-show t]
3000 ["Go To (other window)" org-agenda-goto t]
3001 ["Go To (one window)" org-agenda-switch-to t]
3002 ["Follow Mode" org-agenda-follow-mode
3003 :style toggle :selected org-agenda-follow-mode :active t]
3005 ["Cycle TODO" org-agenda-todo t]
3007 ["Reschedule +1 day" org-agenda-date-later t]
3008 ["Reschedule -1 day" org-agenda-date-earlier t]
3010 ["Reschedule to today" org-agenda-date-today t])
3012 ["Set Priority" org-agenda-priority t]
3013 ["Increase Priority" org-agenda-priority-up t]
3014 ["Decrease Priority" org-agenda-priority-down t]
3015 ["Show Priority" org-agenda-show-priority t])
3017 ["Rebuild" org-agenda-redo t]
3018 ["Goto Today" org-agenda-goto-today t]
3019 ["Next Dates" org-agenda-later (local-variable-p 'starting-day)]
3020 ["Previous Dates" org-agenda-earlier (local-variable-p 'starting-day)]
3022 ["Week/Day View" org-agenda-week-view (local-variable-p 'starting-day)]
3023 ["Include Diary" org-agenda-toggle-diary
3024 :style toggle :selected org-agenda-include-diary :active t]
3026 ["New Diary Entry" org-agenda-diary-entry t]
3027 ("Calendar commands"
3028 ["Goto calendar" org-agenda-goto-calendar t]
3029 ["Phases of the Moon" org-agenda-phases-of-moon t]
3030 ["Sunrise/Sunset" org-agenda-sunrise-sunset t]
3031 ["Holidays" org-agenda-holidays t]
3032 ["Convert" org-agenda-convert-date t])
3034 ["Quit" org-agenda-quit t]
3035 ["Exit and Release Buffers" org-agenda-exit t]
3038 (defvar org-agenda-markers nil
3039 "List of all currently active markers created by org-agenda")
3040 (defvar org-agenda-last-marker-time (time-to-seconds (current-time))
3041 "Creation time of the last agenda marker.")
3043 (defun org-agenda-new-marker (pos)
3044 "Return a new agenda marker.
3045 Org-mode keeps a list of these markers and resets them when they are
3047 (let ((m (copy-marker pos)))
3048 (setq org-agenda-last-marker-time (time-to-seconds (current-time)))
3049 (push m org-agenda-markers)
3052 (defun org-agenda-maybe-reset-markers (&optional force)
3053 "Reset markers created by org-agenda. But only if they are old enough."
3055 (> (- (time-to-seconds (current-time))
3056 org-agenda-last-marker-time)
3058 (while org-agenda-markers
3059 (move-marker (pop org-agenda-markers) nil))))
3061 (defvar org-agenda-new-buffers nil
3062 "Buffers created to visit agenda files.")
3064 (defun org-get-agenda-file-buffer (file)
3065 "Get a buffer visiting FILE. If the buffer needs to be created, add
3066 it to the list of buffers which might be released later."
3067 (let ((buf (find-buffer-visiting file)))
3069 buf ; just return it
3070 ;; Make a new buffer and remember it
3071 (setq buf (find-file-noselect file))
3072 (if buf (push buf org-agenda-new-buffers))
3075 (defun org-release-buffers (blist)
3076 "Release all buffers in list, asking the user for confirmation when needed.
3077 When a buffer is unmodified, it is just killed. When modified, it is saved
3078 \(if the user agrees) and then killed."
3080 (while (setq buf (pop blist))
3081 (setq file (buffer-file-name buf))
3082 (when (and (buffer-modified-p buf)
3084 (y-or-n-p (format "Save file %s? " file)))
3086 (set-buffer buf) (save-buffer)))
3087 (kill-buffer buf))))
3089 (defun org-timeline (&optional include-all)
3090 "Show a time-sorted view of the entries in the current org file.
3091 Only entries with a time stamp of today or later will be listed. With
3092 one C-u prefix argument, also past entries will be listed.
3093 With two C-u prefixes, all unfinished TODO items will also be shown,
3094 under the current date.
3095 If the buffer contains an active region, only check the region for
3099 (org-agenda-maybe-reset-markers 'force)
3100 (let* ((dopast include-all)
3101 (dotodo (equal include-all '(16)))
3102 (entry (buffer-file-name))
3103 (org-agenda-files (list (buffer-file-name)))
3104 (date (calendar-current-date))
3105 (win (selected-window))
3107 (beg (if (org-region-active-p) (region-beginning) (point-min)))
3108 (end (if (org-region-active-p) (region-end) (point-max)))
3109 (day-numbers (org-get-all-dates beg end 'no-ranges
3110 t)) ; always include today
3111 (today (time-to-days (current-time)))
3112 (org-respect-restriction t)
3115 (setq org-agenda-redo-command
3117 (list 'switch-to-buffer-other-window (current-buffer))
3118 (list 'org-timeline include-all)))
3120 ;; Remove past dates from the list of dates.
3121 (setq day-numbers (delq nil (mapcar (lambda(x)
3122 (if (>= x today) x nil))
3124 (switch-to-buffer-other-window
3125 (get-buffer-create org-agenda-buffer-name))
3126 (setq buffer-read-only nil)
3128 (org-agenda-mode) (setq buffer-read-only nil)
3129 (while (setq d (pop day-numbers))
3130 (if (and (>= d today)
3135 (insert (make-string 79 ?-) "\n")))
3136 (setq date (calendar-gregorian-from-absolute d))
3139 (setq rtn (org-agenda-get-day-entries
3140 entry date :todo :timestamp))
3141 (setq rtn (org-agenda-get-day-entries entry date :timestamp)))
3142 (if (or rtn (equal d today))
3144 (insert (calendar-day-name date) " "
3145 (number-to-string (extract-calendar-day date)) " "
3146 (calendar-month-name (extract-calendar-month date)) " "
3147 (number-to-string (extract-calendar-year date)) "\n")
3148 (put-text-property s (1- (point)) 'face
3151 (put-text-property s (1- (point)) 'org-today t))
3152 (insert (org-finalize-agenda-entries rtn) "\n")
3153 (put-text-property s (1- (point)) 'day d))))
3154 (goto-char (point-min))
3155 (setq buffer-read-only t)
3156 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3158 (when (not org-select-timeline-window)
3163 (defun org-agenda (&optional include-all start-day ndays)
3164 "Produce a weekly view from all files in variable `org-agenda-files'.
3165 The view will be for the current week, but from the overview buffer you
3166 will be able to go to other weeks.
3167 With one C-u prefix argument INCLUDE-ALL, all unfinished TODO items will
3168 also be shown, under the current date.
3169 START-DAY defaults to TODAY, or to the most recent match for the weekday
3170 given in `org-agenda-start-on-weekday'.
3171 NDAYS defaults to `org-agenda-ndays'."
3173 (org-agenda-maybe-reset-markers 'force)
3175 (let* ((org-agenda-start-on-weekday
3176 (if (or (equal ndays 1)
3177 (and (null ndays) (equal 1 org-agenda-ndays)))
3178 nil org-agenda-start-on-weekday))
3179 (files (copy-sequence org-agenda-files))
3180 (win (selected-window))
3181 (today (time-to-days (current-time)))
3182 (sd (or start-day today))
3183 (start (if (or (null org-agenda-start-on-weekday)
3184 (< org-agenda-ndays 7))
3186 (let* ((nt (calendar-day-of-week
3187 (calendar-gregorian-from-absolute sd)))
3188 (n1 org-agenda-start-on-weekday)
3190 (- sd (+ (if (< d 0) 7 0) d)))))
3191 (day-numbers (list start))
3192 s e rtn rtnall file date d start-pos end-pos)
3193 (setq org-agenda-redo-command
3194 (list 'org-agenda include-all start-day ndays))
3195 ;; Make the list of days
3196 (setq ndays (or ndays org-agenda-ndays))
3198 (push (1+ (car day-numbers)) day-numbers)
3199 (setq ndays (1- ndays)))
3200 (setq day-numbers (nreverse day-numbers))
3201 (if (not (equal (current-buffer) (get-buffer org-agenda-buffer-name)))
3203 (delete-other-windows)
3204 (switch-to-buffer-other-window
3205 (get-buffer-create org-agenda-buffer-name))))
3206 (setq buffer-read-only nil)
3208 (org-agenda-mode) (setq buffer-read-only nil)
3209 (set (make-local-variable 'starting-day) (car day-numbers))
3210 (set (make-local-variable 'include-all-loc) include-all)
3211 (when (and (or include-all org-agenda-include-all-todo)
3212 (member today day-numbers))
3213 (setq files org-agenda-files
3215 (while (setq file (pop files))
3217 (org-check-agenda-file file)
3218 (setq date (calendar-gregorian-from-absolute today)
3219 rtn (org-agenda-get-day-entries
3221 (setq rtnall (append rtnall rtn))))
3222 (if rtnall (insert (org-finalize-agenda-entries rtnall) "\n")))
3223 (while (setq d (pop day-numbers))
3224 (setq date (calendar-gregorian-from-absolute d)
3227 (and (not start-pos) (= d sd)))
3228 (setq start-pos (point))
3229 (if (and start-pos (not end-pos))
3230 (setq end-pos (point))))
3231 (setq files org-agenda-files
3233 (while (setq file (pop files))
3235 (org-check-agenda-file file)
3236 (setq rtn (org-agenda-get-day-entries file date))
3237 (setq rtnall (append rtnall rtn))))
3238 (if org-agenda-include-diary
3241 (require 'diary-lib)
3242 (setq rtn (org-get-entries-from-diary date))
3243 (setq rtnall (append rtnall rtn))))
3244 (if (or rtnall org-agenda-show-all-dates)
3246 (insert (format "%-9s %2d %-9s %4d\n"
3247 (calendar-day-name date)
3248 (extract-calendar-day date)
3249 (calendar-month-name (extract-calendar-month date))
3250 (extract-calendar-year date)))
3251 (put-text-property s (1- (point)) 'face
3253 (if rtnall (insert (org-finalize-agenda-entries rtnall) "\n"))
3254 (put-text-property s (1- (point)) 'day d))))
3255 (goto-char (point-min))
3256 (setq buffer-read-only t)
3257 (if org-fit-agenda-window
3258 (fit-window-to-buffer nil (/ (* (frame-height) 3) 4)
3259 (/ (frame-height) 2)))
3260 (unless (and (pos-visible-in-window-p (point-min))
3261 (pos-visible-in-window-p (point-max)))
3262 (goto-char (1- (point-max)))
3264 (if (not (pos-visible-in-window-p (or start-pos 1)))
3266 (goto-char (or start-pos 1))
3268 (goto-char (or start-pos 1))
3269 (if (not org-select-agenda-window) (select-window win))
3272 (defun org-check-agenda-file (file)
3273 "Make sure FILE exists. If not, ask user what to do."
3274 ;; FIXME: this does not correctly change the menus
3275 ;; Could probably be fixed by explicitly going to the buffer.
3276 (when (not (file-exists-p file))
3277 (message "non-existent file %s. [R]emove from agenda-files or [A]bort?"
3279 (let ((r (downcase (read-char-exclusive))))
3282 (org-remove-file file)
3283 (throw 'nextfile t))
3284 (t (error "Abort"))))))
3286 (defun org-agenda-quit (arg)
3287 "Exit agenda by removing the window or the buffer."
3289 (let ((buf (current-buffer)))
3290 (if (not (one-window-p)) (delete-window))
3292 (org-agenda-maybe-reset-markers 'force)))
3294 (defun org-agenda-exit (arg)
3295 "Exit agenda by removing the window or the buffer.
3296 Also kill all Org-mode buffers which have be loaded by `org-agenda'.
3297 Org-mode buffers visitied directly by the user will no be touched."
3299 (org-release-buffers org-agenda-new-buffers)
3300 (setq org-agenda-new-buffers nil)
3301 (org-agenda-quit arg))
3303 (defun org-agenda-redo (&optional arg)
3306 (eval org-agenda-redo-command))
3308 (defun org-agenda-goto-today (arg)
3311 (if (boundp 'starting-day)
3312 (let ((cmd (car org-agenda-redo-command))
3313 (iall (nth 1 org-agenda-redo-command))
3314 (nday (nth 3 org-agenda-redo-command)))
3315 (eval (list cmd iall nil nday)))
3316 (goto-char (or (text-property-any (point-min) (point-max) 'org-today t)
3319 (defun org-agenda-later (arg)
3320 "Go forward in time by `org-agenda-ndays' days.
3321 With prefix ARG, go forward that many times `org-agenda-ndays'."
3323 (unless (boundp 'starting-day)
3324 (error "Not allowed"))
3325 (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
3326 (+ starting-day (* arg org-agenda-ndays))))
3328 (defun org-agenda-earlier (arg)
3329 "Go back in time by `org-agenda-ndays' days.
3330 With prefix ARG, go back that many times `org-agenda-ndays'."
3332 (unless (boundp 'starting-day)
3333 (error "Not allowed"))
3334 (org-agenda (if (boundp 'include-all-loc) include-all-loc nil)
3335 (- starting-day (* arg org-agenda-ndays))))
3337 (defun org-agenda-day-view (arg)
3338 "Switch agenda to single day view."
3340 (unless (boundp 'starting-day)
3341 (error "Not allowed"))
3342 (setq org-agenda-ndays 1)
3343 (org-agenda include-all-loc starting-day 1))
3345 (defun org-agenda-week-view (arg)
3346 "Switch agenda to week view."
3348 (unless (boundp 'starting-day)
3349 (error "Not allowed"))
3350 (setq org-agenda-ndays
3351 (if (equal org-agenda-ndays 1) 7 1))
3352 (org-agenda include-all-loc
3353 (or (get-text-property (point) 'day)
3355 (org-agenda-set-mode-name)
3356 (message "Switched to %s view"
3357 (if (equal org-agenda-ndays 1) "day" "week")))
3359 (defun org-agenda-follow-mode ()
3360 "Toggle follow mode in an agenda buffer."
3362 (setq org-agenda-follow-mode (not org-agenda-follow-mode))
3363 (org-agenda-set-mode-name)
3364 (message "Follow mode is %s"
3365 (if org-agenda-follow-mode "on" "off")))
3367 (defun org-agenda-toggle-diary ()
3368 "Toggle follow mode in an agenda buffer."
3370 (setq org-agenda-include-diary (not org-agenda-include-diary))
3372 (org-agenda-set-mode-name)
3373 (message "Diary inclusion turned %s"
3374 (if org-agenda-include-diary "on" "off")))
3376 (defun org-agenda-set-mode-name ()
3377 "Set the mode name to indicate all the small mode seetings."
3379 (concat "Org-Agenda"
3380 (if (equal org-agenda-ndays 1) " Day" "")
3381 (if (equal org-agenda-ndays 7) " Week" "")
3382 (if org-agenda-follow-mode " Follow" "")
3383 (if org-agenda-include-diary " Diary" "")))
3384 (force-mode-line-update))
3386 (defun org-agenda-post-command-hook ()
3387 (if (and org-agenda-follow-mode
3388 (get-text-property (point) 'org-marker))
3391 (defun org-get-entries-from-diary (date)
3392 "Get the (emacs calendar) diary entries for DATE."
3393 (let* ((fancy-diary-buffer "*temporary-fancy-diary-buffer*")
3394 (diary-display-hook '(fancy-diary-display))
3395 (list-diary-entries-hook
3396 (cons 'org-diary-default-entry list-diary-entries-hook))
3398 (disable-org-diary t))
3400 (save-window-excursion
3401 (list-diary-entries date 1)))
3402 (if (not (get-buffer fancy-diary-buffer))
3405 (switch-to-buffer fancy-diary-buffer)
3406 (setq buffer-read-only nil)
3407 (if (= (point-max) 1)
3410 ;; Omit the date and other unnecessary stuff
3411 (org-agenda-cleanup-fancy-diary)
3412 ;; Add prefix to each line and extend the text properties
3413 (goto-char (point-min))
3414 (while (and (re-search-forward "^" nil t) (not (eobp)))
3415 (replace-match " Diary: ")
3416 (add-text-properties (point-at-bol) (point)
3417 (text-properties-at (point))))
3418 (if (= (point-max) 1)
3420 (setq entries (buffer-substring (point-min) (- (point-max) 1)))))
3421 (set-buffer-modified-p nil)
3422 (kill-buffer fancy-diary-buffer)))
3424 (setq entries (org-split-string entries "\n"))
3428 (if (string-match "\\<\\([012][0-9]\\):\\([0-6][0-9]\\)" x)
3429 (add-text-properties
3432 (+ (* 100 (string-to-number
3433 (match-string 1 x)))
3434 (string-to-number (match-string 2 x))))
3439 (defun org-agenda-cleanup-fancy-diary ()
3440 "Remove unwanted stuff in buffer created by fancy-diary-display.
3441 This gets rid of the date, the underline under the date, and
3442 the dummy entry installed by org-mode to ensure non-empty diary for each
3444 (goto-char (point-min))
3445 (if (looking-at ".*?:[ \t]*")
3448 (re-search-forward "\n=+$" nil t)
3450 (while (re-search-backward "^ +" nil t) (replace-match "")))
3451 (re-search-forward "\n=+$" nil t)
3452 (delete-region (point-min) (min (point-max) (1+ (match-end 0)))))
3453 (if (re-search-forward "^Org-mode dummy\n?" nil t)
3454 (replace-match "")))
3456 ;; Advise the add-to-diary-list function to allow org to jump to
3457 ;; diary entires. Wrapped into eval-after-load to avoid loading
3458 ;; advice unnecessarily
3459 (eval-after-load "diary-lib"
3460 '(defadvice add-to-diary-list (before org-mark-diary-entry activate)
3461 "Make the position visible."
3462 (if (and (boundp 'disable-org-diary) ;; called from org-agenda
3465 (add-text-properties
3467 (list 'mouse-face 'highlight
3468 'keymap org-agenda-keymap
3471 "mouse-2 or RET jump to diary file %s"
3472 (abbreviate-file-name (buffer-file-name)))
3473 'org-agenda-diary-link t
3474 'org-marker (org-agenda-new-marker (point-at-bol)))
3477 (defun org-diary-default-entry ()
3478 "Add a dummy entry to the diary.
3479 Needed to avoid empty dates which mess up holiday display."
3480 (add-to-diary-list original-date "Org-mode dummy" "" nil))
3482 (defun org-add-file (&optional file)
3483 "Add current file to the list of files in variable `org-agenda-files'.
3484 These are the files which are being checked for agenda entries.
3485 Optional argument FILE means, use this file instead of the current.
3486 It is possible (but not recommended) to add this function to the
3490 (let* ((file (or file (buffer-file-name)
3492 (error "Buffer is not visiting a file")
3493 (throw 'exit nil))))
3494 (true-file (file-truename file))
3495 (afile (abbreviate-file-name file))
3496 (present (delq nil (mapcar
3498 (equal true-file (file-truename x)))
3499 org-agenda-files))))
3502 (setq org-agenda-files
3503 (cons afile org-agenda-files))
3504 ;; Make sure custom.el does not end up with Org-mode
3505 (let ((org-mode-hook nil) (default-major-mode 'fundamental-mode))
3506 (customize-save-variable 'org-agenda-files org-agenda-files))
3507 (org-install-agenda-files-menu)
3508 (message "Added file: %s" afile))
3509 (message "File was already in list: %s" afile)))))
3511 (defun org-remove-file (&optional file)
3512 "Remove current file from the list of files in variable `org-agenda-files'.
3513 These are the files which are being checked for agenda entries.
3514 Optional argument FILE means, use this file instead of the current."
3516 (let* ((file (or file (buffer-file-name)))
3517 (true-file (file-truename file))
3518 (afile (abbreviate-file-name file))
3519 (files (delq nil (mapcar
3521 (if (equal true-file
3524 org-agenda-files))))
3525 (if (not (= (length files) (length org-agenda-files)))
3527 (setq org-agenda-files files)
3528 (customize-save-variable 'org-agenda-files org-agenda-files)
3529 (org-install-agenda-files-menu)
3530 (message "Removed file: %s" afile))
3531 (message "File was not in list: %s" afile))))
3533 (defun org-file-menu-entry (file)
3534 (vector file (list 'find-file file) t))
3536 (defun org-get-all-dates (beg end &optional no-ranges force-today)
3537 "Return a list of all relevant day numbers from BEG to END buffer positions.
3538 If NO-RANGES is non-nil, include only the start and end dates of a range,
3539 not every single day in the range. If FORCE-TODAY is non-nil, make
3540 sure that TODAY is included in the list."
3541 (let (dates date day day1 day2 ts1 ts2)
3543 (setq dates (list (time-to-days (current-time)))))
3546 (while (re-search-forward org-ts-regexp end t)
3547 (setq day (time-to-days (org-time-string-to-time
3548 (substring (match-string 1) 0 10))))
3549 (or (memq day dates) (push day dates)))
3552 (while (re-search-forward org-tr-regexp end t)
3553 (setq ts1 (substring (match-string 1) 0 10)
3554 ts2 (substring (match-string 2) 0 10)
3555 day1 (time-to-days (org-time-string-to-time ts1))
3556 day2 (time-to-days (org-time-string-to-time ts2)))
3557 (while (< (setq day1 (1+ day1)) day2)
3558 (or (memq day1 dates) (push day1 dates)))))
3562 (defun org-diary (&rest args)
3563 "Returns diary information from org-files.
3564 This function can be used in an \"sexp\" diary entry in the Emacs calendar.
3565 It accesses org files and extracts information from those files to be
3566 listed in the diary. The function accepts arguments specifying what
3567 items should be listed. The following arguments are allowed:
3569 :timestamp List the headlines of items containing a date stamp or
3570 date range matching the selected date. Deadlines will
3571 also be listed, on the expiration day.
3573 :deadline List any deadlines past due, or due within
3574 `org-deadline-warning-days'. The listing occurs only
3575 in the diary for *today*, not at any other date. If
3576 an entry is marked DONE, it is no longer listed.
3578 :scheduled List all items which are scheduled for the given date.
3579 The diary for *today* also contains items which were
3580 scheduled earlier and are not yet marked DONE.
3582 :todo List all TODO items from the org-file. This may be a
3583 long list - so this is not turned on by default.
3584 Like deadlines, these entires only show up in the
3585 diary for *today*, not at any other date.
3587 The call in the diary file should look like this:
3589 &%%(org-diary) ~/path/to/some/orgfile.org
3591 Use a separate line for each org file to check. Or, if you omit the file name,
3592 all files listed in `org-agenda-files' will be checked automatically:
3596 If you don't give any arguments (as in the example above), the default
3597 arguments (:deadline :scheduled :timestamp) are used. So the example above may
3600 &%%(org-diary :deadline :timestamp :scheduled)
3602 The function expects the lisp variables `entry' and `date' to be provided
3603 by the caller, because this is how the calendar works. Don't use this
3604 function from a program - use `org-agenda-get-day-entries' instead."
3605 (org-agenda-maybe-reset-markers)
3606 (setq args (or args '(:deadline :scheduled :timestamp)))
3607 (let* ((files (if (and entry (stringp entry) (string-match "\\S-" entry))
3611 ;; If this is called during org-agenda, don't return any entries to
3612 ;; the calendar. Org Agenda will list these entries itself.
3613 (if (boundp 'disable-org-diary) (setq files nil))
3614 (while (setq file (pop files))
3615 (setq rtn (apply 'org-agenda-get-day-entries file date args))
3616 (setq results (append results rtn)))
3617 (concat (org-finalize-agenda-entries results) "\n")))
3619 (defun org-agenda-get-day-entries (file date &rest args)
3620 "Does the work for `org-diary' and `org-agenda'
3621 FILE is the path to a file to be checked for entries. DATE is date like
3622 the one returned by `calendar-current-date'. ARGS are symbols indicating
3623 which kind of entries should be extracted. For details about these, see
3624 the documentation of `org-diary'."
3625 (setq args (or args '(:deadline :scheduled :timestamp)))
3626 (let* ((org-startup-with-deadline-check nil)
3627 (org-startup-folded nil)
3628 (buffer (if (file-exists-p file)
3629 ; (find-file-noselect file)
3630 (org-get-agenda-file-buffer file)
3631 (error "No such file %s" file)))
3632 (respect-narrow-p (boundp 'org-respect-restriction))
3635 ;; If file does not exist, make sure an error message ends up in diary
3636 (format "ORG-AGENDA-ERROR: No such org-file %s" file)
3639 (let ((case-fold-search nil))
3642 (if respect-narrow-p
3643 (if (org-region-active-p)
3644 ;; Respect a region to restrict search
3645 (narrow-to-region (region-beginning) (region-end)))
3646 ;; If we work for the calendar or many files,
3647 ;; get rid of any restriction
3649 (while (setq arg (pop args))
3651 ((and (eq arg :todo)
3652 (equal date (calendar-current-date)))
3653 (setq rtn (org-agenda-get-todos))
3654 (setq results (append results rtn)))
3655 ((eq arg :timestamp)
3656 (setq rtn (org-agenda-get-blocks))
3657 (setq results (append results rtn))
3658 (setq rtn (org-agenda-get-timestamps))
3659 (setq results (append results rtn)))
3660 ((eq arg :scheduled)
3661 (setq rtn (org-agenda-get-scheduled))
3662 (setq results (append results rtn)))
3663 ((and (eq arg :deadline)
3664 (equal date (calendar-current-date)))
3665 (setq rtn (org-agenda-get-deadlines))
3666 (setq results (append results rtn))))))))))
3669 (defun org-entry-is-done-p ()
3670 "Is the current entry marked DONE?"
3672 (and (re-search-backward "[\r\n]\\*" nil t)
3673 (looking-at orb-nl-done-regexp))))
3675 (defun org-at-date-range-p ()
3676 "It the cursor inside a date range?"
3680 (let ((pos (point)))
3681 (skip-chars-backward "^<\r\n")
3682 (skip-chars-backward "<")
3683 (and (looking-at org-tr-regexp)
3684 (>= (match-end 0) pos)
3686 (skip-chars-backward "^<\r\n")
3687 (skip-chars-backward "<")
3688 (and (looking-at org-tr-regexp)
3689 (>= (match-end 0) pos)
3693 (defun org-agenda-get-todos ()
3694 "Return the TODO information for agenda display."
3695 (let* ((props (list 'face nil
3696 'mouse-face 'highlight
3697 'keymap org-agenda-keymap
3699 (format "mouse-2 or RET jump to org file %s"
3700 (abbreviate-file-name (buffer-file-name)))))
3701 (regexp (concat "[\n\r]\\*+ *\\(" org-not-done-regexp
3705 (goto-char (point-min))
3706 (while (re-search-forward regexp nil t)
3707 (goto-char (match-beginning 1))
3708 (setq marker (org-agenda-new-marker (point))
3709 txt (org-format-agenda-item "" (match-string 1))
3711 (+ (org-get-priority txt)
3712 (if org-todo-kwd-priority-p
3713 (- org-todo-kwd-max-priority -2
3715 (member (match-string 2) org-todo-keywords)))
3717 (add-text-properties
3718 0 (length txt) (append (list 'org-marker marker 'priority priority)
3722 (goto-char (match-end 1)))
3725 (defconst org-agenda-no-heading-message
3726 "No heading for this item in buffer or region")
3728 (defun org-agenda-get-timestamps ()
3729 "Return the date stamp information for agenda display."
3730 (let* ((props (list 'face nil
3731 'mouse-face 'highlight
3732 'keymap org-agenda-keymap
3734 (format "mouse-2 or RET jump to org file %s"
3735 (abbreviate-file-name (buffer-file-name)))))
3736 (regexp (regexp-quote
3739 (car org-time-stamp-formats)
3740 (apply 'encode-time ; DATE bound by calendar
3741 (list 0 0 0 (nth 1 date) (car date) (nth 2 date))))
3743 marker deadlinep scheduledp tmp priority
3745 (goto-char (point-min))
3746 (while (re-search-forward regexp nil t)
3747 (if (not (save-match-data (org-at-date-range-p)))
3749 (setq marker (org-agenda-new-marker (point))
3750 tmp (buffer-substring (max (point-min)
3751 (- (match-beginning 0)
3752 org-ds-keyword-length))
3753 (match-beginning 0))
3754 deadlinep (string-match org-deadline-regexp tmp)
3755 scheduledp (string-match org-scheduled-regexp tmp))
3757 (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
3759 (goto-char (match-end 1))
3760 (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
3761 (setq txt (org-format-agenda-item
3763 (if deadlinep "Deadline: " "")
3764 (if scheduledp "Scheduled: " ""))
3766 (setq txt org-agenda-no-heading-message))
3767 (setq priority (org-get-priority txt))
3768 (add-text-properties
3769 0 (length txt) (append (list 'org-marker marker) props)
3772 (add-text-properties
3774 (list 'face 'org-warning-face
3775 'priority (+ 100 priority))
3778 (add-text-properties
3780 (list 'face 'org-scheduled-today-face
3781 priority (+ 99 priority))
3783 (add-text-properties
3785 (list 'priority priority) txt)))
3787 (outline-next-heading))))
3790 (defun org-agenda-get-deadlines ()
3791 "Return the deadline information for agenda display."
3792 (let* ((wdays org-deadline-warning-days)
3793 (props (list 'face nil
3794 'mouse-face 'highlight
3795 'keymap org-agenda-keymap
3797 (format "mouse-2 or RET jump to org file %s"
3798 (abbreviate-file-name (buffer-file-name)))))
3799 (regexp org-deadline-time-regexp)
3800 (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
3801 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
3804 (goto-char (point-min))
3805 (while (re-search-forward regexp nil t)
3806 (setq d2 (time-to-days
3807 (org-time-string-to-time (match-string 1)))
3810 ;; When to show a deadline in the calendar:
3811 ;; If the expiration is within wdays warning time.
3812 ;; Past-due deadlines are only shown on the current date
3813 (if (and (< diff wdays) todayp (not (= diff 0)))
3815 (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
3817 (goto-char (match-end 0))
3818 (setq head (buffer-substring-no-properties
3820 (progn (skip-chars-forward "^\r\n")
3822 (if (string-match org-looking-at-done-regexp head)
3824 (setq txt (org-format-agenda-item
3825 (format "In %3d d.: " diff) head))))
3826 (setq txt org-agenda-no-heading-message))
3828 (add-text-properties
3831 (list 'org-marker (org-agenda-new-marker pos)
3832 'priority (+ (- 10 diff) (org-get-priority txt))
3833 'face (cond ((<= diff 0) 'org-warning-face)
3834 ((<= diff 5) 'font-lock-function-name-face)
3841 (defun org-agenda-get-scheduled ()
3842 "Return the scheduled information for agenda display."
3843 (let* ((props (list 'face 'org-scheduled-previously-face
3844 'mouse-face 'highlight
3845 'keymap org-agenda-keymap
3847 (format "mouse-2 or RET jump to org file %s"
3848 (abbreviate-file-name (buffer-file-name)))))
3849 (regexp org-scheduled-time-regexp)
3850 (todayp (equal date (calendar-current-date))) ; DATE bound by calendar
3851 (d1 (calendar-absolute-from-gregorian date)) ; DATE bound by calendar
3854 (goto-char (point-min))
3855 (while (re-search-forward regexp nil t)
3856 (setq d2 (time-to-days
3857 (org-time-string-to-time (match-string 1)))
3860 ;; When to show a scheduled item in the calendar:
3861 ;; If it is on or past the date.
3862 (if (and (< diff 0) todayp)
3864 (if (re-search-backward "\\(^\\|\r\\)\\*+[ \t]*" nil t)
3866 (goto-char (match-end 0))
3867 (setq head (buffer-substring-no-properties
3869 (progn (skip-chars-forward "^\r\n") (point))))
3870 (if (string-match org-looking-at-done-regexp head)
3872 (setq txt (org-format-agenda-item
3873 (format "Sched.%2dx: " (- 1 diff)) head))))
3874 (setq txt org-agenda-no-heading-message))
3876 (setq marker (org-agenda-new-marker pos))
3877 (add-text-properties
3879 (append (list 'org-marker marker
3880 'priority (+ (- 5 diff) (org-get-priority txt)))
3885 (defun org-agenda-get-blocks ()
3886 "Return the date-range information for agenda display."
3887 (let* ((props (list 'face nil
3888 'mouse-face 'highlight
3889 'keymap org-agenda-keymap
3891 (format "mouse-2 or RET jump to org file %s"
3892 (abbreviate-file-name (buffer-file-name)))))
3893 (regexp org-tr-regexp)
3894 (d0 (calendar-absolute-from-gregorian date))
3895 marker ee txt d1 d2 s1 s2)
3896 (goto-char (point-min))
3897 (while (re-search-forward regexp nil t)
3898 (setq s1 (match-string 1)
3900 d1 (time-to-days (org-time-string-to-time s1))
3901 d2 (time-to-days (org-time-string-to-time s2)))
3902 (if (and (> (- d0 d1) -1) (> (- d2 d0) -1))
3903 ;; Only allow days between the limits, because the normal
3904 ;; date stamps will catch the limits.
3906 (setq marker (org-agenda-new-marker (point)))
3907 (if (re-search-backward "\\(^\\|\r\\)\\*+" nil t)
3909 (goto-char (match-end 1))
3910 (looking-at "\\*+[ \t]*\\([^\r\n]+\\)")
3911 (setq txt (org-format-agenda-item
3913 (1+ (- d0 d1)) (1+ (- d2 d1)))
3915 (setq txt org-agenda-no-heading-message))
3916 (add-text-properties
3917 0 (length txt) (append (list 'org-marker marker
3918 'priority (org-get-priority txt))
3922 (outline-next-heading))
3923 ;; Sort the entries by expiration date.
3927 (defun org-format-agenda-item (prefix txt)
3928 "Format TXT to be inserted into the agenda buffer.
3929 In particular, this indents the lins and adds a category."
3930 (let ((cat (or org-category
3931 (file-name-sans-extension
3932 (file-name-nondirectory (buffer-file-name)))))
3934 (if (symbolp cat) (setq cat (symbol-name cat)))
3935 (setq rtn (format " %-10s %s%s" (concat cat ":") prefix txt))
3936 (add-text-properties
3937 0 2 (list 'category (downcase cat)
3938 'prefix-length (- (length rtn) (length txt))
3939 'time-of-day (org-get-time-of-day rtn))
3943 ;; FIXME: Should this be restricted to beginning of string?
3944 (defun org-get-time-of-day (s)
3945 "Check string S for a time of day."
3949 "\\<\\([012][0-9]\\)\\(:\\([0-6][0-9]\\)\\)?\\([AaPp][Mm]\\)?\\>" s)
3950 (or (match-beginning 2) (match-beginning 4)))
3951 (+ (* 100 (+ (string-to-number (match-string 1 s))
3952 (if (and (match-beginning 4)
3953 (equal (downcase (match-string 4 s)) "pm"))
3955 (if (match-beginning 3)
3956 (string-to-number (match-string 3 s))
3959 (defun org-finalize-agenda-entries (list)
3960 "Sort and concatenate the agenda items."
3961 (mapconcat 'identity (sort list 'org-entries-lessp) "\n"))
3963 (defsubst org-cmp-priority (a b)
3964 "Compare the priorities of string a and b."
3965 (let ((pa (or (get-text-property 1 'priority a) 0))
3966 (pb (or (get-text-property 1 'priority b) 0)))
3967 (cond ((> pa pb) +1)
3971 (defsubst org-cmp-category (a b)
3972 "Compare the string values of categories of strings a and b."
3973 (let ((ca (or (get-text-property 1 'category a) ""))
3974 (cb (or (get-text-property 1 'category b) "")))
3975 (cond ((string-lessp ca cb) -1)
3976 ((string-lessp cb ca) +1)
3979 (defsubst org-cmp-time (a b)
3980 "Compare the time-of-day values of strings a and b."
3981 (let* ((def (if org-sort-agenda-notime-is-late 2401 -1))
3982 (ta (or (get-text-property 1 'time-of-day a) def))
3983 (tb (or (get-text-property 1 'time-of-day b) def)))
3984 (cond ((< ta tb) -1)
3988 (defun org-entries-lessp (a b)
3989 "Predicate for sorting agenda entries."
3990 (let* ((time-up (org-cmp-time a b))
3991 (time-down (if time-up (- time-up) nil))
3992 (priority-up (org-cmp-priority a b))
3993 (priority-down (if priority-up (- priority-up) nil))
3994 (category-up (org-cmp-category a b))
3995 (category-down (if category-up (- category-up) nil))
3996 (category-keep (if category-up +1 nil))) ; FIXME +1 or -1?
3998 (eval (cons 'or org-agenda-sorting-strategy))
3999 '((-1 . t) (1 . nil) (nil . nil))))))
4001 (defun org-agenda-show-priority ()
4002 "Show the priority of the current item.
4003 This priority is composed of the main priority given with the [#A] cookies,
4004 and by additional input from the age of a schedules or deadline entry."
4006 (let* ((pri (get-text-property (point-at-bol) 'priority)))
4007 (message "Priority is %d" (if pri pri -1000))))
4009 (defun org-agenda-goto ()
4010 "Go to the Org-mode file which contains the item at point."
4012 (let* ((marker (or (get-text-property (point) 'org-marker)
4013 (org-agenda-error)))
4014 (buffer (marker-buffer marker))
4015 (pos (marker-position marker)))
4016 (switch-to-buffer-other-window buffer)
4019 (when (eq major-mode 'org-mode)
4020 (org-show-hidden-entry)
4022 (and (outline-next-heading)
4023 (org-flag-heading nil)))))) ; show the next heading
4025 (defun org-agenda-switch-to ()
4026 "Go to the Org-mode file which contains the item at point."
4028 (let* ((marker (or (get-text-property (point) 'org-marker)
4029 (org-agenda-error)))
4030 (buffer (marker-buffer marker))
4031 (pos (marker-position marker)))
4032 (switch-to-buffer buffer)
4033 (delete-other-windows)
4036 (when (eq major-mode 'org-mode)
4037 (org-show-hidden-entry)
4039 (and (outline-next-heading)
4040 (org-flag-heading nil)))))) ; show the next heading
4042 (defun org-agenda-goto-mouse (ev)
4043 "Go to the Org-mode file which contains the deadline at the mouse click."
4045 (mouse-set-point ev)
4048 (defun org-agenda-show ()
4049 "Display the Org-mode file which contains the item at point."
4051 (let ((win (selected-window)))
4053 (select-window win)))
4055 (defun org-agenda-recenter (arg)
4056 "Display the Org-mode file which contains the item at point and recenter."
4058 (let ((win (selected-window)))
4061 (select-window win)))
4063 (defun org-agenda-show-mouse (ev)
4064 "Display the Org-mode file which contains the deadline at the mouse click."
4066 (mouse-set-point ev)
4069 (defun org-agenda-check-no-diary ()
4070 "Check if the entry is a diary link and abort if yes."
4071 (if (get-text-property (point) 'org-agenda-diary-link)
4072 (org-agenda-error)))
4074 (defun org-agenda-error ()
4075 (error "Command not allowed in this line."))
4077 (defun org-agenda-todo ()
4078 "Cycle TODO state of line at point, also in Org-mode file."
4080 (org-agenda-check-no-diary)
4081 (let* ((props (text-properties-at (point)))
4082 (col (current-column))
4083 (marker (or (get-text-property (point) 'org-marker)
4084 (org-agenda-error)))
4085 (pl (get-text-property (point-at-bol) 'prefix-length))
4086 (buffer (marker-buffer marker))
4087 (pos (marker-position marker))
4088 (buffer-read-only nil)
4094 (org-show-hidden-entry)
4096 (and (outline-next-heading)
4097 (org-flag-heading nil))) ; show the next heading
4099 (setq newhead (org-get-heading)))
4100 (beginning-of-line 1)
4102 (if (looking-at ".*")
4104 (replace-match newhead t t)
4105 (move-to-column col)
4106 (add-text-properties (point-at-bol) (point-at-eol) props)
4107 (beginning-of-line 1))
4108 (error "Line update did not work"))))
4110 (defun org-agenda-priority-up ()
4111 "Increase the priority of line at point, also in Org-mode file."
4113 (org-agenda-priority 'up))
4115 (defun org-agenda-priority-down ()
4116 "Decrease the priority of line at point, also in Org-mode file."
4118 (org-agenda-priority 'down))
4120 (defun org-agenda-priority (&optional force-direction)
4121 "Set the priority of line at point, also in Org-mode file."
4123 (org-agenda-check-no-diary)
4124 (let* ((props (text-properties-at (point)))
4125 (col (current-column))
4126 (marker (or (get-text-property (point) 'org-marker)
4127 (org-agenda-error)))
4128 (pl (get-text-property (point-at-bol) 'prefix-length))
4129 (buffer (marker-buffer marker))
4130 (pos (marker-position marker))
4131 (buffer-read-only nil)
4137 (org-show-hidden-entry)
4139 (and (outline-next-heading)
4140 (org-flag-heading nil))) ; show the next heading
4141 (funcall 'org-priority force-direction)
4142 (setq newhead (org-get-heading)))
4143 (beginning-of-line 1)
4145 (if (looking-at ".*")
4147 (replace-match (concat newhead) t t)
4148 (move-to-column col)
4149 (add-text-properties (point-at-bol) (point-at-eol) props)
4150 (beginning-of-line 1))
4151 (error "Line update did not work"))))
4153 (defun org-agenda-date-later (arg &optional what)
4154 "Change the date of this item to one day later."
4156 (org-agenda-check-no-diary)
4157 (let* ((marker (or (get-text-property (point) 'org-marker)
4158 (org-agenda-error)))
4159 (buffer (marker-buffer marker))
4160 (pos (marker-position marker)))
4165 (if (not (org-at-timestamp-p))
4166 (error "Cannot find time stamp"))
4167 (org-timestamp-change arg (or what 'day))
4168 (message "Time stamp changed to %s" org-last-changed-timestamp))))
4170 (defun org-agenda-date-earlier (arg &optional what)
4171 "Change the date of this item to one day earlier."
4173 (org-agenda-date-later (- arg) what))
4175 (defun org-agenda-date-today (arg)
4176 "Change the date of this item to today."
4178 (org-agenda-check-no-diary)
4179 (let* ((marker (or (get-text-property (point) 'org-marker)
4180 (org-agenda-error)))
4181 (buffer (marker-buffer marker))
4182 (pos (marker-position marker)))
4187 (if (not (org-at-timestamp-p))
4188 (error "Cannot find time stamp"))
4189 (org-time-stamp nil)
4190 (message "Time stamp changed to %s" org-last-changed-timestamp))))
4192 (defun org-get-heading ()
4193 "Return the heading of the current entry, without the stars."
4195 (if (and (re-search-backward "[\r\n]\\*" nil t)
4196 (looking-at "[\r\n]\\*+[ \t]+\\(.*\\)"))
4200 (defun org-agenda-diary-entry (arg)
4201 "Make a diary entry, like the `i' command from the calendar.
4202 All the standard commands work: block, weekly etc"
4204 (require 'diary-lib)
4206 (message "Diary entry: [d]ay [w]eekly [m]onthly [y]early [a]nniversary [b]lock [c]yclic")
4207 (read-char-exclusive)))
4208 (cmd (cdr (assoc char
4209 '((?d . insert-diary-entry)
4210 (?w . insert-weekly-diary-entry)
4211 (?m . insert-monthly-diary-entry)
4212 (?y . insert-yearly-diary-entry)
4213 (?a . insert-anniversary-diary-entry)
4214 (?b . insert-block-diary-entry)
4215 (?c . insert-cyclic-diary-entry)))))
4216 (oldf (symbol-function 'calendar-cursor-to-date))
4218 (mark (or (mark t) (point))))
4220 (error "No command associated with <%c>" char))
4221 (unless (and (get-text-property point 'day)
4222 (or (not (equal ?b char))
4223 (get-text-property mark 'day)))
4224 (error "Don't know which date to use for diary entry"))
4225 ;; We implememnt this by hacking the `calendar-cursor-to-date' function
4226 ;; and the `calendar-mark-ring' variable. Saves a lot of code.
4227 (let ((calendar-mark-ring
4228 (list (calendar-gregorian-from-absolute
4229 (or (get-text-property mark 'day)
4230 (get-text-property point 'day))))))
4233 (fset 'calendar-cursor-to-date
4234 (lambda (&optional error)
4235 (calendar-gregorian-from-absolute
4236 (get-text-property point 'day))))
4237 (call-interactively cmd))
4238 (fset 'calendar-cursor-to-date oldf)))))
4241 (defun org-agenda-execute-calendar-command (cmd)
4242 "Execute a calendar command from the agenda, with the date associated to
4243 the cursor position."
4244 (require 'diary-lib)
4245 (unless (get-text-property (point) 'day)
4246 (error "Don't know which date to use for calendar command"))
4247 (let* ((oldf (symbol-function 'calendar-cursor-to-date))
4249 (mark (or (mark t) (point)))
4250 (date (calendar-gregorian-from-absolute
4251 (get-text-property point 'day)))
4252 (displayed-day (extract-calendar-day date))
4253 (displayed-month (extract-calendar-month date))
4254 (displayed-year (extract-calendar-year date)))
4257 (fset 'calendar-cursor-to-date
4258 (lambda (&optional error)
4259 (calendar-gregorian-from-absolute
4260 (get-text-property point 'day))))
4261 (call-interactively cmd))
4262 (fset 'calendar-cursor-to-date oldf))))
4264 (defun org-agenda-phases-of-moon ()
4265 "Display the phases of the moon for 3 month around cursor date."
4267 (org-agenda-execute-calendar-command 'calendar-phases-of-moon))
4269 (defun org-agenda-holidays ()
4270 "Display the holidays for 3 month around cursor date."
4272 (org-agenda-execute-calendar-command 'list-calendar-holidays))
4274 (defun org-agenda-sunrise-sunset (arg)
4275 "Display sunrise and sunset for the cursor date.
4276 Latitude and longitude can be specified with the variables
4277 `calendar-latitude' and `calendar-longitude'. When called with prefix
4278 argument, location will be prompted for."
4280 (let ((calendar-longitude (if arg nil calendar-longitude))
4281 (calendar-latitude (if arg nil calendar-latitude))
4282 (calendar-location-name nil))
4283 (org-agenda-execute-calendar-command 'calendar-sunrise-sunset)))
4285 (defun org-agenda-goto-calendar ()
4286 "Open the Emacs calendar with the date at the cursor."
4288 (let* ((day (or (get-text-property (point) 'day)
4289 (error "Don't know which date to open in calendar")))
4290 (date (calendar-gregorian-from-absolute day)))
4292 (calendar-goto-date date)))
4294 (defun org-agenda-convert-date ()
4296 (let ((day (get-text-property (point) 'day))
4299 (error "Don't know which date to convert"))
4300 (setq date (calendar-gregorian-from-absolute day))
4301 (require 'cal-julian)
4302 (require 'cal-hebrew)
4303 (require 'cal-islam)
4304 (require 'cal-french)
4305 (require 'cal-mayan)
4306 (require 'cal-coptic)
4307 (require 'cal-persia)
4308 (require 'cal-china)
4310 "Gregorian: " (calendar-date-string date) "\n"
4311 "Julian: " (calendar-julian-date-string date) "\n"
4312 "Astronomic: " (calendar-astro-date-string date) " (at noon UTC)\n"
4313 "Hebrew: " (calendar-hebrew-date-string date) "\n"
4314 "Islamic: " (calendar-islamic-date-string date) "\n"
4315 "French: " (calendar-french-date-string date) "\n"
4316 "Maya: " (calendar-mayan-date-string date) "\n"
4317 "Coptic: " (calendar-coptic-date-string date) "\n"
4318 "Persian: " (calendar-persian-date-string date) "\n"
4319 "Chineese: " (calendar-chinese-date-string date) "\n"))
4320 (with-output-to-temp-buffer "*Dates*"
4322 (fit-window-to-buffer (get-buffer-window "*Dates*"))))
4326 (defun org-find-file-at-mouse (ev)
4327 "Open file link or URL at mouse."
4329 (mouse-set-point ev)
4330 (org-open-at-point 'in-emacs))
4332 (defun org-open-at-mouse (ev)
4333 "Open file link or URL at mouse."
4335 (mouse-set-point ev)
4336 (org-open-at-point))
4338 (defun org-open-at-point (&optional in-emacs)
4339 "Open link at or after point.
4340 If there is no link at point, this function will search forward up to
4341 the end of the current subtree.
4342 Normally, files will be opened by an appropriate application. If the
4343 optional argument IN-EMACS is non-nil, Emacs will visit the file."
4345 (if (org-at-timestamp-p)
4346 (org-agenda nil (time-to-days (org-time-string-to-time
4347 (substring (match-string 1) 0 10)))
4349 (let (type path line (pos (point)))
4351 (skip-chars-backward
4352 (if org-allow-space-in-links "^\t\n\r" "^ \t\n\r"))
4353 (if (re-search-forward
4357 (progn (outline-end-of-subtree) (max pos (point)))
4358 (error (end-of-line 1) (point))))
4360 (setq type (match-string 1)
4361 path (match-string 2)))
4363 (error "No link found."))
4364 ;; Remove any trailing spaces in path
4365 (if (string-match " +\\'" path)
4366 (setq path (replace-match "" t t path)))
4370 ((string= type "file")
4371 (if (string-match ":\\([0-9]+\\)\\'" path)
4372 (setq line (string-to-number (match-string 1 path))
4373 path (substring path 0 (match-beginning 0))))
4374 (org-open-file path in-emacs line))
4376 ((string= type "news")
4377 (org-follow-gnus-link path))
4379 ((string= type "bbdb")
4380 (org-follow-bbdb-link path))
4382 ((string= type "gnus")
4383 (let (group article)
4384 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4385 (error "Error in Gnus link"))
4386 (setq group (match-string 1 path)
4387 article (match-string 3 path))
4388 (org-follow-gnus-link group article)))
4390 ((string= type "vm")
4391 (let (folder article)
4392 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4393 (error "Error in VM link"))
4394 (setq folder (match-string 1 path)
4395 article (match-string 3 path))
4396 ;; in-emacs is the prefix arg, will be interpreted as read-only
4397 (org-follow-vm-link folder article in-emacs)))
4399 ((string= type "wl")
4400 (let (folder article)
4401 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4402 (error "Error in Wanderlust link"))
4403 (setq folder (match-string 1 path)
4404 article (match-string 3 path))
4405 (org-follow-wl-link folder article)))
4407 ((string= type "rmail")
4408 (let (folder article)
4409 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path))
4410 (error "Error in RMAIL link"))
4411 (setq folder (match-string 1 path)
4412 article (match-string 3 path))
4413 (org-follow-rmail-link folder article)))
4415 ((string= type "shell")
4417 (if (or (not org-confirm-shell-links)
4418 (yes-or-no-p (format "Execute \"%s\" in the shell? " cmd)))
4423 (browse-url-at-point)))))))
4425 (defun org-follow-bbdb-link (name)
4426 "Follow a BBDB link to NAME."
4428 ;; First try an exact match
4429 (bbdb-name (concat "\\`" name "\\'") nil)
4430 (if (= 0 (buffer-size (get-buffer "*BBDB*")))
4431 ;; No exact match - try partial match
4432 (bbdb-name name nil)))
4434 (defun org-follow-gnus-link (&optional group article)
4435 "Follow a Gnus link to GROUP and ARTICLE."
4437 (funcall (cdr (assq 'gnus org-link-frame-setup)))
4438 (if group (gnus-fetch-group group))
4440 (or (gnus-summary-goto-article article nil 'force)
4441 (if (fboundp 'gnus-summary-insert-cached-articles)
4443 (gnus-summary-insert-cached-articles)
4444 (gnus-summary-goto-article article nil 'force))
4445 (message "Message could not be found.")))))
4446 ;; (if article (gnus-summary-goto-article article nil 'force)))
4448 (defun org-follow-vm-link (&optional folder article readonly)
4449 "Follow a VM link to FOLDER and ARTICLE."
4451 (if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder)
4452 ;; ange-ftp or efs or tramp access
4453 (let ((user (or (match-string 1 folder) (user-login-name)))
4454 (host (match-string 2 folder))
4455 (file (match-string 3 folder)))
4458 ;; use tramp to access the file
4460 (setq folder (format "[%s@%s]%s" user host file))
4461 (setq folder (format "/%s@%s:%s" user host file))))
4463 ;; use ange-ftp or efs
4464 (require (if org-xemacs-p 'efs 'ange-ftp))
4465 (setq folder (format "/%s@%s:%s" user host file))))))
4467 (funcall (cdr (assq 'vm org-link-frame-setup)) folder readonly)
4470 (vm-select-folder-buffer)
4472 (let ((case-fold-search t))
4473 (goto-char (point-min))
4474 (if (not (re-search-forward
4475 (concat "^" "message-id: *" (regexp-quote article))))
4476 (error "Could not find the specified message in this folder"))
4479 (vm-beginning-of-message)
4482 (defun org-follow-wl-link (folder article)
4483 "Follow a Wanderlust link to FOLDER and ARTICLE."
4484 (wl-summary-goto-folder-subr folder 'no-sync t nil t)
4485 (if article (wl-summary-jump-to-msg-by-message-id article))
4486 (wl-summary-redisplay))
4488 (defun org-follow-rmail-link (folder article)
4489 "Follow an RMAIL link to FOLDER and ARTICLE."
4490 (let (message-number)
4492 (save-window-excursion
4493 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
4494 (setq message-number
4497 (goto-char (point-max))
4498 (if (re-search-backward
4499 (concat "^Message-ID:\\s-+" (regexp-quote
4502 (rmail-what-message))))))
4505 (rmail (if (string= folder "RMAIL") rmail-file-name folder))
4506 (rmail-show-message message-number)
4508 (error "Message not found"))))
4510 (defun org-open-file (path &optional in-emacs line)
4511 "Open the file at PATH.
4512 First, this expands any special file name abbreviations. Then the
4513 configuration variable `org-file-apps' is checked if it contains an
4514 entry for this file type, and if yes, the corresponding command is launched.
4515 If no application is found, Emacs simply visits the file.
4516 With optional argument IN-EMACS, Emacs will visit the file.
4517 If the file does not exist, an error is thrown."
4518 (let* ((file (convert-standard-filename (org-expand-file-name path)))
4519 (dfile (downcase file))
4521 (if (and (not (file-exists-p file))
4522 (not org-open-non-existing-files))
4523 (error "No such file: %s" file))
4524 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
4525 (setq ext (match-string 1 dfile))
4526 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
4527 (setq ext (match-string 1 dfile))))
4528 (setq apps (append org-file-apps (org-default-apps)))
4531 (setq cmd (or (cdr (assoc ext apps))
4532 (cdr (assoc t apps)))))
4534 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
4535 (setq cmd (format cmd file))
4536 (save-window-excursion
4537 (shell-command (concat cmd " & &"))))
4540 (funcall (cdr (assq 'file org-link-frame-setup)) file)
4541 (if line (goto-line line)))
4544 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))))
4546 (defun org-default-apps ()
4547 "Return the default applications for this operating system."
4549 ((eq system-type 'darwin)
4550 org-file-apps-defaults-macosx)
4551 ((eq system-type 'windows-nt)
4552 org-file-apps-defaults-windowsnt)
4553 ((eq system-type 'linux)
4554 org-file-apps-defaults-linux)
4555 (t org-file-apps-defaults-linux)))
4557 (defun org-expand-file-name (path)
4558 "Replace special path abbreviations and expand the file name."
4559 (expand-file-name path))
4562 (defvar org-insert-link-history nil
4563 "Minibuffer history for links inserted with `org-insert-link'.")
4565 (defvar org-stored-links nil
4566 "Contains the links stored with `org-store-link'.")
4569 (defun org-store-link (arg)
4570 "\\<org-mode-map>Store an org-link to the current location.
4571 This link can later be inserted into an org-buffer with
4572 \\[org-insert-link].
4573 For some link types, a prefix arg is interpreted:
4574 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
4575 For file links, arg negates `org-line-numbers-in-file-links'."
4580 ((eq major-mode 'bbdb-mode)
4581 (setq link (concat "bbdb:"
4582 (bbdb-record-name (bbdb-current-record)))))
4584 ((eq major-mode 'calendar-mode)
4585 (let ((cd (calendar-cursor-to-date)))
4588 (car org-time-stamp-formats)
4590 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
4593 ((or (eq major-mode 'vm-summary-mode)
4594 (eq major-mode 'vm-presentation-mode))
4595 (and (eq major-mode 'vm-presentation-mode) (vm-summarize))
4596 (vm-follow-summary-cursor)
4598 (vm-select-folder-buffer)
4599 (let* ((message (car vm-message-pointer))
4600 (folder (buffer-file-name))
4601 (subject (vm-su-subject message))
4602 (author (vm-su-full-name message))
4603 (address (vm-su-from message))
4604 (message-id (vm-su-message-id message)))
4605 (setq folder (abbreviate-file-name folder))
4606 (if (string-match (concat "^" (regexp-quote vm-folder-directory))
4608 (setq folder (replace-match "" t t folder)))
4609 (setq cpltxt (concat author " on: " subject))
4610 (setq link (concat cpltxt "\n " "vm:" folder
4613 ((eq major-mode 'wl-summary-mode)
4614 (let* ((msgnum (wl-summary-message-number))
4615 (message-id (elmo-message-field wl-summary-buffer-elmo-folder
4616 msgnum 'message-id))
4617 (wl-message-entity (elmo-msgdb-overview-get-entity
4618 msgnum (wl-summary-buffer-msgdb)))
4619 (author (wl-summary-line-from)) ; FIXME: how to get author name?
4620 (subject "???")) ; FIXME: How to get subject of email?
4621 (setq cpltxt (concat author " on: " subject))
4622 (setq link (concat cpltxt "\n " "wl:" wl-summary-buffer-folder-name
4625 ((eq major-mode 'rmail-mode)
4628 (rmail-narrow-to-non-pruned-header)
4629 (let ((folder (buffer-file-name))
4630 (message-id (mail-fetch-field "message-id"))
4631 (author (mail-fetch-field "from"))
4632 (subject (mail-fetch-field "subject")))
4633 (setq cpltxt (concat author " on: " subject))
4634 (setq link (concat cpltxt "\n " "rmail:" folder
4635 "#" message-id))))))
4637 ((eq major-mode 'gnus-group-mode)
4638 (let ((group (cond ((fboundp 'gnus-group-group-name) ; depending on Gnus
4639 (gnus-group-group-name)) ; version
4640 ((fboundp 'gnus-group-name)
4643 (if (org-xor arg org-usenet-links-prefer-google)
4644 (setq link (format "http://groups.google.com/groups?group=%s"
4646 (setq link (concat "gnus:" group)))))
4648 ((or (eq major-mode 'gnus-summary-mode)
4649 (eq major-mode 'gnus-article-mode))
4650 (gnus-article-show-summary)
4651 (gnus-summary-beginning-of-article)
4652 (let* ((group (car gnus-article-current))
4653 (article (cdr gnus-article-current))
4654 (header (gnus-summary-article-header article))
4655 (author (mail-header-from header))
4656 (message-id (mail-header-id header))
4657 (date (mail-header-date header))
4658 (subject (gnus-summary-subject-string)))
4659 (setq cpltxt (concat author " on: " subject))
4660 (if (org-xor arg org-usenet-links-prefer-google)
4664 (format "http://groups.google.com/groups?as_umsgid=%s"
4665 (org-fixup-message-id-for-http message-id))))
4666 (setq link (concat cpltxt "\n" "gnus:" group
4667 "#" (number-to-string article))))))
4669 ((eq major-mode 'w3-mode)
4670 (setq link (url-view-url t)))
4671 ((eq major-mode 'w3m-mode)
4672 (setq link w3m-current-url))
4675 ;; Just link to this file here.
4676 (setq link (concat "file:"
4677 (abbreviate-file-name (buffer-file-name))))
4678 ;; Add the line number?
4679 (if (org-xor org-line-numbers-in-file-links arg)
4683 (+ (if (bolp) 1 0) (count-lines
4684 (point-min) (point))))))))
4686 (error "Cannot link to a buffer which is not visiting a file"))
4687 (t (setq link nil)))
4689 (if (and (interactive-p) link)
4691 (setq org-stored-links
4692 (cons (cons (or cpltxt link) link) org-stored-links))
4693 (message "Stored: %s" (or cpltxt link)))
4696 (defun org-xor (a b)
4701 (defun org-get-header (header)
4702 "Find a header field in the current buffer."
4704 (goto-char (point-min))
4705 (let ((case-fold-search t) s)
4708 (if (re-search-forward "^From:\\s-+\\(.*\\)" nil t)
4709 (setq s (match-string 1)))
4710 (while (string-match "\"" s)
4711 (setq s (replace-match "" t t s)))
4712 (if (string-match "[<(].*" s)
4713 (setq s (replace-match "" t t s))))
4714 ((eq header 'message-id)
4715 (if (re-search-forward "^message-id:\\s-+\\(.*\\)" nil t)
4716 (setq s (match-string 1))))
4717 ((eq header 'subject)
4718 (if (re-search-forward "^subject:\\s-+\\(.*\\)" nil t)
4719 (setq s (match-string 1)))))
4720 (if (string-match "\\`[ \t\]+" s) (setq s (replace-match "" t t s)))
4721 (if (string-match "[ \t\]+\\'" s) (setq s (replace-match "" t t s)))
4725 (defun org-fixup-message-id-for-http (s)
4726 "Replace special characters in a message id, so that it can be used
4728 (while (string-match "<" s)
4729 (setq s (replace-match "%3C" t t s)))
4730 (while (string-match ">" s)
4731 (setq s (replace-match "%3E" t t s)))
4732 (while (string-match "@" s)
4733 (setq s (replace-match "%40" t t s)))
4736 (defun org-insert-link (&optional complete-file)
4737 "Insert a link. At the prompt, enter the link.
4739 Completion can be used to select a link previously stored with
4740 `org-store-link'. When the empty string is entered (i.e. if you just
4741 press RET at the prompt), the link defaults to the most recently
4744 With a C-u prefix, prompts for a file to link to. The file name can be
4745 selected using completion. The path to the file will be relative to
4746 the current directory if the file is in the current directory or a
4747 subdirectory. Otherwise, the link will be the absolute path as
4748 completed in the minibuffer (i.e. normally ~/path/to/file).
4750 With two C-u prefixes, enforce an absolute path even if the file
4751 is in the current directory or below."
4753 (let ((link (if complete-file
4754 (read-file-name "File: ")
4756 "Link: " org-stored-links nil nil nil
4757 org-insert-link-history
4758 (or (car (car org-stored-links))))))
4760 (if (or (not link) (equal link ""))
4761 (error "No links available"))
4763 (let ((pwd (file-name-as-directory (expand-file-name "."))))
4765 ((equal complete-file '(16))
4766 (insert "file:" (abbreviate-file-name (expand-file-name link))))
4767 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
4768 (expand-file-name link))
4769 (insert "file:" (match-string 1 (expand-file-name link))))
4770 (t (insert "file:" link))))
4771 (setq linktxt (cdr (assoc link org-stored-links)))
4772 (if (not org-keep-stored-link-after-insertion)
4773 (setq org-stored-links (delq (assoc link org-stored-links)
4775 (let ((lines (org-split-string (or linktxt link) "\n")))
4776 (insert (car lines))
4777 (setq matched (string-match org-link-regexp (car lines)))
4778 (setq lines (cdr lines))
4782 (beginning-of-line 0)
4783 (looking-at "[ \t]+\\S-"))
4785 (setq matched (or matched
4786 (string-match org-link-regexp (car lines))))
4787 (insert (car lines))
4788 (setq lines (cdr lines))))
4790 (error "Add link type: http(s),ftp,mailto,file,news,bbdb,vm,wl,rmail,gnus, or shell")))))
4792 ;;; Hooks for remember.el
4794 (defun org-remember-annotation ()
4795 "Return a link to the current location as an annotation for remember.el.
4796 If you are using Org-mode files as target for data storage with
4797 remember.el, then the annotations should include a link compatible with the
4798 conventions in Org-mode. This function returns such a link."
4799 (org-store-link nil))
4801 (defconst org-remember-help
4802 "Select a destination location for the note.
4803 UP/DOWN=headline TAB=cycle visibility [Q]uit RET/<left>/<right>=Store
4804 RET at beg-of-buf -> Append to file as level 2 headline
4805 RET on headline -> Store as sublevel entry to current headline
4806 <left>/<right> -> before/after current headline, same headings level")
4809 (defun org-remember-handler ()
4810 "Store stuff from remember.el into an org file.
4811 First prompts for an org file. If the user just presses return, the value
4812 of `org-default-notes-file' is used.
4813 Then the command offers the headings tree of the selected file in order to
4814 file the text at a specific location.
4815 You can either immediately press RET to get the note appended to the
4816 file. Or you can use vertical cursor motion and visibility cycling (TAB) to
4817 find a better place. Then press RET or <left> or <right> in insert the note.
4819 Key Cursor position Note gets inserted
4820 -----------------------------------------------------------------------------
4821 RET buffer-start as level 2 heading at end of file
4822 RET on headline as sublevel of the heading at cursor
4823 RET no heading at cursor position, level taken from context.
4824 Or use prefix arg to specify level manually.
4825 <left> on headline as same level, before current heading
4826 <right> on headline as same level, after current heading
4828 So the fastest way to store the note is to press RET RET to append it to
4829 the default file. This way your current train of thought is not
4830 interrupted, in accordance with the principles of remember.el. But with
4831 little extra effort, you can push it directly to the correct location.
4833 Before being stored away, the function ensures that the text has a
4834 headline, i.e. a first line that starts with a \"*\". If not, a headline
4835 is constructed from the current date and some additional data.
4837 If the variable `org-adapt-indentation' is non-nil, the entire text is
4838 also indented so that it starts in the same column as the headline
4839 \(i.e. after the stars).
4841 See also the variable `org-reverse-note-order'."
4843 (let* ((txt (buffer-substring (point-min) (point-max)))
4844 (fastp current-prefix-arg)
4845 (file (if fastp org-default-notes-file (org-get-org-file)))
4846 (visiting (find-buffer-visiting file))
4847 (org-startup-with-deadline-check nil)
4848 (org-startup-folded nil)
4849 spos level indent reversed)
4850 ;; Modify text so that it becomes a nice subtree which can be inserted
4851 ;; into an org tree.
4852 (let* ((lines (split-string txt "\n"))
4854 (lines (cdr lines)))
4855 (if (string-match "^\\*+" first)
4856 ;; Is already a headline
4857 (setq indent (make-string (- (match-end 0) (match-beginning 0)
4859 ;; We need to add a headline: Use time and first buffer line
4860 (setq lines (cons first lines)
4861 first (concat "* " (current-time-string)
4862 " (" (remember-buffer-desc) ")")
4864 (if org-adapt-indentation
4865 (setq lines (mapcar (lambda (x) (concat indent x)) lines)))
4866 (setq txt (concat first "\n"
4867 (mapconcat 'identity lines "\n"))))
4870 (find-file-noselect file))
4872 (set-buffer (get-file-buffer file))
4873 (setq reversed (org-notes-order-reversed-p))
4877 ;; Ask the User for a location
4878 (setq spos (if fastp 1 (org-get-location
4880 org-remember-help)))
4881 (if (not spos) (throw 'quit nil)) ; return nil to show we did
4882 ; not handle this note
4885 ;; Put it at the start or end, as level 2
4888 (goto-char (if reversed (point-min) (point-max)))
4889 (if (not (bolp)) (newline))
4890 (org-paste-subtree (or current-prefix-arg 2) txt)))
4891 ((and (org-on-heading-p nil) (not current-prefix-arg))
4892 ;; Put it below this entry, at the beg/end of the subtree
4893 (org-back-to-heading)
4894 (setq level (outline-level))
4896 (outline-end-of-heading)
4897 (outline-end-of-subtree))
4898 (if (not (bolp)) (newline))
4899 (beginning-of-line 1)
4900 (org-paste-subtree (1+ level) txt))
4902 ;; Put it right there, with automatic level determined by
4903 ;; org-paste-subtree or from prefix arg
4904 (org-paste-subtree current-prefix-arg txt)))
4905 (when remember-save-after-remembering
4907 (if (not visiting) (kill-buffer (current-buffer)))))))))
4908 t) ;; return t to indicate that we took care of this note.
4910 (defun org-get-org-file ()
4911 "Read a filename, with default directory `org-directory'."
4912 (let ((default (or org-default-notes-file remember-data-file)))
4913 (read-file-name (format "File name [%s]: " default)
4914 (file-name-as-directory org-directory)
4917 (defun org-notes-order-reversed-p ()
4918 "Check if the current file should receive notes in reversed order."
4920 ((not org-reverse-note-order) nil)
4921 ((eq t org-reverse-note-order) t)
4922 ((not (listp org-reverse-note-order)) nil)
4924 (let ((all org-reverse-note-order)
4926 (while (setq entry (pop all))
4927 (if (string-match (car entry) (buffer-file-name))
4928 (throw 'exit (cdr entry))))
4933 ;; Watch out: Here we are talking about two different kind of tables.
4934 ;; Most of the code is for the tables created with the Org-mode table editor.
4935 ;; Sometimes, we talk about tables created and edited with the table.el
4936 ;; Emacs package. We call the former org-type tables, and the latter
4937 ;; table.el-type tables.
4939 ;; We use a before-change function to check if a table might need
4941 (defvar org-table-may-need-update t
4942 "Indicates of a table might need an update.
4943 This variable is set by `org-before-change-function'. `org-table-align'
4944 sets it back to nil.")
4946 (defun org-before-change-function (beg end)
4947 "Every change indicates that a table might need an update."
4948 (setq org-table-may-need-update t))
4950 (defconst org-table-line-regexp "^[ \t]*|"
4951 "Detects an org-type table line.")
4952 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
4953 "Detects an org-type table line.")
4954 (defconst org-table-hline-regexp "^[ \t]*|-"
4955 "Detects an org-type table hline.")
4956 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
4957 "Detects a table-type table hline.")
4958 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
4959 "Detects an org-type or table-type table")
4960 (defconst org-table-border-regexp "^[ \t]*[^| \t]"
4961 "Searching from within a table (any type) this finds the first line
4962 outside the table.")
4963 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
4964 "Searching from within a table (any type) this finds the first line
4965 outside the table.")
4967 (defun org-table-create-with-table.el ()
4968 "Use the table.el package to insert a new table.
4969 If there is already a table at point, convert between Org-mode tables
4970 and table.el tables."
4974 ((org-at-table.el-p)
4975 (if (y-or-n-p "Convert table to Org-mode table? ")
4976 (org-table-convert)))
4978 (if (y-or-n-p "Convert table to table.el table? ")
4979 (org-table-convert)))
4980 (t (call-interactively 'table-insert))))
4982 (defun org-table-create (&optional size)
4983 "Query for a size and insert a table skeleton.
4984 SIZE is a string Columns x Rows like for example \"3x2\"."
4987 (setq size (read-string
4988 (concat "Table size Columns x Rows [e.g. "
4989 org-table-default-size "]: ")
4990 "" nil org-table-default-size)))
4992 (let* ((pos (point))
4993 (indent (make-string (current-column) ?\ ))
4994 (split (org-split-string size " *x *"))
4995 (rows (string-to-number (nth 1 split)))
4996 (columns (string-to-number (car split)))
4997 (line (concat (apply 'concat indent "|" (make-list columns " |"))
4999 (if (string-match "^[ \t]*$" (buffer-substring-no-properties
5000 (point-at-bol) (point)))
5001 (beginning-of-line 1)
5003 (mapcar (lambda (x) (insert line)) (make-list rows t))
5006 ;; Insert a hline after the first row.
5013 (defun org-table-convert-region (beg0 end0 nspace)
5014 "Convert region to a table.
5015 The region goes from BEG0 to END0, but these borders will be moved
5016 slightly, to make sure a beginning of line in the first line is included.
5017 When NSPACE is non-nil, it indicates the minimum number of spaces that
5018 separate columns (default: just one space)"
5019 (let* ((beg (min beg0 end0))
5020 (end (max beg0 end0))
5024 (beginning-of-line 1)
5025 (setq beg (move-marker (make-marker) (point)))
5027 (if (bolp) (backward-char 1) (end-of-line 1))
5028 (setq end (move-marker (make-marker) (point)))
5029 ;; Lets see if this is tab-separated material. If every nonempty line
5030 ;; contains a tab, we will assume that it is tab-separated material
5034 (and (re-search-forward "^[^\n\t]+$" end t) (setq tabsep nil)))
5035 (if nspace (setq tabsep nil))
5038 (setq re (format "^ *\\| *\t *\\| \\{%d,\\}"
5039 (max 1 (prefix-numeric-value nspace)))))
5041 (while (re-search-forward re end t)
5042 (replace-match "|" t t))
5047 (defun org-table-import (file arg)
5048 "Import FILE as a table.
5049 The file is assumed to be tab-separated. Such files can be produced by most
5050 spreadsheet and database applications. If no tabs (at least one per line)
5051 are found, lines will be split on whitespace into fields."
5052 (interactive "f\nP")
5053 (or (bolp) (newline))
5056 (insert-file-contents file)
5057 (org-table-convert-region beg (+ (point) (- (point-max) pm)) arg)))
5059 (defun org-table-export ()
5060 "Export table as a tab-separated file.
5061 Such a file can be imported into a spreadsheet program like Excel."
5063 (let* ((beg (org-table-begin))
5064 (end (org-table-end))
5065 (table (buffer-substring beg end))
5066 (file (read-file-name "Export table to: "))
5068 (unless (or (not (file-exists-p file))
5069 (y-or-n-p (format "Overwrite file %s? " file)))
5073 (setq buf (current-buffer))
5077 (goto-char (point-min))
5078 (while (re-search-forward "^[ \t]*|[ \t]*" nil t)
5079 (replace-match "" t t)
5081 (goto-char (point-min))
5082 (while (re-search-forward "[ \t]*|[ \t]*$" nil t)
5083 (replace-match "" t t)
5084 (goto-char (min (1+ (point)) (point-max))))
5085 (goto-char (point-min))
5086 (while (re-search-forward "^-[-+]*$" nil t)
5088 (if (looking-at "\n")
5090 (goto-char (point-min))
5091 (while (re-search-forward "[ \t]*|[ \t]*" nil t)
5092 (replace-match "\t" t t))
5096 (defvar org-table-aligned-begin-marker (make-marker)
5097 "Marker at the beginning of the table last aligned.
5098 Used to check if cursor still is in that table, to minimize realignment.")
5099 (defvar org-table-aligned-end-marker (make-marker)
5100 "Marker at the end of the table last aligned.
5101 Used to check if cursor still is in that table, to minimize realignment.")
5102 (defvar org-table-last-alignment nil
5103 "List of flags for flushright alignment, from the last re-algnment.
5104 This is being used to correctly align a single field after TAB or RET.")
5105 ;; FIXME: The following is currently not used.
5106 (defvar org-table-last-column-widths nil
5107 "List of max width of ffields in each column.
5108 This is being used to correctly align a single field after TAB or RET.")
5111 (defun org-table-align (&optional arg)
5112 "Align the table at point by aligning all vertical bars."
5116 (beg (org-table-begin))
5117 (end (org-table-end))
5118 ;; Current cursor position
5119 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5120 (colpos (org-table-current-column))
5121 (winstart (window-start))
5122 text lines (new "") lengths l typenums ty fields maxfields i
5124 (indent "") cnt frac
5126 (spaces (if (org-in-invisibility-spec-p '(org-table))
5127 org-table-spaces-around-invisible-separators
5128 org-table-spaces-around-separators))
5132 (make-string sp2 ?\ ) "%%%s%ds" (make-string sp1 ?\ ) "|"))
5134 (make-string sp2 ?-) "%s" (make-string sp1 ?-) "+"))
5137 ;; (message "Aligning table...")
5139 (setq lines (org-split-string
5140 (buffer-substring-no-properties beg end) "\n"))
5141 ;; Store the indentation of the first line
5142 (if (string-match "^ *" (car lines))
5143 (setq indent (make-string (- (match-end 0) (match-beginning 0)) ?\ )))
5145 (setq lines (mapcar (lambda (l) (if (string-match "^ *|-" l) nil l))
5147 ;; Get the data fields
5148 (setq fields (mapcar
5150 (org-split-string l " *| *"))
5151 (delq nil (copy-sequence lines))))
5152 ;; How many fields in the longest line?
5154 (setq maxfields (apply 'max (mapcar 'length fields)))
5156 (kill-region beg end)
5157 (org-table-create org-table-default-size)
5158 (error "Empty table - created default table")))
5159 ;; A list of empty string to fill any short rows on output
5160 (setq emptystrings (make-list maxfields ""))
5161 ;; Get the maximum length of a field and the most common datatype
5164 (while (< (setq i (1+ i)) maxfields) ;; Loop over all columns
5165 (setq column (mapcar (lambda (x) (or (nth i x) "")) fields))
5167 (push (apply 'max 1 (mapcar 'length column)) lengths)
5168 ;; compute the fraction stepwise, ignoring empty fields
5169 (setq cnt 0 frac 0.0)
5174 (setq frac ( / (+ (* frac cnt)
5175 (if (string-match org-table-number-regexp x) 1 0))
5176 (setq cnt (1+ cnt))))))
5178 (push (>= frac org-table-number-fraction) typenums))
5179 (setq lengths (nreverse lengths)
5180 typenums (nreverse typenums))
5181 (setq org-table-last-alignment typenums
5182 org-table-last-column-widths lengths)
5183 ;; Compute the formats needed for output of the table
5184 (setq rfmt (concat indent "|") hfmt (concat indent "|"))
5185 (while (setq l (pop lengths))
5186 (setq ty (if (pop typenums) "" "-")) ; number types flushright
5187 (setq rfmt (concat rfmt (format rfmt1 ty l))
5188 hfmt (concat hfmt (format hfmt1 (make-string l ?-)))))
5189 (setq rfmt (concat rfmt "\n")
5190 hfmt (concat (substring hfmt 0 -1) "|\n"))
5191 ;; Produce the new table
5193 (setq l (pop lines))
5195 (setq new (concat new (apply 'format rfmt
5196 (append (pop fields) emptystrings))))
5197 (setq new (concat new hfmt))))
5198 ;; Replace the old one
5199 (delete-region beg end)
5200 (move-marker end nil)
5201 (move-marker org-table-aligned-begin-marker (point))
5203 (move-marker org-table-aligned-end-marker (point))
5204 ;; Try to move to the old location (approximately)
5206 (set-window-start (selected-window) winstart 'noforce)
5207 (org-table-goto-column colpos)
5208 (setq org-table-may-need-update nil)
5209 (if (org-in-invisibility-spec-p '(org-table))
5210 (org-table-add-invisible-to-vertical-lines))
5213 (defun org-table-begin (&optional table-type)
5214 "Find the beginning of the table and return its position.
5215 With argument TABLE-TYPE, go to the beginning of a table.el-type table."
5217 (if (not (re-search-backward
5218 (if table-type org-table-any-border-regexp
5219 org-table-border-regexp)
5221 (error "Can't find beginning of table")
5222 (goto-char (match-beginning 0))
5223 (beginning-of-line 2)
5226 (defun org-table-end (&optional table-type)
5227 "Find the end of the table and return its position.
5228 With argument TABLE-TYPE, go to the end of a table.el-type table."
5230 (if (not (re-search-forward
5231 (if table-type org-table-any-border-regexp
5232 org-table-border-regexp)
5234 (goto-char (point-max))
5235 (goto-char (match-beginning 0)))
5238 (defun org-table-justify-field-maybe ()
5239 "Justify the current field, text to left, number to right."
5241 (org-table-may-need-update) ; Realignment will happen anyway, don't bother
5242 ((org-at-table-hline-p)
5243 ;; This is pretty stupid, but I don't know how to deal with hlines
5244 (setq org-table-may-need-update t))
5245 ((or (not (equal (marker-buffer org-table-aligned-begin-marker)
5247 (< (point) org-table-aligned-begin-marker)
5248 (>= (point) org-table-aligned-end-marker))
5249 ;; This is not the same table, force a full re-align
5250 (setq org-table-may-need-update t))
5251 (t ;; realign the current field, based on previous full realign
5252 (let* ((pos (point)) s org-table-may-need-update
5253 (col (org-table-current-column))
5254 (num (nth (1- col) org-table-last-alignment))
5257 (skip-chars-backward "^|\n")
5258 (if (looking-at " *\\([^|\n]*?\\) *|")
5260 (setq s (match-string 1)
5261 l (max 1 (- (match-end 0) (match-beginning 0) 3)))
5262 (setq f (format (if num " %%%ds |" " %%-%ds |") l))
5263 (replace-match (format f s t t)))
5264 (setq org-table-may-need-update t))
5265 (goto-char pos))))))
5267 (defun org-table-next-field (&optional arg)
5268 "Go to the next field in the current table.
5269 Before doing so, re-align the table if necessary."
5271 (if (and org-table-automatic-realign
5272 org-table-may-need-update)
5274 (if (org-at-table-hline-p)
5278 (re-search-forward "|" (org-table-end))
5279 (if (looking-at "[ \t]*$")
5280 (re-search-forward "|" (org-table-end)))
5281 (if (looking-at "-")
5283 (beginning-of-line 0)
5284 (org-table-insert-row 'below))
5285 (if (looking-at " ") (forward-char 1))))
5287 (org-table-insert-row 'below))))
5289 (defun org-table-previous-field (&optional arg)
5290 "Go to the previous field in the table.
5291 Before doing so, re-align the table if necessary."
5293 (if (and org-table-automatic-realign
5294 org-table-may-need-update)
5296 (if (org-at-table-hline-p)
5298 (re-search-backward "|" (org-table-begin))
5299 (re-search-backward "|" (org-table-begin))
5300 (while (looking-at "|\\(-\\|[ \t]*$\\)")
5301 (re-search-backward "|" (org-table-begin)))
5302 (if (looking-at "| ?")
5303 (goto-char (match-end 0))))
5305 (defun org-table-next-row (&optional arg)
5306 "Go to the next row (same column) in the current table.
5307 Before doing so, re-align the table if necessary."
5309 (if (or (looking-at "[ \t]*$")
5310 (save-excursion (skip-chars-backward " \t") (bolp)))
5312 (if (and org-table-automatic-realign
5313 org-table-may-need-update)
5315 (let ((col (org-table-current-column)))
5316 (beginning-of-line 2)
5317 (if (or (not (org-at-table-p))
5318 (org-at-table-hline-p))
5320 (beginning-of-line 0)
5321 (org-table-insert-row 'below)))
5322 (org-table-goto-column col)
5323 (skip-chars-backward "^|\n\r")
5324 (if (looking-at " ") (forward-char 1)))))
5326 (defun org-table-copy-down (n)
5327 "Copy a field down in the current column.
5328 If the field at the cursor is empty, copy into it the content of the nearest
5329 non-empty field above. With argument N, use the Nth non-empty field.
5330 If the current fields is not empty, it is copied down to the next row, and
5331 the cursor is moved with it. Therefore, repeating this command causes the
5332 column to be filled row-by-row.
5333 If the variable `org-table-copy-increment' is non-nil and the field is an
5334 integer, it will be incremented while copying."
5336 (let* ((colpos (org-table-current-column))
5337 (field (org-table-get-field))
5338 (non-empty (string-match "[^ \t]" field))
5339 (beg (org-table-begin))
5341 (org-table-check-inside-data-field)
5342 (if non-empty (progn (org-table-next-row) (org-table-blank-field)))
5346 (while (progn (beginning-of-line 1)
5347 (re-search-backward org-table-dataline-regexp
5349 (org-table-goto-column colpos t)
5350 (if (and (looking-at
5351 "|[ \t]*\\([^| \t][^|]*?\\)[ \t]*|")
5352 (= (setq n (1- n)) 0))
5353 (throw 'exit (match-string 1)))))))
5355 (if (and org-table-copy-increment
5356 (string-match "^[0-9]+$" txt))
5357 (setq txt (format "%d" (+ (string-to-int txt) 1))))
5360 (error "No non-empty field found"))))
5362 (defun org-table-check-inside-data-field ()
5363 "Is point inside a table data field?
5364 I.e. not on a hline or before the first or after the last column?"
5365 (if (or (not (org-at-table-p))
5366 (= (org-table-current-column) 0)
5367 (org-at-table-hline-p)
5368 (looking-at "[ \t]*$"))
5369 (error "Not in table data field")))
5371 (defun org-table-blank-field ()
5372 "Blank the current table field or active region."
5374 (org-table-check-inside-data-field)
5375 (if (and (interactive-p) (org-region-active-p))
5376 (let (org-table-clip)
5377 (org-table-cut-region))
5378 (skip-chars-backward "^|")
5380 (if (looking-at "|[^|]+")
5381 (let* ((pos (match-beginning 0))
5382 (match (match-string 0))
5383 (len (length match)))
5384 (replace-match (concat "|" (make-string (1- len) ?\ )))
5385 (goto-char (+ 2 pos))
5386 (substring match 1)))))
5388 (defun org-table-get-field (&optional n replace)
5389 "Return the value of the field in column N of current row.
5390 N defaults to current field.
5391 If REPLACE is a string, replace field with this value. The return value
5392 is always the old value."
5393 (and n (org-table-goto-column n))
5394 (skip-chars-backward "^|")
5396 (if (looking-at "|[^|\r\n]*")
5397 (let* ((pos (match-beginning 0))
5398 (len (length (match-string 0)))
5399 (val (buffer-substring (1+ pos) (match-end 0))))
5401 (replace-match (concat "|" replace)))
5402 (goto-char (+ 2 pos))
5405 (defun org-table-current-column ()
5406 "Find out which column we are in.
5407 When called interactively, column is also displayed in echo area."
5409 (if (interactive-p) (org-table-check-inside-data-field))
5411 (let ((cnt 0) (pos (point)))
5412 (beginning-of-line 1)
5413 (while (search-forward "|" pos t)
5414 (setq cnt (1+ cnt)))
5415 (if (interactive-p) (message "This is table column %d" cnt))
5418 (defun org-table-goto-column (n &optional on-delim force)
5419 "Move the cursor to the Nth column in the current table line.
5420 With optional argument ON-DELIM, stop with point before the left delimiter
5422 If there are less than N fields, just go to after the last delimiter.
5423 However, when FORCE is non-nil, create new columns if necessary."
5424 (let ((pos (point-at-eol)))
5425 (beginning-of-line 1)
5427 (while (and (> (setq n (1- n)) -1)
5428 (or (search-forward "|" pos t)
5430 (progn (end-of-line 1)
5431 (skip-chars-backward "^|")
5433 (bachward-char 2) t)))))
5434 (when (and force (not (looking-at ".*|")))
5435 (save-excursion (end-of-line 1) (insert "|")))
5438 (if (looking-at " ") (forward-char 1))))))
5440 (defun org-at-table-p (&optional table-type)
5441 "Return t if the cursor is inside an org-type table."
5442 (if org-enable-table-editor
5444 (beginning-of-line 1)
5445 (looking-at (if table-type org-table-any-line-regexp
5446 org-table-line-regexp)))
5449 (defun org-table-recognize-table.el ()
5450 "If there is a table.el table nearby, recognize it and move into it."
5451 (if org-table-tab-recognizes-table.el
5452 (if (org-at-table.el-p)
5454 (beginning-of-line 1)
5455 (if (looking-at org-table-dataline-regexp)
5457 (if (looking-at org-table1-hline-regexp)
5459 (beginning-of-line 2)
5460 (if (looking-at org-table-any-border-regexp)
5461 (beginning-of-line -1)))))
5462 (if (re-search-forward "|" (org-table-end t) t)
5465 (if (table--at-cell-p (point))
5467 (message "recognizing table.el table...")
5468 (table-recognize-table)
5469 (message "recognizing table.el table...done")))
5470 (error "This should not happen..."))
5475 (defun org-at-table.el-p ()
5476 "Return t if the cursor is inside a table.el-type table."
5478 (if (org-at-table-p 'any)
5480 (goto-char (org-table-begin 'any))
5481 (looking-at org-table1-hline-regexp))
5484 (defun org-at-table-hline-p ()
5485 "Return t if the cursor is inside a hline in a table."
5486 (if org-enable-table-editor
5488 (beginning-of-line 1)
5489 (looking-at org-table-hline-regexp))
5492 (defun org-table-insert-column (&optional arg)
5493 "Insert a new column into the table."
5495 (if (not (org-at-table-p))
5496 (error "Not at a table"))
5497 (org-table-find-dataline)
5498 (let* ((col (max 1 (org-table-current-column)))
5499 (beg (org-table-begin))
5500 (end (org-table-end))
5501 ;; Current cursor position
5502 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5505 (while (< (point) end)
5506 (if (org-at-table-hline-p)
5508 (org-table-goto-column col t)
5510 (beginning-of-line 2))
5511 (move-marker end nil)
5513 (org-table-goto-column colpos))
5516 (defun org-table-find-dataline ()
5517 "Find a dataline in the current table, which is needed for column commands."
5518 (if (and (org-at-table-p)
5519 (not (org-at-table-hline-p)))
5521 (let ((col (current-column))
5522 (end (org-table-end)))
5523 (move-to-column col)
5524 (while (and (< (point) end)
5525 (or (not (= (current-column) col))
5526 (org-at-table-hline-p)))
5527 (beginning-of-line 2)
5528 (move-to-column col))
5529 (if (and (org-at-table-p)
5530 (not (org-at-table-hline-p)))
5533 "Please position cursor in a data line for column operations")))))
5535 (defun org-table-delete-column (&optional arg)
5536 "Insert a new column into the table."
5538 (if (not (org-at-table-p))
5539 (error "Not at a table"))
5540 (org-table-find-dataline)
5541 (org-table-check-inside-data-field)
5542 (let* ((col (org-table-current-column))
5543 (beg (org-table-begin))
5544 (end (org-table-end))
5545 ;; Current cursor position
5546 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5549 (while (< (point) end)
5550 (if (org-at-table-hline-p)
5552 (org-table-goto-column col t)
5553 (and (looking-at "|[^|\n]+|")
5554 (replace-match "|")))
5555 (beginning-of-line 2))
5556 (move-marker end nil)
5558 (org-table-goto-column colpos))
5561 (defun org-table-move-column-right ()
5562 "Move column to the right."
5564 (org-table-move-column nil))
5565 (defun org-table-move-column-left ()
5566 "Move column to the left."
5568 (org-table-move-column 'left))
5570 (defun org-table-move-column (&optional left)
5571 "Move the current column to the right. With arg LEFT, move to the left."
5573 (if (not (org-at-table-p))
5574 (error "Not at a table"))
5575 (org-table-find-dataline)
5576 (org-table-check-inside-data-field)
5577 (let* ((col (org-table-current-column))
5578 (col1 (if left (1- col) col))
5579 (beg (org-table-begin))
5580 (end (org-table-end))
5581 ;; Current cursor position
5582 (linepos (+ (if (bolp) 1 0) (count-lines (point-min) (point))))
5583 (colpos (if left (1- col) (1+ col))))
5584 (if (and left (= col 1))
5585 (error "Cannot move column further left"))
5586 (if (and (not left) (looking-at "[^|\n]*|[^|\n]*$"))
5587 (error "Cannot move column further right"))
5589 (while (< (point) end)
5590 (if (org-at-table-hline-p)
5592 (org-table-goto-column col1 t)
5593 (and (looking-at "|\\([^|\n]+\\)|\\([^|\n]+\\)|")
5594 (replace-match "|\\2|\\1|")))
5595 (beginning-of-line 2))
5596 (move-marker end nil)
5598 (org-table-goto-column colpos))
5601 (defun org-table-move-row-down ()
5602 "Move table row down."
5604 (org-table-move-row nil))
5605 (defun org-table-move-row-up ()
5606 "Move table row down."
5608 (org-table-move-row 'up))
5610 (defun org-table-move-row (&optional up)
5611 "Move the current table line down. With arg UP, move it up."
5613 (let ((col (current-column))
5617 (beginning-of-line tonew)
5618 (if (not (org-at-table-p))
5621 (error "Cannot move row further.")))
5623 (beginning-of-line 1)
5625 (setq txt (buffer-substring (point) (1+ (point-at-eol))))
5626 (delete-region (point) (1+ (point-at-eol)))
5627 (beginning-of-line tonew)
5629 (beginning-of-line 0)
5630 (move-to-column col)))
5632 (defun org-table-insert-row (&optional arg)
5633 "Insert a new row above the current line into the table.
5634 With prefix ARG, insert below the current line."
5636 (if (not (org-at-table-p))
5637 (error "Not at a table"))
5638 (let ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
5639 (if (string-match "^[ \t]*|-" line)
5640 (setq line (mapcar (lambda (x) (if (member x '(?| ?+)) ?| ?\ )) line))
5641 (setq line (mapcar (lambda (x) (if (equal x ?|) ?| ?\ )) line)))
5642 (beginning-of-line (if arg 2 1))
5643 (let (org-table-may-need-update)
5644 (apply 'insert-before-markers line)
5645 (insert-before-markers "\n"))
5646 (beginning-of-line 0)
5647 (re-search-forward "| ?" (point-at-eol) t)
5648 (and org-table-may-need-update (org-table-align))))
5650 (defun org-table-insert-hline (&optional arg)
5651 "Insert a horizontal-line below the current line into the table.
5652 With prefix ARG, insert above the current line."
5654 (if (not (org-at-table-p))
5655 (error "Not at a table"))
5656 (let ((line (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
5657 (col (current-column))
5659 (if (string-match "^[ \t]*|-" line)
5661 (mapcar (lambda (x) (if (member x '(?| ?+))
5662 (prog1 (if start ?+ ?|) (setq start t))
5666 (mapcar (lambda (x) (if (equal x ?|)
5667 (prog1 (if start ?+ ?|) (setq start t))
5670 (beginning-of-line (if arg 1 2))
5671 (apply 'insert line)
5672 (if (equal (char-before (point)) ?+)
5673 (progn (backward-delete-char 1) (insert "|")))
5675 (beginning-of-line 0)
5676 (move-to-column col)))
5678 (defun org-table-kill-row (&optional arg)
5679 "Delete the current row or horizontal line from the table."
5681 (if (not (org-at-table-p))
5682 (error "Not at a table"))
5683 (let ((col (current-column)))
5684 (kill-region (point-at-bol) (min (1+ (point-at-eol)) (point-max)))
5685 (if (not (org-at-table-p)) (beginning-of-line 0))
5686 (move-to-column col)))
5689 (defun org-table-cut-region (&optional arg)
5690 "Copy region in table to the clipboard and blank all relevant fields."
5692 (org-table-copy-region 'cut))
5694 (defvar org-table-clip nil
5695 "Clipboard for table regions")
5697 (defun org-table-copy-region (&optional cut)
5698 "Copy rectangular region in table to clipboard.
5699 A special clibbooard is used which can only be accessed
5700 with `org-table-paste-rectangle'"
5702 (unless (org-region-active-p) (error "No active region"))
5703 (let* ((beg (region-beginning))
5705 l01 c01 l02 c02 l1 c1 l2 c2 ic1 ic2
5707 (rpl (if cut " " nil)))
5709 (org-table-check-inside-data-field)
5710 (setq l01 (count-lines (point-min) (point))
5711 c01 (org-table-current-column))
5713 (org-table-check-inside-data-field)
5714 (setq l02 (count-lines (point-min) (point))
5715 c02 (org-table-current-column))
5716 (setq l1 (min l01 l02) l2 (max l01 l02)
5717 c1 (min c01 c02) c2 (max c01 c02))
5721 (if (> l1 l2) (throw 'exit t))
5723 (if (org-at-table-hline-p) (throw 'nextline (setq l1 (1+ l1))))
5724 (setq cols nil ic1 c1 ic2 c2)
5725 (while (< ic1 (1+ ic2))
5726 (push (org-table-get-field ic1 rpl) cols)
5727 (setq ic1 (1+ ic1)))
5728 (push (nreverse cols) region)
5729 (setq l1 (1+ l1)))))
5730 (setq org-table-clip (nreverse region))
5731 (if cut (org-table-align))))
5733 (defun org-table-paste-rectangle (&optional arg)
5734 "Paste a rectangluar region into a table.
5735 The upper right corner ends up in the current field. All involved fields
5736 will be overwritten. If the rectangle does not fit into the present table,
5737 the table is enlarged as needed. The process ignores horizontal separator
5740 (unless (and org-table-clip (listp org-table-clip))
5741 (error "First cut/copy a region to paste!"))
5742 (org-table-check-inside-data-field)
5743 (let* ((clip org-table-clip)
5744 (line (count-lines (point-min) (point)))
5745 (col (org-table-current-column))
5747 (org-enable-table-editor t)
5748 (org-table-automatic-realign nil)
5750 (while (setq cols (pop clip))
5751 (while (org-at-table-hline-p) (beginning-of-line 2))
5752 (if (not (org-at-table-p))
5753 (progn (end-of-line 0) (org-table-next-field)))
5755 (while (setq field (pop cols))
5756 (org-table-goto-column c nil 'force)
5757 (org-table-get-field nil field)
5759 (beginning-of-line 2))
5761 (org-table-goto-column col)
5764 (defun org-table-convert ()
5765 "Convert from org-mode table to table.el and back.
5766 Obviously, this only works within limits. When an Org-mode table is
5767 converted to table.el, all horizontal separator lines get lost, because
5768 table.el uses these as cell boundaries and has no notion of horizontal lines.
5769 A table.el table can be converted to an Org-mode table only if it does not
5770 do row or column spanning. Multiline cells will become multiple cells.
5771 Beware, Org-mode does not test if the table can be successfully converted - it
5772 blindly applies a recipe that works for simple tables."
5775 (if (org-at-table.el-p)
5776 ;; convert to Org-mode table
5777 (let ((beg (move-marker (make-marker) (org-table-begin t)))
5778 (end (move-marker (make-marker) (org-table-end t))))
5779 (table-unrecognize-region beg end)
5781 (while (re-search-forward "^\\([ \t]*\\)\\+-.*\n" end t)
5784 (if (org-at-table-p)
5785 ;; convert to table.el table
5786 (let ((beg (move-marker (make-marker) (org-table-begin)))
5787 (end (move-marker (make-marker) (org-table-end))))
5788 ;; first, get rid of all horizontal lines
5790 (while (re-search-forward "^\\([ \t]*\\)|-.*\n" end t)
5792 ;; insert a hline before first
5794 (org-table-insert-hline 'above)
5795 ;; insert a hline after each line
5796 (while (progn (beginning-of-line 2) (< (point) end))
5797 (org-table-insert-hline))
5799 (setq end (move-marker end (org-table-end)))
5800 ;; replace "+" at beginning and ending of hlines
5801 (while (re-search-forward "^\\([ \t]*\\)|-" end t)
5802 (replace-match "\\1+-"))
5804 (while (re-search-forward "-|[ \t]*$" end t)
5805 (replace-match "-+"))
5808 (defun org-table-wrap-region (arg)
5809 "Wrap several fields in a column like a paragraph.
5810 This is useful if you'd like to spread the contents of a field over several
5811 lines, in order to keep the table compact.
5813 If there is an active region, and both point and mark are in the same column,
5814 the text in the column is wrapped to minimum width for the given number of
5815 lines. Generally, this makes the table more compact. A prefix ARG may be
5816 used to change the number of desired lines. For example, `C-2 C-c C-q'
5817 formats the selected text to two lines. If the region was longer than 2
5818 lines, the remaining lines remain empty. A negative prefix argument reduces
5819 the current number of lines by that amount. The wrapped text is pasted back
5820 into the table. If you formatted it to more lines than it was before, fields
5821 further down in the table get overwritten - so you might need to make space in
5824 If there is no region, the current field is split at the cursor position and
5825 the text fragment to the right of the cursor is prepended to the field one
5828 If there is no region, but you specify a prefix ARG, the current field gets
5829 blank, and the content is appended to the field above."
5831 (org-table-check-inside-data-field)
5832 (if (org-region-active-p)
5833 ;; There is a region: fill as a paragraph
5834 (let ((beg (region-beginning))
5836 (org-table-cut-region)
5837 (if (> (length (car org-table-clip)) 1)
5838 (error "Region must be limited to single columm"))
5839 (setq nlines (if arg
5841 (+ (length org-table-clip) arg)
5843 (length org-table-clip)))
5844 (setq org-table-clip
5845 (mapcar 'list (org-wrap (mapconcat 'car org-table-clip " ")
5848 (org-table-paste-rectangle))
5849 ;; No region, split the current field at point
5851 ;; combine with field above
5852 (let ((s (org-table-blank-field))
5853 (col (org-table-current-column)))
5854 (beginning-of-line 0)
5855 (while (org-at-table-hline-p) (beginning-of-line 0))
5856 (org-table-goto-column col)
5857 (skip-chars-forward "^|")
5858 (skip-chars-backward " ")
5859 (insert " " (org-trim s))
5862 (when (looking-at "\\([^|]+\\)+|")
5863 (let ((s (match-string 1)))
5864 (replace-match " |")
5865 (goto-char (match-beginning 0))
5866 (org-table-next-row)
5867 (insert (org-trim s) " ")
5868 (org-table-align))))))
5871 "Remove whitespace at beginning and end of string."
5872 (if (string-match "^[ \t]+" s) (setq s (replace-match "" t t s)))
5873 (if (string-match "[ \t]+$" s) (setq s (replace-match "" t t s))))
5875 (defun org-wrap (string &optional width lines)
5876 "Wrap string to either a number of lines, or a with in characters.
5877 If WIDTH is non-nil, the string is wrapped to that width, however many lines
5878 that costs. If there is a work longer than WIDTH, the text is actually
5879 wrapped to the length of that word.
5880 IF WIDTH is nil and LINES is non-nil, the string is forced into at mot that
5881 many lines, whatever width that takes.
5882 The return value is a list of lines, without newlines at the end."
5883 (let* ((words (org-split-string string "[ \t\n]+"))
5884 (maxword (apply 'max (mapcar 'length words)))
5885 (black (apply '+ (mapcar 'length words)))
5886 (total (+ black (length words)))
5889 (org-do-wrap words (max maxword width)))
5892 (setq ll (org-do-wrap words maxword))
5893 (if (<= (length ll) lines)
5896 (while (> (length ll) lines)
5898 (setq ll (org-do-wrap words w)))
5900 (t (error "Cannot wrap this")))))
5903 (defun org-do-wrap (words width)
5904 "Creates lines of maximum width WIDTH (in characters) from word list WORDS."
5907 (setq line (pop words))
5908 (while (and words (< (+ (length line) (length (car words))) width))
5909 (setq line (concat line " " (pop words))))
5910 (setq lines (push line lines)))
5913 ;; FIXME: I think I can make this more efficient
5914 (defun org-split-string (string &optional separators)
5915 "Splits STRING into substrings at SEPARATORS.
5916 No empty strings are returned if there are matches at the beginning
5918 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
5922 (while (and (string-match rexp string
5924 (= start (match-beginning 0))
5925 (< start (length string)))
5927 (< (match-beginning 0) (length string)))
5929 (or (eq (match-beginning 0) 0)
5930 (and (eq (match-beginning 0) (match-end 0))
5931 (eq (match-beginning 0) start))
5933 (cons (substring string start (match-beginning 0))
5935 (setq start (match-end 0)))
5936 (or (eq start (length string))
5938 (cons (substring string start)
5942 (defun org-table-add-invisible-to-vertical-lines ()
5943 "Add an `invisible' property to vertical lines of current table."
5945 (let* ((beg (org-table-begin))
5946 (end (org-table-end))
5950 (while (< (point) end)
5951 (setq end1 (point-at-eol))
5952 (if (looking-at org-table-dataline-regexp)
5953 (while (re-search-forward "|" end1 t)
5954 (add-text-properties (1- (point)) (point)
5955 '(invisible org-table)))
5956 (while (re-search-forward "[+|]" end1 t)
5957 (add-text-properties (1- (point)) (point)
5958 '(invisible org-table))))
5959 (beginning-of-line 2)))))
5961 (defun org-table-toggle-vline-visibility (&optional arg)
5962 "Toggle the visibility of table vertical lines.
5963 The effect is immediate and on all tables in the file.
5964 With prefix ARG, make lines invisible when ARG if positive, make lines
5965 visible when ARG is not positive"
5968 ((and arg (> (prefix-numeric-value arg) 0)) 'on)
5969 ((and arg (< (prefix-numeric-value arg) 1)) 'off)
5970 (t (if (org-in-invisibility-spec-p '(org-table))
5973 (if (eq action 'off)
5975 (org-remove-from-invisibility-spec '(org-table))
5976 (org-table-map-tables 'org-table-align)
5977 (message "Vertical table lines visible")
5978 (if (org-at-table-p)
5980 (org-add-to-invisibility-spec '(org-table))
5981 (org-table-map-tables 'org-table-align)
5982 (message "Vertical table lines invisible"))
5983 (redraw-frame (selected-frame))))
5985 (defun org-table-map-tables (function)
5986 "Apply FUNCTION to the start of all tables in the buffer."
5990 (goto-char (point-min))
5991 (while (re-search-forward org-table-any-line-regexp nil t)
5992 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size)))
5993 (beginning-of-line 1)
5994 (if (looking-at org-table-line-regexp)
5995 (save-excursion (funcall function)))
5996 (re-search-forward org-table-any-border-regexp nil 1)))))
5998 (defun org-table-sum ()
5999 "Sum numbers in region of current table column.
6000 The result will be displayed in the echo area, and will be available
6001 as kill to be inserted with \\[yank].
6003 If there is an active region, it is interpreted as a rectangle and all
6004 numbers in that rectangle will be summed. If there is no active
6005 region and point is located in a table column, sum all numbers in that
6008 If at least on number looks like a time HH:MM or HH:MM:SS, all other
6009 numbers are assumed to be times as well (in decimal hours) and the
6010 numbers are added as such."
6013 (let (beg end col (timecnt 0) diff h m s)
6014 (if (org-region-active-p)
6015 (setq beg (region-beginning) end (region-end))
6016 (setq col (org-table-current-column))
6017 (goto-char (org-table-begin))
6018 (unless (re-search-forward "^[ \t]*|[^-]" nil t)
6019 (error "No table data"))
6020 (org-table-goto-column col)
6021 (skip-chars-backward "^|")
6023 (goto-char (org-table-end))
6024 (unless (re-search-backward "^[ \t]*|[^-]" nil t)
6025 (error "No table data"))
6026 (org-table-goto-column col)
6027 (skip-chars-forward "^|")
6029 (let* ((l1 (progn (goto-char beg)
6030 (+ (if (bolp) 1 0) (count-lines (point-min) (point)))))
6031 (l2 (progn (goto-char end)
6032 (+ (if (bolp) 1 0) (count-lines (point-min) (point)))))
6033 (items (if (= l1 l2)
6034 (split-string (buffer-substring beg end))
6036 (mapconcat 'identity (extract-rectangle beg end) " "))))
6037 (numbers (delq nil (mapcar 'org-table-get-number-for-summing
6039 (res (apply '+ numbers))
6040 (sres (if (= timecnt 0)
6042 (setq diff (* 3600 res)
6043 h (floor (/ diff 3600)) diff (mod diff 3600)
6044 m (floor (/ diff 60)) diff (mod diff 60)
6046 (format "%d:%02d:%02d" h m s))))
6048 (message (substitute-command-keys
6049 (format "Sum of %d items: %-20s (\\[yank] will insert result into buffer)"
6050 (length numbers) sres)))))))
6052 (defun org-table-get-number-for-summing (s)
6054 (if (string-match "^ *|? *" s)
6055 (setq s (replace-match "" nil nil s)))
6056 (if (string-match " *|? *$" s)
6057 (setq s (replace-match "" nil nil s)))
6058 (setq n (string-to-number s))
6060 ((and (string-match "0" s)
6061 (string-match "\\`[-+ \t0.edED]+\\'" s)) 0)
6062 ((string-match "\\`[ \t]+\\'" s) nil)
6063 ((string-match "\\`\\([0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?\\'" s)
6064 (let ((h (string-to-number (or (match-string 1 s) "0")))
6065 (m (string-to-number (or (match-string 2 s) "0")))
6066 (s (string-to-number (or (match-string 4 s) "0"))))
6067 (if (boundp 'timecnt) (setq timecnt (1+ timecnt)))
6068 (* 1.0 (+ h (/ m 60.0) (/ s 3600.0)))))
6072 (defvar org-table-current-formula nil)
6073 (defvar org-table-formula-history nil)
6074 (defun org-table-get-formula (current)
6075 (if (and current (not (equal "" org-table-current-formula)))
6076 org-table-current-formula
6077 (setq org-table-current-formula
6079 "Formula [last]: " "" 'org-table-formula-history
6080 org-table-current-formula))))
6082 (defun org-this-word ()
6083 ;; Get the current word
6085 (let ((beg (progn (skip-chars-backward "^ \t\n") (point)))
6086 (end (progn (skip-chars-forward "^ \t\n") (point))))
6087 (buffer-substring-no-properties beg end))))
6089 (defun org-table-eval-formula (&optional ndown)
6090 "Replace the table field value at the cursor by the result of a calculation.
6092 This function makes use of Dave Gillespie's calc package, arguably the most
6093 exciting program ever written for GNU Emacs. So you need to have calc
6094 installed in order to use this function.
6096 In a table, this command replaces the value in the current field with the
6097 result of a formula. While nowhere near the computation options of a
6098 spreadsheet program, this is still very useful. Note that there is no
6099 automatic updating of a calculated field, nor will the field remember the
6100 formula. The command needs to be applied again after changing input
6103 When called, the command first prompts for a formula, which is read in the
6104 minibuffer. Previously entered formulae are available through the history
6105 list, and the last used formula is the default, reachable by simply
6108 The formula can be any algebraic expression understood by the calc package.
6109 Before evaluation, variable substitution takes place: \"$\" is replaced by
6110 the field the cursor is currently in, and $1..$n reference the fields in
6111 the current row. Values from a *different* row can *not* be referenced
6112 here, so the command supports only horizontal computing. The formula can
6113 contain an optional printf format specifier after a semicolon, to reformat
6116 A few examples for formulae:
6117 $1+$2 Sum of first and second field
6118 $1+$2;%f.2 Same, and format result to two digits after dec.point
6119 exp($2)+exp($1) Math functions can be used
6120 $;%f.1 Reformat current cell to 1 digit after dec.point
6121 ($3-32)*5/9 degrees F -> C conversion
6123 When called with a raw C-u prefix, the formula is applied to the current
6124 field, and to the same same column in all following rows, until reaching a
6125 horizontal line or the end of the table. When the command is called with a
6126 numeric prefix argument (like M-3 or C-7 or C-u 24), the formula is applied
6127 to the current row, and to the following n-1 rows (but not beyond a
6130 (setq ndown (if (equal ndown '(4)) 10000 (prefix-numeric-value ndown)))
6132 (org-table-check-inside-data-field)
6134 (org-table-automatic-realign nil)
6136 (formula (org-table-get-formula nil))
6137 (n0 (org-table-current-column))
6139 (if (string-match ";" formula)
6140 (let ((tmp (org-split-string formula ";")))
6141 (setq formula (car tmp) fmt (nth 1 tmp))))
6143 (setq fields (org-split-string
6144 (concat " " (buffer-substring
6145 (point-at-bol) (point-at-eol))) "|"))
6146 (setq ndown (1- ndown))
6147 (setq form (copy-sequence formula))
6148 (while (string-match "\\$\\([0-9]+\\)?" form)
6149 (setq n (if (match-beginning 1)
6150 (string-to-int (match-string 1 form))
6153 (unless x (error "Invalid field specifier \"%s\""
6154 (match-string 0 form)))
6155 (if (equal (string-to-number x) 0) (setq x "0"))
6156 (setq form (replace-match x t t form)))
6157 (setq ev (calc-eval (list form) 'num))
6159 (error "Invalid expression: %s (%s at %d)" form (nth 1 ev) (car ev)))
6160 (org-table-blank-field)
6162 (insert (format fmt (string-to-number ev)))
6164 (if (and down (> ndown 0) (looking-at ".*\n[ \t]*|[^-]"))
6165 (call-interactively 'org-return)
6169 ;;; The orgtbl minor mode
6171 ;; Define a minor mode which can be used in other modes in order to
6172 ;; integrate the org-mode table editor.
6174 ;; This is really a hack, because the org-mode table editor uses several
6175 ;; keys which normally belong to the major mode, for example the TAB and
6176 ;; RET keys. Here is how it works: The minor mode defines all the keys
6177 ;; necessary to operate the table editor, but wraps the commands into a
6178 ;; function which tests if the cursor is currently inside a table. If that
6179 ;; is the case, the table editor command is executed. However, when any of
6180 ;; those keys is used outside a table, the function uses `key-binding' to
6181 ;; look up if the key has an associated command in another currently active
6182 ;; keymap (minor modes, major mode, global), and executes that command.
6183 ;; There might be problems if any of the keys used by the table editor is
6184 ;; otherwise used as a prefix key.
6186 ;; Another challenge is that the key binding for TAB can be tab or \C-i,
6187 ;; likewise the binding for RET can be return or \C-m. Orgtbl-mode
6188 ;; addresses this by checking explicitly for both bindings.
6190 ;; The optimized version (see variable `orgtbl-optimized') takes over
6191 ;; all keys which are bound to `self-insert-command' in the *global map*.
6192 ;; Some modes bind other commands to simple characters, for example
6193 ;; AUCTeX binds the double quote to `Tex-insert-quote'. With orgtbl-mode
6194 ;; active, this binding is ignored inside tables and replaced with a
6195 ;; modified self-insert.
6197 (defcustom orgtbl-optimized (eq org-enable-table-editor 'optimized)
6198 "Non-nil means, use the optimized table editor version for orgtbl-mode.
6199 In the optimized version, the table editor takes over all simple keys that
6200 normally just insert a character. In tables, the characters are inserted
6201 in a way to minimize disturbing the table structure (i.e. in overwrite mode
6202 for empty fields). Outside tables, the correct binding of the keys is
6205 The default for this option is t if the optimized version is also used in
6206 Org-mode. See the variable `org-enable-table-editor' for details. Changing
6207 this variable requires a restart of Emacs to become effective."
6211 (defvar orgtbl-mode nil
6212 "Variable controlling orgtbl-mode, a minor mode enabling the org-mode
6213 table editor iin arbitrary modes.")
6214 (make-variable-buffer-local 'orgtbl-mode)
6216 (defvar orgtbl-mode-map (make-sparse-keymap)
6217 "Keymap for orgtbl-mode.")
6220 (defun turn-on-orgtbl ()
6221 "Unconditionally turn on orgtbl-mode."
6225 (defun orgtbl-mode (&optional arg)
6226 "The org-mode table editor as a minor mode for use in other modes."
6229 (if arg (> (prefix-numeric-value arg) 0) (not orgtbl-mode)))
6232 (set (make-local-variable (quote org-table-may-need-update)) t)
6233 (make-local-hook (quote before-change-functions))
6234 (add-hook 'before-change-functions 'org-before-change-function
6236 (set (make-local-variable 'org-old-auto-fill-inhibit-regexp)
6237 auto-fill-inhibit-regexp)
6238 (set (make-local-variable 'auto-fill-inhibit-regexp)
6239 (if auto-fill-inhibit-regexp
6240 (concat "\\([ \t]*|\\|" auto-fill-inhibit-regexp)
6242 (easy-menu-add orgtbl-mode-menu)
6243 (run-hooks (quote orgtbl-mode-hook)))
6244 (setq auto-fill-inhibit-regexp org-old-auto-fill-inhibit-regexp)
6245 (remove-hook 'before-change-functions 'org-before-change-function t)
6246 (easy-menu-remove orgtbl-mode-menu)
6247 (force-mode-line-update 'all)))
6249 ;; Install it as a minor mode.
6250 (put 'orgtbl-mode :included t)
6251 (put 'orgtbl-mode :menu-tag "Org Table Mode")
6252 (add-minor-mode 'orgtbl-mode " OrgTbl" orgtbl-mode-map)
6254 (defun orgtbl-make-binding (fun &rest keys)
6255 "Create a function for binding in the table minor mode."
6256 (list 'lambda '(arg) '(interactive "p")
6259 (list 'call-interactively (list 'quote fun))
6260 (list 'let '(orgtbl-mode)
6261 (list 'call-interactively
6264 (list 'key-binding k))
6266 '('orgtbl-error)))))))
6268 (defun orgtbl-error ()
6269 "Error when there is no default binding for a table key."
6271 (error "This key is has no function outside tables"))
6273 ;; Keybindings for the minor mode
6275 '(([(meta shift left)] org-table-delete-column)
6276 ([(meta left)] org-table-move-column-left)
6277 ([(meta right)] org-table-move-column-right)
6278 ([(meta shift right)] org-table-insert-column)
6279 ([(meta shift up)] org-table-kill-row)
6280 ([(meta shift down)] org-table-insert-row)
6281 ([(meta up)] org-table-move-row-up)
6282 ([(meta down)] org-table-move-row-down)
6283 ("\C-c\C-w" org-table-cut-region)
6284 ("\C-c\M-w" org-table-copy-region)
6285 ("\C-c\C-y" org-table-paste-rectangle)
6286 ("\C-c-" org-table-insert-hline)
6287 ([(shift tab)] org-table-previous-field)
6288 ("\C-c\C-c" org-table-align)
6289 ([(return)] org-table-next-row)
6290 ([(shift return)] org-table-copy-down)
6291 ([(meta return)] org-table-wrap-region)
6292 ("\C-c\C-q" org-table-wrap-region)
6293 ("\C-c?" org-table-current-column)
6294 ("\C-c " org-table-blank-field)
6295 ("\C-c+" org-table-sum)
6296 ("\C-c|" org-table-toggle-vline-visibility)
6297 ("\C-c=" org-table-eval-formula)))
6299 (while (setq elt (pop bindings))
6302 cmd (orgtbl-make-binding fun key))
6303 (define-key orgtbl-mode-map key cmd)))
6305 ;; Special treatment needed for TAB and RET
6306 ;(define-key orgtbl-mode-map [(return)]
6307 ; (orgtbl-make-binding 'org-table-next-row [(return)] "\C-m"))
6308 ;(define-key orgtbl-mode-map "\C-m"
6309 ; (orgtbl-make-binding 'org-table-next-row "\C-m" [(return)]))
6310 ;(define-key orgtbl-mode-map [(tab)]
6311 ; (orgtbl-make-binding 'org-table-next-field [(tab)] "\C-i"))
6312 ;(define-key orgtbl-mode-map "\C-i"
6313 ; (orgtbl-make-binding 'org-table-next-field "\C-i" [(tab)]))
6315 (define-key orgtbl-mode-map [(return)]
6316 (orgtbl-make-binding 'orgtbl-ret [(return)] "\C-m"))
6317 (define-key orgtbl-mode-map "\C-m"
6318 (orgtbl-make-binding 'orgtbl-ret "\C-m" [(return)]))
6319 (define-key orgtbl-mode-map [(tab)]
6320 (orgtbl-make-binding 'orgtbl-tab [(tab)] "\C-i"))
6321 (define-key orgtbl-mode-map "\C-i"
6322 (orgtbl-make-binding 'orgtbl-tab "\C-i" [(tab)]))
6324 (when orgtbl-optimized
6325 ;; If the user wants maximum table support, we need to hijack
6326 ;; some standard editing functions
6327 (substitute-key-definition 'self-insert-command 'orgtbl-self-insert-command
6328 orgtbl-mode-map global-map)
6329 (substitute-key-definition 'delete-char 'orgtbl-delete-char
6330 orgtbl-mode-map global-map)
6331 (substitute-key-definition 'delete-backward-char 'orgtbl-delete-backward-char
6332 orgtbl-mode-map global-map)
6333 (define-key org-mode-map "|" 'self-insert-command))
6335 (defun orgtbl-tab ()
6336 "Justification and field motion for orgtbl-mode."
6338 (org-table-justify-field-maybe)
6339 (org-table-next-field))
6341 (defun orgtbl-ret ()
6342 "Justification and field motion for orgtbl-mode."
6344 (org-table-justify-field-maybe)
6345 (org-table-next-row))
6347 (defun orgtbl-self-insert-command (N)
6348 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
6349 If the cursor is in a table looking at whitespace, the whitespace is
6350 overwritten, and the table is not marked as requiring realignment."
6352 (if (and (org-at-table-p)
6354 (looking-at "[^|\n]* +|"))
6355 (let (org-table-may-need-update (pos (point)))
6356 (goto-char (1- (match-end 0)))
6357 (delete-backward-char 1)
6358 (goto-char (match-beginning 0))
6359 (self-insert-command N))
6360 (setq org-table-may-need-update t)
6362 (call-interactively (key-binding (vector last-input-event))))))
6364 (defun orgtbl-delete-backward-char (N)
6365 "Like `delete-backward-char', insert whitespace at field end in tables.
6366 When deleting backwards, in tables this function will insert whitespace in
6367 front of the next \"|\" separator, to keep the table aligned. The table will
6368 still be marked for re-alignment, because a narrow field may lead to a
6369 reduced column width."
6371 (if (and (org-at-table-p)
6373 (looking-at ".*?|"))
6374 (let ((pos (point)))
6375 (backward-delete-char N)
6376 (skip-chars-forward "^|")
6378 (goto-char (1- pos)))
6379 (message "%s" last-input-event) (sit-for 1)
6380 (delete-backward-char N)))
6382 (defun orgtbl-delete-char (N)
6383 "Like `delete-char', but insert whitespace at field end in tables.
6384 When deleting characters, in tables this function will insert whitespace in
6385 front of the next \"|\" separator, to keep the table aligned. The table
6386 will still be marked for re-alignment, because a narrow field may lead to
6387 a reduced column width."
6389 (if (and (org-at-table-p)
6391 (if (looking-at ".*?|")
6392 (let ((pos (point)))
6393 (replace-match (concat
6394 (substring (match-string 0) 1 -1)
6399 (easy-menu-define orgtbl-mode-menu orgtbl-mode-map "OrgTbl menu"
6401 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p) :keys "C-c C-c"]
6402 ["Next field" org-cycle :active (org-at-table-p) :keys "TAB"]
6403 ["Previous Field" org-shifttab :active (org-at-table-p) :keys "S-TAB"]
6404 ["Next row" org-return :active (org-at-table-p) :keys "RET"]
6406 ["Blank field" org-table-blank-field :active (org-at-table-p) :keys "C-c SPC"]
6407 ["Copy field from above"
6408 org-table-copy-down :active (org-at-table-p) :keys "S-RET"]
6411 ["Move column left" org-metaleft :active (org-at-table-p) :keys "M-<left>"]
6412 ["Move column right" org-metaright :active (org-at-table-p) :keys "M-<right>"]
6413 ["Delete column" org-shiftmetaleft :active (org-at-table-p) :keys "M-S-<left>"]
6414 ["Insert column" org-shiftmetaright :active (org-at-table-p) :keys "M-S-<right>"])
6416 ["Move row up" org-metaup :active (org-at-table-p) :keys "M-<up>"]
6417 ["Move row down" org-metadown :active (org-at-table-p) :keys "M-<down>"]
6418 ["Delete row" org-shiftmetaup :active (org-at-table-p) :keys "M-S-<up>"]
6419 ["Insert row" org-shiftmetadown :active (org-at-table-p) :keys "M-S-<down>"]
6421 ["Insert hline" org-table-insert-hline :active (org-at-table-p) :keys "C-c -"])
6423 ["Copy rectangle" org-copy-special :active (org-at-table-p) :keys "C-c M-w"]
6424 ["Cut rectangle" org-cut-special :active (org-at-table-p) :keys "C-c C-w"]
6425 ["Paste rectangle" org-paste-special :active (org-at-table-p) :keys "C-c C-y"]
6426 ["Fill rectangle" org-table-wrap-region :active (org-at-table-p) :keys "C-c C-q"])
6428 ["Which column?" org-table-current-column :active (org-at-table-p) :keys "C-c ?"]
6429 ["Sum column/rectangle" org-table-sum
6430 :active (or (org-at-table-p) (org-region-active-p)) :keys "C-c +"]
6431 ["Eval formula" org-table-eval-formula :active (org-at-table-p) :keys "C-c ="]
6436 (defconst org-level-max 20)
6438 (defun org-export-find-first-heading-line (list)
6439 "Remove all lines from LIST which are before the first headline."
6440 (let ((orig-list list)
6441 (re (concat "^" outline-regexp)))
6443 (not (string-match re (car list))))
6445 (or list orig-list)))
6447 (defun org-skip-comments (lines)
6448 "Skip lines starting with \"#\" and subtrees starting with COMMENT."
6449 (let ((re1 (concat "^\\(\\*+\\)[ \t]+" org-comment-string))
6450 (re2 "^\\(\\*+\\)[ \t\n\r]")
6452 (while (setq line (pop lines))
6454 ((and (string-match re1 line)
6455 (setq level (- (match-end 1) (match-beginning 1))))
6456 ;; Beginning of a COMMENT subtree. Skip it.
6457 (while (and (setq line (pop lines))
6458 (or (not (string-match re2 line))
6459 (> (- (match-end 1) (match-beginning 1)) level))))
6460 (setq lines (cons line lines)))
6461 ((string-match "^#" line)
6462 ;; an ordinary comment line
6464 (t (setq rtn (cons line rtn)))))
6469 (defconst org-ascii-underline '(?\$ ?\# ?^ ?\~ ?\= ?\-)
6470 "Characters for underlining headings in ASCII export.")
6472 (defconst org-html-entities
6512 ("Aring") ("AA"."Å")
6601 ("varepsilon"."ε")
6614 ("sigmaf") ("varsigma"."ς")
6622 ("thetasym") ("vartheta"."ϑ")
6625 ("bull") ("bullet"."•")
6626 ("hellip") ("dots"."…")
6636 ("larr") ("leftarrow"."←") ("gets"."←")
6637 ("uarr") ("uparrow"."↑")
6638 ("rarr") ("to"."→") ("rightarrow"."→")
6639 ("darr")("downarrow"."↓")
6640 ("harr") ("leftrightarrow"."↔")
6641 ("crarr") ("hookleftarrow"."↵") ; has round hook, not quite CR
6642 ("lArr") ("Leftarrow"."⇐")
6643 ("uArr") ("Uparrow"."⇑")
6644 ("rArr") ("Rightarrow"."⇒")
6645 ("dArr") ("Downarrow"."⇓")
6646 ("hArr") ("Leftrightarrow"."⇔")
6648 ("part") ("partial"."∂")
6649 ("exist") ("exists"."∃")
6650 ("empty") ("emptyset"."∅")
6652 ("isin") ("in"."∈")
6658 ("lowast") ("ast"."∗")
6660 ("prop") ("proptp"."∝")
6661 ("infin") ("infty"."∞")
6662 ("ang") ("angle"."∠")
6663 ("and") ("vee"."∧")
6664 ("or") ("wedge"."∨")
6670 ("cong") ("simeq"."≅")
6671 ("asymp")("approx"."≈")
6672 ("ne") ("neq"."≠")
6676 ("sub") ("subset"."⊂")
6677 ("sup") ("supset"."⊃")
6684 ("sdot") ("cdot"."⋅")
6691 ("loz") ("Diamond"."◊")
6692 ("spades") ("spadesuit"."♠")
6693 ("clubs") ("clubsuit"."♣")
6694 ("hearts") ("diamondsuit"."♥")
6695 ("diams") ("diamondsuit"."♦")
6762 "Entities for TeX->HTML translation.
6763 Entries can be like (\"ent\"), in which case \"\\ent\" will be translated to
6764 \"&ent;\". An entry can also be a dotted pair like (\"ent\".\"&other;\").
6765 In that case, \"\\ent\" will be translated to \"&other;\".
6766 The list contains HTML entities for Latin-1, Greek and other symbols.
6767 It is supplemented by a number of commonly used TeX macros with appropriate
6770 (defun org-export-as-ascii (arg)
6771 "Export the outline as a pretty ASCII file.
6772 If there is an active region, export only the region.
6773 The prefix ARG specifies how many levels of the outline should become
6774 underlined headlines. The default is 3."
6776 (setq-default org-todo-line-regexp org-todo-line-regexp)
6779 (if (org-region-active-p) (region-beginning) (point-min))
6780 (if (org-region-active-p) (region-end) (point-max))))
6781 (lines (org-export-find-first-heading-line
6782 (org-skip-comments (org-split-string region "[\r\n]"))))
6783 (org-startup-with-deadline-check nil)
6786 (case-fold-search nil)
6787 (filename (concat (file-name-sans-extension (buffer-file-name))
6789 (buffer (find-file-noselect filename))
6790 (levels-open (make-vector org-level-max nil))
6791 (date (format-time-string "%Y/%m/%d" (current-time)))
6792 (time (format-time-string "%X" (current-time)))
6793 (author user-full-name)
6794 (title (buffer-name))
6796 (email user-mail-address)
6797 (language org-export-default-language)
6803 (org-init-section-numbers)
6805 (find-file-noselect filename)
6807 ;; Search for the export key lines
6808 (org-parse-key-lines)
6810 (setq lang-words (or (assoc language org-export-language-setup)
6811 (assoc "en" org-export-language-setup)))
6812 (if org-export-ascii-show-new-buffer
6813 (switch-to-buffer-other-window buffer)
6814 (set-buffer buffer))
6817 (if options (org-parse-export-options options))
6818 (setq umax (if arg (prefix-numeric-value arg)
6819 org-export-headline-levels))
6822 (if title (org-insert-centered title ?=))
6824 (if (or author email)
6825 (insert (concat (nth 1 lang-words) ": " (or author "")
6826 (if email (concat " <" email ">") "")
6829 (insert (concat (nth 2 lang-words) ": " date " " time "\n")))
6830 (if text (insert (concat (org-html-expand-for-ascii text) "\n\n")))
6834 (if org-export-with-toc
6836 (insert (nth 3 lang-words) "\n"
6837 (make-string (length (nth 3 lang-words)) ?=) "\n")
6838 (mapcar '(lambda (line)
6839 (if (string-match org-todo-line-regexp
6841 ;; This is a headline
6843 (setq level (- (match-end 1) (match-beginning 1))
6844 txt (match-string 3 line)
6846 (or (and (match-beginning 2)
6847 (not (equal (match-string 2 line)
6851 (org-search-todo-below
6852 line lines level))))
6853 (setq txt (org-html-expand-for-ascii txt))
6855 (if org-export-with-section-numbers
6856 (setq txt (concat (org-section-number level)
6861 (make-string (* (1- level) 4) ?\ )
6862 (format (if todo "%s (*)\n" "%s\n") txt))
6863 (setq last-level level))
6867 (org-init-section-numbers)
6868 (while (setq line (pop lines))
6869 ;; Remove the quoted HTML tags.
6870 (setq line (org-html-expand-for-ascii line))
6872 ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
6874 (setq level (- (match-end 1) (match-beginning 1))
6875 txt (match-string 2 line))
6876 (org-ascii-level-start level txt umax))
6877 (t (insert line "\n"))))
6880 (goto-char (point-min))))
6882 (defun org-search-todo-below (line lines level)
6883 "Search the subtree below LINE for any TODO entries."
6884 (let ((rest (cdr (memq line lines)))
6885 (re org-todo-line-regexp)
6888 (while (setq line (pop rest))
6889 (if (string-match re line)
6891 (setq lv (- (match-end 1) (match-beginning 1))
6892 todo (and (match-beginning 2)
6893 (not (equal (match-string 2 line)
6896 (if (<= lv level) (throw 'exit nil))
6897 (if todo (throw 'exit t))))))))
6899 ;; FIXME: Try to handle <b> and <i> as faces via text properties.
6900 ;; FIXME: Can I implement *bold*,/italic/ and _underline_ for AXCII export?
6901 (defun org-html-expand-for-ascii (line)
6902 "Handle quoted HTML for ASCII export."
6903 (if org-export-html-expand
6904 (while (string-match "@<[^<>\n]*>" line)
6905 ;; We just remove the tags for now.
6906 (setq line (replace-match "" nil nil line))))
6909 (defun org-insert-centered (s &optional underline)
6910 "Insert the string S centered and underline it with character UNDERLINE."
6911 (let ((ind (max (/ (- 80 (length s)) 2) 0)))
6912 (insert (make-string ind ?\ ) s "\n")
6914 (insert (make-string ind ?\ )
6915 (make-string (length s) underline)
6918 (defun org-ascii-level-start (level title umax)
6919 "Insert a new level in ASCII export."
6922 (insert (make-string (* 2 (- level umax 1)) ?\ ) "* " title "\n")
6923 (if (or (not (equal (char-before) ?\n))
6924 (not (equal (char-before (1- (point))) ?\n)))
6926 (setq char (nth (- umax level) (reverse org-ascii-underline)))
6927 (if org-export-with-section-numbers
6928 (setq title (concat (org-section-number level) " " title)))
6929 (insert title "\n" (make-string (string-width title) char) "\n"))))
6931 (defun org-export-copy-visible (&optional arg)
6932 "Copy the visible part of the buffer to another buffer, for printing.
6933 Also removes the first line of the buffer it is specifies a mode,
6934 and all options lines."
6936 (let* ((filename (concat (file-name-sans-extension (buffer-file-name))
6938 (buffer (find-file-noselect filename))
6940 (org-make-options-regexp
6941 '("CATEGORY" "SEQ_TODO" "PRI_TODO" "TYP_TODO" "STARTUP"
6942 "TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE"))
6943 (if org-noutline-p "\\(\n\\|$\\)" "")))
6950 (setq s (goto-char (point-min)))
6951 (while (not (= (point) (point-max)))
6952 (goto-char (org-find-invisible))
6953 (append-to-buffer buffer s (point))
6954 (setq s (goto-char (org-find-visible)))))
6955 (switch-to-buffer-other-window buffer)
6957 (goto-char (point-min))
6958 (if (looking-at ".*-\\*- mode:.*\n")
6960 (while (re-search-forward ore nil t)
6962 (goto-char (point-min))))
6964 (defun org-find-visible ()
6965 (if (featurep 'noutline)
6967 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
6968 (get-char-property s 'invisible)))
6970 (skip-chars-forward "^\n")
6972 (defun org-find-invisible ()
6973 (if (featurep 'noutline)
6975 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
6976 (not (get-char-property s 'invisible))))
6978 (skip-chars-forward "^\r")
6983 (defun org-get-current-options ()
6984 "Return a string with current options as keyword options.
6985 Does include HTML export options as well as TODO and CATEGORY stuff."
6991 #+TEXT: Some descriptive text to be emitted. Several lines OK.
6992 #+OPTIONS: H:%d num:%s toc:%s \\n:%s @:%s ::%s |:%s ^:%s *:%s TeX:%s
6998 (buffer-name) (user-full-name) user-mail-address org-export-default-language
6999 org-export-headline-levels
7000 org-export-with-section-numbers
7002 org-export-preserve-breaks
7003 org-export-html-expand
7004 org-export-with-fixed-width
7005 org-export-with-tables
7006 org-export-with-sub-superscripts
7007 org-export-with-emphasize
7008 org-export-with-TeX-macros
7009 (file-name-nondirectory (buffer-file-name))
7010 (if (equal org-todo-interpretation 'sequence)
7011 (mapconcat 'identity org-todo-keywords " ")
7012 "TODO FEEDBACK VERIFY DONE")
7013 (if (equal org-todo-interpretation 'type)
7014 (mapconcat 'identity org-todo-keywords " ")
7015 "Me Jason Marie DONE")
7016 (if org-startup-folded "fold" "nofold")
7017 (if org-startup-with-deadline-check "dlcheck" "nodlcheck")
7020 (defun org-insert-export-options-template ()
7021 "Insert into the buffer a template with information for exporting."
7023 (if (not (bolp)) (newline))
7024 (let ((s (org-get-current-options)))
7025 (and (string-match "#\\+CATEGORY" s)
7026 (setq s (substring s 0 (match-beginning 0))))
7029 (defun org-toggle-fixed-width-section (arg)
7030 "Toggle the fixed-width indicator at the beginning of lines in the region.
7031 If there is no active region, only acts on the current line.
7032 If the first non-white character in the first line of the region is a
7033 vertical bar \"|\", then the command removes the bar from all lines in
7034 the region. If the first character is not a bar, the command adds a
7035 bar to all lines, in the column given by the beginning of the region.
7037 If there is a numerical prefix ARG, create ARG new lines starting with \"|\"."
7040 (regionp (org-region-active-p))
7041 (beg (if regionp (region-beginning) (point)))
7042 (end (if regionp (region-end)))
7043 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
7044 (re "[ \t]*\\(:\\)")
7048 (setq cc (current-column))
7049 (beginning-of-line 1)
7050 (setq off (looking-at re))
7052 (setq nlines (1- nlines))
7053 (beginning-of-line 1)
7056 (move-to-column cc t)
7059 ((and off (looking-at re))
7060 (replace-match "" t t nil 1))
7061 ((not off) (move-to-column cc t) (insert ":")))
7062 (forward-line 1)))))
7064 (defun org-export-as-html-and-open (arg)
7065 "Export the outline as HTML and immediately open it with a browser.
7066 If there is an active region, export only the region.
7067 The prefix ARG specifies how many levels of the outline should become
7068 headlines. The default is 3. Lower levels will become bulleted lists."
7070 (org-export-as-html arg 'hidden)
7071 (org-open-file (buffer-file-name)))
7073 (defun org-export-as-html-batch ()
7074 "Call org-export-as-html, may be used in batch processing as
7076 --load=$HOME/lib/emacs/org.el
7077 --eval \"(setq org-export-headline-levels 2)\"
7078 --visit=MyFile --funcall org-export-as-html-batch"
7079 (org-export-as-html org-export-headline-levels 'hidden))
7081 (defun org-export-as-html (arg &optional hidden)
7082 "Export the outline as a pretty HTML file.
7083 If there is an active region, export only the region.
7084 The prefix ARG specifies how many levels of the outline should become
7085 headlines. The default is 3. Lower levels will become bulleted lists."
7087 (setq-default org-todo-line-regexp org-todo-line-regexp)
7088 (setq-default org-deadline-line-regexp org-deadline-line-regexp)
7089 (setq-default org-done-string org-done-string)
7090 (let* ((region-p (org-region-active-p))
7093 (if region-p (region-beginning) (point-min))
7094 (if region-p (region-end) (point-max))))
7096 (org-skip-comments (org-split-string region "[\r\n]")))
7097 (lines (org-export-find-first-heading-line all_lines))
7098 (level 0) (line "") (origline "") txt todo
7101 (filename (concat (file-name-sans-extension (buffer-file-name))
7103 (buffer (find-file-noselect filename))
7104 (levels-open (make-vector org-level-max nil))
7105 (date (format-time-string "%Y/%m/%d" (current-time)))
7106 (time (format-time-string "%X" (current-time)))
7107 (author user-full-name)
7108 (title (buffer-name))
7110 (email user-mail-address)
7111 (language org-export-default-language)
7116 table-buffer table-orig-buffer
7118 (message "Exporting...")
7120 (org-init-section-numbers)
7122 ;; Search for the export key lines
7123 (org-parse-key-lines)
7124 (setq lang-words (or (assoc language org-export-language-setup)
7125 (assoc "en" org-export-language-setup)))
7127 ;; Switch to the output buffer
7128 (if (or hidden (not org-export-html-show-new-buffer))
7130 (switch-to-buffer-other-window buffer))
7133 (let ((case-fold-search nil))
7134 (if options (org-parse-export-options options))
7135 (setq umax (if arg (prefix-numeric-value arg)
7136 org-export-headline-levels))
7140 "<html lang=\"%s\"><head>
7142 <meta http-equiv=\"Content-Type\" content=\"text/html\">
7143 <meta name=generator content=\"Org-mode\">
7144 <meta name=generated content=\"%s %s\">
7145 <meta name=author content=\"%s\">
7148 language (org-html-expand title) date time author))
7149 (if title (insert (concat "<H1 align=\"center\">"
7150 (org-html-expand title) "</H1>\n")))
7151 (if author (insert (concat (nth 1 lang-words) ": " author "\n")))
7152 (if email (insert (concat "<a href=\"mailto:" email "\"><"
7153 email "></a>\n")))
7154 (if (or author email) (insert "<br>\n"))
7155 (if (and date time) (insert (concat (nth 2 lang-words) ": "
7156 date " " time "<br>\n")))
7157 (if text (insert (concat "<p>\n" (org-html-expand text))))
7158 (if org-export-with-toc
7160 (insert (format "<H2>%s</H2>\n" (nth 3 lang-words)))
7162 (mapcar '(lambda (line)
7163 (if (string-match org-todo-line-regexp line)
7164 ;; This is a headline
7166 (setq level (- (match-end 1) (match-beginning 1))
7167 txt (save-match-data
7169 (match-string 3 line)))
7171 (or (and (match-beginning 2)
7172 (not (equal (match-string 2 line)
7176 (org-search-todo-below
7177 line lines level))))
7178 (if org-export-with-section-numbers
7179 (setq txt (concat (org-section-number level)
7183 (setq head-count (+ head-count 1))
7184 (if (> level last-level)
7186 (setq cnt (- level last-level))
7187 (while (>= (setq cnt (1- cnt)) 0)
7190 (if (< level last-level)
7192 (setq cnt (- last-level level))
7193 (while (>= (setq cnt (1- cnt)) 0)
7199 "<li><a href=\"#sec-%d\"><span style='color:red'>%s</span></a></li>\n"
7200 "<li><a href=\"#sec-%d\">%s</a></li>\n")
7202 (setq last-level level))
7205 (while (> last-level 0)
7206 (setq last-level (1- last-level))
7210 (org-init-section-numbers)
7212 (while (setq line (pop lines) origline line)
7213 ;; replace "<" and ">" by "<" and ">"
7214 ;; handle @<..> HTML tags (replace "@>..<" by "<..>")
7215 (setq line (org-html-expand line))
7218 (if (and org-export-with-fixed-width
7219 (string-match "^[ \t]*:\\(.*\\)" line))
7221 (let ((l (match-string 1 line)))
7222 (while (string-match " " l)
7223 (setq l (replace-match " " t t l)))
7224 (insert "\n<span style='font-family:Courier'>"
7227 (not (string-match "^[ \t]+\\(:.*\\)"
7231 (when (string-match org-link-regexp line)
7232 (setq type (match-string 1 line))
7234 ((member type '("http" "https" "ftp" "mailto" "news"))
7236 (setq line (replace-match
7237 "<a href=\"\\1:\\2\"><\\1:\\2></a>"
7239 ((string= type "file")
7242 (let* ((filename (match-string 2 line))
7245 (string-match (org-image-file-name-regexp) filename))))
7246 (setq line (replace-match
7247 (if (and org-export-html-inline-images
7249 "<img src=\"\\2\"/>"
7250 "<a href=\"\\2\">\\1:\\2</a>")
7253 ((member type '("bbdb" "vm" "wl" "rmail" "gnus" "shell"))
7254 (setq line (replace-match
7255 "<i><\\1:\\2></i>" nil nil line)))))
7258 (if (and (string-match org-todo-line-regexp line)
7259 (match-beginning 2))
7260 (if (equal (match-string 2 line) org-done-string)
7261 (setq line (replace-match
7262 "<span style='color:green'>\\2</span>"
7264 (setq line (replace-match "<span style='color:red'>\\2</span>"
7268 (if (string-match org-deadline-line-regexp line)
7270 (if (save-match-data
7271 (string-match "<a href"
7272 (substring line 0 (match-beginning 0))))
7273 nil ; Don't do the replacement - it is inside a link
7274 (setq line (replace-match "<span style='color:red'>\\&</span>"
7278 ((string-match "^\\(\\*+\\)[ \t]*\\(.*\\)" line)
7279 ;; This is a headline
7280 (setq level (- (match-end 1) (match-beginning 1))
7281 txt (match-string 2 line))
7282 (if (<= level umax) (setq head-count (+ head-count 1)))
7283 (org-html-level-start level txt umax
7284 (and org-export-with-toc (<= level umax))
7287 ((and org-export-with-tables
7288 (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)" line))
7289 (if (not table-open)
7291 (setq table-open t table-buffer nil table-orig-buffer nil))
7293 (setq table-buffer (cons line table-buffer)
7294 table-orig-buffer (cons origline table-orig-buffer))
7295 (when (or (not lines)
7296 (not (string-match "^\\([ \t]*\\)\\(|\\|\\+-+\\+\\)"
7298 (setq table-open nil
7299 table-buffer (nreverse table-buffer)
7300 table-orig-buffer (nreverse table-orig-buffer))
7301 (insert (org-format-table-html table-buffer table-orig-buffer))))
7304 ;; Lines starting with "-", and empty lines make new paragraph.
7305 (if (string-match "^ *-\\|^[ \t]*$" line) (insert "<p>"))
7306 (insert line (if org-export-preserve-breaks "<br>\n" "\n"))))
7308 (if org-export-html-with-timestamp
7309 (insert org-export-html-html-helper-timestamp))
7310 (insert "</body>\n</html>\n")
7313 (goto-char (point-min)))))
7315 (defun org-format-table-html (lines olines)
7316 "Find out which HTML converter to use and return the HTML code."
7317 (if (string-match "^[ \t]*|" (car lines))
7318 ;; A normal org table
7319 (org-format-org-table-html lines)
7320 ;; Table made by table.el - test for spanning
7321 (let* ((hlines (delq nil (mapcar
7323 (if (string-match "^[ \t]*\\+-" x) x
7326 (first (car hlines))
7327 (ll (and (string-match "\\S-+" first)
7328 (match-string 0 first)))
7329 (re (concat "^[ \t]*" (regexp-quote ll)))
7330 (spanning (delq nil (mapcar (lambda (x) (not (string-match re x)))
7332 (if (and (not spanning)
7333 (not org-export-prefer-native-exporter-for-tables))
7334 ;; We can use my own converter with HTML conversions
7335 (org-format-table-table-html lines)
7336 ;; Need to use the code generator in table.el, with the original text.
7337 (org-format-table-table-html-using-table-generate-source olines)))))
7339 (defun org-format-org-table-html (lines)
7340 "Format a table into html."
7341 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
7342 (setq lines (nreverse lines))
7343 (if (string-match "^[ \t]*|-" (car lines)) (setq lines (cdr lines)))
7344 (setq lines (nreverse lines))
7345 (let ((head (and org-export-highlight-first-table-line
7347 (lambda (x) (string-match "^[ \t]*|-" x))
7349 lastline line fields html empty)
7350 (setq html (concat org-export-html-table-tag "\n"))
7351 (while (setq lastline line
7353 (setq empty " ")
7355 (if (string-match "^[ \t]*|-" line)
7357 ;; A hline: simulate an empty table row instead.
7358 (setq line (org-fake-empty-table-line lastline)
7362 (throw 'next-line t)))
7363 ;; Break the line into fields
7364 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
7368 (mapconcat (lambda (x)
7369 (if (equal x "") (setq x empty))
7371 (concat "<th>" x "</th>")
7372 (concat "<td valign=\"top\">" x "</td>")))
7375 (setq html (concat html "</table>\n"))
7378 (defun org-fake-empty-table-line (line)
7379 "Replace everything except \"|\" with spaces."
7380 (let ((i (length line))
7381 (newstr (copy-sequence line)))
7384 (if (not (eq (aref newstr i) ?|))
7385 (aset newstr i ?\ )))
7388 (defun org-format-table-table-html (lines)
7389 "Format a table generated by table.el into html.
7390 This conversion does *not* use `table-generate-source' from table.el.
7391 This has the advantage that Org-mode's HTML conversions can be used.
7392 But it has the disadvantage, that no cell- or row-spanning is allowed."
7393 (let (line field-buffer
7394 (head org-export-highlight-first-table-line)
7396 (setq html (concat org-export-html-table-tag "\n"))
7397 (while (setq line (pop lines))
7398 (setq empty " ")
7400 (if (string-match "^[ \t]*\\+-" line)
7409 (if (equal x "") (setq x empty))
7411 (concat "<th valign=\"top\">" x
7413 (concat "<td valign=\"top\">" x
7418 (setq field-buffer nil)))
7420 (throw 'next-line t)))
7421 ;; Break the line into fields and store the fields
7422 (setq fields (org-split-string line "[ \t]*|[ \t]*"))
7424 (setq field-buffer (mapcar
7426 (concat x "<br>" (pop fields)))
7428 (setq field-buffer fields))))
7429 (setq html (concat html "</table>\n"))
7432 (defun org-format-table-table-html-using-table-generate-source (lines)
7433 "Format a table into html, using `table-generate-source' from table.el.
7434 This has the advantage that cell- or row-spanning is allowed.
7435 But it has the disadvantage, that Org-mode's HTML conversions cannot be used."
7438 (set-buffer (get-buffer-create " org-tmp1 "))
7440 (insert (mapconcat 'identity lines "\n"))
7441 (goto-char (point-min))
7442 (if (not (re-search-forward "|[^+]" nil t))
7443 (error "Error processing table."))
7444 (table-recognize-table)
7446 (set-buffer (get-buffer-create " org-tmp2 "))
7448 (table-generate-source 'html " org-tmp2 ")
7449 (set-buffer " org-tmp2 ")
7450 (buffer-substring (point-min) (point-max))))
7452 (defun org-html-expand (string)
7453 "Prepare STRING for HTML export. Applies all active conversions."
7454 ;; First check if there is a link in the line - if yes, apply conversions
7455 ;; only before the start of the link.
7456 (let* ((m (string-match org-link-regexp string))
7457 (s (if m (substring string 0 m) string))
7458 (r (if m (substring string m) "")))
7459 ;; convert < to < and > to >
7460 (while (string-match "<" s)
7461 (setq s (replace-match "<" nil nil s)))
7462 (while (string-match ">" s)
7463 (setq s (replace-match ">" nil nil s)))
7464 (if org-export-html-expand
7465 (while (string-match "@<\\([^&]*\\)>" s)
7466 (setq s (replace-match "<\\1>" nil nil s))))
7467 (if org-export-with-emphasize
7468 (setq s (org-export-html-convert-emphasize s)))
7469 (if org-export-with-sub-superscripts
7470 (setq s (org-export-html-convert-sub-super s)))
7471 (if org-export-with-TeX-macros
7472 (let ((start 0) wd ass)
7473 (while (setq start (string-match "\\\\\\([a-zA-Z]+\\)" s start))
7474 (setq wd (match-string 1 s))
7475 (if (setq ass (assoc wd org-html-entities))
7476 (setq s (replace-match (or (cdr ass)
7477 (concat "&" (car ass) ";"))
7479 (setq start (+ start (length wd)))))))
7482 (defun org-create-multibrace-regexp (left right n)
7483 "Create a regular expression which will match a balanced sexp.
7484 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
7485 as single character strings.
7486 The regexp returned will match the entire expression including the
7487 delimiters. It will also define a single group which contains the
7488 match except for the outermost delimiters. The maximum depth of
7489 stacked delimiters is N. Escaping delimiters is not possible."
7490 (let* ((nothing (concat "[^" "\\" left "\\" right "]*?"))
7493 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
7496 re (concat re or next)
7497 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
7498 (concat left "\\(" re "\\)" right)))
7500 (defvar org-match-substring-regexp
7502 "\\([^\\]\\)\\([_^]\\)\\("
7503 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
7505 "\\(" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
7507 "\\(\\(?:\\*\\|[-+]?[^-+*!@#$%^_ \t\r\n,:\"?<>~;./{}=()]+\\)\\)\\)")
7508 "The regular expression matching a sub- or superscript.")
7510 (defun org-export-html-convert-sub-super (string)
7511 "Convert sub- and superscripts in STRING to HTML."
7513 (while (string-match org-match-substring-regexp string)
7514 (setq key (if (string= (match-string 2 string) "_") "sub" "sup"))
7515 (setq c (or (match-string 8 string)
7516 (match-string 6 string)
7517 (match-string 5 string)))
7518 (setq string (replace-match
7519 (concat (match-string 1 string)
7520 "<" key ">" c "</" key ">")
7522 (while (string-match "\\\\\\([_^]\\)" string)
7523 (setq string (replace-match (match-string 1 string) t t string))))
7526 (defun org-export-html-convert-emphasize (string)
7527 (while (string-match
7528 "\\(\\s-\\|^\\)\\(\\*\\([a-zA-Z]+\\)\\*\\)\\([^a-zA-Z*]\\|$\\)"
7530 (setq string (replace-match
7531 (concat "<b>" (match-string 3 string) "</b>")
7533 (while (string-match
7534 "\\(\\s-\\|^\\)\\(/\\([a-zA-Z]+\\)/\\)\\([^a-zA-Z*]\\|$\\)"
7536 (setq string (replace-match
7537 (concat "<i>" (match-string 3 string) "</i>")
7539 (while (string-match
7540 "\\(\\s-\\|^\\)\\(_\\([a-zA-Z]+\\)_\\)\\([^a-zA-Z*]\\|$\\)"
7542 (setq string (replace-match
7543 (concat "<u>" (match-string 3 string) "</u>")
7547 (defun org-parse-key-lines ()
7548 "Find the special key lines with the information for exporters."
7551 (let ((re (org-make-options-regexp
7552 '("TITLE" "AUTHOR" "EMAIL" "TEXT" "OPTIONS" "LANGUAGE")))
7554 (while (re-search-forward re nil t)
7555 (setq key (match-string 1))
7556 (cond ((string-equal key "TITLE")
7557 (setq title (match-string 2)))
7558 ((string-equal key "AUTHOR")
7559 (setq author (match-string 2)))
7560 ((string-equal key "EMAIL")
7561 (setq email (match-string 2)))
7562 ((string-equal key "LANGUAGE")
7563 (setq language (match-string 2)))
7564 ((string-equal key "TEXT")
7565 (setq text (concat text "\n" (match-string 2))))
7566 ((string-equal key "OPTIONS")
7567 (setq options (match-string 2))))))))
7569 (defun org-parse-export-options (s)
7570 "Parse the export options line."
7571 (let ((op '(("H" . org-export-headline-levels)
7572 ("num" . org-export-with-section-numbers)
7573 ("toc" . org-export-with-toc)
7574 ("\\n" . org-export-preserve-breaks)
7575 ("@" . org-export-html-expand)
7576 (":" . org-export-with-fixed-width)
7577 ("|" . org-export-with-tables)
7578 ("^" . org-export-with-sub-superscripts)
7579 ("*" . org-export-with-emphasize)
7580 ("TeX" . org-export-with-TeX-macros)))
7582 (while (setq o (pop op))
7583 (if (string-match (concat (regexp-quote (car o)) ":\\([^ \t\n\r;,.]*\\)")
7585 (set (make-local-variable (cdr o))
7586 (car (read-from-string (match-string 1 s))))))))
7588 (defun org-html-level-start (level title umax with-toc head-count)
7589 "Insert a new level in HTML export."
7590 (let ((l (1+ (max level umax))))
7591 (while (<= l org-level-max)
7592 (if (aref levels-open (1- l))
7594 (org-html-level-close l)
7595 (aset levels-open (1- l) nil)))
7599 (if (aref levels-open (1- level))
7600 (insert "<li>" title "<p>\n")
7601 (aset levels-open (1- level) t)
7602 (insert "<ul><li>" title "<p>\n")))
7603 (if org-export-with-section-numbers
7604 (setq title (concat (org-section-number level) " " title)))
7605 (setq level (+ level 1))
7607 (insert (format "\n<H%d><a name=\"sec-%d\">%s</a></H%d>\n"
7608 level head-count title level))
7609 (insert (format "\n<H%d>%s</H%d>\n" level title level))))))
7611 (defun org-html-level-close (level)
7612 "Terminate one level in HTML export."
7616 ;; Variable holding the vector with section numbers
7617 (defvar org-section-numbers (make-vector org-level-max 0))
7619 (defun org-init-section-numbers ()
7620 "Initialize the vector for the section numbers."
7622 (numbers (nreverse (org-split-string "" "\\.")))
7623 (depth (1- (length org-section-numbers)))
7624 (i depth) number-string)
7627 (aset org-section-numbers i 0)
7628 (setq number-string (or (car numbers) "0"))
7629 (if (string-match "\\`[A-Z]\\'" number-string)
7630 (aset org-section-numbers i
7631 (- (string-to-char number-string) ?A -1))
7632 (aset org-section-numbers i (string-to-int number-string)))
7636 (defun org-section-number (&optional level)
7637 "Return a string with the current section number.
7638 When LEVEL is non-nil, increase section numbers on that level."
7639 (let* ((depth (1- (length org-section-numbers))) idx n (string ""))
7642 (aset org-section-numbers
7643 level (1+ (aref org-section-numbers level))))
7644 (setq idx (1+ level))
7645 (while (<= idx depth)
7647 (aset org-section-numbers idx 0))
7648 (setq idx (1+ idx))))
7650 (while (<= idx depth)
7651 (setq n (aref org-section-numbers idx))
7652 (setq string (concat string (if (not (string= string "")) "." "")
7654 (setq idx (1+ idx)))
7656 (if (string-match "\\`\\([@0]\\.\\)+" string)
7657 (setq string (replace-match "" nil nil string)))
7658 (if (string-match "\\(\\.0\\)+\\'" string)
7659 (setq string (replace-match "" nil nil string))))
7665 ;; - Bindings in Org-mode map are currently
7666 ;; 0123456789abcdefghijklmnopqrstuvwxyz!?@#$%^&-+*/=()_{}[]:;"|,.<>~`'\t the alphabet
7667 ;; abcd fgh j lmnopqrstuvwxyz ? # -+ /= [] ; |,.<> \t necessary bindings
7668 ;; e (?) useful from outline-mode
7669 ;; i k @ expendable from outline-mode
7670 ;; 0123456789 ! $%^& * ()_{} " ~`' free
7672 (define-key org-mode-map [(tab)] 'org-cycle)
7673 (define-key org-mode-map "\C-i" 'org-cycle)
7674 (define-key org-mode-map [(meta tab)] 'org-complete)
7675 (define-key org-mode-map "\M-\C-i" 'org-complete)
7676 (define-key org-mode-map [(meta shift left)] 'org-shiftmetaleft)
7677 (define-key org-mode-map [(meta left)] 'org-metaleft)
7678 (define-key org-mode-map [(meta shift right)] 'org-shiftmetaright)
7679 (define-key org-mode-map [(meta shift up)] 'org-shiftmetaup)
7680 (define-key org-mode-map [(meta shift down)] 'org-shiftmetadown)
7681 (define-key org-mode-map [(meta right)] 'org-metaright)
7682 (define-key org-mode-map [(meta up)] 'org-metaup)
7683 (define-key org-mode-map [(meta down)] 'org-metadown)
7684 ;(define-key org-mode-map "\C-c\C-h\C-w" 'org-cut-subtree)
7685 ;(define-key org-mode-map "\C-c\C-h\M-w" 'org-copy-subtree)
7686 ;(define-key org-mode-map "\C-c\C-h\C-y" 'org-paste-subtree)
7687 (define-key org-mode-map "\C-c\C-h\C-w" 'org-cut-special)
7688 (define-key org-mode-map "\C-c\C-h\M-w" 'org-copy-special)
7689 (define-key org-mode-map "\C-c\C-h\C-y" 'org-paste-special)
7690 (define-key org-mode-map "\C-c\C-j" 'org-goto)
7691 (define-key org-mode-map "\C-c\C-t" 'org-todo)
7692 (define-key org-mode-map "\C-c\C-s" 'org-schedule)
7693 (define-key org-mode-map "\C-c\C-d" 'org-deadline)
7694 (define-key org-mode-map "\C-c;" 'org-toggle-comment)
7695 (define-key org-mode-map "\C-c\C-v" 'org-show-todo-tree)
7696 (define-key org-mode-map "\C-c\C-w" 'org-check-deadlines)
7697 (define-key org-mode-map "\C-c/" 'org-occur) ; Minor-mode reserved
7698 (define-key org-mode-map "\C-c\C-m" 'org-insert-heading)
7699 (define-key org-mode-map "\M-\C-m" 'org-insert-heading)
7700 (define-key org-mode-map "\C-c\C-l" 'org-insert-link)
7701 (define-key org-mode-map "\C-c\C-o" 'org-open-at-point)
7702 (define-key org-mode-map "\C-c\C-z" 'org-time-stamp) ; Alternative binding
7703 (define-key org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
7704 (define-key org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
7705 (define-key org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
7706 (define-key org-mode-map "\C-c>" 'org-goto-calendar)
7707 (define-key org-mode-map "\C-c<" 'org-date-from-calendar)
7708 (define-key org-mode-map "\C-c[" 'org-add-file)
7709 (define-key org-mode-map "\C-c]" 'org-remove-file)
7710 (define-key org-mode-map "\C-c\C-r" 'org-timeline)
7711 ;(define-key org-mode-map [(shift up)] 'org-timestamp-up)
7712 ;(define-key org-mode-map [(shift down)] 'org-timestamp-down)
7713 (define-key org-mode-map [(shift up)] 'org-shiftup)
7714 (define-key org-mode-map [(shift down)] 'org-shiftdown)
7715 (define-key org-mode-map [(shift left)] 'org-timestamp-down-day)
7716 (define-key org-mode-map [(shift right)] 'org-timestamp-up-day)
7717 (define-key org-mode-map "\C-c-" 'org-table-insert-hline)
7718 ;; The following line is e.g. necessary for German keyboards under Suse Linux
7719 (unless org-xemacs-p
7720 (define-key org-mode-map [S-iso-lefttab] 'org-shifttab))
7721 (define-key org-mode-map [(shift tab)] 'org-shifttab)
7722 (define-key org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
7723 (define-key org-mode-map [(return)] 'org-return)
7724 (define-key org-mode-map [(shift return)] 'org-table-copy-down)
7725 (define-key org-mode-map [(meta return)] 'org-meta-return)
7726 (define-key org-mode-map [(control up)] 'org-move-line-up)
7727 (define-key org-mode-map [(control down)] 'org-move-line-down)
7728 (define-key org-mode-map "\C-c?" 'org-table-current-column)
7729 (define-key org-mode-map "\C-c " 'org-table-blank-field)
7730 (define-key org-mode-map "\C-c+" 'org-table-sum)
7731 (define-key org-mode-map "\C-c|" 'org-table-toggle-vline-visibility)
7732 (define-key org-mode-map "\C-c=" 'org-table-eval-formula)
7733 (define-key org-mode-map "\C-c#" 'org-table-create-with-table.el)
7734 (define-key org-mode-map "\C-c\C-q" 'org-table-wrap-region)
7735 (define-key org-mode-map "\C-c\C-xa" 'org-export-as-ascii)
7736 (define-key org-mode-map "\C-c\C-x\C-a" 'org-export-as-ascii)
7737 (define-key org-mode-map "\C-c\C-xv" 'org-export-copy-visible)
7738 (define-key org-mode-map "\C-c\C-x\C-v" 'org-export-copy-visible)
7739 (define-key org-mode-map "\C-c\C-xo" 'org-export-as-opml)
7740 (define-key org-mode-map "\C-c\C-x\C-o" 'org-export-as-opml)
7741 (define-key org-mode-map "\C-c\C-xt" 'org-insert-export-options-template)
7742 (define-key org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
7743 (define-key org-mode-map "\C-c\C-xh" 'org-export-as-html)
7744 (define-key org-mode-map "\C-c\C-x\C-h" 'org-export-as-html-and-open)
7747 ;; FIXME: Do we really need to save match data in these commands?
7748 ;; I would like to remove it in order to minimize impact.
7749 ;; Self-insert already does not preserve it. How much resources used by this???
7751 (defsubst org-table-p ()
7752 (if (and (eq major-mode 'org-mode) font-lock-mode)
7753 (eq (get-text-property (point) 'face) 'org-table-face)
7754 (save-match-data (org-at-table-p))))
7756 (defun org-self-insert-command (N)
7757 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
7758 If the cursor is in a table looking at whitespace, the whitespace is
7759 overwritten, and the table is not marked as requiring realignment."
7761 (if (and (org-table-p)
7763 (looking-at "[^|\n]* +|"))
7764 (let (org-table-may-need-update (pos (point)))
7765 (goto-char (1- (match-end 0)))
7766 (delete-backward-char 1)
7767 (goto-char (match-beginning 0))
7768 (self-insert-command N))
7769 (setq org-table-may-need-update t)
7770 (self-insert-command N)))
7773 ;; The following two functions might still be optimized to trigger
7774 ;; re-alignment less frequently.
7776 (defun org-delete-backward-char (N)
7777 "Like `delete-backward-char', insert whitespace at field end in tables.
7778 When deleting backwards, in tables this function will insert whitespace in
7779 front of the next \"|\" separator, to keep the table aligned. The table will
7780 still be marked for re-alignment, because a narrow field may lead to a
7781 reduced column width."
7783 (if (and (org-table-p)
7785 (looking-at ".*?|"))
7786 (let ((pos (point)))
7787 (backward-delete-char N)
7788 (skip-chars-forward "^|")
7790 (goto-char (1- pos)))
7791 (backward-delete-char N)))
7793 (defun org-delete-char (N)
7794 "Like `delete-char', but insert whitespace at field end in tables.
7795 When deleting characters, in tables this function will insert whitespace in
7796 front of the next \"|\" separator, to keep the table aligned. The table
7797 will still be marked for re-alignment, because a narrow field may lead to
7798 a reduced column width."
7800 (if (and (org-table-p)
7802 (if (looking-at ".*?|")
7803 (let ((pos (point)))
7804 (replace-match (concat
7805 (substring (match-string 0) 1 -1)
7810 ;; How to do this: Measure non-white length of current string
7811 ;; If equal to column width, we should realign.
7813 (when (eq org-enable-table-editor 'optimized)
7814 ;; If the user wants maximum table support, we need to hijack
7815 ;; some standard editing functions
7816 (substitute-key-definition 'self-insert-command 'org-self-insert-command
7817 org-mode-map global-map)
7818 (substitute-key-definition 'delete-char 'org-delete-char
7819 org-mode-map global-map)
7820 (substitute-key-definition 'delete-backward-char 'org-delete-backward-char
7821 org-mode-map global-map)
7822 (define-key org-mode-map "|" 'self-insert-command))
7824 (defun org-shiftcursor-error ()
7825 "Throw an error because Shift-Cursor command was applied in wrong context."
7826 (error "This command is only active in tables and on headlines."))
7828 (defun org-shifttab ()
7829 "Call `(org-cycle t)' or `org-table-previous-field'."
7832 ((org-at-table-p) (org-table-previous-field))
7833 (t (org-cycle '(4)))))
7835 (defun org-shiftmetaleft (&optional arg)
7836 "Call `org-promote-subtree' or `org-table-delete-column'."
7839 ((org-at-table-p) (org-table-delete-column arg))
7840 ((org-on-heading-p) (org-promote-subtree arg))
7841 (t (org-shiftcursor-error))))
7842 (defun org-shiftmetaright (&optional arg)
7843 "Call `org-demote-subtree' or `org-table-insert-column'."
7846 ((org-at-table-p) (org-table-insert-column arg))
7847 ((org-on-heading-p) (org-demote-subtree arg))
7848 (t (org-shiftcursor-error))))
7849 (defun org-shiftmetaup (&optional arg)
7850 "Call `org-move-subtree-up' or `org-table-kill-row'."
7853 ((org-at-table-p) (org-table-kill-row arg))
7854 ((org-on-heading-p) (org-move-subtree-up arg))
7855 (t (org-shiftcursor-error))))
7856 (defun org-shiftmetadown (&optional arg)
7857 "Call `org-move-subtree-down' or `org-table-insert-row'."
7860 ((org-at-table-p) (org-table-insert-row arg))
7861 ((org-on-heading-p) (org-move-subtree-down arg))
7862 (t (org-shiftcursor-error))))
7864 (defun org-metaleft (&optional arg)
7865 "Call `org-do-promote' or `org-table-move-column' to left."
7868 ((org-at-table-p) (org-table-move-column 'left))
7869 ((or (org-on-heading-p) (org-region-active-p)) (org-do-promote arg))
7870 (t (backward-word (prefix-numeric-value arg)))))
7871 (defun org-metaright (&optional arg)
7872 "Call `org-do-demote' or `org-table-move-column' to right."
7875 ((org-at-table-p) (org-table-move-column nil))
7876 ((or (org-on-heading-p) (org-region-active-p)) (org-do-demote arg))
7877 (t (forward-word (prefix-numeric-value arg)))))
7878 (defun org-metaup (&optional arg)
7879 "Call `org-move-subtree-up' or `org-table-move-row' up."
7882 ((org-at-table-p) (org-table-move-row 'up))
7883 ((org-on-heading-p) (org-move-subtree-up arg))
7884 (t (org-shiftcursor-error))))
7885 (defun org-metadown (&optional arg)
7886 "Call `org-move-subtree-down' or `org-table-move-row' down."
7889 ((org-at-table-p) (org-table-move-row nil))
7890 ((org-on-heading-p) (org-move-subtree-down arg))
7891 (t (org-shiftcursor-error))))
7893 (defun org-shiftup (&optional arg)
7894 "Call `org-timestamp-up' or `org-priority-up'."
7897 ((org-at-timestamp-p) (org-timestamp-up arg))
7898 (t (org-priority-up))))
7900 (defun org-shiftdown (&optional arg)
7901 "Call `org-timestamp-down' or `org-priority-down'."
7904 ((org-at-timestamp-p) (org-timestamp-down arg))
7905 (t (org-priority-down))))
7907 (defun org-copy-special (arg)
7908 "Call either `org-table-copy' or `org-copy-subtree'."
7910 (if (org-at-table-p)
7911 (org-table-copy-region arg)
7912 (org-copy-subtree arg)))
7914 (defun org-cut-special (arg)
7915 "Call either `org-table-copy' or `org-copy-subtree'."
7917 (if (org-at-table-p)
7918 (org-table-cut-region arg)
7919 (org-cut-subtree arg)))
7921 (defun org-paste-special (arg)
7922 "Call either `org-table-paste-rectangle' or `org-paste-subtree'."
7924 (if (org-at-table-p)
7925 (org-table-paste-rectangle arg)
7926 (org-paste-subtree arg)))
7928 (defun org-ctrl-c-ctrl-c (&optional arg)
7929 "Call realign table, or recognize a table.el table.
7930 When the cursor is inside a table created by the table.el package,
7931 activate that table. Otherwise, if the cursor is at a normal table
7932 created with org.el, re-align that table. This command works even if
7933 the automatic table editor has been turned off."
7935 (let ((org-enable-table-editor t))
7937 ((org-at-table.el-p)
7939 (beginning-of-line 1)
7940 (re-search-forward "|" (save-excursion (end-of-line 2) (point)))
7941 (table-recognize-table))
7944 ((org-region-active-p)
7945 (org-table-convert-region (region-beginning) (region-end) arg))
7946 ((and (region-beginning) (region-end))
7947 (if (y-or-n-p "Convert inactive region to table? ")
7948 (org-table-convert-region (region-beginning) (region-end) arg)
7950 (t (error "No table at point, and no region to make one.")))))
7952 (defun org-return (&optional arg)
7953 "Call `org-table-next-row' or `newline'."
7957 (org-table-justify-field-maybe)
7958 (org-table-next-row))
7961 (defun org-meta-return (&optional arg)
7962 "Call `org-insert-heading' or `org-table-wrap-region'."
7966 (org-table-wrap-region arg))
7967 (t (org-insert-heading arg))))
7971 ;; First, remove the outline menus.
7973 (add-hook 'org-mode-hook
7975 (delete-menu-item '("Headings"))
7976 (delete-menu-item '("Show"))
7977 (delete-menu-item '("Hide"))
7978 (set-menubar-dirty-flag)))
7979 (setq org-mode-map (delq (assoc 'menu-bar (cdr org-mode-map))
7982 ;; Define the Org-mode menus
7983 (easy-menu-define org-org-menu org-mode-map "Org menu"
7985 ["Cycle Visibility" org-cycle (or (bobp) (outline-on-heading-p))]
7986 ["Sparse Tree" org-occur t]
7987 ["Show All" show-all t]
7989 ["New Heading" org-insert-heading t]
7990 ("Navigate Headings"
7991 ["Up" outline-up-heading t]
7992 ["Next" outline-next-visible-heading t]
7993 ["Previous" outline-previous-visible-heading t]
7994 ["Next Same Level" outline-forward-same-level t]
7995 ["Previous Same Level" outline-backward-same-level t]
7997 ["Jump" org-goto t])
7999 ["Move subtree up" org-shiftmetaup (not (org-at-table-p))]
8000 ["Move subtree down" org-shiftmetadown (not (org-at-table-p))]
8002 ["Copy Subtree" org-copy-special (not (org-at-table-p))]
8003 ["Cut Subtree" org-cut-special (not (org-at-table-p))]
8004 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
8006 ["Promote Heading" org-metaleft (not (org-at-table-p))]
8007 ["Promote Subtree" org-shiftmetaleft (not (org-at-table-p))]
8008 ["Demote Heading" org-metaright (not (org-at-table-p))]
8009 ["Demote Subtree" org-shiftmetaright (not (org-at-table-p))])
8012 ["TODO/DONE/-" org-todo t]
8013 ["Show TODO Tree" org-show-todo-tree t]
8015 ["Set priority" org-priority t]
8016 ["Priority up" org-shiftup t]
8017 ["Priority down" org-shiftdown t])
8018 ("Dates and Scheduling"
8019 ["Timestamp" org-time-stamp t]
8021 ["1 day later" org-timestamp-up-day t]
8022 ["1 day earlier" org-timestamp-down-day t]
8023 ["1 ... later" org-shiftup t]
8024 ["1 ... earlier" org-shiftdown t])
8025 ["Compute Time Range" org-evaluate-time-range t]
8026 ["Schedule Item" org-schedule t]
8027 ["Deadline" org-deadline t]
8029 ["Goto Calendar" org-goto-calendar t]
8030 ["Date from Calendar" org-date-from-calendar t])
8033 ["Show TODO Tree this file" org-show-todo-tree t]
8034 ["Check Deadlines this file" org-check-deadlines t]
8035 ["Timeline current file" org-timeline t]
8037 ["Adenda (multifile)" org-agenda t])
8038 ("File List for Agenda")
8041 ["Store Link (global)" org-store-link t]
8042 ["Insert Link" org-insert-link t]
8043 ["Follow Link" org-open-at-point t])
8044 ;; ["BBDB" org-bbdb-name t]
8047 ["Align" org-ctrl-c-ctrl-c (org-at-table-p)]
8048 ["Next field" org-cycle (org-at-table-p)]
8049 ["Previous Field" org-shifttab (org-at-table-p)]
8050 ["Next row" org-return (org-at-table-p)]
8052 ["Blank field" org-table-blank-field (org-at-table-p)]
8053 ["Copy field from above" org-table-copy-down (org-at-table-p)]
8056 ["Move column left" org-metaleft (org-at-table-p)]
8057 ["Move column right" org-metaright (org-at-table-p)]
8058 ["Delete column" org-shiftmetaleft (org-at-table-p)]
8059 ["Insert column" org-shiftmetaright (org-at-table-p)])
8061 ["Move row up" org-metaup (org-at-table-p)]
8062 ["Move row down" org-metadown (org-at-table-p)]
8063 ["Delete row" org-shiftmetaup (org-at-table-p)]
8064 ["Insert row" org-shiftmetadown (org-at-table-p)]
8066 ["Insert hline" org-table-insert-hline (org-at-table-p)])
8068 ["Copy rectangle" org-copy-special (org-at-table-p)]
8069 ["Cut rectangle" org-cut-special (org-at-table-p)]
8070 ["Paste rectangle" org-paste-special (org-at-table-p)]
8071 ["Fill rectangle" org-table-wrap-region (org-at-table-p)])
8073 ["Which column?" org-table-current-column (org-at-table-p)]
8074 ["Sum column/rectangle" org-table-sum
8075 (or (org-at-table-p) (org-region-active-p))]
8076 ["Eval formula" org-table-eval-formula (org-at-table-p)]
8078 ["Invisible Vlines" org-table-toggle-vline-visibility
8079 :style toggle :selected (org-in-invisibility-spec-p '(org-table))]
8081 ["Create" org-table-create (and (not (org-at-table-p))
8082 org-enable-table-editor)]
8083 ["Convert region" org-ctrl-c-ctrl-c (not (org-at-table-p 'any))]
8084 ["Import from file" org-table-import (not (org-at-table-p))]
8085 ["Export to file" org-table-export (org-at-table-p)]
8087 ["Create/convert from/to table.el" org-table-create-with-table.el t])
8090 ["ASCII" org-export-as-ascii t]
8091 ["Extract visible text" org-export-copy-visible t]
8092 ["HTML" org-export-as-html t]
8093 ["HTML, and open" org-export-as-html-and-open t]
8094 ["OPML" org-export-as-opml nil]
8096 ["Option template" org-insert-export-options-template t]
8097 ["Toggle fixed width" org-toggle-fixed-width-section t])
8100 ["Show Version" org-version t]
8101 ["Info Documentation" org-info t])
8103 ["Browse Org Group" org-customize t]
8105 ["Build Full Customize Menu" org-create-customize-menu
8106 (fboundp 'customize-menu-create)])
8110 (defun org-info (&optional node)
8111 "Read documentation for Org-mode in the info system.
8112 With optional NODE, go directly to that node."
8115 (Info-goto-node (format "(org)%s" (or node ""))))
8118 (defun org-install-agenda-files-menu ()
8120 '("Org") "File List for Agenda"
8123 ["Edit file list" (customize-variable 'org-agenda-files) t]
8124 ["Add current file to list" org-add-file t]
8125 ["Remove current file from list" org-remove-file t]
8127 (mapcar 'org-file-menu-entry org-agenda-files))))
8131 (defun org-customize ()
8132 "Call the customize function with org as argument."
8134 (customize-browse 'org))
8136 (defun org-create-customize-menu ()
8137 "Create a full customization menu for Org-mode, insert it into the menu."
8139 (if (fboundp 'customize-menu-create)
8142 '("Org") "Customize"
8143 `(["Browse Org group" org-customize t]
8145 ,(customize-menu-create 'org)
8146 ["Set" Custom-set t]
8147 ["Save" Custom-save t]
8148 ["Reset to Current" Custom-reset-current t]
8149 ["Reset to Saved" Custom-reset-saved t]
8150 ["Reset to Standard Settings" Custom-reset-standard t]))
8151 (message "\"Org\"-menu now contains full customization menu"))
8152 (error "Cannot expand menu (outdated version of cus-edit.el)")))
8154 ;;; Miscellaneous stuff
8156 (defun org-move-line-down (arg)
8157 "Move the current line up."
8159 (let ((col (current-column))
8161 (beginning-of-line 1) (setq beg (point))
8162 (beginning-of-line 2) (setq end (point))
8163 (beginning-of-line (+ 1 arg))
8164 (setq pos (move-marker (make-marker) (point)))
8165 (insert (delete-and-extract-region beg end))
8167 (move-to-column col)))
8169 (defun org-move-line-up (arg)
8170 "Move the current line up."
8172 (let ((col (current-column))
8174 (beginning-of-line 1) (setq beg (point))
8175 (beginning-of-line 2) (setq end (point))
8176 (beginning-of-line (+ -2 arg))
8177 (setq pos (move-marker (make-marker) (point)))
8178 (insert (delete-and-extract-region beg end))
8180 (move-to-column col)))
8182 ;; Functions needed for Emacs/XEmacs region compatibility
8184 (defun org-region-active-p ()
8185 "Is transient-mark-mode on and the region active?
8186 Works on both Emacs and XEmacs."
8187 (if org-ignore-region
8190 (and zmacs-regions (region-active-p))
8191 (and transient-mark-mode mark-active))))
8193 (defun org-add-to-invisibility-spec (arg)
8194 "Add elements to `buffer-invisibility-spec'.
8195 See documentation for `buffer-invisibility-spec' for the kind of elements
8198 ((fboundp 'add-to-invisibility-spec)
8199 (add-to-invisibility-spec arg))
8200 ((or (null buffer-invisibility-spec) (eq buffer-invisibility-spec t))
8201 (setq buffer-invisibility-spec (list arg)))
8203 (setq buffer-invisibility-spec
8204 (cons arg buffer-invisibility-spec)))))
8206 (defun org-remove-from-invisibility-spec (arg)
8207 "Remove elements from `buffer-invisibility-spec'."
8208 (if (fboundp 'remove-from-invisibility-spec)
8209 (remove-from-invisibility-spec arg)
8210 (if (consp buffer-invisibility-spec)
8211 (setq buffer-invisibility-spec
8212 (delete arg buffer-invisibility-spec)))))
8214 (defun org-in-invisibility-spec-p (arg)
8215 "Is ARG a member of `buffer-invisibility-spec'?."
8216 (if (consp buffer-invisibility-spec)
8217 (member arg buffer-invisibility-spec)
8220 (defun org-image-file-name-regexp ()
8221 "Return regexp matching the file names of images."
8222 (if (fboundp 'image-file-name-regexp)
8223 (image-file-name-regexp)
8224 (let ((image-file-name-extensions
8225 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
8226 "xbm" "xpm" "pbm" "pgm" "ppm")))
8228 (regexp-opt (nconc (mapcar 'upcase
8229 image-file-name-extensions)
8230 image-file-name-extensions)
8234 ;; Functions needed for compatibility with old outline.el
8236 ;; The following functions capture almost the entire compatibility code
8237 ;; between the different versions of outline-mode. The only other place
8238 ;; where this is important are the font-lock-keywords. Search for
8239 ;; `org-noutline-p' to find it.
8241 ;; C-a should go to the beginning of a *visible* line, also in the
8242 ;; new outline.el. I guess this should be patched into Emacs?
8243 (defun org-beginning-of-line ()
8244 "Go to the beginning of the current line. If that is invisible, continue
8245 to a visible line beginning. This makes the function of C-a more intuitive."
8247 (beginning-of-line 1)
8251 (if (org-invisible-p)
8252 (while (and (not (bobp)) (org-invisible-p))
8254 (beginning-of-line 1))
8256 (when org-noutline-p
8257 (define-key org-mode-map "\C-a" 'org-beginning-of-line))
8259 (defun org-invisible-p ()
8260 "Check if point is at a character currently not visible."
8262 ;; Early versions of noutline don't have `outline-invisible-p'.
8263 (if (fboundp 'outline-invisible-p)
8264 (outline-invisible-p)
8265 (get-char-property (point) 'invisible))
8267 (skip-chars-backward "^\r\n")
8270 (equal (char-before) ?\r)))))
8272 (defun org-back-to-heading (&optional invisible-ok)
8273 "Move to previous heading line, or beg of this line if it's a heading.
8274 Only visible heading lines are considered, unless INVISIBLE-OK is non-nil."
8276 (outline-back-to-heading invisible-ok)
8277 (if (looking-at outline-regexp)
8279 (if (re-search-backward (concat (if invisible-ok "[\r\n]" "^")
8283 (progn (forward-char 1)
8284 (looking-at outline-regexp)))
8285 (error "Before first heading")))))
8287 (defun org-on-heading-p (&optional invisible-ok)
8288 "Return t if point is on a (visible) heading line.
8289 If INVISIBLE-OK is non-nil, an invisible heading line is ok too."
8291 (outline-on-heading-p 'invisible-ok)
8293 (skip-chars-backward "^\n\r")
8294 (and (looking-at outline-regexp)
8297 (equal (char-before) ?\n))))))
8299 (defun org-up-heading-all (arg)
8300 "Move to the heading line of which the present line is a subheading.
8301 This function considers both visible and invisible heading lines.
8302 With argument, move up ARG levels."
8304 (outline-up-heading-all arg)
8305 (org-back-to-heading t)
8306 (looking-at outline-regexp)
8307 (if (<= (- (match-end 0) (match-beginning 0)) arg)
8308 (error "Cannot move up %d levels" arg)
8310 (concat "[\n\r]" (regexp-quote
8311 (make-string (- (match-end 0) (match-beginning 0) arg)
8316 (defun org-show-hidden-entry ()
8317 "Show an entry where even the heading is hidden."
8319 (if (not org-noutline-p)
8321 (org-back-to-heading t)
8322 (org-flag-heading nil)))
8325 (defun org-check-occur-regexp (regexp)
8326 "If REGEXP starts with \"^\", modify it to check for \\r as well.
8327 Of course, only for the old outline mode."
8330 (if (string-match "^\\^" regexp)
8331 (concat "[\n\r]" (substring regexp 1))
8334 (defun org-flag-heading (flag &optional entry)
8335 "Flag the current heading. FLAG non-nil means make invisible.
8336 When ENTRY is non-nil, show the entire entry."
8338 (org-back-to-heading t)
8339 (if (not org-noutline-p)
8340 ;; Make the current headline visible
8341 (outline-flag-region (max 1 (1- (point))) (point) (if flag ?\r ?\n)))
8342 ;; Check if we should show the entire entry
8346 (save-excursion ;; FIXME: Is this the fix for points in the -|
8347 ;; middle of text? |
8348 (and (outline-next-heading) ;; |
8349 (org-flag-heading nil)))) ; show the next heading _|
8350 (outline-flag-region (max 1 (1- (point)))
8351 (save-excursion (outline-end-of-heading) (point))
8354 (if flag ?\r ?\n))))))
8356 (defun org-make-options-regexp (kwds)
8357 "Make a regular expression for keyword lines."
8359 (if org-noutline-p "^" "[\n\r]")
8361 (mapconcat 'regexp-quote kwds "\\|")
8363 (if org-noutline-p "\\(.+\\)" "\\([^\n\r]+\\)")))
8365 ;; Advise the bookmark-jump function to make jump position visible
8366 ;; Wrapped into eval-after-load to avoid loading advice unnecessarily
8367 (eval-after-load "bookmark"
8368 '(defadvice bookmark-jump (after org-make-visible activate)
8369 "Make the position visible."
8370 (and (eq major-mode 'org-mode)
8372 (org-show-hierarchy-above))))
8378 (run-hooks 'org-load-hook)
8380 ;; arch-tag: e77da1a7-acc7-4336-b19e-efa25af3f9fd
8382 ;;; org.el ends here