org-mouse.el 37.6 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
;;; org-mouse.el --- Better mouse support for Org -*- lexical-binding: t; -*-
Carsten Dominik's avatar
Carsten Dominik committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2006-2020 Free Software Foundation, Inc.
4

Carsten Dominik's avatar
Carsten Dominik committed
5 6
;; Author: Piotr Zielinski <piotr dot zielinski at gmail dot com>
;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
Bastien Guerry's avatar
Bastien Guerry committed
7

Carsten Dominik's avatar
Carsten Dominik committed
8
;; This file is part of GNU Emacs.
9

10
;; GNU Emacs is free software: you can redistribute it and/or modify
Carsten Dominik's avatar
Carsten Dominik committed
11
;; it under the terms of the GNU General Public License as published by
12 13
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Carsten Dominik's avatar
Carsten Dominik committed
14 15 16 17 18 19 20

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
21
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
22

Carsten Dominik's avatar
Carsten Dominik committed
23 24 25 26
;;; Commentary:
;;
;; Org-mouse provides mouse support for org-mode.
;;
Rasmus's avatar
Rasmus committed
27
;; https://orgmode.org
Carsten Dominik's avatar
Carsten Dominik committed
28
;;
Rasmus's avatar
Rasmus committed
29 30
;; Org mouse implements the following features:
;; * following links with the left mouse button
Carsten Dominik's avatar
Carsten Dominik committed
31 32 33 34 35 36 37 38 39 40
;; * subtree expansion/collapse (org-cycle) with the left mouse button
;; * several context menus on the right mouse button:
;;    + general text
;;    + headlines
;;    + timestamps
;;    + priorities
;;    + links
;;    + tags
;; * promoting/demoting/moving subtrees with mouse-3
;;    + if the drag starts and ends in the same line then promote/demote
41
;;    + otherwise move the subtree
Carsten Dominik's avatar
Carsten Dominik committed
42 43 44 45 46 47 48 49 50
;;
;; Use
;; ---
;;
;; To use this package, put the following line in your .emacs:
;;
;;    (require 'org-mouse)
;;

51
;; FIXME:
Carsten Dominik's avatar
Carsten Dominik committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
;; + deal with folding / unfolding issues

;; TODO (This list is only theoretical, if you'd like to have some
;; feature implemented or a bug fix please send me an email, even if
;; something similar appears in the list below.  This will help me get
;; the priorities right.):
;;
;; + org-store-link, insert link
;; + org tables
;; + occur with the current word/tag (same menu item)
;; + ctrl-c ctrl-c, for example, renumber the current list
;; + internal links

;; Please email the maintainer with new feature suggestions / bugs

;; History:
;;
Rasmus's avatar
Rasmus committed
69
;; Since version 5.10: Changes are listed in the general Org docs.
Carsten Dominik's avatar
Carsten Dominik committed
70
;;
Rasmus's avatar
Rasmus committed
71
;; Version 5.09;; + Version number synchronization with Org mode.
Carsten Dominik's avatar
Carsten Dominik committed
72 73
;;
;; Version 0.25
Rasmus's avatar
Rasmus committed
74
;; + made compatible with Org 4.70 (thanks to Carsten for the patch)
Carsten Dominik's avatar
Carsten Dominik committed
75 76 77 78 79 80 81 82 83
;;
;; Version 0.24
;; + minor changes to the table menu
;;
;; Version 0.23
;; + preliminary support for tables and calculation marks
;; + context menu support for org-agenda-undo & org-sort-entries
;;
;; Version 0.22
Rasmus's avatar
Rasmus committed
84
;; + handles undo support for the agenda buffer (requires Org >=4.58)
Carsten Dominik's avatar
Carsten Dominik committed
85 86 87 88 89 90
;;
;; Version 0.21
;; + selected text activates its context menu
;; + shift-middleclick or right-drag inserts the text from the clipboard in the form of a link
;;
;; Version 0.20
91
;; + the new "TODO Status" submenu replaces the "Cycle TODO" menu item
Carsten Dominik's avatar
Carsten Dominik committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
;; + the TODO menu can now list occurrences of a specific TODO keyword
;; + #+STARTUP line is now recognized
;;
;; Version 0.19
;; + added support for dragging URLs to the org-buffer
;;
;; Version 0.18
;; + added support for agenda blocks
;;
;; Version 0.17
;; + toggle checkboxes with a single click
;;
;; Version 0.16
;; + added support for checkboxes
;;
;; Version 0.15
Rasmus's avatar
Rasmus committed
108
;; + Org now works with the Agenda buffer as well
Carsten Dominik's avatar
Carsten Dominik committed
109 110 111 112
;;
;; Version 0.14
;; + added a menu option that converts plain list items to outline items
;;
113
;; Version 0.13
Carsten Dominik's avatar
Carsten Dominik committed
114 115
;; + "Insert Heading" now inserts a sibling heading if the point is
;;   on "***" and a child heading otherwise
116
;;
Carsten Dominik's avatar
Carsten Dominik committed
117 118 119 120 121 122 123 124 125 126 127
;; Version 0.12
;; + compatible with Emacs 21
;; + custom agenda commands added to the main menu
;; + moving trees should now work between windows in the same frame
;;
;; Version 0.11
;; + fixed org-mouse-at-link (thanks to Carsten)
;; + removed [follow-link] bindings
;;
;; Version 0.10
;; + added a menu option to remove highlights
Rasmus's avatar
Rasmus committed
128
;; + compatible with Org 4.21 now
Carsten Dominik's avatar
Carsten Dominik committed
129
;;
130
;; Version 0.08:
Carsten Dominik's avatar
Carsten Dominik committed
131 132 133 134 135 136
;; + trees can be moved/promoted/demoted by dragging with the right
;;   mouse button (mouse-3)
;; + small changes in the above function
;;
;; Versions 0.01 -- 0.07: (I don't remember)

137 138
;;; Code:

Carsten Dominik's avatar
Carsten Dominik committed
139
(require 'org)
Rasmus's avatar
Rasmus committed
140
(require 'cl-lib)
Carsten Dominik's avatar
Carsten Dominik committed
141

142 143 144 145
(defvar org-agenda-allow-remote-undo)
(defvar org-agenda-undo-list)
(defvar org-agenda-custom-commands)
(declare-function org-agenda-change-all-lines "org-agenda"
146
		  (newhead hdmarker &optional fixface just-this))
147
(declare-function org-verify-change-for-undo "org-agenda" (l1 l2))
148
(declare-function org-apply-on-list "org-list" (function init-value &rest args))
149 150
(declare-function org-agenda-earlier "org-agenda" (arg))
(declare-function org-agenda-later "org-agenda" (arg))
151

Rasmus's avatar
Rasmus committed
152 153
(defvar org-mouse-main-buffer nil
  "Active buffer for mouse operations.")
Carsten Dominik's avatar
Carsten Dominik committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
(defvar org-mouse-plain-list-regexp "\\([ \t]*\\)\\([-+*]\\|[0-9]+[.)]\\) "
  "Regular expression that matches a plain list.")
(defvar org-mouse-direct t
  "Internal variable indicating whether the current action is direct.

If t, then the current action has been invoked directly through the buffer
it is intended to operate on.  If nil, then the action has been invoked
indirectly, for example, through the agenda buffer.")

(defgroup org-mouse nil
  "Mouse support for org-mode."
  :tag "Org Mouse"
  :group 'org)

(defcustom org-mouse-punctuation ":"
  "Punctuation used when inserting text by drag and drop."
  :group 'org-mouse
  :type 'string)

173 174 175 176 177 178 179 180 181 182 183
(defcustom org-mouse-features
  '(context-menu yank-link activate-stars activate-bullets activate-checkboxes)
  "The features of org-mouse that should be activated.
Changing this variable requires a restart of Emacs to get activated."
  :group 'org-mouse
  :type '(set :greedy t
	      (const :tag "Mouse-3 shows context menu" context-menu)
	      (const :tag "C-mouse-1 and mouse-3 move trees" move-tree)
	      (const :tag "S-mouse-2 and drag-mouse-3 yank link" yank-link)
	      (const :tag "Activate headline stars" activate-stars)
	      (const :tag "Activate item bullets" activate-bullets)
184
	      (const :tag "Activate checkboxes" activate-checkboxes)))
Carsten Dominik's avatar
Carsten Dominik committed
185 186 187 188 189 190 191 192 193 194 195

(defun org-mouse-re-search-line (regexp)
  "Search the current line for a given regular expression."
  (beginning-of-line)
  (re-search-forward regexp (point-at-eol) t))

(defun org-mouse-end-headline ()
  "Go to the end of current headline (ignoring tags)."
  (interactive)
  (end-of-line)
  (skip-chars-backward "\t ")
Rasmus's avatar
Rasmus committed
196
  (when (looking-back ":[A-Za-z]+:" (line-beginning-position))
Carsten Dominik's avatar
Carsten Dominik committed
197 198 199
    (skip-chars-backward ":A-Za-z")
    (skip-chars-backward "\t ")))

Rasmus's avatar
Rasmus committed
200
(defvar-local org-mouse-context-menu-function nil
Carsten Dominik's avatar
Carsten Dominik committed
201 202 203 204 205 206 207 208
  "Function to create the context menu.
The value of this variable is the function invoked by
`org-mouse-context-menu' as the context menu.")

(defun org-mouse-show-context-menu (event prefix)
  "Invoke the context menu.

If the value of `org-mouse-context-menu-function' is a function, then
209
this function is called.  Otherwise, the current major mode menu is used."
Carsten Dominik's avatar
Carsten Dominik committed
210 211
  (interactive "@e \nP")
  (if (and (= (event-click-count event) 1)
212
	   (or (not mark-active)
Carsten Dominik's avatar
Carsten Dominik committed
213 214
	       (sit-for (/ double-click-time 1000.0))))
      (progn
215
	(select-window (posn-window (event-start event)))
Carsten Dominik's avatar
Carsten Dominik committed
216 217 218
	(when (not (org-mouse-mark-active))
	  (goto-char (posn-point (event-start event)))
	  (when (not (eolp)) (save-excursion (run-hooks 'post-command-hook)))
Rasmus's avatar
Rasmus committed
219
	  (sit-for 0))
Carsten Dominik's avatar
Carsten Dominik committed
220 221
	(if (functionp org-mouse-context-menu-function)
	    (funcall org-mouse-context-menu-function event)
222 223
	  (if (fboundp 'mouse-menu-major-mode-map)
	      (popup-menu (mouse-menu-major-mode-map) event prefix)
Rasmus's avatar
Rasmus committed
224
	    (with-no-warnings ; don't warn about fallback, obsolete since 23.1
225
	     (mouse-major-mode-menu event prefix)))))
Carsten Dominik's avatar
Carsten Dominik committed
226 227 228 229
    (setq this-command 'mouse-save-then-kill)
    (mouse-save-then-kill event)))

(defun org-mouse-line-position ()
230
  "Return `:beginning' or `:middle' or `:end', depending on the point position.
Carsten Dominik's avatar
Carsten Dominik committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260

If the point is at the end of the line, return `:end'.
If the point is separated from the beginning of the line only by white
space and *'s (`org-mouse-bolp'), return `:beginning'.  Otherwise,
return `:middle'."
  (cond
   ((eolp) :end)
   ((org-mouse-bolp) :beginning)
   (t :middle)))

(defun org-mouse-empty-line ()
  "Return non-nil iff the line contains only white space."
  (save-excursion (beginning-of-line) (looking-at "[ \t]*$")))

(defun org-mouse-next-heading ()
  "Go to the next heading.
If there is none, ensure that the point is at the beginning of an empty line."
  (unless (outline-next-heading)
    (beginning-of-line)
    (unless (org-mouse-empty-line)
      (end-of-line)
      (newline))))

(defun org-mouse-insert-heading ()
  "Insert a new heading, as `org-insert-heading'.

If the point is at the :beginning (`org-mouse-line-position') of the line,
insert the new heading before the current line.  Otherwise, insert it
after the current heading."
  (interactive)
Rasmus's avatar
Rasmus committed
261
  (cl-case (org-mouse-line-position)
Carsten Dominik's avatar
Carsten Dominik committed
262
    (:beginning (beginning-of-line)
263
		(org-insert-heading))
Carsten Dominik's avatar
Carsten Dominik committed
264 265 266
    (t (org-mouse-next-heading)
       (org-insert-heading))))

267 268
(defun org-mouse-timestamp-today (&optional shift units)
  "Change the timestamp into SHIFT UNITS in the future.
Carsten Dominik's avatar
Carsten Dominik committed
269 270 271

For the acceptable UNITS, see `org-timestamp-change'."
  (interactive)
272 273
  (org-time-stamp nil)
  (when shift (org-timestamp-change shift units)))
Carsten Dominik's avatar
Carsten Dominik committed
274 275 276 277 278 279 280 281 282 283 284 285 286

(defun org-mouse-keyword-menu (keywords function &optional selected itemformat)
  "A helper function.

Returns a menu fragment consisting of KEYWORDS.  When a keyword
is selected by the user, FUNCTION is called with the selected
keyword as the only argument.

If SELECTED is nil, then all items are normal menu items.  If
SELECTED is a function, then each item is a checkbox, which is
enabled for a given keyword iff (funcall SELECTED keyword) return
non-nil.  If SELECTED is neither nil nor a function, then the
items are radio buttons.  A radio button is enabled for the
287
keyword `equal' to SELECTED.
Carsten Dominik's avatar
Carsten Dominik committed
288 289 290 291 292

ITEMFORMAT governs formatting of the elements of KEYWORDS.  If it
is a function, it is invoked with the keyword as the only
argument.  If it is a string, it is interpreted as the format
string to (format ITEMFORMAT keyword).  If it is neither a string
293
nor a function, elements of KEYWORDS are used directly."
294 295
  (mapcar
   `(lambda (keyword)
296 297 298 299 300 301 302 303 304 305 306 307 308
      (vector (cond
	       ((functionp ,itemformat) (funcall ,itemformat keyword))
	       ((stringp ,itemformat) (format ,itemformat keyword))
	       (t keyword))
	      (list 'funcall ,function keyword)
	      :style (cond
		      ((null ,selected) t)
		      ((functionp ,selected) 'toggle)
		      (t 'radio))
	      :selected (if (functionp ,selected)
			    (and (funcall ,selected keyword) t)
			  (equal ,selected keyword))))
   keywords))
309

Carsten Dominik's avatar
Carsten Dominik committed
310 311 312 313 314 315
(defun org-mouse-remove-match-and-spaces ()
  "Remove the match, make just one space around the point."
  (interactive)
  (replace-match "")
  (just-one-space))

316
(defvar org-mouse-rest)
Rasmus's avatar
Rasmus committed
317 318
(defun org-mouse-replace-match-and-surround
    (_newtext &optional _fixedcase _literal _string subexp)
Carsten Dominik's avatar
Carsten Dominik committed
319
  "The same as `replace-match', but surrounds the replacement with spaces."
Rasmus's avatar
Rasmus committed
320
  (apply #'replace-match org-mouse-rest)
Carsten Dominik's avatar
Carsten Dominik committed
321
  (save-excursion
322
    (goto-char (match-beginning (or subexp 0)))
Carsten Dominik's avatar
Carsten Dominik committed
323
    (just-one-space)
324
    (goto-char (match-end (or subexp 0)))
Carsten Dominik's avatar
Carsten Dominik committed
325
    (just-one-space)))
326

Carsten Dominik's avatar
Carsten Dominik committed
327 328 329 330 331 332 333 334
(defun org-mouse-keyword-replace-menu (keywords &optional group itemformat
						nosurround)
  "A helper function.

Returns a menu fragment consisting of KEYWORDS.  When a keyword
is selected, group GROUP of the current match is replaced by the
keyword.  The method ensures that both ends of the replacement
are separated from the rest of the text in the buffer by
335
individual spaces (unless NOSURROUND is non-nil).
Carsten Dominik's avatar
Carsten Dominik committed
336 337 338 339 340 341 342 343

The final entry of the menu is always \"None\", which removes the
match.

ITEMFORMAT governs formatting of the elements of KEYWORDS.  If it
is a function, it is invoked with the keyword as the only
argument.  If it is a string, it is interpreted as the format
string to (format ITEMFORMAT keyword).  If it is neither a string
344
nor a function, elements of KEYWORDS are used directly."
Carsten Dominik's avatar
Carsten Dominik committed
345
  (setq group (or group 0))
346
  (let ((replace (org-mouse-match-closure
Carsten Dominik's avatar
Carsten Dominik committed
347 348 349
		  (if nosurround 'replace-match
		    'org-mouse-replace-match-and-surround))))
    (append
350
     (org-mouse-keyword-menu
Carsten Dominik's avatar
Carsten Dominik committed
351 352 353 354
      keywords
      `(lambda (keyword) (funcall ,replace keyword t t nil ,group))
      (match-string group)
      itemformat)
355
     `(["None" org-mouse-remove-match-and-spaces
Carsten Dominik's avatar
Carsten Dominik committed
356 357
	:style radio
	:selected ,(not (member (match-string group) keywords))]))))
358

Carsten Dominik's avatar
Carsten Dominik committed
359 360
(defun org-mouse-show-headlines ()
  "Change the visibility of the current org buffer to only show headlines."
361 362
  (interactive)
  (let ((this-command 'org-cycle)
Carsten Dominik's avatar
Carsten Dominik committed
363 364 365 366 367 368 369
	(last-command 'org-cycle)
	(org-cycle-global-status nil))
    (org-cycle '(4))
    (org-cycle '(4))))

(defun org-mouse-show-overview ()
  "Change visibility of current org buffer to first-level headlines only."
370
  (interactive)
Carsten Dominik's avatar
Carsten Dominik committed
371 372 373 374 375
  (let ((org-cycle-global-status nil))
    (org-cycle '(4))))

(defun org-mouse-set-priority (priority)
  "Set the priority of the current headline to PRIORITY."
376
  (org-priority priority))
Carsten Dominik's avatar
Carsten Dominik committed
377 378 379 380

(defvar org-mouse-priority-regexp "\\[#\\([A-Z]\\)\\]"
  "Regular expression matching the priority indicator.
Differs from `org-priority-regexp' in that it doesn't contain the
381
leading `.*?'.")
Carsten Dominik's avatar
Carsten Dominik committed
382 383 384 385

(defun org-mouse-get-priority (&optional default)
  "Return the priority of the current headline.
DEFAULT is returned if no priority is given in the headline."
386
  (save-excursion
Carsten Dominik's avatar
Carsten Dominik committed
387 388 389 390 391 392 393
    (if (org-mouse-re-search-line org-mouse-priority-regexp)
	(match-string 1)
      (when default (char-to-string org-default-priority)))))

(defun org-mouse-delete-timestamp ()
  "Deletes the current timestamp as well as the preceding keyword.
SCHEDULED: or DEADLINE: or ANYTHINGLIKETHIS:"
Rasmus's avatar
Rasmus committed
394 395
  (when (or (org-at-date-range-p) (org-at-timestamp-p 'lax))
    (replace-match "")			;delete the timestamp
Carsten Dominik's avatar
Carsten Dominik committed
396 397 398 399
    (skip-chars-backward " :A-Z")
    (when (looking-at " *[A-Z][A-Z]+:")
      (replace-match ""))))

400
(defun org-mouse-looking-at (regexp skipchars &optional movechars)
Carsten Dominik's avatar
Carsten Dominik committed
401 402 403 404 405 406 407
  (save-excursion
    (let ((point (point)))
      (if (looking-at regexp) t
	(skip-chars-backward skipchars)
	(forward-char (or movechars 0))
	(when (looking-at regexp)
	  (> (match-end 0) point))))))
408

Carsten Dominik's avatar
Carsten Dominik committed
409
(defun org-mouse-priority-list ()
Rasmus's avatar
Rasmus committed
410 411
  (cl-loop for priority from ?A to org-lowest-priority
	   collect (char-to-string priority)))
Carsten Dominik's avatar
Carsten Dominik committed
412

413 414 415 416 417 418 419 420 421
(defun org-mouse-todo-menu (state)
  "Create the menu with TODO keywords."
  (append
   (let ((kwds org-todo-keywords-1))
     (org-mouse-keyword-menu
      kwds
      `(lambda (kwd) (org-todo kwd))
      (lambda (kwd) (equal state kwd))))))

Carsten Dominik's avatar
Carsten Dominik committed
422
(defun org-mouse-tag-menu ()		;todo
423
  "Create the tags menu."
Carsten Dominik's avatar
Carsten Dominik committed
424
  (append
Bastien's avatar
Bastien committed
425
   (let ((tags (org-get-tags nil t)))
426
     (org-mouse-keyword-menu
Carsten Dominik's avatar
Carsten Dominik committed
427
      (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
428 429 430
      `(lambda (tag)
	 (org-mouse-set-tags
	  (sort (if (member tag (quote ,tags))
Carsten Dominik's avatar
Carsten Dominik committed
431 432 433 434 435 436
		    (delete tag (quote ,tags))
		  (cons tag (quote ,tags)))
		'string-lessp)))
      `(lambda (tag) (member tag (quote ,tags)))
      ))
   '("--"
Bastien's avatar
Bastien committed
437 438 439
     ["Align Tags Here" (org-align-tags) t]
     ["Align Tags in Buffer" (org-align-tags t) t]
     ["Set Tags ..." (org-set-tags-command) t])))
440

Carsten Dominik's avatar
Carsten Dominik committed
441
(defun org-mouse-set-tags (tags)
Bastien's avatar
Bastien committed
442
  (org-set-tags tags))
443

Carsten Dominik's avatar
Carsten Dominik committed
444 445 446 447 448 449 450 451 452
(defun org-mouse-insert-checkbox ()
  (interactive)
  (and (org-at-item-p)
       (goto-char (match-end 0))
       (unless (org-at-item-checkbox-p)
	 (delete-horizontal-space)
	 (insert " [ ] "))))

(defun org-mouse-agenda-type (type)
Rasmus's avatar
Rasmus committed
453 454 455 456 457 458 459
  (pcase type
    (`tags "Tags: ")
    (`todo "TODO: ")
    (`tags-tree "Tags tree: ")
    (`todo-tree "TODO tree: ")
    (`occur-tree "Occur tree: ")
    (_ "Agenda command ???")))
Carsten Dominik's avatar
Carsten Dominik committed
460 461

(defun org-mouse-list-options-menu (alloptions &optional function)
462
  (let ((options (save-match-data
Carsten Dominik's avatar
Carsten Dominik committed
463 464
		   (split-string (match-string-no-properties 1)))))
    (print options)
Rasmus's avatar
Rasmus committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
    (cl-loop for name in alloptions
	     collect
	     (vector name
		     `(progn
			(replace-match
			 (mapconcat 'identity
				    (sort (if (member ',name ',options)
					      (delete ',name ',options)
					    (cons ',name ',options))
					  'string-lessp)
				    " ")
			 nil nil nil 1)
			(when (functionp ',function) (funcall ',function)))
		     :style 'toggle
		     :selected (and (member name options) t)))))
Carsten Dominik's avatar
Carsten Dominik committed
480 481 482 483 484 485 486

(defun org-mouse-clip-text (text maxlength)
  (if (> (length text) maxlength)
      (concat (substring text 0 (- maxlength 3)) "...")
    text))

(defun org-mouse-popup-global-menu ()
487
  (popup-menu
Carsten Dominik's avatar
Carsten Dominik committed
488 489 490
   `("Main Menu"
     ["Show Overview" org-mouse-show-overview t]
     ["Show Headlines" org-mouse-show-headlines t]
Bastien's avatar
Bastien committed
491
     ["Show All" org-show-all t]
Carsten Dominik's avatar
Carsten Dominik committed
492 493 494
     ["Remove Highlights" org-remove-occur-highlights
      :visible org-occur-highlights]
     "--"
495
     ["Check Deadlines"
Carsten Dominik's avatar
Carsten Dominik committed
496 497 498 499
      (if (functionp 'org-check-deadlines-and-todos)
	  (org-check-deadlines-and-todos org-deadline-warning-days)
	(org-check-deadlines org-deadline-warning-days)) t]
     ["Check TODOs" org-show-todo-tree t]
500 501
     ("Check Tags"
      ,@(org-mouse-keyword-menu
Carsten Dominik's avatar
Carsten Dominik committed
502
	 (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
503
	 #'(lambda (tag) (org-tags-sparse-tree nil tag)))
Carsten Dominik's avatar
Carsten Dominik committed
504 505 506 507 508 509
      "--"
      ["Custom Tag ..." org-tags-sparse-tree t])
     ["Check Phrase ..." org-occur]
     "--"
     ["Display Agenda" org-agenda-list t]
     ["Display TODO List" org-todo-list t]
510 511
     ("Display Tags"
      ,@(org-mouse-keyword-menu
Carsten Dominik's avatar
Carsten Dominik committed
512
	 (sort (mapcar 'car (org-get-buffer-tags)) 'string-lessp)
513
	 #'(lambda (tag) (org-tags-view nil tag)))
Carsten Dominik's avatar
Carsten Dominik committed
514 515 516 517
      "--"
      ["Custom Tag ..." org-tags-view t])
     ["Display Calendar" org-goto-calendar t]
     "--"
518
     ,@(org-mouse-keyword-menu
Carsten Dominik's avatar
Carsten Dominik committed
519
	(mapcar 'car org-agenda-custom-commands)
520
	#'(lambda (key)
521
	    (eval `(org-agenda nil (string-to-char ,key))))
522
	nil
523
	#'(lambda (key)
524 525 526 527 528 529 530
	    (let ((entry (assoc key org-agenda-custom-commands)))
	      (org-mouse-clip-text
	       (cond
		((stringp (nth 1 entry)) (nth 1 entry))
		((stringp (nth 2 entry))
		 (concat (org-mouse-agenda-type (nth 1 entry))
			 (nth 2 entry)))
531
		(t "Agenda Command `%s'"))
532
	       30))))
Carsten Dominik's avatar
Carsten Dominik committed
533
     "--"
534
     ["Delete Blank Lines" delete-blank-lines
Carsten Dominik's avatar
Carsten Dominik committed
535 536 537
      :visible (org-mouse-empty-line)]
     ["Insert Checkbox" org-mouse-insert-checkbox
      :visible (and (org-at-item-p) (not (org-at-item-checkbox-p)))]
538
     ["Insert Checkboxes"
Carsten Dominik's avatar
Carsten Dominik committed
539 540 541 542 543 544 545 546
      (org-mouse-for-each-item 'org-mouse-insert-checkbox)
      :visible (and (org-at-item-p) (not (org-at-item-checkbox-p)))]
     ["Plain List to Outline" org-mouse-transform-to-outline
      :visible (org-at-item-p)])))

(defun org-mouse-get-context (contextlist context)
  (let ((contextdata (assq context contextlist)))
    (when contextdata
547
      (save-excursion
Rasmus's avatar
Rasmus committed
548 549
	(goto-char (nth 1 contextdata))
	(re-search-forward ".*" (nth 2 contextdata))))))
Carsten Dominik's avatar
Carsten Dominik committed
550

551
(defun org-mouse-for-each-item (funct)
Rasmus's avatar
Rasmus committed
552 553
  ;; Functions called by `org-apply-on-list' need an argument.
  (let ((wrap-fun (lambda (_) (funcall funct))))
554 555
    (when (ignore-errors (goto-char (org-in-item-p)))
      (save-excursion (org-apply-on-list wrap-fun nil)))))
Carsten Dominik's avatar
Carsten Dominik committed
556 557

(defun org-mouse-bolp ()
558
  "Return true if there only spaces, tabs, and `*' before point.
559
This means, between the beginning of line and the point."
Carsten Dominik's avatar
Carsten Dominik committed
560 561
  (save-excursion
    (skip-chars-backward " \t*") (bolp)))
562

Carsten Dominik's avatar
Carsten Dominik committed
563
(defun org-mouse-insert-item (text)
Rasmus's avatar
Rasmus committed
564 565
  (cl-case (org-mouse-line-position)
    (:beginning				; insert before
566
     (beginning-of-line)
Carsten Dominik's avatar
Carsten Dominik committed
567 568
     (looking-at "[ \t]*")
     (open-line 1)
Rasmus's avatar
Rasmus committed
569
     (indent-to-column (- (match-end 0) (match-beginning 0)))
Carsten Dominik's avatar
Carsten Dominik committed
570
     (insert "+ "))
Rasmus's avatar
Rasmus committed
571
    (:middle				; insert after
572 573
     (end-of-line)
     (newline t)
Carsten Dominik's avatar
Carsten Dominik committed
574 575 576
     (indent-relative)
     (insert "+ "))
    (:end				; insert text here
577
     (skip-chars-backward " \t")
Carsten Dominik's avatar
Carsten Dominik committed
578
     (kill-region (point) (point-at-eol))
Rasmus's avatar
Rasmus committed
579
     (unless (looking-back org-mouse-punctuation (line-beginning-position))
Carsten Dominik's avatar
Carsten Dominik committed
580 581 582 583 584
       (insert (concat org-mouse-punctuation " ")))))
  (insert text)
  (beginning-of-line))

(defadvice dnd-insert-text (around org-mouse-dnd-insert-text activate)
585
  (if (derived-mode-p 'org-mode)
Carsten Dominik's avatar
Carsten Dominik committed
586 587 588 589
      (org-mouse-insert-item text)
    ad-do-it))

(defadvice dnd-open-file (around org-mouse-dnd-open-file activate)
590
  (if (derived-mode-p 'org-mode)
Carsten Dominik's avatar
Carsten Dominik committed
591 592 593 594 595
      (org-mouse-insert-item uri)
    ad-do-it))

(defun org-mouse-match-closure (function)
  (let ((match (match-data t)))
596
    `(lambda (&rest rest)
597 598 599
       (save-match-data
	 (set-match-data ',match)
	 (apply ',function rest)))))
Carsten Dominik's avatar
Carsten Dominik committed
600 601 602 603 604 605 606 607 608 609 610

(defun org-mouse-yank-link (click)
  (interactive "e")
  ;; Give temporary modes such as isearch a chance to turn off.
  (run-hooks 'mouse-leave-buffer-hook)
  (mouse-set-point click)
  (setq mouse-selection-click-count 0)
  (delete-horizontal-space)
  (insert-for-yank (concat " [[" (current-kill 0) "]] ")))

(defun org-mouse-context-menu (&optional event)
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
  (let* ((stamp-prefixes (list org-deadline-string org-scheduled-string))
	 (contextlist (org-context))
	 (get-context (lambda (context) (org-mouse-get-context contextlist context))))
    (cond
     ((org-mouse-mark-active)
      (let ((region-string (buffer-substring (region-beginning) (region-end))))
	(popup-menu
	 `(nil
	   ["Sparse Tree" (org-occur ',region-string)]
	   ["Find in Buffer" (occur ',region-string)]
	   ["Grep in Current Dir"
	    (grep (format "grep -rnH -e '%s' *" ',region-string))]
	   ["Grep in Parent Dir"
	    (grep (format "grep -rnH -e '%s' ../*" ',region-string))]
	   "--"
	   ["Convert to Link"
	    (progn (save-excursion (goto-char (region-beginning)) (insert "[["))
		   (save-excursion (goto-char (region-end)) (insert "]]")))]
	   ["Insert Link Here" (org-mouse-yank-link ',event)]))))
Rasmus's avatar
Rasmus committed
630
     ((save-excursion (beginning-of-line) (looking-at "[ \t]*#\\+STARTUP: \\(.*\\)"))
Carsten Dominik's avatar
Carsten Dominik committed
631 632
      (popup-menu
       `(nil
633 634 635
	 ,@(org-mouse-list-options-menu (mapcar 'car org-startup-options)
					'org-mode-restart))))
     ((or (eolp)
636
	  (and (looking-at "\\(  \\|\t\\)\\(\\+:[0-9a-zA-Z_:]+\\)?\\(  \\|\t\\)+$")
Rasmus's avatar
Rasmus committed
637 638
	       (looking-back "  \\|\t" (- (point) 2)
			     (line-beginning-position))))
639 640 641 642 643 644 645 646 647 648
      (org-mouse-popup-global-menu))
     ((funcall get-context :checkbox)
      (popup-menu
       '(nil
	 ["Toggle" org-toggle-checkbox t]
	 ["Remove" org-mouse-remove-match-and-spaces t]
	 ""
	 ["All Clear" (org-mouse-for-each-item
		       (lambda ()
			 (when (save-excursion (org-at-item-checkbox-p))
Bastien Guerry's avatar
Bastien Guerry committed
649
			   (replace-match "[ ] "))))]
650
	 ["All Set" (org-mouse-for-each-item
Carsten Dominik's avatar
Carsten Dominik committed
651 652
		     (lambda ()
		       (when (save-excursion (org-at-item-checkbox-p))
Bastien Guerry's avatar
Bastien Guerry committed
653
			 (replace-match "[X] "))))]
654 655 656 657 658 659 660 661 662 663 664
	 ["All Toggle" (org-mouse-for-each-item 'org-toggle-checkbox) t]
	 ["All Remove" (org-mouse-for-each-item
			(lambda ()
			  (when (save-excursion (org-at-item-checkbox-p))
			    (org-mouse-remove-match-and-spaces))))]
	 )))
     ((and (org-mouse-looking-at "\\b\\w+" "a-zA-Z0-9_")
	   (member (match-string 0) org-todo-keywords-1))
      (popup-menu
       `(nil
	 ,@(org-mouse-todo-menu (match-string 0))
Carsten Dominik's avatar
Carsten Dominik committed
665
	 "--"
666 667 668 669 670 671 672 673 674 675
	 ["Check TODOs" org-show-todo-tree t]
	 ["List all TODO keywords" org-todo-list t]
	 [,(format "List only %s" (match-string 0))
	  (org-todo-list (match-string 0)) t]
	 )))
     ((and (org-mouse-looking-at "\\b[A-Z]+:" "A-Z")
	   (member (match-string 0) stamp-prefixes))
      (popup-menu
       `(nil
	 ,@(org-mouse-keyword-replace-menu stamp-prefixes)
Carsten Dominik's avatar
Carsten Dominik committed
676
	 "--"
677 678 679 680 681 682
	 ["Check Deadlines" org-check-deadlines t]
	 )))
     ((org-mouse-looking-at org-mouse-priority-regexp "[]A-Z#") ; priority
      (popup-menu `(nil ,@(org-mouse-keyword-replace-menu
			   (org-mouse-priority-list) 1 "Priority %s" t))))
     ((funcall get-context :link)
Carsten Dominik's avatar
Carsten Dominik committed
683
      (popup-menu
684 685 686 687 688 689 690 691 692
       '(nil
	 ["Open" org-open-at-point t]
	 ["Open in Emacs" (org-open-at-point t) t]
	 "--"
	 ["Copy link" (org-kill-new (match-string 0))]
	 ["Cut link"
	  (progn
	    (kill-region (match-beginning 0) (match-end 0))
	    (just-one-space))]
Carsten Dominik's avatar
Carsten Dominik committed
693
	 "--"
694 695 696 697 698 699 700
	 ["Grep for TODOs"
	  (grep (format "grep -nH -i 'todo\\|fixme' %s*" (match-string 2)))]
					;       ["Paste file link" ((insert "file:") (yank))]
	 )))
     ((org-mouse-looking-at ":\\([A-Za-z0-9_]+\\):" "A-Za-z0-9_" -1) ;tags
      (popup-menu
       `(nil
701
	 [,(format-message "Display `%s'" (match-string 1))
702
	  (org-tags-view nil ,(match-string 1))]
703
	 [,(format-message "Sparse Tree `%s'" (match-string 1))
704 705 706
	  (org-tags-sparse-tree nil ,(match-string 1))]
	 "--"
	 ,@(org-mouse-tag-menu))))
Rasmus's avatar
Rasmus committed
707
     ((org-at-timestamp-p 'lax)
708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
      (popup-menu
       '(nil
	 ["Show Day" org-open-at-point t]
	 ["Change Timestamp" org-time-stamp t]
	 ["Delete Timestamp" (org-mouse-delete-timestamp) t]
	 ["Compute Time Range" org-evaluate-time-range (org-at-date-range-p)]
	 "--"
	 ["Set for Today" org-mouse-timestamp-today]
	 ["Set for Tomorrow" (org-mouse-timestamp-today 1 'day)]
	 ["Set in 1 Week" (org-mouse-timestamp-today 7 'day)]
	 ["Set in 2 Weeks" (org-mouse-timestamp-today 14 'day)]
	 ["Set in a Month" (org-mouse-timestamp-today 1 'month)]
	 "--"
	 ["+ 1 Day" (org-timestamp-change 1 'day)]
	 ["+ 1 Week" (org-timestamp-change 7 'day)]
	 ["+ 1 Month" (org-timestamp-change 1 'month)]
	 "--"
	 ["- 1 Day" (org-timestamp-change -1 'day)]
	 ["- 1 Week" (org-timestamp-change -7 'day)]
	 ["- 1 Month" (org-timestamp-change -1 'month)])))
     ((funcall get-context :table-special)
      (let ((mdata (match-data)))
Rasmus's avatar
Rasmus committed
730
	(cl-incf (car mdata) 2)
731 732 733 734 735
	(store-match-data mdata))
      (message "match: %S" (match-string 0))
      (popup-menu `(nil ,@(org-mouse-keyword-replace-menu
			   '(" " "!" "^" "_" "$" "#" "*" "'") 0
			   (lambda (mark)
Rasmus's avatar
Rasmus committed
736
			     (cl-case (string-to-char mark)
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
			       (?  "( ) Nothing Special")
			       (?! "(!) Column Names")
			       (?^ "(^) Field Names Above")
			       (?_ "(^) Field Names Below")
			       (?$ "($) Formula Parameters")
			       (?# "(#) Recalculation: Auto")
			       (?* "(*) Recalculation: Manual")
			       (?' "(') Recalculation: None"))) t))))
     ((assq :table contextlist)
      (popup-menu
       '(nil
	 ["Align Table" org-ctrl-c-ctrl-c]
	 ["Blank Field" org-table-blank-field]
	 ["Edit Field" org-table-edit-field]
	 "--"
	 ("Column"
	  ["Move Column Left" org-metaleft]
	  ["Move Column Right" org-metaright]
	  ["Delete Column" org-shiftmetaleft]
	  ["Insert Column" org-shiftmetaright]
	  "--"
	  ["Enable Narrowing" (setq org-table-limit-column-width (not org-table-limit-column-width)) :selected org-table-limit-column-width :style toggle])
	 ("Row"
	  ["Move Row Up" org-metaup]
	  ["Move Row Down" org-metadown]
	  ["Delete Row" org-shiftmetaup]
	  ["Insert Row" org-shiftmetadown]
	  ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
Carsten Dominik's avatar
Carsten Dominik committed
765
	  "--"
766 767 768 769 770 771
	  ["Insert Hline" org-table-insert-hline])
	 ("Rectangle"
	  ["Copy Rectangle" org-copy-special]
	  ["Cut Rectangle" org-cut-special]
	  ["Paste Rectangle" org-paste-special]
	  ["Fill Rectangle" org-table-wrap-region])
Carsten Dominik's avatar
Carsten Dominik committed
772
	 "--"
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
	 ["Set Column Formula" org-table-eval-formula]
	 ["Set Field Formula" (org-table-eval-formula '(4))]
	 ["Edit Formulas" org-table-edit-formulas]
	 "--"
	 ["Recalculate Line" org-table-recalculate]
	 ["Recalculate All" (org-table-recalculate '(4))]
	 ["Iterate All" (org-table-recalculate '(16))]
	 "--"
	 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks]
	 ["Sum Column/Rectangle" org-table-sum
	  :active (or (org-at-table-p) (org-region-active-p))]
	 ["Field Info" org-table-field-info]
	 ["Debug Formulas"
	  (setq org-table-formula-debug (not org-table-formula-debug))
	  :style toggle :selected org-table-formula-debug]
	 )))
     ((and (assq :headline contextlist) (not (eolp)))
      (let ((priority (org-mouse-get-priority t)))
	(popup-menu
	 `("Headline Menu"
	   ("Tags and Priorities"
	    ,@(org-mouse-keyword-menu
	       (org-mouse-priority-list)
	       #'(lambda (keyword)
		   (org-mouse-set-priority (string-to-char keyword)))
	       priority "Priority %s")
	    "--"
	    ,@(org-mouse-tag-menu))
	   ("TODO Status"
	    ,@(org-mouse-todo-menu (org-get-todo-state)))
	   ["Show Tags"
	    (with-current-buffer org-mouse-main-buffer (org-agenda-show-tags))
	    :visible (not org-mouse-direct)]
	   ["Show Priority"
	    (with-current-buffer org-mouse-main-buffer (org-agenda-show-priority))
	    :visible (not org-mouse-direct)]
	   ,@(if org-mouse-direct '("--") nil)
	   ["New Heading" org-mouse-insert-heading :visible org-mouse-direct]
	   ["Set Deadline"
	    (progn (org-mouse-end-headline) (insert " ") (org-deadline))
	    :active (not (save-excursion
			   (org-mouse-re-search-line org-deadline-regexp)))]
	   ["Schedule Task"
	    (progn (org-mouse-end-headline) (insert " ") (org-schedule))
	    :active (not (save-excursion
			   (org-mouse-re-search-line org-scheduled-regexp)))]
	   ["Insert Timestamp"
	    (progn (org-mouse-end-headline) (insert " ") (org-time-stamp nil)) t]
					;	 ["Timestamp (inactive)" org-time-stamp-inactive t]
	   "--"
	   ["Archive Subtree" org-archive-subtree]
	   ["Cut Subtree"  org-cut-special]
	   ["Copy Subtree"  org-copy-special]
	   ["Paste Subtree"  org-paste-special :visible org-mouse-direct]
	   ("Sort Children"
	    ["Alphabetically" (org-sort-entries nil ?a)]
	    ["Numerically" (org-sort-entries nil ?n)]
	    ["By Time/Date" (org-sort-entries nil ?t)]
	    "--"
	    ["Reverse Alphabetically" (org-sort-entries nil ?A)]
	    ["Reverse Numerically" (org-sort-entries nil ?N)]
	    ["Reverse By Time/Date" (org-sort-entries nil ?T)])
	   "--"
	   ["Move Trees" org-mouse-move-tree :active nil]
	   ))))
     (t
      (org-mouse-popup-global-menu)))))
Carsten Dominik's avatar
Carsten Dominik committed
840 841 842 843 844

(defun org-mouse-mark-active ()
  (and mark-active transient-mark-mode))

(defun org-mouse-in-region-p (pos)
845 846
  (and (org-mouse-mark-active)
       (>= pos (region-beginning))
Carsten Dominik's avatar
Carsten Dominik committed
847 848 849 850 851 852 853 854 855 856
       (<  pos (region-end))))

(defun org-mouse-down-mouse (event)
  (interactive "e")
  (setq this-command last-command)
  (unless (and (= 1 (event-click-count event))
	       (org-mouse-in-region-p (posn-point (event-start event))))
    (mouse-drag-region event)))

(add-hook 'org-mode-hook
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
	  #'(lambda ()
	      (setq org-mouse-context-menu-function 'org-mouse-context-menu)

	      (when (memq 'context-menu org-mouse-features)
		(org-defkey org-mouse-map [mouse-3] nil)
		(org-defkey org-mode-map [mouse-3] 'org-mouse-show-context-menu))
	      (org-defkey org-mode-map [down-mouse-1] 'org-mouse-down-mouse)
	      (when (memq 'context-menu org-mouse-features)
		(org-defkey org-mouse-map [C-drag-mouse-1] 'org-mouse-move-tree)
		(org-defkey org-mouse-map [C-down-mouse-1] 'org-mouse-move-tree-start))
	      (when (memq 'yank-link org-mouse-features)
		(org-defkey org-mode-map [S-mouse-2] 'org-mouse-yank-link)
		(org-defkey org-mode-map [drag-mouse-3] 'org-mouse-yank-link))
	      (when (memq 'move-tree org-mouse-features)
		(org-defkey org-mouse-map [drag-mouse-3] 'org-mouse-move-tree)
		(org-defkey org-mouse-map [down-mouse-3] 'org-mouse-move-tree-start))

	      (when (memq 'activate-stars org-mouse-features)
		(font-lock-add-keywords
		 nil
		 `((,org-outline-regexp
		    0 `(face org-link mouse-face highlight keymap ,org-mouse-map)
		    'prepend))
		 t))

	      (when (memq 'activate-bullets org-mouse-features)
		(font-lock-add-keywords
		 nil
		 `(("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +"
		    (1 `(face org-link keymap ,org-mouse-map mouse-face highlight)
		       'prepend)))
		 t))

	      (when (memq 'activate-checkboxes org-mouse-features)
		(font-lock-add-keywords
		 nil
		 `(("^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) +\\(\\[[ X]\\]\\)"
		    (2 `(face bold keymap ,org-mouse-map mouse-face highlight) t)))
		 t))

	      (defadvice org-open-at-point (around org-mouse-open-at-point activate)
		(let ((context (org-context)))
		  (cond
		   ((assq :headline-stars context) (org-cycle))
		   ((assq :checkbox context) (org-toggle-checkbox))
		   ((assq :item-bullet context)
		    (let ((org-cycle-include-plain-lists t)) (org-cycle)))
		   ((org-footnote-at-reference-p) nil)
		   (t ad-do-it))))))
Carsten Dominik's avatar
Carsten Dominik committed
906

Rasmus's avatar
Rasmus committed
907
(defun org-mouse-move-tree-start (_event)
Carsten Dominik's avatar
Carsten Dominik committed
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
  (interactive "e")
  (message "Same line: promote/demote, (***):move before, (text): make a child"))


(defun org-mouse-make-marker (position)
  (with-current-buffer (window-buffer (posn-window position))
    (copy-marker (posn-point position))))

(defun org-mouse-move-tree (event)
  ;; todo: handle movements between different buffers
  (interactive "e")
  (save-excursion
    (let* ((start (org-mouse-make-marker (event-start event)))
	   (end (org-mouse-make-marker (event-end event)))
	   (sbuf (marker-buffer start))
	   (ebuf (marker-buffer end)))

925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
      (when (and sbuf ebuf)
	(set-buffer sbuf)
	(goto-char start)
	(org-back-to-heading)
	(if (and (eq sbuf ebuf)
		 (equal
		  (point)
		  (save-excursion (goto-char end) (org-back-to-heading) (point))))
	    ;; if the same line then promote/demote
	    (if (>= end start) (org-demote-subtree) (org-promote-subtree))
	  ;; if different lines then move
	  (org-cut-subtree)

	  (set-buffer ebuf)
	  (goto-char end)
	  (org-back-to-heading)
	  (when  (and (eq sbuf ebuf)
		      (equal
		       (point)
		       (save-excursion (goto-char start)
				       (org-back-to-heading) (point))))
Bastien Guerry's avatar
Bastien Guerry committed
946 947
	    (progn (org-end-of-subtree nil t)
		   (unless (eobp) (backward-char)))
Carsten Dominik's avatar
Carsten Dominik committed
948
	    (end-of-line)
949 950 951 952 953
	    (if (eobp) (newline) (forward-char)))

	  (when (looking-at org-outline-regexp)
	    (let ((level (- (match-end 0) (match-beginning 0))))
	      (when (> end (match-end 0))
Bastien Guerry's avatar
Bastien Guerry committed
954 955
		(progn (org-end-of-subtree nil t)
		       (unless (eobp) (backward-char)))
956 957 958 959 960
		(end-of-line)
		(if (eobp) (newline) (forward-char))
		(setq level (1+ level)))
	      (org-paste-subtree level)
	      (save-excursion
Bastien Guerry's avatar
Bastien Guerry committed
961 962
		(progn (org-end-of-subtree nil t)
		       (unless (eobp) (backward-char)))
963
		(when (bolp) (delete-char -1))))))))))
Carsten Dominik's avatar
Carsten Dominik committed
964 965 966 967 968 969 970 971 972


(defun org-mouse-transform-to-outline ()
  (interactive)
  (org-back-to-heading)
  (let ((minlevel 1000)
	(replace-text (concat (match-string 0) "* ")))
    (beginning-of-line 2)
    (save-excursion
973
      (while (not (or (eobp) (looking-at org-outline-regexp)))
Carsten Dominik's avatar
Carsten Dominik committed
974 975 976
	(when (looking-at org-mouse-plain-list-regexp)
	  (setq minlevel (min minlevel (- (match-end 1) (match-beginning 1)))))
	(forward-line)))
977
    (while (not (or (eobp) (looking-at org-outline-regexp)))
Carsten Dominik's avatar
Carsten Dominik committed
978 979 980 981 982
      (when (and (looking-at org-mouse-plain-list-regexp)
		 (eq minlevel (- (match-end 1) (match-beginning 1))))
	(replace-match replace-text))
      (forward-line))))

983
(defvar org-mouse-cmd) ;dynamically scoped from `org-with-remote-undo'.
Carsten Dominik's avatar
Carsten Dominik committed
984 985

(defun org-mouse-do-remotely (command)
Rasmus's avatar
Rasmus committed
986
  ;;  (org-agenda-check-no-diary)
Carsten Dominik's avatar
Carsten Dominik committed
987 988 989 990 991 992 993 994 995 996 997
  (when (get-text-property (point) 'org-marker)
    (let* ((anticol (- (point-at-eol) (point)))
	   (marker (get-text-property (point) 'org-marker))
	   (buffer (marker-buffer marker))
	   (pos (marker-position marker))
	   (hdmarker (get-text-property (point) 'org-hd-marker))
	   (buffer-read-only nil)
	   (newhead "--- removed ---")
	   (org-mouse-direct nil)
	   (org-mouse-main-buffer (current-buffer)))
      (when (eq (with-current-buffer buffer major-mode) 'org-mode)
998
	(let ((endmarker (with-current-buffer buffer
Bastien Guerry's avatar
Bastien Guerry committed
999 1000
			   (org-end-of-subtree nil t)
			   (unless (eobp) (forward-char 1))
1001
			   (point-marker))))
Carsten Dominik's avatar
Carsten Dominik committed
1002 1003 1004 1005 1006 1007 1008 1009 1010
	  (org-with-remote-undo buffer
	    (with-current-buffer buffer
	      (widen)
	      (goto-char pos)
	      (org-show-hidden-entry)
	      (save-excursion
		(and (outline-next-heading)
		     (org-flag-heading nil)))   ; show the next heading
	      (org-back-to-heading)
1011
	      (setq marker (point-marker))
Carsten Dominik's avatar
Carsten Dominik committed
1012 1013
	      (goto-char (max (point-at-bol) (- (point-at-eol) anticol)))
	      (funcall command)
1014
	      (message "_cmd: %S" org-mouse-cmd)
Carsten Dominik's avatar
Carsten Dominik committed
1015 1016 1017
	      (message "this-command: %S" this-command)
	      (unless (eq (marker-position marker) (marker-position endmarker))
		(setq newhead (org-get-heading))))
1018

Carsten Dominik's avatar
Carsten Dominik committed
1019 1020 1021 1022 1023
	    (beginning-of-line 1)
	    (save-excursion
	      (org-agenda-change-all-lines newhead hdmarker 'fixface))))
	t))))

Rasmus's avatar
Rasmus committed
1024
(defun org-mouse-agenda-context-menu (&optional _event)
Carsten Dominik's avatar
Carsten Dominik committed
1025
  (or (org-mouse-do-remotely 'org-mouse-context-menu)
1026
      (popup-menu
Carsten Dominik's avatar
Carsten Dominik committed
1027 1028 1029 1030
       '("Agenda"
	 ("Agenda Files")
	 "--"
	 ["Undo" (progn (message "last command: %S" last-command) (setq this-command 'org-agenda-undo) (org-agenda-undo))
1031
	  :visible (if (eq last-command 'org-agenda-undo)
Carsten Dominik's avatar
Carsten Dominik committed
1032 1033 1034
		       org-agenda-pending-undo-list
		     org-agenda-undo-list)]
	 ["Rebuild Buffer" org-agenda-redo t]
1035
	 ["New Diary Entry"
Rasmus's avatar
Rasmus committed
1036
	  org-agenda-diary-entry (org-agenda-check-type nil 'agenda) t]
Carsten Dominik's avatar
Carsten Dominik committed
1037
	 "--"
1038
	 ["Goto Today" org-agenda-goto-today
Rasmus's avatar
Rasmus committed
1039
	  (org-agenda-check-type nil 'agenda) t]
1040
	 ["Display Calendar" org-agenda-goto-calendar
Rasmus's avatar
Rasmus committed
1041
	  (org-agenda-check-type nil 'agenda) t]
Carsten Dominik's avatar
Carsten Dominik committed
1042
	 ("Calendar Commands"
1043
	  ["Phases of the Moon" org-agenda-phases-of-moon
Rasmus's avatar
Rasmus committed
1044
	   (org-agenda-check-type nil 'agenda)]
1045
	  ["Sunrise/Sunset" org-agenda-sunrise-sunset
Rasmus's avatar
Rasmus committed
1046
	   (org-agenda-check-type nil 'agenda)]
1047
	  ["Holidays" org-agenda-holidays
Rasmus's avatar
Rasmus committed
1048
	   (org-agenda-check-type nil 'agenda)]
1049
	  ["Convert" org-agenda-convert-date
Rasmus's avatar
Rasmus committed
1050
	   (org-agenda-check-type nil 'agenda)]
Carsten Dominik's avatar
Carsten Dominik committed
1051
	  "--"
Bastien Guerry's avatar
Bastien Guerry committed
1052
	  ["Create iCalendar file" org-icalendar-combine-agenda-files t])
Carsten Dominik's avatar
Carsten Dominik committed
1053
	 "--"
1054
	 ["Day View" org-agenda-day-view
Carsten Dominik's avatar
Carsten Dominik committed
1055
	  :active (org-agenda-check-type nil 'agenda)
Carsten Dominik's avatar
Carsten Dominik committed
1056
	  :style radio :selected (eq org-agenda-current-span 'day)]
1057
	 ["Week View" org-agenda-week-view
Carsten Dominik's avatar
Carsten Dominik committed
1058
	  :active (org-agenda-check-type nil 'agenda)
Carsten Dominik's avatar
Carsten Dominik committed
1059
	  :style radio :selected (eq org-agenda-current-span 'week)]
Carsten Dominik's avatar
Carsten Dominik committed
1060 1061
	 "--"
	 ["Show Logbook entries" org-agenda-log-mode
1062
	  :style toggle :selected org-agenda-show-log
Rasmus's avatar
Rasmus committed
1063
	  :active (org-agenda-check-type nil 'agenda)]
Carsten Dominik's avatar
Carsten Dominik committed
1064
	 ["Include Diary" org-agenda-toggle-diary
1065
	  :style toggle :selected org-agenda-include-diary
Carsten Dominik's avatar
Carsten Dominik committed
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
	  :active (org-agenda-check-type nil 'agenda)]
	 ["Use Time Grid" org-agenda-toggle-time-grid
	  :style toggle :selected org-agenda-use-time-grid
	  :active (org-agenda-check-type nil 'agenda)]
	 ["Follow Mode" org-agenda-follow-mode
	  :style toggle :selected org-agenda-follow-mode]
	 "--"
	 ["Quit" org-agenda-quit t]
	 ["Exit and Release Buffers" org-agenda-exit t]
	 ))))

(defun org-mouse-get-gesture (event)
  (let ((startxy (posn-x-y (event-start event)))
	(endxy (posn-x-y (event-end event))))
    (if (< (car startxy) (car endxy)) :right :left)))


1083
					; (setq org-agenda-mode-hook nil)
1084
(defvar org-agenda-mode-map)
1085
(add-hook 'org-agenda-mode-hook
Rasmus's avatar
Rasmus committed
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
	  (lambda ()
	    (setq org-mouse-context-menu-function 'org-mouse-agenda-context-menu)
	    (org-defkey org-agenda-mode-map [mouse-3] 'org-mouse-show-context-menu)
	    (org-defkey org-agenda-mode-map [down-mouse-3] 'org-mouse-move-tree-start)
	    (org-defkey org-agenda-mode-map [C-mouse-4] 'org-agenda-earlier)
	    (org-defkey org-agenda-mode-map [C-mouse-5] 'org-agenda-later)
	    (org-defkey org-agenda-mode-map [drag-mouse-3]
			(lambda (event) (interactive "e")
			  (cl-case (org-mouse-get-gesture event)
			    (:left (org-agenda-earlier 1))
			    (:right (org-agenda-later 1)))))))
Carsten Dominik's avatar
Carsten Dominik committed
1097 1098

(provide 'org-mouse)
Miles Bader's avatar
Miles Bader committed
1099

1100
;;; org-mouse.el ends here