Mercurial > emacs
annotate lisp/dnd.el @ 87880:d9edfa21892c
*** empty log message ***
author | Thien-Thi Nguyen <ttn@gnuvola.org> |
---|---|
date | Mon, 21 Jan 2008 14:03:09 +0000 |
parents | 73661ddc7ac7 |
children | 606f2d163a64 |
rev | line source |
---|---|
61479 | 1 ;;; dnd.el --- drag and drop support. |
2 | |
79721 | 3 ;; Copyright (C) 2005, 2006, 2007, 2008 Free Software Foundation, Inc. |
61479 | 4 |
5 ;; Author: Jan Dj,Ad(Brv <jan.h.d@swipnet.se> | |
6 ;; Maintainer: FSF | |
7 ;; Keywords: window, drag, drop | |
8 | |
9 ;; This file is part of GNU Emacs. | |
10 | |
11 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
12 ;; it under the terms of the GNU General Public License as published by | |
78236
9355f9b7bbff
Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents:
78061
diff
changeset
|
13 ;; the Free Software Foundation; either version 3, or (at your option) |
61479 | 14 ;; any later version. |
15 | |
16 ;; GNU Emacs is distributed in the hope that it will be useful, | |
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 ;; GNU General Public License for more details. | |
20 | |
21 ;; You should have received a copy of the GNU General Public License | |
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
64091 | 23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 ;; Boston, MA 02110-1301, USA. | |
61479 | 25 |
26 ;;; Commentary: | |
27 | |
28 ;; This file provides the generic handling of the drop part only. | |
29 ;; Different DND backends (X11, W32, etc.) that handle the platform | |
30 ;; specific DND parts call the functions here to do final delivery of | |
31 ;; a drop. | |
32 | |
33 ;;; Code: | |
34 | |
35 ;;; Customizable variables | |
36 | |
37 | |
62311
a8f10a069bde
(dnd-protocol-alist): Add autoload.
Richard M. Stallman <rms@gnu.org>
parents:
62240
diff
changeset
|
38 ;;;###autoload |
61479 | 39 (defcustom dnd-protocol-alist |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
40 '(("^file:///" . dnd-open-local-file) ; XDND format. |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
41 ("^file://" . dnd-open-file) ; URL with host |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
42 ("^file:" . dnd-open-local-file) ; Old KDE, Motif, Sun |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
43 ("^\\(https?\\|ftp\\|file\\|nfs\\)://" . dnd-open-file) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
44 ) |
61479 | 45 |
46 "The functions to call for different protocols when a drop is made. | |
47 This variable is used by `dnd-handle-one-url' and `dnd-handle-file-name'. | |
48 The list contains of (REGEXP . FUNCTION) pairs. | |
49 The functions shall take two arguments, URL, which is the URL dropped and | |
50 ACTION which is the action to be performed for the drop (move, copy, link, | |
51 private or ask). | |
52 If no match is found here, and the value of `browse-url-browser-function' | |
53 is a pair of (REGEXP . FUNCTION), those regexps are tried for a match. | |
54 If no match is found, the URL is inserted as text by calling `dnd-insert-text'. | |
55 The function shall return the action done (move, copy, link or private) | |
56 if some action was made, or nil if the URL is ignored." | |
57 :version "22.1" | |
62240
19d278c4224b
* dnd.el (dnd-protocol-alist): Improve custom type.
Reiner Steib <Reiner.Steib@gmx.de>
parents:
61482
diff
changeset
|
58 :type '(repeat (cons (regexp) (function))) |
61479 | 59 :group 'dnd) |
60 | |
61 | |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
62 (defcustom dnd-open-remote-file-function |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
63 (if (eq system-type 'windows-nt) |
72912
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
64 'dnd-open-local-file |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
65 'dnd-open-remote-url) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
66 "The function to call when opening a file on a remote machine. |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
67 The function will be called with two arguments; URI and ACTION. See |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
68 `dnd-open-file' for details. |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
69 If nil, then dragging remote files into Emacs will result in an error. |
72912
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
70 Predefined functions are `dnd-open-local-file' and `dnd-open-remote-url'. |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
71 `dnd-open-local-file' attempts to open a remote file using its UNC name and |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
72 is the default on MS-Windows. `dnd-open-remote-url' uses `url-handler-mode' |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
73 and is the default except for MS-Windows." |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
74 :version "22.1" |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
75 :type 'function |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
76 :group 'dnd) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
77 |
61479 | 78 |
79 (defcustom dnd-open-file-other-window nil | |
80 "If non-nil, always use find-file-other-window to open dropped files." | |
81 :version "22.1" | |
82 :type 'boolean | |
83 :group 'dnd) | |
84 | |
85 | |
86 ;; Functions | |
87 | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
88 (defun dnd-handle-one-url (window action url) |
61479 | 89 "Handle one dropped url by calling the appropriate handler. |
90 The handler is first located by looking at `dnd-protocol-alist'. | |
91 If no match is found here, and the value of `browse-url-browser-function' | |
92 is a pair of (REGEXP . FUNCTION), those regexps are tried for a match. | |
93 If no match is found, just call `dnd-insert-text'. | |
73330
400487787181
* dnd.el (dnd-handle-one-url): Fix typo in doc-string.
Jan Djärv <jan.h.d@swipnet.se>
parents:
72912
diff
changeset
|
94 WINDOW is where the drop happened, ACTION is the action for the drop, |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
95 URL is what has been dropped. |
61479 | 96 Returns ACTION." |
97 (require 'browse-url) | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
98 (let (ret) |
61479 | 99 (or |
100 (catch 'done | |
101 (dolist (bf dnd-protocol-alist) | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
102 (when (string-match (car bf) url) |
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
103 (setq ret (funcall (cdr bf) url action)) |
61479 | 104 (throw 'done t))) |
105 nil) | |
106 (when (not (functionp browse-url-browser-function)) | |
107 (catch 'done | |
108 (dolist (bf browse-url-browser-function) | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
109 (when (string-match (car bf) url) |
61479 | 110 (setq ret 'private) |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
111 (funcall (cdr bf) url action) |
61479 | 112 (throw 'done t))) |
113 nil)) | |
114 (progn | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
115 (dnd-insert-text window action url) |
61479 | 116 (setq ret 'private))) |
117 ret)) | |
118 | |
119 | |
120 (defun dnd-get-local-file-uri (uri) | |
121 "Return an uri converted to file:/// syntax if uri is a local file. | |
122 Return nil if URI is not a local file." | |
123 | |
124 ;; The hostname may be our hostname, in that case, convert to a local | |
125 ;; file. Otherwise return nil. TODO: How about an IP-address as hostname? | |
126 (let ((hostname (when (string-match "^file://\\([^/]*\\)" uri) | |
127 (downcase (match-string 1 uri)))) | |
128 (system-name-no-dot | |
129 (downcase (if (string-match "^[^\\.]+" system-name) | |
130 (match-string 0 system-name) | |
131 system-name)))) | |
132 (when (and hostname | |
133 (or (string-equal "localhost" hostname) | |
134 (string-equal (downcase system-name) hostname) | |
135 (string-equal system-name-no-dot hostname))) | |
136 (concat "file://" (substring uri (+ 7 (length hostname))))))) | |
137 | |
138 (defun dnd-get-local-file-name (uri &optional must-exist) | |
139 "Return file name converted from file:/// or file: syntax. | |
140 URI is the uri for the file. If MUST-EXIST is given and non-nil, | |
141 only return non-nil if the file exists. | |
142 Return nil if URI is not a local file." | |
143 (let ((f (cond ((string-match "^file:///" uri) ; XDND format. | |
144 (substring uri (1- (match-end 0)))) | |
145 ((string-match "^file:" uri) ; Old KDE, Motif, Sun | |
146 (substring uri (match-end 0)))))) | |
147 (when (and f must-exist) | |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
148 (setq f (replace-regexp-in-string |
77132
4d39a7fbbc3c
(dnd-get-local-file-name): Decode both upper and lower
Jason Rumney <jasonr@gnu.org>
parents:
75347
diff
changeset
|
149 "%[A-Fa-f0-9][A-Fa-f0-9]" |
70760
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
150 (lambda (arg) |
eca94c558ceb
(dnd-handle-one-url): Change 3rd arg ARG to URL. Don't unescape URL.
YAMAMOTO Mitsuharu <mituharu@math.s.chiba-u.ac.jp>
parents:
68651
diff
changeset
|
151 (format "%c" (string-to-number (substring arg 1) 16))) |
78061
08057013c059
(dnd-get-local-file-name): Set fixcase to t in call to
Jan Djärv <jan.h.d@swipnet.se>
parents:
77132
diff
changeset
|
152 f t t)) |
61479 | 153 (let* ((decoded-f (decode-coding-string |
154 f | |
155 (or file-name-coding-system | |
156 default-file-name-coding-system))) | |
157 (try-f (if (file-readable-p decoded-f) decoded-f f))) | |
158 (when (file-readable-p try-f) try-f))))) | |
159 | |
160 | |
161 (defun dnd-open-local-file (uri action) | |
162 "Open a local file. | |
163 The file is opened in the current window, or a new window if | |
164 `dnd-open-file-other-window' is set. URI is the url for the file, | |
165 and must have the format file:file-name or file:///file-name. | |
72912
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
166 The last / in file:/// is part of the file name. If the system |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
167 natively supports unc file names, then remote urls of the form |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
168 file://server-name/file-name will also be handled by this function. |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
169 An alternative for systems that do not support unc file names is |
1c4d17d3a136
(dnd-open-remote-file-function): Use dnd-open-local-file on ms-windows.
Jason Rumney <jasonr@gnu.org>
parents:
72689
diff
changeset
|
170 `dnd-open-remote-url'. ACTION is ignored." |
61479 | 171 |
172 (let* ((f (dnd-get-local-file-name uri t))) | |
173 (if (and f (file-readable-p f)) | |
174 (progn | |
175 (if dnd-open-file-other-window | |
176 (find-file-other-window f) | |
177 (find-file f)) | |
178 'private) | |
179 (error "Can not read %s" uri)))) | |
180 | |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
181 (defun dnd-open-remote-url (uri action) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
182 "Open a remote file with `find-file' and `url-handler-mode'. |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
183 Turns `url-handler-mode' on if not on before. The file is opened in the |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
184 current window, or a new window if `dnd-open-file-other-window' is set. |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
185 URI is the url for the file. ACTION is ignored." |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
186 (progn |
72689
3ff56e45c67f
* dnd.el: Fix bootstrapping
Jan Djärv <jan.h.d@swipnet.se>
parents:
72687
diff
changeset
|
187 (require 'url-handlers) |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
188 (or url-handler-mode (url-handler-mode)) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
189 (if dnd-open-file-other-window |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
190 (find-file-other-window uri) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
191 (find-file uri)) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
192 'private)) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
193 |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
194 |
61479 | 195 (defun dnd-open-file (uri action) |
196 "Open a local or remote file. | |
197 The file is opened in the current window, or a new window if | |
198 `dnd-open-file-other-window' is set. URI is the url for the file, | |
199 and must have the format file://hostname/file-name. ACTION is ignored. | |
200 The last / in file://hostname/ is part of the file name." | |
201 | |
202 ;; The hostname may be our hostname, in that case, convert to a local | |
203 ;; file. Otherwise return nil. | |
204 (let ((local-file (dnd-get-local-file-uri uri))) | |
205 (if local-file (dnd-open-local-file local-file action) | |
72687
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
206 (if dnd-open-remote-file-function |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
207 (funcall dnd-open-remote-file-function uri action) |
eedaad0e9f80
* dnd.el (dnd-protocol-alist): Add what url-handler-mode can handle.
Jan Djärv <jan.h.d@swipnet.se>
parents:
70760
diff
changeset
|
208 (error "Remote files not supported"))))) |
61479 | 209 |
210 | |
211 (defun dnd-insert-text (window action text) | |
212 "Insert text at point or push to the kill ring if buffer is read only. | |
213 TEXT is the text as a string, WINDOW is the window where the drop happened." | |
214 (if (or buffer-read-only | |
215 (not (windowp window))) | |
216 (progn | |
217 (kill-new text) | |
65582
4d1085b02d64
Message format spec fixes (1)
Deepak Goel <deego@gnufans.org>
parents:
64762
diff
changeset
|
218 (message "%s" |
61479 | 219 (substitute-command-keys |
220 "The dropped text can be accessed with \\[yank]"))) | |
221 (insert text)) | |
222 action) | |
223 | |
224 | |
225 (provide 'dnd) | |
226 | |
61482 | 227 ;; arch-tag: 0472f6a5-2e8f-4304-9e44-1a0877c771b7 |
61479 | 228 ;;; dnd.el ends here |