1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-15 09:47:20 +00:00
emacs/lisp/progmodes/ada-stmt.el

485 lines
12 KiB
EmacsLisp
Raw Normal View History

;;; ada-stmt.el --- an extension to Ada mode for inserting statement templates
1998-12-14 03:18:06 +00:00
2007-01-21 03:53:13 +00:00
;; Copyright (C) 1987, 1993, 1994, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
2008-01-07 02:11:00 +00:00
;; 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
1998-12-14 03:18:06 +00:00
;; Authors: Daniel Pfeiffer, Markus Heritsch, Rolf Ebert <ebert@waporo.muc.de>
;; Maintainer: Stephen Leake <stephen_leake@stephe-leake.org>
1998-12-14 03:18:06 +00:00
;; Keywords: languages, ada
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
1998-12-14 03:18:06 +00:00
;;; Commentary:
;; This file is now automatically loaded from ada-mode.el, and creates a submenu
;; in Ada/ on the menu bar.
1998-12-14 03:18:06 +00:00
;;; History:
;; Created May 1987.
;; Original version from V. Bowman as in ada.el of Emacs-18
;; (borrowed heavily from Mick Jordan's Modula-2 package for GNU,
;; as modified by Peter Robinson, Michael Schmidt, and Tom Perrine.)
;;
;; Sep 1993. Daniel Pfeiffer <pfeiffer@cict.fr> (DP)
;; Introduced statement.el for smaller code and user configurability.
;;
;; Nov 1993. Rolf Ebert <ebert@enpc.fr> (RE) Moved the
;; skeleton generation into this separate file. The code still is
;; essentially written by DP
2003-02-04 13:24:35 +00:00
;;
1998-12-14 03:18:06 +00:00
;; Adapted Jun 1994. Markus Heritsch
;; <Markus.Heritsch@studbox.uni-stuttgart.de> (MH)
;; added menu bar support for templates
;;
;; 1994/12/02 Christian Egli <cegli@hcsd.hac.com>
;; General cleanup and bug fixes.
;;
;; 1995/12/20 John Hutchison <hutchiso@epi.syr.ge.com>
;; made it work with skeleton.el from Emacs-19.30. Several
1998-12-14 03:18:06 +00:00
;; enhancements and bug fixes.
;; BUGS:
;;;> I have the following suggestions for the function template: 1) I
;;;> don't want it automatically assigning it a name for the return variable. I
;;;> never want it to be called "Result" because that is nondescriptive. If you
;;;> must define a variable, give me the ability to specify its name.
;;;>
;;;> 2) You do not provide a type for variable 'Result'. Its type is the same
;;;> as the function's return type, which the template knows, so why force me
;;;> to type it in?
;;;>
;;;It would be nice if one could configure such layout details separately
;;;without patching the LISP code. Maybe the metalanguage used in ada-stmt.el
;;;could be taken even further, providing the user with some nice syntax
;;;for describing layout. Then my own hacks would survive the next
;;;update of the package :-)
;;; Code:
(require 'skeleton nil t)
1998-12-14 03:18:06 +00:00
(require 'easymenu)
(require 'ada-mode)
1998-12-14 03:18:06 +00:00
(defun ada-func-or-proc-name ()
"Return the name of the current function or procedure."
1998-12-14 03:18:06 +00:00
(save-excursion
(let ((case-fold-search t))
(if (re-search-backward ada-procedure-start-regexp nil t)
(match-string 5)
1998-12-14 03:18:06 +00:00
"NAME?"))))
;;; ---- statement skeletons ------------------------------------------
(define-skeleton ada-array
1999-10-12 22:19:26 +00:00
"Insert array type definition.
Prompt for component type and index subtypes."
1998-12-14 03:18:06 +00:00
()
"array (" ("index definition: " str ", " ) -2 ") of " _ ?\;)
(define-skeleton ada-case
1999-10-12 22:19:26 +00:00
"Build skeleton case statement.
Prompt for the selector expression. Also builds the first when clause."
1998-12-14 03:18:06 +00:00
"[selector expression]: "
"case " str " is" \n
> "when " ("discrete choice: " str " | ") -3 " =>" \n
> _ \n
< < "end case;")
(define-skeleton ada-when
"Start a case statement alternative with a when clause."
()
< "when " ("discrete choice: " str " | ") -3 " =>" \n
>)
(define-skeleton ada-declare-block
"Insert a block with a declare part.
Indent for the first declaration."
"[block name]: "
< str & ?: & \n
> "declare" \n
> _ \n
< "begin" \n
> \n
< "end " str | -1 ?\;)
(define-skeleton ada-exception-block
"Insert a block with an exception part.
Indent for the first line of code."
"[block name]: "
< str & ?: & \n
> "begin" \n
> _ \n
< "exception" \n
> \n
< "end " str | -1 ?\;)
(define-skeleton ada-exception
"Insert an indented exception part into a block."
()
< "exception" \n
>)
(define-skeleton ada-exit-1
"Insert then exit condition of the exit statement, prompting for condition."
"[exit condition]: "
"when " str | -5)
(define-skeleton ada-exit
"Insert an exit statement, prompting for loop name and condition."
"[name of loop to exit]: "
"exit " str & ?\ (ada-exit-1) | -1 ?\;)
1998-12-14 03:18:06 +00:00
;;;###autoload
1998-12-14 03:18:06 +00:00
(defun ada-header ()
"Insert a descriptive header at the top of the file."
(interactive "*")
(save-excursion
(goto-char (point-min))
(if (fboundp 'make-header)
(funcall (symbol-function 'make-header))
1998-12-14 03:18:06 +00:00
(ada-header-tmpl))))
(define-skeleton ada-header-tmpl
"Insert a comment block containing the module title, author, etc."
"[Description]: "
"-- -*- Mode: Ada -*-"
"\n" ada-fill-comment-prefix "Filename : " (buffer-name)
"\n" ada-fill-comment-prefix "Description : " str
"\n" ada-fill-comment-prefix "Author : " (user-full-name)
"\n" ada-fill-comment-prefix "Created On : " (current-time-string)
"\n" ada-fill-comment-prefix "Last Modified By: ."
"\n" ada-fill-comment-prefix "Last Modified On: ."
"\n" ada-fill-comment-prefix "Update Count : 0"
"\n" ada-fill-comment-prefix "Status : Unknown, Use with caution!"
1998-12-14 03:18:06 +00:00
"\n")
(define-skeleton ada-display-comment
"Inserts three comment lines, making a display comment."
()
"--\n" ada-fill-comment-prefix _ "\n--")
1998-12-14 03:18:06 +00:00
(define-skeleton ada-if
"Insert skeleton if statment, prompting for a boolean-expression."
"[condition]: "
"if " str " then" \n
> _ \n
< "end if;")
(define-skeleton ada-elsif
"Add an elsif clause to an if statement,
1998-12-14 03:18:06 +00:00
prompting for the boolean-expression."
"[condition]: "
< "elsif " str " then" \n
>)
(define-skeleton ada-else
"Add an else clause inside an if-then-end-if clause."
()
< "else" \n
>)
(define-skeleton ada-loop
"Insert a skeleton loop statement. The exit statement is added by hand."
"[loop name]: "
< str & ?: & \n
> "loop" \n
> _ \n
< "end loop " str | -1 ?\;)
(define-skeleton ada-for-loop-prompt-variable
"Prompt for the loop variable."
"[loop variable]: "
str)
(define-skeleton ada-for-loop-prompt-range
"Prompt for the loop range."
"[loop range]: "
str)
(define-skeleton ada-for-loop
"Build a skeleton for-loop statement, prompting for the loop parameters."
"[loop name]: "
< str & ?: & \n
> "for "
(ada-for-loop-prompt-variable)
" in "
(ada-for-loop-prompt-range)
" loop" \n
> _ \n
< "end loop " str | -1 ?\;)
(define-skeleton ada-while-loop-prompt-entry-condition
"Prompt for the loop entry condition."
"[entry condition]: "
str)
(define-skeleton ada-while-loop
"Insert a skeleton while loop statement."
"[loop name]: "
< str & ?: & \n
> "while "
(ada-while-loop-prompt-entry-condition)
" loop" \n
> _ \n
< "end loop " str | -1 ?\;)
(define-skeleton ada-package-spec
"Insert a skeleton package specification."
"[package name]: "
"package " str " is" \n
> _ \n
< "end " str ?\;)
(define-skeleton ada-package-body
"Insert a skeleton package body -- includes a begin statement."
1998-12-14 03:18:06 +00:00
"[package name]: "
"package body " str " is" \n
> _ \n
; < "begin" \n
< "end " str ?\;)
(define-skeleton ada-private
"Undent and start a private section of a package spec. Reindent."
1998-12-14 03:18:06 +00:00
()
< "private" \n
>)
(define-skeleton ada-function-spec-prompt-return
"Prompts for function result type."
"[result type]: "
str)
(define-skeleton ada-function-spec
"Insert a function specification. Prompts for name and arguments."
"[function name]: "
"function " str
1998-12-14 03:18:06 +00:00
" (" ("[parameter_specification]: " str "; " ) -2 ")"
" return "
(ada-function-spec-prompt-return)
";" \n )
(define-skeleton ada-procedure-spec
"Insert a procedure specification, prompting for its name and arguments."
"[procedure name]: "
"procedure " str
1998-12-14 03:18:06 +00:00
" (" ("[parameter_specification]: " str "; " ) -2 ")"
";" \n )
(define-skeleton ada-subprogram-body
"Insert frame for subprogram body.
Invoke right after `ada-function-spec' or `ada-procedure-spec'."
()
;; Remove `;' from subprogram decl
(save-excursion
(let ((pos (1+ (point))))
(ada-search-ignore-string-comment ada-subprog-start-re t nil)
(when (ada-search-ignore-string-comment "(" nil pos t 'search-forward)
(backward-char 1)
(forward-sexp 1)))
1998-12-14 03:18:06 +00:00
(if (looking-at ";")
(delete-char 1)))
" is" \n
_ \n
< "begin" \n
\n
< "exception" \n
"when others => null;" \n
< < "end "
1998-12-14 03:18:06 +00:00
(ada-func-or-proc-name)
";" \n)
1998-12-14 03:18:06 +00:00
(define-skeleton ada-separate
"Finish a body stub with `separate'."
()
> "separate;" \n
<)
;(define-skeleton ada-with
; "Inserts a with clause, prompting for the list of units depended upon."
; "[list of units depended upon]: "
; "with " str ?\;)
;(define-skeleton ada-use
; "Inserts a use clause, prompting for the list of packages used."
; "[list of packages used]: "
; "use " str ?\;)
2003-02-04 13:24:35 +00:00
1998-12-14 03:18:06 +00:00
(define-skeleton ada-record
"Insert a skeleton record type declaration."
()
"record" \n
> _ \n
< "end record;")
(define-skeleton ada-subtype
"Start insertion of a subtype declaration, prompting for the subtype name."
"[subtype name]: "
"subtype " str " is " _ ?\;
(not (message "insert subtype indication.")))
(define-skeleton ada-type
"Start insertion of a type declaration, prompting for the type name."
"[type name]: "
"type " str ?\(
("[discriminant specs]: " str " ")
| (backward-delete-char 1) | ?\)
" is "
(not (message "insert type definition.")))
(define-skeleton ada-task-body
"Insert a task body, prompting for the task name."
"[task name]: "
"task body " str " is\n"
"begin\n"
> _ \n
< "end " str ";" )
(define-skeleton ada-task-spec
"Insert a task specification, prompting for the task name."
"[task name]: "
"task " str
1998-12-14 03:18:06 +00:00
" (" ("[discriminant]: " str "; ") ") is\n"
> "entry " _ \n
<"end " str ";" )
2003-02-04 13:24:35 +00:00
1998-12-14 03:18:06 +00:00
(define-skeleton ada-get-param1
"Prompt for arguments and if any enclose them in brackets."
()
("[parameter_specification]: " str "; " ) & -2 & ")")
1998-12-14 03:18:06 +00:00
(define-skeleton ada-get-param
"Prompt for arguments and if any enclose them in brackets."
()
" ("
(ada-get-param1) | -2)
1998-12-14 03:18:06 +00:00
(define-skeleton ada-entry
"Insert a task entry, prompting for the entry name."
"[entry name]: "
"entry " str
1998-12-14 03:18:06 +00:00
(ada-get-param)
";" \n)
1998-12-14 03:18:06 +00:00
(define-skeleton ada-entry-family-prompt-discriminant
"Insert a entry specification, prompting for the entry name."
"[discriminant name]: "
str)
(define-skeleton ada-entry-family
"Insert a entry specification, prompting for the entry name."
"[entry name]: "
"entry " str
" (" (ada-entry-family-prompt-discriminant) ")"
(ada-get-param)
";" \n)
1998-12-14 03:18:06 +00:00
(define-skeleton ada-select
"Insert a select block."
()
"select\n"
> _ \n
< "end select;")
(define-skeleton ada-accept-1
"Insert a condition statement, prompting for the condition name."
"[condition]: "
1998-12-14 03:18:06 +00:00
"when " str | -5 )
(define-skeleton ada-accept-2
"Insert an accept statement, prompting for the name and arguments."
"[accept name]: "
> "accept " str
1998-12-14 03:18:06 +00:00
(ada-get-param)
" do" \n
> _ \n
< "end " str ";" )
(define-skeleton ada-accept
"Insert an accept statement (prompt for condition, name and arguments)."
()
> (ada-accept-1) & " =>\n"
(ada-accept-2))
1998-12-14 03:18:06 +00:00
(define-skeleton ada-or-accept
"Insert an accept alternative, prompting for the condition name."
1998-12-14 03:18:06 +00:00
()
< "or\n"
(ada-accept))
1998-12-14 03:18:06 +00:00
(define-skeleton ada-or-delay
"Insert a delay alternative, prompting for the delay value."
"[delay value]: "
1998-12-14 03:18:06 +00:00
< "or\n"
> "delay " str ";")
2003-02-04 13:24:35 +00:00
1998-12-14 03:18:06 +00:00
(define-skeleton ada-or-terminate
"Insert a terminate alternative."
1998-12-14 03:18:06 +00:00
()
< "or\n"
> "terminate;")
(provide 'ada-stmt)
;; arch-tag: 94f51555-cc0e-44e5-8865-8788aae8ecd3
1998-12-14 03:18:06 +00:00
;;; ada-stmt.el ends here