oook-selector.el

(require 'xdmp-methods)
(require 'oook-tools)

;;;; Oook selector

;; based on slime-selector, a.k.a. Slime's Buffer selector
;; see: https://github.com/slime/slime/blob/master/slime.el

;;;; License and Commentary

;;     Copyright (C) 2003  Eric Marsden, Luke Gorrie, Helmut Eller
;;     Copyright (C) 2004,2005,2006  Luke Gorrie, Helmut Eller
;;     Copyright (C) 2007,2008,2009  Helmut Eller, Tobias C. Rittweiler
;;     Copyright (C) 2016,2017  Max-Gerd Retzlaff
;;
;;     For a detailed list of contributors, see the manual.
;;
;;     This program is free software; you can redistribute it and/or
;;     modify it under the terms of the GNU General Public License as
;;     published by the Free Software Foundation; either version 2 of
;;     the License, or (at your option) any later version.
;;
;;     This program is distributed in the hope that it will be useful,
;;     but WITHOUT ANY WARRANTY; without even the implied warranty of
;;     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;     GNU General Public License for more details.
;;
;;     You should have received a copy of the GNU General Public
;;     License along with this program; if not, write to the Free
;;     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
;;     MA 02111-1307, USA.


(defvar oook-selector-methods nil
  "List of buffer-selection methods for the `oook-select' command.
Each element is a list (KEY DESCRIPTION FUNCTION).
DESCRIPTION is a one-line description of what the key selects.")

(defvar oook-selector-other-window nil
  "If non-nil use switch-to-buffer-other-window.")

(defun oook-selector (&optional other-window)
  "Select a new buffer by type, indicated by a single character.
The user is prompted for a single character indicating the method by
which to choose a new buffer. The `?' character describes the
available methods.

See `oook-selector-defmethod' for defining new methods."
  (interactive)
  (message "Select [%s]: "
           (apply #'string (mapcar #'car oook-selector-methods)))
  (let* ((oook-selector-other-window other-window)
         (ch (save-window-excursion
               (select-window (minibuffer-window))
               (read-char)))
         (method (cl-find ch oook-selector-methods :key #'car)))
    (cond (method
           (funcall (cl-third method)))
          (t
           (message "No method for character: ?\\%c" ch)
           (ding)
           (sleep-for 1)
           (discard-input)
           (oook-selector)))))

(defmacro oook-selector-defmethod (key description &rest body)
  "Define a new `oook-select' buffer selection method.

KEY is the key the user will enter to choose this method.

DESCRIPTION is a one-line sentence describing how the method
selects a buffer.

BODY is a series of forms which are evaluated when the selector
is chosen. The returned buffer is selected with
switch-to-buffer."
  (let ((method `(lambda ()
                   ,@body)))
    `(setq oook-selector-methods
           (cl-sort (cons (list ,key ,description ,method)
                          (cl-remove ,key oook-selector-methods :key #'car))
                    #'< :key #'car))))


;; general methods

(oook-selector-defmethod ??
  "Selector help buffer"
  (ignore-errors (kill-buffer "*Select Help*"))
  (with-current-buffer (get-buffer-create "*Select Help*")
    (insert "Select Methods:\n\n")
    (cl-loop for (key line nil) in oook-selector-methods
             do (insert (format "%c:\t%s\n" key line)))
    (goto-char (point-min))
    (help-mode)
    (display-buffer (current-buffer) t))
  (oook-selector)
  (current-buffer))

;; (cl-pushnew (list ?4 "Select in other window" (lambda () (oook-selector t)))
;;             oook-selector-methods :key #'car)

(oook-selector-defmethod ?q
  "Quit / abort"
  (top-level))


;;; custom methods

;;;; simple xquery evaluation

(oook-selector-defmethod ?x
  "Evaluate an xquery from minibuffer"
  (call-interactively 'xdmp-query))

(oook-selector-defmethod ?X
  "Evaluate an xquery from minibuffer in the modules database"
  (xdmp-with-modules-database
   (call-interactively 'xdmp-query)))


;;;; document management

(oook-selector-defmethod ?l
  "List documents (For paged output, set page limit with xdmp-set-page-limit.)"
  (call-interactively 'xdmp-list-documents))

(oook-selector-defmethod ?L
  "List documents in the modules database"
  (xdmp-with-modules-database
   (call-interactively 'xdmp-list-documents)))

(oook-selector-defmethod ?s
  "Show document"
  (call-interactively 'xdmp-show))

(oook-selector-defmethod ?S
  "Show document in the modules database"
  (xdmp-with-modules-database
   (call-interactively 'xdmp-show)))

(oook-selector-defmethod ?t ;; show "this" document / show document at point, use in documents list
  "Show this document at point"
  (xdmp-show-this))

(oook-selector-defmethod ?T ;; show "This" document / show document at point in modules database, use in documents list
  "Show this document at point in the modules database"
  (xdmp-with-modules-database
   (xdmp-show-this)))

(oook-selector-defmethod ?u
  "Upload a document"
  (call-interactively 'xdmp-document-load))

(oook-selector-defmethod ?U
  "Upload a document in the modules database"
  (xdmp-with-modules-database
   (call-interactively 'xdmp-document-load)))


(oook-selector-defmethod ?d
  "Delete a document"
  (call-interactively 'xdmp-document-delete))

(oook-selector-defmethod ?D
  "Delete a document in the modules database"
  (xdmp-with-modules-database
   (call-interactively 'xdmp-document-delete)))

(oook-selector-defmethod ?b
  "Set server path for current buffer"
  (call-interactively 'xdmp-set-buffer-path))

(oook-selector-defmethod ?B
  "Set database for current buffer"
  (call-interactively 'xdmp-set-buffer-database))

;;;; database selection

(oook-selector-defmethod ?c ;; "choose"
  "Choose/select database within current session/connection "
  (call-interactively 'xdmp-select-database))

(oook-selector-defmethod ?.
  "Select default database of the server"
  (xdmp-select-default-database))

(oook-selector-defmethod ?,
  "Select modules database of the server"
  (xdmp-select-modules-database))

(oook-selector-defmethod ?-
  "Show which database is currently used"
  (xdmp-show-current-database))

(oook-selector-defmethod ?/
  "Show which database is currently used"
  (xdmp-show-current-database))

;; cider convenience functions

(oook-selector-defmethod ?j
  "(cider) Start an nREPL server for the current project and connect to it."
  (cider-jack-in))

(oook-selector-defmethod ?r
  "(cider) Select the REPL buffer, when possible in an existing window."
  (cider-switch-to-repl-buffer))

(oook-selector-defmethod ?R
  "(cider) Switch to the last Clojure buffer."
  (cider-switch-to-last-clojure-buffer))

(provide 'oook-selector)