diff options
| -rw-r--r-- | lisp/Makefile | 6 | ||||
| -rw-r--r-- | lisp/magit-core.el | 3 | ||||
| -rw-r--r-- | lisp/magit-log.el | 169 | ||||
| -rw-r--r-- | lisp/magit-margin.el | 216 | ||||
| -rw-r--r-- | lisp/magit-utils.el | 35 |
5 files changed, 247 insertions, 182 deletions
diff --git a/lisp/Makefile b/lisp/Makefile index 8d8b2e8..706c62a 100644 --- a/lisp/Makefile +++ b/lisp/Makefile @@ -15,11 +15,13 @@ magit-utils.elc: magit-section.elc: magit-utils.elc magit-git.elc: magit-utils.elc magit-section.elc magit-mode.elc: magit-section.elc magit-git.elc magit-popup.elc +magit-margin.elc: magit-section.elc magit-mode.elc magit-process.elc: magit-utils.elc magit-section.elc \ magit-git.elc magit-mode.elc magit-autorevert.elc: magit-git.elc magit-process.elc -magit-core.elc: magit-utils.elc magit-section.elc magit-git.elc \ - magit-mode.elc magit-popup.elc magit-process.elc +magit-core.elc: magit-popup.elc magit-margin.elc magit-utils.elc \ + magit-section.elc magit-git.elc magit-mode.elc \ + magit-process.elc magit-autorevert.elc magit-diff.elc: git-commit.elc magit-core.elc magit-log.elc: magit-core.elc magit-diff.elc magit-wip.elc: magit-core.elc magit-log.elc diff --git a/lisp/magit-core.el b/lisp/magit-core.el index ea14dc1..a074c1d 100644 --- a/lisp/magit-core.el +++ b/lisp/magit-core.el @@ -30,11 +30,12 @@ ;;; Code: +(require 'magit-popup) (require 'magit-utils) (require 'magit-section) (require 'magit-git) (require 'magit-mode) -(require 'magit-popup) +(require 'magit-margin) (require 'magit-process) (require 'magit-autorevert) diff --git a/lisp/magit-log.el b/lisp/magit-log.el index 5e205ae..d5cf538 100644 --- a/lisp/magit-log.el +++ b/lisp/magit-log.el @@ -99,24 +99,6 @@ Only considered when moving past the last entry with :group 'magit-log :type 'boolean) -(defconst magit-log-margin--custom-type - '(list (boolean :tag "Show initially") - (integer :tag "Show author name using width") - (choice :tag "Show committer" - (string :tag "date using format" "%Y-%m-%d %H:%M ") - (const :tag "date's age" age) - (const :tag "date's age (abbreviated)" age-abbreviated)))) - -(defun magit-margin-set-variable (mode symbol value) - (set-default symbol value) - (message "Updating margins in %s buffers..." mode) - (dolist (buffer (buffer-list)) - (with-current-buffer buffer - (when (eq major-mode mode) - (magit-set-buffer-margin magit-show-margin) - (magit-refresh)))) - (message "Updating margins in %s buffers...done" mode)) - (defcustom magit-log-margin '(t 18 age) "Format of the margin in `magit-log-mode' buffers. @@ -1067,29 +1049,6 @@ Do not add this to a hook variable." (insert graph ?\n)))))))) t) -(defun magit-log-format-margin (author date) - (when (magit-margin-get :option) - (magit-make-margin-overlay - (concat (-when-let (width (magit-margin-get :person)) - (concat (propertize (truncate-string-to-width - (or author "") - width - nil ?\s (make-string 1 magit-ellipsis)) - 'face 'magit-log-author) - " ")) - (propertize - (let ((style (magit-margin-get :style))) - (if (stringp style) - (format-time-string - style - (seconds-to-time (string-to-number date))) - (-let* ((abbr (eq style 'age-abbreviated)) - ((cnt unit) (magit--age date abbr))) - (format (format (if abbr "%%2i%%-%ic" "%%2i %%-%is") - (1- (magit-margin-get :age-width))) - cnt unit)))) - 'face 'magit-log-date))))) - (defun magit-log-maybe-show-more-commits (section) "Automatically insert more commit sections in a log. Only do so if `point' is on the \"show more\" section, @@ -1162,6 +1121,31 @@ If there is no blob buffer in the same frame, then do nothing." (magit-section-children magit-root-section)))) (goto-char (magit-section-start same)))) +;;; Log Margin + +(defun magit-log-format-margin (author date) + (when (magit-margin-get :option) + (magit-make-margin-overlay + (concat (-when-let (width (magit-margin-get :person)) + (concat (propertize (truncate-string-to-width + (or author "") + width + nil ?\s (make-string 1 magit-ellipsis)) + 'face 'magit-log-author) + " ")) + (propertize + (let ((style (magit-margin-get :style))) + (if (stringp style) + (format-time-string + style + (seconds-to-time (string-to-number date))) + (-let* ((abbr (eq style 'age-abbreviated)) + ((cnt unit) (magit--age date abbr))) + (format (format (if abbr "%%2i%%-%ic" "%%2i %%-%is") + (1- (magit-margin-get :age-width))) + cnt unit)))) + 'face 'magit-log-date))))) + ;;; Select Mode (defvar magit-log-select-mode-map @@ -1489,109 +1473,6 @@ all others with \"-\"." (magit-git-wash (apply-partially 'magit-log-wash-log 'cherry) "cherry" "-v" (magit-abbrev-arg) "@{upstream}")))) -;;; Buffer Margins - -(defvar-local magit-set-buffer-margin-refresh nil) - -(defvar-local magit-show-margin nil) -(put 'magit-show-margin 'permanent-local t) - -(defvar-local magit-margin-age-width nil) -(put 'magit-margin-age-width 'permanent-local t) - -(defun magit-margin-get (prop) - (pcase prop - (:age-width magit-margin-age-width) - (:option (pcase major-mode - (`magit-cherry-mode 'magit-cherry-margin) - (`magit-log-mode 'magit-log-margin) - (`magit-log-select-mode 'magit-log-select-margin) - (`magit-reflog-mode 'magit-reflog-margin) - (`magit-refs-mode 'magit-refs-margin) - (`magit-stashes-mode 'magit-stashes-margin) - (`magit-status-mode 'magit-status-margin))) - (_ (nth (pcase prop - (:initially 0) - (:person 1) - (:style 2)) - (symbol-value (magit-margin-get :option)))))) - -(defun magit-toggle-margin () - "Show or hide the Magit margin." - (interactive) - (unless (derived-mode-p 'magit-log-mode 'magit-status-mode - 'magit-refs-mode 'magit-cherry-mode) - (user-error "Magit margin isn't supported in this buffer")) - (magit-set-buffer-margin (not (cdr (window-margins))))) - -(defun magit-maybe-show-margin () - "Maybe show the margin, depending on the major-mode and an option." - (cond ((local-variable-p 'magit-show-margin) - (magit-set-buffer-margin magit-show-margin)) - ((magit-margin-get :option) - (magit-set-buffer-margin (magit-margin-get :initially))))) - -(defun magit-set-buffer-margin (enable) - (let ((style (magit-margin-get :style))) - (setq magit-margin-age-width - (+ 1 ; gap between committer and time - ;;; width of unit - (if (eq style 'age-abbreviated) - 1 ; single character - (+ 1 ; gap between count and unit - (apply #'max (--map (max (length (nth 1 it)) - (length (nth 2 it))) - magit--age-spec)))))) - (let ((width (and enable - (+ (-if-let (width (magit-margin-get :person)) - (1+ width) - 0) - (if (stringp style) - (length (format-time-string style)) - (+ 2 ; count width - (magit-margin-get :age-width))))))) - (setq magit-show-margin width) - (when (and enable magit-set-buffer-margin-refresh) - (magit-refresh-buffer)) - (dolist (window (get-buffer-window-list nil nil 0)) - (with-selected-window window - (set-window-margins nil (car (window-margins)) width) - (if enable - (add-hook 'window-configuration-change-hook - 'magit-set-buffer-margin-1 nil t) - (remove-hook 'window-configuration-change-hook - 'magit-set-buffer-margin-1 t))))))) - -(defun magit-set-buffer-margin-1 () - (-when-let (window (get-buffer-window)) - (with-selected-window window - (set-window-margins nil (car (window-margins)) magit-show-margin)))) - -(defun magit-make-margin-overlay (&optional string previous-line) - (if previous-line - (save-excursion - (forward-line -1) - (magit-make-margin-overlay string)) - ;; Don't put the overlay on the complete line to work around #1880. - (let ((o (make-overlay (1+ (line-beginning-position)) - (line-end-position) - nil t))) - (overlay-put o 'evaporate t) - (overlay-put o 'before-string - (propertize "o" 'display - (list (list 'margin 'right-margin) - (or string " "))))))) - -(defun magit-maybe-make-margin-overlay () - (when (or (magit-section-match - '(unpulled unpushed recent stashes local cherries) - magit-insert-section--current) - (and (eq major-mode 'magit-refs-mode) - (magit-section-match - '(remote commit) - magit-insert-section--current))) - (magit-make-margin-overlay nil t))) - ;;; magit-log.el ends soon (define-obsolete-variable-alias 'magit-log-section-args diff --git a/lisp/magit-margin.el b/lisp/magit-margin.el new file mode 100644 index 0000000..dcb2070 --- /dev/null +++ b/lisp/magit-margin.el @@ -0,0 +1,216 @@ +;;; magit-margin.el --- margins in Magit buffers -*- lexical-binding: t -*- + +;; Copyright (C) 2010-2016 The Magit Project Contributors +;; +;; You should have received a copy of the AUTHORS.md file which +;; lists all contributors. If not, see http://magit.vc/authors. + +;; Author: Jonas Bernoulli <jonas@bernoul.li> +;; Maintainer: Jonas Bernoulli <jonas@bernoul.li> + +;; Magit is free software; you can redistribute it and/or modify it +;; under the terms of the GNU General Public License as published by +;; the Free Software Foundation; either version 3, or (at your option) +;; any later version. +;; +;; Magit is distributed in the hope that it will be useful, but WITHOUT +;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY +;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public +;; License for more details. +;; +;; You should have received a copy of the GNU General Public License +;; along with Magit. If not, see http://www.gnu.org/licenses. + +;;; Commentary: + +;; This library implements support for showing additional information +;; in the margins of Magit buffers. Currently this is only used for +;; commits, for which the author name and optionally committer date or +;; age are shown. + +;;; Code: + +(require 'dash) + +(require 'magit-section) +(require 'magit-mode) + +(defgroup magit-margin nil + "Information Magit displays in the margin. + +If you want to change the DATE-STYLE of all `magit-*-margin' +options to the same value, you can do so by only customizing +`magit-log-margin' *before* `magit' is loaded. If you do so, +then the respective value for the other options will default +to what you have set for `magit-log-margin'." + :group 'magit-log) + +(defvar-local magit-set-buffer-margin-refresh nil) + +(defvar-local magit-show-margin nil) +(put 'magit-show-margin 'permanent-local t) + +(defvar-local magit-margin-age-width nil) +(put 'magit-margin-age-width 'permanent-local t) + +(defvar magit--age-spec) + +;;; Commands + +(defun magit-toggle-margin () + "Show or hide the Magit margin." + (interactive) + (unless (derived-mode-p 'magit-log-mode 'magit-status-mode + 'magit-refs-mode 'magit-cherry-mode) + (user-error "Magit margin isn't supported in this buffer")) + (magit-set-buffer-margin (not (cdr (window-margins))))) + +;;; Core + +(defun magit-margin-get (prop) + (pcase prop + (:age-width magit-margin-age-width) + (:option (pcase major-mode + (`magit-cherry-mode 'magit-cherry-margin) + (`magit-log-mode 'magit-log-margin) + (`magit-log-select-mode 'magit-log-select-margin) + (`magit-reflog-mode 'magit-reflog-margin) + (`magit-refs-mode 'magit-refs-margin) + (`magit-stashes-mode 'magit-stashes-margin) + (`magit-status-mode 'magit-status-margin))) + (_ (nth (pcase prop + (:initially 0) + (:person 1) + (:style 2)) + (symbol-value (magit-margin-get :option)))))) + +(defun magit-maybe-show-margin () + "Maybe show the margin, depending on the major-mode and an option." + (cond ((local-variable-p 'magit-show-margin) + (magit-set-buffer-margin magit-show-margin)) + ((magit-margin-get :option) + (magit-set-buffer-margin (magit-margin-get :initially))))) + +(defun magit-set-buffer-margin (enable) + (let ((style (magit-margin-get :style))) + (setq magit-margin-age-width + (+ 1 ; gap between committer and time + ;;; width of unit + (if (eq style 'age-abbreviated) + 1 ; single character + (+ 1 ; gap between count and unit + (apply #'max (--map (max (length (nth 1 it)) + (length (nth 2 it))) + magit--age-spec)))))) + (let ((width (and enable + (+ (-if-let (width (magit-margin-get :person)) + (1+ width) + 0) + (if (stringp style) + (length (format-time-string style)) + (+ 2 ; count width + (magit-margin-get :age-width))))))) + (setq magit-show-margin width) + (when (and enable magit-set-buffer-margin-refresh) + (magit-refresh-buffer)) + (dolist (window (get-buffer-window-list nil nil 0)) + (with-selected-window window + (set-window-margins nil (car (window-margins)) width) + (if enable + (add-hook 'window-configuration-change-hook + 'magit-set-buffer-margin-1 nil t) + (remove-hook 'window-configuration-change-hook + 'magit-set-buffer-margin-1 t))))))) + +(defun magit-set-buffer-margin-1 () + (-when-let (window (get-buffer-window)) + (with-selected-window window + (set-window-margins nil (car (window-margins)) magit-show-margin)))) + +(defun magit-make-margin-overlay (&optional string previous-line) + (if previous-line + (save-excursion + (forward-line -1) + (magit-make-margin-overlay string)) + ;; Don't put the overlay on the complete line to work around #1880. + (let ((o (make-overlay (1+ (line-beginning-position)) + (line-end-position) + nil t))) + (overlay-put o 'evaporate t) + (overlay-put o 'before-string + (propertize "o" 'display + (list (list 'margin 'right-margin) + (or string " "))))))) + +(defun magit-maybe-make-margin-overlay () + (when (or (magit-section-match + '(unpulled unpushed recent stashes local cherries) + magit-insert-section--current) + (and (eq major-mode 'magit-refs-mode) + (magit-section-match + '(remote commit) + magit-insert-section--current))) + (magit-make-margin-overlay nil t))) + +;;; Custom Support + +(defun magit-margin-set-variable (mode symbol value) + (set-default symbol value) + (message "Updating margins in %s buffers..." mode) + (dolist (buffer (buffer-list)) + (with-current-buffer buffer + (when (eq major-mode mode) + (magit-set-buffer-margin magit-show-margin) + (magit-refresh)))) + (message "Updating margins in %s buffers...done" mode)) + +(defconst magit-log-margin--custom-type + '(list (boolean :tag "Show initially") + (integer :tag "Show author name using width") + (choice :tag "Show committer" + (string :tag "date using format" "%Y-%m-%d %H:%M ") + (const :tag "date's age" age) + (const :tag "date's age (abbreviated)" age-abbreviated)))) + +;;; Time Utilities + +(defvar magit--age-spec + `((?Y "year" "years" ,(round (* 60 60 24 365.2425))) + (?M "month" "months" ,(round (* 60 60 24 30.436875))) + (?w "week" "weeks" ,(* 60 60 24 7)) + (?d "day" "days" ,(* 60 60 24)) + (?h "hour" "hours" ,(* 60 60)) + (?m "minute" "minutes" 60) + (?s "second" "seconds" 1)) + "Time units used when formatting relative commit ages. + +The value is a list of time units, beginning with the longest. +Each element has the form (CHAR UNIT UNITS SECONDS). UNIT is the +time unit, UNITS is the plural of that unit. CHAR is a character +abbreviation. And SECONDS is the number of seconds in one UNIT. + +This is defined as a variable to make it possible to use time +units for a language other than English. It is not defined +as an option, because most other parts of Magit are always in +English.") + +(defun magit--age (date &optional abbreviate) + (cl-labels ((fn (age spec) + (-let [(char unit units weight) (car spec)] + (let ((cnt (round (/ age weight 1.0)))) + (if (or (not (cdr spec)) + (>= (/ age weight) 1)) + (list cnt (cond (abbreviate char) + ((= cnt 1) unit) + (t units))) + (fn age (cdr spec))))))) + (fn (abs (- (float-time) (string-to-number date))) + magit--age-spec))) + +;;; magit-margin.el ends soon +(provide 'magit-margin) +;; Local Variables: +;; coding: utf-8 +;; indent-tabs-mode: nil +;; End: +;;; magit-margin.el ends here diff --git a/lisp/magit-utils.el b/lisp/magit-utils.el index f5c3d9b..02e8c55 100644 --- a/lisp/magit-utils.el +++ b/lisp/magit-utils.el @@ -532,41 +532,6 @@ Unless optional argument KEEP-EMPTY-LINES is t, trim all empty lines." (insert-file-contents file) (split-string (buffer-string) "\n" (not keep-empty-lines))))) -;;; Time Utilities - -(defvar magit--age-spec - `((?Y "year" "years" ,(round (* 60 60 24 365.2425))) - (?M "month" "months" ,(round (* 60 60 24 30.436875))) - (?w "week" "weeks" ,(* 60 60 24 7)) - (?d "day" "days" ,(* 60 60 24)) - (?h "hour" "hours" ,(* 60 60)) - (?m "minute" "minutes" 60) - (?s "second" "seconds" 1)) - "Time units used when formatting relative commit ages. - -The value is a list of time units, beginning with the longest. -Each element has the form (CHAR UNIT UNITS SECONDS). UNIT is the -time unit, UNITS is the plural of that unit. CHAR is a character -abbreviation. And SECONDS is the number of seconds in one UNIT. - -This is defined as a variable to make it possible to use time -units for a language other than English. It is not defined -as an option, because most other parts of Magit are always in -English.") - -(defun magit--age (date &optional abbreviate) - (cl-labels ((fn (age spec) - (-let [(char unit units weight) (car spec)] - (let ((cnt (round (/ age weight 1.0)))) - (if (or (not (cdr spec)) - (>= (/ age weight) 1)) - (list cnt (cond (abbreviate char) - ((= cnt 1) unit) - (t units))) - (fn age (cdr spec))))))) - (fn (abs (- (float-time) (string-to-number date))) - magit--age-spec))) - ;;; Kludges (defun magit-file-accessible-directory-p (filename) |