bug#64101: 29.0.91; Eglot inlay hints rendered out of order

[Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>]

> Right, that makes sense.  It's more or less what I feared too, though
> this is all speculative at this point.  Anyway, can you explain this?

Nope :-(

> Take this scratch buffer
>
>    ;; This buffer is for text that is not saved, and for Lisp evaluation.
>    ;; To create a file, visit it with C-x C-f and enter text in its buffer.
>     
>    (progn
>      (mapc #'delete-overlay (overlays-in (point-min) (point-max)))
>      (let ((a (make-overlay 10 20))
>            (b (make-overlay 10 20)))
>        (overlay-put a 'after-string (propertize "aaaa" 'face 'highlight))
>        (overlay-put b 'after-string (propertize "bbbb" 'face 'speedbar-highlight-face))
>        ;; (overlay-put a 'priority 1)
>        ;; (overlay-put b 'priority 2)
>        (overlay-put a 'priority `(nil . 1))
>        (overlay-put b 'priority `(nil . 2))
>        ))
>
> This displays AAAABBBB eventually, but I would expect it to show
> BBBBAAAA, which is what I get if I use "primary" priorities.

I can indeed reproduce the different rendering here, yet the sorting
done by `overlays-at` is the same in both cases, so it looks like we
sort some other way somewhere (presumably somewhere in the C code).


        Stefan