1 ;;; fuel-scaffold.el -- interaction with tools.scaffold
3 ;; Copyright (C) 2009 Jose Antonio Ortega Ruiz
4 ;; See http://factorcode.org/license.txt for BSD license.
6 ;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
7 ;; Keywords: languages, fuel, factor
8 ;; Start date: Sun Jan 11, 2009 18:40
12 ;; Utilities for creating new vocabulary files and other boilerplate.
13 ;; Mainly, an interface to Factor's tools.scaffold.
19 (require 'fuel-syntax)
25 (defgroup fuel-scaffold nil
26 "Options for FUEL's scaffolding."
29 (defcustom fuel-scaffold-developer-name nil
30 "The name to be inserted as yours in scaffold templates."
32 (const :tag "Factor's value for developer-name" nil))
33 :group 'fuel-scaffold)
36 ;;; Auxiliary functions:
38 (defun fuel-scaffold--vocab-roots ()
39 (let ((cmd '(:fuel* (vocab-roots get :get) "fuel")))
40 (fuel-eval--retort-result (fuel-eval--send/wait cmd))))
42 (defun fuel-scaffold--dev-name ()
43 (or fuel-scaffold-developer-name
44 (let ((cmd '(:fuel* (developer-name get :get) "fuel")))
45 (fuel-eval--retort-result (fuel-eval--send/wait cmd)))
48 (defun fuel-scaffold--first-vocab ()
49 (goto-char (point-min))
50 (re-search-forward fuel-syntax--current-vocab-regex nil t))
52 (defsubst fuel-scaffold--vocab (file)
54 (set-buffer (find-file-noselect file))
55 (fuel-scaffold--first-vocab)
56 (fuel-syntax--current-vocab)))
58 (defconst fuel-scaffold--tests-header-format
59 "! Copyright (C) %s %s
60 ! See http://factorcode.org/license.txt for BSD license.
61 USING: %s tools.test ;
65 (defsubst fuel-scaffold--check-auto (var)
66 (and var (or (eq var 'always) (y-or-n-p "Insert template? "))))
68 (defun fuel-scaffold--tests (parent)
69 (when (and parent (fuel-scaffold--check-auto fuel-scaffold-test-autoinsert-p))
70 (let ((year (format-time-string "%Y"))
71 (name (fuel-scaffold--dev-name))
72 (vocab (fuel-scaffold--vocab parent)))
73 (insert (format fuel-scaffold--tests-header-format
74 year name vocab vocab))
77 (defsubst fuel-scaffold--create-docs (vocab)
78 (let ((cmd `(:fuel* (,vocab ,fuel-scaffold-developer-name fuel-scaffold-help)
80 (fuel-eval--send/wait cmd)))
82 (defsubst fuel-scaffold--create-tests (vocab)
83 (let ((cmd `(:fuel* (,vocab ,fuel-scaffold-developer-name fuel-scaffold-tests)
85 (fuel-eval--send/wait cmd)))
87 (defsubst fuel-scaffold--create-authors (vocab)
88 (let ((cmd `(:fuel* (,vocab ,fuel-scaffold-developer-name fuel-scaffold-authors) "fuel")))
89 (fuel-eval--send/wait cmd)))
91 (defsubst fuel-scaffold--create-tags (vocab tags)
92 (let ((cmd `(:fuel* (,vocab ,tags fuel-scaffold-tags) "fuel")))
93 (fuel-eval--send/wait cmd)))
95 (defsubst fuel-scaffold--create-summary (vocab summary)
96 (let ((cmd `(:fuel* (,vocab ,summary fuel-scaffold-summary) "fuel")))
97 (fuel-eval--send/wait cmd)))
99 (defun fuel-scaffold--help (parent)
100 (when (and parent (fuel-scaffold--check-auto fuel-scaffold-help-autoinsert-p))
101 (let* ((ret (fuel-scaffold--create-docs (fuel-scaffold--vocab parent)))
102 (file (fuel-eval--retort-result ret)))
104 (revert-buffer t t t)
105 (when (and fuel-scaffold-help-header-only-p
106 (fuel-scaffold--first-vocab))
107 (delete-region (1+ (point)) (point-max))
109 (message "Inserting template ... done."))
110 (goto-char (point-min)))))
112 (defun fuel-scaffold--maybe-insert ()
114 (or (fuel-scaffold--tests (factor-mode--in-tests))
115 (fuel-scaffold--help (factor-mode--in-docs)))))
120 (defun fuel-scaffold-vocab (&optional other-window name-hint root-hint)
121 "Creates a directory in the given root for a new vocabulary and
122 adds source and authors.txt files. Prompts the user for optional summary,
123 tags, help, and test file creation.
125 You can configure `fuel-scaffold-developer-name' (set by default to
126 `user-full-name') for the name to be inserted in the generated files."
128 (let* ((name (read-string "Vocab name: " name-hint))
129 (root (completing-read "Vocab root: "
130 (fuel-scaffold--vocab-roots)
131 nil t (or root-hint "resource:")))
132 (summary (read-string "Vocab summary (empty for none): "))
133 (tags (read-string "Vocab tags (empty for none): "))
134 (help (y-or-n-p "Scaffold help? "))
135 (tests (y-or-n-p "Scaffold tests? "))
136 (cmd `(:fuel* ((,root ,name ,fuel-scaffold-developer-name)
137 (fuel-scaffold-vocab)) "fuel"))
138 (ret (fuel-eval--send/wait cmd))
139 (file (fuel-eval--retort-result ret)))
141 (error "Error creating vocab (%s)" (car (fuel-eval--retort-error ret))))
142 (when (not (equal "" summary))
143 (fuel-scaffold--create-summary name summary))
144 (when (not (equal "" tags))
145 (fuel-scaffold--create-tags name tags))
147 (fuel-scaffold--create-docs name))
149 (fuel-scaffold--create-tests name))
150 (if other-window (find-file-other-window file) (find-file file))
151 (goto-char (point-max))
154 (defun fuel-scaffold-help (&optional arg)
155 "Creates, if it does not already exist, a help file with
156 scaffolded help for each word in the current vocabulary.
158 With prefix argument, ask for the vocabulary name.
159 You can configure `fuel-scaffold-developer-name' (set by default to
160 `user-full-name') for the name to be inserted in the generated file."
162 (let* ((vocab (or (and (not arg) (fuel-syntax--current-vocab))
163 (fuel-completion--read-vocab nil)))
164 (ret (fuel-scaffold--create-docs vocab))
165 (file (fuel-eval--retort-result ret)))
167 (error "Error creating help file" (car (fuel-eval--retort-error ret))))
170 (defun fuel-scaffold-tests (&optional arg)
171 "Creates, if it does not already exist, a tests file for the current vocabulary.
173 With prefix argument, ask for the vocabulary name.
174 You can configure `fuel-scaffold-developer-name' (set by default to
175 `user-full-name') for the name to be inserted in the generated file."
177 (let* ((vocab (or (and (not arg) (fuel-syntax--current-vocab))
178 (fuel-completion--read-vocab nil)))
179 (ret (fuel-scaffold--create-tests vocab))
180 (file (fuel-eval--retort-result ret)))
182 (error "Error creating tests file" (car (fuel-eval--retort-error ret))))
185 (defun fuel-scaffold-authors (&optional arg)
186 "Creates, if it does not already exist, an authors file for the current vocabulary.
188 With prefix argument, ask for the vocabulary name.
189 You can configure `fuel-scaffold-developer-name' (set by default to
190 `user-full-name') for the name to be inserted in the generated file."
192 (let* ((vocab (or (and (not arg) (fuel-syntax--current-vocab))
193 (fuel-completion--read-vocab nil)))
194 (ret (fuel-scaffold--create-authors vocab))
195 (file (fuel-eval--retort-result ret)))
197 (error "Error creating authors file" (car (fuel-eval--retort-error ret))))
200 (defun fuel-scaffold-tags (&optional arg)
201 "Creates, if it does not already exist, a tags file for the current vocabulary."
203 (let* ((vocab (or (and (not arg) (fuel-syntax--current-vocab))
204 (fuel-completion--read-vocab nil)))
205 (tags (read-string "Tags: "))
206 (ret (fuel-scaffold--create-tags vocab tags))
207 (file (fuel-eval--retort-result ret)))
209 (error "Error creating tags file" (car (fuel-eval--retort-error ret))))
212 (defun fuel-scaffold-summary (&optional arg)
213 "Creates, if it does not already exist, a summary file for the current vocabulary."
215 (let* ((vocab (or (and (not arg ) (fuel-syntax--current-vocab))
216 (fuel-completion--read-vocab nil)))
217 (summary (read-string "Summary: "))
218 (ret (fuel-scaffold--create-summary vocab summary))
219 (file (fuel-eval--retort-result ret)))
221 (error "Error creating summary file" (car (fuel-eval--retort-error ret))))
225 (provide 'fuel-scaffold)
226 ;;; fuel-scaffold.el ends here