1 ;;; ada-mode.el --- major-mode for editing Ada sources
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Rolf Ebert <ebert@inf.enst.fr>
7 ;; Markus Heritsch <Markus.Heritsch@studbox.uni-stuttgart.de>
8 ;; Emmanuel Briot <briot@gnat.com>
9 ;; Maintainer: Stephen Leake <stephen_leake@member.fsf.org>
10 ;; Keywords: languages ada
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This mode is a major mode for editing Ada code. This is a major
29 ;; rewrite of the file packaged with Emacs-20. The Ada mode is
30 ;; composed of four Lisp files: ada-mode.el, ada-xref.el, ada-prj.el
31 ;; and ada-stmt.el. Only this file (ada-mode.el) is completely
32 ;; independent from the GNU Ada compiler GNAT, distributed by Ada
33 ;; Core Technologies. All the other files rely heavily on features
34 ;; provided only by GNAT.
36 ;; Note: this mode will not work with Emacs 19. If you are on a VMS
37 ;; system, where the latest version of Emacs is 19.28, you will need
38 ;; another file, called ada-vms.el, that provides some required
42 ;; Emacs should enter Ada mode automatically when you load an Ada file.
43 ;; By default, the valid extensions for Ada files are .ads, .adb or .ada
44 ;; If the ada-mode does not start automatically, then simply type the
45 ;; following command :
48 ;; By default, ada-mode is configured to take full advantage of the GNAT
49 ;; compiler (the menus will include the cross-referencing features,...).
50 ;; If you are using another compiler, you might want to set the following
51 ;; variable in your .emacs (Note: do not set this in the ada-mode-hook, it
53 ;; (setq ada-which-compiler 'generic)
55 ;; This mode requires find-file.el to be present on your system.
58 ;; The first Ada mode for GNU Emacs was written by V. Broman in
59 ;; 1985. He based his work on the already existing Modula-2 mode.
60 ;; This was distributed as ada.el in versions of Emacs prior to 19.29.
62 ;; Lynn Slater wrote an extensive Ada mode in 1989. It consisted of
63 ;; several files with support for dired commands and other nice
64 ;; things. It is currently available from the PAL
65 ;; (wuarchive.wustl.edu:/languages/ada) as ada-mode-1.06a.tar.Z.
67 ;; The probably very first Ada mode (called electric-ada.el) was
68 ;; written by Steven D. Litvintchouk and Steven M. Rosen for the
69 ;; Gosling Emacs. L. Slater based his development on ada.el and
72 ;; A complete rewrite by M. Heritsch and R. Ebert has been done.
73 ;; Some ideas from the Ada mode mailing list have been
74 ;; added. Some of the functionality of L. Slater's mode has not
75 ;; (yet) been recoded in this new mode. Perhaps you prefer sticking
78 ;; A complete rewrite for Emacs-20 / GNAT-3.11 has been done by Ada Core
82 ;; Many thanks to John McCabe <john@assen.demon.co.uk> for sending so
83 ;; many patches included in this package.
84 ;; Christian Egli <Christian.Egli@hcsd.hac.com>:
85 ;; ada-imenu-generic-expression
86 ;; Many thanks also to the following persons that have contributed
88 ;; Philippe Waroquiers (PW) <philippe@cfmu.eurocontrol.be> in particular,
89 ;; woodruff@stc.llnl.gov (John Woodruff)
90 ;; jj@ddci.dk (Jesper Joergensen)
91 ;; gse@ocsystems.com (Scott Evans)
92 ;; comar@gnat.com (Cyrille Comar)
93 ;; stephen.leake@gsfc.nasa.gov (Stephen Leake)
94 ;; robin-reply@reagans.org
95 ;; and others for their valuable hints.
98 ;; Note: Every function in this package is compiler-independent.
99 ;; The names start with ada-
100 ;; The variables that the user can edit can all be modified through
101 ;; the customize mode. They are sorted in alphabetical order in this
104 ;; Supported packages.
105 ;; This package supports a number of other Emacs modes. These other modes
106 ;; should be loaded before the ada-mode, which will then setup some variables
107 ;; to improve the support for Ada code.
108 ;; Here is the list of these modes:
109 ;; `which-function-mode': Display the name of the subprogram the cursor is
110 ;; in in the mode line.
111 ;; `outline-mode': Provides the capability to collapse or expand the code
112 ;; for specific language constructs, for instance if you want to hide the
113 ;; code corresponding to a subprogram
114 ;; `align': This mode is now provided with Emacs 21, but can also be
115 ;; installed manually for older versions of Emacs. It provides the
116 ;; capability to automatically realign the selected region (for instance
117 ;; all ':=', ':' and '--' will be aligned on top of each other.
118 ;; `imenu': Provides a menu with the list of entities defined in the current
119 ;; buffer, and an easy way to jump to any of them
120 ;; `speedbar': Provides a separate file browser, and the capability for each
121 ;; file to see the list of entities defined in it and to jump to them
123 ;; `abbrev-mode': Provides the capability to define abbreviations, which
124 ;; are automatically expanded when you type them. See the Emacs manual.
126 (require 'find-file nil t
)
127 (require 'align nil t
)
128 (require 'which-func nil t
)
129 (require 'compile nil t
)
131 (defvar ispell-check-comments
)
132 (defvar skeleton-further-elements
)
134 (defun ada-mode-version ()
135 "Return Ada mode version."
137 (let ((version-string "4.00"))
138 (if (called-interactively-p 'interactive
)
139 (message version-string
)
142 (defvar ada-mode-hook nil
143 "*List of functions to call when Ada mode is invoked.
144 This hook is automatically executed after the `ada-mode' is
146 This is a good place to add Ada environment specific bindings.")
149 "Major mode for editing and compiling Ada source in Emacs."
150 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
153 (defcustom ada-auto-case t
154 "*Non-nil means automatically change case of preceding word while typing.
155 Casing is done according to `ada-case-keyword', `ada-case-identifier'
156 and `ada-case-attribute'."
157 :type
'boolean
:group
'ada
)
159 (defcustom ada-broken-decl-indent
0
160 "*Number of columns to indent a broken declaration.
166 :type
'integer
:group
'ada
)
168 (defcustom ada-broken-indent
2
169 "*Number of columns to indent the continuation of a broken line.
172 My_Var : My_Type := (Field1 =>
174 :type
'integer
:group
'ada
)
176 (defcustom ada-continuation-indent ada-broken-indent
177 "*Number of columns to indent the continuation of broken lines in parenthesis.
182 :type
'integer
:group
'ada
)
184 (defcustom ada-case-attribute
'ada-capitalize-word
185 "*Function to call to adjust the case of Ada attributes.
186 It may be `downcase-word', `upcase-word', `ada-loose-case-word',
187 `ada-capitalize-word' or `ada-no-auto-case'."
188 :type
'(choice (const downcase-word
)
190 (const ada-capitalize-word
)
191 (const ada-loose-case-word
)
192 (const ada-no-auto-case
))
195 (defcustom ada-case-exception-file
196 (list (convert-standard-filename' "~/.emacs_case_exceptions"))
197 "*List of special casing exceptions dictionaries for identifiers.
198 The first file is the one where new exceptions will be saved by Emacs
199 when you call `ada-create-case-exception'.
201 These files should contain one word per line, that gives the casing
202 to be used for that word in Ada files. If the line starts with the
203 character *, then the exception will be used for substrings that either
204 start at the beginning of a word or after a _ character, and end either
205 at the end of the word or at a _ character. Each line can be terminated
207 :type
'(repeat (file))
210 (defcustom ada-case-keyword
'downcase-word
211 "*Function to call to adjust the case of an Ada keywords.
212 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
213 `ada-capitalize-word'."
214 :type
'(choice (const downcase-word
)
216 (const ada-capitalize-word
)
217 (const ada-loose-case-word
)
218 (const ada-no-auto-case
))
221 (defcustom ada-case-identifier
'ada-loose-case-word
222 "*Function to call to adjust the case of an Ada identifier.
223 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
224 `ada-capitalize-word'."
225 :type
'(choice (const downcase-word
)
227 (const ada-capitalize-word
)
228 (const ada-loose-case-word
)
229 (const ada-no-auto-case
))
232 (defcustom ada-clean-buffer-before-saving t
233 "*Non-nil means remove trailing spaces and untabify the buffer before saving."
234 :type
'boolean
:group
'ada
)
235 (make-obsolete-variable 'ada-clean-buffer-before-saving
236 "use the `write-file-functions' hook."
240 (defcustom ada-indent
3
241 "*Size of Ada indentation.
247 :type
'integer
:group
'ada
)
249 (defcustom ada-indent-after-return t
250 "*Non-nil means automatically indent after RET or LFD."
251 :type
'boolean
:group
'ada
)
253 (defcustom ada-indent-align-comments t
254 "*Non-nil means align comments on previous line comments, if any.
255 If nil, indentation is calculated as usual.
256 Note that indentation is calculated only if `ada-indent-comment-as-code' is t.
259 A := 1; -- A multi-line comment
260 -- aligned if `ada-indent-align-comments' is t"
261 :type
'boolean
:group
'ada
)
263 (defcustom ada-indent-comment-as-code t
264 "*Non-nil means indent comment lines as code.
265 A nil value means do not auto-indent comments."
266 :type
'boolean
:group
'ada
)
268 (defcustom ada-indent-handle-comment-special nil
269 "*Non-nil if comment lines should be handled specially inside parenthesis.
270 By default, if the line that contains the open parenthesis has some
271 text following it, then the following lines will be indented in the
272 same column as this text. This will not be true if the first line is
273 a comment and `ada-indent-handle-comment-special' is t.
276 ( Value_1, -- common behavior, when not a comment
280 ( -- `ada-indent-handle-comment-special' is nil
285 ( -- `ada-indent-handle-comment-special' is non-nil
288 :type
'boolean
:group
'ada
)
290 (defcustom ada-indent-is-separate t
291 "*Non-nil means indent 'is separate' or 'is abstract' if on a single line."
292 :type
'boolean
:group
'ada
)
294 (defcustom ada-indent-record-rel-type
3
295 "*Indentation for 'record' relative to 'type' or 'use'.
300 :type
'integer
:group
'ada
)
302 (defcustom ada-indent-renames ada-broken-indent
303 "*Indentation for renames relative to the matching function statement.
304 If `ada-indent-return' is null or negative, the indentation is done relative to
305 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
308 function A (B : Integer)
311 :type
'integer
:group
'ada
)
313 (defcustom ada-indent-return
0
314 "*Indentation for 'return' relative to the matching 'function' statement.
315 If `ada-indent-return' is null or negative, the indentation is done relative to
316 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
319 function A (B : Integer)
321 :type
'integer
:group
'ada
)
323 (defcustom ada-indent-to-open-paren t
324 "*Non-nil means indent according to the innermost open parenthesis."
325 :type
'boolean
:group
'ada
)
327 (defcustom ada-fill-comment-prefix
"-- "
328 "*Text inserted in the first columns when filling a comment paragraph.
329 Note: if you modify this variable, you will have to invoke `ada-mode'
330 again to take account of the new value."
331 :type
'string
:group
'ada
)
333 (defcustom ada-fill-comment-postfix
" --"
334 "*Text inserted at the end of each line when filling a comment paragraph.
335 Used by `ada-fill-comment-paragraph-postfix'."
336 :type
'string
:group
'ada
)
338 (defcustom ada-label-indent -
4
339 "*Number of columns to indent a label.
346 This is also used for <<..>> labels"
347 :type
'integer
:group
'ada
)
349 (defcustom ada-language-version
'ada95
350 "*Ada language version; one of `ada83', `ada95', `ada2005'."
351 :type
'(choice (const ada83
) (const ada95
) (const ada2005
)) :group
'ada
)
353 (defcustom ada-move-to-declaration nil
354 "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'."
355 :type
'boolean
:group
'ada
)
357 (defcustom ada-popup-key
'[down-mouse-3
]
358 "*Key used for binding the contextual menu.
359 If nil, no contextual menu is available."
360 :type
'(restricted-sexp :match-alternatives
(stringp vectorp
))
363 (defcustom ada-search-directories
365 (split-string (or (getenv "ADA_INCLUDE_PATH") "") ":")
366 '("/usr/adainclude" "/usr/local/adainclude"
367 "/opt/gnu/adainclude"))
368 "*Default list of directories to search for Ada files.
369 See the description for the `ff-search-directories' variable. This variable
370 is the initial value of `ada-search-directories-internal'."
371 :type
'(repeat (choice :tag
"Directory"
372 (const :tag
"default" nil
)
373 (directory :format
"%v")))
376 (defvar ada-search-directories-internal ada-search-directories
377 "Internal version of `ada-search-directories'.
378 Its value is the concatenation of the search path as read in the project file
379 and the standard runtime location, and the value of the user-defined
380 `ada-search-directories'.")
382 (defcustom ada-stmt-end-indent
0
383 "*Number of columns to indent the end of a statement on a separate line.
388 :type
'integer
:group
'ada
)
390 (defcustom ada-tab-policy
'indent-auto
391 "*Control the behavior of the TAB key.
393 `indent-rigidly' : always adds `ada-indent' blanks at the beginning of the line.
394 `indent-auto' : use indentation functions in this file.
395 `always-tab' : do `indent-relative'."
396 :type
'(choice (const indent-auto
)
397 (const indent-rigidly
)
401 (defcustom ada-use-indent ada-broken-indent
402 "*Indentation for the lines in a 'use' statement.
407 :type
'integer
:group
'ada
)
409 (defcustom ada-when-indent
3
410 "*Indentation for 'when' relative to 'exception' or 'case'.
415 :type
'integer
:group
'ada
)
417 (defcustom ada-with-indent ada-broken-indent
418 "*Indentation for the lines in a 'with' statement.
423 :type
'integer
:group
'ada
)
425 (defcustom ada-which-compiler
'gnat
426 "*Name of the compiler to use.
427 This will determine what features are made available through the Ada mode.
428 The possible choices are:
429 `gnat': Use Ada Core Technologies' GNAT compiler. Add some cross-referencing
431 `generic': Use a generic compiler."
432 :type
'(choice (const gnat
)
437 ;;; ---- end of user configurable variables
440 (defvar ada-body-suffixes
'(".adb")
441 "List of possible suffixes for Ada body files.
442 The extensions should include a `.' if needed.")
444 (defvar ada-spec-suffixes
'(".ads")
445 "List of possible suffixes for Ada spec files.
446 The extensions should include a `.' if needed.")
448 (defvar ada-mode-menu
(make-sparse-keymap "Ada")
449 "Menu for Ada mode.")
451 (defvar ada-mode-map
(make-sparse-keymap)
452 "Local keymap used for Ada mode.")
454 (defvar ada-mode-extra-map
(make-sparse-keymap)
455 "Keymap used for non-standard keybindings.")
457 ;; default is C-c C-q because it's free in ada-mode-map
458 (defvar ada-mode-extra-prefix
"\C-c\C-q"
459 "Prefix key to access `ada-mode-extra-map' functions.")
461 (defvar ada-mode-abbrev-table nil
462 "Local abbrev table for Ada mode.")
464 (defvar ada-mode-syntax-table nil
465 "Syntax table to be used for editing Ada source code.")
467 (defvar ada-mode-symbol-syntax-table nil
468 "Syntax table for Ada, where `_' is a word constituent.")
471 ;; These values are used in eval-when-compile expressions.
472 (defconst ada-83-string-keywords
473 '("abort" "abs" "accept" "access" "all" "and" "array" "at" "begin"
474 "body" "case" "constant" "declare" "delay" "delta" "digits" "do"
475 "else" "elsif" "end" "entry" "exception" "exit" "for" "function"
476 "generic" "goto" "if" "in" "is" "limited" "loop" "mod" "new"
477 "not" "null" "of" "or" "others" "out" "package" "pragma" "private"
478 "procedure" "raise" "range" "record" "rem" "renames" "return"
479 "reverse" "select" "separate" "subtype" "task" "terminate" "then"
480 "type" "use" "when" "while" "with" "xor")
481 "List of Ada 83 keywords.
482 Used to define `ada-*-keywords'.")
484 (defconst ada-95-string-keywords
485 '("abstract" "aliased" "protected" "requeue" "tagged" "until")
486 "List of keywords new in Ada 95.
487 Used to define `ada-*-keywords'.")
489 (defconst ada-2005-string-keywords
490 '("interface" "overriding" "synchronized")
491 "List of keywords new in Ada 2005.
492 Used to define `ada-*-keywords.'"))
494 (defvar ada-ret-binding nil
495 "Variable to save key binding of RET when casing is activated.")
497 (defvar ada-case-exception
'()
498 "Alist of words (entities) that have special casing.")
500 (defvar ada-case-exception-substring
'()
501 "Alist of substrings (entities) that have special casing.
502 The substrings are detected for word constituant when the word
503 is not itself in `ada-case-exception', and only for substrings that
504 either are at the beginning or end of the word, or start after '_'.")
506 (defvar ada-lfd-binding nil
507 "Variable to save key binding of LFD when casing is activated.")
509 (defvar ada-other-file-alist nil
510 "Variable used by `find-file' to find the name of the other package.
511 See `ff-other-file-alist'.")
513 (defvar ada-align-list
514 '(("[^:]\\(\\s-*\\):[^:]" 1 t
)
515 ("[^=]\\(\\s-+\\)=[^=]" 1 t
)
516 ("\\(\\s-*\\)use\\s-" 1)
518 "Ada support for align.el <= 2.2.
519 This variable provides regular expressions on which to align different lines.
520 See `align-mode-alist' for more information.")
522 (defvar ada-align-modes
524 (regexp .
"[^:]\\(\\s-*\\):[^:]")
525 (valid .
(lambda() (not (ada-in-comment-p))))
526 (modes .
'(ada-mode)))
528 (regexp .
"[^=]\\(\\s-+\\)=[^=]")
529 (valid .
(lambda() (not (ada-in-comment-p))))
530 (modes .
'(ada-mode)))
532 (regexp .
"\\(\\s-*\\)--")
533 (modes .
'(ada-mode)))
535 (regexp .
"\\(\\s-*\\)use\\s-")
536 (valid .
(lambda() (not (ada-in-comment-p))))
537 (modes .
'(ada-mode)))
539 "Ada support for align.el >= 2.8.
540 This variable defines several rules to use to align different lines.")
542 (defconst ada-align-region-separate
562 "See the variable `align-region-separate' for more information.")
564 ;;; ---- Below are the regexp used in this package for parsing
566 (defconst ada-83-keywords
568 (concat "\\<" (regexp-opt ada-83-string-keywords t
) "\\>"))
569 "Regular expression matching Ada83 keywords.")
571 (defconst ada-95-keywords
573 (concat "\\<" (regexp-opt
575 ada-95-string-keywords
576 ada-83-string-keywords
) t
) "\\>"))
577 "Regular expression matching Ada95 keywords.")
579 (defconst ada-2005-keywords
581 (concat "\\<" (regexp-opt
583 ada-2005-string-keywords
584 ada-83-string-keywords
585 ada-95-string-keywords
) t
) "\\>"))
586 "Regular expression matching Ada2005 keywords.")
588 (defvar ada-keywords ada-2005-keywords
589 "Regular expression matching Ada keywords.")
590 ;; FIXME: make this customizable
592 (defconst ada-ident-re
593 "[[:alpha:]]\\(?:[_[:alnum:]]\\)*"
594 ;; [:alnum:] matches any multibyte word constituent, as well as
595 ;; Latin-1 letters and numbers. This allows __ and trailing _;
596 ;; someone (emacs bug#1919) proposed [^\W_] to fix that, but \W does
597 ;; _not_ mean "not word constituent" inside a character alternative.
598 "Regexp matching an Ada identifier.")
600 (defconst ada-goto-label-re
601 (concat "<<" ada-ident-re
">>")
602 "Regexp matching a goto label.")
604 (defconst ada-block-label-re
605 (concat ada-ident-re
"[ \t\n]*:[^=]")
606 "Regexp matching a block label.
607 Note that this also matches a variable declaration.")
609 (defconst ada-label-re
610 (concat "\\(?:" ada-block-label-re
"\\)\\|\\(?:" ada-goto-label-re
"\\)")
611 "Regexp matching a goto or block label.")
613 ;; "with" needs to be included in the regexp, to match generic subprogram parameters
614 ;; Similarly, we put '[not] overriding' on the same line with 'procedure' etc.
615 (defvar ada-procedure-start-regexp
617 "^[ \t]*\\(with[ \t]+\\)?\\(\\(not[ \t]+\\)?overriding[ \t]+\\)?\\(procedure\\|function\\|task\\)[ \t\n]+"
619 ;; subprogram name: operator ("[+/=*]")
623 ;; subprogram name: name
625 "\\(\\(\\sw\\|[_.]\\)+\\)"
627 "Regexp matching Ada subprogram start.
628 The actual start is at (match-beginning 4). The name is in (match-string 5).")
630 (defconst ada-name-regexp
631 "\\([a-zA-Z][a-zA-Z0-9_.']*[a-zA-Z0-9]\\)"
632 "Regexp matching a fully qualified name (including attribute).")
634 (defconst ada-package-start-regexp
635 (concat "^[ \t]*\\(private[ \t]+\\)?\\(package\\)[ \t\n]+\\(body[ \t]*\\)?" ada-name-regexp
)
636 "Regexp matching start of package.
637 The package name is in (match-string 4).")
639 (defconst ada-compile-goto-error-file-linenr-re
640 "\\([-_.a-zA-Z0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?"
641 "Regexp matching filename:linenr[:column].")
644 ;;; ---- regexps for indentation functions
646 (defvar ada-block-start-re
648 (concat "\\<\\(" (regexp-opt '("begin" "declare" "else"
649 "exception" "generic" "loop" "or"
650 "private" "select" ))
651 "\\|\\(\\(limited\\|abstract\\|tagged\\)[ \t\n]+\\)*record\\)\\>"))
652 "Regexp for keywords starting Ada blocks.")
654 (defvar ada-end-stmt-re
659 "=>[ \t]*--.*$" "\\|"
660 "^[ \t]*separate[ \t]*(\\(\\sw\\|[_.]\\)+)" "\\|"
661 "\\<" (regexp-opt '("begin" "declare" "is" "do" "else" "generic"
662 "loop" "private" "record" "select"
663 "then abort" "then") t
) "\\>" "\\|"
664 "^[ \t]*" (regexp-opt '("function" "package" "procedure")
665 t
) "\\>\\(\\sw\\|[ \t_.]\\)+\\<is\\>" "\\|"
666 "^[ \t]*exception\\>"
668 "Regexp of possible ends for a non-broken statement.
669 A new statement starts after these.")
671 (defvar ada-matching-start-re
675 '("end" "loop" "select" "begin" "case" "do" "declare"
676 "if" "task" "package" "procedure" "function" "record" "protected") t
)
678 "Regexp used in `ada-goto-matching-start'.")
680 (defvar ada-loop-start-re
681 "\\<\\(for\\|while\\|loop\\)\\>"
682 "Regexp for the start of a loop.")
684 (defvar ada-subprog-start-re
686 (concat "\\<" (regexp-opt '("accept" "entry" "function" "overriding" "package" "procedure"
687 "protected" "task") t
) "\\>"))
688 "Regexp for the start of a subprogram.")
690 (defvar ada-contextual-menu-on-identifier nil
691 "Set to true when the right mouse button was clicked on an identifier.")
693 (defvar ada-contextual-menu-last-point nil
694 "Position of point just before displaying the menu.
695 This is a list (point buffer).
696 Since `ada-popup-menu' moves the point where the user clicked, the region
697 is modified. Therefore no command from the menu knows what the user selected
698 before displaying the contextual menu.
699 To get the original region, restore the point to this position before
700 calling `region-end' and `region-beginning'.
701 Modify this variable if you want to restore the point to another position.")
703 (easy-menu-define ada-contextual-menu nil
704 "Menu to use when the user presses the right mouse button.
705 The variable `ada-contextual-menu-on-identifier' will be set to t before
706 displaying the menu if point was on an identifier."
708 ["Goto Declaration/Body" ada-point-and-xref
709 :included ada-contextual-menu-on-identifier
]
710 ["Goto Body" ada-point-and-xref-body
711 :included ada-contextual-menu-on-identifier
]
712 ["Goto Previous Reference" ada-xref-goto-previous-reference
]
713 ["List References" ada-find-references
714 :included ada-contextual-menu-on-identifier
]
715 ["List Local References" ada-find-local-references
716 :included ada-contextual-menu-on-identifier
]
718 ["Other File" ff-find-other-file
]
719 ["Goto Parent Unit" ada-goto-parent
]))
722 ;;------------------------------------------------------------------
723 ;; Support for imenu (see imenu.el)
724 ;;------------------------------------------------------------------
726 (defconst ada-imenu-comment-re
"\\([ \t]*--.*\\)?")
728 (defconst ada-imenu-subprogram-menu-re
729 (concat "^[ \t]*\\(overriding[ \t]*\\)?\\(procedure\\|function\\)[ \t\n]+"
730 "\\(\\(\\sw\\|_\\)+\\)[ \t\n]*\\([ \t\n]\\|([^)]+)"
733 "\\(return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?is[ \t\n]"))
735 (defvar ada-imenu-generic-expression
737 (list nil ada-imenu-subprogram-menu-re
3)
740 "^[ \t]*\\(procedure\\|function\\)[ \t\n]+\\(\\(\\sw\\|_\\)+\\)"
742 "\\(" ada-imenu-comment-re
"[ \t\n]+\\|[ \t\n]*([^)]+)"
743 ada-imenu-comment-re
"\\)";; parameter list or simple space
744 "\\([ \t\n]*return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?"
746 '("*Tasks*" "^[ \t]*task[ \t]+\\(type[ \t]+\\)?\\(\\(body[ \t]+\\)?\\(\\sw\\|_\\)+\\)" 2)
747 '("*Type Defs*" "^[ \t]*\\(sub\\)?type[ \t]+\\(\\(\\sw\\|_\\)+\\)" 2)
749 "^[ \t]*protected[ \t]+\\(type[ \t]+\\)?\\(\\(body[ \t]+\\)?\\(\\sw\\|_\\)+\\)" 2)
750 '("*Packages*" "^[ \t]*package[ \t]+\\(\\(body[ \t]+\\)?\\(\\sw\\|[_.]\\)+\\)" 1))
751 "Imenu generic expression for Ada mode.
752 See `imenu-generic-expression'. This variable will create several submenus for
753 each type of entity that can be found in an Ada file.")
756 ;;------------------------------------------------------------
757 ;; Support for compile.el
758 ;;------------------------------------------------------------
760 (defun ada-compile-mouse-goto-error ()
761 "Mouse interface for `ada-compile-goto-error'."
763 (mouse-set-point last-input-event
)
764 (ada-compile-goto-error (point))
767 (defun ada-compile-goto-error (pos)
768 "Replace `compile-goto-error' from compile.el.
769 If POS is on a file and line location, go to this position. It adds
770 to compile.el the capacity to go to a reference in an error message.
771 For instance, on these lines:
772 foo.adb:61:11: [...] in call to size declared at foo.ads:11
773 foo.adb:61:11: [...] in call to local declared at line 20
774 the 4 file locations can be clicked on and jumped to."
778 (skip-chars-backward "-a-zA-Z0-9_:./\\")
780 ;; special case: looking at a filename:line not at the beginning of a line
781 ;; or a simple line reference "at line ..."
783 (or (looking-at ada-compile-goto-error-file-linenr-re
)
787 (looking-at ada-compile-goto-error-file-linenr-re
))
789 (if (looking-at "\\([0-9]+\\)") (backward-word 1))
790 (looking-at "line \\([0-9]+\\)"))))
792 (let ((line (if (match-beginning 2) (match-string 2) (match-string 1)))
793 (file (if (match-beginning 2) (match-string 1)
794 (save-excursion (beginning-of-line)
795 (looking-at ada-compile-goto-error-file-linenr-re
)
797 (error-pos (point-marker))
802 (compilation-find-file (point-marker) (match-string 1) "./")
806 (goto-char (point-min))
807 (forward-line (1- (string-to-number line
))))
809 (setq source
(point-marker)))
811 (compilation-goto-locus error-pos source nil
)
815 ;; otherwise, default behavior
817 (compile-goto-error))
822 ;;-------------------------------------------------------------------------
823 ;; Grammar related function
824 ;; The functions below work with the syntax class of the characters in an Ada
825 ;; buffer. Two syntax tables are created, depending on whether we want '_'
826 ;; to be considered as part of a word or not.
827 ;; Some characters may have multiple meanings depending on the context:
828 ;; - ' is either the beginning of a constant character or an attribute
829 ;; - # is either part of a based litteral or a gnatprep statement.
830 ;; - " starts a string, but not if inside a constant character.
831 ;; - ( and ) should be ignored if inside a constant character.
832 ;; Thus their syntax property is changed automatically, and we can still use
833 ;; the standard Emacs functions for sexp (see `ada-in-string-p')
835 ;; On Emacs, this is done through the `syntax-table' text property. The
836 ;; corresponding action is applied automatically each time the buffer
837 ;; changes. If `font-lock-mode' is enabled (the default) the action is
838 ;; set up by `font-lock-syntactic-keywords'. Otherwise, we do it
839 ;; manually in `ada-after-change-function'. The proper method is
840 ;; installed by `ada-handle-syntax-table-properties'.
842 ;; on XEmacs, the `syntax-table' property does not exist and we have to use a
843 ;; slow advice to `parse-partial-sexp' to do the same thing.
844 ;; When executing parse-partial-sexp, we simply modify the strings before and
845 ;; after, so that the special constants '"', '(' and ')' do not interact
846 ;; with parse-partial-sexp.
847 ;; Note: this code is slow and needs to be rewritten as soon as something
848 ;; better is available on XEmacs.
849 ;;-------------------------------------------------------------------------
851 (defun ada-create-syntax-table ()
852 "Create the two syntax tables use in the Ada mode.
853 The standard table declares `_' as a symbol constituent, the second one
854 declares it as a word constituent."
856 (setq ada-mode-syntax-table
(make-syntax-table))
858 ;; define string brackets (`%' is alternative string bracket, but
859 ;; almost never used as such and throws font-lock and indentation
861 (modify-syntax-entry ?%
"$" ada-mode-syntax-table
)
862 (modify-syntax-entry ?
\" "\"" ada-mode-syntax-table
)
864 (modify-syntax-entry ?
: "." ada-mode-syntax-table
)
865 (modify-syntax-entry ?\
; "." ada-mode-syntax-table)
866 (modify-syntax-entry ?
& "." ada-mode-syntax-table
)
867 (modify-syntax-entry ?\|
"." ada-mode-syntax-table
)
868 (modify-syntax-entry ?
+ "." ada-mode-syntax-table
)
869 (modify-syntax-entry ?
* "." ada-mode-syntax-table
)
870 (modify-syntax-entry ?
/ "." ada-mode-syntax-table
)
871 (modify-syntax-entry ?
= "." ada-mode-syntax-table
)
872 (modify-syntax-entry ?
< "." ada-mode-syntax-table
)
873 (modify-syntax-entry ?
> "." ada-mode-syntax-table
)
874 (modify-syntax-entry ?$
"." ada-mode-syntax-table
)
875 (modify-syntax-entry ?\
[ "." ada-mode-syntax-table
)
876 (modify-syntax-entry ?\
] "." ada-mode-syntax-table
)
877 (modify-syntax-entry ?\
{ "." ada-mode-syntax-table
)
878 (modify-syntax-entry ?\
} "." ada-mode-syntax-table
)
879 (modify-syntax-entry ?.
"." ada-mode-syntax-table
)
880 (modify-syntax-entry ?
\\ "." ada-mode-syntax-table
)
881 (modify-syntax-entry ?
\' "." ada-mode-syntax-table
)
883 ;; a single hyphen is punctuation, but a double hyphen starts a comment
884 (modify-syntax-entry ?-
". 12" ada-mode-syntax-table
)
886 ;; See the comment above on grammar related function for the special
888 (if (featurep 'xemacs
)
889 (modify-syntax-entry ?
# "<" ada-mode-syntax-table
)
890 (modify-syntax-entry ?
# "$" ada-mode-syntax-table
))
892 ;; and \f and \n end a comment
893 (modify-syntax-entry ?
\f "> " ada-mode-syntax-table
)
894 (modify-syntax-entry ?
\n "> " ada-mode-syntax-table
)
896 ;; define what belongs in Ada symbols
897 (modify-syntax-entry ?_
"_" ada-mode-syntax-table
)
899 ;; define parentheses to match
900 (modify-syntax-entry ?\
( "()" ada-mode-syntax-table
)
901 (modify-syntax-entry ?\
) ")(" ada-mode-syntax-table
)
903 (setq ada-mode-symbol-syntax-table
(copy-syntax-table ada-mode-syntax-table
))
904 (modify-syntax-entry ?_
"w" ada-mode-symbol-syntax-table
)
907 ;; Support of special characters in XEmacs (see the comments at the beginning
908 ;; of the section on Grammar related functions).
910 (if (featurep 'xemacs
)
911 (defadvice parse-partial-sexp
(around parse-partial-sexp-protect-constants
)
912 "Handles special character constants and gnatprep statements."
916 (setq from to to tmp
)))
919 (while (re-search-forward "'\\([(\")#]\\)'" to t
)
920 (setq change
(cons (list (match-beginning 1)
924 (replace-match "'A'"))
926 (while (re-search-forward "\\(#[0-9a-fA-F]*#\\)" to t
)
927 (setq change
(cons (list (match-beginning 1)
928 (length (match-string 1))
931 (replace-match (make-string (length (match-string 1)) ?
@))))
935 (goto-char (caar change
))
936 (delete-char (cadar change
))
937 (insert (caddar change
))
938 (setq change
(cdr change
)))))))
940 (defun ada-set-syntax-table-properties ()
941 "Assign `syntax-table' properties in accessible part of buffer.
942 In particular, character constants are said to be strings, #...#
943 are treated as numbers instead of gnatprep comments."
944 (let ((modified (buffer-modified-p))
946 (inhibit-read-only t
)
947 (inhibit-point-motion-hooks t
)
948 (inhibit-modification-hooks t
))
949 (remove-text-properties (point-min) (point-max) '(syntax-table nil
))
950 (goto-char (point-min))
951 (while (re-search-forward
952 ;; The following regexp was adapted from
953 ;; `ada-font-lock-syntactic-keywords'.
954 "^[ \t]*\\(#\\(?:if\\|else\\|elsif\\|end\\)\\)\\|[^a-zA-Z0-9)]\\('\\)[^'\n]\\('\\)"
956 (if (match-beginning 1)
958 (match-beginning 1) (match-end 1) 'syntax-table
'(11 . ?
\n))
960 (match-beginning 2) (match-end 2) 'syntax-table
'(7 . ?
'))
962 (match-beginning 3) (match-end 3) 'syntax-table
'(7 . ?
'))))
964 (restore-buffer-modified-p nil
))))
966 (defun ada-after-change-function (beg end old-len
)
967 "Called when the region between BEG and END was changed in the buffer.
968 OLD-LEN indicates what the length of the replaced text was."
971 (let ((from (progn (goto-char beg
) (line-beginning-position)))
972 (to (progn (goto-char end
) (line-end-position))))
973 (narrow-to-region from to
)
975 (ada-set-syntax-table-properties))))))
977 (defun ada-initialize-syntax-table-properties ()
978 "Assign `syntax-table' properties in current buffer."
983 (ada-set-syntax-table-properties))))
984 (add-hook 'after-change-functions
'ada-after-change-function nil t
))
986 (defun ada-handle-syntax-table-properties ()
987 "Handle `syntax-table' properties."
989 ;; `font-lock-mode' will take care of `syntax-table' properties.
990 (remove-hook 'after-change-functions
'ada-after-change-function t
)
991 ;; Take care of `syntax-table' properties manually.
992 (ada-initialize-syntax-table-properties)))
994 ;;------------------------------------------------------------------
995 ;; Testing the grammatical context
996 ;;------------------------------------------------------------------
998 (defsubst ada-in-comment-p
(&optional parse-result
)
999 "Return t if inside a comment.
1000 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1001 (nth 4 (or parse-result
1003 (line-beginning-position) (point)))))
1005 (defsubst ada-in-string-p
(&optional parse-result
)
1006 "Return t if point is inside a string.
1007 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1008 (nth 3 (or parse-result
1010 (line-beginning-position) (point)))))
1012 (defsubst ada-in-string-or-comment-p
(&optional parse-result
)
1013 "Return t if inside a comment or string.
1014 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1015 (setq parse-result
(or parse-result
1017 (line-beginning-position) (point))))
1018 (or (ada-in-string-p parse-result
) (ada-in-comment-p parse-result
)))
1020 (defsubst ada-in-numeric-literal-p
()
1021 "Return t if point is after a prefix of a numeric literal."
1022 (looking-back "\\([0-9]+#[0-9a-fA-F_]+\\)"))
1024 ;;------------------------------------------------------------------
1026 ;; The Ada mode comes with contextual menus, bound by default to the right
1028 ;; Add items to this menu by modifying `ada-contextual-menu'. Note that the
1029 ;; variable `ada-contextual-menu-on-identifier' is set automatically to t
1030 ;; if the mouse button was pressed on an identifier.
1031 ;;------------------------------------------------------------------
1033 (defun ada-call-from-contextual-menu (function)
1034 "Execute FUNCTION when called from the contextual menu.
1035 It forces Emacs to change the cursor position."
1038 (setq ada-contextual-menu-last-point
1039 (list (point) (current-buffer))))
1041 (defun ada-popup-menu (position)
1042 "Pops up a contextual menu, depending on where the user clicked.
1043 POSITION is the location the mouse was clicked on.
1044 Sets `ada-contextual-menu-last-point' to the current position before
1045 displaying the menu. When a function from the menu is called, the
1046 point is where the mouse button was clicked."
1049 ;; declare this as a local variable, so that the function called
1050 ;; in the contextual menu does not hide the region in
1051 ;; transient-mark-mode.
1052 (let ((deactivate-mark nil
))
1053 (setq ada-contextual-menu-last-point
1054 (list (point) (current-buffer)))
1055 (mouse-set-point last-input-event
)
1057 (setq ada-contextual-menu-on-identifier
1059 (or (= (char-syntax (char-after)) ?w
)
1060 (= (char-after) ?_
))
1061 (not (ada-in-string-or-comment-p))
1062 (save-excursion (skip-syntax-forward "w")
1063 (not (ada-after-keyword-p)))
1065 (if (fboundp 'popup-menu
)
1066 (funcall (symbol-function 'popup-menu
) ada-contextual-menu
)
1068 (setq choice
(x-popup-menu position ada-contextual-menu
))
1070 (funcall (lookup-key ada-contextual-menu
(vector (car choice
)))))))
1072 (set-buffer (cadr ada-contextual-menu-last-point
))
1073 (goto-char (car ada-contextual-menu-last-point
))
1077 ;;------------------------------------------------------------------
1079 ;;------------------------------------------------------------------
1082 (defun ada-add-extensions (spec body
)
1083 "Define SPEC and BODY as being valid extensions for Ada files.
1084 Going from body to spec with `ff-find-other-file' used these
1086 SPEC and BODY are two regular expressions that must match against
1088 (let* ((reg (concat (regexp-quote body
) "$"))
1089 (tmp (assoc reg ada-other-file-alist
)))
1091 (setcdr tmp
(list (cons spec
(cadr tmp
))))
1092 (add-to-list 'ada-other-file-alist
(list reg
(list spec
)))))
1094 (let* ((reg (concat (regexp-quote spec
) "$"))
1095 (tmp (assoc reg ada-other-file-alist
)))
1097 (setcdr tmp
(list (cons body
(cadr tmp
))))
1098 (add-to-list 'ada-other-file-alist
(list reg
(list body
)))))
1100 (add-to-list 'auto-mode-alist
1101 (cons (concat (regexp-quote spec
) "\\'") 'ada-mode
))
1102 (add-to-list 'auto-mode-alist
1103 (cons (concat (regexp-quote body
) "\\'") 'ada-mode
))
1105 (add-to-list 'ada-spec-suffixes spec
)
1106 (add-to-list 'ada-body-suffixes body
)
1108 ;; Support for speedbar (Specifies that we want to see these files in
1110 (if (fboundp 'speedbar-add-supported-extension
)
1112 (funcall (symbol-function 'speedbar-add-supported-extension
)
1114 (funcall (symbol-function 'speedbar-add-supported-extension
)
1121 "Ada mode is the major mode for editing Ada code."
1124 (kill-all-local-variables)
1126 (set-syntax-table ada-mode-syntax-table
)
1128 (set (make-local-variable 'require-final-newline
) mode-require-final-newline
)
1130 ;; Set the paragraph delimiters so that one can select a whole block
1132 (set (make-local-variable 'paragraph-start
) "[ \t\n\f]*$")
1133 (set (make-local-variable 'paragraph-separate
) "[ \t\n\f]*$")
1135 ;; comment end must be set because it may hold a wrong value if
1136 ;; this buffer had been in another mode before. RE
1137 (set (make-local-variable 'comment-end
) "")
1139 ;; used by autofill and indent-new-comment-line
1140 (set (make-local-variable 'comment-start-skip
) "---*[ \t]*")
1142 ;; used by autofill to break a comment line and continue it on another line.
1143 ;; The reason we need this one is that the default behavior does not work
1144 ;; correctly with the definition of paragraph-start above when the comment
1145 ;; is right after a multi-line subprogram declaration (the comments are
1146 ;; aligned under the latest parameter, not under the declaration start).
1147 (set (make-local-variable 'comment-line-break-function
)
1148 (lambda (&optional soft
) (let ((fill-prefix nil
))
1149 (indent-new-comment-line soft
))))
1151 (set (make-local-variable 'indent-line-function
)
1152 'ada-indent-current-function
)
1154 (set (make-local-variable 'comment-column
) 40)
1156 ;; Emacs 20.3 defines a comment-padding to insert spaces between
1157 ;; the comment and the text. We do not want any, this is already
1158 ;; included in comment-start
1159 (unless (featurep 'xemacs
)
1160 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
1161 (set (make-local-variable 'comment-padding
) 0)
1162 (set (make-local-variable 'parse-sexp-lookup-properties
) t
))
1164 (set 'case-fold-search t
)
1165 (if (boundp 'imenu-case-fold-search
)
1166 (set 'imenu-case-fold-search t
))
1168 (set (make-local-variable 'fill-paragraph-function
)
1169 'ada-fill-comment-paragraph
)
1171 ;; Support for compile.el
1172 ;; We just substitute our own functions to go to the error.
1173 (add-hook 'compilation-mode-hook
1175 ;; FIXME: This has global impact! -stef
1176 (define-key compilation-minor-mode-map
[mouse-2
]
1177 'ada-compile-mouse-goto-error
)
1178 (define-key compilation-minor-mode-map
"\C-c\C-c"
1179 'ada-compile-goto-error
)
1180 (define-key compilation-minor-mode-map
"\C-m"
1181 'ada-compile-goto-error
)))
1183 ;; font-lock support :
1185 (set (make-local-variable 'font-lock-defaults
)
1186 '(ada-font-lock-keywords
1188 ((?\_ .
"w") (?
# .
"."))
1190 (font-lock-syntactic-keywords . ada-font-lock-syntactic-keywords
)))
1192 ;; Set up support for find-file.el.
1193 (set (make-local-variable 'ff-other-file-alist
)
1194 'ada-other-file-alist
)
1195 (set (make-local-variable 'ff-search-directories
)
1196 'ada-search-directories-internal
)
1197 (setq ff-post-load-hook
'ada-set-point-accordingly
1198 ff-file-created-hook
'ada-make-body
)
1199 (add-hook 'ff-pre-load-hook
'ada-which-function-are-we-in
)
1201 (make-local-variable 'ff-special-constructs
)
1202 (mapc (lambda (pair) (add-to-list 'ff-special-constructs pair
))
1204 ;; Top level child package declaration; go to the parent package.
1205 (cons (eval-when-compile
1206 (concat "^\\(private[ \t]\\)?[ \t]*package[ \t]+"
1208 "\\(\\(\\sw\\|[_.]\\)+\\)\\.\\(\\sw\\|_\\)+[ \t\n]+is"))
1211 ada-search-directories-internal
1212 (ada-make-filename-from-adaname (match-string 3))
1213 ada-spec-suffixes
)))
1215 ;; A "separate" clause.
1216 (cons "^separate[ \t\n]*(\\(\\(\\sw\\|[_.]\\)+\\))"
1219 ada-search-directories-internal
1220 (ada-make-filename-from-adaname (match-string 1))
1221 ada-spec-suffixes
)))
1224 (cons "^with[ \t]+\\([a-zA-Z0-9_\\.]+\\)"
1227 ada-search-directories-internal
1228 (ada-make-filename-from-adaname (match-string 1))
1229 ada-spec-suffixes
)))
1232 ;; Support for outline-minor-mode
1233 (set (make-local-variable 'outline-regexp
)
1234 "\\([ \t]*\\(procedure\\|function\\|package\\|if\\|while\\|for\\|declare\\|case\\|end\\|begin\\|loop\\)\\|--\\)")
1235 (set (make-local-variable 'outline-level
) 'ada-outline-level
)
1237 ;; Support for imenu : We want a sorted index
1238 (setq imenu-generic-expression ada-imenu-generic-expression
)
1240 (setq imenu-sort-function
'imenu--sort-by-name
)
1242 ;; Support for ispell : Check only comments
1243 (set (make-local-variable 'ispell-check-comments
) 'exclusive
)
1245 ;; Support for align
1246 (add-to-list 'align-dq-string-modes
'ada-mode
)
1247 (add-to-list 'align-open-comment-modes
'ada-mode
)
1248 (set (make-local-variable 'align-region-separate
) ada-align-region-separate
)
1250 ;; Exclude comments alone on line from alignment.
1251 (add-to-list 'align-exclude-rules-list
1253 (regexp .
"^\\(\\s-*\\)--")
1254 (modes .
'(ada-mode))))
1255 (add-to-list 'align-exclude-rules-list
1257 (regexp .
"^\\(\\s-*\\)\\<use\\>")
1258 (modes .
'(ada-mode))))
1260 (setq ada-align-modes nil
)
1262 (add-to-list 'ada-align-modes
1263 '(ada-declaration-assign
1264 (regexp .
"[^:]\\(\\s-*\\):[^:]")
1265 (valid .
(lambda() (not (ada-in-comment-p))))
1267 (modes .
'(ada-mode))))
1268 (add-to-list 'ada-align-modes
1270 (regexp .
"[^=]\\(\\s-*\\)=>")
1271 (valid .
(lambda() (not (ada-in-comment-p))))
1272 (modes .
'(ada-mode))))
1273 (add-to-list 'ada-align-modes
1275 (regexp .
"\\(\\s-*\\)--")
1276 (modes .
'(ada-mode))))
1277 (add-to-list 'ada-align-modes
1279 (regexp .
"\\(\\s-*\\)\\<use\\s-")
1280 (valid .
(lambda() (not (ada-in-comment-p))))
1281 (modes .
'(ada-mode))))
1282 (add-to-list 'ada-align-modes
1284 (regexp .
"\\(\\s-+\\)at\\>")
1285 (modes .
'(ada-mode))))
1287 (setq align-mode-rules-list ada-align-modes
)
1289 ;; Set up the contextual menu
1291 (define-key ada-mode-map ada-popup-key
'ada-popup-menu
))
1293 ;; Support for Abbreviations (the user still need to "M-x abbrev-mode"
1294 (define-abbrev-table 'ada-mode-abbrev-table
())
1295 (setq local-abbrev-table ada-mode-abbrev-table
)
1297 ;; Support for which-function mode
1298 (make-local-variable 'which-func-functions
)
1299 (setq which-func-functions
'(ada-which-function))
1301 ;; Support for indent-new-comment-line (Especially for XEmacs)
1302 (set (make-local-variable 'comment-multi-line
) nil
)
1304 ;; Support for add-log
1305 (set (make-local-variable 'add-log-current-defun-function
) 'ada-which-function
)
1307 (setq major-mode
'ada-mode
1310 (use-local-map ada-mode-map
)
1312 (easy-menu-add ada-mode-menu ada-mode-map
)
1314 (set-syntax-table ada-mode-syntax-table
)
1316 (set (make-local-variable 'skeleton-further-elements
)
1317 '((< '(backward-delete-char-untabify
1318 (min ada-indent
(current-column))))))
1319 (add-hook 'skeleton-end-hook
'ada-adjust-case-skeleton nil t
)
1321 (run-mode-hooks 'ada-mode-hook
)
1323 ;; To be run after the hook, in case the user modified
1324 ;; ada-fill-comment-prefix
1325 (make-local-variable 'comment-start
)
1326 (if ada-fill-comment-prefix
1327 (set 'comment-start ada-fill-comment-prefix
)
1328 (set 'comment-start
"-- "))
1330 ;; Run this after the hook to give the users a chance to activate
1333 (unless (featurep 'xemacs
)
1334 (ada-initialize-syntax-table-properties)
1335 (add-hook 'font-lock-mode-hook
'ada-handle-syntax-table-properties nil t
))
1337 ;; the following has to be done after running the ada-mode-hook
1338 ;; because users might want to set the values of these variable
1341 (cond ((eq ada-language-version
'ada83
)
1342 (setq ada-keywords ada-83-keywords
))
1343 ((eq ada-language-version
'ada95
)
1344 (setq ada-keywords ada-95-keywords
))
1345 ((eq ada-language-version
'ada2005
)
1346 (setq ada-keywords ada-2005-keywords
)))
1349 (ada-activate-keys-for-case)))
1351 (defun ada-adjust-case-skeleton ()
1352 "Adjust the case of the text inserted by a skeleton."
1354 (let ((aa-end (point)))
1355 (ada-adjust-case-region
1356 (progn (goto-char (symbol-value 'beg
)) (forward-word -
1) (point))
1357 (goto-char aa-end
)))))
1359 (defun ada-region-selected ()
1360 "Should we operate on an active region?"
1361 (if (fboundp 'use-region-p
)
1365 ;;-----------------------------------------------------------------
1367 ;; Since Ada is case-insensitive, the Ada mode provides an extensive set of
1368 ;; functions to auto-case identifiers, keywords, ...
1369 ;; The basic rules for autocasing are defined through the variables
1370 ;; `ada-case-attribute', `ada-case-keyword' and `ada-case-identifier'. These
1371 ;; are references to the functions that will do the actual casing.
1373 ;; However, in most cases, the user will want to define some exceptions to
1374 ;; these casing rules. This is done through a list of files, that contain
1375 ;; one word per line. These files are stored in `ada-case-exception-file'.
1376 ;; For backward compatibility, this variable can also be a string.
1377 ;;-----------------------------------------------------------------
1379 (defun ada-save-exceptions-to-file (file-name)
1380 "Save the casing exception lists to the file FILE-NAME.
1381 Casing exception lists are `ada-case-exception' and `ada-case-exception-substring'."
1382 (find-file (expand-file-name file-name
))
1384 (mapc (lambda (x) (insert (car x
) "\n"))
1385 (sort (copy-sequence ada-case-exception
)
1386 (lambda(a b
) (string< (car a
) (car b
)))))
1387 (mapc (lambda (x) (insert "*" (car x
) "\n"))
1388 (sort (copy-sequence ada-case-exception-substring
)
1389 (lambda(a b
) (string< (car a
) (car b
)))))
1394 (defun ada-create-case-exception (&optional word
)
1395 "Define WORD as an exception for the casing system.
1396 If WORD is not given, then the current word in the buffer is used instead.
1397 The new word is added to the first file in `ada-case-exception-file'.
1398 The standard casing rules will no longer apply to this word."
1400 (let ((previous-syntax-table (syntax-table))
1404 (cond ((stringp ada-case-exception-file
)
1405 (setq file-name ada-case-exception-file
))
1406 ((listp ada-case-exception-file
)
1407 (setq file-name
(car ada-case-exception-file
)))
1409 (error (concat "No exception file specified. "
1410 "See variable ada-case-exception-file"))))
1412 (set-syntax-table ada-mode-symbol-syntax-table
)
1415 (skip-syntax-backward "w")
1416 (setq word
(buffer-substring-no-properties
1417 (point) (save-excursion (forward-word 1) (point))))))
1418 (set-syntax-table previous-syntax-table
)
1420 ;; Reread the exceptions file, in case it was modified by some other,
1421 (ada-case-read-exceptions-from-file file-name
)
1423 ;; If the word is already in the list, even with a different casing
1424 ;; we simply want to replace it.
1425 (if (and (not (equal ada-case-exception
'()))
1426 (assoc-string word ada-case-exception t
))
1427 (setcar (assoc-string word ada-case-exception t
) word
)
1428 (add-to-list 'ada-case-exception
(cons word t
))
1431 (ada-save-exceptions-to-file file-name
)
1434 (defun ada-create-case-exception-substring (&optional word
)
1435 "Define the substring WORD as an exception for the casing system.
1436 If WORD is not given, then the current word in the buffer is used instead,
1437 or the selected region if any is active.
1438 The new word is added to the first file in `ada-case-exception-file'.
1439 When auto-casing a word, this substring will be special-cased, unless the
1440 word itself has a special casing."
1443 (cond ((stringp ada-case-exception-file
)
1444 ada-case-exception-file
)
1445 ((listp ada-case-exception-file
)
1446 (car ada-case-exception-file
))
1448 (error (concat "No exception file specified. "
1449 "See variable ada-case-exception-file"))))))
1451 ;; Find the substring to define as an exception. Order is: the parameter,
1452 ;; if any, or the selected region, or the word under the cursor
1456 ((ada-region-selected)
1457 (setq word
(buffer-substring-no-properties
1458 (region-beginning) (region-end))))
1461 (let ((underscore-syntax (char-syntax ?_
)))
1464 (modify-syntax-entry ?_
"." (syntax-table))
1466 (skip-syntax-backward "w")
1467 (set 'word
(buffer-substring-no-properties
1469 (save-excursion (forward-word 1) (point))))))
1470 (modify-syntax-entry ?_
(make-string 1 underscore-syntax
)
1473 ;; Reread the exceptions file, in case it was modified by some other,
1474 (ada-case-read-exceptions-from-file file-name
)
1476 ;; If the word is already in the list, even with a different casing
1477 ;; we simply want to replace it.
1478 (if (and (not (equal ada-case-exception-substring
'()))
1479 (assoc-string word ada-case-exception-substring t
))
1480 (setcar (assoc-string word ada-case-exception-substring t
) word
)
1481 (add-to-list 'ada-case-exception-substring
(cons word t
))
1484 (ada-save-exceptions-to-file file-name
)
1486 (message "%s" (concat "Defining " word
" as a casing exception"))))
1488 (defun ada-case-read-exceptions-from-file (file-name)
1489 "Read the content of the casing exception file FILE-NAME."
1490 (if (file-readable-p (expand-file-name file-name
))
1491 (let ((buffer (current-buffer)))
1492 (find-file (expand-file-name file-name
))
1493 (set-syntax-table ada-mode-symbol-syntax-table
)
1495 (goto-char (point-min))
1498 ;; If the item is already in the list, even with an other casing,
1499 ;; do not add it again. This way, the user can easily decide which
1500 ;; priority should be applied to each casing exception
1501 (let ((word (buffer-substring-no-properties
1502 (point) (save-excursion (forward-word 1) (point)))))
1504 ;; Handling a substring ?
1505 (if (char-equal (string-to-char word
) ?
*)
1507 (setq word
(substring word
1))
1508 (unless (assoc-string word ada-case-exception-substring t
)
1509 (add-to-list 'ada-case-exception-substring
(cons word t
))))
1510 (unless (assoc-string word ada-case-exception t
)
1511 (add-to-list 'ada-case-exception
(cons word t
)))))
1515 (set-buffer buffer
)))
1518 (defun ada-case-read-exceptions ()
1519 "Read all the casing exception files from `ada-case-exception-file'."
1522 ;; Reinitialize the casing exception list
1523 (setq ada-case-exception
'()
1524 ada-case-exception-substring
'())
1526 (cond ((stringp ada-case-exception-file
)
1527 (ada-case-read-exceptions-from-file ada-case-exception-file
))
1529 ((listp ada-case-exception-file
)
1530 (mapcar 'ada-case-read-exceptions-from-file
1531 ada-case-exception-file
))))
1533 (defun ada-adjust-case-substring ()
1534 "Adjust case of substrings in the previous word."
1536 (let ((substrings ada-case-exception-substring
)
1538 (case-fold-search t
)
1539 (underscore-syntax (char-syntax ?_
))
1547 (modify-syntax-entry ?_
"." (syntax-table))
1550 (setq re
(concat "\\b" (regexp-quote (caar substrings
)) "\\b"))
1553 (while (re-search-forward re max t
)
1554 (replace-match (caar substrings
) t
)))
1555 (setq substrings
(cdr substrings
))
1558 (modify-syntax-entry ?_
(make-string 1 underscore-syntax
) (syntax-table)))
1561 (defun ada-adjust-case-identifier ()
1562 "Adjust case of the previous identifier.
1563 The auto-casing is done according to the value of `ada-case-identifier'
1564 and the exceptions defined in `ada-case-exception-file'."
1566 (if (or (equal ada-case-exception
'())
1567 (equal (char-after) ?_
))
1569 (funcall ada-case-identifier -
1)
1570 (ada-adjust-case-substring))
1574 (start (save-excursion (skip-syntax-backward "w")
1577 ;; If we have an exception, replace the word by the correct casing
1578 (if (setq match
(assoc-string (buffer-substring start end
)
1579 ada-case-exception t
))
1582 (delete-region start end
)
1583 (insert (car match
)))
1585 ;; Else simply re-case the word
1586 (funcall ada-case-identifier -
1)
1587 (ada-adjust-case-substring))))))
1589 (defun ada-after-keyword-p ()
1590 "Return t if cursor is after a keyword that is not an attribute."
1593 (and (not (and (char-before)
1594 (or (= (char-before) ?_
)
1595 (= (char-before) ?
'))));; unless we have a _ or '
1596 (looking-at (concat ada-keywords
"[^_]")))))
1598 (defun ada-adjust-case (&optional force-identifier
)
1599 "Adjust the case of the word before the character just typed.
1600 If FORCE-IDENTIFIER is non-nil then also adjust keyword as identifier."
1604 (if (and (not (bobp))
1605 ;; or if at the end of a character constant
1606 (not (and (eq (following-char) ?
')
1607 (eq (char-before (1- (point))) ?
')))
1608 ;; or if the previous character was not part of a word
1609 (eq (char-syntax (char-before)) ?w
)
1610 ;; if in a string or a comment
1611 (not (ada-in-string-or-comment-p))
1612 ;; if in a numeric literal
1613 (not (ada-in-numeric-literal-p))
1617 (or (= (point) (point-min))
1619 (= (following-char) ?
'))
1620 (funcall ada-case-attribute -
1)
1622 (not force-identifier
) ; (MH)
1623 (ada-after-keyword-p))
1624 (funcall ada-case-keyword -
1)
1625 (ada-adjust-case-identifier))))
1630 (defun ada-adjust-case-interactive (arg)
1631 "Adjust the case of the previous word, and process the character just typed.
1632 ARG is the prefix the user entered with \\[universal-argument]."
1636 (let ((lastk last-command-event
)
1637 (previous-syntax-table (syntax-table)))
1641 (set-syntax-table ada-mode-symbol-syntax-table
)
1642 (cond ((or (eq lastk ?
\n)
1647 ;; horrible dekludge
1648 (delete-backward-char 1)
1649 ;; some special keys and their bindings
1652 (funcall ada-lfd-binding
))
1654 (funcall ada-ret-binding
))))
1655 ((eq lastk ?\C-i
) (ada-tab))
1656 ;; Else just insert the character
1657 ((self-insert-command (prefix-numeric-value arg
))))
1658 ;; if there is a keyword in front of the underscore
1659 ;; then it should be part of an identifier (MH)
1664 ;; Restore the syntax table
1665 (set-syntax-table previous-syntax-table
))
1668 ;; Else, no auto-casing
1670 ((eq last-command-event ?
\n)
1671 (funcall ada-lfd-binding
))
1672 ((eq last-command-event ?
\r)
1673 (funcall ada-ret-binding
))
1675 (self-insert-command (prefix-numeric-value arg
))))
1678 (defun ada-activate-keys-for-case ()
1679 "Modify the key bindings for all the keys that should readjust the casing."
1681 ;; Save original key-bindings to allow swapping ret/lfd
1682 ;; when casing is activated.
1683 ;; The 'or ...' is there to be sure that the value will not
1684 ;; be changed again when Ada mode is called more than once
1685 (or ada-ret-binding
(setq ada-ret-binding
(key-binding "\C-M")))
1686 (or ada-lfd-binding
(setq ada-lfd-binding
(key-binding "\C-j")))
1688 ;; Call case modifying function after certain keys.
1689 (mapcar (function (lambda(key) (define-key
1691 (char-to-string key
)
1692 'ada-adjust-case-interactive
)))
1693 '( ?
` ?_ ?
# ?% ?
& ?
* ?
( ?
) ?- ?
= ?
+
1694 ?| ?\
; ?: ?' ?\" ?< ?, ?. ?> ?/ ?\n 32 ?\r )))
1696 (defun ada-loose-case-word (&optional arg
)
1697 "Upcase first letter and letters following `_' in the following word.
1698 No other letter is modified.
1699 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1702 (let ((end (save-excursion (skip-syntax-forward "w") (point)))
1704 (skip-syntax-backward "w")
1705 (while (and (or first
(search-forward "_" end t
))
1709 (insert-char (upcase (following-char)) 1)
1712 (defun ada-no-auto-case (&optional arg
)
1713 "Do nothing. ARG is ignored.
1714 This function can be used for the auto-casing variables in Ada mode, to
1715 adapt to unusal auto-casing schemes. Since it does nothing, you can for
1716 instance use it for `ada-case-identifier' if you don't want any special
1717 auto-casing for identifiers, whereas keywords have to be lower-cased.
1718 See also `ada-auto-case' to disable auto casing altogether."
1721 (defun ada-capitalize-word (&optional arg
)
1722 "Upcase first letter and letters following '_', lower case other letters.
1723 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1725 (let ((end (save-excursion (skip-syntax-forward "w") (point)))
1726 (begin (save-excursion (skip-syntax-backward "w") (point))))
1727 (modify-syntax-entry ?_
"_")
1728 (capitalize-region begin end
)
1729 (modify-syntax-entry ?_
"w")))
1731 (defun ada-adjust-case-region (from to
)
1732 "Adjust the case of all words in the region between FROM and TO.
1733 Attention: This function might take very long for big regions!"
1739 (previous-syntax-table (syntax-table)))
1740 (message "Adjusting case ...")
1743 (set-syntax-table ada-mode-symbol-syntax-table
)
1746 ;; loop: look for all identifiers, keywords, and attributes
1748 (while (re-search-backward "\\<\\(\\sw+\\)\\>" from t
)
1749 (setq end
(match-end 1))
1751 (and (> (point) from
)
1754 (setq attribp
(looking-at "'.[^']")))))
1756 ;; do nothing if it is a string or comment
1757 (ada-in-string-or-comment-p)
1760 ;; get the identifier or keyword or attribute
1762 (setq begin
(point))
1763 (setq keywordp
(looking-at ada-keywords
))
1766 ;; casing according to user-option
1769 (funcall ada-case-attribute -
1)
1771 (funcall ada-case-keyword -
1)
1772 (ada-adjust-case-identifier)))
1773 (goto-char begin
))))
1774 (message "Adjusting case ... Done"))
1775 (set-syntax-table previous-syntax-table
))))
1777 (defun ada-adjust-case-buffer ()
1778 "Adjust the case of all words in the whole buffer.
1779 ATTENTION: This function might take very long for big buffers!"
1781 (ada-adjust-case-region (point-min) (point-max)))
1784 ;;--------------------------------------------------------------
1785 ;; Format Parameter Lists
1786 ;; Some special algorithms are provided to indent the parameter lists in
1787 ;; subprogram declarations. This is done in two steps:
1788 ;; - First parses the parameter list. The returned list has the following
1790 ;; ( (<Param_Name> in? out? access? <Type_Name> <Default_Expression>)
1792 ;; This is done in `ada-scan-paramlist'.
1793 ;; - Delete and recreate the parameter list in function
1794 ;; `ada-insert-paramlist'.
1795 ;; Both steps are called from `ada-format-paramlist'.
1796 ;; Note: Comments inside the parameter list are lost.
1797 ;; The syntax has to be correct, or the reformating will fail.
1798 ;;--------------------------------------------------------------
1800 (defun ada-format-paramlist ()
1801 "Reformat the parameter list point is in."
1807 (previous-syntax-table (syntax-table)))
1810 (set-syntax-table ada-mode-symbol-syntax-table
)
1812 ;; check if really inside parameter list
1813 (or (ada-in-paramlist-p)
1814 (error "Not in parameter list"))
1816 ;; find start of current parameter-list
1817 (ada-search-ignore-string-comment
1818 (concat ada-subprog-start-re
"\\|\\<body\\>" ) t nil
)
1821 (setq begin
(point))
1823 ;; find end of parameter-list
1825 (setq delend
(point))
1829 ;; find end of last parameter-declaration
1830 (forward-comment -
1000)
1833 ;; build a list of all elements of the parameter-list
1834 (setq paramlist
(ada-scan-paramlist (1+ begin
) end
))
1836 ;; delete the original parameter-list
1837 (delete-region begin delend
)
1839 ;; insert the new parameter-list
1841 (ada-insert-paramlist paramlist
))
1843 ;; restore syntax-table
1844 (set-syntax-table previous-syntax-table
)
1847 (defun ada-scan-paramlist (begin end
)
1848 "Scan the parameter list found in between BEGIN and END.
1849 Return the equivalent internal parameter list."
1850 (let ((paramlist (list))
1860 ;; loop until end of last parameter
1863 ;; find first character of parameter-declaration
1864 (ada-goto-next-non-ws)
1867 ;; find last character of parameter-declaration
1868 (if (setq match-cons
1869 (ada-search-ignore-string-comment "[ \t\n]*;" nil end t
))
1871 (setq epos
(car match-cons
))
1872 (setq semipos
(cdr match-cons
)))
1875 ;; read name(s) of parameter(s)
1877 (looking-at "\\(\\(\\sw\\|[_, \t\n]\\)*\\(\\sw\\|_\\)\\)[ \t\n]*:[^=]")
1879 (setq param
(list (match-string 1)))
1880 (ada-search-ignore-string-comment ":" nil epos t
'search-forward
)
1888 (ada-search-ignore-string-comment
1889 "in" nil epos t
'word-search-forward
)))))
1897 (ada-search-ignore-string-comment
1898 "out" nil epos t
'word-search-forward
)))))
1900 ;; look for 'access'
1906 (ada-search-ignore-string-comment
1907 "access" nil epos t
'word-search-forward
)))))
1909 ;; skip 'in'/'out'/'access'
1911 (ada-goto-next-non-ws)
1912 (while (looking-at "\\<\\(in\\|out\\|access\\)\\>")
1914 (ada-goto-next-non-ws))
1916 ;; read type of parameter
1917 ;; We accept spaces in the name, since some software like Rose
1918 ;; generates something like: "A : B 'Class"
1919 (looking-at "\\<\\(\\sw\\|[_.' \t]\\)+\\>")
1922 (list (match-string 0))))
1924 ;; read default-expression, if there is one
1925 (goto-char (setq apos
(match-end 0)))
1929 (if (setq match-cons
1930 (ada-search-ignore-string-comment
1931 ":=" nil epos t
'search-forward
))
1932 (buffer-substring (car match-cons
) epos
)
1935 ;; add this parameter-declaration to the list
1936 (setq paramlist
(append paramlist
(list param
)))
1938 ;; check if it was the last parameter
1941 (goto-char semipos
))
1943 (reverse paramlist
)))
1945 (defun ada-insert-paramlist (paramlist)
1946 "Insert a formatted PARAMLIST in the buffer."
1947 (let ((i (length paramlist
))
1956 ;; loop until last parameter
1957 (while (not (zerop i
))
1960 ;; get max length of parameter-name
1961 (setq parlen
(max parlen
(length (nth 0 (nth i paramlist
)))))
1963 ;; get max length of type-name
1964 (setq typlen
(max typlen
(length (nth 4 (nth i paramlist
)))))
1966 ;; is there any 'in' ?
1967 (setq inp
(or inp
(nth 1 (nth i paramlist
))))
1969 ;; is there any 'out' ?
1970 (setq outp
(or outp
(nth 2 (nth i paramlist
))))
1972 ;; is there any 'access' ?
1973 (setq accessp
(or accessp
(nth 3 (nth i paramlist
))))
1976 ;; does paramlist already start on a separate line ?
1978 (re-search-backward "^.\\|[^ \t]" nil t
)
1980 ;; yes => re-indent it
1982 (ada-indent-current)
1984 (if (looking-at "\\(is\\|return\\)")
1985 (replace-match " \\1"))))
1987 ;; no => insert it where we are after removing any whitespace
1991 ((looking-at "[ \t]*\\(\n\\|;\\)")
1992 (replace-match "\\1"))
1993 ((looking-at "[ \t]*\\(is\\|return\\)")
1994 (replace-match " \\1"))))
1998 (ada-indent-current)
2000 (setq firstcol
(current-column))
2001 (setq i
(length paramlist
))
2003 ;; loop until last parameter
2004 (while (not (zerop i
))
2006 (setq column firstcol
)
2008 ;; insert parameter-name, space and colon
2009 (insert (nth 0 (nth i paramlist
)))
2010 (indent-to (+ column parlen
1))
2012 (setq column
(current-column))
2014 ;; insert 'in' or space
2015 (if (nth 1 (nth i paramlist
))
2020 (not (nth 3 (nth i paramlist
))))
2023 ;; insert 'out' or space
2024 (if (nth 2 (nth i paramlist
))
2029 (not (nth 3 (nth i paramlist
))))
2033 (if (nth 3 (nth i paramlist
))
2036 (setq column
(current-column))
2038 ;; insert type-name and, if necessary, space and default-expression
2039 (insert (nth 4 (nth i paramlist
)))
2040 (if (nth 5 (nth i paramlist
))
2042 (indent-to (+ column typlen
1))
2043 (insert (nth 5 (nth i paramlist
)))))
2045 ;; check if it was the last parameter
2048 ;; no => insert ';' and newline and indent
2051 (indent-to firstcol
))
2054 ;; if anything follows, except semicolon, newline, is or return
2055 ;; put it in a new line and indent it
2056 (unless (looking-at "[ \t]*\\(;\\|\n\\|is\\|return\\)")
2057 (ada-indent-newline-indent))
2062 ;;;----------------------------------------------------------------
2063 ;; Indentation Engine
2064 ;; All indentations are indicated as a two-element string:
2065 ;; - position of reference in the buffer
2066 ;; - offset to indent from this position (can also be a symbol or a list
2067 ;; that are evaluated)
2068 ;; Thus the total indentation for a line is the column number of the reference
2069 ;; position plus whatever value the evaluation of the second element provides.
2070 ;; This mechanism is used so that the Ada mode can "explain" how the
2071 ;; indentation was calculated, by showing which variables were used.
2073 ;; The indentation itself is done in only one pass: first we try to guess in
2074 ;; what context we are by looking at the following keyword or punctuation
2075 ;; sign. If nothing remarkable is found, just try to guess the indentation
2076 ;; based on previous lines.
2078 ;; The relevant functions for indentation are:
2079 ;; - `ada-indent-region': Re-indent a region of text
2080 ;; - `ada-justified-indent-current': Re-indent the current line and shows the
2081 ;; calculation that were done
2082 ;; - `ada-indent-current': Re-indent the current line
2083 ;; - `ada-get-current-indent': Calculate the indentation for the current line,
2084 ;; based on the context (see above).
2085 ;; - `ada-get-indent-*': Calculate the indentation in a specific context.
2086 ;; For efficiency, these functions do not check they are in the correct
2088 ;;;----------------------------------------------------------------
2090 (defun ada-indent-region (beg end
)
2091 "Indent the region between BEG end END."
2094 (let ((block-done 0)
2095 (lines-remaining (count-lines beg end
))
2096 (msg (format "%%4d out of %4d lines remaining ..."
2097 (count-lines beg end
)))
2098 (endmark (copy-marker end
)))
2099 ;; catch errors while indenting
2100 (while (< (point) endmark
)
2101 (if (> block-done
39)
2103 (setq lines-remaining
(- lines-remaining block-done
)
2105 (message msg lines-remaining
)))
2106 (if (= (char-after) ?
\n) nil
2107 (ada-indent-current))
2109 (setq block-done
(1+ block-done
)))
2110 (message "Indenting ... done")))
2112 (defun ada-indent-newline-indent ()
2113 "Indent the current line, insert a newline and then indent the new line."
2115 (ada-indent-current)
2117 (ada-indent-current))
2119 (defun ada-indent-newline-indent-conditional ()
2120 "Insert a newline and indent it.
2121 The original line is re-indented if `ada-indent-after-return' is non-nil."
2123 ;; If at end of buffer (entering brand new code), some indentation
2124 ;; fails. For example, a block label requires whitespace following
2125 ;; the : to be recognized. So we do the newline first, then
2126 ;; go back and indent the original line.
2128 (if ada-indent-after-return
2131 (ada-indent-current)
2133 (ada-indent-current))
2135 (defun ada-justified-indent-current ()
2136 "Indent the current line and explain how the calculation was done."
2139 (let ((cur-indent (ada-indent-current)))
2141 (let ((line (save-excursion
2142 (goto-char (car cur-indent
))
2143 (count-lines 1 (point)))))
2145 (if (equal (cdr cur-indent
) '(0))
2146 (message (concat "same indentation as line " (number-to-string line
)))
2147 (message "%s" (mapconcat (lambda(x)
2152 (number-to-string x
))
2154 (concat "- " (symbol-name (cadr x
))))
2159 (goto-char (car cur-indent
))
2162 (defun ada-batch-reformat ()
2163 "Re-indent and re-case all the files found on the command line.
2164 This function should be used from the command line, with a
2166 emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
2168 (while command-line-args-left
2169 (let ((source (car command-line-args-left
)))
2170 (message "Formating %s" source
)
2172 (ada-indent-region (point-min) (point-max))
2173 (ada-adjust-case-buffer)
2174 (write-file source
))
2175 (setq command-line-args-left
(cdr command-line-args-left
)))
2179 (defsubst ada-goto-previous-word
()
2180 "Move point to the beginning of the previous word of Ada code.
2181 Return the new position of point or nil if not found."
2182 (ada-goto-next-word t
))
2184 (defun ada-indent-current ()
2185 "Indent current line as Ada code.
2186 Return the calculation that was done, including the reference point
2189 (let ((previous-syntax-table (syntax-table))
2190 (orgpoint (point-marker))
2191 cur-indent tmp-indent
2196 (set-syntax-table ada-mode-symbol-syntax-table
)
2198 ;; This need to be done here so that the advice is not always
2199 ;; activated (this might interact badly with other modes)
2200 (if (featurep 'xemacs
)
2201 (ad-activate 'parse-partial-sexp t
))
2206 ;; Not First line in the buffer ?
2207 (if (save-excursion (zerop (forward-line -
1)))
2209 (back-to-indentation)
2210 (ada-get-current-indent))
2212 ;; first line in the buffer
2213 (list (point-min) 0))))
2215 ;; Evaluate the list to get the column to indent to
2216 ;; prev-indent contains the column to indent to
2218 (setq prev-indent
(save-excursion (goto-char (car cur-indent
))
2220 tmp-indent
(cdr cur-indent
))
2221 (setq prev-indent
0 tmp-indent
'()))
2223 (while (not (null tmp-indent
))
2225 ((numberp (car tmp-indent
))
2226 (setq prev-indent
(+ prev-indent
(car tmp-indent
))))
2228 (setq prev-indent
(+ prev-indent
(eval (car tmp-indent
)))))
2230 (setq tmp-indent
(cdr tmp-indent
)))
2232 ;; only re-indent if indentation is different then the current
2233 (if (= (save-excursion (back-to-indentation) (current-column)) prev-indent
)
2236 (delete-horizontal-space)
2237 (indent-to prev-indent
))
2239 ;; restore position of point
2241 (goto-char orgpoint
)
2242 (if (< (current-column) (current-indentation))
2243 (back-to-indentation)))
2245 ;; restore syntax-table
2246 (set-syntax-table previous-syntax-table
)
2247 (if (featurep 'xemacs
)
2248 (ad-deactivate 'parse-partial-sexp
))
2254 (defun ada-get-current-indent ()
2255 "Return the indentation to use for the current line."
2260 (orgpoint (save-excursion
2262 (forward-comment -
10000)
2269 ;;-----------------------------
2270 ;; in open parenthesis, but not in parameter-list
2271 ;;-----------------------------
2273 ((and ada-indent-to-open-paren
2274 (not (ada-in-paramlist-p))
2275 (setq column
(ada-in-open-paren-p)))
2277 ;; check if we have something like this (Table_Component_Type =>
2278 ;; Source_File_Record)
2281 ;; Align the closing parenthesis on the opening one
2282 (if (= (following-char) ?\
))
2285 (skip-chars-backward " \t")
2286 (list (1- (point)) 0))
2288 (if (and (skip-chars-backward " \t")
2289 (= (char-before) ?
\n)
2290 (not (forward-comment -
10000))
2291 (= (char-before) ?
>))
2292 ;; ??? Could use a different variable
2293 (list column
'ada-broken-indent
)
2295 ;; We want all continuation lines to be indented the same
2296 ;; (ada-broken-line from the opening parenthesis. However, in
2297 ;; parameter list, each new parameter should be indented at the
2298 ;; column as the opening parenthesis.
2300 ;; A special case to handle nested boolean expressions, as in
2302 ;; and then C) -- indented by ada-broken-indent
2303 ;; or else D) -- indenting this line.
2304 ;; ??? This is really a hack, we should have a proper way to go to
2305 ;; ??? the beginning of the statement
2307 (if (= (char-before) ?\
))
2310 (if (memq (char-before) '(?
, ?\
; ?\( ?\)))
2312 (list column
'ada-continuation-indent
)
2315 ;;---------------------------
2317 ;;---------------------------
2320 (ada-indent-on-previous-lines nil orgpoint orgpoint
))
2322 ;;---------------------------
2324 ;;---------------------------
2326 ((= (downcase (char-after)) ?e
)
2329 ;; ------- end ------
2331 ((looking-at "end\\>")
2335 (ada-goto-matching-start 1)
2338 ;; found 'loop' => skip back to 'while' or 'for'
2339 ;; if 'loop' is not on a separate line
2340 ;; Stop the search for 'while' and 'for' when a ';' is encountered.
2344 (looking-at ".+\\<loop\\>"))
2347 (setq limit
(car (ada-search-ignore-string-comment ";" t
))))
2351 (ada-search-ignore-string-comment ada-loop-start-re t limit
))
2352 (not (looking-at "\\<loop\\>"))))
2354 (goto-char (car match-cons
))
2356 (back-to-indentation)
2357 (if (looking-at ada-block-label-re
)
2358 (setq label
(- ada-label-indent
))))))))
2360 ;; found 'record' =>
2361 ;; if the keyword is found at the beginning of a line (or just
2362 ;; after limited, we indent on it, otherwise we indent on the
2363 ;; beginning of the type declaration)
2364 ;; type A is (B : Integer;
2365 ;; C : Integer) is record
2366 ;; end record; -- This is badly indented otherwise
2367 (if (looking-at "record")
2370 (looking-at "^[ \t]*\\(record\\|limited record\\)"))
2371 (list (save-excursion (back-to-indentation) (point)) 0)
2372 (list (save-excursion
2373 (car (ada-search-ignore-string-comment "\\<type\\>" t
)))
2376 ;; Else keep the same indentation as the beginning statement
2377 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0)))))
2379 ;; ------ exception ----
2381 ((looking-at "exception\\>")
2383 (ada-goto-matching-start 1)
2384 (list (save-excursion (back-to-indentation) (point)) 0)))
2388 ((looking-at "else\\>")
2389 (if (save-excursion (ada-goto-previous-word)
2390 (looking-at "\\<or\\>"))
2391 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2393 (ada-goto-matching-start 1 nil t
)
2394 (list (progn (back-to-indentation) (point)) 0))))
2398 ((looking-at "elsif\\>")
2400 (ada-goto-matching-start 1 nil t
)
2401 (list (progn (back-to-indentation) (point)) 0)))
2405 ;;---------------------------
2406 ;; starting with w (when)
2407 ;;---------------------------
2409 ((and (= (downcase (char-after)) ?w
)
2410 (looking-at "when\\>"))
2412 (ada-goto-matching-start 1)
2413 (list (save-excursion (back-to-indentation) (point))
2416 ;;---------------------------
2417 ;; starting with t (then)
2418 ;;---------------------------
2420 ((and (= (downcase (char-after)) ?t
)
2421 (looking-at "then\\>"))
2422 (if (save-excursion (ada-goto-previous-word)
2423 (looking-at "and\\>"))
2424 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2426 ;; Select has been added for the statement: "select ... then abort"
2427 (ada-search-ignore-string-comment
2428 "\\<\\(elsif\\|if\\|select\\)\\>" t nil
)
2429 (list (progn (back-to-indentation) (point))
2430 'ada-stmt-end-indent
))))
2432 ;;---------------------------
2433 ;; starting with l (loop)
2434 ;;---------------------------
2436 ((and (= (downcase (char-after)) ?l
)
2437 (looking-at "loop\\>"))
2440 (goto-char (match-end 0))
2441 (ada-goto-stmt-start)
2442 (if (looking-at "\\<\\(loop\\|if\\)\\>")
2443 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2444 (unless (looking-at ada-loop-start-re
)
2445 (ada-search-ignore-string-comment ada-loop-start-re
2447 (if (looking-at "\\<loop\\>")
2448 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2449 (list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent
)))))
2451 ;;----------------------------
2452 ;; starting with l (limited) or r (record)
2453 ;;----------------------------
2455 ((or (and (= (downcase (char-after)) ?l
)
2456 (looking-at "limited\\>"))
2457 (and (= (downcase (char-after)) ?r
)
2458 (looking-at "record\\>")))
2461 (ada-search-ignore-string-comment
2462 "\\<\\(type\\|use\\)\\>" t nil
)
2463 (if (looking-at "\\<use\\>")
2464 (ada-search-ignore-string-comment "for" t nil nil
2465 'word-search-backward
))
2466 (list (progn (back-to-indentation) (point))
2467 'ada-indent-record-rel-type
)))
2469 ;;---------------------------
2470 ;; starting with b (begin)
2471 ;;---------------------------
2473 ((and (= (downcase (char-after)) ?b
)
2474 (looking-at "begin\\>"))
2476 (if (ada-goto-decl-start t
)
2477 (list (progn (back-to-indentation) (point)) 0)
2478 (ada-indent-on-previous-lines nil orgpoint orgpoint
))))
2480 ;;---------------------------
2481 ;; starting with i (is)
2482 ;;---------------------------
2484 ((and (= (downcase (char-after)) ?i
)
2485 (looking-at "is\\>"))
2487 (if (and ada-indent-is-separate
2489 (goto-char (match-end 0))
2490 (ada-goto-next-non-ws (save-excursion (end-of-line)
2492 (looking-at "\\<abstract\\>\\|\\<separate\\>")))
2494 (ada-goto-stmt-start)
2495 (list (progn (back-to-indentation) (point)) 'ada-indent
))
2497 (ada-goto-stmt-start)
2498 (if (looking-at "\\<overriding\\|package\\|procedure\\|function\\>")
2499 (list (progn (back-to-indentation) (point)) 0)
2500 (list (progn (back-to-indentation) (point)) 'ada-indent
)))))
2502 ;;---------------------------
2503 ;; starting with r (return, renames)
2504 ;;---------------------------
2506 ((and (= (downcase (char-after)) ?r
)
2507 (looking-at "re\\(turn\\|names\\)\\>"))
2510 (let ((var 'ada-indent-return
))
2511 ;; If looking at a renames, skip the 'return' statement too
2512 (if (looking-at "renames")
2515 (set 'pos
(ada-search-ignore-string-comment ";\\|return\\>" t
)))
2517 (= (downcase (char-after (car pos
))) ?r
))
2518 (goto-char (car pos
)))
2519 (set 'var
'ada-indent-renames
)))
2521 (forward-comment -
1000)
2522 (if (= (char-before) ?\
))
2526 ;; If there is a parameter list, and we have a function declaration
2527 ;; or a access to subprogram declaration
2529 (if (and (= (following-char) ?\
()
2533 (looking-at "\\(function\\|procedure\\)\\>"))
2537 (looking-at "\\(function\\|procedure\\)\\>")))))
2539 ;; The indentation depends of the value of ada-indent-return
2540 (if (<= (eval var
) 0)
2541 (list (point) (list '- var
))
2542 (list (progn (backward-word num-back
) (point))
2545 ;; Else there is no parameter list, but we have a function
2546 ;; Only do something special if the user want to indent
2547 ;; relative to the "function" keyword
2548 (if (and (> (eval var
) 0)
2549 (save-excursion (forward-word -
1)
2550 (looking-at "function\\>")))
2551 (list (progn (forward-word -
1) (point)) var
)
2554 (ada-indent-on-previous-lines nil orgpoint orgpoint
)))))))
2556 ;;--------------------------------
2557 ;; starting with 'o' or 'p'
2558 ;; 'or' as statement-start
2559 ;; 'private' as statement-start
2560 ;;--------------------------------
2562 ((and (or (= (downcase (char-after)) ?o
)
2563 (= (downcase (char-after)) ?p
))
2564 (or (ada-looking-at-semi-or)
2565 (ada-looking-at-semi-private)))
2567 ;; ??? Wasn't this done already in ada-looking-at-semi-or ?
2568 (ada-goto-matching-start 1)
2569 (list (progn (back-to-indentation) (point)) 0)))
2571 ;;--------------------------------
2572 ;; starting with 'd' (do)
2573 ;;--------------------------------
2575 ((and (= (downcase (char-after)) ?d
)
2576 (looking-at "do\\>"))
2578 (ada-goto-stmt-start)
2579 (list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent
)))
2581 ;;--------------------------------
2582 ;; starting with '-' (comment)
2583 ;;--------------------------------
2585 ((= (char-after) ?-
)
2586 (if ada-indent-comment-as-code
2588 ;; Indent comments on previous line comments if required
2589 ;; We must use a search-forward (even if the code is more complex),
2590 ;; since we want to find the beginning of the comment.
2593 (if (and ada-indent-align-comments
2597 (while (and (not pos
)
2598 (search-forward "--"
2600 (end-of-line) (point))
2602 (unless (ada-in-string-p)
2603 (setq pos
(point))))
2607 ;; Else always on previous line
2608 (ada-indent-on-previous-lines nil orgpoint orgpoint
)))
2610 ;; Else same indentation as the previous line
2611 (list (save-excursion (back-to-indentation) (point)) 0)))
2613 ;;--------------------------------
2614 ;; starting with '#' (preprocessor line)
2615 ;;--------------------------------
2617 ((and (= (char-after) ?
#)
2618 (equal ada-which-compiler
'gnat
)
2619 (looking-at "#[ \t]*\\(if\\|els\\(e\\|if\\)\\|end[ \t]*if\\)"))
2620 (list (save-excursion (beginning-of-line) (point)) 0))
2622 ;;--------------------------------
2623 ;; starting with ')' (end of a parameter list)
2624 ;;--------------------------------
2626 ((and (not (eobp)) (= (char-after) ?\
)))
2632 ;;---------------------------------
2633 ;; new/abstract/separate
2634 ;;---------------------------------
2636 ((looking-at "\\(new\\|abstract\\|separate\\)\\>")
2637 (ada-indent-on-previous-lines nil orgpoint orgpoint
))
2639 ;;---------------------------------
2640 ;; package/function/procedure
2641 ;;---------------------------------
2643 ((and (or (= (downcase (char-after)) ?p
) (= (downcase (char-after)) ?f
))
2644 (looking-at "\\<\\(package\\|function\\|procedure\\)\\>"))
2646 ;; Go up until we find either a generic section, or the end of the
2647 ;; previous subprogram/package, or 'overriding' for this function/procedure
2649 (while (and (not found
)
2650 (ada-search-ignore-string-comment
2651 "\\<\\(generic\\|end\\|begin\\|overriding\\|package\\|procedure\\|function\\)\\>" t
))
2653 ;; avoid "with procedure"... in generic parts
2656 (setq found
(not (looking-at "with"))))))
2659 ((looking-at "\\<generic\\|overriding\\>")
2660 (list (progn (back-to-indentation) (point)) 0))
2663 (ada-indent-on-previous-lines nil orgpoint orgpoint
)))))
2665 ;;---------------------------------
2667 ;;---------------------------------
2669 ((looking-at ada-label-re
)
2671 ;; ada-block-label-re matches variable declarations
2672 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2673 (append (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2674 '(ada-label-indent))))
2678 ;;---------------------------------
2680 ;;---------------------------------
2681 (or result
(ada-indent-on-previous-lines nil orgpoint orgpoint
))))
2683 (defun ada-indent-on-previous-lines (&optional nomove orgpoint initial-pos
)
2684 "Calculate the indentation for the new line after ORGPOINT.
2685 The result list is based on the previous lines in the buffer.
2686 If NOMOVE is nil, moves point to the beginning of the current statement.
2687 if INITIAL-POS is non-nil, moves point to INITIAL-POS before calculation."
2689 (goto-char initial-pos
))
2690 (let ((oldpoint (point)))
2692 ;; Is inside a parameter-list ?
2693 (if (ada-in-paramlist-p)
2694 (ada-get-indent-paramlist)
2696 ;; Move to beginning of current statement. If already at a
2697 ;; statement start, move to beginning of enclosing statement.
2699 (ada-goto-stmt-start t
))
2701 ;; no beginning found => don't change indentation
2702 (if (and (eq oldpoint
(point))
2704 (ada-get-indent-nochange)
2709 ada-indent-to-open-paren
2710 (ada-in-open-paren-p))
2711 (ada-get-indent-open-paren))
2713 ((looking-at "end\\>")
2714 (ada-get-indent-end orgpoint
))
2716 ((looking-at ada-loop-start-re
)
2717 (ada-get-indent-loop orgpoint
))
2719 ((looking-at ada-subprog-start-re
)
2720 (ada-get-indent-subprog orgpoint
))
2722 ((looking-at ada-block-start-re
)
2723 (ada-get-indent-block-start orgpoint
))
2725 ((looking-at ada-block-label-re
) ; also variable declaration
2726 (ada-get-indent-block-label orgpoint
))
2728 ((looking-at ada-goto-label-re
)
2729 (ada-get-indent-goto-label orgpoint
))
2731 ((looking-at "\\(sub\\)?type\\>")
2732 (ada-get-indent-type orgpoint
))
2734 ;; "then" has to be included in the case of "select...then abort"
2735 ;; statements, since (goto-stmt-start) at the beginning of
2736 ;; the current function would leave the cursor on that position
2737 ((looking-at "\\(\\(els\\)?if\\>\\)\\|then abort\\\>")
2738 (ada-get-indent-if orgpoint
))
2740 ((looking-at "case\\>")
2741 (ada-get-indent-case orgpoint
))
2743 ((looking-at "when\\>")
2744 (ada-get-indent-when orgpoint
))
2746 ((looking-at "separate\\>")
2747 (ada-get-indent-nochange))
2749 ((looking-at "with\\>\\|use\\>")
2750 ;; Are we still in that statement, or are we in fact looking at
2751 ;; the previous one ?
2752 (if (save-excursion (search-forward ";" oldpoint t
))
2753 (list (progn (back-to-indentation) (point)) 0)
2754 (list (point) (if (looking-at "with")
2759 (ada-get-indent-noindent orgpoint
)))))
2762 (defun ada-get-indent-open-paren ()
2763 "Calculate the indentation when point is behind an unclosed parenthesis."
2764 (list (ada-in-open-paren-p) 0))
2766 (defun ada-get-indent-nochange ()
2767 "Return the current indentation of the previous line."
2770 (back-to-indentation)
2773 (defun ada-get-indent-paramlist ()
2774 "Calculate the indentation when point is inside a parameter list."
2776 (ada-search-ignore-string-comment "[^ \t\n]" t nil t
)
2778 ;; in front of the first parameter
2779 ((= (char-after) ?\
()
2780 (goto-char (match-end 0))
2783 ;; in front of another parameter
2784 ((= (char-after) ?\
;)
2785 (goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t
)))
2786 (ada-goto-next-non-ws)
2789 ;; After an affectation (default parameter value in subprogram
2791 ((and (= (following-char) ?
=) (= (preceding-char) ?
:))
2792 (back-to-indentation)
2793 (list (point) 'ada-broken-indent
))
2795 ;; inside a parameter declaration
2797 (goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t
)))
2798 (ada-goto-next-non-ws)
2799 (list (point) 'ada-broken-indent
)))))
2801 (defun ada-get-indent-end (orgpoint)
2802 "Calculate the indentation when point is just before an end statement.
2803 ORGPOINT is the limit position used in the calculation."
2804 (let ((defun-name nil
)
2807 ;; is the line already terminated by ';' ?
2809 (ada-search-ignore-string-comment ";" nil orgpoint nil
2812 ;; yes, look what's following 'end'
2815 (ada-goto-next-non-ws)
2818 ;; loop/select/if/case/return
2820 ((looking-at "\\<\\(loop\\|select\\|if\\|case\\|return\\)\\>")
2821 (save-excursion (ada-check-matching-start (match-string 0)))
2822 (list (save-excursion (back-to-indentation) (point)) 0))
2827 ((looking-at "\\<record\\>")
2829 (ada-check-matching-start (match-string 0))
2830 ;; we are now looking at the matching "record" statement
2832 (ada-goto-stmt-start)
2833 ;; now on the matching type declaration, or use clause
2834 (unless (looking-at "\\(for\\|type\\)\\>")
2835 (ada-search-ignore-string-comment "\\<type\\>" t
))
2836 (list (progn (back-to-indentation) (point)) 0)))
2838 ;; a named block end
2840 ((looking-at ada-ident-re
)
2841 (setq defun-name
(match-string 0))
2843 (ada-goto-matching-start 0)
2844 (ada-check-defun-name defun-name
))
2845 (list (progn (back-to-indentation) (point)) 0))
2847 ;; a block-end without name
2849 ((= (char-after) ?\
;)
2851 (ada-goto-matching-start 0)
2852 (if (looking-at "\\<begin\\>")
2854 (setq indent
(list (point) 0))
2855 (if (ada-goto-decl-start t
)
2856 (list (progn (back-to-indentation) (point)) 0)
2858 (list (progn (back-to-indentation) (point)) 0)
2861 ;; anything else - should maybe signal an error ?
2864 (list (save-excursion (back-to-indentation) (point))
2865 'ada-broken-indent
))))
2867 (list (save-excursion (back-to-indentation) (point))
2868 'ada-broken-indent
))))
2870 (defun ada-get-indent-case (orgpoint)
2871 "Calculate the indentation when point is just before a case statement.
2872 ORGPOINT is the limit position used in the calculation."
2873 (let ((match-cons nil
)
2877 ;; case..is..when..=>
2880 (setq match-cons
(and
2881 ;; the `=>' must be after the keyword `is'.
2882 (ada-search-ignore-string-comment
2883 "is" nil orgpoint nil
'word-search-forward
)
2884 (ada-search-ignore-string-comment
2885 "[ \t\n]+=>" nil orgpoint
))))
2887 (goto-char (car match-cons
))
2888 (unless (ada-search-ignore-string-comment "when" t opos
)
2889 (error "Missing 'when' between 'case' and '=>'"))
2890 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)))
2895 (setq match-cons
(ada-search-ignore-string-comment
2896 "when" nil orgpoint nil
'word-search-forward
)))
2897 (goto-char (cdr match-cons
))
2898 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
2903 (setq match-cons
(ada-search-ignore-string-comment
2904 "is" nil orgpoint nil
'word-search-forward
)))
2905 (list (save-excursion (back-to-indentation) (point)) 'ada-when-indent
))
2910 (list (save-excursion (back-to-indentation) (point))
2911 'ada-broken-indent
)))))
2913 (defun ada-get-indent-when (orgpoint)
2914 "Calculate the indentation when point is just before a when statement.
2915 ORGPOINT is the limit position used in the calculation."
2916 (let ((cur-indent (save-excursion (back-to-indentation) (point))))
2917 (if (ada-search-ignore-string-comment "[ \t\n]*=>" nil orgpoint
)
2918 (list cur-indent
'ada-indent
)
2919 (list cur-indent
'ada-broken-indent
))))
2921 (defun ada-get-indent-if (orgpoint)
2922 "Calculate the indentation when point is just before an if statement.
2923 ORGPOINT is the limit position used in the calculation."
2924 (let ((cur-indent (save-excursion (back-to-indentation) (point)))
2927 ;; Move to the correct then (ignore all "and then")
2929 (while (and (setq match-cons
(ada-search-ignore-string-comment
2930 "\\<\\(then\\|and[ \t]*then\\)\\>"
2932 (= (downcase (char-after (car match-cons
))) ?a
)))
2933 ;; If "then" was found (we are looking at it)
2937 ;; 'then' first in separate line ?
2938 ;; => indent according to 'then',
2939 ;; => else indent according to 'if'
2942 (back-to-indentation)
2943 (looking-at "\\<then\\>"))
2944 (setq cur-indent
(save-excursion (back-to-indentation) (point))))
2947 (list cur-indent
'ada-indent
))
2949 (list cur-indent
'ada-broken-indent
))))
2951 (defun ada-get-indent-block-start (orgpoint)
2952 "Calculate the indentation when point is at the start of a block.
2953 ORGPOINT is the limit position used in the calculation."
2958 (setq pos
(ada-goto-next-non-ws orgpoint
)))
2961 (ada-indent-on-previous-lines t orgpoint
)))
2963 ;; Special case for record types, for instance for:
2964 ;; type A is (B : Integer;
2965 ;; C : Integer) is record
2966 ;; null; -- This is badly indented otherwise
2967 ((looking-at "record")
2969 ;; If record is at the beginning of the line, indent from there
2972 (looking-at "^[ \t]*\\(record\\|limited record\\)"))
2973 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)
2975 ;; else indent relative to the type command
2976 (list (save-excursion
2977 (car (ada-search-ignore-string-comment "\\<type\\>" t
)))
2980 ;; Special case for label:
2981 ((looking-at ada-block-label-re
)
2982 (list (- (save-excursion (back-to-indentation) (point)) ada-label-indent
) 'ada-indent
))
2984 ;; nothing follows the block-start
2986 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)))))
2988 (defun ada-get-indent-subprog (orgpoint)
2989 "Calculate the indentation when point is just before a subprogram.
2990 ORGPOINT is the limit position used in the calculation."
2991 (let ((match-cons nil
)
2992 (cur-indent (save-excursion (back-to-indentation) (point)))
2995 ;; is there an 'is' in front of point ?
2999 (ada-search-ignore-string-comment
3000 "\\<\\(is\\|do\\)\\>" nil orgpoint
)))
3002 ;; yes, then skip to its end
3006 (goto-char (cdr match-cons
)))
3008 ;; no, then goto next non-ws, if there is one in front of point
3011 (unless (ada-goto-next-non-ws orgpoint
)
3012 (goto-char orgpoint
))))
3016 ;; nothing follows 'is'
3021 (not (ada-search-ignore-string-comment
3022 "[^ \t\n]" nil orgpoint t
))))
3023 (list cur-indent
'ada-indent
))
3025 ;; is abstract/separate/new ...
3031 (ada-search-ignore-string-comment
3032 "\\<\\(separate\\|new\\|abstract\\)\\>"
3034 (goto-char (car match-cons
))
3035 (ada-search-ignore-string-comment ada-subprog-start-re t
)
3036 (ada-get-indent-noindent orgpoint
))
3038 ;; something follows 'is'
3042 (save-excursion (setq match-cons
(ada-goto-next-non-ws orgpoint
)))
3043 (goto-char match-cons
)
3044 (ada-indent-on-previous-lines t orgpoint
)))
3049 (ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward
))
3050 (list cur-indent
0))
3055 (list cur-indent
'ada-broken-indent
)))))
3057 (defun ada-get-indent-noindent (orgpoint)
3058 "Calculate the indentation when point is just before a 'noindent stmt'.
3059 ORGPOINT is the limit position used in the calculation."
3066 ;; This one is called when indenting a line preceded by a multi-line
3067 ;; subprogram declaration (in that case, we are at this point inside
3068 ;; the parameter declaration list)
3069 ((ada-in-paramlist-p)
3070 (ada-previous-procedure)
3071 (list (save-excursion (back-to-indentation) (point)) 0))
3073 ;; This one is called when indenting the second line of a multi-line
3074 ;; declaration section, in a declare block or a record declaration
3075 ((looking-at "[ \t]*\\(\\sw\\|_\\)*[ \t]*,[ \t]*$")
3076 (list (save-excursion (back-to-indentation) (point))
3077 'ada-broken-decl-indent
))
3079 ;; This one is called in every other case when indenting a line at the
3082 (if (looking-at (concat "[ \t]*" ada-block-label-re
))
3083 (setq label
(- ada-label-indent
))
3087 ;; "with private" or "null record" cases
3088 (if (or (save-excursion
3089 (and (ada-search-ignore-string-comment "\\<private\\>" nil orgpoint
)
3091 (save-excursion (forward-char -
7);; skip back "private"
3092 (ada-goto-previous-word)
3093 (looking-at "with"))))
3095 (and (ada-search-ignore-string-comment "\\<record\\>" nil orgpoint
)
3097 (save-excursion (forward-char -
6);; skip back "record"
3098 (ada-goto-previous-word)
3099 (looking-at "null")))))
3102 (re-search-backward "\\<\\(type\\|subtype\\)\\>" nil t
)
3103 (list (save-excursion (back-to-indentation) (point)) 0)))))
3105 (ada-search-ignore-string-comment ";" nil orgpoint nil
3107 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0)
3108 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3109 'ada-broken-indent
)))))))
3111 (defun ada-get-indent-block-label (orgpoint)
3112 "Calculate the indentation when before a label or variable declaration.
3113 ORGPOINT is the limit position used in the calculation."
3114 (let ((match-cons nil
)
3115 (cur-indent (save-excursion (back-to-indentation) (point))))
3116 (ada-search-ignore-string-comment ":" nil
)
3120 (setq match-cons
(ada-search-ignore-string-comment
3121 ada-loop-start-re nil orgpoint
)))
3122 (goto-char (car match-cons
))
3123 (ada-get-indent-loop orgpoint
))
3127 (setq match-cons
(ada-search-ignore-string-comment
3128 "\\<declare\\|begin\\>" nil orgpoint
)))
3129 (goto-char (car match-cons
))
3130 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3132 ;; variable declaration
3135 (ada-search-ignore-string-comment ";" nil orgpoint
))
3137 (list cur-indent
'ada-broken-indent
)))
3139 ;; nothing follows colon
3141 (list cur-indent
'(- ada-label-indent
))))))
3143 (defun ada-get-indent-goto-label (orgpoint)
3144 "Calculate the indentation when at a goto label."
3145 (search-forward ">>")
3146 (ada-goto-next-non-ws)
3147 (if (>= (point) orgpoint
)
3148 ;; labeled statement is the one we need to indent
3149 (list (- (point) ada-label-indent
))
3150 ;; else indentation is indent for labeled statement
3151 (ada-indent-on-previous-lines t orgpoint
)))
3153 (defun ada-get-indent-loop (orgpoint)
3154 "Calculate the indentation when just before a loop or a for ... use.
3155 ORGPOINT is the limit position used in the calculation."
3156 (let ((match-cons nil
)
3159 ;; If looking at a named block, skip the label
3160 (label (save-excursion
3161 (back-to-indentation)
3162 (if (looking-at ada-block-label-re
)
3163 (- ada-label-indent
)
3169 ;; statement complete
3172 (ada-search-ignore-string-comment ";" nil orgpoint nil
3174 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0))
3178 ((looking-at "loop\\>")
3179 (setq pos
(ada-get-indent-block-start orgpoint
))
3182 (list (+ (car pos
) label
) (cadr pos
))))
3185 ;; 'for'- loop (or also a for ... use statement)
3187 ((looking-at "for\\>")
3194 (goto-char (match-end 0))
3195 (ada-goto-next-non-ws orgpoint
)
3197 (if (= (char-after) ?
') (forward-word 1) t
)
3198 (ada-goto-next-non-ws orgpoint
)
3199 (looking-at "\\<use\\>")
3201 ;; check if there is a 'record' before point
3204 (setq match-cons
(ada-search-ignore-string-comment
3205 "record" nil orgpoint nil
'word-search-forward
))
3209 (goto-char (car match-cons
))
3210 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3211 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
3218 (setq match-cons
(ada-search-ignore-string-comment
3219 "loop" nil orgpoint nil
'word-search-forward
)))
3220 (goto-char (car match-cons
))
3222 ;; indent according to 'loop', if it's first in the line;
3223 ;; otherwise to 'for'
3225 (unless (save-excursion
3226 (back-to-indentation)
3227 (looking-at "\\<loop\\>"))
3229 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3232 ;; for-statement is broken
3235 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3236 'ada-broken-indent
))))
3241 ((looking-at "while\\>")
3246 (setq match-cons
(ada-search-ignore-string-comment
3247 "loop" nil orgpoint nil
'word-search-forward
)))
3250 (goto-char (car match-cons
))
3252 ;; indent according to 'loop', if it's first in the line;
3253 ;; otherwise to 'while'.
3255 (unless (save-excursion
3256 (back-to-indentation)
3257 (looking-at "\\<loop\\>"))
3259 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3262 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3263 'ada-broken-indent
))))))
3265 (defun ada-get-indent-type (orgpoint)
3266 "Calculate the indentation when before a type statement.
3267 ORGPOINT is the limit position used in the calculation."
3268 (let ((match-dat nil
))
3271 ;; complete record declaration
3275 (setq match-dat
(ada-search-ignore-string-comment
3276 "end" nil orgpoint nil
'word-search-forward
))
3277 (ada-goto-next-non-ws)
3278 (looking-at "\\<record\\>")
3280 (ada-goto-next-non-ws)
3281 (= (char-after) ?\
;)))
3282 (goto-char (car match-dat
))
3283 (list (save-excursion (back-to-indentation) (point)) 0))
3288 (setq match-dat
(ada-search-ignore-string-comment
3289 "record" nil orgpoint nil
'word-search-forward
)))
3290 (goto-char (car match-dat
))
3291 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3293 ;; complete type declaration
3296 (ada-search-ignore-string-comment ";" nil orgpoint nil
3298 (list (save-excursion (back-to-indentation) (point)) 0))
3300 ;; "type ... is", but not "type ... is ...", which is broken
3304 (ada-search-ignore-string-comment "is" nil orgpoint nil
3305 'word-search-forward
)
3306 (not (ada-goto-next-non-ws orgpoint
))))
3307 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
3312 (list (save-excursion (back-to-indentation) (point))
3313 'ada-broken-indent
)))))
3316 ;; -----------------------------------------------------------
3317 ;; -- searching and matching
3318 ;; -----------------------------------------------------------
3320 (defun ada-goto-stmt-start (&optional ignore-goto-label
)
3321 "Move point to the beginning of the statement that point is in or after.
3322 Return the new position of point.
3323 As a special case, if we are looking at a closing parenthesis, skip to the
3325 (let ((match-dat nil
)
3328 (setq match-dat
(ada-search-prev-end-stmt))
3332 ;; found a previous end-statement => check if anything follows
3334 (unless (looking-at "declare")
3336 (unless (save-excursion
3337 (goto-char (cdr match-dat
))
3338 (ada-goto-next-non-ws orgpoint ignore-goto-label
))
3340 ;; nothing follows => it's the end-statement directly in
3341 ;; front of point => search again
3343 (setq match-dat
(ada-search-prev-end-stmt)))
3345 ;; if found the correct end-statement => goto next non-ws
3348 (goto-char (cdr match-dat
)))
3349 (ada-goto-next-non-ws)
3353 ;; no previous end-statement => we are at the beginning of the
3354 ;; accessible part of the buffer
3357 (goto-char (point-min))
3359 ;; skip to the very first statement, if there is one
3361 (unless (ada-goto-next-non-ws orgpoint
)
3362 (goto-char orgpoint
))))
3366 (defun ada-search-prev-end-stmt ()
3367 "Move point to previous end statement.
3368 Return a cons cell whose car is the beginning and whose cdr
3369 is the end of the match."
3370 (let ((match-dat nil
)
3373 ;; search until found or beginning-of-buffer
3377 (setq match-dat
(ada-search-ignore-string-comment
3378 ada-end-stmt-re t
)))
3380 (goto-char (car match-dat
))
3381 (unless (ada-in-open-paren-p)
3385 "\\<\\(record\\|loop\\|select\\|else\\|then\\)\\>")
3387 (ada-goto-previous-word)
3388 (looking-at "\\<\\(end\\|or\\|and\\)\\>[ \t]*[^;]")))
3393 (and (save-excursion (ada-goto-previous-word)
3394 (ada-goto-previous-word)
3395 (not (looking-at "subtype")))
3397 (save-excursion (goto-char (cdr match-dat
))
3398 (ada-goto-next-non-ws)
3399 ;; words that can go after an 'is'
3404 '("separate" "access" "array"
3405 "private" "abstract" "new") t
)
3408 ((looking-at "private")
3411 (setq found
(not (looking-at "is")))))
3421 (defun ada-goto-next-non-ws (&optional limit skip-goto-label
)
3422 "Skip to next non-whitespace character.
3423 Skips spaces, newlines and comments, and possibly goto labels.
3424 Return `point' if moved, nil if not.
3425 Stop the search at LIMIT.
3426 Do not call this function from within a string."
3428 (setq limit
(point-max)))
3429 (while (and (<= (point) limit
)
3430 (or (progn (forward-comment 10000)
3431 (if (and (not (eobp))
3432 (save-excursion (forward-char 1)
3434 (progn (forward-sexp 1) t
)))
3435 (and skip-goto-label
3436 (looking-at ada-goto-label-re
)
3438 (goto-char (match-end 0))
3440 (if (< (point) limit
)
3446 (defun ada-goto-stmt-end (&optional limit
)
3447 "Move point to the end of the statement that point is in or before.
3448 Return the new position of point or nil if not found.
3449 Stop the search at LIMIT."
3450 (if (ada-search-ignore-string-comment ada-end-stmt-re nil limit
)
3455 (defun ada-goto-next-word (&optional backward
)
3456 "Move point to the beginning of the next word of Ada code.
3457 If BACKWARD is non-nil, jump to the beginning of the previous word.
3458 Return the new position of point or nil if not found."
3459 (let ((match-cons nil
)
3461 (old-syntax (char-to-string (char-syntax ?_
))))
3462 (modify-syntax-entry ?_
"w")
3464 (skip-syntax-forward "w"))
3465 (if (setq match-cons
3466 (ada-search-ignore-string-comment "\\w" backward nil t
))
3468 ;; move to the beginning of the word found
3471 (goto-char (car match-cons
))
3472 (skip-syntax-backward "w")
3475 ;; if not found, restore old position of point
3477 (goto-char orgpoint
)
3479 (modify-syntax-entry ?_ old-syntax
))
3483 (defun ada-check-matching-start (keyword)
3484 "Signal an error if matching block start is not KEYWORD.
3485 Moves point to the matching block start."
3486 (ada-goto-matching-start 0)
3487 (unless (looking-at (concat "\\<" keyword
"\\>"))
3488 (error "Matching start is not '%s'" keyword
)))
3491 (defun ada-check-defun-name (defun-name)
3492 "Check if the name of the matching defun really is DEFUN-NAME.
3493 Assumes point to be already positioned by `ada-goto-matching-start'.
3494 Moves point to the beginning of the declaration."
3496 ;; named block without a `declare'; ada-goto-matching-start leaves
3497 ;; point at start of 'begin' for a block.
3499 (ada-goto-previous-word)
3500 (looking-at (concat "\\<" defun-name
"\\> *:")))
3504 ;; 'accept' or 'package' ?
3506 (unless (looking-at ada-subprog-start-re
)
3507 (ada-goto-decl-start))
3509 ;; 'begin' of 'procedure'/'function'/'task' or 'declare'
3513 ;; a named 'declare'-block ? => jump to the label
3515 (if (looking-at "\\<declare\\>")
3517 (forward-comment -
1)
3520 ;; no, => 'procedure'/'function'/'task'/'protected'
3526 ;; skip 'body' 'type'
3528 (if (looking-at "\\<\\(body\\|type\\)\\>")
3533 ;; should be looking-at the correct name
3535 (unless (looking-at (concat "\\<" defun-name
"\\>"))
3536 (error "Matching defun has different name: %s"
3537 (buffer-substring (point)
3538 (progn (forward-sexp 1) (point))))))))
3540 (defun ada-goto-decl-start (&optional noerror
)
3541 "Move point to the declaration start of the current construct.
3542 If NOERROR is non-nil, return nil if no match was found;
3543 otherwise throw error."
3544 (let ((nest-count 1)
3545 (regexp (eval-when-compile
3548 '("is" "separate" "end" "declare" "if" "new" "begin" "generic" "when") t
)
3551 ;; first should be set to t if we should stop at the first
3552 ;; "begin" we encounter.
3558 ;; Ignore "when" most of the time, except if we are looking at the
3559 ;; beginning of a block (structure: case .. is
3563 (if (looking-at "begin")
3564 (setq stop-at-when t
))
3567 (looking-at "\\<\\(package\\|procedure\\|function\\)\\>")
3569 (ada-search-ignore-string-comment
3570 "\\<\\(package\\|procedure\\|function\\|generic\\)\\>" t
)
3571 (looking-at "generic")))
3572 (setq count-generic t
))
3574 ;; search backward for interesting keywords
3576 (not (zerop nest-count
))
3577 (ada-search-ignore-string-comment regexp t
))
3579 ;; calculate nest-depth
3584 (ada-goto-matching-start 1 noerror
)
3586 ;; In some case, two begin..end block can follow each other closely,
3587 ;; which we have to detect, as in
3592 ;; begin -- here we should go to procedure, not begin
3595 (if (looking-at "begin")
3596 (let ((loop-again t
))
3599 ;; If begin was just there as the beginning of a block
3600 ;; (with no declare) then do nothing, otherwise just
3601 ;; register that we have to find the statement that
3602 ;; required the begin
3604 (ada-search-ignore-string-comment
3605 "\\<\\(declare\\|begin\\|end\\|procedure\\|function\\|task\\|package\\)\\>"
3608 (if (looking-at "end")
3609 (ada-goto-matching-start 1 noerror t
)
3611 (setq loop-again nil
)
3612 (unless (looking-at "begin")
3613 (setq nest-count
(1+ nest-count
))))
3617 ((looking-at "generic")
3621 (setq nest-count
(1- nest-count
)))))
3626 (unless (looking-at "\\<end[ \t\n]*if\\>")
3628 (setq nest-count
(1- nest-count
))
3629 (setq first nil
)))))
3632 ((looking-at "declare\\|generic")
3633 (setq nest-count
(1- nest-count
))
3637 ;; look for things to ignore
3640 ;; generic formal parameter
3641 (looking-at "is[ t]+<>")
3643 ;; A type definition, or a case statement. Note that the
3644 ;; goto-matching-start above on 'end record' leaves us at
3645 ;; 'record', not at 'type'.
3647 ;; We get to a case statement here by calling
3648 ;; 'ada-move-to-end' from inside a case statement; then
3649 ;; we are not ignoring 'when'.
3651 ;; Skip type discriminants or case argument function call param list
3652 (forward-comment -
10000)
3654 (if (= (char-after) ?\
))
3658 (forward-comment -
10000)
3660 ;; skip type or case argument name
3661 (skip-chars-backward "a-zA-Z0-9_.'")
3662 (ada-goto-previous-word)
3664 ;; if it's a protected type, it's the decl start we
3665 ;; are looking for; since we didn't see the 'end'
3666 ;; above, we are inside it.
3667 (looking-at "\\<\\(sub\\)?type\\|case\\>")
3669 (ada-goto-previous-word)
3670 (not (looking-at "\\<protected\\>"))))
3671 ) ; end of type definition p
3673 ;; null procedure declaration
3674 (save-excursion (ada-goto-next-word) (looking-at "\\<null\\>"))
3676 ;; skip this construct
3678 ;; this is the right "is"
3679 (setq nest-count
(1- nest-count
))
3685 (ada-goto-previous-word)
3687 (goto-char (match-beginning 0))))
3690 (looking-at "begin"))
3691 (setq nest-count
0))
3693 ((looking-at "when")
3696 (unless (looking-at "\\<exit[ \t\n]*when\\>")
3699 (setq nest-count
(1- nest-count
)))
3702 ((looking-at "begin")
3706 (setq nest-count
(1+ nest-count
))
3711 ;; check if declaration-start is really found
3714 (if (looking-at "is")
3715 (ada-search-ignore-string-comment ada-subprog-start-re t
)
3716 (looking-at "declare\\|generic")))
3719 (error "No matching proc/func/task/declare/package/protected")))
3722 (defun ada-goto-matching-start (&optional nest-level noerror gotothen
)
3723 "Move point to the beginning of a block-start.
3724 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3725 If NOERROR is non-nil, it only returns nil if no matching start was found.
3726 If GOTOTHEN is non-nil, point moves to the 'then' following 'if'."
3727 (let ((nest-count (if nest-level nest-level
0))
3730 (last-was-begin '())
3731 ;; List all keywords encountered while traversing
3732 ;; something like '("end" "end" "begin")
3733 ;; This is removed from the list when "package", "procedure",...
3734 ;; are seen. The goal is to find whether a package has an elaboration
3739 ;; search backward for interesting keywords
3742 (ada-search-ignore-string-comment ada-matching-start-re t
))
3744 (unless (and (looking-at "\\<record\\>")
3747 (looking-at "\\<null\\>")))
3749 ;; calculate nest-depth
3751 ;; found block end => increase nest depth
3753 (push nil last-was-begin
)
3754 (setq nest-count
(1+ nest-count
)))
3756 ;; found loop/select/record/case/if => check if it starts or
3758 ((looking-at "loop\\|select\\|record\\|case\\|if")
3761 ;; check if keyword follows 'end'
3762 (ada-goto-previous-word)
3763 (if (looking-at "\\<end\\>[ \t]*[^;]")
3765 ;; it ends a block => increase nest depth
3766 (setq nest-count
(1+ nest-count
)
3768 (push nil last-was-begin
))
3770 ;; it starts a block => decrease nest depth
3771 (setq nest-count
(1- nest-count
))
3773 ;; Some nested "begin .. end" blocks with no "declare"?
3774 ;; => remove those entries
3775 (while (car last-was-begin
)
3776 (setq last-was-begin
(cdr (cdr last-was-begin
))))
3778 (setq last-was-begin
(cdr last-was-begin
))
3783 ;; found package start => check if it really is a block
3784 ((looking-at "package")
3786 ;; ignore if this is just a renames statement
3787 (let ((current (point))
3788 (pos (ada-search-ignore-string-comment
3789 "\\<\\(is\\|renames\\|;\\)\\>" nil
)))
3791 (goto-char (car pos
))
3793 "No matching 'is' or 'renames' for 'package' at"
3795 (number-to-string (count-lines 1 (1+ current
)))))))
3796 (unless (looking-at "renames")
3799 (ada-goto-next-non-ws)
3800 ;; ignore it if it is only a declaration with 'new'
3801 ;; We could have package Foo is new ....
3802 ;; or package Foo is separate;
3803 ;; or package Foo is begin null; end Foo
3804 ;; for elaboration code (elaboration)
3805 (if (and (not (looking-at "\\<\\(new\\|separate\\|begin\\)\\>"))
3806 (not (car last-was-begin
)))
3807 (setq nest-count
(1- nest-count
))))))
3809 (setq last-was-begin
(cdr last-was-begin
))
3811 ;; found task start => check if it has a body
3812 ((looking-at "task")
3815 (ada-goto-next-non-ws)
3817 ((looking-at "\\<body\\>"))
3818 ((looking-at "\\<type\\>")
3819 ;; In that case, do nothing if there is a "is"
3820 (forward-word 2);; skip "type"
3821 (ada-goto-next-non-ws);; skip type name
3823 ;; Do nothing if we are simply looking at a simple
3824 ;; "task type name;" statement with no block
3825 (unless (looking-at ";")
3827 ;; Skip the parameters
3828 (if (looking-at "(")
3829 (ada-search-ignore-string-comment ")" nil
))
3830 (let ((tmp (ada-search-ignore-string-comment
3831 "\\<\\(is\\|;\\)\\>" nil
)))
3834 (goto-char (car tmp
))
3835 (if (looking-at "is")
3836 (setq nest-count
(1- nest-count
)))))))))
3838 ;; Check if that task declaration had a block attached to
3839 ;; it (i.e do nothing if we have just "task name;")
3840 (unless (progn (forward-word 1)
3841 (looking-at "[ \t]*;"))
3842 (setq nest-count
(1- nest-count
))))))
3843 (setq last-was-begin
(cdr last-was-begin
))
3846 ((looking-at "declare")
3847 ;; remove entry for begin and end (include nested begin..end
3849 (setq last-was-begin
(cdr last-was-begin
))
3851 (while (and (> count
0))
3852 (if (equal (car last-was-begin
) t
)
3853 (setq count
(1+ count
))
3854 (setq count
(1- count
)))
3855 (setq last-was-begin
(cdr last-was-begin
))
3858 ((looking-at "protected")
3859 ;; Ignore if this is just a declaration
3861 (let ((pos (ada-search-ignore-string-comment
3862 "\\(\\<is\\>\\|\\<renames\\>\\|;\\)" nil
)))
3864 (goto-char (car pos
)))
3865 (if (looking-at "is")
3866 ;; remove entry for end
3867 (setq last-was-begin
(cdr last-was-begin
)))))
3868 (setq nest-count
(1- nest-count
)))
3870 ((or (looking-at "procedure")
3871 (looking-at "function"))
3872 ;; Ignore if this is just a declaration
3874 (let ((pos (ada-search-ignore-string-comment
3875 "\\(\\<is\\>\\|\\<renames\\>\\|)[ \t]*;\\)" nil
)))
3877 (goto-char (car pos
)))
3878 (if (looking-at "is")
3879 ;; remove entry for begin and end
3880 (setq last-was-begin
(cdr (cdr last-was-begin
))))))
3883 ;; all the other block starts
3885 (push (looking-at "begin") last-was-begin
)
3886 (setq nest-count
(1- nest-count
)))
3890 ;; match is found, if nest-depth is zero
3891 (setq found
(zerop nest-count
))))) ; end of loop
3897 ;; match found => is there anything else to do ?
3902 ;; found 'if' => skip to 'then', if it's on a separate line
3903 ;; and GOTOTHEN is non-nil
3909 (ada-search-ignore-string-comment "then" nil nil nil
3910 'word-search-forward
)
3911 (back-to-indentation)
3912 (looking-at "\\<then\\>")))
3913 (goto-char (match-beginning 0)))
3916 ;; found 'do' => skip back to 'accept' or 'return'
3919 (unless (ada-search-ignore-string-comment
3920 "\\<accept\\|return\\>" t
)
3921 (error "Missing 'accept' or 'return' in front of 'do'"))))
3926 (error "No matching start"))))))
3929 (defun ada-goto-matching-end (&optional nest-level noerror
)
3930 "Move point to the end of a block.
3931 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3932 If NOERROR is non-nil, it only returns nil if no matching start found."
3933 (let ((nest-count (or nest-level
0))
3934 (regex (eval-when-compile
3936 (regexp-opt '("end" "loop" "select" "begin" "case"
3937 "if" "task" "package" "record" "do"
3938 "procedure" "function") t
)
3943 ;; First is used for subprograms: they are generally handled
3944 ;; recursively, but of course we do not want to do that the
3945 ;; first time (see comment below about subprograms)
3946 (first (not (looking-at "declare"))))
3948 ;; If we are already looking at one of the keywords, this shouldn't count
3949 ;; in the nesting loop below, so we just make sure we don't count it.
3950 ;; "declare" is a special case because we need to look after the "begin"
3952 (if (looking-at "\\<if\\|loop\\|case\\|begin\\>")
3956 ;; search forward for interesting keywords
3960 (ada-search-ignore-string-comment regex nil
))
3963 ;; calculate nest-depth
3967 ;; procedures and functions need to be processed recursively, in
3968 ;; case they are defined in a declare/begin block, as in:
3969 ;; declare -- NL 0 (nested level)
3971 ;; procedure B (C : D) is
3974 ;; end B; -- NL 0, and we would exit
3976 ;; end; -- we should exit here
3977 ;; processing them recursively avoids the need for any special
3979 ;; Nothing should be done if we have only the specs or a
3980 ;; generic instantion.
3982 ((and (looking-at "\\<procedure\\|function\\>"))
3987 (ada-search-ignore-string-comment "is\\|;")
3988 (if (= (char-before) ?s
)
3990 (ada-goto-next-non-ws)
3991 (unless (looking-at "\\<new\\>")
3994 (ada-goto-matching-end 0 t
)))))))
3996 ;; found block end => decrease nest depth
3997 ((looking-at "\\<end\\>")
3998 (setq nest-count
(1- nest-count
)
3999 found
(<= nest-count
0))
4000 ;; skip the following keyword
4002 (skip-chars-forward "end")
4003 (ada-goto-next-non-ws)
4004 (looking-at "\\<\\(loop\\|select\\|record\\|case\\|if\\)\\>"))
4007 ;; found package start => check if it really starts a block, and is not
4008 ;; in fact a generic instantiation for instance
4009 ((looking-at "\\<package\\>")
4010 (ada-search-ignore-string-comment "is" nil nil nil
4011 'word-search-forward
)
4012 (ada-goto-next-non-ws)
4013 ;; ignore and skip it if it is only a 'new' package
4014 (if (looking-at "\\<new\\>")
4015 (goto-char (match-end 0))
4016 (setq nest-count
(1+ nest-count
)
4017 found
(<= nest-count
0))))
4019 ;; all the other block starts
4022 (setq nest-count
(1+ nest-count
)))
4023 (setq found
(<= nest-count
0))
4024 (forward-word 1))) ; end of 'cond'
4032 (error "No matching end")))
4036 (defun ada-search-ignore-string-comment
4037 (search-re &optional backward limit paramlists search-func
)
4038 "Regexp-search for SEARCH-RE, ignoring comments, strings.
4039 Returns a cons cell of begin and end of match data or nil, if not found.
4040 If BACKWARD is non-nil, search backward; search forward otherwise.
4041 The search stops at pos LIMIT.
4042 If PARAMLISTS is nil, ignore parameter lists.
4043 The search is done using SEARCH-FUNC. SEARCH-FUNC can be optimized
4044 in case we are searching for a constant string.
4045 Point is moved at the beginning of the SEARCH-RE."
4050 (previous-syntax-table (syntax-table)))
4052 ;; FIXME: need to pass BACKWARD to search-func!
4054 (setq search-func
(if backward
're-search-backward
're-search-forward
)))
4057 ;; search until found or end-of-buffer
4058 ;; We have to test that we do not look further than limit
4060 (set-syntax-table ada-mode-symbol-syntax-table
)
4061 (while (and (not found
)
4063 (or (and backward
(<= limit
(point)))
4064 (>= limit
(point))))
4065 (funcall search-func search-re limit
1))
4066 (setq begin
(match-beginning 0))
4067 (setq end
(match-end 0))
4069 (setq parse-result
(parse-partial-sexp
4070 (save-excursion (beginning-of-line) (point))
4075 ;; If inside a string, skip it (and the following comments)
4077 ((ada-in-string-p parse-result
)
4078 (if (featurep 'xemacs
)
4079 (search-backward "\"" nil t
)
4080 (goto-char (nth 8 parse-result
)))
4081 (unless backward
(forward-sexp 1)))
4083 ;; If inside a comment, skip it (and the following comments)
4084 ;; There is a special code for comments at the end of the file
4086 ((ada-in-comment-p parse-result
)
4087 (if (featurep 'xemacs
)
4091 (forward-comment -
1))
4092 (goto-char (nth 8 parse-result
)))
4094 ;; at the end of the file, it is not possible to skip a comment
4095 ;; so we just go at the end of the line
4096 (if (forward-comment 1)
4098 (forward-comment 1000)
4099 (beginning-of-line))
4102 ;; directly in front of a comment => skip it, if searching forward
4104 ((and (= (char-after begin
) ?-
) (= (char-after (1+ begin
)) ?-
))
4105 (unless backward
(progn (forward-char -
1) (forward-comment 1000))))
4108 ;; found a parameter-list but should ignore it => skip it
4110 ((and (not paramlists
) (ada-in-paramlist-p))
4112 (search-backward "(" nil t
)
4113 (search-forward ")" nil t
)))
4115 ;; found what we were looking for
4118 (setq found t
)))) ; end of loop
4120 (set-syntax-table previous-syntax-table
)
4126 ;; -------------------------------------------------------
4127 ;; -- Testing the position of the cursor
4128 ;; -------------------------------------------------------
4130 (defun ada-in-decl-p ()
4131 "Return t if point is inside a declarative part.
4132 Assumes point to be at the end of a statement."
4133 (or (ada-in-paramlist-p)
4135 (ada-goto-decl-start t
))))
4138 (defun ada-looking-at-semi-or ()
4139 "Return t if looking at an 'or' following a semicolon."
4141 (and (looking-at "\\<or\\>")
4144 (ada-goto-stmt-start)
4145 (looking-at "\\<or\\>")))))
4148 (defun ada-looking-at-semi-private ()
4149 "Return t if looking at the start of a private section in a package.
4150 Return nil if the private is part of the package name, as in
4151 'private package A is...' (this can only happen at top level)."
4153 (and (looking-at "\\<private\\>")
4154 (not (looking-at "\\<private[ \t]*\\(package\\|generic\\)"))
4156 ;; Make sure this is the start of a private section (ie after
4157 ;; a semicolon or just after the package declaration, but not
4158 ;; after a 'type ... is private' or 'is new ... with private'
4160 ;; Note that a 'private' statement at the beginning of the buffer
4161 ;; does not indicate a private section, since this is instead a
4162 ;; 'private procedure ...'
4163 (progn (forward-comment -
1000)
4165 (or (= (char-before) ?\
;)
4166 (and (forward-word -
3)
4167 (looking-at "\\<package\\>"))))))))
4170 (defun ada-in-paramlist-p ()
4171 "Return t if point is inside the parameter-list of a declaration, but not a subprogram call or aggregate."
4174 (ada-search-ignore-string-comment "(\\|)" t nil t
)
4175 ;; inside parentheses ?
4176 (= (char-after) ?\
()
4178 ;; We could be looking at two things here:
4179 ;; operator definition: function "." (
4180 ;; subprogram definition: procedure .... (
4181 ;; Let's skip back over the first one
4183 (skip-chars-backward " \t\n")
4184 (if (= (char-before) ?
\")
4189 ;; and now over the second one
4192 ;; We should ignore the case when the reserved keyword is in a
4193 ;; comment (for instance, when we have:
4196 ;; we should return nil
4198 (not (ada-in-string-or-comment-p))
4200 ;; right keyword two words before parenthesis ?
4201 ;; Type is in this list because of discriminants
4202 ;; pragma is not, because the syntax is that of a subprogram call.
4203 (looking-at (eval-when-compile
4205 "procedure\\|function\\|body\\|"
4206 "task\\|entry\\|accept\\|"
4207 "access[ \t]+procedure\\|"
4208 "access[ \t]+function\\|"
4211 (defun ada-search-ignore-complex-boolean (regexp backwardp
)
4212 "Search for REGEXP, ignoring comments, strings, 'and then', 'or else'.
4213 If BACKWARDP is non-nil, search backward; search forward otherwise."
4215 (while (and (setq result
(ada-search-ignore-string-comment regexp backwardp
))
4216 (save-excursion (forward-word -
1)
4217 (looking-at "and then\\|or else"))))
4220 (defun ada-in-open-paren-p ()
4221 "Non-nil if in an open parenthesis.
4222 Return value is the position of the first non-ws behind the last unclosed
4223 parenthesis, or nil."
4225 (let ((parse (parse-partial-sexp
4227 (or (car (ada-search-ignore-complex-boolean
4228 "\\<\\(;\\|is\\|then\\|loop\\|begin\\|else\\)\\>"
4234 (goto-char (1+ (nth 1 parse
)))
4236 ;; Skip blanks, if they are not followed by a comment
4238 ;; type A is ( Value_0,
4240 ;; type B is ( -- comment
4243 (if (or (not ada-indent-handle-comment-special
)
4244 (not (looking-at "[ \t]+--")))
4245 (skip-chars-forward " \t"))
4250 ;; -----------------------------------------------------------
4251 ;; -- Behavior Of TAB Key
4252 ;; -----------------------------------------------------------
4255 "Do indenting or tabbing according to `ada-tab-policy'.
4256 In Transient Mark mode, if the mark is active, operate on the contents
4257 of the region. Otherwise, operate only on the current line."
4259 (cond ((eq ada-tab-policy
'indent-rigidly
) (ada-tab-hard))
4260 ((eq ada-tab-policy
'indent-auto
)
4261 (if (ada-region-selected)
4262 (ada-indent-region (region-beginning) (region-end))
4263 (ada-indent-current)))
4264 ((eq ada-tab-policy
'always-tab
) (error "Not implemented"))
4267 (defun ada-untab (arg)
4268 "Delete leading indenting according to `ada-tab-policy'."
4269 ;; FIXME: ARG is ignored
4271 (cond ((eq ada-tab-policy
'indent-rigidly
) (ada-untab-hard))
4272 ((eq ada-tab-policy
'indent-auto
) (error "Not implemented"))
4273 ((eq ada-tab-policy
'always-tab
) (error "Not implemented"))
4276 (defun ada-indent-current-function ()
4277 "Ada mode version of the `indent-line-function'."
4279 (let ((starting-point (point-marker)))
4282 (if (< (point) starting-point
)
4283 (goto-char starting-point
))
4284 (set-marker starting-point nil
)
4287 (defun ada-tab-hard ()
4288 "Indent current line to next tab stop."
4292 (insert-char ? ada-indent
))
4293 (if (save-excursion (= (point) (progn (beginning-of-line) (point))))
4294 (forward-char ada-indent
)))
4296 (defun ada-untab-hard ()
4297 "Indent current line to previous tab stop."
4299 (let ((bol (save-excursion (progn (beginning-of-line) (point))))
4300 (eol (save-excursion (progn (end-of-line) (point)))))
4301 (indent-rigidly bol eol
(- 0 ada-indent
))))
4305 ;; ------------------------------------------------------------
4307 ;; ------------------------------------------------------------
4309 ;; Not needed any more for Emacs 21.2, but still needed for backward
4311 (defun ada-remove-trailing-spaces ()
4312 "Remove trailing spaces in the whole buffer."
4318 (goto-char (point-min))
4319 (while (re-search-forward "[ \t]+$" (point-max) t
)
4320 (replace-match "" nil nil
))))))
4322 (defun ada-gnat-style ()
4323 "Clean up comments, `(' and `,' for GNAT style checking switch."
4327 ;; The \n is required, or the line after an empty comment line is
4329 (goto-char (point-min))
4330 (while (re-search-forward "--[ \t]*\\([^-\n]\\)" nil t
)
4331 (replace-match "-- \\1")
4333 (beginning-of-line))
4335 (goto-char (point-min))
4336 (while (re-search-forward "\\>(" nil t
)
4337 (if (not (ada-in-string-or-comment-p))
4338 (replace-match " (")))
4339 (goto-char (point-min))
4340 (while (re-search-forward ";--" nil t
)
4342 (if (not (ada-in-string-or-comment-p))
4343 (replace-match "; --")))
4344 (goto-char (point-min))
4345 (while (re-search-forward "([ \t]+" nil t
)
4346 (if (not (ada-in-string-or-comment-p))
4347 (replace-match "(")))
4348 (goto-char (point-min))
4349 (while (re-search-forward ")[ \t]+)" nil t
)
4350 (if (not (ada-in-string-or-comment-p))
4351 (replace-match "))")))
4352 (goto-char (point-min))
4353 (while (re-search-forward "\\>:" nil t
)
4354 (if (not (ada-in-string-or-comment-p))
4355 (replace-match " :")))
4357 ;; Make sure there is a space after a ','.
4358 ;; Always go back to the beginning of the match, since otherwise
4359 ;; a statement like ('F','D','E') is incorrectly modified.
4360 (goto-char (point-min))
4361 (while (re-search-forward ",[ \t]*\\(.\\)" nil t
)
4362 (if (not (save-excursion
4363 (goto-char (match-beginning 0))
4364 (ada-in-string-or-comment-p)))
4365 (replace-match ", \\1")))
4367 ;; Operators should be surrounded by spaces.
4368 (goto-char (point-min))
4369 (while (re-search-forward
4370 "[ \t]*\\(/=\\|\\*\\*\\|:=\\|\\.\\.\\|[-:+*/]\\)[ \t]*"
4372 (goto-char (match-beginning 1))
4373 (if (or (looking-at "--")
4374 (ada-in-string-or-comment-p))
4377 (beginning-of-line))
4379 ((string= (match-string 1) "/=")
4380 (replace-match " /= "))
4381 ((string= (match-string 1) "..")
4382 (replace-match " .. "))
4383 ((string= (match-string 1) "**")
4384 (replace-match " ** "))
4385 ((string= (match-string 1) ":=")
4386 (replace-match " := "))
4388 (replace-match " \\1 ")))
4394 ;; -------------------------------------------------------------
4395 ;; -- Moving To Procedures/Packages/Statements
4396 ;; -------------------------------------------------------------
4398 (defun ada-move-to-start ()
4399 "Move point to the matching start of the current Ada structure."
4402 (previous-syntax-table (syntax-table)))
4405 (set-syntax-table ada-mode-symbol-syntax-table
)
4409 ;; do nothing if in string or comment or not on 'end ...;'
4410 ;; or if an error occurs during processing
4413 (ada-in-string-or-comment-p)
4415 (or (looking-at "[ \t]*\\<end\\>")
4417 (or (looking-at "[ \t]*\\<end\\>")
4419 (or (looking-at "[ \t]*\\<end\\>")
4420 (error "Not on end ...;")))
4421 (ada-goto-matching-start 1)
4425 ;; on 'begin' => go on, according to user option
4427 ada-move-to-declaration
4428 (looking-at "\\<begin\\>")
4429 (ada-goto-decl-start)
4430 (setq pos
(point))))
4432 ) ; end of save-excursion
4434 ;; now really move to the found position
4437 ;; restore syntax-table
4438 (set-syntax-table previous-syntax-table
))))
4440 (defun ada-move-to-end ()
4441 "Move point to the end of the block around point.
4442 Moves to 'begin' if in a declarative part."
4446 (previous-syntax-table (syntax-table)))
4449 (set-syntax-table ada-mode-symbol-syntax-table
)
4454 ;; Go to the beginning of the current word, and check if we are
4455 ;; directly on 'begin'
4457 (skip-syntax-backward "w")
4458 (looking-at "\\<begin\\>"))
4459 (ada-goto-matching-end 1)
4462 ;; on first line of subprogram body
4463 ;; Do nothing for specs or generic instantion, since these are
4464 ;; handled as the general case (find the enclosing block)
4465 ;; We also need to make sure that we ignore nested subprograms
4467 (and (skip-syntax-backward "w")
4468 (looking-at "\\<function\\>\\|\\<procedure\\>" )
4469 (ada-search-ignore-string-comment "is\\|;")
4470 (not (= (char-before) ?\
;))
4472 (skip-syntax-backward "w")
4473 (ada-goto-matching-end 0 t
))
4475 ;; on first line of task declaration
4477 (and (ada-goto-stmt-start)
4478 (looking-at "\\<task\\>" )
4480 (ada-goto-next-non-ws)
4481 (looking-at "\\<body\\>")))
4482 (ada-search-ignore-string-comment "begin" nil nil nil
4483 'word-search-forward
))
4484 ;; accept block start
4486 (and (ada-goto-stmt-start)
4487 (looking-at "\\<accept\\>" )))
4488 (ada-goto-matching-end 0))
4491 (setq decl-start
(and (ada-goto-decl-start t
) (point)))
4492 (and decl-start
(looking-at "\\<package\\>")))
4493 (ada-goto-matching-end 1))
4495 ;; On a "declare" keyword
4497 (skip-syntax-backward "w")
4498 (looking-at "\\<declare\\>"))
4499 (ada-goto-matching-end 0 t
))
4501 ;; inside a 'begin' ... 'end' block
4503 (goto-char decl-start
)
4504 (ada-goto-matching-end 0 t
))
4506 ;; (hopefully ;-) everything else
4508 (ada-goto-matching-end 1)))
4512 ;; now really move to the position found
4515 ;; restore syntax-table
4516 (set-syntax-table previous-syntax-table
))))
4518 (defun ada-next-procedure ()
4519 "Move point to next procedure."
4522 (if (re-search-forward ada-procedure-start-regexp nil t
)
4523 (goto-char (match-beginning 4))
4524 (error "No more functions/procedures/tasks")))
4526 (defun ada-previous-procedure ()
4527 "Move point to previous procedure."
4530 (if (re-search-backward ada-procedure-start-regexp nil t
)
4531 (goto-char (match-beginning 4))
4532 (error "No more functions/procedures/tasks")))
4534 (defun ada-next-package ()
4535 "Move point to next package."
4538 (if (re-search-forward ada-package-start-regexp nil t
)
4539 (goto-char (match-beginning 1))
4540 (error "No more packages")))
4542 (defun ada-previous-package ()
4543 "Move point to previous package."
4546 (if (re-search-backward ada-package-start-regexp nil t
)
4547 (goto-char (match-beginning 1))
4548 (error "No more packages")))
4551 ;; ------------------------------------------------------------
4552 ;; -- Define keymap and menus for Ada
4553 ;; -------------------------------------------------------------
4555 (defun ada-create-keymap ()
4556 "Create the keymap associated with the Ada mode."
4558 ;; All non-standard keys go into ada-mode-extra-map
4559 (define-key ada-mode-map ada-mode-extra-prefix ada-mode-extra-map
)
4561 ;; Indentation and Formatting
4562 (define-key ada-mode-map
"\C-j" 'ada-indent-newline-indent-conditional
)
4563 (define-key ada-mode-map
"\C-m" 'ada-indent-newline-indent-conditional
)
4564 (define-key ada-mode-map
"\t" 'ada-tab
)
4565 (define-key ada-mode-map
"\C-c\t" 'ada-justified-indent-current
)
4566 (define-key ada-mode-map
"\C-c\C-l" 'ada-indent-region
)
4567 (define-key ada-mode-map
[(shift tab
)] 'ada-untab
)
4568 (define-key ada-mode-map
"\C-c\C-f" 'ada-format-paramlist
)
4569 ;; We don't want to make meta-characters case-specific.
4572 (define-key ada-mode-map
"\M-\C-e" 'ada-next-procedure
)
4573 (define-key ada-mode-map
"\M-\C-a" 'ada-previous-procedure
)
4574 (define-key ada-mode-map
"\C-c\C-a" 'ada-move-to-start
)
4575 (define-key ada-mode-map
"\C-c\C-e" 'ada-move-to-end
)
4578 (unless (lookup-key ada-mode-map
"\C-c\C-c")
4579 (define-key ada-mode-map
"\C-c\C-c" 'compile
))
4582 (define-key ada-mode-map
"\C-c\C-b" 'ada-adjust-case-buffer
)
4583 (define-key ada-mode-map
"\C-c\C-t" 'ada-case-read-exceptions
)
4584 (define-key ada-mode-map
"\C-c\C-y" 'ada-create-case-exception
)
4585 (define-key ada-mode-map
"\C-c\C-\M-y" 'ada-create-case-exception-substring
)
4587 ;; On XEmacs, you can easily specify whether DEL should deletes
4588 ;; one character forward or one character backward. Take this into
4590 (define-key ada-mode-map
4591 (if (boundp 'delete-key-deletes-forward
) [backspace] "\177")
4592 'backward-delete-char-untabify)
4595 (define-key ada-mode-map "\C-c\C-n" 'ada-make-subprogram-body)
4597 ;; Use predefined function of Emacs19 for comments (RE)
4598 (define-key ada-mode-map "\C-c;" 'comment-region)
4599 (define-key ada-mode-map "\C-c:" 'ada-uncomment-region)
4601 ;; The following keys are bound to functions defined in ada-xref.el or
4602 ;; ada-prj,el., However, RMS rightly thinks that the code should be shared,
4603 ;; and activated only if the right compiler is used
4605 (define-key ada-mode-map (if (featurep 'xemacs) '(shift button3) [S-mouse-3])
4606 'ada-point-and-xref)
4607 (define-key ada-mode-map [(control tab)] 'ada-complete-identifier)
4609 (define-key ada-mode-extra-map "o" 'ff-find-other-file)
4610 (define-key ada-mode-map "\C-c5\C-d" 'ada-goto-declaration-other-frame)
4611 (define-key ada-mode-map "\C-c\C-d" 'ada-goto-declaration)
4612 (define-key ada-mode-map "\C-c\C-s" 'ada-xref-goto-previous-reference)
4613 (define-key ada-mode-map "\C-c\C-c" 'ada-compile-application)
4614 (define-key ada-mode-extra-map "c" 'ada-change-prj)
4615 (define-key ada-mode-extra-map "d" 'ada-set-default-project-file)
4616 (define-key ada-mode-extra-map "g" 'ada-gdb-application)
4617 (define-key ada-mode-map "\C-c\C-m" 'ada-set-main-compile-application)
4618 (define-key ada-mode-extra-map "r" 'ada-run-application)
4619 (define-key ada-mode-map "\C-c\C-o" 'ada-goto-parent)
4620 (define-key ada-mode-map "\C-c\C-r" 'ada-find-references)
4621 (define-key ada-mode-extra-map "l" 'ada-find-local-references)
4622 (define-key ada-mode-map "\C-c\C-v" 'ada-check-current)
4623 (define-key ada-mode-extra-map "f" 'ada-find-file)
4625 (define-key ada-mode-extra-map "u" 'ada-prj-edit)
4627 (define-key ada-mode-map "\C-xnd" 'ada-narrow-to-defun); override narrow-to-defun
4629 ;; The templates, defined in ada-stmt.el
4631 (let ((map (make-sparse-keymap)))
4632 (define-key map "h" 'ada-header)
4633 (define-key map "\C-a" 'ada-array)
4634 (define-key map "b" 'ada-exception-block)
4635 (define-key map "d" 'ada-declare-block)
4636 (define-key map "c" 'ada-case)
4637 (define-key map "\C-e" 'ada-elsif)
4638 (define-key map "e" 'ada-else)
4639 (define-key map "\C-k" 'ada-package-spec)
4640 (define-key map "k" 'ada-package-body)
4641 (define-key map "\C-p" 'ada-procedure-spec)
4642 (define-key map "p" 'ada-subprogram-body)
4643 (define-key map "\C-f" 'ada-function-spec)
4644 (define-key map "f" 'ada-for-loop)
4645 (define-key map "i" 'ada-if)
4646 (define-key map "l" 'ada-loop)
4647 (define-key map "\C-r" 'ada-record)
4648 (define-key map "\C-s" 'ada-subtype)
4649 (define-key map "S" 'ada-tabsize)
4650 (define-key map "\C-t" 'ada-task-spec)
4651 (define-key map "t" 'ada-task-body)
4652 (define-key map "\C-y" 'ada-type)
4653 (define-key map "\C-v" 'ada-private)
4654 (define-key map "u" 'ada-use)
4655 (define-key map "\C-u" 'ada-with)
4656 (define-key map "\C-w" 'ada-when)
4657 (define-key map "w" 'ada-while-loop)
4658 (define-key map "\C-x" 'ada-exception)
4659 (define-key map "x" 'ada-exit)
4660 (define-key ada-mode-extra-map "t" map))
4664 (defun ada-create-menu ()
4665 "Create the Ada menu as shown in the menu bar."
4668 ["Ada Mode" (info "ada-mode") t]
4669 ["GNAT User's Guide" (info "gnat_ugn")
4670 (eq ada-which-compiler 'gnat)]
4671 ["GNAT Reference Manual" (info "gnat_rm")
4672 (eq ada-which-compiler 'gnat)]
4673 ["Gcc Documentation" (info "gcc")
4674 (eq ada-which-compiler 'gnat)]
4675 ["Gdb Documentation" (info "gdb")
4676 (eq ada-which-compiler 'gnat)]
4677 ["Ada95 Reference Manual" (info "arm95") t])
4678 ("Options" :included (eq major-mode 'ada-mode)
4679 ["Auto Casing" (setq ada-auto-case (not ada-auto-case))
4680 :style toggle :selected ada-auto-case]
4681 ["Auto Indent After Return"
4682 (setq ada-indent-after-return (not ada-indent-after-return))
4683 :style toggle :selected ada-indent-after-return]
4684 ["Automatically Recompile For Cross-references"
4685 (setq ada-xref-create-ali (not ada-xref-create-ali))
4686 :style toggle :selected ada-xref-create-ali
4687 :included (eq ada-which-compiler 'gnat)]
4689 (setq ada-xref-confirm-compile (not ada-xref-confirm-compile))
4690 :style toggle :selected ada-xref-confirm-compile
4691 :included (eq ada-which-compiler 'gnat)]
4692 ["Show Cross-references In Other Buffer"
4693 (setq ada-xref-other-buffer (not ada-xref-other-buffer))
4694 :style toggle :selected ada-xref-other-buffer
4695 :included (eq ada-which-compiler 'gnat)]
4696 ["Tight Integration With GNU Visual Debugger"
4697 (setq ada-tight-gvd-integration (not ada-tight-gvd-integration))
4698 :style toggle :selected ada-tight-gvd-integration
4699 :included (string-match "gvd" ada-prj-default-debugger)])
4700 ["Customize" (customize-group 'ada)
4701 :included (fboundp 'customize-group)]
4702 ["Check file" ada-check-current t]
4703 ["Compile file" ada-compile-current t]
4704 ["Set main and Build" ada-set-main-compile-application t]
4705 ["Show main" ada-show-current-main t]
4706 ["Build" ada-compile-application t]
4707 ["Run" ada-run-application t]
4708 ["Debug" ada-gdb-application (eq ada-which-compiler 'gnat)]
4711 ["Show project" ada-show-current-project t]
4712 ["Load..." ada-set-default-project-file t]
4713 ["New..." ada-prj-new t]
4714 ["Edit..." ada-prj-edit t])
4715 ("Goto" :included (eq major-mode 'ada-mode)
4716 ["Goto Declaration/Body" ada-goto-declaration
4717 (eq ada-which-compiler 'gnat)]
4718 ["Goto Body" ada-goto-body
4719 (eq ada-which-compiler 'gnat)]
4720 ["Goto Declaration Other Frame"
4721 ada-goto-declaration-other-frame
4722 (eq ada-which-compiler 'gnat)]
4723 ["Goto Previous Reference" ada-xref-goto-previous-reference
4724 (eq ada-which-compiler 'gnat)]
4725 ["List Local References" ada-find-local-references
4726 (eq ada-which-compiler 'gnat)]
4727 ["List References" ada-find-references
4728 (eq ada-which-compiler 'gnat)]
4729 ["Goto Reference To Any Entity" ada-find-any-references
4730 (eq ada-which-compiler 'gnat)]
4731 ["Goto Parent Unit" ada-goto-parent
4732 (eq ada-which-compiler 'gnat)]
4734 ["Next compilation error" next-error t]
4735 ["Previous Package" ada-previous-package t]
4736 ["Next Package" ada-next-package t]
4737 ["Previous Procedure" ada-previous-procedure t]
4738 ["Next Procedure" ada-next-procedure t]
4739 ["Goto Start Of Statement" ada-move-to-start t]
4740 ["Goto End Of Statement" ada-move-to-end t]
4742 ["Other File" ff-find-other-file t]
4743 ["Other File Other Window" ada-ff-other-window t])
4744 ("Edit" :included (eq major-mode 'ada-mode)
4745 ["Search File On Source Path" ada-find-file t]
4747 ["Complete Identifier" ada-complete-identifier t]
4749 ["Indent Line" ada-indent-current-function t]
4750 ["Justify Current Indentation" ada-justified-indent-current t]
4751 ["Indent Lines in Selection" ada-indent-region t]
4752 ["Indent Lines in File"
4753 (ada-indent-region (point-min) (point-max)) t]
4754 ["Format Parameter List" ada-format-paramlist t]
4756 ["Comment Selection" comment-region t]
4757 ["Uncomment Selection" ada-uncomment-region t]
4759 ["Fill Comment Paragraph" fill-paragraph t]
4760 ["Fill Comment Paragraph Justify"
4761 ada-fill-comment-paragraph-justify t]
4762 ["Fill Comment Paragraph Postfix"
4763 ada-fill-comment-paragraph-postfix t]
4765 ["Adjust Case Selection" ada-adjust-case-region t]
4766 ["Adjust Case in File" ada-adjust-case-buffer t]
4767 ["Create Case Exception" ada-create-case-exception t]
4768 ["Create Case Exception Substring"
4769 ada-create-case-exception-substring t]
4770 ["Reload Case Exceptions" ada-case-read-exceptions t]
4772 ["Make body for subprogram" ada-make-subprogram-body t]
4774 ["Narrow to subprogram" ada-narrow-to-defun t])
4776 :included (eq major-mode 'ada-mode)
4777 ["Header" ada-header t]
4779 ["Package Body" ada-package-body t]
4780 ["Package Spec" ada-package-spec t]
4781 ["Function Spec" ada-function-spec t]
4782 ["Procedure Spec" ada-procedure-spec t]
4783 ["Proc/func Body" ada-subprogram-body t]
4784 ["Task Body" ada-task-body t]
4785 ["Task Spec" ada-task-spec t]
4786 ["Declare Block" ada-declare-block t]
4787 ["Exception Block" ada-exception-block t]
4789 ["Entry" ada-entry t]
4790 ["Entry family" ada-entry-family t]
4791 ["Select" ada-select t]
4792 ["Accept" ada-accept t]
4793 ["Or accept" ada-or-accep t]
4794 ["Or delay" ada-or-delay t]
4795 ["Or terminate" ada-or-terminate t]
4798 ["Private" ada-private t]
4799 ["Subtype" ada-subtype t]
4800 ["Record" ada-record t]
4801 ["Array" ada-array t]
4805 ["Elsif" ada-elsif t]
4808 ["While Loop" ada-while-loop t]
4809 ["For Loop" ada-for-loop t]
4812 ["Exception" ada-exception t]
4814 ["When" ada-when t])
4817 (easy-menu-define ada-mode-menu ada-mode-map "Menu keymap for Ada mode" m)
4818 (if (featurep 'xemacs)
4820 (define-key ada-mode-map [menu-bar] ada-mode-menu)
4821 (set 'mode-popup-menu (cons "Ada mode" ada-mode-menu))))))
4824 ;; -------------------------------------------------------
4825 ;; Commenting/Uncommenting code
4826 ;; The following two calls are provided to enhance the standard
4827 ;; comment-region function, which only allows uncommenting if the
4828 ;; comment is at the beginning of a line. If the line have been re-indented,
4829 ;; we are unable to use comment-region, which makes no sense.
4831 ;; In addition, we provide an interface to the standard comment handling
4832 ;; function for justifying the comments.
4833 ;; -------------------------------------------------------
4835 (defadvice comment-region (before ada-uncomment-anywhere disable)
4836 (if (and (consp arg) ;; a prefix with \C-u is of the form '(4), whereas
4837 ;; \C-u 2 sets arg to '2' (fixed by S.Leake)
4838 (derived-mode-p 'ada-mode))
4840 (let ((cs (concat "^[ \t]*" (regexp-quote comment-start))))
4842 (while (re-search-forward cs end t)
4843 (replace-match comment-start))
4846 (defun ada-uncomment-region (beg end &optional arg)
4847 "Uncomment region BEG .. END.
4848 ARG gives number of comment characters."
4849 (interactive "r\nP")
4851 ;; This advice is not needed anymore with Emacs21. However, for older
4852 ;; versions, as well as for XEmacs, we still need to enable it.
4853 (if (or (<= emacs-major-version 20) (featurep 'xemacs))
4855 (ad-activate 'comment-region)
4856 (comment-region beg end (- (or arg 2)))
4857 (ad-deactivate 'comment-region))
4858 (comment-region beg end (list (- (or arg 2))))
4859 (ada-indent-region beg end)))
4861 (defun ada-fill-comment-paragraph-justify ()
4862 "Fill current comment paragraph and justify each line as well."
4864 (ada-fill-comment-paragraph 'full))
4866 (defun ada-fill-comment-paragraph-postfix ()
4867 "Fill current comment paragraph and justify each line as well.
4868 Adds `ada-fill-comment-postfix' at the end of each line."
4870 (ada-fill-comment-paragraph 'full t))
4872 (defun ada-fill-comment-paragraph (&optional justify postfix)
4873 "Fill the current comment paragraph.
4874 If JUSTIFY is non-nil, each line is justified as well.
4875 If POSTFIX and JUSTIFY are non-nil, `ada-fill-comment-postfix' is appended
4876 to each line filled and justified.
4877 The paragraph is indented on the first line."
4880 ;; check if inside comment or just in front a comment
4881 (if (and (not (ada-in-comment-p))
4882 (not (looking-at "[ \t]*--")))
4883 (error "Not inside comment"))
4885 (let* (indent from to
4886 (opos (point-marker))
4888 ;; Sets this variable to nil, otherwise it prevents
4889 ;; fill-region-as-paragraph to work on Emacs <= 20.2
4890 (parse-sexp-lookup-properties nil)
4893 (fill-column (current-fill-column)))
4895 ;; Find end of paragraph
4896 (back-to-indentation)
4897 (while (and (not (eobp)) (looking-at ".*--[ \t]*[^ \t\n]"))
4900 ;; If we were at the last line in the buffer, create a dummy empty
4901 ;; line at the end of the buffer.
4904 (back-to-indentation)))
4906 (setq to (point-marker))
4909 ;; Find beginning of paragraph
4910 (back-to-indentation)
4911 (while (and (not (bobp)) (looking-at ".*--[ \t]*[^ \t\n]"))
4913 (back-to-indentation))
4915 ;; We want one line above the first one, unless we are at the beginning
4920 (setq from (point-marker))
4922 ;; Calculate the indentation we will need for the paragraph
4923 (back-to-indentation)
4924 (setq indent (current-column))
4925 ;; unindent the first line of the paragraph
4926 (delete-region from (point))
4928 ;; Remove the old postfixes
4930 (while (re-search-forward "--\n" to t)
4931 (replace-match "\n"))
4934 (setq to (point-marker))
4936 ;; Indent and justify the paragraph
4937 (setq fill-prefix ada-fill-comment-prefix)
4938 (set-left-margin from to indent)
4940 (setq fill-column (- fill-column (length ada-fill-comment-postfix))))
4942 (fill-region-as-paragraph from to justify)
4944 ;; Add the postfixes if required
4948 (narrow-to-region from to)
4951 (insert-char ? (- fill-column (current-column)))
4952 (insert ada-fill-comment-postfix)
4956 ;; In Emacs <= 20.2 and XEmacs <=20.4, there is a bug, and a newline is
4957 ;; inserted at the end. Delete it
4958 (if (or (featurep 'xemacs)
4959 (<= emacs-major-version 19)
4960 (and (= emacs-major-version 20)
4961 (<= emacs-minor-version 2)))
4970 ;; ---------------------------------------------------
4971 ;; support for find-file.el
4972 ;; These functions are used by find-file to guess the file names from
4973 ;; unit names, and to find the other file (spec or body) from the current
4974 ;; file (body or spec).
4975 ;; It is also used to find in which function we are, so as to put the
4976 ;; cursor at the correct position.
4977 ;; Standard Ada does not force any relation between unit names and file names,
4978 ;; so some of these functions can only be a good approximation. However, they
4979 ;; are also overridden in `ada-xref'.el when we know that the user is using
4981 ;; ---------------------------------------------------
4983 ;; Overridden when we work with GNAT, to use gnatkrunch
4984 (defun ada-make-filename-from-adaname (adaname)
4985 "Determine the filename in which ADANAME is found.
4986 This matches the GNAT default naming convention, except for
4988 (while (string-match "\\." adaname)
4989 (setq adaname (replace-match "-" t t adaname)))
4993 (defun ada-other-file-name ()
4994 "Return the name of the other file.
4995 The name returned is the body if `current-buffer' is the spec,
4996 or the spec otherwise."
5000 (suffixes ada-spec-suffixes)
5001 (name (buffer-file-name)))
5003 ;; Guess whether we have a spec or a body, and get the basename of the
5004 ;; file. Since the extension may not start with '.', we can not use
5005 ;; file-name-extension
5006 (while (and (not is-spec)
5008 (if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
5010 name (match-string 1 name)))
5011 (setq suffixes (cdr suffixes)))
5015 (setq suffixes ada-body-suffixes)
5016 (while (and (not is-body)
5018 (if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
5020 name (match-string 1 name)))
5021 (setq suffixes (cdr suffixes)))))
5023 ;; If this wasn't in either list, return name itself
5024 (if (not (or is-spec is-body))
5027 ;; Else find the other possible names
5029 (setq suffixes ada-body-suffixes)
5030 (setq suffixes ada-spec-suffixes))
5035 ;; If we are using project file, search for the other file in all
5036 ;; the possible src directories.
5038 (if (fboundp 'ada-find-src-file-in-dir)
5040 (ada-find-src-file-in-dir
5041 (file-name-nondirectory (concat name (car suffixes))))))
5043 (set 'is-spec other)))
5045 ;; Else search in the current directory
5046 (if (file-exists-p (concat name (car suffixes)))
5047 (setq is-spec (concat name (car suffixes)))))
5048 (setq suffixes (cdr suffixes)))
5052 (defun ada-which-function-are-we-in ()
5053 "Return the name of the function whose definition/declaration point is in.
5054 Used in `ff-pre-load-hook'."
5055 (setq ff-function-name nil)
5057 (end-of-line);; make sure we get the complete name
5058 (or (if (re-search-backward ada-procedure-start-regexp nil t)
5059 (setq ff-function-name (match-string 5)))
5060 (if (re-search-backward ada-package-start-regexp nil t)
5061 (setq ff-function-name (match-string 4))))
5065 (defvar ada-last-which-function-line -1
5066 "Last line on which `ada-which-function' was called.")
5067 (defvar ada-last-which-function-subprog 0
5068 "Last subprogram name returned by `ada-which-function'.")
5069 (make-variable-buffer-local 'ada-last-which-function-subprog)
5070 (make-variable-buffer-local 'ada-last-which-function-line)
5073 (defun ada-which-function ()
5074 "Return the name of the function whose body the point is in.
5075 This function works even in the case of nested subprograms, whereas the
5076 standard Emacs function `which-function' does not.
5077 Since the search can be long, the results are cached."
5079 (let ((line (count-lines 1 (point)))
5085 ;; If this is the same line as before, simply return the same result
5086 (if (= line ada-last-which-function-line)
5087 ada-last-which-function-subprog
5090 ;; In case the current line is also the beginning of the body
5093 ;; Are we looking at "function Foo\n (paramlist)"
5094 (skip-chars-forward " \t\n(")
5100 (skip-chars-forward " \t\n")
5101 (if (looking-at "return")
5104 (skip-chars-forward " \t\n")
5105 (skip-chars-forward "a-zA-Z0-9_'")))
5107 ;; Can't simply do forward-word, in case the "is" is not on the
5108 ;; same line as the closing parenthesis
5109 (skip-chars-forward "is \t\n")
5111 ;; No look for the closest subprogram body that has not ended yet.
5112 ;; Not that we expect all the bodies to be finished by "end <name>",
5113 ;; or a simple "end;" indented in the same column as the start of
5114 ;; the subprogram. The goal is to be as efficient as possible.
5116 (while (and (not found)
5117 (re-search-backward ada-imenu-subprogram-menu-re nil t))
5119 ;; Get the function name, but not the properties, or this changes
5120 ;; the face in the modeline on Emacs 21
5121 (setq func-name (match-string-no-properties 3))
5122 (if (and (not (ada-in-comment-p))
5123 (not (save-excursion
5124 (goto-char (match-end 0))
5125 (looking-at "[ \t\n]*new"))))
5127 (back-to-indentation)
5128 (setq indent (current-column))
5129 (if (ada-search-ignore-string-comment
5130 (concat "end[ \t]+" func-name "[ \t]*;\\|^"
5131 (make-string indent ? ) "end;"))
5132 (setq end-pos (point))
5133 (setq end-pos (point-max)))
5134 (if (>= end-pos pos)
5135 (setq found func-name))))
5137 (setq ada-last-which-function-line line
5138 ada-last-which-function-subprog found)
5141 (defun ada-ff-other-window ()
5142 "Find other file in other window using `ff-find-other-file'."
5144 (and (fboundp 'ff-find-other-file)
5145 (ff-find-other-file t)))
5147 (defun ada-set-point-accordingly ()
5148 "Move to the function declaration that was set by `ff-which-function-are-we-in'."
5149 (if ff-function-name
5151 (goto-char (point-min))
5152 (unless (ada-search-ignore-string-comment
5153 (concat ff-function-name "\\b") nil)
5154 (goto-char (point-min))))))
5156 (defun ada-get-body-name (&optional spec-name)
5157 "Return the file name for the body of SPEC-NAME.
5158 If SPEC-NAME is nil, return the body for the current package.
5159 Return nil if no body was found."
5162 (unless spec-name (setq spec-name (buffer-file-name)))
5164 ;; Remove the spec extension. We can not simply remove the file extension,
5165 ;; but we need to take into account the specific non-GNAT extensions that the
5166 ;; user might have specified.
5168 (let ((suffixes ada-spec-suffixes)
5171 (setq end (- (length spec-name) (length (car suffixes))))
5172 (if (string-equal (car suffixes) (substring spec-name end))
5173 (setq spec-name (substring spec-name 0 end)))
5174 (setq suffixes (cdr suffixes))))
5176 ;; If find-file.el was available, use its functions
5177 (if (fboundp 'ff-get-file-name)
5178 (ff-get-file-name ada-search-directories-internal
5179 (ada-make-filename-from-adaname
5180 (file-name-nondirectory
5181 (file-name-sans-extension spec-name)))
5183 ;; Else emulate it very simply
5184 (concat (ada-make-filename-from-adaname
5185 (file-name-nondirectory
5186 (file-name-sans-extension spec-name)))
5190 ;; ---------------------------------------------------
5191 ;; support for font-lock.el
5192 ;; Strings are a real pain in Ada because a single quote character is
5193 ;; overloaded as a string quote and type/instance delimiter. By default, a
5194 ;; single quote is given punctuation syntax in `ada-mode-syntax-table'.
5195 ;; So, for Font Lock mode purposes, we mark single quotes as having string
5196 ;; syntax when the gods that created Ada determine them to be.
5198 ;; This only works in Emacs. See the comments before the grammar functions
5199 ;; at the beginning of this file for how this is done with XEmacs.
5200 ;; ----------------------------------------------------
5202 (defconst ada-font-lock-syntactic-keywords
5203 ;; Mark single quotes as having string quote syntax in 'c' instances.
5204 ;; We used to explicitly avoid ''' as a special case for fear the buffer
5205 ;; be highlighted as a string, but it seems this fear is unfounded.
5207 ;; This sets the properties of the characters, so that ada-in-string-p
5208 ;; correctly handles '"' too...
5209 '(("[^a-zA-Z0-9)]\\('\\)[^\n]\\('\\)" (1 (7 . ?')) (2 (7 . ?')))
5210 ("^[ \t]*\\(#\\(if\\|else\\|elsif\\|end\\)\\)" (1 (11 . ?\n)))))
5212 (defvar ada-font-lock-keywords
5216 ;; handle "type T is access function return S;"
5217 (list "\\<\\(function[ \t]+return\\)\\>" '(1 font-lock-keyword-face) )
5219 ;; preprocessor line
5220 (list "^[ \t]*\\(#.*\n\\)" '(1 font-lock-type-face t))
5223 ;; accept, entry, function, package (body), protected (body|type),
5224 ;; pragma, procedure, task (body) plus name.
5230 "package[ \t]+body\\|"
5234 "protected[ \t]+body\\|"
5235 "protected[ \t]+type\\|"
5241 "\\(\\sw+\\(\\.\\sw*\\)*\\)?")
5242 '(1 font-lock-keyword-face) '(2 font-lock-function-name-face nil t))
5244 ;; Optional keywords followed by a type name.
5245 (list (concat ; ":[ \t]*"
5246 "\\<\\(access[ \t]+all\\|access[ \t]+constant\\|access\\|constant\\|in[ \t]+reverse\\|\\|in[ \t]+out\\|in\\|out\\)\\>"
5248 "\\(\\sw+\\(\\.\\sw*\\)*\\)?")
5249 '(1 font-lock-keyword-face nil t) '(2 font-lock-type-face nil t))
5252 ;; Main keywords, except those treated specially below.
5255 '("abort" "abs" "abstract" "accept" "access" "aliased" "all"
5256 "and" "array" "at" "begin" "case" "declare" "delay" "delta"
5257 "digits" "do" "else" "elsif" "entry" "exception" "exit" "for"
5258 "generic" "if" "in" "interface" "is" "limited" "loop" "mod" "not"
5259 "null" "or" "others" "overriding" "private" "protected" "raise"
5260 "range" "record" "rem" "renames" "requeue" "return" "reverse"
5261 "select" "separate" "synchronized" "tagged" "task" "terminate"
5262 "then" "until" "when" "while" "with" "xor") t)
5265 ;; Anything following end and not already fontified is a body name.
5266 '("\\<\\(end\\)\\>\\([ \t]+\\)?\\(\\(\\sw\\|[_.]\\)+\\)?"
5267 (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
5269 ;; Keywords followed by a type or function name.
5270 (list (concat "\\<\\("
5271 "new\\|of\\|subtype\\|type"
5272 "\\)\\>[ \t]*\\(\\sw+\\(\\.\\sw*\\)*\\)?[ \t]*\\((\\)?")
5273 '(1 font-lock-keyword-face)
5274 '(2 (if (match-beginning 4)
5275 font-lock-function-name-face
5276 font-lock-type-face) nil t))
5278 ;; Keywords followed by a (comma separated list of) reference.
5279 ;; Note that font-lock only works on single lines, thus we can not
5280 ;; correctly highlight a with_clause that spans multiple lines.
5281 (list (concat "\\<\\(goto\\|raise\\|use\\|with\\)"
5282 "[ \t]+\\([a-zA-Z0-9_., \t]+\\)\\W")
5283 '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
5287 '("<<\\(\\sw+\\)>>" 1 font-lock-reference-face)
5289 ;; Highlight based-numbers (R. Reagan <robin-reply@reagans.org>)
5290 (list "\\([0-9]+#[0-9a-fA-F_]+#\\)" '(1 font-lock-constant-face t))
5292 ;; Ada unnamed numerical constants
5293 (list "\\W\\([-+]?[0-9._]+\\)\\>" '(1 font-lock-constant-face))
5296 "Default expressions to highlight in Ada mode.")
5299 ;; ---------------------------------------------------------
5300 ;; Support for outline.el
5301 ;; ---------------------------------------------------------
5303 (defun ada-outline-level ()
5304 "This is so that `current-column' DTRT in otherwise-hidden text."
5305 ;; patch from Dave Love <fx@gnu.org>
5306 (let (buffer-invisibility-spec)
5308 (back-to-indentation)
5311 ;; ---------------------------------------------------------
5312 ;; Support for narrow-to-region
5313 ;; ---------------------------------------------------------
5315 (defun ada-narrow-to-defun (&optional arg)
5316 "Make text outside current subprogram invisible.
5317 The subprogram visible is the one that contains or follow point.
5318 Optional ARG is ignored.
5319 Use \\[widen] to go back to the full visibility for the buffer."
5326 (ada-previous-procedure)
5334 (narrow-to-region end (point))
5336 "Use M-x widen to get back to full visibility in the buffer"))))
5338 ;; ---------------------------------------------------------
5339 ;; Automatic generation of code
5340 ;; The Ada mode has a set of function to automatically generate a subprogram
5341 ;; or package body from its spec.
5342 ;; These function only use a primary and basic algorithm, this could use a
5343 ;; lot of improvement.
5344 ;; When the user is using GNAT, we rather use gnatstub to generate an accurate
5346 ;; ----------------------------------------------------------
5348 (defun ada-gen-treat-proc (match)
5349 "Make dummy body of a procedure/function specification.
5350 MATCH is a cons cell containing the start and end locations of the last search
5351 for `ada-procedure-start-regexp'."
5352 (goto-char (car match))
5353 (let (func-found procname functype)
5355 ((or (looking-at "^[ \t]*procedure")
5356 (setq func-found (looking-at "^[ \t]*function")))
5357 ;; treat it as a proc/func
5360 (setq procname (buffer-substring (point) (cdr match))) ; store proc name
5362 ;; goto end of procname
5363 (goto-char (cdr match))
5365 ;; skip over parameterlist
5366 (unless (looking-at "[ \t\n]*\\(;\\|return\\)")
5369 ;; if function, skip over 'return' and result type.
5373 (skip-chars-forward " \t\n")
5374 (setq functype (buffer-substring (point)
5379 ;; look for next non WS
5381 ((looking-at "[ \t]*;")
5382 (delete-region (match-beginning 0) (match-end 0));; delete the ';'
5383 (ada-indent-newline-indent)
5385 (ada-indent-newline-indent)
5388 (insert "Result : " functype ";")
5389 (ada-indent-newline-indent)))
5391 (ada-indent-newline-indent)
5393 (insert "return Result;")
5395 (ada-indent-newline-indent)
5396 (insert "end " procname ";")
5397 (ada-indent-newline-indent)
5400 ((looking-at "[ \t\n]*is")
5404 ((looking-at "[ \t\n]*rename")
5409 (message "unknown syntax"))))
5411 (if (looking-at "^[ \t]*task")
5413 (message "Task conversion is not yet implemented")
5415 (if (looking-at "[ \t]*;")
5420 (defun ada-make-body ()
5421 "Create an Ada package body in the current buffer.
5422 The spec must be the previously visited buffer.
5423 This function typically is to be hooked into `ff-file-created-hook'."
5424 (delete-region (point-min) (point-max))
5425 (insert-buffer-substring (car (cdr (buffer-list))))
5426 (goto-char (point-min))
5429 (let (found ada-procedure-or-package-start-regexp)
5431 (ada-search-ignore-string-comment ada-package-start-regexp nil))
5432 (progn (goto-char (cdr found))
5435 (error "No package"))
5437 (setq ada-procedure-or-package-start-regexp
5438 (concat ada-procedure-start-regexp
5440 ada-package-start-regexp))
5443 (ada-search-ignore-string-comment
5444 ada-procedure-or-package-start-regexp nil))
5446 (goto-char (car found))
5447 (if (looking-at ada-package-start-regexp)
5448 (progn (goto-char (cdr found))
5450 (ada-gen-treat-proc found))))))
5453 (defun ada-make-subprogram-body ()
5454 "Create a dummy subprogram body in package body file from spec surrounding point."
5456 (let* ((found (re-search-backward ada-procedure-start-regexp nil t))
5457 (spec (match-beginning 0))
5462 (if (and (re-search-forward "(\\|;" nil t)
5463 (= (char-before) ?\())
5465 (ada-search-ignore-string-comment ")" nil)
5466 (ada-search-ignore-string-comment ";" nil)))
5467 (setq spec (buffer-substring spec (point)))
5469 ;; If find-file.el was available, use its functions
5470 (setq body-file (ada-get-body-name))
5472 (find-file body-file)
5473 (error "No body found for the package. Create it first"))
5477 (goto-char (point-max))
5478 (forward-comment -10000)
5479 (re-search-backward "\\<end\\>" nil t)
5480 ;; Move to the beginning of the elaboration part, if any
5481 (re-search-backward "^begin" nil t)
5485 (re-search-backward ada-procedure-start-regexp nil t)
5486 (ada-gen-treat-proc (cons (match-beginning 0) (match-end 0)))
5488 (error "Not in subprogram spec"))))
5490 ;; --------------------------------------------------------
5491 ;; Global initializations
5492 ;; --------------------------------------------------------
5494 ;; Create the keymap once and for all. If we do that in ada-mode,
5495 ;; the keys changed in the user's .emacs have to be modified
5500 ;; Create the syntax tables, but do not activate them
5501 (ada-create-syntax-table)
5503 ;; Add the default extensions (and set up speedbar)
5504 (ada-add-extensions ".ads" ".adb")
5505 ;; This two files are generated by GNAT when running with -gnatD
5506 (if (equal ada-which-compiler 'gnat)
5507 (ada-add-extensions ".ads.dg" ".adb.dg"))
5509 ;; Read the special cases for exceptions
5510 (ada-case-read-exceptions)
5512 ;; Setup auto-loading of the other Ada mode files.
5513 (autoload 'ada-change-prj "ada-xref" nil t)
5514 (autoload 'ada-check-current "ada-xref" nil t)
5515 (autoload 'ada-compile-application "ada-xref" nil t)
5516 (autoload 'ada-compile-current "ada-xref" nil t)
5517 (autoload 'ada-complete-identifier "ada-xref" nil t)
5518 (autoload 'ada-find-file "ada-xref" nil t)
5519 (autoload 'ada-find-any-references "ada-xref" nil t)
5520 (autoload 'ada-find-src-file-in-dir "ada-xref" nil t)
5521 (autoload 'ada-find-local-references "ada-xref" nil t)
5522 (autoload 'ada-find-references "ada-xref" nil t)
5523 (autoload 'ada-gdb-application "ada-xref" nil t)
5524 (autoload 'ada-goto-declaration "ada-xref" nil t)
5525 (autoload 'ada-goto-declaration-other-frame "ada-xref" nil t)
5526 (autoload 'ada-goto-parent "ada-xref" nil t)
5527 (autoload 'ada-make-body-gnatstub "ada-xref" nil t)
5528 (autoload 'ada-point-and-xref "ada-xref" nil t)
5529 (autoload 'ada-reread-prj-file "ada-xref" nil t)
5530 (autoload 'ada-run-application "ada-xref" nil t)
5531 (autoload 'ada-set-default-project-file "ada-xref" nil t)
5532 (autoload 'ada-xref-goto-previous-reference "ada-xref" nil t)
5533 (autoload 'ada-set-main-compile-application "ada-xref" nil t)
5534 (autoload 'ada-show-current-main "ada-xref" nil t)
5536 (autoload 'ada-customize "ada-prj" nil t)
5537 (autoload 'ada-prj-edit "ada-prj" nil t)
5538 (autoload 'ada-prj-new "ada-prj" nil t)
5539 (autoload 'ada-prj-save "ada-prj" nil t)
5541 (autoload 'ada-array "ada-stmt" nil t)
5542 (autoload 'ada-case "ada-stmt" nil t)
5543 (autoload 'ada-declare-block "ada-stmt" nil t)
5544 (autoload 'ada-else "ada-stmt" nil t)
5545 (autoload 'ada-elsif "ada-stmt" nil t)
5546 (autoload 'ada-exception "ada-stmt" nil t)
5547 (autoload 'ada-exception-block "ada-stmt" nil t)
5548 (autoload 'ada-exit "ada-stmt" nil t)
5549 (autoload 'ada-for-loop "ada-stmt" nil t)
5550 (autoload 'ada-function-spec "ada-stmt" nil t)
5551 (autoload 'ada-header "ada-stmt" nil t)
5552 (autoload 'ada-if "ada-stmt" nil t)
5553 (autoload 'ada-loop "ada-stmt" nil t)
5554 (autoload 'ada-package-body "ada-stmt" nil t)
5555 (autoload 'ada-package-spec "ada-stmt" nil t)
5556 (autoload 'ada-private "ada-stmt" nil t)
5557 (autoload 'ada-procedure-spec "ada-stmt" nil t)
5558 (autoload 'ada-record "ada-stmt" nil t)
5559 (autoload 'ada-subprogram-body "ada-stmt" nil t)
5560 (autoload 'ada-subtype "ada-stmt" nil t)
5561 (autoload 'ada-tabsize "ada-stmt" nil t)
5562 (autoload 'ada-task-body "ada-stmt" nil t)
5563 (autoload 'ada-task-spec "ada-stmt" nil t)
5564 (autoload 'ada-type "ada-stmt" nil t)
5565 (autoload 'ada-use "ada-stmt" nil t)
5566 (autoload 'ada-when "ada-stmt" nil t)
5567 (autoload 'ada-while-loop "ada-stmt" nil t)
5568 (autoload 'ada-with "ada-stmt" nil t)
5570 ;;; provide ourselves
5573 ;; arch-tag: 1b7d45ec-1698-43b5-8d4a-e479ea023270
5574 ;;; ada-mode.el ends here