xref Atom Feed

Description
Cross-referencing commands
Latest
xref-1.6.3.0.20240518.3950.tar (.sig), 2024-May-18, 90.0 KiB
Maintainer
Website
https://elpa.gnu.org/packages/xref.html
Browse ELPA's repository
CGit or Gitweb
Badge

To install this package from Emacs, use list-packages.

Full description

This file provides a somewhat generic infrastructure for cross
referencing commands, in particular "find-definition".

Some part of the functionality must be implemented in a language
dependent way and that's done by defining an xref backend.

That consists of a constructor function, which should return a
backend value, and a set of implementations for the generic
functions:

`xref-backend-identifier-at-point',
`xref-backend-identifier-completion-table',
`xref-backend-definitions', `xref-backend-references',
`xref-backend-apropos', which see.

A major mode would normally use `add-hook' to add the backend
constructor to `xref-backend-functions'.

The last three methods operate with "xref" and "location" values.

One would usually call `xref-make' and `xref-make-file-location',
`xref-make-buffer-location' or `xref-make-bogus-location' to create
them.  More generally, a location must be an instance of a type for
which methods `xref-location-group' and `xref-location-marker' are
implemented.

There's a special kind of xrefs we call "match xrefs", which
correspond to search results.  For these values,
`xref-match-length' must be defined, and `xref-location-marker'
must return the beginning of the match.

Each identifier must be represented as a string.  Implementers can
use string properties to store additional information about the
identifier, but they should keep in mind that values returned from
`xref-backend-identifier-completion-table' should still be
distinct, because the user can't see the properties when making the
choice.

Older versions of Xref used EIEIO for implementation of the
built-in types, and included a class called `xref-location' which
was supposed to be inherited from.  Neither is true anymore.

See the etags and elisp-mode implementations for full examples.

Old versions

xref-1.6.3.0.20240516.220611.tar.lz2024-May-1720.9 KiB
xref-1.6.3.0.20240514.212205.tar.lz2024-May-1520.8 KiB
xref-1.6.3.0.20240509.25707.tar.lz2024-May-0920.7 KiB
xref-1.6.3.0.20240328.32323.tar.lz2024-Apr-2420.6 KiB
xref-1.6.3.0.20231023.205120.tar.lz2023-Oct-2320.6 KiB
xref-1.6.2.0.20230219.170133.tar.lz2023-Feb-2120.3 KiB
xref-1.6.0.0.20230101.53112.tar.lz2023-Jan-0120.3 KiB
xref-1.5.1.0.20221123.182545.tar.lz2022-Nov-2319.8 KiB
xref-1.4.1.0.20220620.4414.tar.lz2022-Jun-2019.5 KiB
xref-1.0.4.0.20210424.95444.tar.lz2021-Apr-2416.6 KiB