From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id +MO5ET531GLaBAAAbAwnHQ (envelope-from ) for ; Sun, 17 Jul 2022 22:55:26 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id 0HDBET531GJUFgEA9RJhRA (envelope-from ) for ; Sun, 17 Jul 2022 22:55:26 +0200 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 095293C86C for ; Sun, 17 Jul 2022 22:55:25 +0200 (CEST) Received: from localhost ([::1]:52528 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oDBIQ-0004G3-Iv for larch@yhetil.org; Sun, 17 Jul 2022 16:55:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:42680) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oDBH6-0004Fd-Eu for emacs-orgmode@gnu.org; Sun, 17 Jul 2022 16:54:00 -0400 Received: from [2a01:c0:2:6:225:90ff:fed2:2b47] (port=39611 helo=mail.oa5.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oDBGz-00058K-9O for emacs-orgmode@gnu.org; Sun, 17 Jul 2022 16:54:00 -0400 Received: from hugoLaptop (localhost.localdomain [127.0.0.1]) hugo@heagren.com (authenticated bits=0) by mail.oa5.com (8.14.4/8.12.11) with ESMTP id 26HKrfp0023616 sender hugo@heagren.com ; Sun, 17 Jul 2022 21:53:43 +0100 DKIM-Signature: v=1; a=rsa-sha1; c=relaxed/relaxed; d=heagren.com; h= Message-ID:From:Subject:Date:To:MIME-Version:Content-Type; s= 202207; bh=l1quSHFMHqjqcwm0Ebz/zfR04Kc=; b=DzkMjbFaosg34DCvs8oVB jMhqJTlQBKeK/pMXQ10FrB5dsIpK+eZ5FSURiy8/JwupdQRoNPng+mpfi+hrsa/4 oqgsrXzwsyXJdnWj5YglnArufAAMMzRWgl+soUlm6OxH7hONvq0cMngKu7/tTezR pHpmepDIge3wI6fVFUDOWqfzY5KYRp8g1vvykmrLWjGLBooSTM4iE7GlykrzpaeO HGE6GYmrNsbMSJKCdh7C+7Gk2nyhFlcCB1+5t+5G3Cr X-Assp-Version: 2.6.7(22137) on ASSP.OA5.COM X-Assp-ID: ASSP.OA5.COM X-Assp-Session: CEBC8A8 (mail 1) X-Assp-Envelope-From: hugo@heagren.com X-Assp-Intended-For: manikulin@gmail.com X-Assp-Intended-For: yantar92@gmail.com X-Assp-Intended-For: emacs-orgmode@gnu.org X-Assp-Client-TLS: yes Received: from global-5-156.n-2.net.cam.ac.uk ([131.111.5.156] helo=hugoLaptop) by ASSP.OA5.COM with SMTPSA(TLSv1_2 ECDHE-RSA-AES128-GCM-SHA256) (2.6.7); 17 Jul 2022 21:53:41 +0100 From: Hugo Heagren To: emacs-orgmode@gnu.org Cc: Ihor Radchenko , Max Nikulin Subject: Re: [PATCH v6] ol.el: add description format parameter to org-link-parameters References: <87zgl1npow.fsf@localhost> <20220405192931.6747-1-hugo@heagren.com> <87a6cx79xn.fsf@localhost> <87zgi6fckr.fsf@heagren.com> <871qvixhfw.fsf@gmail.com> <87v8s8n1bm.fsf@heagren.com> <87let39d3c.fsf@localhost> <877d4flu3x.fsf@heagren.com> <87cze5e84m.fsf@localhost> <87tu7gkb4l.fsf@heagren.com> <87y1ws6o0c.fsf@localhost> Date: Sun, 17 Jul 2022 21:59:14 +0100 Message-ID: <87k08bjw0t.fsf@heagren.com> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Host-Lookup-Failed: Reverse DNS lookup failed for 2a01:c0:2:6:225:90ff:fed2:2b47 (failed) Received-SPF: pass client-ip=2a01:c0:2:6:225:90ff:fed2:2b47; envelope-from=hugo@heagren.com; helo=mail.oa5.com X-Spam_score_int: -12 X-Spam_score: -1.3 X-Spam_bar: - X-Spam_report: (-1.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RDNS_NONE=0.793, SPF_HELO_PASS=-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-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: "Emacs-orgmode" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1658091326; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=xRUqRSXOQHKU3aG8imA909lzUPrE0S62rouqN+LNA7c=; b=qjfcyiJHVPbG+dEt3p2H/h2N14v6LzQvtgAzyXOWHCTiMxxNCYqKqoqyD9N0N/LhKecGZs jBEFptXIMoY6ZsiFOEn5hIk/Mj4gNbO56EQbHGyVnoxlR6ck2pBTYC6X20fTSEuBqF1Lpl 4/VEQe2JT8GaB24cO8oW4D3SxBTUvkmpgQj0Rb0QjG3+SPVF4JnD7E3Rh4aJIgCu7dniWE yNvitXqpmJ6fbWVFfZzs+T+2J7byabfTttYNBCRgMf5mZGDJRGmC718stNZIH2kmpmuPyl qGyKRjLjJCLzb7hgfcjDH7wj0y2lLgAcsH8tKaTogviTwPxBACtC6WkPRbSnaw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1658091326; a=rsa-sha256; cv=none; b=JDFFMATjC9ZEQyGvwajTR4bd7YcAKhyzTTjeCeG4DIz9fhBvkB9nNlkVl6gBinIHlubUcw bHIqBP0A/bTVC9WC6iTrDypWcWVBBF2P0hehVh1TOEu8mG3icjvWr2X3HoXLmo85v5M0Gp 1lDlJJgRD3zO7/ottW/eXCguwMuAYaYy3ehcenaf2weqJfgK805WYSskV0bS0Wq0ySHJxv 2nvHYtRbLhbO9Xq+gxGJvc7WhrGSQxVT94uCKIECCIFtk6eHMdYX5a2hzvdNCKVCOTCyYx LQIhmw5s9+gI3QfeGUjnYu2pBAkfiueX0pDRZhm8arADK0G7V6Ym3LJ3A1+ZNQ== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=heagren.com header.s=202207 header.b=DzkMjbFa; dmarc=fail reason="SPF not aligned (relaxed)" header.from=heagren.com (policy=quarantine); spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: 6.00 X-Spam: Yes Authentication-Results: aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=heagren.com header.s=202207 header.b=DzkMjbFa; dmarc=fail reason="SPF not aligned (relaxed)" header.from=heagren.com (policy=quarantine); spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 095293C86C X-Spam-Score: 6.00 X-Migadu-Spam: Yes X-Migadu-Scanner: scn0.migadu.com X-TUID: AJ/ZJzqV3YRX --=-=-= Content-Type: text/plain Content-Disposition: inline On 17/07/2022 04:20, Ihor Radchenko wrote: > The return value of org-link-make-description-function can also be nil > in addition to string. I suggest documenting this, just as you did for > :insert-description parameter. Ah I understand. Done. Also updated the changelog commit message to reflect the new documentation. On 17/07/2022 04:20, Max Nikulin wrote: > See info "(elisp) Indenting Macros". I understand now. Fixed in this version. Thanks for clarifying. > In addition to changing behavior, you decision is still a trade-off. > Consider the case when, editing some link, a user changes link path > and expects to get new default description. Yes, I see what you mean. I suppose that without a user option or similar to control this behaviour, it will always be a trade-off. I think the behaviour I have written makes the most sense, and as you say, a solution to completely resolve it might be unwieldy. If someone else really wants different behaviour I suppose they can submit a patch. > You do not check that `org-link-make-description-function' is not nil. This is a good point. I've substituted `org-link-make-description-function' for `t', which has exactly the effect of only running that clause if `org-link-make-description-function' is not nil. This also means that in the case where `:insert-description' *and* `org-link-make-description-function' are both nil then the user won't get a 2-second error message. Since this configuration is the default state which ships with org, an error message seems rather odd, so this is probably a good result! This also means that if we reach that clause and `org-link-make-description-function' *is* nil, then the whole `cond' just returns nil, and so the link inserted with no default description, which makes sense to me. > You might even add a test for such configuration (no > :insert-description is defined). Good idea. Done in the latest version. Thanks, Hugo --=-=-= Content-Type: text/x-diff Content-Disposition: attachment; filename=0002-test-ol-tests-for-insert-description-param-when-inse.patch >From fbe030ad3a2aafd09d491aefb9c56242b7ec669b Mon Sep 17 00:00:00 2001 From: Hugo Heagren Date: Sat, 16 Jul 2022 19:50:15 +0100 Subject: [PATCH] test-ol: tests for insert-description param when inserting links * test-ol (test-ol-with-link-parameters-as): Convenience macro for testing. (test-ol-insert-link-get-desc): Convenience macro for testing. (test-ol/return-foobar): Convenience function for testing. (test-ol/insert-link-insert-description): Test for various values of `:insert-description' in `org-link-parameters' (including `test-ol/return-foobar'). --- testing/lisp/test-ol.el | 97 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/testing/lisp/test-ol.el b/testing/lisp/test-ol.el index 429bb52ee..a3aa302c3 100644 --- a/testing/lisp/test-ol.el +++ b/testing/lisp/test-ol.el @@ -19,6 +19,8 @@ ;;; Code: +(require 'cl-lib) + ;;; Decode and Encode Links @@ -625,5 +627,100 @@ See https://github.com/yantar92/org/issues/4." (test-ol-parse-link-in-text "The http://foo.com/(something)?after=parens link")))) +;;; Insert Links + +(defmacro test-ol-with-link-parameters-as (type parameters &rest body) + "Pass TYPE/PARAMETERS to `org-link-parameters' and execute BODY. + +Save the original value of `org-link-parameters', execute +`org-link-set-parameters' with the relevant args, execute BODY +and restore `org-link-parameters'. + +TYPE is as in `org-link-set-parameters'. PARAMETERS is a plist to +be passed to `org-link-set-parameters'." + (declare (indent 2)) + (let (orig-parameters) + ;; Copy all keys in `parameters' and their original values to + ;; `orig-parameters'. + (map-do + (lambda (key _) (setq orig-parameters + (plist-put + orig-parameters key + (org-link-get-parameter type key)))) + parameters) + `(unwind-protect + ;; Set `parameters' values and execute body. + (progn (org-link-set-parameters ,type ,@parameters) ,@body) + ;; Restore original values. + (apply 'org-link-set-parameters ,type ',orig-parameters)))) + +(defun test-ol-insert-link-get-desc (&optional link-location description) + "Insert link in temp buffer, return description. + +LINK-LOCATION and DESCRIPTION are passed to +`org-insert-link' (COMPLETE-FILE is always nil)." + (org-test-with-temp-text "" + (org-insert-link nil link-location description) + (save-match-data + (when (and + (org-in-regexp org-link-bracket-re 1) + (match-end 2)) + (match-string-no-properties 2))))) + +(defun test-ol/return-foobar (_link-test _desc) + "Return string \"foobar\". + +Take (and ignore) arguments conforming to `:insert-description' +API in `org-link-parameters'. Used in test +`test-ol/insert-link-insert-description', for the case where +`:insert-description' is a function symbol." + "foobar") + +(ert-deftest test-ol/insert-link-insert-description () + "Test `:insert-description' parameter handling." + ;; String case. + (should + (string= + "foobar" + (test-ol-with-link-parameters-as + "id" (:insert-description "foobar") + (test-ol-insert-link-get-desc "id:foo-bar")))) + ;; Lambda case. + (should + (string= + "foobar" + (test-ol-with-link-parameters-as + "id" (:insert-description (lambda (_link-test _desc) "foobar")) + (test-ol-insert-link-get-desc "id:foo-bar")))) + ;; Function symbol case. + (should + (string= + "foobar" + (test-ol-with-link-parameters-as + "id" (:insert-description #'test-ol/return-foobar) + (test-ol-insert-link-get-desc "id:foo-bar")))) + ;; `:insert-description' parameter is defined, but doesn't return a + ;; string. + (should + (null + (test-ol-with-link-parameters-as + "id" (:insert-description #'ignore) + (test-ol-insert-link-get-desc "id:foo-bar")))) + ;; Description argument should override `:insert-description'. + (should + (string= + "notfoobar" + (test-ol-with-link-parameters-as + "id" (:insert-description "foobar") + (test-ol-insert-link-get-desc "id:foo-bar" "notfoobar")))) + ;; When neither `:insert-description' nor + ;; `org-link-make-description-function' is defined, there should be + ;; no description + (should + (null + (let ((org-link-make-description-function nil) + (org-link-parameters nil)) + (test-ol-insert-link-get-desc "id:foo-bar"))))) + (provide 'test-ol) ;;; test-ol.el ends here -- 2.20.1 --=-=-= Content-Type: text/x-diff; charset=utf-8 Content-Disposition: attachment; filename=0001-ol.el-add-description-format-parameter-to-org-link-p.patch Content-Transfer-Encoding: quoted-printable >From 4f6868175fc8204a5a1e7fd5a9ae430ff760a96d Mon Sep 17 00:00:00 2001 From: Hugo Heagren Date: Mon, 28 Mar 2022 23:18:45 +0100 Subject: [PATCH] ol.el: add description format parameter to org-link-parameters * ol.el (org-link-parameters): Add parameter `:insert-description', a string or a function. * (org-insert-link): If no description is provided (pre-existing or as an argument), next option is to use the `:insert-description' (if non-nil) parameter to generate one. * (org-link-make-description-function): Add documentation to describe behaviour of nil return value, like that of `:insert-description'. Default descriptions are predictable within a link type, but because link types are quite diverse, are NOT predictable across many types. A type-parameter is thus a good place to store information on the default description. --- etc/ORG-NEWS | 7 +++++ lisp/ol.el | 78 ++++++++++++++++++++++++++++++++++++++-------------- 2 files changed, 64 insertions(+), 21 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index 35af94f92..86128d100 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -322,6 +322,13 @@ purpose of the variable. The replacement variable accepts =3Dlistings=3D and =3Dverbatim=3D in place of =3Dt=3D and =3Dnil= =3D (which still work, but are no longer listed as valid options). =20 +*** ~org-link-parameters~ has a new ~:insert-description~ parameter + +The value of ~:insert-description~ is used as the initial input when +prompting for a link description. It can be a string (used as-is) or +a function (called with the same arguments as +~org-make-link-description-function~ to return a string to use). + * Version 9.5 =20 ** Important announcements and breaking changes diff --git a/lisp/ol.el b/lisp/ol.el index d4bd0e40c..f49105e17 100644 --- a/lisp/ol.el +++ b/lisp/ol.el @@ -141,6 +141,18 @@ link. Function that inserts a link with completion. The function takes one optional prefix argument. =20 +`:insert-description' + + String or function used as a default when prompting users for a + link's description. A string is used as-is, a function is + called with two arguments: the full link text, and the + description generated by `org-insert-link'. It should return + the description to use (this reflects the behaviour of + `org-link-make-description-function'). If it returns nil, no + default description is used, but no error is thrown (from the + user's perspective, this is equivalent to a default description + of \"\"). + `:display' =20 Value for `invisible' text property on the hidden parts of the @@ -200,7 +212,9 @@ You can interactively set the value of this variable by= calling This function must take two parameters: the first one is the link, the second one is the description generated by `org-insert-link'. The function should return the description to -use." +use. If it returns nil, no default description is used, but no +error is thrown (from the user=E2=80=99s perspective, this is equivalent +to a default description of \"\")." :group 'org-link :type '(choice (const nil) (function)) :safe #'null) @@ -1804,11 +1818,14 @@ prefix negates `org-link-keep-stored-after-insertio= n'. If the LINK-LOCATION parameter is non-nil, this value will be used as the link location instead of reading one interactively. =20 -If the DESCRIPTION parameter is non-nil, this value will be used as the -default description. Otherwise, if `org-link-make-description-function' -is non-nil, this function will be called with the link target, and the -result will be the default link description. When called non-interactivel= y, -don't allow to edit the default description." +If the DESCRIPTION parameter is non-nil, this value will be used +as the default description. If not, and the chosen link type has +a non-nil `:insert-description' parameter, that is used to +generate a description as described in `org-link-parameters' +docstring. Otherwise, if `org-link-make-description-function' is +non-nil, this function will be called with the link target, and +the result will be the default link description. When called +non-interactively, don't allow to edit the default description." (interactive "P") (let* ((wcf (current-window-configuration)) (origbuf (current-buffer)) @@ -1818,7 +1835,10 @@ don't allow to edit the default description." (desc region) (link link-location) (abbrevs org-link-abbrev-alist-local) - entry all-prefixes auto-desc) + (all-prefixes (append (mapcar #'car abbrevs) + (mapcar #'car org-link-abbrev-alist) + (org-link-types))) + entry auto-desc) (cond (link-location) ; specified by arg, just use it. ((org-in-regexp org-link-bracket-re 1) @@ -1859,9 +1879,6 @@ Use TAB to complete link prefixes, then RET for type-= specific completion support (unless (pos-visible-in-window-p (point-max)) (org-fit-window-to-buffer)) (and (window-live-p cw) (select-window cw)))) - (setq all-prefixes (append (mapcar #'car abbrevs) - (mapcar #'car org-link-abbrev-alist) - (org-link-types))) (unwind-protect ;; Fake a link history, containing the stored links. (let ((org-link--history @@ -1958,17 +1975,36 @@ Use TAB to complete link prefixes, then RET for typ= e-specific completion support (setq desc path))))) =20 (unless auto-desc - (let ((initial-input - (cond - (description) - ((not org-link-make-description-function) desc) - (t (condition-case nil - (funcall org-link-make-description-function link desc) - (error - (message "Can't get link description from %S" - (symbol-name org-link-make-description-function)) - (sit-for 2) - nil)))))) + (let* ((type + (cond + ((string-match (rx-to-string `(: string-start (submatch (or= ,@all-prefixes)) ":")) link) + (match-string 1 link)) + ((file-name-absolute-p link) "file") + ((string-match "\\`\\.\\.?/" link) "file"))) + (initial-input + (cond + (description) + (desc) + ((org-link-get-parameter type :insert-description) + (let ((def (org-link-get-parameter type :insert-descriptio= n))) + (condition-case nil + (cond + ((stringp def) def) + ((functionp def) + (funcall def link desc))) + (error + (message "Can't get link description from org link pa= rameter `:insert-description': %S" + def) + (sit-for 2) + nil)))) + (org-link-make-description-function + (condition-case nil + (funcall org-link-make-description-function link desc) + (error + (message "Can't get link description from %S" + org-link-make-description-function) + (sit-for 2) + nil)))))) (setq desc (if (called-interactively-p 'any) (read-string "Description: " initial-input) initial-input)))) --=20 2.20.1 --=-=-=--