Commit | Line | Data |
---|---|---|
07a79ce4 | 1 | ;;; srecode/insert.el --- Insert srecode templates to an output stream. |
4d902e6f | 2 | |
acaf905b | 3 | ;; Copyright (C) 2005, 2007-2012 Free Software Foundation, Inc. |
4d902e6f CY |
4 | |
5 | ;; Author: Eric M. Ludlam <zappo@gnu.org> | |
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 3 of the License, or | |
12 | ;; (at your option) 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. If not, see <http://www.gnu.org/licenses/>. | |
21 | ||
22 | ;;; Commentary: | |
23 | ;; | |
24 | ;; Define and implements specific inserter objects. | |
25 | ;; | |
26 | ;; Manage the insertion process for a template. | |
27 | ;; | |
28 | ||
b9749554 EL |
29 | (eval-when-compile |
30 | (require 'cl)) ;; for `lexical-let' | |
31 | ||
4d902e6f CY |
32 | (require 'srecode/compile) |
33 | (require 'srecode/find) | |
34 | (require 'srecode/dictionary) | |
a70bfe61 | 35 | (require 'srecode/args) |
4d902e6f CY |
36 | |
37 | (defvar srecode-template-inserter-point) | |
38 | (declare-function srecode-overlaid-activate "srecode/fields") | |
39 | (declare-function srecode-template-inserted-region "srecode/fields") | |
40 | ||
41 | ;;; Code: | |
42 | ||
43 | (defcustom srecode-insert-ask-variable-method 'ask | |
44 | "Determine how to ask for a dictionary value when inserting a template. | |
45 | Only the ASK style inserter will query the user for a value. | |
46 | Dictionary value references that ask begin with the ? character. | |
47 | Possible values are: | |
48 | 'ask - Prompt in the minibuffer as the value is inserted. | |
49 | 'field - Use the dictionary macro name as the inserted value, | |
50 | and place a field there. Matched fields change together. | |
51 | ||
52 | NOTE: The field feature does not yet work with XEmacs." | |
53 | :group 'srecode | |
54 | :type '(choice (const :tag "Ask" ask) | |
b9749554 | 55 | (const :tag "Field" field))) |
4d902e6f CY |
56 | |
57 | (defvar srecode-insert-with-fields-in-progress nil | |
58 | "Non-nil means that we are actively inserting a template with fields.") | |
59 | ||
60 | ;;; INSERTION COMMANDS | |
61 | ;; | |
62 | ;; User level commands for inserting stuff. | |
63 | (defvar srecode-insertion-start-context nil | |
64 | "The context that was at point at the beginning of the template insertion.") | |
65 | ||
66 | (defun srecode-insert-again () | |
67 | "Insert the previously inserted template (by name) again." | |
68 | (interactive) | |
69 | (let ((prev (car srecode-read-template-name-history))) | |
70 | (if prev | |
71 | (srecode-insert prev) | |
72 | (call-interactively 'srecode-insert)))) | |
73 | ||
74 | ;;;###autoload | |
75 | (defun srecode-insert (template-name &rest dict-entries) | |
2f10955c | 76 | "Insert the template TEMPLATE-NAME into the current buffer at point. |
4d902e6f CY |
77 | DICT-ENTRIES are additional dictionary values to add." |
78 | (interactive (list (srecode-read-template-name "Template Name: "))) | |
79 | (if (not (srecode-table)) | |
80 | (error "No template table found for mode %s" major-mode)) | |
81 | (let ((newdict (srecode-create-dictionary)) | |
82 | (temp (srecode-template-get-table (srecode-table) template-name)) | |
83 | (srecode-insertion-start-context (srecode-calculate-context)) | |
84 | ) | |
85 | (if (not temp) | |
86 | (error "No Template named %s" template-name)) | |
87 | (while dict-entries | |
88 | (srecode-dictionary-set-value newdict | |
89 | (car dict-entries) | |
90 | (car (cdr dict-entries))) | |
91 | (setq dict-entries (cdr (cdr dict-entries)))) | |
4d902e6f CY |
92 | (srecode-insert-fcn temp newdict) |
93 | ;; Don't put code here. We need to return the end-mark | |
94 | ;; for this insertion step. | |
95 | )) | |
96 | ||
97 | (defun srecode-insert-fcn (template dictionary &optional stream skipresolver) | |
98 | "Insert TEMPLATE using DICTIONARY into STREAM. | |
99 | Optional SKIPRESOLVER means to avoid refreshing the tag list, | |
100 | or resolving any template arguments. It is assumed the caller | |
101 | has set everything up already." | |
102 | ;; Perform the insertion. | |
103 | (let ((standard-output (or stream (current-buffer))) | |
104 | (end-mark nil)) | |
b9749554 EL |
105 | ;; Merge any template entries into the input dictionary. |
106 | (when (slot-boundp template 'dictionary) | |
107 | (srecode-dictionary-merge dictionary (oref template dictionary))) | |
108 | ||
4d902e6f CY |
109 | (unless skipresolver |
110 | ;; Make sure the semantic tags are up to date. | |
111 | (semantic-fetch-tags) | |
112 | ;; Resolve the arguments | |
113 | (srecode-resolve-arguments template dictionary)) | |
114 | ;; Insert | |
115 | (if (bufferp standard-output) | |
116 | ;; If there is a buffer, turn off various hooks. This will cause | |
117 | ;; the mod hooks to be buffered up during the insert, but | |
118 | ;; prevent tools like font-lock from fontifying mid-template. | |
b9749554 | 119 | ;; Especially important during insertion of complex comments that |
4d902e6f CY |
120 | ;; cause the new font-lock to comment-color stuff after the inserted |
121 | ;; comment. | |
122 | ;; | |
123 | ;; I'm not sure about the motion hooks. It seems like a good | |
124 | ;; idea though. | |
125 | ;; | |
126 | ;; Borrowed these concepts out of font-lock. | |
127 | ;; | |
128 | ;; I tried `combine-after-change-calls', but it did not have | |
129 | ;; the effect I wanted. | |
130 | (let ((start (point))) | |
131 | (let ((inhibit-point-motion-hooks t) | |
132 | (inhibit-modification-hooks t) | |
133 | ) | |
134 | (srecode--insert-into-buffer template dictionary) | |
135 | ) | |
136 | ;; Now call those after change functions. | |
137 | (run-hook-with-args 'after-change-functions | |
138 | start (point) 0) | |
139 | ) | |
140 | (srecode-insert-method template dictionary)) | |
141 | ;; Handle specialization of the POINT inserter. | |
142 | (when (and (bufferp standard-output) | |
143 | (slot-boundp 'srecode-template-inserter-point 'point) | |
144 | ) | |
145 | (set-buffer standard-output) | |
146 | (setq end-mark (point-marker)) | |
147 | (goto-char (oref srecode-template-inserter-point point))) | |
148 | (oset-default 'srecode-template-inserter-point point eieio-unbound) | |
149 | ||
150 | ;; Return the end-mark. | |
151 | (or end-mark (point))) | |
152 | ) | |
153 | ||
154 | (defun srecode--insert-into-buffer (template dictionary) | |
155 | "Insert a TEMPLATE with DICTIONARY into a buffer. | |
156 | Do not call this function yourself. Instead use: | |
157 | `srecode-insert' - Inserts by name. | |
158 | `srecode-insert-fcn' - Insert with objects. | |
159 | This function handles the case from one of the above functions when | |
160 | the template is inserted into a buffer. It looks | |
161 | at `srecode-insert-ask-variable-method' to decide if unbound dictionary | |
162 | entries ask questions or insert editable fields. | |
163 | ||
164 | Buffer based features related to change hooks is handled one level up." | |
165 | ;; This line prevents the field archive from being let bound | |
166 | ;; while the field insert tool is loaded via autoloads during | |
167 | ;; the insert. | |
168 | (when (eq srecode-insert-ask-variable-method 'field) | |
b82525f2 | 169 | (require 'srecode/fields)) |
4d902e6f CY |
170 | |
171 | (let ((srecode-field-archive nil) ; Prevent field leaks during insert | |
172 | (start (point)) ; Beginning of the region. | |
173 | ) | |
174 | ;; This sub-let scopes the 'in-progress' piece so we know | |
175 | ;; when to setup the end-template. | |
176 | (let ((srecode-insert-with-fields-in-progress | |
177 | (if (eq srecode-insert-ask-variable-method 'field) t nil)) | |
178 | ) | |
179 | (srecode-insert-method template dictionary) | |
180 | ) | |
181 | ;; If we are not in-progress, and we insert fields, then | |
182 | ;; create the end-template with fields editable area. | |
183 | (when (and (not srecode-insert-with-fields-in-progress) | |
184 | (eq srecode-insert-ask-variable-method 'field) ; Only if user asked | |
185 | srecode-field-archive ; Only if there were fields created | |
186 | ) | |
187 | (let ((reg | |
188 | ;; Create the field-driven editable area. | |
189 | (srecode-template-inserted-region | |
190 | "TEMPLATE" :start start :end (point)))) | |
191 | (srecode-overlaid-activate reg)) | |
192 | ) | |
193 | ;; We return with 'point being the end of the template insertion | |
194 | ;; area. Return value is not important. | |
195 | )) | |
196 | ||
197 | ;;; TEMPLATE ARGUMENTS | |
198 | ;; | |
737b5223 | 199 | ;; Some templates have arguments. Each argument is associated with |
4d902e6f CY |
200 | ;; a function that can resolve the inputs needed. |
201 | (defun srecode-resolve-arguments (temp dict) | |
202 | "Resolve all the arguments needed by the template TEMP. | |
203 | Apply anything learned to the dictionary DICT." | |
204 | (srecode-resolve-argument-list (oref temp args) dict temp)) | |
205 | ||
206 | (defun srecode-resolve-argument-list (args dict &optional temp) | |
207 | "Resolve arguments in the argument list ARGS. | |
208 | ARGS is a list of symbols, such as :blank, or :file. | |
209 | Apply values to DICT. | |
d1f18ec0 | 210 | Optional argument TEMP is the template that is getting its arguments resolved." |
4d902e6f CY |
211 | (let ((fcn nil)) |
212 | (while args | |
213 | (setq fcn (intern-soft (concat "srecode-semantic-handle-" | |
214 | (symbol-name (car args))))) | |
215 | (if (not fcn) | |
216 | (error "Error resolving template argument %S" (car args))) | |
217 | (if temp | |
218 | (condition-case nil | |
219 | ;; Allow some to accept a 2nd argument optionally. | |
220 | ;; They throw an error if not available, so try again. | |
221 | (funcall fcn dict temp) | |
222 | (wrong-number-of-arguments (funcall fcn dict))) | |
223 | (funcall fcn dict)) | |
224 | (setq args (cdr args))) | |
225 | )) | |
226 | ||
227 | ;;; INSERTION STACK & METHOD | |
228 | ;; | |
229 | ;; Code managing the top-level insert method and the current | |
230 | ;; insertion stack. | |
231 | ;; | |
232 | (defmethod srecode-push ((st srecode-template)) | |
233 | "Push the srecoder template ST onto the active stack." | |
234 | (oset st active (cons st (oref st active)))) | |
235 | ||
236 | (defmethod srecode-pop :STATIC ((st srecode-template)) | |
237 | "Pop the srecoder template ST onto the active stack. | |
238 | ST can be a class, or an object." | |
239 | (oset st active (cdr (oref st active)))) | |
240 | ||
241 | (defmethod srecode-peek :STATIC ((st srecode-template)) | |
242 | "Fetch the topmost active template record. ST can be a class." | |
243 | (car (oref st active))) | |
244 | ||
245 | (defmethod srecode-insert-method ((st srecode-template) dictionary) | |
246 | "Insert the srecoder template ST." | |
247 | ;; Merge any template entries into the input dictionary. | |
b9749554 EL |
248 | ;; This may happen twice since some templates arguments need |
249 | ;; these dictionary values earlier, but these values always | |
250 | ;; need merging for template inserting in other templates. | |
4d902e6f CY |
251 | (when (slot-boundp st 'dictionary) |
252 | (srecode-dictionary-merge dictionary (oref st dictionary))) | |
253 | ;; Do an insertion. | |
254 | (unwind-protect | |
255 | (let ((c (oref st code))) | |
256 | (srecode-push st) | |
257 | (srecode-insert-code-stream c dictionary)) | |
09e80d9f | 258 | ;; Popping the stack is protected. |
4d902e6f CY |
259 | (srecode-pop st))) |
260 | ||
261 | (defun srecode-insert-code-stream (code dictionary) | |
262 | "Insert the CODE from a template into `standard-output'. | |
263 | Use DICTIONARY to resolve any macros." | |
264 | (while code | |
265 | (cond ((stringp (car code)) | |
266 | (princ (car code))) | |
267 | (t | |
268 | (srecode-insert-method (car code) dictionary))) | |
269 | (setq code (cdr code)))) | |
270 | ||
271 | ;;; INSERTERS | |
272 | ;; | |
273 | ;; Specific srecode inserters. | |
274 | ;; The base class is from srecode-compile. | |
275 | ;; | |
b9749554 | 276 | ;; Each inserter handles various macro codes from the template. |
4d902e6f CY |
277 | ;; The `code' slot specifies a character used to identify which |
278 | ;; inserter is to be created. | |
279 | ;; | |
280 | (defclass srecode-template-inserter-newline (srecode-template-inserter) | |
281 | ((key :initform "\n" | |
282 | :allocation :class | |
283 | :documentation | |
284 | "The character code used to identify inserters of this style.") | |
285 | (hard :initform nil | |
286 | :initarg :hard | |
287 | :documentation | |
288 | "Is this a hard newline (always inserted) or optional? | |
289 | Optional newlines don't insert themselves if they are on a blank line | |
290 | by themselves.") | |
291 | ) | |
292 | "Insert a newline, and possibly do indenting. | |
293 | Specify the :indent argument to enable automatic indentation when newlines | |
294 | occur in your template.") | |
295 | ||
296 | (defmethod srecode-insert-method ((sti srecode-template-inserter-newline) | |
297 | dictionary) | |
298 | "Insert the STI inserter." | |
299 | ;; To be safe, indent the previous line since the template will | |
300 | ;; change what is there to indent | |
301 | (let ((i (srecode-dictionary-lookup-name dictionary "INDENT")) | |
302 | (inbuff (bufferp standard-output)) | |
303 | (doit t) | |
304 | (pm (point-marker))) | |
305 | (when (and inbuff (not (oref sti hard))) | |
306 | ;; If this is not a hard newline, we need do the calculation | |
307 | ;; and set "doit" to nil. | |
308 | (beginning-of-line) | |
309 | (save-restriction | |
310 | (narrow-to-region (point) pm) | |
311 | (when (looking-at "\\s-*$") | |
312 | (setq doit nil))) | |
313 | (goto-char pm) | |
314 | ) | |
fa463103 | 315 | ;; Do indentation regardless of the newline. |
4d902e6f CY |
316 | (when (and (eq i t) inbuff) |
317 | (indent-according-to-mode) | |
318 | (goto-char pm)) | |
319 | ||
320 | (when doit | |
321 | (princ "\n") | |
322 | ;; Indent after the newline, particularly for numeric indents. | |
323 | (cond ((and (eq i t) (bufferp standard-output)) | |
324 | ;; WARNING - indent according to mode requires that standard-output | |
325 | ;; is a buffer! | |
326 | ;; @todo - how to indent in a string??? | |
327 | (setq pm (point-marker)) | |
328 | (indent-according-to-mode) | |
329 | (goto-char pm)) | |
330 | ((numberp i) | |
331 | (princ (make-string i " "))) | |
332 | ((stringp i) | |
333 | (princ i)))))) | |
334 | ||
335 | (defmethod srecode-dump ((ins srecode-template-inserter-newline) indent) | |
336 | "Dump the state of the SRecode template inserter INS." | |
337 | (call-next-method) | |
338 | (when (oref ins hard) | |
339 | (princ " : hard") | |
340 | )) | |
341 | ||
342 | (defclass srecode-template-inserter-blank (srecode-template-inserter) | |
343 | ((key :initform "\r" | |
344 | :allocation :class | |
345 | :documentation | |
d1f18ec0 | 346 | "The character representing this inserter style. |
4d902e6f CY |
347 | Can't be blank, or it might be used by regular variable insertion.") |
348 | (where :initform 'begin | |
349 | :initarg :where | |
350 | :documentation | |
d1f18ec0 | 351 | "This should be 'begin or 'end, indicating where to insert a CR. |
4d902e6f | 352 | When set to 'begin, it will insert a CR if we are not at 'bol'. |
d1f18ec0 | 353 | When set to 'end it will insert a CR if we are not at 'eol'.") |
4d902e6f CY |
354 | ;; @TODO - Add slot and control for the number of blank |
355 | ;; lines before and after point. | |
356 | ) | |
357 | "Insert a newline before and after a template, and possibly do indenting. | |
358 | Specify the :blank argument to enable this inserter.") | |
359 | ||
360 | (defmethod srecode-insert-method ((sti srecode-template-inserter-blank) | |
361 | dictionary) | |
362 | "Make sure there is no text before or after point." | |
363 | (let ((i (srecode-dictionary-lookup-name dictionary "INDENT")) | |
364 | (inbuff (bufferp standard-output)) | |
365 | (pm (point-marker))) | |
366 | (when (and inbuff | |
367 | ;; Don't do this if we are not the active template. | |
368 | (= (length (oref srecode-template active)) 1)) | |
369 | ||
370 | (when (and (eq i t) inbuff (not (eq (oref sti where) 'begin))) | |
371 | (indent-according-to-mode) | |
372 | (goto-char pm)) | |
373 | ||
374 | (cond ((and (eq (oref sti where) 'begin) (not (bolp))) | |
375 | (princ "\n")) | |
376 | ((eq (oref sti where) 'end) | |
377 | ;; If there is whitespace after pnt, then clear it out. | |
378 | (when (looking-at "\\s-*$") | |
379 | (delete-region (point) (point-at-eol))) | |
380 | (when (not (eolp)) | |
381 | (princ "\n"))) | |
382 | ) | |
383 | (setq pm (point-marker)) | |
384 | (when (and (eq i t) inbuff (not (eq (oref sti where) 'end))) | |
385 | (indent-according-to-mode) | |
386 | (goto-char pm)) | |
387 | ))) | |
388 | ||
389 | (defclass srecode-template-inserter-comment (srecode-template-inserter) | |
390 | ((key :initform ?! | |
391 | :allocation :class | |
392 | :documentation | |
393 | "The character code used to identify inserters of this style.") | |
394 | ) | |
395 | "Allow comments within template coding. This inserts nothing.") | |
396 | ||
397 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-comment) | |
398 | escape-start escape-end) | |
399 | "Insert an example using inserter INS. | |
400 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
401 | (princ " ") | |
402 | (princ escape-start) | |
403 | (princ "! Miscellaneous text commenting in your template. ") | |
404 | (princ escape-end) | |
405 | (terpri) | |
406 | ) | |
407 | ||
408 | (defmethod srecode-insert-method ((sti srecode-template-inserter-comment) | |
409 | dictionary) | |
410 | "Don't insert anything for comment macros in STI." | |
411 | nil) | |
412 | ||
413 | ||
414 | (defclass srecode-template-inserter-variable (srecode-template-inserter) | |
415 | ((key :initform nil | |
416 | :allocation :class | |
417 | :documentation | |
418 | "The character code used to identify inserters of this style.")) | |
d1f18ec0 | 419 | "Insert the value of a dictionary entry. |
4d902e6f CY |
420 | If there is no entry, insert nothing.") |
421 | ||
422 | (defvar srecode-inserter-variable-current-dictionary nil | |
423 | "The active dictionary when calling a variable filter.") | |
424 | ||
425 | (defmethod srecode-insert-variable-secondname-handler | |
426 | ((sti srecode-template-inserter-variable) dictionary value secondname) | |
427 | "For VALUE handle SECONDNAME behaviors for this variable inserter. | |
428 | Return the result as a string. | |
429 | By default, treat as a function name. | |
430 | If SECONDNAME is nil, return VALUE." | |
431 | (if secondname | |
432 | (let ((fcnpart (read secondname))) | |
433 | (if (fboundp fcnpart) | |
434 | (let ((srecode-inserter-variable-current-dictionary dictionary)) | |
435 | (funcall fcnpart value)) | |
436 | ;; Else, warn. | |
2f10955c | 437 | (error "Variable insertion second arg %s is not a function" |
4d902e6f CY |
438 | secondname))) |
439 | value)) | |
440 | ||
441 | (defmethod srecode-insert-method ((sti srecode-template-inserter-variable) | |
442 | dictionary) | |
443 | "Insert the STI inserter." | |
444 | ;; Convert the name into a name/fcn pair | |
445 | (let* ((name (oref sti :object-name)) | |
446 | (fcnpart (oref sti :secondname)) | |
447 | (val (srecode-dictionary-lookup-name | |
448 | dictionary name)) | |
449 | (do-princ t) | |
450 | ) | |
451 | ;; Alert if a macro wasn't found. | |
452 | (when (not val) | |
453 | (message "Warning: macro %S was not found in the dictionary." name) | |
454 | (setq val "")) | |
455 | ;; If there was a functional part, call that function. | |
456 | (cond ;; Strings | |
457 | ((stringp val) | |
458 | (setq val (srecode-insert-variable-secondname-handler | |
459 | sti dictionary val fcnpart))) | |
460 | ;; Compound data value | |
461 | ((srecode-dictionary-compound-value-child-p val) | |
462 | ;; Force FCN to be a symbol | |
463 | (when fcnpart (setq fcnpart (read fcnpart))) | |
464 | ;; Convert compound value to a string with the fcn. | |
465 | (setq val (srecode-compound-toString val fcnpart dictionary)) | |
466 | ;; If the value returned is nil, then it may be a special | |
467 | ;; field inserter that requires us to set do-princ to nil. | |
468 | (when (not val) | |
469 | (setq do-princ nil) | |
470 | ) | |
471 | ) | |
472 | ;; Dictionaries... not allowed in this style | |
473 | ((srecode-dictionary-child-p val) | |
2f10955c | 474 | (error "Macro %s cannot insert a dictionary - use section macros instead" |
4d902e6f CY |
475 | name)) |
476 | ;; Other stuff... convert | |
477 | (t | |
2f10955c | 478 | (error "Macro %s cannot insert arbitrary data" name) |
4d902e6f CY |
479 | ;;(if (and val (not (stringp val))) |
480 | ;; (setq val (format "%S" val)))) | |
481 | )) | |
482 | ;; Output the dumb thing unless the type of thing specifically | |
b9749554 | 483 | ;; did the inserting for us. |
4d902e6f CY |
484 | (when do-princ |
485 | (princ val)))) | |
486 | ||
487 | (defclass srecode-template-inserter-ask (srecode-template-inserter-variable) | |
488 | ((key :initform ?? | |
489 | :allocation :class | |
490 | :documentation | |
491 | "The character code used to identify inserters of this style.") | |
492 | (prompt :initarg :prompt | |
493 | :initform nil | |
494 | :documentation | |
495 | "The prompt used to query for this dictionary value.") | |
496 | (defaultfcn :initarg :defaultfcn | |
497 | :initform nil | |
498 | :documentation | |
499 | "The function which can calculate a default value.") | |
500 | (read-fcn :initarg :read-fcn | |
501 | :initform 'read-string | |
502 | :documentation | |
503 | "The function used to read in the text for this prompt.") | |
504 | ) | |
d1f18ec0 | 505 | "Insert the value of a dictionary entry. |
4d902e6f CY |
506 | If there is no entry, prompt the user for the value to use. |
507 | The prompt text used is derived from the previous PROMPT command in the | |
508 | template file.") | |
509 | ||
b9749554 EL |
510 | (defmethod srecode-inserter-apply-state |
511 | ((ins srecode-template-inserter-ask) STATE) | |
4d902e6f CY |
512 | "For the template inserter INS, apply information from STATE. |
513 | Loop over the prompts to see if we have a match." | |
514 | (let ((prompts (oref STATE prompts)) | |
515 | ) | |
516 | (while prompts | |
517 | (when (string= (semantic-tag-name (car prompts)) | |
518 | (oref ins :object-name)) | |
519 | (oset ins :prompt | |
520 | (semantic-tag-get-attribute (car prompts) :text)) | |
521 | (oset ins :defaultfcn | |
522 | (semantic-tag-get-attribute (car prompts) :default)) | |
523 | (oset ins :read-fcn | |
524 | (or (semantic-tag-get-attribute (car prompts) :read) | |
525 | 'read-string)) | |
526 | ) | |
527 | (setq prompts (cdr prompts))) | |
528 | )) | |
529 | ||
530 | (defmethod srecode-insert-method ((sti srecode-template-inserter-ask) | |
531 | dictionary) | |
532 | "Insert the STI inserter." | |
533 | (let ((val (srecode-dictionary-lookup-name | |
534 | dictionary (oref sti :object-name)))) | |
535 | (if val | |
536 | ;; Does some extra work. Oh well. | |
537 | (call-next-method) | |
538 | ||
539 | ;; How is our -ask value determined? | |
540 | (if srecode-insert-with-fields-in-progress | |
541 | ;; Setup editable fields. | |
542 | (setq val (srecode-insert-method-field sti dictionary)) | |
543 | ;; Ask the question... | |
544 | (setq val (srecode-insert-method-ask sti dictionary))) | |
545 | ||
546 | ;; After asking, save in the dictionary so that | |
547 | ;; the user can use the same name again later. | |
548 | (srecode-dictionary-set-value | |
549 | (srecode-root-dictionary dictionary) | |
550 | (oref sti :object-name) val) | |
551 | ||
552 | ;; Now that this value is safely stowed in the dictionary, | |
553 | ;; we can do what regular inserters do. | |
554 | (call-next-method)))) | |
555 | ||
556 | (defmethod srecode-insert-ask-default ((sti srecode-template-inserter-ask) | |
557 | dictionary) | |
558 | "Derive the default value for an askable inserter STI. | |
559 | DICTIONARY is used to derive some values." | |
560 | (let ((defaultfcn (oref sti :defaultfcn))) | |
561 | (cond ((stringp defaultfcn) | |
562 | defaultfcn) | |
563 | ((functionp defaultfcn) | |
564 | (funcall defaultfcn)) | |
565 | ((and (listp defaultfcn) | |
566 | (eq (car defaultfcn) 'macro)) | |
567 | (srecode-dictionary-lookup-name | |
568 | dictionary (cdr defaultfcn))) | |
569 | ((null defaultfcn) | |
570 | "") | |
571 | (t | |
572 | (error "Unknown default for prompt: %S" | |
573 | defaultfcn))))) | |
574 | ||
575 | (defmethod srecode-insert-method-ask ((sti srecode-template-inserter-ask) | |
576 | dictionary) | |
577 | "Do the \"asking\" for the template inserter STI. | |
578 | Use DICTIONARY to resolve values." | |
579 | (let* ((prompt (oref sti prompt)) | |
580 | (default (srecode-insert-ask-default sti dictionary)) | |
581 | (reader (oref sti :read-fcn)) | |
582 | (val nil) | |
583 | ) | |
584 | (cond ((eq reader 'y-or-n-p) | |
585 | (if (y-or-n-p (or prompt | |
586 | (format "%s? " | |
587 | (oref sti :object-name)))) | |
588 | (setq val default) | |
589 | (setq val ""))) | |
590 | ((eq reader 'read-char) | |
591 | (setq val (format | |
592 | "%c" | |
593 | (read-char (or prompt | |
594 | (format "Char for %s: " | |
595 | (oref sti :object-name)))))) | |
596 | ) | |
597 | (t | |
598 | (save-excursion | |
599 | (setq val (funcall reader | |
600 | (or prompt | |
601 | (format "Specify %s: " | |
602 | (oref sti :object-name))) | |
603 | default | |
604 | ))))) | |
605 | ;; Return our derived value. | |
606 | val) | |
607 | ) | |
608 | ||
609 | (defmethod srecode-insert-method-field ((sti srecode-template-inserter-ask) | |
610 | dictionary) | |
611 | "Create an editable field for the template inserter STI. | |
612 | Use DICTIONARY to resolve values." | |
613 | (let* ((default (srecode-insert-ask-default sti dictionary)) | |
614 | (compound-value | |
615 | (srecode-field-value (oref sti :object-name) | |
616 | :firstinserter sti | |
617 | :defaultvalue default)) | |
618 | ) | |
619 | ;; Return this special compound value as the thing to insert. | |
620 | ;; This special compound value will repeat our asked question | |
621 | ;; across multiple locations. | |
622 | compound-value)) | |
623 | ||
624 | (defmethod srecode-dump ((ins srecode-template-inserter-ask) indent) | |
625 | "Dump the state of the SRecode template inserter INS." | |
626 | (call-next-method) | |
627 | (princ " : \"") | |
628 | (princ (oref ins prompt)) | |
629 | (princ "\"") | |
630 | ) | |
631 | ||
632 | (defclass srecode-template-inserter-width (srecode-template-inserter-variable) | |
633 | ((key :initform ?| | |
634 | :allocation :class | |
635 | :documentation | |
636 | "The character code used to identify inserters of this style.") | |
637 | ) | |
638 | "Inserts the value of a dictionary variable with a specific width. | |
d1f18ec0 JB |
639 | The second argument specifies the width, and a pad, separated by a colon. |
640 | Thus a specification of `10:left' will insert the value of A | |
4d902e6f CY |
641 | to 10 characters, with spaces added to the left. Use `right' for adding |
642 | spaces to the right.") | |
643 | ||
644 | (defmethod srecode-insert-variable-secondname-handler | |
645 | ((sti srecode-template-inserter-width) dictionary value width) | |
646 | "For VALUE handle WIDTH behaviors for this variable inserter. | |
647 | Return the result as a string. | |
648 | By default, treat as a function name." | |
649 | (if width | |
650 | ;; Trim or pad to new length | |
651 | (let* ((split (split-string width ":")) | |
652 | (width (string-to-number (nth 0 split))) | |
653 | (second (nth 1 split)) | |
654 | (pad (cond ((or (null second) (string= "right" second)) | |
655 | 'right) | |
656 | ((string= "left" second) | |
657 | 'left) | |
658 | (t | |
659 | (error "Unknown pad type %s" second))))) | |
660 | (if (>= (length value) width) | |
661 | ;; Simple case - too long. | |
662 | (substring value 0 width) | |
663 | ;; We need to pad on one side or the other. | |
664 | (let ((padchars (make-string (- width (length value)) ? ))) | |
665 | (if (eq pad 'left) | |
666 | (concat padchars value) | |
667 | (concat value padchars))))) | |
2f10955c | 668 | (error "Width not specified for variable/width inserter"))) |
4d902e6f CY |
669 | |
670 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-width) | |
671 | escape-start escape-end) | |
672 | "Insert an example using inserter INS. | |
673 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
674 | (princ " ") | |
675 | (princ escape-start) | |
676 | (princ "|A:10:right") | |
677 | (princ escape-end) | |
678 | (terpri) | |
679 | ) | |
680 | ||
681 | (defvar srecode-template-inserter-point-override nil | |
b9749554 EL |
682 | "Point-positioning method for the SRecode template inserter. |
683 | When nil, perform normal point-positioning behavior. | |
684 | When the value is a cons cell (DEPTH . FUNCTION), call FUNCTION | |
685 | instead, unless the template nesting depth, measured | |
686 | by (length (oref srecode-template active)), is greater than | |
687 | DEPTH.") | |
688 | ||
4d902e6f CY |
689 | |
690 | (defclass srecode-template-inserter-point (srecode-template-inserter) | |
691 | ((key :initform ?^ | |
692 | :allocation :class | |
693 | :documentation | |
694 | "The character code used to identify inserters of this style.") | |
695 | (point :type (or null marker) | |
696 | :allocation :class | |
697 | :documentation | |
698 | "Record the value of (point) in this class slot. | |
699 | It is the responsibility of the inserter algorithm to clear this | |
700 | after a successful insertion.")) | |
701 | "Record the value of (point) when inserted. | |
702 | The cursor is placed at the ^ macro after insertion. | |
703 | Some inserter macros, such as `srecode-template-inserter-include-wrap' | |
704 | will place text at the ^ macro from the included macro.") | |
705 | ||
706 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-point) | |
707 | escape-start escape-end) | |
708 | "Insert an example using inserter INS. | |
709 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
710 | (princ " ") | |
711 | (princ escape-start) | |
712 | (princ "^") | |
713 | (princ escape-end) | |
714 | (terpri) | |
715 | ) | |
716 | ||
717 | (defmethod srecode-insert-method ((sti srecode-template-inserter-point) | |
718 | dictionary) | |
719 | "Insert the STI inserter. | |
720 | Save point in the class allocated 'point' slot. | |
b9749554 EL |
721 | If `srecode-template-inserter-point-override' non-nil then this |
722 | generalized marker will do something else. See | |
723 | `srecode-template-inserter-include-wrap' as an example." | |
724 | ;; If `srecode-template-inserter-point-override' is non-nil, its car | |
725 | ;; is the maximum template nesting depth for which the override is | |
726 | ;; valid. Compare this to the actual template nesting depth and | |
727 | ;; maybe use the override function which is stored in the cdr. | |
728 | (if (and srecode-template-inserter-point-override | |
729 | (<= (length (oref srecode-template active)) | |
730 | (car srecode-template-inserter-point-override))) | |
4d902e6f | 731 | ;; Disable the old override while we do this. |
b9749554 | 732 | (let ((over (cdr srecode-template-inserter-point-override)) |
4d902e6f | 733 | (srecode-template-inserter-point-override nil)) |
b9749554 | 734 | (funcall over dictionary)) |
4d902e6f CY |
735 | (oset sti point (point-marker)) |
736 | )) | |
737 | ||
738 | (defclass srecode-template-inserter-subtemplate (srecode-template-inserter) | |
739 | () | |
740 | "Wrap a section of a template under the control of a macro." | |
741 | :abstract t) | |
742 | ||
743 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-subtemplate) | |
744 | escape-start escape-end) | |
745 | "Insert an example using inserter INS. | |
746 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
747 | (call-next-method) | |
748 | (princ " Template Text to control") | |
749 | (terpri) | |
750 | (princ " ") | |
751 | (princ escape-start) | |
752 | (princ "/VARNAME") | |
753 | (princ escape-end) | |
754 | (terpri) | |
755 | ) | |
756 | ||
757 | (defmethod srecode-insert-subtemplate ((sti srecode-template-inserter-subtemplate) | |
758 | dict slot) | |
759 | "Insert a subtemplate for the inserter STI with dictionary DICT." | |
760 | ;; make sure that only dictionaries are used. | |
761 | (when (not (srecode-dictionary-child-p dict)) | |
762 | (error "Only section dictionaries allowed for %s" | |
763 | (object-name-string sti))) | |
764 | ;; Output the code from the sub-template. | |
765 | (srecode-insert-method (slot-value sti slot) dict) | |
766 | ) | |
767 | ||
768 | (defmethod srecode-insert-method-helper ((sti srecode-template-inserter-subtemplate) | |
769 | dictionary slot) | |
770 | "Do the work for inserting the STI inserter. | |
771 | Loops over the embedded CODE which was saved here during compilation. | |
772 | The template to insert is stored in SLOT." | |
773 | (let ((dicts (srecode-dictionary-lookup-name | |
774 | dictionary (oref sti :object-name)))) | |
b9749554 EL |
775 | (when (not (listp dicts)) |
776 | (error "Cannot insert section %S from non-section variable." | |
777 | (oref sti :object-name))) | |
4d902e6f CY |
778 | ;; If there is no section dictionary, then don't output anything |
779 | ;; from this section. | |
780 | (while dicts | |
b9749554 EL |
781 | (when (not (srecode-dictionary-p (car dicts))) |
782 | (error "Cannot insert section %S from non-section variable." | |
783 | (oref sti :object-name))) | |
4d902e6f CY |
784 | (srecode-insert-subtemplate sti (car dicts) slot) |
785 | (setq dicts (cdr dicts))))) | |
786 | ||
787 | (defmethod srecode-insert-method ((sti srecode-template-inserter-subtemplate) | |
788 | dictionary) | |
789 | "Insert the STI inserter. | |
790 | Calls back to `srecode-insert-method-helper' for this class." | |
791 | (srecode-insert-method-helper sti dictionary 'template)) | |
792 | ||
793 | ||
794 | (defclass srecode-template-inserter-section-start (srecode-template-inserter-subtemplate) | |
795 | ((key :initform ?# | |
796 | :allocation :class | |
797 | :documentation | |
798 | "The character code used to identify inserters of this style.") | |
799 | (template :initarg :template | |
800 | :documentation | |
d1f18ec0 | 801 | "A template used to frame the codes from this inserter.") |
4d902e6f CY |
802 | ) |
803 | "Apply values from a sub-dictionary to a template section. | |
804 | The dictionary saved at the named dictionary entry will be | |
805 | applied to the text between the section start and the | |
806 | `srecode-template-inserter-section-end' macro.") | |
807 | ||
808 | (defmethod srecode-parse-input ((ins srecode-template-inserter-section-start) | |
809 | tag input STATE) | |
810 | "For the section inserter INS, parse INPUT. | |
811 | Shorten input until the END token is found. | |
812 | Return the remains of INPUT." | |
813 | (let* ((out (srecode-compile-split-code tag input STATE | |
814 | (oref ins :object-name)))) | |
815 | (oset ins template (srecode-template | |
816 | (object-name-string ins) | |
817 | :context nil | |
818 | :args nil | |
819 | :code (cdr out))) | |
820 | (car out))) | |
821 | ||
822 | (defmethod srecode-dump ((ins srecode-template-inserter-section-start) indent) | |
823 | "Dump the state of the SRecode template inserter INS." | |
824 | (call-next-method) | |
825 | (princ "\n") | |
826 | (srecode-dump-code-list (oref (oref ins template) code) | |
827 | (concat indent " ")) | |
828 | ) | |
829 | ||
830 | (defclass srecode-template-inserter-section-end (srecode-template-inserter) | |
831 | ((key :initform ?/ | |
832 | :allocation :class | |
833 | :documentation | |
834 | "The character code used to identify inserters of this style.") | |
835 | ) | |
d1f18ec0 | 836 | "All template segments between the section-start and section-end |
4d902e6f CY |
837 | are treated specially.") |
838 | ||
839 | (defmethod srecode-insert-method ((sti srecode-template-inserter-section-end) | |
840 | dictionary) | |
841 | "Insert the STI inserter." | |
842 | ) | |
843 | ||
844 | (defmethod srecode-match-end ((ins srecode-template-inserter-section-end) name) | |
845 | ||
846 | "For the template inserter INS, do I end a section called NAME?" | |
847 | (string= name (oref ins :object-name))) | |
848 | ||
849 | (defclass srecode-template-inserter-include (srecode-template-inserter-subtemplate) | |
850 | ((key :initform ?> | |
851 | :allocation :class | |
852 | :documentation | |
853 | "The character code used to identify inserters of this style.") | |
854 | (includedtemplate | |
855 | :initarg :includedtemplate | |
856 | :documentation | |
857 | "The template included for this inserter.")) | |
858 | "Include a different template into this one. | |
859 | The included template will have additional dictionary entries from the subdictionary | |
860 | stored specified by this macro.") | |
861 | ||
862 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-include) | |
863 | escape-start escape-end) | |
864 | "Insert an example using inserter INS. | |
865 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
866 | (princ " ") | |
867 | (princ escape-start) | |
868 | (princ ">DICTNAME:contextname:templatename") | |
869 | (princ escape-end) | |
870 | (terpri) | |
871 | ) | |
872 | ||
873 | (defmethod srecode-insert-include-lookup ((sti srecode-template-inserter-include) | |
874 | dictionary) | |
875 | "For the template inserter STI, lookup the template to include. | |
876 | Finds the template with this macro function part and stores it in | |
877 | this template instance." | |
878 | (let* ((templatenamepart (oref sti :secondname)) | |
879 | ) | |
880 | ;; If there was no template name, throw an error | |
881 | (if (not templatenamepart) | |
2f10955c | 882 | (error "Include macro %s needs a template name" (oref sti :object-name))) |
b9749554 EL |
883 | |
884 | ;; NOTE: We used to cache the template and not look it up a second time, | |
885 | ;; but changes in the template tables can change which template is | |
886 | ;; eventually discovered, so now we always lookup that template. | |
887 | ||
888 | ;; Calculate and store the discovered template | |
889 | (let ((tmpl (srecode-template-get-table (srecode-table) | |
890 | templatenamepart)) | |
891 | (active (oref srecode-template active)) | |
892 | ctxt) | |
893 | (when (not tmpl) | |
894 | ;; If it isn't just available, scan back through | |
895 | ;; the active template stack, searching for a matching | |
896 | ;; context. | |
897 | (while (and (not tmpl) active) | |
898 | (setq ctxt (oref (car active) context)) | |
899 | (setq tmpl (srecode-template-get-table (srecode-table) | |
900 | templatenamepart | |
901 | ctxt)) | |
4d902e6f | 902 | (when (not tmpl) |
b9749554 EL |
903 | (when (slot-boundp (car active) 'table) |
904 | (let ((app (oref (oref (car active) table) application))) | |
905 | (when app | |
906 | (setq tmpl (srecode-template-get-table | |
907 | (srecode-table) | |
908 | templatenamepart | |
909 | ctxt app))) | |
910 | ))) | |
911 | (setq active (cdr active))) | |
912 | (when (not tmpl) | |
913 | ;; If it wasn't in this context, look to see if it | |
07a79ce4 | 914 | ;; defines its own context |
b9749554 EL |
915 | (setq tmpl (srecode-template-get-table (srecode-table) |
916 | templatenamepart))) | |
917 | ) | |
918 | ||
919 | ;; Store the found template into this object for later use. | |
920 | (oset sti :includedtemplate tmpl)) | |
4d902e6f CY |
921 | |
922 | (if (not (oref sti includedtemplate)) | |
923 | ;; @todo - Call into a debugger to help find the template in question. | |
924 | (error "No template \"%s\" found for include macro `%s'" | |
925 | templatenamepart (oref sti :object-name))) | |
926 | )) | |
927 | ||
928 | (defmethod srecode-insert-method ((sti srecode-template-inserter-include) | |
929 | dictionary) | |
930 | "Insert the STI inserter. | |
931 | Finds the template with this macro function part, and inserts it | |
d1f18ec0 | 932 | with the dictionaries found in the dictionary." |
4d902e6f CY |
933 | (srecode-insert-include-lookup sti dictionary) |
934 | ;; Insert the template. | |
935 | ;; Our baseclass has a simple way to do this. | |
936 | (if (srecode-dictionary-lookup-name dictionary (oref sti :object-name)) | |
937 | ;; If we have a value, then call the next method | |
938 | (srecode-insert-method-helper sti dictionary 'includedtemplate) | |
4c36be58 | 939 | ;; If we don't have a special dictionary, then just insert with the |
4d902e6f CY |
940 | ;; current dictionary. |
941 | (srecode-insert-subtemplate sti dictionary 'includedtemplate)) | |
942 | ) | |
943 | ||
944 | ;; | |
945 | ;; This template combines the include template and the sectional template. | |
946 | ;; It will first insert the included template, then insert the embedded | |
947 | ;; template wherever the $^$ in the included template was. | |
948 | ;; | |
53964682 | 949 | ;; Since it uses dual inheritance, it will magically get the end-matching |
4d902e6f CY |
950 | ;; behavior of #, with the including feature of >. |
951 | ;; | |
952 | (defclass srecode-template-inserter-include-wrap (srecode-template-inserter-include srecode-template-inserter-section-start) | |
953 | ((key :initform ?< | |
954 | :allocation :class | |
955 | :documentation | |
956 | "The character code used to identify inserters of this style.") | |
957 | ) | |
958 | "Include a different template into this one, and add text at the ^ macro. | |
959 | The included template will have additional dictionary entries from the subdictionary | |
960 | stored specified by this macro. If the included macro includes a ^ macro, | |
961 | then the text between this macro and the end macro will be inserted at | |
962 | the ^ macro.") | |
963 | ||
964 | (defmethod srecode-inserter-prin-example :STATIC ((ins srecode-template-inserter-include-wrap) | |
965 | escape-start escape-end) | |
966 | "Insert an example using inserter INS. | |
967 | Arguments ESCAPE-START and ESCAPE-END are the current escape sequences in use." | |
968 | (princ " ") | |
969 | (princ escape-start) | |
970 | (princ "<DICTNAME:contextname:templatename") | |
971 | (princ escape-end) | |
972 | (terpri) | |
973 | (princ " Template Text to insert at ^ macro") | |
974 | (terpri) | |
975 | (princ " ") | |
976 | (princ escape-start) | |
977 | (princ "/DICTNAME") | |
978 | (princ escape-end) | |
979 | (terpri) | |
980 | ) | |
981 | ||
982 | (defmethod srecode-insert-method ((sti srecode-template-inserter-include-wrap) | |
983 | dictionary) | |
984 | "Insert the template STI. | |
985 | This will first insert the include part via inheritance, then | |
986 | insert the section it wraps into the location in the included | |
d1f18ec0 | 987 | template where a ^ inserter occurs." |
4d902e6f CY |
988 | ;; Step 1: Look up the included inserter |
989 | (srecode-insert-include-lookup sti dictionary) | |
b9749554 EL |
990 | ;; Step 2: Temporarily override the point inserter. |
991 | ;; We bind `srecode-template-inserter-point-override' to a cons cell | |
992 | ;; (DEPTH . FUNCTION) that has the maximum template nesting depth, | |
993 | ;; for which the override is valid, in DEPTH and a lambda function | |
994 | ;; which implements the wrap insertion behavior in FUNCTION. The | |
995 | ;; maximum valid nesting depth is just the current depth + 1. | |
996 | (let ((srecode-template-inserter-point-override | |
997 | (lexical-let ((inserter1 sti)) | |
998 | (cons | |
999 | ;; DEPTH | |
1000 | (+ (length (oref srecode-template active)) 1) | |
1001 | ;; FUNCTION | |
1002 | (lambda (dict) | |
1003 | (let ((srecode-template-inserter-point-override nil)) | |
1004 | (if (srecode-dictionary-lookup-name | |
1005 | dict (oref inserter1 :object-name)) | |
1006 | ;; Insert our sectional part with looping. | |
1007 | (srecode-insert-method-helper | |
1008 | inserter1 dict 'template) | |
1009 | ;; Insert our sectional part just once. | |
1010 | (srecode-insert-subtemplate | |
1011 | inserter1 dict 'template)))))))) | |
4d902e6f CY |
1012 | ;; Do a regular insertion for an include, but with our override in |
1013 | ;; place. | |
b9749554 | 1014 | (call-next-method))) |
4d902e6f CY |
1015 | |
1016 | (provide 'srecode/insert) | |
1017 | ||
1018 | ;; Local variables: | |
1019 | ;; generated-autoload-file: "loaddefs.el" | |
4d902e6f CY |
1020 | ;; generated-autoload-load-name: "srecode/insert" |
1021 | ;; End: | |
1022 | ||
1023 | ;;; srecode/insert.el ends here |