treemacs-tag-follow-mode is broken when imenu-create-index-function returns positions rather than markers

[bcc32]

(I think this is similar to #132 which was closed for inactivity.)

For major modes with imenu backends that return positions rather than markers, treemacs-tag-follow-mode breaks and messages the following error repeatedly:

  [Treemacs] Encountered error while following tag at point: (wrong-type-argument markerp 138) [2 times]

This is because treemacs--compare-tag-paths assumes the positions in imenu--index-alist are specifically markers rather than just positions (ints). I think this function should not make this assumption. The docstring of imenu--index-alist does not require markers, and indeed eglot-imenu is an example of a prominent imenu backend function that produces positions, not markers.

BTW, < can be used on markers and will automatically do the equiavlent of calling marker-position if necessary. This function can be written simply as:

(define-inline treemacs--compare-tag-paths (p1 p2)
  "Compare two tag paths P1 & P2 by the position of the tags they lead to.
Used to sort tag paths according to the order their tags appear in.

P1: Tag-Path
P2: Tag-Path"
  (declare (pure t) (side-effect-free t))
  (inline-letevals (p1 p2)
    (inline-quote
     (< (-> ,p1 (cdar))
        (-> ,p2 (cdar))))))

(I'm not familiar with the inline library so I just did what seemed intuitively right. It works on my machine, but feel free to implement a different bugfix if you prefer.)

[stale]

This issue has been automatically marked as stale because it has not had recent activity (this bot only works as a reminder, it will not close issues).

[bcc32]

@Alexander-Miller Hi, would just like to gently ping this PR since I think it is basically pretty easy to fix with the above patch. I applied it at my site and it worked for my users.

[tosmi]

+1. i changed the function as proposed by bcc32 and this fixes the issue for me. i'm using eglot here.