Andrew's git - gitweb.git/blob - contrib/emacs/git.el

   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;;  - diff against other branch
  39;;  - renaming files from the status buffer
  40;;  - creating tags
  41;;  - fetch/pull
  42;;  - switching branches
  43;;  - revlist browser
  44;;  - git-show-branch browser
  45;;  - menus
  46;;
  47
  48(eval-when-compile (require 'cl))
  49(require 'ewoc)
  50(require 'log-edit)
  51(require 'easymenu)
  52
  53
  54;;;; Customizations
  55;;;; ------------------------------------------------------------
  56
  57(defgroup git nil
  58  "A user interface for the git versioning system."
  59  :group 'tools)
  60
  61(defcustom git-committer-name nil
  62  "User name to use for commits.
  63The default is to fall back to the repository config,
  64then to `add-log-full-name' and then to `user-full-name'."
  65  :group 'git
  66  :type '(choice (const :tag "Default" nil)
  67                 (string :tag "Name")))
  68
  69(defcustom git-committer-email nil
  70  "Email address to use for commits.
  71The default is to fall back to the git repository config,
  72then to `add-log-mailing-address' and then to `user-mail-address'."
  73  :group 'git
  74  :type '(choice (const :tag "Default" nil)
  75                 (string :tag "Email")))
  76
  77(defcustom git-commits-coding-system nil
  78  "Default coding system for the log message of git commits."
  79  :group 'git
  80  :type '(choice (const :tag "From repository config" nil)
  81                 (coding-system)))
  82
  83(defcustom git-append-signed-off-by nil
  84  "Whether to append a Signed-off-by line to the commit message before editing."
  85  :group 'git
  86  :type 'boolean)
  87
  88(defcustom git-reuse-status-buffer t
  89  "Whether `git-status' should try to reuse an existing buffer
  90if there is already one that displays the same directory."
  91  :group 'git
  92  :type 'boolean)
  93
  94(defcustom git-per-dir-ignore-file ".gitignore"
  95  "Name of the per-directory ignore file."
  96  :group 'git
  97  :type 'string)
  98
  99(defcustom git-show-uptodate nil
 100  "Whether to display up-to-date files."
 101  :group 'git
 102  :type 'boolean)
 103
 104(defcustom git-show-ignored nil
 105  "Whether to display ignored files."
 106  :group 'git
 107  :type 'boolean)
 108
 109(defcustom git-show-unknown t
 110  "Whether to display unknown files."
 111  :group 'git
 112  :type 'boolean)
 113
 114
 115(defface git-status-face
 116  '((((class color) (background light)) (:foreground "purple"))
 117    (((class color) (background dark)) (:foreground "salmon")))
 118  "Git mode face used to highlight added and modified files."
 119  :group 'git)
 120
 121(defface git-unmerged-face
 122  '((((class color) (background light)) (:foreground "red" :bold t))
 123    (((class color) (background dark)) (:foreground "red" :bold t)))
 124  "Git mode face used to highlight unmerged files."
 125  :group 'git)
 126
 127(defface git-unknown-face
 128  '((((class color) (background light)) (:foreground "goldenrod" :bold t))
 129    (((class color) (background dark)) (:foreground "goldenrod" :bold t)))
 130  "Git mode face used to highlight unknown files."
 131  :group 'git)
 132
 133(defface git-uptodate-face
 134  '((((class color) (background light)) (:foreground "grey60"))
 135    (((class color) (background dark)) (:foreground "grey40")))
 136  "Git mode face used to highlight up-to-date files."
 137  :group 'git)
 138
 139(defface git-ignored-face
 140  '((((class color) (background light)) (:foreground "grey60"))
 141    (((class color) (background dark)) (:foreground "grey40")))
 142  "Git mode face used to highlight ignored files."
 143  :group 'git)
 144
 145(defface git-mark-face
 146  '((((class color) (background light)) (:foreground "red" :bold t))
 147    (((class color) (background dark)) (:foreground "tomato" :bold t)))
 148  "Git mode face used for the file marks."
 149  :group 'git)
 150
 151(defface git-header-face
 152  '((((class color) (background light)) (:foreground "blue"))
 153    (((class color) (background dark)) (:foreground "blue")))
 154  "Git mode face used for commit headers."
 155  :group 'git)
 156
 157(defface git-separator-face
 158  '((((class color) (background light)) (:foreground "brown"))
 159    (((class color) (background dark)) (:foreground "brown")))
 160  "Git mode face used for commit separator."
 161  :group 'git)
 162
 163(defface git-permission-face
 164  '((((class color) (background light)) (:foreground "green" :bold t))
 165    (((class color) (background dark)) (:foreground "green" :bold t)))
 166  "Git mode face used for permission changes."
 167  :group 'git)
 168
 169
 170;;;; Utilities
 171;;;; ------------------------------------------------------------
 172
 173(defconst git-log-msg-separator "--- log message follows this line ---")
 174
 175(defvar git-log-edit-font-lock-keywords
 176  `(("^\\(Author:\\|Date:\\|Merge:\\|Signed-off-by:\\)\\(.*\\)$"
 177     (1 font-lock-keyword-face)
 178     (2 font-lock-function-name-face))
 179    (,(concat "^\\(" (regexp-quote git-log-msg-separator) "\\)$")
 180     (1 font-lock-comment-face))))
 181
 182(defun git-get-env-strings (env)
 183  "Build a list of NAME=VALUE strings from a list of environment strings."
 184  (mapcar (lambda (entry) (concat (car entry) "=" (cdr entry))) env))
 185
 186(defun git-call-process (buffer &rest args)
 187  "Wrapper for call-process that sets environment strings."
 188  (apply #'call-process "git" nil buffer nil args))
 189
 190(defun git-call-process-display-error (&rest args)
 191  "Wrapper for call-process that displays error messages."
 192  (let* ((dir default-directory)
 193         (buffer (get-buffer-create "*Git Command Output*"))
 194         (ok (with-current-buffer buffer
 195               (let ((default-directory dir)
 196                     (buffer-read-only nil))
 197                 (erase-buffer)
 198                 (eq 0 (apply #'git-call-process (list buffer t) args))))))
 199    (unless ok (display-message-or-buffer buffer))
 200    ok))
 201
 202(defun git-call-process-string (&rest args)
 203  "Wrapper for call-process that returns the process output as a string,
 204or nil if the git command failed."
 205  (with-temp-buffer
 206    (and (eq 0 (apply #'git-call-process t args))
 207         (buffer-string))))
 208
 209(defun git-call-process-string-display-error (&rest args)
 210  "Wrapper for call-process that displays error message and returns
 211the process output as a string, or nil if the git command failed."
 212  (with-temp-buffer
 213    (if (eq 0 (apply #'git-call-process (list t t) args))
 214        (buffer-string)
 215      (display-message-or-buffer (current-buffer))
 216      nil)))
 217
 218(defun git-run-process-region (buffer start end program args)
 219  "Run a git process with a buffer region as input."
 220  (let ((output-buffer (current-buffer))
 221        (dir default-directory))
 222    (with-current-buffer buffer
 223      (cd dir)
 224      (apply #'call-process-region start end program
 225             nil (list output-buffer nil) nil args))))
 226
 227(defun git-run-command-buffer (buffer-name &rest args)
 228  "Run a git command, sending the output to a buffer named BUFFER-NAME."
 229  (let ((dir default-directory)
 230        (buffer (get-buffer-create buffer-name)))
 231    (message "Running git %s..." (car args))
 232    (with-current-buffer buffer
 233      (let ((default-directory dir)
 234            (buffer-read-only nil))
 235        (erase-buffer)
 236        (apply #'git-call-process buffer args)))
 237    (message "Running git %s...done" (car args))
 238    buffer))
 239
 240(defun git-run-command-region (buffer start end env &rest args)
 241  "Run a git command with specified buffer region as input."
 242  (unless (eq 0 (if env
 243                    (git-run-process-region
 244                     buffer start end "env"
 245                     (append (git-get-env-strings env) (list "git") args))
 246                  (git-run-process-region
 247                   buffer start end "git" args)))
 248    (error "Failed to run \"git %s\":\n%s" (mapconcat (lambda (x) x) args " ") (buffer-string))))
 249
 250(defun git-run-hook (hook env &rest args)
 251  "Run a git hook and display its output if any."
 252  (let ((dir default-directory)
 253        (hook-name (expand-file-name (concat ".git/hooks/" hook))))
 254    (or (not (file-executable-p hook-name))
 255        (let (status (buffer (get-buffer-create "*Git Hook Output*")))
 256          (with-current-buffer buffer
 257            (erase-buffer)
 258            (cd dir)
 259            (setq status
 260                  (if env
 261                      (apply #'call-process "env" nil (list buffer t) nil
 262                             (append (git-get-env-strings env) (list hook-name) args))
 263                    (apply #'call-process hook-name nil (list buffer t) nil args))))
 264          (display-message-or-buffer buffer)
 265          (eq 0 status)))))
 266
 267(defun git-get-string-sha1 (string)
 268  "Read a SHA1 from the specified string."
 269  (and string
 270       (string-match "[0-9a-f]\\{40\\}" string)
 271       (match-string 0 string)))
 272
 273(defun git-get-committer-name ()
 274  "Return the name to use as GIT_COMMITTER_NAME."
 275  ; copied from log-edit
 276  (or git-committer-name
 277      (git-config "user.name")
 278      (and (boundp 'add-log-full-name) add-log-full-name)
 279      (and (fboundp 'user-full-name) (user-full-name))
 280      (and (boundp 'user-full-name) user-full-name)))
 281
 282(defun git-get-committer-email ()
 283  "Return the email address to use as GIT_COMMITTER_EMAIL."
 284  ; copied from log-edit
 285  (or git-committer-email
 286      (git-config "user.email")
 287      (and (boundp 'add-log-mailing-address) add-log-mailing-address)
 288      (and (fboundp 'user-mail-address) (user-mail-address))
 289      (and (boundp 'user-mail-address) user-mail-address)))
 290
 291(defun git-get-commits-coding-system ()
 292  "Return the coding system to use for commits."
 293  (let ((repo-config (git-config "i18n.commitencoding")))
 294    (or git-commits-coding-system
 295        (and repo-config
 296             (fboundp 'locale-charset-to-coding-system)
 297             (locale-charset-to-coding-system repo-config))
 298      'utf-8)))
 299
 300(defun git-get-logoutput-coding-system ()
 301  "Return the coding system used for git-log output."
 302  (let ((repo-config (or (git-config "i18n.logoutputencoding")
 303                         (git-config "i18n.commitencoding"))))
 304    (or git-commits-coding-system
 305        (and repo-config
 306             (fboundp 'locale-charset-to-coding-system)
 307             (locale-charset-to-coding-system repo-config))
 308      'utf-8)))
 309
 310(defun git-escape-file-name (name)
 311  "Escape a file name if necessary."
 312  (if (string-match "[\n\t\"\\]" name)
 313      (concat "\""
 314              (mapconcat (lambda (c)
 315                   (case c
 316                     (?\n "\\n")
 317                     (?\t "\\t")
 318                     (?\\ "\\\\")
 319                     (?\" "\\\"")
 320                     (t (char-to-string c))))
 321                 name "")
 322              "\"")
 323    name))
 324
 325(defun git-success-message (text files)
 326  "Print a success message after having handled FILES."
 327  (let ((n (length files)))
 328    (if (equal n 1)
 329        (message "%s %s" text (car files))
 330      (message "%s %d files" text n))))
 331
 332(defun git-get-top-dir (dir)
 333  "Retrieve the top-level directory of a git tree."
 334  (let ((cdup (with-output-to-string
 335                (with-current-buffer standard-output
 336                  (cd dir)
 337                  (unless (eq 0 (git-call-process t "rev-parse" "--show-cdup"))
 338                    (error "cannot find top-level git tree for %s." dir))))))
 339    (expand-file-name (concat (file-name-as-directory dir)
 340                              (car (split-string cdup "\n"))))))
 341
 342;stolen from pcl-cvs
 343(defun git-append-to-ignore (file)
 344  "Add a file name to the ignore file in its directory."
 345  (let* ((fullname (expand-file-name file))
 346         (dir (file-name-directory fullname))
 347         (name (file-name-nondirectory fullname))
 348         (ignore-name (expand-file-name git-per-dir-ignore-file dir))
 349         (created (not (file-exists-p ignore-name))))
 350  (save-window-excursion
 351    (set-buffer (find-file-noselect ignore-name))
 352    (goto-char (point-max))
 353    (unless (zerop (current-column)) (insert "\n"))
 354    (insert "/" name "\n")
 355    (sort-lines nil (point-min) (point-max))
 356    (save-buffer))
 357  (when created
 358    (git-call-process nil "update-index" "--add" "--" (file-relative-name ignore-name)))
 359  (git-update-status-files (list (file-relative-name ignore-name)))))
 360
 361; propertize definition for XEmacs, stolen from erc-compat
 362(eval-when-compile
 363  (unless (fboundp 'propertize)
 364    (defun propertize (string &rest props)
 365      (let ((string (copy-sequence string)))
 366        (while props
 367          (put-text-property 0 (length string) (nth 0 props) (nth 1 props) string)
 368          (setq props (cddr props)))
 369        string))))
 370
 371;;;; Wrappers for basic git commands
 372;;;; ------------------------------------------------------------
 373
 374(defun git-rev-parse (rev)
 375  "Parse a revision name and return its SHA1."
 376  (git-get-string-sha1
 377   (git-call-process-string "rev-parse" rev)))
 378
 379(defun git-config (key)
 380  "Retrieve the value associated to KEY in the git repository config file."
 381  (let ((str (git-call-process-string "config" key)))
 382    (and str (car (split-string str "\n")))))
 383
 384(defun git-symbolic-ref (ref)
 385  "Wrapper for the git-symbolic-ref command."
 386  (let ((str (git-call-process-string "symbolic-ref" ref)))
 387    (and str (car (split-string str "\n")))))
 388
 389(defun git-update-ref (ref newval &optional oldval reason)
 390  "Update a reference by calling git-update-ref."
 391  (let ((args (and oldval (list oldval))))
 392    (when newval (push newval args))
 393    (push ref args)
 394    (when reason
 395     (push reason args)
 396     (push "-m" args))
 397    (unless newval (push "-d" args))
 398    (apply 'git-call-process-display-error "update-ref" args)))
 399
 400(defun git-read-tree (tree &optional index-file)
 401  "Read a tree into the index file."
 402  (let ((process-environment
 403         (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file))) process-environment)))
 404    (apply 'git-call-process-display-error "read-tree" (if tree (list tree)))))
 405
 406(defun git-write-tree (&optional index-file)
 407  "Call git-write-tree and return the resulting tree SHA1 as a string."
 408  (let ((process-environment
 409         (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file))) process-environment)))
 410    (git-get-string-sha1
 411     (git-call-process-string-display-error "write-tree"))))
 412
 413(defun git-commit-tree (buffer tree head)
 414  "Call git-commit-tree with buffer as input and return the resulting commit SHA1."
 415  (let ((author-name (git-get-committer-name))
 416        (author-email (git-get-committer-email))
 417        (subject "commit (initial): ")
 418        author-date log-start log-end args coding-system-for-write)
 419    (when head
 420      (setq subject "commit: ")
 421      (push "-p" args)
 422      (push head args))
 423    (with-current-buffer buffer
 424      (goto-char (point-min))
 425      (if
 426          (setq log-start (re-search-forward (concat "^" (regexp-quote git-log-msg-separator) "\n") nil t))
 427          (save-restriction
 428            (narrow-to-region (point-min) log-start)
 429            (goto-char (point-min))
 430            (when (re-search-forward "^Author: +\\(.*?\\) *<\\(.*\\)> *$" nil t)
 431              (setq author-name (match-string 1)
 432                    author-email (match-string 2)))
 433            (goto-char (point-min))
 434            (when (re-search-forward "^Date: +\\(.*\\)$" nil t)
 435              (setq author-date (match-string 1)))
 436            (goto-char (point-min))
 437            (when (re-search-forward "^Merge: +\\(.*\\)" nil t)
 438              (setq subject "commit (merge): ")
 439              (dolist (parent (split-string (match-string 1) " +" t))
 440                (push "-p" args)
 441                (push parent args))))
 442        (setq log-start (point-min)))
 443      (setq log-end (point-max))
 444      (goto-char log-start)
 445      (when (re-search-forward ".*$" nil t)
 446        (setq subject (concat subject (match-string 0))))
 447      (setq coding-system-for-write buffer-file-coding-system))
 448    (let ((commit
 449           (git-get-string-sha1
 450            (with-output-to-string
 451              (with-current-buffer standard-output
 452                (let ((env `(("GIT_AUTHOR_NAME" . ,author-name)
 453                             ("GIT_AUTHOR_EMAIL" . ,author-email)
 454                             ("GIT_COMMITTER_NAME" . ,(git-get-committer-name))
 455                             ("GIT_COMMITTER_EMAIL" . ,(git-get-committer-email)))))
 456                  (when author-date (push `("GIT_AUTHOR_DATE" . ,author-date) env))
 457                  (apply #'git-run-command-region
 458                         buffer log-start log-end env
 459                         "commit-tree" tree (nreverse args))))))))
 460      (and (git-update-ref "HEAD" commit head subject)
 461           commit))))
 462
 463(defun git-empty-db-p ()
 464  "Check if the git db is empty (no commit done yet)."
 465  (not (eq 0 (git-call-process nil "rev-parse" "--verify" "HEAD"))))
 466
 467(defun git-get-merge-heads ()
 468  "Retrieve the merge heads from the MERGE_HEAD file if present."
 469  (let (heads)
 470    (when (file-readable-p ".git/MERGE_HEAD")
 471      (with-temp-buffer
 472        (insert-file-contents ".git/MERGE_HEAD" nil nil nil t)
 473        (goto-char (point-min))
 474        (while (re-search-forward "[0-9a-f]\\{40\\}" nil t)
 475          (push (match-string 0) heads))))
 476    (nreverse heads)))
 477
 478(defun git-get-commit-description (commit)
 479  "Get a one-line description of COMMIT."
 480  (let ((coding-system-for-read (git-get-logoutput-coding-system)))
 481    (let ((descr (git-call-process-string "log" "--max-count=1" "--pretty=oneline" commit)))
 482      (if (and descr (string-match "\\`\\([0-9a-f]\\{40\\}\\) *\\(.*\\)$" descr))
 483          (concat (substring (match-string 1 descr) 0 10) " - " (match-string 2 descr))
 484        descr))))
 485
 486;;;; File info structure
 487;;;; ------------------------------------------------------------
 488
 489; fileinfo structure stolen from pcl-cvs
 490(defstruct (git-fileinfo
 491            (:copier nil)
 492            (:constructor git-create-fileinfo (state name &optional old-perm new-perm rename-state orig-name marked))
 493            (:conc-name git-fileinfo->))
 494  marked              ;; t/nil
 495  state               ;; current state
 496  name                ;; file name
 497  old-perm new-perm   ;; permission flags
 498  rename-state        ;; rename or copy state
 499  orig-name           ;; original name for renames or copies
 500  needs-update        ;; whether file needs to be updated
 501  needs-refresh)      ;; whether file needs to be refreshed
 502
 503(defvar git-status nil)
 504
 505(defun git-set-fileinfo-state (info state)
 506  "Set the state of a file info."
 507  (unless (eq (git-fileinfo->state info) state)
 508    (setf (git-fileinfo->state info) state
 509          (git-fileinfo->new-perm info) (git-fileinfo->old-perm info)
 510          (git-fileinfo->rename-state info) nil
 511          (git-fileinfo->orig-name info) nil
 512          (git-fileinfo->needs-update info) nil
 513          (git-fileinfo->needs-refresh info) t)))
 514
 515(defun git-status-filenames-map (status func files &rest args)
 516  "Apply FUNC to the status files names in the FILES list."
 517  (when files
 518    (setq files (sort files #'string-lessp))
 519    (let ((file (pop files))
 520          (node (ewoc-nth status 0)))
 521      (while (and file node)
 522        (let* ((info (ewoc-data node))
 523               (name (git-fileinfo->name info)))
 524          (if (string-lessp name file)
 525              (setq node (ewoc-next status node))
 526            (if (string-equal name file)
 527                (apply func info args))
 528            (setq file (pop files))))))))
 529
 530(defun git-set-filenames-state (status files state)
 531  "Set the state of a list of named files."
 532  (when files
 533    (git-status-filenames-map status #'git-set-fileinfo-state files state)
 534    (unless state  ;; delete files whose state has been set to nil
 535      (ewoc-filter status (lambda (info) (git-fileinfo->state info))))))
 536
 537(defun git-state-code (code)
 538  "Convert from a string to a added/deleted/modified state."
 539  (case (string-to-char code)
 540    (?M 'modified)
 541    (?? 'unknown)
 542    (?A 'added)
 543    (?D 'deleted)
 544    (?U 'unmerged)
 545    (?T 'modified)
 546    (t nil)))
 547
 548(defun git-status-code-as-string (code)
 549  "Format a git status code as string."
 550  (case code
 551    ('modified (propertize "Modified" 'face 'git-status-face))
 552    ('unknown  (propertize "Unknown " 'face 'git-unknown-face))
 553    ('added    (propertize "Added   " 'face 'git-status-face))
 554    ('deleted  (propertize "Deleted " 'face 'git-status-face))
 555    ('unmerged (propertize "Unmerged" 'face 'git-unmerged-face))
 556    ('uptodate (propertize "Uptodate" 'face 'git-uptodate-face))
 557    ('ignored  (propertize "Ignored " 'face 'git-ignored-face))
 558    (t "?       ")))
 559
 560(defun git-file-type-as-string (old-perm new-perm)
 561  "Return a string describing the file type based on its permissions."
 562  (let* ((old-type (lsh (or old-perm 0) -9))
 563         (new-type (lsh (or new-perm 0) -9))
 564         (str (case new-type
 565                (?\100  ;; file
 566                 (case old-type
 567                   (?\100 nil)
 568                   (?\120 "   (type change symlink -> file)")
 569                   (?\160 "   (type change subproject -> file)")))
 570                 (?\120  ;; symlink
 571                  (case old-type
 572                    (?\100 "   (type change file -> symlink)")
 573                    (?\160 "   (type change subproject -> symlink)")
 574                    (t "   (symlink)")))
 575                  (?\160  ;; subproject
 576                   (case old-type
 577                     (?\100 "   (type change file -> subproject)")
 578                     (?\120 "   (type change symlink -> subproject)")
 579                     (t "   (subproject)")))
 580                  (?\110 nil)  ;; directory (internal, not a real git state)
 581                  (?\000  ;; deleted or unknown
 582                   (case old-type
 583                     (?\120 "   (symlink)")
 584                     (?\160 "   (subproject)")))
 585                  (t (format "   (unknown type %o)" new-type)))))
 586    (cond (str (propertize str 'face 'git-status-face))
 587          ((eq new-type ?\110) "/")
 588          (t ""))))
 589
 590(defun git-rename-as-string (info)
 591  "Return a string describing the copy or rename associated with INFO, or an empty string if none."
 592  (let ((state (git-fileinfo->rename-state info)))
 593    (if state
 594        (propertize
 595         (concat "   ("
 596                 (if (eq state 'copy) "copied from "
 597                   (if (eq (git-fileinfo->state info) 'added) "renamed from "
 598                     "renamed to "))
 599                 (git-escape-file-name (git-fileinfo->orig-name info))
 600                 ")") 'face 'git-status-face)
 601      "")))
 602
 603(defun git-permissions-as-string (old-perm new-perm)
 604  "Format a permission change as string."
 605  (propertize
 606   (if (or (not old-perm)
 607           (not new-perm)
 608           (eq 0 (logand ?\111 (logxor old-perm new-perm))))
 609       "  "
 610     (if (eq 0 (logand ?\111 old-perm)) "+x" "-x"))
 611  'face 'git-permission-face))
 612
 613(defun git-fileinfo-prettyprint (info)
 614  "Pretty-printer for the git-fileinfo structure."
 615  (let ((old-perm (git-fileinfo->old-perm info))
 616        (new-perm (git-fileinfo->new-perm info)))
 617    (insert (concat "   " (if (git-fileinfo->marked info) (propertize "*" 'face 'git-mark-face) " ")
 618                    " " (git-status-code-as-string (git-fileinfo->state info))
 619                    " " (git-permissions-as-string old-perm new-perm)
 620                    "  " (git-escape-file-name (git-fileinfo->name info))
 621                    (git-file-type-as-string old-perm new-perm)
 622                    (git-rename-as-string info)))))
 623
 624(defun git-update-node-fileinfo (node info)
 625  "Update the fileinfo of the specified node. The names are assumed to match already."
 626  (let ((data (ewoc-data node)))
 627    (setf
 628     ;; preserve the marked flag
 629     (git-fileinfo->marked info) (git-fileinfo->marked data)
 630     (git-fileinfo->needs-update data) nil)
 631    (when (not (equal info data))
 632      (setf (git-fileinfo->needs-refresh info) t
 633            (ewoc-data node) info))))
 634
 635(defun git-insert-info-list (status infolist files)
 636  "Insert a sorted list of file infos in the status buffer, replacing existing ones if any."
 637  (let* ((info (pop infolist))
 638         (node (ewoc-nth status 0))
 639         (name (and info (git-fileinfo->name info)))
 640         remaining)
 641    (while info
 642      (let ((nodename (and node (git-fileinfo->name (ewoc-data node)))))
 643        (while (and files (string-lessp (car files) name))
 644          (push (pop files) remaining))
 645        (when (and files (string-equal (car files) name))
 646          (setq files (cdr files)))
 647        (cond ((not nodename)
 648               (setq node (ewoc-enter-last status info))
 649               (setq info (pop infolist))
 650               (setq name (and info (git-fileinfo->name info))))
 651              ((string-lessp nodename name)
 652               (setq node (ewoc-next status node)))
 653              ((string-equal nodename name)
 654               ;; preserve the marked flag
 655               (git-update-node-fileinfo node info)
 656               (setq info (pop infolist))
 657               (setq name (and info (git-fileinfo->name info))))
 658              (t
 659               (setq node (ewoc-enter-before status node info))
 660               (setq info (pop infolist))
 661               (setq name (and info (git-fileinfo->name info)))))))
 662    (nconc (nreverse remaining) files)))
 663
 664(defun git-run-diff-index (status files)
 665  "Run git-diff-index on FILES and parse the results into STATUS.
 666Return the list of files that haven't been handled."
 667  (let (infolist)
 668    (with-temp-buffer
 669      (apply #'git-call-process t "diff-index" "-z" "-M" "HEAD" "--" files)
 670      (goto-char (point-min))
 671      (while (re-search-forward
 672              ":\\([0-7]\\{6\\}\\) \\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} [0-9a-f]\\{40\\} \\(\\([ADMUT]\\)\0\\([^\0]+\\)\\|\\([CR]\\)[0-9]*\0\\([^\0]+\\)\0\\([^\0]+\\)\\)\0"
 673              nil t 1)
 674        (let ((old-perm (string-to-number (match-string 1) 8))
 675              (new-perm (string-to-number (match-string 2) 8))
 676              (state (or (match-string 4) (match-string 6)))
 677              (name (or (match-string 5) (match-string 7)))
 678              (new-name (match-string 8)))
 679          (if new-name  ; copy or rename
 680              (if (eq ?C (string-to-char state))
 681                  (push (git-create-fileinfo 'added new-name old-perm new-perm 'copy name) infolist)
 682                (push (git-create-fileinfo 'deleted name 0 0 'rename new-name) infolist)
 683                (push (git-create-fileinfo 'added new-name old-perm new-perm 'rename name) infolist))
 684            (push (git-create-fileinfo (git-state-code state) name old-perm new-perm) infolist)))))
 685    (setq infolist (sort (nreverse infolist)
 686                         (lambda (info1 info2)
 687                           (string-lessp (git-fileinfo->name info1)
 688                                         (git-fileinfo->name info2)))))
 689    (git-insert-info-list status infolist files)))
 690
 691(defun git-find-status-file (status file)
 692  "Find a given file in the status ewoc and return its node."
 693  (let ((node (ewoc-nth status 0)))
 694    (while (and node (not (string= file (git-fileinfo->name (ewoc-data node)))))
 695      (setq node (ewoc-next status node)))
 696    node))
 697
 698(defun git-run-ls-files (status files default-state &rest options)
 699  "Run git-ls-files on FILES and parse the results into STATUS.
 700Return the list of files that haven't been handled."
 701  (let (infolist)
 702    (with-temp-buffer
 703      (apply #'git-call-process t "ls-files" "-z" (append options (list "--") files))
 704      (goto-char (point-min))
 705      (while (re-search-forward "\\([^\0]*?\\)\\(/?\\)\0" nil t 1)
 706        (let ((name (match-string 1)))
 707          (push (git-create-fileinfo default-state name 0
 708                                     (if (string-equal "/" (match-string 2)) (lsh ?\110 9) 0))
 709                infolist))))
 710    (setq infolist (nreverse infolist))  ;; assume it is sorted already
 711    (git-insert-info-list status infolist files)))
 712
 713(defun git-run-ls-files-cached (status files default-state)
 714  "Run git-ls-files -c on FILES and parse the results into STATUS.
 715Return the list of files that haven't been handled."
 716  (let (infolist)
 717    (with-temp-buffer
 718      (apply #'git-call-process t "ls-files" "-z" "-s" "-c" "--" files)
 719      (goto-char (point-min))
 720      (while (re-search-forward "\\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} 0\t\\([^\0]+\\)\0" nil t)
 721        (let* ((new-perm (string-to-number (match-string 1) 8))
 722               (old-perm (if (eq default-state 'added) 0 new-perm))
 723               (name (match-string 2)))
 724          (push (git-create-fileinfo default-state name old-perm new-perm) infolist))))
 725    (setq infolist (nreverse infolist))  ;; assume it is sorted already
 726    (git-insert-info-list status infolist files)))
 727
 728(defun git-run-ls-unmerged (status files)
 729  "Run git-ls-files -u on FILES and parse the results into STATUS."
 730  (with-temp-buffer
 731    (apply #'git-call-process t "ls-files" "-z" "-u" "--" files)
 732    (goto-char (point-min))
 733    (let (unmerged-files)
 734      (while (re-search-forward "[0-7]\\{6\\} [0-9a-f]\\{40\\} [123]\t\\([^\0]+\\)\0" nil t)
 735        (push (match-string 1) unmerged-files))
 736      (git-set-filenames-state status unmerged-files 'unmerged))))
 737
 738(defun git-get-exclude-files ()
 739  "Get the list of exclude files to pass to git-ls-files."
 740  (let (files
 741        (config (git-config "core.excludesfile")))
 742    (when (file-readable-p ".git/info/exclude")
 743      (push ".git/info/exclude" files))
 744    (when (and config (file-readable-p config))
 745      (push config files))
 746    files))
 747
 748(defun git-run-ls-files-with-excludes (status files default-state &rest options)
 749  "Run git-ls-files on FILES with appropriate --exclude-from options."
 750  (let ((exclude-files (git-get-exclude-files)))
 751    (apply #'git-run-ls-files status files default-state "--directory" "--no-empty-directory"
 752           (concat "--exclude-per-directory=" git-per-dir-ignore-file)
 753           (append options (mapcar (lambda (f) (concat "--exclude-from=" f)) exclude-files)))))
 754
 755(defun git-update-status-files (&optional files mark-files)
 756  "Update the status of FILES from the index."
 757  (unless git-status (error "Not in git-status buffer."))
 758  ;; set the needs-update flag on existing files
 759  (if (setq files (sort files #'string-lessp))
 760      (git-status-filenames-map
 761       git-status (lambda (info) (setf (git-fileinfo->needs-update info) t)) files)
 762    (ewoc-map (lambda (info) (setf (git-fileinfo->needs-update info) t) nil) git-status)
 763    (git-call-process nil "update-index" "--refresh")
 764    (when git-show-uptodate
 765      (git-run-ls-files-cached git-status nil 'uptodate)))
 766  (let* ((remaining-files
 767          (if (git-empty-db-p) ; we need some special handling for an empty db
 768              (git-run-ls-files-cached git-status files 'added)
 769            (git-run-diff-index git-status files))))
 770    (git-run-ls-unmerged git-status files)
 771    (when (or remaining-files (and git-show-unknown (not files)))
 772      (setq remaining-files (git-run-ls-files-with-excludes git-status remaining-files 'unknown "-o")))
 773    (when (or remaining-files (and git-show-ignored (not files)))
 774      (setq remaining-files (git-run-ls-files-with-excludes git-status remaining-files 'ignored "-o" "-i")))
 775    (unless files
 776      (setq remaining-files (git-get-filenames (ewoc-collect git-status #'git-fileinfo->needs-update))))
 777    (when remaining-files
 778      (setq remaining-files (git-run-ls-files-cached git-status remaining-files 'uptodate)))
 779    (git-set-filenames-state git-status remaining-files nil)
 780    (when mark-files (git-mark-files git-status files))
 781    (git-refresh-files)
 782    (git-refresh-ewoc-hf git-status)))
 783
 784(defun git-mark-files (status files)
 785  "Mark all the specified FILES, and unmark the others."
 786  (let ((file (and files (pop files)))
 787        (node (ewoc-nth status 0)))
 788    (while node
 789      (let ((info (ewoc-data node)))
 790        (if (and file (string-equal (git-fileinfo->name info) file))
 791            (progn
 792              (unless (git-fileinfo->marked info)
 793                (setf (git-fileinfo->marked info) t)
 794                (setf (git-fileinfo->needs-refresh info) t))
 795              (setq file (pop files))
 796              (setq node (ewoc-next status node)))
 797          (when (git-fileinfo->marked info)
 798            (setf (git-fileinfo->marked info) nil)
 799            (setf (git-fileinfo->needs-refresh info) t))
 800          (if (and file (string-lessp file (git-fileinfo->name info)))
 801              (setq file (pop files))
 802            (setq node (ewoc-next status node))))))))
 803
 804(defun git-marked-files ()
 805  "Return a list of all marked files, or if none a list containing just the file at cursor position."
 806  (unless git-status (error "Not in git-status buffer."))
 807  (or (ewoc-collect git-status (lambda (info) (git-fileinfo->marked info)))
 808      (list (ewoc-data (ewoc-locate git-status)))))
 809
 810(defun git-marked-files-state (&rest states)
 811  "Return marked files that are in the specified states."
 812  (let ((files (git-marked-files))
 813        result)
 814    (dolist (info files)
 815      (when (memq (git-fileinfo->state info) states)
 816        (push info result)))
 817    result))
 818
 819(defun git-refresh-files ()
 820  "Refresh all files that need it and clear the needs-refresh flag."
 821  (unless git-status (error "Not in git-status buffer."))
 822  (ewoc-map
 823   (lambda (info)
 824     (let ((refresh (git-fileinfo->needs-refresh info)))
 825       (setf (git-fileinfo->needs-refresh info) nil)
 826       refresh))
 827   git-status)
 828  ; move back to goal column
 829  (when goal-column (move-to-column goal-column)))
 830
 831(defun git-refresh-ewoc-hf (status)
 832  "Refresh the ewoc header and footer."
 833  (let ((branch (git-symbolic-ref "HEAD"))
 834        (head (if (git-empty-db-p) "Nothing committed yet"
 835                (git-get-commit-description "HEAD")))
 836        (merge-heads (git-get-merge-heads)))
 837    (ewoc-set-hf status
 838                 (format "Directory:  %s\nBranch:     %s\nHead:       %s%s\n"
 839                         default-directory
 840                         (if branch
 841                             (if (string-match "^refs/heads/" branch)
 842                                 (substring branch (match-end 0))
 843                               branch)
 844                           "none (detached HEAD)")
 845                         head
 846                         (if merge-heads
 847                             (concat "\nMerging:    "
 848                                     (mapconcat (lambda (str) (git-get-commit-description str)) merge-heads "\n            "))
 849                           ""))
 850                 (if (ewoc-nth status 0) "" "    No changes."))))
 851
 852(defun git-get-filenames (files)
 853  (mapcar (lambda (info) (git-fileinfo->name info)) files))
 854
 855(defun git-update-index (index-file files)
 856  "Run git-update-index on a list of files."
 857  (let ((process-environment (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file)))
 858                                     process-environment))
 859        added deleted modified)
 860    (dolist (info files)
 861      (case (git-fileinfo->state info)
 862        ('added (push info added))
 863        ('deleted (push info deleted))
 864        ('modified (push info modified))))
 865    (and
 866     (or (not added) (apply #'git-call-process-display-error "update-index" "--add" "--" (git-get-filenames added)))
 867     (or (not deleted) (apply #'git-call-process-display-error "update-index" "--remove" "--" (git-get-filenames deleted)))
 868     (or (not modified) (apply #'git-call-process-display-error "update-index" "--" (git-get-filenames modified))))))
 869
 870(defun git-run-pre-commit-hook ()
 871  "Run the pre-commit hook if any."
 872  (unless git-status (error "Not in git-status buffer."))
 873  (let ((files (git-marked-files-state 'added 'deleted 'modified)))
 874    (or (not files)
 875        (not (file-executable-p ".git/hooks/pre-commit"))
 876        (let ((index-file (make-temp-file "gitidx")))
 877          (unwind-protect
 878            (let ((head-tree (unless (git-empty-db-p) (git-rev-parse "HEAD^{tree}"))))
 879              (git-read-tree head-tree index-file)
 880              (git-update-index index-file files)
 881              (git-run-hook "pre-commit" `(("GIT_INDEX_FILE" . ,index-file))))
 882          (delete-file index-file))))))
 883
 884(defun git-do-commit ()
 885  "Perform the actual commit using the current buffer as log message."
 886  (interactive)
 887  (let ((buffer (current-buffer))
 888        (index-file (make-temp-file "gitidx")))
 889    (with-current-buffer log-edit-parent-buffer
 890      (if (git-marked-files-state 'unmerged)
 891          (message "You cannot commit unmerged files, resolve them first.")
 892        (unwind-protect
 893            (let ((files (git-marked-files-state 'added 'deleted 'modified))
 894                  head tree head-tree)
 895              (unless (git-empty-db-p)
 896                (setq head (git-rev-parse "HEAD")
 897                      head-tree (git-rev-parse "HEAD^{tree}")))
 898              (message "Running git commit...")
 899              (when
 900                  (and
 901                   (git-read-tree head-tree index-file)
 902                   (git-update-index nil files)         ;update both the default index
 903                   (git-update-index index-file files)  ;and the temporary one
 904                   (setq tree (git-write-tree index-file)))
 905                (if (or (not (string-equal tree head-tree))
 906                        (yes-or-no-p "The tree was not modified, do you really want to perform an empty commit? "))
 907                    (let ((commit (git-commit-tree buffer tree head)))
 908                      (when commit
 909                        (condition-case nil (delete-file ".git/MERGE_HEAD") (error nil))
 910                        (condition-case nil (delete-file ".git/MERGE_MSG") (error nil))
 911                        (with-current-buffer buffer (erase-buffer))
 912                        (git-update-status-files (git-get-filenames files))
 913                        (git-call-process nil "rerere")
 914                        (git-call-process nil "gc" "--auto")
 915                        (message "Committed %s." commit)
 916                        (git-run-hook "post-commit" nil)))
 917                  (message "Commit aborted."))))
 918          (delete-file index-file))))))
 919
 920
 921;;;; Interactive functions
 922;;;; ------------------------------------------------------------
 923
 924(defun git-mark-file ()
 925  "Mark the file that the cursor is on and move to the next one."
 926  (interactive)
 927  (unless git-status (error "Not in git-status buffer."))
 928  (let* ((pos (ewoc-locate git-status))
 929         (info (ewoc-data pos)))
 930    (setf (git-fileinfo->marked info) t)
 931    (ewoc-invalidate git-status pos)
 932    (ewoc-goto-next git-status 1)))
 933
 934(defun git-unmark-file ()
 935  "Unmark the file that the cursor is on and move to the next one."
 936  (interactive)
 937  (unless git-status (error "Not in git-status buffer."))
 938  (let* ((pos (ewoc-locate git-status))
 939         (info (ewoc-data pos)))
 940    (setf (git-fileinfo->marked info) nil)
 941    (ewoc-invalidate git-status pos)
 942    (ewoc-goto-next git-status 1)))
 943
 944(defun git-unmark-file-up ()
 945  "Unmark the file that the cursor is on and move to the previous one."
 946  (interactive)
 947  (unless git-status (error "Not in git-status buffer."))
 948  (let* ((pos (ewoc-locate git-status))
 949         (info (ewoc-data pos)))
 950    (setf (git-fileinfo->marked info) nil)
 951    (ewoc-invalidate git-status pos)
 952    (ewoc-goto-prev git-status 1)))
 953
 954(defun git-mark-all ()
 955  "Mark all files."
 956  (interactive)
 957  (unless git-status (error "Not in git-status buffer."))
 958  (ewoc-map (lambda (info) (unless (git-fileinfo->marked info)
 959                             (setf (git-fileinfo->marked info) t))) git-status)
 960  ; move back to goal column after invalidate
 961  (when goal-column (move-to-column goal-column)))
 962
 963(defun git-unmark-all ()
 964  "Unmark all files."
 965  (interactive)
 966  (unless git-status (error "Not in git-status buffer."))
 967  (ewoc-map (lambda (info) (when (git-fileinfo->marked info)
 968                             (setf (git-fileinfo->marked info) nil)
 969                             t)) git-status)
 970  ; move back to goal column after invalidate
 971  (when goal-column (move-to-column goal-column)))
 972
 973(defun git-toggle-all-marks ()
 974  "Toggle all file marks."
 975  (interactive)
 976  (unless git-status (error "Not in git-status buffer."))
 977  (ewoc-map (lambda (info) (setf (git-fileinfo->marked info) (not (git-fileinfo->marked info))) t) git-status)
 978  ; move back to goal column after invalidate
 979  (when goal-column (move-to-column goal-column)))
 980
 981(defun git-next-file (&optional n)
 982  "Move the selection down N files."
 983  (interactive "p")
 984  (unless git-status (error "Not in git-status buffer."))
 985  (ewoc-goto-next git-status n))
 986
 987(defun git-prev-file (&optional n)
 988  "Move the selection up N files."
 989  (interactive "p")
 990  (unless git-status (error "Not in git-status buffer."))
 991  (ewoc-goto-prev git-status n))
 992
 993(defun git-next-unmerged-file (&optional n)
 994  "Move the selection down N unmerged files."
 995  (interactive "p")
 996  (unless git-status (error "Not in git-status buffer."))
 997  (let* ((last (ewoc-locate git-status))
 998         (node (ewoc-next git-status last)))
 999    (while (and node (> n 0))
1000      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
1001        (setq n (1- n))
1002        (setq last node))
1003      (setq node (ewoc-next git-status node)))
1004    (ewoc-goto-node git-status last)))
1005
1006(defun git-prev-unmerged-file (&optional n)
1007  "Move the selection up N unmerged files."
1008  (interactive "p")
1009  (unless git-status (error "Not in git-status buffer."))
1010  (let* ((last (ewoc-locate git-status))
1011         (node (ewoc-prev git-status last)))
1012    (while (and node (> n 0))
1013      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
1014        (setq n (1- n))
1015        (setq last node))
1016      (setq node (ewoc-prev git-status node)))
1017    (ewoc-goto-node git-status last)))
1018
1019(defun git-insert-file (file)
1020  "Insert file(s) into the git-status buffer."
1021  (interactive "fInsert file: ")
1022  (git-update-status-files (list (file-relative-name file))))
1023
1024(defun git-add-file ()
1025  "Add marked file(s) to the index cache."
1026  (interactive)
1027  (let ((files (git-get-filenames (git-marked-files-state 'unknown 'ignored))))
1028    ;; FIXME: add support for directories
1029    (unless files
1030      (push (file-relative-name (read-file-name "File to add: " nil nil t)) files))
1031    (when (apply 'git-call-process-display-error "update-index" "--add" "--" files)
1032      (git-update-status-files files)
1033      (git-success-message "Added" files))))
1034
1035(defun git-ignore-file ()
1036  "Add marked file(s) to the ignore list."
1037  (interactive)
1038  (let ((files (git-get-filenames (git-marked-files-state 'unknown))))
1039    (unless files
1040      (push (file-relative-name (read-file-name "File to ignore: " nil nil t)) files))
1041    (dolist (f files) (git-append-to-ignore f))
1042    (git-update-status-files files)
1043    (git-success-message "Ignored" files)))
1044
1045(defun git-remove-file ()
1046  "Remove the marked file(s)."
1047  (interactive)
1048  (let ((files (git-get-filenames (git-marked-files-state 'added 'modified 'unknown 'uptodate 'ignored))))
1049    (unless files
1050      (push (file-relative-name (read-file-name "File to remove: " nil nil t)) files))
1051    (if (yes-or-no-p
1052         (format "Remove %d file%s? " (length files) (if (> (length files) 1) "s" "")))
1053        (progn
1054          (dolist (name files)
1055            (ignore-errors
1056              (if (file-directory-p name)
1057                  (delete-directory name)
1058                (delete-file name))))
1059          (when (apply 'git-call-process-display-error "update-index" "--remove" "--" files)
1060            (git-update-status-files files)
1061            (git-success-message "Removed" files)))
1062      (message "Aborting"))))
1063
1064(defun git-revert-file ()
1065  "Revert changes to the marked file(s)."
1066  (interactive)
1067  (let ((files (git-marked-files-state 'added 'deleted 'modified 'unmerged))
1068        added modified)
1069    (when (and files
1070               (yes-or-no-p
1071                (format "Revert %d file%s? " (length files) (if (> (length files) 1) "s" ""))))
1072      (dolist (info files)
1073        (case (git-fileinfo->state info)
1074          ('added (push (git-fileinfo->name info) added))
1075          ('deleted (push (git-fileinfo->name info) modified))
1076          ('unmerged (push (git-fileinfo->name info) modified))
1077          ('modified (push (git-fileinfo->name info) modified))))
1078      ;; check if a buffer contains one of the files and isn't saved
1079      (dolist (file modified)
1080        (let ((buffer (get-file-buffer file)))
1081          (when (and buffer (buffer-modified-p buffer))
1082            (error "Buffer %s is modified. Please kill or save modified buffers before reverting." (buffer-name buffer)))))
1083      (let ((ok (and
1084                 (or (not added)
1085                     (apply 'git-call-process-display-error "update-index" "--force-remove" "--" added))
1086                 (or (not modified)
1087                     (apply 'git-call-process-display-error "checkout" "HEAD" modified)))))
1088        (git-update-status-files (append added modified))
1089        (when ok
1090          (dolist (file modified)
1091            (let ((buffer (get-file-buffer file)))
1092              (when buffer (with-current-buffer buffer (revert-buffer t t t)))))
1093          (git-success-message "Reverted" (git-get-filenames files)))))))
1094
1095(defun git-resolve-file ()
1096  "Resolve conflicts in marked file(s)."
1097  (interactive)
1098  (let ((files (git-get-filenames (git-marked-files-state 'unmerged))))
1099    (when files
1100      (when (apply 'git-call-process-display-error "update-index" "--" files)
1101        (git-update-status-files files)
1102        (git-success-message "Resolved" files)))))
1103
1104(defun git-remove-handled ()
1105  "Remove handled files from the status list."
1106  (interactive)
1107  (ewoc-filter git-status
1108               (lambda (info)
1109                 (case (git-fileinfo->state info)
1110                   ('ignored git-show-ignored)
1111                   ('uptodate git-show-uptodate)
1112                   ('unknown git-show-unknown)
1113                   (t t))))
1114  (unless (ewoc-nth git-status 0)  ; refresh header if list is empty
1115    (git-refresh-ewoc-hf git-status)))
1116
1117(defun git-toggle-show-uptodate ()
1118  "Toogle the option for showing up-to-date files."
1119  (interactive)
1120  (if (setq git-show-uptodate (not git-show-uptodate))
1121      (git-refresh-status)
1122    (git-remove-handled)))
1123
1124(defun git-toggle-show-ignored ()
1125  "Toogle the option for showing ignored files."
1126  (interactive)
1127  (if (setq git-show-ignored (not git-show-ignored))
1128      (progn
1129        (message "Inserting ignored files...")
1130        (git-run-ls-files-with-excludes git-status nil 'ignored "-o" "-i")
1131        (git-refresh-files)
1132        (git-refresh-ewoc-hf git-status)
1133        (message "Inserting ignored files...done"))
1134    (git-remove-handled)))
1135
1136(defun git-toggle-show-unknown ()
1137  "Toogle the option for showing unknown files."
1138  (interactive)
1139  (if (setq git-show-unknown (not git-show-unknown))
1140      (progn
1141        (message "Inserting unknown files...")
1142        (git-run-ls-files-with-excludes git-status nil 'unknown "-o")
1143        (git-refresh-files)
1144        (git-refresh-ewoc-hf git-status)
1145        (message "Inserting unknown files...done"))
1146    (git-remove-handled)))
1147
1148(defun git-expand-directory (info)
1149  "Expand the directory represented by INFO to list its files."
1150  (when (eq (lsh (git-fileinfo->new-perm info) -9) ?\110)
1151    (let ((dir (git-fileinfo->name info)))
1152      (git-set-filenames-state git-status (list dir) nil)
1153      (git-run-ls-files-with-excludes git-status (list (concat dir "/")) 'unknown "-o")
1154      (git-refresh-files)
1155      (git-refresh-ewoc-hf git-status)
1156      t)))
1157
1158(defun git-setup-diff-buffer (buffer)
1159  "Setup a buffer for displaying a diff."
1160  (let ((dir default-directory))
1161    (with-current-buffer buffer
1162      (diff-mode)
1163      (goto-char (point-min))
1164      (setq default-directory dir)
1165      (setq buffer-read-only t)))
1166  (display-buffer buffer)
1167  ; shrink window only if it displays the status buffer
1168  (when (eq (window-buffer) (current-buffer))
1169    (shrink-window-if-larger-than-buffer)))
1170
1171(defun git-diff-file ()
1172  "Diff the marked file(s) against HEAD."
1173  (interactive)
1174  (let ((files (git-marked-files)))
1175    (git-setup-diff-buffer
1176     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M" "HEAD" "--" (git-get-filenames files)))))
1177
1178(defun git-diff-file-merge-head (arg)
1179  "Diff the marked file(s) against the first merge head (or the nth one with a numeric prefix)."
1180  (interactive "p")
1181  (let ((files (git-marked-files))
1182        (merge-heads (git-get-merge-heads)))
1183    (unless merge-heads (error "No merge in progress"))
1184    (git-setup-diff-buffer
1185     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M"
1186            (or (nth (1- arg) merge-heads) "HEAD") "--" (git-get-filenames files)))))
1187
1188(defun git-diff-unmerged-file (stage)
1189  "Diff the marked unmerged file(s) against the specified stage."
1190  (let ((files (git-marked-files)))
1191    (git-setup-diff-buffer
1192     (apply #'git-run-command-buffer "*git-diff*" "diff-files" "-p" stage "--" (git-get-filenames files)))))
1193
1194(defun git-diff-file-base ()
1195  "Diff the marked unmerged file(s) against the common base file."
1196  (interactive)
1197  (git-diff-unmerged-file "-1"))
1198
1199(defun git-diff-file-mine ()
1200  "Diff the marked unmerged file(s) against my pre-merge version."
1201  (interactive)
1202  (git-diff-unmerged-file "-2"))
1203
1204(defun git-diff-file-other ()
1205  "Diff the marked unmerged file(s) against the other's pre-merge version."
1206  (interactive)
1207  (git-diff-unmerged-file "-3"))
1208
1209(defun git-diff-file-combined ()
1210  "Do a combined diff of the marked unmerged file(s)."
1211  (interactive)
1212  (git-diff-unmerged-file "-c"))
1213
1214(defun git-diff-file-idiff ()
1215  "Perform an interactive diff on the current file."
1216  (interactive)
1217  (let ((files (git-marked-files-state 'added 'deleted 'modified)))
1218    (unless (eq 1 (length files))
1219      (error "Cannot perform an interactive diff on multiple files."))
1220    (let* ((filename (car (git-get-filenames files)))
1221           (buff1 (find-file-noselect filename))
1222           (buff2 (git-run-command-buffer (concat filename ".~HEAD~") "cat-file" "blob" (concat "HEAD:" filename))))
1223      (ediff-buffers buff1 buff2))))
1224
1225(defun git-log-file ()
1226  "Display a log of changes to the marked file(s)."
1227  (interactive)
1228  (let* ((files (git-marked-files))
1229         (coding-system-for-read git-commits-coding-system)
1230         (buffer (apply #'git-run-command-buffer "*git-log*" "rev-list" "--pretty" "HEAD" "--" (git-get-filenames files))))
1231    (with-current-buffer buffer
1232      ; (git-log-mode)  FIXME: implement log mode
1233      (goto-char (point-min))
1234      (setq buffer-read-only t))
1235    (display-buffer buffer)))
1236
1237(defun git-log-edit-files ()
1238  "Return a list of marked files for use in the log-edit buffer."
1239  (with-current-buffer log-edit-parent-buffer
1240    (git-get-filenames (git-marked-files-state 'added 'deleted 'modified))))
1241
1242(defun git-log-edit-diff ()
1243  "Run a diff of the current files being committed from a log-edit buffer."
1244  (with-current-buffer log-edit-parent-buffer
1245    (git-diff-file)))
1246
1247(defun git-append-sign-off (name email)
1248  "Append a Signed-off-by entry to the current buffer, avoiding duplicates."
1249  (let ((sign-off (format "Signed-off-by: %s <%s>" name email))
1250        (case-fold-search t))
1251    (goto-char (point-min))
1252    (unless (re-search-forward (concat "^" (regexp-quote sign-off)) nil t)
1253      (goto-char (point-min))
1254      (unless (re-search-forward "^Signed-off-by: " nil t)
1255        (setq sign-off (concat "\n" sign-off)))
1256      (goto-char (point-max))
1257      (insert sign-off "\n"))))
1258
1259(defun git-setup-log-buffer (buffer &optional merge-heads author-name author-email subject date msg)
1260  "Setup the log buffer for a commit."
1261  (unless git-status (error "Not in git-status buffer."))
1262  (let ((dir default-directory)
1263        (committer-name (git-get-committer-name))
1264        (committer-email (git-get-committer-email))
1265        (sign-off git-append-signed-off-by))
1266    (with-current-buffer buffer
1267      (cd dir)
1268      (erase-buffer)
1269      (insert
1270       (propertize
1271        (format "Author: %s <%s>\n%s%s"
1272                (or author-name committer-name)
1273                (or author-email committer-email)
1274                (if date (format "Date: %s\n" date) "")
1275                (if merge-heads
1276                    (format "Merge: %s\n"
1277                            (mapconcat 'identity merge-heads " "))
1278                  ""))
1279        'face 'git-header-face)
1280       (propertize git-log-msg-separator 'face 'git-separator-face)
1281       "\n")
1282      (when subject (insert subject "\n\n"))
1283      (cond (msg (insert msg "\n"))
1284            ((file-readable-p ".git/rebase-apply/msg")
1285             (insert-file-contents ".git/rebase-apply/msg"))
1286            ((file-readable-p ".git/MERGE_MSG")
1287             (insert-file-contents ".git/MERGE_MSG")))
1288      ; delete empty lines at end
1289      (goto-char (point-min))
1290      (when (re-search-forward "\n+\\'" nil t)
1291        (replace-match "\n" t t))
1292      (when sign-off (git-append-sign-off committer-name committer-email)))
1293    buffer))
1294
1295(defun git-commit-file ()
1296  "Commit the marked file(s), asking for a commit message."
1297  (interactive)
1298  (unless git-status (error "Not in git-status buffer."))
1299  (when (git-run-pre-commit-hook)
1300    (let ((buffer (get-buffer-create "*git-commit*"))
1301          (coding-system (git-get-commits-coding-system))
1302          author-name author-email subject date)
1303      (when (eq 0 (buffer-size buffer))
1304        (when (file-readable-p ".git/rebase-apply/info")
1305          (with-temp-buffer
1306            (insert-file-contents ".git/rebase-apply/info")
1307            (goto-char (point-min))
1308            (when (re-search-forward "^Author: \\(.*\\)\nEmail: \\(.*\\)$" nil t)
1309              (setq author-name (match-string 1))
1310              (setq author-email (match-string 2)))
1311            (goto-char (point-min))
1312            (when (re-search-forward "^Subject: \\(.*\\)$" nil t)
1313              (setq subject (match-string 1)))
1314            (goto-char (point-min))
1315            (when (re-search-forward "^Date: \\(.*\\)$" nil t)
1316              (setq date (match-string 1)))))
1317        (git-setup-log-buffer buffer (git-get-merge-heads) author-name author-email subject date))
1318      (if (boundp 'log-edit-diff-function)
1319          (log-edit 'git-do-commit nil '((log-edit-listfun . git-log-edit-files)
1320                                         (log-edit-diff-function . git-log-edit-diff)) buffer)
1321        (log-edit 'git-do-commit nil 'git-log-edit-files buffer))
1322      (setq font-lock-keywords (font-lock-compile-keywords git-log-edit-font-lock-keywords))
1323      (setq buffer-file-coding-system coding-system)
1324      (re-search-forward (regexp-quote (concat git-log-msg-separator "\n")) nil t))))
1325
1326(defun git-setup-commit-buffer (commit)
1327  "Setup the commit buffer with the contents of COMMIT."
1328  (let (parents author-name author-email subject date msg)
1329    (with-temp-buffer
1330      (let ((coding-system (git-get-logoutput-coding-system)))
1331        (git-call-process t "log" "-1" "--pretty=medium" "--abbrev=40" commit)
1332        (goto-char (point-min))
1333        (when (re-search-forward "^Merge: *\\(.*\\)$" nil t)
1334          (setq parents (cdr (split-string (match-string 1) " +"))))
1335        (when (re-search-forward "^Author: *\\(.*\\) <\\(.*\\)>$" nil t)
1336          (setq author-name (match-string 1))
1337          (setq author-email (match-string 2)))
1338        (when (re-search-forward "^Date: *\\(.*\\)$" nil t)
1339          (setq date (match-string 1)))
1340        (while (re-search-forward "^    \\(.*\\)$" nil t)
1341          (push (match-string 1) msg))
1342        (setq msg (nreverse msg))
1343        (setq subject (pop msg))
1344        (while (and msg (zerop (length (car msg))) (pop msg)))))
1345    (git-setup-log-buffer (get-buffer-create "*git-commit*")
1346                          parents author-name author-email subject date
1347                          (mapconcat #'identity msg "\n"))))
1348
1349(defun git-get-commit-files (commit)
1350  "Retrieve the list of files modified by COMMIT."
1351  (let (files)
1352    (with-temp-buffer
1353      (git-call-process t "diff-tree" "-m" "-r" "-z" "--name-only" "--no-commit-id" "--root" commit)
1354      (goto-char (point-min))
1355      (while (re-search-forward "\\([^\0]*\\)\0" nil t 1)
1356        (push (match-string 1) files)))
1357    files))
1358
1359(defun git-amend-commit ()
1360  "Undo the last commit on HEAD, and set things up to commit an
1361amended version of it."
1362  (interactive)
1363  (unless git-status (error "Not in git-status buffer."))
1364  (when (git-empty-db-p) (error "No commit to amend."))
1365  (let* ((commit (git-rev-parse "HEAD"))
1366         (files (git-get-commit-files commit)))
1367    (when (if (git-rev-parse "HEAD^")
1368              (git-call-process-display-error "reset" "--soft" "HEAD^")
1369            (and (git-update-ref "ORIG_HEAD" commit)
1370                 (git-update-ref "HEAD" nil commit)))
1371      (git-update-status-files files t)
1372      (git-setup-commit-buffer commit)
1373      (git-commit-file))))
1374
1375(defun git-find-file ()
1376  "Visit the current file in its own buffer."
1377  (interactive)
1378  (unless git-status (error "Not in git-status buffer."))
1379  (let ((info (ewoc-data (ewoc-locate git-status))))
1380    (unless (git-expand-directory info)
1381      (find-file (git-fileinfo->name info))
1382      (when (eq 'unmerged (git-fileinfo->state info))
1383        (smerge-mode 1)))))
1384
1385(defun git-find-file-other-window ()
1386  "Visit the current file in its own buffer in another window."
1387  (interactive)
1388  (unless git-status (error "Not in git-status buffer."))
1389  (let ((info (ewoc-data (ewoc-locate git-status))))
1390    (find-file-other-window (git-fileinfo->name info))
1391    (when (eq 'unmerged (git-fileinfo->state info))
1392      (smerge-mode))))
1393
1394(defun git-find-file-imerge ()
1395  "Visit the current file in interactive merge mode."
1396  (interactive)
1397  (unless git-status (error "Not in git-status buffer."))
1398  (let ((info (ewoc-data (ewoc-locate git-status))))
1399    (find-file (git-fileinfo->name info))
1400    (smerge-ediff)))
1401
1402(defun git-view-file ()
1403  "View the current file in its own buffer."
1404  (interactive)
1405  (unless git-status (error "Not in git-status buffer."))
1406  (let ((info (ewoc-data (ewoc-locate git-status))))
1407    (view-file (git-fileinfo->name info))))
1408
1409(defun git-refresh-status ()
1410  "Refresh the git status buffer."
1411  (interactive)
1412  (unless git-status (error "Not in git-status buffer."))
1413  (message "Refreshing git status...")
1414  (git-update-status-files)
1415  (message "Refreshing git status...done"))
1416
1417(defun git-status-quit ()
1418  "Quit git-status mode."
1419  (interactive)
1420  (bury-buffer))
1421
1422;;;; Major Mode
1423;;;; ------------------------------------------------------------
1424
1425(defvar git-status-mode-hook nil
1426  "Run after `git-status-mode' is setup.")
1427
1428(defvar git-status-mode-map nil
1429  "Keymap for git major mode.")
1430
1431(defvar git-status nil
1432  "List of all files managed by the git-status mode.")
1433
1434(unless git-status-mode-map
1435  (let ((map (make-keymap))
1436        (commit-map (make-sparse-keymap))
1437        (diff-map (make-sparse-keymap))
1438        (toggle-map (make-sparse-keymap)))
1439    (suppress-keymap map)
1440    (define-key map "?"   'git-help)
1441    (define-key map "h"   'git-help)
1442    (define-key map " "   'git-next-file)
1443    (define-key map "a"   'git-add-file)
1444    (define-key map "c"   'git-commit-file)
1445    (define-key map "\C-c" commit-map)
1446    (define-key map "d"    diff-map)
1447    (define-key map "="   'git-diff-file)
1448    (define-key map "f"   'git-find-file)
1449    (define-key map "\r"  'git-find-file)
1450    (define-key map "g"   'git-refresh-status)
1451    (define-key map "i"   'git-ignore-file)
1452    (define-key map "I"   'git-insert-file)
1453    (define-key map "l"   'git-log-file)
1454    (define-key map "m"   'git-mark-file)
1455    (define-key map "M"   'git-mark-all)
1456    (define-key map "n"   'git-next-file)
1457    (define-key map "N"   'git-next-unmerged-file)
1458    (define-key map "o"   'git-find-file-other-window)
1459    (define-key map "p"   'git-prev-file)
1460    (define-key map "P"   'git-prev-unmerged-file)
1461    (define-key map "q"   'git-status-quit)
1462    (define-key map "r"   'git-remove-file)
1463    (define-key map "R"   'git-resolve-file)
1464    (define-key map "t"    toggle-map)
1465    (define-key map "T"   'git-toggle-all-marks)
1466    (define-key map "u"   'git-unmark-file)
1467    (define-key map "U"   'git-revert-file)
1468    (define-key map "v"   'git-view-file)
1469    (define-key map "x"   'git-remove-handled)
1470    (define-key map "\C-?" 'git-unmark-file-up)
1471    (define-key map "\M-\C-?" 'git-unmark-all)
1472    ; the commit submap
1473    (define-key commit-map "\C-a" 'git-amend-commit)
1474    ; the diff submap
1475    (define-key diff-map "b" 'git-diff-file-base)
1476    (define-key diff-map "c" 'git-diff-file-combined)
1477    (define-key diff-map "=" 'git-diff-file)
1478    (define-key diff-map "e" 'git-diff-file-idiff)
1479    (define-key diff-map "E" 'git-find-file-imerge)
1480    (define-key diff-map "h" 'git-diff-file-merge-head)
1481    (define-key diff-map "m" 'git-diff-file-mine)
1482    (define-key diff-map "o" 'git-diff-file-other)
1483    ; the toggle submap
1484    (define-key toggle-map "u" 'git-toggle-show-uptodate)
1485    (define-key toggle-map "i" 'git-toggle-show-ignored)
1486    (define-key toggle-map "k" 'git-toggle-show-unknown)
1487    (define-key toggle-map "m" 'git-toggle-all-marks)
1488    (setq git-status-mode-map map))
1489  (easy-menu-define git-menu git-status-mode-map
1490    "Git Menu"
1491    `("Git"
1492      ["Refresh" git-refresh-status t]
1493      ["Commit" git-commit-file t]
1494      ("Merge"
1495        ["Next Unmerged File" git-next-unmerged-file t]
1496        ["Prev Unmerged File" git-prev-unmerged-file t]
1497        ["Mark as Resolved" git-resolve-file t]
1498        ["Interactive Merge File" git-find-file-imerge t]
1499        ["Diff Against Common Base File" git-diff-file-base t]
1500        ["Diff Combined" git-diff-file-combined t]
1501        ["Diff Against Merge Head" git-diff-file-merge-head t]
1502        ["Diff Against Mine" git-diff-file-mine t]
1503        ["Diff Against Other" git-diff-file-other t])
1504      "--------"
1505      ["Add File" git-add-file t]
1506      ["Revert File" git-revert-file t]
1507      ["Ignore File" git-ignore-file t]
1508      ["Remove File" git-remove-file t]
1509      ["Insert File" git-insert-file t]
1510      "--------"
1511      ["Find File" git-find-file t]
1512      ["View File" git-view-file t]
1513      ["Diff File" git-diff-file t]
1514      ["Interactive Diff File" git-diff-file-idiff t]
1515      ["Log" git-log-file t]
1516      "--------"
1517      ["Mark" git-mark-file t]
1518      ["Mark All" git-mark-all t]
1519      ["Unmark" git-unmark-file t]
1520      ["Unmark All" git-unmark-all t]
1521      ["Toggle All Marks" git-toggle-all-marks t]
1522      ["Hide Handled Files" git-remove-handled t]
1523      "--------"
1524      ["Show Uptodate Files" git-toggle-show-uptodate :style toggle :selected git-show-uptodate]
1525      ["Show Ignored Files" git-toggle-show-ignored :style toggle :selected git-show-ignored]
1526      ["Show Unknown Files" git-toggle-show-unknown :style toggle :selected git-show-unknown]
1527      "--------"
1528      ["Quit" git-status-quit t])))
1529
1530
1531;; git mode should only run in the *git status* buffer
1532(put 'git-status-mode 'mode-class 'special)
1533
1534(defun git-status-mode ()
1535  "Major mode for interacting with Git.
1536Commands:
1537\\{git-status-mode-map}"
1538  (kill-all-local-variables)
1539  (buffer-disable-undo)
1540  (setq mode-name "git status"
1541        major-mode 'git-status-mode
1542        goal-column 17
1543        buffer-read-only t)
1544  (use-local-map git-status-mode-map)
1545  (let ((buffer-read-only nil))
1546    (erase-buffer)
1547  (let ((status (ewoc-create 'git-fileinfo-prettyprint "" "")))
1548    (set (make-local-variable 'git-status) status))
1549  (set (make-local-variable 'list-buffers-directory) default-directory)
1550  (make-local-variable 'git-show-uptodate)
1551  (make-local-variable 'git-show-ignored)
1552  (make-local-variable 'git-show-unknown)
1553  (run-hooks 'git-status-mode-hook)))
1554
1555(defun git-find-status-buffer (dir)
1556  "Find the git status buffer handling a specified directory."
1557  (let ((list (buffer-list))
1558        (fulldir (expand-file-name dir))
1559        found)
1560    (while (and list (not found))
1561      (let ((buffer (car list)))
1562        (with-current-buffer buffer
1563          (when (and list-buffers-directory
1564                     (string-equal fulldir (expand-file-name list-buffers-directory))
1565                     (eq major-mode 'git-status-mode))
1566            (setq found buffer))))
1567      (setq list (cdr list)))
1568    found))
1569
1570(defun git-status (dir)
1571  "Entry point into git-status mode."
1572  (interactive "DSelect directory: ")
1573  (setq dir (git-get-top-dir dir))
1574  (if (file-directory-p (concat (file-name-as-directory dir) ".git"))
1575      (let ((buffer (or (and git-reuse-status-buffer (git-find-status-buffer dir))
1576                        (create-file-buffer (expand-file-name "*git-status*" dir)))))
1577        (switch-to-buffer buffer)
1578        (cd dir)
1579        (git-status-mode)
1580        (git-refresh-status)
1581        (goto-char (point-min))
1582        (add-hook 'after-save-hook 'git-update-saved-file))
1583    (message "%s is not a git working tree." dir)))
1584
1585(defun git-update-saved-file ()
1586  "Update the corresponding git-status buffer when a file is saved.
1587Meant to be used in `after-save-hook'."
1588  (let* ((file (expand-file-name buffer-file-name))
1589         (dir (condition-case nil (git-get-top-dir (file-name-directory file)) (error nil)))
1590         (buffer (and dir (git-find-status-buffer dir))))
1591    (when buffer
1592      (with-current-buffer buffer
1593        (let ((filename (file-relative-name file dir)))
1594          ; skip files located inside the .git directory
1595          (unless (string-match "^\\.git/" filename)
1596            (git-call-process nil "add" "--refresh" "--" filename)
1597            (git-update-status-files (list filename))))))))
1598
1599(defun git-help ()
1600  "Display help for Git mode."
1601  (interactive)
1602  (describe-function 'git-status-mode))
1603
1604(provide 'git)
1605;;; git.el ends here