emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Public API change: How to handle function signature change gracefully
@ 2020-04-19  6:42 Benjamin Andresen via General discussions about Org-mode.
  2020-04-21 17:57 ` Nicolas Goaziou
  0 siblings, 1 reply; 4+ messages in thread
From: Benjamin Andresen via General discussions about Org-mode. @ 2020-04-19  6:42 UTC (permalink / raw)
  To: emacs-orgmode

Hello everyone,

I would like to change the public API of the :face part of `org-link-set-parameters':

        (org-link-set-parameters "file" :face 'org-link)

My ultimate goal is to have org-links be able to be have their face changed based on the contents, not just the path of the link.

I found the relevant code in org.el in the function `org-activate-links':

   'face (pcase (org-link-get-parameter type :face)
   ((and (pred functionp) face) (funcall face path))
   ((and (pred facep) face) face)
   ((and (pred consp) face) face) ;anonymous
   (_ 'org-link))

and would like to change this to 

   'face (pcase (org-link-get-parameter type :face)
   ((and (pred functionp) face) (funcall face path contents)) ;; this is the change
   ((and (pred facep) face) face)
   ((and (pred consp) face) face) ;anonymous
   (_ 'org-link))

Now that will introduce a host of call issues because the callees don't expect to the amount of arguments changed under their bottom.

I would like some guidance how I could get what I think is neat: The contents of the bracket-style links as an additional parameter to set faces on and not breaking existing hookups.

I'm thinking to change the above code to look at the callee's function signature and checking how many arguments it accepts and then use the right funcall for the situation.

To make this more palatable I would suggest it's changed so that the 2nd argument will be a list of alists or keywords so to not have this function signature problem if someone else comes up with a reason to introduce yet more data.

Thanks in advance,
Benjamin Andresen


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-04-21 21:58 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-19  6:42 Public API change: How to handle function signature change gracefully Benjamin Andresen via General discussions about Org-mode.
2020-04-21 17:57 ` Nicolas Goaziou
2020-04-21 20:07   ` John Kitchin
     [not found]   ` <CAJ51ETrUxoWoraMxKTCRnzNxtmj5kwVWBAWvAeL1PSZvJs5hjw@mail.gmail.com-M5TLt9R----2>
2020-04-21 21:56     ` Benjamin Andresen via General discussions about Org-mode.

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).