From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id ojeHHqbzEWDZQwAA0tVLHw (envelope-from ) for ; Wed, 27 Jan 2021 23:13:42 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2 with LMTPS id gPHYGabzEWA9YwAAB5/wlQ (envelope-from ) for ; Wed, 27 Jan 2021 23:13:42 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 45B399404C2 for ; Wed, 27 Jan 2021 23:13:42 +0000 (UTC) Received: from localhost ([::1]:45116 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l4u0L-0007OY-7j for larch@yhetil.org; Wed, 27 Jan 2021 18:13:41 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:34160) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l4tzv-0007OG-D0 for emacs-orgmode@gnu.org; Wed, 27 Jan 2021 18:13:15 -0500 Received: from mout-p-102.mailbox.org ([80.241.56.152]:63796) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_CHACHA20_POLY1305:256) (Exim 4.90_1) (envelope-from ) id 1l4tzs-000524-AI for emacs-orgmode@gnu.org; Wed, 27 Jan 2021 18:13:14 -0500 Received: from smtp2.mailbox.org (smtp2.mailbox.org [IPv6:2001:67c:2050:105:465:1:2:0]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (P-384) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by mout-p-102.mailbox.org (Postfix) with ESMTPS id 4DQzsw2NFZzQkm3; Thu, 28 Jan 2021 00:13:08 +0100 (CET) X-Virus-Scanned: amavisd-new at heinlein-support.de Received: from smtp2.mailbox.org ([80.241.60.241]) by spamfilter01.heinlein-hosting.de (spamfilter01.heinlein-hosting.de [80.241.56.115]) (amavisd-new, port 10030) with ESMTP id 29ESeiTqahXW; Thu, 28 Jan 2021 00:13:05 +0100 (CET) From: Kevin Foley To: Kyle Meyer Subject: Re: [PATCH] Org Agenda Support Argument Collection for Custom Bulk Functions (was: Custom Bulk Functions With Prompt) In-Reply-To: <87zh11sfnu.fsf@kyleam.com> References: <871rekxgpf.fsf@localhost> <87lfcrvvro.fsf@localhost> <878s8qwrvb.fsf@localhost> <87v9bsumpb.fsf@localhost> <87zh11sfnu.fsf@kyleam.com> Date: Wed, 27 Jan 2021 18:13:01 -0500 Message-ID: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-MBO-SPAM-Probability: X-Rspamd-Score: -6.81 / 15.00 / 15.00 X-Rspamd-Queue-Id: 31D901726 X-Rspamd-UID: ef7fe5 Received-SPF: pass client-ip=80.241.56.152; envelope-from=kevin@kevinjfoley.me; helo=mout-p-102.mailbox.org X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: emacs-orgmode@gnu.org, Ihor Radchenko Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -4.00 Authentication-Results: aspmx1.migadu.com; none X-Migadu-Queue-Id: 45B399404C2 X-Spam-Score: -4.00 X-Migadu-Scanner: scn1.migadu.com X-TUID: yr1sDT0ea2uK --=-=-= Content-Type: text/plain Kyle Meyer writes: Thanks for the review Kyle. > nit: No ":" after "lisp/org-agenda.el". Fixed. > Drop either "about" or "for"? Fixed. > In addition to the NEWS entry that Ihor mentioned, it looks like an > update to the manual is missing. NEWS entry added. With regard to the manual, the custom bulk function option is only mentioned as a footnote. I'm happy to add a more in depth explanation, however I'm not sure where it should go, any recommendations? > s/it's/its/ Fixed. > Should this :type be updated? Updated. I went with list with and optional second element for the argument collection function (I also updated my patch to handle a nil second argument). I think it makes sense to encourage use of the list even when not using an argument collection function but let me know if you think a choice between function and list would be better. > Please update this version, or rather drop :version and add > :package-version '(Org . "9.5") Updated. Thanks, Kevin --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-org-agenda.el-Support-argument-collection-for-custom.patch >From 1d09a90abcb4136a3cf7562870f7eda831f163d3 Mon Sep 17 00:00:00 2001 From: "Kevin J. Foley" Date: Thu, 21 Jan 2021 08:48:52 -0500 Subject: [PATCH] org-agenda.el: Support argument collection for custom bulk functions * lisp/org-agenda.el (org-agenda-bulk-custom-functions): Add documentation about argument collection for custom bulk functions. (org-agenda-bulk-action): Support function to collect arguments for custom bulk functions. * etc/ORG-NEWS (Option ~org-agenda-bulk-custom-functions~ now supports collecting bulk arguments): Add entry to NEWS. --- etc/ORG-NEWS | 7 ++++++- lisp/org-agenda.el | 29 +++++++++++++++++++++++++---- 2 files changed, 31 insertions(+), 5 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 5e5f1954d..4958d2b2e 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -81,8 +81,13 @@ block. ~org-babel-latex-preamble~, ~org-babel-latex-begin-env~ and the user to specify the preamble and code that preceedes and proceeds the contents of the source block. +*** Option ~org-agenda-bulk-custom-functions~ now supports collecting bulk arguments + +When specifying a custom agenda bulk option, you can now also specify a function which collects the arguments to be used with each call to the custom function. + + ** New features -*** =ob-python= improvements to =:return= header argument +*** =ob-python= improvements to =:return= header argument The =:return= header argument in =ob-python= now works for session blocks as well as non-session blocks. Also, it now works with the diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index dedf7e5bb..c5c1b54ba 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -2080,9 +2080,25 @@ (defcustom org-agenda-bulk-custom-functions nil With selected entries in an agenda buffer, `B R' will call the custom function `set-category' on the selected entries. -Note that functions in this alist don't need to be quoted." - :type '(alist :key-type character :value-type (group function)) - :version "24.1" +Note that functions in this alist don't need to be quoted. + +If the custom function accepts arguments which you'd like to +collect once from the user to be used for each call, you can pass +a list with the bulk function, and the function which collects +its arguments and returns them as a list. For example: + + \\='((?R (set-category get-category)) + (?C bulk-cut)) + +Now, `B R' will call the custom `get-category' which would prompt +the user once for a category. That category is then passed as an +argument to `set-category' for each entry it's called against. +" + :type '(alist :key-type character + :value-type (list (function :tag "Bulk Custom Function") + (choice (const :tag "No Bulk Custom Argument Function" nil) + (function :tag "Bulk Custom Argument Function")))) + :package-version '(Org . "9.5") :group 'org-agenda) (defmacro org-agenda-with-point-at-orig-entry (string &rest body) @@ -10487,7 +10503,12 @@ (defun org-agenda-bulk-action (&optional arg) (action (pcase (assoc action org-agenda-bulk-custom-functions) - (`(,_ ,f) (setq cmd f) (setq redo-at-end t)) + (`(,_ ,f) + (when (listp f) + (let ((args (when (nth 1 f) (funcall (nth 1 f)))) + (func (nth 0 f))) + (setq f (apply #'apply-partially func args)))) + (setq cmd f) (setq redo-at-end t)) (_ (user-error "Invalid bulk action: %c" action))))) ;; Sort the markers, to make sure that parents are handled -- 2.28.0 --=-=-=--