From: Kyle Meyer <kyle@kyleam.com>
To: Zhitao Gong <zhitaao.gong@gmail.com>, emacs-orgmode@gnu.org
Subject: Re: About org-sort -> org-sort-list with custom sort function
Date: Sat, 06 May 2017 22:55:15 -0400 [thread overview]
Message-ID: <87vapd5qb0.fsf@kyleam.com> (raw)
In-Reply-To: <87inlhhgvf.fsf@gmail.com>
Zhitao Gong <zhitaao.gong@gmail.com> writes:
> I think there is a bug in org-sort or org-sort-list function.
>
> If you call org-sort (C-c ^) on list items, this function will call
> org-sort-list. However, org-sort calls org-sort-list with only one
> argument, i.e., the with-case (see the code below)
>
> #+BEGIN_SRC emacs-lisp
> ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
> #+END_SRC emacs-lisp
org-sort actually isn't calling org-sort-list with one argument; it's
calling it interactively, while let-binding current-prefix-arg:
(defsubst org-call-with-arg (command arg)
"Call COMMAND interactively, but pretend prefix arg was ARG."
(let ((current-prefix-arg arg)) (call-interactively command)))
I'm a bit confused about why org-call-with-arg is necessary because I
think call-interactively already propagates the current prefix argument,
but perhaps I'm missing some subtlety here. Either way ...
> The problem is that if you choose ?f (sorting with custom key function),
> then org-sort-list expects another argument, the compare-func, which is
> not passed to it.
>
> IMHO, there are two ways to solve this
>
> 1. Ask for the compare-func in org-sort-list, as it does for the
> getkey-func. A default value could be provided for compare-func,
> e.g., string<, <, etc. Or
> 2. Restrict the return type to a string (or integer) so that we could
> fix the compare-func
I see it as a documentation issue. org-sort-list's docstring doesn't
make it clear which part of the description applies to an interactive
caller versus a Lisp caller. An interactive caller can choose the ?f
sorting type, but they can't specify the compare-func. Entries are
compared using sort-subr's default comparison behavior (see its
docstring), and getkey-func has to return a value that's compatible with
this behavior.
And I think it's OK to not expose compare-func to the interactive
caller. In cases where sort-subr's default behavior won't do and a user
wants to supply a value for compare-func, they can create their own
command that wraps a non-interactive org-sort-list call.
What do you think?
--
Kyle
next prev parent reply other threads:[~2017-05-07 2:55 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-05-03 19:36 About org-sort -> org-sort-list with custom sort function Zhitao Gong
2017-05-07 2:55 ` Kyle Meyer [this message]
2017-05-07 10:00 ` Nicolas Goaziou
2017-05-07 14:20 ` Kyle Meyer
2017-05-07 15:37 ` Kyle Meyer
2017-05-08 9:48 ` Nicolas Goaziou
2017-05-08 15:24 ` Kyle Meyer
2017-05-08 16:23 ` Nicolas Goaziou
2017-05-08 16:45 ` Kyle Meyer
2017-05-08 16:48 ` Nicolas Goaziou
2017-05-09 19:47 ` [PATCH] org-sort: Read compare-func in interactive calls Kyle Meyer
2017-05-11 21:47 ` Nicolas Goaziou
2017-05-12 1:48 ` Kyle Meyer
2017-05-12 7:10 ` Nicolas Goaziou
2017-05-13 14:50 ` [PATCH v2] " Kyle Meyer
2017-05-14 8:24 ` Nicolas Goaziou
2017-05-14 13:45 ` Kyle Meyer
2017-05-14 16:51 ` Nicolas Goaziou
2017-05-14 20:54 ` Kyle Meyer
2017-05-17 12:32 ` Nicolas Goaziou
2017-05-09 4:10 ` About org-sort -> org-sort-list with custom sort function Kyle Meyer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87vapd5qb0.fsf@kyleam.com \
--to=kyle@kyleam.com \
--cc=emacs-orgmode@gnu.org \
--cc=zhitaao.gong@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public 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).