ENHANCED: load and initialize sweep-module just-in-time

Instead of loading sweep-module and initializing Prolog as part of
loading sweeprolog.el (subject to the user option
sweeprolog-init-on-load), this commit introduces just-in-time loading
and initialization of Prolog.  Suggested by Stefan Monnier.

* sweeprolog.el: (sweeprolog--open-query): new function, wraps
sweeprolog-open-query and initializes Prolog on the first call. Used
in place of sweeprolog-open-query throughout.
(sweeprolog-init-on-load): make variable obsolete.

diff --git a/NEWS.org b/NEWS.org
index 4f589361afacc3b106aaff64003f9ada1909fb54..0284cfd43e3bf2ed5977c2fcb443851a48faac22 100644 (file)
--- a/NEWS.org
+++ b/NEWS.org
@@ -11,6 +11,22 @@ SWI-Prolog in Emacs.
 For further details, please consult the manual:
 <https://eshelyaron.com/sweep.html>.
 
+* Version 0.7.2 on 2022-10-20
+
+** ~sweep-module~ is now loaded on-demand
+
+Previously, loading =sweeprolog.el= with e.g. ~(require 'sweeprolog)~
+would cause Emacs to also load =sweep-module= immediately, unless the
+user option ~sweeprolog-init-on-load~ had been explicitly set by the
+user to nil.  This version implements lazy loading of =sweep-module=,
+which makes loading =sweeprolog.el= a lot faster and circumvents
+potential problems with byte-compiling Elisp files that depend on
+=sweeprolog.el= but do not have =sweep-module= available at compile time.
+
+** Newly deprecated user option ~sweeprolog-init-on-load~
+
+The embedded Prolog is now loaded and initiated lazily, regardless of
+the value of ~sweeprolog-init-on-load~, which is now obsolete.
 
 * Version 0.7.1 on 2022-10-19
 

diff --git a/README.org b/README.org
index 28fc8cf99536f325464c16d852fe880ab3104b60..d5b65968f7a4ed1e3009e0cc1e56f106c462952c 100644 (file)
--- a/README.org
+++ b/README.org
@@ -141,10 +141,11 @@ line arguments, where the first argument to =sweeprolog-initialize=
 corresponds to =argv[0]=.
 
 #+VINDEX: sweeprolog-init-args
-By default, =sweeprolog.el= will initialize Prolog automatically when it is
-loaded into Emacs.  The arguments used to initialize Prolog in that
-case are determined by the value of the user-option =sweeprolog-init-args=
-which the user is free to extend with e.g.:
+~sweep~ loads and initializes Prolog on-demand at the first invocation
+of a command that requires the embedded Prolog.  The arguments used to
+initialize Prolog in case are determined by the value of the
+user-option ~sweeprolog-init-args~ which the user is free to extend with
+e.g.:
 
 #+begin_src emacs-lisp
   (add-to-list 'sweeprolog-init-args "--stack-limit=512m")
@@ -155,15 +156,11 @@ The default value of ~sweeprolog-init-args~ is set to load the Prolog
 helper library =sweep.pl= and to create a boolean Prolog flag ~sweep~, set
 to ~true~, which indicates to SWI-Prolog that it is running under ~sweep~.
 
-#+VINDEX: sweeprolog-init-on-load
-To inhibit =sweeprolog= from initializing Prolog on load, set the user-option
-=sweeprolog-init-on-load= to nil.
-
 #+FINDEX: sweeprolog-restart
 The embedded Prolog runtime can be reset using the command
-=sweeprolog-restart=.  This command cleans up the the Prolog state and
+~sweeprolog-restart~.  This command cleans up the the Prolog state and
 resources, and starts it anew.  When called with a prefix argument
-(=C-u M-x sweeprolog-restart=), this command prompts the user for
+(~C-u M-x sweeprolog-restart~), this command prompts the user for
 additional initialization arguments to pass to the embedded Prolog
 runtime on startup.
 
@@ -1332,7 +1329,7 @@ there some further improvements that we want to pursue:
 
 - Provide right-click (~mouse-3~) menus with ~context-menu-mode~ :: To
   accommodate users who prefer a mouse-based workflow, ~sweeprolog-mode~
-  should provide right-click context-aware menus by integrating with
+  should provide context-aware right-click menus by integrating with
   ~context-menu-mode~.
 
 - Provide descriptions for tokens by setting their ~help-echo~ propety :: We

diff --git a/sweep.pl b/sweep.pl
index 4699803c6661a27a19919bb711094878a22559ba..27b169daf905831fd7e28359f05d982dc8f1fd12 100644 (file)
--- a/sweep.pl
+++ b/sweep.pl
@@ -142,8 +142,8 @@ sweep_colourise_buffer_(Path0, Contents, []) :-
     set_stream(Contents, encoding(utf8)),
     set_stream(Contents, file_name(Path)),
     get_time(Time),
-    asserta(sweep_open(Path, Contents), Ref0),
     asserta(sweep_source_time(Path, Time), Ref1),
+    asserta(sweep_open(Path, Contents), Ref0),
     xref_source(Path, [comments(store)]),
     seek(Contents, 0, bof, _),
     retractall(sweep_current_comment(_, _, _)),

diff --git a/sweeprolog.el b/sweeprolog.el
index 3c1d9d7be7ad55ec2039acc44327d1a5d7af1718..54812e25f38523fdfd9e817cd04b0eae1ed65ac0 100644 (file)
--- a/sweeprolog.el
+++ b/sweeprolog.el
@@ -6,7 +6,7 @@
 ;; Maintainer: Eshel Yaron <~eshel/dev@lists.sr.ht>
 ;; Keywords: prolog languages extensions
 ;; URL: https://git.sr.ht/~eshel/sweep
-;; Package-Version: 0.7.1
+;; Package-Version: 0.7.2
 ;; Package-Requires: ((emacs "28.1"))
 
 ;; This file is NOT part of GNU Emacs.
@@ -36,6 +36,10 @@
 (require 'find-func)
 (require 'shr)
 
+(defvar sweeprolog--directory (file-name-directory load-file-name))
+
+(defvar sweeprolog-prolog-server-port nil)
+
 (defgroup sweeprolog nil
   "SWI-Prolog Embedded in Emacs."
   :group 'prolog)
@@ -52,7 +56,7 @@ be a path to the SWI-Prolog source code root directory.  Any
 other non-nil value instructs `sweeprolog-predicate-location' to
 try and find the SWI-Prolog sources among known project roots
 obtained from `project-known-project-roots', which see."
-  :package-version '((sweeprolog . "0.4.6"))
+  :package-version '((sweeprolog . "0.7.1"))
   :type '(choice (const  :tag "Detect"  t)
                  (string :tag "Manual")
                  (const  :tag "Disable" nil))
@@ -197,13 +201,19 @@ inserted to the input history in `sweeprolog-top-level-mode' buffers."
   :type 'boolean
   :group 'sweeprolog)
 
+(make-obsolete-variable 'sweeprolog-init-on-load
+                        (concat
+                         "Prolog is initialized on-demand,"
+                         " regardless of the value of this option.")
+                        "sweeprolog version 0.7.2")
+
 (defcustom sweeprolog-init-args (list "-q"
                                       "--no-signals"
                                       "-g"
                                       "create_prolog_flag(sweep,true,[access(read_only),type(boolean)])"
                                       (expand-file-name
                                        "sweep.pl"
-                                       (file-name-directory load-file-name)))
+                                       sweeprolog--directory))
   "List of strings used as initialization arguments for Prolog."
   :package-version '((sweeprolog "0.5.2"))
   :type '(repeat string)
@@ -231,7 +241,6 @@ clause."
   :type 'boolean
   :group 'sweeprolog)
 
-(defvar sweeprolog-prolog-server-port nil)
 
 (declare-function sweeprolog-initialize    "sweep-module")
 (declare-function sweeprolog-initialized-p "sweep-module")
@@ -265,13 +274,78 @@ clause."
                             "-t" "halt"
                             (expand-file-name
                              "sweep.pl"
-                             (file-name-directory load-file-name)))))
+                             sweeprolog--directory))))
                        "\n" t))))
         (mapc #'sweeprolog--load-module lines)
       (error (concat "Failed to locate `sweep-module'. "
                      "Make sure SWI-Prolog is installed "
                      "and up to date")))))
 
+(defun sweeprolog-ensure-initialized ()
+  (sweeprolog--ensure-module)
+  (sweeprolog-init))
+
+(defun sweeprolog--open-query (ctx mod fun arg &optional rev)
+  "Ensure that Prolog is initialized and execute a new query.
+
+CTX, MOD and FUN are strings.  CTX is the context Prolog module
+in which the query in invoked.  MOD is the Prolog module in which
+the invoked predicate is defined.  FUN is the functor of the
+invoked predicate.
+
+ARG is converted to a Prolog term and used as the input argument
+for the query.  When REV is a nil, the input argument is the
+first argument, and the output argument is second.  Otherwise,
+the order of the arguments is reversed."
+  (sweeprolog-ensure-initialized)
+  (sweeprolog-open-query ctx mod fun arg rev))
+
+(defvar sweeprolog--initialized nil)
+
+(defun sweeprolog-init (&rest args)
+  "Initialize and setup the embedded Prolog runtime.
+
+If specified, ARGS should be a list of string passed to Prolog as
+extra initialization arguments."
+  (unless sweeprolog--initialized
+    (apply #'sweeprolog-initialize
+           (cons (or sweeprolog-swipl-path (executable-find "swipl"))
+                 (append sweeprolog-init-args args)))
+    (setq sweeprolog--initialized t)
+    (sweeprolog-setup-message-hook)
+    (sweeprolog-start-prolog-server)))
+
+(defun sweeprolog-restart (&rest args)
+  "Restart the embedded Prolog runtime.
+
+ARGS is a list of strings appended to the value of
+`sweeprolog-init-args' to produce the Prolog initialization
+arguments.
+
+Interactively, with a prefix arguments, prompt for ARGS.
+Otherwise set ARGS to nil."
+  (interactive
+   (and
+    current-prefix-arg
+    (fboundp 'split-string-shell-command)
+    (split-string-shell-command (read-string "swipl arguments: "))))
+  (when-let ((top-levels (seq-filter (lambda (buffer)
+                                       (eq 'sweeprolog-top-level-mode
+                                           (buffer-local-value 'major-mode
+                                                               buffer)))
+                                     (buffer-list))))
+    (if (y-or-n-p "Stop running sweep top-level processes?")
+        (dolist (buffer top-levels)
+          (let ((process (get-buffer-process buffer)))
+            (when (process-live-p process)
+              (delete-process process))))
+      (user-error "Cannot restart sweep with running top-level processes")))
+  (message "Stoping sweep.")
+  (sweeprolog-cleanup)
+  (message "Starting sweep.")
+  (apply #'sweeprolog-init args))
+
+
 (defface sweeprolog-debug-prefix-face
   '((default :inherit shadow))
   "Face used to highlight the \"DEBUG\" message prefix."
@@ -323,7 +397,7 @@ clause."
 
 (defun sweeprolog-current-prolog-flags (&optional prefix)
   "Return the list of defined Prolog flags defined with prefix PREFIX."
-  (sweeprolog-open-query "user" "sweep" "sweep_current_prolog_flags" (or prefix ""))
+  (sweeprolog--open-query "user" "sweep" "sweep_current_prolog_flags" (or prefix ""))
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -348,7 +422,7 @@ clause."
 FLAG and VALUE are specified as strings and read as Prolog terms."
   (interactive (let ((f (sweeprolog-read-prolog-flag)))
                  (list f (read-string (concat "Set " f " to: ")))))
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                     "sweep"
                     "sweep_set_prolog_flag"
                     (cons flag value))
@@ -363,7 +437,7 @@ FLAG and VALUE are specified as strings and read as Prolog terms."
   (with-current-buffer (get-buffer-create sweeprolog-messages-buffer-name)
     (setq-local window-point-insertion-type t)
     (compilation-minor-mode 1))
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_setup_message_hook"
                          nil)
@@ -401,7 +475,7 @@ FLAG and VALUE are specified as strings and read as Prolog terms."
 
 (defun sweeprolog-start-prolog-server ()
   "Start the `sweep' Prolog top-level embedded server."
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_top_level_server"
                          nil)
@@ -410,46 +484,6 @@ FLAG and VALUE are specified as strings and read as Prolog terms."
     (when (sweeprolog-true-p sol)
       (setq sweeprolog-prolog-server-port (cdr sol)))))
 
-(defun sweeprolog-init (&rest args)
-  "Initialize and setup the embedded Prolog runtime.
-
-If specified, ARGS should be a list of string passed to Prolog as
-extra initialization arguments."
-  (apply #'sweeprolog-initialize
-         (cons (or sweeprolog-swipl-path (executable-find "swipl"))
-               (append sweeprolog-init-args args)))
-  (sweeprolog-setup-message-hook)
-  (sweeprolog-start-prolog-server))
-
-(defun sweeprolog-restart (&rest args)
-  "Restart the embedded Prolog runtime.
-
-ARGS is a list of strings appended to the value of
-`sweeprolog-init-args' to produce the Prolog initialization
-arguments.
-
-Interactively, with a prefix arguments, prompt for ARGS.
-Otherwise set ARGS to nil."
-  (interactive
-   (and
-    current-prefix-arg
-    (fboundp 'split-string-shell-command)
-    (split-string-shell-command (read-string "swipl arguments: "))))
-  (when-let ((top-levels (seq-filter (lambda (buffer)
-                                       (eq 'sweeprolog-top-level-mode
-                                           (buffer-local-value 'major-mode
-                                                               buffer)))
-                                     (buffer-list))))
-    (if (y-or-n-p "Stop running sweep top-level processes?")
-        (dolist (buffer top-levels)
-          (let ((process (get-buffer-process buffer)))
-            (when (process-live-p process)
-              (delete-process process))))
-      (user-error "Cannot restart sweep with running top-level processes")))
-  (message "Stoping sweep.")
-  (sweeprolog-cleanup)
-  (message "Starting sweep.")
-  (apply #'sweeprolog-init args))
 
 (defvar sweeprolog-predicate-completion-collection nil)
 
@@ -459,7 +493,7 @@ Otherwise set ARGS to nil."
   "Return a list of prediactes accessible in the current buffer.
 
 When non-nil, only predicates whose name contains PREFIX are returned."
-  (sweeprolog-open-query "user" "sweep" "sweep_local_predicate_completion"
+  (sweeprolog--open-query "user" "sweep" "sweep_local_predicate_completion"
                     (cons sweeprolog-buffer-module
                           prefix))
   (let ((sol (sweeprolog-next-solution)))
@@ -469,7 +503,7 @@ When non-nil, only predicates whose name contains PREFIX are returned."
 
 (defun sweeprolog-predicates-collection (&optional prefix)
   "Return a list of prediacte completion candidates matchitng PREFIX."
-  (sweeprolog-open-query "user" "sweep" "sweep_predicates_collection" prefix)
+  (sweeprolog--open-query "user" "sweep" "sweep_predicates_collection" prefix)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -477,7 +511,7 @@ When non-nil, only predicates whose name contains PREFIX are returned."
 
 (defun sweeprolog-predicate-references (mfn)
   "Find source locations where the predicate MFN is called."
-  (sweeprolog-open-query "user" "sweep" "sweep_predicate_references" mfn)
+  (sweeprolog--open-query "user" "sweep" "sweep_predicate_references" mfn)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -539,7 +573,7 @@ When non-nil, only predicates whose name contains PREFIX are returned."
 For native built-in predicates, the behavior of this function
 depends on the value of the user option
 `sweeprolog-swipl-sources', which see."
-  (sweeprolog-open-query "user" "sweep" "sweep_predicate_location" mfn)
+  (sweeprolog--open-query "user" "sweep" "sweep_predicate_location" mfn)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (if (sweeprolog-true-p sol)
@@ -548,7 +582,7 @@ depends on the value of the user option
 
 (defun sweeprolog-predicate-apropos (pattern)
   "Return a list of predicates whose name resembeles PATTERN."
-  (sweeprolog-open-query "user" "sweep" "sweep_predicate_apropos" pattern)
+  (sweeprolog--open-query "user" "sweep" "sweep_predicate_apropos" pattern)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -593,7 +627,7 @@ default."
             (cons start (point))))))))
 
 (defun sweeprolog-prefix-operators (&optional file)
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                     "sweep" "sweep_prefix_ops"
                     (or file (buffer-file-name)))
   (let ((sol (sweeprolog-next-solution)))
@@ -653,14 +687,14 @@ module name, F is a functor name and N is its arity."
     (user-error "Unable to locate predicate %s" mfn)))
 
 (defun sweeprolog-modules-collection ()
-  (sweeprolog-open-query "user" "sweep" "sweep_modules_collection" nil)
+  (sweeprolog--open-query "user" "sweep" "sweep_modules_collection" nil)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
       (cdr sol))))
 
 (defun sweeprolog-module-path (mod)
-  (sweeprolog-open-query "user" "sweep" "sweep_module_path" mod)
+  (sweeprolog--open-query "user" "sweep" "sweep_module_path" mod)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -687,7 +721,7 @@ module name, F is a functor name and N is its arity."
 
 
 (defun sweeprolog--set-buffer-module ()
-  (sweeprolog-open-query "user" "sweep" "sweep_path_module" (buffer-file-name))
+  (sweeprolog--open-query "user" "sweep" "sweep_path_module" (buffer-file-name))
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (setq sweeprolog-buffer-module
@@ -702,7 +736,7 @@ module name, F is a functor name and N is its arity."
   (find-file (sweeprolog-module-path mod)))
 
 (defun sweeprolog-packs-collection ()
-  (sweeprolog-open-query "user" "sweep" "sweep_packs_collection" "")
+  (sweeprolog--open-query "user" "sweep" "sweep_packs_collection" "")
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (when (sweeprolog-true-p sol)
@@ -731,7 +765,7 @@ module name, F is a functor name and N is its arity."
 (defun sweeprolog-pack-install (pack)
   "Install or upgrade Prolog package PACK."
   (interactive (list (sweeprolog-read-pack-name)))
-  (sweeprolog-open-query "user" "sweep" "sweep_pack_install" pack)
+  (sweeprolog--open-query "user" "sweep" "sweep_pack_install" pack)
   (let ((sol (sweeprolog-next-solution)))
     (sweeprolog-close-query)
     (if (sweeprolog-true-p sol)
@@ -1638,7 +1672,7 @@ module name, F is a functor name and N is its arity."
            (contents (buffer-substring-no-properties beg end)))
       (with-silent-modifications
         (font-lock-unfontify-region beg end))
-      (sweeprolog-open-query "user"
+      (sweeprolog--open-query "user"
                              "sweep"
                              "sweep_colourise_buffer"
                              (cons contents (buffer-file-name)))
@@ -1664,7 +1698,7 @@ module name, F is a functor name and N is its arity."
          (contents (buffer-substring-no-properties beg end)))
     (with-silent-modifications
       (font-lock-unfontify-region beg end))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                            "sweep"
                            "sweep_colourise_some_terms"
                            (list contents
@@ -1688,7 +1722,7 @@ module name, F is a functor name and N is its arity."
                  (query (buffer-substring-no-properties beg end)))
         (with-silent-modifications
           (font-lock-unfontify-region beg end))
-        (sweeprolog-open-query "user"
+        (sweeprolog--open-query "user"
                           "sweep"
                           "sweep_colourise_query"
                           (cons query (marker-position beg)))
@@ -1719,7 +1753,7 @@ buffer to load."
     (let* ((beg (point-min))
            (end (point-max))
            (contents (buffer-substring-no-properties beg end)))
-      (sweeprolog-open-query "user"
+      (sweeprolog--open-query "user"
                              "sweep"
                              "sweep_load_buffer"
                              (cons contents (buffer-file-name)))
@@ -1750,7 +1784,7 @@ Interactively, a prefix arg means to prompt for BUFFER."
     (with-current-buffer buf
       (unless (eq major-mode 'sweeprolog-top-level-mode)
         (sweeprolog-top-level-mode)))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                            "sweep"
                            "sweep_accept_top_level_client"
                            (buffer-name buf))
@@ -1786,7 +1820,7 @@ Interactively, a prefix arg means to prompt for BUFFER."
   "Prolog top-level thread ID corresponding to this buffer.")
 
 (defun sweeprolog-top-level--populate-thread-id ()
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_top_level_thread_buffer"
                          (buffer-name)
@@ -1797,7 +1831,7 @@ Interactively, a prefix arg means to prompt for BUFFER."
       (setq sweeprolog-top-level-thread-id (cdr sol)))))
 
 (defun sweeprolog-signal-thread (tid goal)
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_thread_signal"
                          (cons tid goal))
@@ -1858,9 +1892,6 @@ Interactively, a prefix arg means to prompt for BUFFER."
                 (cancel-timer sweeprolog-top-level-timer)))
             nil t))
 
-(sweeprolog--ensure-module)
-(when sweeprolog-init-on-load (sweeprolog-init))
-
 ;;;###autoload
 (defvar sweeprolog-help-prefix-map
   (let ((map (make-sparse-keymap)))
@@ -1890,7 +1921,7 @@ Interactively, a prefix arg means to prompt for BUFFER."
   (cond ((eq operation 'expand-file-name)
          (let ((fn (car  args))
                (dn (cadr args)))
-           (sweeprolog-open-query "user"
+           (sweeprolog--open-query "user"
                              "sweep"
                              "sweep_expand_file_name"
                              (cons fn dn))
@@ -2351,7 +2382,7 @@ Interactively, PROJ is the prefix argument."
       (setq times (1- times)))))
 
 (defun sweeprolog-op-suffix-precedence (token)
-  (sweeprolog-open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
+  (sweeprolog--open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
   (let ((res nil) (go t))
     (while go
       (if-let ((sol (sweeprolog-next-solution))
@@ -2367,7 +2398,7 @@ Interactively, PROJ is the prefix argument."
     res))
 
 (defun sweeprolog-op-prefix-precedence (token)
-  (sweeprolog-open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
+  (sweeprolog--open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
   (let ((res nil) (go t))
     (while go
       (if-let ((sol (sweeprolog-next-solution))
@@ -2383,7 +2414,7 @@ Interactively, PROJ is the prefix argument."
     res))
 
 (defun sweeprolog-op-infix-precedence (token)
-  (sweeprolog-open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
+  (sweeprolog--open-query "user" "sweep" "sweep_op_info" (cons token (buffer-file-name)))
   (let ((res nil) (go t))
     (while go
       (if-let ((sol (sweeprolog-next-solution))
@@ -2524,7 +2555,7 @@ Interactively, PROJ is the prefix argument."
                 (sweeprolog-end-of-top-term)
                 (point)))
          (contents (buffer-substring-no-properties beg end)))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                            "sweep"
                            "sweep_definition_at_point"
                            (cons contents
@@ -2611,7 +2642,7 @@ predicate definition at or directly above POINT."
                 (sweeprolog-end-of-top-term)
                 (point)))
          (contents (buffer-substring-no-properties beg end)))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                       "sweep"
                       "sweep_file_at_point"
                       (list contents
@@ -2643,7 +2674,7 @@ Interactively, POINT is set to the current point."
                 (sweeprolog-end-of-top-term)
                 (point)))
          (contents (buffer-substring-no-properties beg end)))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                            "sweep"
                            "sweep_identifier_at_point"
                            (list contents
@@ -2694,7 +2725,7 @@ Interactively, POINT is set to the current point."
              matches)))
 
 (defun sweeprolog-create-index-function ()
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                     "sweep"
                     "sweep_imenu_index"
                     (buffer-file-name))
@@ -2745,7 +2776,7 @@ variable at point, if any."
 
 (defun sweeprolog-predicate-modes-doc (cb)
   (when-let ((pi (sweeprolog-identifier-at-point)))
-    (sweeprolog-open-query "user"
+    (sweeprolog--open-query "user"
                            "sweep"
                            "sweep_documentation"
                            pi)
@@ -2758,7 +2789,7 @@ variable at point, if any."
 (defvar-local sweeprolog--colourise-buffer-duration 0.2)
 
 (defun sweeprolog-local-predicate-export-comment (fun ari)
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_local_predicate_export_comment"
                          (list (buffer-file-name) fun ari))
@@ -2927,7 +2958,7 @@ if-then-else constructs in SWI-Prolog."
                "\n\n*/\n\n"))
 
 (defun sweeprolog-top-level-menu--entries ()
-  (sweeprolog-open-query "user"
+  (sweeprolog--open-query "user"
                          "sweep"
                          "sweep_top_level_threads"
                          nil)
@@ -3102,7 +3133,7 @@ if-then-else constructs in SWI-Prolog."
 (defun sweeprolog--describe-module (mod)
   (let ((page
          (progn
-           (sweeprolog-open-query "user"
+           (sweeprolog--open-query "user"
                                   "sweep"
                                   "sweep_module_html_documentation"
                                   mod)
@@ -3137,7 +3168,7 @@ if-then-else constructs in SWI-Prolog."
 (defun sweeprolog--describe-predicate (pred)
   (let ((page
          (progn
-           (sweeprolog-open-query "user"
+           (sweeprolog--open-query "user"
                                   "sweep"
                                   "sweep_predicate_html_documentation"
                                   pred)