vc-bzr.el 29.7 KB
Newer Older
Stefan Monnier's avatar
Stefan Monnier committed
1 2
;;; vc-bzr.el --- VC backend for the bzr revision control system

3
;; Copyright (C) 2006, 2007, 2008  Free Software Foundation, Inc.
Stefan Monnier's avatar
Stefan Monnier committed
4 5 6 7

;; Author: Dave Love <fx@gnu.org>, Riccardo Murri <riccardo.murri@gmail.com>
;; Keywords: tools
;; Created: Sept 2006
8
;; Version: 2008-01-04 (Bzr revno 25)
Stefan Monnier's avatar
Stefan Monnier committed
9 10
;; URL: http://launchpad.net/vc-bzr

11 12 13
;; This file is part of GNU Emacs.

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

18
;; GNU Emacs is distributed in the hope that it will be useful,
Stefan Monnier's avatar
Stefan Monnier committed
19 20 21 22 23
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Stefan Monnier's avatar
Stefan Monnier committed
25 26 27

;;; Commentary:

28 29 30
;; See <URL:http://bazaar-vcs.org/> concerning bzr.  See
;; <URL:http://launchpad.net/vc-bzr> for alternate development
;; branches of `vc-bzr'.
Stefan Monnier's avatar
Stefan Monnier committed
31

32
;; Load this library to register bzr support in VC.
33 34 35 36 37 38 39

;; Known bugs
;; ==========

;; When edititing a symlink and *both* the symlink and its target
;; are bzr-versioned, `vc-bzr` presently runs `bzr status` on the
;; symlink, thereby not detecting whether the actual contents
40
;; (that is, the target contents) are changed.
41 42 43 44
;; See https://bugs.launchpad.net/vc-bzr/+bug/116607

;; For an up-to-date list of bugs, please see:
;;   https://bugs.launchpad.net/vc-bzr/+bugs
Stefan Monnier's avatar
Stefan Monnier committed
45

46 47 48 49
;;; Properties of the backend

(defun vc-bzr-revision-granularity () 'repository)
(defun vc-bzr-checkout-model (files) 'implicit)
Stefan Monnier's avatar
Stefan Monnier committed
50 51 52 53

;;; Code:

(eval-when-compile
54
  (require 'cl)
55 56
  (require 'vc)  ;; for vc-exec-after
  (require 'vc-dir))
Stefan Monnier's avatar
Stefan Monnier committed
57

58 59
;; Clear up the cache to force vc-call to check again and discover
;; new functions when we reload this file.
60
(put 'Bzr 'vc-functions nil)
61

Stefan Monnier's avatar
Stefan Monnier committed
62 63
(defgroup vc-bzr nil
  "VC bzr backend."
64
  :version "22.2"
Stefan Monnier's avatar
Stefan Monnier committed
65 66 67
  :group 'vc)

(defcustom vc-bzr-program "bzr"
68
  "Name of the bzr command (excluding any arguments)."
Stefan Monnier's avatar
Stefan Monnier committed
69 70 71 72
  :group 'vc-bzr
  :type 'string)

(defcustom vc-bzr-diff-switches nil
73
  "String/list of strings specifying extra switches for bzr diff under VC."
Stefan Monnier's avatar
Stefan Monnier committed
74 75 76 77 78
  :type '(choice (const :tag "None" nil)
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

79 80 81 82 83 84 85
(defcustom vc-bzr-log-switches nil
  "String/list of strings specifying extra switches for `bzr log' under VC."
  :type '(choice (const :tag "None" nil)
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

86 87
;; since v0.9, bzr supports removing the progress indicators
;; by setting environment variable BZR_PROGRESS_BAR to "none".
88
(defun vc-bzr-command (bzr-command buffer okstatus file-or-list &rest args)
89
  "Wrapper round `vc-do-command' using `vc-bzr-program' as COMMAND.
90 91
Invoke the bzr command adding `BZR_PROGRESS_BAR=none' and
`LC_MESSAGES=C' to the environment."
92 93
  (let ((process-environment
         (list* "BZR_PROGRESS_BAR=none" ; Suppress progress output (bzr >=0.9)
94
                "LC_MESSAGES=C"         ; Force English output
95
                process-environment)))
96
    (apply 'vc-do-command (or buffer "*vc*") okstatus vc-bzr-program
97
           file-or-list bzr-command args)))
Stefan Monnier's avatar
Stefan Monnier committed
98

99 100

;;;###autoload
101
(defconst vc-bzr-admin-dirname ".bzr"
102
  "Name of the directory containing Bzr repository status files.")
103
;;;###autoload
104 105
(defconst vc-bzr-admin-checkout-format-file
  (concat vc-bzr-admin-dirname "/checkout/format"))
106
(defconst vc-bzr-admin-dirstate
107 108 109
  (concat vc-bzr-admin-dirname "/checkout/dirstate"))
(defconst vc-bzr-admin-branch-format-file
  (concat vc-bzr-admin-dirname "/branch/format"))
110
(defconst vc-bzr-admin-revhistory
111
  (concat vc-bzr-admin-dirname "/branch/revision-history"))
112 113
(defconst vc-bzr-admin-lastrev
  (concat vc-bzr-admin-dirname "/branch/last-revision"))
114 115

;;;###autoload (defun vc-bzr-registered (file)
116
;;;###autoload   (if (vc-find-root file vc-bzr-admin-checkout-format-file)
117 118 119
;;;###autoload       (progn
;;;###autoload         (load "vc-bzr")
;;;###autoload         (vc-bzr-registered file))))
Stefan Monnier's avatar
Stefan Monnier committed
120

121 122 123 124
(defun vc-bzr-root (file)
  "Return the root directory of the bzr repository containing FILE."
  ;; Cache technique copied from vc-arch.el.
  (or (vc-file-getprop file 'bzr-root)
125 126
      (let ((root (vc-find-root file vc-bzr-admin-checkout-format-file)))
	(when root (vc-file-setprop file 'bzr-root root)))))
Stefan Monnier's avatar
Stefan Monnier committed
127

Stefan Monnier's avatar
Stefan Monnier committed
128
(require 'sha1)                         ;For sha1-program
129

Stefan Monnier's avatar
Stefan Monnier committed
130 131 132 133 134 135 136 137
(defun vc-bzr-sha1 (file)
  (with-temp-buffer
    (set-buffer-multibyte nil)
    (let ((prog sha1-program)
          (args nil))
      (when (consp prog)
	(setq args (cdr prog))
        (setq prog (car prog)))
138
      (apply 'process-file prog (file-relative-name file) t nil args)
Stefan Monnier's avatar
Stefan Monnier committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152
      (buffer-substring (point-min) (+ (point-min) 40)))))

(defun vc-bzr-state-heuristic (file)
  "Like `vc-bzr-state' but hopefully without running Bzr."
  ;; `bzr status' is excrutiatingly slow with large histories and
  ;; pending merges, so try to avoid using it until they fix their
  ;; performance problems.
  ;; This function tries first to parse Bzr internal file
  ;; `checkout/dirstate', but it may fail if Bzr internal file format
  ;; has changed.  As a safeguard, the `checkout/dirstate' file is
  ;; only parsed if it contains the string `#bazaar dirstate flat
  ;; format 3' in the first line.
  ;; If the `checkout/dirstate' file cannot be parsed, fall back to
  ;; running `vc-bzr-state'."
153 154 155 156 157 158 159 160 161 162 163 164 165 166
  (lexical-let ((root (vc-bzr-root file)))
    (when root    ; Short cut.
      ;; This looks at internal files.  May break if they change
      ;; their format.
      (lexical-let ((dirstate (expand-file-name vc-bzr-admin-dirstate root)))
        (if (not (file-readable-p dirstate))
            (vc-bzr-state file)         ; Expensive.
          (with-temp-buffer
            (insert-file-contents dirstate)
            (goto-char (point-min))
            (if (not (looking-at "#bazaar dirstate flat format 3"))
                (vc-bzr-state file)     ; Some other unknown format?
              (let* ((relfile (file-relative-name file root))
                     (reldir (file-name-directory relfile)))
Stefan Monnier's avatar
Stefan Monnier committed
167 168 169 170 171 172 173
                (if (re-search-forward
                     (concat "^\0"
                             (if reldir (regexp-quote
                                         (directory-file-name reldir)))
                             "\0"
                             (regexp-quote (file-name-nondirectory relfile))
                             "\0"
174 175 176 177 178 179 180 181 182 183 184 185 186
                             "[^\0]*\0"       ;id?
                             "\\([^\0]*\\)\0" ;"a/f/d", a=removed?
                             "[^\0]*\0"       ;sha1 (empty if conflicted)?
                             "\\([^\0]*\\)\0" ;size?
                             "[^\0]*\0"       ;"y/n", executable?
                             "[^\0]*\0"       ;?
                             "\\([^\0]*\\)\0" ;"a/f/d" a=added?
                             "\\([^\0]*\\)\0" ;sha1 again?
                             "[^\0]*\0"       ;size again?
                             "[^\0]*\0"       ;"y/n", executable again?
                             "[^\0]*\0"       ;last revid?
                             ;; There are more fields when merges are pending.
                             )
Stefan Monnier's avatar
Stefan Monnier committed
187
                     nil t)
188 189 190 191
                    ;; Apparently the second sha1 is the one we want: when
                    ;; there's a conflict, the first sha1 is absent (and the
                    ;; first size seems to correspond to the file with
                    ;; conflict markers).
Stefan Monnier's avatar
Stefan Monnier committed
192
                    (cond
193
                     ((eq (char-after (match-beginning 1)) ?a) 'removed)
Stefan Monnier's avatar
Stefan Monnier committed
194
                     ((eq (char-after (match-beginning 3)) ?a) 'added)
195
                     ((and (eq (string-to-number (match-string 2))
Stefan Monnier's avatar
Stefan Monnier committed
196
                               (nth 7 (file-attributes file)))
197
                           (equal (match-string 4)
Stefan Monnier's avatar
Stefan Monnier committed
198 199 200 201 202 203 204 205 206
                                  (vc-bzr-sha1 file)))
                      'up-to-date)
                     (t 'edited))
                  'unregistered)))))))))

(defun vc-bzr-registered (file)
  "Return non-nil if FILE is registered with bzr."
  (let ((state (vc-bzr-state-heuristic file)))
    (not (memq state '(nil unregistered ignored)))))
207 208

(defconst vc-bzr-state-words
209
  "added\\|ignored\\|kind changed\\|modified\\|removed\\|renamed\\|unknown"
210 211
  "Regexp matching file status words as reported in `bzr' output.")

212 213 214 215
(defun vc-bzr-file-name-relative (filename)
  "Return file name FILENAME stripped of the initial Bzr repository path."
  (lexical-let*
      ((filename* (expand-file-name filename))
216
       (rootdir (vc-bzr-root filename*)))
217
    (when rootdir
218 219
         (file-relative-name filename* rootdir))))

220 221 222
(defun vc-bzr-status (file)
  "Return FILE status according to Bzr.
Return value is a cons (STATUS . WARNING), where WARNING is a
223 224
string or nil, and STATUS is one of the symbols: `added',
`ignored', `kindchanged', `modified', `removed', `renamed', `unknown',
225 226 227 228 229 230
which directly correspond to `bzr status' output, or 'unchanged
for files whose copy in the working tree is identical to the one
in the branch repository, or nil for files that are not
registered with Bzr.

If any error occurred in running `bzr status', then return nil."
231
  (with-temp-buffer
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
    (let ((ret (condition-case nil
                   (vc-bzr-command "status" t 0 file)
                 (file-error nil)))     ; vc-bzr-program not found.
          (status 'unchanged))
          ;; the only secure status indication in `bzr status' output
          ;; is a couple of lines following the pattern::
          ;;   | <status>:
          ;;   |   <file name>
          ;; if the file is up-to-date, we get no status report from `bzr',
          ;; so if the regexp search for the above pattern fails, we consider
          ;; the file to be up-to-date.
          (goto-char (point-min))
          (when (re-search-forward
                 ;; bzr prints paths relative to the repository root.
                 (concat "^\\(" vc-bzr-state-words "\\):[ \t\n]+"
                         (regexp-quote (vc-bzr-file-name-relative file))
248 249 250
                         ;; Bzr appends a '/' to directory names and
                         ;; '*' to executable files
                         (if (file-directory-p file) "/?" "\\*?")
251 252
                         "[ \t\n]*$")
                 nil t)
253
            (lexical-let ((statusword (match-string 1)))
254 255
              ;; Erase the status text that matched.
              (delete-region (match-beginning 0) (match-end 0))
256
              (setq status
257
                    (intern (replace-regexp-in-string " " "" statusword)))))
258 259 260 261 262 263 264 265 266 267 268 269
          (when status
            (goto-char (point-min))
            (skip-chars-forward " \n\t") ;Throw away spaces.
            (cons status
                  ;; "bzr" will output warnings and informational messages to
                  ;; stderr; due to Emacs' `vc-do-command' (and, it seems,
                  ;; `start-process' itself) limitations, we cannot catch stderr
                  ;; and stdout into different buffers.  So, if there's anything
                  ;; left in the buffer after removing the above status
                  ;; keywords, let us just presume that any other message from
                  ;; "bzr" is a user warning, and display it.
                  (unless (eobp) (buffer-substring (point) (point-max))))))))
270

271 272 273
(defun vc-bzr-state (file)
  (lexical-let ((result (vc-bzr-status file)))
    (when (consp result)
274 275
      (when (cdr result)
	(message "Warnings in `bzr' output: %s" (cdr result)))
276
      (cdr (assq (car result)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
277
                 '((added . added)
278
                   (kindchanged . edited)
279 280
                   (renamed . edited)
                   (modified . edited)
281
                   (removed . removed)
282
                   (ignored . ignored)
283
                   (unknown . unregistered)
284
                   (unchanged . up-to-date)))))))
Stefan Monnier's avatar
Stefan Monnier committed
285

286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
(defun vc-bzr-resolve-when-done ()
  "Call \"bzr resolve\" if the conflict markers have been removed."
  (save-excursion
    (goto-char (point-min))
    (unless (re-search-forward "^<<<<<<< " nil t)
      (vc-bzr-command "resolve" nil 0 buffer-file-name)
      ;; Remove the hook so that it is not called multiple times.
      (remove-hook 'after-save-hook 'vc-bzr-resolve-when-done t))))

(defun vc-bzr-find-file-hook ()
  (when (and buffer-file-name
             ;; FIXME: We should check that "bzr status" says "conflict".
             (file-exists-p (concat buffer-file-name ".BASE"))
             (file-exists-p (concat buffer-file-name ".OTHER"))
             (file-exists-p (concat buffer-file-name ".THIS"))
             ;; If "bzr status" says there's a conflict but there are no
             ;; conflict markers, it's not clear what we should do.
             (save-excursion
               (goto-char (point-min))
               (re-search-forward "^<<<<<<< " nil t)))
    ;; TODO: the merge algorithm used in `bzr merge' is nicely configurable,
    ;; but the one in `bzr pull' isn't, so it would be good to provide an
    ;; elisp function to remerge from the .BASE/OTHER/THIS files.
    (smerge-start-session)
    (add-hook 'after-save-hook 'vc-bzr-resolve-when-done nil t)
    (message "There are unresolved conflicts in this file")))

Stefan Monnier's avatar
Stefan Monnier committed
313
(defun vc-bzr-workfile-unchanged-p (file)
314
  (eq 'unchanged (car (vc-bzr-status file))))
Stefan Monnier's avatar
Stefan Monnier committed
315

Eric S. Raymond's avatar
Eric S. Raymond committed
316
(defun vc-bzr-working-revision (file)
Stefan Monnier's avatar
Stefan Monnier committed
317 318
  ;; Together with the code in vc-state-heuristic, this makes it possible
  ;; to get the initial VC state of a Bzr file even if Bzr is not installed.
319 320
  (lexical-let*
      ((rootdir (vc-bzr-root file))
321 322 323 324 325 326
       (branch-format-file (expand-file-name vc-bzr-admin-branch-format-file
                                             rootdir))
       (revhistory-file (expand-file-name vc-bzr-admin-revhistory rootdir))
       (lastrev-file (expand-file-name vc-bzr-admin-lastrev rootdir)))
    ;; This looks at internal files to avoid forking a bzr process.
    ;; May break if they change their format.
327
    (if (file-exists-p branch-format-file)
328
        (with-temp-buffer
329
          (insert-file-contents branch-format-file)
330 331 332 333 334 335
          (goto-char (point-min))
          (cond
           ((or
             (looking-at "Bazaar-NG branch, format 0.0.4")
             (looking-at "Bazaar-NG branch format 5"))
            ;; count lines in .bzr/branch/revision-history
336
            (insert-file-contents revhistory-file)
337 338 339
            (number-to-string (count-lines (line-end-position) (point-max))))
           ((looking-at "Bazaar Branch Format 6 (bzr 0.15)")
            ;; revno is the first number in .bzr/branch/last-revision
340
            (insert-file-contents lastrev-file)
341 342 343
            (if (re-search-forward "[0-9]+" nil t)
                (buffer-substring (match-beginning 0) (match-end 0))))))
      ;; fallback to calling "bzr revno"
344
      (lexical-let*
345
          ((result (vc-bzr-command-discarding-stderr
346
                    vc-bzr-program "revno" (file-relative-name file)))
347 348 349 350 351
           (exitcode (car result))
           (output (cdr result)))
        (cond
         ((eq exitcode 0) (substring output 0 -1))
         (t nil))))))
Stefan Monnier's avatar
Stefan Monnier committed
352

353
(defun vc-bzr-create-repo ()
354
  "Create a new Bzr repository."
355 356
  (vc-bzr-command "init" nil 0 nil))

357
(defun vc-bzr-init-revision (&optional file)
358 359 360
  "Always return nil, as Bzr cannot register explicit versions."
  nil)

361 362 363 364 365 366 367 368 369 370
(defun vc-bzr-previous-revision (file rev)
  (if (string-match "\\`[0-9]+\\'" rev)
      (number-to-string (1- (string-to-number rev)))
    (concat "before:" rev)))

(defun vc-bzr-next-revision (file rev)
  (if (string-match "\\`[0-9]+\\'" rev)
      (number-to-string (1+ (string-to-number rev)))
    (error "Don't know how to compute the next revision of %s" rev)))

371
(defun vc-bzr-register (files &optional rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
372 373 374
  "Register FILE under bzr.
Signal an error unless REV is nil.
COMMENT is ignored."
375
  (if rev (error "Can't register explicit revision with bzr"))
376
  (vc-bzr-command "add" nil 0 files))
Stefan Monnier's avatar
Stefan Monnier committed
377 378 379

;; Could run `bzr status' in the directory and see if it succeeds, but
;; that's relatively expensive.
380
(defalias 'vc-bzr-responsible-p 'vc-bzr-root
Stefan Monnier's avatar
Stefan Monnier committed
381 382
  "Return non-nil if FILE is (potentially) controlled by bzr.
The criterion is that there is a `.bzr' directory in the same
383
or a superior directory.")
Stefan Monnier's avatar
Stefan Monnier committed
384 385 386 387 388 389 390 391 392

(defun vc-bzr-could-register (file)
  "Return non-nil if FILE could be registered under bzr."
  (and (vc-bzr-responsible-p file)      ; shortcut
       (condition-case ()
           (with-temp-buffer
             (vc-bzr-command "add" t 0 file "--dry-run")
             ;; The command succeeds with no output if file is
             ;; registered (in bzr 0.8).
393
             (goto-char (point-min))
Stefan Monnier's avatar
Stefan Monnier committed
394 395 396 397 398
             (looking-at "added "))
         (error))))

(defun vc-bzr-unregister (file)
  "Unregister FILE from bzr."
399
  (vc-bzr-command "remove" nil 0 file "--keep"))
Stefan Monnier's avatar
Stefan Monnier committed
400

401
(defun vc-bzr-checkin (files rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
402 403
  "Check FILE in to bzr with log message COMMENT.
REV non-nil gets an error."
404
  (if rev (error "Can't check in a specific revision with bzr"))
405
  (vc-bzr-command "commit" nil 0 files "-m" comment))
Stefan Monnier's avatar
Stefan Monnier committed
406

407 408
(defun vc-bzr-find-revision (file rev buffer)
  "Fetch revision REV of file FILE and put it into BUFFER."
409 410 411 412 413
    (with-current-buffer buffer
      (if (and rev (stringp rev) (not (string= rev "")))
          (vc-bzr-command "cat" t 0 file "-r" rev)
        (vc-bzr-command "cat" t 0 file))))

Stefan Monnier's avatar
Stefan Monnier committed
414 415 416 417
(defun vc-bzr-checkout (file &optional editable rev)
  (if rev (error "Operation not supported")
    ;; Else, there's nothing to do.
    nil))
Stefan Monnier's avatar
Stefan Monnier committed
418 419 420

(defun vc-bzr-revert (file &optional contents-done)
  (unless contents-done
421
    (with-temp-buffer (vc-bzr-command "revert" t 0 file))))
Stefan Monnier's avatar
Stefan Monnier committed
422

423 424 425 426
(defvar log-view-message-re)
(defvar log-view-file-re)
(defvar log-view-font-lock-keywords)
(defvar log-view-current-tag-function)
427
(defvar log-view-per-file-logs)
428 429 430

(define-derived-mode vc-bzr-log-view-mode log-view-mode "Bzr-Log-View"
  (remove-hook 'log-view-mode-hook 'vc-bzr-log-view-mode) ;Deactivate the hack.
Stefan Monnier's avatar
Stefan Monnier committed
431
  (require 'add-log)
432
  (set (make-local-variable 'log-view-per-file-logs) nil)
433
  (set (make-local-variable 'log-view-file-re) "^Working file:[ \t]+\\(.+\\)")
434
  (set (make-local-variable 'log-view-message-re)
435
       "^ *-+\n *\\(?:revno: \\([0-9.]+\\)\\|merged: .+\\)")
Stefan Monnier's avatar
Stefan Monnier committed
436
  (set (make-local-variable 'log-view-font-lock-keywords)
437 438 439 440 441
       ;; log-view-font-lock-keywords is careful to use the buffer-local
       ;; value of log-view-message-re only since Emacs-23.
       (append `((,log-view-message-re . 'log-view-message-face))
               ;; log-view-font-lock-keywords
               '(("^ *committer: \
442
\\([^<(]+?\\)[  ]*[(<]\\([[:alnum:]_.+-]+@[[:alnum:]_.-]+\\)[>)]"
443 444 445
                  (1 'change-log-name)
                  (2 'change-log-email))
                 ("^ *timestamp: \\(.*\\)" (1 'change-log-date-face))))))
Stefan Monnier's avatar
Stefan Monnier committed
446

447 448
(defun vc-bzr-print-log (files &optional buffer) ; get buffer arg in Emacs 22
  "Get bzr change log for FILES into specified BUFFER."
449 450 451 452 453
  ;; `vc-do-command' creates the buffer, but we need it before running
  ;; the command.
  (vc-setup-buffer buffer)
  ;; If the buffer exists from a previous invocation it might be
  ;; read-only.
Stefan Monnier's avatar
Stefan Monnier committed
454 455 456 457
  ;; FIXME: `vc-bzr-command' runs `bzr log' with `LC_MESSAGES=C', so
  ;; the log display may not what the user wants - but I see no other
  ;; way of getting the above regexps working.
  (dolist (file files)
458 459
    (vc-exec-after
     `(let ((inhibit-read-only t))
Stefan Monnier's avatar
Stefan Monnier committed
460 461
        (with-current-buffer buffer
          ;; Insert the file name so that log-view.el can find it.
462 463 464
          (insert "Working file: " ',file "\n")) ;; Like RCS/CVS.
        (apply 'vc-bzr-command "log" ',buffer 'async ',file
               ',(if (stringp vc-bzr-log-switches)
Stefan Monnier's avatar
Stefan Monnier committed
465
                     (list vc-bzr-log-switches)
466
                   vc-bzr-log-switches))))))
Stefan Monnier's avatar
Stefan Monnier committed
467

468 469
(defun vc-bzr-show-log-entry (revision)
  "Find entry for patch name REVISION in bzr change log buffer."
Stefan Monnier's avatar
Stefan Monnier committed
470
  (goto-char (point-min))
471 472 473 474 475 476 477 478 479 480 481
  (when revision
    (let (case-fold-search)
      (if (re-search-forward
	   ;; "revno:" can appear either at the beginning of a line,
	   ;; or indented.
	   (concat "^[ ]*-+\n[ ]*revno: "
		   ;; The revision can contain ".", quote it so that it
		   ;; does not interfere with regexp matching.
		   (regexp-quote revision) "$") nil t)
	  (beginning-of-line 0)
	(goto-char (point-min))))))
Stefan Monnier's avatar
Stefan Monnier committed
482

483
(defun vc-bzr-diff (files &optional rev1 rev2 buffer)
Stefan Monnier's avatar
Stefan Monnier committed
484
  "VC bzr backend for diff."
485
  ;; `bzr diff' exits with code 1 if diff is non-empty.
486
  (apply #'vc-bzr-command "diff" (or buffer "*vc-diff*") 'async files
487
         "--diff-options" (mapconcat 'identity
488
                                     (vc-switches 'bzr 'diff)
Miles Bader's avatar
Miles Bader committed
489
				     " ")
490 491 492 493
         ;; This `when' is just an optimization because bzr-1.2 is *much*
         ;; faster when the revision argument is not given.
         (when (or rev1 rev2)
           (list "-r" (format "%s..%s"
494
                              (or rev1 "revno:-1")
495
                              (or rev2 ""))))))
Stefan Monnier's avatar
Stefan Monnier committed
496 497


498 499
;; FIXME: vc-{next,previous}-revision need fixing in vc.el to deal with
;; straight integer revisions.
Stefan Monnier's avatar
Stefan Monnier committed
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515

(defun vc-bzr-delete-file (file)
  "Delete FILE and delete it in the bzr repository."
  (condition-case ()
      (delete-file file)
    (file-error nil))
  (vc-bzr-command "remove" nil 0 file))

(defun vc-bzr-rename-file (old new)
  "Rename file from OLD to NEW using `bzr mv'."
  (vc-bzr-command "mv" nil 0 new old))

(defvar vc-bzr-annotation-table nil
  "Internal use.")
(make-variable-buffer-local 'vc-bzr-annotation-table)

516
(defun vc-bzr-annotate-command (file buffer &optional revision)
Stefan Monnier's avatar
Stefan Monnier committed
517 518 519
  "Prepare BUFFER for `vc-annotate' on FILE.
Each line is tagged with the revision number, which has a `help-echo'
property containing author and date information."
520
  (apply #'vc-bzr-command "annotate" buffer 0 file "--long" "--all"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
521 522 523 524 525 526
         (if revision (list "-r" revision)))
  (with-current-buffer buffer
    ;; Store the tags for the annotated source lines in a hash table
    ;; to allow saving space by sharing the text properties.
    (setq vc-bzr-annotation-table (make-hash-table :test 'equal))
    (goto-char (point-min))
527
    (while (re-search-forward "^\\( *[0-9.]+ *\\) \\([^\n ]+\\) +\\([0-9]\\{8\\}\\) |"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
528 529 530 531 532 533 534 535 536 537 538 539 540
                              nil t)
      (let* ((rev (match-string 1))
             (author (match-string 2))
             (date (match-string 3))
             (key (match-string 0))
             (tag (gethash key vc-bzr-annotation-table)))
        (unless tag
          (setq tag (propertize rev 'help-echo (concat "Author: " author
                                                       ", date: " date)
                                'mouse-face 'highlight))
          (puthash key tag vc-bzr-annotation-table))
        (replace-match "")
        (insert tag " |")))))
Stefan Monnier's avatar
Stefan Monnier committed
541

542 543
(declare-function vc-annotate-convert-time "vc-annotate" (time))

Stefan Monnier's avatar
Stefan Monnier committed
544
(defun vc-bzr-annotate-time ()
545
  (when (re-search-forward "^ *[0-9.]+ +|" nil t)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
546 547
    (let ((prop (get-text-property (line-beginning-position) 'help-echo)))
      (string-match "[0-9]+\\'" prop)
548
      (let ((str (match-string-no-properties 0 prop)))
Stefan Monnier's avatar
Stefan Monnier committed
549 550
      (vc-annotate-convert-time
       (encode-time 0 0 0
551 552 553
                      (string-to-number (substring str 6 8))
                      (string-to-number (substring str 4 6))
                      (string-to-number (substring str 0 4))))))))
Stefan Monnier's avatar
Stefan Monnier committed
554 555 556 557 558 559

(defun vc-bzr-annotate-extract-revision-at-line ()
  "Return revision for current line of annoation buffer, or nil.
Return nil if current line isn't annotated."
  (save-excursion
    (beginning-of-line)
560
    (if (looking-at " *\\([0-9.]+\\) *| ")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
561
        (match-string-no-properties 1))))
Stefan Monnier's avatar
Stefan Monnier committed
562

563 564
(defun vc-bzr-command-discarding-stderr (command &rest args)
  "Execute shell command COMMAND (with ARGS); return its output and exitcode.
565 566 567 568 569
Return value is a cons (EXITCODE . OUTPUT), where EXITCODE is
the (numerical) exit code of the process, and OUTPUT is a string
containing whatever the process sent to its standard output
stream.  Standard error output is discarded."
  (with-temp-buffer
570
    (cons
571
     (apply #'process-file command nil (list (current-buffer) nil) nil args)
572
     (buffer-substring (point-min) (point-max)))))
Stefan Monnier's avatar
Stefan Monnier committed
573

574 575
(defun vc-bzr-prettify-state-info (file)
  "Bzr-specific version of `vc-prettify-state-info'."
Stefan Monnier's avatar
Stefan Monnier committed
576
  (if (eq 'edited (vc-state file))
577
        (concat "(" (symbol-name (or (vc-file-getprop file 'vc-bzr-state)
578 579
                                     'edited)) ")")
    ;; else fall back to default vc.el representation
580
    (vc-default-prettify-state-info 'Bzr file)))
Stefan Monnier's avatar
Stefan Monnier committed
581

582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
(defstruct (vc-bzr-extra-fileinfo
            (:copier nil)
            (:constructor vc-bzr-create-extra-fileinfo (extra-name))
            (:conc-name vc-bzr-extra-fileinfo->))
  extra-name)         ;; original name for rename targets, new name for

(defun vc-bzr-status-printer (info)
  "Pretty-printer for the vc-dir-fileinfo structure."
  (let ((extra (vc-dir-fileinfo->extra info)))
    (vc-default-status-printer 'Bzr info)
    (when extra
      (insert (propertize
	       (format "   (renamed from %s)"
		       (vc-bzr-extra-fileinfo->extra-name extra))
	       'face 'font-lock-comment-face)))))

598
;; FIXME: this needs testing, it's probably incomplete.
599
(defun vc-bzr-after-dir-status (update-function)
600
  (let ((status-str nil)
601 602 603 604 605 606 607
	(translation '(("+N " . added)
		       ("-D " . removed)
		       (" M " . edited) ;; file text modified
		       ("  *" . edited) ;; execute bit changed
		       (" M*" . edited) ;; text modified + execute bit changed
		       ;; FIXME: what about ignored files?
		       (" D " . missing)
608
                       ;; For conflicts, should we list the .THIS/.BASE/.OTHER?
609 610
		       ("C  " . conflict)
		       ("?  " . unregistered)
611 612 613
		       ("?  " . unregistered)
		       ;; No such state, but we need to distinguish this case.
		       ("R  " . renamed)
614 615
                       ;; Ignore "P " and "P." for pending patches.
                       ))
616 617 618 619 620
	(translated nil)
	(result nil))
      (goto-char (point-min))
      (while (not (eobp))
	(setq status-str
621
	      (buffer-substring-no-properties (point) (+ (point) 3)))
622
	(setq translated (cdr (assoc status-str translation)))
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
	(cond
	 ((eq translated 'conflict)
	  ;; For conflicts the file appears twice in the listing: once
	  ;; with the M flag and once with the C flag, so take care
	  ;; not to add it twice to `result'.  Ugly.
	  (let* ((file
		  (buffer-substring-no-properties
		   ;;For files with conflicts the format is:
		   ;;C   Text conflict in FILENAME
		   ;; Bah.
		   (+ (point) 21) (line-end-position)))
		 (entry (assoc file result)))
	    (when entry
	      (setf (nth 1 entry) 'conflict))))
	 ((eq translated 'renamed)
	  (re-search-forward "R   \\(.*\\) => \\(.*\\)$" (line-end-position) t)
	  (let ((new-name (match-string 2))
		(old-name (match-string 1)))
	    (push (list new-name 'edited
		      (vc-bzr-create-extra-fileinfo old-name)) result)))
	 (t
644 645
	  (push (list (buffer-substring-no-properties
		       (+ (point) 4)
646
		       (line-end-position))
647
		      translated) result)))
648
	(forward-line))
649
      (funcall update-function result)))
650

651
(defun vc-bzr-dir-status (dir update-function)
652
  "Return a list of conses (file . state) for DIR."
653 654
  (vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S")
  (vc-exec-after
655
   `(vc-bzr-after-dir-status (quote ,update-function))))
656

657 658 659 660 661 662 663 664 665
;;; Revision completion

(defun vc-bzr-revision-completion-table (files)
  (lexical-let ((files files))
    ;; What about using `files'?!?  --Stef
    (lambda (string pred action)
      (cond
       ((string-match "\\`\\(ancestor\\|branch\\|\\(revno:\\)?[-0-9]+:\\):"
                      string)
666
        (completion-table-with-context (substring string 0 (match-end 0))
667 668
                                       ;; FIXME: only allow directories.
                                       ;; FIXME: don't allow envvars.
669 670 671 672 673 674 675
                                       'read-file-name-internal
                                       (substring string (match-end 0))
                                       ;; Dropping `pred'.   Maybe we should
                                       ;; just stash it in
                                       ;; `read-file-name-predicate'?
                                       nil
                                       action))
676
       ((string-match "\\`\\(before\\):" string)
677 678 679 680 681
        (completion-table-with-context (substring string 0 (match-end 0))
                                       (vc-bzr-revision-completion-table files)
                                       (substring string (match-end 0))
                                       pred
                                       action))
682 683 684 685 686 687
       ((string-match "\\`\\(tag\\):" string)
        (let ((prefix (substring string 0 (match-end 0)))
              (tag (substring string (match-end 0)))
              (table nil))
          (with-temp-buffer
            ;; "bzr-1.2 tags" is much faster with --show-ids.
688
            (process-file vc-bzr-program nil '(t) nil "tags" "--show-ids")
689 690 691 692 693
            ;; The output is ambiguous, unless we assume that revids do not
            ;; contain spaces.
            (goto-char (point-min))
            (while (re-search-forward "^\\(.*[^ \n]\\) +[^ \n]*$" nil t)
              (push (match-string-no-properties 1) table)))
694
          (completion-table-with-context prefix table tag pred action)))
695 696 697 698

       ((string-match "\\`\\(revid\\):" string)
        ;; FIXME: How can I get a list of revision ids?
        )
699 700
       ((eq (car-safe action) 'boundaries)
        (list* 'boundaries
701
               (string-match "[^:]*\\'" string)
702
               (string-match ":" (cdr action))))
703
       (t
704 705 706
        ;; Could use completion-table-with-terminator, except that it
        ;; currently doesn't work right w.r.t pcm and doesn't give
        ;; the *Completions* output we want.
707 708 709 710 711
        (complete-with-action action '("revno:" "revid:" "last:" "before:"
                                       "tag:" "date:" "ancestor:" "branch:"
                                       "submit:")
                              string pred))))))

Stefan Monnier's avatar
Stefan Monnier committed
712
(eval-after-load "vc"
713
  '(add-to-list 'vc-directory-exclusion-list vc-bzr-admin-dirname t))
Stefan Monnier's avatar
Stefan Monnier committed
714 715 716 717

(provide 'vc-bzr)
;; arch-tag: 8101bad8-4e92-4e7d-85ae-d8e08b4e7c06
;;; vc-bzr.el ends here