53ada39b430c0248b4908081356db5fb282bd43c
   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)) 'unknown)))
 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    (push newval args)
 393    (push ref args)
 394    (when reason
 395     (push reason args)
 396     (push "-m" args))
 397    (apply 'git-call-process-display-error "update-ref" args)))
 398
 399(defun git-read-tree (tree &optional index-file)
 400  "Read a tree into the index file."
 401  (let ((process-environment
 402         (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file))) process-environment)))
 403    (apply 'git-call-process-display-error "read-tree" (if tree (list tree)))))
 404
 405(defun git-write-tree (&optional index-file)
 406  "Call git-write-tree and return the resulting tree SHA1 as a string."
 407  (let ((process-environment
 408         (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file))) process-environment)))
 409    (git-get-string-sha1
 410     (git-call-process-string-display-error "write-tree"))))
 411
 412(defun git-commit-tree (buffer tree head)
 413  "Call git-commit-tree with buffer as input and return the resulting commit SHA1."
 414  (let ((author-name (git-get-committer-name))
 415        (author-email (git-get-committer-email))
 416        (subject "commit (initial): ")
 417        author-date log-start log-end args coding-system-for-write)
 418    (when head
 419      (setq subject "commit: ")
 420      (push "-p" args)
 421      (push head args))
 422    (with-current-buffer buffer
 423      (goto-char (point-min))
 424      (if
 425          (setq log-start (re-search-forward (concat "^" (regexp-quote git-log-msg-separator) "\n") nil t))
 426          (save-restriction
 427            (narrow-to-region (point-min) log-start)
 428            (goto-char (point-min))
 429            (when (re-search-forward "^Author: +\\(.*?\\) *<\\(.*\\)> *$" nil t)
 430              (setq author-name (match-string 1)
 431                    author-email (match-string 2)))
 432            (goto-char (point-min))
 433            (when (re-search-forward "^Date: +\\(.*\\)$" nil t)
 434              (setq author-date (match-string 1)))
 435            (goto-char (point-min))
 436            (when (re-search-forward "^Merge: +\\(.*\\)" nil t)
 437              (setq subject "commit (merge): ")
 438              (dolist (parent (split-string (match-string 1) " +" t))
 439                (push "-p" args)
 440                (push parent args))))
 441        (setq log-start (point-min)))
 442      (setq log-end (point-max))
 443      (goto-char log-start)
 444      (when (re-search-forward ".*$" nil t)
 445        (setq subject (concat subject (match-string 0))))
 446      (setq coding-system-for-write buffer-file-coding-system))
 447    (let ((commit
 448           (git-get-string-sha1
 449            (with-output-to-string
 450              (with-current-buffer standard-output
 451                (let ((env `(("GIT_AUTHOR_NAME" . ,author-name)
 452                             ("GIT_AUTHOR_EMAIL" . ,author-email)
 453                             ("GIT_COMMITTER_NAME" . ,(git-get-committer-name))
 454                             ("GIT_COMMITTER_EMAIL" . ,(git-get-committer-email)))))
 455                  (when author-date (push `("GIT_AUTHOR_DATE" . ,author-date) env))
 456                  (apply #'git-run-command-region
 457                         buffer log-start log-end env
 458                         "commit-tree" tree (nreverse args))))))))
 459      (and (git-update-ref "HEAD" commit head subject)
 460           commit))))
 461
 462(defun git-empty-db-p ()
 463  "Check if the git db is empty (no commit done yet)."
 464  (not (eq 0 (git-call-process nil "rev-parse" "--verify" "HEAD"))))
 465
 466(defun git-get-merge-heads ()
 467  "Retrieve the merge heads from the MERGE_HEAD file if present."
 468  (let (heads)
 469    (when (file-readable-p ".git/MERGE_HEAD")
 470      (with-temp-buffer
 471        (insert-file-contents ".git/MERGE_HEAD" nil nil nil t)
 472        (goto-char (point-min))
 473        (while (re-search-forward "[0-9a-f]\\{40\\}" nil t)
 474          (push (match-string 0) heads))))
 475    (nreverse heads)))
 476
 477(defun git-get-commit-description (commit)
 478  "Get a one-line description of COMMIT."
 479  (let ((coding-system-for-read (git-get-logoutput-coding-system)))
 480    (let ((descr (git-call-process-string "log" "--max-count=1" "--pretty=oneline" commit)))
 481      (if (and descr (string-match "\\`\\([0-9a-f]\\{40\\}\\) *\\(.*\\)$" descr))
 482          (concat (substring (match-string 1 descr) 0 10) " - " (match-string 2 descr))
 483        descr))))
 484
 485;;;; File info structure
 486;;;; ------------------------------------------------------------
 487
 488; fileinfo structure stolen from pcl-cvs
 489(defstruct (git-fileinfo
 490            (:copier nil)
 491            (:constructor git-create-fileinfo (state name &optional old-perm new-perm rename-state orig-name marked))
 492            (:conc-name git-fileinfo->))
 493  marked              ;; t/nil
 494  state               ;; current state
 495  name                ;; file name
 496  old-perm new-perm   ;; permission flags
 497  rename-state        ;; rename or copy state
 498  orig-name           ;; original name for renames or copies
 499  needs-refresh)      ;; whether file needs to be refreshed
 500
 501(defvar git-status nil)
 502
 503(defun git-clear-status (status)
 504  "Remove everything from the status list."
 505  (ewoc-filter status (lambda (info) nil)))
 506
 507(defun git-set-fileinfo-state (info state)
 508  "Set the state of a file info."
 509  (unless (eq (git-fileinfo->state info) state)
 510    (setf (git-fileinfo->state info) state
 511          (git-fileinfo->new-perm info) (git-fileinfo->old-perm info)
 512          (git-fileinfo->rename-state info) nil
 513          (git-fileinfo->orig-name info) nil
 514          (git-fileinfo->needs-refresh info) t)))
 515
 516(defun git-status-filenames-map (status func files &rest args)
 517  "Apply FUNC to the status files names in the FILES list."
 518  (when files
 519    (setq files (sort files #'string-lessp))
 520    (let ((file (pop files))
 521          (node (ewoc-nth status 0)))
 522      (while (and file node)
 523        (let ((info (ewoc-data node)))
 524          (if (string-lessp (git-fileinfo->name info) file)
 525              (setq node (ewoc-next status node))
 526            (if (string-equal (git-fileinfo->name info) 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-insert-info-list (status infolist)
 625  "Insert a list of file infos in the status buffer, replacing existing ones if any."
 626  (setq infolist (sort infolist
 627                       (lambda (info1 info2)
 628                         (string-lessp (git-fileinfo->name info1)
 629                                       (git-fileinfo->name info2)))))
 630  (let ((info (pop infolist))
 631        (node (ewoc-nth status 0)))
 632    (while info
 633      (cond ((not node)
 634             (setq node (ewoc-enter-last status info))
 635             (setq info (pop infolist)))
 636            ((string-lessp (git-fileinfo->name (ewoc-data node))
 637                           (git-fileinfo->name info))
 638             (setq node (ewoc-next status node)))
 639            ((string-equal (git-fileinfo->name (ewoc-data node))
 640                           (git-fileinfo->name info))
 641              ;; preserve the marked flag
 642              (setf (git-fileinfo->marked info) (git-fileinfo->marked (ewoc-data node)))
 643              (setf (git-fileinfo->needs-refresh info) t)
 644              (setf (ewoc-data node) info)
 645              (setq info (pop infolist)))
 646            (t
 647             (setq node (ewoc-enter-before status node info))
 648             (setq info (pop infolist)))))))
 649
 650(defun git-run-diff-index (status files)
 651  "Run git-diff-index on FILES and parse the results into STATUS.
 652Return the list of files that haven't been handled."
 653  (let ((remaining (copy-sequence files))
 654        infolist)
 655    (with-temp-buffer
 656      (apply #'git-call-process t "diff-index" "-z" "-M" "HEAD" "--" files)
 657      (goto-char (point-min))
 658      (while (re-search-forward
 659              ":\\([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"
 660              nil t 1)
 661        (let ((old-perm (string-to-number (match-string 1) 8))
 662              (new-perm (string-to-number (match-string 2) 8))
 663              (state (or (match-string 4) (match-string 6)))
 664              (name (or (match-string 5) (match-string 7)))
 665              (new-name (match-string 8)))
 666          (if new-name  ; copy or rename
 667              (if (eq ?C (string-to-char state))
 668                  (push (git-create-fileinfo 'added new-name old-perm new-perm 'copy name) infolist)
 669                (push (git-create-fileinfo 'deleted name 0 0 'rename new-name) infolist)
 670                (push (git-create-fileinfo 'added new-name old-perm new-perm 'rename name) infolist))
 671            (push (git-create-fileinfo (git-state-code state) name old-perm new-perm) infolist))
 672          (setq remaining (delete name remaining))
 673          (when new-name (setq remaining (delete new-name remaining))))))
 674    (git-insert-info-list status infolist)
 675    remaining))
 676
 677(defun git-find-status-file (status file)
 678  "Find a given file in the status ewoc and return its node."
 679  (let ((node (ewoc-nth status 0)))
 680    (while (and node (not (string= file (git-fileinfo->name (ewoc-data node)))))
 681      (setq node (ewoc-next status node)))
 682    node))
 683
 684(defun git-run-ls-files (status files default-state &rest options)
 685  "Run git-ls-files on FILES and parse the results into STATUS.
 686Return the list of files that haven't been handled."
 687  (let (infolist)
 688    (with-temp-buffer
 689      (apply #'git-call-process t "ls-files" "-z" (append options (list "--") files))
 690      (goto-char (point-min))
 691      (while (re-search-forward "\\([^\0]*?\\)\\(/?\\)\0" nil t 1)
 692        (let ((name (match-string 1)))
 693          (push (git-create-fileinfo default-state name 0
 694                                     (if (string-equal "/" (match-string 2)) (lsh ?\110 9) 0))
 695                infolist)
 696          (setq files (delete name files)))))
 697    (git-insert-info-list status infolist)
 698    files))
 699
 700(defun git-run-ls-files-cached (status files default-state)
 701  "Run git-ls-files -c on FILES and parse the results into STATUS.
 702Return the list of files that haven't been handled."
 703  (let ((remaining (copy-sequence files))
 704        infolist)
 705    (with-temp-buffer
 706      (apply #'git-call-process t "ls-files" "-z" "-s" "-c" "--" files)
 707      (goto-char (point-min))
 708      (while (re-search-forward "\\([0-7]\\{6\\}\\) [0-9a-f]\\{40\\} 0\t\\([^\0]+\\)\0" nil t)
 709        (let* ((new-perm (string-to-number (match-string 1) 8))
 710               (old-perm (if (eq default-state 'added) 0 new-perm))
 711               (name (match-string 2)))
 712          (push (git-create-fileinfo default-state name old-perm new-perm) infolist)
 713          (setq remaining (delete name remaining)))))
 714    (git-insert-info-list status infolist)
 715    remaining))
 716
 717(defun git-run-ls-unmerged (status files)
 718  "Run git-ls-files -u on FILES and parse the results into STATUS."
 719  (with-temp-buffer
 720    (apply #'git-call-process t "ls-files" "-z" "-u" "--" files)
 721    (goto-char (point-min))
 722    (let (unmerged-files)
 723      (while (re-search-forward "[0-7]\\{6\\} [0-9a-f]\\{40\\} [123]\t\\([^\0]+\\)\0" nil t)
 724        (push (match-string 1) unmerged-files))
 725      (git-set-filenames-state status unmerged-files 'unmerged))))
 726
 727(defun git-get-exclude-files ()
 728  "Get the list of exclude files to pass to git-ls-files."
 729  (let (files
 730        (config (git-config "core.excludesfile")))
 731    (when (file-readable-p ".git/info/exclude")
 732      (push ".git/info/exclude" files))
 733    (when (and config (file-readable-p config))
 734      (push config files))
 735    files))
 736
 737(defun git-run-ls-files-with-excludes (status files default-state &rest options)
 738  "Run git-ls-files on FILES with appropriate --exclude-from options."
 739  (let ((exclude-files (git-get-exclude-files)))
 740    (apply #'git-run-ls-files status files default-state "--directory" "--no-empty-directory"
 741           (concat "--exclude-per-directory=" git-per-dir-ignore-file)
 742           (append options (mapcar (lambda (f) (concat "--exclude-from=" f)) exclude-files)))))
 743
 744(defun git-update-status-files (files &optional default-state)
 745  "Update the status of FILES from the index."
 746  (unless git-status (error "Not in git-status buffer."))
 747  (when (or git-show-uptodate files)
 748    (git-run-ls-files-cached git-status files 'uptodate))
 749  (let* ((remaining-files
 750          (if (git-empty-db-p) ; we need some special handling for an empty db
 751              (git-run-ls-files-cached git-status files 'added)
 752            (git-run-diff-index git-status files))))
 753    (git-run-ls-unmerged git-status files)
 754    (when (or remaining-files (and git-show-unknown (not files)))
 755      (setq remaining-files (git-run-ls-files-with-excludes git-status remaining-files 'unknown "-o")))
 756    (when (or remaining-files (and git-show-ignored (not files)))
 757      (setq remaining-files (git-run-ls-files-with-excludes git-status remaining-files 'ignored "-o" "-i")))
 758    (git-set-filenames-state git-status remaining-files default-state)
 759    (git-refresh-files)
 760    (git-refresh-ewoc-hf git-status)))
 761
 762(defun git-mark-files (status files)
 763  "Mark all the specified FILES, and unmark the others."
 764  (setq files (sort files #'string-lessp))
 765  (let ((file (and files (pop files)))
 766        (node (ewoc-nth status 0)))
 767    (while node
 768      (let ((info (ewoc-data node)))
 769        (if (and file (string-equal (git-fileinfo->name info) file))
 770            (progn
 771              (unless (git-fileinfo->marked info)
 772                (setf (git-fileinfo->marked info) t)
 773                (setf (git-fileinfo->needs-refresh info) t))
 774              (setq file (pop files))
 775              (setq node (ewoc-next status node)))
 776          (when (git-fileinfo->marked info)
 777            (setf (git-fileinfo->marked info) nil)
 778            (setf (git-fileinfo->needs-refresh info) t))
 779          (if (and file (string-lessp file (git-fileinfo->name info)))
 780              (setq file (pop files))
 781            (setq node (ewoc-next status node))))))))
 782
 783(defun git-marked-files ()
 784  "Return a list of all marked files, or if none a list containing just the file at cursor position."
 785  (unless git-status (error "Not in git-status buffer."))
 786  (or (ewoc-collect git-status (lambda (info) (git-fileinfo->marked info)))
 787      (list (ewoc-data (ewoc-locate git-status)))))
 788
 789(defun git-marked-files-state (&rest states)
 790  "Return marked files that are in the specified states."
 791  (let ((files (git-marked-files))
 792        result)
 793    (dolist (info files)
 794      (when (memq (git-fileinfo->state info) states)
 795        (push info result)))
 796    result))
 797
 798(defun git-refresh-files ()
 799  "Refresh all files that need it and clear the needs-refresh flag."
 800  (unless git-status (error "Not in git-status buffer."))
 801  (ewoc-map
 802   (lambda (info)
 803     (let ((refresh (git-fileinfo->needs-refresh info)))
 804       (setf (git-fileinfo->needs-refresh info) nil)
 805       refresh))
 806   git-status)
 807  ; move back to goal column
 808  (when goal-column (move-to-column goal-column)))
 809
 810(defun git-refresh-ewoc-hf (status)
 811  "Refresh the ewoc header and footer."
 812  (let ((branch (git-symbolic-ref "HEAD"))
 813        (head (if (git-empty-db-p) "Nothing committed yet"
 814                (git-get-commit-description "HEAD")))
 815        (merge-heads (git-get-merge-heads)))
 816    (ewoc-set-hf status
 817                 (format "Directory:  %s\nBranch:     %s\nHead:       %s%s\n"
 818                         default-directory
 819                         (if branch
 820                             (if (string-match "^refs/heads/" branch)
 821                                 (substring branch (match-end 0))
 822                               branch)
 823                           "none (detached HEAD)")
 824                         head
 825                         (if merge-heads
 826                             (concat "\nMerging:    "
 827                                     (mapconcat (lambda (str) (git-get-commit-description str)) merge-heads "\n            "))
 828                           ""))
 829                 (if (ewoc-nth status 0) "" "    No changes."))))
 830
 831(defun git-get-filenames (files)
 832  (mapcar (lambda (info) (git-fileinfo->name info)) files))
 833
 834(defun git-update-index (index-file files)
 835  "Run git-update-index on a list of files."
 836  (let ((process-environment (append (and index-file (list (concat "GIT_INDEX_FILE=" index-file)))
 837                                     process-environment))
 838        added deleted modified)
 839    (dolist (info files)
 840      (case (git-fileinfo->state info)
 841        ('added (push info added))
 842        ('deleted (push info deleted))
 843        ('modified (push info modified))))
 844    (and
 845     (or (not added) (apply #'git-call-process-display-error "update-index" "--add" "--" (git-get-filenames added)))
 846     (or (not deleted) (apply #'git-call-process-display-error "update-index" "--remove" "--" (git-get-filenames deleted)))
 847     (or (not modified) (apply #'git-call-process-display-error "update-index" "--" (git-get-filenames modified))))))
 848
 849(defun git-run-pre-commit-hook ()
 850  "Run the pre-commit hook if any."
 851  (unless git-status (error "Not in git-status buffer."))
 852  (let ((files (git-marked-files-state 'added 'deleted 'modified)))
 853    (or (not files)
 854        (not (file-executable-p ".git/hooks/pre-commit"))
 855        (let ((index-file (make-temp-file "gitidx")))
 856          (unwind-protect
 857            (let ((head-tree (unless (git-empty-db-p) (git-rev-parse "HEAD^{tree}"))))
 858              (git-read-tree head-tree index-file)
 859              (git-update-index index-file files)
 860              (git-run-hook "pre-commit" `(("GIT_INDEX_FILE" . ,index-file))))
 861          (delete-file index-file))))))
 862
 863(defun git-do-commit ()
 864  "Perform the actual commit using the current buffer as log message."
 865  (interactive)
 866  (let ((buffer (current-buffer))
 867        (index-file (make-temp-file "gitidx")))
 868    (with-current-buffer log-edit-parent-buffer
 869      (if (git-marked-files-state 'unmerged)
 870          (message "You cannot commit unmerged files, resolve them first.")
 871        (unwind-protect
 872            (let ((files (git-marked-files-state 'added 'deleted 'modified))
 873                  head tree head-tree)
 874              (unless (git-empty-db-p)
 875                (setq head (git-rev-parse "HEAD")
 876                      head-tree (git-rev-parse "HEAD^{tree}")))
 877              (if files
 878                  (progn
 879                    (message "Running git commit...")
 880                    (when
 881                        (and
 882                         (git-read-tree head-tree index-file)
 883                         (git-update-index nil files)         ;update both the default index
 884                         (git-update-index index-file files)  ;and the temporary one
 885                         (setq tree (git-write-tree index-file)))
 886                      (if (or (not (string-equal tree head-tree))
 887                              (yes-or-no-p "The tree was not modified, do you really want to perform an empty commit? "))
 888                          (let ((commit (git-commit-tree buffer tree head)))
 889                            (when commit
 890                              (condition-case nil (delete-file ".git/MERGE_HEAD") (error nil))
 891                              (condition-case nil (delete-file ".git/MERGE_MSG") (error nil))
 892                              (with-current-buffer buffer (erase-buffer))
 893                              (git-update-status-files (git-get-filenames files) 'uptodate)
 894                              (git-call-process nil "rerere")
 895                              (git-call-process nil "gc" "--auto")
 896                              (git-refresh-files)
 897                              (git-refresh-ewoc-hf git-status)
 898                              (message "Committed %s." commit)
 899                              (git-run-hook "post-commit" nil)))
 900                        (message "Commit aborted."))))
 901                (message "No files to commit.")))
 902          (delete-file index-file))))))
 903
 904
 905;;;; Interactive functions
 906;;;; ------------------------------------------------------------
 907
 908(defun git-mark-file ()
 909  "Mark the file that the cursor is on and move to the next one."
 910  (interactive)
 911  (unless git-status (error "Not in git-status buffer."))
 912  (let* ((pos (ewoc-locate git-status))
 913         (info (ewoc-data pos)))
 914    (setf (git-fileinfo->marked info) t)
 915    (ewoc-invalidate git-status pos)
 916    (ewoc-goto-next git-status 1)))
 917
 918(defun git-unmark-file ()
 919  "Unmark the file that the cursor is on and move to the next one."
 920  (interactive)
 921  (unless git-status (error "Not in git-status buffer."))
 922  (let* ((pos (ewoc-locate git-status))
 923         (info (ewoc-data pos)))
 924    (setf (git-fileinfo->marked info) nil)
 925    (ewoc-invalidate git-status pos)
 926    (ewoc-goto-next git-status 1)))
 927
 928(defun git-unmark-file-up ()
 929  "Unmark the file that the cursor is on and move to the previous one."
 930  (interactive)
 931  (unless git-status (error "Not in git-status buffer."))
 932  (let* ((pos (ewoc-locate git-status))
 933         (info (ewoc-data pos)))
 934    (setf (git-fileinfo->marked info) nil)
 935    (ewoc-invalidate git-status pos)
 936    (ewoc-goto-prev git-status 1)))
 937
 938(defun git-mark-all ()
 939  "Mark all files."
 940  (interactive)
 941  (unless git-status (error "Not in git-status buffer."))
 942  (ewoc-map (lambda (info) (unless (git-fileinfo->marked info)
 943                             (setf (git-fileinfo->marked info) t))) git-status)
 944  ; move back to goal column after invalidate
 945  (when goal-column (move-to-column goal-column)))
 946
 947(defun git-unmark-all ()
 948  "Unmark all files."
 949  (interactive)
 950  (unless git-status (error "Not in git-status buffer."))
 951  (ewoc-map (lambda (info) (when (git-fileinfo->marked info)
 952                             (setf (git-fileinfo->marked info) nil)
 953                             t)) git-status)
 954  ; move back to goal column after invalidate
 955  (when goal-column (move-to-column goal-column)))
 956
 957(defun git-toggle-all-marks ()
 958  "Toggle all file marks."
 959  (interactive)
 960  (unless git-status (error "Not in git-status buffer."))
 961  (ewoc-map (lambda (info) (setf (git-fileinfo->marked info) (not (git-fileinfo->marked info))) t) git-status)
 962  ; move back to goal column after invalidate
 963  (when goal-column (move-to-column goal-column)))
 964
 965(defun git-next-file (&optional n)
 966  "Move the selection down N files."
 967  (interactive "p")
 968  (unless git-status (error "Not in git-status buffer."))
 969  (ewoc-goto-next git-status n))
 970
 971(defun git-prev-file (&optional n)
 972  "Move the selection up N files."
 973  (interactive "p")
 974  (unless git-status (error "Not in git-status buffer."))
 975  (ewoc-goto-prev git-status n))
 976
 977(defun git-next-unmerged-file (&optional n)
 978  "Move the selection down N unmerged files."
 979  (interactive "p")
 980  (unless git-status (error "Not in git-status buffer."))
 981  (let* ((last (ewoc-locate git-status))
 982         (node (ewoc-next git-status last)))
 983    (while (and node (> n 0))
 984      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
 985        (setq n (1- n))
 986        (setq last node))
 987      (setq node (ewoc-next git-status node)))
 988    (ewoc-goto-node git-status last)))
 989
 990(defun git-prev-unmerged-file (&optional n)
 991  "Move the selection up N unmerged files."
 992  (interactive "p")
 993  (unless git-status (error "Not in git-status buffer."))
 994  (let* ((last (ewoc-locate git-status))
 995         (node (ewoc-prev git-status last)))
 996    (while (and node (> n 0))
 997      (when (eq 'unmerged (git-fileinfo->state (ewoc-data node)))
 998        (setq n (1- n))
 999        (setq last node))
1000      (setq node (ewoc-prev git-status node)))
1001    (ewoc-goto-node git-status last)))
1002
1003(defun git-add-file ()
1004  "Add marked file(s) to the index cache."
1005  (interactive)
1006  (let ((files (git-get-filenames (git-marked-files-state 'unknown 'ignored))))
1007    ;; FIXME: add support for directories
1008    (unless files
1009      (push (file-relative-name (read-file-name "File to add: " nil nil t)) files))
1010    (when (apply 'git-call-process-display-error "update-index" "--add" "--" files)
1011      (git-update-status-files files 'uptodate)
1012      (git-success-message "Added" files))))
1013
1014(defun git-ignore-file ()
1015  "Add marked file(s) to the ignore list."
1016  (interactive)
1017  (let ((files (git-get-filenames (git-marked-files-state 'unknown))))
1018    (unless files
1019      (push (file-relative-name (read-file-name "File to ignore: " nil nil t)) files))
1020    (dolist (f files) (git-append-to-ignore f))
1021    (git-update-status-files files 'ignored)
1022    (git-success-message "Ignored" files)))
1023
1024(defun git-remove-file ()
1025  "Remove the marked file(s)."
1026  (interactive)
1027  (let ((files (git-get-filenames (git-marked-files-state 'added 'modified 'unknown 'uptodate 'ignored))))
1028    (unless files
1029      (push (file-relative-name (read-file-name "File to remove: " nil nil t)) files))
1030    (if (yes-or-no-p
1031         (format "Remove %d file%s? " (length files) (if (> (length files) 1) "s" "")))
1032        (progn
1033          (dolist (name files)
1034            (ignore-errors
1035              (if (file-directory-p name)
1036                  (delete-directory name)
1037                (delete-file name))))
1038          (when (apply 'git-call-process-display-error "update-index" "--remove" "--" files)
1039            (git-update-status-files files nil)
1040            (git-success-message "Removed" files)))
1041      (message "Aborting"))))
1042
1043(defun git-revert-file ()
1044  "Revert changes to the marked file(s)."
1045  (interactive)
1046  (let ((files (git-marked-files-state 'added 'deleted 'modified 'unmerged))
1047        added modified)
1048    (when (and files
1049               (yes-or-no-p
1050                (format "Revert %d file%s? " (length files) (if (> (length files) 1) "s" ""))))
1051      (dolist (info files)
1052        (case (git-fileinfo->state info)
1053          ('added (push (git-fileinfo->name info) added))
1054          ('deleted (push (git-fileinfo->name info) modified))
1055          ('unmerged (push (git-fileinfo->name info) modified))
1056          ('modified (push (git-fileinfo->name info) modified))))
1057      ;; check if a buffer contains one of the files and isn't saved
1058      (dolist (file modified)
1059        (let ((buffer (get-file-buffer file)))
1060          (when (and buffer (buffer-modified-p buffer))
1061            (error "Buffer %s is modified. Please kill or save modified buffers before reverting." (buffer-name buffer)))))
1062      (let ((ok (and
1063                 (or (not added)
1064                     (apply 'git-call-process-display-error "update-index" "--force-remove" "--" added))
1065                 (or (not modified)
1066                     (apply 'git-call-process-display-error "checkout" "HEAD" modified)))))
1067        (git-update-status-files (append added modified) 'uptodate)
1068        (when ok
1069          (dolist (file modified)
1070            (let ((buffer (get-file-buffer file)))
1071              (when buffer (with-current-buffer buffer (revert-buffer t t t)))))
1072          (git-success-message "Reverted" (git-get-filenames files)))))))
1073
1074(defun git-resolve-file ()
1075  "Resolve conflicts in marked file(s)."
1076  (interactive)
1077  (let ((files (git-get-filenames (git-marked-files-state 'unmerged))))
1078    (when files
1079      (when (apply 'git-call-process-display-error "update-index" "--" files)
1080        (git-update-status-files files 'uptodate)
1081        (git-success-message "Resolved" files)))))
1082
1083(defun git-remove-handled ()
1084  "Remove handled files from the status list."
1085  (interactive)
1086  (ewoc-filter git-status
1087               (lambda (info)
1088                 (case (git-fileinfo->state info)
1089                   ('ignored git-show-ignored)
1090                   ('uptodate git-show-uptodate)
1091                   ('unknown git-show-unknown)
1092                   (t t))))
1093  (unless (ewoc-nth git-status 0)  ; refresh header if list is empty
1094    (git-refresh-ewoc-hf git-status)))
1095
1096(defun git-toggle-show-uptodate ()
1097  "Toogle the option for showing up-to-date files."
1098  (interactive)
1099  (if (setq git-show-uptodate (not git-show-uptodate))
1100      (git-refresh-status)
1101    (git-remove-handled)))
1102
1103(defun git-toggle-show-ignored ()
1104  "Toogle the option for showing ignored files."
1105  (interactive)
1106  (if (setq git-show-ignored (not git-show-ignored))
1107      (progn
1108        (message "Inserting ignored files...")
1109        (git-run-ls-files-with-excludes git-status nil 'ignored "-o" "-i")
1110        (git-refresh-files)
1111        (git-refresh-ewoc-hf git-status)
1112        (message "Inserting ignored files...done"))
1113    (git-remove-handled)))
1114
1115(defun git-toggle-show-unknown ()
1116  "Toogle the option for showing unknown files."
1117  (interactive)
1118  (if (setq git-show-unknown (not git-show-unknown))
1119      (progn
1120        (message "Inserting unknown files...")
1121        (git-run-ls-files-with-excludes git-status nil 'unknown "-o")
1122        (git-refresh-files)
1123        (git-refresh-ewoc-hf git-status)
1124        (message "Inserting unknown files...done"))
1125    (git-remove-handled)))
1126
1127(defun git-expand-directory (info)
1128  "Expand the directory represented by INFO to list its files."
1129  (when (eq (lsh (git-fileinfo->new-perm info) -9) ?\110)
1130    (let ((dir (git-fileinfo->name info)))
1131      (git-set-filenames-state git-status (list dir) nil)
1132      (git-run-ls-files-with-excludes git-status (list (concat dir "/")) 'unknown "-o")
1133      (git-refresh-files)
1134      (git-refresh-ewoc-hf git-status)
1135      t)))
1136
1137(defun git-setup-diff-buffer (buffer)
1138  "Setup a buffer for displaying a diff."
1139  (let ((dir default-directory))
1140    (with-current-buffer buffer
1141      (diff-mode)
1142      (goto-char (point-min))
1143      (setq default-directory dir)
1144      (setq buffer-read-only t)))
1145  (display-buffer buffer)
1146  ; shrink window only if it displays the status buffer
1147  (when (eq (window-buffer) (current-buffer))
1148    (shrink-window-if-larger-than-buffer)))
1149
1150(defun git-diff-file ()
1151  "Diff the marked file(s) against HEAD."
1152  (interactive)
1153  (let ((files (git-marked-files)))
1154    (git-setup-diff-buffer
1155     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M" "HEAD" "--" (git-get-filenames files)))))
1156
1157(defun git-diff-file-merge-head (arg)
1158  "Diff the marked file(s) against the first merge head (or the nth one with a numeric prefix)."
1159  (interactive "p")
1160  (let ((files (git-marked-files))
1161        (merge-heads (git-get-merge-heads)))
1162    (unless merge-heads (error "No merge in progress"))
1163    (git-setup-diff-buffer
1164     (apply #'git-run-command-buffer "*git-diff*" "diff-index" "-p" "-M"
1165            (or (nth (1- arg) merge-heads) "HEAD") "--" (git-get-filenames files)))))
1166
1167(defun git-diff-unmerged-file (stage)
1168  "Diff the marked unmerged file(s) against the specified stage."
1169  (let ((files (git-marked-files)))
1170    (git-setup-diff-buffer
1171     (apply #'git-run-command-buffer "*git-diff*" "diff-files" "-p" stage "--" (git-get-filenames files)))))
1172
1173(defun git-diff-file-base ()
1174  "Diff the marked unmerged file(s) against the common base file."
1175  (interactive)
1176  (git-diff-unmerged-file "-1"))
1177
1178(defun git-diff-file-mine ()
1179  "Diff the marked unmerged file(s) against my pre-merge version."
1180  (interactive)
1181  (git-diff-unmerged-file "-2"))
1182
1183(defun git-diff-file-other ()
1184  "Diff the marked unmerged file(s) against the other's pre-merge version."
1185  (interactive)
1186  (git-diff-unmerged-file "-3"))
1187
1188(defun git-diff-file-combined ()
1189  "Do a combined diff of the marked unmerged file(s)."
1190  (interactive)
1191  (git-diff-unmerged-file "-c"))
1192
1193(defun git-diff-file-idiff ()
1194  "Perform an interactive diff on the current file."
1195  (interactive)
1196  (let ((files (git-marked-files-state 'added 'deleted 'modified)))
1197    (unless (eq 1 (length files))
1198      (error "Cannot perform an interactive diff on multiple files."))
1199    (let* ((filename (car (git-get-filenames files)))
1200           (buff1 (find-file-noselect filename))
1201           (buff2 (git-run-command-buffer (concat filename ".~HEAD~") "cat-file" "blob" (concat "HEAD:" filename))))
1202      (ediff-buffers buff1 buff2))))
1203
1204(defun git-log-file ()
1205  "Display a log of changes to the marked file(s)."
1206  (interactive)
1207  (let* ((files (git-marked-files))
1208         (coding-system-for-read git-commits-coding-system)
1209         (buffer (apply #'git-run-command-buffer "*git-log*" "rev-list" "--pretty" "HEAD" "--" (git-get-filenames files))))
1210    (with-current-buffer buffer
1211      ; (git-log-mode)  FIXME: implement log mode
1212      (goto-char (point-min))
1213      (setq buffer-read-only t))
1214    (display-buffer buffer)))
1215
1216(defun git-log-edit-files ()
1217  "Return a list of marked files for use in the log-edit buffer."
1218  (with-current-buffer log-edit-parent-buffer
1219    (git-get-filenames (git-marked-files-state 'added 'deleted 'modified))))
1220
1221(defun git-log-edit-diff ()
1222  "Run a diff of the current files being committed from a log-edit buffer."
1223  (with-current-buffer log-edit-parent-buffer
1224    (git-diff-file)))
1225
1226(defun git-append-sign-off (name email)
1227  "Append a Signed-off-by entry to the current buffer, avoiding duplicates."
1228  (let ((sign-off (format "Signed-off-by: %s <%s>" name email))
1229        (case-fold-search t))
1230    (goto-char (point-min))
1231    (unless (re-search-forward (concat "^" (regexp-quote sign-off)) nil t)
1232      (goto-char (point-min))
1233      (unless (re-search-forward "^Signed-off-by: " nil t)
1234        (setq sign-off (concat "\n" sign-off)))
1235      (goto-char (point-max))
1236      (insert sign-off "\n"))))
1237
1238(defun git-setup-log-buffer (buffer &optional author-name author-email subject date msg)
1239  "Setup the log buffer for a commit."
1240  (unless git-status (error "Not in git-status buffer."))
1241  (let ((merge-heads (git-get-merge-heads))
1242        (dir default-directory)
1243        (committer-name (git-get-committer-name))
1244        (committer-email (git-get-committer-email))
1245        (sign-off git-append-signed-off-by))
1246    (with-current-buffer buffer
1247      (cd dir)
1248      (erase-buffer)
1249      (insert
1250       (propertize
1251        (format "Author: %s <%s>\n%s%s"
1252                (or author-name committer-name)
1253                (or author-email committer-email)
1254                (if date (format "Date: %s\n" date) "")
1255                (if merge-heads
1256                    (format "Merge: %s\n"
1257                            (mapconcat 'identity merge-heads " "))
1258                  ""))
1259        'face 'git-header-face)
1260       (propertize git-log-msg-separator 'face 'git-separator-face)
1261       "\n")
1262      (when subject (insert subject "\n\n"))
1263      (cond (msg (insert msg "\n"))
1264            ((file-readable-p ".git/rebase-apply/msg")
1265             (insert-file-contents ".git/rebase-apply/msg"))
1266            ((file-readable-p ".git/MERGE_MSG")
1267             (insert-file-contents ".git/MERGE_MSG")))
1268      ; delete empty lines at end
1269      (goto-char (point-min))
1270      (when (re-search-forward "\n+\\'" nil t)
1271        (replace-match "\n" t t))
1272      (when sign-off (git-append-sign-off committer-name committer-email)))
1273    buffer))
1274
1275(defun git-commit-file ()
1276  "Commit the marked file(s), asking for a commit message."
1277  (interactive)
1278  (unless git-status (error "Not in git-status buffer."))
1279  (when (git-run-pre-commit-hook)
1280    (let ((buffer (get-buffer-create "*git-commit*"))
1281          (coding-system (git-get-commits-coding-system))
1282          author-name author-email subject date)
1283      (when (eq 0 (buffer-size buffer))
1284        (when (file-readable-p ".git/rebase-apply/info")
1285          (with-temp-buffer
1286            (insert-file-contents ".git/rebase-apply/info")
1287            (goto-char (point-min))
1288            (when (re-search-forward "^Author: \\(.*\\)\nEmail: \\(.*\\)$" nil t)
1289              (setq author-name (match-string 1))
1290              (setq author-email (match-string 2)))
1291            (goto-char (point-min))
1292            (when (re-search-forward "^Subject: \\(.*\\)$" nil t)
1293              (setq subject (match-string 1)))
1294            (goto-char (point-min))
1295            (when (re-search-forward "^Date: \\(.*\\)$" nil t)
1296              (setq date (match-string 1)))))
1297        (git-setup-log-buffer buffer author-name author-email subject date))
1298      (if (boundp 'log-edit-diff-function)
1299          (log-edit 'git-do-commit nil '((log-edit-listfun . git-log-edit-files)
1300                                         (log-edit-diff-function . git-log-edit-diff)) buffer)
1301        (log-edit 'git-do-commit nil 'git-log-edit-files buffer))
1302      (setq font-lock-keywords (font-lock-compile-keywords git-log-edit-font-lock-keywords))
1303      (setq buffer-file-coding-system coding-system)
1304      (re-search-forward (regexp-quote (concat git-log-msg-separator "\n")) nil t))))
1305
1306(defun git-setup-commit-buffer (commit)
1307  "Setup the commit buffer with the contents of COMMIT."
1308  (let (author-name author-email subject date msg)
1309    (with-temp-buffer
1310      (let ((coding-system (git-get-logoutput-coding-system)))
1311        (git-call-process t "log" "-1" "--pretty=medium" commit)
1312        (goto-char (point-min))
1313        (when (re-search-forward "^Author: *\\(.*\\) <\\(.*\\)>$" nil t)
1314          (setq author-name (match-string 1))
1315          (setq author-email (match-string 2)))
1316        (when (re-search-forward "^Date: *\\(.*\\)$" nil t)
1317          (setq date (match-string 1)))
1318        (while (re-search-forward "^    \\(.*\\)$" nil t)
1319          (push (match-string 1) msg))
1320        (setq msg (nreverse msg))
1321        (setq subject (pop msg))
1322        (while (and msg (zerop (length (car msg))) (pop msg)))))
1323    (git-setup-log-buffer (get-buffer-create "*git-commit*")
1324                          author-name author-email subject date
1325                          (mapconcat #'identity msg "\n"))))
1326
1327(defun git-get-commit-files (commit)
1328  "Retrieve the list of files modified by COMMIT."
1329  (let (files)
1330    (with-temp-buffer
1331      (git-call-process t "diff-tree" "-r" "-z" "--name-only" "--no-commit-id" commit)
1332      (goto-char (point-min))
1333      (while (re-search-forward "\\([^\0]*\\)\0" nil t 1)
1334        (push (match-string 1) files)))
1335    files))
1336
1337(defun git-amend-commit ()
1338  "Undo the last commit on HEAD, and set things up to commit an
1339amended version of it."
1340  (interactive)
1341  (unless git-status (error "Not in git-status buffer."))
1342  (when (git-empty-db-p) (error "No commit to amend."))
1343  (let* ((commit (git-rev-parse "HEAD"))
1344         (files (git-get-commit-files commit)))
1345    (when (git-call-process-display-error "reset" "--soft" "HEAD^")
1346      (git-update-status-files (copy-sequence files) 'uptodate)
1347      (git-mark-files git-status files)
1348      (git-refresh-files)
1349      (git-setup-commit-buffer commit)
1350      (git-commit-file))))
1351
1352(defun git-find-file ()
1353  "Visit the current file in its own buffer."
1354  (interactive)
1355  (unless git-status (error "Not in git-status buffer."))
1356  (let ((info (ewoc-data (ewoc-locate git-status))))
1357    (unless (git-expand-directory info)
1358      (find-file (git-fileinfo->name info))
1359      (when (eq 'unmerged (git-fileinfo->state info))
1360        (smerge-mode 1)))))
1361
1362(defun git-find-file-other-window ()
1363  "Visit the current file in its own buffer in another window."
1364  (interactive)
1365  (unless git-status (error "Not in git-status buffer."))
1366  (let ((info (ewoc-data (ewoc-locate git-status))))
1367    (find-file-other-window (git-fileinfo->name info))
1368    (when (eq 'unmerged (git-fileinfo->state info))
1369      (smerge-mode))))
1370
1371(defun git-find-file-imerge ()
1372  "Visit the current file in interactive merge mode."
1373  (interactive)
1374  (unless git-status (error "Not in git-status buffer."))
1375  (let ((info (ewoc-data (ewoc-locate git-status))))
1376    (find-file (git-fileinfo->name info))
1377    (smerge-ediff)))
1378
1379(defun git-view-file ()
1380  "View the current file in its own buffer."
1381  (interactive)
1382  (unless git-status (error "Not in git-status buffer."))
1383  (let ((info (ewoc-data (ewoc-locate git-status))))
1384    (view-file (git-fileinfo->name info))))
1385
1386(defun git-refresh-status ()
1387  "Refresh the git status buffer."
1388  (interactive)
1389  (let* ((status git-status)
1390         (pos (ewoc-locate status))
1391         (marked-files (git-get-filenames (ewoc-collect status (lambda (info) (git-fileinfo->marked info)))))
1392         (cur-name (and pos (git-fileinfo->name (ewoc-data pos)))))
1393    (unless status (error "Not in git-status buffer."))
1394    (message "Refreshing git status...")
1395    (git-call-process nil "update-index" "--refresh")
1396    (git-clear-status status)
1397    (git-update-status-files nil)
1398    ; restore file marks
1399    (when marked-files
1400      (git-status-filenames-map status
1401                                (lambda (info)
1402                                        (setf (git-fileinfo->marked info) t)
1403                                        (setf (git-fileinfo->needs-refresh info) t))
1404                                marked-files)
1405      (git-refresh-files))
1406    ; move point to the current file name if any
1407    (message "Refreshing git status...done")
1408    (let ((node (and cur-name (git-find-status-file status cur-name))))
1409      (when node (ewoc-goto-node status node)))))
1410
1411(defun git-status-quit ()
1412  "Quit git-status mode."
1413  (interactive)
1414  (bury-buffer))
1415
1416;;;; Major Mode
1417;;;; ------------------------------------------------------------
1418
1419(defvar git-status-mode-hook nil
1420  "Run after `git-status-mode' is setup.")
1421
1422(defvar git-status-mode-map nil
1423  "Keymap for git major mode.")
1424
1425(defvar git-status nil
1426  "List of all files managed by the git-status mode.")
1427
1428(unless git-status-mode-map
1429  (let ((map (make-keymap))
1430        (commit-map (make-sparse-keymap))
1431        (diff-map (make-sparse-keymap))
1432        (toggle-map (make-sparse-keymap)))
1433    (suppress-keymap map)
1434    (define-key map "?"   'git-help)
1435    (define-key map "h"   'git-help)
1436    (define-key map " "   'git-next-file)
1437    (define-key map "a"   'git-add-file)
1438    (define-key map "c"   'git-commit-file)
1439    (define-key map "\C-c" commit-map)
1440    (define-key map "d"    diff-map)
1441    (define-key map "="   'git-diff-file)
1442    (define-key map "f"   'git-find-file)
1443    (define-key map "\r"  'git-find-file)
1444    (define-key map "g"   'git-refresh-status)
1445    (define-key map "i"   'git-ignore-file)
1446    (define-key map "l"   'git-log-file)
1447    (define-key map "m"   'git-mark-file)
1448    (define-key map "M"   'git-mark-all)
1449    (define-key map "n"   'git-next-file)
1450    (define-key map "N"   'git-next-unmerged-file)
1451    (define-key map "o"   'git-find-file-other-window)
1452    (define-key map "p"   'git-prev-file)
1453    (define-key map "P"   'git-prev-unmerged-file)
1454    (define-key map "q"   'git-status-quit)
1455    (define-key map "r"   'git-remove-file)
1456    (define-key map "R"   'git-resolve-file)
1457    (define-key map "t"    toggle-map)
1458    (define-key map "T"   'git-toggle-all-marks)
1459    (define-key map "u"   'git-unmark-file)
1460    (define-key map "U"   'git-revert-file)
1461    (define-key map "v"   'git-view-file)
1462    (define-key map "x"   'git-remove-handled)
1463    (define-key map "\C-?" 'git-unmark-file-up)
1464    (define-key map "\M-\C-?" 'git-unmark-all)
1465    ; the commit submap
1466    (define-key commit-map "\C-a" 'git-amend-commit)
1467    ; the diff submap
1468    (define-key diff-map "b" 'git-diff-file-base)
1469    (define-key diff-map "c" 'git-diff-file-combined)
1470    (define-key diff-map "=" 'git-diff-file)
1471    (define-key diff-map "e" 'git-diff-file-idiff)
1472    (define-key diff-map "E" 'git-find-file-imerge)
1473    (define-key diff-map "h" 'git-diff-file-merge-head)
1474    (define-key diff-map "m" 'git-diff-file-mine)
1475    (define-key diff-map "o" 'git-diff-file-other)
1476    ; the toggle submap
1477    (define-key toggle-map "u" 'git-toggle-show-uptodate)
1478    (define-key toggle-map "i" 'git-toggle-show-ignored)
1479    (define-key toggle-map "k" 'git-toggle-show-unknown)
1480    (define-key toggle-map "m" 'git-toggle-all-marks)
1481    (setq git-status-mode-map map))
1482  (easy-menu-define git-menu git-status-mode-map
1483    "Git Menu"
1484    `("Git"
1485      ["Refresh" git-refresh-status t]
1486      ["Commit" git-commit-file t]
1487      ("Merge"
1488        ["Next Unmerged File" git-next-unmerged-file t]
1489        ["Prev Unmerged File" git-prev-unmerged-file t]
1490        ["Mark as Resolved" git-resolve-file t]
1491        ["Interactive Merge File" git-find-file-imerge t]
1492        ["Diff Against Common Base File" git-diff-file-base t]
1493        ["Diff Combined" git-diff-file-combined t]
1494        ["Diff Against Merge Head" git-diff-file-merge-head t]
1495        ["Diff Against Mine" git-diff-file-mine t]
1496        ["Diff Against Other" git-diff-file-other t])
1497      "--------"
1498      ["Add File" git-add-file t]
1499      ["Revert File" git-revert-file t]
1500      ["Ignore File" git-ignore-file t]
1501      ["Remove File" git-remove-file t]
1502      "--------"
1503      ["Find File" git-find-file t]
1504      ["View File" git-view-file t]
1505      ["Diff File" git-diff-file t]
1506      ["Interactive Diff File" git-diff-file-idiff t]
1507      ["Log" git-log-file t]
1508      "--------"
1509      ["Mark" git-mark-file t]
1510      ["Mark All" git-mark-all t]
1511      ["Unmark" git-unmark-file t]
1512      ["Unmark All" git-unmark-all t]
1513      ["Toggle All Marks" git-toggle-all-marks t]
1514      ["Hide Handled Files" git-remove-handled t]
1515      "--------"
1516      ["Show Uptodate Files" git-toggle-show-uptodate :style toggle :selected git-show-uptodate]
1517      ["Show Ignored Files" git-toggle-show-ignored :style toggle :selected git-show-ignored]
1518      ["Show Unknown Files" git-toggle-show-unknown :style toggle :selected git-show-unknown]
1519      "--------"
1520      ["Quit" git-status-quit t])))
1521
1522
1523;; git mode should only run in the *git status* buffer
1524(put 'git-status-mode 'mode-class 'special)
1525
1526(defun git-status-mode ()
1527  "Major mode for interacting with Git.
1528Commands:
1529\\{git-status-mode-map}"
1530  (kill-all-local-variables)
1531  (buffer-disable-undo)
1532  (setq mode-name "git status"
1533        major-mode 'git-status-mode
1534        goal-column 17
1535        buffer-read-only t)
1536  (use-local-map git-status-mode-map)
1537  (let ((buffer-read-only nil))
1538    (erase-buffer)
1539  (let ((status (ewoc-create 'git-fileinfo-prettyprint "" "")))
1540    (set (make-local-variable 'git-status) status))
1541  (set (make-local-variable 'list-buffers-directory) default-directory)
1542  (make-local-variable 'git-show-uptodate)
1543  (make-local-variable 'git-show-ignored)
1544  (make-local-variable 'git-show-unknown)
1545  (run-hooks 'git-status-mode-hook)))
1546
1547(defun git-find-status-buffer (dir)
1548  "Find the git status buffer handling a specified directory."
1549  (let ((list (buffer-list))
1550        (fulldir (expand-file-name dir))
1551        found)
1552    (while (and list (not found))
1553      (let ((buffer (car list)))
1554        (with-current-buffer buffer
1555          (when (and list-buffers-directory
1556                     (string-equal fulldir (expand-file-name list-buffers-directory))
1557                     (eq major-mode 'git-status-mode))
1558            (setq found buffer))))
1559      (setq list (cdr list)))
1560    found))
1561
1562(defun git-status (dir)
1563  "Entry point into git-status mode."
1564  (interactive "DSelect directory: ")
1565  (setq dir (git-get-top-dir dir))
1566  (if (file-directory-p (concat (file-name-as-directory dir) ".git"))
1567      (let ((buffer (or (and git-reuse-status-buffer (git-find-status-buffer dir))
1568                        (create-file-buffer (expand-file-name "*git-status*" dir)))))
1569        (switch-to-buffer buffer)
1570        (cd dir)
1571        (git-status-mode)
1572        (git-refresh-status)
1573        (goto-char (point-min))
1574        (add-hook 'after-save-hook 'git-update-saved-file))
1575    (message "%s is not a git working tree." dir)))
1576
1577(defun git-update-saved-file ()
1578  "Update the corresponding git-status buffer when a file is saved.
1579Meant to be used in `after-save-hook'."
1580  (let* ((file (expand-file-name buffer-file-name))
1581         (dir (condition-case nil (git-get-top-dir (file-name-directory file)) (error nil)))
1582         (buffer (and dir (git-find-status-buffer dir))))
1583    (when buffer
1584      (with-current-buffer buffer
1585        (let ((filename (file-relative-name file dir)))
1586          ; skip files located inside the .git directory
1587          (unless (string-match "^\\.git/" filename)
1588            (git-call-process nil "add" "--refresh" "--" filename)
1589            (git-update-status-files (list filename) 'uptodate)))))))
1590
1591(defun git-help ()
1592  "Display help for Git mode."
1593  (interactive)
1594  (describe-function 'git-status-mode))
1595
1596(provide 'git)
1597;;; git.el ends here