| 1 | ;;; vc.el --- drive a version-control system from within Emacs |
| 2 | |
| 3 | ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, |
| 4 | ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
| 5 | ;; Free Software Foundation, Inc. |
| 6 | |
| 7 | ;; Author: FSF (see below for full credits) |
| 8 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> |
| 9 | ;; Keywords: tools |
| 10 | |
| 11 | ;; This file is part of GNU Emacs. |
| 12 | |
| 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
| 14 | ;; it under the terms of the GNU General Public License as published by |
| 15 | ;; the Free Software Foundation, either version 3 of the License, or |
| 16 | ;; (at your option) any later version. |
| 17 | |
| 18 | ;; GNU Emacs is distributed in the hope that it will be useful, |
| 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 21 | ;; GNU General Public License for more details. |
| 22 | |
| 23 | ;; You should have received a copy of the GNU General Public License |
| 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
| 25 | |
| 26 | ;;; Credits: |
| 27 | |
| 28 | ;; VC was initially designed and implemented by Eric S. Raymond |
| 29 | ;; <esr@thyrsus.com> in 1992. Over the years, many other people have |
| 30 | ;; contributed substantial amounts of work to VC. These include: |
| 31 | ;; |
| 32 | ;; Per Cederqvist <ceder@lysator.liu.se> |
| 33 | ;; Paul Eggert <eggert@twinsun.com> |
| 34 | ;; Sebastian Kremer <sk@thp.uni-koeln.de> |
| 35 | ;; Martin Lorentzson <martinl@gnu.org> |
| 36 | ;; Dave Love <fx@gnu.org> |
| 37 | ;; Stefan Monnier <monnier@cs.yale.edu> |
| 38 | ;; Thien-Thi Nguyen <ttn@gnu.org> |
| 39 | ;; Dan Nicolaescu <dann@ics.uci.edu> |
| 40 | ;; J.D. Smith <jdsmith@alum.mit.edu> |
| 41 | ;; Andre Spiegel <spiegel@gnu.org> |
| 42 | ;; Richard Stallman <rms@gnu.org> |
| 43 | ;; |
| 44 | ;; In July 2007 ESR returned and redesigned the mode to cope better |
| 45 | ;; with modern version-control systems that do commits by fileset |
| 46 | ;; rather than per individual file. |
| 47 | ;; |
| 48 | ;; If you maintain a client of the mode or customize it in your .emacs, |
| 49 | ;; note that some backend functions which formerly took single file arguments |
| 50 | ;; now take a list of files. These include: register, checkin, print-log, |
| 51 | ;; rollback, and diff. |
| 52 | |
| 53 | ;;; Commentary: |
| 54 | |
| 55 | ;; This mode is fully documented in the Emacs user's manual. |
| 56 | ;; |
| 57 | ;; Supported version-control systems presently include CVS, RCS, GNU |
| 58 | ;; Arch, Subversion, Bzr, Git, Mercurial, Monotone and SCCS |
| 59 | ;; (or its free replacement, CSSC). |
| 60 | ;; |
| 61 | ;; Some features will not work with old RCS versions. Where |
| 62 | ;; appropriate, VC finds out which version you have, and allows or |
| 63 | ;; disallows those features (stealing locks, for example, works only |
| 64 | ;; from 5.6.2 onwards). |
| 65 | ;; Even initial checkins will fail if your RCS version is so old that ci |
| 66 | ;; doesn't understand -t-; this has been known to happen to people running |
| 67 | ;; NExTSTEP 3.0. |
| 68 | ;; |
| 69 | ;; You can support the RCS -x option by customizing vc-rcs-master-templates. |
| 70 | ;; |
| 71 | ;; Proper function of the SCCS diff commands requires the shellscript vcdiff |
| 72 | ;; to be installed somewhere on Emacs's path for executables. |
| 73 | ;; |
| 74 | ;; If your site uses the ChangeLog convention supported by Emacs, the |
| 75 | ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook, |
| 76 | ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog') |
| 77 | ;; from the commit buffer instead or to set `log-edit-setup-invert'. |
| 78 | ;; |
| 79 | ;; The vc code maintains some internal state in order to reduce expensive |
| 80 | ;; version-control operations to a minimum. Some names are only computed |
| 81 | ;; once. If you perform version control operations with the backend while |
| 82 | ;; vc's back is turned, or move/rename master files while vc is running, |
| 83 | ;; vc may get seriously confused. Don't do these things! |
| 84 | ;; |
| 85 | ;; ADDING SUPPORT FOR OTHER BACKENDS |
| 86 | ;; |
| 87 | ;; VC can use arbitrary version control systems as a backend. To add |
| 88 | ;; support for a new backend named SYS, write a library vc-sys.el that |
| 89 | ;; contains functions of the form `vc-sys-...' (note that SYS is in lower |
| 90 | ;; case for the function and library names). VC will use that library if |
| 91 | ;; you put the symbol SYS somewhere into the list of |
| 92 | ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered' |
| 93 | ;; returns non-nil for a file, all SYS-specific versions of VC commands |
| 94 | ;; will be available for that file. |
| 95 | ;; |
| 96 | ;; VC keeps some per-file information in the form of properties (see |
| 97 | ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions |
| 98 | ;; do not generally need to be aware of these properties. For example, |
| 99 | ;; `vc-sys-working-revision' should compute the working revision and |
| 100 | ;; return it; it should not look it up in the property, and it needn't |
| 101 | ;; store it there either. However, if a backend-specific function does |
| 102 | ;; store a value in a property, that value takes precedence over any |
| 103 | ;; value that the generic code might want to set (check for uses of |
| 104 | ;; the macro `with-vc-properties' in vc.el). |
| 105 | ;; |
| 106 | ;; In the list of functions below, each identifier needs to be prepended |
| 107 | ;; with `vc-sys-'. Some of the functions are mandatory (marked with a |
| 108 | ;; `*'), others are optional (`-'). |
| 109 | ;; |
| 110 | ;; BACKEND PROPERTIES |
| 111 | ;; |
| 112 | ;; * revision-granularity |
| 113 | ;; |
| 114 | ;; Takes no arguments. Returns either 'file or 'repository. Backends |
| 115 | ;; that return 'file have per-file revision numbering; backends |
| 116 | ;; that return 'repository have per-repository revision numbering, |
| 117 | ;; so a revision level implicitly identifies a changeset |
| 118 | ;; |
| 119 | ;; STATE-QUERYING FUNCTIONS |
| 120 | ;; |
| 121 | ;; * registered (file) |
| 122 | ;; |
| 123 | ;; Return non-nil if FILE is registered in this backend. Both this |
| 124 | ;; function as well as `state' should be careful to fail gracefully |
| 125 | ;; in the event that the backend executable is absent. It is |
| 126 | ;; preferable that this function's body is autoloaded, that way only |
| 127 | ;; calling vc-registered does not cause the backend to be loaded |
| 128 | ;; (all the vc-FOO-registered functions are called to try to find |
| 129 | ;; the controlling backend for FILE. |
| 130 | ;; |
| 131 | ;; * state (file) |
| 132 | ;; |
| 133 | ;; Return the current version control state of FILE. For a list of |
| 134 | ;; possible values, see `vc-state'. This function should do a full and |
| 135 | ;; reliable state computation; it is usually called immediately after |
| 136 | ;; C-x v v. If you want to use a faster heuristic when visiting a |
| 137 | ;; file, put that into `state-heuristic' below. Note that under most |
| 138 | ;; VCSes this won't be called at all, dir-status is used instead. |
| 139 | ;; |
| 140 | ;; - state-heuristic (file) |
| 141 | ;; |
| 142 | ;; If provided, this function is used to estimate the version control |
| 143 | ;; state of FILE at visiting time. It should be considerably faster |
| 144 | ;; than the implementation of `state'. For a list of possible values, |
| 145 | ;; see the doc string of `vc-state'. |
| 146 | ;; |
| 147 | ;; - dir-status (dir update-function) |
| 148 | ;; |
| 149 | ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA) |
| 150 | ;; for the files in DIR. |
| 151 | ;; EXTRA can be used for backend specific information about FILE. |
| 152 | ;; If a command needs to be run to compute this list, it should be |
| 153 | ;; run asynchronously using (current-buffer) as the buffer for the |
| 154 | ;; command. When RESULT is computed, it should be passed back by |
| 155 | ;; doing: (funcall UPDATE-FUNCTION RESULT nil). |
| 156 | ;; If the backend uses a process filter, hence it produces partial results, |
| 157 | ;; they can be passed back by doing: |
| 158 | ;; (funcall UPDATE-FUNCTION RESULT t) |
| 159 | ;; and then do a (funcall UPDATE-FUNCTION RESULT nil) |
| 160 | ;; when all the results have been computed. |
| 161 | ;; To provide more backend specific functionality for `vc-dir' |
| 162 | ;; the following functions might be needed: `status-extra-headers', |
| 163 | ;; `status-printer', `extra-status-menu' and `dir-status-files'. |
| 164 | ;; |
| 165 | ;; - dir-status-files (dir files default-state update-function) |
| 166 | ;; |
| 167 | ;; This function is identical to dir-status except that it should |
| 168 | ;; only report status for the specified FILES. Also it needs to |
| 169 | ;; report on all requested files, including up-to-date or ignored |
| 170 | ;; files. If not provided, the default is to consider that the files |
| 171 | ;; are in DEFAULT-STATE. |
| 172 | ;; |
| 173 | ;; - status-extra-headers (dir) |
| 174 | ;; |
| 175 | ;; Return a string that will be added to the *vc-dir* buffer header. |
| 176 | ;; |
| 177 | ;; - status-printer (fileinfo) |
| 178 | ;; |
| 179 | ;; Pretty print the `vc-dir-fileinfo' FILEINFO. |
| 180 | ;; If a backend needs to show more information than the default FILE |
| 181 | ;; and STATE in the vc-dir listing, it can store that extra |
| 182 | ;; information in `vc-dir-fileinfo->extra'. This function can be |
| 183 | ;; used to display that extra information in the *vc-dir* buffer. |
| 184 | ;; |
| 185 | ;; - status-fileinfo-extra (file) |
| 186 | ;; |
| 187 | ;; Compute `vc-dir-fileinfo->extra' for FILE. |
| 188 | ;; |
| 189 | ;; * working-revision (file) |
| 190 | ;; |
| 191 | ;; Return the working revision of FILE. This is the revision fetched |
| 192 | ;; by the last checkout or upate, not necessarily the same thing as the |
| 193 | ;; head or tip revision. Should return "0" for a file added but not yet |
| 194 | ;; committed. |
| 195 | ;; |
| 196 | ;; - latest-on-branch-p (file) |
| 197 | ;; |
| 198 | ;; Return non-nil if the working revision of FILE is the latest revision |
| 199 | ;; on its branch (many VCSes call this the 'tip' or 'head' revision). |
| 200 | ;; The default implementation always returns t, which means that |
| 201 | ;; working with non-current revisions is not supported by default. |
| 202 | ;; |
| 203 | ;; * checkout-model (files) |
| 204 | ;; |
| 205 | ;; Indicate whether FILES need to be "checked out" before they can be |
| 206 | ;; edited. See `vc-checkout-model' for a list of possible values. |
| 207 | ;; |
| 208 | ;; - workfile-unchanged-p (file) |
| 209 | ;; |
| 210 | ;; Return non-nil if FILE is unchanged from the working revision. |
| 211 | ;; This function should do a brief comparison of FILE's contents |
| 212 | ;; with those of the repository master of the working revision. If |
| 213 | ;; the backend does not have such a brief-comparison feature, the |
| 214 | ;; default implementation of this function can be used, which |
| 215 | ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff |
| 216 | ;; must not run asynchronously in this case, see variable |
| 217 | ;; `vc-disable-async-diff'.) |
| 218 | ;; |
| 219 | ;; - mode-line-string (file) |
| 220 | ;; |
| 221 | ;; If provided, this function should return the VC-specific mode |
| 222 | ;; line string for FILE. The returned string should have a |
| 223 | ;; `help-echo' property which is the text to be displayed as a |
| 224 | ;; tooltip when the mouse hovers over the VC entry on the mode-line. |
| 225 | ;; The default implementation deals well with all states that |
| 226 | ;; `vc-state' can return. |
| 227 | ;; |
| 228 | ;; - prettify-state-info (file) |
| 229 | ;; |
| 230 | ;; Translate the `vc-state' property of FILE into a string that can be |
| 231 | ;; used in a human-readable buffer. The default implementation deals well |
| 232 | ;; with all states that `vc-state' can return. |
| 233 | ;; |
| 234 | ;; STATE-CHANGING FUNCTIONS |
| 235 | ;; |
| 236 | ;; * create-repo (backend) |
| 237 | ;; |
| 238 | ;; Create an empty repository in the current directory and initialize |
| 239 | ;; it so VC mode can add files to it. For file-oriented systems, this |
| 240 | ;; need do no more than create a subdirectory with the right name. |
| 241 | ;; |
| 242 | ;; * register (files &optional rev comment) |
| 243 | ;; |
| 244 | ;; Register FILES in this backend. Optionally, an initial revision REV |
| 245 | ;; and an initial description of the file, COMMENT, may be specified, |
| 246 | ;; but it is not guaranteed that the backend will do anything with this. |
| 247 | ;; The implementation should pass the value of vc-register-switches |
| 248 | ;; to the backend command. (Note: in older versions of VC, this |
| 249 | ;; command took a single file argument and not a list.) |
| 250 | ;; |
| 251 | ;; - init-revision (file) |
| 252 | ;; |
| 253 | ;; The initial revision to use when registering FILE if one is not |
| 254 | ;; specified by the user. If not provided, the variable |
| 255 | ;; vc-default-init-revision is used instead. |
| 256 | ;; |
| 257 | ;; - responsible-p (file) |
| 258 | ;; |
| 259 | ;; Return non-nil if this backend considers itself "responsible" for |
| 260 | ;; FILE, which can also be a directory. This function is used to find |
| 261 | ;; out what backend to use for registration of new files and for things |
| 262 | ;; like change log generation. The default implementation always |
| 263 | ;; returns nil. |
| 264 | ;; |
| 265 | ;; - could-register (file) |
| 266 | ;; |
| 267 | ;; Return non-nil if FILE could be registered under this backend. The |
| 268 | ;; default implementation always returns t. |
| 269 | ;; |
| 270 | ;; - receive-file (file rev) |
| 271 | ;; |
| 272 | ;; Let this backend "receive" a file that is already registered under |
| 273 | ;; another backend. The default implementation simply calls `register' |
| 274 | ;; for FILE, but it can be overridden to do something more specific, |
| 275 | ;; e.g. keep revision numbers consistent or choose editing modes for |
| 276 | ;; FILE that resemble those of the other backend. |
| 277 | ;; |
| 278 | ;; - unregister (file) |
| 279 | ;; |
| 280 | ;; Unregister FILE from this backend. This is only needed if this |
| 281 | ;; backend may be used as a "more local" backend for temporary editing. |
| 282 | ;; |
| 283 | ;; * checkin (files rev comment) |
| 284 | ;; |
| 285 | ;; Commit changes in FILES to this backend. If REV is non-nil, that |
| 286 | ;; should become the new revision number (not all backends do |
| 287 | ;; anything with it). COMMENT is used as a check-in comment. The |
| 288 | ;; implementation should pass the value of vc-checkin-switches to |
| 289 | ;; the backend command. (Note: in older versions of VC, this |
| 290 | ;; command took a single file argument and not a list.) |
| 291 | ;; |
| 292 | ;; * find-revision (file rev buffer) |
| 293 | ;; |
| 294 | ;; Fetch revision REV of file FILE and put it into BUFFER. |
| 295 | ;; If REV is the empty string, fetch the head of the trunk. |
| 296 | ;; The implementation should pass the value of vc-checkout-switches |
| 297 | ;; to the backend command. |
| 298 | ;; |
| 299 | ;; * checkout (file &optional editable rev) |
| 300 | ;; |
| 301 | ;; Check out revision REV of FILE into the working area. If EDITABLE |
| 302 | ;; is non-nil, FILE should be writable by the user and if locking is |
| 303 | ;; used for FILE, a lock should also be set. If REV is non-nil, that |
| 304 | ;; is the revision to check out (default is the working revision). |
| 305 | ;; If REV is t, that means to check out the head of the current branch; |
| 306 | ;; if it is the empty string, check out the head of the trunk. |
| 307 | ;; The implementation should pass the value of vc-checkout-switches |
| 308 | ;; to the backend command. |
| 309 | ;; |
| 310 | ;; * revert (file &optional contents-done) |
| 311 | ;; |
| 312 | ;; Revert FILE back to the working revision. If optional |
| 313 | ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have |
| 314 | ;; already been reverted from a version backup, and this function |
| 315 | ;; only needs to update the status of FILE within the backend. |
| 316 | ;; |
| 317 | ;; - rollback (files) |
| 318 | ;; |
| 319 | ;; Remove the tip revision of each of FILES from the repository. If |
| 320 | ;; this function is not provided, trying to cancel a revision is |
| 321 | ;; caught as an error. (Most backends don't provide it.) (Also |
| 322 | ;; note that older versions of this backend command were called |
| 323 | ;; 'cancel-version' and took a single file arg, not a list of |
| 324 | ;; files.) |
| 325 | ;; |
| 326 | ;; - merge (file rev1 rev2) |
| 327 | ;; |
| 328 | ;; Merge the changes between REV1 and REV2 into the current working file. |
| 329 | ;; |
| 330 | ;; - merge-news (file) |
| 331 | ;; |
| 332 | ;; Merge recent changes from the current branch into FILE. |
| 333 | ;; |
| 334 | ;; - steal-lock (file &optional revision) |
| 335 | ;; |
| 336 | ;; Steal any lock on the working revision of FILE, or on REVISION if |
| 337 | ;; that is provided. This function is only needed if locking is |
| 338 | ;; used for files under this backend, and if files can indeed be |
| 339 | ;; locked by other users. |
| 340 | ;; |
| 341 | ;; - modify-change-comment (files rev comment) |
| 342 | ;; |
| 343 | ;; Modify the change comments associated with the files at the |
| 344 | ;; given revision. This is optional, many backends do not support it. |
| 345 | ;; |
| 346 | ;; - mark-resolved (files) |
| 347 | ;; |
| 348 | ;; Mark conflicts as resolved. Some VC systems need to run a |
| 349 | ;; command to mark conflicts as resolved. |
| 350 | ;; |
| 351 | ;; HISTORY FUNCTIONS |
| 352 | ;; |
| 353 | ;; * print-log (files &optional buffer) |
| 354 | ;; |
| 355 | ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer |
| 356 | ;; if BUFFER is nil. (Note: older versions of this function expected |
| 357 | ;; only a single file argument.) |
| 358 | ;; |
| 359 | ;; - log-view-mode () |
| 360 | ;; |
| 361 | ;; Mode to use for the output of print-log. This defaults to |
| 362 | ;; `log-view-mode' and is expected to be changed (if at all) to a derived |
| 363 | ;; mode of `log-view-mode'. |
| 364 | ;; |
| 365 | ;; - show-log-entry (revision) |
| 366 | ;; |
| 367 | ;; If provided, search the log entry for REVISION in the current buffer, |
| 368 | ;; and make sure it is displayed in the buffer's window. The default |
| 369 | ;; implementation of this function works for RCS-style logs. |
| 370 | ;; |
| 371 | ;; - comment-history (file) |
| 372 | ;; |
| 373 | ;; Return a string containing all log entries that were made for FILE. |
| 374 | ;; This is used for transferring a file from one backend to another, |
| 375 | ;; retaining comment information. |
| 376 | ;; |
| 377 | ;; - update-changelog (files) |
| 378 | ;; |
| 379 | ;; Using recent log entries, create ChangeLog entries for FILES, or for |
| 380 | ;; all files at or below the default-directory if FILES is nil. The |
| 381 | ;; default implementation runs rcs2log, which handles RCS- and |
| 382 | ;; CVS-style logs. |
| 383 | ;; |
| 384 | ;; * diff (files &optional rev1 rev2 buffer) |
| 385 | ;; |
| 386 | ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if |
| 387 | ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences |
| 388 | ;; from REV1 to REV2. If REV1 is nil, use the working revision (as |
| 389 | ;; found in the repository) as the older revision; if REV2 is nil, |
| 390 | ;; use the current working-copy contents as the newer revision. This |
| 391 | ;; function should pass the value of (vc-switches BACKEND 'diff) to |
| 392 | ;; the backend command. It should return a status of either 0 (no |
| 393 | ;; differences found), or 1 (either non-empty diff or the diff is |
| 394 | ;; run asynchronously). |
| 395 | ;; |
| 396 | ;; - revision-completion-table (files) |
| 397 | ;; |
| 398 | ;; Return a completion table for existing revisions of FILES. |
| 399 | ;; The default is to not use any completion table. |
| 400 | ;; |
| 401 | ;; - annotate-command (file buf &optional rev) |
| 402 | ;; |
| 403 | ;; If this function is provided, it should produce an annotated display |
| 404 | ;; of FILE in BUF, relative to revision REV. Annotation means each line |
| 405 | ;; of FILE displayed is prefixed with version information associated with |
| 406 | ;; its addition (deleted lines leave no history) and that the text of the |
| 407 | ;; file is fontified according to age. |
| 408 | ;; |
| 409 | ;; - annotate-time () |
| 410 | ;; |
| 411 | ;; Only required if `annotate-command' is defined for the backend. |
| 412 | ;; Return the time of the next line of annotation at or after point, |
| 413 | ;; as a floating point fractional number of days. The helper |
| 414 | ;; function `vc-annotate-convert-time' may be useful for converting |
| 415 | ;; multi-part times as returned by `current-time' and `encode-time' |
| 416 | ;; to this format. Return nil if no more lines of annotation appear |
| 417 | ;; in the buffer. You can safely assume that point is placed at the |
| 418 | ;; beginning of each line, starting at `point-min'. The buffer that |
| 419 | ;; point is placed in is the Annotate output, as defined by the |
| 420 | ;; relevant backend. This function also affects how much of the line |
| 421 | ;; is fontified; where it leaves point is where fontification begins. |
| 422 | ;; |
| 423 | ;; - annotate-current-time () |
| 424 | ;; |
| 425 | ;; Only required if `annotate-command' is defined for the backend, |
| 426 | ;; AND you'd like the current time considered to be anything besides |
| 427 | ;; (vc-annotate-convert-time (current-time)) -- i.e. the current |
| 428 | ;; time with hours, minutes, and seconds included. Probably safe to |
| 429 | ;; ignore. Return the current-time, in units of fractional days. |
| 430 | ;; |
| 431 | ;; - annotate-extract-revision-at-line () |
| 432 | ;; |
| 433 | ;; Only required if `annotate-command' is defined for the backend. |
| 434 | ;; Invoked from a buffer in vc-annotate-mode, return the revision |
| 435 | ;; corresponding to the current line, or nil if there is no revision |
| 436 | ;; corresponding to the current line. |
| 437 | ;; |
| 438 | ;; TAG SYSTEM |
| 439 | ;; |
| 440 | ;; - create-tag (dir name branchp) |
| 441 | ;; |
| 442 | ;; Attach the tag NAME to the state of the working copy. This |
| 443 | ;; should make sure that files are up-to-date before proceeding with |
| 444 | ;; the action. DIR can also be a file and if BRANCHP is specified, |
| 445 | ;; NAME should be created as a branch and DIR should be checked out |
| 446 | ;; under this new branch. The default implementation does not |
| 447 | ;; support branches but does a sanity check, a tree traversal and |
| 448 | ;; assigns the tag to each file. |
| 449 | ;; |
| 450 | ;; - retrieve-tag (dir name update) |
| 451 | ;; |
| 452 | ;; Retrieve the version tagged by NAME of all registered files at or below DIR. |
| 453 | ;; If UPDATE is non-nil, then update buffers of any files in the |
| 454 | ;; tag that are currently visited. The default implementation |
| 455 | ;; does a sanity check whether there aren't any uncommitted changes at |
| 456 | ;; or below DIR, and then performs a tree walk, using the `checkout' |
| 457 | ;; function to retrieve the corresponding revisions. |
| 458 | ;; |
| 459 | ;; MISCELLANEOUS |
| 460 | ;; |
| 461 | ;; - root (dir) |
| 462 | ;; |
| 463 | ;; Return DIR's "root" directory, that is, a parent directory of |
| 464 | ;; DIR for which the same backend as used for DIR applies. If no |
| 465 | ;; such parent exists, this function should return DIR. |
| 466 | ;; |
| 467 | ;; - make-version-backups-p (file) |
| 468 | ;; |
| 469 | ;; Return non-nil if unmodified repository revisions of FILE should be |
| 470 | ;; backed up locally. If this is done, VC can perform `diff' and |
| 471 | ;; `revert' operations itself, without calling the backend system. The |
| 472 | ;; default implementation always returns nil. |
| 473 | ;; |
| 474 | ;; - repository-hostname (dirname) |
| 475 | ;; |
| 476 | ;; Return the hostname that the backend will have to contact |
| 477 | ;; in order to operate on a file in DIRNAME. If the return value |
| 478 | ;; is nil, it means that the repository is local. |
| 479 | ;; This function is used in `vc-stay-local-p' which backends can use |
| 480 | ;; for their convenience. |
| 481 | ;; |
| 482 | ;; - previous-revision (file rev) |
| 483 | ;; |
| 484 | ;; Return the revision number that precedes REV for FILE, or nil if no such |
| 485 | ;; revision exists. |
| 486 | ;; |
| 487 | ;; - next-revision (file rev) |
| 488 | ;; |
| 489 | ;; Return the revision number that follows REV for FILE, or nil if no such |
| 490 | ;; revision exists. |
| 491 | ;; |
| 492 | ;; - check-headers () |
| 493 | ;; |
| 494 | ;; Return non-nil if the current buffer contains any version headers. |
| 495 | ;; |
| 496 | ;; - clear-headers () |
| 497 | ;; |
| 498 | ;; In the current buffer, reset all version headers to their unexpanded |
| 499 | ;; form. This function should be provided if the state-querying code |
| 500 | ;; for this backend uses the version headers to determine the state of |
| 501 | ;; a file. This function will then be called whenever VC changes the |
| 502 | ;; version control state in such a way that the headers would give |
| 503 | ;; wrong information. |
| 504 | ;; |
| 505 | ;; - delete-file (file) |
| 506 | ;; |
| 507 | ;; Delete FILE and mark it as deleted in the repository. If this |
| 508 | ;; function is not provided, the command `vc-delete-file' will |
| 509 | ;; signal an error. |
| 510 | ;; |
| 511 | ;; - rename-file (old new) |
| 512 | ;; |
| 513 | ;; Rename file OLD to NEW, both in the working area and in the |
| 514 | ;; repository. If this function is not provided, the renaming |
| 515 | ;; will be done by (vc-delete-file old) and (vc-register new). |
| 516 | ;; |
| 517 | ;; - find-file-hook () |
| 518 | ;; |
| 519 | ;; Operation called in current buffer when opening a file. This can |
| 520 | ;; be used by the backend to setup some local variables it might need. |
| 521 | ;; |
| 522 | ;; - find-file-not-found-hook () |
| 523 | ;; |
| 524 | ;; Operation called in current buffer when opening a non-existing file. |
| 525 | ;; By default, this asks the user if she wants to check out the file. |
| 526 | ;; |
| 527 | ;; - extra-menu () |
| 528 | ;; |
| 529 | ;; Return a menu keymap, the items in the keymap will appear at the |
| 530 | ;; end of the Version Control menu. The goal is to allow backends |
| 531 | ;; to specify extra menu items that appear in the VC menu. This way |
| 532 | ;; you can provide menu entries for functionality that is specific |
| 533 | ;; to your backend and which does not map to any of the VC generic |
| 534 | ;; concepts. |
| 535 | ;; |
| 536 | ;; - extra-status-menu () |
| 537 | ;; |
| 538 | ;; Return a menu keymap, the items in the keymap will appear at the |
| 539 | ;; end of the VC Status menu. The goal is to allow backends to |
| 540 | ;; specify extra menu items that appear in the VC Status menu. This |
| 541 | ;; makes it possible to provide menu entries for functionality that |
| 542 | ;; is specific to a backend and which does not map to any of the VC |
| 543 | ;; generic concepts. |
| 544 | |
| 545 | ;;; Todo: |
| 546 | |
| 547 | ;; - Get rid of the "master file" terminology. |
| 548 | |
| 549 | ;; - Add key-binding for vc-delete-file. |
| 550 | |
| 551 | ;;;; New Primitives: |
| 552 | ;; |
| 553 | ;; - deal with push/pull operations. |
| 554 | ;; |
| 555 | ;; - add a mechanism for editing the underlying VCS's list of files |
| 556 | ;; to be ignored, when that's possible. |
| 557 | ;; |
| 558 | ;;;; Primitives that need changing: |
| 559 | ;; |
| 560 | ;; - vc-update/vc-merge should deal with VC systems that don't |
| 561 | ;; update/merge on a file basis, but on a whole repository basis. |
| 562 | ;; vc-update and vc-merge assume the arguments are always files, |
| 563 | ;; they don't deal with directories. Make sure the *vc-dir* buffer |
| 564 | ;; is updated after these operations. |
| 565 | ;; At least bzr, git and hg should benefit from this. |
| 566 | ;; |
| 567 | ;;;; Improved branch and tag handling: |
| 568 | ;; |
| 569 | ;; - add a generic mechanism for remembering the current branch names, |
| 570 | ;; display the branch name in the mode-line. Replace |
| 571 | ;; vc-cvs-sticky-tag with that. |
| 572 | ;; |
| 573 | ;; - vc-create-tag and vc-retrieve-tag should update the |
| 574 | ;; buffers that might be visiting the affected files. |
| 575 | ;; |
| 576 | ;;;; Default Behavior: |
| 577 | ;; |
| 578 | ;; - do not default to RCS anymore when the current directory is not |
| 579 | ;; controlled by any VCS and the user does C-x v v |
| 580 | ;; |
| 581 | ;; - vc-responsible-backend should not return RCS if no backend |
| 582 | ;; declares itself responsible. |
| 583 | ;; |
| 584 | ;;;; Internal cleanups: |
| 585 | ;; |
| 586 | ;; - backends that care about vc-stay-local should try to take it into |
| 587 | ;; account for vc-dir. Is this likely to be useful??? YES! |
| 588 | ;; |
| 589 | ;; - vc-expand-dirs should take a backend parameter and only look for |
| 590 | ;; files managed by that backend. |
| 591 | ;; |
| 592 | ;; - Another important thing: merge all the status-like backend operations. |
| 593 | ;; We should remove dir-status, state, and dir-status-files, and |
| 594 | ;; replace them with just `status' which takes a fileset and a continuation |
| 595 | ;; (like dir-status) and returns a buffer in which the process(es) are run |
| 596 | ;; (or nil if it worked synchronously). Hopefully we can define the old |
| 597 | ;; 4 operations in term of this one. |
| 598 | ;; |
| 599 | ;;;; Other |
| 600 | ;; |
| 601 | ;; - when a file is in `conflict' state, turn on smerge-mode. |
| 602 | ;; |
| 603 | ;; - figure out what to do with conflicts that are not caused by the |
| 604 | ;; file contents, but by metadata or other causes. Example: File A |
| 605 | ;; gets renamed to B in one branch and to C in another and you merge |
| 606 | ;; the two branches. Or you locally add file FOO and then pull a |
| 607 | ;; change that also adds a new file FOO, ... |
| 608 | ;; |
| 609 | ;; - make it easier to write logs. Maybe C-x 4 a should add to the log |
| 610 | ;; buffer, if one is present, instead of adding to the ChangeLog. |
| 611 | ;; |
| 612 | ;; - When vc-next-action calls vc-checkin it could pre-fill the |
| 613 | ;; *VC-log* buffer with some obvious items: the list of files that |
| 614 | ;; were added, the list of files that were removed. If the diff is |
| 615 | ;; available, maybe it could even call something like |
| 616 | ;; `diff-add-change-log-entries-other-window' to create a detailed |
| 617 | ;; skeleton for the log... |
| 618 | ;; |
| 619 | ;; - most vc-dir backends need more work. They might need to |
| 620 | ;; provide custom headers, use the `extra' field and deal with all |
| 621 | ;; possible VC states. |
| 622 | ;; |
| 623 | ;; - add a function that calls vc-dir to `find-directory-functions'. |
| 624 | ;; |
| 625 | ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered |
| 626 | ;; files. Now that unregistered and ignored files are shown in |
| 627 | ;; vc-dir, it is possible that these commands are called |
| 628 | ;; for unregistered/ignored files. |
| 629 | ;; |
| 630 | ;; - vc-next-action needs work in order to work with multiple |
| 631 | ;; backends: `vc-state' returns the state for the default backend, |
| 632 | ;; not for the backend in the current *vc-dir* buffer. |
| 633 | ;; |
| 634 | ;; - vc-dir-kill-dir-status-process should not be specific to dir-status, |
| 635 | ;; it should work for other async commands done through vc-do-command |
| 636 | ;; as well, |
| 637 | ;; |
| 638 | ;; - vc-dir toolbar needs more icons. |
| 639 | ;; |
| 640 | ;; - The backends should avoid using `vc-file-setprop' and `vc-file-getprop'. |
| 641 | ;; |
| 642 | ;;; Code: |
| 643 | |
| 644 | (require 'vc-hooks) |
| 645 | (require 'vc-dispatcher) |
| 646 | |
| 647 | (eval-when-compile |
| 648 | (require 'cl)) |
| 649 | |
| 650 | (unless (assoc 'vc-parent-buffer minor-mode-alist) |
| 651 | (setq minor-mode-alist |
| 652 | (cons '(vc-parent-buffer vc-parent-buffer-name) |
| 653 | minor-mode-alist))) |
| 654 | |
| 655 | ;; General customization |
| 656 | |
| 657 | (defgroup vc nil |
| 658 | "Version-control system in Emacs." |
| 659 | :group 'tools) |
| 660 | |
| 661 | (defcustom vc-initial-comment nil |
| 662 | "If non-nil, prompt for initial comment when a file is registered." |
| 663 | :type 'boolean |
| 664 | :group 'vc) |
| 665 | |
| 666 | (defcustom vc-default-init-revision "1.1" |
| 667 | "A string used as the default revision number when a new file is registered. |
| 668 | This can be overridden by giving a prefix argument to \\[vc-register]. This |
| 669 | can also be overridden by a particular VC backend." |
| 670 | :type 'string |
| 671 | :group 'vc |
| 672 | :version "20.3") |
| 673 | |
| 674 | (defcustom vc-checkin-switches nil |
| 675 | "A string or list of strings specifying extra switches for checkin. |
| 676 | These are passed to the checkin program by \\[vc-checkin]." |
| 677 | :type '(choice (const :tag "None" nil) |
| 678 | (string :tag "Argument String") |
| 679 | (repeat :tag "Argument List" |
| 680 | :value ("") |
| 681 | string)) |
| 682 | :group 'vc) |
| 683 | |
| 684 | (defcustom vc-checkout-switches nil |
| 685 | "A string or list of strings specifying extra switches for checkout. |
| 686 | These are passed to the checkout program by \\[vc-checkout]." |
| 687 | :type '(choice (const :tag "None" nil) |
| 688 | (string :tag "Argument String") |
| 689 | (repeat :tag "Argument List" |
| 690 | :value ("") |
| 691 | string)) |
| 692 | :group 'vc) |
| 693 | |
| 694 | (defcustom vc-register-switches nil |
| 695 | "A string or list of strings; extra switches for registering a file. |
| 696 | These are passed to the checkin program by \\[vc-register]." |
| 697 | :type '(choice (const :tag "None" nil) |
| 698 | (string :tag "Argument String") |
| 699 | (repeat :tag "Argument List" |
| 700 | :value ("") |
| 701 | string)) |
| 702 | :group 'vc) |
| 703 | |
| 704 | (defcustom vc-diff-switches nil |
| 705 | "A string or list of strings specifying switches for diff under VC. |
| 706 | When running diff under a given BACKEND, VC concatenates the values of |
| 707 | `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to |
| 708 | get the switches for that command. Thus, `vc-diff-switches' should |
| 709 | contain switches that are specific to version control, but not |
| 710 | specific to any particular backend." |
| 711 | :type '(choice (const :tag "None" nil) |
| 712 | (string :tag "Argument String") |
| 713 | (repeat :tag "Argument List" |
| 714 | :value ("") |
| 715 | string)) |
| 716 | :group 'vc |
| 717 | :version "21.1") |
| 718 | |
| 719 | (defcustom vc-diff-knows-L nil |
| 720 | "*Indicates whether diff understands the -L option. |
| 721 | The value is either `yes', `no', or nil. If it is nil, VC tries |
| 722 | to use -L and sets this variable to remember whether it worked." |
| 723 | :type '(choice (const :tag "Work out" nil) (const yes) (const no)) |
| 724 | :group 'vc) |
| 725 | |
| 726 | (defcustom vc-allow-async-revert nil |
| 727 | "Specifies whether the diff during \\[vc-revert] may be asynchronous. |
| 728 | Enabling this option means that you can confirm a revert operation even |
| 729 | if the local changes in the file have not been found and displayed yet." |
| 730 | :type '(choice (const :tag "No" nil) |
| 731 | (const :tag "Yes" t)) |
| 732 | :group 'vc |
| 733 | :version "22.1") |
| 734 | |
| 735 | ;;;###autoload |
| 736 | (defcustom vc-checkout-hook nil |
| 737 | "Normal hook (list of functions) run after checking out a file. |
| 738 | See `run-hooks'." |
| 739 | :type 'hook |
| 740 | :group 'vc |
| 741 | :version "21.1") |
| 742 | |
| 743 | ;;;###autoload |
| 744 | (defcustom vc-checkin-hook nil |
| 745 | "Normal hook (list of functions) run after commit or file checkin. |
| 746 | See also `log-edit-done-hook'." |
| 747 | :type 'hook |
| 748 | :options '(log-edit-comment-to-change-log) |
| 749 | :group 'vc) |
| 750 | |
| 751 | ;;;###autoload |
| 752 | (defcustom vc-before-checkin-hook nil |
| 753 | "Normal hook (list of functions) run before a commit or a file checkin. |
| 754 | See `run-hooks'." |
| 755 | :type 'hook |
| 756 | :group 'vc) |
| 757 | |
| 758 | ;; Header-insertion hair |
| 759 | |
| 760 | (defcustom vc-static-header-alist |
| 761 | '(("\\.c\\'" . |
| 762 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) |
| 763 | "*Associate static header string templates with file types. |
| 764 | A \%s in the template is replaced with the first string associated with |
| 765 | the file's version control type in `vc-header-alist'." |
| 766 | :type '(repeat (cons :format "%v" |
| 767 | (regexp :tag "File Type") |
| 768 | (string :tag "Header String"))) |
| 769 | :group 'vc) |
| 770 | |
| 771 | (defcustom vc-comment-alist |
| 772 | '((nroff-mode ".\\\"" "")) |
| 773 | "*Special comment delimiters for generating VC headers. |
| 774 | Add an entry in this list if you need to override the normal `comment-start' |
| 775 | and `comment-end' variables. This will only be necessary if the mode language |
| 776 | is sensitive to blank lines." |
| 777 | :type '(repeat (list :format "%v" |
| 778 | (symbol :tag "Mode") |
| 779 | (string :tag "Comment Start") |
| 780 | (string :tag "Comment End"))) |
| 781 | :group 'vc) |
| 782 | |
| 783 | (defcustom vc-checkout-carefully (= (user-uid) 0) |
| 784 | "*Non-nil means be extra-careful in checkout. |
| 785 | Verify that the file really is not locked |
| 786 | and that its contents match what the master file says." |
| 787 | :type 'boolean |
| 788 | :group 'vc) |
| 789 | (make-obsolete-variable 'vc-checkout-carefully |
| 790 | "the corresponding checks are always done now." |
| 791 | "21.1") |
| 792 | |
| 793 | \f |
| 794 | ;; Variables users don't need to see |
| 795 | |
| 796 | (defvar vc-disable-async-diff nil |
| 797 | "VC sets this to t locally to disable some async diff operations. |
| 798 | Backends that offer asynchronous diffs should respect this variable |
| 799 | in their implementation of vc-BACKEND-diff.") |
| 800 | |
| 801 | ;; File property caching |
| 802 | |
| 803 | (defun vc-clear-context () |
| 804 | "Clear all cached file properties." |
| 805 | (interactive) |
| 806 | (fillarray vc-file-prop-obarray 0)) |
| 807 | |
| 808 | (defmacro with-vc-properties (files form settings) |
| 809 | "Execute FORM, then maybe set per-file properties for FILES. |
| 810 | SETTINGS is an association list of property/value pairs. After |
| 811 | executing FORM, set those properties from SETTINGS that have not yet |
| 812 | been updated to their corresponding values." |
| 813 | (declare (debug t)) |
| 814 | `(let ((vc-touched-properties (list t))) |
| 815 | ,form |
| 816 | (dolist (file ,files) |
| 817 | (dolist (setting ,settings) |
| 818 | (let ((property (car setting))) |
| 819 | (unless (memq property vc-touched-properties) |
| 820 | (put (intern file vc-file-prop-obarray) |
| 821 | property (cdr setting)))))))) |
| 822 | |
| 823 | ;;; Code for deducing what fileset and backend to assume |
| 824 | |
| 825 | (defun vc-responsible-backend (file &optional register) |
| 826 | "Return the name of a backend system that is responsible for FILE. |
| 827 | The optional argument REGISTER means that a backend suitable for |
| 828 | registration should be found. |
| 829 | |
| 830 | If REGISTER is nil, then if FILE is already registered, return the |
| 831 | backend of FILE. If FILE is not registered, or a directory, then the |
| 832 | first backend in `vc-handled-backends' that declares itself |
| 833 | responsible for FILE is returned. If no backend declares itself |
| 834 | responsible, return the first backend. |
| 835 | |
| 836 | If REGISTER is non-nil, return the first responsible backend under |
| 837 | which FILE is not yet registered. If there is no such backend, return |
| 838 | the first backend under which FILE is not yet registered, but could |
| 839 | be registered." |
| 840 | (when (not vc-handled-backends) |
| 841 | (error "No handled backends")) |
| 842 | (or (and (not (file-directory-p file)) (not register) (vc-backend file)) |
| 843 | (catch 'found |
| 844 | ;; First try: find a responsible backend. If this is for registration, |
| 845 | ;; it must be a backend under which FILE is not yet registered. |
| 846 | (dolist (backend vc-handled-backends) |
| 847 | (and (or (not register) |
| 848 | (not (vc-call-backend backend 'registered file))) |
| 849 | (vc-call-backend backend 'responsible-p file) |
| 850 | (throw 'found backend))) |
| 851 | ;; no responsible backend |
| 852 | (if (not register) |
| 853 | ;; if this is not for registration, the first backend must do |
| 854 | (car vc-handled-backends) |
| 855 | ;; for registration, we need to find a new backend that |
| 856 | ;; could register FILE |
| 857 | (dolist (backend vc-handled-backends) |
| 858 | (and (not (vc-call-backend backend 'registered file)) |
| 859 | (vc-call-backend backend 'could-register file) |
| 860 | (throw 'found backend))) |
| 861 | (error "No backend that could register"))))) |
| 862 | |
| 863 | (defun vc-expand-dirs (file-or-dir-list) |
| 864 | "Expands directories in a file list specification. |
| 865 | Within directories, only files already under version control are noticed." |
| 866 | (let ((flattened '())) |
| 867 | (dolist (node file-or-dir-list) |
| 868 | (when (file-directory-p node) |
| 869 | (vc-file-tree-walk |
| 870 | node (lambda (f) (when (vc-backend f) (push f flattened))))) |
| 871 | (unless (file-directory-p node) (push node flattened))) |
| 872 | (nreverse flattened))) |
| 873 | |
| 874 | (defun vc-derived-from-dir-mode (&optional buffer) |
| 875 | "Are we in a VC-directory buffer, or do we have one as an ancestor?" |
| 876 | (let ((buffer (or buffer (current-buffer)))) |
| 877 | (cond ((derived-mode-p 'vc-dir-mode) t) |
| 878 | (vc-parent-buffer (vc-derived-from-dir-mode vc-parent-buffer)) |
| 879 | (t nil)))) |
| 880 | |
| 881 | (defvar vc-dir-backend) |
| 882 | |
| 883 | ;; FIXME: this is not functional, commented out. |
| 884 | ;; (defun vc-deduce-fileset (&optional observer) |
| 885 | ;; "Deduce a set of files and a backend to which to apply an operation and |
| 886 | ;; the common state of the fileset. Return (BACKEND . FILESET)." |
| 887 | ;; (let* ((selection (vc-dispatcher-selection-set observer)) |
| 888 | ;; (raw (car selection)) ;; Selection as user made it |
| 889 | ;; (cooked (cdr selection)) ;; Files only |
| 890 | ;; ;; FIXME: Store the backend in a buffer-local variable. |
| 891 | ;; (backend (if (vc-derived-from-dir-mode (current-buffer)) |
| 892 | ;; ;; FIXME: this should use vc-dir-backend from |
| 893 | ;; ;; the *vc-dir* buffer. |
| 894 | ;; (vc-responsible-backend default-directory) |
| 895 | ;; (assert (and (= 1 (length raw)) |
| 896 | ;; (not (file-directory-p (car raw))))) |
| 897 | ;; (vc-backend (car cooked))))) |
| 898 | ;; (cons backend selection))) |
| 899 | |
| 900 | (declare-function vc-dir-current-file "vc-dir" ()) |
| 901 | (declare-function vc-dir-deduce-fileset "vc-dir" (&optional state-model-only-files)) |
| 902 | |
| 903 | (defun vc-deduce-fileset (&optional observer allow-unregistered |
| 904 | state-model-only-files) |
| 905 | "Deduce a set of files and a backend to which to apply an operation. |
| 906 | |
| 907 | Return (BACKEND FILESET FILESET-ONLY-FILES STATE CHECKOUT-MODEL). |
| 908 | If we're in VC-dir mode, the fileset is the list of marked files. |
| 909 | Otherwise, if we're looking at a buffer visiting a version-controlled file, |
| 910 | the fileset is a singleton containing this file. |
| 911 | If none of these conditions is met, but ALLOW_UNREGISTERED is on and the |
| 912 | visited file is not registered, return a singleton fileset containing it. |
| 913 | Otherwise, throw an error. |
| 914 | |
| 915 | STATE-MODEL-ONLY-FILES if non-nil, means that the caller needs |
| 916 | the FILESET-ONLY-FILES STATE and MODEL info. Otherwise, that |
| 917 | part may be skipped. |
| 918 | BEWARE: this function may change the |
| 919 | current buffer." |
| 920 | ;; FIXME: OBSERVER is unused. The name is not intuitive and is not |
| 921 | ;; documented. It's set to t when called from diff and print-log. |
| 922 | (let (backend) |
| 923 | (cond |
| 924 | ((derived-mode-p 'vc-dir-mode) |
| 925 | (vc-dir-deduce-fileset state-model-only-files)) |
| 926 | ((setq backend (vc-backend buffer-file-name)) |
| 927 | (if state-model-only-files |
| 928 | (list backend (list buffer-file-name) |
| 929 | (list buffer-file-name) |
| 930 | (vc-state buffer-file-name) |
| 931 | (vc-checkout-model backend buffer-file-name)) |
| 932 | (list backend (list buffer-file-name)))) |
| 933 | ((and (buffer-live-p vc-parent-buffer) |
| 934 | ;; FIXME: Why this test? --Stef |
| 935 | (or (buffer-file-name vc-parent-buffer) |
| 936 | (with-current-buffer vc-parent-buffer |
| 937 | (eq major-mode 'vc-dir-mode)))) |
| 938 | (progn ;FIXME: Why not `with-current-buffer'? --Stef. |
| 939 | (set-buffer vc-parent-buffer) |
| 940 | (vc-deduce-fileset observer allow-unregistered state-model-only-files))) |
| 941 | ((not buffer-file-name) |
| 942 | (error "Buffer %s is not associated with a file" (buffer-name))) |
| 943 | ((and allow-unregistered (not (vc-registered buffer-file-name))) |
| 944 | (if state-model-only-files |
| 945 | (list (vc-responsible-backend |
| 946 | (file-name-directory (buffer-file-name))) |
| 947 | (list buffer-file-name) |
| 948 | (list buffer-file-name) |
| 949 | (when state-model-only-files 'unregistered) |
| 950 | nil) |
| 951 | (list (vc-responsible-backend |
| 952 | (file-name-directory (buffer-file-name))) |
| 953 | (list buffer-file-name)))) |
| 954 | (t (error "No fileset is available here."))))) |
| 955 | |
| 956 | (defun vc-ensure-vc-buffer () |
| 957 | "Make sure that the current buffer visits a version-controlled file." |
| 958 | (cond |
| 959 | ((derived-mode-p 'vc-dir-mode) |
| 960 | (set-buffer (find-file-noselect (vc-dir-current-file)))) |
| 961 | (t |
| 962 | (while (and vc-parent-buffer |
| 963 | (buffer-live-p vc-parent-buffer) |
| 964 | ;; Avoid infinite looping when vc-parent-buffer and |
| 965 | ;; current buffer are the same buffer. |
| 966 | (not (eq vc-parent-buffer (current-buffer)))) |
| 967 | (set-buffer vc-parent-buffer)) |
| 968 | (if (not buffer-file-name) |
| 969 | (error "Buffer %s is not associated with a file" (buffer-name)) |
| 970 | (unless (vc-backend buffer-file-name) |
| 971 | (error "File %s is not under version control" buffer-file-name)))))) |
| 972 | |
| 973 | ;;; Support for the C-x v v command. |
| 974 | ;; This is where all the single-file-oriented code from before the fileset |
| 975 | ;; rewrite lives. |
| 976 | |
| 977 | (defsubst vc-editable-p (file) |
| 978 | "Return non-nil if FILE can be edited." |
| 979 | (let ((backend (vc-backend file))) |
| 980 | (and backend |
| 981 | (or (eq (vc-checkout-model backend (list file)) 'implicit) |
| 982 | (memq (vc-state file) '(edited needs-merge conflict)))))) |
| 983 | |
| 984 | (defun vc-compatible-state (p q) |
| 985 | "Controls which states can be in the same commit." |
| 986 | (or |
| 987 | (eq p q) |
| 988 | (and (member p '(edited added removed)) (member q '(edited added removed))))) |
| 989 | |
| 990 | ;; Here's the major entry point. |
| 991 | |
| 992 | ;;;###autoload |
| 993 | (defun vc-next-action (verbose) |
| 994 | "Do the next logical version control operation on the current fileset. |
| 995 | This requires that all files in the fileset be in the same state. |
| 996 | |
| 997 | For locking systems: |
| 998 | If every file is not already registered, this registers each for version |
| 999 | control. |
| 1000 | If every file is registered and not locked by anyone, this checks out |
| 1001 | a writable and locked file of each ready for editing. |
| 1002 | If every file is checked out and locked by the calling user, this |
| 1003 | first checks to see if each file has changed since checkout. If not, |
| 1004 | it performs a revert on that file. |
| 1005 | If every file has been changed, this pops up a buffer for entry |
| 1006 | of a log message; when the message has been entered, it checks in the |
| 1007 | resulting changes along with the log message as change commentary. If |
| 1008 | the variable `vc-keep-workfiles' is non-nil (which is its default), a |
| 1009 | read-only copy of each changed file is left in place afterwards. |
| 1010 | If the affected file is registered and locked by someone else, you are |
| 1011 | given the option to steal the lock(s). |
| 1012 | |
| 1013 | For merging systems: |
| 1014 | If every file is not already registered, this registers each one for version |
| 1015 | control. This does an add, but not a commit. |
| 1016 | If every file is added but not committed, each one is committed. |
| 1017 | If every working file is changed, but the corresponding repository file is |
| 1018 | unchanged, this pops up a buffer for entry of a log message; when the |
| 1019 | message has been entered, it checks in the resulting changes along |
| 1020 | with the logmessage as change commentary. A writable file is retained. |
| 1021 | If the repository file is changed, you are asked if you want to |
| 1022 | merge in the changes into your working copy." |
| 1023 | (interactive "P") |
| 1024 | (let* ((vc-fileset (vc-deduce-fileset nil t 'state-model-only-files)) |
| 1025 | (backend (car vc-fileset)) |
| 1026 | (files (nth 1 vc-fileset)) |
| 1027 | (fileset-only-files (nth 2 vc-fileset)) |
| 1028 | ;; FIXME: We used to call `vc-recompute-state' here. |
| 1029 | (state (nth 3 vc-fileset)) |
| 1030 | ;; The backend should check that the checkout-model is consistent |
| 1031 | ;; among all the `files'. |
| 1032 | (model (nth 4 vc-fileset)) |
| 1033 | revision) |
| 1034 | |
| 1035 | ;; Do the right thing |
| 1036 | (cond |
| 1037 | ((eq state 'missing) |
| 1038 | (error "Fileset files are missing, so cannot be operated on.")) |
| 1039 | ((eq state 'ignored) |
| 1040 | (error "Fileset files are ignored by the version-control system.")) |
| 1041 | ((or (null state) (eq state 'unregistered)) |
| 1042 | (vc-register nil vc-fileset)) |
| 1043 | ;; Files are up-to-date, or need a merge and user specified a revision |
| 1044 | ((or (eq state 'up-to-date) (and verbose (eq state 'needs-update))) |
| 1045 | (cond |
| 1046 | (verbose |
| 1047 | ;; go to a different revision |
| 1048 | (setq revision (read-string "Branch, revision, or backend to move to: ")) |
| 1049 | (let ((vsym (intern-soft (upcase revision)))) |
| 1050 | (if (member vsym vc-handled-backends) |
| 1051 | (dolist (file files) (vc-transfer-file file vsym)) |
| 1052 | (dolist (file files) |
| 1053 | (vc-checkout file (eq model 'implicit) revision))))) |
| 1054 | ((not (eq model 'implicit)) |
| 1055 | ;; check the files out |
| 1056 | (dolist (file files) (vc-checkout file t))) |
| 1057 | (t |
| 1058 | ;; do nothing |
| 1059 | (message "Fileset is up-to-date")))) |
| 1060 | ;; Files have local changes |
| 1061 | ((vc-compatible-state state 'edited) |
| 1062 | (let ((ready-for-commit files)) |
| 1063 | ;; If files are edited but read-only, give user a chance to correct |
| 1064 | (dolist (file files) |
| 1065 | (unless (file-writable-p file) |
| 1066 | ;; Make the file+buffer read-write. |
| 1067 | (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file)) |
| 1068 | (error "Aborted")) |
| 1069 | (set-file-modes file (logior (file-modes file) 128)) |
| 1070 | (let ((visited (get-file-buffer file))) |
| 1071 | (when visited |
| 1072 | (with-current-buffer visited |
| 1073 | (toggle-read-only -1)))))) |
| 1074 | ;; Allow user to revert files with no changes |
| 1075 | (save-excursion |
| 1076 | (dolist (file files) |
| 1077 | (let ((visited (get-file-buffer file))) |
| 1078 | ;; For files with locking, if the file does not contain |
| 1079 | ;; any changes, just let go of the lock, i.e. revert. |
| 1080 | (when (and (not (eq model 'implicit)) |
| 1081 | (vc-workfile-unchanged-p file) |
| 1082 | ;; If buffer is modified, that means the user just |
| 1083 | ;; said no to saving it; in that case, don't revert, |
| 1084 | ;; because the user might intend to save after |
| 1085 | ;; finishing the log entry and committing. |
| 1086 | (not (and visited (buffer-modified-p)))) |
| 1087 | (vc-revert-file file) |
| 1088 | (setq ready-for-commit (delete file ready-for-commit)))))) |
| 1089 | ;; Remaining files need to be committed |
| 1090 | (if (not ready-for-commit) |
| 1091 | (message "No files remain to be committed") |
| 1092 | (if (not verbose) |
| 1093 | (vc-checkin ready-for-commit) |
| 1094 | (progn |
| 1095 | (setq revision (read-string "New revision or backend: ")) |
| 1096 | (let ((vsym (intern (upcase revision)))) |
| 1097 | (if (member vsym vc-handled-backends) |
| 1098 | (dolist (file files) (vc-transfer-file file vsym)) |
| 1099 | (vc-checkin ready-for-commit revision)))))))) |
| 1100 | ;; locked by somebody else (locking VCSes only) |
| 1101 | ((stringp state) |
| 1102 | ;; In the old days, we computed the revision once and used it on |
| 1103 | ;; the single file. Then, for the 2007-2008 fileset rewrite, we |
| 1104 | ;; computed the revision once (incorrectly, using a free var) and |
| 1105 | ;; used it on all files. To fix the free var bug, we can either |
| 1106 | ;; use `(car files)' or do what we do here: distribute the |
| 1107 | ;; revision computation among `files'. Although this may be |
| 1108 | ;; tedious for those backends where a "revision" is a trans-file |
| 1109 | ;; concept, it is nonetheless correct for both those and (more |
| 1110 | ;; importantly) for those where "revision" is a per-file concept. |
| 1111 | ;; If the intersection of the former group and "locking VCSes" is |
| 1112 | ;; non-empty [I vaguely doubt it --ttn], we can reinstate the |
| 1113 | ;; pre-computation approach of yore. |
| 1114 | (dolist (file files) |
| 1115 | (vc-steal-lock |
| 1116 | file (if verbose |
| 1117 | (read-string (format "%s revision to steal: " file)) |
| 1118 | (vc-working-revision file)) |
| 1119 | state))) |
| 1120 | ;; conflict |
| 1121 | ((eq state 'conflict) |
| 1122 | ;; FIXME: Is it really the UI we want to provide? |
| 1123 | ;; In my experience, the conflicted files should be marked as resolved |
| 1124 | ;; one-by-one when saving the file after resolving the conflicts. |
| 1125 | ;; I.e. stating explicitly that the conflicts are resolved is done |
| 1126 | ;; very rarely. |
| 1127 | (vc-mark-resolved backend files)) |
| 1128 | ;; needs-update |
| 1129 | ((eq state 'needs-update) |
| 1130 | (dolist (file files) |
| 1131 | (if (yes-or-no-p (format |
| 1132 | "%s is not up-to-date. Get latest revision? " |
| 1133 | (file-name-nondirectory file))) |
| 1134 | (vc-checkout file (eq model 'implicit) t) |
| 1135 | (when (and (not (eq model 'implicit)) |
| 1136 | (yes-or-no-p "Lock this revision? ")) |
| 1137 | (vc-checkout file t))))) |
| 1138 | ;; needs-merge |
| 1139 | ((eq state 'needs-merge) |
| 1140 | (dolist (file files) |
| 1141 | (when (yes-or-no-p (format |
| 1142 | "%s is not up-to-date. Merge in changes now? " |
| 1143 | (file-name-nondirectory file))) |
| 1144 | (vc-maybe-resolve-conflicts |
| 1145 | file (vc-call-backend backend 'merge-news file))))) |
| 1146 | |
| 1147 | ;; unlocked-changes |
| 1148 | ((eq state 'unlocked-changes) |
| 1149 | (dolist (file files) |
| 1150 | (when (not (equal buffer-file-name file)) |
| 1151 | (find-file-other-window file)) |
| 1152 | (if (save-window-excursion |
| 1153 | (vc-diff-internal nil |
| 1154 | (cons (car vc-fileset) (cons (cadr vc-fileset) (list file))) |
| 1155 | (vc-working-revision file) nil) |
| 1156 | (goto-char (point-min)) |
| 1157 | (let ((inhibit-read-only t)) |
| 1158 | (insert |
| 1159 | (format "Changes to %s since last lock:\n\n" file))) |
| 1160 | (not (beep)) |
| 1161 | (yes-or-no-p (concat "File has unlocked changes. " |
| 1162 | "Claim lock retaining changes? "))) |
| 1163 | (progn (vc-call-backend backend 'steal-lock file) |
| 1164 | (clear-visited-file-modtime) |
| 1165 | ;; Must clear any headers here because they wouldn't |
| 1166 | ;; show that the file is locked now. |
| 1167 | (vc-clear-headers file) |
| 1168 | (write-file buffer-file-name) |
| 1169 | (vc-mode-line file)) |
| 1170 | (if (not (yes-or-no-p |
| 1171 | "Revert to checked-in revision, instead? ")) |
| 1172 | (error "Checkout aborted") |
| 1173 | (vc-revert-buffer-internal t t) |
| 1174 | (vc-checkout file t))))) |
| 1175 | ;; Unknown fileset state |
| 1176 | (t |
| 1177 | (error "Fileset is in an unknown state %s" state))))) |
| 1178 | |
| 1179 | (defun vc-create-repo (backend) |
| 1180 | "Create an empty repository in the current directory." |
| 1181 | (interactive |
| 1182 | (list |
| 1183 | (intern |
| 1184 | (upcase |
| 1185 | (completing-read |
| 1186 | "Create repository for: " |
| 1187 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends) |
| 1188 | nil t))))) |
| 1189 | (vc-call-backend backend 'create-repo)) |
| 1190 | |
| 1191 | ;;;###autoload |
| 1192 | (defun vc-register (&optional set-revision vc-fileset comment) |
| 1193 | "Register into a version control system. |
| 1194 | If VC-FILESET is given, register the files in that fileset. |
| 1195 | Otherwise register the current file. |
| 1196 | With prefix argument SET-REVISION, allow user to specify initial revision |
| 1197 | level. If COMMENT is present, use that as an initial comment. |
| 1198 | |
| 1199 | The version control system to use is found by cycling through the list |
| 1200 | `vc-handled-backends'. The first backend in that list which declares |
| 1201 | itself responsible for the file (usually because other files in that |
| 1202 | directory are already registered under that backend) will be used to |
| 1203 | register the file. If no backend declares itself responsible, the |
| 1204 | first backend that could register the file is used." |
| 1205 | (interactive "P") |
| 1206 | (let* ((fileset-arg (or vc-fileset (vc-deduce-fileset nil t))) |
| 1207 | (backend (car fileset-arg)) |
| 1208 | (files (nth 1 fileset-arg))) |
| 1209 | ;; We used to operate on `only-files', but VC wants to provide the |
| 1210 | ;; possibility to register directories rather than files only, since |
| 1211 | ;; many VCS allow that as well. |
| 1212 | (dolist (fname files) |
| 1213 | (let ((bname (get-file-buffer fname))) |
| 1214 | (unless fname (setq fname buffer-file-name)) |
| 1215 | (when (vc-backend fname) |
| 1216 | (if (vc-registered fname) |
| 1217 | (error "This file is already registered") |
| 1218 | (unless (y-or-n-p "Previous master file has vanished. Make a new one? ") |
| 1219 | (error "Aborted")))) |
| 1220 | ;; Watch out for new buffers of size 0: the corresponding file |
| 1221 | ;; does not exist yet, even though buffer-modified-p is nil. |
| 1222 | (when bname |
| 1223 | (with-current-buffer bname |
| 1224 | (when (and (not (buffer-modified-p)) |
| 1225 | (zerop (buffer-size)) |
| 1226 | (not (file-exists-p buffer-file-name))) |
| 1227 | (set-buffer-modified-p t)) |
| 1228 | (vc-buffer-sync))))) |
| 1229 | (lexical-let ((backend backend) |
| 1230 | (files files)) |
| 1231 | (vc-start-logentry |
| 1232 | files |
| 1233 | (if set-revision |
| 1234 | (read-string (format "Initial revision level for %s: " files)) |
| 1235 | (vc-call-backend backend 'init-revision)) |
| 1236 | (or comment (not vc-initial-comment)) |
| 1237 | nil |
| 1238 | "Enter initial comment." |
| 1239 | "*VC-log*" |
| 1240 | (lambda (files rev comment) |
| 1241 | (message "Registering %s... " files) |
| 1242 | (mapc 'vc-file-clearprops files) |
| 1243 | (vc-call-backend backend 'register files rev comment) |
| 1244 | (dolist (file files) |
| 1245 | (vc-file-setprop file 'vc-backend backend) |
| 1246 | ;; FIXME: This is wrong: it should set `backup-inhibited' in all |
| 1247 | ;; the buffers visiting files affected by this `vc-register', not |
| 1248 | ;; in the current-buffer. |
| 1249 | ;; (unless vc-make-backup-files |
| 1250 | ;; (make-local-variable 'backup-inhibited) |
| 1251 | ;; (setq backup-inhibited t)) |
| 1252 | ) |
| 1253 | (message "Registering %s... done" files)))))) |
| 1254 | |
| 1255 | (defun vc-register-with (backend) |
| 1256 | "Register the current file with a specified back end." |
| 1257 | (interactive "SBackend: ") |
| 1258 | (when (not (member backend vc-handled-backends)) |
| 1259 | (error "Unknown back end.")) |
| 1260 | (let ((vc-handled-backends (list backend))) |
| 1261 | (call-interactively 'vc-register))) |
| 1262 | |
| 1263 | (defun vc-checkout (file &optional writable rev) |
| 1264 | "Retrieve a copy of the revision REV of FILE. |
| 1265 | If WRITABLE is non-nil, make sure the retrieved file is writable. |
| 1266 | REV defaults to the latest revision. |
| 1267 | |
| 1268 | After check-out, runs the normal hook `vc-checkout-hook'." |
| 1269 | (and writable |
| 1270 | (not rev) |
| 1271 | (vc-call make-version-backups-p file) |
| 1272 | (vc-up-to-date-p file) |
| 1273 | (vc-make-version-backup file)) |
| 1274 | (let ((backend (vc-backend file))) |
| 1275 | (with-vc-properties (list file) |
| 1276 | (condition-case err |
| 1277 | (vc-call-backend backend 'checkout file writable rev) |
| 1278 | (file-error |
| 1279 | ;; Maybe the backend is not installed ;-( |
| 1280 | (when writable |
| 1281 | (let ((buf (get-file-buffer file))) |
| 1282 | (when buf (with-current-buffer buf (toggle-read-only -1))))) |
| 1283 | (signal (car err) (cdr err)))) |
| 1284 | `((vc-state . ,(if (or (eq (vc-checkout-model backend (list file)) 'implicit) |
| 1285 | (not writable)) |
| 1286 | (if (vc-call-backend backend 'latest-on-branch-p file) |
| 1287 | 'up-to-date |
| 1288 | 'needs-update) |
| 1289 | 'edited)) |
| 1290 | (vc-checkout-time . ,(nth 5 (file-attributes file)))))) |
| 1291 | (vc-resynch-buffer file t t) |
| 1292 | (run-hooks 'vc-checkout-hook)) |
| 1293 | |
| 1294 | (defun vc-mark-resolved (backend files) |
| 1295 | (with-vc-properties |
| 1296 | files |
| 1297 | (vc-call-backend backend 'mark-resolved files) |
| 1298 | ;; FIXME: Is this TRTD? Might not be. |
| 1299 | `((vc-state . edited)))) |
| 1300 | |
| 1301 | (defun vc-steal-lock (file rev owner) |
| 1302 | "Steal the lock on FILE." |
| 1303 | (let (file-description) |
| 1304 | (if rev |
| 1305 | (setq file-description (format "%s:%s" file rev)) |
| 1306 | (setq file-description file)) |
| 1307 | (when (not (yes-or-no-p (format "Steal the lock on %s from %s? " |
| 1308 | file-description owner))) |
| 1309 | (error "Steal canceled")) |
| 1310 | (message "Stealing lock on %s..." file) |
| 1311 | (with-vc-properties |
| 1312 | (list file) |
| 1313 | (vc-call steal-lock file rev) |
| 1314 | `((vc-state . edited))) |
| 1315 | (vc-resynch-buffer file t t) |
| 1316 | (message "Stealing lock on %s...done" file) |
| 1317 | ;; Write mail after actually stealing, because if the stealing |
| 1318 | ;; goes wrong, we don't want to send any mail. |
| 1319 | (compose-mail owner (format "Stolen lock on %s" file-description)) |
| 1320 | (setq default-directory (expand-file-name "~/")) |
| 1321 | (goto-char (point-max)) |
| 1322 | (insert |
| 1323 | (format "I stole the lock on %s, " file-description) |
| 1324 | (current-time-string) |
| 1325 | ".\n") |
| 1326 | (message "Please explain why you stole the lock. Type C-c C-c when done."))) |
| 1327 | |
| 1328 | (defun vc-checkin (files &optional rev comment initial-contents) |
| 1329 | "Check in FILES. |
| 1330 | The optional argument REV may be a string specifying the new revision |
| 1331 | level (if nil increment the current level). COMMENT is a comment |
| 1332 | string; if omitted, a buffer is popped up to accept a comment. If |
| 1333 | INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents |
| 1334 | of the log entry buffer. |
| 1335 | |
| 1336 | If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided |
| 1337 | that the version control system supports this mode of operation. |
| 1338 | |
| 1339 | Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'." |
| 1340 | (when vc-before-checkin-hook |
| 1341 | (run-hooks 'vc-before-checkin-hook)) |
| 1342 | (vc-start-logentry |
| 1343 | files rev comment initial-contents |
| 1344 | "Enter a change comment." |
| 1345 | "*VC-log*" |
| 1346 | (lambda (files rev comment) |
| 1347 | (message "Checking in %s..." (vc-delistify files)) |
| 1348 | ;; "This log message intentionally left almost blank". |
| 1349 | ;; RCS 5.7 gripes about white-space-only comments too. |
| 1350 | (or (and comment (string-match "[^\t\n ]" comment)) |
| 1351 | (setq comment "*** empty log message ***")) |
| 1352 | (with-vc-properties |
| 1353 | files |
| 1354 | ;; We used to change buffers to get local value of vc-checkin-switches, |
| 1355 | ;; but 'the' local buffer is not a well-defined concept for filesets. |
| 1356 | (progn |
| 1357 | (vc-call checkin files rev comment) |
| 1358 | (mapc 'vc-delete-automatic-version-backups files)) |
| 1359 | `((vc-state . up-to-date) |
| 1360 | (vc-checkout-time . ,(nth 5 (file-attributes file))) |
| 1361 | (vc-working-revision . nil))) |
| 1362 | (message "Checking in %s...done" (vc-delistify files))) |
| 1363 | 'vc-checkin-hook)) |
| 1364 | |
| 1365 | ;;; Additional entry points for examining version histories |
| 1366 | |
| 1367 | ;; (defun vc-default-diff-tree (backend dir rev1 rev2) |
| 1368 | ;; "List differences for all registered files at and below DIR. |
| 1369 | ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'." |
| 1370 | ;; ;; This implementation does an explicit tree walk, and calls |
| 1371 | ;; ;; vc-BACKEND-diff directly for each file. An optimization |
| 1372 | ;; ;; would be to use `vc-diff-internal', so that diffs can be local, |
| 1373 | ;; ;; and to call it only for files that are actually changed. |
| 1374 | ;; ;; However, this is expensive for some backends, and so it is left |
| 1375 | ;; ;; to backend-specific implementations. |
| 1376 | ;; (setq default-directory dir) |
| 1377 | ;; (vc-file-tree-walk |
| 1378 | ;; default-directory |
| 1379 | ;; (lambda (f) |
| 1380 | ;; (vc-exec-after |
| 1381 | ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f))) |
| 1382 | ;; (message "Looking at %s" ',f) |
| 1383 | ;; (vc-call-backend ',(vc-backend f) |
| 1384 | ;; 'diff (list ',f) ',rev1 ',rev2)))))) |
| 1385 | |
| 1386 | (defun vc-coding-system-for-diff (file) |
| 1387 | "Return the coding system for reading diff output for FILE." |
| 1388 | (or coding-system-for-read |
| 1389 | ;; if we already have this file open, |
| 1390 | ;; use the buffer's coding system |
| 1391 | (let ((buf (find-buffer-visiting file))) |
| 1392 | (when buf (with-current-buffer buf |
| 1393 | buffer-file-coding-system))) |
| 1394 | ;; otherwise, try to find one based on the file name |
| 1395 | (car (find-operation-coding-system 'insert-file-contents file)) |
| 1396 | ;; and a final fallback |
| 1397 | 'undecided)) |
| 1398 | |
| 1399 | (defun vc-switches (backend op) |
| 1400 | (let ((switches |
| 1401 | (or (when backend |
| 1402 | (let ((sym (vc-make-backend-sym |
| 1403 | backend (intern (concat (symbol-name op) |
| 1404 | "-switches"))))) |
| 1405 | (when (boundp sym) (symbol-value sym)))) |
| 1406 | (let ((sym (intern (format "vc-%s-switches" (symbol-name op))))) |
| 1407 | (when (boundp sym) (symbol-value sym))) |
| 1408 | (cond |
| 1409 | ((eq op 'diff) diff-switches))))) |
| 1410 | (if (stringp switches) (list switches) |
| 1411 | ;; If not a list, return nil. |
| 1412 | ;; This is so we can set vc-diff-switches to t to override |
| 1413 | ;; any switches in diff-switches. |
| 1414 | (when (listp switches) switches)))) |
| 1415 | |
| 1416 | ;; Old def for compatibility with Emacs-21.[123]. |
| 1417 | (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff)) |
| 1418 | (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1") |
| 1419 | |
| 1420 | (defun vc-diff-finish (buffer messages) |
| 1421 | ;; The empty sync output case has already been handled, so the only |
| 1422 | ;; possibility of an empty output is for an async process. |
| 1423 | (when (buffer-live-p buffer) |
| 1424 | (let ((window (get-buffer-window buffer t)) |
| 1425 | (emptyp (zerop (buffer-size buffer)))) |
| 1426 | (with-current-buffer buffer |
| 1427 | (and messages emptyp |
| 1428 | (let ((inhibit-read-only t)) |
| 1429 | (insert (cdr messages) ".\n") |
| 1430 | (message "%s" (cdr messages)))) |
| 1431 | (goto-char (point-min)) |
| 1432 | (when window |
| 1433 | (shrink-window-if-larger-than-buffer window))) |
| 1434 | (when (and messages (not emptyp)) |
| 1435 | (message "%sdone" (car messages)))))) |
| 1436 | |
| 1437 | (defvar vc-diff-added-files nil |
| 1438 | "If non-nil, diff added files by comparing them to /dev/null.") |
| 1439 | |
| 1440 | (defun vc-diff-internal (async vc-fileset rev1 rev2 &optional verbose) |
| 1441 | "Report diffs between two revisions of a fileset. |
| 1442 | Diff output goes to the *vc-diff* buffer. The function |
| 1443 | returns t if the buffer had changes, nil otherwise." |
| 1444 | (let* ((files (cadr vc-fileset)) |
| 1445 | (messages (cons (format "Finding changes in %s..." |
| 1446 | (vc-delistify files)) |
| 1447 | (format "No changes between %s and %s" |
| 1448 | (or rev1 "working revision") |
| 1449 | (or rev2 "workfile")))) |
| 1450 | ;; Set coding system based on the first file. It's a kluge, |
| 1451 | ;; but the only way to set it for each file included would |
| 1452 | ;; be to call the back end separately for each file. |
| 1453 | (coding-system-for-read |
| 1454 | (if files (vc-coding-system-for-diff (car files)) 'undecided))) |
| 1455 | (vc-setup-buffer "*vc-diff*") |
| 1456 | (message "%s" (car messages)) |
| 1457 | ;; Many backends don't handle well the case of a file that has been |
| 1458 | ;; added but not yet committed to the repo (notably CVS and Subversion). |
| 1459 | ;; Do that work here so the backends don't have to futz with it. --ESR |
| 1460 | ;; |
| 1461 | ;; Actually most backends (including CVS) have options to control the |
| 1462 | ;; behavior since which one is better depends on the user and on the |
| 1463 | ;; situation). Worse yet: this code does not handle the case where |
| 1464 | ;; `file' is a directory which contains added files. |
| 1465 | ;; I made it conditional on vc-diff-added-files but it should probably |
| 1466 | ;; just be removed (or copied/moved to specific backends). --Stef. |
| 1467 | (when vc-diff-added-files |
| 1468 | (let ((filtered '())) |
| 1469 | (dolist (file files) |
| 1470 | (if (or (file-directory-p file) |
| 1471 | (not (string= (vc-working-revision file) "0"))) |
| 1472 | (push file filtered) |
| 1473 | ;; This file is added but not yet committed; |
| 1474 | ;; there is no master file to diff against. |
| 1475 | (if (or rev1 rev2) |
| 1476 | (error "No revisions of %s exist" file) |
| 1477 | ;; We regard this as "changed". |
| 1478 | ;; Diff it against /dev/null. |
| 1479 | (apply 'vc-do-command "*vc-diff*" |
| 1480 | 1 "diff" file |
| 1481 | (append (vc-switches nil 'diff) '("/dev/null")))))) |
| 1482 | (setq files (nreverse filtered)))) |
| 1483 | (let ((vc-disable-async-diff (not async))) |
| 1484 | (vc-call-backend (car vc-fileset) 'diff files rev1 rev2 "*vc-diff*")) |
| 1485 | (set-buffer "*vc-diff*") |
| 1486 | (if (and (zerop (buffer-size)) |
| 1487 | (not (get-buffer-process (current-buffer)))) |
| 1488 | ;; Treat this case specially so as not to pop the buffer. |
| 1489 | (progn |
| 1490 | (message "%s" (cdr messages)) |
| 1491 | nil) |
| 1492 | (diff-mode) |
| 1493 | ;; Make the *vc-diff* buffer read only, the diff-mode key |
| 1494 | ;; bindings are nicer for read only buffers. pcl-cvs does the |
| 1495 | ;; same thing. |
| 1496 | (setq buffer-read-only t) |
| 1497 | (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose |
| 1498 | messages))) |
| 1499 | ;; Display the buffer, but at the end because it can change point. |
| 1500 | (pop-to-buffer (current-buffer)) |
| 1501 | ;; In the async case, we return t even if there are no differences |
| 1502 | ;; because we don't know that yet. |
| 1503 | t))) |
| 1504 | |
| 1505 | ;;;###autoload |
| 1506 | (defun vc-version-diff (files rev1 rev2) |
| 1507 | "Report diffs between revisions of the fileset in the repository history." |
| 1508 | (interactive |
| 1509 | (let* ((vc-fileset (vc-deduce-fileset t)) ;FIXME: why t? --Stef |
| 1510 | (files (cadr vc-fileset)) |
| 1511 | (backend (car vc-fileset)) |
| 1512 | (first (car files)) |
| 1513 | (completion-table |
| 1514 | (vc-call-backend backend 'revision-completion-table files)) |
| 1515 | (rev1-default nil) |
| 1516 | (rev2-default nil)) |
| 1517 | (cond |
| 1518 | ;; someday we may be able to do revision completion on non-singleton |
| 1519 | ;; filesets, but not yet. |
| 1520 | ((/= (length files) 1) |
| 1521 | nil) |
| 1522 | ;; if it's a directory, don't supply any revision default |
| 1523 | ((file-directory-p first) |
| 1524 | nil) |
| 1525 | ;; if the file is not up-to-date, use working revision as older revision |
| 1526 | ((not (vc-up-to-date-p first)) |
| 1527 | (setq rev1-default (vc-working-revision first))) |
| 1528 | ;; if the file is not locked, use last and previous revisions as defaults |
| 1529 | (t |
| 1530 | (setq rev1-default (vc-call-backend backend 'previous-revision first |
| 1531 | (vc-working-revision first))) |
| 1532 | (when (string= rev1-default "") (setq rev1-default nil)) |
| 1533 | (setq rev2-default (vc-working-revision first)))) |
| 1534 | ;; construct argument list |
| 1535 | (let* ((rev1-prompt (if rev1-default |
| 1536 | (concat "Older revision (default " |
| 1537 | rev1-default "): ") |
| 1538 | "Older revision: ")) |
| 1539 | (rev2-prompt (concat "Newer revision (default " |
| 1540 | (or rev2-default "current source") "): ")) |
| 1541 | (rev1 (if completion-table |
| 1542 | (completing-read rev1-prompt completion-table |
| 1543 | nil nil nil nil rev1-default) |
| 1544 | (read-string rev1-prompt nil nil rev1-default))) |
| 1545 | (rev2 (if completion-table |
| 1546 | (completing-read rev2-prompt completion-table |
| 1547 | nil nil nil nil rev2-default) |
| 1548 | (read-string rev2-prompt nil nil rev2-default)))) |
| 1549 | (when (string= rev1 "") (setq rev1 nil)) |
| 1550 | (when (string= rev2 "") (setq rev2 nil)) |
| 1551 | (list files rev1 rev2)))) |
| 1552 | ;; All that was just so we could do argument completion! |
| 1553 | (when (and (not rev1) rev2) |
| 1554 | (error "Not a valid revision range.")) |
| 1555 | ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the |
| 1556 | ;; placement rules for (interactive) don't actually leave us a choice. |
| 1557 | (vc-diff-internal t (vc-deduce-fileset) rev1 rev2 (interactive-p))) |
| 1558 | |
| 1559 | ;; (defun vc-contains-version-controlled-file (dir) |
| 1560 | ;; "Return t if DIR contains a version-controlled file, nil otherwise." |
| 1561 | ;; (catch 'found |
| 1562 | ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir)) |
| 1563 | ;; nil)) |
| 1564 | |
| 1565 | ;;;###autoload |
| 1566 | (defun vc-diff (historic &optional not-urgent) |
| 1567 | "Display diffs between file revisions. |
| 1568 | Normally this compares the currently selected fileset with their |
| 1569 | working revisions. With a prefix argument HISTORIC, it reads two revision |
| 1570 | designators specifying which revisions to compare. |
| 1571 | |
| 1572 | The optional argument NOT-URGENT non-nil means it is ok to say no to |
| 1573 | saving the buffer." |
| 1574 | (interactive (list current-prefix-arg t)) |
| 1575 | (if historic |
| 1576 | (call-interactively 'vc-version-diff) |
| 1577 | (when buffer-file-name (vc-buffer-sync not-urgent)) |
| 1578 | (vc-diff-internal t (vc-deduce-fileset) nil nil (interactive-p)))) |
| 1579 | |
| 1580 | ;;;###autoload |
| 1581 | (defun vc-revision-other-window (rev) |
| 1582 | "Visit revision REV of the current file in another window. |
| 1583 | If the current file is named `F', the revision is named `F.~REV~'. |
| 1584 | If `F.~REV~' already exists, use it instead of checking it out again." |
| 1585 | (interactive |
| 1586 | (save-current-buffer |
| 1587 | (vc-ensure-vc-buffer) |
| 1588 | (let ((completion-table |
| 1589 | (vc-call revision-completion-table buffer-file-name)) |
| 1590 | (prompt "Revision to visit (default is working revision): ")) |
| 1591 | (list |
| 1592 | (if completion-table |
| 1593 | (completing-read prompt completion-table) |
| 1594 | (read-string prompt)))))) |
| 1595 | (vc-ensure-vc-buffer) |
| 1596 | (let* ((file buffer-file-name) |
| 1597 | (revision (if (string-equal rev "") |
| 1598 | (vc-working-revision file) |
| 1599 | rev))) |
| 1600 | (switch-to-buffer-other-window (vc-find-revision file revision)))) |
| 1601 | |
| 1602 | (defun vc-find-revision (file revision) |
| 1603 | "Read REVISION of FILE into a buffer and return the buffer." |
| 1604 | (let ((automatic-backup (vc-version-backup-file-name file revision)) |
| 1605 | (filebuf (or (get-file-buffer file) (current-buffer))) |
| 1606 | (filename (vc-version-backup-file-name file revision 'manual))) |
| 1607 | (unless (file-exists-p filename) |
| 1608 | (if (file-exists-p automatic-backup) |
| 1609 | (rename-file automatic-backup filename nil) |
| 1610 | (message "Checking out %s..." filename) |
| 1611 | (with-current-buffer filebuf |
| 1612 | (let ((failed t)) |
| 1613 | (unwind-protect |
| 1614 | (let ((coding-system-for-read 'no-conversion) |
| 1615 | (coding-system-for-write 'no-conversion)) |
| 1616 | (with-temp-file filename |
| 1617 | (let ((outbuf (current-buffer))) |
| 1618 | ;; Change buffer to get local value of |
| 1619 | ;; vc-checkout-switches. |
| 1620 | (with-current-buffer filebuf |
| 1621 | (vc-call find-revision file revision outbuf)))) |
| 1622 | (setq failed nil)) |
| 1623 | (when (and failed (file-exists-p filename)) |
| 1624 | (delete-file filename)))) |
| 1625 | (vc-mode-line file)) |
| 1626 | (message "Checking out %s...done" filename))) |
| 1627 | (let ((result-buf (find-file-noselect filename))) |
| 1628 | (with-current-buffer result-buf |
| 1629 | ;; Set the parent buffer so that things like |
| 1630 | ;; C-x v g, C-x v l, ... etc work. |
| 1631 | (set (make-local-variable 'vc-parent-buffer) filebuf)) |
| 1632 | result-buf))) |
| 1633 | |
| 1634 | ;; Header-insertion code |
| 1635 | |
| 1636 | ;;;###autoload |
| 1637 | (defun vc-insert-headers () |
| 1638 | "Insert headers into a file for use with a version control system. |
| 1639 | Headers desired are inserted at point, and are pulled from |
| 1640 | the variable `vc-BACKEND-header'." |
| 1641 | (interactive) |
| 1642 | (vc-ensure-vc-buffer) |
| 1643 | (save-excursion |
| 1644 | (save-restriction |
| 1645 | (widen) |
| 1646 | (when (or (not (vc-check-headers)) |
| 1647 | (y-or-n-p "Version headers already exist. Insert another set? ")) |
| 1648 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) |
| 1649 | (comment-start-vc (or (car delims) comment-start "#")) |
| 1650 | (comment-end-vc (or (car (cdr delims)) comment-end "")) |
| 1651 | (hdsym (vc-make-backend-sym (vc-backend buffer-file-name) |
| 1652 | 'header)) |
| 1653 | (hdstrings (and (boundp hdsym) (symbol-value hdsym)))) |
| 1654 | (dolist (s hdstrings) |
| 1655 | (insert comment-start-vc "\t" s "\t" |
| 1656 | comment-end-vc "\n")) |
| 1657 | (when vc-static-header-alist |
| 1658 | (dolist (f vc-static-header-alist) |
| 1659 | (when (string-match (car f) buffer-file-name) |
| 1660 | (insert (format (cdr f) (car hdstrings))))))))))) |
| 1661 | |
| 1662 | (defun vc-clear-headers (&optional file) |
| 1663 | "Clear all version headers in the current buffer (or FILE). |
| 1664 | The headers are reset to their non-expanded form." |
| 1665 | (let* ((filename (or file buffer-file-name)) |
| 1666 | (visited (find-buffer-visiting filename)) |
| 1667 | (backend (vc-backend filename))) |
| 1668 | (when (vc-find-backend-function backend 'clear-headers) |
| 1669 | (if visited |
| 1670 | (let ((context (vc-buffer-context))) |
| 1671 | ;; save-excursion may be able to relocate point and mark |
| 1672 | ;; properly. If it fails, vc-restore-buffer-context |
| 1673 | ;; will give it a second try. |
| 1674 | (save-excursion |
| 1675 | (vc-call-backend backend 'clear-headers)) |
| 1676 | (vc-restore-buffer-context context)) |
| 1677 | (set-buffer (find-file-noselect filename)) |
| 1678 | (vc-call-backend backend 'clear-headers) |
| 1679 | (kill-buffer filename))))) |
| 1680 | |
| 1681 | (defun vc-modify-change-comment (files rev oldcomment) |
| 1682 | "Edit the comment associated with the given files and revision." |
| 1683 | (vc-start-logentry |
| 1684 | files rev oldcomment t |
| 1685 | "Enter a replacement change comment." |
| 1686 | "*VC-log*" |
| 1687 | (lambda (files rev comment) |
| 1688 | (vc-call-backend |
| 1689 | ;; Less of a kluge than it looks like; log-view mode only passes |
| 1690 | ;; this function a singleton list. Arguments left in this form in |
| 1691 | ;; case the more general operation ever becomes meaningful. |
| 1692 | (vc-responsible-backend (car files)) |
| 1693 | 'modify-change-comment files rev comment)))) |
| 1694 | |
| 1695 | ;;;###autoload |
| 1696 | (defun vc-merge () |
| 1697 | "Merge changes between two revisions into the current buffer's file. |
| 1698 | This asks for two revisions to merge from in the minibuffer. If the |
| 1699 | first revision is a branch number, then merge all changes from that |
| 1700 | branch. If the first revision is empty, merge news, i.e. recent changes |
| 1701 | from the current branch. |
| 1702 | |
| 1703 | See Info node `Merging'." |
| 1704 | (interactive) |
| 1705 | (vc-ensure-vc-buffer) |
| 1706 | (vc-buffer-sync) |
| 1707 | (let* ((file buffer-file-name) |
| 1708 | (backend (vc-backend file)) |
| 1709 | (state (vc-state file)) |
| 1710 | first-revision second-revision status) |
| 1711 | (cond |
| 1712 | ((stringp state) ;; Locking VCses only |
| 1713 | (error "File is locked by %s" state)) |
| 1714 | ((not (vc-editable-p file)) |
| 1715 | (if (y-or-n-p |
| 1716 | "File must be checked out for merging. Check out now? ") |
| 1717 | (vc-checkout file t) |
| 1718 | (error "Merge aborted")))) |
| 1719 | (setq first-revision |
| 1720 | (read-string (concat "Branch or revision to merge from " |
| 1721 | "(default news on current branch): "))) |
| 1722 | (if (string= first-revision "") |
| 1723 | (setq status (vc-call-backend backend 'merge-news file)) |
| 1724 | (if (not (vc-find-backend-function backend 'merge)) |
| 1725 | (error "Sorry, merging is not implemented for %s" backend) |
| 1726 | (if (not (vc-branch-p first-revision)) |
| 1727 | (setq second-revision |
| 1728 | (read-string "Second revision: " |
| 1729 | (concat (vc-branch-part first-revision) "."))) |
| 1730 | ;; We want to merge an entire branch. Set revisions |
| 1731 | ;; accordingly, so that vc-BACKEND-merge understands us. |
| 1732 | (setq second-revision first-revision) |
| 1733 | ;; first-revision must be the starting point of the branch |
| 1734 | (setq first-revision (vc-branch-part first-revision))) |
| 1735 | (setq status (vc-call-backend backend 'merge file |
| 1736 | first-revision second-revision)))) |
| 1737 | (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE"))) |
| 1738 | |
| 1739 | (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B) |
| 1740 | (vc-resynch-buffer file t (not (buffer-modified-p))) |
| 1741 | (if (zerop status) (message "Merge successful") |
| 1742 | (smerge-mode 1) |
| 1743 | (message "File contains conflicts."))) |
| 1744 | |
| 1745 | ;;;###autoload |
| 1746 | (defalias 'vc-resolve-conflicts 'smerge-ediff) |
| 1747 | |
| 1748 | ;; Named-configuration entry points |
| 1749 | |
| 1750 | (defun vc-tag-precondition (dir) |
| 1751 | "Scan the tree below DIR, looking for files not up-to-date. |
| 1752 | If any file is not up-to-date, return the name of the first such file. |
| 1753 | \(This means, neither tag creation nor retrieval is allowed.\) |
| 1754 | If one or more of the files are currently visited, return `visited'. |
| 1755 | Otherwise, return nil." |
| 1756 | (let ((status nil)) |
| 1757 | (catch 'vc-locked-example |
| 1758 | (vc-file-tree-walk |
| 1759 | dir |
| 1760 | (lambda (f) |
| 1761 | (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f) |
| 1762 | (when (get-file-buffer f) (setq status 'visited))))) |
| 1763 | status))) |
| 1764 | |
| 1765 | ;;;###autoload |
| 1766 | (defun vc-create-tag (dir name branchp) |
| 1767 | "Descending recursively from DIR, make a tag called NAME. |
| 1768 | For each registered file, the working revision becomes part of |
| 1769 | the named configuration. If the prefix argument BRANCHP is |
| 1770 | given, the tag is made as a new branch and the files are |
| 1771 | checked out in that new branch." |
| 1772 | (interactive |
| 1773 | (list (read-file-name "Directory: " default-directory default-directory t) |
| 1774 | (read-string "New tag name: ") |
| 1775 | current-prefix-arg)) |
| 1776 | (message "Making %s... " (if branchp "branch" "tag")) |
| 1777 | (when (file-directory-p dir) (setq dir (file-name-as-directory dir))) |
| 1778 | (vc-call-backend (vc-responsible-backend dir) |
| 1779 | 'create-tag dir name branchp) |
| 1780 | (message "Making %s... done" (if branchp "branch" "tag"))) |
| 1781 | |
| 1782 | ;;;###autoload |
| 1783 | (defun vc-retrieve-tag (dir name) |
| 1784 | "Descending recursively from DIR, retrieve the tag called NAME. |
| 1785 | If NAME is empty, it refers to the latest revisions. |
| 1786 | If locking is used for the files in DIR, then there must not be any |
| 1787 | locked files at or below DIR (but if NAME is empty, locked files are |
| 1788 | allowed and simply skipped)." |
| 1789 | (interactive |
| 1790 | (list (read-file-name "Directory: " default-directory default-directory t) |
| 1791 | (read-string "Tag name to retrieve (default latest revisions): "))) |
| 1792 | (let ((update (yes-or-no-p "Update any affected buffers? ")) |
| 1793 | (msg (if (or (not name) (string= name "")) |
| 1794 | (format "Updating %s... " (abbreviate-file-name dir)) |
| 1795 | (format "Retrieving tag into %s... " |
| 1796 | (abbreviate-file-name dir))))) |
| 1797 | (message "%s" msg) |
| 1798 | (vc-call-backend (vc-responsible-backend dir) |
| 1799 | 'retrieve-tag dir name update) |
| 1800 | (message "%s" (concat msg "done")))) |
| 1801 | |
| 1802 | ;; Miscellaneous other entry points |
| 1803 | |
| 1804 | ;;;###autoload |
| 1805 | (defun vc-print-log (&optional working-revision) |
| 1806 | "List the change log of the current fileset in a window. |
| 1807 | If WORKING-REVISION is non-nil, leave the point at that revision." |
| 1808 | (interactive) |
| 1809 | (let* ((vc-fileset (vc-deduce-fileset t)) ;FIXME: Why t? --Stef |
| 1810 | (backend (car vc-fileset)) |
| 1811 | (files (cadr vc-fileset)) |
| 1812 | (working-revision (or working-revision (vc-working-revision (car files))))) |
| 1813 | ;; Don't switch to the output buffer before running the command, |
| 1814 | ;; so that any buffer-local settings in the vc-controlled |
| 1815 | ;; buffer can be accessed by the command. |
| 1816 | (vc-call-backend backend 'print-log files "*vc-change-log*") |
| 1817 | (pop-to-buffer "*vc-change-log*") |
| 1818 | (vc-exec-after |
| 1819 | `(let ((inhibit-read-only t)) |
| 1820 | (vc-call-backend ',backend 'log-view-mode) |
| 1821 | (set (make-local-variable 'log-view-vc-backend) ',backend) |
| 1822 | (set (make-local-variable 'log-view-vc-fileset) ',files) |
| 1823 | (goto-char (point-max)) (forward-line -1) |
| 1824 | (while (looking-at "=*\n") |
| 1825 | (delete-char (- (match-end 0) (match-beginning 0))) |
| 1826 | (forward-line -1)) |
| 1827 | (goto-char (point-min)) |
| 1828 | (when (looking-at "[\b\t\n\v\f\r ]+") |
| 1829 | (delete-char (- (match-end 0) (match-beginning 0)))) |
| 1830 | (shrink-window-if-larger-than-buffer) |
| 1831 | ;; move point to the log entry for the working revision |
| 1832 | (vc-call-backend ',backend 'show-log-entry ',working-revision) |
| 1833 | (setq vc-sentinel-movepoint (point)) |
| 1834 | (set-buffer-modified-p nil))))) |
| 1835 | |
| 1836 | ;;;###autoload |
| 1837 | (defun vc-revert () |
| 1838 | "Revert working copies of the selected fileset to their repository contents. |
| 1839 | This asks for confirmation if the buffer contents are not identical |
| 1840 | to the working revision (except for keyword expansion)." |
| 1841 | (interactive) |
| 1842 | (let* ((vc-fileset (vc-deduce-fileset)) |
| 1843 | (files (cadr vc-fileset))) |
| 1844 | ;; If any of the files is visited by the current buffer, make |
| 1845 | ;; sure buffer is saved. If the user says `no', abort since |
| 1846 | ;; we cannot show the changes and ask for confirmation to |
| 1847 | ;; discard them. |
| 1848 | (when (or (not files) (memq (buffer-file-name) files)) |
| 1849 | (vc-buffer-sync nil)) |
| 1850 | (dolist (file files) |
| 1851 | (let ((buf (get-file-buffer file))) |
| 1852 | (when (and buf (buffer-modified-p buf)) |
| 1853 | (error "Please kill or save all modified buffers before reverting."))) |
| 1854 | (when (vc-up-to-date-p file) |
| 1855 | (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file)) |
| 1856 | (error "Revert canceled")))) |
| 1857 | (when (vc-diff-internal vc-allow-async-revert vc-fileset nil nil) |
| 1858 | (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files))) |
| 1859 | (error "Revert canceled")) |
| 1860 | (delete-windows-on "*vc-diff*") |
| 1861 | (kill-buffer "*vc-diff*")) |
| 1862 | (dolist (file files) |
| 1863 | (message "Reverting %s..." (vc-delistify files)) |
| 1864 | (vc-revert-file file) |
| 1865 | (message "Reverting %s...done" (vc-delistify files))))) |
| 1866 | |
| 1867 | ;;;###autoload |
| 1868 | (defun vc-rollback () |
| 1869 | "Roll back (remove) the most recent changeset committed to the repository. |
| 1870 | This may be either a file-level or a repository-level operation, |
| 1871 | depending on the underlying version-control system." |
| 1872 | (interactive) |
| 1873 | (let* ((vc-fileset (vc-deduce-fileset)) |
| 1874 | (backend (car vc-fileset)) |
| 1875 | (files (cadr vc-fileset)) |
| 1876 | (granularity (vc-call-backend backend 'revision-granularity))) |
| 1877 | (unless (vc-find-backend-function backend 'rollback) |
| 1878 | (error "Rollback is not supported in %s" backend)) |
| 1879 | (when (and (not (eq granularity 'repository)) (/= (length files) 1)) |
| 1880 | (error "Rollback requires a singleton fileset or repository versioning")) |
| 1881 | ;; FIXME: latest-on-branch-p should take the fileset. |
| 1882 | (when (not (vc-call-backend backend 'latest-on-branch-p (car files))) |
| 1883 | (error "Rollback is only possible at the tip revision.")) |
| 1884 | ;; If any of the files is visited by the current buffer, make |
| 1885 | ;; sure buffer is saved. If the user says `no', abort since |
| 1886 | ;; we cannot show the changes and ask for confirmation to |
| 1887 | ;; discard them. |
| 1888 | (when (or (not files) (memq (buffer-file-name) files)) |
| 1889 | (vc-buffer-sync nil)) |
| 1890 | (dolist (file files) |
| 1891 | (when (buffer-modified-p (get-file-buffer file)) |
| 1892 | (error "Please kill or save all modified buffers before rollback.")) |
| 1893 | (when (not (vc-up-to-date-p file)) |
| 1894 | (error "Please revert all modified workfiles before rollback."))) |
| 1895 | ;; Accumulate changes associated with the fileset |
| 1896 | (vc-setup-buffer "*vc-diff*") |
| 1897 | (not-modified) |
| 1898 | (message "Finding changes...") |
| 1899 | (let* ((tip (vc-working-revision (car files))) |
| 1900 | ;; FIXME: `previous-revision' should take the fileset. |
| 1901 | (previous (vc-call-backend backend 'previous-revision |
| 1902 | (car files) tip))) |
| 1903 | (vc-diff-internal nil vc-fileset previous tip)) |
| 1904 | ;; Display changes |
| 1905 | (unless (yes-or-no-p "Discard these revisions? ") |
| 1906 | (error "Rollback canceled")) |
| 1907 | (delete-windows-on "*vc-diff*") |
| 1908 | (kill-buffer"*vc-diff*") |
| 1909 | ;; Do the actual reversions |
| 1910 | (message "Rolling back %s..." (vc-delistify files)) |
| 1911 | (with-vc-properties |
| 1912 | files |
| 1913 | (vc-call-backend backend 'rollback files) |
| 1914 | `((vc-state . ,'up-to-date) |
| 1915 | (vc-checkout-time . , (nth 5 (file-attributes file))) |
| 1916 | (vc-working-revision . nil))) |
| 1917 | (dolist (f files) (vc-resynch-buffer f t t)) |
| 1918 | (message "Rolling back %s...done" (vc-delistify files)))) |
| 1919 | |
| 1920 | ;;;###autoload |
| 1921 | (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1") |
| 1922 | |
| 1923 | ;;;###autoload |
| 1924 | (defun vc-update () |
| 1925 | "Update the current fileset's files to their tip revisions. |
| 1926 | For each one that contains no changes, and is not locked, then this simply |
| 1927 | replaces the work file with the latest revision on its branch. If the file |
| 1928 | contains changes, and the backend supports merging news, then any recent |
| 1929 | changes from the current branch are merged into the working file." |
| 1930 | (interactive) |
| 1931 | (let* ((vc-fileset (vc-deduce-fileset)) |
| 1932 | (backend (car vc-fileset)) |
| 1933 | (files (cadr vc-fileset))) |
| 1934 | (save-some-buffers ; save buffers visiting files |
| 1935 | nil (lambda () |
| 1936 | (and (buffer-modified-p) |
| 1937 | (let ((file (buffer-file-name))) |
| 1938 | (and file (member file files)))))) |
| 1939 | (dolist (file files) |
| 1940 | (if (vc-up-to-date-p file) |
| 1941 | (vc-checkout file nil t) |
| 1942 | (if (eq (vc-checkout-model backend (list file)) 'locking) |
| 1943 | (if (eq (vc-state file) 'edited) |
| 1944 | (error "%s" |
| 1945 | (substitute-command-keys |
| 1946 | "File is locked--type \\[vc-revert] to discard changes")) |
| 1947 | (error "Unexpected file state (%s) -- type %s" |
| 1948 | (vc-state file) |
| 1949 | (substitute-command-keys |
| 1950 | "\\[vc-next-action] to correct"))) |
| 1951 | (vc-maybe-resolve-conflicts |
| 1952 | file (vc-call-backend backend 'merge-news file))))))) |
| 1953 | |
| 1954 | (defun vc-version-backup-file (file &optional rev) |
| 1955 | "Return name of backup file for revision REV of FILE. |
| 1956 | If version backups should be used for FILE, and there exists |
| 1957 | such a backup for REV or the working revision of file, return |
| 1958 | its name; otherwise return nil." |
| 1959 | (when (vc-call make-version-backups-p file) |
| 1960 | (let ((backup-file (vc-version-backup-file-name file rev))) |
| 1961 | (if (file-exists-p backup-file) |
| 1962 | backup-file |
| 1963 | ;; there is no automatic backup, but maybe the user made one manually |
| 1964 | (setq backup-file (vc-version-backup-file-name file rev 'manual)) |
| 1965 | (when (file-exists-p backup-file) |
| 1966 | backup-file))))) |
| 1967 | |
| 1968 | (defun vc-revert-file (file) |
| 1969 | "Revert FILE back to the repository working revision it was based on." |
| 1970 | (with-vc-properties |
| 1971 | (list file) |
| 1972 | (let ((backup-file (vc-version-backup-file file))) |
| 1973 | (when backup-file |
| 1974 | (copy-file backup-file file 'ok-if-already-exists 'keep-date) |
| 1975 | (vc-delete-automatic-version-backups file)) |
| 1976 | (vc-call revert file backup-file)) |
| 1977 | `((vc-state . up-to-date) |
| 1978 | (vc-checkout-time . ,(nth 5 (file-attributes file))))) |
| 1979 | (vc-resynch-buffer file t t)) |
| 1980 | |
| 1981 | ;;;###autoload |
| 1982 | (defun vc-switch-backend (file backend) |
| 1983 | "Make BACKEND the current version control system for FILE. |
| 1984 | FILE must already be registered in BACKEND. The change is not |
| 1985 | permanent, only for the current session. This function only changes |
| 1986 | VC's perspective on FILE, it does not register or unregister it. |
| 1987 | By default, this command cycles through the registered backends. |
| 1988 | To get a prompt, use a prefix argument." |
| 1989 | (interactive |
| 1990 | (list |
| 1991 | (or buffer-file-name |
| 1992 | (error "There is no version-controlled file in this buffer")) |
| 1993 | (let ((crt-bk (vc-backend buffer-file-name)) |
| 1994 | (backends nil)) |
| 1995 | (unless crt-bk |
| 1996 | (error "File %s is not under version control" buffer-file-name)) |
| 1997 | ;; Find the registered backends. |
| 1998 | (dolist (crt vc-handled-backends) |
| 1999 | (when (and (vc-call-backend crt 'registered buffer-file-name) |
| 2000 | (not (eq crt-bk crt))) |
| 2001 | (push crt backends))) |
| 2002 | ;; Find the next backend. |
| 2003 | (let ((def (car backends)) |
| 2004 | (others backends)) |
| 2005 | (cond |
| 2006 | ((null others) (error "No other backend to switch to")) |
| 2007 | (current-prefix-arg |
| 2008 | (intern |
| 2009 | (upcase |
| 2010 | (completing-read |
| 2011 | (format "Switch to backend [%s]: " def) |
| 2012 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends) |
| 2013 | nil t nil nil (downcase (symbol-name def)))))) |
| 2014 | (t def)))))) |
| 2015 | (unless (eq backend (vc-backend file)) |
| 2016 | (vc-file-clearprops file) |
| 2017 | (vc-file-setprop file 'vc-backend backend) |
| 2018 | ;; Force recomputation of the state |
| 2019 | (unless (vc-call-backend backend 'registered file) |
| 2020 | (vc-file-clearprops file) |
| 2021 | (error "%s is not registered in %s" file backend)) |
| 2022 | (vc-mode-line file))) |
| 2023 | |
| 2024 | ;;;###autoload |
| 2025 | (defun vc-transfer-file (file new-backend) |
| 2026 | "Transfer FILE to another version control system NEW-BACKEND. |
| 2027 | If NEW-BACKEND has a higher precedence than FILE's current backend |
| 2028 | \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in |
| 2029 | NEW-BACKEND, using the revision number from the current backend as the |
| 2030 | base level. If NEW-BACKEND has a lower precedence than the current |
| 2031 | backend, then commit all changes that were made under the current |
| 2032 | backend to NEW-BACKEND, and unregister FILE from the current backend. |
| 2033 | \(If FILE is not yet registered under NEW-BACKEND, register it.)" |
| 2034 | (let* ((old-backend (vc-backend file)) |
| 2035 | (edited (memq (vc-state file) '(edited needs-merge))) |
| 2036 | (registered (vc-call-backend new-backend 'registered file)) |
| 2037 | (move |
| 2038 | (and registered ; Never move if not registered in new-backend yet. |
| 2039 | ;; move if new-backend comes later in vc-handled-backends |
| 2040 | (or (memq new-backend (memq old-backend vc-handled-backends)) |
| 2041 | (y-or-n-p "Final transfer? ")))) |
| 2042 | (comment nil)) |
| 2043 | (when (eq old-backend new-backend) |
| 2044 | (error "%s is the current backend of %s" new-backend file)) |
| 2045 | (if registered |
| 2046 | (set-file-modes file (logior (file-modes file) 128)) |
| 2047 | ;; `registered' might have switched under us. |
| 2048 | (vc-switch-backend file old-backend) |
| 2049 | (let* ((rev (vc-working-revision file)) |
| 2050 | (modified-file (and edited (make-temp-file file))) |
| 2051 | (unmodified-file (and modified-file (vc-version-backup-file file)))) |
| 2052 | ;; Go back to the base unmodified file. |
| 2053 | (unwind-protect |
| 2054 | (progn |
| 2055 | (when modified-file |
| 2056 | (copy-file file modified-file 'ok-if-already-exists) |
| 2057 | ;; If we have a local copy of the unmodified file, handle that |
| 2058 | ;; here and not in vc-revert-file because we don't want to |
| 2059 | ;; delete that copy -- it is still useful for OLD-BACKEND. |
| 2060 | (if unmodified-file |
| 2061 | (copy-file unmodified-file file |
| 2062 | 'ok-if-already-exists 'keep-date) |
| 2063 | (when (y-or-n-p "Get base revision from master? ") |
| 2064 | (vc-revert-file file)))) |
| 2065 | (vc-call-backend new-backend 'receive-file file rev)) |
| 2066 | (when modified-file |
| 2067 | (vc-switch-backend file new-backend) |
| 2068 | (unless (eq (vc-checkout-model new-backend (list file)) 'implicit) |
| 2069 | (vc-checkout file t nil)) |
| 2070 | (rename-file modified-file file 'ok-if-already-exists) |
| 2071 | (vc-file-setprop file 'vc-checkout-time nil))))) |
| 2072 | (when move |
| 2073 | (vc-switch-backend file old-backend) |
| 2074 | (setq comment (vc-call-backend old-backend 'comment-history file)) |
| 2075 | (vc-call-backend old-backend 'unregister file)) |
| 2076 | (vc-switch-backend file new-backend) |
| 2077 | (when (or move edited) |
| 2078 | (vc-file-setprop file 'vc-state 'edited) |
| 2079 | (vc-mode-line file) |
| 2080 | (vc-checkin file nil comment (stringp comment))))) |
| 2081 | |
| 2082 | (defun vc-rename-master (oldmaster newfile templates) |
| 2083 | "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES." |
| 2084 | (let* ((dir (file-name-directory (expand-file-name oldmaster))) |
| 2085 | (newdir (or (file-name-directory newfile) "")) |
| 2086 | (newbase (file-name-nondirectory newfile)) |
| 2087 | (masters |
| 2088 | ;; List of potential master files for `newfile' |
| 2089 | (mapcar |
| 2090 | (lambda (s) (vc-possible-master s newdir newbase)) |
| 2091 | templates))) |
| 2092 | (when (or (file-symlink-p oldmaster) |
| 2093 | (file-symlink-p (file-name-directory oldmaster))) |
| 2094 | (error "This is unsafe in the presence of symbolic links")) |
| 2095 | (rename-file |
| 2096 | oldmaster |
| 2097 | (catch 'found |
| 2098 | ;; If possible, keep the master file in the same directory. |
| 2099 | (dolist (f masters) |
| 2100 | (when (and f (string= (file-name-directory (expand-file-name f)) dir)) |
| 2101 | (throw 'found f))) |
| 2102 | ;; If not, just use the first possible place. |
| 2103 | (dolist (f masters) |
| 2104 | (and f (or (not (setq dir (file-name-directory f))) |
| 2105 | (file-directory-p dir)) |
| 2106 | (throw 'found f))) |
| 2107 | (error "New file lacks a version control directory"))))) |
| 2108 | |
| 2109 | (defun vc-delete-file (file) |
| 2110 | "Delete file and mark it as such in the version control system." |
| 2111 | (interactive "fVC delete file: ") |
| 2112 | (setq file (expand-file-name file)) |
| 2113 | (let ((buf (get-file-buffer file)) |
| 2114 | (backend (vc-backend file))) |
| 2115 | (unless backend |
| 2116 | (error "File %s is not under version control" |
| 2117 | (file-name-nondirectory file))) |
| 2118 | (unless (vc-find-backend-function backend 'delete-file) |
| 2119 | (error "Deleting files under %s is not supported in VC" backend)) |
| 2120 | (when (and buf (buffer-modified-p buf)) |
| 2121 | (error "Please save or undo your changes before deleting %s" file)) |
| 2122 | (let ((state (vc-state file))) |
| 2123 | (when (eq state 'edited) |
| 2124 | (error "Please commit or undo your changes before deleting %s" file)) |
| 2125 | (when (eq state 'conflict) |
| 2126 | (error "Please resolve the conflicts before deleting %s" file))) |
| 2127 | (unless (y-or-n-p (format "Really want to delete %s? " |
| 2128 | (file-name-nondirectory file))) |
| 2129 | (error "Abort!")) |
| 2130 | (unless (or (file-directory-p file) (null make-backup-files) |
| 2131 | (not (file-exists-p file))) |
| 2132 | (with-current-buffer (or buf (find-file-noselect file)) |
| 2133 | (let ((backup-inhibited nil)) |
| 2134 | (backup-buffer)))) |
| 2135 | ;; Bind `default-directory' so that the command that the backend |
| 2136 | ;; runs to remove the file is invoked in the correct context. |
| 2137 | (let ((default-directory (file-name-directory file))) |
| 2138 | (vc-call-backend backend 'delete-file file)) |
| 2139 | ;; If the backend hasn't deleted the file itself, let's do it for him. |
| 2140 | (when (file-exists-p file) (delete-file file)) |
| 2141 | ;; Forget what VC knew about the file. |
| 2142 | (vc-file-clearprops file) |
| 2143 | ;; Make sure the buffer is deleted and the *vc-dir* buffers are |
| 2144 | ;; updated after this. |
| 2145 | (vc-resynch-buffer file nil t))) |
| 2146 | |
| 2147 | ;;;###autoload |
| 2148 | (defun vc-rename-file (old new) |
| 2149 | "Rename file OLD to NEW, and rename its master file likewise." |
| 2150 | (interactive "fVC rename file: \nFRename to: ") |
| 2151 | ;; in CL I would have said (setq new (merge-pathnames new old)) |
| 2152 | (let ((old-base (file-name-nondirectory old))) |
| 2153 | (when (and (not (string= "" old-base)) |
| 2154 | (string= "" (file-name-nondirectory new))) |
| 2155 | (setq new (concat new old-base)))) |
| 2156 | (let ((oldbuf (get-file-buffer old))) |
| 2157 | (when (and oldbuf (buffer-modified-p oldbuf)) |
| 2158 | (error "Please save files before moving them")) |
| 2159 | (when (get-file-buffer new) |
| 2160 | (error "Already editing new file name")) |
| 2161 | (when (file-exists-p new) |
| 2162 | (error "New file already exists")) |
| 2163 | (let ((state (vc-state old))) |
| 2164 | (unless (memq state '(up-to-date edited)) |
| 2165 | (error "Please %s files before moving them" |
| 2166 | (if (stringp state) "check in" "update")))) |
| 2167 | (vc-call rename-file old new) |
| 2168 | (vc-file-clearprops old) |
| 2169 | ;; Move the actual file (unless the backend did it already) |
| 2170 | (when (file-exists-p old) (rename-file old new)) |
| 2171 | ;; ?? Renaming a file might change its contents due to keyword expansion. |
| 2172 | ;; We should really check out a new copy if the old copy was precisely equal |
| 2173 | ;; to some checked-in revision. However, testing for this is tricky.... |
| 2174 | (when oldbuf |
| 2175 | (with-current-buffer oldbuf |
| 2176 | (let ((buffer-read-only buffer-read-only)) |
| 2177 | (set-visited-file-name new)) |
| 2178 | (vc-backend new) |
| 2179 | (vc-mode-line new) |
| 2180 | (set-buffer-modified-p nil))))) |
| 2181 | |
| 2182 | ;;;###autoload |
| 2183 | (defun vc-update-change-log (&rest args) |
| 2184 | "Find change log file and add entries from recent version control logs. |
| 2185 | Normally, find log entries for all registered files in the default |
| 2186 | directory. |
| 2187 | |
| 2188 | With prefix arg of \\[universal-argument], only find log entries for the current buffer's file. |
| 2189 | |
| 2190 | With any numeric prefix arg, find log entries for all currently visited |
| 2191 | files that are under version control. This puts all the entries in the |
| 2192 | log for the default directory, which may not be appropriate. |
| 2193 | |
| 2194 | From a program, any ARGS are assumed to be filenames for which |
| 2195 | log entries should be gathered." |
| 2196 | (interactive |
| 2197 | (cond ((consp current-prefix-arg) ;C-u |
| 2198 | (list buffer-file-name)) |
| 2199 | (current-prefix-arg ;Numeric argument. |
| 2200 | (let ((files nil) |
| 2201 | (buffers (buffer-list)) |
| 2202 | file) |
| 2203 | (while buffers |
| 2204 | (setq file (buffer-file-name (car buffers))) |
| 2205 | (and file (vc-backend file) |
| 2206 | (setq files (cons file files))) |
| 2207 | (setq buffers (cdr buffers))) |
| 2208 | files)) |
| 2209 | (t |
| 2210 | ;; Don't supply any filenames to backend; this means |
| 2211 | ;; it should find all relevant files relative to |
| 2212 | ;; the default-directory. |
| 2213 | nil))) |
| 2214 | (vc-call-backend (vc-responsible-backend default-directory) |
| 2215 | 'update-changelog args)) |
| 2216 | |
| 2217 | ;;; The default back end. Assumes RCS-like revision numbering. |
| 2218 | |
| 2219 | (defun vc-default-revision-granularity () |
| 2220 | (error "Your backend will not work with this version of VC mode.")) |
| 2221 | |
| 2222 | ;; functions that operate on RCS revision numbers. This code should |
| 2223 | ;; also be moved into the backends. It stays for now, however, since |
| 2224 | ;; it is used in code below. |
| 2225 | ;;;###autoload |
| 2226 | (defun vc-trunk-p (rev) |
| 2227 | "Return t if REV is a revision on the trunk." |
| 2228 | (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev)))) |
| 2229 | |
| 2230 | (defun vc-branch-p (rev) |
| 2231 | "Return t if REV is a branch revision." |
| 2232 | (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev)))) |
| 2233 | |
| 2234 | ;;;###autoload |
| 2235 | (defun vc-branch-part (rev) |
| 2236 | "Return the branch part of a revision number REV." |
| 2237 | (let ((index (string-match "\\.[0-9]+\\'" rev))) |
| 2238 | (when index |
| 2239 | (substring rev 0 index)))) |
| 2240 | |
| 2241 | (defun vc-minor-part (rev) |
| 2242 | "Return the minor revision number of a revision number REV." |
| 2243 | (string-match "[0-9]+\\'" rev) |
| 2244 | (substring rev (match-beginning 0) (match-end 0))) |
| 2245 | |
| 2246 | (define-obsolete-function-alias |
| 2247 | 'vc-default-previous-version 'vc-default-previous-revision "23.1") |
| 2248 | |
| 2249 | (defun vc-default-previous-revision (backend file rev) |
| 2250 | "Return the revision number immediately preceding REV for FILE, |
| 2251 | or nil if there is no previous revision. This default |
| 2252 | implementation works for MAJOR.MINOR-style revision numbers as |
| 2253 | used by RCS and CVS." |
| 2254 | (let ((branch (vc-branch-part rev)) |
| 2255 | (minor-num (string-to-number (vc-minor-part rev)))) |
| 2256 | (when branch |
| 2257 | (if (> minor-num 1) |
| 2258 | ;; revision does probably not start a branch or release |
| 2259 | (concat branch "." (number-to-string (1- minor-num))) |
| 2260 | (if (vc-trunk-p rev) |
| 2261 | ;; we are at the beginning of the trunk -- |
| 2262 | ;; don't know anything to return here |
| 2263 | nil |
| 2264 | ;; we are at the beginning of a branch -- |
| 2265 | ;; return revision of starting point |
| 2266 | (vc-branch-part branch)))))) |
| 2267 | |
| 2268 | (defun vc-default-next-revision (backend file rev) |
| 2269 | "Return the revision number immediately following REV for FILE, |
| 2270 | or nil if there is no next revision. This default implementation |
| 2271 | works for MAJOR.MINOR-style revision numbers as used by RCS |
| 2272 | and CVS." |
| 2273 | (when (not (string= rev (vc-working-revision file))) |
| 2274 | (let ((branch (vc-branch-part rev)) |
| 2275 | (minor-num (string-to-number (vc-minor-part rev)))) |
| 2276 | (concat branch "." (number-to-string (1+ minor-num)))))) |
| 2277 | |
| 2278 | (defun vc-default-responsible-p (backend file) |
| 2279 | "Indicate whether BACKEND is reponsible for FILE. |
| 2280 | The default is to return nil always." |
| 2281 | nil) |
| 2282 | |
| 2283 | (defun vc-default-could-register (backend file) |
| 2284 | "Return non-nil if BACKEND could be used to register FILE. |
| 2285 | The default implementation returns t for all files." |
| 2286 | t) |
| 2287 | |
| 2288 | (defun vc-default-latest-on-branch-p (backend file) |
| 2289 | "Return non-nil if FILE is the latest on its branch. |
| 2290 | This default implementation always returns non-nil, which means that |
| 2291 | editing non-current revisions is not supported by default." |
| 2292 | t) |
| 2293 | |
| 2294 | (defun vc-default-init-revision (backend) vc-default-init-revision) |
| 2295 | |
| 2296 | (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log) |
| 2297 | |
| 2298 | (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log) |
| 2299 | |
| 2300 | ;; FIXME: This should probably be moved to vc-rcs.el and replaced in |
| 2301 | ;; vc-cvs.el by code using cvs2cl. |
| 2302 | (defun vc-update-changelog-rcs2log (files) |
| 2303 | "Default implementation of update-changelog. |
| 2304 | Uses `rcs2log' which only works for RCS and CVS." |
| 2305 | ;; FIXME: We (c|sh)ould add support for cvs2cl |
| 2306 | (let ((odefault default-directory) |
| 2307 | (changelog (find-change-log)) |
| 2308 | ;; Presumably not portable to non-Unixy systems, along with rcs2log: |
| 2309 | (tempfile (make-temp-file |
| 2310 | (expand-file-name "vc" |
| 2311 | (or small-temporary-file-directory |
| 2312 | temporary-file-directory)))) |
| 2313 | (login-name (or user-login-name |
| 2314 | (format "uid%d" (number-to-string (user-uid))))) |
| 2315 | (full-name (or add-log-full-name |
| 2316 | (user-full-name) |
| 2317 | (user-login-name) |
| 2318 | (format "uid%d" (number-to-string (user-uid))))) |
| 2319 | (mailing-address (or add-log-mailing-address |
| 2320 | user-mail-address))) |
| 2321 | (find-file-other-window changelog) |
| 2322 | (barf-if-buffer-read-only) |
| 2323 | (vc-buffer-sync) |
| 2324 | (undo-boundary) |
| 2325 | (goto-char (point-min)) |
| 2326 | (push-mark) |
| 2327 | (message "Computing change log entries...") |
| 2328 | (message "Computing change log entries... %s" |
| 2329 | (unwind-protect |
| 2330 | (progn |
| 2331 | (setq default-directory odefault) |
| 2332 | (if (eq 0 (apply 'call-process |
| 2333 | (expand-file-name "rcs2log" |
| 2334 | exec-directory) |
| 2335 | nil (list t tempfile) nil |
| 2336 | "-c" changelog |
| 2337 | "-u" (concat login-name |
| 2338 | "\t" full-name |
| 2339 | "\t" mailing-address) |
| 2340 | (mapcar |
| 2341 | (lambda (f) |
| 2342 | (file-relative-name |
| 2343 | (expand-file-name f odefault))) |
| 2344 | files))) |
| 2345 | "done" |
| 2346 | (pop-to-buffer (get-buffer-create "*vc*")) |
| 2347 | (erase-buffer) |
| 2348 | (insert-file-contents tempfile) |
| 2349 | "failed")) |
| 2350 | (setq default-directory (file-name-directory changelog)) |
| 2351 | (delete-file tempfile))))) |
| 2352 | |
| 2353 | (defun vc-default-find-revision (backend file rev buffer) |
| 2354 | "Provide the new `find-revision' op based on the old `checkout' op. |
| 2355 | This is only for compatibility with old backends. They should be updated |
| 2356 | to provide the `find-revision' operation instead." |
| 2357 | (let ((tmpfile (make-temp-file (expand-file-name file)))) |
| 2358 | (unwind-protect |
| 2359 | (progn |
| 2360 | (vc-call-backend backend 'checkout file nil rev tmpfile) |
| 2361 | (with-current-buffer buffer |
| 2362 | (insert-file-contents-literally tmpfile))) |
| 2363 | (delete-file tmpfile)))) |
| 2364 | |
| 2365 | (defun vc-default-prettify-state-info (backend file) |
| 2366 | (let* ((state (vc-state file)) |
| 2367 | (statestring |
| 2368 | (cond |
| 2369 | ((stringp state) (concat "(locked:" state ")")) |
| 2370 | ((eq state 'edited) "(modified)") |
| 2371 | ((eq state 'needs-merge) "(merge)") |
| 2372 | ((eq state 'needs-update) "(update)") |
| 2373 | ((eq state 'added) "(added)") |
| 2374 | ((eq state 'removed) "(removed)") |
| 2375 | ((eq state 'ignored) "(ignored)") |
| 2376 | ((eq state 'unregistered) "(unregistered)") |
| 2377 | ((eq state 'unlocked-changes) "(stale)") |
| 2378 | (t (format "(unknown:%s)" state)))) |
| 2379 | (buffer |
| 2380 | (get-file-buffer file)) |
| 2381 | (modflag |
| 2382 | (if (and buffer (buffer-modified-p buffer)) "+" ""))) |
| 2383 | (concat statestring modflag))) |
| 2384 | |
| 2385 | (defun vc-default-rename-file (backend old new) |
| 2386 | (condition-case nil |
| 2387 | (add-name-to-file old new) |
| 2388 | (error (rename-file old new))) |
| 2389 | (vc-delete-file old) |
| 2390 | (with-current-buffer (find-file-noselect new) |
| 2391 | (vc-register))) |
| 2392 | |
| 2393 | (defalias 'vc-default-check-headers 'ignore) |
| 2394 | |
| 2395 | (defun vc-default-log-view-mode (backend) (log-view-mode)) |
| 2396 | |
| 2397 | (defun vc-default-show-log-entry (backend rev) |
| 2398 | (with-no-warnings |
| 2399 | (log-view-goto-rev rev))) |
| 2400 | |
| 2401 | (defun vc-default-comment-history (backend file) |
| 2402 | "Return a string with all log entries stored in BACKEND for FILE." |
| 2403 | (when (vc-find-backend-function backend 'print-log) |
| 2404 | (with-current-buffer "*vc*" |
| 2405 | (vc-call-backend backend 'print-log (list file)) |
| 2406 | (buffer-string)))) |
| 2407 | |
| 2408 | (defun vc-default-receive-file (backend file rev) |
| 2409 | "Let BACKEND receive FILE from another version control system." |
| 2410 | (vc-call-backend backend 'register file rev "")) |
| 2411 | |
| 2412 | (defun vc-default-retrieve-tag (backend dir name update) |
| 2413 | (if (string= name "") |
| 2414 | (progn |
| 2415 | (vc-file-tree-walk |
| 2416 | dir |
| 2417 | (lambda (f) (and |
| 2418 | (vc-up-to-date-p f) |
| 2419 | (vc-error-occurred |
| 2420 | (vc-call-backend backend 'checkout f nil "") |
| 2421 | (when update (vc-resynch-buffer f t t))))))) |
| 2422 | (let ((result (vc-tag-precondition dir))) |
| 2423 | (if (stringp result) |
| 2424 | (error "File %s is locked" result) |
| 2425 | (setq update (and (eq result 'visited) update)) |
| 2426 | (vc-file-tree-walk |
| 2427 | dir |
| 2428 | (lambda (f) (vc-error-occurred |
| 2429 | (vc-call-backend backend 'checkout f nil name) |
| 2430 | (when update (vc-resynch-buffer f t t))))))))) |
| 2431 | |
| 2432 | (defun vc-default-revert (backend file contents-done) |
| 2433 | (unless contents-done |
| 2434 | (let ((rev (vc-working-revision file)) |
| 2435 | (file-buffer (or (get-file-buffer file) (current-buffer)))) |
| 2436 | (message "Checking out %s..." file) |
| 2437 | (let ((failed t) |
| 2438 | (backup-name (car (find-backup-file-name file)))) |
| 2439 | (when backup-name |
| 2440 | (copy-file file backup-name 'ok-if-already-exists 'keep-date) |
| 2441 | (unless (file-writable-p file) |
| 2442 | (set-file-modes file (logior (file-modes file) 128)))) |
| 2443 | (unwind-protect |
| 2444 | (let ((coding-system-for-read 'no-conversion) |
| 2445 | (coding-system-for-write 'no-conversion)) |
| 2446 | (with-temp-file file |
| 2447 | (let ((outbuf (current-buffer))) |
| 2448 | ;; Change buffer to get local value of vc-checkout-switches. |
| 2449 | (with-current-buffer file-buffer |
| 2450 | (let ((default-directory (file-name-directory file))) |
| 2451 | (vc-call-backend backend 'find-revision |
| 2452 | file rev outbuf))))) |
| 2453 | (setq failed nil)) |
| 2454 | (when backup-name |
| 2455 | (if failed |
| 2456 | (rename-file backup-name file 'ok-if-already-exists) |
| 2457 | (and (not vc-make-backup-files) (delete-file backup-name)))))) |
| 2458 | (message "Checking out %s...done" file)))) |
| 2459 | |
| 2460 | (defalias 'vc-default-revision-completion-table 'ignore) |
| 2461 | |
| 2462 | (defun vc-default-dir-status-files (backend dir files default-state update-function) |
| 2463 | (funcall update-function |
| 2464 | (mapcar (lambda (file) (list file default-state)) files))) |
| 2465 | |
| 2466 | (defun vc-check-headers () |
| 2467 | "Check if the current file has any headers in it." |
| 2468 | (interactive) |
| 2469 | (vc-call-backend (vc-backend buffer-file-name) 'check-headers)) |
| 2470 | |
| 2471 | \f |
| 2472 | |
| 2473 | ;; These things should probably be generally available |
| 2474 | |
| 2475 | (defun vc-string-prefix-p (prefix string) |
| 2476 | (let ((lpref (length prefix))) |
| 2477 | (and (>= (length string) lpref) |
| 2478 | (eq t (compare-strings prefix nil nil string nil lpref))))) |
| 2479 | |
| 2480 | (defun vc-file-tree-walk (dirname func &rest args) |
| 2481 | "Walk recursively through DIRNAME. |
| 2482 | Invoke FUNC f ARGS on each VC-managed file f underneath it." |
| 2483 | (vc-file-tree-walk-internal (expand-file-name dirname) func args) |
| 2484 | (message "Traversing directory %s...done" dirname)) |
| 2485 | |
| 2486 | (defun vc-file-tree-walk-internal (file func args) |
| 2487 | (if (not (file-directory-p file)) |
| 2488 | (when (vc-backend file) (apply func file args)) |
| 2489 | (message "Traversing directory %s..." (abbreviate-file-name file)) |
| 2490 | (let ((dir (file-name-as-directory file))) |
| 2491 | (mapcar |
| 2492 | (lambda (f) (or |
| 2493 | (string-equal f ".") |
| 2494 | (string-equal f "..") |
| 2495 | (member f vc-directory-exclusion-list) |
| 2496 | (let ((dirf (expand-file-name f dir))) |
| 2497 | (or |
| 2498 | (file-symlink-p dirf) ;; Avoid possible loops. |
| 2499 | (vc-file-tree-walk-internal dirf func args))))) |
| 2500 | (directory-files dir))))) |
| 2501 | |
| 2502 | (provide 'vc) |
| 2503 | |
| 2504 | ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6 |
| 2505 | ;;; vc.el ends here |