Bump version to 0.22.0

; Use 'sweeprolog-deftest' more widely to isolate unit tests

; Only load 'library(macros)' if available

Refactor and enhance 'completion-at-point' support

Replace 'sweeprolog-completion-at-point-functions' with a single
function 'sweeprolog-completion-at-point' that implements a much more
refined context-sensitive decision tree to determine what kind of
completion to perform.

; Fix typo

* sweeprolog.el (sweeprolog-terms-at-point): Fix typo.

; Simplify list notation

* sweeprolog.el (sweeprolog-module-completion-table): Simplify list
notation of completion 'metadata' list.

; Fix unused argument

* sweeprolog.el (sweeprolog-module-minibuffer-annotation-1): Use 'pad'
argument.

; Remove stale reference to 'sweeprolog-debug-prefix-face'

* sweeprolog.el (sweeprolog-message): Remove stale reference to
'sweeprolog-debug-prefix-face'.

Bump version to 0.21.0

Add grouping and affixation functions for module completion

This adds a 'group-function' and an 'affixation-function' to
'sweeprolog-module-completion-table', for Emacs 28+

The affixation API allows us to compute the appropriate padding to
insert before annotations in a cleaner way.  Modules are group
according to their classes.

* sweep.pl (sweep_module_class/2): New predicate.

* sweeprolog.el (sweeprolog-module-minibuffer-annotation-1):
Extract helper function from...
(sweeprolog-module-minibuffer-annotation): ...here. Adapt.
(sweeprolog-module-minibuffer-affixation)
(sweeprolog-module-minibuffer-group): New functions.
(sweeprolog-module-completion-table): Use them.

Announce recent changes in NEWS.org

Report correct predicate indicators in 'C-x 4 a'

* sweeprolog.el (sweeprolog-add-log-current-defun): New function.
(sweeprolog-mode): Set 'add-log-current-defun-function' to it.

* sweeprolog-tests.el: Test it.

Improve module completion annotations

* sweep.pl (sweep_known_module/1, sweep_is_module/2)
(sweep_module_description_/3, sweep_matching_module/3)
(sweep_module_annotation/2): New predicates.
(sweep_modules_collection/2): Adapt.

* sweeprolog.el (sweeprolog-module-completion-table)
(sweeprolog-module-p, sweeprolog-module-minibuffer-annotation)
(sweeprolog-module-annotation): New functions.
(sweeprolog-modules-collection)
(sweeprolog-read-module-name): Adapt.
(sweeprolog-find-module): Improve feedback for modules that are not
backed by files.

Fix highlighting for nonexistent Prolog flag names

* sweeprolog.el: Reorganizes 'defface's

* sweeprolog-pce-theme.el: Reformat

* README.org (PceEmacs Theme): Reword and fix typo

MODIFIED: Replace "faces styles" with a theme emulating PceEmacs

This adds a custom theme called 'sweeprolog-pce' that mimics the
highlighting of SWI-Prolog's built-in editor, PceEmacs.  It obsoletes
the "faces styles" feature that Sweep provided thus far.  For backward
compatibility, The user option 'sweeprolog-faces-style' is retained
and mostly still respected.

Thanks to Stefan Monnier for suggesting this approach for simplifying
Sweep's code and making it more conformant with Emacs conventions.

* sweeprolog-pce-theme.el: New file.

* sweeprolog.el: Remove 'sweeprolog-defface' macro its
'sweeprolog-*-face' functions, use plain face definitions and refer to
them directly by their names instead.  Also extend
'custom-theme-load-path' to include the new sweeprolog-pce-theme.el.

* README.org (Semantic Highlighting): Replace "Available Styles"
subsection with new subsection "PceEmacs Theme".

Refer to font-lock face directly instead of via variable

* sweeprolog.el (sweeprolog-predicate-modes-doc): Avoid using
deprecated "face variable".  Thanks to Stefan Monnier for suggesting
this improvement.

DOC: Extend the "Overview" manual section

* README.org (Main Features)
(Comparison with Emacs's built-in Prolog mode): New subsections.

Announce recent changes in NEWS.org and bump version to 0.20.0

Improve documentation for persistent top-level history

ADDED: Persistent history for Sweep top-levels

This adds a new user option that controls the value of
'comint-input-ring-file-name' in Sweep top-level buffers.

* sweeprolog.el (sweeprolog-top-level-persistent-history): New user
option.
(sweeprolog-top-level-sentinel)
(sweeprolog-top-level-setup-history): New functions.
(sweeprolog-top-level-setup-buffer): Call
'sweeprolog-top-level-setup-history' when creating a new top-level
buffer.

Use 'derived-mode-p' instead of checking 'major-mode' directly

* sweeprolog.el (sweeprolog-restart, sweeprolog-top-level-buffer)
(sweeprolog-top-level, sweeprolog-menu)
(sweeprolog-analyze-fragment-to-faces, sweeprolog-load-buffer): Use
'derived-mode-p' instead of checking 'major-mode' directly.

Announce recent changes in NEWS.org and bump version to 0.19.1

FIXED: Correctly recognize DCG grammar rules in 'C-c C-d'

* sweeprolog.el (sweeprolog-beginning-of-predicate-at-point): Also
return the module and neck operator of the predicate at point.
(sweeprolog-insert-predicate-documentation)
(sweeprolog-read-predicate-documentation-function)
(sweeprolog-read-predicate-documentation-with-holes)
(sweeprolog-read-predicate-documentation-default-function)
(sweeprolog-read-predicate-documentation)
(sweeprolog-document-predicate-at-point): Adapt to support DCGs and
non-local predicates.

Simplify 'sweeprolog-beginning-of-top-term'

Extract the core of 'sweeprolog-beginning-of-top-term' to
'sweeprolog-beginning-of-top-term-once' and make it leave point at the
very beginning of the top term, rather than at the following
character.

* sweeprolog.el (sweeprolog-beginning-of-top-term-once): New function.
(sweeprolog-beginning-of-top-term): Use it.
(sweeprolog-local-variables-collection)
(sweeprolog-analyze-term)
(sweeprolog-analyze-some-terms)
(sweeprolog-beginning-of-predicate-at-point)
(sweeprolog-terms-at-point): Adapt.

ENHANCED: Guess argument names for DCG grammar rules

* sweeprolog.el (sweeprolog-predicate-completion-at-point)
(sweeprolog-insert-clause): Support guessing argument names from
documentation also for DCG grammar rules.

ENHANCED: Also highlight "undefined" head terms

ENHANCED: 'sweeprolog-find-predicate/module' improvements

Allow finding modules and predicates in another window with prefix
argument.  Also improve prompt for 'sweeprolog-find-predicate'.

* sweeprolog.el (sweeprolog-read-predicate-prompt): Remove trailing
colon and space.
(sweeprolog-predicate-visible-p-function): New user option.
(sweeprolog-read-predicate): Use it, and format PROMPT with predicate
at point as the default argument.
(sweeprolog-find-module)
(sweeprolog-find-predicate): Add optional argument OTHER-WINDOW.
(sweeprolog-describe-predicate): Adapt PROMPT argument passed to
'sweeprolog-read-predicate'.

* README.org (Finding Prolog Code): Expand.

* README.org (High-level Architecture): Minor tweaks.

Announce recent changes in NEWS.org and bump version to 0.19.0

ENHANCED: Improve DCG support

Take into account DCG grammar rules and ensure they're supported all
around.  Crucially, allow 'sweeprolog-describe-predicate' to display
documentation for DCG grammar rules.

FIXED: Don't change hooks globally

* sweeprolog.el (sweeprolog-mode): Extend 'kill-buffer-hook' and
'context-menu-functions' locally rather than global.

* sweeprolog.el (sweeprolog-context-menu-for-module): Fix typo

Give a better name to 'sweeprolog--mfn-to-functor-arity'

* sweeprolog.el (sweeprolog--pi-to-functor-arity): New function,
renamed from 'sweeprolog--mfn-to-functor-arity'.
(sweeprolog-native-predicate-location): Use it.

Fix a couple of typos in docstrings

* sweeprolog.el (sweeprolog-predicates-collection)
(sweeprolog-head-undefined-face): Fix typo in docstring.

Announce recent changes in NEWS.org and bump version to 0.18.4

ENHANCED: Add tooltip info for string-stye DCG terminals

Use 'ignore-errors' instead of 'condition-case' with no handlers

Add docstring for 'sweeprolog-definition-at-point'

ENHANCED: Export DCG non-terminals as 'foo//N', not 'foo/N+2'

* sweep.pl (strip_det/2): Handle DCG non-terminals with determinism
specification.
(sweep_local_predicate_export_comment/2, sweep_exportable_predicates/2)
* sweeprolog.el (sweeprolog-local-export-comment)
(sweeprolog-local-export-comment): Adapt for DCG non-terminals.

ENHANCED: Highlight string-style DCG terminals

Announce recent changes in NEWS.org and bump version to 0.18.3

Avoid using 'string-replace' for Emacs 27 compatibility

* sweeprolog.el (sweeprolog-top-level-example-done): Refactor and use
'replace-regexp-in-string' instead of 'string-replace'.

Test 'sweeprolog-make-example-usage-comment'

ADDED: highlighting and tooltip info for declaration options

* sweep.pl (sweep_color_normalized_/4): Handle 'decl_option/1'
fragments.

* sweeprolog.el (sweeprolog-declaration-option): New face, used in...
(sweeprolog-analyze-fragment-to-faces): ...for 'decl_option' frags.
(sweeprolog--help-echo-for-declaration-option): New function.
(sweeprolog-analyze-fragment-help-echo): Use it.

* README.org (Example Usage Comments): improve wording

Announce recent changes in NEWS.org and bump version to 0.18.2

ADDED: command for inserting example usage comments

* sweeprolog.el (sweeprolog-top-level-example-mode): New minor mode.
(sweeprolog-make-example-usage-comment): New command.
(sweeprolog-mode-map): Bind it.

* README.org (Example Usage Comments): New section.

Announce recent changes in NEWS.org and bump version to 0.18.1

ADDED: New command for expanding macros

* sweep.pl (sweep_expand_macro/2): New predicate.
* sweeprolog.el (sweeprolog-expand-macro-at-pos): New function.
(sweeprolog-expand-macro-at-point): New command.
(sweeprolog-context-menu-functions): Add...
(sweeprolog-context-menu-for-macro): New function.
* README.org (Macro Expansion): New section.

ADDED: Highlighting and tooltip info for macros

* sweep.pl (sweep_color_normalized_/4): Handle 'macro(String)' terms.
* sweeprolog.el (sweeprolog-macro): New face.
(sweeprolog-analyze-fragment-to-faces)
(sweeprolog-analyze-fragment-help-echo): Handle 'macro' fragments.

FIXED: tokenizing adjacent operators

Make Sweep's Prolog tokenization functions more careful in their
handling of unrelated adjacent operators.  This fixes an issue that
affects term-based movement commands and other commands that rely on
'sweeprolog--forward-sexp' and friends.

* sweeprolog.el (sweeprolog-next-token-boundaries)
(sweeprolog-last-token-boundaries): Fix handling of
adjacent (distinct) operators.

* sweeprolog-tests.el
(forward-sexp-with-adjacent-operators): New test case.

Fix copy-paste error in NEWS.org

Announce recent changes in NEWS.org and bump version to 0.18.0

Use 'nil' for some 'defface's instead of ':inherit default'

Change 'defface's that only specify inheritance from 'default' to
empty (nil) definitions, such that the appearance of text these with
faces can be determined by other faces applied to the same text.  This
is important, for example, when using Sweep in Org mode source blocks.

MODIFIED: Remove '-face' suffix from face names

Remove the '-face' suffix from the names of all defined faces as
prescribed in (info "(elisp)Defining Faces").

ENHANCED: faster completion-at-point for predicates

Filter predicate completion candidates according to the text near
point before formatting and computing argument names.  This makes
completion-at-point for predicates much faster when there are lots of
known predicates.

* sweeprolog.el (sweeprolog-predicate-completion-at-point): Pass
(partial) functor at point to...
* sweep.pl (sweep_predicate_completion_candidates/2): Filter
predicates based on new Sub argument.

* sweeprolog.el (sweeprolog--load-module): Use 'module-load'.

Announce recent changes in NEWS.org and bump version to 0.17.0

FIXED: beginning-of-clause detection with quoted head functors

* sweeprolog.el (sweeprolog-beginning-of-top-term): don't skip quoted
functors in clause heads.

ADDED: Support setting breakpoints in sweeprolog-mode

* sweep.pl (sweep_set_breakpoint/2)
(sweep_delete_breakpoint/2)
(sweep_set_breakpoint_condition/2): new predicates.

* sweeprolog.el (sweeprolog-dependency-directive): update
package-version field.
(sweeprolog-set-breakpoint)
(sweeprolog-set-breakpoint-condition)
(sweeprolog-delete-breakpoint)
(sweeprolog-list-breakpoints): new commands.
(sweeprolog-highlight-breakpoints): new user option.
(sweeprolog-mode-map): bind sweeprolog-set-breakpoint.

* README.org (Setting Breakpoints): new manual section.

ADDED: mode line indication for loaded buffers

* sweep.pl (sweep_source_file_load_time/2): new predicate.
(sweep_load_buffer/2): also update source modification time based.
* sweeprolog.el (sweeprolog-buffer-load-time)
(sweeprolog-buffer-loaded-since-last-modification-p): new functions.
(sweeprolog-load-buffer): use it.
(sweeprolog-mode): add mode line indication if buffer is loaded.

* (sweeprolog-context-menu-for-variable): fix docstring

MODIFIED: sweeprolog-update-dependencies choice of directives

* sweeprolog.el (sweeprolog-dependency-directive): New user option.
Determines which directive to use in...
(sweeprolog-update-dependencies): Fix edge cases in finding where to
insert new directives. Optionally infer directive to add based on
current buffer contents.

* README.org (Managing Dependencies): Update section.

Announce recent changes in NEWS.org and bump version to 0.16.0

* (sweeprolog-insert-term-dwim): add undo-inhibit-region property

* README.org (Discovering Sweep): new manual section

* sweeprolog.el: allow info-lookup to recognize Sweep commands

* README.org: add explicit indexing directive

FIXED: end-of-term detection after a fullstop turns to a dict dot

This fixes an issue with finding clause bounds after changing e.g.:

    foo(Bar, Baz) :- Baz = Bar.
                              ^ read as fullstop

to:

    foo(Bar, Baz) :- Baz = Bar.foo.
                              ^ read as dict dot

ADDED: new commands for managing numbered variables

* sweeprolog.el (sweeprolog-increment-numbered-variables)
(sweeprolog-decrement-numbered-variables): new commands.
(sweeprolog-mode-map): bind them to C-c C-+ and C-c C--.
(sweeprolog-context-menu-for-variable): allow calling these new
commands from context menus for numbered variables.
* sweeprolog-tests.el: add test for incrementing numbered variables.
* README.org (Numbered Variables): new manual section.

* (sweeprolog-rename-variable-allow-existing): refine custom type

ENHANCED: handle renaming variables to existing variable names

* sweeprolog.el (sweeprolog-rename-variable-allow-existing): new user
option, used by...
(sweeprolog-read-new-variable-try): new command, exists the minibuffer
if it contains a valid variable name.  It checks if the selected
variable name already exists.  Used by...
(sweeprolog-read-new-variable): new function, reads a Prolog variable
name in the minibuffer with a dedicated exit command.
(sweeprolog-rename-variable): use it.

Announce recent changes in NEWS.org and bump version to 0.15.0

Avoid moving cursor while renaming variables from context menu

* sweeprolog.el (sweeprolog-analyze-term-at-point): new optional
argument POINT.
(sweeprolog-rename-variable): use it instead of moving point during
prompting to avoid the cursor being displayed at the click position
when called from the context menu.

* (xref-backend-references): report progress while formatting refs

ENHANCED: provide exact buffer positions for cross references

* sweep.pl (reference_span/5): new predicate.
(sweep_predicate_references/2): use it to find exact character offset of
predicate references.
* sweeprolog.el (xref-backend-references): adapt accordingly.

* (sweeprolog-rename-variable): report results if interactive

ADDED: command for renaming a variable in Prolog term

* sweeprolog.el (sweeprolog-rename-variable): new command.
(sweeprolog-context-menu-rename-variable): new command used in context
menus for variables.
(sweeprolog-context-menu-for-variable): new function, used in...
(sweeprolog-context-menu-functions): add it to the list.
(sweeprolog-mode-map): bind it to C-c C-r.
* README.org (Renaming Variables): new section.

Announce recent changes in NEWS.org and bump version to 0.14.1

ENHANCED: use docs from the SWI-Prolog manual to guess hole names

* sweep.pl (predicate_argument_names/2): also consult the SWI-Prolog
manual via pldoc_man:load_man_object/4 to find argument names for
built-in predicates.

ADDED: numeric argument for sweeprolog-forward/backward-hole

* sweeprolog.el (sweeprolog-count-holes): new command, counts holes
in the current buffer.
(sweeprolog-forward-hole, sweeprolog-backward-hole): new numeric
argument, corresponding to the prefix argument when called
interactively.  With positive/negative numeric argument, move over
that many holes.  With zero numeric argument, call
sweeprolog-count-holes instead.

DOC: improve documentation for holes

* README.org (Holes): Fix wording and index directives

yank holes back as plain variables

* sweeprolog.el (sweeprolog-mode): add sweeprolog-hole to
yank-excluded-properties buffer-locally.
* sweeprolog-tests.el: test it.
* README.org (Holes): mention it.

Add sweeprolog-view-news command and bump version to 0.14.0

* sweeprolog.el (sweeprolog-view-news): new command for viewing the
Sweep News file.

Document sweeprolog-file-at-point, file-name-at-point-functions

* (sweeprolog-xref-project-source-files): add progress reporting

don't use file-name-split for compatibility with older Emacsen

* sweeprolog.el: capitalize "Sweep" in major mode names

ADDED: command to pipe output of Prolog goals to Emacs buffers

* sweep.c (sweep_open_channel(), sweep_fd_open()): new helper
functions for obtaining Prolog streams from Emacs pipe buffers.
* sweep.pl (sweep_async_goal/2, sweep_interrupt_async_goal/2): new
predicates.
* sweeprolog.el (sweeprolog-async-goal): new command, executes a goal
in a separate thread and redirects its output to a buffer with mode..
(sweeprolog-async-goal-output-mode): new major mode, derived from
Compilation mode.
(sweeprolog-mode-map, sweeprolog-prefix-map, sweeprolog-menu): bind
sweeprolog-async-goal.
* README.org (Executing Prolog Asynchronously): new manual section.

FIXED: possible race condition when signaling new top-level threads

Announce recent changes in NEWS.org and bump version to 0.13.0

ENHANCED: consult with library index for finding predicate defs

* sweep.pl (sweep_predicate_location_/4): also check library_index/3.
* sweeprolog-tests.el: add test for finding the source location of a
predicate in the package clib.

expose new arithmetic functions support in library(prolog_colour)

FIXED: stale xref data when jumping across files with M-.

ADDED: right-click context menus in sweeprolog-mode

* sweeprolog.el (sweeprolog-context-menu-find-module)
(sweeprolog-context-menu-find-module-other-window)
(sweeprolog-context-menu-describe-module)
(sweeprolog-context-menu-find-file)
(sweeprolog-context-menu-find-file-other-window)
(sweeprolog-context-menu-describe-predicate): new commands, add to context menus by...
(sweeprolog-context-menu-for-predicate)
(sweeprolog-context-menu-for-module)
(sweeprolog-context-menu-for-file): new functions, used in...
(sweeprolog-context-menu-functions): new abnormal hook, used by...
(sweeprolog-context-menu-function): new function.
(sweeprolog-mode): add it to context-menu-functions.

* README.org (Context Menu): new section.

Announce recent changes in NEWS.org and bump version to 0.12.0