Mercurial > emacs
comparison lisp/vc/vc-dispatcher.el @ 109404:e93288477c43
Merge from mainline.
author | Katsumi Yamaoka <yamaoka@jpl.org> |
---|---|
date | Sun, 13 Jun 2010 22:57:55 +0000 |
parents | lisp/vc-dispatcher.el@d418516def73 lisp/vc-dispatcher.el@d928a6a7c3f2 |
children | 1b626601d32d |
comparison
equal
deleted
inserted
replaced
109403:681cd08dc0f7 | 109404:e93288477c43 |
---|---|
1 ;;; vc-dispatcher.el -- generic command-dispatcher facility. | |
2 | |
3 ;; Copyright (C) 2008, 2009, 2010 | |
4 ;; Free Software Foundation, Inc. | |
5 | |
6 ;; Author: FSF (see below for full credits) | |
7 ;; Maintainer: Eric S. Raymond <esr@thyrsus.com> | |
8 ;; Keywords: vc tools | |
9 | |
10 ;; This file is part of GNU Emacs. | |
11 | |
12 ;; GNU Emacs is free software: you can redistribute it and/or modify | |
13 ;; it under the terms of the GNU General Public License as published by | |
14 ;; the Free Software Foundation, either version 3 of the License, or | |
15 ;; (at your option) any later version. | |
16 | |
17 ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 ;; GNU General Public License for more details. | |
21 | |
22 ;; You should have received a copy of the GNU General Public License | |
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. | |
24 | |
25 ;;; Credits: | |
26 | |
27 ;; Designed and implemented by Eric S. Raymond, originally as part of VC mode. | |
28 ;; Stefan Monnier and Dan Nicolaescu contributed substantial work on the | |
29 ;; vc-dir front end. | |
30 | |
31 ;;; Commentary: | |
32 | |
33 ;; Goals: | |
34 ;; | |
35 ;; There is a class of front-ending problems that Emacs might be used | |
36 ;; to address that involves selecting sets of files, or possibly | |
37 ;; directories, and passing the selection set to slave commands. The | |
38 ;; prototypical example, from which this code is derived, is talking | |
39 ;; to version-control systems. | |
40 ;; | |
41 ;; vc-dispatcher.el is written to decouple the UI issues in such front | |
42 ;; ends from their application-specific logic. It also provides a | |
43 ;; service layer for running the slave commands either synchronously | |
44 ;; or asynchronously and managing the message/error logs from the | |
45 ;; command runs. | |
46 ;; | |
47 ;; Similar UI problems can be expected to come up in applications | |
48 ;; areas other than VCSes; IDEs and document search are two obvious ones. | |
49 ;; This mode is intended to ensure that the Emacs interfaces for all such | |
50 ;; beasts are consistent and carefully designed. But even if nothing | |
51 ;; but VC ever uses it, getting the layer separation right will be | |
52 ;; a valuable thing. | |
53 | |
54 ;; Dispatcher's universe: | |
55 ;; | |
56 ;; The universe consists of the file tree rooted at the current | |
57 ;; directory. The dispatcher's upper layer deduces some subset | |
58 ;; of the file tree from the state of the currently visited buffer | |
59 ;; and returns that subset, presumably to a client mode. | |
60 ;; | |
61 ;; The user may be looking at either of two different views; a buffer | |
62 ;; visiting a file, or a directory buffer generated by vc-dispatcher. | |
63 ;; | |
64 ;; The lower layer of this mode runs commands in subprocesses, either | |
65 ;; synchronously or asynchronously. Commands may be launched in one | |
66 ;; of two ways: they may be run immediately, or the calling mode can | |
67 ;; create a closure associated with a text-entry buffer, to be | |
68 ;; executed when the user types C-c to ship the buffer contents. In | |
69 ;; either case the command messages and error (if any) will remain | |
70 ;; available in a status buffer. | |
71 | |
72 ;; Special behavior of dispatcher directory buffers: | |
73 ;; | |
74 ;; In dispatcher directory buffers, facilities to perform basic | |
75 ;; navigation and selection operations are provided by keymap and menu | |
76 ;; entries that dispatcher sets up itself, so they'll be uniform | |
77 ;; across all dispatcher-using client modes. Client modes are | |
78 ;; expected to append to these to provide mode-specific bindings. | |
79 ;; | |
80 ;; The standard map associates a 'state' slot (that the client mode | |
81 ;; may set) with each directory entry. The dispatcher knows nothing | |
82 ;; about the semantics of individual states, but mark and unmark commands | |
83 ;; treat all entries with the same state as the currently selected one as | |
84 ;; a unit. | |
85 | |
86 ;; The interface: | |
87 ;; | |
88 ;; The main interface to the lower level is vc-do-command. This launches a | |
89 ;; command, synchronously or asynchronously, making the output available | |
90 ;; in a command log buffer. Two other functions, (vc-start-logentry) and | |
91 ;; (vc-finish-logentry), allow you to associate a command closure with an | |
92 ;; annotation buffer so that when the user confirms the comment the closure | |
93 ;; is run (with the comment as part of its context). | |
94 ;; | |
95 ;; The interface to the upper level has the two main entry points (vc-dir) | |
96 ;; and (vc-dispatcher-selection-set) and a couple of convenience functions. | |
97 ;; (vc-dir) sets up a dispatcher browsing buffer; (vc-dispatcher-selection-set) | |
98 ;; returns a selection set of files, either the marked files in a browsing | |
99 ;; buffer or the singleton set consisting of the file visited by the current | |
100 ;; buffer (when that is appropriate). It also does what is needed to ensure | |
101 ;; that on-disk files and the contents of their visiting Emacs buffers | |
102 ;; coincide. | |
103 ;; | |
104 ;; When the client mode adds a local vc-mode-line-hook to a buffer, it | |
105 ;; will be called with the buffer file name as argument whenever the | |
106 ;; dispatcher resynchs the buffer. | |
107 | |
108 ;; To do: | |
109 ;; | |
110 ;; - log buffers need font-locking. | |
111 ;; | |
112 | |
113 ;; General customization | |
114 (defcustom vc-logentry-check-hook nil | |
115 "Normal hook run by `vc-finish-logentry'. | |
116 Use this to impose your own rules on the entry in addition to any the | |
117 dispatcher client mode imposes itself." | |
118 :type 'hook | |
119 :group 'vc) | |
120 | |
121 (defcustom vc-delete-logbuf-window t | |
122 "If non-nil, delete the log buffer and window after each logical action. | |
123 If nil, bury that buffer instead. | |
124 This is most useful if you have multiple windows on a frame and would like to | |
125 preserve the setting." | |
126 :type 'boolean | |
127 :group 'vc) | |
128 | |
129 (defcustom vc-command-messages nil | |
130 "If non-nil, display run messages from back-end commands." | |
131 :type 'boolean | |
132 :group 'vc) | |
133 | |
134 (defcustom vc-suppress-confirm nil | |
135 "If non-nil, treat user as expert; suppress yes-no prompts on some things." | |
136 :type 'boolean | |
137 :group 'vc) | |
138 | |
139 ;; Variables the user doesn't need to know about. | |
140 | |
141 (defvar vc-log-operation nil) | |
142 (defvar vc-log-after-operation-hook nil) | |
143 (defvar vc-log-fileset) | |
144 | |
145 ;; In a log entry buffer, this is a local variable | |
146 ;; that points to the buffer for which it was made | |
147 ;; (either a file, or a directory buffer). | |
148 (defvar vc-parent-buffer nil) | |
149 (put 'vc-parent-buffer 'permanent-local t) | |
150 (defvar vc-parent-buffer-name nil) | |
151 (put 'vc-parent-buffer-name 'permanent-local t) | |
152 | |
153 ;; Common command execution logic | |
154 | |
155 (defun vc-process-filter (p s) | |
156 "An alternative output filter for async process P. | |
157 One difference with the default filter is that this inserts S after markers. | |
158 Another is that undo information is not kept." | |
159 (let ((buffer (process-buffer p))) | |
160 (when (buffer-live-p buffer) | |
161 (with-current-buffer buffer | |
162 (save-excursion | |
163 (let ((buffer-undo-list t) | |
164 (inhibit-read-only t)) | |
165 (goto-char (process-mark p)) | |
166 (insert s) | |
167 (set-marker (process-mark p) (point)))))))) | |
168 | |
169 (defun vc-setup-buffer (buf) | |
170 "Prepare BUF for executing a slave command and make it current." | |
171 (let ((camefrom (current-buffer)) | |
172 (olddir default-directory)) | |
173 (set-buffer (get-buffer-create buf)) | |
174 (kill-all-local-variables) | |
175 (set (make-local-variable 'vc-parent-buffer) camefrom) | |
176 (set (make-local-variable 'vc-parent-buffer-name) | |
177 (concat " from " (buffer-name camefrom))) | |
178 (setq default-directory olddir) | |
179 (let ((buffer-undo-list t) | |
180 (inhibit-read-only t)) | |
181 (erase-buffer)))) | |
182 | |
183 (defvar vc-sentinel-movepoint) ;Dynamically scoped. | |
184 | |
185 (defun vc-process-sentinel (p s) | |
186 (let ((previous (process-get p 'vc-previous-sentinel)) | |
187 (buf (process-buffer p))) | |
188 ;; Impatient users sometime kill "slow" buffers; check liveness | |
189 ;; to avoid "error in process sentinel: Selecting deleted buffer". | |
190 (when (buffer-live-p buf) | |
191 (when previous (funcall previous p s)) | |
192 (with-current-buffer buf | |
193 (setq mode-line-process | |
194 (let ((status (process-status p))) | |
195 ;; Leave mode-line uncluttered, normally. | |
196 (unless (eq 'exit status) | |
197 (format " (%s)" status)))) | |
198 (let (vc-sentinel-movepoint) | |
199 ;; Normally, we want async code such as sentinels to not move point. | |
200 (save-excursion | |
201 (goto-char (process-mark p)) | |
202 (let ((cmds (process-get p 'vc-sentinel-commands))) | |
203 (process-put p 'vc-sentinel-commands nil) | |
204 (dolist (cmd cmds) | |
205 ;; Each sentinel may move point and the next one should be run | |
206 ;; at that new point. We could get the same result by having | |
207 ;; each sentinel read&set process-mark, but since `cmd' needs | |
208 ;; to work both for async and sync processes, this would be | |
209 ;; difficult to achieve. | |
210 (vc-exec-after cmd)))) | |
211 ;; But sometimes the sentinels really want to move point. | |
212 (when vc-sentinel-movepoint | |
213 (let ((win (get-buffer-window (current-buffer) 0))) | |
214 (if (not win) | |
215 (goto-char vc-sentinel-movepoint) | |
216 (with-selected-window win | |
217 (goto-char vc-sentinel-movepoint)))))))))) | |
218 | |
219 (defun vc-set-mode-line-busy-indicator () | |
220 (setq mode-line-process | |
221 (concat " " (propertize "[waiting...]" | |
222 'face 'mode-line-emphasis | |
223 'help-echo | |
224 "A command is in progress in this buffer")))) | |
225 | |
226 (defun vc-exec-after (code) | |
227 "Eval CODE when the current buffer's process is done. | |
228 If the current buffer has no process, just evaluate CODE. | |
229 Else, add CODE to the process' sentinel." | |
230 (let ((proc (get-buffer-process (current-buffer)))) | |
231 (cond | |
232 ;; If there's no background process, just execute the code. | |
233 ;; We used to explicitly call delete-process on exited processes, | |
234 ;; but this led to timing problems causing process output to be | |
235 ;; lost. Terminated processes get deleted automatically | |
236 ;; anyway. -- cyd | |
237 ((or (null proc) (eq (process-status proc) 'exit)) | |
238 ;; Make sure we've read the process's output before going further. | |
239 (when proc (accept-process-output proc)) | |
240 (eval code)) | |
241 ;; If a process is running, add CODE to the sentinel | |
242 ((eq (process-status proc) 'run) | |
243 (vc-set-mode-line-busy-indicator) | |
244 (let ((previous (process-sentinel proc))) | |
245 (unless (eq previous 'vc-process-sentinel) | |
246 (process-put proc 'vc-previous-sentinel previous)) | |
247 (set-process-sentinel proc 'vc-process-sentinel)) | |
248 (process-put proc 'vc-sentinel-commands | |
249 ;; We keep the code fragments in the order given | |
250 ;; so that vc-diff-finish's message shows up in | |
251 ;; the presence of non-nil vc-command-messages. | |
252 (append (process-get proc 'vc-sentinel-commands) | |
253 (list code)))) | |
254 (t (error "Unexpected process state")))) | |
255 nil) | |
256 | |
257 (defvar vc-post-command-functions nil | |
258 "Hook run at the end of `vc-do-command'. | |
259 Each function is called inside the buffer in which the command was run | |
260 and is passed 3 arguments: the COMMAND, the FILES and the FLAGS.") | |
261 | |
262 (defvar w32-quote-process-args) | |
263 | |
264 (defun vc-delistify (filelist) | |
265 "Smash a FILELIST into a file list string suitable for info messages." | |
266 ;; FIXME what about file names with spaces? | |
267 (if (not filelist) "." (mapconcat 'identity filelist " "))) | |
268 | |
269 ;;;###autoload | |
270 (defun vc-do-command (buffer okstatus command file-or-list &rest flags) | |
271 "Execute a slave command, notifying user and checking for errors. | |
272 Output from COMMAND goes to BUFFER, or the current buffer if | |
273 BUFFER is t. If the destination buffer is not already current, | |
274 set it up properly and erase it. The command is considered | |
275 successful if its exit status does not exceed OKSTATUS (if | |
276 OKSTATUS is nil, that means to ignore error status, if it is | |
277 `async', that means not to wait for termination of the | |
278 subprocess; if it is t it means to ignore all execution errors). | |
279 FILE-OR-LIST is the name of a working file; it may be a list of | |
280 files or be nil (to execute commands that don't expect a file | |
281 name or set of files). If an optional list of FLAGS is present, | |
282 that is inserted into the command line before the filename. | |
283 Return the return value of the slave command in the synchronous | |
284 case, and the process object in the asynchronous case." | |
285 ;; FIXME: file-relative-name can return a bogus result because | |
286 ;; it doesn't look at the actual file-system to see if symlinks | |
287 ;; come into play. | |
288 (let* ((files | |
289 (mapcar (lambda (f) (file-relative-name (expand-file-name f))) | |
290 (if (listp file-or-list) file-or-list (list file-or-list)))) | |
291 (full-command | |
292 ;; What we're doing here is preparing a version of the command | |
293 ;; for display in a debug-progress message. If it's fewer than | |
294 ;; 20 characters display the entire command (without trailing | |
295 ;; newline). Otherwise display the first 20 followed by an ellipsis. | |
296 (concat (if (string= (substring command -1) "\n") | |
297 (substring command 0 -1) | |
298 command) | |
299 " " | |
300 (vc-delistify (mapcar (lambda (s) (if (> (length s) 20) (concat (substring s 0 2) "...") s)) flags)) | |
301 " " (vc-delistify files)))) | |
302 (save-current-buffer | |
303 (unless (or (eq buffer t) | |
304 (and (stringp buffer) | |
305 (string= (buffer-name) buffer)) | |
306 (eq buffer (current-buffer))) | |
307 (vc-setup-buffer buffer)) | |
308 ;; If there's some previous async process still running, just kill it. | |
309 (let ((oldproc (get-buffer-process (current-buffer)))) | |
310 ;; If we wanted to wait for oldproc to finish before doing | |
311 ;; something, we'd have used vc-eval-after. | |
312 ;; Use `delete-process' rather than `kill-process' because we don't | |
313 ;; want any of its output to appear from now on. | |
314 (when oldproc (delete-process oldproc))) | |
315 (let ((squeezed (remq nil flags)) | |
316 (inhibit-read-only t) | |
317 (status 0)) | |
318 (when files | |
319 (setq squeezed (nconc squeezed files))) | |
320 (let (;; Since some functions need to parse the output | |
321 ;; from external commands, set LC_MESSAGES to C. | |
322 (process-environment (cons "LC_MESSAGES=C" process-environment)) | |
323 (w32-quote-process-args t)) | |
324 (if (eq okstatus 'async) | |
325 ;; Run asynchronously. | |
326 (let ((proc | |
327 (let ((process-connection-type nil)) | |
328 (apply 'start-file-process command (current-buffer) | |
329 command squeezed)))) | |
330 (when vc-command-messages | |
331 (message "Running %s in background..." full-command)) | |
332 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p))) | |
333 (set-process-filter proc 'vc-process-filter) | |
334 (setq status proc) | |
335 (when vc-command-messages | |
336 (vc-exec-after | |
337 `(message "Running %s in background... done" ',full-command)))) | |
338 ;; Run synchronously | |
339 (when vc-command-messages | |
340 (message "Running %s in foreground..." full-command)) | |
341 (let ((buffer-undo-list t)) | |
342 (setq status (apply 'process-file command nil t nil squeezed))) | |
343 (when (and (not (eq t okstatus)) | |
344 (or (not (integerp status)) | |
345 (and okstatus (< okstatus status)))) | |
346 (unless (eq ?\s (aref (buffer-name (current-buffer)) 0)) | |
347 (pop-to-buffer (current-buffer)) | |
348 (goto-char (point-min)) | |
349 (shrink-window-if-larger-than-buffer)) | |
350 (error "Running %s...FAILED (%s)" full-command | |
351 (if (integerp status) (format "status %d" status) status))) | |
352 (when vc-command-messages | |
353 (message "Running %s...OK = %d" full-command status)))) | |
354 (vc-exec-after | |
355 `(run-hook-with-args 'vc-post-command-functions | |
356 ',command ',file-or-list ',flags)) | |
357 status)))) | |
358 | |
359 ;; These functions are used to ensure that the view the user sees is up to date | |
360 ;; even if the dispatcher client mode has messed with file contents (as in, | |
361 ;; for example, VCS keyword expansion). | |
362 | |
363 (declare-function view-mode-exit "view" (&optional return-to-alist exit-action all-win)) | |
364 | |
365 (defun vc-position-context (posn) | |
366 "Save a bit of the text around POSN in the current buffer. | |
367 Used to help us find the corresponding position again later | |
368 if markers are destroyed or corrupted." | |
369 ;; A lot of this was shamelessly lifted from Sebastian Kremer's | |
370 ;; rcs.el mode. | |
371 (list posn | |
372 (buffer-size) | |
373 (buffer-substring posn | |
374 (min (point-max) (+ posn 100))))) | |
375 | |
376 (defun vc-find-position-by-context (context) | |
377 "Return the position of CONTEXT in the current buffer. | |
378 If CONTEXT cannot be found, return nil." | |
379 (let ((context-string (nth 2 context))) | |
380 (if (equal "" context-string) | |
381 (point-max) | |
382 (save-excursion | |
383 (let ((diff (- (nth 1 context) (buffer-size)))) | |
384 (when (< diff 0) (setq diff (- diff))) | |
385 (goto-char (nth 0 context)) | |
386 (if (or (search-forward context-string nil t) | |
387 ;; Can't use search-backward since the match may continue | |
388 ;; after point. | |
389 (progn (goto-char (- (point) diff (length context-string))) | |
390 ;; goto-char doesn't signal an error at | |
391 ;; beginning of buffer like backward-char would | |
392 (search-forward context-string nil t))) | |
393 ;; to beginning of OSTRING | |
394 (- (point) (length context-string)))))))) | |
395 | |
396 (defun vc-context-matches-p (posn context) | |
397 "Return t if POSN matches CONTEXT, nil otherwise." | |
398 (let* ((context-string (nth 2 context)) | |
399 (len (length context-string)) | |
400 (end (+ posn len))) | |
401 (if (> end (1+ (buffer-size))) | |
402 nil | |
403 (string= context-string (buffer-substring posn end))))) | |
404 | |
405 (defun vc-buffer-context () | |
406 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE). | |
407 Used by `vc-restore-buffer-context' to later restore the context." | |
408 (let ((point-context (vc-position-context (point))) | |
409 ;; Use mark-marker to avoid confusion in transient-mark-mode. | |
410 (mark-context (when (eq (marker-buffer (mark-marker)) (current-buffer)) | |
411 (vc-position-context (mark-marker)))) | |
412 ;; Make the right thing happen in transient-mark-mode. | |
413 (mark-active nil)) | |
414 (list point-context mark-context nil))) | |
415 | |
416 (defun vc-restore-buffer-context (context) | |
417 "Restore point/mark, and reparse any affected compilation buffers. | |
418 CONTEXT is that which `vc-buffer-context' returns." | |
419 (let ((point-context (nth 0 context)) | |
420 (mark-context (nth 1 context))) | |
421 ;; if necessary, restore point and mark | |
422 (if (not (vc-context-matches-p (point) point-context)) | |
423 (let ((new-point (vc-find-position-by-context point-context))) | |
424 (when new-point (goto-char new-point)))) | |
425 (and mark-active | |
426 mark-context | |
427 (not (vc-context-matches-p (mark) mark-context)) | |
428 (let ((new-mark (vc-find-position-by-context mark-context))) | |
429 (when new-mark (set-mark new-mark)))))) | |
430 | |
431 (defun vc-revert-buffer-internal (&optional arg no-confirm) | |
432 "Revert buffer, keeping point and mark where user expects them. | |
433 Try to be clever in the face of changes due to expanded version-control | |
434 key words. This is important for typeahead to work as expected. | |
435 ARG and NO-CONFIRM are passed on to `revert-buffer'." | |
436 (interactive "P") | |
437 (widen) | |
438 (let ((context (vc-buffer-context))) | |
439 ;; Use save-excursion here, because it may be able to restore point | |
440 ;; and mark properly even in cases where vc-restore-buffer-context | |
441 ;; would fail. However, save-excursion might also get it wrong -- | |
442 ;; in this case, vc-restore-buffer-context gives it a second try. | |
443 (save-excursion | |
444 ;; t means don't call normal-mode; | |
445 ;; that's to preserve various minor modes. | |
446 (revert-buffer arg no-confirm t)) | |
447 (vc-restore-buffer-context context))) | |
448 | |
449 (defvar vc-mode-line-hook nil) | |
450 (make-variable-buffer-local 'vc-mode-line-hook) | |
451 (put 'vc-mode-line-hook 'permanent-local t) | |
452 | |
453 (defun vc-resynch-window (file &optional keep noquery reset-vc-info) | |
454 "If FILE is in the current buffer, either revert or unvisit it. | |
455 The choice between revert (to see expanded keywords) and unvisit | |
456 depends on KEEP. NOQUERY if non-nil inhibits confirmation for | |
457 reverting. NOQUERY should be t *only* if it is known the only | |
458 difference between the buffer and the file is due to | |
459 modifications by the dispatcher client code, rather than user | |
460 editing!" | |
461 (and (string= buffer-file-name file) | |
462 (if keep | |
463 (when (file-exists-p file) | |
464 (when reset-vc-info | |
465 (vc-file-clearprops file)) | |
466 (vc-revert-buffer-internal t noquery) | |
467 | |
468 ;; VC operations might toggle the read-only state. In | |
469 ;; that case we need to adjust the `view-mode' status | |
470 ;; when `view-read-only' is non-nil. | |
471 (and view-read-only | |
472 (if (file-writable-p file) | |
473 (and view-mode | |
474 (let ((view-old-buffer-read-only nil)) | |
475 (view-mode-exit))) | |
476 (and (not view-mode) | |
477 (not (eq (get major-mode 'mode-class) 'special)) | |
478 (view-mode-enter)))) | |
479 | |
480 ;; FIXME: Why use a hook? Why pass it buffer-file-name? | |
481 (run-hook-with-args 'vc-mode-line-hook buffer-file-name)) | |
482 (kill-buffer (current-buffer))))) | |
483 | |
484 (declare-function vc-dir-resynch-file "vc-dir" (&optional fname)) | |
485 (declare-function vc-string-prefix-p "vc" (prefix string)) | |
486 | |
487 (defun vc-resynch-buffers-in-directory (directory &optional keep noquery reset-vc-info) | |
488 "Resync all buffers that visit files in DIRECTORY." | |
489 (dolist (buffer (buffer-list)) | |
490 (let ((fname (buffer-file-name buffer))) | |
491 (when (and fname (vc-string-prefix-p directory fname)) | |
492 (with-current-buffer buffer | |
493 (vc-resynch-buffer fname keep noquery reset-vc-info)))))) | |
494 | |
495 (defun vc-resynch-buffer (file &optional keep noquery reset-vc-info) | |
496 "If FILE is currently visited, resynch its buffer." | |
497 (if (string= buffer-file-name file) | |
498 (vc-resynch-window file keep noquery reset-vc-info) | |
499 (if (file-directory-p file) | |
500 (vc-resynch-buffers-in-directory file keep noquery reset-vc-info) | |
501 (let ((buffer (get-file-buffer file))) | |
502 (when buffer | |
503 (with-current-buffer buffer | |
504 (vc-resynch-window file keep noquery reset-vc-info)))))) | |
505 ;; Try to avoid unnecessary work, a *vc-dir* buffer is only present | |
506 ;; if this is true. | |
507 (when vc-dir-buffers | |
508 (vc-dir-resynch-file file))) | |
509 | |
510 (defun vc-buffer-sync (&optional not-urgent) | |
511 "Make sure the current buffer and its working file are in sync. | |
512 NOT-URGENT means it is ok to continue if the user says not to save." | |
513 (when (buffer-modified-p) | |
514 (if (or vc-suppress-confirm | |
515 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name)))) | |
516 (save-buffer) | |
517 (unless not-urgent | |
518 (error "Aborted"))))) | |
519 | |
520 ;; Command closures | |
521 | |
522 ;; Set up key bindings for use while editing log messages | |
523 | |
524 (defun vc-log-edit (fileset mode) | |
525 "Set up `log-edit' for use on FILE." | |
526 (setq default-directory | |
527 (with-current-buffer vc-parent-buffer default-directory)) | |
528 (log-edit 'vc-finish-logentry | |
529 nil | |
530 `((log-edit-listfun . (lambda () | |
531 ;; FIXME: Should expand the list | |
532 ;; for directories. | |
533 (mapcar 'file-relative-name | |
534 ',fileset))) | |
535 (log-edit-diff-function . (lambda () (vc-diff nil)))) | |
536 nil | |
537 mode) | |
538 (set (make-local-variable 'vc-log-fileset) fileset) | |
539 (set-buffer-modified-p nil) | |
540 (setq buffer-file-name nil)) | |
541 | |
542 (defun vc-start-logentry (files comment initial-contents msg logbuf mode action &optional after-hook) | |
543 "Accept a comment for an operation on FILES. | |
544 If COMMENT is nil, pop up a LOGBUF buffer, emit MSG, and set the | |
545 action on close to ACTION. If COMMENT is a string and | |
546 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial | |
547 contents of the log entry buffer. If COMMENT is a string and | |
548 INITIAL-CONTENTS is nil, do action immediately as if the user had | |
549 entered COMMENT. If COMMENT is t, also do action immediately with an | |
550 empty comment. Remember the file's buffer in `vc-parent-buffer' | |
551 \(current one if no file). Puts the log-entry buffer in major-mode | |
552 MODE, defaulting to `log-edit-mode' if MODE is nil. | |
553 AFTER-HOOK specifies the local value for `vc-log-after-operation-hook'." | |
554 (let ((parent | |
555 (if (vc-dispatcher-browsing) | |
556 ;; If we are called from a directory browser, the parent buffer is | |
557 ;; the current buffer. | |
558 (current-buffer) | |
559 (if (and files (equal (length files) 1)) | |
560 (get-file-buffer (car files)) | |
561 (current-buffer))))) | |
562 (if (and comment (not initial-contents)) | |
563 (set-buffer (get-buffer-create logbuf)) | |
564 (pop-to-buffer (get-buffer-create logbuf))) | |
565 (set (make-local-variable 'vc-parent-buffer) parent) | |
566 (set (make-local-variable 'vc-parent-buffer-name) | |
567 (concat " from " (buffer-name vc-parent-buffer))) | |
568 (vc-log-edit files mode) | |
569 (make-local-variable 'vc-log-after-operation-hook) | |
570 (when after-hook | |
571 (setq vc-log-after-operation-hook after-hook)) | |
572 (setq vc-log-operation action) | |
573 (when comment | |
574 (erase-buffer) | |
575 (when (stringp comment) (insert comment))) | |
576 (if (or (not comment) initial-contents) | |
577 (message "%s Type C-c C-c when done" msg) | |
578 (vc-finish-logentry (eq comment t))))) | |
579 | |
580 (declare-function vc-dir-move-to-goal-column "vc-dir" ()) | |
581 ;; vc-finish-logentry is typically called from a log-edit buffer (see | |
582 ;; vc-start-logentry). | |
583 (defun vc-finish-logentry (&optional nocomment) | |
584 "Complete the operation implied by the current log entry. | |
585 Use the contents of the current buffer as a check-in or registration | |
586 comment. If the optional arg NOCOMMENT is non-nil, then don't check | |
587 the buffer contents as a comment." | |
588 (interactive) | |
589 ;; Check and record the comment, if any. | |
590 (unless nocomment | |
591 (run-hooks 'vc-logentry-check-hook)) | |
592 ;; Sync parent buffer in case the user modified it while editing the comment. | |
593 ;; But not if it is a vc-dir buffer. | |
594 (with-current-buffer vc-parent-buffer | |
595 (or (vc-dispatcher-browsing) (vc-buffer-sync))) | |
596 (unless vc-log-operation | |
597 (error "No log operation is pending")) | |
598 | |
599 ;; save the parameters held in buffer-local variables | |
600 (let ((logbuf (current-buffer)) | |
601 (log-operation vc-log-operation) | |
602 ;; FIXME: When coming from VC-Dir, we should check that the | |
603 ;; set of selected files is still equal to vc-log-fileset, | |
604 ;; to avoid surprises. | |
605 (log-fileset vc-log-fileset) | |
606 (log-entry (buffer-string)) | |
607 (after-hook vc-log-after-operation-hook)) | |
608 (pop-to-buffer vc-parent-buffer) | |
609 ;; OK, do it to it | |
610 (save-excursion | |
611 (funcall log-operation | |
612 log-fileset | |
613 log-entry)) | |
614 ;; Remove checkin window (after the checkin so that if that fails | |
615 ;; we don't zap the log buffer and the typing therein). | |
616 ;; -- IMO this should be replaced with quit-window | |
617 (cond ((and logbuf vc-delete-logbuf-window) | |
618 (delete-windows-on logbuf (selected-frame)) | |
619 ;; Kill buffer and delete any other dedicated windows/frames. | |
620 (kill-buffer logbuf)) | |
621 (logbuf | |
622 (with-selected-window (or (get-buffer-window logbuf 0) | |
623 (selected-window)) | |
624 (with-current-buffer logbuf | |
625 (bury-buffer))))) | |
626 ;; Now make sure we see the expanded headers | |
627 (when log-fileset | |
628 (mapc | |
629 (lambda (file) (vc-resynch-buffer file vc-keep-workfiles t)) | |
630 log-fileset)) | |
631 (when (vc-dispatcher-browsing) | |
632 (vc-dir-move-to-goal-column)) | |
633 (run-hooks after-hook 'vc-finish-logentry-hook))) | |
634 | |
635 (defun vc-dispatcher-browsing () | |
636 "Are we in a directory browser buffer?" | |
637 (derived-mode-p 'vc-dir-mode)) | |
638 | |
639 ;; These are unused. | |
640 ;; (defun vc-dispatcher-in-fileset-p (fileset) | |
641 ;; (let ((member nil)) | |
642 ;; (while (and (not member) fileset) | |
643 ;; (let ((elem (pop fileset))) | |
644 ;; (if (if (file-directory-p elem) | |
645 ;; (eq t (compare-strings buffer-file-name nil (length elem) | |
646 ;; elem nil nil)) | |
647 ;; (eq (current-buffer) (get-file-buffer elem))) | |
648 ;; (setq member t)))) | |
649 ;; member)) | |
650 | |
651 ;; (defun vc-dispatcher-selection-set (&optional observer) | |
652 ;; "Deduce a set of files to which to apply an operation. Return a cons | |
653 ;; cell (SELECTION . FILESET), where SELECTION is what the user chose | |
654 ;; and FILES is the flist with any directories replaced by the listed files | |
655 ;; within them. | |
656 | |
657 ;; If we're in a directory display, the fileset is the list of marked files (if | |
658 ;; there is one) else the file on the current line. If not in a directory | |
659 ;; display, but the current buffer visits a file, the fileset is a singleton | |
660 ;; containing that file. Otherwise, throw an error." | |
661 ;; (let ((selection | |
662 ;; (cond | |
663 ;; ;; Browsing with vc-dir | |
664 ;; ((vc-dispatcher-browsing) | |
665 ;; ;; If no files are marked, temporarily mark current file | |
666 ;; ;; and choose on that basis (so we get subordinate files) | |
667 ;; (if (not (vc-dir-marked-files)) | |
668 ;; (prog2 | |
669 ;; (vc-dir-mark-file) | |
670 ;; (cons (vc-dir-marked-files) (vc-dir-marked-only-files)) | |
671 ;; (vc-dir-unmark-all-files t)) | |
672 ;; (cons (vc-dir-marked-files) (vc-dir-marked-only-files)))) | |
673 ;; ;; Visiting an eligible file | |
674 ;; ((buffer-file-name) | |
675 ;; (cons (list buffer-file-name) (list buffer-file-name))) | |
676 ;; ;; No eligible file -- if there's a parent buffer, deduce from there | |
677 ;; ((and vc-parent-buffer (or (buffer-file-name vc-parent-buffer) | |
678 ;; (with-current-buffer vc-parent-buffer | |
679 ;; (vc-dispatcher-browsing)))) | |
680 ;; (with-current-buffer vc-parent-buffer | |
681 ;; (vc-dispatcher-selection-set))) | |
682 ;; ;; No good set here, throw error | |
683 ;; (t (error "No fileset is available here"))))) | |
684 ;; ;; We assume, in order to avoid unpleasant surprises to the user, | |
685 ;; ;; that a fileset is not in good shape to be handed to the user if the | |
686 ;; ;; buffers visiting the fileset don't match the on-disk contents. | |
687 ;; (unless observer | |
688 ;; (save-some-buffers | |
689 ;; nil (lambda () (vc-dispatcher-in-fileset-p (cdr selection))))) | |
690 ;; selection)) | |
691 | |
692 (provide 'vc-dispatcher) | |
693 | |
694 ;; arch-tag: 7d08b17f-5470-4799-914b-bfb9fcf6a246 | |
695 ;;; vc-dispatcher.el ends here |