Andrew's git / gitweb.git / contrib/emacs/git.el
?
contrib / emacs / git.elon commit Merge branch 'maint' (520d7e2)
   1;;; git.el --- A user interface for git
   2
   3;; Copyright (C) 2005, 2006, 2007 Alexandre Julliard <julliard@winehq.org>
   4
   5;; Version: 1.0
   6
   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.
  11;;
  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.
  16;;
  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,
  20;; MA 02111-1307 USA
  21
  22;;; Commentary:
  23
  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.
  28;;
  29;; To install: put this file on the load-path and place the following
  30;; in your .emacs file:
  31;;
  32;;    (require 'git)
  33;;
  34;; To start: `M-x git-status'
  35;;
  36;; TODO
  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
  42;;  - creating tags
  43;;  - fetch/pull
  44;;  - switching branches
  45;;  - revlist browser
  46;;  - git-show-branch browser
  47;;  - menus
  48;;
  49
  50(eval-when-compile (require 'cl))
  51(require 'ewoc)
  52(require 'log-edit)
  53
  54
  55;;;; Customizations
  56;;;; ------------------------------------------------------------
  57
  58(defgroup git nil
  59  "A user interface for the git versioning system."
  60  :group 'tools)
  61
  62(defcustom git-committer-name nil
  63  "User name to use for commits.
  64The default is to fall back to the repository config,
  65then to `add-log-full-name' and then to `user-full-name'."
  66  :group 'git
  67  :type '(choice (const :tag "Default" nil)
  68                 (string :tag "Name")))
  69
  70(defcustom git-committer-email nil
  71  "Email address to use for commits.
  72The default is to fall back to the git repository config,
  73then to `add-log-mailing-address' and then to `user-mail-address'."
  74  :group 'git
  75  :type '(choice (const :tag "Default" nil)
  76                 (string :tag "Email")))
  77
  78(defcustom git-commits-coding-system nil
  79  "Default coding system for the log message of git commits."
  80  :group 'git
  81  :type '(choice (const :tag "From repository config" nil)
  82                 (coding-system)))
  83
  84(defcustom git-append-signed-off-by nil
  85  "Whether to append a Signed-off-by line to the commit message before editing."
  86  :group 'git
  87  :type 'boolean)
  88
  89(defcustom git-reuse-status-buffer t
  90  "Whether `git-status' should try to reuse an existing buffer
  91if there is already one that displays the same directory."
  92  :group 'git
  93  :type 'boolean)
  94
  95(defcustom git-per-dir-ignore-file ".gitignore"
  96  "Name of the per-directory ignore file."
  97  :group 'git
  98  :type 'string)
  99
 100
 101(defface git-status-face
 102  '((((class color) (background light)) (:foreground "purple")))
 103  "Git mode face used to highlight added and modified files."
 104  :group 'git)
 105
 106(defface git-unmerged-face
 107  '((((class color) (background light)) (:foreground "red" :bold t)))
 108  "Git mode face used to highlight unmerged files."
 109  :group 'git)
 110
 111(defface git-unknown-face
 112  '((((class color) (background light)) (:foreground "goldenrod" :bold t)))
 113  "Git mode face used to highlight unknown files."
 114  :group 'git)
 115
 116(defface git-uptodate-face
 117  '((((class color) (background light)) (:foreground "grey60")))
 118  "Git mode face used to highlight up-to-date files."
 119  :group 'git)
 120
 121(defface git-ignored-face
 122  '((((class color) (background light)) (:foreground "grey60")))
 123  "Git mode face used to highlight ignored files."
 124  :group 'git)
 125
 126(defface git-mark-face
 127  '((((class color) (background light)) (:foreground "red" :bold t)))
 128  "Git mode face used for the file marks."
 129  :group 'git)
 130
 131(defface git-header-face
 132  '((((class color) (background light)) (:foreground "blue")))
 133  "Git mode face used for commit headers."
 134  :group 'git)
 135
 136(defface git-separator-face
 137  '((((class color) (background light)) (:foreground "brown")))
 138  "Git mode face used for commit separator."
 139  :group 'git)
 140
 141(defface git-permission-face
 142  '((((class color) (background light)) (:foreground "green" :bold t)))
 143  "Git mode face used for permission changes."
 144  :group 'git)
 145
 146
 147;;;; Utilities
 148;;;; ------------------------------------------------------------
 149
 150(defconst git-log-msg-separator "--- log message follows this line ---")
 151
 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))))
 158
 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))
 162
 163(defun git-call-process-env (buffer env &rest args)
 164  "Wrapper for call-process that sets environment strings."
 165  (if env
 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)))
 169
 170(defun git-call-process-env-string (env &rest args)
 171  "Wrapper for call-process that sets environment strings,
 172and returns the process output as a string."
 173  (with-temp-buffer
 174    (and (eq 0 (apply #' git-call-process-env t env args))
 175         (buffer-string))))
 176
 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
 182      (cd dir)
 183      (apply #'call-process-region start end program
 184             nil (list output-buffer nil) nil args))))
 185
 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))
 194        (erase-buffer)
 195        (apply #'git-call-process-env buffer nil args)))
 196    (message "Running git %s...done" (car args))
 197    buffer))
 198
 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)))
 203
 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)))
 215
 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
 223            (erase-buffer)
 224            (cd dir)
 225            (setq status
 226                  (if env
 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)
 231          (eq 0 status)))))
 232
 233(defun git-get-string-sha1 (string)
 234  "Read a SHA1 from the specified string."
 235  (and string
 236       (string-match "[0-9a-f]\\{40\\}" string)
 237       (match-string 0 string)))
 238
 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)))
 247
 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)))
 256
 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
 261        (and repo-config
 262             (fboundp 'locale-charset-to-coding-system)
 263             (locale-charset-to-coding-system repo-config))
 264      'utf-8)))
 265
 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
 271        (and repo-config
 272             (fboundp 'locale-charset-to-coding-system)
 273             (locale-charset-to-coding-system repo-config))
 274      'utf-8)))
 275
 276(defun git-escape-file-name (name)
 277  "Escape a file name if necessary."
 278  (if (string-match "[\n\t\"\\]" name)
 279      (concat "\""
 280              (mapconcat (lambda (c)
 281                   (case c
 282                     (?\n "\\n")
 283                     (?\t "\\t")
 284                     (?\\ "\\\\")
 285                     (?\" "\\\"")
 286                     (t (char-to-string c))))
 287                 name "")
 288              "\"")
 289    name))
 290
 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
 295                  (cd dir)
 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"))))))
 300
 301;stolen from pcl-cvs
 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))
 315    (save-buffer))
 316  (when created
 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))))
 319
 320; propertize definition for XEmacs, stolen from erc-compat
 321(eval-when-compile
 322  (unless (fboundp 'propertize)
 323    (defun propertize (string &rest props)
 324      (let ((string (copy-sequence string)))
 325        (while props
 326          (put-text-property 0 (length string) (nth 0 props) (nth 1 props) string)
 327          (setq props (cddr props)))
 328        string))))
 329
 330;;;; Wrappers for basic git commands
 331;;;; ------------------------------------------------------------
 332
 333(defun git-rev-parse (rev)
 334  "Parse a revision name and return its SHA1."
 335  (git-get-string-sha1
 336   (git-call-process-env-string nil "rev-parse" rev)))
 337
 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")))))
 342
 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")))))
 347
 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))))
 351    (push newval args)
 352    (push ref args)
 353    (when reason
 354     (push reason args)
 355     (push "-m" args))
 356    (eq 0 (apply #'git-call-process-env nil nil "update-ref" args))))
 357
 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))))
 363
 364(defun git-write-tree (&optional index-file)
 365  "Call git-write-tree and return the resulting tree SHA1 as a string."
 366  (git-get-string-sha1
 367   (git-call-process-env-string (and index-file `(("GIT_INDEX_FILE" . ,index-file))) "write-tree")))
 368
 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)
 375    (when head
 376      (setq subject "commit: ")
 377      (push "-p" args)
 378      (push head args))
 379    (with-current-buffer buffer
 380      (goto-char (point-min))
 381      (if
 382          (setq log-start (re-search-forward (concat "^" (regexp-quote git-log-msg-separator) "\n") nil t))
 383          (save-restriction
 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): ")
 396                (push "-p" args)
 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))
 404    (let ((commit
 405           (git-get-string-sha1
 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)
 417           commit))))
 418
 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"))))
 422
 423(defun git-get-merge-heads ()
 424  "Retrieve the merge heads from the MERGE_HEAD file if present."
 425  (let (heads)
 426    (when (file-readable-p ".git/MERGE_HEAD")
 427      (with-temp-buffer
 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))))
 432    (nreverse heads)))
 433
 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))
 440        descr))))
 441
 442;;;; File info structure
 443;;;; ------------------------------------------------------------
 444
 445; fileinfo structure stolen from pcl-cvs
 446(defstruct (git-fileinfo
 447            (:copier nil)
 448            (:constructor git-create-fileinfo (state name &optional old-perm new-perm rename-state orig-name marked))
 449            (:conc-name git-fileinfo->))
 450  marked              ;; t/nil
 451  state               ;; current state
 452  name                ;; file name
 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
 457
 458(defvar git-status nil)
 459
 460(defun git-clear-status (status)
 461  "Remove everything from the status list."
 462  (ewoc-filter status (lambda (info) nil)))
 463
 464(defun git-set-files-state (files state)
 465  "Set the state of a list of files."
 466  (dolist (info 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))))
 472
 473(defun git-state-code (code)
 474  "Convert from a string to a added/deleted/modified state."
 475  (case (string-to-char code)
 476    (?M 'modified)
 477    (?? 'unknown)
 478    (?A 'added)
 479    (?D 'deleted)
 480    (?U 'unmerged)
 481    (t nil)))
 482
 483(defun git-status-code-as-string (code)
 484  "Format a git status code as string."
 485  (case code
 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))
 493    (t "?       ")))
 494
 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)))
 498    (if state
 499        (propertize
 500         (concat "   ("
 501                 (if (eq state 'copy) "copied from "
 502                   (if (eq (git-fileinfo->state info) 'added) "renamed from "
 503                     "renamed to "))
 504                 (git-escape-file-name (git-fileinfo->orig-name info))
 505                 ")") 'face 'git-status-face)
 506      "")))
 507
 508(defun git-permissions-as-string (old-perm new-perm)
 509  "Format a permission change as string."
 510  (propertize
 511   (if (or (not old-perm)
 512           (not new-perm)
 513           (eq 0 (logand ?\111 (logxor old-perm new-perm))))
 514       "  "
 515     (if (eq 0 (logand ?\111 old-perm)) "+x" "-x"))
 516  'face 'git-permission-face))
 517
 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))))
 525
 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"
 531          nil t 1)
 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))))))
 543
 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)))
 549    node))
 550
 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))
 554  (let (infolist)
 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))))
 562
 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))
 566  (let (files)
 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)))
 571
 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))))
 577
 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)))))
 583
 584(defun git-marked-files-state (&rest states)
 585  "Return marked files that are in the specified states."
 586  (let ((files (git-marked-files))
 587        result)
 588    (dolist (info files)
 589      (when (memq (git-fileinfo->state info) states)
 590        (push info result)))
 591    result))
 592
 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."))
 596  (ewoc-map
 597   (lambda (info)
 598     (let ((refresh (git-fileinfo->needs-refresh info)))
 599       (setf (git-fileinfo->needs-refresh info) nil)
 600       refresh))
 601   git-status)
 602  ; move back to goal column
 603  (when goal-column (move-to-column goal-column)))
 604
 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)))
 611    (ewoc-set-hf status
 612                 (format "Directory:  %s\nBranch:     %s\nHead:       %s%s\n"
 613                         default-directory
 614                         (if (string-match "^refs/heads/" branch)
 615                             (substring branch (match-end 0))
 616                           branch)
 617                         head
 618                         (if merge-heads
 619                             (concat "\nMerging:    "
 620                                     (mapconcat (lambda (str) (git-get-commit-description str)) merge-heads "\n            "))
 621                           ""))
 622                 (if (ewoc-nth status 0) "" "    No changes."))))
 623
 624(defun git-get-filenames (files)
 625  (mapcar (lambda (info) (git-fileinfo->name info)) files))
 626
 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)
 631    (dolist (info files)
 632      (case (git-fileinfo->state info)
 633        ('added (push info added))
 634        ('deleted (push info deleted))
 635        ('modified (push info modified))))
 636    (when added
 637      (apply #'git-run-command nil env "update-index" "--add" "--" (git-get-filenames added)))
 638    (when deleted
 639      (apply #'git-run-command nil env "update-index" "--remove" "--" (git-get-filenames deleted)))
 640    (when modified
 641      (apply #'git-run-command nil env "update-index" "--" (git-get-filenames modified)))))
 642
 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)))
 647    (or (not files)
 648        (not (file-executable-p ".git/hooks/pre-commit"))
 649        (let ((index-file (make-temp-file "gitidx")))
 650          (unwind-protect
 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))))))
 656
 657(defun git-do-commit ()
 658  "Perform the actual commit using the current buffer as log message."
 659  (interactive)
 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.")
 665        (unwind-protect
 666            (let ((files (git-marked-files-state 'added 'deleted 'modified))
 667                  head head-tree)
 668              (unless (git-empty-db-p)
 669                (setq head (git-rev-parse "HEAD")
 670                      head-tree (git-rev-parse "HEAD^{tree}")))
 671              (if files
 672                  (progn
 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                            (when (file-directory-p ".git/rr-cache")
 685                              (git-run-command nil nil "rerere"))
 686                            (git-refresh-files)
 687                            (git-refresh-ewoc-hf git-status)
 688                            (message "Committed %s." commit)
 689                            (git-run-hook "post-commit" nil))
 690                        (message "Commit aborted."))))
 691                (message "No files to commit.")))
 692          (delete-file index-file))))))
 693
 694
 695;;;; Interactive functions
 696;;;; ------------------------------------------------------------
 697
 698(defun git-mark-file ()
 699  "Mark the file that the cursor is on and move to the next one."
 700  (interactive)
 701  (unless git-status (error "Not in git-status buffer."))
 702  (let* ((pos (ewoc-locate git-status))
 703         (info (ewoc-data pos)))
 704    (setf (git-fileinfo->marked info) t)
 705    (ewoc-invalidate git-status pos)
 706    (ewoc-goto-next git-status 1)))
 707
 708(defun git-unmark-file ()
 709  "Unmark the file that the cursor is on and move to the next one."
 710  (interactive)
 711  (unless git-status (error "Not in git-status buffer."))
 712  (let* ((pos (ewoc-locate git-status))
 713         (info (ewoc-data pos)))
 714    (setf (git-fileinfo->marked info) nil)
 715    (ewoc-invalidate git-status pos)
 716    (ewoc-goto-next git-status 1)))
 717
 718(defun git-unmark-file-up ()
 719  "Unmark the file that the cursor is on and move to the previous one."
 720  (interactive)
 721  (unless git-status (error "Not in git-status buffer."))
 722  (let* ((pos (ewoc-locate git-status))
 723         (info (ewoc-data pos)))
 724    (setf (git-fileinfo->marked info) nil)
 725    (ewoc-invalidate git-status pos)
 726    (ewoc-goto-prev git-status 1)))
 727
 728(defun git-mark-all ()
 729  "Mark all files."
 730  (interactive)
 731  (unless git-status (error "Not in git-status buffer."))
 732  (ewoc-map (lambda (info) (setf (git-fileinfo->marked info) t) t) git-status)
 733  ; move back to goal column after invalidate
 734  (when goal-column (move-to-column goal-column)))
 735
 736(defun git-unmark-all ()
 737  "Unmark all files."
 738  (interactive)
 739  (unless git-status (error "Not in git-status buffer."))
 740  (ewoc-map (lambda (info) (setf (git-fileinfo->marked info) nil) t) git-status)
 741  ; move back to goal column after invalidate
 742  (when goal-column (move-to-column goal-column)))
 743
 744(defun git-toggle-all-marks ()
 745  "Toggle all file marks."
 746  (interactive)
 747  (unless git-status (error "Not in git-status buffer."))
 748  (ewoc-map (lambda (info) (setf (git-fileinfo->marked info) (not (git-fileinfo->marked info))) t) git-status)
 749  ; move back to goal column after invalidate
 750  (when goal-column (move-to-column goal-column)))
 751
 752(defun git-next-file (&optional n)
 753  "Move the selection down N files."
 754  (interactive "p")
 755  (unless git-status (error "Not in git-status buffer."))
 756  (ewoc-goto-next git-status n))
 757
 758(defun git-prev-file (&optional n)
 759  "Move the selection up N files."
 760  (interactive "p")
 761  (unless git-status (error "Not in git-status buffer."))
 762  (ewoc-goto-prev git-status n))
 763
 764(defun git-next-unmerged-file (&optional n)
 765  "Move the selection down N unmerged files."
 766  (interactive "p")
 767  (unless git-status (error "Not in git-status buffer."))
 768  (let* ((last (ewoc-locate git-status))
 769         (node (ewoc-next git-status last)))
 770    (while (and node (> n 0))
 771      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
 772        (setq n (1- n))
 773        (setq last node))
 774      (setq node (ewoc-next git-status node)))
 775    (ewoc-goto-node git-status last)))
 776
 777(defun git-prev-unmerged-file (&optional n)
 778  "Move the selection up N unmerged files."
 779  (interactive "p")
 780  (unless git-status (error "Not in git-status buffer."))
 781  (let* ((last (ewoc-locate git-status))
 782         (node (ewoc-prev git-status last)))
 783    (while (and node (> n 0))
 784      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
 785        (setq n (1- n))
 786        (setq last node))
 787      (setq node (ewoc-prev git-status node)))
 788    (ewoc-goto-node git-status last)))
 789
 790(defun git-add-file ()
 791  "Add marked file(s) to the index cache."
 792  (interactive)
 793  (let ((files (git-marked-files-state 'unknown)))
 794    (unless files
 795      (push (ewoc-data
 796             (git-add-status-file 'added (file-relative-name
 797                                          (read-file-name "File to add: " nil nil t))))
 798            files))
 799    (apply #'git-run-command nil nil "update-index" "--info-only" "--add" "--" (git-get-filenames files))
 800    (git-set-files-state files 'added)
 801    (git-refresh-files)))
 802
 803(defun git-ignore-file ()
 804  "Add marked file(s) to the ignore list."
 805  (interactive)
 806  (let ((files (git-marked-files-state 'unknown)))
 807    (unless files
 808      (push (ewoc-data
 809             (git-add-status-file 'unknown (file-relative-name
 810                                            (read-file-name "File to ignore: " nil nil t))))
 811            files))
 812    (dolist (info files) (git-append-to-ignore (git-fileinfo->name info)))
 813    (git-set-files-state files 'ignored)
 814    (git-refresh-files)))
 815
 816(defun git-remove-file ()
 817  "Remove the marked file(s)."
 818  (interactive)
 819  (let ((files (git-marked-files-state 'added 'modified 'unknown 'uptodate)))
 820    (unless files
 821      (push (ewoc-data
 822             (git-add-status-file 'unknown (file-relative-name
 823                                            (read-file-name "File to remove: " nil nil t))))
 824            files))
 825    (if (yes-or-no-p
 826         (format "Remove %d file%s? " (length files) (if (> (length files) 1) "s" "")))
 827        (progn
 828          (dolist (info files)
 829            (let ((name (git-fileinfo->name info)))
 830              (when (file-exists-p name) (delete-file name))))
 831          (apply #'git-run-command nil nil "update-index" "--info-only" "--remove" "--" (git-get-filenames files))
 832          ; remove unknown files from the list, set the others to deleted
 833          (ewoc-filter git-status
 834                       (lambda (info files)
 835                         (not (and (memq info files) (eq (git-fileinfo->state info) 'unknown))))
 836                       files)
 837          (git-set-files-state files 'deleted)
 838          (git-refresh-files)
 839          (unless (ewoc-nth git-status 0)  ; refresh header if list is empty
 840            (git-refresh-ewoc-hf git-status)))
 841      (message "Aborting"))))
 842
 843(defun git-revert-file ()
 844  "Revert changes to the marked file(s)."
 845  (interactive)
 846  (let ((files (git-marked-files))
 847        added modified)
 848    (when (and files
 849               (yes-or-no-p
 850                (format "Revert %d file%s? " (length files) (if (> (length files) 1) "s" ""))))
 851      (dolist (info files)
 852        (case (git-fileinfo->state info)
 853          ('added (push info added))
 854          ('deleted (push info modified))
 855          ('unmerged (push info modified))
 856          ('modified (push info modified))))
 857      (when added
 858          (apply #'git-run-command nil nil "update-index" "--force-remove" "--" (git-get-filenames added))
 859          (git-set-files-state added 'unknown))
 860      (when modified
 861          (apply #'git-run-command nil nil "checkout" "HEAD" (git-get-filenames modified))
 862          (git-set-files-state modified 'uptodate))
 863      (git-refresh-files))))
 864
 865(defun git-resolve-file ()
 866  "Resolve conflicts in marked file(s)."
 867  (interactive)
 868  (let ((files (git-marked-files-state 'unmerged)))
 869    (when files
 870      (apply #'git-run-command nil nil "update-index" "--" (git-get-filenames files))
 871      (git-set-files-state files 'modified)
 872      (git-refresh-files))))
 873
 874(defun git-remove-handled ()
 875  "Remove handled files from the status list."
 876  (interactive)
 877  (ewoc-filter git-status
 878               (lambda (info)
 879                 (not (or (eq (git-fileinfo->state info) 'ignored)
 880                          (eq (git-fileinfo->state info) 'uptodate)))))
 881  (unless (ewoc-nth git-status 0)  ; refresh header if list is empty
 882    (git-refresh-ewoc-hf git-status)))
 883
 884(defun git-setup-diff-buffer (buffer)
 885  "Setup a buffer for displaying a diff."
 886  (with-current-buffer buffer
 887    (diff-mode)
 888    (goto-char (point-min))
 889    (setq buffer-read-only t))
 890  (display-buffer buffer)
 891  (shrink-window-if-larger-than-buffer))
 892
 893(defun git-diff-file ()
 894  "Diff the marked file(s) against HEAD."
 895  (interactive)
 896  (let ((files (git-marked-files)))
 897    (git-setup-diff-buffer
 898     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M" "HEAD" "--" (git-get-filenames files)))))
 899
 900(defun git-diff-file-merge-head (arg)
 901  "Diff the marked file(s) against the first merge head (or the nth one with a numeric prefix)."
 902  (interactive "p")
 903  (let ((files (git-marked-files))
 904        (merge-heads (git-get-merge-heads)))
 905    (unless merge-heads (error "No merge in progress"))
 906    (git-setup-diff-buffer
 907     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M"
 908            (or (nth (1- arg) merge-heads) "HEAD") "--" (git-get-filenames files)))))
 909
 910(defun git-diff-unmerged-file (stage)
 911  "Diff the marked unmerged file(s) against the specified stage."
 912  (let ((files (git-marked-files)))
 913    (git-setup-diff-buffer
 914     (apply #'git-run-command-buffer "*git-diff*" "diff-files" "-p" stage "--" (git-get-filenames files)))))
 915
 916(defun git-diff-file-base ()
 917  "Diff the marked unmerged file(s) against the common base file."
 918  (interactive)
 919  (git-diff-unmerged-file "-1"))
 920
 921(defun git-diff-file-mine ()
 922  "Diff the marked unmerged file(s) against my pre-merge version."
 923  (interactive)
 924  (git-diff-unmerged-file "-2"))
 925
 926(defun git-diff-file-other ()
 927  "Diff the marked unmerged file(s) against the other's pre-merge version."
 928  (interactive)
 929  (git-diff-unmerged-file "-3"))
 930
 931(defun git-diff-file-combined ()
 932  "Do a combined diff of the marked unmerged file(s)."
 933  (interactive)
 934  (git-diff-unmerged-file "-c"))
 935
 936(defun git-diff-file-idiff ()
 937  "Perform an interactive diff on the current file."
 938  (interactive)
 939  (error "Interactive diffs not implemented yet."))
 940
 941(defun git-log-file ()
 942  "Display a log of changes to the marked file(s)."
 943  (interactive)
 944  (let* ((files (git-marked-files))
 945         (coding-system-for-read git-commits-coding-system)
 946         (buffer (apply #'git-run-command-buffer "*git-log*" "rev-list" "--pretty" "HEAD" "--" (git-get-filenames files))))
 947    (with-current-buffer buffer
 948      ; (git-log-mode)  FIXME: implement log mode
 949      (goto-char (point-min))
 950      (setq buffer-read-only t))
 951    (display-buffer buffer)))
 952
 953(defun git-log-edit-files ()
 954  "Return a list of marked files for use in the log-edit buffer."
 955  (with-current-buffer log-edit-parent-buffer
 956    (git-get-filenames (git-marked-files-state 'added 'deleted 'modified))))
 957
 958(defun git-append-sign-off (name email)
 959  "Append a Signed-off-by entry to the current buffer, avoiding duplicates."
 960  (let ((sign-off (format "Signed-off-by: %s <%s>" name email))
 961        (case-fold-search t))
 962    (goto-char (point-min))
 963    (unless (re-search-forward (concat "^" (regexp-quote sign-off)) nil t)
 964      (goto-char (point-min))
 965      (unless (re-search-forward "^Signed-off-by: " nil t)
 966        (setq sign-off (concat "\n" sign-off)))
 967      (goto-char (point-max))
 968      (insert sign-off "\n"))))
 969
 970(defun git-setup-log-buffer (buffer &optional author-name author-email subject date msg)
 971  "Setup the log buffer for a commit."
 972  (unless git-status (error "Not in git-status buffer."))
 973  (let ((merge-heads (git-get-merge-heads))
 974        (dir default-directory)
 975        (committer-name (git-get-committer-name))
 976        (committer-email (git-get-committer-email))
 977        (sign-off git-append-signed-off-by))
 978    (with-current-buffer buffer
 979      (cd dir)
 980      (erase-buffer)
 981      (insert
 982       (propertize
 983        (format "Author: %s <%s>\n%s%s"
 984                (or author-name committer-name)
 985                (or author-email committer-email)
 986                (if date (format "Date: %s\n" date) "")
 987                (if merge-heads
 988                    (format "Parent: %s\n%s\n"
 989                            (git-rev-parse "HEAD")
 990                            (mapconcat (lambda (str) (concat "Parent: " str)) merge-heads "\n"))
 991                  ""))
 992        'face 'git-header-face)
 993       (propertize git-log-msg-separator 'face 'git-separator-face)
 994       "\n")
 995      (when subject (insert subject "\n\n"))
 996      (cond (msg (insert msg "\n"))
 997            ((file-readable-p ".dotest/msg")
 998             (insert-file-contents ".dotest/msg"))
 999            ((file-readable-p ".git/MERGE_MSG")
1000             (insert-file-contents ".git/MERGE_MSG")))
1001      ; delete empty lines at end
1002      (goto-char (point-min))
1003      (when (re-search-forward "\n+\\'" nil t)
1004        (replace-match "\n" t t))
1005      (when sign-off (git-append-sign-off committer-name committer-email)))))
1006
1007(defun git-commit-file ()
1008  "Commit the marked file(s), asking for a commit message."
1009  (interactive)
1010  (unless git-status (error "Not in git-status buffer."))
1011  (when (git-run-pre-commit-hook)
1012    (let ((buffer (get-buffer-create "*git-commit*"))
1013          (coding-system (git-get-commits-coding-system))
1014          author-name author-email subject date)
1015      (when (eq 0 (buffer-size buffer))
1016        (when (file-readable-p ".dotest/info")
1017          (with-temp-buffer
1018            (insert-file-contents ".dotest/info")
1019            (goto-char (point-min))
1020            (when (re-search-forward "^Author: \\(.*\\)\nEmail: \\(.*\\)$" nil t)
1021              (setq author-name (match-string 1))
1022              (setq author-email (match-string 2)))
1023            (goto-char (point-min))
1024            (when (re-search-forward "^Subject: \\(.*\\)$" nil t)
1025              (setq subject (match-string 1)))
1026            (goto-char (point-min))
1027            (when (re-search-forward "^Date: \\(.*\\)$" nil t)
1028              (setq date (match-string 1)))))
1029        (git-setup-log-buffer buffer author-name author-email subject date))
1030      (log-edit #'git-do-commit nil #'git-log-edit-files buffer)
1031      (setq font-lock-keywords (font-lock-compile-keywords git-log-edit-font-lock-keywords))
1032      (setq buffer-file-coding-system coding-system)
1033      (re-search-forward (regexp-quote (concat git-log-msg-separator "\n")) nil t))))
1034
1035(defun git-find-file ()
1036  "Visit the current file in its own buffer."
1037  (interactive)
1038  (unless git-status (error "Not in git-status buffer."))
1039  (let ((info (ewoc-data (ewoc-locate git-status))))
1040    (find-file (git-fileinfo->name info))
1041    (when (eq 'unmerged (git-fileinfo->state info))
1042      (smerge-mode))))
1043
1044(defun git-find-file-other-window ()
1045  "Visit the current file in its own buffer in another window."
1046  (interactive)
1047  (unless git-status (error "Not in git-status buffer."))
1048  (let ((info (ewoc-data (ewoc-locate git-status))))
1049    (find-file-other-window (git-fileinfo->name info))
1050    (when (eq 'unmerged (git-fileinfo->state info))
1051      (smerge-mode))))
1052
1053(defun git-find-file-imerge ()
1054  "Visit the current file in interactive merge mode."
1055  (interactive)
1056  (unless git-status (error "Not in git-status buffer."))
1057  (let ((info (ewoc-data (ewoc-locate git-status))))
1058    (find-file (git-fileinfo->name info))
1059    (smerge-ediff)))
1060
1061(defun git-view-file ()
1062  "View the current file in its own buffer."
1063  (interactive)
1064  (unless git-status (error "Not in git-status buffer."))
1065  (let ((info (ewoc-data (ewoc-locate git-status))))
1066    (view-file (git-fileinfo->name info))))
1067
1068(defun git-refresh-status ()
1069  "Refresh the git status buffer."
1070  (interactive)
1071  (let* ((status git-status)
1072         (pos (ewoc-locate status))
1073         (cur-name (and pos (git-fileinfo->name (ewoc-data pos)))))
1074    (unless status (error "Not in git-status buffer."))
1075    (git-clear-status status)
1076    (git-run-command nil nil "update-index" "--info-only" "--refresh")
1077    (if (git-empty-db-p)
1078        ; we need some special handling for an empty db
1079        (with-temp-buffer
1080          (git-run-command t nil "ls-files" "-z" "-t" "-c")
1081          (git-parse-ls-files status 'added))
1082      (with-temp-buffer
1083        (git-run-command t nil "diff-index" "-z" "-M" "HEAD")
1084        (git-parse-status status)))
1085      (with-temp-buffer
1086        (git-run-command t nil "ls-files" "-z" "-u")
1087        (git-parse-ls-unmerged status))
1088      (when (file-readable-p ".git/info/exclude")
1089        (with-temp-buffer
1090          (git-run-command t nil "ls-files" "-z" "-t" "-o"
1091                           "--exclude-from=.git/info/exclude"
1092                           (concat "--exclude-per-directory=" git-per-dir-ignore-file))
1093          (git-parse-ls-files status 'unknown)))
1094    (git-refresh-files)
1095    (git-refresh-ewoc-hf status)
1096    ; move point to the current file name if any
1097    (let ((node (and cur-name (git-find-status-file status cur-name))))
1098      (when node (ewoc-goto-node status node)))))
1099
1100(defun git-status-quit ()
1101  "Quit git-status mode."
1102  (interactive)
1103  (bury-buffer))
1104
1105;;;; Major Mode
1106;;;; ------------------------------------------------------------
1107
1108(defvar git-status-mode-hook nil
1109  "Run after `git-status-mode' is setup.")
1110
1111(defvar git-status-mode-map nil
1112  "Keymap for git major mode.")
1113
1114(defvar git-status nil
1115  "List of all files managed by the git-status mode.")
1116
1117(unless git-status-mode-map
1118  (let ((map (make-keymap))
1119        (diff-map (make-sparse-keymap)))
1120    (suppress-keymap map)
1121    (define-key map "?"   'git-help)
1122    (define-key map "h"   'git-help)
1123    (define-key map " "   'git-next-file)
1124    (define-key map "a"   'git-add-file)
1125    (define-key map "c"   'git-commit-file)
1126    (define-key map "d"    diff-map)
1127    (define-key map "="   'git-diff-file)
1128    (define-key map "f"   'git-find-file)
1129    (define-key map "\r"  'git-find-file)
1130    (define-key map "g"   'git-refresh-status)
1131    (define-key map "i"   'git-ignore-file)
1132    (define-key map "l"   'git-log-file)
1133    (define-key map "m"   'git-mark-file)
1134    (define-key map "M"   'git-mark-all)
1135    (define-key map "n"   'git-next-file)
1136    (define-key map "N"   'git-next-unmerged-file)
1137    (define-key map "o"   'git-find-file-other-window)
1138    (define-key map "p"   'git-prev-file)
1139    (define-key map "P"   'git-prev-unmerged-file)
1140    (define-key map "q"   'git-status-quit)
1141    (define-key map "r"   'git-remove-file)
1142    (define-key map "R"   'git-resolve-file)
1143    (define-key map "T"   'git-toggle-all-marks)
1144    (define-key map "u"   'git-unmark-file)
1145    (define-key map "U"   'git-revert-file)
1146    (define-key map "v"   'git-view-file)
1147    (define-key map "x"   'git-remove-handled)
1148    (define-key map "\C-?" 'git-unmark-file-up)
1149    (define-key map "\M-\C-?" 'git-unmark-all)
1150    ; the diff submap
1151    (define-key diff-map "b" 'git-diff-file-base)
1152    (define-key diff-map "c" 'git-diff-file-combined)
1153    (define-key diff-map "=" 'git-diff-file)
1154    (define-key diff-map "e" 'git-diff-file-idiff)
1155    (define-key diff-map "E" 'git-find-file-imerge)
1156    (define-key diff-map "h" 'git-diff-file-merge-head)
1157    (define-key diff-map "m" 'git-diff-file-mine)
1158    (define-key diff-map "o" 'git-diff-file-other)
1159    (setq git-status-mode-map map)))
1160
1161;; git mode should only run in the *git status* buffer
1162(put 'git-status-mode 'mode-class 'special)
1163
1164(defun git-status-mode ()
1165  "Major mode for interacting with Git.
1166Commands:
1167\\{git-status-mode-map}"
1168  (kill-all-local-variables)
1169  (buffer-disable-undo)
1170  (setq mode-name "git status"
1171        major-mode 'git-status-mode
1172        goal-column 17
1173        buffer-read-only t)
1174  (use-local-map git-status-mode-map)
1175  (let ((buffer-read-only nil))
1176    (erase-buffer)
1177  (let ((status (ewoc-create 'git-fileinfo-prettyprint "" "")))
1178    (set (make-local-variable 'git-status) status))
1179  (set (make-local-variable 'list-buffers-directory) default-directory)
1180  (run-hooks 'git-status-mode-hook)))
1181
1182(defun git-find-status-buffer (dir)
1183  "Find the git status buffer handling a specified directory."
1184  (let ((list (buffer-list))
1185        (fulldir (expand-file-name dir))
1186        found)
1187    (while (and list (not found))
1188      (let ((buffer (car list)))
1189        (with-current-buffer buffer
1190          (when (and list-buffers-directory
1191                     (string-equal fulldir (expand-file-name list-buffers-directory))
1192                     (string-match "\\*git-status\\*$" (buffer-name buffer)))
1193            (setq found buffer))))
1194      (setq list (cdr list)))
1195    found))
1196
1197(defun git-status (dir)
1198  "Entry point into git-status mode."
1199  (interactive "DSelect directory: ")
1200  (setq dir (git-get-top-dir dir))
1201  (if (file-directory-p (concat (file-name-as-directory dir) ".git"))
1202      (let ((buffer (or (and git-reuse-status-buffer (git-find-status-buffer dir))
1203                        (create-file-buffer (expand-file-name "*git-status*" dir)))))
1204        (switch-to-buffer buffer)
1205        (cd dir)
1206        (git-status-mode)
1207        (git-refresh-status)
1208        (goto-char (point-min)))
1209    (message "%s is not a git working tree." dir)))
1210
1211(defun git-help ()
1212  "Display help for Git mode."
1213  (interactive)
1214  (describe-function 'git-status-mode))
1215
1216(provide 'git)
1217;;; git.el ends here