1 ;;; git.el --- A user interface for git
3 ;; Copyright (C) 2005, 2006, 2007 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 ;; - portability to XEmacs
38 ;; - better handling of subprocess errors
39 ;; - hook into file save (after-save-hook)
40 ;; - diff against other branch
41 ;; - renaming files from the status buffer
44 ;; - switching branches
46 ;; - git-show-branch browser
50 (eval-when-compile (require 'cl
))
56 ;;;; ------------------------------------------------------------
59 "A user interface for the git versioning system."
62 (defcustom git-committer-name nil
63 "User name to use for commits.
64 The default is to fall back to the repository config,
65 then to `add-log-full-name' and then to `user-full-name'."
67 :type
'(choice (const :tag
"Default" nil
)
68 (string :tag
"Name")))
70 (defcustom git-committer-email nil
71 "Email address to use for commits.
72 The default is to fall back to the git repository config,
73 then to `add-log-mailing-address' and then to `user-mail-address'."
75 :type
'(choice (const :tag
"Default" nil
)
76 (string :tag
"Email")))
78 (defcustom git-commits-coding-system nil
79 "Default coding system for the log message of git commits."
81 :type
'(choice (const :tag
"From repository config" nil
)
84 (defcustom git-append-signed-off-by nil
85 "Whether to append a Signed-off-by line to the commit message before editing."
89 (defcustom git-reuse-status-buffer t
90 "Whether `git-status' should try to reuse an existing buffer
91 if there is already one that displays the same directory."
95 (defcustom git-per-dir-ignore-file
".gitignore"
96 "Name of the per-directory ignore file."
101 (defface git-status-face
102 '((((class color
) (background light
)) (:foreground
"purple")))
103 "Git mode face used to highlight added and modified files."
106 (defface git-unmerged-face
107 '((((class color
) (background light
)) (:foreground
"red" :bold t
)))
108 "Git mode face used to highlight unmerged files."
111 (defface git-unknown-face
112 '((((class color
) (background light
)) (:foreground
"goldenrod" :bold t
)))
113 "Git mode face used to highlight unknown files."
116 (defface git-uptodate-face
117 '((((class color
) (background light
)) (:foreground
"grey60")))
118 "Git mode face used to highlight up-to-date files."
121 (defface git-ignored-face
122 '((((class color
) (background light
)) (:foreground
"grey60")))
123 "Git mode face used to highlight ignored files."
126 (defface git-mark-face
127 '((((class color
) (background light
)) (:foreground
"red" :bold t
)))
128 "Git mode face used for the file marks."
131 (defface git-header-face
132 '((((class color
) (background light
)) (:foreground
"blue")))
133 "Git mode face used for commit headers."
136 (defface git-separator-face
137 '((((class color
) (background light
)) (:foreground
"brown")))
138 "Git mode face used for commit separator."
141 (defface git-permission-face
142 '((((class color
) (background light
)) (:foreground
"green" :bold t
)))
143 "Git mode face used for permission changes."
148 ;;;; ------------------------------------------------------------
150 (defconst git-log-msg-separator
"--- log message follows this line ---")
152 (defvar git-log-edit-font-lock-keywords
153 `(("^\\(Author:\\|Date:\\|Parent:\\|Signed-off-by:\\)\\(.*\\)$"
154 (1 font-lock-keyword-face
)
155 (2 font-lock-function-name-face
))
156 (,(concat "^\\(" (regexp-quote git-log-msg-separator
) "\\)$")
157 (1 font-lock-comment-face
))))
159 (defun git-get-env-strings (env)
160 "Build a list of NAME=VALUE strings from a list of environment strings."
161 (mapcar (lambda (entry) (concat (car entry
) "=" (cdr entry
))) env
))
163 (defun git-call-process-env (buffer env
&rest args
)
164 "Wrapper for call-process that sets environment strings."
166 (apply #'call-process
"env" nil buffer nil
167 (append (git-get-env-strings env
) (list "git") args
))
168 (apply #'call-process
"git" nil buffer nil args
)))
170 (defun git-call-process-env-string (env &rest args
)
171 "Wrapper for call-process that sets environment strings,
172 and returns the process output as a string."
174 (and (eq 0 (apply #' git-call-process-env t env args
))
177 (defun git-run-process-region (buffer start end program args
)
178 "Run a git process with a buffer region as input."
179 (let ((output-buffer (current-buffer))
180 (dir default-directory
))
181 (with-current-buffer buffer
183 (apply #'call-process-region start end program
184 nil
(list output-buffer nil
) nil args
))))
186 (defun git-run-command-buffer (buffer-name &rest args
)
187 "Run a git command, sending the output to a buffer named BUFFER-NAME."
188 (let ((dir default-directory
)
189 (buffer (get-buffer-create buffer-name
)))
190 (message "Running git %s..." (car args
))
191 (with-current-buffer buffer
192 (let ((default-directory dir
)
193 (buffer-read-only nil
))
195 (apply #'git-call-process-env buffer nil args
)))
196 (message "Running git %s...done" (car args
))
199 (defun git-run-command (buffer env
&rest args
)
200 (message "Running git %s..." (car args
))
201 (apply #'git-call-process-env buffer env args
)
202 (message "Running git %s...done" (car args
)))
204 (defun git-run-command-region (buffer start end env
&rest args
)
205 "Run a git command with specified buffer region as input."
206 (message "Running git %s..." (car args
))
207 (unless (eq 0 (if env
208 (git-run-process-region
209 buffer start end
"env"
210 (append (git-get-env-strings env
) (list "git") args
))
211 (git-run-process-region
212 buffer start end
"git" args
)))
213 (error "Failed to run \"git %s\":\n%s" (mapconcat (lambda (x) x
) args
" ") (buffer-string)))
214 (message "Running git %s...done" (car args
)))
216 (defun git-run-hook (hook env
&rest args
)
217 "Run a git hook and display its output if any."
218 (let ((dir default-directory
)
219 (hook-name (expand-file-name (concat ".git/hooks/" hook
))))
220 (or (not (file-executable-p hook-name
))
221 (let (status (buffer (get-buffer-create "*Git Hook Output*")))
222 (with-current-buffer buffer
227 (apply #'call-process
"env" nil
(list buffer t
) nil
228 (append (git-get-env-strings env
) (list hook-name
) args
))
229 (apply #'call-process hook-name nil
(list buffer t
) nil args
))))
230 (display-message-or-buffer buffer
)
233 (defun git-get-string-sha1 (string)
234 "Read a SHA1 from the specified string."
236 (string-match "[0-9a-f]\\{40\\}" string
)
237 (match-string 0 string
)))
239 (defun git-get-committer-name ()
240 "Return the name to use as GIT_COMMITTER_NAME."
241 ; copied from log-edit
242 (or git-committer-name
243 (git-config "user.name")
244 (and (boundp 'add-log-full-name
) add-log-full-name
)
245 (and (fboundp 'user-full-name
) (user-full-name))
246 (and (boundp 'user-full-name
) user-full-name
)))
248 (defun git-get-committer-email ()
249 "Return the email address to use as GIT_COMMITTER_EMAIL."
250 ; copied from log-edit
251 (or git-committer-email
252 (git-config "user.email")
253 (and (boundp 'add-log-mailing-address
) add-log-mailing-address
)
254 (and (fboundp 'user-mail-address
) (user-mail-address))
255 (and (boundp 'user-mail-address
) user-mail-address
)))
257 (defun git-get-commits-coding-system ()
258 "Return the coding system to use for commits."
259 (let ((repo-config (git-config "i18n.commitencoding")))
260 (or git-commits-coding-system
262 (fboundp 'locale-charset-to-coding-system
)
263 (locale-charset-to-coding-system repo-config
))
266 (defun git-get-logoutput-coding-system ()
267 "Return the coding system used for git-log output."
268 (let ((repo-config (or (git-config "i18n.logoutputencoding")
269 (git-config "i18n.commitencoding"))))
270 (or git-commits-coding-system
272 (fboundp 'locale-charset-to-coding-system
)
273 (locale-charset-to-coding-system repo-config
))
276 (defun git-escape-file-name (name)
277 "Escape a file name if necessary."
278 (if (string-match "[\n\t\"\\]" name
)
280 (mapconcat (lambda (c)
286 (t (char-to-string c
))))
291 (defun git-get-top-dir (dir)
292 "Retrieve the top-level directory of a git tree."
293 (let ((cdup (with-output-to-string
294 (with-current-buffer standard-output
296 (unless (eq 0 (call-process "git" nil t nil
"rev-parse" "--show-cdup"))
297 (error "cannot find top-level git tree for %s." dir
))))))
298 (expand-file-name (concat (file-name-as-directory dir
)
299 (car (split-string cdup
"\n"))))))
302 (defun git-append-to-ignore (file)
303 "Add a file name to the ignore file in its directory."
304 (let* ((fullname (expand-file-name file
))
305 (dir (file-name-directory fullname
))
306 (name (file-name-nondirectory fullname
))
307 (ignore-name (expand-file-name git-per-dir-ignore-file dir
))
308 (created (not (file-exists-p ignore-name
))))
309 (save-window-excursion
310 (set-buffer (find-file-noselect ignore-name
))
311 (goto-char (point-max))
312 (unless (zerop (current-column)) (insert "\n"))
313 (insert "/" name
"\n")
314 (sort-lines nil
(point-min) (point-max))
317 (git-run-command nil nil
"update-index" "--info-only" "--add" "--" (file-relative-name ignore-name
)))
318 (git-add-status-file (if created
'added
'modified
) (file-relative-name ignore-name
))))
320 ; propertize definition for XEmacs, stolen from erc-compat
322 (unless (fboundp 'propertize
)
323 (defun propertize (string &rest props
)
324 (let ((string (copy-sequence string
)))
326 (put-text-property 0 (length string
) (nth 0 props
) (nth 1 props
) string
)
327 (setq props
(cddr props
)))
330 ;;;; Wrappers for basic git commands
331 ;;;; ------------------------------------------------------------
333 (defun git-rev-parse (rev)
334 "Parse a revision name and return its SHA1."
336 (git-call-process-env-string nil
"rev-parse" rev
)))
338 (defun git-config (key)
339 "Retrieve the value associated to KEY in the git repository config file."
340 (let ((str (git-call-process-env-string nil
"config" key
)))
341 (and str
(car (split-string str
"\n")))))
343 (defun git-symbolic-ref (ref)
344 "Wrapper for the git-symbolic-ref command."
345 (let ((str (git-call-process-env-string nil
"symbolic-ref" ref
)))
346 (and str
(car (split-string str
"\n")))))
348 (defun git-update-ref (ref newval
&optional oldval reason
)
349 "Update a reference by calling git-update-ref."
350 (let ((args (and oldval
(list oldval
))))
356 (eq 0 (apply #'git-call-process-env nil nil
"update-ref" args
))))
358 (defun git-read-tree (tree &optional index-file
)
359 "Read a tree into the index file."
360 (apply #'git-call-process-env nil
361 (if index-file
`(("GIT_INDEX_FILE" .
,index-file
)) nil
)
362 "read-tree" (if tree
(list tree
))))
364 (defun git-write-tree (&optional index-file
)
365 "Call git-write-tree and return the resulting tree SHA1 as a string."
367 (git-call-process-env-string (and index-file
`(("GIT_INDEX_FILE" .
,index-file
))) "write-tree")))
369 (defun git-commit-tree (buffer tree head
)
370 "Call git-commit-tree with buffer as input and return the resulting commit SHA1."
371 (let ((author-name (git-get-committer-name))
372 (author-email (git-get-committer-email))
373 (subject "commit (initial): ")
374 author-date log-start log-end args coding-system-for-write
)
376 (setq subject
"commit: ")
379 (with-current-buffer buffer
380 (goto-char (point-min))
382 (setq log-start
(re-search-forward (concat "^" (regexp-quote git-log-msg-separator
) "\n") nil t
))
384 (narrow-to-region (point-min) log-start
)
385 (goto-char (point-min))
386 (when (re-search-forward "^Author: +\\(.*?\\) *<\\(.*\\)> *$" nil t
)
387 (setq author-name
(match-string 1)
388 author-email
(match-string 2)))
389 (goto-char (point-min))
390 (when (re-search-forward "^Date: +\\(.*\\)$" nil t
)
391 (setq author-date
(match-string 1)))
392 (goto-char (point-min))
393 (while (re-search-forward "^Parent: +\\([0-9a-f]+\\)" nil t
)
394 (unless (string-equal head
(match-string 1))
395 (setq subject
"commit (merge): ")
397 (push (match-string 1) args
))))
398 (setq log-start
(point-min)))
399 (setq log-end
(point-max))
400 (goto-char log-start
)
401 (when (re-search-forward ".*$" nil t
)
402 (setq subject
(concat subject
(match-string 0))))
403 (setq coding-system-for-write buffer-file-coding-system
))
406 (with-output-to-string
407 (with-current-buffer standard-output
408 (let ((env `(("GIT_AUTHOR_NAME" .
,author-name
)
409 ("GIT_AUTHOR_EMAIL" .
,author-email
)
410 ("GIT_COMMITTER_NAME" .
,(git-get-committer-name))
411 ("GIT_COMMITTER_EMAIL" .
,(git-get-committer-email)))))
412 (when author-date
(push `("GIT_AUTHOR_DATE" .
,author-date
) env
))
413 (apply #'git-run-command-region
414 buffer log-start log-end env
415 "commit-tree" tree
(nreverse args
))))))))
416 (and (git-update-ref "HEAD" commit head subject
)
419 (defun git-empty-db-p ()
420 "Check if the git db is empty (no commit done yet)."
421 (not (eq 0 (call-process "git" nil nil nil
"rev-parse" "--verify" "HEAD"))))
423 (defun git-get-merge-heads ()
424 "Retrieve the merge heads from the MERGE_HEAD file if present."
426 (when (file-readable-p ".git/MERGE_HEAD")
428 (insert-file-contents ".git/MERGE_HEAD" nil nil nil t
)
429 (goto-char (point-min))
430 (while (re-search-forward "[0-9a-f]\\{40\\}" nil t
)
431 (push (match-string 0) heads
))))
434 (defun git-get-commit-description (commit)
435 "Get a one-line description of COMMIT."
436 (let ((coding-system-for-read (git-get-logoutput-coding-system)))
437 (let ((descr (git-call-process-env-string nil
"log" "--max-count=1" "--pretty=oneline" commit
)))
438 (if (and descr
(string-match "\\`\\([0-9a-f]\\{40\\}\\) *\\(.*\\)$" descr
))
439 (concat (substring (match-string 1 descr
) 0 10) " - " (match-string 2 descr
))
442 ;;;; File info structure
443 ;;;; ------------------------------------------------------------
445 ; fileinfo structure stolen from pcl-cvs
446 (defstruct (git-fileinfo
448 (:constructor git-create-fileinfo
(state name
&optional old-perm new-perm rename-state orig-name marked
))
449 (:conc-name git-fileinfo-
>))
451 state
;; current state
453 old-perm new-perm
;; permission flags
454 rename-state
;; rename or copy state
455 orig-name
;; original name for renames or copies
456 needs-refresh
) ;; whether file needs to be refreshed
458 (defvar git-status nil
)
460 (defun git-clear-status (status)
461 "Remove everything from the status list."
462 (ewoc-filter status
(lambda (info) nil
)))
464 (defun git-set-files-state (files state
)
465 "Set the state of a list of files."
467 (unless (eq (git-fileinfo->state info
) state
)
468 (setf (git-fileinfo->state info
) state
)
469 (setf (git-fileinfo->rename-state info
) nil
)
470 (setf (git-fileinfo->orig-name info
) nil
)
471 (setf (git-fileinfo->needs-refresh info
) t
))))
473 (defun git-state-code (code)
474 "Convert from a string to a added/deleted/modified state."
475 (case (string-to-char code
)
483 (defun git-status-code-as-string (code)
484 "Format a git status code as string."
486 ('modified
(propertize "Modified" 'face
'git-status-face
))
487 ('unknown
(propertize "Unknown " 'face
'git-unknown-face
))
488 ('added
(propertize "Added " 'face
'git-status-face
))
489 ('deleted
(propertize "Deleted " 'face
'git-status-face
))
490 ('unmerged
(propertize "Unmerged" 'face
'git-unmerged-face
))
491 ('uptodate
(propertize "Uptodate" 'face
'git-uptodate-face
))
492 ('ignored
(propertize "Ignored " 'face
'git-ignored-face
))
495 (defun git-rename-as-string (info)
496 "Return a string describing the copy or rename associated with INFO, or an empty string if none."
497 (let ((state (git-fileinfo->rename-state info
)))
501 (if (eq state
'copy
) "copied from "
502 (if (eq (git-fileinfo->state info
) 'added
) "renamed from "
504 (git-escape-file-name (git-fileinfo->orig-name info
))
505 ")") 'face
'git-status-face
)
508 (defun git-permissions-as-string (old-perm new-perm
)
509 "Format a permission change as string."
511 (if (or (not old-perm
)
513 (eq 0 (logand ?
\111 (logxor old-perm new-perm
))))
515 (if (eq 0 (logand ?
\111 old-perm
)) "+x" "-x"))
516 'face
'git-permission-face
))
518 (defun git-fileinfo-prettyprint (info)
519 "Pretty-printer for the git-fileinfo structure."
520 (insert (concat " " (if (git-fileinfo->marked info
) (propertize "*" 'face
'git-mark-face
) " ")
521 " " (git-status-code-as-string (git-fileinfo->state info
))
522 " " (git-permissions-as-string (git-fileinfo->old-perm info
) (git-fileinfo->new-perm info
))
523 " " (git-escape-file-name (git-fileinfo->name info
))
524 (git-rename-as-string info
))))
526 (defun git-parse-status (status)
527 "Parse the output of git-diff-index in the current buffer."
528 (goto-char (point-min))
529 (while (re-search-forward
530 ":\\([0-7]\\{6\\}\\) \\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} [0-9a-f]\\{40\\} \\(\\([ADMU]\\)\0\\([^\0]+\\)\\|\\([CR]\\)[0-9]*\0\\([^\0]+\\)\0\\([^\0]+\\)\\)\0"
532 (let ((old-perm (string-to-number (match-string 1) 8))
533 (new-perm (string-to-number (match-string 2) 8))
534 (state (or (match-string 4) (match-string 6)))
535 (name (or (match-string 5) (match-string 7)))
536 (new-name (match-string 8)))
537 (if new-name
; copy or rename
538 (if (eq ?C
(string-to-char state
))
539 (ewoc-enter-last status
(git-create-fileinfo 'added new-name old-perm new-perm
'copy name
))
540 (ewoc-enter-last status
(git-create-fileinfo 'deleted name
0 0 'rename new-name
))
541 (ewoc-enter-last status
(git-create-fileinfo 'added new-name old-perm new-perm
'rename name
)))
542 (ewoc-enter-last status
(git-create-fileinfo (git-state-code state
) name old-perm new-perm
))))))
544 (defun git-find-status-file (status file
)
545 "Find a given file in the status ewoc and return its node."
546 (let ((node (ewoc-nth status
0)))
547 (while (and node
(not (string= file
(git-fileinfo->name
(ewoc-data node
)))))
548 (setq node
(ewoc-next status node
)))
551 (defun git-parse-ls-files (status default-state
&optional skip-existing
)
552 "Parse the output of git-ls-files in the current buffer."
553 (goto-char (point-min))
555 (while (re-search-forward "\\([HMRCK?]\\) \\([^\0]*\\)\0" nil t
1)
556 (let ((state (match-string 1))
557 (name (match-string 2)))
558 (unless (and skip-existing
(git-find-status-file status name
))
559 (push (git-create-fileinfo (or (git-state-code state
) default-state
) name
) infolist
))))
560 (dolist (info (nreverse infolist
))
561 (ewoc-enter-last status info
))))
563 (defun git-parse-ls-unmerged (status)
564 "Parse the output of git-ls-files -u in the current buffer."
565 (goto-char (point-min))
567 (while (re-search-forward "[0-7]\\{6\\} [0-9a-f]\\{40\\} [123]\t\\([^\0]+\\)\0" nil t
)
568 (let ((node (git-find-status-file status
(match-string 1))))
569 (when node
(push (ewoc-data node
) files
))))
570 (git-set-files-state files
'unmerged
)))
572 (defun git-add-status-file (state name
)
573 "Add a new file to the status list (if not existing already) and return its node."
574 (unless git-status
(error "Not in git-status buffer."))
575 (or (git-find-status-file git-status name
)
576 (ewoc-enter-last git-status
(git-create-fileinfo state name
))))
578 (defun git-marked-files ()
579 "Return a list of all marked files, or if none a list containing just the file at cursor position."
580 (unless git-status
(error "Not in git-status buffer."))
581 (or (ewoc-collect git-status
(lambda (info) (git-fileinfo->marked info
)))
582 (list (ewoc-data (ewoc-locate git-status
)))))
584 (defun git-marked-files-state (&rest states
)
585 "Return marked files that are in the specified states."
586 (let ((files (git-marked-files))
589 (when (memq (git-fileinfo->state info
) states
)
593 (defun git-refresh-files ()
594 "Refresh all files that need it and clear the needs-refresh flag."
595 (unless git-status
(error "Not in git-status buffer."))
598 (let ((refresh (git-fileinfo->needs-refresh info
)))
599 (setf (git-fileinfo->needs-refresh info
) nil
)
602 ; move back to goal column
603 (when goal-column
(move-to-column goal-column
)))
605 (defun git-refresh-ewoc-hf (status)
606 "Refresh the ewoc header and footer."
607 (let ((branch (git-symbolic-ref "HEAD"))
608 (head (if (git-empty-db-p) "Nothing committed yet"
609 (git-get-commit-description "HEAD")))
610 (merge-heads (git-get-merge-heads)))
612 (format "Directory: %s\nBranch: %s\nHead: %s%s\n"
614 (if (string-match "^refs/heads/" branch
)
615 (substring branch
(match-end 0))
619 (concat "\nMerging: "
620 (mapconcat (lambda (str) (git-get-commit-description str
)) merge-heads
"\n "))
622 (if (ewoc-nth status
0) "" " No changes."))))
624 (defun git-get-filenames (files)
625 (mapcar (lambda (info) (git-fileinfo->name info
)) files
))
627 (defun git-update-index (index-file files
)
628 "Run git-update-index on a list of files."
629 (let ((env (and index-file
`(("GIT_INDEX_FILE" .
,index-file
))))
630 added deleted modified
)
632 (case (git-fileinfo->state info
)
633 ('added
(push info added
))
634 ('deleted
(push info deleted
))
635 ('modified
(push info modified
))))
637 (apply #'git-run-command nil env
"update-index" "--add" "--" (git-get-filenames added
)))
639 (apply #'git-run-command nil env
"update-index" "--remove" "--" (git-get-filenames deleted
)))
641 (apply #'git-run-command nil env
"update-index" "--" (git-get-filenames modified
)))))
643 (defun git-run-pre-commit-hook ()
644 "Run the pre-commit hook if any."
645 (unless git-status
(error "Not in git-status buffer."))
646 (let ((files (git-marked-files-state 'added
'deleted
'modified
)))
648 (not (file-executable-p ".git/hooks/pre-commit"))
649 (let ((index-file (make-temp-file "gitidx")))
651 (let ((head-tree (unless (git-empty-db-p) (git-rev-parse "HEAD^{tree}"))))
652 (git-read-tree head-tree index-file
)
653 (git-update-index index-file files
)
654 (git-run-hook "pre-commit" `(("GIT_INDEX_FILE" .
,index-file
))))
655 (delete-file index-file
))))))
657 (defun git-do-commit ()
658 "Perform the actual commit using the current buffer as log message."
660 (let ((buffer (current-buffer))
661 (index-file (make-temp-file "gitidx")))
662 (with-current-buffer log-edit-parent-buffer
663 (if (git-marked-files-state 'unmerged
)
664 (message "You cannot commit unmerged files, resolve them first.")
666 (let ((files (git-marked-files-state 'added
'deleted
'modified
))
668 (unless (git-empty-db-p)
669 (setq head
(git-rev-parse "HEAD")
670 head-tree
(git-rev-parse "HEAD^{tree}")))
673 (git-read-tree head-tree index-file
)
674 (git-update-index nil files
) ;update both the default index
675 (git-update-index index-file files
) ;and the temporary one
676 (let ((tree (git-write-tree index-file
)))
677 (if (or (not (string-equal tree head-tree
))
678 (yes-or-no-p "The tree was not modified, do you really want to perform an empty commit? "))
679 (let ((commit (git-commit-tree buffer tree head
)))
680 (condition-case nil
(delete-file ".git/MERGE_HEAD") (error nil
))
681 (condition-case nil
(delete-file ".git/MERGE_MSG") (error nil
))
682 (with-current-buffer buffer
(erase-buffer))
683 (git-set-files-state files
'uptodate
)
684 (git-run-command nil nil
"rerere")
686 (git-refresh-ewoc-hf git-status
)
687 (message "Committed %s." commit
)
688 (git-run-hook "post-commit" nil
))
689 (message "Commit aborted."))))
690 (message "No files to commit.")))
691 (delete-file index-file
))))))
694 ;;;; Interactive functions
695 ;;;; ------------------------------------------------------------
697 (defun git-mark-file ()
698 "Mark the file that the cursor is on and move to the next one."
700 (unless git-status
(error "Not in git-status buffer."))
701 (let* ((pos (ewoc-locate git-status
))
702 (info (ewoc-data pos
)))
703 (setf (git-fileinfo->marked info
) t
)
704 (ewoc-invalidate git-status pos
)
705 (ewoc-goto-next git-status
1)))
707 (defun git-unmark-file ()
708 "Unmark the file that the cursor is on and move to the next one."
710 (unless git-status
(error "Not in git-status buffer."))
711 (let* ((pos (ewoc-locate git-status
))
712 (info (ewoc-data pos
)))
713 (setf (git-fileinfo->marked info
) nil
)
714 (ewoc-invalidate git-status pos
)
715 (ewoc-goto-next git-status
1)))
717 (defun git-unmark-file-up ()
718 "Unmark the file that the cursor is on and move to the previous one."
720 (unless git-status
(error "Not in git-status buffer."))
721 (let* ((pos (ewoc-locate git-status
))
722 (info (ewoc-data pos
)))
723 (setf (git-fileinfo->marked info
) nil
)
724 (ewoc-invalidate git-status pos
)
725 (ewoc-goto-prev git-status
1)))
727 (defun git-mark-all ()
730 (unless git-status
(error "Not in git-status buffer."))
731 (ewoc-map (lambda (info) (setf (git-fileinfo->marked info
) t
) t
) git-status
)
732 ; move back to goal column after invalidate
733 (when goal-column
(move-to-column goal-column
)))
735 (defun git-unmark-all ()
738 (unless git-status
(error "Not in git-status buffer."))
739 (ewoc-map (lambda (info) (setf (git-fileinfo->marked info
) nil
) t
) git-status
)
740 ; move back to goal column after invalidate
741 (when goal-column
(move-to-column goal-column
)))
743 (defun git-toggle-all-marks ()
744 "Toggle all file marks."
746 (unless git-status
(error "Not in git-status buffer."))
747 (ewoc-map (lambda (info) (setf (git-fileinfo->marked info
) (not (git-fileinfo->marked info
))) t
) git-status
)
748 ; move back to goal column after invalidate
749 (when goal-column
(move-to-column goal-column
)))
751 (defun git-next-file (&optional n
)
752 "Move the selection down N files."
754 (unless git-status
(error "Not in git-status buffer."))
755 (ewoc-goto-next git-status n
))
757 (defun git-prev-file (&optional n
)
758 "Move the selection up N files."
760 (unless git-status
(error "Not in git-status buffer."))
761 (ewoc-goto-prev git-status n
))
763 (defun git-next-unmerged-file (&optional n
)
764 "Move the selection down N unmerged files."
766 (unless git-status
(error "Not in git-status buffer."))
767 (let* ((last (ewoc-locate git-status
))
768 (node (ewoc-next git-status last
)))
769 (while (and node
(> n
0))
770 (when (eq 'unmerged
(git-fileinfo->state
(ewoc-data node
)))
773 (setq node
(ewoc-next git-status node
)))
774 (ewoc-goto-node git-status last
)))
776 (defun git-prev-unmerged-file (&optional n
)
777 "Move the selection up N unmerged files."
779 (unless git-status
(error "Not in git-status buffer."))
780 (let* ((last (ewoc-locate git-status
))
781 (node (ewoc-prev git-status last
)))
782 (while (and node
(> n
0))
783 (when (eq 'unmerged
(git-fileinfo->state
(ewoc-data node
)))
786 (setq node
(ewoc-prev git-status node
)))
787 (ewoc-goto-node git-status last
)))
789 (defun git-add-file ()
790 "Add marked file(s) to the index cache."
792 (let ((files (git-marked-files-state 'unknown
)))
795 (git-add-status-file 'added
(file-relative-name
796 (read-file-name "File to add: " nil nil t
))))
798 (apply #'git-run-command nil nil
"update-index" "--info-only" "--add" "--" (git-get-filenames files
))
799 (git-set-files-state files
'added
)
800 (git-refresh-files)))
802 (defun git-ignore-file ()
803 "Add marked file(s) to the ignore list."
805 (let ((files (git-marked-files-state 'unknown
)))
808 (git-add-status-file 'unknown
(file-relative-name
809 (read-file-name "File to ignore: " nil nil t
))))
811 (dolist (info files
) (git-append-to-ignore (git-fileinfo->name info
)))
812 (git-set-files-state files
'ignored
)
813 (git-refresh-files)))
815 (defun git-remove-file ()
816 "Remove the marked file(s)."
818 (let ((files (git-marked-files-state 'added
'modified
'unknown
'uptodate
)))
821 (git-add-status-file 'unknown
(file-relative-name
822 (read-file-name "File to remove: " nil nil t
))))
825 (format "Remove %d file%s? " (length files
) (if (> (length files
) 1) "s" "")))
828 (let ((name (git-fileinfo->name info
)))
829 (when (file-exists-p name
) (delete-file name
))))
830 (apply #'git-run-command nil nil
"update-index" "--info-only" "--remove" "--" (git-get-filenames files
))
831 ; remove unknown files from the list, set the others to deleted
832 (ewoc-filter git-status
834 (not (and (memq info files
) (eq (git-fileinfo->state info
) 'unknown
))))
836 (git-set-files-state files
'deleted
)
838 (unless (ewoc-nth git-status
0) ; refresh header if list is empty
839 (git-refresh-ewoc-hf git-status
)))
840 (message "Aborting"))))
842 (defun git-revert-file ()
843 "Revert changes to the marked file(s)."
845 (let ((files (git-marked-files))
849 (format "Revert %d file%s? " (length files
) (if (> (length files
) 1) "s" ""))))
851 (case (git-fileinfo->state info
)
852 ('added
(push info added
))
853 ('deleted
(push info modified
))
854 ('unmerged
(push info modified
))
855 ('modified
(push info modified
))))
857 (apply #'git-run-command nil nil
"update-index" "--force-remove" "--" (git-get-filenames added
))
858 (git-set-files-state added
'unknown
))
860 (apply #'git-run-command nil nil
"checkout" "HEAD" (git-get-filenames modified
))
861 (git-set-files-state modified
'uptodate
))
862 (git-refresh-files))))
864 (defun git-resolve-file ()
865 "Resolve conflicts in marked file(s)."
867 (let ((files (git-marked-files-state 'unmerged
)))
869 (apply #'git-run-command nil nil
"update-index" "--" (git-get-filenames files
))
870 (git-set-files-state files
'modified
)
871 (git-refresh-files))))
873 (defun git-remove-handled ()
874 "Remove handled files from the status list."
876 (ewoc-filter git-status
878 (not (or (eq (git-fileinfo->state info
) 'ignored
)
879 (eq (git-fileinfo->state info
) 'uptodate
)))))
880 (unless (ewoc-nth git-status
0) ; refresh header if list is empty
881 (git-refresh-ewoc-hf git-status
)))
883 (defun git-setup-diff-buffer (buffer)
884 "Setup a buffer for displaying a diff."
885 (with-current-buffer buffer
887 (goto-char (point-min))
888 (setq buffer-read-only t
))
889 (display-buffer buffer
)
890 (shrink-window-if-larger-than-buffer))
892 (defun git-diff-file ()
893 "Diff the marked file(s) against HEAD."
895 (let ((files (git-marked-files)))
896 (git-setup-diff-buffer
897 (apply #'git-run-command-buffer
"*git-diff*" "diff-index" "-p" "-M" "HEAD" "--" (git-get-filenames files
)))))
899 (defun git-diff-file-merge-head (arg)
900 "Diff the marked file(s) against the first merge head (or the nth one with a numeric prefix)."
902 (let ((files (git-marked-files))
903 (merge-heads (git-get-merge-heads)))
904 (unless merge-heads
(error "No merge in progress"))
905 (git-setup-diff-buffer
906 (apply #'git-run-command-buffer
"*git-diff*" "diff-index" "-p" "-M"
907 (or (nth (1- arg
) merge-heads
) "HEAD") "--" (git-get-filenames files
)))))
909 (defun git-diff-unmerged-file (stage)
910 "Diff the marked unmerged file(s) against the specified stage."
911 (let ((files (git-marked-files)))
912 (git-setup-diff-buffer
913 (apply #'git-run-command-buffer
"*git-diff*" "diff-files" "-p" stage
"--" (git-get-filenames files
)))))
915 (defun git-diff-file-base ()
916 "Diff the marked unmerged file(s) against the common base file."
918 (git-diff-unmerged-file "-1"))
920 (defun git-diff-file-mine ()
921 "Diff the marked unmerged file(s) against my pre-merge version."
923 (git-diff-unmerged-file "-2"))
925 (defun git-diff-file-other ()
926 "Diff the marked unmerged file(s) against the other's pre-merge version."
928 (git-diff-unmerged-file "-3"))
930 (defun git-diff-file-combined ()
931 "Do a combined diff of the marked unmerged file(s)."
933 (git-diff-unmerged-file "-c"))
935 (defun git-diff-file-idiff ()
936 "Perform an interactive diff on the current file."
938 (error "Interactive diffs not implemented yet."))
940 (defun git-log-file ()
941 "Display a log of changes to the marked file(s)."
943 (let* ((files (git-marked-files))
944 (coding-system-for-read git-commits-coding-system
)
945 (buffer (apply #'git-run-command-buffer
"*git-log*" "rev-list" "--pretty" "HEAD" "--" (git-get-filenames files
))))
946 (with-current-buffer buffer
947 ; (git-log-mode) FIXME: implement log mode
948 (goto-char (point-min))
949 (setq buffer-read-only t
))
950 (display-buffer buffer
)))
952 (defun git-log-edit-files ()
953 "Return a list of marked files for use in the log-edit buffer."
954 (with-current-buffer log-edit-parent-buffer
955 (git-get-filenames (git-marked-files-state 'added
'deleted
'modified
))))
957 (defun git-append-sign-off (name email
)
958 "Append a Signed-off-by entry to the current buffer, avoiding duplicates."
959 (let ((sign-off (format "Signed-off-by: %s <%s>" name email
))
960 (case-fold-search t
))
961 (goto-char (point-min))
962 (unless (re-search-forward (concat "^" (regexp-quote sign-off
)) nil t
)
963 (goto-char (point-min))
964 (unless (re-search-forward "^Signed-off-by: " nil t
)
965 (setq sign-off
(concat "\n" sign-off
)))
966 (goto-char (point-max))
967 (insert sign-off
"\n"))))
969 (defun git-setup-log-buffer (buffer &optional author-name author-email subject date msg
)
970 "Setup the log buffer for a commit."
971 (unless git-status
(error "Not in git-status buffer."))
972 (let ((merge-heads (git-get-merge-heads))
973 (dir default-directory
)
974 (committer-name (git-get-committer-name))
975 (committer-email (git-get-committer-email))
976 (sign-off git-append-signed-off-by
))
977 (with-current-buffer buffer
982 (format "Author: %s <%s>\n%s%s"
983 (or author-name committer-name
)
984 (or author-email committer-email
)
985 (if date
(format "Date: %s\n" date
) "")
987 (format "Parent: %s\n%s\n"
988 (git-rev-parse "HEAD")
989 (mapconcat (lambda (str) (concat "Parent: " str
)) merge-heads
"\n"))
991 'face
'git-header-face
)
992 (propertize git-log-msg-separator
'face
'git-separator-face
)
994 (when subject
(insert subject
"\n\n"))
995 (cond (msg (insert msg
"\n"))
996 ((file-readable-p ".dotest/msg")
997 (insert-file-contents ".dotest/msg"))
998 ((file-readable-p ".git/MERGE_MSG")
999 (insert-file-contents ".git/MERGE_MSG")))
1000 ; delete empty lines at end
1001 (goto-char (point-min))
1002 (when (re-search-forward "\n+\\'" nil t
)
1003 (replace-match "\n" t t
))
1004 (when sign-off
(git-append-sign-off committer-name committer-email
)))))
1006 (defun git-commit-file ()
1007 "Commit the marked file(s), asking for a commit message."
1009 (unless git-status
(error "Not in git-status buffer."))
1010 (when (git-run-pre-commit-hook)
1011 (let ((buffer (get-buffer-create "*git-commit*"))
1012 (coding-system (git-get-commits-coding-system))
1013 author-name author-email subject date
)
1014 (when (eq 0 (buffer-size buffer
))
1015 (when (file-readable-p ".dotest/info")
1017 (insert-file-contents ".dotest/info")
1018 (goto-char (point-min))
1019 (when (re-search-forward "^Author: \\(.*\\)\nEmail: \\(.*\\)$" nil t
)
1020 (setq author-name
(match-string 1))
1021 (setq author-email
(match-string 2)))
1022 (goto-char (point-min))
1023 (when (re-search-forward "^Subject: \\(.*\\)$" nil t
)
1024 (setq subject
(match-string 1)))
1025 (goto-char (point-min))
1026 (when (re-search-forward "^Date: \\(.*\\)$" nil t
)
1027 (setq date
(match-string 1)))))
1028 (git-setup-log-buffer buffer author-name author-email subject date
))
1029 (log-edit #'git-do-commit nil
#'git-log-edit-files buffer
)
1030 (setq font-lock-keywords
(font-lock-compile-keywords git-log-edit-font-lock-keywords
))
1031 (setq buffer-file-coding-system coding-system
)
1032 (re-search-forward (regexp-quote (concat git-log-msg-separator
"\n")) nil t
))))
1034 (defun git-find-file ()
1035 "Visit the current file in its own buffer."
1037 (unless git-status
(error "Not in git-status buffer."))
1038 (let ((info (ewoc-data (ewoc-locate git-status
))))
1039 (find-file (git-fileinfo->name info
))
1040 (when (eq 'unmerged
(git-fileinfo->state info
))
1043 (defun git-find-file-other-window ()
1044 "Visit the current file in its own buffer in another window."
1046 (unless git-status
(error "Not in git-status buffer."))
1047 (let ((info (ewoc-data (ewoc-locate git-status
))))
1048 (find-file-other-window (git-fileinfo->name info
))
1049 (when (eq 'unmerged
(git-fileinfo->state info
))
1052 (defun git-find-file-imerge ()
1053 "Visit the current file in interactive merge mode."
1055 (unless git-status
(error "Not in git-status buffer."))
1056 (let ((info (ewoc-data (ewoc-locate git-status
))))
1057 (find-file (git-fileinfo->name info
))
1060 (defun git-view-file ()
1061 "View the current file in its own buffer."
1063 (unless git-status
(error "Not in git-status buffer."))
1064 (let ((info (ewoc-data (ewoc-locate git-status
))))
1065 (view-file (git-fileinfo->name info
))))
1067 (defun git-refresh-status ()
1068 "Refresh the git status buffer."
1070 (let* ((status git-status
)
1071 (pos (ewoc-locate status
))
1072 (cur-name (and pos
(git-fileinfo->name
(ewoc-data pos
)))))
1073 (unless status
(error "Not in git-status buffer."))
1074 (git-clear-status status
)
1075 (git-run-command nil nil
"update-index" "--info-only" "--refresh")
1076 (if (git-empty-db-p)
1077 ; we need some special handling for an empty db
1079 (git-run-command t nil
"ls-files" "-z" "-t" "-c")
1080 (git-parse-ls-files status
'added
))
1082 (git-run-command t nil
"diff-index" "-z" "-M" "HEAD")
1083 (git-parse-status status
)))
1085 (git-run-command t nil
"ls-files" "-z" "-u")
1086 (git-parse-ls-unmerged status
))
1087 (when (file-readable-p ".git/info/exclude")
1089 (git-run-command t nil
"ls-files" "-z" "-t" "-o"
1090 "--exclude-from=.git/info/exclude"
1091 (concat "--exclude-per-directory=" git-per-dir-ignore-file
))
1092 (git-parse-ls-files status
'unknown
)))
1094 (git-refresh-ewoc-hf status
)
1095 ; move point to the current file name if any
1096 (let ((node (and cur-name
(git-find-status-file status cur-name
))))
1097 (when node
(ewoc-goto-node status node
)))))
1099 (defun git-status-quit ()
1100 "Quit git-status mode."
1105 ;;;; ------------------------------------------------------------
1107 (defvar git-status-mode-hook nil
1108 "Run after `git-status-mode' is setup.")
1110 (defvar git-status-mode-map nil
1111 "Keymap for git major mode.")
1113 (defvar git-status nil
1114 "List of all files managed by the git-status mode.")
1116 (unless git-status-mode-map
1117 (let ((map (make-keymap))
1118 (diff-map (make-sparse-keymap)))
1119 (suppress-keymap map
)
1120 (define-key map
"?" 'git-help
)
1121 (define-key map
"h" 'git-help
)
1122 (define-key map
" " 'git-next-file
)
1123 (define-key map
"a" 'git-add-file
)
1124 (define-key map
"c" 'git-commit-file
)
1125 (define-key map
"d" diff-map
)
1126 (define-key map
"=" 'git-diff-file
)
1127 (define-key map
"f" 'git-find-file
)
1128 (define-key map
"\r" 'git-find-file
)
1129 (define-key map
"g" 'git-refresh-status
)
1130 (define-key map
"i" 'git-ignore-file
)
1131 (define-key map
"l" 'git-log-file
)
1132 (define-key map
"m" 'git-mark-file
)
1133 (define-key map
"M" 'git-mark-all
)
1134 (define-key map
"n" 'git-next-file
)
1135 (define-key map
"N" 'git-next-unmerged-file
)
1136 (define-key map
"o" 'git-find-file-other-window
)
1137 (define-key map
"p" 'git-prev-file
)
1138 (define-key map
"P" 'git-prev-unmerged-file
)
1139 (define-key map
"q" 'git-status-quit
)
1140 (define-key map
"r" 'git-remove-file
)
1141 (define-key map
"R" 'git-resolve-file
)
1142 (define-key map
"T" 'git-toggle-all-marks
)
1143 (define-key map
"u" 'git-unmark-file
)
1144 (define-key map
"U" 'git-revert-file
)
1145 (define-key map
"v" 'git-view-file
)
1146 (define-key map
"x" 'git-remove-handled
)
1147 (define-key map
"\C-?" 'git-unmark-file-up
)
1148 (define-key map
"\M-\C-?" 'git-unmark-all
)
1150 (define-key diff-map
"b" 'git-diff-file-base
)
1151 (define-key diff-map
"c" 'git-diff-file-combined
)
1152 (define-key diff-map
"=" 'git-diff-file
)
1153 (define-key diff-map
"e" 'git-diff-file-idiff
)
1154 (define-key diff-map
"E" 'git-find-file-imerge
)
1155 (define-key diff-map
"h" 'git-diff-file-merge-head
)
1156 (define-key diff-map
"m" 'git-diff-file-mine
)
1157 (define-key diff-map
"o" 'git-diff-file-other
)
1158 (setq git-status-mode-map map
)))
1160 ;; git mode should only run in the *git status* buffer
1161 (put 'git-status-mode
'mode-class
'special
)
1163 (defun git-status-mode ()
1164 "Major mode for interacting with Git.
1166 \\{git-status-mode-map}"
1167 (kill-all-local-variables)
1168 (buffer-disable-undo)
1169 (setq mode-name
"git status"
1170 major-mode
'git-status-mode
1173 (use-local-map git-status-mode-map
)
1174 (let ((buffer-read-only nil
))
1176 (let ((status (ewoc-create 'git-fileinfo-prettyprint
"" "")))
1177 (set (make-local-variable 'git-status
) status
))
1178 (set (make-local-variable 'list-buffers-directory
) default-directory
)
1179 (run-hooks 'git-status-mode-hook
)))
1181 (defun git-find-status-buffer (dir)
1182 "Find the git status buffer handling a specified directory."
1183 (let ((list (buffer-list))
1184 (fulldir (expand-file-name dir
))
1186 (while (and list
(not found
))
1187 (let ((buffer (car list
)))
1188 (with-current-buffer buffer
1189 (when (and list-buffers-directory
1190 (string-equal fulldir
(expand-file-name list-buffers-directory
))
1191 (string-match "\\*git-status\\*$" (buffer-name buffer
)))
1192 (setq found buffer
))))
1193 (setq list
(cdr list
)))
1196 (defun git-status (dir)
1197 "Entry point into git-status mode."
1198 (interactive "DSelect directory: ")
1199 (setq dir
(git-get-top-dir dir
))
1200 (if (file-directory-p (concat (file-name-as-directory dir
) ".git"))
1201 (let ((buffer (or (and git-reuse-status-buffer
(git-find-status-buffer dir
))
1202 (create-file-buffer (expand-file-name "*git-status*" dir
)))))
1203 (switch-to-buffer buffer
)
1206 (git-refresh-status)
1207 (goto-char (point-min)))
1208 (message "%s is not a git working tree." dir
)))
1211 "Display help for Git mode."
1213 (describe-function 'git-status-mode
))
1216 ;;; git.el ends here