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 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 compile-auto-highlight
)
132 (defvar ispell-check-comments
)
133 (defvar skeleton-further-elements
)
135 (defun ada-mode-version ()
136 "Return Ada mode version."
138 (let ((version-string "4.00"))
140 (message version-string
)
143 (defvar ada-mode-hook nil
144 "*List of functions to call when Ada mode is invoked.
145 This hook is automatically executed after the `ada-mode' is
147 This is a good place to add Ada environment specific bindings.")
150 "Major mode for editing and compiling Ada source in Emacs."
151 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
154 (defcustom ada-auto-case t
155 "*Non-nil means automatically change case of preceding word while typing.
156 Casing is done according to `ada-case-keyword', `ada-case-identifier'
157 and `ada-case-attribute'."
158 :type
'boolean
:group
'ada
)
160 (defcustom ada-broken-decl-indent
0
161 "*Number of columns to indent a broken declaration.
167 :type
'integer
:group
'ada
)
169 (defcustom ada-broken-indent
2
170 "*Number of columns to indent the continuation of a broken line.
173 My_Var : My_Type := (Field1 =>
175 :type
'integer
:group
'ada
)
177 (defcustom ada-continuation-indent ada-broken-indent
178 "*Number of columns to indent the continuation of broken lines in parenthesis.
183 :type
'integer
:group
'ada
)
185 (defcustom ada-case-attribute
'ada-capitalize-word
186 "*Function to call to adjust the case of Ada attributes.
187 It may be `downcase-word', `upcase-word', `ada-loose-case-word',
188 `ada-capitalize-word' or `ada-no-auto-case'."
189 :type
'(choice (const downcase-word
)
191 (const ada-capitalize-word
)
192 (const ada-loose-case-word
)
193 (const ada-no-auto-case
))
196 (defcustom ada-case-exception-file
197 (list (convert-standard-filename' "~/.emacs_case_exceptions"))
198 "*List of special casing exceptions dictionaries for identifiers.
199 The first file is the one where new exceptions will be saved by Emacs
200 when you call `ada-create-case-exception'.
202 These files should contain one word per line, that gives the casing
203 to be used for that word in Ada files. If the line starts with the
204 character *, then the exception will be used for substrings that either
205 start at the beginning of a word or after a _ character, and end either
206 at the end of the word or at a _ character. Each line can be terminated
208 :type
'(repeat (file))
211 (defcustom ada-case-keyword
'downcase-word
212 "*Function to call to adjust the case of an Ada keywords.
213 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
214 `ada-capitalize-word'."
215 :type
'(choice (const downcase-word
)
217 (const ada-capitalize-word
)
218 (const ada-loose-case-word
)
219 (const ada-no-auto-case
))
222 (defcustom ada-case-identifier
'ada-loose-case-word
223 "*Function to call to adjust the case of an Ada identifier.
224 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
225 `ada-capitalize-word'."
226 :type
'(choice (const downcase-word
)
228 (const ada-capitalize-word
)
229 (const ada-loose-case-word
)
230 (const ada-no-auto-case
))
233 (defcustom ada-clean-buffer-before-saving t
234 "*Non-nil means remove trailing spaces and untabify the buffer before saving."
235 :type
'boolean
:group
'ada
)
237 (defcustom ada-indent
3
238 "*Size of Ada indentation.
244 :type
'integer
:group
'ada
)
246 (defcustom ada-indent-after-return t
247 "*Non-nil means automatically indent after RET or LFD."
248 :type
'boolean
:group
'ada
)
250 (defcustom ada-indent-align-comments t
251 "*Non-nil means align comments on previous line comments, if any.
252 If nil, indentation is calculated as usual.
253 Note that indentation is calculated only if `ada-indent-comment-as-code' is t.
256 A := 1; -- A multi-line comment
257 -- aligned if ada-indent-align-comments is t"
258 :type
'boolean
:group
'ada
)
260 (defcustom ada-indent-comment-as-code t
261 "*Non-nil means indent comment lines as code.
262 A nil value means do not auto-indent comments."
263 :type
'boolean
:group
'ada
)
265 (defcustom ada-indent-handle-comment-special nil
266 "*Non-nil if comment lines should be handled specially inside parenthesis.
267 By default, if the line that contains the open parenthesis has some
268 text following it, then the following lines will be indented in the
269 same column as this text. This will not be true if the first line is
270 a comment and `ada-indent-handle-comment-special' is t.
273 ( Value_1, -- common behavior, when not a comment
277 ( -- `ada-indent-handle-comment-special' is nil
282 ( -- `ada-indent-handle-comment-special' is non-nil
285 :type
'boolean
:group
'ada
)
287 (defcustom ada-indent-is-separate t
288 "*Non-nil means indent 'is separate' or 'is abstract' if on a single line."
289 :type
'boolean
:group
'ada
)
291 (defcustom ada-indent-record-rel-type
3
292 "*Indentation for 'record' relative to 'type' or 'use'.
297 :type
'integer
:group
'ada
)
299 (defcustom ada-indent-renames ada-broken-indent
300 "*Indentation for renames relative to the matching function statement.
301 If `ada-indent-return' is null or negative, the indentation is done relative to
302 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
305 function A (B : Integer)
308 :type
'integer
:group
'ada
)
310 (defcustom ada-indent-return
0
311 "*Indentation for 'return' relative to the matching 'function' statement.
312 If `ada-indent-return' is null or negative, the indentation is done relative to
313 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
316 function A (B : Integer)
318 :type
'integer
:group
'ada
)
320 (defcustom ada-indent-to-open-paren t
321 "*Non-nil means indent according to the innermost open parenthesis."
322 :type
'boolean
:group
'ada
)
324 (defcustom ada-fill-comment-prefix
"-- "
325 "*Text inserted in the first columns when filling a comment paragraph.
326 Note: if you modify this variable, you will have to invoke `ada-mode'
327 again to take account of the new value."
328 :type
'string
:group
'ada
)
330 (defcustom ada-fill-comment-postfix
" --"
331 "*Text inserted at the end of each line when filling a comment paragraph.
332 Used by `ada-fill-comment-paragraph-postfix'."
333 :type
'string
:group
'ada
)
335 (defcustom ada-label-indent -
4
336 "*Number of columns to indent a label.
343 This is also used for <<..>> labels"
344 :type
'integer
:group
'ada
)
346 (defcustom ada-language-version
'ada95
347 "*Ada language version; one of `ada83', `ada95', `ada2005'."
348 :type
'(choice (const ada83
) (const ada95
) (const ada2005
)) :group
'ada
)
350 (defcustom ada-move-to-declaration nil
351 "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'."
352 :type
'boolean
:group
'ada
)
354 (defcustom ada-popup-key
'[down-mouse-3
]
355 "*Key used for binding the contextual menu.
356 If nil, no contextual menu is available."
357 :type
'(restricted-sexp :match-alternatives
(stringp vectorp
))
360 (defcustom ada-search-directories
362 (split-string (or (getenv "ADA_INCLUDE_PATH") "") ":")
363 '("/usr/adainclude" "/usr/local/adainclude"
364 "/opt/gnu/adainclude"))
365 "*Default list of directories to search for Ada files.
366 See the description for the `ff-search-directories' variable. This variable
367 is the initial value of `ada-search-directories-internal'."
368 :type
'(repeat (choice :tag
"Directory"
369 (const :tag
"default" nil
)
370 (directory :format
"%v")))
373 (defvar ada-search-directories-internal ada-search-directories
374 "Internal version of `ada-search-directories'.
375 Its value is the concatenation of the search path as read in the project file
376 and the standard runtime location, and the value of the user-defined
377 `ada-search-directories'.")
379 (defcustom ada-stmt-end-indent
0
380 "*Number of columns to indent the end of a statement on a separate line.
385 :type
'integer
:group
'ada
)
387 (defcustom ada-tab-policy
'indent-auto
388 "*Control the behavior of the TAB key.
390 `indent-rigidly' : always adds `ada-indent' blanks at the beginning of the line.
391 `indent-auto' : use indentation functions in this file.
392 `always-tab' : do `indent-relative'."
393 :type
'(choice (const indent-auto
)
394 (const indent-rigidly
)
398 (defcustom ada-use-indent ada-broken-indent
399 "*Indentation for the lines in a 'use' statement.
404 :type
'integer
:group
'ada
)
406 (defcustom ada-when-indent
3
407 "*Indentation for 'when' relative to 'exception' or 'case'.
412 :type
'integer
:group
'ada
)
414 (defcustom ada-with-indent ada-broken-indent
415 "*Indentation for the lines in a 'with' statement.
420 :type
'integer
:group
'ada
)
422 (defcustom ada-which-compiler
'gnat
423 "*Name of the compiler to use.
424 This will determine what features are made available through the Ada mode.
425 The possible choices are:
426 `gnat': Use Ada Core Technologies' GNAT compiler. Add some cross-referencing
428 `generic': Use a generic compiler."
429 :type
'(choice (const gnat
)
434 ;;; ---- end of user configurable variables
437 (defvar ada-body-suffixes
'(".adb")
438 "List of possible suffixes for Ada body files.
439 The extensions should include a `.' if needed.")
441 (defvar ada-spec-suffixes
'(".ads")
442 "List of possible suffixes for Ada spec files.
443 The extensions should include a `.' if needed.")
445 (defvar ada-mode-menu
(make-sparse-keymap "Ada")
446 "Menu for Ada mode.")
448 (defvar ada-mode-map
(make-sparse-keymap)
449 "Local keymap used for Ada mode.")
451 (defvar ada-mode-extra-map
(make-sparse-keymap)
452 "Keymap used for non-standard keybindings.")
454 ;; default is C-c C-q because it's free in ada-mode-map
455 (defvar ada-mode-extra-prefix
"\C-c\C-q"
456 "Prefix key to access `ada-mode-extra-map' functions.")
458 (defvar ada-mode-abbrev-table nil
459 "Local abbrev table for Ada mode.")
461 (defvar ada-mode-syntax-table nil
462 "Syntax table to be used for editing Ada source code.")
464 (defvar ada-mode-symbol-syntax-table nil
465 "Syntax table for Ada, where `_' is a word constituent.")
468 ;; These values are used in eval-when-compile expressions.
469 (defconst ada-83-string-keywords
470 '("abort" "abs" "accept" "access" "all" "and" "array" "at" "begin"
471 "body" "case" "constant" "declare" "delay" "delta" "digits" "do"
472 "else" "elsif" "end" "entry" "exception" "exit" "for" "function"
473 "generic" "goto" "if" "in" "is" "limited" "loop" "mod" "new"
474 "not" "null" "of" "or" "others" "out" "package" "pragma" "private"
475 "procedure" "raise" "range" "record" "rem" "renames" "return"
476 "reverse" "select" "separate" "subtype" "task" "terminate" "then"
477 "type" "use" "when" "while" "with" "xor")
478 "List of Ada 83 keywords.
479 Used to define `ada-*-keywords'.")
481 (defconst ada-95-string-keywords
482 '("abstract" "aliased" "protected" "requeue" "tagged" "until")
483 "List of keywords new in Ada 95.
484 Used to define `ada-*-keywords'.")
486 (defconst ada-2005-string-keywords
487 '("interface" "overriding" "synchronized")
488 "List of keywords new in Ada 2005.
489 Used to define `ada-*-keywords.'"))
491 (defvar ada-ret-binding nil
492 "Variable to save key binding of RET when casing is activated.")
494 (defvar ada-case-exception
'()
495 "Alist of words (entities) that have special casing.")
497 (defvar ada-case-exception-substring
'()
498 "Alist of substrings (entities) that have special casing.
499 The substrings are detected for word constituant when the word
500 is not itself in `ada-case-exception', and only for substrings that
501 either are at the beginning or end of the word, or start after '_'.")
503 (defvar ada-lfd-binding nil
504 "Variable to save key binding of LFD when casing is activated.")
506 (defvar ada-other-file-alist nil
507 "Variable used by `find-file' to find the name of the other package.
508 See `ff-other-file-alist'.")
510 (defvar ada-align-list
511 '(("[^:]\\(\\s-*\\):[^:]" 1 t
)
512 ("[^=]\\(\\s-+\\)=[^=]" 1 t
)
513 ("\\(\\s-*\\)use\\s-" 1)
515 "Ada support for align.el <= 2.2.
516 This variable provides regular expressions on which to align different lines.
517 See `align-mode-alist' for more information.")
519 (defvar ada-align-modes
521 (regexp .
"[^:]\\(\\s-*\\):[^:]")
522 (valid .
(lambda() (not (ada-in-comment-p))))
523 (modes .
'(ada-mode)))
525 (regexp .
"[^=]\\(\\s-+\\)=[^=]")
526 (valid .
(lambda() (not (ada-in-comment-p))))
527 (modes .
'(ada-mode)))
529 (regexp .
"\\(\\s-*\\)--")
530 (modes .
'(ada-mode)))
532 (regexp .
"\\(\\s-*\\)use\\s-")
533 (valid .
(lambda() (not (ada-in-comment-p))))
534 (modes .
'(ada-mode)))
536 "Ada support for align.el >= 2.8.
537 This variable defines several rules to use to align different lines.")
539 (defconst ada-align-region-separate
559 "See the variable `align-region-separate' for more information.")
561 ;;; ---- Below are the regexp used in this package for parsing
563 (defconst ada-83-keywords
565 (concat "\\<" (regexp-opt ada-83-string-keywords t
) "\\>"))
566 "Regular expression matching Ada83 keywords.")
568 (defconst ada-95-keywords
570 (concat "\\<" (regexp-opt
572 ada-95-string-keywords
573 ada-83-string-keywords
) t
) "\\>"))
574 "Regular expression matching Ada95 keywords.")
576 (defconst ada-2005-keywords
578 (concat "\\<" (regexp-opt
580 ada-2005-string-keywords
581 ada-83-string-keywords
582 ada-95-string-keywords
) t
) "\\>"))
583 "Regular expression matching Ada2005 keywords.")
585 (defvar ada-keywords ada-2005-keywords
586 "Regular expression matching Ada keywords.")
587 ;; FIXME: make this customizable
589 (defconst ada-ident-re
591 "Regexp matching Ada (qualified) identifiers.")
593 ;; "with" needs to be included in the regexp, to match generic subprogram parameters
594 ;; Similarly, we put '[not] overriding' on the same line with 'procedure' etc.
595 (defvar ada-procedure-start-regexp
597 "^[ \t]*\\(with[ \t]+\\)?\\(\\(not[ \t]+\\)?overriding[ \t]+\\)?\\(procedure\\|function\\|task\\)[ \t\n]+"
599 ;; subprogram name: operator ("[+/=*]")
603 ;; subprogram name: name
605 "\\(\\(\\sw\\|[_.]\\)+\\)"
607 "Regexp matching Ada subprogram start.
608 The actual start is at (match-beginning 4). The name is in (match-string 5).")
610 (defconst ada-name-regexp
611 "\\([a-zA-Z][a-zA-Z0-9_.']*[a-zA-Z0-9]\\)"
612 "Regexp matching a fully qualified name (including attribute).")
614 (defconst ada-package-start-regexp
615 (concat "^[ \t]*\\(private[ \t]+\\)?\\(package\\)[ \t\n]+\\(body[ \t]*\\)?" ada-name-regexp
)
616 "Regexp matching start of package.
617 The package name is in (match-string 4).")
619 (defconst ada-compile-goto-error-file-linenr-re
620 "\\([-_.a-zA-Z0-9]+\\):\\([0-9]+\\)\\(:\\([0-9]+\\)\\)?"
621 "Regexp matching filename:linenr[:column].")
624 ;;; ---- regexps for indentation functions
626 (defvar ada-block-start-re
628 (concat "\\<\\(" (regexp-opt '("begin" "declare" "else"
629 "exception" "generic" "loop" "or"
630 "private" "select" ))
631 "\\|\\(\\(limited\\|abstract\\|tagged\\)[ \t\n]+\\)*record\\)\\>"))
632 "Regexp for keywords starting Ada blocks.")
634 (defvar ada-end-stmt-re
639 "=>[ \t]*--.*$" "\\|"
640 "^[ \t]*separate[ \t]*(\\(\\sw\\|[_.]\\)+)" "\\|"
641 "\\<" (regexp-opt '("begin" "declare" "is" "do" "else" "generic"
642 "loop" "private" "record" "select"
643 "then abort" "then") t
) "\\>" "\\|"
644 "^[ \t]*" (regexp-opt '("function" "package" "procedure")
645 t
) "\\>\\(\\sw\\|[ \t_.]\\)+\\<is\\>" "\\|"
646 "^[ \t]*exception\\>"
648 "Regexp of possible ends for a non-broken statement.
649 A new statement starts after these.")
651 (defvar ada-matching-start-re
655 '("end" "loop" "select" "begin" "case" "do" "declare"
656 "if" "task" "package" "procedure" "function" "record" "protected") t
)
658 "Regexp used in `ada-goto-matching-start'.")
660 (defvar ada-matching-decl-start-re
664 '("is" "separate" "end" "declare" "if" "new" "begin" "generic" "when") t
)
666 "Regexp used in `ada-goto-matching-decl-start'.")
668 (defvar ada-loop-start-re
669 "\\<\\(for\\|while\\|loop\\)\\>"
670 "Regexp for the start of a loop.")
672 (defvar ada-subprog-start-re
674 (concat "\\<" (regexp-opt '("accept" "entry" "function" "package" "procedure"
675 "protected" "task") t
) "\\>"))
676 "Regexp for the start of a subprogram.")
678 (defvar ada-named-block-re
679 "[ \t]*\\(\\sw\\|_\\)+[ \t]*:[^=]"
680 "Regexp of the name of a block or loop.")
682 (defvar ada-contextual-menu-on-identifier nil
683 "Set to true when the right mouse button was clicked on an identifier.")
685 (defvar ada-contextual-menu-last-point nil
686 "Position of point just before displaying the menu.
687 This is a list (point buffer).
688 Since `ada-popup-menu' moves the point where the user clicked, the region
689 is modified. Therefore no command from the menu knows what the user selected
690 before displaying the contextual menu.
691 To get the original region, restore the point to this position before
692 calling `region-end' and `region-beginning'.
693 Modify this variable if you want to restore the point to another position.")
695 (easy-menu-define ada-contextual-menu nil
696 "Menu to use when the user presses the right mouse button.
697 The variable `ada-contextual-menu-on-identifier' will be set to t before
698 displaying the menu if point was on an identifier."
700 ["Goto Declaration/Body" ada-point-and-xref
701 :included ada-contextual-menu-on-identifier
]
702 ["Goto Body" ada-point-and-xref-body
703 :included ada-contextual-menu-on-identifier
]
704 ["Goto Previous Reference" ada-xref-goto-previous-reference
]
705 ["List References" ada-find-references
706 :included ada-contextual-menu-on-identifier
]
707 ["List Local References" ada-find-local-references
708 :included ada-contextual-menu-on-identifier
]
710 ["Other File" ff-find-other-file
]
711 ["Goto Parent Unit" ada-goto-parent
]))
714 ;;------------------------------------------------------------------
715 ;; Support for imenu (see imenu.el)
716 ;;------------------------------------------------------------------
718 (defconst ada-imenu-comment-re
"\\([ \t]*--.*\\)?")
720 (defconst ada-imenu-subprogram-menu-re
721 (concat "^[ \t]*\\(procedure\\|function\\)[ \t\n]+"
722 "\\(\\(\\sw\\|_\\)+\\)[ \t\n]*\\([ \t\n]\\|([^)]+)"
725 "\\(return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?is[ \t\n]"))
727 (defvar ada-imenu-generic-expression
729 (list nil ada-imenu-subprogram-menu-re
2)
732 "^[ \t]*\\(procedure\\|function\\)[ \t\n]+\\(\\(\\sw\\|_\\)+\\)"
734 "\\(" ada-imenu-comment-re
"[ \t\n]+\\|[ \t\n]*([^)]+)"
735 ada-imenu-comment-re
"\\)";; parameter list or simple space
736 "\\([ \t\n]*return[ \t\n]+\\(\\sw\\|[_.]\\)+[ \t\n]*\\)?"
738 '("*Tasks*" "^[ \t]*task[ \t]+\\(type[ \t]+\\)?\\(\\(body[ \t]+\\)?\\(\\sw\\|_\\)+\\)" 2)
739 '("*Type Defs*" "^[ \t]*\\(sub\\)?type[ \t]+\\(\\(\\sw\\|_\\)+\\)" 2)
741 "^[ \t]*protected[ \t]+\\(type[ \t]+\\)?\\(\\(body[ \t]+\\)?\\(\\sw\\|_\\)+\\)" 2)
742 '("*Packages*" "^[ \t]*package[ \t]+\\(\\(body[ \t]+\\)?\\(\\sw\\|[_.]\\)+\\)" 1))
743 "Imenu generic expression for Ada mode.
744 See `imenu-generic-expression'. This variable will create several submenus for
745 each type of entity that can be found in an Ada file.")
748 ;;------------------------------------------------------------
749 ;; Support for compile.el
750 ;;------------------------------------------------------------
752 (defun ada-compile-mouse-goto-error ()
753 "Mouse interface for `ada-compile-goto-error'."
755 (mouse-set-point last-input-event
)
756 (ada-compile-goto-error (point))
759 (defun ada-compile-goto-error (pos)
760 "Replace `compile-goto-error' from compile.el.
761 If POS is on a file and line location, go to this position. It adds
762 to compile.el the capacity to go to a reference in an error message.
763 For instance, on these lines:
764 foo.adb:61:11: [...] in call to size declared at foo.ads:11
765 foo.adb:61:11: [...] in call to local declared at line 20
766 the 4 file locations can be clicked on and jumped to."
770 (skip-chars-backward "-a-zA-Z0-9_:./\\")
772 ;; special case: looking at a filename:line not at the beginning of a line
773 ;; or a simple line reference "at line ..."
775 (or (looking-at ada-compile-goto-error-file-linenr-re
)
779 (looking-at ada-compile-goto-error-file-linenr-re
))
781 (if (looking-at "\\([0-9]+\\)") (backward-word 1))
782 (looking-at "line \\([0-9]+\\)"))))
784 (let ((line (if (match-beginning 2) (match-string 2) (match-string 1)))
785 (file (if (match-beginning 2) (match-string 1)
786 (save-excursion (beginning-of-line)
787 (looking-at ada-compile-goto-error-file-linenr-re
)
789 (error-pos (point-marker))
794 (compilation-find-file (point-marker) (match-string 1) "./")
798 (goto-line (string-to-number line
)))
800 (setq source
(point-marker)))
802 (compilation-goto-locus error-pos source nil
)
806 ;; otherwise, default behavior
808 (compile-goto-error))
813 ;;-------------------------------------------------------------------------
814 ;; Grammar related function
815 ;; The functions below work with the syntax class of the characters in an Ada
816 ;; buffer. Two syntax tables are created, depending on whether we want '_'
817 ;; to be considered as part of a word or not.
818 ;; Some characters may have multiple meanings depending on the context:
819 ;; - ' is either the beginning of a constant character or an attribute
820 ;; - # is either part of a based litteral or a gnatprep statement.
821 ;; - " starts a string, but not if inside a constant character.
822 ;; - ( and ) should be ignored if inside a constant character.
823 ;; Thus their syntax property is changed automatically, and we can still use
824 ;; the standard Emacs functions for sexp (see `ada-in-string-p')
826 ;; On Emacs, this is done through the `syntax-table' text property. The
827 ;; corresponding action is applied automatically each time the buffer
828 ;; changes. If `font-lock-mode' is enabled (the default) the action is
829 ;; set up by `font-lock-syntactic-keywords'. Otherwise, we do it
830 ;; manually in `ada-after-change-function'. The proper method is
831 ;; installed by `ada-handle-syntax-table-properties'.
833 ;; on XEmacs, the `syntax-table' property does not exist and we have to use a
834 ;; slow advice to `parse-partial-sexp' to do the same thing.
835 ;; When executing parse-partial-sexp, we simply modify the strings before and
836 ;; after, so that the special constants '"', '(' and ')' do not interact
837 ;; with parse-partial-sexp.
838 ;; Note: this code is slow and needs to be rewritten as soon as something
839 ;; better is available on XEmacs.
840 ;;-------------------------------------------------------------------------
842 (defun ada-create-syntax-table ()
843 "Create the two syntax tables use in the Ada mode.
844 The standard table declares `_' as a symbol constituent, the second one
845 declares it as a word constituent."
847 (setq ada-mode-syntax-table
(make-syntax-table))
849 ;; define string brackets (`%' is alternative string bracket, but
850 ;; almost never used as such and throws font-lock and indentation
852 (modify-syntax-entry ?%
"$" ada-mode-syntax-table
)
853 (modify-syntax-entry ?
\" "\"" ada-mode-syntax-table
)
855 (modify-syntax-entry ?
: "." ada-mode-syntax-table
)
856 (modify-syntax-entry ?\
; "." ada-mode-syntax-table)
857 (modify-syntax-entry ?
& "." ada-mode-syntax-table
)
858 (modify-syntax-entry ?\|
"." ada-mode-syntax-table
)
859 (modify-syntax-entry ?
+ "." ada-mode-syntax-table
)
860 (modify-syntax-entry ?
* "." ada-mode-syntax-table
)
861 (modify-syntax-entry ?
/ "." ada-mode-syntax-table
)
862 (modify-syntax-entry ?
= "." ada-mode-syntax-table
)
863 (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
)
874 ;; a single hyphen is punctuation, but a double hyphen starts a comment
875 (modify-syntax-entry ?-
". 12" ada-mode-syntax-table
)
877 ;; See the comment above on grammar related function for the special
879 (if (featurep 'xemacs
)
880 (modify-syntax-entry ?
# "<" ada-mode-syntax-table
)
881 (modify-syntax-entry ?
# "$" ada-mode-syntax-table
))
883 ;; and \f and \n end a comment
884 (modify-syntax-entry ?
\f "> " ada-mode-syntax-table
)
885 (modify-syntax-entry ?
\n "> " ada-mode-syntax-table
)
887 ;; define what belongs in Ada symbols
888 (modify-syntax-entry ?_
"_" ada-mode-syntax-table
)
890 ;; define parentheses to match
891 (modify-syntax-entry ?\
( "()" ada-mode-syntax-table
)
892 (modify-syntax-entry ?\
) ")(" ada-mode-syntax-table
)
894 (setq ada-mode-symbol-syntax-table
(copy-syntax-table ada-mode-syntax-table
))
895 (modify-syntax-entry ?_
"w" ada-mode-symbol-syntax-table
)
898 ;; Support of special characters in XEmacs (see the comments at the beginning
899 ;; of the section on Grammar related functions).
901 (if (featurep 'xemacs
)
902 (defadvice parse-partial-sexp
(around parse-partial-sexp-protect-constants
)
903 "Handles special character constants and gnatprep statements."
907 (setq from to to tmp
)))
910 (while (re-search-forward "'\\([(\")#]\\)'" to t
)
911 (setq change
(cons (list (match-beginning 1)
915 (replace-match "'A'"))
917 (while (re-search-forward "\\(#[0-9a-fA-F]*#\\)" to t
)
918 (setq change
(cons (list (match-beginning 1)
919 (length (match-string 1))
922 (replace-match (make-string (length (match-string 1)) ?
@))))
926 (goto-char (caar change
))
927 (delete-char (cadar change
))
928 (insert (caddar change
))
929 (setq change
(cdr change
)))))))
931 (defun ada-set-syntax-table-properties ()
932 "Assign `syntax-table' properties in accessible part of buffer.
933 In particular, character constants are said to be strings, #...#
934 are treated as numbers instead of gnatprep comments."
935 (let ((modified (buffer-modified-p))
937 (inhibit-read-only t
)
938 (inhibit-point-motion-hooks t
)
939 (inhibit-modification-hooks t
))
940 (remove-text-properties (point-min) (point-max) '(syntax-table nil
))
941 (goto-char (point-min))
942 (while (re-search-forward
943 ;; The following regexp was adapted from
944 ;; `ada-font-lock-syntactic-keywords'.
945 "^[ \t]*\\(#\\(?:if\\|else\\|elsif\\|end\\)\\)\\|[^a-zA-Z0-9)]\\('\\)[^'\n]\\('\\)"
947 (if (match-beginning 1)
949 (match-beginning 1) (match-end 1) 'syntax-table
'(11 . ?
\n))
951 (match-beginning 2) (match-end 2) 'syntax-table
'(7 . ?
'))
953 (match-beginning 3) (match-end 3) 'syntax-table
'(7 . ?
'))))
955 (restore-buffer-modified-p nil
))))
957 (defun ada-after-change-function (beg end old-len
)
958 "Called when the region between BEG and END was changed in the buffer.
959 OLD-LEN indicates what the length of the replaced text was."
962 (let ((from (progn (goto-char beg
) (line-beginning-position)))
963 (to (progn (goto-char end
) (line-end-position))))
964 (narrow-to-region from to
)
966 (ada-set-syntax-table-properties))))))
968 (defun ada-initialize-syntax-table-properties ()
969 "Assign `syntax-table' properties in current buffer."
974 (ada-set-syntax-table-properties))))
975 (add-hook 'after-change-functions
'ada-after-change-function nil t
))
977 (defun ada-handle-syntax-table-properties ()
978 "Handle `syntax-table' properties."
980 ;; `font-lock-mode' will take care of `syntax-table' properties.
981 (remove-hook 'after-change-functions
'ada-after-change-function t
)
982 ;; Take care of `syntax-table' properties manually.
983 (ada-initialize-syntax-table-properties)))
985 ;;------------------------------------------------------------------
986 ;; Testing the grammatical context
987 ;;------------------------------------------------------------------
989 (defsubst ada-in-comment-p
(&optional parse-result
)
990 "Return t if inside a comment.
991 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
992 (nth 4 (or parse-result
994 (line-beginning-position) (point)))))
996 (defsubst ada-in-string-p
(&optional parse-result
)
997 "Return t if point is inside a string.
998 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
999 (nth 3 (or parse-result
1001 (line-beginning-position) (point)))))
1003 (defsubst ada-in-string-or-comment-p
(&optional parse-result
)
1004 "Return t if inside a comment or string.
1005 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1006 (setq parse-result
(or parse-result
1008 (line-beginning-position) (point))))
1009 (or (ada-in-string-p parse-result
) (ada-in-comment-p parse-result
)))
1012 ;;------------------------------------------------------------------
1014 ;; The Ada mode comes with contextual menus, bound by default to the right
1016 ;; Add items to this menu by modifying `ada-contextual-menu'. Note that the
1017 ;; variable `ada-contextual-menu-on-identifier' is set automatically to t
1018 ;; if the mouse button was pressed on an identifier.
1019 ;;------------------------------------------------------------------
1021 (defun ada-call-from-contextual-menu (function)
1022 "Execute FUNCTION when called from the contextual menu.
1023 It forces Emacs to change the cursor position."
1026 (setq ada-contextual-menu-last-point
1027 (list (point) (current-buffer))))
1029 (defun ada-popup-menu (position)
1030 "Pops up a contextual menu, depending on where the user clicked.
1031 POSITION is the location the mouse was clicked on.
1032 Sets `ada-contextual-menu-last-point' to the current position before
1033 displaying the menu. When a function from the menu is called, the
1034 point is where the mouse button was clicked."
1037 ;; declare this as a local variable, so that the function called
1038 ;; in the contextual menu does not hide the region in
1039 ;; transient-mark-mode.
1040 (let ((deactivate-mark nil
))
1041 (setq ada-contextual-menu-last-point
1042 (list (point) (current-buffer)))
1043 (mouse-set-point last-input-event
)
1045 (setq ada-contextual-menu-on-identifier
1047 (or (= (char-syntax (char-after)) ?w
)
1048 (= (char-after) ?_
))
1049 (not (ada-in-string-or-comment-p))
1050 (save-excursion (skip-syntax-forward "w")
1051 (not (ada-after-keyword-p)))
1053 (if (fboundp 'popup-menu
)
1054 (funcall (symbol-function 'popup-menu
) ada-contextual-menu
)
1056 (setq choice
(x-popup-menu position ada-contextual-menu
))
1058 (funcall (lookup-key ada-contextual-menu
(vector (car choice
)))))))
1060 (set-buffer (cadr ada-contextual-menu-last-point
))
1061 (goto-char (car ada-contextual-menu-last-point
))
1065 ;;------------------------------------------------------------------
1067 ;;------------------------------------------------------------------
1070 (defun ada-add-extensions (spec body
)
1071 "Define SPEC and BODY as being valid extensions for Ada files.
1072 Going from body to spec with `ff-find-other-file' used these
1074 SPEC and BODY are two regular expressions that must match against
1076 (let* ((reg (concat (regexp-quote body
) "$"))
1077 (tmp (assoc reg ada-other-file-alist
)))
1079 (setcdr tmp
(list (cons spec
(cadr tmp
))))
1080 (add-to-list 'ada-other-file-alist
(list reg
(list spec
)))))
1082 (let* ((reg (concat (regexp-quote spec
) "$"))
1083 (tmp (assoc reg ada-other-file-alist
)))
1085 (setcdr tmp
(list (cons body
(cadr tmp
))))
1086 (add-to-list 'ada-other-file-alist
(list reg
(list body
)))))
1088 (add-to-list 'auto-mode-alist
1089 (cons (concat (regexp-quote spec
) "\\'") 'ada-mode
))
1090 (add-to-list 'auto-mode-alist
1091 (cons (concat (regexp-quote body
) "\\'") 'ada-mode
))
1093 (add-to-list 'ada-spec-suffixes spec
)
1094 (add-to-list 'ada-body-suffixes body
)
1096 ;; Support for speedbar (Specifies that we want to see these files in
1098 (if (fboundp 'speedbar-add-supported-extension
)
1100 (funcall (symbol-function 'speedbar-add-supported-extension
)
1102 (funcall (symbol-function 'speedbar-add-supported-extension
)
1109 "Ada mode is the major mode for editing Ada code.
1111 Bindings are as follows: (Note: 'LFD' is control-j.)
1114 Indent line '\\[ada-tab]'
1115 Indent line, insert newline and indent the new line. '\\[newline-and-indent]'
1117 Re-format the parameter-list point is in '\\[ada-format-paramlist]'
1118 Indent all lines in region '\\[ada-indent-region]'
1120 Adjust case of identifiers and keywords in region '\\[ada-adjust-case-region]'
1121 Adjust case of identifiers and keywords in buffer '\\[ada-adjust-case-buffer]'
1123 Fill comment paragraph, justify and append postfix '\\[fill-paragraph]'
1125 Next func/proc/task '\\[ada-next-procedure]' Previous func/proc/task '\\[ada-previous-procedure]'
1126 Next package '\\[ada-next-package]' Previous package '\\[ada-previous-package]'
1128 Goto matching start of current 'end ...;' '\\[ada-move-to-start]'
1129 Goto end of current block '\\[ada-move-to-end]'
1131 Comments are handled using standard GNU Emacs conventions, including:
1132 Start a comment '\\[indent-for-comment]'
1133 Comment region '\\[comment-region]'
1134 Uncomment region '\\[ada-uncomment-region]'
1135 Continue comment on next line '\\[indent-new-comment-line]'
1137 If you use imenu.el:
1138 Display index-menu of functions and procedures '\\[imenu]'
1140 If you use find-file.el:
1141 Switch to other file (Body <-> Spec) '\\[ff-find-other-file]'
1142 or '\\[ff-mouse-find-other-file]
1143 Switch to other file in other window '\\[ada-ff-other-window]'
1144 or '\\[ff-mouse-find-other-file-other-window]
1145 If you use this function in a spec and no body is available, it gets created with body stubs.
1147 If you use ada-xref.el:
1148 Goto declaration: '\\[ada-point-and-xref]' on the identifier
1149 or '\\[ada-goto-declaration]' with point on the identifier
1150 Complete identifier: '\\[ada-complete-identifier]'."
1153 (kill-all-local-variables)
1155 (set-syntax-table ada-mode-syntax-table
)
1157 (set (make-local-variable 'require-final-newline
) mode-require-final-newline
)
1159 ;; Set the paragraph delimiters so that one can select a whole block
1161 (set (make-local-variable 'paragraph-start
) "[ \t\n\f]*$")
1162 (set (make-local-variable 'paragraph-separate
) "[ \t\n\f]*$")
1164 ;; comment end must be set because it may hold a wrong value if
1165 ;; this buffer had been in another mode before. RE
1166 (set (make-local-variable 'comment-end
) "")
1168 ;; used by autofill and indent-new-comment-line
1169 (set (make-local-variable 'comment-start-skip
) "---*[ \t]*")
1171 ;; used by autofill to break a comment line and continue it on another line.
1172 ;; The reason we need this one is that the default behavior does not work
1173 ;; correctly with the definition of paragraph-start above when the comment
1174 ;; is right after a multi-line subprogram declaration (the comments are
1175 ;; aligned under the latest parameter, not under the declaration start).
1176 (set (make-local-variable 'comment-line-break-function
)
1177 (lambda (&optional soft
) (let ((fill-prefix nil
))
1178 (indent-new-comment-line soft
))))
1180 (set (make-local-variable 'indent-line-function
)
1181 'ada-indent-current-function
)
1183 (set (make-local-variable 'comment-column
) 40)
1185 ;; Emacs 20.3 defines a comment-padding to insert spaces between
1186 ;; the comment and the text. We do not want any, this is already
1187 ;; included in comment-start
1188 (unless (featurep 'xemacs
)
1189 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
1190 (set (make-local-variable 'comment-padding
) 0)
1191 (set (make-local-variable 'parse-sexp-lookup-properties
) t
))
1193 (set 'case-fold-search t
)
1194 (if (boundp 'imenu-case-fold-search
)
1195 (set 'imenu-case-fold-search t
))
1197 (set (make-local-variable 'fill-paragraph-function
)
1198 'ada-fill-comment-paragraph
)
1200 ;; Support for compile.el
1201 ;; We just substitute our own functions to go to the error.
1202 (add-hook 'compilation-mode-hook
1204 (set (make-local-variable 'compile-auto-highlight
) 40)
1205 ;; FIXME: This has global impact! -stef
1206 (define-key compilation-minor-mode-map
[mouse-2
]
1207 'ada-compile-mouse-goto-error
)
1208 (define-key compilation-minor-mode-map
"\C-c\C-c"
1209 'ada-compile-goto-error
)
1210 (define-key compilation-minor-mode-map
"\C-m"
1211 'ada-compile-goto-error
)))
1213 ;; font-lock support :
1215 (set (make-local-variable 'font-lock-defaults
)
1216 '(ada-font-lock-keywords
1218 ((?\_ .
"w") (?
# .
"."))
1220 (font-lock-syntactic-keywords . ada-font-lock-syntactic-keywords
)))
1222 ;; Set up support for find-file.el.
1223 (set (make-local-variable 'ff-other-file-alist
)
1224 'ada-other-file-alist
)
1225 (set (make-local-variable 'ff-search-directories
)
1226 'ada-search-directories-internal
)
1227 (setq ff-post-load-hook
'ada-set-point-accordingly
1228 ff-file-created-hook
'ada-make-body
)
1229 (add-hook 'ff-pre-load-hook
'ada-which-function-are-we-in
)
1231 (make-local-variable 'ff-special-constructs
)
1232 (mapc (lambda (pair) (add-to-list 'ff-special-constructs pair
))
1234 ;; Top level child package declaration; go to the parent package.
1235 (cons (eval-when-compile
1236 (concat "^\\(private[ \t]\\)?[ \t]*package[ \t]+"
1238 "\\(\\(\\sw\\|[_.]\\)+\\)\\.\\(\\sw\\|_\\)+[ \t\n]+is"))
1241 ada-search-directories-internal
1242 (ada-make-filename-from-adaname (match-string 3))
1243 ada-spec-suffixes
)))
1245 ;; A "separate" clause.
1246 (cons "^separate[ \t\n]*(\\(\\(\\sw\\|[_.]\\)+\\))"
1249 ada-search-directories-internal
1250 (ada-make-filename-from-adaname (match-string 1))
1251 ada-spec-suffixes
)))
1254 (cons "^with[ \t]+\\([a-zA-Z0-9_\\.]+\\)"
1257 ada-search-directories-internal
1258 (ada-make-filename-from-adaname (match-string 1))
1259 ada-spec-suffixes
)))
1262 ;; Support for outline-minor-mode
1263 (set (make-local-variable 'outline-regexp
)
1264 "\\([ \t]*\\(procedure\\|function\\|package\\|if\\|while\\|for\\|declare\\|case\\|end\\|begin\\|loop\\)\\|--\\)")
1265 (set (make-local-variable 'outline-level
) 'ada-outline-level
)
1267 ;; Support for imenu : We want a sorted index
1268 (setq imenu-generic-expression ada-imenu-generic-expression
)
1270 (setq imenu-sort-function
'imenu--sort-by-name
)
1272 ;; Support for ispell : Check only comments
1273 (set (make-local-variable 'ispell-check-comments
) 'exclusive
)
1275 ;; Support for align
1276 (add-to-list 'align-dq-string-modes
'ada-mode
)
1277 (add-to-list 'align-open-comment-modes
'ada-mode
)
1278 (set (make-local-variable 'align-region-separate
) ada-align-region-separate
)
1280 ;; Exclude comments alone on line from alignment.
1281 (add-to-list 'align-exclude-rules-list
1283 (regexp .
"^\\(\\s-*\\)--")
1284 (modes .
'(ada-mode))))
1285 (add-to-list 'align-exclude-rules-list
1287 (regexp .
"^\\(\\s-*\\)\\<use\\>")
1288 (modes .
'(ada-mode))))
1290 (setq ada-align-modes nil
)
1292 (add-to-list 'ada-align-modes
1293 '(ada-declaration-assign
1294 (regexp .
"[^:]\\(\\s-*\\):[^:]")
1295 (valid .
(lambda() (not (ada-in-comment-p))))
1297 (modes .
'(ada-mode))))
1298 (add-to-list 'ada-align-modes
1300 (regexp .
"[^=]\\(\\s-*\\)=>")
1301 (valid .
(lambda() (not (ada-in-comment-p))))
1302 (modes .
'(ada-mode))))
1303 (add-to-list 'ada-align-modes
1305 (regexp .
"\\(\\s-*\\)--")
1306 (modes .
'(ada-mode))))
1307 (add-to-list 'ada-align-modes
1309 (regexp .
"\\(\\s-*\\)\\<use\\s-")
1310 (valid .
(lambda() (not (ada-in-comment-p))))
1311 (modes .
'(ada-mode))))
1312 (add-to-list 'ada-align-modes
1314 (regexp .
"\\(\\s-+\\)at\\>")
1315 (modes .
'(ada-mode))))
1317 (setq align-mode-rules-list ada-align-modes
)
1319 ;; Set up the contextual menu
1321 (define-key ada-mode-map ada-popup-key
'ada-popup-menu
))
1323 ;; Support for Abbreviations (the user still need to "M-x abbrev-mode"
1324 (define-abbrev-table 'ada-mode-abbrev-table
())
1325 (setq local-abbrev-table ada-mode-abbrev-table
)
1327 ;; Support for which-function mode
1328 (make-local-variable 'which-func-functions
)
1329 (setq which-func-functions
'(ada-which-function))
1331 ;; Support for indent-new-comment-line (Especially for XEmacs)
1332 (set (make-local-variable 'comment-multi-line
) nil
)
1334 ;; Support for add-log
1335 (set (make-local-variable 'add-log-current-defun-function
) 'ada-which-function
)
1337 (setq major-mode
'ada-mode
1340 (use-local-map ada-mode-map
)
1342 (easy-menu-add ada-mode-menu ada-mode-map
)
1344 (set-syntax-table ada-mode-syntax-table
)
1346 (if ada-clean-buffer-before-saving
1348 ;; remove all spaces at the end of lines in the whole buffer.
1349 (add-hook 'local-write-file-hooks
'delete-trailing-whitespace
)
1350 ;; convert all tabs to the correct number of spaces.
1351 (add-hook 'local-write-file-hooks
1352 (lambda () (untabify (point-min) (point-max))))))
1354 (set (make-local-variable 'skeleton-further-elements
)
1355 '((< '(backward-delete-char-untabify
1356 (min ada-indent
(current-column))))))
1357 (add-hook 'skeleton-end-hook
'ada-adjust-case-skeleton nil t
)
1359 (run-mode-hooks 'ada-mode-hook
)
1361 ;; To be run after the hook, in case the user modified
1362 ;; ada-fill-comment-prefix
1363 (make-local-variable 'comment-start
)
1364 (if ada-fill-comment-prefix
1365 (set 'comment-start ada-fill-comment-prefix
)
1366 (set 'comment-start
"-- "))
1368 ;; Run this after the hook to give the users a chance to activate
1371 (unless (featurep 'xemacs
)
1372 (ada-initialize-syntax-table-properties)
1373 (add-hook 'font-lock-mode-hook
'ada-handle-syntax-table-properties nil t
))
1375 ;; the following has to be done after running the ada-mode-hook
1376 ;; because users might want to set the values of these variable
1379 (cond ((eq ada-language-version
'ada83
)
1380 (setq ada-keywords ada-83-keywords
))
1381 ((eq ada-language-version
'ada95
)
1382 (setq ada-keywords ada-95-keywords
))
1383 ((eq ada-language-version
'ada2005
)
1384 (setq ada-keywords ada-2005-keywords
)))
1387 (ada-activate-keys-for-case)))
1389 (defun ada-adjust-case-skeleton ()
1390 "Adjust the case of the text inserted by a skeleton."
1392 (let ((aa-end (point)))
1393 (ada-adjust-case-region
1394 (progn (goto-char (symbol-value 'beg
)) (forward-word -
1) (point))
1395 (goto-char aa-end
)))))
1397 (defun ada-region-selected ()
1398 "Should we operate on an active region?"
1399 (if (fboundp 'use-region-p
)
1403 ;;-----------------------------------------------------------------
1405 ;; Since Ada is case-insensitive, the Ada mode provides an extensive set of
1406 ;; functions to auto-case identifiers, keywords, ...
1407 ;; The basic rules for autocasing are defined through the variables
1408 ;; `ada-case-attribute', `ada-case-keyword' and `ada-case-identifier'. These
1409 ;; are references to the functions that will do the actual casing.
1411 ;; However, in most cases, the user will want to define some exceptions to
1412 ;; these casing rules. This is done through a list of files, that contain
1413 ;; one word per line. These files are stored in `ada-case-exception-file'.
1414 ;; For backward compatibility, this variable can also be a string.
1415 ;;-----------------------------------------------------------------
1417 (defun ada-save-exceptions-to-file (file-name)
1418 "Save the casing exception lists to the file FILE-NAME.
1419 Casing exception lists are `ada-case-exception' and `ada-case-exception-substring'."
1420 (find-file (expand-file-name file-name
))
1422 (mapc (lambda (x) (insert (car x
) "\n"))
1423 (sort (copy-sequence ada-case-exception
)
1424 (lambda(a b
) (string< (car a
) (car b
)))))
1425 (mapc (lambda (x) (insert "*" (car x
) "\n"))
1426 (sort (copy-sequence ada-case-exception-substring
)
1427 (lambda(a b
) (string< (car a
) (car b
)))))
1432 (defun ada-create-case-exception (&optional word
)
1433 "Define WORD as an exception for the casing system.
1434 If WORD is not given, then the current word in the buffer is used instead.
1435 The new word is added to the first file in `ada-case-exception-file'.
1436 The standard casing rules will no longer apply to this word."
1438 (let ((previous-syntax-table (syntax-table))
1442 (cond ((stringp ada-case-exception-file
)
1443 (setq file-name ada-case-exception-file
))
1444 ((listp ada-case-exception-file
)
1445 (setq file-name
(car ada-case-exception-file
)))
1447 (error (concat "No exception file specified. "
1448 "See variable ada-case-exception-file"))))
1450 (set-syntax-table ada-mode-symbol-syntax-table
)
1453 (skip-syntax-backward "w")
1454 (setq word
(buffer-substring-no-properties
1455 (point) (save-excursion (forward-word 1) (point))))))
1456 (set-syntax-table previous-syntax-table
)
1458 ;; Reread the exceptions file, in case it was modified by some other,
1459 (ada-case-read-exceptions-from-file file-name
)
1461 ;; If the word is already in the list, even with a different casing
1462 ;; we simply want to replace it.
1463 (if (and (not (equal ada-case-exception
'()))
1464 (assoc-string word ada-case-exception t
))
1465 (setcar (assoc-string word ada-case-exception t
) word
)
1466 (add-to-list 'ada-case-exception
(cons word t
))
1469 (ada-save-exceptions-to-file file-name
)
1472 (defun ada-create-case-exception-substring (&optional word
)
1473 "Define the substring WORD as an exception for the casing system.
1474 If WORD is not given, then the current word in the buffer is used instead,
1475 or the selected region if any is active.
1476 The new word is added to the first file in `ada-case-exception-file'.
1477 When auto-casing a word, this substring will be special-cased, unless the
1478 word itself has a special casing."
1481 (cond ((stringp ada-case-exception-file
)
1482 ada-case-exception-file
)
1483 ((listp ada-case-exception-file
)
1484 (car ada-case-exception-file
))
1486 (error (concat "No exception file specified. "
1487 "See variable ada-case-exception-file"))))))
1489 ;; Find the substring to define as an exception. Order is: the parameter,
1490 ;; if any, or the selected region, or the word under the cursor
1494 ((ada-region-selected)
1495 (setq word
(buffer-substring-no-properties
1496 (region-beginning) (region-end))))
1499 (let ((underscore-syntax (char-syntax ?_
)))
1502 (modify-syntax-entry ?_
"." (syntax-table))
1504 (skip-syntax-backward "w")
1505 (set 'word
(buffer-substring-no-properties
1507 (save-excursion (forward-word 1) (point))))))
1508 (modify-syntax-entry ?_
(make-string 1 underscore-syntax
)
1511 ;; Reread the exceptions file, in case it was modified by some other,
1512 (ada-case-read-exceptions-from-file file-name
)
1514 ;; If the word is already in the list, even with a different casing
1515 ;; we simply want to replace it.
1516 (if (and (not (equal ada-case-exception-substring
'()))
1517 (assoc-string word ada-case-exception-substring t
))
1518 (setcar (assoc-string word ada-case-exception-substring t
) word
)
1519 (add-to-list 'ada-case-exception-substring
(cons word t
))
1522 (ada-save-exceptions-to-file file-name
)
1524 (message "%s" (concat "Defining " word
" as a casing exception"))))
1526 (defun ada-case-read-exceptions-from-file (file-name)
1527 "Read the content of the casing exception file FILE-NAME."
1528 (if (file-readable-p (expand-file-name file-name
))
1529 (let ((buffer (current-buffer)))
1530 (find-file (expand-file-name file-name
))
1531 (set-syntax-table ada-mode-symbol-syntax-table
)
1533 (goto-char (point-min))
1536 ;; If the item is already in the list, even with an other casing,
1537 ;; do not add it again. This way, the user can easily decide which
1538 ;; priority should be applied to each casing exception
1539 (let ((word (buffer-substring-no-properties
1540 (point) (save-excursion (forward-word 1) (point)))))
1542 ;; Handling a substring ?
1543 (if (char-equal (string-to-char word
) ?
*)
1545 (setq word
(substring word
1))
1546 (unless (assoc-string word ada-case-exception-substring t
)
1547 (add-to-list 'ada-case-exception-substring
(cons word t
))))
1548 (unless (assoc-string word ada-case-exception t
)
1549 (add-to-list 'ada-case-exception
(cons word t
)))))
1553 (set-buffer buffer
)))
1556 (defun ada-case-read-exceptions ()
1557 "Read all the casing exception files from `ada-case-exception-file'."
1560 ;; Reinitialize the casing exception list
1561 (setq ada-case-exception
'()
1562 ada-case-exception-substring
'())
1564 (cond ((stringp ada-case-exception-file
)
1565 (ada-case-read-exceptions-from-file ada-case-exception-file
))
1567 ((listp ada-case-exception-file
)
1568 (mapcar 'ada-case-read-exceptions-from-file
1569 ada-case-exception-file
))))
1571 (defun ada-adjust-case-substring ()
1572 "Adjust case of substrings in the previous word."
1574 (let ((substrings ada-case-exception-substring
)
1576 (case-fold-search t
)
1577 (underscore-syntax (char-syntax ?_
))
1585 (modify-syntax-entry ?_
"." (syntax-table))
1588 (setq re
(concat "\\b" (regexp-quote (caar substrings
)) "\\b"))
1591 (while (re-search-forward re max t
)
1592 (replace-match (caar substrings
) t
)))
1593 (setq substrings
(cdr substrings
))
1596 (modify-syntax-entry ?_
(make-string 1 underscore-syntax
) (syntax-table)))
1599 (defun ada-adjust-case-identifier ()
1600 "Adjust case of the previous identifier.
1601 The auto-casing is done according to the value of `ada-case-identifier'
1602 and the exceptions defined in `ada-case-exception-file'."
1604 (if (or (equal ada-case-exception
'())
1605 (equal (char-after) ?_
))
1607 (funcall ada-case-identifier -
1)
1608 (ada-adjust-case-substring))
1612 (start (save-excursion (skip-syntax-backward "w")
1615 ;; If we have an exception, replace the word by the correct casing
1616 (if (setq match
(assoc-string (buffer-substring start end
)
1617 ada-case-exception t
))
1620 (delete-region start end
)
1621 (insert (car match
)))
1623 ;; Else simply re-case the word
1624 (funcall ada-case-identifier -
1)
1625 (ada-adjust-case-substring))))))
1627 (defun ada-after-keyword-p ()
1628 "Return t if cursor is after a keyword that is not an attribute."
1631 (and (not (and (char-before)
1632 (or (= (char-before) ?_
)
1633 (= (char-before) ?
'))));; unless we have a _ or '
1634 (looking-at (concat ada-keywords
"[^_]")))))
1636 (defun ada-adjust-case (&optional force-identifier
)
1637 "Adjust the case of the word before the character just typed.
1638 If FORCE-IDENTIFIER is non-nil then also adjust keyword as identifier."
1642 (if (and (not (bobp))
1643 ;; or if at the end of a character constant
1644 (not (and (eq (following-char) ?
')
1645 (eq (char-before (1- (point))) ?
')))
1646 ;; or if the previous character was not part of a word
1647 (eq (char-syntax (char-before)) ?w
)
1648 ;; if in a string or a comment
1649 (not (ada-in-string-or-comment-p))
1653 (or (= (point) (point-min))
1655 (= (following-char) ?
'))
1656 (funcall ada-case-attribute -
1)
1658 (not force-identifier
) ; (MH)
1659 (ada-after-keyword-p))
1660 (funcall ada-case-keyword -
1)
1661 (ada-adjust-case-identifier))))
1666 (defun ada-adjust-case-interactive (arg)
1667 "Adjust the case of the previous word, and process the character just typed.
1668 ARG is the prefix the user entered with \\[universal-argument]."
1672 (let ((lastk last-command-char
)
1673 (previous-syntax-table (syntax-table)))
1677 (set-syntax-table ada-mode-symbol-syntax-table
)
1678 (cond ((or (eq lastk ?
\n)
1683 ;; horrible dekludge
1684 (delete-backward-char 1)
1685 ;; some special keys and their bindings
1688 (funcall ada-lfd-binding
))
1690 (funcall ada-ret-binding
))))
1691 ((eq lastk ?\C-i
) (ada-tab))
1692 ;; Else just insert the character
1693 ((self-insert-command (prefix-numeric-value arg
))))
1694 ;; if there is a keyword in front of the underscore
1695 ;; then it should be part of an identifier (MH)
1700 ;; Restore the syntax table
1701 (set-syntax-table previous-syntax-table
))
1704 ;; Else, no auto-casing
1706 ((eq last-command-char ?
\n)
1707 (funcall ada-lfd-binding
))
1708 ((eq last-command-char ?
\r)
1709 (funcall ada-ret-binding
))
1711 (self-insert-command (prefix-numeric-value arg
))))
1714 (defun ada-activate-keys-for-case ()
1715 "Modify the key bindings for all the keys that should readjust the casing."
1717 ;; Save original key-bindings to allow swapping ret/lfd
1718 ;; when casing is activated.
1719 ;; The 'or ...' is there to be sure that the value will not
1720 ;; be changed again when Ada mode is called more than once
1721 (or ada-ret-binding
(setq ada-ret-binding
(key-binding "\C-M")))
1722 (or ada-lfd-binding
(setq ada-lfd-binding
(key-binding "\C-j")))
1724 ;; Call case modifying function after certain keys.
1725 (mapcar (function (lambda(key) (define-key
1727 (char-to-string key
)
1728 'ada-adjust-case-interactive
)))
1729 '( ?
` ?_ ?
# ?% ?
& ?
* ?
( ?
) ?- ?
= ?
+
1730 ?| ?\
; ?: ?' ?\" ?< ?, ?. ?> ?/ ?\n 32 ?\r )))
1732 (defun ada-loose-case-word (&optional arg
)
1733 "Upcase first letter and letters following `_' in the following word.
1734 No other letter is modified.
1735 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1738 (let ((end (save-excursion (skip-syntax-forward "w") (point)))
1740 (skip-syntax-backward "w")
1741 (while (and (or first
(search-forward "_" end t
))
1745 (insert-char (upcase (following-char)) 1)
1748 (defun ada-no-auto-case (&optional arg
)
1749 "Do nothing. ARG is ignored.
1750 This function can be used for the auto-casing variables in Ada mode, to
1751 adapt to unusal auto-casing schemes. Since it does nothing, you can for
1752 instance use it for `ada-case-identifier' if you don't want any special
1753 auto-casing for identifiers, whereas keywords have to be lower-cased.
1754 See also `ada-auto-case' to disable auto casing altogether."
1757 (defun ada-capitalize-word (&optional arg
)
1758 "Upcase first letter and letters following '_', lower case other letters.
1759 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1761 (let ((end (save-excursion (skip-syntax-forward "w") (point)))
1762 (begin (save-excursion (skip-syntax-backward "w") (point))))
1763 (modify-syntax-entry ?_
"_")
1764 (capitalize-region begin end
)
1765 (modify-syntax-entry ?_
"w")))
1767 (defun ada-adjust-case-region (from to
)
1768 "Adjust the case of all words in the region between FROM and TO.
1769 Attention: This function might take very long for big regions!"
1775 (previous-syntax-table (syntax-table)))
1776 (message "Adjusting case ...")
1779 (set-syntax-table ada-mode-symbol-syntax-table
)
1782 ;; loop: look for all identifiers, keywords, and attributes
1784 (while (re-search-backward "\\<\\(\\sw+\\)\\>" from t
)
1785 (setq end
(match-end 1))
1787 (and (> (point) from
)
1790 (setq attribp
(looking-at "'.[^']")))))
1792 ;; do nothing if it is a string or comment
1793 (ada-in-string-or-comment-p)
1796 ;; get the identifier or keyword or attribute
1798 (setq begin
(point))
1799 (setq keywordp
(looking-at ada-keywords
))
1802 ;; casing according to user-option
1805 (funcall ada-case-attribute -
1)
1807 (funcall ada-case-keyword -
1)
1808 (ada-adjust-case-identifier)))
1809 (goto-char begin
))))
1810 (message "Adjusting case ... Done"))
1811 (set-syntax-table previous-syntax-table
))))
1813 (defun ada-adjust-case-buffer ()
1814 "Adjust the case of all words in the whole buffer.
1815 ATTENTION: This function might take very long for big buffers!"
1817 (ada-adjust-case-region (point-min) (point-max)))
1820 ;;--------------------------------------------------------------
1821 ;; Format Parameter Lists
1822 ;; Some special algorithms are provided to indent the parameter lists in
1823 ;; subprogram declarations. This is done in two steps:
1824 ;; - First parses the parameter list. The returned list has the following
1826 ;; ( (<Param_Name> in? out? access? <Type_Name> <Default_Expression>)
1828 ;; This is done in `ada-scan-paramlist'.
1829 ;; - Delete and recreate the parameter list in function
1830 ;; `ada-insert-paramlist'.
1831 ;; Both steps are called from `ada-format-paramlist'.
1832 ;; Note: Comments inside the parameter list are lost.
1833 ;; The syntax has to be correct, or the reformating will fail.
1834 ;;--------------------------------------------------------------
1836 (defun ada-format-paramlist ()
1837 "Reformat the parameter list point is in."
1843 (previous-syntax-table (syntax-table)))
1846 (set-syntax-table ada-mode-symbol-syntax-table
)
1848 ;; check if really inside parameter list
1849 (or (ada-in-paramlist-p)
1850 (error "Not in parameter list"))
1852 ;; find start of current parameter-list
1853 (ada-search-ignore-string-comment
1854 (concat ada-subprog-start-re
"\\|\\<body\\>" ) t nil
)
1857 (setq begin
(point))
1859 ;; find end of parameter-list
1861 (setq delend
(point))
1865 ;; find end of last parameter-declaration
1866 (forward-comment -
1000)
1869 ;; build a list of all elements of the parameter-list
1870 (setq paramlist
(ada-scan-paramlist (1+ begin
) end
))
1872 ;; delete the original parameter-list
1873 (delete-region begin delend
)
1875 ;; insert the new parameter-list
1877 (ada-insert-paramlist paramlist
))
1879 ;; restore syntax-table
1880 (set-syntax-table previous-syntax-table
)
1883 (defun ada-scan-paramlist (begin end
)
1884 "Scan the parameter list found in between BEGIN and END.
1885 Return the equivalent internal parameter list."
1886 (let ((paramlist (list))
1896 ;; loop until end of last parameter
1899 ;; find first character of parameter-declaration
1900 (ada-goto-next-non-ws)
1903 ;; find last character of parameter-declaration
1904 (if (setq match-cons
1905 (ada-search-ignore-string-comment "[ \t\n]*;" nil end t
))
1907 (setq epos
(car match-cons
))
1908 (setq semipos
(cdr match-cons
)))
1911 ;; read name(s) of parameter(s)
1913 (looking-at "\\(\\(\\sw\\|[_, \t\n]\\)*\\(\\sw\\|_\\)\\)[ \t\n]*:[^=]")
1915 (setq param
(list (match-string 1)))
1916 (ada-search-ignore-string-comment ":" nil epos t
'search-forward
)
1924 (ada-search-ignore-string-comment
1925 "in" nil epos t
'word-search-forward
)))))
1933 (ada-search-ignore-string-comment
1934 "out" nil epos t
'word-search-forward
)))))
1936 ;; look for 'access'
1942 (ada-search-ignore-string-comment
1943 "access" nil epos t
'word-search-forward
)))))
1945 ;; skip 'in'/'out'/'access'
1947 (ada-goto-next-non-ws)
1948 (while (looking-at "\\<\\(in\\|out\\|access\\)\\>")
1950 (ada-goto-next-non-ws))
1952 ;; read type of parameter
1953 ;; We accept spaces in the name, since some software like Rose
1954 ;; generates something like: "A : B 'Class"
1955 (looking-at "\\<\\(\\sw\\|[_.' \t]\\)+\\>")
1958 (list (match-string 0))))
1960 ;; read default-expression, if there is one
1961 (goto-char (setq apos
(match-end 0)))
1965 (if (setq match-cons
1966 (ada-search-ignore-string-comment
1967 ":=" nil epos t
'search-forward
))
1968 (buffer-substring (car match-cons
) epos
)
1971 ;; add this parameter-declaration to the list
1972 (setq paramlist
(append paramlist
(list param
)))
1974 ;; check if it was the last parameter
1977 (goto-char semipos
))
1979 (reverse paramlist
)))
1981 (defun ada-insert-paramlist (paramlist)
1982 "Insert a formatted PARAMLIST in the buffer."
1983 (let ((i (length paramlist
))
1992 ;; loop until last parameter
1993 (while (not (zerop i
))
1996 ;; get max length of parameter-name
1997 (setq parlen
(max parlen
(length (nth 0 (nth i paramlist
)))))
1999 ;; get max length of type-name
2000 (setq typlen
(max typlen
(length (nth 4 (nth i paramlist
)))))
2002 ;; is there any 'in' ?
2003 (setq inp
(or inp
(nth 1 (nth i paramlist
))))
2005 ;; is there any 'out' ?
2006 (setq outp
(or outp
(nth 2 (nth i paramlist
))))
2008 ;; is there any 'access' ?
2009 (setq accessp
(or accessp
(nth 3 (nth i paramlist
))))
2012 ;; does paramlist already start on a separate line ?
2014 (re-search-backward "^.\\|[^ \t]" nil t
)
2016 ;; yes => re-indent it
2018 (ada-indent-current)
2020 (if (looking-at "\\(is\\|return\\)")
2021 (replace-match " \\1"))))
2023 ;; no => insert it where we are after removing any whitespace
2027 ((looking-at "[ \t]*\\(\n\\|;\\)")
2028 (replace-match "\\1"))
2029 ((looking-at "[ \t]*\\(is\\|return\\)")
2030 (replace-match " \\1"))))
2034 (ada-indent-current)
2036 (setq firstcol
(current-column))
2037 (setq i
(length paramlist
))
2039 ;; loop until last parameter
2040 (while (not (zerop i
))
2042 (setq column firstcol
)
2044 ;; insert parameter-name, space and colon
2045 (insert (nth 0 (nth i paramlist
)))
2046 (indent-to (+ column parlen
1))
2048 (setq column
(current-column))
2050 ;; insert 'in' or space
2051 (if (nth 1 (nth i paramlist
))
2056 (not (nth 3 (nth i paramlist
))))
2059 ;; insert 'out' or space
2060 (if (nth 2 (nth i paramlist
))
2065 (not (nth 3 (nth i paramlist
))))
2069 (if (nth 3 (nth i paramlist
))
2072 (setq column
(current-column))
2074 ;; insert type-name and, if necessary, space and default-expression
2075 (insert (nth 4 (nth i paramlist
)))
2076 (if (nth 5 (nth i paramlist
))
2078 (indent-to (+ column typlen
1))
2079 (insert (nth 5 (nth i paramlist
)))))
2081 ;; check if it was the last parameter
2084 ;; no => insert ';' and newline and indent
2087 (indent-to firstcol
))
2090 ;; if anything follows, except semicolon, newline, is or return
2091 ;; put it in a new line and indent it
2092 (unless (looking-at "[ \t]*\\(;\\|\n\\|is\\|return\\)")
2093 (ada-indent-newline-indent))
2098 ;;;----------------------------------------------------------------
2099 ;; Indentation Engine
2100 ;; All indentations are indicated as a two-element string:
2101 ;; - position of reference in the buffer
2102 ;; - offset to indent from this position (can also be a symbol or a list
2103 ;; that are evaluated)
2104 ;; Thus the total indentation for a line is the column number of the reference
2105 ;; position plus whatever value the evaluation of the second element provides.
2106 ;; This mechanism is used so that the Ada mode can "explain" how the
2107 ;; indentation was calculated, by showing which variables were used.
2109 ;; The indentation itself is done in only one pass: first we try to guess in
2110 ;; what context we are by looking at the following keyword or punctuation
2111 ;; sign. If nothing remarkable is found, just try to guess the indentation
2112 ;; based on previous lines.
2114 ;; The relevant functions for indentation are:
2115 ;; - `ada-indent-region': Re-indent a region of text
2116 ;; - `ada-justified-indent-current': Re-indent the current line and shows the
2117 ;; calculation that were done
2118 ;; - `ada-indent-current': Re-indent the current line
2119 ;; - `ada-get-current-indent': Calculate the indentation for the current line,
2120 ;; based on the context (see above).
2121 ;; - `ada-get-indent-*': Calculate the indentation in a specific context.
2122 ;; For efficiency, these functions do not check they are in the correct
2124 ;;;----------------------------------------------------------------
2126 (defun ada-indent-region (beg end
)
2127 "Indent the region between BEG end END."
2130 (let ((block-done 0)
2131 (lines-remaining (count-lines beg end
))
2132 (msg (format "%%4d out of %4d lines remaining ..."
2133 (count-lines beg end
)))
2134 (endmark (copy-marker end
)))
2135 ;; catch errors while indenting
2136 (while (< (point) endmark
)
2137 (if (> block-done
39)
2139 (setq lines-remaining
(- lines-remaining block-done
)
2141 (message msg lines-remaining
)))
2142 (if (= (char-after) ?
\n) nil
2143 (ada-indent-current))
2145 (setq block-done
(1+ block-done
)))
2146 (message "Indenting ... done")))
2148 (defun ada-indent-newline-indent ()
2149 "Indent the current line, insert a newline and then indent the new line."
2151 (ada-indent-current)
2153 (ada-indent-current))
2155 (defun ada-indent-newline-indent-conditional ()
2156 "Insert a newline and indent it.
2157 The original line is indented first if `ada-indent-after-return' is non-nil."
2159 (if ada-indent-after-return
(ada-indent-current))
2161 (ada-indent-current))
2163 (defun ada-justified-indent-current ()
2164 "Indent the current line and explain how the calculation was done."
2167 (let ((cur-indent (ada-indent-current)))
2169 (let ((line (save-excursion
2170 (goto-char (car cur-indent
))
2171 (count-lines 1 (point)))))
2173 (if (equal (cdr cur-indent
) '(0))
2174 (message (concat "same indentation as line " (number-to-string line
)))
2175 (message "%s" (mapconcat (lambda(x)
2180 (number-to-string x
))
2182 (concat "- " (symbol-name (cadr x
))))
2187 (goto-char (car cur-indent
))
2190 (defun ada-batch-reformat ()
2191 "Re-indent and re-case all the files found on the command line.
2192 This function should be used from the command line, with a
2194 emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
2196 (while command-line-args-left
2197 (let ((source (car command-line-args-left
)))
2198 (message "Formating %s" source
)
2200 (ada-indent-region (point-min) (point-max))
2201 (ada-adjust-case-buffer)
2202 (write-file source
))
2203 (setq command-line-args-left
(cdr command-line-args-left
)))
2207 (defsubst ada-goto-previous-word
()
2208 "Move point to the beginning of the previous word of Ada code.
2209 Return the new position of point or nil if not found."
2210 (ada-goto-next-word t
))
2212 (defun ada-indent-current ()
2213 "Indent current line as Ada code.
2214 Return the calculation that was done, including the reference point
2217 (let ((previous-syntax-table (syntax-table))
2218 (orgpoint (point-marker))
2219 cur-indent tmp-indent
2224 (set-syntax-table ada-mode-symbol-syntax-table
)
2226 ;; This need to be done here so that the advice is not always
2227 ;; activated (this might interact badly with other modes)
2228 (if (featurep 'xemacs
)
2229 (ad-activate 'parse-partial-sexp t
))
2234 ;; Not First line in the buffer ?
2235 (if (save-excursion (zerop (forward-line -
1)))
2237 (back-to-indentation)
2238 (ada-get-current-indent))
2240 ;; first line in the buffer
2241 (list (point-min) 0))))
2243 ;; Evaluate the list to get the column to indent to
2244 ;; prev-indent contains the column to indent to
2246 (setq prev-indent
(save-excursion (goto-char (car cur-indent
))
2248 tmp-indent
(cdr cur-indent
))
2249 (setq prev-indent
0 tmp-indent
'()))
2251 (while (not (null tmp-indent
))
2253 ((numberp (car tmp-indent
))
2254 (setq prev-indent
(+ prev-indent
(car tmp-indent
))))
2256 (setq prev-indent
(+ prev-indent
(eval (car tmp-indent
)))))
2258 (setq tmp-indent
(cdr tmp-indent
)))
2260 ;; only re-indent if indentation is different then the current
2261 (if (= (save-excursion (back-to-indentation) (current-column)) prev-indent
)
2264 (delete-horizontal-space)
2265 (indent-to prev-indent
))
2267 ;; restore position of point
2269 (goto-char orgpoint
)
2270 (if (< (current-column) (current-indentation))
2271 (back-to-indentation)))
2273 ;; restore syntax-table
2274 (set-syntax-table previous-syntax-table
)
2275 (if (featurep 'xemacs
)
2276 (ad-deactivate 'parse-partial-sexp
))
2282 (defun ada-get-current-indent ()
2283 "Return the indentation to use for the current line."
2288 (orgpoint (save-excursion
2290 (forward-comment -
10000)
2297 ;;-----------------------------
2298 ;; in open parenthesis, but not in parameter-list
2299 ;;-----------------------------
2301 ((and ada-indent-to-open-paren
2302 (not (ada-in-paramlist-p))
2303 (setq column
(ada-in-open-paren-p)))
2305 ;; check if we have something like this (Table_Component_Type =>
2306 ;; Source_File_Record)
2309 ;; Align the closing parenthesis on the opening one
2310 (if (= (following-char) ?\
))
2313 (skip-chars-backward " \t")
2314 (list (1- (point)) 0))
2316 (if (and (skip-chars-backward " \t")
2317 (= (char-before) ?
\n)
2318 (not (forward-comment -
10000))
2319 (= (char-before) ?
>))
2320 ;; ??? Could use a different variable
2321 (list column
'ada-broken-indent
)
2323 ;; We want all continuation lines to be indented the same
2324 ;; (ada-broken-line from the opening parenthesis. However, in
2325 ;; parameter list, each new parameter should be indented at the
2326 ;; column as the opening parenthesis.
2328 ;; A special case to handle nested boolean expressions, as in
2330 ;; and then C) -- indented by ada-broken-indent
2331 ;; or else D) -- indenting this line.
2332 ;; ??? This is really a hack, we should have a proper way to go to
2333 ;; ??? the beginning of the statement
2335 (if (= (char-before) ?\
))
2338 (if (memq (char-before) '(?
, ?\
; ?\( ?\)))
2340 (list column
'ada-continuation-indent
)
2343 ;;---------------------------
2345 ;;---------------------------
2348 (ada-indent-on-previous-lines nil orgpoint orgpoint
))
2350 ;;---------------------------
2352 ;;---------------------------
2354 ((= (downcase (char-after)) ?e
)
2357 ;; ------- end ------
2359 ((looking-at "end\\>")
2363 (ada-goto-matching-start 1)
2366 ;; found 'loop' => skip back to 'while' or 'for'
2367 ;; if 'loop' is not on a separate line
2368 ;; Stop the search for 'while' and 'for' when a ';' is encountered.
2372 (looking-at ".+\\<loop\\>"))
2375 (setq limit
(car (ada-search-ignore-string-comment ";" t
))))
2379 (ada-search-ignore-string-comment ada-loop-start-re t limit
))
2380 (not (looking-at "\\<loop\\>"))))
2382 (goto-char (car match-cons
))
2385 (if (looking-at ada-named-block-re
)
2386 (setq label
(- ada-label-indent
))))))))
2388 ;; found 'record' =>
2389 ;; if the keyword is found at the beginning of a line (or just
2390 ;; after limited, we indent on it, otherwise we indent on the
2391 ;; beginning of the type declaration)
2392 ;; type A is (B : Integer;
2393 ;; C : Integer) is record
2394 ;; end record; -- This is badly indented otherwise
2395 (if (looking-at "record")
2398 (looking-at "^[ \t]*\\(record\\|limited record\\)"))
2399 (list (save-excursion (back-to-indentation) (point)) 0)
2400 (list (save-excursion
2401 (car (ada-search-ignore-string-comment "\\<type\\>" t
)))
2404 ;; Else keep the same indentation as the beginning statement
2405 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0)))))
2407 ;; ------ exception ----
2409 ((looking-at "exception\\>")
2411 (ada-goto-matching-start 1)
2412 (list (save-excursion (back-to-indentation) (point)) 0)))
2416 ((looking-at "else\\>")
2417 (if (save-excursion (ada-goto-previous-word)
2418 (looking-at "\\<or\\>"))
2419 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2421 (ada-goto-matching-start 1 nil t
)
2422 (list (progn (back-to-indentation) (point)) 0))))
2426 ((looking-at "elsif\\>")
2428 (ada-goto-matching-start 1 nil t
)
2429 (list (progn (back-to-indentation) (point)) 0)))
2433 ;;---------------------------
2434 ;; starting with w (when)
2435 ;;---------------------------
2437 ((and (= (downcase (char-after)) ?w
)
2438 (looking-at "when\\>"))
2440 (ada-goto-matching-start 1)
2441 (list (save-excursion (back-to-indentation) (point))
2444 ;;---------------------------
2445 ;; starting with t (then)
2446 ;;---------------------------
2448 ((and (= (downcase (char-after)) ?t
)
2449 (looking-at "then\\>"))
2450 (if (save-excursion (ada-goto-previous-word)
2451 (looking-at "and\\>"))
2452 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2454 ;; Select has been added for the statement: "select ... then abort"
2455 (ada-search-ignore-string-comment
2456 "\\<\\(elsif\\|if\\|select\\)\\>" t nil
)
2457 (list (progn (back-to-indentation) (point))
2458 'ada-stmt-end-indent
))))
2460 ;;---------------------------
2461 ;; starting with l (loop)
2462 ;;---------------------------
2464 ((and (= (downcase (char-after)) ?l
)
2465 (looking-at "loop\\>"))
2468 (goto-char (match-end 0))
2469 (ada-goto-stmt-start)
2470 (if (looking-at "\\<\\(loop\\|if\\)\\>")
2471 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2472 (unless (looking-at ada-loop-start-re
)
2473 (ada-search-ignore-string-comment ada-loop-start-re
2475 (if (looking-at "\\<loop\\>")
2476 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2477 (list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent
)))))
2479 ;;----------------------------
2480 ;; starting with l (limited) or r (record)
2481 ;;----------------------------
2483 ((or (and (= (downcase (char-after)) ?l
)
2484 (looking-at "limited\\>"))
2485 (and (= (downcase (char-after)) ?r
)
2486 (looking-at "record\\>")))
2489 (ada-search-ignore-string-comment
2490 "\\<\\(type\\|use\\)\\>" t nil
)
2491 (if (looking-at "\\<use\\>")
2492 (ada-search-ignore-string-comment "for" t nil nil
2493 'word-search-backward
))
2494 (list (progn (back-to-indentation) (point))
2495 'ada-indent-record-rel-type
)))
2497 ;;---------------------------
2498 ;; starting with b (begin)
2499 ;;---------------------------
2501 ((and (= (downcase (char-after)) ?b
)
2502 (looking-at "begin\\>"))
2504 (if (ada-goto-matching-decl-start t
)
2505 (list (progn (back-to-indentation) (point)) 0)
2506 (ada-indent-on-previous-lines nil orgpoint orgpoint
))))
2508 ;;---------------------------
2509 ;; starting with i (is)
2510 ;;---------------------------
2512 ((and (= (downcase (char-after)) ?i
)
2513 (looking-at "is\\>"))
2515 (if (and ada-indent-is-separate
2517 (goto-char (match-end 0))
2518 (ada-goto-next-non-ws (save-excursion (end-of-line)
2520 (looking-at "\\<abstract\\>\\|\\<separate\\>")))
2522 (ada-goto-stmt-start)
2523 (list (progn (back-to-indentation) (point)) 'ada-indent
))
2525 (ada-goto-stmt-start)
2526 (if (looking-at "\\<package\\|procedure\\|function\\>")
2527 (list (progn (back-to-indentation) (point)) 0)
2528 (list (progn (back-to-indentation) (point)) 'ada-indent
)))))
2530 ;;---------------------------
2531 ;; starting with r (return, renames)
2532 ;;---------------------------
2534 ((and (= (downcase (char-after)) ?r
)
2535 (looking-at "re\\(turn\\|names\\)\\>"))
2538 (let ((var 'ada-indent-return
))
2539 ;; If looking at a renames, skip the 'return' statement too
2540 (if (looking-at "renames")
2543 (set 'pos
(ada-search-ignore-string-comment ";\\|return\\>" t
)))
2545 (= (downcase (char-after (car pos
))) ?r
))
2546 (goto-char (car pos
)))
2547 (set 'var
'ada-indent-renames
)))
2549 (forward-comment -
1000)
2550 (if (= (char-before) ?\
))
2554 ;; If there is a parameter list, and we have a function declaration
2555 ;; or a access to subprogram declaration
2557 (if (and (= (following-char) ?\
()
2561 (looking-at "\\(function\\|procedure\\)\\>"))
2565 (looking-at "\\(function\\|procedure\\)\\>")))))
2567 ;; The indentation depends of the value of ada-indent-return
2568 (if (<= (eval var
) 0)
2569 (list (point) (list '- var
))
2570 (list (progn (backward-word num-back
) (point))
2573 ;; Else there is no parameter list, but we have a function
2574 ;; Only do something special if the user want to indent
2575 ;; relative to the "function" keyword
2576 (if (and (> (eval var
) 0)
2577 (save-excursion (forward-word -
1)
2578 (looking-at "function\\>")))
2579 (list (progn (forward-word -
1) (point)) var
)
2582 (ada-indent-on-previous-lines nil orgpoint orgpoint
)))))))
2584 ;;--------------------------------
2585 ;; starting with 'o' or 'p'
2586 ;; 'or' as statement-start
2587 ;; 'private' as statement-start
2588 ;;--------------------------------
2590 ((and (or (= (downcase (char-after)) ?o
)
2591 (= (downcase (char-after)) ?p
))
2592 (or (ada-looking-at-semi-or)
2593 (ada-looking-at-semi-private)))
2595 ;; ??? Wasn't this done already in ada-looking-at-semi-or ?
2596 (ada-goto-matching-start 1)
2597 (list (progn (back-to-indentation) (point)) 0)))
2599 ;;--------------------------------
2600 ;; starting with 'd' (do)
2601 ;;--------------------------------
2603 ((and (= (downcase (char-after)) ?d
)
2604 (looking-at "do\\>"))
2606 (ada-goto-stmt-start)
2607 (list (progn (back-to-indentation) (point)) 'ada-stmt-end-indent
)))
2609 ;;--------------------------------
2610 ;; starting with '-' (comment)
2611 ;;--------------------------------
2613 ((= (char-after) ?-
)
2614 (if ada-indent-comment-as-code
2616 ;; Indent comments on previous line comments if required
2617 ;; We must use a search-forward (even if the code is more complex),
2618 ;; since we want to find the beginning of the comment.
2621 (if (and ada-indent-align-comments
2625 (while (and (not pos
)
2626 (search-forward "--"
2628 (end-of-line) (point))
2630 (unless (ada-in-string-p)
2631 (setq pos
(point))))
2635 ;; Else always on previous line
2636 (ada-indent-on-previous-lines nil orgpoint orgpoint
)))
2638 ;; Else same indentation as the previous line
2639 (list (save-excursion (back-to-indentation) (point)) 0)))
2641 ;;--------------------------------
2642 ;; starting with '#' (preprocessor line)
2643 ;;--------------------------------
2645 ((and (= (char-after) ?
#)
2646 (equal ada-which-compiler
'gnat
)
2647 (looking-at "#[ \t]*\\(if\\|els\\(e\\|if\\)\\|end[ \t]*if\\)"))
2648 (list (save-excursion (beginning-of-line) (point)) 0))
2650 ;;--------------------------------
2651 ;; starting with ')' (end of a parameter list)
2652 ;;--------------------------------
2654 ((and (not (eobp)) (= (char-after) ?\
)))
2660 ;;---------------------------------
2661 ;; new/abstract/separate
2662 ;;---------------------------------
2664 ((looking-at "\\(new\\|abstract\\|separate\\)\\>")
2665 (ada-indent-on-previous-lines nil orgpoint orgpoint
))
2667 ;;---------------------------------
2668 ;; package/function/procedure
2669 ;;---------------------------------
2671 ((and (or (= (downcase (char-after)) ?p
) (= (downcase (char-after)) ?f
))
2672 (looking-at "\\<\\(package\\|function\\|procedure\\)\\>"))
2674 ;; Go up until we find either a generic section, or the end of the
2675 ;; previous subprogram/package
2677 (while (and (not found
)
2678 (ada-search-ignore-string-comment
2679 "\\<\\(generic\\|end\\|begin\\|package\\|procedure\\|function\\)\\>" t
))
2681 ;; avoid "with procedure"... in generic parts
2684 (setq found
(not (looking-at "with"))))))
2686 (if (looking-at "generic")
2687 (list (progn (back-to-indentation) (point)) 0)
2688 (ada-indent-on-previous-lines nil orgpoint orgpoint
))))
2690 ;;---------------------------------
2692 ;;---------------------------------
2694 ((looking-at "\\(\\sw\\|_\\)+[ \t\n]*:[^=]")
2696 (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2697 (append (ada-indent-on-previous-lines nil orgpoint orgpoint
)
2698 '(ada-label-indent))))
2702 ;;---------------------------------
2704 ;;---------------------------------
2705 (or result
(ada-indent-on-previous-lines nil orgpoint orgpoint
))))
2707 (defun ada-indent-on-previous-lines (&optional nomove orgpoint initial-pos
)
2708 "Calculate the indentation for the new line after ORGPOINT.
2709 The result list is based on the previous lines in the buffer.
2710 If NOMOVE is nil, moves point to the beginning of the current statement.
2711 if INITIAL-POS is non-nil, moves point to INITIAL-POS before calculation."
2713 (goto-char initial-pos
))
2714 (let ((oldpoint (point)))
2716 ;; Is inside a parameter-list ?
2717 (if (ada-in-paramlist-p)
2718 (ada-get-indent-paramlist)
2720 ;; move to beginning of current statement
2722 (ada-goto-stmt-start))
2724 ;; no beginning found => don't change indentation
2725 (if (and (eq oldpoint
(point))
2727 (ada-get-indent-nochange)
2732 ada-indent-to-open-paren
2733 (ada-in-open-paren-p))
2734 (ada-get-indent-open-paren))
2736 ((looking-at "end\\>")
2737 (ada-get-indent-end orgpoint
))
2739 ((looking-at ada-loop-start-re
)
2740 (ada-get-indent-loop orgpoint
))
2742 ((looking-at ada-subprog-start-re
)
2743 (ada-get-indent-subprog orgpoint
))
2745 ((looking-at ada-block-start-re
)
2746 (ada-get-indent-block-start orgpoint
))
2748 ((looking-at "\\(sub\\)?type\\>")
2749 (ada-get-indent-type orgpoint
))
2751 ;; "then" has to be included in the case of "select...then abort"
2752 ;; statements, since (goto-stmt-start) at the beginning of
2753 ;; the current function would leave the cursor on that position
2754 ((looking-at "\\(\\(els\\)?if\\>\\)\\|then abort\\\>")
2755 (ada-get-indent-if orgpoint
))
2757 ((looking-at "case\\>")
2758 (ada-get-indent-case orgpoint
))
2760 ((looking-at "when\\>")
2761 (ada-get-indent-when orgpoint
))
2763 ((looking-at "\\(\\sw\\|_\\)+[ \t\n]*:[^=]")
2764 (ada-get-indent-label orgpoint
))
2766 ((looking-at "separate\\>")
2767 (ada-get-indent-nochange))
2771 (list (+ (save-excursion (back-to-indentation) (point))
2772 (- ada-label-indent
))))
2775 ((looking-at "with\\>\\|use\\>")
2776 ;; Are we still in that statement, or are we in fact looking at
2777 ;; the previous one ?
2778 (if (save-excursion (search-forward ";" oldpoint t
))
2779 (list (progn (back-to-indentation) (point)) 0)
2780 (list (point) (if (looking-at "with")
2785 (ada-get-indent-noindent orgpoint
)))))
2788 (defun ada-get-indent-open-paren ()
2789 "Calculate the indentation when point is behind an unclosed parenthesis."
2790 (list (ada-in-open-paren-p) 0))
2792 (defun ada-get-indent-nochange ()
2793 "Return the current indentation of the previous line."
2796 (back-to-indentation)
2799 (defun ada-get-indent-paramlist ()
2800 "Calculate the indentation when point is inside a parameter list."
2802 (ada-search-ignore-string-comment "[^ \t\n]" t nil t
)
2804 ;; in front of the first parameter
2805 ((= (char-after) ?\
()
2806 (goto-char (match-end 0))
2809 ;; in front of another parameter
2810 ((= (char-after) ?\
;)
2811 (goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t
)))
2812 (ada-goto-next-non-ws)
2815 ;; After an affectation (default parameter value in subprogram
2817 ((and (= (following-char) ?
=) (= (preceding-char) ?
:))
2818 (back-to-indentation)
2819 (list (point) 'ada-broken-indent
))
2821 ;; inside a parameter declaration
2823 (goto-char (cdr (ada-search-ignore-string-comment "(\\|;" t nil t
)))
2824 (ada-goto-next-non-ws)
2825 (list (point) 0)))))
2827 (defun ada-get-indent-end (orgpoint)
2828 "Calculate the indentation when point is just before an end statement.
2829 ORGPOINT is the limit position used in the calculation."
2830 (let ((defun-name nil
)
2833 ;; is the line already terminated by ';' ?
2835 (ada-search-ignore-string-comment ";" nil orgpoint nil
2838 ;; yes, look what's following 'end'
2841 (ada-goto-next-non-ws)
2843 ((looking-at "\\<\\(loop\\|select\\|if\\|case\\)\\>")
2844 (save-excursion (ada-check-matching-start (match-string 0)))
2845 (list (save-excursion (back-to-indentation) (point)) 0))
2848 ;; loop/select/if/case/record/select
2850 ((looking-at "\\<record\\>")
2852 (ada-check-matching-start (match-string 0))
2853 ;; we are now looking at the matching "record" statement
2855 (ada-goto-stmt-start)
2856 ;; now on the matching type declaration, or use clause
2857 (unless (looking-at "\\(for\\|type\\)\\>")
2858 (ada-search-ignore-string-comment "\\<type\\>" t
))
2859 (list (progn (back-to-indentation) (point)) 0)))
2861 ;; a named block end
2863 ((looking-at ada-ident-re
)
2864 (setq defun-name
(match-string 0))
2866 (ada-goto-matching-start 0)
2867 (ada-check-defun-name defun-name
))
2868 (list (progn (back-to-indentation) (point)) 0))
2870 ;; a block-end without name
2872 ((= (char-after) ?\
;)
2874 (ada-goto-matching-start 0)
2875 (if (looking-at "\\<begin\\>")
2877 (setq indent
(list (point) 0))
2878 (if (ada-goto-matching-decl-start t
)
2879 (list (progn (back-to-indentation) (point)) 0)
2881 (list (progn (back-to-indentation) (point)) 0)
2884 ;; anything else - should maybe signal an error ?
2887 (list (save-excursion (back-to-indentation) (point))
2888 'ada-broken-indent
))))
2890 (list (save-excursion (back-to-indentation) (point))
2891 'ada-broken-indent
))))
2893 (defun ada-get-indent-case (orgpoint)
2894 "Calculate the indentation when point is just before a case statement.
2895 ORGPOINT is the limit position used in the calculation."
2896 (let ((match-cons nil
)
2900 ;; case..is..when..=>
2903 (setq match-cons
(and
2904 ;; the `=>' must be after the keyword `is'.
2905 (ada-search-ignore-string-comment
2906 "is" nil orgpoint nil
'word-search-forward
)
2907 (ada-search-ignore-string-comment
2908 "[ \t\n]+=>" nil orgpoint
))))
2910 (goto-char (car match-cons
))
2911 (unless (ada-search-ignore-string-comment "when" t opos
)
2912 (error "Missing 'when' between 'case' and '=>'"))
2913 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)))
2918 (setq match-cons
(ada-search-ignore-string-comment
2919 "when" nil orgpoint nil
'word-search-forward
)))
2920 (goto-char (cdr match-cons
))
2921 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
2926 (setq match-cons
(ada-search-ignore-string-comment
2927 "is" nil orgpoint nil
'word-search-forward
)))
2928 (list (save-excursion (back-to-indentation) (point)) 'ada-when-indent
))
2933 (list (save-excursion (back-to-indentation) (point))
2934 'ada-broken-indent
)))))
2936 (defun ada-get-indent-when (orgpoint)
2937 "Calculate the indentation when point is just before a when statement.
2938 ORGPOINT is the limit position used in the calculation."
2939 (let ((cur-indent (save-excursion (back-to-indentation) (point))))
2940 (if (ada-search-ignore-string-comment "[ \t\n]*=>" nil orgpoint
)
2941 (list cur-indent
'ada-indent
)
2942 (list cur-indent
'ada-broken-indent
))))
2944 (defun ada-get-indent-if (orgpoint)
2945 "Calculate the indentation when point is just before an if statement.
2946 ORGPOINT is the limit position used in the calculation."
2947 (let ((cur-indent (save-excursion (back-to-indentation) (point)))
2950 ;; Move to the correct then (ignore all "and then")
2952 (while (and (setq match-cons
(ada-search-ignore-string-comment
2953 "\\<\\(then\\|and[ \t]*then\\)\\>"
2955 (= (downcase (char-after (car match-cons
))) ?a
)))
2956 ;; If "then" was found (we are looking at it)
2960 ;; 'then' first in separate line ?
2961 ;; => indent according to 'then',
2962 ;; => else indent according to 'if'
2965 (back-to-indentation)
2966 (looking-at "\\<then\\>"))
2967 (setq cur-indent
(save-excursion (back-to-indentation) (point))))
2970 (list cur-indent
'ada-indent
))
2972 (list cur-indent
'ada-broken-indent
))))
2974 (defun ada-get-indent-block-start (orgpoint)
2975 "Calculate the indentation when point is at the start of a block.
2976 ORGPOINT is the limit position used in the calculation."
2981 (setq pos
(ada-goto-next-non-ws orgpoint
)))
2984 (ada-indent-on-previous-lines t orgpoint
)))
2986 ;; Special case for record types, for instance for:
2987 ;; type A is (B : Integer;
2988 ;; C : Integer) is record
2989 ;; null; -- This is badly indented otherwise
2990 ((looking-at "record")
2992 ;; If record is at the beginning of the line, indent from there
2995 (looking-at "^[ \t]*\\(record\\|limited record\\)"))
2996 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)
2998 ;; else indent relative to the type command
2999 (list (save-excursion
3000 (car (ada-search-ignore-string-comment "\\<type\\>" t
)))
3003 ;; nothing follows the block-start
3005 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
)))))
3007 (defun ada-get-indent-subprog (orgpoint)
3008 "Calculate the indentation when point is just before a subprogram.
3009 ORGPOINT is the limit position used in the calculation."
3010 (let ((match-cons nil
)
3011 (cur-indent (save-excursion (back-to-indentation) (point)))
3014 ;; is there an 'is' in front of point ?
3018 (ada-search-ignore-string-comment
3019 "\\<\\(is\\|do\\)\\>" nil orgpoint
)))
3021 ;; yes, then skip to its end
3025 (goto-char (cdr match-cons
)))
3027 ;; no, then goto next non-ws, if there is one in front of point
3030 (unless (ada-goto-next-non-ws orgpoint
)
3031 (goto-char orgpoint
))))
3035 ;; nothing follows 'is'
3040 (not (ada-search-ignore-string-comment
3041 "[^ \t\n]" nil orgpoint t
))))
3042 (list cur-indent
'ada-indent
))
3044 ;; is abstract/separate/new ...
3050 (ada-search-ignore-string-comment
3051 "\\<\\(separate\\|new\\|abstract\\)\\>"
3053 (goto-char (car match-cons
))
3054 (ada-search-ignore-string-comment ada-subprog-start-re t
)
3055 (ada-get-indent-noindent orgpoint
))
3057 ;; something follows 'is'
3061 (save-excursion (setq match-cons
(ada-goto-next-non-ws orgpoint
)))
3062 (goto-char match-cons
)
3063 (ada-indent-on-previous-lines t orgpoint
)))
3068 (ada-search-ignore-string-comment ";" nil orgpoint nil
'search-forward
))
3069 (list cur-indent
0))
3074 (list cur-indent
'ada-broken-indent
)))))
3076 (defun ada-get-indent-noindent (orgpoint)
3077 "Calculate the indentation when point is just before a 'noindent stmt'.
3078 ORGPOINT is the limit position used in the calculation."
3085 ;; This one is called when indenting a line preceded by a multi-line
3086 ;; subprogram declaration (in that case, we are at this point inside
3087 ;; the parameter declaration list)
3088 ((ada-in-paramlist-p)
3089 (ada-previous-procedure)
3090 (list (save-excursion (back-to-indentation) (point)) 0))
3092 ;; This one is called when indenting the second line of a multi-line
3093 ;; declaration section, in a declare block or a record declaration
3094 ((looking-at "[ \t]*\\(\\sw\\|_\\)*[ \t]*,[ \t]*$")
3095 (list (save-excursion (back-to-indentation) (point))
3096 'ada-broken-decl-indent
))
3098 ;; This one is called in every over case when indenting a line at the
3101 (if (looking-at ada-named-block-re
)
3102 (setq label
(- ada-label-indent
))
3106 ;; "with private" or "null record" cases
3107 (if (or (save-excursion
3108 (and (ada-search-ignore-string-comment "\\<private\\>" nil orgpoint
)
3110 (save-excursion (forward-char -
7);; skip back "private"
3111 (ada-goto-previous-word)
3112 (looking-at "with"))))
3114 (and (ada-search-ignore-string-comment "\\<record\\>" nil orgpoint
)
3116 (save-excursion (forward-char -
6);; skip back "record"
3117 (ada-goto-previous-word)
3118 (looking-at "null")))))
3121 (re-search-backward "\\<\\(type\\|subtype\\)\\>" nil t
)
3122 (list (save-excursion (back-to-indentation) (point)) 0)))))
3124 (ada-search-ignore-string-comment ";" nil orgpoint nil
3126 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0)
3127 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3128 'ada-broken-indent
)))))))
3130 (defun ada-get-indent-label (orgpoint)
3131 "Calculate the indentation when before a label or variable declaration.
3132 ORGPOINT is the limit position used in the calculation."
3133 (let ((match-cons nil
)
3134 (cur-indent (save-excursion (back-to-indentation) (point))))
3135 (ada-search-ignore-string-comment ":" nil
)
3139 (setq match-cons
(ada-search-ignore-string-comment
3140 ada-loop-start-re nil orgpoint
)))
3141 (goto-char (car match-cons
))
3142 (ada-get-indent-loop orgpoint
))
3146 (setq match-cons
(ada-search-ignore-string-comment
3147 "\\<declare\\|begin\\>" nil orgpoint
)))
3148 (goto-char (car match-cons
))
3149 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3151 ;; variable declaration
3154 (ada-search-ignore-string-comment ";" nil orgpoint
))
3156 (list cur-indent
'ada-broken-indent
)))
3158 ;; nothing follows colon
3160 (list cur-indent
'(- ada-label-indent
))))))
3162 (defun ada-get-indent-loop (orgpoint)
3163 "Calculate the indentation when just before a loop or a for ... use.
3164 ORGPOINT is the limit position used in the calculation."
3165 (let ((match-cons nil
)
3168 ;; If looking at a named block, skip the label
3169 (label (save-excursion
3171 (if (looking-at ada-named-block-re
)
3172 (- ada-label-indent
)
3178 ;; statement complete
3181 (ada-search-ignore-string-comment ";" nil orgpoint nil
3183 (list (+ (save-excursion (back-to-indentation) (point)) label
) 0))
3187 ((looking-at "loop\\>")
3188 (setq pos
(ada-get-indent-block-start orgpoint
))
3191 (list (+ (car pos
) label
) (cdr pos
))))
3194 ;; 'for'- loop (or also a for ... use statement)
3196 ((looking-at "for\\>")
3203 (goto-char (match-end 0))
3204 (ada-goto-next-non-ws orgpoint
)
3206 (if (= (char-after) ?
') (forward-word 1) t
)
3207 (ada-goto-next-non-ws orgpoint
)
3208 (looking-at "\\<use\\>")
3210 ;; check if there is a 'record' before point
3213 (setq match-cons
(ada-search-ignore-string-comment
3214 "record" nil orgpoint nil
'word-search-forward
))
3218 (goto-char (car match-cons
))
3219 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3220 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
3227 (setq match-cons
(ada-search-ignore-string-comment
3228 "loop" nil orgpoint nil
'word-search-forward
)))
3229 (goto-char (car match-cons
))
3231 ;; indent according to 'loop', if it's first in the line;
3232 ;; otherwise to 'for'
3234 (unless (save-excursion
3235 (back-to-indentation)
3236 (looking-at "\\<loop\\>"))
3238 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3241 ;; for-statement is broken
3244 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3245 'ada-broken-indent
))))
3250 ((looking-at "while\\>")
3255 (setq match-cons
(ada-search-ignore-string-comment
3256 "loop" nil orgpoint nil
'word-search-forward
)))
3259 (goto-char (car match-cons
))
3261 ;; indent according to 'loop', if it's first in the line;
3262 ;; otherwise to 'while'.
3264 (unless (save-excursion
3265 (back-to-indentation)
3266 (looking-at "\\<loop\\>"))
3268 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3271 (list (+ (save-excursion (back-to-indentation) (point)) label
)
3272 'ada-broken-indent
))))))
3274 (defun ada-get-indent-type (orgpoint)
3275 "Calculate the indentation when before a type statement.
3276 ORGPOINT is the limit position used in the calculation."
3277 (let ((match-dat nil
))
3280 ;; complete record declaration
3284 (setq match-dat
(ada-search-ignore-string-comment
3285 "end" nil orgpoint nil
'word-search-forward
))
3286 (ada-goto-next-non-ws)
3287 (looking-at "\\<record\\>")
3289 (ada-goto-next-non-ws)
3290 (= (char-after) ?\
;)))
3291 (goto-char (car match-dat
))
3292 (list (save-excursion (back-to-indentation) (point)) 0))
3297 (setq match-dat
(ada-search-ignore-string-comment
3298 "record" nil orgpoint nil
'word-search-forward
)))
3299 (goto-char (car match-dat
))
3300 (list (save-excursion (back-to-indentation) (point)) 'ada-indent
))
3302 ;; complete type declaration
3305 (ada-search-ignore-string-comment ";" nil orgpoint nil
3307 (list (save-excursion (back-to-indentation) (point)) 0))
3309 ;; "type ... is", but not "type ... is ...", which is broken
3313 (ada-search-ignore-string-comment "is" nil orgpoint nil
3314 'word-search-forward
)
3315 (not (ada-goto-next-non-ws orgpoint
))))
3316 (list (save-excursion (back-to-indentation) (point)) 'ada-broken-indent
))
3321 (list (save-excursion (back-to-indentation) (point))
3322 'ada-broken-indent
)))))
3325 ;; -----------------------------------------------------------
3326 ;; -- searching and matching
3327 ;; -----------------------------------------------------------
3329 (defun ada-goto-stmt-start ()
3330 "Move point to the beginning of the statement that point is in or after.
3331 Return the new position of point.
3332 As a special case, if we are looking at a closing parenthesis, skip to the
3334 (let ((match-dat nil
)
3337 (setq match-dat
(ada-search-prev-end-stmt))
3341 ;; found a previous end-statement => check if anything follows
3343 (unless (looking-at "declare")
3345 (unless (save-excursion
3346 (goto-char (cdr match-dat
))
3347 (ada-goto-next-non-ws orgpoint
))
3349 ;; nothing follows => it's the end-statement directly in
3350 ;; front of point => search again
3352 (setq match-dat
(ada-search-prev-end-stmt)))
3354 ;; if found the correct end-statement => goto next non-ws
3357 (goto-char (cdr match-dat
)))
3358 (ada-goto-next-non-ws)
3362 ;; no previous end-statement => we are at the beginning of the
3363 ;; accessible part of the buffer
3366 (goto-char (point-min))
3368 ;; skip to the very first statement, if there is one
3370 (unless (ada-goto-next-non-ws orgpoint
)
3371 (goto-char orgpoint
))))
3375 (defun ada-search-prev-end-stmt ()
3376 "Move point to previous end statement.
3377 Return a cons cell whose car is the beginning and whose cdr
3378 is the end of the match."
3379 (let ((match-dat nil
)
3382 ;; search until found or beginning-of-buffer
3386 (setq match-dat
(ada-search-ignore-string-comment
3387 ada-end-stmt-re t
)))
3389 (goto-char (car match-dat
))
3390 (unless (ada-in-open-paren-p)
3394 "\\<\\(record\\|loop\\|select\\|else\\|then\\)\\>")
3396 (ada-goto-previous-word)
3397 (looking-at "\\<\\(end\\|or\\|and\\)\\>[ \t]*[^;]")))
3402 (and (save-excursion (ada-goto-previous-word)
3403 (ada-goto-previous-word)
3404 (not (looking-at "subtype")))
3406 (save-excursion (goto-char (cdr match-dat
))
3407 (ada-goto-next-non-ws)
3408 ;; words that can go after an 'is'
3413 '("separate" "access" "array"
3414 "private" "abstract" "new") t
)
3417 ((looking-at "private")
3420 (setq found
(not (looking-at "is")))))
3431 (defun ada-goto-next-non-ws (&optional limit
)
3432 "Skip white spaces, newlines and comments to next non-ws character.
3433 Stop the search at LIMIT.
3434 Do not call this function from within a string."
3436 (setq limit
(point-max)))
3437 (while (and (<= (point) limit
)
3438 (progn (forward-comment 10000)
3439 (if (and (not (eobp))
3440 (save-excursion (forward-char 1)
3442 (progn (forward-sexp 1) t
)))))
3443 (if (< (point) limit
)
3449 (defun ada-goto-stmt-end (&optional limit
)
3450 "Move point to the end of the statement that point is in or before.
3451 Return the new position of point or nil if not found.
3452 Stop the search at LIMIT."
3453 (if (ada-search-ignore-string-comment ada-end-stmt-re nil limit
)
3458 (defun ada-goto-next-word (&optional backward
)
3459 "Move point to the beginning of the next word of Ada code.
3460 If BACKWARD is non-nil, jump to the beginning of the previous word.
3461 Return the new position of point or nil if not found."
3462 (let ((match-cons nil
)
3464 (old-syntax (char-to-string (char-syntax ?_
))))
3465 (modify-syntax-entry ?_
"w")
3467 (skip-syntax-forward "w"))
3468 (if (setq match-cons
3470 (ada-search-ignore-string-comment "\\w" t nil t
)
3471 (ada-search-ignore-string-comment "\\w" nil nil t
)))
3473 ;; move to the beginning of the word found
3476 (goto-char (car match-cons
))
3477 (skip-syntax-backward "w")
3480 ;; if not found, restore old position of point
3482 (goto-char orgpoint
)
3484 (modify-syntax-entry ?_ old-syntax
))
3488 (defun ada-check-matching-start (keyword)
3489 "Signal an error if matching block start is not KEYWORD.
3490 Moves point to the matching block start."
3491 (ada-goto-matching-start 0)
3492 (unless (looking-at (concat "\\<" keyword
"\\>"))
3493 (error "Matching start is not '%s'" keyword
)))
3496 (defun ada-check-defun-name (defun-name)
3497 "Check if the name of the matching defun really is DEFUN-NAME.
3498 Assumes point to be already positioned by `ada-goto-matching-start'.
3499 Moves point to the beginning of the declaration."
3501 ;; named block without a `declare'; ada-goto-matching-start leaves
3502 ;; point at start of 'begin' for a block.
3504 (ada-goto-previous-word)
3505 (looking-at (concat "\\<" defun-name
"\\> *:")))
3509 ;; 'accept' or 'package' ?
3511 (unless (looking-at ada-subprog-start-re
)
3512 (ada-goto-matching-decl-start))
3514 ;; 'begin' of 'procedure'/'function'/'task' or 'declare'
3518 ;; a named 'declare'-block ? => jump to the label
3520 (if (looking-at "\\<declare\\>")
3522 (forward-comment -
1)
3525 ;; no, => 'procedure'/'function'/'task'/'protected'
3531 ;; skip 'body' 'type'
3533 (if (looking-at "\\<\\(body\\|type\\)\\>")
3538 ;; should be looking-at the correct name
3540 (unless (looking-at (concat "\\<" defun-name
"\\>"))
3541 (error "Matching defun has different name: %s"
3542 (buffer-substring (point)
3543 (progn (forward-sexp 1) (point))))))))
3545 (defun ada-goto-matching-decl-start (&optional noerror recursive
)
3546 "Move point to the matching declaration start of the current 'begin'.
3547 If NOERROR is non-nil, it only returns nil if no match was found."
3548 (let ((nest-count 1)
3550 ;; first should be set to t if we should stop at the first
3551 ;; "begin" we encounter.
3552 (first (not recursive
))
3557 ;; Ignore "when" most of the time, except if we are looking at the
3558 ;; beginning of a block (structure: case .. is
3562 (if (looking-at "begin")
3563 (setq stop-at-when t
))
3566 (looking-at "\\<\\(package\\|procedure\\|function\\)\\>")
3568 (ada-search-ignore-string-comment
3569 "\\<\\(package\\|procedure\\|function\\|generic\\)\\>" t
)
3570 (looking-at "generic")))
3571 (setq count-generic t
))
3573 ;; search backward for interesting keywords
3575 (not (zerop nest-count
))
3576 (ada-search-ignore-string-comment ada-matching-decl-start-re t
))
3578 ;; calculate nest-depth
3583 (ada-goto-matching-start 1 noerror
)
3585 ;; In some case, two begin..end block can follow each other closely,
3586 ;; which we have to detect, as in
3591 ;; begin -- here we should go to procedure, not begin
3594 (if (looking-at "begin")
3595 (let ((loop-again t
))
3598 ;; If begin was just there as the beginning of a block
3599 ;; (with no declare) then do nothing, otherwise just
3600 ;; register that we have to find the statement that
3601 ;; required the begin
3603 (ada-search-ignore-string-comment
3604 "\\<\\(declare\\|begin\\|end\\|procedure\\|function\\|task\\|package\\)\\>"
3607 (if (looking-at "end")
3608 (ada-goto-matching-start 1 noerror t
)
3609 ;; (ada-goto-matching-decl-start 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 ;; check if it is only a type definition, but not a protected
3638 ;; type definition, which should be handled like a procedure.
3639 (if (or (looking-at "is[ \t]+<>")
3641 (forward-comment -
10000)
3644 ;; Detect if we have a closing parenthesis (Could be
3645 ;; either the end of subprogram parameters or (<>)
3646 ;; in a type definition
3647 (if (= (char-after) ?\
))
3651 (forward-comment -
10000)
3653 (skip-chars-backward "a-zA-Z0-9_.'")
3654 (ada-goto-previous-word)
3656 (looking-at "\\<\\(sub\\)?type\\|case\\>")
3658 (ada-goto-previous-word)
3659 (not (looking-at "\\<protected\\>"))))
3661 (goto-char (match-beginning 0))
3663 (setq nest-count
(1- nest-count
))
3669 (ada-goto-previous-word)
3671 (goto-char (match-beginning 0))))
3674 (looking-at "begin"))
3675 (setq nest-count
0))
3677 ((looking-at "when")
3680 (unless (looking-at "\\<exit[ \t\n]*when\\>")
3683 (setq nest-count
(1- nest-count
)))
3686 ((looking-at "begin")
3690 (setq nest-count
(1+ nest-count
))
3695 ;; check if declaration-start is really found
3698 (if (looking-at "is")
3699 (ada-search-ignore-string-comment ada-subprog-start-re t
)
3700 (looking-at "declare\\|generic")))
3703 (error "No matching proc/func/task/declare/package/protected")))
3706 (defun ada-goto-matching-start (&optional nest-level noerror gotothen
)
3707 "Move point to the beginning of a block-start.
3708 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3709 If NOERROR is non-nil, it only returns nil if no matching start was found.
3710 If GOTOTHEN is non-nil, point moves to the 'then' following 'if'."
3711 (let ((nest-count (if nest-level nest-level
0))
3714 (last-was-begin '())
3715 ;; List all keywords encountered while traversing
3716 ;; something like '("end" "end" "begin")
3717 ;; This is removed from the list when "package", "procedure",...
3718 ;; are seen. The goal is to find whether a package has an elaboration
3723 ;; search backward for interesting keywords
3726 (ada-search-ignore-string-comment ada-matching-start-re t
))
3728 (unless (and (looking-at "\\<record\\>")
3731 (looking-at "\\<null\\>")))
3733 ;; calculate nest-depth
3735 ;; found block end => increase nest depth
3737 (push nil last-was-begin
)
3738 (setq nest-count
(1+ nest-count
)))
3740 ;; found loop/select/record/case/if => check if it starts or
3742 ((looking-at "loop\\|select\\|record\\|case\\|if")
3745 ;; check if keyword follows 'end'
3746 (ada-goto-previous-word)
3747 (if (looking-at "\\<end\\>[ \t]*[^;]")
3749 ;; it ends a block => increase nest depth
3750 (setq nest-count
(1+ nest-count
)
3752 (push nil last-was-begin
))
3754 ;; it starts a block => decrease nest depth
3755 (setq nest-count
(1- nest-count
))
3757 ;; Some nested "begin .. end" blocks with no "declare"?
3758 ;; => remove those entries
3759 (while (car last-was-begin
)
3760 (setq last-was-begin
(cdr (cdr last-was-begin
))))
3762 (setq last-was-begin
(cdr last-was-begin
))
3767 ;; found package start => check if it really is a block
3768 ((looking-at "package")
3770 ;; ignore if this is just a renames statement
3771 (let ((current (point))
3772 (pos (ada-search-ignore-string-comment
3773 "\\<\\(is\\|renames\\|;\\)\\>" nil
)))
3775 (goto-char (car pos
))
3777 "No matching 'is' or 'renames' for 'package' at"
3779 (number-to-string (count-lines 1 (1+ current
)))))))
3780 (unless (looking-at "renames")
3783 (ada-goto-next-non-ws)
3784 ;; ignore it if it is only a declaration with 'new'
3785 ;; We could have package Foo is new ....
3786 ;; or package Foo is separate;
3787 ;; or package Foo is begin null; end Foo
3788 ;; for elaboration code (elaboration)
3789 (if (and (not (looking-at "\\<\\(new\\|separate\\|begin\\)\\>"))
3790 (not (car last-was-begin
)))
3791 (setq nest-count
(1- nest-count
))))))
3793 (setq last-was-begin
(cdr last-was-begin
))
3795 ;; found task start => check if it has a body
3796 ((looking-at "task")
3799 (ada-goto-next-non-ws)
3801 ((looking-at "\\<body\\>"))
3802 ((looking-at "\\<type\\>")
3803 ;; In that case, do nothing if there is a "is"
3804 (forward-word 2);; skip "type"
3805 (ada-goto-next-non-ws);; skip type name
3807 ;; Do nothing if we are simply looking at a simple
3808 ;; "task type name;" statement with no block
3809 (unless (looking-at ";")
3811 ;; Skip the parameters
3812 (if (looking-at "(")
3813 (ada-search-ignore-string-comment ")" nil
))
3814 (let ((tmp (ada-search-ignore-string-comment
3815 "\\<\\(is\\|;\\)\\>" nil
)))
3818 (goto-char (car tmp
))
3819 (if (looking-at "is")
3820 (setq nest-count
(1- nest-count
)))))))))
3822 ;; Check if that task declaration had a block attached to
3823 ;; it (i.e do nothing if we have just "task name;")
3824 (unless (progn (forward-word 1)
3825 (looking-at "[ \t]*;"))
3826 (setq nest-count
(1- nest-count
))))))
3827 (setq last-was-begin
(cdr last-was-begin
))
3830 ((looking-at "declare")
3831 ;; remove entry for begin and end (include nested begin..end
3833 (setq last-was-begin
(cdr last-was-begin
))
3835 (while (and (> count
0))
3836 (if (equal (car last-was-begin
) t
)
3837 (setq count
(1+ count
))
3838 (setq count
(1- count
)))
3839 (setq last-was-begin
(cdr last-was-begin
))
3842 ((looking-at "protected")
3843 ;; Ignore if this is just a declaration
3845 (let ((pos (ada-search-ignore-string-comment
3846 "\\(\\<is\\>\\|\\<renames\\>\\|;\\)" nil
)))
3848 (goto-char (car pos
)))
3849 (if (looking-at "is")
3850 ;; remove entry for end
3851 (setq last-was-begin
(cdr last-was-begin
)))))
3852 (setq nest-count
(1- nest-count
)))
3854 ((or (looking-at "procedure")
3855 (looking-at "function"))
3856 ;; Ignore if this is just a declaration
3858 (let ((pos (ada-search-ignore-string-comment
3859 "\\(\\<is\\>\\|\\<renames\\>\\|)[ \t]*;\\)" nil
)))
3861 (goto-char (car pos
)))
3862 (if (looking-at "is")
3863 ;; remove entry for begin and end
3864 (setq last-was-begin
(cdr (cdr last-was-begin
))))))
3867 ;; all the other block starts
3869 (push (looking-at "begin") last-was-begin
)
3870 (setq nest-count
(1- nest-count
)))
3874 ;; match is found, if nest-depth is zero
3875 (setq found
(zerop nest-count
))))) ; end of loop
3881 ;; match found => is there anything else to do ?
3886 ;; found 'if' => skip to 'then', if it's on a separate line
3887 ;; and GOTOTHEN is non-nil
3893 (ada-search-ignore-string-comment "then" nil nil nil
3894 'word-search-forward
)
3895 (back-to-indentation)
3896 (looking-at "\\<then\\>")))
3897 (goto-char (match-beginning 0)))
3900 ;; found 'do' => skip back to 'accept'
3903 (unless (ada-search-ignore-string-comment
3905 'word-search-backward
)
3906 (error "Missing 'accept' in front of 'do'"))))
3911 (error "No matching start"))))))
3914 (defun ada-goto-matching-end (&optional nest-level noerror
)
3915 "Move point to the end of a block.
3916 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3917 If NOERROR is non-nil, it only returns nil if no matching start found."
3918 (let ((nest-count (or nest-level
0))
3919 (regex (eval-when-compile
3921 (regexp-opt '("end" "loop" "select" "begin" "case"
3922 "if" "task" "package" "record" "do"
3923 "procedure" "function") t
)
3928 ;; First is used for subprograms: they are generally handled
3929 ;; recursively, but of course we do not want to do that the
3930 ;; first time (see comment below about subprograms)
3931 (first (not (looking-at "declare"))))
3933 ;; If we are already looking at one of the keywords, this shouldn't count
3934 ;; in the nesting loop below, so we just make sure we don't count it.
3935 ;; "declare" is a special case because we need to look after the "begin"
3937 (if (looking-at "\\<if\\|loop\\|case\\|begin\\>")
3941 ;; search forward for interesting keywords
3945 (ada-search-ignore-string-comment regex nil
))
3948 ;; calculate nest-depth
3952 ;; procedures and functions need to be processed recursively, in
3953 ;; case they are defined in a declare/begin block, as in:
3954 ;; declare -- NL 0 (nested level)
3956 ;; procedure B (C : D) is
3959 ;; end B; -- NL 0, and we would exit
3961 ;; end; -- we should exit here
3962 ;; processing them recursively avoids the need for any special
3964 ;; Nothing should be done if we have only the specs or a
3965 ;; generic instantion.
3967 ((and (looking-at "\\<procedure\\|function\\>"))
3972 (ada-search-ignore-string-comment "is\\|;")
3973 (if (= (char-before) ?s
)
3975 (ada-goto-next-non-ws)
3976 (unless (looking-at "\\<new\\>")
3979 (ada-goto-matching-end 0 t
)))))))
3981 ;; found block end => decrease nest depth
3982 ((looking-at "\\<end\\>")
3983 (setq nest-count
(1- nest-count
)
3984 found
(<= nest-count
0))
3985 ;; skip the following keyword
3987 (skip-chars-forward "end")
3988 (ada-goto-next-non-ws)
3989 (looking-at "\\<\\(loop\\|select\\|record\\|case\\|if\\)\\>"))
3992 ;; found package start => check if it really starts a block, and is not
3993 ;; in fact a generic instantiation for instance
3994 ((looking-at "\\<package\\>")
3995 (ada-search-ignore-string-comment "is" nil nil nil
3996 'word-search-forward
)
3997 (ada-goto-next-non-ws)
3998 ;; ignore and skip it if it is only a 'new' package
3999 (if (looking-at "\\<new\\>")
4000 (goto-char (match-end 0))
4001 (setq nest-count
(1+ nest-count
)
4002 found
(<= nest-count
0))))
4004 ;; all the other block starts
4007 (setq nest-count
(1+ nest-count
)))
4008 (setq found
(<= nest-count
0))
4009 (forward-word 1))) ; end of 'cond'
4017 (error "No matching end")))
4021 (defun ada-search-ignore-string-comment
4022 (search-re &optional backward limit paramlists search-func
)
4023 "Regexp-search for SEARCH-RE, ignoring comments, strings.
4024 Returns a cons cell of begin and end of match data or nil, if not found.
4025 If BACKWARD is non-nil, search backward; search forward otherwise.
4026 The search stops at pos LIMIT.
4027 If PARAMLISTS is nil, ignore parameter lists.
4028 The search is done using SEARCH-FUNC. SEARCH-FUNC can be optimized
4029 in case we are searching for a constant string.
4030 Point is moved at the beginning of the SEARCH-RE."
4035 (previous-syntax-table (syntax-table)))
4037 ;; FIXME: need to pass BACKWARD to search-func!
4039 (setq search-func
(if backward
're-search-backward
're-search-forward
)))
4042 ;; search until found or end-of-buffer
4043 ;; We have to test that we do not look further than limit
4045 (set-syntax-table ada-mode-symbol-syntax-table
)
4046 (while (and (not found
)
4048 (or (and backward
(<= limit
(point)))
4049 (>= limit
(point))))
4050 (funcall search-func search-re limit
1))
4051 (setq begin
(match-beginning 0))
4052 (setq end
(match-end 0))
4054 (setq parse-result
(parse-partial-sexp
4055 (save-excursion (beginning-of-line) (point))
4060 ;; If inside a string, skip it (and the following comments)
4062 ((ada-in-string-p parse-result
)
4063 (if (featurep 'xemacs
)
4064 (search-backward "\"" nil t
)
4065 (goto-char (nth 8 parse-result
)))
4066 (unless backward
(forward-sexp 1)))
4068 ;; If inside a comment, skip it (and the following comments)
4069 ;; There is a special code for comments at the end of the file
4071 ((ada-in-comment-p parse-result
)
4072 (if (featurep 'xemacs
)
4076 (forward-comment -
1))
4077 (goto-char (nth 8 parse-result
)))
4079 ;; at the end of the file, it is not possible to skip a comment
4080 ;; so we just go at the end of the line
4081 (if (forward-comment 1)
4083 (forward-comment 1000)
4084 (beginning-of-line))
4087 ;; directly in front of a comment => skip it, if searching forward
4089 ((and (= (char-after begin
) ?-
) (= (char-after (1+ begin
)) ?-
))
4090 (unless backward
(progn (forward-char -
1) (forward-comment 1000))))
4093 ;; found a parameter-list but should ignore it => skip it
4095 ((and (not paramlists
) (ada-in-paramlist-p))
4097 (search-backward "(" nil t
)
4098 (search-forward ")" nil t
)))
4100 ;; found what we were looking for
4103 (setq found t
)))) ; end of loop
4105 (set-syntax-table previous-syntax-table
)
4111 ;; -------------------------------------------------------
4112 ;; -- Testing the position of the cursor
4113 ;; -------------------------------------------------------
4115 (defun ada-in-decl-p ()
4116 "Return t if point is inside a declarative part.
4117 Assumes point to be at the end of a statement."
4118 (or (ada-in-paramlist-p)
4120 (ada-goto-matching-decl-start t
))))
4123 (defun ada-looking-at-semi-or ()
4124 "Return t if looking at an 'or' following a semicolon."
4126 (and (looking-at "\\<or\\>")
4129 (ada-goto-stmt-start)
4130 (looking-at "\\<or\\>")))))
4133 (defun ada-looking-at-semi-private ()
4134 "Return t if looking at the start of a private section in a package.
4135 Return nil if the private is part of the package name, as in
4136 'private package A is...' (this can only happen at top level)."
4138 (and (looking-at "\\<private\\>")
4139 (not (looking-at "\\<private[ \t]*\\(package\\|generic\\)"))
4141 ;; Make sure this is the start of a private section (ie after
4142 ;; a semicolon or just after the package declaration, but not
4143 ;; after a 'type ... is private' or 'is new ... with private'
4145 ;; Note that a 'private' statement at the beginning of the buffer
4146 ;; does not indicate a private section, since this is instead a
4147 ;; 'private procedure ...'
4148 (progn (forward-comment -
1000)
4150 (or (= (char-before) ?\
;)
4151 (and (forward-word -
3)
4152 (looking-at "\\<package\\>"))))))))
4155 (defun ada-in-paramlist-p ()
4156 "Return t if point is inside a parameter-list."
4159 (ada-search-ignore-string-comment "(\\|)" t nil t
)
4160 ;; inside parentheses ?
4161 (= (char-after) ?\
()
4163 ;; We could be looking at two things here:
4164 ;; operator definition: function "." (
4165 ;; subprogram definition: procedure .... (
4166 ;; Let's skip back over the first one
4168 (skip-chars-backward " \t\n")
4169 (if (= (char-before) ?
\")
4174 ;; and now over the second one
4177 ;; We should ignore the case when the reserved keyword is in a
4178 ;; comment (for instance, when we have:
4181 ;; we should return nil
4183 (not (ada-in-string-or-comment-p))
4185 ;; right keyword two words before parenthesis ?
4186 ;; Type is in this list because of discriminants
4187 (looking-at (eval-when-compile
4189 "procedure\\|function\\|body\\|"
4190 "task\\|entry\\|accept\\|"
4191 "access[ \t]+procedure\\|"
4192 "access[ \t]+function\\|"
4196 (defun ada-search-ignore-complex-boolean (regexp backwardp
)
4197 "Search for REGEXP, ignoring comments, strings, 'and then', 'or else'.
4198 If BACKWARDP is non-nil, search backward; search forward otherwise."
4200 (while (and (setq result
(ada-search-ignore-string-comment regexp backwardp
))
4201 (save-excursion (forward-word -
1)
4202 (looking-at "and then\\|or else"))))
4205 (defun ada-in-open-paren-p ()
4206 "Non-nil if in an open parenthesis.
4207 Return value is the position of the first non-ws behind the last unclosed
4208 parenthesis, or nil."
4210 (let ((parse (parse-partial-sexp
4212 (or (car (ada-search-ignore-complex-boolean
4213 "\\<\\(;\\|is\\|then\\|loop\\|begin\\|else\\)\\>"
4219 (goto-char (1+ (nth 1 parse
)))
4221 ;; Skip blanks, if they are not followed by a comment
4223 ;; type A is ( Value_0,
4225 ;; type B is ( -- comment
4228 (if (or (not ada-indent-handle-comment-special
)
4229 (not (looking-at "[ \t]+--")))
4230 (skip-chars-forward " \t"))
4235 ;; -----------------------------------------------------------
4236 ;; -- Behavior Of TAB Key
4237 ;; -----------------------------------------------------------
4240 "Do indenting or tabbing according to `ada-tab-policy'.
4241 In Transient Mark mode, if the mark is active, operate on the contents
4242 of the region. Otherwise, operate only on the current line."
4244 (cond ((eq ada-tab-policy
'indent-rigidly
) (ada-tab-hard))
4245 ((eq ada-tab-policy
'indent-auto
)
4246 (if (ada-region-selected)
4247 (ada-indent-region (region-beginning) (region-end))
4248 (ada-indent-current)))
4249 ((eq ada-tab-policy
'always-tab
) (error "Not implemented"))
4252 (defun ada-untab (arg)
4253 "Delete leading indenting according to `ada-tab-policy'."
4254 ;; FIXME: ARG is ignored
4256 (cond ((eq ada-tab-policy
'indent-rigidly
) (ada-untab-hard))
4257 ((eq ada-tab-policy
'indent-auto
) (error "Not implemented"))
4258 ((eq ada-tab-policy
'always-tab
) (error "Not implemented"))
4261 (defun ada-indent-current-function ()
4262 "Ada mode version of the `indent-line-function'."
4264 (let ((starting-point (point-marker)))
4267 (if (< (point) starting-point
)
4268 (goto-char starting-point
))
4269 (set-marker starting-point nil
)
4272 (defun ada-tab-hard ()
4273 "Indent current line to next tab stop."
4277 (insert-char ? ada-indent
))
4278 (if (save-excursion (= (point) (progn (beginning-of-line) (point))))
4279 (forward-char ada-indent
)))
4281 (defun ada-untab-hard ()
4282 "Indent current line to previous tab stop."
4284 (let ((bol (save-excursion (progn (beginning-of-line) (point))))
4285 (eol (save-excursion (progn (end-of-line) (point)))))
4286 (indent-rigidly bol eol
(- 0 ada-indent
))))
4290 ;; ------------------------------------------------------------
4292 ;; ------------------------------------------------------------
4294 ;; Not needed any more for Emacs 21.2, but still needed for backward
4296 (defun ada-remove-trailing-spaces ()
4297 "Remove trailing spaces in the whole buffer."
4303 (goto-char (point-min))
4304 (while (re-search-forward "[ \t]+$" (point-max) t
)
4305 (replace-match "" nil nil
))))))
4307 (defun ada-gnat-style ()
4308 "Clean up comments, `(' and `,' for GNAT style checking switch."
4312 ;; The \n is required, or the line after an empty comment line is
4314 (goto-char (point-min))
4315 (while (re-search-forward "--[ \t]*\\([^-\n]\\)" nil t
)
4316 (replace-match "-- \\1")
4318 (beginning-of-line))
4320 (goto-char (point-min))
4321 (while (re-search-forward "\\>(" nil t
)
4322 (if (not (ada-in-string-or-comment-p))
4323 (replace-match " (")))
4324 (goto-char (point-min))
4325 (while (re-search-forward ";--" nil t
)
4327 (if (not (ada-in-string-or-comment-p))
4328 (replace-match "; --")))
4329 (goto-char (point-min))
4330 (while (re-search-forward "([ \t]+" nil t
)
4331 (if (not (ada-in-string-or-comment-p))
4332 (replace-match "(")))
4333 (goto-char (point-min))
4334 (while (re-search-forward ")[ \t]+)" nil t
)
4335 (if (not (ada-in-string-or-comment-p))
4336 (replace-match "))")))
4337 (goto-char (point-min))
4338 (while (re-search-forward "\\>:" nil t
)
4339 (if (not (ada-in-string-or-comment-p))
4340 (replace-match " :")))
4342 ;; Make sure there is a space after a ','.
4343 ;; Always go back to the beginning of the match, since otherwise
4344 ;; a statement like ('F','D','E') is incorrectly modified.
4345 (goto-char (point-min))
4346 (while (re-search-forward ",[ \t]*\\(.\\)" nil t
)
4347 (if (not (save-excursion
4348 (goto-char (match-beginning 0))
4349 (ada-in-string-or-comment-p)))
4350 (replace-match ", \\1")))
4352 ;; Operators should be surrounded by spaces.
4353 (goto-char (point-min))
4354 (while (re-search-forward
4355 "[ \t]*\\(/=\\|\\*\\*\\|:=\\|\\.\\.\\|[-:+*/]\\)[ \t]*"
4357 (goto-char (match-beginning 1))
4358 (if (or (looking-at "--")
4359 (ada-in-string-or-comment-p))
4362 (beginning-of-line))
4364 ((string= (match-string 1) "/=")
4365 (replace-match " /= "))
4366 ((string= (match-string 1) "..")
4367 (replace-match " .. "))
4368 ((string= (match-string 1) "**")
4369 (replace-match " ** "))
4370 ((string= (match-string 1) ":=")
4371 (replace-match " := "))
4373 (replace-match " \\1 ")))
4379 ;; -------------------------------------------------------------
4380 ;; -- Moving To Procedures/Packages/Statements
4381 ;; -------------------------------------------------------------
4383 (defun ada-move-to-start ()
4384 "Move point to the matching start of the current Ada structure."
4387 (previous-syntax-table (syntax-table)))
4390 (set-syntax-table ada-mode-symbol-syntax-table
)
4394 ;; do nothing if in string or comment or not on 'end ...;'
4395 ;; or if an error occurs during processing
4398 (ada-in-string-or-comment-p)
4400 (or (looking-at "[ \t]*\\<end\\>")
4402 (or (looking-at "[ \t]*\\<end\\>")
4404 (or (looking-at "[ \t]*\\<end\\>")
4405 (error "Not on end ...;")))
4406 (ada-goto-matching-start 1)
4410 ;; on 'begin' => go on, according to user option
4412 ada-move-to-declaration
4413 (looking-at "\\<begin\\>")
4414 (ada-goto-matching-decl-start)
4415 (setq pos
(point))))
4417 ) ; end of save-excursion
4419 ;; now really move to the found position
4422 ;; restore syntax-table
4423 (set-syntax-table previous-syntax-table
))))
4425 (defun ada-move-to-end ()
4426 "Move point to the matching end of the block around point.
4427 Moves to 'begin' if in a declarative part."
4431 (previous-syntax-table (syntax-table)))
4434 (set-syntax-table ada-mode-symbol-syntax-table
)
4439 ;; Go to the beginning of the current word, and check if we are
4440 ;; directly on 'begin'
4442 (skip-syntax-backward "w")
4443 (looking-at "\\<begin\\>"))
4444 (ada-goto-matching-end 1)
4447 ;; on first line of subprogram body
4448 ;; Do nothing for specs or generic instantion, since these are
4449 ;; handled as the general case (find the enclosing block)
4450 ;; We also need to make sure that we ignore nested subprograms
4452 (and (skip-syntax-backward "w")
4453 (looking-at "\\<function\\>\\|\\<procedure\\>" )
4454 (ada-search-ignore-string-comment "is\\|;")
4455 (not (= (char-before) ?\
;))
4457 (skip-syntax-backward "w")
4458 (ada-goto-matching-end 0 t
))
4460 ;; on first line of task declaration
4462 (and (ada-goto-stmt-start)
4463 (looking-at "\\<task\\>" )
4465 (ada-goto-next-non-ws)
4466 (looking-at "\\<body\\>")))
4467 (ada-search-ignore-string-comment "begin" nil nil nil
4468 'word-search-forward
))
4469 ;; accept block start
4471 (and (ada-goto-stmt-start)
4472 (looking-at "\\<accept\\>" )))
4473 (ada-goto-matching-end 0))
4476 (setq decl-start
(and (ada-goto-matching-decl-start t
) (point)))
4477 (and decl-start
(looking-at "\\<package\\>")))
4478 (ada-goto-matching-end 1))
4480 ;; On a "declare" keyword
4482 (skip-syntax-backward "w")
4483 (looking-at "\\<declare\\>"))
4484 (ada-goto-matching-end 0 t
))
4486 ;; inside a 'begin' ... 'end' block
4488 (goto-char decl-start
)
4489 (ada-goto-matching-end 0 t
))
4491 ;; (hopefully ;-) everything else
4493 (ada-goto-matching-end 1)))
4497 ;; now really move to the position found
4500 ;; restore syntax-table
4501 (set-syntax-table previous-syntax-table
))))
4503 (defun ada-next-procedure ()
4504 "Move point to next procedure."
4507 (if (re-search-forward ada-procedure-start-regexp nil t
)
4508 (goto-char (match-beginning 4))
4509 (error "No more functions/procedures/tasks")))
4511 (defun ada-previous-procedure ()
4512 "Move point to previous procedure."
4515 (if (re-search-backward ada-procedure-start-regexp nil t
)
4516 (goto-char (match-beginning 4))
4517 (error "No more functions/procedures/tasks")))
4519 (defun ada-next-package ()
4520 "Move point to next package."
4523 (if (re-search-forward ada-package-start-regexp nil t
)
4524 (goto-char (match-beginning 1))
4525 (error "No more packages")))
4527 (defun ada-previous-package ()
4528 "Move point to previous package."
4531 (if (re-search-backward ada-package-start-regexp nil t
)
4532 (goto-char (match-beginning 1))
4533 (error "No more packages")))
4536 ;; ------------------------------------------------------------
4537 ;; -- Define keymap and menus for Ada
4538 ;; -------------------------------------------------------------
4540 (defun ada-create-keymap ()
4541 "Create the keymap associated with the Ada mode."
4543 ;; All non-standard keys go into ada-mode-extra-map
4544 (define-key ada-mode-map ada-mode-extra-prefix ada-mode-extra-map
)
4546 ;; Indentation and Formatting
4547 (define-key ada-mode-map
"\C-j" 'ada-indent-newline-indent-conditional
)
4548 (define-key ada-mode-map
"\C-m" 'ada-indent-newline-indent-conditional
)
4549 (define-key ada-mode-map
"\t" 'ada-tab
)
4550 (define-key ada-mode-map
"\C-c\t" 'ada-justified-indent-current
)
4551 (define-key ada-mode-map
"\C-c\C-l" 'ada-indent-region
)
4552 (define-key ada-mode-map
[(shift tab
)] 'ada-untab
)
4553 (define-key ada-mode-map
"\C-c\C-f" 'ada-format-paramlist
)
4554 ;; We don't want to make meta-characters case-specific.
4557 (define-key ada-mode-map
"\M-\C-e" 'ada-next-procedure
)
4558 (define-key ada-mode-map
"\M-\C-a" 'ada-previous-procedure
)
4559 (define-key ada-mode-map
"\C-c\C-a" 'ada-move-to-start
)
4560 (define-key ada-mode-map
"\C-c\C-e" 'ada-move-to-end
)
4563 (unless (lookup-key ada-mode-map
"\C-c\C-c")
4564 (define-key ada-mode-map
"\C-c\C-c" 'compile
))
4567 (define-key ada-mode-map
"\C-c\C-b" 'ada-adjust-case-buffer
)
4568 (define-key ada-mode-map
"\C-c\C-t" 'ada-case-read-exceptions
)
4569 (define-key ada-mode-map
"\C-c\C-y" 'ada-create-case-exception
)
4570 (define-key ada-mode-map
"\C-c\C-\M-y" 'ada-create-case-exception-substring
)
4572 ;; On XEmacs, you can easily specify whether DEL should deletes
4573 ;; one character forward or one character backward. Take this into
4575 (define-key ada-mode-map
4576 (if (boundp 'delete-key-deletes-forward
) [backspace] "\177")
4577 'backward-delete-char-untabify)
4580 (define-key ada-mode-map "\C-c\C-n" 'ada-make-subprogram-body)
4582 ;; Use predefined function of Emacs19 for comments (RE)
4583 (define-key ada-mode-map "\C-c;" 'comment-region)
4584 (define-key ada-mode-map "\C-c:" 'ada-uncomment-region)
4586 ;; The following keys are bound to functions defined in ada-xref.el or
4587 ;; ada-prj,el., However, RMS rightly thinks that the code should be shared,
4588 ;; and activated only if the right compiler is used
4590 (define-key ada-mode-map (if (featurep 'xemacs) '(shift button3) [S-mouse-3])
4591 'ada-point-and-xref)
4592 (define-key ada-mode-map [(control tab)] 'ada-complete-identifier)
4594 (define-key ada-mode-extra-map "o" 'ff-find-other-file)
4595 (define-key ada-mode-map "\C-c5\C-d" 'ada-goto-declaration-other-frame)
4596 (define-key ada-mode-map "\C-c\C-d" 'ada-goto-declaration)
4597 (define-key ada-mode-map "\C-c\C-s" 'ada-xref-goto-previous-reference)
4598 (define-key ada-mode-map "\C-c\C-c" 'ada-compile-application)
4599 (define-key ada-mode-extra-map "c" 'ada-change-prj)
4600 (define-key ada-mode-extra-map "d" 'ada-set-default-project-file)
4601 (define-key ada-mode-extra-map "g" 'ada-gdb-application)
4602 (define-key ada-mode-map "\C-c\C-m" 'ada-set-main-compile-application)
4603 (define-key ada-mode-extra-map "r" 'ada-run-application)
4604 (define-key ada-mode-map "\C-c\C-o" 'ada-goto-parent)
4605 (define-key ada-mode-map "\C-c\C-r" 'ada-find-references)
4606 (define-key ada-mode-extra-map "l" 'ada-find-local-references)
4607 (define-key ada-mode-map "\C-c\C-v" 'ada-check-current)
4608 (define-key ada-mode-extra-map "f" 'ada-find-file)
4610 (define-key ada-mode-extra-map "u" 'ada-prj-edit)
4612 ;; The templates, defined in ada-stmt.el
4614 (let ((map (make-sparse-keymap)))
4615 (define-key map "h" 'ada-header)
4616 (define-key map "\C-a" 'ada-array)
4617 (define-key map "b" 'ada-exception-block)
4618 (define-key map "d" 'ada-declare-block)
4619 (define-key map "c" 'ada-case)
4620 (define-key map "\C-e" 'ada-elsif)
4621 (define-key map "e" 'ada-else)
4622 (define-key map "\C-k" 'ada-package-spec)
4623 (define-key map "k" 'ada-package-body)
4624 (define-key map "\C-p" 'ada-procedure-spec)
4625 (define-key map "p" 'ada-subprogram-body)
4626 (define-key map "\C-f" 'ada-function-spec)
4627 (define-key map "f" 'ada-for-loop)
4628 (define-key map "i" 'ada-if)
4629 (define-key map "l" 'ada-loop)
4630 (define-key map "\C-r" 'ada-record)
4631 (define-key map "\C-s" 'ada-subtype)
4632 (define-key map "S" 'ada-tabsize)
4633 (define-key map "\C-t" 'ada-task-spec)
4634 (define-key map "t" 'ada-task-body)
4635 (define-key map "\C-y" 'ada-type)
4636 (define-key map "\C-v" 'ada-private)
4637 (define-key map "u" 'ada-use)
4638 (define-key map "\C-u" 'ada-with)
4639 (define-key map "\C-w" 'ada-when)
4640 (define-key map "w" 'ada-while-loop)
4641 (define-key map "\C-x" 'ada-exception)
4642 (define-key map "x" 'ada-exit)
4643 (define-key ada-mode-extra-map "t" map))
4647 (defun ada-create-menu ()
4648 "Create the Ada menu as shown in the menu bar."
4651 ["Ada Mode" (info "ada-mode") t]
4652 ["GNAT User's Guide" (info "gnat_ugn")
4653 (eq ada-which-compiler 'gnat)]
4654 ["GNAT Reference Manual" (info "gnat_rm")
4655 (eq ada-which-compiler 'gnat)]
4656 ["Gcc Documentation" (info "gcc")
4657 (eq ada-which-compiler 'gnat)]
4658 ["Gdb Documentation" (info "gdb")
4659 (eq ada-which-compiler 'gnat)]
4660 ["Ada95 Reference Manual" (info "arm95") t])
4661 ("Options" :included (eq major-mode 'ada-mode)
4662 ["Auto Casing" (setq ada-auto-case (not ada-auto-case))
4663 :style toggle :selected ada-auto-case]
4664 ["Auto Indent After Return"
4665 (setq ada-indent-after-return (not ada-indent-after-return))
4666 :style toggle :selected ada-indent-after-return]
4667 ["Automatically Recompile For Cross-references"
4668 (setq ada-xref-create-ali (not ada-xref-create-ali))
4669 :style toggle :selected ada-xref-create-ali
4670 :included (eq ada-which-compiler 'gnat)]
4672 (setq ada-xref-confirm-compile (not ada-xref-confirm-compile))
4673 :style toggle :selected ada-xref-confirm-compile
4674 :included (eq ada-which-compiler 'gnat)]
4675 ["Show Cross-references In Other Buffer"
4676 (setq ada-xref-other-buffer (not ada-xref-other-buffer))
4677 :style toggle :selected ada-xref-other-buffer
4678 :included (eq ada-which-compiler 'gnat)]
4679 ["Tight Integration With GNU Visual Debugger"
4680 (setq ada-tight-gvd-integration (not ada-tight-gvd-integration))
4681 :style toggle :selected ada-tight-gvd-integration
4682 :included (string-match "gvd" ada-prj-default-debugger)])
4683 ["Customize" (customize-group 'ada)
4684 :included (fboundp 'customize-group)]
4685 ["Check file" ada-check-current t]
4686 ["Compile file" ada-compile-current t]
4687 ["Set main and Build" ada-set-main-compile-application t]
4688 ["Show main" ada-show-current-main t]
4689 ["Build" ada-compile-application t]
4690 ["Run" ada-run-application t]
4691 ["Debug" ada-gdb-application (eq ada-which-compiler 'gnat)]
4694 ["Show project" ada-show-current-project t]
4695 ["Load..." ada-set-default-project-file t]
4696 ["New..." ada-prj-new t]
4697 ["Edit..." ada-prj-edit t])
4698 ("Goto" :included (eq major-mode 'ada-mode)
4699 ["Goto Declaration/Body" ada-goto-declaration
4700 (eq ada-which-compiler 'gnat)]
4701 ["Goto Body" ada-goto-body
4702 (eq ada-which-compiler 'gnat)]
4703 ["Goto Declaration Other Frame"
4704 ada-goto-declaration-other-frame
4705 (eq ada-which-compiler 'gnat)]
4706 ["Goto Previous Reference" ada-xref-goto-previous-reference
4707 (eq ada-which-compiler 'gnat)]
4708 ["List Local References" ada-find-local-references
4709 (eq ada-which-compiler 'gnat)]
4710 ["List References" ada-find-references
4711 (eq ada-which-compiler 'gnat)]
4712 ["Goto Reference To Any Entity" ada-find-any-references
4713 (eq ada-which-compiler 'gnat)]
4714 ["Goto Parent Unit" ada-goto-parent
4715 (eq ada-which-compiler 'gnat)]
4717 ["Next compilation error" next-error t]
4718 ["Previous Package" ada-previous-package t]
4719 ["Next Package" ada-next-package t]
4720 ["Previous Procedure" ada-previous-procedure t]
4721 ["Next Procedure" ada-next-procedure t]
4722 ["Goto Start Of Statement" ada-move-to-start t]
4723 ["Goto End Of Statement" ada-move-to-end t]
4725 ["Other File" ff-find-other-file t]
4726 ["Other File Other Window" ada-ff-other-window t])
4727 ("Edit" :included (eq major-mode 'ada-mode)
4728 ["Search File On Source Path" ada-find-file t]
4730 ["Complete Identifier" ada-complete-identifier t]
4732 ["Indent Line" ada-indent-current-function t]
4733 ["Justify Current Indentation" ada-justified-indent-current t]
4734 ["Indent Lines in Selection" ada-indent-region t]
4735 ["Indent Lines in File"
4736 (ada-indent-region (point-min) (point-max)) t]
4737 ["Format Parameter List" ada-format-paramlist t]
4739 ["Comment Selection" comment-region t]
4740 ["Uncomment Selection" ada-uncomment-region t]
4742 ["Fill Comment Paragraph" fill-paragraph t]
4743 ["Fill Comment Paragraph Justify"
4744 ada-fill-comment-paragraph-justify t]
4745 ["Fill Comment Paragraph Postfix"
4746 ada-fill-comment-paragraph-postfix t]
4748 ["Adjust Case Selection" ada-adjust-case-region t]
4749 ["Adjust Case in File" ada-adjust-case-buffer t]
4750 ["Create Case Exception" ada-create-case-exception t]
4751 ["Create Case Exception Substring"
4752 ada-create-case-exception-substring t]
4753 ["Reload Case Exceptions" ada-case-read-exceptions t]
4755 ["Make body for subprogram" ada-make-subprogram-body t]
4757 ["Narrow to subprogram" ada-narrow-to-defun t])
4759 :included (eq major-mode 'ada-mode)
4760 ["Header" ada-header t]
4762 ["Package Body" ada-package-body t]
4763 ["Package Spec" ada-package-spec t]
4764 ["Function Spec" ada-function-spec t]
4765 ["Procedure Spec" ada-procedure-spec t]
4766 ["Proc/func Body" ada-subprogram-body t]
4767 ["Task Body" ada-task-body t]
4768 ["Task Spec" ada-task-spec t]
4769 ["Declare Block" ada-declare-block t]
4770 ["Exception Block" ada-exception-block t]
4772 ["Entry" ada-entry t]
4773 ["Entry family" ada-entry-family t]
4774 ["Select" ada-select t]
4775 ["Accept" ada-accept t]
4776 ["Or accept" ada-or-accep t]
4777 ["Or delay" ada-or-delay t]
4778 ["Or terminate" ada-or-terminate t]
4781 ["Private" ada-private t]
4782 ["Subtype" ada-subtype t]
4783 ["Record" ada-record t]
4784 ["Array" ada-array t]
4788 ["Elsif" ada-elsif t]
4791 ["While Loop" ada-while-loop t]
4792 ["For Loop" ada-for-loop t]
4795 ["Exception" ada-exception t]
4797 ["When" ada-when t])
4800 (easy-menu-define ada-mode-menu ada-mode-map "Menu keymap for Ada mode" m)
4801 (if (featurep 'xemacs)
4803 (define-key ada-mode-map [menu-bar] ada-mode-menu)
4804 (set 'mode-popup-menu (cons "Ada mode" ada-mode-menu))))))
4807 ;; -------------------------------------------------------
4808 ;; Commenting/Uncommenting code
4809 ;; The following two calls are provided to enhance the standard
4810 ;; comment-region function, which only allows uncommenting if the
4811 ;; comment is at the beginning of a line. If the line have been re-indented,
4812 ;; we are unable to use comment-region, which makes no sense.
4814 ;; In addition, we provide an interface to the standard comment handling
4815 ;; function for justifying the comments.
4816 ;; -------------------------------------------------------
4818 (defadvice comment-region (before ada-uncomment-anywhere disable)
4819 (if (and (consp arg) ;; a prefix with \C-u is of the form '(4), whereas
4820 ;; \C-u 2 sets arg to '2' (fixed by S.Leake)
4821 (derived-mode-p 'ada-mode))
4823 (let ((cs (concat "^[ \t]*" (regexp-quote comment-start))))
4825 (while (re-search-forward cs end t)
4826 (replace-match comment-start))
4829 (defun ada-uncomment-region (beg end &optional arg)
4830 "Uncomment region BEG .. END.
4831 ARG gives number of comment characters."
4832 (interactive "r\nP")
4834 ;; This advice is not needed anymore with Emacs21. However, for older
4835 ;; versions, as well as for XEmacs, we still need to enable it.
4836 (if (or (<= emacs-major-version 20) (featurep 'xemacs))
4838 (ad-activate 'comment-region)
4839 (comment-region beg end (- (or arg 2)))
4840 (ad-deactivate 'comment-region))
4841 (comment-region beg end (list (- (or arg 2))))
4842 (ada-indent-region beg end)))
4844 (defun ada-fill-comment-paragraph-justify ()
4845 "Fill current comment paragraph and justify each line as well."
4847 (ada-fill-comment-paragraph 'full))
4849 (defun ada-fill-comment-paragraph-postfix ()
4850 "Fill current comment paragraph and justify each line as well.
4851 Adds `ada-fill-comment-postfix' at the end of each line."
4853 (ada-fill-comment-paragraph 'full t))
4855 (defun ada-fill-comment-paragraph (&optional justify postfix)
4856 "Fill the current comment paragraph.
4857 If JUSTIFY is non-nil, each line is justified as well.
4858 If POSTFIX and JUSTIFY are non-nil, `ada-fill-comment-postfix' is appended
4859 to each line filled and justified.
4860 The paragraph is indented on the first line."
4863 ;; check if inside comment or just in front a comment
4864 (if (and (not (ada-in-comment-p))
4865 (not (looking-at "[ \t]*--")))
4866 (error "Not inside comment"))
4868 (let* (indent from to
4869 (opos (point-marker))
4871 ;; Sets this variable to nil, otherwise it prevents
4872 ;; fill-region-as-paragraph to work on Emacs <= 20.2
4873 (parse-sexp-lookup-properties nil)
4876 (fill-column (current-fill-column)))
4878 ;; Find end of paragraph
4879 (back-to-indentation)
4880 (while (and (not (eobp)) (looking-at ".*--[ \t]*[^ \t\n]"))
4883 ;; If we were at the last line in the buffer, create a dummy empty
4884 ;; line at the end of the buffer.
4887 (back-to-indentation)))
4889 (setq to (point-marker))
4892 ;; Find beginning of paragraph
4893 (back-to-indentation)
4894 (while (and (not (bobp)) (looking-at ".*--[ \t]*[^ \t\n]"))
4896 (back-to-indentation))
4898 ;; We want one line above the first one, unless we are at the beginning
4903 (setq from (point-marker))
4905 ;; Calculate the indentation we will need for the paragraph
4906 (back-to-indentation)
4907 (setq indent (current-column))
4908 ;; unindent the first line of the paragraph
4909 (delete-region from (point))
4911 ;; Remove the old postfixes
4913 (while (re-search-forward "--\n" to t)
4914 (replace-match "\n"))
4917 (setq to (point-marker))
4919 ;; Indent and justify the paragraph
4920 (setq fill-prefix ada-fill-comment-prefix)
4921 (set-left-margin from to indent)
4923 (setq fill-column (- fill-column (length ada-fill-comment-postfix))))
4925 (fill-region-as-paragraph from to justify)
4927 ;; Add the postfixes if required
4931 (narrow-to-region from to)
4934 (insert-char ? (- fill-column (current-column)))
4935 (insert ada-fill-comment-postfix)
4939 ;; In Emacs <= 20.2 and XEmacs <=20.4, there is a bug, and a newline is
4940 ;; inserted at the end. Delete it
4941 (if (or (featurep 'xemacs)
4942 (<= emacs-major-version 19)
4943 (and (= emacs-major-version 20)
4944 (<= emacs-minor-version 2)))
4953 ;; ---------------------------------------------------
4954 ;; support for find-file.el
4955 ;; These functions are used by find-file to guess the file names from
4956 ;; unit names, and to find the other file (spec or body) from the current
4957 ;; file (body or spec).
4958 ;; It is also used to find in which function we are, so as to put the
4959 ;; cursor at the correct position.
4960 ;; Standard Ada does not force any relation between unit names and file names,
4961 ;; so some of these functions can only be a good approximation. However, they
4962 ;; are also overridden in `ada-xref'.el when we know that the user is using
4964 ;; ---------------------------------------------------
4966 ;; Overridden when we work with GNAT, to use gnatkrunch
4967 (defun ada-make-filename-from-adaname (adaname)
4968 "Determine the filename in which ADANAME is found.
4969 This matches the GNAT default naming convention, except for
4971 (while (string-match "\\." adaname)
4972 (setq adaname (replace-match "-" t t adaname)))
4976 (defun ada-other-file-name ()
4977 "Return the name of the other file.
4978 The name returned is the body if `current-buffer' is the spec,
4979 or the spec otherwise."
4983 (suffixes ada-spec-suffixes)
4984 (name (buffer-file-name)))
4986 ;; Guess whether we have a spec or a body, and get the basename of the
4987 ;; file. Since the extension may not start with '.', we can not use
4988 ;; file-name-extension
4989 (while (and (not is-spec)
4991 (if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
4993 name (match-string 1 name)))
4994 (setq suffixes (cdr suffixes)))
4998 (setq suffixes ada-body-suffixes)
4999 (while (and (not is-body)
5001 (if (string-match (concat "\\(.*\\)" (car suffixes) "$") name)
5003 name (match-string 1 name)))
5004 (setq suffixes (cdr suffixes)))))
5006 ;; If this wasn't in either list, return name itself
5007 (if (not (or is-spec is-body))
5010 ;; Else find the other possible names
5012 (setq suffixes ada-body-suffixes)
5013 (setq suffixes ada-spec-suffixes))
5018 ;; If we are using project file, search for the other file in all
5019 ;; the possible src directories.
5021 (if (fboundp 'ada-find-src-file-in-dir)
5023 (ada-find-src-file-in-dir
5024 (file-name-nondirectory (concat name (car suffixes))))))
5026 (set 'is-spec other)))
5028 ;; Else search in the current directory
5029 (if (file-exists-p (concat name (car suffixes)))
5030 (setq is-spec (concat name (car suffixes)))))
5031 (setq suffixes (cdr suffixes)))
5035 (defun ada-which-function-are-we-in ()
5036 "Return the name of the function whose definition/declaration point is in.
5037 Used in `ff-pre-load-hook'."
5038 (setq ff-function-name nil)
5040 (end-of-line);; make sure we get the complete name
5041 (or (if (re-search-backward ada-procedure-start-regexp nil t)
5042 (setq ff-function-name (match-string 5)))
5043 (if (re-search-backward ada-package-start-regexp nil t)
5044 (setq ff-function-name (match-string 4))))
5048 (defvar ada-last-which-function-line -1
5049 "Last line on which `ada-which-function' was called.")
5050 (defvar ada-last-which-function-subprog 0
5051 "Last subprogram name returned by `ada-which-function'.")
5052 (make-variable-buffer-local 'ada-last-which-function-subprog)
5053 (make-variable-buffer-local 'ada-last-which-function-line)
5056 (defun ada-which-function ()
5057 "Return the name of the function whose body the point is in.
5058 This function works even in the case of nested subprograms, whereas the
5059 standard Emacs function `which-function' does not.
5060 Since the search can be long, the results are cached."
5062 (let ((line (count-lines 1 (point)))
5068 ;; If this is the same line as before, simply return the same result
5069 (if (= line ada-last-which-function-line)
5070 ada-last-which-function-subprog
5073 ;; In case the current line is also the beginning of the body
5076 ;; Are we looking at "function Foo\n (paramlist)"
5077 (skip-chars-forward " \t\n(")
5083 (skip-chars-forward " \t\n")
5084 (if (looking-at "return")
5087 (skip-chars-forward " \t\n")
5088 (skip-chars-forward "a-zA-Z0-9_'")))
5090 ;; Can't simply do forward-word, in case the "is" is not on the
5091 ;; same line as the closing parenthesis
5092 (skip-chars-forward "is \t\n")
5094 ;; No look for the closest subprogram body that has not ended yet.
5095 ;; Not that we expect all the bodies to be finished by "end <name>",
5096 ;; or a simple "end;" indented in the same column as the start of
5097 ;; the subprogram. The goal is to be as efficient as possible.
5099 (while (and (not found)
5100 (re-search-backward ada-imenu-subprogram-menu-re nil t))
5102 ;; Get the function name, but not the properties, or this changes
5103 ;; the face in the modeline on Emacs 21
5104 (setq func-name (match-string-no-properties 2))
5105 (if (and (not (ada-in-comment-p))
5106 (not (save-excursion
5107 (goto-char (match-end 0))
5108 (looking-at "[ \t\n]*new"))))
5110 (back-to-indentation)
5111 (setq indent (current-column))
5112 (if (ada-search-ignore-string-comment
5113 (concat "end[ \t]+" func-name "[ \t]*;\\|^"
5114 (make-string indent ? ) "end;"))
5115 (setq end-pos (point))
5116 (setq end-pos (point-max)))
5117 (if (>= end-pos pos)
5118 (setq found func-name))))
5120 (setq ada-last-which-function-line line
5121 ada-last-which-function-subprog found)
5124 (defun ada-ff-other-window ()
5125 "Find other file in other window using `ff-find-other-file'."
5127 (and (fboundp 'ff-find-other-file)
5128 (ff-find-other-file t)))
5130 (defun ada-set-point-accordingly ()
5131 "Move to the function declaration that was set by `ff-which-function-are-we-in'."
5132 (if ff-function-name
5134 (goto-char (point-min))
5135 (unless (ada-search-ignore-string-comment
5136 (concat ff-function-name "\\b") nil)
5137 (goto-char (point-min))))))
5139 (defun ada-get-body-name (&optional spec-name)
5140 "Return the file name for the body of SPEC-NAME.
5141 If SPEC-NAME is nil, return the body for the current package.
5142 Return nil if no body was found."
5145 (unless spec-name (setq spec-name (buffer-file-name)))
5147 ;; Remove the spec extension. We can not simply remove the file extension,
5148 ;; but we need to take into account the specific non-GNAT extensions that the
5149 ;; user might have specified.
5151 (let ((suffixes ada-spec-suffixes)
5154 (setq end (- (length spec-name) (length (car suffixes))))
5155 (if (string-equal (car suffixes) (substring spec-name end))
5156 (setq spec-name (substring spec-name 0 end)))
5157 (setq suffixes (cdr suffixes))))
5159 ;; If find-file.el was available, use its functions
5160 (if (fboundp 'ff-get-file-name)
5161 (ff-get-file-name ada-search-directories-internal
5162 (ada-make-filename-from-adaname
5163 (file-name-nondirectory
5164 (file-name-sans-extension spec-name)))
5166 ;; Else emulate it very simply
5167 (concat (ada-make-filename-from-adaname
5168 (file-name-nondirectory
5169 (file-name-sans-extension spec-name)))
5173 ;; ---------------------------------------------------
5174 ;; support for font-lock.el
5175 ;; Strings are a real pain in Ada because a single quote character is
5176 ;; overloaded as a string quote and type/instance delimiter. By default, a
5177 ;; single quote is given punctuation syntax in `ada-mode-syntax-table'.
5178 ;; So, for Font Lock mode purposes, we mark single quotes as having string
5179 ;; syntax when the gods that created Ada determine them to be.
5181 ;; This only works in Emacs. See the comments before the grammar functions
5182 ;; at the beginning of this file for how this is done with XEmacs.
5183 ;; ----------------------------------------------------
5185 (defconst ada-font-lock-syntactic-keywords
5186 ;; Mark single quotes as having string quote syntax in 'c' instances.
5187 ;; We used to explicitly avoid ''' as a special case for fear the buffer
5188 ;; be highlighted as a string, but it seems this fear is unfounded.
5190 ;; This sets the properties of the characters, so that ada-in-string-p
5191 ;; correctly handles '"' too...
5192 '(("[^a-zA-Z0-9)]\\('\\)[^\n]\\('\\)" (1 (7 . ?')) (2 (7 . ?')))
5193 ("^[ \t]*\\(#\\(if\\|else\\|elsif\\|end\\)\\)" (1 (11 . ?\n)))))
5195 (defvar ada-font-lock-keywords
5199 ;; handle "type T is access function return S;"
5200 (list "\\<\\(function[ \t]+return\\)\\>" '(1 font-lock-keyword-face) )
5202 ;; preprocessor line
5203 (list "^[ \t]*\\(#.*\n\\)" '(1 font-lock-type-face t))
5206 ;; accept, entry, function, package (body), protected (body|type),
5207 ;; pragma, procedure, task (body) plus name.
5213 "package[ \t]+body\\|"
5217 "protected[ \t]+body\\|"
5218 "protected[ \t]+type\\|"
5224 "\\(\\sw+\\(\\.\\sw*\\)*\\)?")
5225 '(1 font-lock-keyword-face) '(2 font-lock-function-name-face nil t))
5227 ;; Optional keywords followed by a type name.
5228 (list (concat ; ":[ \t]*"
5229 "\\<\\(access[ \t]+all\\|access[ \t]+constant\\|access\\|constant\\|in[ \t]+reverse\\|\\|in[ \t]+out\\|in\\|out\\)\\>"
5231 "\\(\\sw+\\(\\.\\sw*\\)*\\)?")
5232 '(1 font-lock-keyword-face nil t) '(2 font-lock-type-face nil t))
5235 ;; Main keywords, except those treated specially below.
5238 '("abort" "abs" "abstract" "accept" "access" "aliased" "all"
5239 "and" "array" "at" "begin" "case" "declare" "delay" "delta"
5240 "digits" "do" "else" "elsif" "entry" "exception" "exit" "for"
5241 "generic" "if" "in" "interface" "is" "limited" "loop" "mod" "not"
5242 "null" "or" "others" "overriding" "private" "protected" "raise"
5243 "range" "record" "rem" "renames" "requeue" "return" "reverse"
5244 "select" "separate" "synchronized" "tagged" "task" "terminate"
5245 "then" "until" "when" "while" "with" "xor") t)
5248 ;; Anything following end and not already fontified is a body name.
5249 '("\\<\\(end\\)\\>\\([ \t]+\\)?\\(\\(\\sw\\|[_.]\\)+\\)?"
5250 (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
5252 ;; Keywords followed by a type or function name.
5253 (list (concat "\\<\\("
5254 "new\\|of\\|subtype\\|type"
5255 "\\)\\>[ \t]*\\(\\sw+\\(\\.\\sw*\\)*\\)?[ \t]*\\((\\)?")
5256 '(1 font-lock-keyword-face)
5257 '(2 (if (match-beginning 4)
5258 font-lock-function-name-face
5259 font-lock-type-face) nil t))
5261 ;; Keywords followed by a (comma separated list of) reference.
5262 ;; Note that font-lock only works on single lines, thus we can not
5263 ;; correctly highlight a with_clause that spans multiple lines.
5264 (list (concat "\\<\\(goto\\|raise\\|use\\|with\\)"
5265 "[ \t]+\\([a-zA-Z0-9_., \t]+\\)\\W")
5266 '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
5270 '("<<\\(\\sw+\\)>>" 1 font-lock-reference-face)
5272 ;; Highlight based-numbers (R. Reagan <robin-reply@reagans.org>)
5273 (list "\\([0-9]+#[0-9a-fA-F_]+#\\)" '(1 font-lock-constant-face t))
5275 ;; Ada unnamed numerical constants
5276 (list "\\W\\([-+]?[0-9._]+\\)\\>" '(1 font-lock-constant-face))
5279 "Default expressions to highlight in Ada mode.")
5282 ;; ---------------------------------------------------------
5283 ;; Support for outline.el
5284 ;; ---------------------------------------------------------
5286 (defun ada-outline-level ()
5287 "This is so that `current-column' DTRT in otherwise-hidden text."
5288 ;; patch from Dave Love <fx@gnu.org>
5289 (let (buffer-invisibility-spec)
5291 (back-to-indentation)
5294 ;; ---------------------------------------------------------
5295 ;; Support for narrow-to-region
5296 ;; ---------------------------------------------------------
5298 (defun ada-narrow-to-defun (&optional arg)
5299 "Make text outside current subprogram invisible.
5300 The subprogram visible is the one that contains or follow point.
5301 Optional ARG is ignored.
5302 Use \\[widen] to go back to the full visibility for the buffer."
5309 (ada-previous-procedure)
5317 (narrow-to-region end (point))
5319 "Use M-x widen to get back to full visibility in the buffer"))))
5321 ;; ---------------------------------------------------------
5322 ;; Automatic generation of code
5323 ;; The Ada mode has a set of function to automatically generate a subprogram
5324 ;; or package body from its spec.
5325 ;; These function only use a primary and basic algorithm, this could use a
5326 ;; lot of improvement.
5327 ;; When the user is using GNAT, we rather use gnatstub to generate an accurate
5329 ;; ----------------------------------------------------------
5331 (defun ada-gen-treat-proc (match)
5332 "Make dummy body of a procedure/function specification.
5333 MATCH is a cons cell containing the start and end locations of the last search
5334 for `ada-procedure-start-regexp'."
5335 (goto-char (car match))
5336 (let (func-found procname functype)
5338 ((or (looking-at "^[ \t]*procedure")
5339 (setq func-found (looking-at "^[ \t]*function")))
5340 ;; treat it as a proc/func
5343 (setq procname (buffer-substring (point) (cdr match))) ; store proc name
5345 ;; goto end of procname
5346 (goto-char (cdr match))
5348 ;; skip over parameterlist
5349 (unless (looking-at "[ \t\n]*\\(;\\|return\\)")
5352 ;; if function, skip over 'return' and result type.
5356 (skip-chars-forward " \t\n")
5357 (setq functype (buffer-substring (point)
5362 ;; look for next non WS
5364 ((looking-at "[ \t]*;")
5365 (delete-region (match-beginning 0) (match-end 0));; delete the ';'
5366 (ada-indent-newline-indent)
5368 (ada-indent-newline-indent)
5371 (insert "Result : " functype ";")
5372 (ada-indent-newline-indent)))
5374 (ada-indent-newline-indent)
5376 (insert "return Result;")
5378 (ada-indent-newline-indent)
5379 (insert "end " procname ";")
5380 (ada-indent-newline-indent)
5383 ((looking-at "[ \t\n]*is")
5387 ((looking-at "[ \t\n]*rename")
5392 (message "unknown syntax"))))
5394 (if (looking-at "^[ \t]*task")
5396 (message "Task conversion is not yet implemented")
5398 (if (looking-at "[ \t]*;")
5403 (defun ada-make-body ()
5404 "Create an Ada package body in the current buffer.
5405 The spec must be the previously visited buffer.
5406 This function typically is to be hooked into `ff-file-created-hook'."
5407 (delete-region (point-min) (point-max))
5408 (insert-buffer-substring (car (cdr (buffer-list))))
5409 (goto-char (point-min))
5412 (let (found ada-procedure-or-package-start-regexp)
5414 (ada-search-ignore-string-comment ada-package-start-regexp nil))
5415 (progn (goto-char (cdr found))
5418 (error "No package"))
5420 (setq ada-procedure-or-package-start-regexp
5421 (concat ada-procedure-start-regexp
5423 ada-package-start-regexp))
5426 (ada-search-ignore-string-comment
5427 ada-procedure-or-package-start-regexp nil))
5429 (goto-char (car found))
5430 (if (looking-at ada-package-start-regexp)
5431 (progn (goto-char (cdr found))
5433 (ada-gen-treat-proc found))))))
5436 (defun ada-make-subprogram-body ()
5437 "Create a dummy subprogram body in package body file from spec surrounding point."
5439 (let* ((found (re-search-backward ada-procedure-start-regexp nil t))
5440 (spec (match-beginning 0))
5445 (if (and (re-search-forward "(\\|;" nil t)
5446 (= (char-before) ?\())
5448 (ada-search-ignore-string-comment ")" nil)
5449 (ada-search-ignore-string-comment ";" nil)))
5450 (setq spec (buffer-substring spec (point)))
5452 ;; If find-file.el was available, use its functions
5453 (setq body-file (ada-get-body-name))
5455 (find-file body-file)
5456 (error "No body found for the package. Create it first"))
5460 (goto-char (point-max))
5461 (forward-comment -10000)
5462 (re-search-backward "\\<end\\>" nil t)
5463 ;; Move to the beginning of the elaboration part, if any
5464 (re-search-backward "^begin" nil t)
5468 (re-search-backward ada-procedure-start-regexp nil t)
5469 (ada-gen-treat-proc (cons (match-beginning 0) (match-end 0)))
5471 (error "Not in subprogram spec"))))
5473 ;; --------------------------------------------------------
5474 ;; Global initializations
5475 ;; --------------------------------------------------------
5477 ;; Create the keymap once and for all. If we do that in ada-mode,
5478 ;; the keys changed in the user's .emacs have to be modified
5483 ;; Create the syntax tables, but do not activate them
5484 (ada-create-syntax-table)
5486 ;; Add the default extensions (and set up speedbar)
5487 (ada-add-extensions ".ads" ".adb")
5488 ;; This two files are generated by GNAT when running with -gnatD
5489 (if (equal ada-which-compiler 'gnat)
5490 (ada-add-extensions ".ads.dg" ".adb.dg"))
5492 ;; Read the special cases for exceptions
5493 (ada-case-read-exceptions)
5495 ;; Setup auto-loading of the other Ada mode files.
5496 (autoload 'ada-change-prj "ada-xref" nil t)
5497 (autoload 'ada-check-current "ada-xref" nil t)
5498 (autoload 'ada-compile-application "ada-xref" nil t)
5499 (autoload 'ada-compile-current "ada-xref" nil t)
5500 (autoload 'ada-complete-identifier "ada-xref" nil t)
5501 (autoload 'ada-find-file "ada-xref" nil t)
5502 (autoload 'ada-find-any-references "ada-xref" nil t)
5503 (autoload 'ada-find-src-file-in-dir "ada-xref" nil t)
5504 (autoload 'ada-find-local-references "ada-xref" nil t)
5505 (autoload 'ada-find-references "ada-xref" nil t)
5506 (autoload 'ada-gdb-application "ada-xref" nil t)
5507 (autoload 'ada-goto-declaration "ada-xref" nil t)
5508 (autoload 'ada-goto-declaration-other-frame "ada-xref" nil t)
5509 (autoload 'ada-goto-parent "ada-xref" nil t)
5510 (autoload 'ada-make-body-gnatstub "ada-xref" nil t)
5511 (autoload 'ada-point-and-xref "ada-xref" nil t)
5512 (autoload 'ada-reread-prj-file "ada-xref" nil t)
5513 (autoload 'ada-run-application "ada-xref" nil t)
5514 (autoload 'ada-set-default-project-file "ada-xref" nil t)
5515 (autoload 'ada-xref-goto-previous-reference "ada-xref" nil t)
5516 (autoload 'ada-set-main-compile-application "ada-xref" nil t)
5517 (autoload 'ada-show-current-main "ada-xref" nil t)
5519 (autoload 'ada-customize "ada-prj" nil t)
5520 (autoload 'ada-prj-edit "ada-prj" nil t)
5521 (autoload 'ada-prj-new "ada-prj" nil t)
5522 (autoload 'ada-prj-save "ada-prj" nil t)
5524 (autoload 'ada-array "ada-stmt" nil t)
5525 (autoload 'ada-case "ada-stmt" nil t)
5526 (autoload 'ada-declare-block "ada-stmt" nil t)
5527 (autoload 'ada-else "ada-stmt" nil t)
5528 (autoload 'ada-elsif "ada-stmt" nil t)
5529 (autoload 'ada-exception "ada-stmt" nil t)
5530 (autoload 'ada-exception-block "ada-stmt" nil t)
5531 (autoload 'ada-exit "ada-stmt" nil t)
5532 (autoload 'ada-for-loop "ada-stmt" nil t)
5533 (autoload 'ada-function-spec "ada-stmt" nil t)
5534 (autoload 'ada-header "ada-stmt" nil t)
5535 (autoload 'ada-if "ada-stmt" nil t)
5536 (autoload 'ada-loop "ada-stmt" nil t)
5537 (autoload 'ada-package-body "ada-stmt" nil t)
5538 (autoload 'ada-package-spec "ada-stmt" nil t)
5539 (autoload 'ada-private "ada-stmt" nil t)
5540 (autoload 'ada-procedure-spec "ada-stmt" nil t)
5541 (autoload 'ada-record "ada-stmt" nil t)
5542 (autoload 'ada-subprogram-body "ada-stmt" nil t)
5543 (autoload 'ada-subtype "ada-stmt" nil t)
5544 (autoload 'ada-tabsize "ada-stmt" nil t)
5545 (autoload 'ada-task-body "ada-stmt" nil t)
5546 (autoload 'ada-task-spec "ada-stmt" nil t)
5547 (autoload 'ada-type "ada-stmt" nil t)
5548 (autoload 'ada-use "ada-stmt" nil t)
5549 (autoload 'ada-when "ada-stmt" nil t)
5550 (autoload 'ada-while-loop "ada-stmt" nil t)
5551 (autoload 'ada-with "ada-stmt" nil t)
5553 ;;; provide ourselves
5556 ;; arch-tag: 1b7d45ec-1698-43b5-8d4a-e479ea023270
5557 ;;; ada-mode.el ends here