cgit.sxemacs.org Git - gnus/blob - lisp/assistant.el

   1 ;;; assistant.el --- guiding users through Emacs setup
   2 ;; Copyright (C) 2004 Free Software Foundation, Inc.
   3
   4 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   5 ;; Keywords: util
   6
   7 ;; This file is part of GNU Emacs.
   8
   9 ;; GNU Emacs is free software; you can redistribute it and/or modify
  10 ;; it under the terms of the GNU General Public License as published by
  11 ;; the Free Software Foundation; either version 2, or (at your option)
  12 ;; any later version.
  13
  14 ;; GNU Emacs is distributed in the hope that it will be useful,
  15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 ;; GNU General Public License for more details.
  18
  19 ;; You should have received a copy of the GNU General Public License
  20 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22 ;; Boston, MA 02111-1307, USA.
  23
  24 ;;; Commentary:
  25
  26 ;;; Code:
  27
  28 (eval-when-compile
  29   (require 'cl))
  30
  31 (defvar assistant-readers
  32   '(("variable" assistant-variable-reader)
  33     ("validate" assistant-sexp-reader)
  34     ("result" assistant-list-reader)
  35     ("next" assistant-list-reader)
  36     ("text" assistant-text-reader)))
  37
  38 (defface assistant-field-face '((t (:bold t)))
  39   "Face used for editable fields."
  40   :group 'gnus-article-emphasis)
  41
  42 ;;; Internal variables
  43
  44 (defvar assistant-data nil)
  45 (defvar assistant-current-node nil)
  46 (defvar assistant-previous-node nil)
  47 (defvar assistant-widgets nil)
  48
  49 (defun assistant-parse-buffer ()
  50   (let (results command value)
  51     (goto-char (point-min))
  52     (while (search-forward "@" nil t)
  53       (if (not (looking-at "[^ \t\n]+"))
  54           (error "Dangling @")
  55         (setq command (downcase (match-string 0)))
  56         (goto-char (match-end 0)))
  57       (setq value
  58             (if (looking-at "[ \t]*\n")
  59                 (let (start)
  60                   (forward-line 1)
  61                   (setq start (point))
  62                   (unless (re-search-forward (concat "^@end " command) nil t)
  63                     (error "No @end %s found" command))
  64                   (beginning-of-line)
  65                   (prog1
  66                       (buffer-substring start (point))
  67                     (forward-line 1)))
  68               (skip-chars-forward " \t")
  69               (prog1
  70                   (buffer-substring (point) (line-end-position))
  71                 (forward-line 1))))
  72       (push (list command (assistant-reader command value))
  73             results))
  74     (assistant-segment (nreverse results))))
  75
  76 (defun assistant-text-reader (text)
  77   (with-temp-buffer
  78     (insert text)
  79     (goto-char (point-min))
  80     (let ((start (point))
  81           (sections nil))
  82       (while (re-search-forward "@\\([^{]+\\){\\([^}]+\\)}" nil t)
  83         (push (buffer-substring start (match-beginning 0))
  84               sections)
  85         (push (list (match-string 1) (match-string 2))
  86               sections)
  87         (setq start (point)))
  88       (push (buffer-substring start (point-max))
  89             sections)
  90       (nreverse sections))))
  91
  92 ;; Segment the raw assistant data into a list of nodes.
  93 (defun assistant-segment (list)
  94   (let ((ast nil)
  95         (node nil)
  96         (title (pop list)))
  97     (dolist (elem list)
  98       (when (and (equal (car elem) "node")
  99                  node)
 100         (push (list "save" nil) node)
 101         (push (nreverse node) ast)
 102         (setq node nil))
 103       (push elem node))
 104     (when node
 105       (push (list "save" nil) node)
 106       (push (nreverse node) ast))
 107     (cons title (nreverse ast))))
 108
 109 (defun assistant-reader (command value)
 110   (let ((formatter (cadr (assoc command assistant-readers))))
 111     (if (not formatter)
 112         value
 113       (funcall formatter value))))
 114
 115 (defun assistant-list-reader (value)
 116   (car (read-from-string (concat "(" value ")"))))
 117
 118 (defun assistant-variable-reader (value)
 119   (let ((section (car (read-from-string (concat "(" value ")")))))
 120     (append section (list 'default))))
 121
 122 (defun assistant-sexp-reader (value)
 123   (if (zerop (length value))
 124       nil
 125     (car (read-from-string value))))
 126
 127 (defun assistant-buffer-name (title)
 128   (format "*Assistant %s*" title))
 129
 130 (defun assistant-get (ast command)
 131   (cadr (assoc command ast)))
 132
 133 (defun assistant-set (ast command value)
 134   (let ((elem (assoc command ast)))
 135     (when elem
 136       (setcar (cdr elem) value))))
 137
 138 (defun assistant-get-list (ast command)
 139   (let ((result nil))
 140     (dolist (elem ast)
 141       (when (equal (car elem) command)
 142         (push elem result)))
 143     (nreverse result)))
 144
 145 (defun assistant (file)
 146   "Assist setting up Emacs based on FILE."
 147   (interactive "fAssistant file name: ")
 148   (let ((ast
 149          (with-temp-buffer
 150            (insert-file-contents file)
 151            (assistant-parse-buffer))))
 152     (pop-to-buffer (assistant-buffer-name (assistant-get ast "title")))
 153     (assistant-render ast)))
 154
 155 (defun assistant-render (ast)
 156   (let ((first-node (assistant-get (nth 1 ast) "node")))
 157     (set (make-local-variable 'assistant-data) ast)
 158     (set (make-local-variable 'assistant-current-node) first-node)
 159     (set (make-local-variable 'assistant-previous-node) nil)
 160     (assistant-render-node first-node)))
 161
 162 (defun assistant-find-node (node-name)
 163   (let ((ast (cdr assistant-data)))
 164     (while (and ast
 165                 (not (string= node-name (assistant-get (car ast) "node"))))
 166       (pop ast))
 167     (car ast)))
 168
 169 (defun assistant-previous-node-text (node)
 170   (format "[ << Go back to %s ]  " node))
 171
 172 (defun assistant-next-node-text (node)
 173   (if node
 174       (format "[ Proceed to %s >> ]" node)
 175     "[ Finish ]"))
 176
 177 (defun assistant-set-defaults (node)
 178   (dolist (variable (assistant-get-list node "variable"))
 179     (setq variable (cadr variable))
 180     (when (eq (nth 3 variable) 'default)
 181       (setcar (nthcdr 3 variable)
 182               (eval (nth 2 variable))))))
 183
 184 (defun assistant-get-variable (node variable)
 185   (let ((variables (assistant-get-list node "variable"))
 186         (result nil))
 187     (while (and (setq elem (pop variables))
 188                 (not result))
 189       (setq elem (cadr elem))
 190       (when (eq (intern variable) (car elem))
 191         (setq result (format "%s" (nth 3 elem)))))
 192     result))
 193
 194 (defun assistant-set-variable (node variable value)
 195   (let ((variables (assistant-get-list node "variable")))
 196     (while (setq elem (pop variables))
 197       (setq elem (cadr elem))
 198       (when (eq (intern variable) (car elem))
 199         (setcar (nthcdr 3 elem) value)))))
 200
 201 (defun assistant-render-text (text node)
 202   (dolist (elem text)
 203     (if (stringp elem)
 204         (insert elem)
 205       (push
 206        (widget-create
 207         'editable-field
 208         :value-face 'assistant-field-face
 209         :assistant-variable (cadr elem)
 210         (assistant-get-variable node (cadr elem)))
 211        assistant-widgets))))
 212
 213 (defun assistant-render-node (node-name)
 214   (let ((node (assistant-find-node node-name)))
 215     (set (make-local-variable 'assistant-widgets) nil)
 216     (assistant-set-defaults node)
 217     (setq assistant-current-node node-name)
 218     (erase-buffer)
 219     (insert (cadar assistant-data) "\n\n")
 220     (insert node-name "\n\n")
 221     (assistant-render-text (assistant-get node "text") node)
 222     (insert "\n\n")
 223     (when assistant-previous-node
 224       (assistant-node-button 'previous assistant-previous-node))
 225     (assistant-node-button 'next (assistant-find-next-node))
 226     (insert "\n")))
 227
 228 (defun assistant-node-button (type node)
 229   (let ((text (if (eq type 'next)
 230                   (assistant-next-node-text node)
 231                 (assistant-previous-node-text node))))
 232     (widget-create
 233      'push-button
 234      :assistant-node node
 235      :assistant-type type
 236      :notify (lambda (widget &rest ignore)
 237                (let* ((node (widget-get widget :assistant-node))
 238                       (type (widget-get widget :assistant-type)))
 239                  (when (eq type 'next)
 240                    (assistant-get-widget-values)
 241                    (assistant-validate))
 242                  (if (null node)
 243                      (assistant-finish)
 244                    (assistant-render-node node))))
 245      text)
 246     (use-local-map widget-keymap)))
 247
 248 (defun assistant-validate-types (node)
 249   (dolist (variable (assistant-get-list node "variable"))
 250     (setq variable (cadr variable))
 251     (let ((type (nth 1 variable))
 252           (value (nth 3 variable)))
 253       (when
 254           (cond
 255            ((eq type :number)
 256             (string-match "[^0-9]" value))
 257            (t
 258             nil))
 259         (error "%s is not of type %s: %s"
 260                (car variable) type value)))))
 261
 262 (defun assistant-get-widget-values ()
 263   (let ((node (assistant-find-node assistant-current-node)))
 264     (dolist (widget assistant-widgets)
 265       (assistant-set-variable
 266        node (widget-get widget :assistant-variable)
 267        (widget-value widget)))))
 268
 269 (defun assistant-validate ()
 270   (let* ((node (assistant-find-node assistant-current-node))
 271          (validation (assistant-get node "validate"))
 272          result)
 273     (assistant-validate-types node)
 274     (when validation
 275       (when (setq result (assistant-eval validation node))
 276         (unless (y-or-n-p (format "Error: %s.  Continue? " result))
 277           (error "%s" result))))
 278     (assistant-set node "save" t)))
 279
 280 (defun assistant-find-next-node ()
 281   (let* ((node (assistant-find-node assistant-current-node))
 282          (nexts (assistant-get-list node "next"))
 283          next elem)
 284     (while (and (setq elem (pop nexts))
 285                 (not next))
 286       (when (assistant-eval (car elem) node)
 287         (setq next (cadr elem))))
 288     next))
 289
 290 (defun assistant-eval (form node)
 291   (let ((bindings nil))
 292     (dolist (variable (assistant-get-list node "variable"))
 293       (setq variable (cadr variable))
 294       (push (list (car variable) (nth 3 variable))
 295             bindings))
 296     (eval
 297      `(let ,bindings
 298         ,form))))
 299
 300 (defun assistant-finish ()
 301   (let ((results nil)
 302         result)
 303     (dolist (node (cdr assistant-data))
 304       (when (assistant-get node "save")
 305         (setq result (assistant-get node "result"))
 306         (push (list (car result)
 307                     (assistant-eval (cadr result) node))
 308               results)))
 309     (message "Results: %s"
 310              (nreverse results))))
 311
 312 (provide 'assistant)
 313
 314 ;;; assistant.el ends here