Commit | Line | Data |
---|---|---|
3afbc435 | 1 | ;;; ada-stmt.el --- an extension to Ada mode for inserting statement templates |
fb98fa17 | 2 | |
85a23134 | 3 | ;; Copyright(C) 1987, 93, 94, 96, 97, 98, 99, 2000 |
383d5bbb | 4 | ;; Free Software Foundation, Inc. |
fb98fa17 | 5 | |
463f5630 | 6 | ;; Ada Core Technologies's version: $Revision: 1.23 $ |
3afbc435 PJ |
7 | |
8 | ;; This file is part of GNU Emacs. | |
3d8e3891 GM |
9 | |
10 | ;; Authors: Daniel Pfeiffer, Markus Heritsch, Rolf Ebert <ebert@waporo.muc.de> | |
4efa209f | 11 | ;; Maintainer: Emmanuel Briot <briot@gnat.com> |
fb98fa17 KH |
12 | ;; Keywords: languages, ada |
13 | ;; Rolf Ebert's version: 2.26 | |
14 | ||
15 | ;;; Commentary: | |
18f9934c SM |
16 | ;; This file is now automatically loaded from ada-mode.el, and creates a submenu |
17 | ;; in Ada/ on the menu bar. | |
fb98fa17 KH |
18 | |
19 | ;;; History: | |
20 | ||
21 | ;; Created May 1987. | |
22 | ;; Original version from V. Bowman as in ada.el of Emacs-18 | |
23 | ;; (borrowed heavily from Mick Jordan's Modula-2 package for GNU, | |
24 | ;; as modified by Peter Robinson, Michael Schmidt, and Tom Perrine.) | |
25 | ;; | |
26 | ;; Sep 1993. Daniel Pfeiffer <pfeiffer@cict.fr> (DP) | |
27 | ;; Introduced statement.el for smaller code and user configurability. | |
28 | ;; | |
29 | ;; Nov 1993. Rolf Ebert <ebert@enpc.fr> (RE) Moved the | |
30 | ;; skeleton generation into this separate file. The code still is | |
31 | ;; essentially written by DP | |
a1506d29 | 32 | ;; |
fb98fa17 KH |
33 | ;; Adapted Jun 1994. Markus Heritsch |
34 | ;; <Markus.Heritsch@studbox.uni-stuttgart.de> (MH) | |
35 | ;; added menu bar support for templates | |
36 | ;; | |
37 | ;; 1994/12/02 Christian Egli <cegli@hcsd.hac.com> | |
38 | ;; General cleanup and bug fixes. | |
39 | ;; | |
40 | ;; 1995/12/20 John Hutchison <hutchiso@epi.syr.ge.com> | |
fb8abe0d | 41 | ;; made it work with skeleton.el from Emacs-19.30. Several |
fb98fa17 KH |
42 | ;; enhancements and bug fixes. |
43 | ||
44 | ;; BUGS: | |
45 | ;;;> I have the following suggestions for the function template: 1) I | |
46 | ;;;> don't want it automatically assigning it a name for the return variable. I | |
47 | ;;;> never want it to be called "Result" because that is nondescriptive. If you | |
48 | ;;;> must define a variable, give me the ability to specify its name. | |
49 | ;;;> | |
50 | ;;;> 2) You do not provide a type for variable 'Result'. Its type is the same | |
51 | ;;;> as the function's return type, which the template knows, so why force me | |
52 | ;;;> to type it in? | |
53 | ;;;> | |
54 | ||
55 | ;;;It would be nice if one could configure such layout details separately | |
56 | ;;;without patching the LISP code. Maybe the metalanguage used in ada-stmt.el | |
57 | ;;;could be taken even further, providing the user with some nice syntax | |
58 | ;;;for describing layout. Then my own hacks would survive the next | |
59 | ;;;update of the package :-) | |
60 | ||
61 | \f | |
62 | ;;; Code: | |
63 | ||
6f9a2614 | 64 | (require 'skeleton nil t) |
fb98fa17 | 65 | (require 'easymenu) |
6f9a2614 | 66 | (require 'ada-mode) |
fb98fa17 | 67 | |
fb98fa17 KH |
68 | (defun ada-func-or-proc-name () |
69 | ;; Get the name of the current function or procedure." | |
70 | (save-excursion | |
71 | (let ((case-fold-search t)) | |
72 | (if (re-search-backward ada-procedure-start-regexp nil t) | |
18f9934c | 73 | (buffer-substring (match-beginning 3) (match-end 3)) |
fb98fa17 KH |
74 | "NAME?")))) |
75 | ||
fb98fa17 KH |
76 | ;;; ---- statement skeletons ------------------------------------------ |
77 | ||
78 | (define-skeleton ada-array | |
1a7244d9 | 79 | "Insert array type definition. |
fb8abe0d | 80 | Prompt for component type and index subtypes." |
fb98fa17 KH |
81 | () |
82 | "array (" ("index definition: " str ", " ) -2 ") of " _ ?\;) | |
83 | ||
84 | ||
85 | (define-skeleton ada-case | |
1a7244d9 GM |
86 | "Build skeleton case statement. |
87 | Prompt for the selector expression. Also builds the first when clause." | |
fb98fa17 KH |
88 | "[selector expression]: " |
89 | "case " str " is" \n | |
90 | > "when " ("discrete choice: " str " | ") -3 " =>" \n | |
91 | > _ \n | |
92 | < < "end case;") | |
93 | ||
94 | ||
95 | (define-skeleton ada-when | |
96 | "Start a case statement alternative with a when clause." | |
97 | () | |
98 | < "when " ("discrete choice: " str " | ") -3 " =>" \n | |
99 | >) | |
100 | ||
101 | ||
102 | (define-skeleton ada-declare-block | |
103 | "Insert a block with a declare part. | |
104 | Indent for the first declaration." | |
105 | "[block name]: " | |
106 | < str & ?: & \n | |
107 | > "declare" \n | |
108 | > _ \n | |
109 | < "begin" \n | |
110 | > \n | |
111 | < "end " str | -1 ?\;) | |
112 | ||
113 | ||
114 | (define-skeleton ada-exception-block | |
115 | "Insert a block with an exception part. | |
116 | Indent for the first line of code." | |
117 | "[block name]: " | |
118 | < str & ?: & \n | |
119 | > "begin" \n | |
120 | > _ \n | |
121 | < "exception" \n | |
122 | > \n | |
123 | < "end " str | -1 ?\;) | |
124 | ||
125 | ||
126 | (define-skeleton ada-exception | |
127 | "Insert an indented exception part into a block." | |
128 | () | |
129 | < "exception" \n | |
130 | >) | |
131 | ||
132 | ||
133 | (define-skeleton ada-exit-1 | |
134 | "Insert then exit condition of the exit statement, prompting for condition." | |
135 | "[exit condition]: " | |
136 | "when " str | -5) | |
137 | ||
138 | ||
139 | (define-skeleton ada-exit | |
140 | "Insert an exit statement, prompting for loop name and condition." | |
141 | "[name of loop to exit]: " | |
18f9934c | 142 | "exit " str & ?\ (ada-exit-1) | -1 ?\;) |
fb98fa17 | 143 | |
3d8e3891 | 144 | ;;;###autoload |
fb98fa17 KH |
145 | (defun ada-header () |
146 | "Insert a descriptive header at the top of the file." | |
147 | (interactive "*") | |
148 | (save-excursion | |
149 | (goto-char (point-min)) | |
150 | (if (fboundp 'make-header) | |
cf543c1c | 151 | (funcall (symbol-function 'make-header)) |
fb98fa17 KH |
152 | (ada-header-tmpl)))) |
153 | ||
154 | ||
155 | (define-skeleton ada-header-tmpl | |
156 | "Insert a comment block containing the module title, author, etc." | |
157 | "[Description]: " | |
158 | "-- -*- Mode: Ada -*-" | |
cf543c1c GM |
159 | "\n" ada-fill-comment-prefix "Filename : " (buffer-name) |
160 | "\n" ada-fill-comment-prefix "Description : " str | |
9dd7cdcc | 161 | "\n" ada-fill-comment-prefix "Author : " (user-full-name) |
cf543c1c GM |
162 | "\n" ada-fill-comment-prefix "Created On : " (current-time-string) |
163 | "\n" ada-fill-comment-prefix "Last Modified By: ." | |
164 | "\n" ada-fill-comment-prefix "Last Modified On: ." | |
165 | "\n" ada-fill-comment-prefix "Update Count : 0" | |
166 | "\n" ada-fill-comment-prefix "Status : Unknown, Use with caution!" | |
fb98fa17 KH |
167 | "\n") |
168 | ||
169 | ||
170 | (define-skeleton ada-display-comment | |
171 | "Inserts three comment lines, making a display comment." | |
172 | () | |
cf543c1c | 173 | "--\n" ada-fill-comment-prefix _ "\n--") |
fb98fa17 KH |
174 | |
175 | ||
176 | (define-skeleton ada-if | |
177 | "Insert skeleton if statment, prompting for a boolean-expression." | |
178 | "[condition]: " | |
179 | "if " str " then" \n | |
180 | > _ \n | |
181 | < "end if;") | |
182 | ||
183 | ||
184 | (define-skeleton ada-elsif | |
9dd7cdcc | 185 | "Add an elsif clause to an if statement, |
fb98fa17 KH |
186 | prompting for the boolean-expression." |
187 | "[condition]: " | |
188 | < "elsif " str " then" \n | |
189 | >) | |
190 | ||
191 | ||
192 | (define-skeleton ada-else | |
193 | "Add an else clause inside an if-then-end-if clause." | |
194 | () | |
195 | < "else" \n | |
196 | >) | |
197 | ||
198 | ||
199 | (define-skeleton ada-loop | |
200 | "Insert a skeleton loop statement. The exit statement is added by hand." | |
201 | "[loop name]: " | |
202 | < str & ?: & \n | |
203 | > "loop" \n | |
204 | > _ \n | |
205 | < "end loop " str | -1 ?\;) | |
206 | ||
207 | ||
208 | (define-skeleton ada-for-loop-prompt-variable | |
209 | "Prompt for the loop variable." | |
210 | "[loop variable]: " | |
211 | str) | |
212 | ||
213 | ||
214 | (define-skeleton ada-for-loop-prompt-range | |
215 | "Prompt for the loop range." | |
216 | "[loop range]: " | |
217 | str) | |
218 | ||
219 | ||
220 | (define-skeleton ada-for-loop | |
221 | "Build a skeleton for-loop statement, prompting for the loop parameters." | |
222 | "[loop name]: " | |
223 | < str & ?: & \n | |
224 | > "for " | |
225 | (ada-for-loop-prompt-variable) | |
226 | " in " | |
227 | (ada-for-loop-prompt-range) | |
228 | " loop" \n | |
229 | > _ \n | |
230 | < "end loop " str | -1 ?\;) | |
231 | ||
232 | ||
233 | (define-skeleton ada-while-loop-prompt-entry-condition | |
234 | "Prompt for the loop entry condition." | |
235 | "[entry condition]: " | |
236 | str) | |
237 | ||
238 | ||
239 | (define-skeleton ada-while-loop | |
240 | "Insert a skeleton while loop statement." | |
241 | "[loop name]: " | |
242 | < str & ?: & \n | |
243 | > "while " | |
244 | (ada-while-loop-prompt-entry-condition) | |
245 | " loop" \n | |
246 | > _ \n | |
247 | < "end loop " str | -1 ?\;) | |
248 | ||
249 | ||
250 | (define-skeleton ada-package-spec | |
251 | "Insert a skeleton package specification." | |
252 | "[package name]: " | |
253 | "package " str " is" \n | |
254 | > _ \n | |
255 | < "end " str ?\;) | |
256 | ||
257 | ||
258 | (define-skeleton ada-package-body | |
259 | "Insert a skeleton package body -- includes a begin statement." | |
260 | "[package name]: " | |
261 | "package body " str " is" \n | |
262 | > _ \n | |
263 | ; < "begin" \n | |
264 | < "end " str ?\;) | |
265 | ||
266 | ||
267 | (define-skeleton ada-private | |
268 | "Undent and start a private section of a package spec. Reindent." | |
269 | () | |
270 | < "private" \n | |
271 | >) | |
272 | ||
273 | ||
274 | (define-skeleton ada-function-spec-prompt-return | |
275 | "Prompts for function result type." | |
276 | "[result type]: " | |
277 | str) | |
278 | ||
279 | ||
280 | (define-skeleton ada-function-spec | |
281 | "Insert a function specification. Prompts for name and arguments." | |
282 | "[function name]: " | |
9dd7cdcc | 283 | "function " str |
fb98fa17 KH |
284 | " (" ("[parameter_specification]: " str "; " ) -2 ")" |
285 | " return " | |
286 | (ada-function-spec-prompt-return) | |
287 | ";" \n ) | |
288 | ||
289 | ||
290 | (define-skeleton ada-procedure-spec | |
291 | "Insert a procedure specification, prompting for its name and arguments." | |
292 | "[procedure name]: " | |
9dd7cdcc | 293 | "procedure " str |
fb98fa17 KH |
294 | " (" ("[parameter_specification]: " str "; " ) -2 ")" |
295 | ";" \n ) | |
296 | ||
297 | ||
298 | (define-skeleton ada-subprogram-body | |
299 | "Insert frame for subprogram body. | |
300 | Invoke right after `ada-function-spec' or `ada-procedure-spec'." | |
301 | () | |
302 | ;; Remove `;' from subprogram decl | |
303 | (save-excursion | |
3d8e3891 GM |
304 | (let ((pos (1+ (point)))) |
305 | (ada-search-ignore-string-comment ada-subprog-start-re t nil) | |
9dd7cdcc SM |
306 | (when (ada-search-ignore-string-comment "(" nil pos t 'search-forward) |
307 | (backward-char 1) | |
308 | (forward-sexp 1))) | |
fb98fa17 KH |
309 | (if (looking-at ";") |
310 | (delete-char 1))) | |
3d8e3891 GM |
311 | " is" \n |
312 | _ \n | |
313 | < "begin" \n | |
314 | \n | |
315 | < "exception" \n | |
316 | "when others => null;" \n | |
317 | < < "end " | |
fb98fa17 | 318 | (ada-func-or-proc-name) |
3d8e3891 | 319 | ";" \n) |
fb98fa17 KH |
320 | |
321 | ||
322 | (define-skeleton ada-separate | |
323 | "Finish a body stub with `separate'." | |
324 | () | |
325 | > "separate;" \n | |
326 | <) | |
327 | ||
328 | ||
329 | ;(define-skeleton ada-with | |
330 | ; "Inserts a with clause, prompting for the list of units depended upon." | |
331 | ; "[list of units depended upon]: " | |
332 | ; "with " str ?\;) | |
333 | ||
334 | ;(define-skeleton ada-use | |
335 | ; "Inserts a use clause, prompting for the list of packages used." | |
336 | ; "[list of packages used]: " | |
337 | ; "use " str ?\;) | |
a1506d29 | 338 | |
fb98fa17 KH |
339 | |
340 | (define-skeleton ada-record | |
341 | "Insert a skeleton record type declaration." | |
342 | () | |
343 | "record" \n | |
344 | > _ \n | |
345 | < "end record;") | |
346 | ||
347 | ||
348 | (define-skeleton ada-subtype | |
349 | "Start insertion of a subtype declaration, prompting for the subtype name." | |
350 | "[subtype name]: " | |
351 | "subtype " str " is " _ ?\; | |
352 | (not (message "insert subtype indication."))) | |
353 | ||
354 | ||
355 | (define-skeleton ada-type | |
356 | "Start insertion of a type declaration, prompting for the type name." | |
357 | "[type name]: " | |
358 | "type " str ?\( | |
359 | ("[discriminant specs]: " str " ") | |
360 | | (backward-delete-char 1) | ?\) | |
361 | " is " | |
362 | (not (message "insert type definition."))) | |
363 | ||
364 | ||
365 | (define-skeleton ada-task-body | |
366 | "Insert a task body, prompting for the task name." | |
367 | "[task name]: " | |
368 | "task body " str " is\n" | |
369 | "begin\n" | |
370 | > _ \n | |
371 | < "end " str ";" ) | |
372 | ||
373 | ||
374 | (define-skeleton ada-task-spec | |
375 | "Insert a task specification, prompting for the task name." | |
376 | "[task name]: " | |
9dd7cdcc | 377 | "task " str |
fb98fa17 KH |
378 | " (" ("[discriminant]: " str "; ") ") is\n" |
379 | > "entry " _ \n | |
380 | <"end " str ";" ) | |
a1506d29 | 381 | |
fb98fa17 KH |
382 | |
383 | (define-skeleton ada-get-param1 | |
384 | "Prompt for arguments and if any enclose them in brackets." | |
385 | () | |
9dd7cdcc | 386 | ("[parameter_specification]: " str "; " ) & -2 & ")") |
fb98fa17 KH |
387 | |
388 | ||
389 | (define-skeleton ada-get-param | |
390 | "Prompt for arguments and if any enclose them in brackets." | |
391 | () | |
9dd7cdcc SM |
392 | " (" |
393 | (ada-get-param1) | -2) | |
fb98fa17 KH |
394 | |
395 | ||
396 | (define-skeleton ada-entry | |
397 | "Insert a task entry, prompting for the entry name." | |
398 | "[entry name]: " | |
9dd7cdcc | 399 | "entry " str |
fb98fa17 | 400 | (ada-get-param) |
9dd7cdcc | 401 | ";" \n) |
fb98fa17 KH |
402 | |
403 | ||
404 | (define-skeleton ada-entry-family-prompt-discriminant | |
405 | "Insert a entry specification, prompting for the entry name." | |
406 | "[discriminant name]: " | |
407 | str) | |
408 | ||
409 | ||
410 | (define-skeleton ada-entry-family | |
411 | "Insert a entry specification, prompting for the entry name." | |
412 | "[entry name]: " | |
413 | "entry " str | |
414 | " (" (ada-entry-family-prompt-discriminant) ")" | |
415 | (ada-get-param) | |
9dd7cdcc | 416 | ";" \n) |
fb98fa17 KH |
417 | |
418 | ||
419 | (define-skeleton ada-select | |
420 | "Insert a select block." | |
421 | () | |
422 | "select\n" | |
423 | > _ \n | |
424 | < "end select;") | |
425 | ||
426 | ||
427 | (define-skeleton ada-accept-1 | |
428 | "Insert a condition statement, prompting for the condition name." | |
9dd7cdcc | 429 | "[condition]: " |
fb98fa17 KH |
430 | "when " str | -5 ) |
431 | ||
432 | ||
433 | (define-skeleton ada-accept-2 | |
434 | "Insert an accept statement, prompting for the name and arguments." | |
9dd7cdcc SM |
435 | "[accept name]: " |
436 | > "accept " str | |
fb98fa17 | 437 | (ada-get-param) |
fb98fa17 KH |
438 | " do" \n |
439 | > _ \n | |
440 | < "end " str ";" ) | |
441 | ||
442 | ||
443 | (define-skeleton ada-accept | |
444 | "Insert an accept statement (prompt for condition, name and arguments)." | |
445 | () | |
446 | > (ada-accept-1) & " =>\n" | |
9dd7cdcc | 447 | (ada-accept-2)) |
fb98fa17 KH |
448 | |
449 | ||
450 | (define-skeleton ada-or-accept | |
9dd7cdcc | 451 | "Insert an or statement, prompting for the condition name." |
fb98fa17 KH |
452 | () |
453 | < "or\n" | |
9dd7cdcc | 454 | (ada-accept)) |
fb98fa17 KH |
455 | |
456 | ||
457 | (define-skeleton ada-or-delay | |
458 | "Insert a delay statement, prompting for the delay value." | |
9dd7cdcc | 459 | "[delay value]: " |
fb98fa17 KH |
460 | < "or\n" |
461 | > "delay " str ";") | |
a1506d29 | 462 | |
fb98fa17 KH |
463 | |
464 | (define-skeleton ada-or-terminate | |
465 | "Insert a terminate statement." | |
466 | () | |
467 | < "or\n" | |
468 | > "terminate;") | |
469 | ||
470 | ||
fb98fa17 | 471 | (defun ada-adjust-case-skeleton () |
9dd7cdcc SM |
472 | "Adjust the case of the text inserted by a skeleton." |
473 | (save-excursion | |
fb98fa17 | 474 | (let ((aa-end (point))) |
9dd7cdcc SM |
475 | (ada-adjust-case-region |
476 | (progn (goto-char (symbol-value 'beg)) (forward-word -1) (point)) | |
477 | (goto-char aa-end))))) | |
478 | ||
479 | (defun ada-stmt-mode-hook () | |
480 | (set (make-local-variable 'skeleton-further-elements) | |
481 | '((< '(backward-delete-char-untabify | |
482 | (min ada-indent (current-column)))))) | |
85a23134 | 483 | (add-hook 'skeleton-end-hook 'ada-adjust-case-skeleton nil t)) |
9dd7cdcc SM |
484 | |
485 | (add-hook 'ada-mode-hook 'ada-stmt-mode-hook) | |
3d8e3891 | 486 | |
fb98fa17 KH |
487 | (provide 'ada-stmt) |
488 | ||
489 | ;;; ada-stmt.el ends here |