From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Theodor Thornhill via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#60128: 30.0.50; [PATCH]: Add treesit-transpose-sexps Date: Mon, 26 Dec 2022 21:53:57 +0100 Message-ID: <873591honu.fsf@thornhill.no> References: <87a63nru7n.fsf@thornhill.no> <87edsytcoh.fsf@thornhill.no> Reply-To: Theodor Thornhill Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="1525"; mail-complaints-to="usenet@ciao.gmane.io" Cc: casouri@gmail.com, eliz@gnu.org, Stefan Monnier To: 60128@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Mon Dec 26 21:55:24 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1p9uVH-0000G0-Nv for geb-bug-gnu-emacs@m.gmane-mx.org; Mon, 26 Dec 2022 21:55:24 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1p9uUx-0002WJ-NE; Mon, 26 Dec 2022 15:55:03 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1p9uUw-0002W6-3k for bug-gnu-emacs@gnu.org; Mon, 26 Dec 2022 15:55:02 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1p9uUv-0000ua-Rf for bug-gnu-emacs@gnu.org; Mon, 26 Dec 2022 15:55:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1p9uUv-0001oS-Nj for bug-gnu-emacs@gnu.org; Mon, 26 Dec 2022 15:55:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Theodor Thornhill Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 26 Dec 2022 20:55:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60128 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 60128-submit@debbugs.gnu.org id=B60128.16720880466884 (code B ref 60128); Mon, 26 Dec 2022 20:55:01 +0000 Original-Received: (at 60128) by debbugs.gnu.org; 26 Dec 2022 20:54:06 +0000 Original-Received: from localhost ([127.0.0.1]:54166 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p9uU1-0001mw-Ci for submit@debbugs.gnu.org; Mon, 26 Dec 2022 15:54:06 -0500 Original-Received: from out-146.mta0.migadu.com ([91.218.175.146]:56349) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1p9uTx-0001mN-HY for 60128@debbugs.gnu.org; Mon, 26 Dec 2022 15:54:04 -0500 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=thornhill.no; s=key1; t=1672088038; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=jHa3LtlgKnQd2q2wzTJgEnCBfRWNMC5P2w0f3mfkPPQ=; b=BkAbaYNQ325MijswxZQCY9NwZOI8wLRrOTiqJsB7oB9zAd0SK7Mo0354pMrqr2H8hpz8R6 WUOtjsxkf6xtfVBxEcKG/dpF2asKlnngBrXuCHWK5Ka8+564wl3UmKvrisgrJNaD24YABA wibZVbnpLTJ8QfBaEoAL5heslog0/BS9QeeYD86WyYD9dO56+pMv1TeK4ZS2bf1bja1cgJ 1OrP2L2RgLWYBoYY0/Reww+hXFZxY1MIGyyqpS9CqNXrJA/YTodfiGgqVrzFuPuAUvkP9J k6F6cWeLiDw2iqGF+hXI6GTfYJzYmVqZCLfdyBDzgN4tXW8fQPdqI/PEUbnQtA== In-Reply-To: <87edsytcoh.fsf@thornhill.no> (Theodor Thornhill's message of "Sat, 17 Dec 2022 13:52:30 +0100") X-Migadu-Flow: FLOW_OUT X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:251916 Archived-At: --=-=-= Content-Type: text/plain Theodor Thornhill writes: > Theodor Thornhill writes: > >> Hi there! >> >> Attached is a patch that enables transpose-sexps for tree-sitter enabled >> modes. >> >> This function will swap the node _before_ node-at-point with the node >> _after_, so it would do something like: >> >> foo a|nd bar => bar and foo| >> >> or >> foo(a + 4,| y + c * b, b, d); => foo(y + c * b, a + 4|, b, d); >> >> It will _not_ try to swap things that are not siblings. I think that >> makes sense in the case of non-lisp languages, since _most_ places you >> can transpose-sexps you will end up with broken code. >> > > from 'transpose-subr-1': > > (if (> (cdr pos1) (car pos2)) (error "Don't have two things to > transpose")) > > I added this hack into the function in the patch, but I think that > triggering an error is too much. > > ;; Hack to trigger the error message in `transpose-subr-1' when we > ;; don't have siblings to swap. > (list (cons 0 1) (cons 0 1)))) > > I guess I could just follow suit in my function and do like in the > following patch: > > Theo Considering there is both a bug-report _and_ a discussion around this I guess the best idea is to add the patch to this bug report, and continue discussing this in the report rather than emacs-devel? What do you think about this patch? (copied from emacs-devel): It feels a little iffy how to handle the separate return values, but it works. I'd be super happy for some feedback on how to best solve that, though :) Also, I made the treesit-transpose-sexps a little better imo, in that we only find named nodes to swap, but use every available node for the entry. We rarely, if ever want to swap the unnamed nodes. Eli, does this require a NEWS entry or more documentation? Theo --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0001-Add-treesit-transpose-sexps-bug-60128.patch >From 0dc412eaf16123dcb65381970fb82c0741809753 Mon Sep 17 00:00:00 2001 From: Theodor Thornhill Date: Sun, 25 Dec 2022 20:11:59 +0100 Subject: [PATCH] Add treesit-transpose-sexps (bug#60128) We don't really need to rely on forward-sexp to define what to transpose. In tree-sitter we can consider siblings as "balanced expressions", and swap them without doing any movement to calculate where the siblings in question are. * lisp/simple.el (transpose-sexps-function): New defvar-local. (transpose-sexps): Use the new defvar-local if available. (transpose-subr): Check whether the mover function returns a cons of conses, then run transpose-subr-1 on the position-pairs. * lisp/treesit.el (treesit-transpose-sexps): New function. --- lisp/simple.el | 97 ++++++++++++++++++++++++++++--------------------- lisp/treesit.el | 24 +++++++++++- 2 files changed, 78 insertions(+), 43 deletions(-) diff --git a/lisp/simple.el b/lisp/simple.el index 4551b749d5..591b659c62 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -8438,6 +8438,14 @@ transpose-words (interactive "*p") (transpose-subr 'forward-word arg)) +(defvar-local transpose-sexps-function nil + "If non-nil, `transpose-sexps' delegates to this function. + +The return value of this function is expected to be a cons of two +conses, denoting the positions in the current buffer to be +transposed. If no such pair of positions is available, signal +USER-ERROR.") + (defun transpose-sexps (arg &optional interactive) "Like \\[transpose-chars] (`transpose-chars'), but applies to sexps. Unlike `transpose-words', point must be between the two sexps and not @@ -8454,36 +8462,37 @@ transpose-sexps (transpose-sexps arg nil) (scan-error (user-error "Not between two complete sexps"))) (transpose-subr - (lambda (arg) - ;; Here we should try to simulate the behavior of - ;; (cons (progn (forward-sexp x) (point)) - ;; (progn (forward-sexp (- x)) (point))) - ;; Except that we don't want to rely on the second forward-sexp - ;; putting us back to where we want to be, since forward-sexp-function - ;; might do funny things like infix-precedence. - (if (if (> arg 0) - (looking-at "\\sw\\|\\s_") - (and (not (bobp)) - (save-excursion - (forward-char -1) - (looking-at "\\sw\\|\\s_")))) - ;; Jumping over a symbol. We might be inside it, mind you. - (progn (funcall (if (> arg 0) - 'skip-syntax-backward 'skip-syntax-forward) - "w_") - (cons (save-excursion (forward-sexp arg) (point)) (point))) - ;; Otherwise, we're between sexps. Take a step back before jumping - ;; to make sure we'll obey the same precedence no matter which - ;; direction we're going. - (funcall (if (> arg 0) 'skip-syntax-backward 'skip-syntax-forward) - " .") - (cons (save-excursion (forward-sexp arg) (point)) - (progn (while (or (forward-comment (if (> arg 0) 1 -1)) - (not (zerop (funcall (if (> arg 0) - 'skip-syntax-forward - 'skip-syntax-backward) - "."))))) - (point))))) + (if transpose-sexps-function transpose-sexps-function + (lambda (arg) + ;; Here we should try to simulate the behavior of + ;; (cons (progn (forward-sexp x) (point)) + ;; (progn (forward-sexp (- x)) (point))) + ;; Except that we don't want to rely on the second forward-sexp + ;; putting us back to where we want to be, since forward-sexp-function + ;; might do funny things like infix-precedence. + (if (if (> arg 0) + (looking-at "\\sw\\|\\s_") + (and (not (bobp)) + (save-excursion + (forward-char -1) + (looking-at "\\sw\\|\\s_")))) + ;; Jumping over a symbol. We might be inside it, mind you. + (progn (funcall (if (> arg 0) + #'skip-syntax-backward #'skip-syntax-forward) + "w_") + (cons (save-excursion (forward-sexp arg) (point)) (point))) + ;; Otherwise, we're between sexps. Take a step back before jumping + ;; to make sure we'll obey the same precedence no matter which + ;; direction we're going. + (funcall (if (> arg 0) #'skip-syntax-backward #'skip-syntax-forward) + " .") + (cons (save-excursion (forward-sexp arg) (point)) + (progn (while (or (forward-comment (if (> arg 0) 1 -1)) + (not (zerop (funcall (if (> arg 0) + #'skip-syntax-forward + #'skip-syntax-backward) + "."))))) + (point)))))) arg 'special))) (defun transpose-lines (arg) @@ -8509,19 +8518,23 @@ transpose-lines ;; FIXME document SPECIAL. (defun transpose-subr (mover arg &optional special) "Subroutine to do the work of transposing objects. -Works for lines, sentences, paragraphs, etc. MOVER is a function that -moves forward by units of the given object (e.g. `forward-sentence', -`forward-paragraph'). If ARG is zero, exchanges the current object -with the one containing mark. If ARG is an integer, moves the -current object past ARG following (if ARG is positive) or -preceding (if ARG is negative) objects, leaving point after the -current object." - (let ((aux (if special mover - (lambda (x) - (cons (progn (funcall mover x) (point)) - (progn (funcall mover (- x)) (point)))))) - pos1 pos2) +Works for lines, sentences, paragraphs, etc. MOVER is either a +function that moves forward by units of the given +object (e.g. `forward-sentence', `forward-paragraph'), or a +function that calculates a cons of two position-pairs. If ARG is +zero, exchanges the current object with the one containing mark. +If ARG is an integer, moves the current object past ARG +following (if ARG is positive) or preceding (if ARG is negative) +objects, leaving point after the current object." + (let* ((aux (if special mover + (lambda (x) + (cons (progn (funcall mover x) (point)) + (progn (funcall mover (- x)) (point)))))) + (pos1 (save-excursion (funcall aux arg))) + pos2) (cond + ((and (consp (car pos1)) (consp (cdr pos1))) + (transpose-subr-1 (car pos1) (cdr pos1))) ((= arg 0) (save-excursion (setq pos1 (funcall aux 1)) diff --git a/lisp/treesit.el b/lisp/treesit.el index cefbed1a16..9f0965ac68 100644 --- a/lisp/treesit.el +++ b/lisp/treesit.el @@ -1582,6 +1582,27 @@ treesit-search-forward-goto (goto-char current-pos))) node)) +(defun treesit-transpose-sexps (&optional arg) + "Tree-sitter `transpose-sexps' function. +Arg is the same as in `transpose-sexps'. + +Return a pair of positions describing the regions to transpose +for use in `transpose-subr' and friends." + (let* ((parent (treesit-node-parent (treesit-node-at (point)))) + (child (treesit-node-child parent 0 t))) + (named-let loop ((prev child) + (next (treesit-node-child + parent (+ arg (treesit-node-index child t)) + t))) + (if (< (point) (or (treesit-node-end next) + (user-error "Don't have two things to transpose"))) + (cons (cons (treesit-node-start prev) + (treesit-node-end prev)) + (cons (treesit-node-start next) + (treesit-node-end next))) + (loop (treesit-node-next-sibling prev t) + (treesit-node-next-sibling next t)))))) + ;;; Navigation, defun, things ;; ;; Emacs lets you define "things" by a regexp that matches the type of @@ -2111,7 +2132,8 @@ treesit-major-mode-setup ;; Defun name. (when treesit-defun-name-function (setq-local add-log-current-defun-function - #'treesit-add-log-current-defun))) + #'treesit-add-log-current-defun)) + (setq-local transpose-sexps-function #'treesit-transpose-sexps)) ;;; Debugging -- 2.34.1 --=-=-=--