From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?utf-8?Q?Barra_=C3=93_Cath=C3=A1in?= via "Emacs development discussions." Newsgroups: gmane.emacs.devel Subject: [PATCH] Add "into-register" functions for buffers and files. Date: Sat, 03 Feb 2024 23:55:32 +0000 Message-ID: <87y1c1f6h7.fsf@ocathain.ie> Reply-To: =?utf-8?Q?Barra_=C3=93_Cath=C3=A1in?= 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="39298"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) To: emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Feb 04 01:06:02 2024 Return-path: Envelope-to: ged-emacs-devel@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 1rWQ1J-0009yy-AA for ged-emacs-devel@m.gmane-mx.org; Sun, 04 Feb 2024 01:06:02 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rWQ0X-0007wZ-FB; Sat, 03 Feb 2024 19:05:14 -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 1rWQ0U-0007wH-Vs for emacs-devel@gnu.org; Sat, 03 Feb 2024 19:05:11 -0500 Original-Received: from abi149bb127.cwl1.oracleemaildelivery.com ([129.149.22.127]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rWQ0S-0008VO-KU for emacs-devel@gnu.org; Sat, 03 Feb 2024 19:05:10 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; s=ocathain-2023-02-08; d=ocathain.ie; h=Date:To:From:Subject:Message-Id:MIME-Version:Sender; bh=++YlI8U1SBkIG5yTKNhp6LsEVxorRrhs6iMCzkOmKgE=; b=lkbCAQVDUiI1v71NaKHnyWh30cRHbDOjmkd3bHpGKdZGFbh1O8A/x5Z2Rep6cazxUw8xzGSHS+JN fKhikvh7kfz2TDBGcbWXAtjf8gAvG9uu7/q3V4i41fDCxanCysBgWJtZkcUygzZVY52tl/FEg0hF EkZwgP2NFMIxMcnFIDpt7IX5LJcHZ3RcrQVx0GEsRTE19BPSkDH8yo67kf9chURXSfxhfZAll+ma yY+F6wGP9cBXnETfFnBYJDLJpethmejjctdelGhEyR1GOWEqsEhD27Skf7mmqaSFKWGAlLaa+2ZR MfgYJ1w73teri18txq1KXhYMu6wo2t1CAEmLIw== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; s=prod-cwl-20201026; d=cwl1.rp.oracleemaildelivery.com; h=Date:To:From:Subject:Message-Id:MIME-Version:Sender; bh=++YlI8U1SBkIG5yTKNhp6LsEVxorRrhs6iMCzkOmKgE=; b=gueGcIf/rCAMiOXXJVtL6ehMna5fY4r2Jk4/9A/zghP1Eq96jVmB2fGLrIXkr7Fi0jHwRR4Rw6Be Is3mIe5YUpxkzXM5ENws2/4Hr6LYM7H2zRI2xkY0nzye49vyfiJgehWm02wJ57x8tAh33roEDu2w ZK1ws5yP6PsnaJJRMpCiw0yaIrb/e1S4MVXoIEw7TnnJO4y1OLQIvxgXvSpg8i13tF1PoXy8P5b5 zA0CYekLGIQ73LiR13rV88LVcDwLAGAlT51aGGNWLKHu3QHbnxYpr4Y1LSY1TS/Fmy7vVnS2zGbM Nq33YIJjC/3CeAGrddd4w/Asl8Q68h++gtp3sA== Original-Received: by omta-ad1-fd3-101-uk-cardiff-1.omtaad1.vcndpcwl.oraclevcn.com (Oracle Communications Messaging Server 8.1.0.1.20231214 64bit (built Dec 14 2023)) with ESMTPS id <0S8B009O913QTV80@omta-ad1-fd3-101-uk-cardiff-1.omtaad1.vcndpcwl.oraclevcn.com> for emacs-devel@gnu.org; Sat, 03 Feb 2024 23:55:02 +0000 (GMT) Reporting-Meta: AAFm0rqB/U6XOkqXDU2p8HOuv9pjAOsNoFMQJ2bQVnQEEAHeXR0w2vyM5sWuf/5c xszzM4/C83A+LWZyz82eTPMiRm77JmQxNLWpJSgKgKwbxm0Q/oyF1gblii/zyUz0 O8f0D78J8OU+2EnvzZVbolpdNEA04ewOowRvATmTUsuw3ZEJ/tvjZ2AZyhfnWpdZ 8EjdnHNjXKgZ8zkpkVMcaezu0w9q3/eZVREb3LbtTdQx3LfsGvX9ckfd4+cClD85 N7ahGKh4dheMcR9XMSBANXq6z6DvR0yXkGus+ouRrhCzbQGz+uNW+PLyI8iOrnXr zvybbULg3EOFWfAXlBY/HXcIEPMuqvHoQZvGFGRmECySTVcIXksi+RbPkMBBkcXI LAjMTv23anTMDmtk9ASGDFFSeS1LiTXNVZ0xBLjPf89rh8hKWQ1RoXH2R/J+pOnN /Eu/AffjKKCeb5RoCkqF4v6BQj++f4swPEWkcqN+cwdkCX8vcxvH3rY= Received-SPF: pass client-ip=129.149.22.127; envelope-from=bounces+emacs-devel=gnu.org@cwl1.rp.oracleemaildelivery.com; helo=abi149bb127.cwl1.oracleemaildelivery.com X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.249, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:315844 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hello, all! I noticed that files and buffers don't have "to-register" functions of their own, rather, relying on (set-register). To that end, I have written 4 functions that I feel may be useful and "complete the set" of register functions, and some minor tweaks to the relevant manual section.=20 =3D=3D=3D=3D=3D Barra =C3=93 Cath=C3=A1in --=-=-= Content-Type: text/plain Content-Disposition: inline; filename=0001-Added-buffer-and-file-to-register-functions.patch >From d697dc8b3fb66fb3c37851ab1d33af665870ae1d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barra=20=C3=93=20Cath=C3=A1in?= Date: Fri, 2 Feb 2024 21:45:05 +0000 Subject: [PATCH 1/4] Added buffer and file to register functions. Added buffer-to-register, file-to-register, current-buffer-to-register, and current-file-to-register to register.el. --- lisp/register.el | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/lisp/register.el b/lisp/register.el index 822467a0d72..8fff867e547 100644 --- a/lisp/register.el +++ b/lisp/register.el @@ -685,6 +685,50 @@ Interactively, prompt for REGISTER using `register-read-with-preview'." (let ((val (get-register register))) (register-val-jump-to val delete))) +(defun file-to-register (register file-name) + "Inserts a given file into a register. To visit the file, use + \\[jump-to-register]. + +Called from Lisp, takes two args: REGISTER, and FILE-NAME. + +Interactively, prompt for REGISTER using `register-read-with-preview', +and prompt for FILE-NAME using `read-file-name'." + (interactive (list (register-read-with-preview "File to register: ") + (read-file-name "File: "))) + (set-register register `(file . ,file-name))) + +(defun current-file-to-register (register) + "Places the current file name into a register. To visit the file, use +\\[jump-to-register]. + +Called from Lisp, takes one arg: REGISTER. + +Interactively, prompt for REGISTER using `register-read-with-preview." + (interactive (list (register-read-with-preview "Current file to register: "))) + (set-register register `(file . ,(buffer-file-name)))) + +(defun buffer-to-register (register buffer) + "Inserts a given buffer into a register. To visit the buffer, use +\\[jump-to-register]. + +Called from Lisp, takes two args: REGISTER, and BUFFER. + +Interactively, prompt for REGISTER using `register-read-with-preview', and +prompt for BUFFER-NAME using `read-buffer'." + (interactive (list (register-read-with-preview "Buffer to register: ") + (read-buffer "Buffer: "))) + (set-register register `(buffer . ,buffer))) + +(defun current-buffer-to-register (register) + "Places the current buffer into a register. To visit the buffer, use +\\[jump-to-register]. + +Called from Lisp, takes one arg: REGISTER. + +Interactively, prompt for REGISTER using `register-read-with-preview.'" + (interactive (list (register-read-with-preview "Current buffer to register: "))) + (set-register register `(buffer . ,(current-buffer)))) + (cl-defgeneric register-val-jump-to (_val _arg) "Execute the \"jump\" operation of VAL. VAL is the contents of a register as returned by `get-register'. -- 2.43.0 --=-=-= Content-Type: text/plain Content-Disposition: inline; filename=0002-Added-bindings-for-the-new-to-register-functions.patch >From f53b313bbf9e033ca0aea9e1e1e4a547d6b5b194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barra=20=C3=93=20Cath=C3=A1in?= Date: Fri, 2 Feb 2024 22:28:44 +0000 Subject: [PATCH 2/4] Added bindings for the new "to register" functions Added bindings for "current-file-to-register" and "current-buffer-to-register" to bindings.el. --- lisp/bindings.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/bindings.el b/lisp/bindings.el index 4690897fed4..21767f37f61 100644 --- a/lisp/bindings.el +++ b/lisp/bindings.el @@ -1570,7 +1570,10 @@ if `inhibit-field-text-motion' is non-nil." "n" #'number-to-register "+" #'increment-register "w" #'window-configuration-to-register - "f" #'frameset-to-register) + "f" #'frameset-to-register + "F" #'current-file-to-register + "B" #'current-buffer-to-register) + (define-key ctl-x-map "r" ctl-x-r-map) (define-key esc-map "q" 'fill-paragraph) -- 2.43.0 --=-=-= Content-Type: text/plain Content-Disposition: inline; filename=0003-Basic-error-checking-for-new-register-functions.patch >From 23dcde96046a9edc04bca68579174300dde5cd44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barra=20=C3=93=20Cath=C3=A1in?= Date: Sat, 3 Feb 2024 20:34:45 +0000 Subject: [PATCH 3/4] Basic error checking for new register functions --- lisp/register.el | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lisp/register.el b/lisp/register.el index 8fff867e547..cfb3c6a2b13 100644 --- a/lisp/register.el +++ b/lisp/register.el @@ -695,7 +695,9 @@ Interactively, prompt for REGISTER using `register-read-with-preview', and prompt for FILE-NAME using `read-file-name'." (interactive (list (register-read-with-preview "File to register: ") (read-file-name "File: "))) - (set-register register `(file . ,file-name))) + (if (file-exists-p file-name) + (set-register register `(file . ,file-name))) + (user-error "File does not exist.") (defun current-file-to-register (register) "Places the current file name into a register. To visit the file, use @@ -717,7 +719,9 @@ Interactively, prompt for REGISTER using `register-read-with-preview', and prompt for BUFFER-NAME using `read-buffer'." (interactive (list (register-read-with-preview "Buffer to register: ") (read-buffer "Buffer: "))) - (set-register register `(buffer . ,buffer))) + (if (buffer-p buffer) + (set-register register `(buffer . ,buffer)) + (user-error "Not a buffer.")) (defun current-buffer-to-register (register) "Places the current buffer into a register. To visit the buffer, use -- 2.43.0 --=-=-= Content-Type: text/plain Content-Disposition: inline; filename=0004-Documentation-in-Info-for-new-register-commands.patch >From cf28598990cb374f6e3bedb0b5c49e0ccc861477 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Barra=20=C3=93=20Cath=C3=A1in?= Date: Sat, 3 Feb 2024 20:43:05 +0000 Subject: [PATCH 4/4] Documentation in Info for new register commands Simple modification to regs.texi to refer to the new register commands. --- doc/emacs/regs.texi | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/emacs/regs.texi b/doc/emacs/regs.texi index cac5b32c566..e9fb2c74773 100644 --- a/doc/emacs/regs.texi +++ b/doc/emacs/regs.texi @@ -291,11 +291,13 @@ numeric argument stores zero in the register. @cindex saving buffer name in a register If you visit certain file names frequently, you can visit them more -conveniently if you put their names in registers. Here's the Lisp code -used to put a file @var{name} into register @var{r}: +conveniently if you put their names in registers. You may use @kbd{C-x +r F} to place the currently visited file in a register. + +Here's the Lisp code used to put a file @var{name} into register @var{r}: @smallexample -(set-register @var{r} '(file . @var{name})) +(file-to-register @var{r} @var{name}) @end smallexample @need 3000 @@ -303,7 +305,7 @@ used to put a file @var{name} into register @var{r}: For example, @smallexample -(set-register ?z '(file . "/gd/gnu/emacs/19.0/src/ChangeLog")) +(file-to-register ?z "/gd/gnu/emacs/19.0/src/ChangeLog") @end smallexample @noindent @@ -314,12 +316,13 @@ puts the file name shown in register @samp{z}. restore a frame configuration.) Similarly, if there are certain buffers you visit frequently, you -can put their names in registers. For instance, if you visit the +can put their names in registers. You may use @kbd{C-x r B} to store +the current buffer in a register. Or, for instance, if you visit the @samp{*Messages*} buffer often, you can use the following snippet to put that buffer into the @samp{m} register: @smallexample -(set-register ?m '(buffer . "*Messages*")) +(buffer-to-register ?m "*Messages*") @end smallexample To switch to the buffer whose name is in register @var{r}, type -- 2.43.0 --=-=-=--