From 8e732a6db9cc2855c2b0f307129555bb2551ff96 Mon Sep 17 00:00:00 2001 From: Eshel Yaron Date: Sat, 21 Sep 2024 12:15:16 +0200 Subject: [PATCH] Teach Electric Pair mode about prefix arguments * lisp/elec-pair.el (electric-pair--insert): New arg TIMES. (electric-pair-inhibit-if-helps-balance) (electric-pair-post-self-insert-function) (electric-pair-open-newline-between-pairs-psif) (electric-pair-skip-if-helps-balance): Respect prefix arg. (electric-pair-delete-pair): Delete ARG chars, not just 1. * test/lisp/electric-tests.el (autowrapping-multi-1) (autowrapping-multi-2): New tests. * doc/emacs/programs.texi (Matching): Mention prefix arg support in Electric Pair mode documentation. * etc/NEWS: Announce it. --- doc/emacs/programs.texi | 4 +- etc/NEWS | 6 +++ lisp/elec-pair.el | 87 ++++++++++++++++++++----------------- test/lisp/electric-tests.el | 16 +++++++ 4 files changed, 72 insertions(+), 41 deletions(-) diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi index 42b57143bf1..948f4128acf 100644 --- a/doc/emacs/programs.texi +++ b/doc/emacs/programs.texi @@ -1061,7 +1061,9 @@ Matching over. If the region is active (@pxref{Mark}), insertion of a delimiter operates on the region: the characters in the region are enclosed in a pair of matching delimiters, leaving point after the -delimiter you typed. +delimiter you typed. If you provide a prefix argument when inserting +a delimiter, the numeric value of that prefix argument specifies the +number of pairs to insert. These variables control additional features of Electric Pair mode: diff --git a/etc/NEWS b/etc/NEWS index b902aaf7ead..f22215851a6 100644 --- a/etc/NEWS +++ b/etc/NEWS @@ -147,6 +147,12 @@ instead of raising an error. Note that if you have disabled Transient Mark mode you might prefer to use 'unix-word-rubout', as this feature relies on there being an active region. ++++ +** Electric Pair mode can now pair multiple delimiters at once. +You can now insert or wrap text with multiple sets of parentheses and +other matching delimiters at once with Electric Pair mode, by providing +a prefix argument when inserting one of the delimiters. + * Changes in Specialized Modes and Packages in Emacs 31.1 diff --git a/lisp/elec-pair.el b/lisp/elec-pair.el index 40618e9ef38..1fae0ba6ba4 100644 --- a/lisp/elec-pair.el +++ b/lisp/elec-pair.el @@ -260,7 +260,7 @@ electric-pair-syntax-info (list ?\( (cdr direct) t string-or-comment))) (reverse (list ?\) (car reverse) t string-or-comment))))) -(defun electric-pair--insert (char) +(defun electric-pair--insert (char times) (let ((last-command-event char) (blink-matching-paren nil) (electric-pair-mode nil) @@ -271,7 +271,7 @@ electric-pair--insert ;; us to add these newlines, and is probably about to kick in ;; again after we add the closer. (electric-layout-allow-duplicate-newlines t)) - (self-insert-command 1))) + (self-insert-command times))) (defun electric-pair--syntax-ppss (&optional pos where) "Like `syntax-ppss', but sometimes fallback to `parse-partial-sexp'. @@ -455,7 +455,8 @@ electric-pair-inhibit-if-helps-balance (atomic-change-group ;; Don't use `delete-char'; that may modify the head of the ;; undo list. - (delete-region (point) (1- (point))) + (delete-region (- (point) (prefix-numeric-value current-prefix-arg)) + (point)) (throw 'done (cond ((eq ?\( syntax) @@ -474,25 +475,26 @@ electric-pair-skip-if-helps-balance Works by first removing the character from the buffer, then doing some list calculations, finally restoring the situation as if nothing happened." - (pcase (electric-pair-syntax-info char) - (`(,syntax ,pair ,_ ,s-or-c) - (unwind-protect - (progn - (delete-char -1) - (cond ((eq syntax ?\)) - (let* ((pair-data - (electric-pair--balance-info - -1 s-or-c)) - (innermost (car pair-data)) - (outermost (cdr pair-data))) - (and - (cond ((car outermost) - (car innermost)) - ((car innermost) - (not (eq (cdr outermost) pair))))))) - ((eq syntax ?\") - (electric-pair--inside-string-p char)))) - (insert char))))) + (let ((num (prefix-numeric-value current-prefix-arg))) + (pcase (electric-pair-syntax-info char) + (`(,syntax ,pair ,_ ,s-or-c) + (unwind-protect + (progn + (delete-char (- num)) + (cond ((eq syntax ?\)) + (let* ((pair-data + (electric-pair--balance-info + (- num) s-or-c)) + (innermost (car pair-data)) + (outermost (cdr pair-data))) + (and + (cond ((car outermost) + (car innermost)) + ((car innermost) + (not (eq (cdr outermost) pair))))))) + ((eq syntax ?\") + (electric-pair--inside-string-p char)))) + (insert (make-string num char))))))) (defun electric-pair-default-skip-self (char) (if electric-pair-preserve-balance @@ -527,11 +529,14 @@ electric-pair-post-self-insert-function `electric-pair-inhibit-predicate', `electric-pair-skip-self' and `electric-pair-skip-whitespace' (which see)." (let* ((pos (and electric-pair-mode (electric--after-char-pos))) + (num (when pos (prefix-numeric-value current-prefix-arg))) + (beg (when num (- pos num))) (skip-whitespace-info)) (pcase (electric-pair-syntax-info last-command-event) (`(,syntax ,pair ,unconditional ,_) (cond ((null pos) nil) + ((zerop num) nil) ;; Wrap a pair around the active region. ;; ((and (memq syntax '(?\( ?\) ?\" ?\$)) (use-region-p)) @@ -545,23 +550,24 @@ electric-pair-post-self-insert-function (>= (mark) (point)))) (save-excursion (goto-char (mark)) - (electric-pair--insert pair)) - (delete-region pos (1- pos)) - (electric-pair--insert pair) + (electric-pair--insert pair num)) + (delete-region beg pos) + (electric-pair--insert pair num) (goto-char (mark)) - (electric-pair--insert last-command-event))) + (electric-pair--insert last-command-event num))) ;; Backslash-escaped: no pairing, no skipping. ((save-excursion - (goto-char (1- pos)) + (goto-char beg) (not (zerop (% (skip-syntax-backward "\\") 2)))) - nil) + (let ((current-prefix-arg (1- num))) + (electric-pair-post-self-insert-function))) ;; Skip self. ((and (memq syntax '(?\) ?\" ?\$)) (and (or unconditional (if (functionp electric-pair-skip-self) (electric-pair--save-literal-point-excursion - (goto-char pos) - (funcall electric-pair-skip-self last-command-event)) + (goto-char pos) + (funcall electric-pair-skip-self last-command-event)) electric-pair-skip-self)) (save-excursion (when (and (not (and unconditional @@ -580,19 +586,19 @@ electric-pair-post-self-insert-function ;; live with it for now. (when skip-whitespace-info (funcall electric-pair-skip-whitespace-function)) - (delete-region (1- pos) (if (eq skip-whitespace-info 'chomp) - (point) - pos)) - (forward-char)) + (delete-region beg (if (eq skip-whitespace-info 'chomp) + (point) + pos)) + (forward-char num)) ;; Insert matching pair. ((and (memq syntax '(?\( ?\" ?\$)) (not overwrite-mode) (or unconditional (not (electric-pair--save-literal-point-excursion - (goto-char pos) - (funcall electric-pair-inhibit-predicate - last-command-event))))) - (save-excursion (electric-pair--insert pair)))))))) + (goto-char pos) + (funcall electric-pair-inhibit-predicate + last-command-event))))) + (save-excursion (electric-pair--insert pair num)))))))) (defun electric-pair-open-newline-between-pairs-psif () "Honor `electric-pair-open-newline-between-pairs'. @@ -604,7 +610,8 @@ electric-pair-open-newline-between-pairs-psif (< (1+ (point-min)) (point) (point-max)) (eq (save-excursion (skip-chars-backward "\t\s") - (char-before (1- (point)))) + (char-before (- (point) + (prefix-numeric-value current-prefix-arg)))) (matching-paren (char-after)))) (save-excursion (newline 1 t)))) @@ -618,7 +625,7 @@ electric-pair-delete-pair ARG and KILLP are passed directly to `backward-delete-char-untabify', which see." (interactive "*p\nP") - (delete-char 1) + (delete-char arg) (backward-delete-char-untabify arg killp)) (defvar electric-pair-mode-map diff --git a/test/lisp/electric-tests.el b/test/lisp/electric-tests.el index 720313511a6..76c18594b26 100644 --- a/test/lisp/electric-tests.el +++ b/test/lisp/electric-tests.el @@ -653,6 +653,22 @@ autowrapping-7 (skip-chars-backward "\"") (mark-sexp -1))) +(define-electric-pair-test autowrapping-multi-1 + "foo" "(" :expected-string "(((((foo)))))" :expected-point 6 + :bindings '((current-prefix-arg . 5)) + :fixture-fn (lambda () + (electric-pair-mode 1) + (mark-sexp 1))) + +(define-electric-pair-test autowrapping-multi-2 + "foo" ")" :expected-string "(((((foo)))))" :expected-point 14 + :bindings '((current-prefix-arg . 5)) + :fixture-fn (lambda () + (electric-pair-mode 1) + (goto-char (point-max)) + (skip-chars-backward "\"") + (mark-sexp -1))) + ;;; Electric quotes (define-electric-pair-test electric-quote-string -- 2.46.0