From 5e898c3ef323971af89b80fe37d94be0bf29443f Mon Sep 17 00:00:00 2001 From: Spencer Baugh Date: Tue, 17 Oct 2023 09:09:55 -0400 Subject: [PATCH] Add read-buffer-sort to customize how read-buffer sorts completions Add the ability to customize how read-buffer (actually internal-complete-buffer) sorts the buffer completion candidates. Also add minibuffer-sort-alphabetically and minibuffer-sort-by-history to provide some reasonable options for read-buffer-sort. And add support for them to completions-sort, too, as a simple change. * lisp/minibuffer.el (completions-sort): Document 'historical option. (minibuffer-completion-help): Support 'historical option. (minibuffer-sort-alphabetically) (minibuffer-completion-base, minibuffer-sort-by-history): Add. * lisp/cus-start.el (standard): Add customization information for read-buffer-sort. * src/minibuf.c (Finternal_complete_buffer): Use read-buffer-sort. (syms_of_minibuf): Add read-buffer-sort. --- lisp/cus-start.el | 7 ++++++ lisp/minibuffer.el | 63 +++++++++++++++++++++++++++++++++++++++++----- src/minibuf.c | 32 ++++++++++++++++++++--- 3 files changed, 93 insertions(+), 9 deletions(-) diff --git a/lisp/cus-start.el b/lisp/cus-start.el index 6d83aaf4d14..40bc4078d77 100644 --- a/lisp/cus-start.el +++ b/lisp/cus-start.el @@ -441,6 +441,13 @@ minibuffer-prompt-properties--setter (read-buffer-function minibuffer (choice (const nil) function)) + (read-buffer-sort minibuffer + (choice (const :tag "completions-sort controls sorting" nil) + (const :tag "sort matching buffer-list" buffer-list) + (const :tag "sort alphabetically" minibuffer-sort-alphabetically) + (const :tag "sort historically" minibuffer-sort-by-history) + (function :tag "User-defined function")) + "30.1") ;; msdos.c (dos-unsupported-char-glyph display integer) ;; nsterm.m diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 026613c9eb2..49086ff6eff 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -1307,14 +1307,26 @@ completion-cycle-threshold (defcustom completions-sort 'alphabetical "Sort candidates in the *Completions* buffer. -The value can be nil to disable sorting, `alphabetical' for -alphabetical sorting or a custom sorting function. The sorting -function takes and returns a list of completion candidate -strings." +Candidate completions in the *Completions* are sorted depending +on the value. + +If nil, sorting is disabled. +If `alphabetical', candidates are sorted by +`minibuffer-sort-alphabetically'. +If `historical', candidates are sorted by +`minibuffer-sort-by-history'. +If a function, the function is called to sort the candidates. +The sorting function takes and returns a list of completion +candidate strings. + +If the completion-specific metadata provides a +`display-sort-function', that is used instead and this value is +ignored." :type '(choice (const :tag "No sorting" nil) (const :tag "Alphabetical sorting" alphabetical) + (const :tag "Historical sorting" historical) (function :tag "Custom function")) - :version "29.1") + :version "30.1") (defcustom completions-group nil "Enable grouping of completion candidates in the *Completions* buffer. @@ -1640,6 +1652,43 @@ minibuffer--sort-preprocess-history (substring c base-size))) hist))))) +(defun minibuffer-sort-alphabetically (completions) + "Sort COMPLETIONS alphabetically. + +COMPLETIONS are sorted alphabetically by `string-lessp'. + +This is a suitable function to use for `completions-sort' or to +include as `display-sort-function' in completion metadata." + (sort completions #'string-lessp)) + +(defvar minibuffer-completion-base nil + "The base for the current completion. + +This is the part of the current minibuffer input which is not +being completed on. This is primarily relevant for file names, +where this is the directory component of the file name.") + +(defun minibuffer-sort-by-history (completions) + "Sort COMPLETIONS by their position in `minibuffer-history-variable'. + +COMPLETIONS are sorted first by `minibuffer-sort-alphbetically', +then any elements occuring in the minibuffer history list are +moved to the front based on the order they occur in the history. +If a history variable hasn't been specified for this call of +`completing-read', COMPLETIONS are sorted only by +`minibuffer-sort-alphbetically'. + +This is a suitable function to use for `completions-sort' or to +include as `display-sort-function' in completion metadata." + (let ((alphabetized (sort completions #'string-lessp))) + ;; Only use history when it's specific to these completions. + (if (eq minibuffer-history-variable + (default-value minibuffer-history-variable)) + alphabetized + (minibuffer--sort-by-position + (minibuffer--sort-preprocess-history minibuffer-completion-base) + alphabetized)))) + (defun minibuffer--group-by (group-fun sort-fun elems) "Group ELEMS by GROUP-FUN and sort groups by SORT-FUN." (let ((groups)) @@ -2470,6 +2519,7 @@ minibuffer-completion-help (let* ((last (last completions)) (base-size (or (cdr last) 0)) (prefix (unless (zerop base-size) (substring string 0 base-size))) + (minibuffer-completion-base (substring string 0 base-size)) (base-prefix (buffer-substring (minibuffer--completion-prompt-end) (+ start base-size))) (base-suffix @@ -2540,7 +2590,8 @@ minibuffer-completion-help (funcall sort-fun completions) (pcase completions-sort ('nil completions) - ('alphabetical (sort completions #'string-lessp)) + ('alphabetical (minibuffer-sort-alphabetically completions)) + ('historical (minibuffer-sort-by-history completions)) (_ (funcall completions-sort completions))))) ;; After sorting, group the candidates using the diff --git a/src/minibuf.c b/src/minibuf.c index 58adde1bf66..04551afeb79 100644 --- a/src/minibuf.c +++ b/src/minibuf.c @@ -2186,9 +2186,15 @@ DEFUN ("internal-complete-buffer", Finternal_complete_buffer, Sinternal_complete else if (EQ (flag, Qlambda)) return Ftest_completion (string, Vbuffer_alist, predicate); else if (EQ (flag, Qmetadata)) - return list3 (Qmetadata, - Fcons (Qcategory, Qbuffer), - Fcons (Qcycle_sort_function, Qidentity)); + { + Lisp_Object res = list2 (Fcons (Qcategory, Qbuffer), + Fcons (Qcycle_sort_function, Qidentity)); + if (EQ (Vread_buffer_sort, Qbuffer_list)) + res = Fcons (Fcons (Qdisplay_sort_function, Qidentity), res); + else if (FUNCTIONP (Vread_buffer_sort)) + res = Fcons (Fcons (Qdisplay_sort_function, Vread_buffer_sort), res); + return Fcons (Qmetadata, res); + } else return Qnil; } @@ -2323,6 +2329,7 @@ syms_of_minibuf (void) DEFSYM (Qcase_fold_search, "case-fold-search"); DEFSYM (Qmetadata, "metadata"); DEFSYM (Qcycle_sort_function, "cycle-sort-function"); + DEFSYM (Qdisplay_sort_function, "display-sort-function"); /* A frame parameter. */ DEFSYM (Qminibuffer_exit, "minibuffer-exit"); @@ -2522,6 +2529,25 @@ syms_of_minibuf (void) the minibuffer. However, if `minibuffer-restore-windows' is present in `minibuffer-exit-hook', exiting the minibuffer will remove the window showing the *Completions* buffer, if any. */); + + DEFVAR_LISP ("read-buffer-sort", Vread_buffer_sort, + doc: /* Non-nil means sort completions in `read-buffer'. + +If this is nil (the default), completions in `read-buffer' are sorted +according to `completions-sort'. + +If this is `buffer-list', completions are sorted to match the order of +`buffer-list'. + +If a function, the function is called to sort the candidates. Some +possible values are `minibuffer-sort-alphabetically' and +`minibuffer-sort-by-history'. + +This variable only affects the default `read-buffer', so if +`read-buffer-function' is set to a function which does not use +`internal-complete-buffer', this variable will have no effect.*/); + Vread_buffer_sort = Qnil; + read_minibuffer_restore_windows = true; defsubr (&Sactive_minibuffer_window); -- 2.42.1