1 ;;; git.el --- A user interface for git
3 ;; Copyright (C) 2005, 2006, 2007, 2008, 2009 Alexandre Julliard <julliard@winehq.org>
7 ;; This program is free software; you can redistribute it and/or
8 ;; modify it under the terms of the GNU General Public License as
9 ;; published by the Free Software Foundation; either version 2 of
10 ;; the License, or (at your option) any later version.
12 ;; This program is distributed in the hope that it will be
13 ;; useful, but WITHOUT ANY WARRANTY; without even the implied
14 ;; warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 ;; PURPOSE. See the GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public
18 ;; License along with this program; if not, write to the Free
19 ;; Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24 ;; This file contains an interface for the git version control
25 ;; system. It provides easy access to the most frequently used git
26 ;; commands. The user interface is as far as possible identical to
27 ;; that of the PCL-CVS mode.
29 ;; To install: put this file on the load-path and place the following
30 ;; in your .emacs file:
34 ;; To start: `M-x git-status'
37 ;; - diff against other branch
38 ;; - renaming files from the status buffer
42 ;; - git-show-branch browser
47 ;; This file works on GNU Emacs 21 or later. It may work on older
48 ;; versions but this is not guaranteed.
50 ;; It may work on XEmacs 21, provided that you first install the ewoc
51 ;; and log-edit packages.
54 (eval-when-compile (require 'cl
))
61 ;;;; ------------------------------------------------------------
64 "A user interface for the git versioning system."
67 (defcustom git-committer-name nil
68 "User name to use for commits.
69 The default is to fall back to the repository config,
70 then to `add-log-full-name' and then to `user-full-name'."
72 :type
'(choice (const :tag
"Default" nil
)
73 (string :tag
"Name")))
75 (defcustom git-committer-email nil
76 "Email address to use for commits.
77 The default is to fall back to the git repository config,
78 then to `add-log-mailing-address' and then to `user-mail-address'."
80 :type
'(choice (const :tag
"Default" nil
)
81 (string :tag
"Email")))
83 (defcustom git-commits-coding-system nil
84 "Default coding system for the log message of git commits."
86 :type
'(choice (const :tag
"From repository config" nil
)
89 (defcustom git-append-signed-off-by nil
90 "Whether to append a Signed-off-by line to the commit message before editing."
94 (defcustom git-reuse-status-buffer t
95 "Whether `git-status' should try to reuse an existing buffer
96 if there is already one that displays the same directory."
100 (defcustom git-per-dir-ignore-file
".gitignore"
101 "Name of the per-directory ignore file."
105 (defcustom git-show-uptodate nil
106 "Whether to display up-to-date files."
110 (defcustom git-show-ignored nil
111 "Whether to display ignored files."
115 (defcustom git-show-unknown t
116 "Whether to display unknown files."
121 (defface git-status-face
122 '((((class color
) (background light
)) (:foreground
"purple"))
123 (((class color
) (background dark
)) (:foreground
"salmon")))
124 "Git mode face used to highlight added and modified files."
127 (defface git-unmerged-face
128 '((((class color
) (background light
)) (:foreground
"red" :bold t
))
129 (((class color
) (background dark
)) (:foreground
"red" :bold t
)))
130 "Git mode face used to highlight unmerged files."
133 (defface git-unknown-face
134 '((((class color
) (background light
)) (:foreground
"goldenrod" :bold t
))
135 (((class color
) (background dark
)) (:foreground
"goldenrod" :bold t
)))
136 "Git mode face used to highlight unknown files."
139 (defface git-uptodate-face
140 '((((class color
) (background light
)) (:foreground
"grey60"))
141 (((class color
) (background dark
)) (:foreground
"grey40")))
142 "Git mode face used to highlight up-to-date files."
145 (defface git-ignored-face
146 '((((class color
) (background light
)) (:foreground
"grey60"))
147 (((class color
) (background dark
)) (:foreground
"grey40")))
148 "Git mode face used to highlight ignored files."
151 (defface git-mark-face
152 '((((class color
) (background light
)) (:foreground
"red" :bold t
))
153 (((class color
) (background dark
)) (:foreground
"tomato" :bold t
)))
154 "Git mode face used for the file marks."
157 (defface git-header-face
158 '((((class color
) (background light
)) (:foreground
"blue"))
159 (((class color
) (background dark
)) (:foreground
"blue")))
160 "Git mode face used for commit headers."
163 (defface git-separator-face
164 '((((class color
) (background light
)) (:foreground
"brown"))
165 (((class color
) (background dark
)) (:foreground
"brown")))
166 "Git mode face used for commit separator."
169 (defface git-permission-face
170 '((((class color
) (background light
)) (:foreground
"green" :bold t
))
171 (((class color
) (background dark
)) (:foreground
"green" :bold t
)))
172 "Git mode face used for permission changes."
177 ;;;; ------------------------------------------------------------
179 (defconst git-log-msg-separator
"--- log message follows this line ---")
181 (defvar git-log-edit-font-lock-keywords
182 `(("^\\(Author:\\|Date:\\|Merge:\\|Signed-off-by:\\)\\(.*\\)$"
183 (1 font-lock-keyword-face
)
184 (2 font-lock-function-name-face
))
185 (,(concat "^\\(" (regexp-quote git-log-msg-separator
) "\\)$")
186 (1 font-lock-comment-face
))))
188 (defun git-get-env-strings (env)
189 "Build a list of NAME=VALUE strings from a list of environment strings."
190 (mapcar (lambda (entry) (concat (car entry
) "=" (cdr entry
))) env
))
192 (defun git-call-process (buffer &rest args
)
193 "Wrapper for call-process that sets environment strings."
194 (apply #'call-process
"git" nil buffer nil args
))
196 (defun git-call-process-display-error (&rest args
)
197 "Wrapper for call-process that displays error messages."
198 (let* ((dir default-directory
)
199 (buffer (get-buffer-create "*Git Command Output*"))
200 (ok (with-current-buffer buffer
201 (let ((default-directory dir
)
202 (buffer-read-only nil
))
204 (eq 0 (apply #'git-call-process
(list buffer t
) args
))))))
205 (unless ok
(display-message-or-buffer buffer
))
208 (defun git-call-process-string (&rest args
)
209 "Wrapper for call-process that returns the process output as a string,
210 or nil if the git command failed."
212 (and (eq 0 (apply #'git-call-process t args
))
215 (defun git-call-process-string-display-error (&rest args
)
216 "Wrapper for call-process that displays error message and returns
217 the process output as a string, or nil if the git command failed."
219 (if (eq 0 (apply #'git-call-process
(list t t
) args
))
221 (display-message-or-buffer (current-buffer))
224 (defun git-run-process-region (buffer start end program args
)
225 "Run a git process with a buffer region as input."
226 (let ((output-buffer (current-buffer))
227 (dir default-directory
))
228 (with-current-buffer buffer
230 (apply #'call-process-region start end program
231 nil
(list output-buffer t
) nil args
))))
233 (defun git-run-command-buffer (buffer-name &rest args
)
234 "Run a git command, sending the output to a buffer named BUFFER-NAME."
235 (let ((dir default-directory
)
236 (buffer (get-buffer-create buffer-name
)))
237 (message "Running git %s..." (car args
))
238 (with-current-buffer buffer
239 (let ((default-directory dir
)
240 (buffer-read-only nil
))
242 (apply #'git-call-process buffer args
)))
243 (message "Running git %s...done" (car args
))
246 (defun git-run-command-region (buffer start end env
&rest args
)
247 "Run a git command with specified buffer region as input."
250 (git-run-process-region
251 buffer start end
"env"
252 (append (git-get-env-strings env
) (list "git") args
))
253 (git-run-process-region buffer start end
"git" args
)))
255 (display-message-or-buffer (current-buffer))
258 (defun git-run-hook (hook env
&rest args
)
259 "Run a git hook and display its output if any."
260 (let ((dir default-directory
)
261 (hook-name (expand-file-name (concat ".git/hooks/" hook
))))
262 (or (not (file-executable-p hook-name
))
263 (let (status (buffer (get-buffer-create "*Git Hook Output*")))
264 (with-current-buffer buffer
269 (apply #'call-process
"env" nil
(list buffer t
) nil
270 (append (git-get-env-strings env
) (list hook-name
) args
))
271 (apply #'call-process hook-name nil
(list buffer t
) nil args
))))
272 (display-message-or-buffer buffer
)
275 (defun git-get-string-sha1 (string)
276 "Read a SHA1 from the specified string."
278 (string-match "[0-9a-f]\\{40\\}" string
)
279 (match-string 0 string
)))
281 (defun git-get-committer-name ()
282 "Return the name to use as GIT_COMMITTER_NAME."
283 ; copied from log-edit
284 (or git-committer-name
285 (git-config "user.name")
286 (and (boundp 'add-log-full-name
) add-log-full-name
)
287 (and (fboundp 'user-full-name
) (user-full-name))
288 (and (boundp 'user-full-name
) user-full-name
)))
290 (defun git-get-committer-email ()
291 "Return the email address to use as GIT_COMMITTER_EMAIL."
292 ; copied from log-edit
293 (or git-committer-email
294 (git-config "user.email")
295 (and (boundp 'add-log-mailing-address
) add-log-mailing-address
)
296 (and (fboundp 'user-mail-address
) (user-mail-address))
297 (and (boundp 'user-mail-address
) user-mail-address
)))
299 (defun git-get-commits-coding-system ()
300 "Return the coding system to use for commits."
301 (let ((repo-config (git-config "i18n.commitencoding")))
302 (or git-commits-coding-system
304 (fboundp 'locale-charset-to-coding-system
)
305 (locale-charset-to-coding-system repo-config
))
308 (defun git-get-logoutput-coding-system ()
309 "Return the coding system used for git-log output."
310 (let ((repo-config (or (git-config "i18n.logoutputencoding")
311 (git-config "i18n.commitencoding"))))
312 (or git-commits-coding-system
314 (fboundp 'locale-charset-to-coding-system
)
315 (locale-charset-to-coding-system repo-config
))
318 (defun git-escape-file-name (name)
319 "Escape a file name if necessary."
320 (if (string-match "[\n\t\"\\]" name
)
322 (mapconcat (lambda (c)
328 (t (char-to-string c
))))
333 (defun git-success-message (text files
)
334 "Print a success message after having handled FILES."
335 (let ((n (length files
)))
337 (message "%s %s" text
(car files
))
338 (message "%s %d files" text n
))))
340 (defun git-get-top-dir (dir)
341 "Retrieve the top-level directory of a git tree."
342 (let ((cdup (with-output-to-string
343 (with-current-buffer standard-output
345 (unless (eq 0 (git-call-process t
"rev-parse" "--show-cdup"))
346 (error "cannot find top-level git tree for %s." dir
))))))
347 (expand-file-name (concat (file-name-as-directory dir
)
348 (car (split-string cdup
"\n"))))))
351 (defun git-append-to-ignore (file)
352 "Add a file name to the ignore file in its directory."
353 (let* ((fullname (expand-file-name file
))
354 (dir (file-name-directory fullname
))
355 (name (file-name-nondirectory fullname
))
356 (ignore-name (expand-file-name git-per-dir-ignore-file dir
))
357 (created (not (file-exists-p ignore-name
))))
358 (save-window-excursion
359 (set-buffer (find-file-noselect ignore-name
))
360 (goto-char (point-max))
361 (unless (zerop (current-column)) (insert "\n"))
362 (insert "/" name
"\n")
363 (sort-lines nil
(point-min) (point-max))
366 (git-call-process nil
"update-index" "--add" "--" (file-relative-name ignore-name
)))
367 (git-update-status-files (list (file-relative-name ignore-name
)))))
369 ; propertize definition for XEmacs, stolen from erc-compat
371 (unless (fboundp 'propertize
)
372 (defun propertize (string &rest props
)
373 (let ((string (copy-sequence string
)))
375 (put-text-property 0 (length string
) (nth 0 props
) (nth 1 props
) string
)
376 (setq props
(cddr props
)))
379 ;;;; Wrappers for basic git commands
380 ;;;; ------------------------------------------------------------
382 (defun git-rev-parse (rev)
383 "Parse a revision name and return its SHA1."
385 (git-call-process-string "rev-parse" rev
)))
387 (defun git-config (key)
388 "Retrieve the value associated to KEY in the git repository config file."
389 (let ((str (git-call-process-string "config" key
)))
390 (and str
(car (split-string str
"\n")))))
392 (defun git-symbolic-ref (ref)
393 "Wrapper for the git-symbolic-ref command."
394 (let ((str (git-call-process-string "symbolic-ref" ref
)))
395 (and str
(car (split-string str
"\n")))))
397 (defun git-update-ref (ref newval
&optional oldval reason
)
398 "Update a reference by calling git-update-ref."
399 (let ((args (and oldval
(list oldval
))))
400 (when newval
(push newval args
))
405 (unless newval
(push "-d" args
))
406 (apply 'git-call-process-display-error
"update-ref" args
)))
408 (defun git-for-each-ref (&rest specs
)
409 "Return a list of refs using git-for-each-ref.
410 Each entry is a cons of (SHORT-NAME . FULL-NAME)."
413 (apply #'git-call-process t
"for-each-ref" "--format=%(refname)" specs
)
414 (goto-char (point-min))
415 (while (re-search-forward "^[^/\n]+/[^/\n]+/\\(.+\\)$" nil t
)
416 (push (cons (match-string 1) (match-string 0)) refs
)))
419 (defun git-read-tree (tree &optional index-file
)
420 "Read a tree into the index file."
421 (let ((process-environment
422 (append (and index-file
(list (concat "GIT_INDEX_FILE=" index-file
))) process-environment
)))
423 (apply 'git-call-process-display-error
"read-tree" (if tree
(list tree
)))))
425 (defun git-write-tree (&optional index-file
)
426 "Call git-write-tree and return the resulting tree SHA1 as a string."
427 (let ((process-environment
428 (append (and index-file
(list (concat "GIT_INDEX_FILE=" index-file
))) process-environment
)))
430 (git-call-process-string-display-error "write-tree"))))
432 (defun git-commit-tree (buffer tree head
)
433 "Call git-commit-tree with buffer as input and return the resulting commit SHA1."
434 (let ((author-name (git-get-committer-name))
435 (author-email (git-get-committer-email))
436 (subject "commit (initial): ")
437 author-date log-start log-end args coding-system-for-write
)
439 (setq subject
"commit: ")
442 (with-current-buffer buffer
443 (goto-char (point-min))
445 (setq log-start
(re-search-forward (concat "^" (regexp-quote git-log-msg-separator
) "\n") nil t
))
447 (narrow-to-region (point-min) log-start
)
448 (goto-char (point-min))
449 (when (re-search-forward "^Author: +\\(.*?\\) *<\\(.*\\)> *$" nil t
)
450 (setq author-name
(match-string 1)
451 author-email
(match-string 2)))
452 (goto-char (point-min))
453 (when (re-search-forward "^Date: +\\(.*\\)$" nil t
)
454 (setq author-date
(match-string 1)))
455 (goto-char (point-min))
456 (when (re-search-forward "^Merge: +\\(.*\\)" nil t
)
457 (setq subject
"commit (merge): ")
458 (dolist (parent (split-string (match-string 1) " +" t
))
460 (push parent args
))))
461 (setq log-start
(point-min)))
462 (setq log-end
(point-max))
463 (goto-char log-start
)
464 (when (re-search-forward ".*$" nil t
)
465 (setq subject
(concat subject
(match-string 0))))
466 (setq coding-system-for-write buffer-file-coding-system
))
469 (let ((env `(("GIT_AUTHOR_NAME" .
,author-name
)
470 ("GIT_AUTHOR_EMAIL" .
,author-email
)
471 ("GIT_COMMITTER_NAME" .
,(git-get-committer-name))
472 ("GIT_COMMITTER_EMAIL" .
,(git-get-committer-email)))))
473 (when author-date
(push `("GIT_AUTHOR_DATE" .
,author-date
) env
))
474 (apply #'git-run-command-region
475 buffer log-start log-end env
476 "commit-tree" tree
(nreverse args
))))))
477 (when commit
(git-update-ref "HEAD" commit head subject
))
480 (defun git-empty-db-p ()
481 "Check if the git db is empty (no commit done yet)."
482 (not (eq 0 (git-call-process nil
"rev-parse" "--verify" "HEAD"))))
484 (defun git-get-merge-heads ()
485 "Retrieve the merge heads from the MERGE_HEAD file if present."
487 (when (file-readable-p ".git/MERGE_HEAD")
489 (insert-file-contents ".git/MERGE_HEAD" nil nil nil t
)
490 (goto-char (point-min))
491 (while (re-search-forward "[0-9a-f]\\{40\\}" nil t
)
492 (push (match-string 0) heads
))))
495 (defun git-get-commit-description (commit)
496 "Get a one-line description of COMMIT."
497 (let ((coding-system-for-read (git-get-logoutput-coding-system)))
498 (let ((descr (git-call-process-string "log" "--max-count=1" "--pretty=oneline" commit
)))
499 (if (and descr
(string-match "\\`\\([0-9a-f]\\{40\\}\\) *\\(.*\\)$" descr
))
500 (concat (substring (match-string 1 descr
) 0 10) " - " (match-string 2 descr
))
503 ;;;; File info structure
504 ;;;; ------------------------------------------------------------
506 ; fileinfo structure stolen from pcl-cvs
507 (defstruct (git-fileinfo
509 (:constructor git-create-fileinfo
(state name
&optional old-perm new-perm rename-state orig-name marked
))
510 (:conc-name git-fileinfo-
>))
512 state
;; current state
514 old-perm new-perm
;; permission flags
515 rename-state
;; rename or copy state
516 orig-name
;; original name for renames or copies
517 needs-update
;; whether file needs to be updated
518 needs-refresh
) ;; whether file needs to be refreshed
520 (defvar git-status nil
)
522 (defun git-set-fileinfo-state (info state
)
523 "Set the state of a file info."
524 (unless (eq (git-fileinfo->state info
) state
)
525 (setf (git-fileinfo->state info
) state
526 (git-fileinfo->new-perm info
) (git-fileinfo->old-perm info
)
527 (git-fileinfo->rename-state info
) nil
528 (git-fileinfo->orig-name info
) nil
529 (git-fileinfo->needs-update info
) nil
530 (git-fileinfo->needs-refresh info
) t
)))
532 (defun git-status-filenames-map (status func files
&rest args
)
533 "Apply FUNC to the status files names in the FILES list."
535 (setq files
(sort files
#'string-lessp
))
536 (let ((file (pop files
))
537 (node (ewoc-nth status
0)))
538 (while (and file node
)
539 (let* ((info (ewoc-data node
))
540 (name (git-fileinfo->name info
)))
541 (if (string-lessp name file
)
542 (setq node
(ewoc-next status node
))
543 (if (string-equal name file
)
544 (apply func info args
))
545 (setq file
(pop files
))))))))
547 (defun git-set-filenames-state (status files state
)
548 "Set the state of a list of named files."
550 (git-status-filenames-map status
#'git-set-fileinfo-state files state
)
551 (unless state
;; delete files whose state has been set to nil
552 (ewoc-filter status
(lambda (info) (git-fileinfo->state info
))))))
554 (defun git-state-code (code)
555 "Convert from a string to a added/deleted/modified state."
556 (case (string-to-char code
)
565 (defun git-status-code-as-string (code)
566 "Format a git status code as string."
568 ('modified
(propertize "Modified" 'face
'git-status-face
))
569 ('unknown
(propertize "Unknown " 'face
'git-unknown-face
))
570 ('added
(propertize "Added " 'face
'git-status-face
))
571 ('deleted
(propertize "Deleted " 'face
'git-status-face
))
572 ('unmerged
(propertize "Unmerged" 'face
'git-unmerged-face
))
573 ('uptodate
(propertize "Uptodate" 'face
'git-uptodate-face
))
574 ('ignored
(propertize "Ignored " 'face
'git-ignored-face
))
577 (defun git-file-type-as-string (old-perm new-perm
)
578 "Return a string describing the file type based on its permissions."
579 (let* ((old-type (lsh (or old-perm
0) -
9))
580 (new-type (lsh (or new-perm
0) -
9))
585 (80 " (type change symlink -> file)")
586 (112 " (type change subproject -> file)")))
589 (64 " (type change file -> symlink)")
590 (112 " (type change subproject -> symlink)")
594 (64 " (type change file -> subproject)")
595 (80 " (type change symlink -> subproject)")
596 (t " (subproject)")))
597 (72 nil
) ;; directory (internal, not a real git state)
598 (0 ;; deleted or unknown
601 (112 " (subproject)")))
602 (t (format " (unknown type %o)" new-type
)))))
603 (cond (str (propertize str
'face
'git-status-face
))
604 ((eq new-type
72) "/")
607 (defun git-rename-as-string (info)
608 "Return a string describing the copy or rename associated with INFO, or an empty string if none."
609 (let ((state (git-fileinfo->rename-state info
)))
613 (if (eq state
'copy
) "copied from "
614 (if (eq (git-fileinfo->state info
) 'added
) "renamed from "
616 (git-escape-file-name (git-fileinfo->orig-name info
))
617 ")") 'face
'git-status-face
)
620 (defun git-permissions-as-string (old-perm new-perm
)
621 "Format a permission change as string."
623 (if (or (not old-perm
)
625 (eq 0 (logand ?
\111 (logxor old-perm new-perm
))))
627 (if (eq 0 (logand ?
\111 old-perm
)) "+x" "-x"))
628 'face
'git-permission-face
))
630 (defun git-fileinfo-prettyprint (info)
631 "Pretty-printer for the git-fileinfo structure."
632 (let ((old-perm (git-fileinfo->old-perm info
))
633 (new-perm (git-fileinfo->new-perm info
)))
634 (insert (concat " " (if (git-fileinfo->marked info
) (propertize "*" 'face
'git-mark-face
) " ")
635 " " (git-status-code-as-string (git-fileinfo->state info
))
636 " " (git-permissions-as-string old-perm new-perm
)
637 " " (git-escape-file-name (git-fileinfo->name info
))
638 (git-file-type-as-string old-perm new-perm
)
639 (git-rename-as-string info
)))))
641 (defun git-update-node-fileinfo (node info
)
642 "Update the fileinfo of the specified node. The names are assumed to match already."
643 (let ((data (ewoc-data node
)))
645 ;; preserve the marked flag
646 (git-fileinfo->marked info
) (git-fileinfo->marked data
)
647 (git-fileinfo->needs-update data
) nil
)
648 (when (not (equal info data
))
649 (setf (git-fileinfo->needs-refresh info
) t
650 (ewoc-data node
) info
))))
652 (defun git-insert-info-list (status infolist files
)
653 "Insert a sorted list of file infos in the status buffer, replacing existing ones if any."
654 (let* ((info (pop infolist
))
655 (node (ewoc-nth status
0))
656 (name (and info
(git-fileinfo->name info
)))
659 (let ((nodename (and node
(git-fileinfo->name
(ewoc-data node
)))))
660 (while (and files
(string-lessp (car files
) name
))
661 (push (pop files
) remaining
))
662 (when (and files
(string-equal (car files
) name
))
663 (setq files
(cdr files
)))
664 (cond ((not nodename
)
665 (setq node
(ewoc-enter-last status info
))
666 (setq info
(pop infolist
))
667 (setq name
(and info
(git-fileinfo->name info
))))
668 ((string-lessp nodename name
)
669 (setq node
(ewoc-next status node
)))
670 ((string-equal nodename name
)
671 ;; preserve the marked flag
672 (git-update-node-fileinfo node info
)
673 (setq info
(pop infolist
))
674 (setq name
(and info
(git-fileinfo->name info
))))
676 (setq node
(ewoc-enter-before status node info
))
677 (setq info
(pop infolist
))
678 (setq name
(and info
(git-fileinfo->name info
)))))))
679 (nconc (nreverse remaining
) files
)))
681 (defun git-run-diff-index (status files
)
682 "Run git-diff-index on FILES and parse the results into STATUS.
683 Return the list of files that haven't been handled."
686 (apply #'git-call-process t
"diff-index" "-z" "-M" "HEAD" "--" files
)
687 (goto-char (point-min))
688 (while (re-search-forward
689 ":\\([0-7]\\{6\\}\\) \\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} [0-9a-f]\\{40\\} \\(\\([ADMUT]\\)\0\\([^\0]+\\)\\|\\([CR]\\)[0-9]*\0\\([^\0]+\\)\0\\([^\0]+\\)\\)\0"
691 (let ((old-perm (string-to-number (match-string 1) 8))
692 (new-perm (string-to-number (match-string 2) 8))
693 (state (or (match-string 4) (match-string 6)))
694 (name (or (match-string 5) (match-string 7)))
695 (new-name (match-string 8)))
696 (if new-name
; copy or rename
697 (if (eq ?C
(string-to-char state
))
698 (push (git-create-fileinfo 'added new-name old-perm new-perm
'copy name
) infolist
)
699 (push (git-create-fileinfo 'deleted name
0 0 'rename new-name
) infolist
)
700 (push (git-create-fileinfo 'added new-name old-perm new-perm
'rename name
) infolist
))
701 (push (git-create-fileinfo (git-state-code state
) name old-perm new-perm
) infolist
)))))
702 (setq infolist
(sort (nreverse infolist
)
703 (lambda (info1 info2
)
704 (string-lessp (git-fileinfo->name info1
)
705 (git-fileinfo->name info2
)))))
706 (git-insert-info-list status infolist files
)))
708 (defun git-find-status-file (status file
)
709 "Find a given file in the status ewoc and return its node."
710 (let ((node (ewoc-nth status
0)))
711 (while (and node
(not (string= file
(git-fileinfo->name
(ewoc-data node
)))))
712 (setq node
(ewoc-next status node
)))
715 (defun git-run-ls-files (status files default-state
&rest options
)
716 "Run git-ls-files on FILES and parse the results into STATUS.
717 Return the list of files that haven't been handled."
720 (apply #'git-call-process t
"ls-files" "-z" (append options
(list "--") files
))
721 (goto-char (point-min))
722 (while (re-search-forward "\\([^\0]*?\\)\\(/?\\)\0" nil t
1)
723 (let ((name (match-string 1)))
724 (push (git-create-fileinfo default-state name
0
725 (if (string-equal "/" (match-string 2)) (lsh ?
\110 9) 0))
727 (setq infolist
(nreverse infolist
)) ;; assume it is sorted already
728 (git-insert-info-list status infolist files
)))
730 (defun git-run-ls-files-cached (status files default-state
)
731 "Run git-ls-files -c on FILES and parse the results into STATUS.
732 Return the list of files that haven't been handled."
735 (apply #'git-call-process t
"ls-files" "-z" "-s" "-c" "--" files
)
736 (goto-char (point-min))
737 (while (re-search-forward "\\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} 0\t\\([^\0]+\\)\0" nil t
)
738 (let* ((new-perm (string-to-number (match-string 1) 8))
739 (old-perm (if (eq default-state
'added
) 0 new-perm
))
740 (name (match-string 2)))
741 (push (git-create-fileinfo default-state name old-perm new-perm
) infolist
))))
742 (setq infolist
(nreverse infolist
)) ;; assume it is sorted already
743 (git-insert-info-list status infolist files
)))
745 (defun git-run-ls-unmerged (status files
)
746 "Run git-ls-files -u on FILES and parse the results into STATUS."
748 (apply #'git-call-process t
"ls-files" "-z" "-u" "--" files
)
749 (goto-char (point-min))
750 (let (unmerged-files)
751 (while (re-search-forward "[0-7]\\{6\\} [0-9a-f]\\{40\\} [123]\t\\([^\0]+\\)\0" nil t
)
752 (push (match-string 1) unmerged-files
))
753 (git-set-filenames-state status unmerged-files
'unmerged
))))
755 (defun git-get-exclude-files ()
756 "Get the list of exclude files to pass to git-ls-files."
758 (config (git-config "core.excludesfile")))
759 (when (file-readable-p ".git/info/exclude")
760 (push ".git/info/exclude" files
))
761 (when (and config
(file-readable-p config
))
765 (defun git-run-ls-files-with-excludes (status files default-state
&rest options
)
766 "Run git-ls-files on FILES with appropriate --exclude-from options."
767 (let ((exclude-files (git-get-exclude-files)))
768 (apply #'git-run-ls-files status files default-state
"--directory" "--no-empty-directory"
769 (concat "--exclude-per-directory=" git-per-dir-ignore-file
)
770 (append options
(mapcar (lambda (f) (concat "--exclude-from=" f
)) exclude-files
)))))
772 (defun git-update-status-files (&optional files mark-files
)
773 "Update the status of FILES from the index."
774 (unless git-status
(error "Not in git-status buffer."))
775 ;; set the needs-update flag on existing files
776 (if (setq files
(sort files
#'string-lessp
))
777 (git-status-filenames-map
778 git-status
(lambda (info) (setf (git-fileinfo->needs-update info
) t
)) files
)
779 (ewoc-map (lambda (info) (setf (git-fileinfo->needs-update info
) t
) nil
) git-status
)
780 (git-call-process nil
"update-index" "--refresh")
781 (when git-show-uptodate
782 (git-run-ls-files-cached git-status nil
'uptodate
)))
783 (let* ((remaining-files
784 (if (git-empty-db-p) ; we need some special handling for an empty db
785 (git-run-ls-files-cached git-status files
'added
)
786 (git-run-diff-index git-status files
))))
787 (git-run-ls-unmerged git-status files
)
788 (when (or remaining-files
(and git-show-unknown
(not files
)))
789 (setq remaining-files
(git-run-ls-files-with-excludes git-status remaining-files
'unknown
"-o")))
790 (when (or remaining-files
(and git-show-ignored
(not files
)))
791 (setq remaining-files
(git-run-ls-files-with-excludes git-status remaining-files
'ignored
"-o" "-i")))
793 (setq remaining-files
(git-get-filenames (ewoc-collect git-status
#'git-fileinfo-
>needs-update
))))
794 (when remaining-files
795 (setq remaining-files
(git-run-ls-files-cached git-status remaining-files
'uptodate
)))
796 (git-set-filenames-state git-status remaining-files nil
)
797 (when mark-files
(git-mark-files git-status files
))
799 (git-refresh-ewoc-hf git-status
)))
801 (defun git-mark-files (status files
)
802 "Mark all the specified FILES, and unmark the others."
803 (let ((file (and files
(pop files
)))
804 (node (ewoc-nth status
0)))
806 (let ((info (ewoc-data node
)))
807 (if (and file
(string-equal (git-fileinfo->name info
) file
))
809 (unless (git-fileinfo->marked info
)
810 (setf (git-fileinfo->marked info
) t
)
811 (setf (git-fileinfo->needs-refresh info
) t
))
812 (setq file
(pop files
))
813 (setq node
(ewoc-next status node
)))
814 (when (git-fileinfo->marked info
)
815 (setf (git-fileinfo->marked info
) nil
)
816 (setf (git-fileinfo->needs-refresh info
) t
))
817 (if (and file
(string-lessp file
(git-fileinfo->name info
)))
818 (setq file
(pop files
))
819 (setq node
(ewoc-next status node
))))))))
821 (defun git-marked-files ()
822 "Return a list of all marked files, or if none a list containing just the file at cursor position."
823 (unless git-status
(error "Not in git-status buffer."))
824 (or (ewoc-collect git-status
(lambda (info) (git-fileinfo->marked info
)))
825 (list (ewoc-data (ewoc-locate git-status
)))))
827 (defun git-marked-files-state (&rest states
)
828 "Return marked files that are in the specified states."
829 (let ((files (git-marked-files))
832 (when (memq (git-fileinfo->state info
) states
)
836 (defun git-refresh-files ()
837 "Refresh all files that need it and clear the needs-refresh flag."
838 (unless git-status
(error "Not in git-status buffer."))
841 (let ((refresh (git-fileinfo->needs-refresh info
)))
842 (setf (git-fileinfo->needs-refresh info
) nil
)
845 ; move back to goal column
846 (when goal-column
(move-to-column goal-column
)))
848 (defun git-refresh-ewoc-hf (status)
849 "Refresh the ewoc header and footer."
850 (let ((branch (git-symbolic-ref "HEAD"))
851 (head (if (git-empty-db-p) "Nothing committed yet"
852 (git-get-commit-description "HEAD")))
853 (merge-heads (git-get-merge-heads)))
855 (format "Directory: %s\nBranch: %s\nHead: %s%s\n"
858 (if (string-match "^refs/heads/" branch
)
859 (substring branch
(match-end 0))
861 "none (detached HEAD)")
864 (concat "\nMerging: "
865 (mapconcat (lambda (str) (git-get-commit-description str
)) merge-heads
"\n "))
867 (if (ewoc-nth status
0) "" " No changes."))))
869 (defun git-get-filenames (files)
870 (mapcar (lambda (info) (git-fileinfo->name info
)) files
))
872 (defun git-update-index (index-file files
)
873 "Run git-update-index on a list of files."
874 (let ((process-environment (append (and index-file
(list (concat "GIT_INDEX_FILE=" index-file
)))
875 process-environment
))
876 added deleted modified
)
878 (case (git-fileinfo->state info
)
879 ('added
(push info added
))
880 ('deleted
(push info deleted
))
881 ('modified
(push info modified
))))
883 (or (not added
) (apply #'git-call-process-display-error
"update-index" "--add" "--" (git-get-filenames added
)))
884 (or (not deleted
) (apply #'git-call-process-display-error
"update-index" "--remove" "--" (git-get-filenames deleted
)))
885 (or (not modified
) (apply #'git-call-process-display-error
"update-index" "--" (git-get-filenames modified
))))))
887 (defun git-run-pre-commit-hook ()
888 "Run the pre-commit hook if any."
889 (unless git-status
(error "Not in git-status buffer."))
890 (let ((files (git-marked-files-state 'added
'deleted
'modified
)))
892 (not (file-executable-p ".git/hooks/pre-commit"))
893 (let ((index-file (make-temp-file "gitidx")))
895 (let ((head-tree (unless (git-empty-db-p) (git-rev-parse "HEAD^{tree}"))))
896 (git-read-tree head-tree index-file
)
897 (git-update-index index-file files
)
898 (git-run-hook "pre-commit" `(("GIT_INDEX_FILE" .
,index-file
))))
899 (delete-file index-file
))))))
901 (defun git-do-commit ()
902 "Perform the actual commit using the current buffer as log message."
904 (let ((buffer (current-buffer))
905 (index-file (make-temp-file "gitidx")))
906 (with-current-buffer log-edit-parent-buffer
907 (if (git-marked-files-state 'unmerged
)
908 (message "You cannot commit unmerged files, resolve them first.")
910 (let ((files (git-marked-files-state 'added
'deleted
'modified
))
912 (unless (git-empty-db-p)
913 (setq head
(git-rev-parse "HEAD")
914 head-tree
(git-rev-parse "HEAD^{tree}")))
915 (message "Running git commit...")
918 (git-read-tree head-tree index-file
)
919 (git-update-index nil files
) ;update both the default index
920 (git-update-index index-file files
) ;and the temporary one
921 (setq tree
(git-write-tree index-file
)))
922 (if (or (not (string-equal tree head-tree
))
923 (yes-or-no-p "The tree was not modified, do you really want to perform an empty commit? "))
924 (let ((commit (git-commit-tree buffer tree head
)))
926 (condition-case nil
(delete-file ".git/MERGE_HEAD") (error nil
))
927 (condition-case nil
(delete-file ".git/MERGE_MSG") (error nil
))
928 (with-current-buffer buffer
(erase-buffer))
929 (git-update-status-files (git-get-filenames files
))
930 (git-call-process nil
"rerere")
931 (git-call-process nil
"gc" "--auto")
932 (message "Committed %s." commit
)
933 (git-run-hook "post-commit" nil
)))
934 (message "Commit aborted."))))
935 (delete-file index-file
))))))
938 ;;;; Interactive functions
939 ;;;; ------------------------------------------------------------
941 (defun git-mark-file ()
942 "Mark the file that the cursor is on and move to the next one."
944 (unless git-status
(error "Not in git-status buffer."))
945 (let* ((pos (ewoc-locate git-status
))
946 (info (ewoc-data pos
)))
947 (setf (git-fileinfo->marked info
) t
)
948 (ewoc-invalidate git-status pos
)
949 (ewoc-goto-next git-status
1)))
951 (defun git-unmark-file ()
952 "Unmark the file that the cursor is on and move to the next one."
954 (unless git-status
(error "Not in git-status buffer."))
955 (let* ((pos (ewoc-locate git-status
))
956 (info (ewoc-data pos
)))
957 (setf (git-fileinfo->marked info
) nil
)
958 (ewoc-invalidate git-status pos
)
959 (ewoc-goto-next git-status
1)))
961 (defun git-unmark-file-up ()
962 "Unmark the file that the cursor is on and move to the previous one."
964 (unless git-status
(error "Not in git-status buffer."))
965 (let* ((pos (ewoc-locate git-status
))
966 (info (ewoc-data pos
)))
967 (setf (git-fileinfo->marked info
) nil
)
968 (ewoc-invalidate git-status pos
)
969 (ewoc-goto-prev git-status
1)))
971 (defun git-mark-all ()
974 (unless git-status
(error "Not in git-status buffer."))
975 (ewoc-map (lambda (info) (unless (git-fileinfo->marked info
)
976 (setf (git-fileinfo->marked info
) t
))) git-status
)
977 ; move back to goal column after invalidate
978 (when goal-column
(move-to-column goal-column
)))
980 (defun git-unmark-all ()
983 (unless git-status
(error "Not in git-status buffer."))
984 (ewoc-map (lambda (info) (when (git-fileinfo->marked info
)
985 (setf (git-fileinfo->marked info
) nil
)
987 ; move back to goal column after invalidate
988 (when goal-column
(move-to-column goal-column
)))
990 (defun git-toggle-all-marks ()
991 "Toggle all file marks."
993 (unless git-status
(error "Not in git-status buffer."))
994 (ewoc-map (lambda (info) (setf (git-fileinfo->marked info
) (not (git-fileinfo->marked info
))) t
) git-status
)
995 ; move back to goal column after invalidate
996 (when goal-column
(move-to-column goal-column
)))
998 (defun git-next-file (&optional n
)
999 "Move the selection down N files."
1001 (unless git-status
(error "Not in git-status buffer."))
1002 (ewoc-goto-next git-status n
))
1004 (defun git-prev-file (&optional n
)
1005 "Move the selection up N files."
1007 (unless git-status
(error "Not in git-status buffer."))
1008 (ewoc-goto-prev git-status n
))
1010 (defun git-next-unmerged-file (&optional n
)
1011 "Move the selection down N unmerged files."
1013 (unless git-status
(error "Not in git-status buffer."))
1014 (let* ((last (ewoc-locate git-status
))
1015 (node (ewoc-next git-status last
)))
1016 (while (and node
(> n
0))
1017 (when (eq 'unmerged
(git-fileinfo->state
(ewoc-data node
)))
1020 (setq node
(ewoc-next git-status node
)))
1021 (ewoc-goto-node git-status last
)))
1023 (defun git-prev-unmerged-file (&optional n
)
1024 "Move the selection up N unmerged files."
1026 (unless git-status
(error "Not in git-status buffer."))
1027 (let* ((last (ewoc-locate git-status
))
1028 (node (ewoc-prev git-status last
)))
1029 (while (and node
(> n
0))
1030 (when (eq 'unmerged
(git-fileinfo->state
(ewoc-data node
)))
1033 (setq node
(ewoc-prev git-status node
)))
1034 (ewoc-goto-node git-status last
)))
1036 (defun git-insert-file (file)
1037 "Insert file(s) into the git-status buffer."
1038 (interactive "fInsert file: ")
1039 (git-update-status-files (list (file-relative-name file
))))
1041 (defun git-add-file ()
1042 "Add marked file(s) to the index cache."
1044 (let ((files (git-get-filenames (git-marked-files-state 'unknown
'ignored
))))
1045 ;; FIXME: add support for directories
1047 (push (file-relative-name (read-file-name "File to add: " nil nil t
)) files
))
1048 (when (apply 'git-call-process-display-error
"update-index" "--add" "--" files
)
1049 (git-update-status-files files
)
1050 (git-success-message "Added" files
))))
1052 (defun git-ignore-file ()
1053 "Add marked file(s) to the ignore list."
1055 (let ((files (git-get-filenames (git-marked-files-state 'unknown
))))
1057 (push (file-relative-name (read-file-name "File to ignore: " nil nil t
)) files
))
1058 (dolist (f files
) (git-append-to-ignore f
))
1059 (git-update-status-files files
)
1060 (git-success-message "Ignored" files
)))
1062 (defun git-remove-file ()
1063 "Remove the marked file(s)."
1065 (let ((files (git-get-filenames (git-marked-files-state 'added
'modified
'unknown
'uptodate
'ignored
))))
1067 (push (file-relative-name (read-file-name "File to remove: " nil nil t
)) files
))
1069 (format "Remove %d file%s? " (length files
) (if (> (length files
) 1) "s" "")))
1071 (dolist (name files
)
1073 (if (file-directory-p name
)
1074 (delete-directory name
)
1075 (delete-file name
))))
1076 (when (apply 'git-call-process-display-error
"update-index" "--remove" "--" files
)
1077 (git-update-status-files files
)
1078 (git-success-message "Removed" files
)))
1079 (message "Aborting"))))
1081 (defun git-revert-file ()
1082 "Revert changes to the marked file(s)."
1084 (let ((files (git-marked-files-state 'added
'deleted
'modified
'unmerged
))
1088 (format "Revert %d file%s? " (length files
) (if (> (length files
) 1) "s" ""))))
1089 (dolist (info files
)
1090 (case (git-fileinfo->state info
)
1091 ('added
(push (git-fileinfo->name info
) added
))
1092 ('deleted
(push (git-fileinfo->name info
) modified
))
1093 ('unmerged
(push (git-fileinfo->name info
) modified
))
1094 ('modified
(push (git-fileinfo->name info
) modified
))))
1095 ;; check if a buffer contains one of the files and isn't saved
1096 (dolist (file modified
)
1097 (let ((buffer (get-file-buffer file
)))
1098 (when (and buffer
(buffer-modified-p buffer
))
1099 (error "Buffer %s is modified. Please kill or save modified buffers before reverting." (buffer-name buffer
)))))
1102 (apply 'git-call-process-display-error
"update-index" "--force-remove" "--" added
))
1104 (apply 'git-call-process-display-error
"checkout" "HEAD" modified
)))))
1105 (git-update-status-files (append added modified
))
1107 (dolist (file modified
)
1108 (let ((buffer (get-file-buffer file
)))
1109 (when buffer
(with-current-buffer buffer
(revert-buffer t t t
)))))
1110 (git-success-message "Reverted" (git-get-filenames files
)))))))
1112 (defun git-resolve-file ()
1113 "Resolve conflicts in marked file(s)."
1115 (let ((files (git-get-filenames (git-marked-files-state 'unmerged
))))
1117 (when (apply 'git-call-process-display-error
"update-index" "--" files
)
1118 (git-update-status-files files
)
1119 (git-success-message "Resolved" files
)))))
1121 (defun git-remove-handled ()
1122 "Remove handled files from the status list."
1124 (ewoc-filter git-status
1126 (case (git-fileinfo->state info
)
1127 ('ignored git-show-ignored
)
1128 ('uptodate git-show-uptodate
)
1129 ('unknown git-show-unknown
)
1131 (unless (ewoc-nth git-status
0) ; refresh header if list is empty
1132 (git-refresh-ewoc-hf git-status
)))
1134 (defun git-toggle-show-uptodate ()
1135 "Toogle the option for showing up-to-date files."
1137 (if (setq git-show-uptodate
(not git-show-uptodate
))
1138 (git-refresh-status)
1139 (git-remove-handled)))
1141 (defun git-toggle-show-ignored ()
1142 "Toogle the option for showing ignored files."
1144 (if (setq git-show-ignored
(not git-show-ignored
))
1146 (message "Inserting ignored files...")
1147 (git-run-ls-files-with-excludes git-status nil
'ignored
"-o" "-i")
1149 (git-refresh-ewoc-hf git-status
)
1150 (message "Inserting ignored files...done"))
1151 (git-remove-handled)))
1153 (defun git-toggle-show-unknown ()
1154 "Toogle the option for showing unknown files."
1156 (if (setq git-show-unknown
(not git-show-unknown
))
1158 (message "Inserting unknown files...")
1159 (git-run-ls-files-with-excludes git-status nil
'unknown
"-o")
1161 (git-refresh-ewoc-hf git-status
)
1162 (message "Inserting unknown files...done"))
1163 (git-remove-handled)))
1165 (defun git-expand-directory (info)
1166 "Expand the directory represented by INFO to list its files."
1167 (when (eq (lsh (git-fileinfo->new-perm info
) -
9) ?
\110)
1168 (let ((dir (git-fileinfo->name info
)))
1169 (git-set-filenames-state git-status
(list dir
) nil
)
1170 (git-run-ls-files-with-excludes git-status
(list (concat dir
"/")) 'unknown
"-o")
1172 (git-refresh-ewoc-hf git-status
)
1175 (defun git-setup-diff-buffer (buffer)
1176 "Setup a buffer for displaying a diff."
1177 (let ((dir default-directory
))
1178 (with-current-buffer buffer
1180 (goto-char (point-min))
1181 (setq default-directory dir
)
1182 (setq buffer-read-only t
)))
1183 (display-buffer buffer
)
1184 ; shrink window only if it displays the status buffer
1185 (when (eq (window-buffer) (current-buffer))
1186 (shrink-window-if-larger-than-buffer)))
1188 (defun git-diff-file ()
1189 "Diff the marked file(s) against HEAD."
1191 (let ((files (git-marked-files)))
1192 (git-setup-diff-buffer
1193 (apply #'git-run-command-buffer
"*git-diff*" "diff-index" "-p" "-M" "HEAD" "--" (git-get-filenames files
)))))
1195 (defun git-diff-file-merge-head (arg)
1196 "Diff the marked file(s) against the first merge head (or the nth one with a numeric prefix)."
1198 (let ((files (git-marked-files))
1199 (merge-heads (git-get-merge-heads)))
1200 (unless merge-heads
(error "No merge in progress"))
1201 (git-setup-diff-buffer
1202 (apply #'git-run-command-buffer
"*git-diff*" "diff-index" "-p" "-M"
1203 (or (nth (1- arg
) merge-heads
) "HEAD") "--" (git-get-filenames files
)))))
1205 (defun git-diff-unmerged-file (stage)
1206 "Diff the marked unmerged file(s) against the specified stage."
1207 (let ((files (git-marked-files)))
1208 (git-setup-diff-buffer
1209 (apply #'git-run-command-buffer
"*git-diff*" "diff-files" "-p" stage
"--" (git-get-filenames files
)))))
1211 (defun git-diff-file-base ()
1212 "Diff the marked unmerged file(s) against the common base file."
1214 (git-diff-unmerged-file "-1"))
1216 (defun git-diff-file-mine ()
1217 "Diff the marked unmerged file(s) against my pre-merge version."
1219 (git-diff-unmerged-file "-2"))
1221 (defun git-diff-file-other ()
1222 "Diff the marked unmerged file(s) against the other's pre-merge version."
1224 (git-diff-unmerged-file "-3"))
1226 (defun git-diff-file-combined ()
1227 "Do a combined diff of the marked unmerged file(s)."
1229 (git-diff-unmerged-file "-c"))
1231 (defun git-diff-file-idiff ()
1232 "Perform an interactive diff on the current file."
1234 (let ((files (git-marked-files-state 'added
'deleted
'modified
)))
1235 (unless (eq 1 (length files
))
1236 (error "Cannot perform an interactive diff on multiple files."))
1237 (let* ((filename (car (git-get-filenames files
)))
1238 (buff1 (find-file-noselect filename
))
1239 (buff2 (git-run-command-buffer (concat filename
".~HEAD~") "cat-file" "blob" (concat "HEAD:" filename
))))
1240 (ediff-buffers buff1 buff2
))))
1242 (defun git-log-file ()
1243 "Display a log of changes to the marked file(s)."
1245 (let* ((files (git-marked-files))
1246 (coding-system-for-read git-commits-coding-system
)
1247 (buffer (apply #'git-run-command-buffer
"*git-log*" "rev-list" "--pretty" "HEAD" "--" (git-get-filenames files
))))
1248 (with-current-buffer buffer
1249 ; (git-log-mode) FIXME: implement log mode
1250 (goto-char (point-min))
1251 (setq buffer-read-only t
))
1252 (display-buffer buffer
)))
1254 (defun git-log-edit-files ()
1255 "Return a list of marked files for use in the log-edit buffer."
1256 (with-current-buffer log-edit-parent-buffer
1257 (git-get-filenames (git-marked-files-state 'added
'deleted
'modified
))))
1259 (defun git-log-edit-diff ()
1260 "Run a diff of the current files being committed from a log-edit buffer."
1261 (with-current-buffer log-edit-parent-buffer
1264 (defun git-append-sign-off (name email
)
1265 "Append a Signed-off-by entry to the current buffer, avoiding duplicates."
1266 (let ((sign-off (format "Signed-off-by: %s <%s>" name email
))
1267 (case-fold-search t
))
1268 (goto-char (point-min))
1269 (unless (re-search-forward (concat "^" (regexp-quote sign-off
)) nil t
)
1270 (goto-char (point-min))
1271 (unless (re-search-forward "^Signed-off-by: " nil t
)
1272 (setq sign-off
(concat "\n" sign-off
)))
1273 (goto-char (point-max))
1274 (insert sign-off
"\n"))))
1276 (defun git-setup-log-buffer (buffer &optional merge-heads author-name author-email subject date msg
)
1277 "Setup the log buffer for a commit."
1278 (unless git-status
(error "Not in git-status buffer."))
1279 (let ((dir default-directory
)
1280 (committer-name (git-get-committer-name))
1281 (committer-email (git-get-committer-email))
1282 (sign-off git-append-signed-off-by
))
1283 (with-current-buffer buffer
1288 (format "Author: %s <%s>\n%s%s"
1289 (or author-name committer-name
)
1290 (or author-email committer-email
)
1291 (if date
(format "Date: %s\n" date
) "")
1293 (format "Merge: %s\n"
1294 (mapconcat 'identity merge-heads
" "))
1296 'face
'git-header-face
)
1297 (propertize git-log-msg-separator
'face
'git-separator-face
)
1299 (when subject
(insert subject
"\n\n"))
1300 (cond (msg (insert msg
"\n"))
1301 ((file-readable-p ".git/rebase-apply/msg")
1302 (insert-file-contents ".git/rebase-apply/msg"))
1303 ((file-readable-p ".git/MERGE_MSG")
1304 (insert-file-contents ".git/MERGE_MSG")))
1305 ; delete empty lines at end
1306 (goto-char (point-min))
1307 (when (re-search-forward "\n+\\'" nil t
)
1308 (replace-match "\n" t t
))
1309 (when sign-off
(git-append-sign-off committer-name committer-email
)))
1312 (defun git-commit-file ()
1313 "Commit the marked file(s), asking for a commit message."
1315 (unless git-status
(error "Not in git-status buffer."))
1316 (when (git-run-pre-commit-hook)
1317 (let ((buffer (get-buffer-create "*git-commit*"))
1318 (coding-system (git-get-commits-coding-system))
1319 author-name author-email subject date
)
1320 (when (eq 0 (buffer-size buffer
))
1321 (when (file-readable-p ".git/rebase-apply/info")
1323 (insert-file-contents ".git/rebase-apply/info")
1324 (goto-char (point-min))
1325 (when (re-search-forward "^Author: \\(.*\\)\nEmail: \\(.*\\)$" nil t
)
1326 (setq author-name
(match-string 1))
1327 (setq author-email
(match-string 2)))
1328 (goto-char (point-min))
1329 (when (re-search-forward "^Subject: \\(.*\\)$" nil t
)
1330 (setq subject
(match-string 1)))
1331 (goto-char (point-min))
1332 (when (re-search-forward "^Date: \\(.*\\)$" nil t
)
1333 (setq date
(match-string 1)))))
1334 (git-setup-log-buffer buffer
(git-get-merge-heads) author-name author-email subject date
))
1335 (if (boundp 'log-edit-diff-function
)
1336 (log-edit 'git-do-commit nil
'((log-edit-listfun . git-log-edit-files
)
1337 (log-edit-diff-function . git-log-edit-diff
)) buffer
)
1338 (log-edit 'git-do-commit nil
'git-log-edit-files buffer
))
1339 (setq font-lock-keywords
(font-lock-compile-keywords git-log-edit-font-lock-keywords
))
1340 (setq paragraph-separate
(concat (regexp-quote git-log-msg-separator
) "$\\|Author: \\|Date: \\|Merge: \\|Signed-off-by: \\|\f\\|[ ]*$"))
1341 (setq buffer-file-coding-system coding-system
)
1342 (re-search-forward (regexp-quote (concat git-log-msg-separator
"\n")) nil t
))))
1344 (defun git-setup-commit-buffer (commit)
1345 "Setup the commit buffer with the contents of COMMIT."
1346 (let (parents author-name author-email subject date msg
)
1348 (let ((coding-system (git-get-logoutput-coding-system)))
1349 (git-call-process t
"log" "-1" "--pretty=medium" "--abbrev=40" commit
)
1350 (goto-char (point-min))
1351 (when (re-search-forward "^Merge: *\\(.*\\)$" nil t
)
1352 (setq parents
(cdr (split-string (match-string 1) " +"))))
1353 (when (re-search-forward "^Author: *\\(.*\\) <\\(.*\\)>$" nil t
)
1354 (setq author-name
(match-string 1))
1355 (setq author-email
(match-string 2)))
1356 (when (re-search-forward "^Date: *\\(.*\\)$" nil t
)
1357 (setq date
(match-string 1)))
1358 (while (re-search-forward "^ \\(.*\\)$" nil t
)
1359 (push (match-string 1) msg
))
1360 (setq msg
(nreverse msg
))
1361 (setq subject
(pop msg
))
1362 (while (and msg
(zerop (length (car msg
))) (pop msg
)))))
1363 (git-setup-log-buffer (get-buffer-create "*git-commit*")
1364 parents author-name author-email subject date
1365 (mapconcat #'identity msg
"\n"))))
1367 (defun git-get-commit-files (commit)
1368 "Retrieve the list of files modified by COMMIT."
1371 (git-call-process t
"diff-tree" "-m" "-r" "-z" "--name-only" "--no-commit-id" "--root" commit
)
1372 (goto-char (point-min))
1373 (while (re-search-forward "\\([^\0]*\\)\0" nil t
1)
1374 (push (match-string 1) files
)))
1377 (defun git-read-commit-name (prompt &optional default
)
1378 "Ask for a commit name, with completion for local branch, remote branch and tag."
1379 (completing-read prompt
1380 (list* "HEAD" "ORIG_HEAD" "FETCH_HEAD" (mapcar #'car
(git-for-each-ref)))
1381 nil nil nil nil default
))
1383 (defun git-checkout (branch &optional merge
)
1384 "Checkout a branch, tag, or any commit.
1385 Use a prefix arg if git should merge while checking out."
1387 (list (git-read-commit-name "Checkout: ")
1388 current-prefix-arg
))
1389 (unless git-status
(error "Not in git-status buffer."))
1390 (let ((args (list branch
"--")))
1391 (when merge
(push "-m" args
))
1392 (when (apply #'git-call-process-display-error
"checkout" args
)
1393 (git-update-status-files))))
1395 (defun git-branch (branch)
1396 "Create a branch from the current HEAD and switch to it."
1397 (interactive (list (git-read-commit-name "Branch: ")))
1398 (unless git-status
(error "Not in git-status buffer."))
1399 (if (git-rev-parse (concat "refs/heads/" branch
))
1400 (if (yes-or-no-p (format "Branch %s already exists, replace it? " branch
))
1401 (and (git-call-process-display-error "branch" "-f" branch
)
1402 (git-call-process-display-error "checkout" branch
))
1403 (message "Canceled."))
1404 (git-call-process-display-error "checkout" "-b" branch
))
1405 (git-refresh-ewoc-hf git-status
))
1407 (defun git-amend-commit ()
1408 "Undo the last commit on HEAD, and set things up to commit an
1409 amended version of it."
1411 (unless git-status
(error "Not in git-status buffer."))
1412 (when (git-empty-db-p) (error "No commit to amend."))
1413 (let* ((commit (git-rev-parse "HEAD"))
1414 (files (git-get-commit-files commit
)))
1415 (when (if (git-rev-parse "HEAD^")
1416 (git-call-process-display-error "reset" "--soft" "HEAD^")
1417 (and (git-update-ref "ORIG_HEAD" commit
)
1418 (git-update-ref "HEAD" nil commit
)))
1419 (git-update-status-files files t
)
1420 (git-setup-commit-buffer commit
)
1421 (git-commit-file))))
1423 (defun git-cherry-pick-commit (arg)
1424 "Cherry-pick a commit."
1425 (interactive (list (git-read-commit-name "Cherry-pick commit: ")))
1426 (unless git-status
(error "Not in git-status buffer."))
1427 (let ((commit (git-rev-parse (concat arg
"^0"))))
1428 (unless commit
(error "Not a valid commit '%s'." arg
))
1429 (when (git-rev-parse (concat commit
"^2"))
1430 (error "Cannot cherry-pick a merge commit."))
1431 (let ((files (git-get-commit-files commit
))
1432 (ok (git-call-process-display-error "cherry-pick" "-n" commit
)))
1433 (git-update-status-files files ok
)
1434 (with-current-buffer (git-setup-commit-buffer commit
)
1435 (goto-char (point-min))
1436 (if (re-search-forward "^\n*Signed-off-by:" nil t
1)
1437 (goto-char (match-beginning 0))
1438 (goto-char (point-max)))
1439 (insert "(cherry picked from commit " commit
")\n"))
1440 (when ok
(git-commit-file)))))
1442 (defun git-revert-commit (arg)
1444 (interactive (list (git-read-commit-name "Revert commit: ")))
1445 (unless git-status
(error "Not in git-status buffer."))
1446 (let ((commit (git-rev-parse (concat arg
"^0"))))
1447 (unless commit
(error "Not a valid commit '%s'." arg
))
1448 (when (git-rev-parse (concat commit
"^2"))
1449 (error "Cannot revert a merge commit."))
1450 (let ((files (git-get-commit-files commit
))
1451 (subject (git-get-commit-description commit
))
1452 (ok (git-call-process-display-error "revert" "-n" commit
)))
1453 (git-update-status-files files ok
)
1454 (when (string-match "^[0-9a-f]+ - \\(.*\\)$" subject
)
1455 (setq subject
(match-string 1 subject
)))
1456 (git-setup-log-buffer (get-buffer-create "*git-commit*")
1457 (git-get-merge-heads) nil nil
(format "Revert \"%s\"" subject
) nil
1458 (format "This reverts commit %s.\n" commit
))
1459 (when ok
(git-commit-file)))))
1461 (defun git-find-file ()
1462 "Visit the current file in its own buffer."
1464 (unless git-status
(error "Not in git-status buffer."))
1465 (let ((info (ewoc-data (ewoc-locate git-status
))))
1466 (unless (git-expand-directory info
)
1467 (find-file (git-fileinfo->name info
))
1468 (when (eq 'unmerged
(git-fileinfo->state info
))
1471 (defun git-find-file-other-window ()
1472 "Visit the current file in its own buffer in another window."
1474 (unless git-status
(error "Not in git-status buffer."))
1475 (let ((info (ewoc-data (ewoc-locate git-status
))))
1476 (find-file-other-window (git-fileinfo->name info
))
1477 (when (eq 'unmerged
(git-fileinfo->state info
))
1480 (defun git-find-file-imerge ()
1481 "Visit the current file in interactive merge mode."
1483 (unless git-status
(error "Not in git-status buffer."))
1484 (let ((info (ewoc-data (ewoc-locate git-status
))))
1485 (find-file (git-fileinfo->name info
))
1488 (defun git-view-file ()
1489 "View the current file in its own buffer."
1491 (unless git-status
(error "Not in git-status buffer."))
1492 (let ((info (ewoc-data (ewoc-locate git-status
))))
1493 (view-file (git-fileinfo->name info
))))
1495 (defun git-refresh-status ()
1496 "Refresh the git status buffer."
1498 (unless git-status
(error "Not in git-status buffer."))
1499 (message "Refreshing git status...")
1500 (git-update-status-files)
1501 (message "Refreshing git status...done"))
1503 (defun git-status-quit ()
1504 "Quit git-status mode."
1509 ;;;; ------------------------------------------------------------
1511 (defvar git-status-mode-hook nil
1512 "Run after `git-status-mode' is setup.")
1514 (defvar git-status-mode-map nil
1515 "Keymap for git major mode.")
1517 (defvar git-status nil
1518 "List of all files managed by the git-status mode.")
1520 (unless git-status-mode-map
1521 (let ((map (make-keymap))
1522 (commit-map (make-sparse-keymap))
1523 (diff-map (make-sparse-keymap))
1524 (toggle-map (make-sparse-keymap)))
1525 (suppress-keymap map
)
1526 (define-key map
"?" 'git-help
)
1527 (define-key map
"h" 'git-help
)
1528 (define-key map
" " 'git-next-file
)
1529 (define-key map
"a" 'git-add-file
)
1530 (define-key map
"c" 'git-commit-file
)
1531 (define-key map
"\C-c" commit-map
)
1532 (define-key map
"d" diff-map
)
1533 (define-key map
"=" 'git-diff-file
)
1534 (define-key map
"f" 'git-find-file
)
1535 (define-key map
"\r" 'git-find-file
)
1536 (define-key map
"g" 'git-refresh-status
)
1537 (define-key map
"i" 'git-ignore-file
)
1538 (define-key map
"I" 'git-insert-file
)
1539 (define-key map
"l" 'git-log-file
)
1540 (define-key map
"m" 'git-mark-file
)
1541 (define-key map
"M" 'git-mark-all
)
1542 (define-key map
"n" 'git-next-file
)
1543 (define-key map
"N" 'git-next-unmerged-file
)
1544 (define-key map
"o" 'git-find-file-other-window
)
1545 (define-key map
"p" 'git-prev-file
)
1546 (define-key map
"P" 'git-prev-unmerged-file
)
1547 (define-key map
"q" 'git-status-quit
)
1548 (define-key map
"r" 'git-remove-file
)
1549 (define-key map
"R" 'git-resolve-file
)
1550 (define-key map
"t" toggle-map
)
1551 (define-key map
"T" 'git-toggle-all-marks
)
1552 (define-key map
"u" 'git-unmark-file
)
1553 (define-key map
"U" 'git-revert-file
)
1554 (define-key map
"v" 'git-view-file
)
1555 (define-key map
"x" 'git-remove-handled
)
1556 (define-key map
"\C-?" 'git-unmark-file-up
)
1557 (define-key map
"\M-\C-?" 'git-unmark-all
)
1559 (define-key commit-map
"\C-a" 'git-amend-commit
)
1560 (define-key commit-map
"\C-b" 'git-branch
)
1561 (define-key commit-map
"\C-o" 'git-checkout
)
1562 (define-key commit-map
"\C-p" 'git-cherry-pick-commit
)
1563 (define-key commit-map
"\C-v" 'git-revert-commit
)
1565 (define-key diff-map
"b" 'git-diff-file-base
)
1566 (define-key diff-map
"c" 'git-diff-file-combined
)
1567 (define-key diff-map
"=" 'git-diff-file
)
1568 (define-key diff-map
"e" 'git-diff-file-idiff
)
1569 (define-key diff-map
"E" 'git-find-file-imerge
)
1570 (define-key diff-map
"h" 'git-diff-file-merge-head
)
1571 (define-key diff-map
"m" 'git-diff-file-mine
)
1572 (define-key diff-map
"o" 'git-diff-file-other
)
1574 (define-key toggle-map
"u" 'git-toggle-show-uptodate
)
1575 (define-key toggle-map
"i" 'git-toggle-show-ignored
)
1576 (define-key toggle-map
"k" 'git-toggle-show-unknown
)
1577 (define-key toggle-map
"m" 'git-toggle-all-marks
)
1578 (setq git-status-mode-map map
))
1579 (easy-menu-define git-menu git-status-mode-map
1582 ["Refresh" git-refresh-status t
]
1583 ["Commit" git-commit-file t
]
1584 ["Checkout..." git-checkout t
]
1585 ["New Branch..." git-branch t
]
1586 ["Cherry-pick Commit..." git-cherry-pick-commit t
]
1587 ["Revert Commit..." git-revert-commit t
]
1589 ["Next Unmerged File" git-next-unmerged-file t
]
1590 ["Prev Unmerged File" git-prev-unmerged-file t
]
1591 ["Mark as Resolved" git-resolve-file t
]
1592 ["Interactive Merge File" git-find-file-imerge t
]
1593 ["Diff Against Common Base File" git-diff-file-base t
]
1594 ["Diff Combined" git-diff-file-combined t
]
1595 ["Diff Against Merge Head" git-diff-file-merge-head t
]
1596 ["Diff Against Mine" git-diff-file-mine t
]
1597 ["Diff Against Other" git-diff-file-other t
])
1599 ["Add File" git-add-file t
]
1600 ["Revert File" git-revert-file t
]
1601 ["Ignore File" git-ignore-file t
]
1602 ["Remove File" git-remove-file t
]
1603 ["Insert File" git-insert-file t
]
1605 ["Find File" git-find-file t
]
1606 ["View File" git-view-file t
]
1607 ["Diff File" git-diff-file t
]
1608 ["Interactive Diff File" git-diff-file-idiff t
]
1609 ["Log" git-log-file t
]
1611 ["Mark" git-mark-file t
]
1612 ["Mark All" git-mark-all t
]
1613 ["Unmark" git-unmark-file t
]
1614 ["Unmark All" git-unmark-all t
]
1615 ["Toggle All Marks" git-toggle-all-marks t
]
1616 ["Hide Handled Files" git-remove-handled t
]
1618 ["Show Uptodate Files" git-toggle-show-uptodate
:style toggle
:selected git-show-uptodate
]
1619 ["Show Ignored Files" git-toggle-show-ignored
:style toggle
:selected git-show-ignored
]
1620 ["Show Unknown Files" git-toggle-show-unknown
:style toggle
:selected git-show-unknown
]
1622 ["Quit" git-status-quit t
])))
1625 ;; git mode should only run in the *git status* buffer
1626 (put 'git-status-mode
'mode-class
'special
)
1628 (defun git-status-mode ()
1629 "Major mode for interacting with Git.
1631 \\{git-status-mode-map}"
1632 (kill-all-local-variables)
1633 (buffer-disable-undo)
1634 (setq mode-name
"git status"
1635 major-mode
'git-status-mode
1638 (use-local-map git-status-mode-map
)
1639 (let ((buffer-read-only nil
))
1641 (let ((status (ewoc-create 'git-fileinfo-prettyprint
"" "")))
1642 (set (make-local-variable 'git-status
) status
))
1643 (set (make-local-variable 'list-buffers-directory
) default-directory
)
1644 (make-local-variable 'git-show-uptodate
)
1645 (make-local-variable 'git-show-ignored
)
1646 (make-local-variable 'git-show-unknown
)
1647 (run-hooks 'git-status-mode-hook
)))
1649 (defun git-find-status-buffer (dir)
1650 "Find the git status buffer handling a specified directory."
1651 (let ((list (buffer-list))
1652 (fulldir (expand-file-name dir
))
1654 (while (and list
(not found
))
1655 (let ((buffer (car list
)))
1656 (with-current-buffer buffer
1657 (when (and list-buffers-directory
1658 (string-equal fulldir
(expand-file-name list-buffers-directory
))
1659 (eq major-mode
'git-status-mode
))
1660 (setq found buffer
))))
1661 (setq list
(cdr list
)))
1664 (defun git-status (dir)
1665 "Entry point into git-status mode."
1666 (interactive "DSelect directory: ")
1667 (setq dir
(git-get-top-dir dir
))
1668 (if (file-directory-p (concat (file-name-as-directory dir
) ".git"))
1669 (let ((buffer (or (and git-reuse-status-buffer
(git-find-status-buffer dir
))
1670 (create-file-buffer (expand-file-name "*git-status*" dir
)))))
1671 (switch-to-buffer buffer
)
1674 (git-refresh-status)
1675 (goto-char (point-min))
1676 (add-hook 'after-save-hook
'git-update-saved-file
))
1677 (message "%s is not a git working tree." dir
)))
1679 (defun git-update-saved-file ()
1680 "Update the corresponding git-status buffer when a file is saved.
1681 Meant to be used in `after-save-hook'."
1682 (let* ((file (expand-file-name buffer-file-name
))
1683 (dir (condition-case nil
(git-get-top-dir (file-name-directory file
)) (error nil
)))
1684 (buffer (and dir
(git-find-status-buffer dir
))))
1686 (with-current-buffer buffer
1687 (let ((filename (file-relative-name file dir
)))
1688 ; skip files located inside the .git directory
1689 (unless (string-match "^\\.git/" filename
)
1690 (git-call-process nil
"add" "--refresh" "--" filename
)
1691 (git-update-status-files (list filename
))))))))
1694 "Display help for Git mode."
1696 (describe-function 'git-status-mode
))
1699 ;;; git.el ends here