lisp/progmodes/ada-stmt.el

   1 ;;; ada-stmt.el --- an extension to Ada mode for inserting statement templates
   2
   3 ;; Copyright(C) 1987, 93, 94, 96, 97, 98, 99, 2000, 2001, 2002
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Ada Core Technologies's version:   Revision: 1.21 (GNAT 3.15)
   7
   8 ;; This file is part of GNU Emacs.
   9
  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
  14
  15 ;;; Commentary:
  16 ;; This file is now automatically loaded from ada-mode.el, and creates a submenu
  17 ;; in Ada/ on the menu bar.
  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
  32 ;;
  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>
  41 ;; made it work with skeleton.el from Emacs-19.30. Several
  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
  64 (eval-when-compile
  65   (condition-case nil  (require 'skeleton)
  66     (error nil)))
  67
  68 (require 'easymenu)
  69
  70 (defun ada-stmt-add-to-ada-menu ()
  71   "Add a new submenu to the Ada menu."
  72   (interactive)
  73   (let ((menu  '(["Header" ada-header t]
  74                  ["-" nil nil]
  75                  ["Package Body" ada-package-body t]
  76                  ["Package Spec" ada-package-spec t]
  77                  ["Function Spec" ada-function-spec t]
  78                  ["Procedure Spec" ada-procedure-spec t]
  79                  ["Proc/func Body" ada-subprogram-body t]
  80                  ["Task Body" ada-task-body t]
  81                  ["Task Spec" ada-task-spec t]
  82                  ["Declare Block" ada-declare-block t]
  83                  ["Exception Block" ada-exception-block t]
  84                  ["--" nil nil]
  85                  ["Entry" ada-entry t]
  86                  ["Entry family" ada-entry-family t]
  87                  ["Select" ada-select t]
  88                  ["Accept" ada-accept t]
  89                  ["Or accept" ada-or-accep t]
  90                  ["Or delay" ada-or-delay t]
  91                  ["Or terminate" ada-or-terminate t]
  92                  ["---" nil nil]
  93                  ["Type" ada-type t]
  94                  ["Private" ada-private t]
  95                  ["Subtype" ada-subtype t]
  96                  ["Record" ada-record t]
  97                  ["Array" ada-array t]
  98                  ["----" nil nil]
  99                  ["If" ada-if t]
 100                  ["Else" ada-else t]
 101                  ["Elsif" ada-elsif t]
 102                  ["Case" ada-case t]
 103                  ["-----" nil nil]
 104                  ["While Loop" ada-while-loop t]
 105                  ["For Loop" ada-for-loop t]
 106                  ["Loop" ada-loop t]
 107                  ["------" nil nil]
 108                  ["Exception" ada-exception t]
 109                  ["Exit" ada-exit t]
 110                  ["When" ada-when t])))
 111     (if ada-xemacs
 112         (funcall (symbol-function 'add-submenu)
 113                  '("Ada") (append (list "Templates"
 114                                         :included '(string= mode-name "Ada"))
 115                                   menu))
 116
 117       (define-key-after (or
 118                          (lookup-key ada-mode-map [menu-bar Ada])
 119                          (lookup-key ada-mode-map [menu-bar ada]))
 120         [Templates]
 121         (list 'menu-item
 122               "Templates"
 123               (easy-menu-create-menu "Templates" menu)
 124               :visible '(string= mode-name "Ada"))
 125         t))))
 126
 127
 128
 129 \f
 130 (defun ada-func-or-proc-name ()
 131   ;; Get the name of the current function or procedure."
 132   (save-excursion
 133     (let ((case-fold-search t))
 134       (if (re-search-backward ada-procedure-start-regexp nil t)
 135           (buffer-substring (match-beginning 3) (match-end 3))
 136         "NAME?"))))
 137
 138 (defvar ada-template-map
 139   (let ((map (make-sparse-keymap)))
 140     (define-key map "h" 'ada-header)
 141     (define-key map "\C-a" 'ada-array)
 142     (define-key map "b" 'ada-exception-block)
 143     (define-key map "d" 'ada-declare-block)
 144     (define-key map "c" 'ada-case)
 145     (define-key map "\C-e"  'ada-elsif)
 146     (define-key map "e"      'ada-else)
 147     (define-key map "\C-k"   'ada-package-spec)
 148     (define-key map "k"      'ada-package-body)
 149     (define-key map "\C-p"   'ada-procedure-spec)
 150     (define-key map "p"      'ada-subprogram-body)
 151     (define-key map "\C-f"   'ada-function-spec)
 152     (define-key map "f"      'ada-for-loop)
 153     (define-key map "i"      'ada-if)
 154     (define-key map "l"      'ada-loop)
 155     (define-key map "\C-r"   'ada-record)
 156     (define-key map "\C-s"   'ada-subtype)
 157     (define-key map "S"      'ada-tabsize)
 158     (define-key map "\C-t"   'ada-task-spec)
 159     (define-key map "t"      'ada-task-body)
 160     (define-key map "\C-y"   'ada-type)
 161     (define-key map "\C-v"   'ada-private)
 162     (define-key map "u"      'ada-use)
 163     (define-key map "\C-u"   'ada-with)
 164     (define-key map "\C-w"   'ada-when)
 165     (define-key map "w"      'ada-while-loop)
 166     (define-key map "\C-x"   'ada-exception)
 167     (define-key map "x"      'ada-exit)
 168     map)
 169   "Keymap used in Ada mode for smart template operations.")
 170
 171 (define-key ada-mode-map "\C-ct" ada-template-map)
 172
 173 ;;; ---- statement skeletons ------------------------------------------
 174
 175 (define-skeleton ada-array
 176   "Insert array type definition.
 177 Prompt for component type and index subtypes."
 178   ()
 179   "array (" ("index definition: " str ", " ) -2 ") of " _ ?\;)
 180
 181
 182 (define-skeleton ada-case
 183   "Build skeleton case statement.
 184 Prompt for the selector expression. Also builds the first when clause."
 185   "[selector expression]: "
 186   "case " str " is" \n
 187   > "when " ("discrete choice: " str " | ") -3 " =>" \n
 188   > _ \n
 189   < < "end case;")
 190
 191
 192 (define-skeleton ada-when
 193   "Start a case statement alternative with a when clause."
 194   ()
 195   < "when " ("discrete choice: " str " | ") -3 " =>" \n
 196   >)
 197
 198
 199 (define-skeleton ada-declare-block
 200   "Insert a block with a declare part.
 201 Indent for the first declaration."
 202   "[block name]: "
 203   < str & ?: & \n
 204   > "declare" \n
 205   > _ \n
 206   < "begin" \n
 207   > \n
 208   < "end " str | -1 ?\;)
 209
 210
 211 (define-skeleton ada-exception-block
 212   "Insert a block with an exception part.
 213 Indent for the first line of code."
 214   "[block name]: "
 215   < str & ?: & \n
 216   > "begin" \n
 217   > _ \n
 218   < "exception" \n
 219   > \n
 220   < "end " str | -1 ?\;)
 221
 222
 223 (define-skeleton ada-exception
 224   "Insert an indented exception part into a block."
 225   ()
 226   < "exception" \n
 227   >)
 228
 229
 230 (define-skeleton ada-exit-1
 231   "Insert then exit condition of the exit statement, prompting for condition."
 232   "[exit condition]: "
 233   "when " str | -5)
 234
 235
 236 (define-skeleton ada-exit
 237   "Insert an exit statement, prompting for loop name and condition."
 238   "[name of loop to exit]: "
 239   "exit " str & ?\ (ada-exit-1) | -1 ?\;)
 240
 241 ;;;###autoload
 242 (defun ada-header ()
 243   "Insert a descriptive header at the top of the file."
 244   (interactive "*")
 245   (save-excursion
 246     (goto-char (point-min))
 247     (if (fboundp 'make-header)
 248         (funcall (symbol-function 'make-header))
 249       (ada-header-tmpl))))
 250
 251
 252 (define-skeleton ada-header-tmpl
 253   "Insert a comment block containing the module title, author, etc."
 254   "[Description]: "
 255   "--                              -*- Mode: Ada -*-"
 256   "\n" ada-fill-comment-prefix "Filename        : " (buffer-name)
 257   "\n" ada-fill-comment-prefix "Description     : " str
 258   "\n" ada-fill-comment-prefix "Author          : " (user-full-name)
 259   "\n" ada-fill-comment-prefix "Created On      : " (current-time-string)
 260   "\n" ada-fill-comment-prefix "Last Modified By: ."
 261   "\n" ada-fill-comment-prefix "Last Modified On: ."
 262   "\n" ada-fill-comment-prefix "Update Count    : 0"
 263   "\n" ada-fill-comment-prefix "Status          : Unknown, Use with caution!"
 264   "\n")
 265
 266
 267 (define-skeleton ada-display-comment
 268   "Inserts three comment lines, making a display comment."
 269   ()
 270   "--\n" ada-fill-comment-prefix _ "\n--")
 271
 272
 273 (define-skeleton ada-if
 274   "Insert skeleton if statment, prompting for a boolean-expression."
 275   "[condition]: "
 276   "if " str " then" \n
 277   > _ \n
 278   < "end if;")
 279
 280
 281 (define-skeleton ada-elsif
 282   "Add an elsif clause to an if statement,
 283 prompting for the boolean-expression."
 284   "[condition]: "
 285   < "elsif " str " then" \n
 286   >)
 287
 288
 289 (define-skeleton ada-else
 290   "Add an else clause inside an if-then-end-if clause."
 291   ()
 292   < "else" \n
 293   >)
 294
 295
 296 (define-skeleton ada-loop
 297   "Insert a skeleton loop statement.  The exit statement is added by hand."
 298   "[loop name]: "
 299   < str & ?: & \n
 300   > "loop" \n
 301   > _ \n
 302   < "end loop " str | -1 ?\;)
 303
 304
 305 (define-skeleton ada-for-loop-prompt-variable
 306   "Prompt for the loop variable."
 307   "[loop variable]: "
 308   str)
 309
 310
 311 (define-skeleton ada-for-loop-prompt-range
 312   "Prompt for the loop range."
 313   "[loop range]: "
 314   str)
 315
 316
 317 (define-skeleton ada-for-loop
 318   "Build a skeleton for-loop statement, prompting for the loop parameters."
 319   "[loop name]: "
 320   < str & ?: & \n
 321   > "for "
 322   (ada-for-loop-prompt-variable)
 323   " in "
 324   (ada-for-loop-prompt-range)
 325   " loop" \n
 326   > _ \n
 327   < "end loop " str | -1 ?\;)
 328
 329
 330 (define-skeleton ada-while-loop-prompt-entry-condition
 331   "Prompt for the loop entry condition."
 332   "[entry condition]: "
 333   str)
 334
 335
 336 (define-skeleton ada-while-loop
 337   "Insert a skeleton while loop statement."
 338   "[loop name]: "
 339   < str & ?: & \n
 340   > "while "
 341   (ada-while-loop-prompt-entry-condition)
 342   " loop" \n
 343   > _ \n
 344   < "end loop " str | -1 ?\;)
 345
 346
 347 (define-skeleton ada-package-spec
 348   "Insert a skeleton package specification."
 349   "[package name]: "
 350   "package " str  " is" \n
 351   > _ \n
 352   < "end " str ?\;)
 353
 354
 355 (define-skeleton ada-package-body
 356   "Insert a skeleton package body --  includes a begin statement."
 357   "[package name]: "
 358   "package body " str " is" \n
 359   > _ \n
 360 ;  < "begin" \n
 361   < "end " str ?\;)
 362
 363
 364 (define-skeleton ada-private
 365   "Undent and start a private section of a package spec. Reindent."
 366   ()
 367   < "private" \n
 368   >)
 369
 370
 371 (define-skeleton ada-function-spec-prompt-return
 372   "Prompts for function result type."
 373   "[result type]: "
 374   str)
 375
 376
 377 (define-skeleton ada-function-spec
 378   "Insert a function specification.  Prompts for name and arguments."
 379   "[function name]: "
 380   "function " str
 381   " (" ("[parameter_specification]: " str "; " ) -2 ")"
 382   " return "
 383   (ada-function-spec-prompt-return)
 384   ";" \n )
 385
 386
 387 (define-skeleton ada-procedure-spec
 388   "Insert a procedure specification, prompting for its name and arguments."
 389   "[procedure name]: "
 390   "procedure " str
 391   " (" ("[parameter_specification]: " str "; " ) -2 ")"
 392   ";" \n )
 393
 394
 395 (define-skeleton ada-subprogram-body
 396   "Insert frame for subprogram body.
 397 Invoke right after `ada-function-spec' or `ada-procedure-spec'."
 398   ()
 399   ;; Remove `;' from subprogram decl
 400   (save-excursion
 401     (let ((pos (1+ (point))))
 402       (ada-search-ignore-string-comment ada-subprog-start-re t nil)
 403       (when (ada-search-ignore-string-comment "(" nil pos t 'search-forward)
 404         (backward-char 1)
 405         (forward-sexp 1)))
 406     (if (looking-at ";")
 407         (delete-char 1)))
 408   " is" \n
 409    _ \n
 410    < "begin" \n
 411    \n
 412    < "exception" \n
 413    "when others => null;" \n
 414    < < "end "
 415   (ada-func-or-proc-name)
 416   ";" \n)
 417
 418
 419 (define-skeleton ada-separate
 420   "Finish a body stub with `separate'."
 421   ()
 422   > "separate;" \n
 423   <)
 424
 425
 426 ;(define-skeleton ada-with
 427 ;  "Inserts a with clause, prompting for the list of units depended upon."
 428 ;  "[list of units depended upon]: "
 429 ;  "with " str ?\;)
 430
 431 ;(define-skeleton ada-use
 432 ;  "Inserts a use clause, prompting for the list of packages used."
 433 ;  "[list of packages used]: "
 434 ;  "use " str ?\;)
 435
 436
 437 (define-skeleton ada-record
 438   "Insert a skeleton record type declaration."
 439   ()
 440   "record" \n
 441   > _ \n
 442   < "end record;")
 443
 444
 445 (define-skeleton ada-subtype
 446   "Start insertion of a subtype declaration, prompting for the subtype name."
 447   "[subtype name]: "
 448   "subtype " str " is " _ ?\;
 449   (not (message "insert subtype indication.")))
 450
 451
 452 (define-skeleton ada-type
 453   "Start insertion of a type declaration, prompting for the type name."
 454   "[type name]: "
 455   "type " str ?\(
 456   ("[discriminant specs]: " str " ")
 457   | (backward-delete-char 1) | ?\)
 458   " is "
 459   (not (message "insert type definition.")))
 460
 461
 462 (define-skeleton ada-task-body
 463   "Insert a task body, prompting for the task name."
 464   "[task name]: "
 465   "task body " str " is\n"
 466   "begin\n"
 467   > _ \n
 468   < "end " str ";" )
 469
 470
 471 (define-skeleton ada-task-spec
 472   "Insert a task specification, prompting for the task name."
 473   "[task name]: "
 474   "task " str
 475   " (" ("[discriminant]: " str "; ") ") is\n"
 476   > "entry " _ \n
 477   <"end " str ";" )
 478
 479
 480 (define-skeleton ada-get-param1
 481   "Prompt for arguments and if any enclose them in brackets."
 482   ()
 483   ("[parameter_specification]: " str "; " ) & -2 & ")")
 484
 485
 486 (define-skeleton ada-get-param
 487   "Prompt for arguments and if any enclose them in brackets."
 488   ()
 489   " ("
 490   (ada-get-param1) | -2)
 491
 492
 493 (define-skeleton ada-entry
 494   "Insert a task entry, prompting for the entry name."
 495   "[entry name]: "
 496   "entry " str
 497   (ada-get-param)
 498   ";" \n)
 499
 500
 501 (define-skeleton ada-entry-family-prompt-discriminant
 502   "Insert a entry specification, prompting for the entry name."
 503   "[discriminant name]: "
 504   str)
 505
 506
 507 (define-skeleton ada-entry-family
 508   "Insert a entry specification, prompting for the entry name."
 509   "[entry name]: "
 510   "entry " str
 511   " (" (ada-entry-family-prompt-discriminant) ")"
 512   (ada-get-param)
 513   ";" \n)
 514
 515
 516 (define-skeleton ada-select
 517   "Insert a select block."
 518   ()
 519   "select\n"
 520   > _ \n
 521   < "end select;")
 522
 523
 524 (define-skeleton ada-accept-1
 525   "Insert a condition statement, prompting for the condition name."
 526   "[condition]: "
 527   "when " str | -5 )
 528
 529
 530 (define-skeleton ada-accept-2
 531   "Insert an accept statement, prompting for the name and arguments."
 532   "[accept name]: "
 533   > "accept " str
 534   (ada-get-param)
 535   " do" \n
 536   > _ \n
 537   < "end " str ";" )
 538
 539
 540 (define-skeleton ada-accept
 541   "Insert an accept statement (prompt for condition, name and arguments)."
 542   ()
 543   > (ada-accept-1) & " =>\n"
 544   (ada-accept-2))
 545
 546
 547 (define-skeleton ada-or-accept
 548   "Insert an or statement, prompting for the condition name."
 549   ()
 550   < "or\n"
 551   (ada-accept))
 552
 553
 554 (define-skeleton ada-or-delay
 555   "Insert a delay statement, prompting for the delay value."
 556   "[delay value]: "
 557   < "or\n"
 558   > "delay " str ";")
 559
 560
 561 (define-skeleton ada-or-terminate
 562   "Insert a terminate statement."
 563   ()
 564   < "or\n"
 565   > "terminate;")
 566
 567
 568 (defun ada-adjust-case-skeleton ()
 569   "Adjust the case of the text inserted by a skeleton."
 570   (save-excursion
 571     (let ((aa-end (point)))
 572       (ada-adjust-case-region
 573        (progn (goto-char (symbol-value 'beg)) (forward-word -1) (point))
 574        (goto-char aa-end)))))
 575
 576 (defun ada-stmt-mode-hook ()
 577   (set (make-local-variable 'skeleton-further-elements)
 578        '((< '(backward-delete-char-untabify
 579               (min ada-indent (current-column))))))
 580   (add-hook 'skeleton-end-hook
 581             'ada-adjust-case-skeleton nil t)
 582   (ada-stmt-add-to-ada-menu))
 583
 584 (add-hook 'ada-mode-hook 'ada-stmt-mode-hook)
 585
 586 (provide 'ada-stmt)
 587
 588 ;;; ada-stmt.el ends here