Declare a function.
[org-mode.git] / lisp / org-mouse.el
blob9b1f456882f7b63a8a6a63ff5e73b849d28e0132
1 ;;; org-mouse.el --- Better mouse support for org-mode
3 ;; Copyright (C) 2006, 2007, 2008, 2009 Free Software Foundation
4 ;;
5 ;; Author: Piotr Zielinski <piotr dot zielinski at gmail dot com>
6 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
7 ;; Version: 6.27trans
8 ;;
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
25 ;;; Commentary:
27 ;; Org-mouse provides mouse support for org-mode.
29 ;; http://orgmode.org
31 ;; Org-mouse implements the following features:
32 ;; * following links with the left mouse button (in Emacs 22)
33 ;; * subtree expansion/collapse (org-cycle) with the left mouse button
34 ;; * several context menus on the right mouse button:
35 ;; + general text
36 ;; + headlines
37 ;; + timestamps
38 ;; + priorities
39 ;; + links
40 ;; + tags
41 ;; * promoting/demoting/moving subtrees with mouse-3
42 ;; + if the drag starts and ends in the same line then promote/demote
43 ;; + otherwise move the subtree
45 ;; Use
46 ;; ---
48 ;; To use this package, put the following line in your .emacs:
50 ;; (require 'org-mouse)
53 ;; FIXME:
54 ;; + deal with folding / unfolding issues
56 ;; TODO (This list is only theoretical, if you'd like to have some
57 ;; feature implemented or a bug fix please send me an email, even if
58 ;; something similar appears in the list below. This will help me get
59 ;; the priorities right.):
61 ;; + org-store-link, insert link
62 ;; + org tables
63 ;; + occur with the current word/tag (same menu item)
64 ;; + ctrl-c ctrl-c, for example, renumber the current list
65 ;; + internal links
67 ;; Please email the maintainer with new feature suggestions / bugs
69 ;; History:
71 ;; Since version 5.10: Changes are listed in the general org-mode docs.
73 ;; Version 5.09
74 ;; + Version number synchronization with Org-mode.
76 ;; Version 0.25
77 ;; + made compatible with org-mode 4.70 (thanks to Carsten for the patch)
79 ;; Version 0.24
80 ;; + minor changes to the table menu
82 ;; Version 0.23
83 ;; + preliminary support for tables and calculation marks
84 ;; + context menu support for org-agenda-undo & org-sort-entries
86 ;; Version 0.22
87 ;; + handles undo support for the agenda buffer (requires org-mode >=4.58)
89 ;; Version 0.21
90 ;; + selected text activates its context menu
91 ;; + shift-middleclick or right-drag inserts the text from the clipboard in the form of a link
93 ;; Version 0.20
94 ;; + the new "TODO Status" submenu replaces the "Cycle TODO" menu item
95 ;; + the TODO menu can now list occurrences of a specific TODO keyword
96 ;; + #+STARTUP line is now recognized
98 ;; Version 0.19
99 ;; + added support for dragging URLs to the org-buffer
101 ;; Version 0.18
102 ;; + added support for agenda blocks
104 ;; Version 0.17
105 ;; + toggle checkboxes with a single click
107 ;; Version 0.16
108 ;; + added support for checkboxes
110 ;; Version 0.15
111 ;; + org-mode now works with the Agenda buffer as well
113 ;; Version 0.14
114 ;; + added a menu option that converts plain list items to outline items
116 ;; Version 0.13
117 ;; + "Insert Heading" now inserts a sibling heading if the point is
118 ;; on "***" and a child heading otherwise
120 ;; Version 0.12
121 ;; + compatible with Emacs 21
122 ;; + custom agenda commands added to the main menu
123 ;; + moving trees should now work between windows in the same frame
125 ;; Version 0.11
126 ;; + fixed org-mouse-at-link (thanks to Carsten)
127 ;; + removed [follow-link] bindings
129 ;; Version 0.10
130 ;; + added a menu option to remove highlights
131 ;; + compatible with org-mode 4.21 now
133 ;; Version 0.08:
134 ;; + trees can be moved/promoted/demoted by dragging with the right
135 ;; mouse button (mouse-3)
136 ;; + small changes in the above function
138 ;; Versions 0.01 -- 0.07: (I don't remember)
140 (eval-when-compile (require 'cl))
141 (require 'org)
143 (defvar org-agenda-allow-remote-undo)
144 (defvar org-agenda-undo-list)
145 (defvar org-agenda-custom-commands)
146 (declare-function org-agenda-change-all-lines "org-agenda"
147 (newhead hdmarker &optional fixface just-this))
148 (declare-function org-verify-change-for-undo "org-agenda" (l1 l2))
150 (defvar org-mouse-plain-list-regexp "\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) "
151 "Regular expression that matches a plain list.")
152 (defvar org-mouse-direct t
153 "Internal variable indicating whether the current action is direct.
155 If t, then the current action has been invoked directly through the buffer
156 it is intended to operate on. If nil, then the action has been invoked
157 indirectly, for example, through the agenda buffer.")
159 (defgroup org-mouse nil
160 "Mouse support for org-mode."
161 :tag "Org Mouse"
162 :group 'org)
164 (defcustom org-mouse-punctuation ":"
165 "Punctuation used when inserting text by drag and drop."
166 :group 'org-mouse
167 :type 'string)
169 (defcustom org-mouse-features
170 '(context-menu yank-link activate-stars activate-bullets activate-checkboxes)
171 "The features of org-mouse that should be activated.
172 Changing this variable requires a restart of Emacs to get activated."
173 :group 'org-mouse
174 :type '(set :greedy t
175 (const :tag "Mouse-3 shows context menu" context-menu)
176 (const :tag "C-mouse-1 and mouse-3 move trees" move-tree)
177 (const :tag "S-mouse-2 and drag-mouse-3 yank link" yank-link)
178 (const :tag "Activate headline stars" activate-stars)
179 (const :tag "Activate item bullets" activate-bullets)
180 (const :tag "Activate checkboxes" activate-checkboxes)))
182 (defun org-mouse-re-search-line (regexp)
183 "Search the current line for a given regular expression."
184 (beginning-of-line)
185 (re-search-forward regexp (point-at-eol) t))
187 (defun org-mouse-end-headline ()
188 "Go to the end of current headline (ignoring tags)."
189 (interactive)
190 (end-of-line)
191 (skip-chars-backward "\t ")
192 (when (looking-back ":[A-Za-z]+:")
193 (skip-chars-backward ":A-Za-z")
194 (skip-chars-backward "\t ")))
196 (defvar org-mouse-context-menu-function nil
197 "Function to create the context menu.
198 The value of this variable is the function invoked by
199 `org-mouse-context-menu' as the context menu.")
200 (make-variable-buffer-local 'org-mouse-context-menu-function)
202 (defun org-mouse-show-context-menu (event prefix)
203 "Invoke the context menu.
205 If the value of `org-mouse-context-menu-function' is a function, then
206 this function is called. Otherwise, the current major mode menu is used."
207 (interactive "@e \nP")
208 (if (and (= (event-click-count event) 1)
209 (or (not mark-active)
210 (sit-for (/ double-click-time 1000.0))))
211 (progn
212 (select-window (posn-window (event-start event)))
213 (when (not (org-mouse-mark-active))
214 (goto-char (posn-point (event-start event)))
215 (when (not (eolp)) (save-excursion (run-hooks 'post-command-hook)))
216 (let ((redisplay-dont-pause t))
217 (sit-for 0)))
218 (if (functionp org-mouse-context-menu-function)
219 (funcall org-mouse-context-menu-function event)
220 (if (fboundp 'mouse-menu-major-mode-map)
221 (popup-menu (mouse-menu-major-mode-map) event prefix)
222 (org-no-warnings ; don't warn about fallback, obsolete since 23.1
223 (mouse-major-mode-menu event prefix)))))
224 (setq this-command 'mouse-save-then-kill)
225 (mouse-save-then-kill event)))
227 (defun org-mouse-line-position ()
228 "Returns `:beginning' or `:middle' or `:end', depending on the point position.
230 If the point is at the end of the line, return `:end'.
231 If the point is separated from the beginning of the line only by white
232 space and *'s (`org-mouse-bolp'), return `:beginning'. Otherwise,
233 return `:middle'."
234 (cond
235 ((eolp) :end)
236 ((org-mouse-bolp) :beginning)
237 (t :middle)))
239 (defun org-mouse-empty-line ()
240 "Return non-nil iff the line contains only white space."
241 (save-excursion (beginning-of-line) (looking-at "[ \t]*$")))
243 (defun org-mouse-next-heading ()
244 "Go to the next heading.
245 If there is none, ensure that the point is at the beginning of an empty line."
246 (unless (outline-next-heading)
247 (beginning-of-line)
248 (unless (org-mouse-empty-line)
249 (end-of-line)
250 (newline))))
252 (defun org-mouse-insert-heading ()
253 "Insert a new heading, as `org-insert-heading'.
255 If the point is at the :beginning (`org-mouse-line-position') of the line,
256 insert the new heading before the current line. Otherwise, insert it
257 after the current heading."
258 (interactive)
259 (case (org-mouse-line-position)
260 (:beginning (beginning-of-line)
261 (org-insert-heading))
262 (t (org-mouse-next-heading)
263 (org-insert-heading))))
265 (defun org-mouse-timestamp-today (&optional shift units)
266 "Change the timestamp into SHIFT UNITS in the future.
268 For the acceptable UNITS, see `org-timestamp-change'."
269 (interactive)
270 (flet ((org-read-date (&rest rest) (current-time)))
271 (org-time-stamp nil))
272 (when shift
273 (org-timestamp-change shift units)))
275 (defun org-mouse-keyword-menu (keywords function &optional selected itemformat)
276 "A helper function.
278 Returns a menu fragment consisting of KEYWORDS. When a keyword
279 is selected by the user, FUNCTION is called with the selected
280 keyword as the only argument.
282 If SELECTED is nil, then all items are normal menu items. If
283 SELECTED is a function, then each item is a checkbox, which is
284 enabled for a given keyword iff (funcall SELECTED keyword) return
285 non-nil. If SELECTED is neither nil nor a function, then the
286 items are radio buttons. A radio button is enabled for the
287 keyword `equal' to SELECTED.
289 ITEMFORMAT governs formatting of the elements of KEYWORDS. If it
290 is a function, it is invoked with the keyword as the only
291 argument. If it is a string, it is interpreted as the format
292 string to (format ITEMFORMAT keyword). If it is neither a string
293 nor a function, elements of KEYWORDS are used directly. "
294 (mapcar
295 `(lambda (keyword)
296 (vector (cond
297 ((functionp ,itemformat) (funcall ,itemformat keyword))
298 ((stringp ,itemformat) (format ,itemformat keyword))
299 (t keyword))
300 (list 'funcall ,function keyword)
301 :style (cond
302 ((null ,selected) t)
303 ((functionp ,selected) 'toggle)
304 (t 'radio))
305 :selected (if (functionp ,selected)
306 (and (funcall ,selected keyword) t)
307 (equal ,selected keyword))))
308 keywords))
310 (defun org-mouse-remove-match-and-spaces ()
311 "Remove the match, make just one space around the point."
312 (interactive)
313 (replace-match "")
314 (just-one-space))
316 (defvar rest)
317 (defun org-mouse-replace-match-and-surround (newtext &optional fixedcase
318 literal string subexp)
319 "The same as `replace-match', but surrounds the replacement with spaces."
320 (apply 'replace-match rest)
321 (save-excursion
322 (goto-char (match-beginning (or subexp 0)))
323 (just-one-space)
324 (goto-char (match-end (or subexp 0)))
325 (just-one-space)))
328 (defun org-mouse-keyword-replace-menu (keywords &optional group itemformat
329 nosurround)
330 "A helper function.
332 Returns a menu fragment consisting of KEYWORDS. When a keyword
333 is selected, group GROUP of the current match is replaced by the
334 keyword. The method ensures that both ends of the replacement
335 are separated from the rest of the text in the buffer by
336 individual spaces (unless NOSURROUND is non-nil).
338 The final entry of the menu is always \"None\", which removes the
339 match.
341 ITEMFORMAT governs formatting of the elements of KEYWORDS. If it
342 is a function, it is invoked with the keyword as the only
343 argument. If it is a string, it is interpreted as the format
344 string to (format ITEMFORMAT keyword). If it is neither a string
345 nor a function, elements of KEYWORDS are used directly.
347 (setq group (or group 0))
348 (let ((replace (org-mouse-match-closure
349 (if nosurround 'replace-match
350 'org-mouse-replace-match-and-surround))))
351 (append
352 (org-mouse-keyword-menu
353 keywords
354 `(lambda (keyword) (funcall ,replace keyword t t nil ,group))
355 (match-string group)
356 itemformat)
357 `(["None" org-mouse-remove-match-and-spaces
358 :style radio
359 :selected ,(not (member (match-string group) keywords))]))))
361 (defun org-mouse-show-headlines ()
362 "Change the visibility of the current org buffer to only show headlines."
363 (interactive)
364 (let ((this-command 'org-cycle)
365 (last-command 'org-cycle)
366 (org-cycle-global-status nil))
367 (org-cycle '(4))
368 (org-cycle '(4))))
370 (defun org-mouse-show-overview ()
371 "Change visibility of current org buffer to first-level headlines only."
372 (interactive)
373 (let ((org-cycle-global-status nil))
374 (org-cycle '(4))))
376 (defun org-mouse-set-priority (priority)
377 "Set the priority of the current headline to PRIORITY."
378 (flet ((read-char-exclusive () priority))
379 (org-priority)))
381 (defvar org-mouse-priority-regexp "\\[#\\([A-Z]\\)\\]"
382 "Regular expression matching the priority indicator.
383 Differs from `org-priority-regexp' in that it doesn't contain the
384 leading '.*?'.")
386 (defun org-mouse-get-priority (&optional default)
387 "Return the priority of the current headline.
388 DEFAULT is returned if no priority is given in the headline."
389 (save-excursion
390 (if (org-mouse-re-search-line org-mouse-priority-regexp)
391 (match-string 1)
392 (when default (char-to-string org-default-priority)))))
394 ;; (defun org-mouse-at-link ()
395 ;; (and (eq (get-text-property (point) 'face) 'org-link)
396 ;; (save-excursion
397 ;; (goto-char (previous-single-property-change (point) 'face))
398 ;; (or (looking-at org-bracket-link-regexp)
399 ;; (looking-at org-angle-link-re)
400 ;; (looking-at org-plain-link-re)))))
403 (defun org-mouse-delete-timestamp ()
404 "Deletes the current timestamp as well as the preceding keyword.
405 SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:"
406 (when (or (org-at-date-range-p) (org-at-timestamp-p))
407 (replace-match "") ; delete the timestamp
408 (skip-chars-backward " :A-Z")
409 (when (looking-at " *[A-Z][A-Z]+:")
410 (replace-match ""))))
412 (defun org-mouse-looking-at (regexp skipchars &optional movechars)
413 (save-excursion
414 (let ((point (point)))
415 (if (looking-at regexp) t
416 (skip-chars-backward skipchars)
417 (forward-char (or movechars 0))
418 (when (looking-at regexp)
419 (> (match-end 0) point))))))
421 (defun org-mouse-priority-list ()
422 (loop for priority from ?A to org-lowest-priority
423 collect (char-to-string priority)))
425 (defun org-mouse-todo-menu (state)
426 "Create the menu with TODO keywords."
427 (append
428 (let ((kwds org-todo-keywords-1))
429 (org-mouse-keyword-menu
430 kwds
431 `(lambda (kwd) (org-todo kwd))
432 (lambda (kwd) (equal state kwd))))))
434 (defun org-mouse-tag-menu () ;todo
435 "Create the tags menu"
436 (append
437 (let ((tags (org-get-tags)))
438 (org-mouse-keyword-menu
439 (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
440 `(lambda (tag)
441 (org-mouse-set-tags
442 (sort (if (member tag (quote ,tags))
443 (delete tag (quote ,tags))
444 (cons tag (quote ,tags)))
445 'string-lessp)))
446 `(lambda (tag) (member tag (quote ,tags)))
448 '("--"
449 ["Align Tags Here" (org-set-tags nil t) t]
450 ["Align Tags in Buffer" (org-set-tags t t) t]
451 ["Set Tags ..." (org-set-tags) t])))
454 (defun org-mouse-set-tags (tags)
455 (save-excursion
456 ;; remove existing tags first
457 (beginning-of-line)
458 (when (org-mouse-re-search-line ":\\(\\([A-Za-z_]+:\\)+\\)")
459 (replace-match ""))
461 ;; set new tags if any
462 (when tags
463 (end-of-line)
464 (insert " :" (mapconcat 'identity tags ":") ":")
465 (org-set-tags nil t))))
467 (defun org-mouse-insert-checkbox ()
468 (interactive)
469 (and (org-at-item-p)
470 (goto-char (match-end 0))
471 (unless (org-at-item-checkbox-p)
472 (delete-horizontal-space)
473 (insert " [ ] "))))
475 (defun org-mouse-agenda-type (type)
476 (case type
477 ('tags "Tags: ")
478 ('todo "TODO: ")
479 ('tags-tree "Tags tree: ")
480 ('todo-tree "TODO tree: ")
481 ('occur-tree "Occur tree: ")
482 (t "Agenda command ???")))
485 (defun org-mouse-list-options-menu (alloptions &optional function)
486 (let ((options (save-match-data
487 (split-string (match-string-no-properties 1)))))
488 (print options)
489 (loop for name in alloptions
490 collect
491 (vector name
492 `(progn
493 (replace-match
494 (mapconcat 'identity
495 (sort (if (member ',name ',options)
496 (delete ',name ',options)
497 (cons ',name ',options))
498 'string-lessp)
499 " ")
500 nil nil nil 1)
501 (when (functionp ',function) (funcall ',function)))
502 :style 'toggle
503 :selected (and (member name options) t)))))
505 (defun org-mouse-clip-text (text maxlength)
506 (if (> (length text) maxlength)
507 (concat (substring text 0 (- maxlength 3)) "...")
508 text))
510 (defun org-mouse-popup-global-menu ()
511 (popup-menu
512 `("Main Menu"
513 ["Show Overview" org-mouse-show-overview t]
514 ["Show Headlines" org-mouse-show-headlines t]
515 ["Show All" show-all t]
516 ["Remove Highlights" org-remove-occur-highlights
517 :visible org-occur-highlights]
518 "--"
519 ["Check Deadlines"
520 (if (functionp 'org-check-deadlines-and-todos)
521 (org-check-deadlines-and-todos org-deadline-warning-days)
522 (org-check-deadlines org-deadline-warning-days)) t]
523 ["Check TODOs" org-show-todo-tree t]
524 ("Check Tags"
525 ,@(org-mouse-keyword-menu
526 (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
527 '(lambda (tag) (org-tags-sparse-tree nil tag)))
528 "--"
529 ["Custom Tag ..." org-tags-sparse-tree t])
530 ["Check Phrase ..." org-occur]
531 "--"
532 ["Display Agenda" org-agenda-list t]
533 ["Display Timeline" org-timeline t]
534 ["Display TODO List" org-todo-list t]
535 ("Display Tags"
536 ,@(org-mouse-keyword-menu
537 (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
538 '(lambda (tag) (org-tags-view nil tag)))
539 "--"
540 ["Custom Tag ..." org-tags-view t])
541 ["Display Calendar" org-goto-calendar t]
542 "--"
543 ,@(org-mouse-keyword-menu
544 (mapcar 'car org-agenda-custom-commands)
545 '(lambda (key)
546 (eval `(flet ((read-char-exclusive () (string-to-char ,key)))
547 (org-agenda nil))))
549 '(lambda (key)
550 (let ((entry (assoc key org-agenda-custom-commands)))
551 (org-mouse-clip-text
552 (cond
553 ((stringp (nth 1 entry)) (nth 1 entry))
554 ((stringp (nth 2 entry))
555 (concat (org-mouse-agenda-type (nth 1 entry))
556 (nth 2 entry)))
557 (t "Agenda Command '%s'"))
558 30))))
559 "--"
560 ["Delete Blank Lines" delete-blank-lines
561 :visible (org-mouse-empty-line)]
562 ["Insert Checkbox" org-mouse-insert-checkbox
563 :visible (and (org-at-item-p) (not (org-at-item-checkbox-p)))]
564 ["Insert Checkboxes"
565 (org-mouse-for-each-item 'org-mouse-insert-checkbox)
566 :visible (and (org-at-item-p) (not (org-at-item-checkbox-p)))]
567 ["Plain List to Outline" org-mouse-transform-to-outline
568 :visible (org-at-item-p)])))
571 (defun org-mouse-get-context (contextlist context)
572 (let ((contextdata (assq context contextlist)))
573 (when contextdata
574 (save-excursion
575 (goto-char (second contextdata))
576 (re-search-forward ".*" (third contextdata))))))
578 (defun org-mouse-for-each-item (function)
579 (save-excursion
580 (ignore-errors
581 (while t (org-previous-item)))
582 (ignore-errors
583 (while t
584 (funcall function)
585 (org-next-item)))))
587 (defun org-mouse-bolp ()
588 "Returns true if there only spaces, tabs, and '*', between the beginning of line and the point"
589 (save-excursion
590 (skip-chars-backward " \t*") (bolp)))
592 (defun org-mouse-insert-item (text)
593 (case (org-mouse-line-position)
594 (:beginning ; insert before
595 (beginning-of-line)
596 (looking-at "[ \t]*")
597 (open-line 1)
598 (org-indent-to-column (- (match-end 0) (match-beginning 0)))
599 (insert "+ "))
601 (:middle ; insert after
602 (end-of-line)
603 (newline t)
604 (indent-relative)
605 (insert "+ "))
607 (:end ; insert text here
608 (skip-chars-backward " \t")
609 (kill-region (point) (point-at-eol))
610 (unless (looking-back org-mouse-punctuation)
611 (insert (concat org-mouse-punctuation " ")))))
613 (insert text)
614 (beginning-of-line))
616 (defadvice dnd-insert-text (around org-mouse-dnd-insert-text activate)
617 (if (eq major-mode 'org-mode)
618 (org-mouse-insert-item text)
619 ad-do-it))
621 (defadvice dnd-open-file (around org-mouse-dnd-open-file activate)
622 (if (eq major-mode 'org-mode)
623 (org-mouse-insert-item uri)
624 ad-do-it))
626 (defun org-mouse-match-closure (function)
627 (let ((match (match-data t)))
628 `(lambda (&rest rest)
629 (save-match-data
630 (set-match-data ',match)
631 (apply ',function rest)))))
633 (defun org-mouse-match-todo-keyword ()
634 (save-excursion
635 (org-back-to-heading)
636 (if (looking-at outline-regexp) (goto-char (match-end 0)))
637 (or (looking-at (concat " +" org-todo-regexp " *"))
638 (looking-at " \\( *\\)"))))
640 (defun org-mouse-yank-link (click)
641 (interactive "e")
642 ;; Give temporary modes such as isearch a chance to turn off.
643 (run-hooks 'mouse-leave-buffer-hook)
644 (mouse-set-point click)
645 (setq mouse-selection-click-count 0)
646 (delete-horizontal-space)
647 (insert-for-yank (concat " [[" (current-kill 0) "]] ")))
649 (defun org-mouse-context-menu (&optional event)
650 (let ((stamp-prefixes (list org-deadline-string org-scheduled-string))
651 (contextlist (org-context)))
652 (flet ((get-context (context) (org-mouse-get-context contextlist context)))
653 (cond
654 ((org-mouse-mark-active)
655 (let ((region-string (buffer-substring (region-beginning) (region-end))))
656 (popup-menu
657 `(nil
658 ["Sparse Tree" (org-occur ',region-string)]
659 ["Find in Buffer" (occur ',region-string)]
660 ["Grep in Current Dir"
661 (grep (format "grep -rnH -e '%s' *" ',region-string))]
662 ["Grep in Parent Dir"
663 (grep (format "grep -rnH -e '%s' ../*" ',region-string))]
664 "--"
665 ["Convert to Link"
666 (progn (save-excursion (goto-char (region-beginning)) (insert "[["))
667 (save-excursion (goto-char (region-end)) (insert "]]")))]
668 ["Insert Link Here" (org-mouse-yank-link ',event)]))))
670 ((save-excursion (beginning-of-line) (looking-at "#\\+STARTUP: \\(.*\\)"))
671 (popup-menu
672 `(nil
673 ,@(org-mouse-list-options-menu (mapcar 'car org-startup-options)
674 'org-mode-restart))))
675 ((or (eolp)
676 (and (looking-at "\\( \\|\t\\)\\(+:[0-9a-zA-Z_:]+\\)?\\( \\|\t\\)+$")
677 (looking-back " \\|\t")))
678 (org-mouse-popup-global-menu))
679 ((get-context :checkbox)
680 (popup-menu
681 '(nil
682 ["Toggle" org-toggle-checkbox t]
683 ["Remove" org-mouse-remove-match-and-spaces t]
685 ["All Clear" (org-mouse-for-each-item
686 (lambda ()
687 (when (save-excursion (org-at-item-checkbox-p))
688 (replace-match "[ ]"))))]
689 ["All Set" (org-mouse-for-each-item
690 (lambda ()
691 (when (save-excursion (org-at-item-checkbox-p))
692 (replace-match "[X]"))))]
693 ["All Toggle" (org-mouse-for-each-item 'org-toggle-checkbox) t]
694 ["All Remove" (org-mouse-for-each-item
695 (lambda ()
696 (when (save-excursion (org-at-item-checkbox-p))
697 (org-mouse-remove-match-and-spaces))))]
699 ((and (org-mouse-looking-at "\\b\\w+" "a-zA-Z0-9_")
700 (member (match-string 0) org-todo-keywords-1))
701 (popup-menu
702 `(nil
703 ,@(org-mouse-todo-menu (match-string 0))
704 "--"
705 ["Check TODOs" org-show-todo-tree t]
706 ["List all TODO keywords" org-todo-list t]
707 [,(format "List only %s" (match-string 0))
708 (org-todo-list (match-string 0)) t]
710 ((and (org-mouse-looking-at "\\b[A-Z]+:" "A-Z")
711 (member (match-string 0) stamp-prefixes))
712 (popup-menu
713 `(nil
714 ,@(org-mouse-keyword-replace-menu stamp-prefixes)
715 "--"
716 ["Check Deadlines" org-check-deadlines t]
718 ((org-mouse-looking-at org-mouse-priority-regexp "[]A-Z#") ; priority
719 (popup-menu `(nil ,@(org-mouse-keyword-replace-menu
720 (org-mouse-priority-list) 1 "Priority %s" t))))
721 ((get-context :link)
722 (popup-menu
723 '(nil
724 ["Open" org-open-at-point t]
725 ["Open in Emacs" (org-open-at-point t) t]
726 "--"
727 ["Copy link" (kill-new (match-string 0))]
728 ["Cut link"
729 (progn
730 (kill-region (match-beginning 0) (match-end 0))
731 (just-one-space))]
732 "--"
733 ["Grep for TODOs"
734 (grep (format "grep -nH -i 'todo\\|fixme' %s*" (match-string 2)))]
735 ; ["Paste file link" ((insert "file:") (yank))]
737 ((org-mouse-looking-at ":\\([A-Za-z0-9_]+\\):" "A-Za-z0-9_" -1) ;tags
738 (popup-menu
739 `(nil
740 [,(format "Display '%s'" (match-string 1))
741 (org-tags-view nil ,(match-string 1))]
742 [,(format "Sparse Tree '%s'" (match-string 1))
743 (org-tags-sparse-tree nil ,(match-string 1))]
744 "--"
745 ,@(org-mouse-tag-menu))))
746 ((org-at-timestamp-p)
747 (popup-menu
748 '(nil
749 ["Show Day" org-open-at-point t]
750 ["Change Timestamp" org-time-stamp t]
751 ["Delete Timestamp" (org-mouse-delete-timestamp) t]
752 ["Compute Time Range" org-evaluate-time-range (org-at-date-range-p)]
753 "--"
754 ["Set for Today" org-mouse-timestamp-today]
755 ["Set for Tomorrow" (org-mouse-timestamp-today 1 'day)]
756 ["Set in 1 Week" (org-mouse-timestamp-today 7 'day)]
757 ["Set in 2 Weeks" (org-mouse-timestamp-today 14 'day)]
758 ["Set in a Month" (org-mouse-timestamp-today 1 'month)]
759 "--"
760 ["+ 1 Day" (org-timestamp-change 1 'day)]
761 ["+ 1 Week" (org-timestamp-change 7 'day)]
762 ["+ 1 Month" (org-timestamp-change 1 'month)]
763 "--"
764 ["- 1 Day" (org-timestamp-change -1 'day)]
765 ["- 1 Week" (org-timestamp-change -7 'day)]
766 ["- 1 Month" (org-timestamp-change -1 'month)])))
767 ((get-context :table-special)
768 (let ((mdata (match-data)))
769 (incf (car mdata) 2)
770 (store-match-data mdata))
771 (message "match: %S" (match-string 0))
772 (popup-menu `(nil ,@(org-mouse-keyword-replace-menu
773 '(" " "!" "^" "_" "$" "#" "*" "'") 0
774 (lambda (mark)
775 (case (string-to-char mark)
776 (? "( ) Nothing Special")
777 (?! "(!) Column Names")
778 (?^ "(^) Field Names Above")
779 (?_ "(^) Field Names Below")
780 (?$ "($) Formula Parameters")
781 (?# "(#) Recalculation: Auto")
782 (?* "(*) Recalculation: Manual")
783 (?' "(') Recalculation: None"))) t))))
784 ((assq :table contextlist)
785 (popup-menu
786 '(nil
787 ["Align Table" org-ctrl-c-ctrl-c]
788 ["Blank Field" org-table-blank-field]
789 ["Edit Field" org-table-edit-field]
790 "--"
791 ("Column"
792 ["Move Column Left" org-metaleft]
793 ["Move Column Right" org-metaright]
794 ["Delete Column" org-shiftmetaleft]
795 ["Insert Column" org-shiftmetaright]
796 "--"
797 ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :selected org-table-limit-column-width :style toggle])
798 ("Row"
799 ["Move Row Up" org-metaup]
800 ["Move Row Down" org-metadown]
801 ["Delete Row" org-shiftmetaup]
802 ["Insert Row" org-shiftmetadown]
803 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
804 "--"
805 ["Insert Hline" org-table-insert-hline])
806 ("Rectangle"
807 ["Copy Rectangle" org-copy-special]
808 ["Cut Rectangle" org-cut-special]
809 ["Paste Rectangle" org-paste-special]
810 ["Fill Rectangle" org-table-wrap-region])
811 "--"
812 ["Set Column Formula" org-table-eval-formula]
813 ["Set Field Formula" (org-table-eval-formula '(4))]
814 ["Edit Formulas" org-table-edit-formulas]
815 "--"
816 ["Recalculate Line" org-table-recalculate]
817 ["Recalculate All" (org-table-recalculate '(4))]
818 ["Iterate All" (org-table-recalculate '(16))]
819 "--"
820 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks]
821 ["Sum Column/Rectangle" org-table-sum
822 :active (or (org-at-table-p) (org-region-active-p))]
823 ["Field Info" org-table-field-info]
824 ["Debug Formulas"
825 (setq org-table-formula-debug (not org-table-formula-debug))
826 :style toggle :selected org-table-formula-debug]
828 ((and (assq :headline contextlist) (not (eolp)))
829 (let ((priority (org-mouse-get-priority t)))
830 (popup-menu
831 `("Headline Menu"
832 ("Tags and Priorities"
833 ,@(org-mouse-keyword-menu
834 (org-mouse-priority-list)
835 '(lambda (keyword)
836 (org-mouse-set-priority (string-to-char keyword)))
837 priority "Priority %s")
838 "--"
839 ,@(org-mouse-tag-menu))
840 ("TODO Status"
841 ,@(org-mouse-todo-menu (org-get-todo-state)))
842 ["Show Tags"
843 (with-current-buffer org-mouse-main-buffer (org-agenda-show-tags))
844 :visible (not org-mouse-direct)]
845 ["Show Priority"
846 (with-current-buffer org-mouse-main-buffer (org-agenda-show-priority))
847 :visible (not org-mouse-direct)]
848 ,@(if org-mouse-direct '("--") nil)
849 ["New Heading" org-mouse-insert-heading :visible org-mouse-direct]
850 ["Set Deadline"
851 (progn (org-mouse-end-headline) (insert " ") (org-deadline))
852 :active (not (save-excursion
853 (org-mouse-re-search-line org-deadline-regexp)))]
854 ["Schedule Task"
855 (progn (org-mouse-end-headline) (insert " ") (org-schedule))
856 :active (not (save-excursion
857 (org-mouse-re-search-line org-scheduled-regexp)))]
858 ["Insert Timestamp"
859 (progn (org-mouse-end-headline) (insert " ") (org-time-stamp nil)) t]
860 ; ["Timestamp (inactive)" org-time-stamp-inactive t]
861 "--"
862 ["Archive Subtree" org-archive-subtree]
863 ["Cut Subtree" org-cut-special]
864 ["Copy Subtree" org-copy-special]
865 ["Paste Subtree" org-paste-special :visible org-mouse-direct]
866 ("Sort Children"
867 ["Alphabetically" (org-sort-entries nil ?a)]
868 ["Numerically" (org-sort-entries nil ?n)]
869 ["By Time/Date" (org-sort-entries nil ?t)]
870 "--"
871 ["Reverse Alphabetically" (org-sort-entries nil ?A)]
872 ["Reverse Numerically" (org-sort-entries nil ?N)]
873 ["Reverse By Time/Date" (org-sort-entries nil ?T)])
874 "--"
875 ["Move Trees" org-mouse-move-tree :active nil]
876 ))))
878 (org-mouse-popup-global-menu))))))
880 ;; (defun org-mouse-at-regexp (regexp)
881 ;; (save-excursion
882 ;; (let ((point (point))
883 ;; (bol (progn (beginning-of-line) (point)))
884 ;; (eol (progn (end-of-line) (point))))
885 ;; (goto-char point)
886 ;; (re-search-backward regexp bol 1)
887 ;; (and (not (eolp))
888 ;; (progn (forward-char)
889 ;; (re-search-forward regexp eol t))
890 ;; (<= (match-beginning 0) point)))))
892 (defun org-mouse-mark-active ()
893 (and mark-active transient-mark-mode))
895 (defun org-mouse-in-region-p (pos)
896 (and (org-mouse-mark-active)
897 (>= pos (region-beginning))
898 (< pos (region-end))))
900 (defun org-mouse-down-mouse (event)
901 (interactive "e")
902 (setq this-command last-command)
903 (unless (and (= 1 (event-click-count event))
904 (org-mouse-in-region-p (posn-point (event-start event))))
905 (mouse-drag-region event)))
907 (add-hook 'org-mode-hook
908 '(lambda ()
909 (setq org-mouse-context-menu-function 'org-mouse-context-menu)
911 (when (memq 'context-menu org-mouse-features)
912 (define-key org-mouse-map (if (featurep 'xemacs) [button3] [mouse-3]) nil)
913 (define-key org-mode-map [mouse-3] 'org-mouse-show-context-menu))
914 (define-key org-mode-map [down-mouse-1] 'org-mouse-down-mouse)
915 (when (memq 'context-menu org-mouse-features)
916 (define-key org-mouse-map [C-drag-mouse-1] 'org-mouse-move-tree)
917 (define-key org-mouse-map [C-down-mouse-1] 'org-mouse-move-tree-start))
918 (when (memq 'yank-link org-mouse-features)
919 (define-key org-mode-map [S-mouse-2] 'org-mouse-yank-link)
920 (define-key org-mode-map [drag-mouse-3] 'org-mouse-yank-link))
921 (when (memq 'move-tree org-mouse-features)
922 (define-key org-mouse-map [drag-mouse-3] 'org-mouse-move-tree)
923 (define-key org-mouse-map [down-mouse-3] 'org-mouse-move-tree-start))
925 (when (memq 'activate-stars org-mouse-features)
926 (font-lock-add-keywords
928 `((,outline-regexp
929 0 `(face org-link mouse-face highlight keymap ,org-mouse-map)
930 'prepend))
933 (when (memq 'activate-bullets org-mouse-features)
934 (font-lock-add-keywords
936 `(("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +"
937 (1 `(face org-link keymap ,org-mouse-map mouse-face highlight)
938 'prepend)))
941 (when (memq 'activate-checkboxes org-mouse-features)
942 (font-lock-add-keywords
944 `(("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[ X]\\]\\)"
945 (2 `(face bold keymap ,org-mouse-map mouse-face highlight) t)))
948 (defadvice org-open-at-point (around org-mouse-open-at-point activate)
949 (let ((context (org-context)))
950 (cond
951 ((assq :headline-stars context) (org-cycle))
952 ((assq :checkbox context) (org-toggle-checkbox))
953 ((assq :item-bullet context)
954 (let ((org-cycle-include-plain-lists t)) (org-cycle)))
955 (t ad-do-it))))))
957 (defun org-mouse-move-tree-start (event)
958 (interactive "e")
959 (message "Same line: promote/demote, (***):move before, (text): make a child"))
962 (defun org-mouse-make-marker (position)
963 (with-current-buffer (window-buffer (posn-window position))
964 (copy-marker (posn-point position))))
966 (defun org-mouse-move-tree (event)
967 ;; todo: handle movements between different buffers
968 (interactive "e")
969 (save-excursion
970 (let* ((start (org-mouse-make-marker (event-start event)))
971 (end (org-mouse-make-marker (event-end event)))
972 (sbuf (marker-buffer start))
973 (ebuf (marker-buffer end)))
975 (when (and sbuf ebuf)
976 (set-buffer sbuf)
977 (goto-char start)
978 (org-back-to-heading)
979 (if (and (eq sbuf ebuf)
980 (equal
981 (point)
982 (save-excursion (goto-char end) (org-back-to-heading) (point))))
983 ;; if the same line then promote/demote
984 (if (>= end start) (org-demote-subtree) (org-promote-subtree))
985 ;; if different lines then move
986 (org-cut-subtree)
988 (set-buffer ebuf)
989 (goto-char end)
990 (org-back-to-heading)
991 (when (and (eq sbuf ebuf)
992 (equal
993 (point)
994 (save-excursion (goto-char start)
995 (org-back-to-heading) (point))))
996 (outline-end-of-subtree)
997 (end-of-line)
998 (if (eobp) (newline) (forward-char)))
1000 (when (looking-at outline-regexp)
1001 (let ((level (- (match-end 0) (match-beginning 0))))
1002 (when (> end (match-end 0))
1003 (outline-end-of-subtree)
1004 (end-of-line)
1005 (if (eobp) (newline) (forward-char))
1006 (setq level (1+ level)))
1007 (org-paste-subtree level)
1008 (save-excursion
1009 (outline-end-of-subtree)
1010 (when (bolp) (delete-char -1))))))))))
1013 (defun org-mouse-transform-to-outline ()
1014 (interactive)
1015 (org-back-to-heading)
1016 (let ((minlevel 1000)
1017 (replace-text (concat (match-string 0) "* ")))
1018 (beginning-of-line 2)
1019 (save-excursion
1020 (while (not (or (eobp) (looking-at outline-regexp)))
1021 (when (looking-at org-mouse-plain-list-regexp)
1022 (setq minlevel (min minlevel (- (match-end 1) (match-beginning 1)))))
1023 (forward-line)))
1024 (while (not (or (eobp) (looking-at outline-regexp)))
1025 (when (and (looking-at org-mouse-plain-list-regexp)
1026 (eq minlevel (- (match-end 1) (match-beginning 1))))
1027 (replace-match replace-text))
1028 (forward-line))))
1030 (defvar _cmd) ;dynamically scoped from `org-with-remote-undo'.
1032 (defun org-mouse-do-remotely (command)
1033 ; (org-agenda-check-no-diary)
1034 (when (get-text-property (point) 'org-marker)
1035 (let* ((anticol (- (point-at-eol) (point)))
1036 (marker (get-text-property (point) 'org-marker))
1037 (buffer (marker-buffer marker))
1038 (pos (marker-position marker))
1039 (hdmarker (get-text-property (point) 'org-hd-marker))
1040 (buffer-read-only nil)
1041 (newhead "--- removed ---")
1042 (org-mouse-direct nil)
1043 (org-mouse-main-buffer (current-buffer)))
1044 (when (eq (with-current-buffer buffer major-mode) 'org-mode)
1045 (let ((endmarker (save-excursion
1046 (set-buffer buffer)
1047 (outline-end-of-subtree)
1048 (forward-char 1)
1049 (copy-marker (point)))))
1050 (org-with-remote-undo buffer
1051 (with-current-buffer buffer
1052 (widen)
1053 (goto-char pos)
1054 (org-show-hidden-entry)
1055 (save-excursion
1056 (and (outline-next-heading)
1057 (org-flag-heading nil))) ; show the next heading
1058 (org-back-to-heading)
1059 (setq marker (copy-marker (point)))
1060 (goto-char (max (point-at-bol) (- (point-at-eol) anticol)))
1061 (funcall command)
1062 (message "_cmd: %S" _cmd)
1063 (message "this-command: %S" this-command)
1064 (unless (eq (marker-position marker) (marker-position endmarker))
1065 (setq newhead (org-get-heading))))
1067 (beginning-of-line 1)
1068 (save-excursion
1069 (org-agenda-change-all-lines newhead hdmarker 'fixface))))
1070 t))))
1072 (defun org-mouse-agenda-context-menu (&optional event)
1073 (or (org-mouse-do-remotely 'org-mouse-context-menu)
1074 (popup-menu
1075 '("Agenda"
1076 ("Agenda Files")
1077 "--"
1078 ["Undo" (progn (message "last command: %S" last-command) (setq this-command 'org-agenda-undo) (org-agenda-undo))
1079 :visible (if (eq last-command 'org-agenda-undo)
1080 org-agenda-pending-undo-list
1081 org-agenda-undo-list)]
1082 ["Rebuild Buffer" org-agenda-redo t]
1083 ["New Diary Entry"
1084 org-agenda-diary-entry (org-agenda-check-type nil 'agenda 'timeline) t]
1085 "--"
1086 ["Goto Today" org-agenda-goto-today
1087 (org-agenda-check-type nil 'agenda 'timeline) t]
1088 ["Display Calendar" org-agenda-goto-calendar
1089 (org-agenda-check-type nil 'agenda 'timeline) t]
1090 ("Calendar Commands"
1091 ["Phases of the Moon" org-agenda-phases-of-moon
1092 (org-agenda-check-type nil 'agenda 'timeline)]
1093 ["Sunrise/Sunset" org-agenda-sunrise-sunset
1094 (org-agenda-check-type nil 'agenda 'timeline)]
1095 ["Holidays" org-agenda-holidays
1096 (org-agenda-check-type nil 'agenda 'timeline)]
1097 ["Convert" org-agenda-convert-date
1098 (org-agenda-check-type nil 'agenda 'timeline)]
1099 "--"
1100 ["Create iCalendar file" org-export-icalendar-combine-agenda-files t])
1101 "--"
1102 ["Day View" org-agenda-day-view
1103 :active (org-agenda-check-type nil 'agenda)
1104 :style radio :selected (equal org-agenda-ndays 1)]
1105 ["Week View" org-agenda-week-view
1106 :active (org-agenda-check-type nil 'agenda)
1107 :style radio :selected (equal org-agenda-ndays 7)]
1108 "--"
1109 ["Show Logbook entries" org-agenda-log-mode
1110 :style toggle :selected org-agenda-show-log
1111 :active (org-agenda-check-type nil 'agenda 'timeline)]
1112 ["Include Diary" org-agenda-toggle-diary
1113 :style toggle :selected org-agenda-include-diary
1114 :active (org-agenda-check-type nil 'agenda)]
1115 ["Use Time Grid" org-agenda-toggle-time-grid
1116 :style toggle :selected org-agenda-use-time-grid
1117 :active (org-agenda-check-type nil 'agenda)]
1118 ["Follow Mode" org-agenda-follow-mode
1119 :style toggle :selected org-agenda-follow-mode]
1120 "--"
1121 ["Quit" org-agenda-quit t]
1122 ["Exit and Release Buffers" org-agenda-exit t]
1123 ))))
1125 (defun org-mouse-get-gesture (event)
1126 (let ((startxy (posn-x-y (event-start event)))
1127 (endxy (posn-x-y (event-end event))))
1128 (if (< (car startxy) (car endxy)) :right :left)))
1131 ; (setq org-agenda-mode-hook nil)
1132 (add-hook 'org-agenda-mode-hook
1133 '(lambda ()
1134 (setq org-mouse-context-menu-function 'org-mouse-agenda-context-menu)
1135 (define-key org-agenda-keymap
1136 (if (featurep 'xemacs) [button3] [mouse-3])
1137 'org-mouse-show-context-menu)
1138 (define-key org-agenda-keymap [down-mouse-3] 'org-mouse-move-tree-start)
1139 (define-key org-agenda-keymap (if (featurep 'xemacs) [(control mouse-4)] [C-mouse-4]) 'org-agenda-earlier)
1140 (define-key org-agenda-keymap (if (featurep 'xemacs) [(control mouse-5)] [C-mouse-5]) 'org-agenda-later)
1141 (define-key org-agenda-keymap [drag-mouse-3]
1142 '(lambda (event) (interactive "e")
1143 (case (org-mouse-get-gesture event)
1144 (:left (org-agenda-earlier 1))
1145 (:right (org-agenda-later 1)))))))
1147 (provide 'org-mouse)
1149 ;; arch-tag: ff1ae557-3529-41a3-95c6-baaebdcc280f
1151 ;;; org-mouse.el ends-here