1 ;;; ada-stmt.el --- an extension to Ada mode for inserting statement templates
3 ;; Copyright(C) 1987, 93, 94, 96, 97, 98, 99, 2000
4 ;; Free Software Foundation, Inc.
6 ;; Ada Core Technologies's version: $Revision: 1.16 $
8 ;; This file is part of GNU Emacs.
10 ;; Authors: Daniel Pfeiffer, Markus Heritsch, Rolf Ebert <ebert@waporo.muc.de>
11 ;; Maintainer: Emmanuel Briot <briot@gnat.com>
12 ;; Keywords: languages, ada
13 ;; Rolf Ebert's version: 2.26
16 ;; This file is now automatically loaded from ada-mode.el, and creates a submenu
17 ;; in Ada/ on the menu bar.
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.)
26 ;; Sep 1993. Daniel Pfeiffer <pfeiffer@cict.fr> (DP)
27 ;; Introduced statement.el for smaller code and user configurability.
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
33 ;; Adapted Jun 1994. Markus Heritsch
34 ;; <Markus.Heritsch@studbox.uni-stuttgart.de> (MH)
35 ;; added menu bar support for templates
37 ;; 1994/12/02 Christian Egli <cegli@hcsd.hac.com>
38 ;; General cleanup and bug fixes.
40 ;; 1995/12/20 John Hutchison <hutchiso@epi.syr.ge.com>
41 ;; made it work with skeleton.el from Emacs-19.30. Several
42 ;; enhancements and bug fixes.
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.
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
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 :-)
64 (require 'skeleton nil t
)
68 (defun ada-func-or-proc-name ()
69 ;; Get the name of the current function or procedure."
71 (let ((case-fold-search t
))
72 (if (re-search-backward ada-procedure-start-regexp nil t
)
73 (buffer-substring (match-beginning 3) (match-end 3))
76 ;;; ---- statement skeletons ------------------------------------------
78 (define-skeleton ada-array
79 "Insert array type definition.
80 Prompt for component type and index subtypes."
82 "array (" ("index definition: " str
", " ) -
2 ") of " _ ?\
;)
85 (define-skeleton ada-case
86 "Build skeleton case statement.
87 Prompt for the selector expression. Also builds the first when clause."
88 "[selector expression]: "
90 > "when " ("discrete choice: " str
" | ") -
3 " =>" \n
95 (define-skeleton ada-when
96 "Start a case statement alternative with a when clause."
98 < "when " ("discrete choice: " str
" | ") -
3 " =>" \n
102 (define-skeleton ada-declare-block
103 "Insert a block with a declare part.
104 Indent for the first declaration."
111 < "end " str | -
1 ?\
;)
114 (define-skeleton ada-exception-block
115 "Insert a block with an exception part.
116 Indent for the first line of code."
123 < "end " str | -
1 ?\
;)
126 (define-skeleton ada-exception
127 "Insert an indented exception part into a block."
133 (define-skeleton ada-exit-1
134 "Insert then exit condition of the exit statement, prompting for condition."
139 (define-skeleton ada-exit
140 "Insert an exit statement, prompting for loop name and condition."
141 "[name of loop to exit]: "
142 "exit " str
& ?\
(ada-exit-1) | -
1 ?\
;)
146 "Insert a descriptive header at the top of the file."
149 (goto-char (point-min))
150 (if (fboundp 'make-header
)
151 (funcall (symbol-function 'make-header
))
155 (define-skeleton ada-header-tmpl
156 "Insert a comment block containing the module title, author, etc."
158 "-- -*- Mode: Ada -*-"
159 "\n" ada-fill-comment-prefix
"Filename : " (buffer-name)
160 "\n" ada-fill-comment-prefix
"Description : " str
161 "\n" ada-fill-comment-prefix
"Author : " (user-full-name)
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!"
170 (define-skeleton ada-display-comment
171 "Inserts three comment lines, making a display comment."
173 "--\n" ada-fill-comment-prefix _
"\n--")
176 (define-skeleton ada-if
177 "Insert skeleton if statment, prompting for a boolean-expression."
184 (define-skeleton ada-elsif
185 "Add an elsif clause to an if statement,
186 prompting for the boolean-expression."
188 < "elsif " str
" then" \n
192 (define-skeleton ada-else
193 "Add an else clause inside an if-then-end-if clause."
199 (define-skeleton ada-loop
200 "Insert a skeleton loop statement. The exit statement is added by hand."
205 < "end loop " str | -
1 ?\
;)
208 (define-skeleton ada-for-loop-prompt-variable
209 "Prompt for the loop variable."
214 (define-skeleton ada-for-loop-prompt-range
215 "Prompt for the loop range."
220 (define-skeleton ada-for-loop
221 "Build a skeleton for-loop statement, prompting for the loop parameters."
225 (ada-for-loop-prompt-variable)
227 (ada-for-loop-prompt-range)
230 < "end loop " str | -
1 ?\
;)
233 (define-skeleton ada-while-loop-prompt-entry-condition
234 "Prompt for the loop entry condition."
235 "[entry condition]: "
239 (define-skeleton ada-while-loop
240 "Insert a skeleton while loop statement."
244 (ada-while-loop-prompt-entry-condition)
247 < "end loop " str | -
1 ?\
;)
250 (define-skeleton ada-package-spec
251 "Insert a skeleton package specification."
253 "package " str
" is" \n
258 (define-skeleton ada-package-body
259 "Insert a skeleton package body -- includes a begin statement."
261 "package body " str
" is" \n
267 (define-skeleton ada-private
268 "Undent and start a private section of a package spec. Reindent."
274 (define-skeleton ada-function-spec-prompt-return
275 "Prompts for function result type."
280 (define-skeleton ada-function-spec
281 "Insert a function specification. Prompts for name and arguments."
284 " (" ("[parameter_specification]: " str
"; " ) -
2 ")"
286 (ada-function-spec-prompt-return)
290 (define-skeleton ada-procedure-spec
291 "Insert a procedure specification, prompting for its name and arguments."
294 " (" ("[parameter_specification]: " str
"; " ) -
2 ")"
298 (define-skeleton ada-subprogram-body
299 "Insert frame for subprogram body.
300 Invoke right after `ada-function-spec' or `ada-procedure-spec'."
302 ;; Remove `;' from subprogram decl
304 (let ((pos (1+ (point))))
305 (ada-search-ignore-string-comment ada-subprog-start-re t nil
)
306 (when (ada-search-ignore-string-comment "(" nil pos t
'search-forward
)
316 "when others => null;" \n
318 (ada-func-or-proc-name)
322 (define-skeleton ada-separate
323 "Finish a body stub with `separate'."
329 ;(define-skeleton ada-with
330 ; "Inserts a with clause, prompting for the list of units depended upon."
331 ; "[list of units depended upon]: "
334 ;(define-skeleton ada-use
335 ; "Inserts a use clause, prompting for the list of packages used."
336 ; "[list of packages used]: "
340 (define-skeleton ada-record
341 "Insert a skeleton record type declaration."
348 (define-skeleton ada-subtype
349 "Start insertion of a subtype declaration, prompting for the subtype name."
351 "subtype " str
" is " _ ?\
;
352 (not (message "insert subtype indication.")))
355 (define-skeleton ada-type
356 "Start insertion of a type declaration, prompting for the type name."
359 ("[discriminant specs]: " str
" ")
360 |
(backward-delete-char 1) | ?\
)
362 (not (message "insert type definition.")))
365 (define-skeleton ada-task-body
366 "Insert a task body, prompting for the task name."
368 "task body " str
" is\n"
374 (define-skeleton ada-task-spec
375 "Insert a task specification, prompting for the task name."
378 " (" ("[discriminant]: " str
"; ") ") is\n"
383 (define-skeleton ada-get-param1
384 "Prompt for arguments and if any enclose them in brackets."
386 ("[parameter_specification]: " str
"; " ) & -
2 & ")")
389 (define-skeleton ada-get-param
390 "Prompt for arguments and if any enclose them in brackets."
393 (ada-get-param1) | -
2)
396 (define-skeleton ada-entry
397 "Insert a task entry, prompting for the entry name."
404 (define-skeleton ada-entry-family-prompt-discriminant
405 "Insert a entry specification, prompting for the entry name."
406 "[discriminant name]: "
410 (define-skeleton ada-entry-family
411 "Insert a entry specification, prompting for the entry name."
414 " (" (ada-entry-family-prompt-discriminant) ")"
419 (define-skeleton ada-select
420 "Insert a select block."
427 (define-skeleton ada-accept-1
428 "Insert a condition statement, prompting for the condition name."
433 (define-skeleton ada-accept-2
434 "Insert an accept statement, prompting for the name and arguments."
443 (define-skeleton ada-accept
444 "Insert an accept statement (prompt for condition, name and arguments)."
446 > (ada-accept-1) & " =>\n"
450 (define-skeleton ada-or-accept
451 "Insert an or statement, prompting for the condition name."
457 (define-skeleton ada-or-delay
458 "Insert a delay statement, prompting for the delay value."
464 (define-skeleton ada-or-terminate
465 "Insert a terminate statement."
471 (defun ada-adjust-case-skeleton ()
472 "Adjust the case of the text inserted by a skeleton."
474 (let ((aa-end (point)))
475 (ada-adjust-case-region
476 (progn (goto-char (symbol-value 'beg
)) (forward-word -
1) (point))
477 (goto-char aa-end
)))))
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))))))
483 (add-hook 'skeleton-end-hook
'ada-adjust-case-skeleton nil t
))
485 (add-hook 'ada-mode-hook
'ada-stmt-mode-hook
)
489 ;;; arch-tag: 94f51555-cc0e-44e5-8865-8788aae8ecd3
490 ;;; ada-stmt.el ends here