| blob | 663f13965d154c241aed4039829c9e0de29a1d44 |
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/>.
27 ;;; Commentary:
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.
35 ;;
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
39 ;; functions.
41 ;;; Usage:
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 :
46 ;; M-x ada-mode
47 ;;
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
52 ;; won't work) :
53 ;; (setq ada-which-compiler 'generic)
54 ;;
55 ;; This mode requires find-file.el to be present on your system.
57 ;;; History:
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.
61 ;;
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.
66 ;;
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
70 ;; electric-ada.el.
71 ;;
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
76 ;; to his version.
77 ;;
78 ;; A complete rewrite for Emacs-20 / GNAT-3.11 has been done by Ada Core
79 ;; Technologies.
81 ;;; Credits:
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
87 ;; to the ada-mode
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.
97 ;;; Code:
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
102 ;; file.
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
122 ;; easily
123 ;; `abbrev-mode': Provides the capability to define abbreviations, which
124 ;; are automatically expanded when you type them. See the Emacs manual.
136 "Return Ada mode version."
141 version-string)))
144 "*List of functions to call when Ada mode is invoked.
145 This hook is automatically executed after the `ada-mode' is
146 fully loaded.
150 "Major mode for editing and compiling Ada source in Emacs."
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'."
161 "*Number of columns to indent a broken declaration.
163 An example is :
164 declare
165 A,
166 >>>>>B : Integer;"
170 "*Number of columns to indent the continuation of a broken line.
172 An example is :
173 My_Var : My_Type := (Field1 =>
174 >>>>>>>>>Value);"
178 "*Number of columns to indent the continuation of broken lines in parenthesis.
180 An example is :
181 Func (Param1,
182 >>>>>Param2);"
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'."
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
207 by a comment."
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'."
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'."
234 "*Non-nil means remove trailing spaces and untabify the buffer before saving."
238 "*Size of Ada indentation.
240 An example is :
241 procedure Foo is
242 begin
243 >>>>>>>>>>null;"
247 "*Non-nil means automatically indent after RET or LFD."
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.
255 For instance:
256 A := 1; -- A multi-line comment
257 -- aligned if ada-indent-align-comments is t"
261 "*Non-nil means indent comment lines as code.
262 A nil value means do not auto-indent comments."
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.
272 type A is
273 ( Value_1, -- common behavior, when not a comment
274 Value_2);
276 type A is
277 ( -- `ada-indent-handle-comment-special' is nil
278 Value_1,
279 Value_2);
281 type A is
282 ( -- `ada-indent-handle-comment-special' is non-nil
283 Value_1,
284 Value_2);"
288 "*Non-nil means indent 'is separate' or 'is abstract' if on a single line."
292 "*Indentation for 'record' relative to 'type' or 'use'.
294 An example is:
295 type A is
296 >>>>>>>>>>>record"
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).
304 An example is:
305 function A (B : Integer)
306 return C;
307 >>>renames Foo;"
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).
315 An example is:
316 function A (B : Integer)
317 >>>>>return C;"
321 "*Non-nil means indent according to the innermost open parenthesis."
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."
331 "*Text inserted at the end of each line when filling a comment paragraph.
332 Used by `ada-fill-comment-paragraph-postfix'."
336 "*Number of columns to indent a label.
338 An example is:
339 procedure Foo is
340 begin
341 >>>>Label:
343 This is also used for <<..>> labels"
347 "*Ada language version; one of `ada83', `ada95', `ada2005'."
351 "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'."
355 "*Key used for binding the contextual menu.
356 If nil, no contextual menu is available."
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'."
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
380 "*Number of columns to indent the end of a statement on a separate line.
382 An example is:
383 if A = B
384 >>>>then"
388 "*Control the behavior of the TAB key.
389 Must be one of :
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'."
399 "*Indentation for the lines in a 'use' statement.
401 An example is:
402 use Ada.Text_IO,
403 >>>>Ada.Numerics;"
407 "*Indentation for 'when' relative to 'exception' or 'case'.
409 An example is:
410 case A is
411 >>>>when B =>"
415 "*Indentation for the lines in a 'with' statement.
417 An example is:
418 with Ada.Text_IO,
419 >>>>Ada.Numerics;"
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
427 features.
428 `generic': Use a generic compiler."
434 ;;; ---- end of user configurable variables
435 \f
438 "List of possible suffixes for Ada body files.
442 "List of possible suffixes for Ada spec files.
454 ;; default is C-c C-q because it's free in ada-mode-map
468 ;; These values are used in eval-when-compile expressions.
478 "List of Ada 83 keywords.
483 "List of keywords new in Ada 95.
488 "List of keywords new in Ada 2005.
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
507 "Variable used by `find-file' to find the name of the other package.
515 "Ada support for align.el <= 2.2.
516 This variable provides regular expressions on which to align different lines.
535 )
536 "Ada support for align.el >= 2.8.
557 "when"
561 ;;; ---- Below are the regexp used in this package for parsing
572 ada-95-string-keywords
580 ada-2005-string-keywords
581 ada-83-string-keywords
587 ;; FIXME: make this customizable
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.
597 "^[ \t]*\\(with[ \t]+\\)?\\(\\(not[ \t]+\\)?overriding[ \t]+\\)?\\(procedure\\|function\\|task\\)[ \t\n]+"
599 ;; subprogram name: operator ("[+/=*]")
603 ;; subprogram name: name
607 "Regexp matching Ada subprogram start.
616 "Regexp matching start of package.
624 ;;; ---- regexps for indentation functions
647 "Regexp of possible ends for a non-broken statement.
685 "Position of point just before displaying the menu.
686 This is a list (point buffer).
687 Since `ada-popup-menu' moves the point where the user clicked, the region
688 is modified. Therefore no command from the menu knows what the user selected
689 before displaying the contextual menu.
690 To get the original region, restore the point to this position before
691 calling `region-end' and `region-beginning'.
695 "Menu to use when the user presses the right mouse button.
696 The variable `ada-contextual-menu-on-identifier' will be set to t before
697 displaying the menu if point was on an identifier."
712 \f
713 ;;------------------------------------------------------------------
714 ;; Support for imenu (see imenu.el)
715 ;;------------------------------------------------------------------
722 ada-imenu-comment-re
742 "Imenu generic expression for Ada mode.
743 See `imenu-generic-expression'. This variable will create several submenus for
746 \f
747 ;;------------------------------------------------------------
748 ;; Support for compile.el
749 ;;------------------------------------------------------------
752 "Mouse interface for `ada-compile-goto-error'."
756 )
759 "Replace `compile-goto-error' from compile.el.
760 If POS is on a file and line location, go to this position. It adds
761 to compile.el the capacity to go to a reference in an error message.
762 For instance, on these lines:
763 foo.adb:61:11: [...] in call to size declared at foo.ads:11
764 foo.adb:61:11: [...] in call to local declared at line 20
765 the 4 file locations can be clicked on and jumped to."
771 ;; special case: looking at a filename:line not at the beginning of a line
772 ;; or a simple line reference "at line ..."
782 )
789 source)
791 ;; set source marker
803 ))
805 ;; otherwise, default behavior
808 )
811 \f
812 ;;-------------------------------------------------------------------------
813 ;; Grammar related function
814 ;; The functions below work with the syntax class of the characters in an Ada
815 ;; buffer. Two syntax tables are created, depending on whether we want '_'
816 ;; to be considered as part of a word or not.
817 ;; Some characters may have multiple meanings depending on the context:
818 ;; - ' is either the beginning of a constant character or an attribute
819 ;; - # is either part of a based litteral or a gnatprep statement.
820 ;; - " starts a string, but not if inside a constant character.
821 ;; - ( and ) should be ignored if inside a constant character.
822 ;; Thus their syntax property is changed automatically, and we can still use
823 ;; the standard Emacs functions for sexp (see `ada-in-string-p')
824 ;;
825 ;; On Emacs, this is done through the `syntax-table' text property. The
826 ;; corresponding action is applied automatically each time the buffer
827 ;; changes. If `font-lock-mode' is enabled (the default) the action is
828 ;; set up by `font-lock-syntactic-keywords'. Otherwise, we do it
829 ;; manually in `ada-after-change-function'. The proper method is
830 ;; installed by `ada-handle-syntax-table-properties'.
831 ;;
832 ;; on XEmacs, the `syntax-table' property does not exist and we have to use a
833 ;; slow advice to `parse-partial-sexp' to do the same thing.
834 ;; When executing parse-partial-sexp, we simply modify the strings before and
835 ;; after, so that the special constants '"', '(' and ')' do not interact
836 ;; with parse-partial-sexp.
837 ;; Note: this code is slow and needs to be rewritten as soon as something
838 ;; better is available on XEmacs.
839 ;;-------------------------------------------------------------------------
842 "Create the two syntax tables use in the Ada mode.
843 The standard table declares `_' as a symbol constituent, the second one
844 declares it as a word constituent."
848 ;; define string brackets (`%' is alternative string bracket, but
849 ;; almost never used as such and throws font-lock and indentation
850 ;; off the track.)
873 ;; a single hyphen is punctuation, but a double hyphen starts a comment
876 ;; See the comment above on grammar related function for the special
877 ;; setup for '#'.
882 ;; and \f and \n end a comment
886 ;; define what belongs in Ada symbols
889 ;; define parentheses to match
895 )
897 ;; Support of special characters in XEmacs (see the comments at the beginning
898 ;; of the section on Grammar related functions).
902 "Handles special character constants and gnatprep statements."
911 1
913 change))
920 change))
922 ad-do-it
931 "Assign `syntax-table' properties in accessible part of buffer.
932 In particular, character constants are said to be strings, #...#
933 are treated as numbers instead of gnatprep comments."
939 buffer-file-name buffer-file-truename)
943 ;; The following regexp was adapted from
944 ;; `ada-font-lock-syntactic-keywords'.
946 nil t)
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."
969 "Assign `syntax-table' properties in current buffer."
978 "Handle `syntax-table' properties."
980 ;; `font-lock-mode' will take care of `syntax-table' properties.
982 ;; Take care of `syntax-table' properties manually.
985 ;;------------------------------------------------------------------
986 ;; Testing the grammatical context
987 ;;------------------------------------------------------------------
990 "Return t if inside a comment.
991 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
997 "Return t if point is inside a string.
998 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1004 "Return t if inside a comment or string.
1005 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1012 ;;------------------------------------------------------------------
1013 ;; Contextual menus
1014 ;; The Ada mode comes with contextual menus, bound by default to the right
1015 ;; mouse button.
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 ;;------------------------------------------------------------------
1022 "Execute FUNCTION when called from the contextual menu.
1023 It forces Emacs to change the cursor 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.
1052 ))
1062 ))
1065 ;;------------------------------------------------------------------
1066 ;; Misc functions
1067 ;;------------------------------------------------------------------
1069 ;;;###autoload
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
1073 extensions.
1074 SPEC and BODY are two regular expressions that must match against
1075 the file name."
1096 ;; Support for speedbar (Specifies that we want to see these files in
1097 ;; speedbar)
1101 spec)
1103 body)))
1104 )
1107 ;;;###autoload
1109 "Ada mode is the major mode for editing Ada code.
1111 Bindings are as follows: (Note: 'LFD' is control-j.)
1125 Next func/proc/task '\\[ada-next-procedure]' Previous func/proc/task '\\[ada-previous-procedure]'
1131 Comments are handled using standard GNU Emacs conventions, including:
1137 If you use imenu.el:
1140 If you use find-file.el:
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:
1159 ;; Set the paragraph delimiters so that one can select a whole block
1160 ;; simply with M-h
1164 ;; comment end must be set because it may hold a wrong value if
1165 ;; this buffer had been in another mode before. RE
1168 ;; used by autofill and indent-new-comment-line
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).
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
1201 ada-imenu-generic-expression)
1203 ;; Support for compile.el
1204 ;; We just substitute our own functions to go to the error.
1208 ;; FIXME: This has global impact! -stef
1216 ;; font-lock support :
1217 ;; We need to set some properties for XEmacs, and define some variables
1218 ;; for Emacs
1220 ;; FIXME: The Emacs code should work just fine under XEmacs AFAIK. --Stef
1222 ;; XEmacs
1226 ;; Emacs
1229 nil t
1231 beginning-of-line
1233 )
1235 ;; Set up support for find-file.el.
1247 ;; Top level child package declaration; go to the parent package.
1254 ada-search-directories-internal
1256 ada-spec-suffixes)))
1258 ;; A "separate" clause.
1262 ada-search-directories-internal
1264 ada-spec-suffixes)))
1266 ;; A "with" clause.
1270 ada-search-directories-internal
1272 ada-spec-suffixes)))
1273 ))
1275 ;; Support for outline-minor-mode
1277 "\\([ \t]*\\(procedure\\|function\\|package\\|if\\|while\\|for\\|declare\\|case\\|end\\|begin\\|loop\\)\\|--\\)")
1280 ;; Support for imenu : We want a sorted index
1283 ;; Support for ispell : Check only comments
1286 ;; Support for align
1291 ;; Exclude comments alone on line from alignment.
1330 ;; Set up the contextual menu
1334 ;; Support for Abbreviations (the user still need to "M-x abbrev-mode"
1338 ;; Support for which-function mode
1342 ;; Support for indent-new-comment-line (Especially for XEmacs)
1356 ;; remove all spaces at the end of lines in the whole buffer.
1358 ;; convert all tabs to the correct number of spaces.
1369 ;; To be run after the hook, in case the user modified
1370 ;; ada-fill-comment-prefix
1376 ;; Run this after the hook to give the users a chance to activate
1377 ;; font-lock-mode
1383 ;; the following has to be done after running the ada-mode-hook
1384 ;; because users might want to set the values of these variable
1385 ;; inside the hook
1398 "Adjust the case of the text inserted by a skeleton."
1406 "Should we operate on an active region?"
1410 \f
1411 ;;-----------------------------------------------------------------
1412 ;; auto-casing
1413 ;; Since Ada is case-insensitive, the Ada mode provides an extensive set of
1414 ;; functions to auto-case identifiers, keywords, ...
1415 ;; The basic rules for autocasing are defined through the variables
1416 ;; `ada-case-attribute', `ada-case-keyword' and `ada-case-identifier'. These
1417 ;; are references to the functions that will do the actual casing.
1418 ;;
1419 ;; However, in most cases, the user will want to define some exceptions to
1420 ;; these casing rules. This is done through a list of files, that contain
1421 ;; one word per line. These files are stored in `ada-case-exception-file'.
1422 ;; For backward compatibility, this variable can also be a string.
1423 ;;-----------------------------------------------------------------
1426 "Save the casing exception lists to the file FILE-NAME.
1427 Casing exception lists are `ada-case-exception' and `ada-case-exception-substring'."
1438 )
1441 "Define WORD as an exception for the casing system.
1442 If WORD is not given, then the current word in the buffer is used instead.
1443 The new words is added to the first file in `ada-case-exception-file'.
1444 The standard casing rules will no longer apply to this word."
1447 file-name
1448 )
1466 ;; Reread the exceptions file, in case it was modified by some other,
1469 ;; If the word is already in the list, even with a different casing
1470 ;; we simply want to replace it.
1475 )
1478 ))
1481 "Define the substring WORD as an exception for the casing system.
1482 If WORD is not given, then the current word in the buffer is used instead,
1483 or the selected region if any is active.
1484 The new word is added to the first file in `ada-case-exception-file'.
1485 When auto-casing a word, this substring will be special-cased, unless the
1486 word itself has a special casing."
1490 ada-case-exception-file)
1497 ;; Find the substring to define as an exception. Order is: the parameter,
1498 ;; if any, or the selected region, or the word under the cursor
1519 ;; Reread the exceptions file, in case it was modified by some other,
1522 ;; If the word is already in the list, even with a different casing
1523 ;; we simply want to replace it.
1528 )
1535 "Read the content of the casing exception file FILE-NAME."
1544 ;; If the item is already in the list, even with an other casing,
1545 ;; do not add it again. This way, the user can easily decide which
1546 ;; priority should be applied to each casing exception
1550 ;; Handling a substring ?
1562 )
1565 "Read all the casing exception files from `ada-case-exception-file'."
1568 ;; Reinitialize the casing exception list
1570 ada-case-exception-substring '())
1577 ada-case-exception-file))))
1580 "Adjust case of substrings in the previous word."
1586 re)
1602 )
1603 )
1605 )))
1608 "Adjust case of the previous identifier.
1609 The auto-casing is done according to the value of `ada-case-identifier'
1610 and the exceptions defined in `ada-case-exception-file'."
1622 match)
1623 ;; If we have an exception, replace the word by the correct casing
1625 ada-case-exception t))
1631 ;; Else simply re-case the word
1636 "Return t if cursor is after a keyword that is not an attribute."
1645 "Adjust the case of the word before the character just typed.
1646 If FORCE-IDENTIFIER is non-nil then also adjust keyword as identifier."
1651 ;; or if at the end of a character constant
1654 ;; or if the previous character was not part of a word
1656 ;; if in a string or a comment
1658 )
1671 ))
1672 )
1675 "Adjust the case of the previous word, and process the character just typed.
1688 ;; horrible kludge
1691 ;; horrible dekludge
1693 ;; some special keys and their bindings
1700 ;; Else just insert the character
1702 ;; if there is a keyword in front of the underscore
1703 ;; then it should be part of an identifier (MH)
1707 )
1708 ;; Restore the syntax table
1710 )
1712 ;; Else, no auto-casing
1720 ))
1723 "Modify the key bindings for all the keys that should readjust the casing."
1725 ;; Save original key-bindings to allow swapping ret/lfd
1726 ;; when casing is activated.
1727 ;; The 'or ...' is there to be sure that the value will not
1728 ;; be changed again when Ada mode is called more than once
1732 ;; Call case modifying function after certain keys.
1734 ada-mode-map
1738 ?| ?\; ?: ?' ?\" ?< ?, ?. ?> ?/ ?\n 32 ?\r )))
1741 "Upcase first letter and letters following `_' in the following word.
1742 No other letter is modified.
1743 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1757 "Do nothing. ARG is ignored.
1758 This function can be used for the auto-casing variables in Ada mode, to
1759 adapt to unusal auto-casing schemes. Since it does nothing, you can for
1760 instance use it for `ada-case-identifier' if you don't want any special
1761 auto-casing for identifiers, whereas keywords have to be lower-cased.
1762 See also `ada-auto-case' to disable auto casing altogether."
1763 )
1766 "Upcase first letter and letters following '_', lower case other letters.
1767 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1776 "Adjust the case of all words in the region between FROM and TO.
1777 Attention: This function might take very long for big regions!"
1789 ;;
1790 ;; loop: look for all identifiers, keywords, and attributes
1791 ;;
1800 ;; do nothing if it is a string or comment
1803 ;;
1804 ;; get the identifier or keyword or attribute
1805 ;;
1809 ;;
1810 ;; casing according to user-option
1811 ;;
1822 "Adjust the case of all words in the whole buffer.
1823 ATTENTION: This function might take very long for big buffers!"
1827 \f
1828 ;;--------------------------------------------------------------
1829 ;; Format Parameter Lists
1830 ;; Some special algorithms are provided to indent the parameter lists in
1831 ;; subprogram declarations. This is done in two steps:
1832 ;; - First parses the parameter list. The returned list has the following
1833 ;; format:
1834 ;; ( (<Param_Name> in? out? access? <Type_Name> <Default_Expression>)
1835 ;; ... )
1836 ;; This is done in `ada-scan-paramlist'.
1837 ;; - Delete and recreate the parameter list in function
1838 ;; `ada-insert-paramlist'.
1839 ;; Both steps are called from `ada-format-paramlist'.
1840 ;; Note: Comments inside the parameter list are lost.
1841 ;; The syntax has to be correct, or the reformating will fail.
1842 ;;--------------------------------------------------------------
1845 "Reformat the parameter list point is in."
1856 ;; check if really inside parameter list
1860 ;; find start of current parameter-list
1867 ;; find end of parameter-list
1873 ;; find end of last parameter-declaration
1877 ;; build a list of all elements of the parameter-list
1880 ;; delete the original parameter-list
1883 ;; insert the new parameter-list
1887 ;; restore syntax-table
1889 )))
1892 "Scan the parameter list found in between BEGIN and END.
1893 Return the equivalent internal parameter list."
1904 ;; loop until end of last parameter
1907 ;; find first character of parameter-declaration
1911 ;; find last character of parameter-declaration
1919 ;; read name(s) of parameter(s)
1926 ;; look for 'in'
1935 ;; look for 'out'
1944 ;; look for 'access'
1953 ;; skip 'in'/'out'/'access'
1960 ;; read type of parameter
1961 ;; We accept spaces in the name, since some software like Rose
1962 ;; generates something like: "A : B 'Class"
1968 ;; read default-expression, if there is one
1977 nil))))
1979 ;; add this parameter-declaration to the list
1982 ;; check if it was the last parameter
1986 )
1990 "Insert a formatted PARAMLIST in the buffer."
2000 ;; loop until last parameter
2004 ;; get max length of parameter-name
2007 ;; get max length of type-name
2010 ;; is there any 'in' ?
2013 ;; is there any 'out' ?
2016 ;; is there any 'access' ?
2018 )
2020 ;; does paramlist already start on a separate line ?
2024 ;; yes => re-indent it
2031 ;; no => insert it where we are after removing any whitespace
2047 ;; loop until last parameter
2052 ;; insert parameter-name, space and colon
2058 ;; insert 'in' or space
2063 accessp)
2067 ;; insert 'out' or space
2072 accessp)
2076 ;; insert 'access'
2082 ;; insert type-name and, if necessary, space and default-expression
2089 ;; check if it was the last parameter
2092 ;; no => insert ';' and newline and indent
2096 )
2098 ;; if anything follows, except semicolon, newline, is or return
2099 ;; put it in a new line and indent it
2102 ))
2105 \f
2106 ;;;----------------------------------------------------------------
2107 ;; Indentation Engine
2108 ;; All indentations are indicated as a two-element string:
2109 ;; - position of reference in the buffer
2110 ;; - offset to indent from this position (can also be a symbol or a list
2111 ;; that are evaluated)
2112 ;; Thus the total indentation for a line is the column number of the reference
2113 ;; position plus whatever value the evaluation of the second element provides.
2114 ;; This mechanism is used so that the Ada mode can "explain" how the
2115 ;; indentation was calculated, by showing which variables were used.
2116 ;;
2117 ;; The indentation itself is done in only one pass: first we try to guess in
2118 ;; what context we are by looking at the following keyword or punctuation
2119 ;; sign. If nothing remarkable is found, just try to guess the indentation
2120 ;; based on previous lines.
2121 ;;
2122 ;; The relevant functions for indentation are:
2123 ;; - `ada-indent-region': Re-indent a region of text
2124 ;; - `ada-justified-indent-current': Re-indent the current line and shows the
2125 ;; calculation that were done
2126 ;; - `ada-indent-current': Re-indent the current line
2127 ;; - `ada-get-current-indent': Calculate the indentation for the current line,
2128 ;; based on the context (see above).
2129 ;; - `ada-get-indent-*': Calculate the indentation in a specific context.
2130 ;; For efficiency, these functions do not check they are in the correct
2131 ;; context.
2132 ;;;----------------------------------------------------------------
2135 "Indent the region between BEG end END."
2143 ;; catch errors while indenting
2157 "Indent the current line, insert a newline and then indent the new line."
2164 "Insert a newline and indent it.
2165 The original line is indented first if `ada-indent-after-return' is non-nil."
2172 "Indent the current line and explain how the calculation was done."
2191 ))
2199 "Re-indent and re-case all the files found on the command line.
2200 This function should be used from the Unix/Windows command line, with a
2201 command like:
2202 emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
2216 "Move point to the beginning of the previous word of Ada code.
2217 Return the new position of point or nil if not found."
2221 "Indent current line as Ada code.
2222 Return the calculation that was done, including the reference point and the
2223 offset."
2227 cur-indent tmp-indent
2228 prev-indent)
2234 ;; This need to be done here so that the advice is not always
2235 ;; activated (this might interact badly with other modes)
2242 ;; Not First line in the buffer ?
2248 ;; first line in the buffer
2251 ;; Evaluate the list to get the column to indent to
2252 ;; prev-indent contains the column to indent to
2265 )
2268 ;; only re-indent if indentation is different then the current
2270 nil
2274 ;;
2275 ;; restore position of point
2276 ;;
2281 ;; restore syntax-table
2285 )
2287 cur-indent
2288 ))
2291 "Return the indentation to use for the current line."
2293 pos
2294 match-cons
2295 result
2305 ;;-----------------------------
2306 ;; in open parenthesis, but not in parameter-list
2307 ;;-----------------------------
2313 ;; check if we have something like this (Table_Component_Type =>
2314 ;; Source_File_Record)
2317 ;; Align the closing parenthesis on the opening one
2328 ;; ??? Could use a different variable
2331 ;; We want all continuation lines to be indented the same
2332 ;; (ada-broken-line from the opening parenthesis. However, in
2333 ;; parameter list, each new parameter should be indented at the
2334 ;; column as the opening parenthesis.
2336 ;; A special case to handle nested boolean expressions, as in
2337 ;; ((B
2338 ;; and then C) -- indented by ada-broken-indent
2339 ;; or else D) -- indenting this line.
2340 ;; ??? This is really a hack, we should have a proper way to go to
2341 ;; ??? the beginning of the statement
2349 )))))
2351 ;;---------------------------
2352 ;; at end of buffer
2353 ;;---------------------------
2358 ;;---------------------------
2359 ;; starting with e
2360 ;;---------------------------
2365 ;; ------- end ------
2369 limit)
2373 ;;
2374 ;; found 'loop' => skip back to 'while' or 'for'
2375 ;; if 'loop' is not on a separate line
2376 ;; Stop the search for 'while' and 'for' when a ';' is encountered.
2377 ;;
2396 ;; found 'record' =>
2397 ;; if the keyword is found at the beginning of a line (or just
2398 ;; after limited, we indent on it, otherwise we indent on the
2399 ;; beginning of the type declaration)
2400 ;; type A is (B : Integer;
2401 ;; C : Integer) is record
2402 ;; end record; -- This is badly indented otherwise
2412 ;; Else keep the same indentation as the beginning statement
2415 ;; ------ exception ----
2422 ;; else
2432 ;; elsif
2439 ))
2441 ;;---------------------------
2442 ;; starting with w (when)
2443 ;;---------------------------
2452 ;;---------------------------
2453 ;; starting with t (then)
2454 ;;---------------------------
2462 ;; Select has been added for the statement: "select ... then abort"
2468 ;;---------------------------
2469 ;; starting with l (loop)
2470 ;;---------------------------
2482 nil pos))
2487 ;;----------------------------
2488 ;; starting with l (limited) or r (record)
2489 ;;----------------------------
2505 ;;---------------------------
2506 ;; starting with b (begin)
2507 ;;---------------------------
2516 ;;---------------------------
2517 ;; starting with i (is)
2518 ;;---------------------------
2538 ;;---------------------------
2539 ;; starting with r (return, renames)
2540 ;;---------------------------
2547 ;; If looking at a renames, skip the 'return' statement too
2562 ;; If there is a parameter list, and we have a function declaration
2563 ;; or a access to subprogram declaration
2575 ;; The indentation depends of the value of ada-indent-return
2579 var))
2581 ;; Else there is no parameter list, but we have a function
2582 ;; Only do something special if the user want to indent
2583 ;; relative to the "function" keyword
2589 ;; Else...
2592 ;;--------------------------------
2593 ;; starting with 'o' or 'p'
2594 ;; 'or' as statement-start
2595 ;; 'private' as statement-start
2596 ;;--------------------------------
2603 ;; ??? Wasn't this done already in ada-looking-at-semi-or ?
2607 ;;--------------------------------
2608 ;; starting with 'd' (do)
2609 ;;--------------------------------
2617 ;;--------------------------------
2618 ;; starting with '-' (comment)
2619 ;;--------------------------------
2624 ;; Indent comments on previous line comments if required
2625 ;; We must use a search-forward (even if the code is more complex),
2626 ;; since we want to find the beginning of the comment.
2637 t))
2640 pos))
2643 ;; Else always on previous line
2646 ;; Else same indentation as the previous line
2649 ;;--------------------------------
2650 ;; starting with '#' (preprocessor line)
2651 ;;--------------------------------
2658 ;;--------------------------------
2659 ;; starting with ')' (end of a parameter list)
2660 ;;--------------------------------
2668 ;;---------------------------------
2669 ;; new/abstract/separate
2670 ;;---------------------------------
2675 ;;---------------------------------
2676 ;; package/function/procedure
2677 ;;---------------------------------
2682 ;; Go up until we find either a generic section, or the end of the
2683 ;; previous subprogram/package
2689 ;; avoid "with procedure"... in generic parts
2698 ;;---------------------------------
2699 ;; label
2700 ;;---------------------------------
2708 ))
2710 ;;---------------------------------
2711 ;; Other syntaxes
2712 ;;---------------------------------
2716 "Calculate the indentation for the new line after ORGPOINT.
2717 The result list is based on the previous lines in the buffer.
2718 If NOMOVE is nil, moves point to the beginning of the current statement.
2719 if INITIAL-POS is non-nil, moves point to INITIAL-POS before calculation."
2724 ;; Is inside a parameter-list ?
2728 ;; move to beginning of current statement
2732 ;; no beginning found => don't change indentation
2738 ;;
2740 ada-indent-to-open-paren
2743 ;;
2746 ;;
2749 ;;
2752 ;;
2755 ;;
2758 ;;
2759 ;; "then" has to be included in the case of "select...then abort"
2760 ;; statements, since (goto-stmt-start) at the beginning of
2761 ;; the current function would leave the cursor on that position
2764 ;;
2767 ;;
2770 ;;
2773 ;;
2777 ;; A label
2782 ;;
2784 ;; Are we still in that statement, or are we in fact looking at
2785 ;; the previous one ?
2789 'ada-with-indent
2791 ;;
2794 ))
2797 "Calculate the indentation when point is behind an unclosed parenthesis."
2801 "Return the current indentation of the previous line."
2808 "Calculate the indentation when point is inside a parameter list."
2812 ;; in front of the first parameter
2817 ;; in front of another parameter
2823 ;; After an affectation (default parameter value in subprogram
2824 ;; declaration)
2829 ;; inside a parameter declaration
2836 "Calculate the indentation when point is just before an end statement.
2837 ORGPOINT is the limit position used in the calculation."
2841 ;; is the line already terminated by ';' ?
2846 ;; yes, look what's following 'end'
2855 ;;
2856 ;; loop/select/if/case/record/select
2857 ;;
2861 ;; we are now looking at the matching "record" statement
2864 ;; now on the matching type declaration, or use clause
2868 ;;
2869 ;; a named block end
2870 ;;
2877 ;;
2878 ;; a block-end without name
2879 ;;
2888 indent))
2890 )))
2891 ;;
2892 ;; anything else - should maybe signal an error ?
2893 ;;
2902 "Calculate the indentation when point is just before a case statement.
2903 ORGPOINT is the limit position used in the calculation."
2907 ;;
2908 ;; case..is..when..=>
2909 ;;
2912 ;; the `=>' must be after the keyword `is'.
2922 ;;
2923 ;; case..is..when
2924 ;;
2930 ;;
2931 ;; case..is
2932 ;;
2937 ;;
2938 ;; incomplete case
2939 ;;
2945 "Calculate the indentation when point is just before a when statement.
2946 ORGPOINT is the limit position used in the calculation."
2953 "Calculate the indentation when point is just before an if statement.
2954 ORGPOINT is the limit position used in the calculation."
2957 ;;
2958 ;; Move to the correct then (ignore all "and then")
2959 ;;
2962 nil orgpoint))
2964 ;; If "then" was found (we are looking at it)
2967 ;;
2968 ;; 'then' first in separate line ?
2969 ;; => indent according to 'then',
2970 ;; => else indent according to 'if'
2971 ;;
2976 ;; skip 'then'
2983 "Calculate the indentation when point is at the start of a block.
2984 ORGPOINT is the limit position used in the calculation."
2994 ;; Special case for record types, for instance for:
2995 ;; type A is (B : Integer;
2996 ;; C : Integer) is record
2997 ;; null; -- This is badly indented otherwise
3000 ;; If record is at the beginning of the line, indent from there
3006 ;; else indent relative to the type command
3011 ;; nothing follows the block-start
3016 "Calculate the indentation when point is just before a subprogram.
3017 ORGPOINT is the limit position used in the calculation."
3021 ;;
3022 ;; is there an 'is' in front of point ?
3023 ;;
3028 ;;
3029 ;; yes, then skip to its end
3030 ;;
3034 ;;
3035 ;; no, then goto next non-ws, if there is one in front of point
3036 ;;
3042 ;;
3043 ;; nothing follows 'is'
3044 ;;
3046 foundis
3051 ;;
3052 ;; is abstract/separate/new ...
3053 ;;
3055 foundis
3060 nil orgpoint))))
3064 ;;
3065 ;; something follows 'is'
3066 ;;
3068 foundis
3072 ;;
3073 ;; no 'is' but ';'
3074 ;;
3078 ;;
3079 ;; no 'is' or ';'
3080 ;;
3085 "Calculate the indentation when point is just before a 'noindent stmt'.
3086 ORGPOINT is the limit position used in the calculation."
3093 ;; This one is called when indenting a line preceded by a multi-line
3094 ;; subprogram declaration (in that case, we are at this point inside
3095 ;; the parameter declaration list)
3100 ;; This one is called when indenting the second line of a multi-line
3101 ;; declaration section, in a declare block or a record declaration
3106 ;; This one is called in every over case when indenting a line at the
3107 ;; top level
3114 ;; "with private" or "null record" cases
3139 "Calculate the indentation when before a label or variable declaration.
3140 ORGPOINT is the limit position used in the calculation."
3145 ;; loop label
3148 ada-loop-start-re nil orgpoint)))
3152 ;; declare label
3159 ;; variable declaration
3166 ;; nothing follows colon
3171 "Calculate the indentation when just before a loop or a for ... use.
3172 ORGPOINT is the limit position used in the calculation."
3176 ;; If looking at a named block, skip the label
3185 ;;
3186 ;; statement complete
3187 ;;
3192 ;;
3193 ;; simple loop
3194 ;;
3198 pos
3201 ;;
3202 ;; 'for'- loop (or also a for ... use statement)
3203 ;;
3206 ;;
3207 ;; for ... use
3208 ;;
3217 ;;
3218 ;; check if there is a 'record' before point
3219 ;;
3223 t)))
3229 )
3231 ;;
3232 ;; for..loop
3233 ;;
3238 ;;
3239 ;; indent according to 'loop', if it's first in the line;
3240 ;; otherwise to 'for'
3241 ;;
3248 ;;
3249 ;; for-statement is broken
3250 ;;
3255 ;;
3256 ;; 'while'-loop
3257 ;;
3259 ;;
3260 ;; while..loop ?
3261 ;;
3268 ;;
3269 ;; indent according to 'loop', if it's first in the line;
3270 ;; otherwise to 'while'.
3271 ;;
3283 "Calculate the indentation when before a type statement.
3284 ORGPOINT is the limit position used in the calculation."
3287 ;;
3288 ;; complete record declaration
3289 ;;
3301 ;;
3302 ;; record type
3303 ;;
3309 ;;
3310 ;; complete type declaration
3311 ;;
3316 ;;
3317 ;; "type ... is", but not "type ... is ...", which is broken
3318 ;;
3325 ;;
3326 ;; broken statement
3327 ;;
3332 \f
3333 ;; -----------------------------------------------------------
3334 ;; -- searching and matching
3335 ;; -----------------------------------------------------------
3338 "Move point to the beginning of the statement that point is in or after.
3339 Return the new position of point.
3340 As a special case, if we are looking at a closing parenthesis, skip to the
3341 open parenthesis."
3348 ;;
3349 ;; found a previous end-statement => check if anything follows
3350 ;;
3356 ;;
3357 ;; nothing follows => it's the end-statement directly in
3358 ;; front of point => search again
3359 ;;
3361 ;;
3362 ;; if found the correct end-statement => goto next non-ws
3363 ;;
3367 ))
3369 ;;
3370 ;; no previous end-statement => we are at the beginning of the
3371 ;; accessible part of the buffer
3372 ;;
3375 ;;
3376 ;; skip to the very first statement, if there is one
3377 ;;
3384 "Move point to previous end statement.
3385 Return a cons cell whose car is the beginning and whose cdr
3386 is the end of the match."
3390 ;; search until found or beginning-of-buffer
3395 ada-end-stmt-re t)))
3416 ;; words that can go after an 'is'
3432 )))
3435 match-dat
3436 nil)))
3440 "Skip white spaces, newlines and comments to next non-ws character.
3441 Stop the search at LIMIT.
3442 Do not call this function from within a string."
3453 nil)
3454 )
3458 "Move point to the end of the statement that point is in or before.
3459 Return the new position of point or nil if not found.
3460 Stop the search at LIMIT."
3463 nil))
3467 "Move point to the beginning of the next word of Ada code.
3468 If BACKWARD is non-nil, jump to the beginning of the previous word.
3469 Return the new position of point or nil if not found."
3480 ;;
3481 ;; move to the beginning of the word found
3482 ;;
3487 ;;
3488 ;; if not found, restore old position of point
3489 ;;
3493 )
3497 "Signal an error if matching block start is not KEYWORD.
3498 Moves point to the matching block start."
3505 "Check if the name of the matching defun really is DEFUN-NAME.
3506 Assumes point to be already positioned by `ada-goto-matching-start'.
3507 Moves point to the beginning of the declaration."
3509 ;; named block without a `declare'
3513 t ; do nothing
3514 ;;
3515 ;; 'accept' or 'package' ?
3516 ;;
3519 ;;
3520 ;; 'begin' of 'procedure'/'function'/'task' or 'declare'
3521 ;;
3523 ;;
3524 ;; a named 'declare'-block ? => jump to the label
3525 ;;
3528 ;;
3529 ;; no, => 'procedure'/'function'/'task'/'protected'
3530 ;;
3534 ;;
3535 ;; skip 'body' 'type'
3536 ;;
3541 ;;
3542 ;; should be looking-at the correct name
3543 ;;
3550 "Move point to the matching declaration start of the current 'begin'.
3551 If NOERROR is non-nil, it only returns nil if no match was found."
3554 ;; first should be set to t if we should stop at the first
3555 ;; "begin" we encounter.
3559 )
3561 ;; Ignore "when" most of the time, except if we are looking at the
3562 ;; beginning of a block (structure: case .. is
3563 ;; when ... =>
3564 ;; begin ...
3565 ;; exception ... )
3577 ;; search backward for interesting keywords
3581 ;;
3582 ;; calculate nest-depth
3583 ;;
3585 ;;
3589 ;; In some case, two begin..end block can follow each other closely,
3590 ;; which we have to detect, as in
3591 ;; procedure P is
3592 ;; procedure Q is
3593 ;; begin
3594 ;; end;
3595 ;; begin -- here we should go to procedure, not begin
3596 ;; end
3602 ;; If begin was just there as the beginning of a block
3603 ;; (with no declare) then do nothing, otherwise just
3604 ;; register that we have to find the statement that
3605 ;; required the begin
3609 t)
3613 ;; (ada-goto-matching-decl-start noerror t)
3618 ))
3619 )))
3620 ;;
3626 ;;
3635 ;;
3639 ;;
3641 ;; check if it is only a type definition, but not a protected
3642 ;; type definition, which should be handled like a procedure.
3648 ;; Detect if we have a closing parenthesis (Could be
3649 ;; either the end of subprogram parameters or (<>)
3650 ;; in a type definition
3656 ))
3670 ;;
3676 ;;
3680 ;;
3688 ))))
3689 ;;
3692 ;;
3699 ;; check if declaration-start is really found
3705 t
3708 ))
3711 "Move point to the beginning of a block-start.
3712 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3713 If NOERROR is non-nil, it only returns nil if no matching start was found.
3714 If GOTOTHEN is non-nil, point moves to the 'then' following 'if'."
3719 ;; List all keywords encountered while traversing
3720 ;; something like '("end" "end" "begin")
3721 ;; This is removed from the list when "package", "procedure",...
3722 ;; are seen. The goal is to find whether a package has an elaboration
3723 ;; part
3727 ;; search backward for interesting keywords
3737 ;; calculate nest-depth
3739 ;; found block end => increase nest depth
3744 ;; found loop/select/record/case/if => check if it starts or
3745 ;; ends a block
3749 ;; check if keyword follows 'end'
3753 ;; it ends a block => increase nest depth
3758 ;; it starts a block => decrease nest depth
3761 ;; Some nested "begin .. end" blocks with no "declare"?
3762 ;; => remove those entries
3767 ))
3769 )
3771 ;; found package start => check if it really is a block
3774 ;; ignore if this is just a renames statement
3781 "No matching 'is' or 'renames' for 'package' at"
3782 " line "
3788 ;; ignore it if it is only a declaration with 'new'
3789 ;; We could have package Foo is new ....
3790 ;; or package Foo is separate;
3791 ;; or package Foo is begin null; end Foo
3792 ;; for elaboration code (elaboration)
3798 )
3799 ;; found task start => check if it has a body
3807 ;; In that case, do nothing if there is a "is"
3811 ;; Do nothing if we are simply looking at a simple
3812 ;; "task type name;" statement with no block
3815 ;; Skip the parameters
3826 ;; Check if that task declaration had a block attached to
3827 ;; it (i.e do nothing if we have just "task name;")
3832 )
3835 ;; remove entry for begin and end (include nested begin..end
3836 ;; groups)
3844 )))
3847 ;; Ignore if this is just a declaration
3854 ;; remove entry for end
3860 ;; Ignore if this is just a declaration
3867 ;; remove entry for begin and end
3869 )
3871 ;; all the other block starts
3876 )
3878 ;; match is found, if nest-depth is zero
3884 ;;
3885 ;; match found => is there anything else to do ?
3886 ;;
3889 ;;
3890 ;; found 'if' => skip to 'then', if it's on a separate line
3891 ;; and GOTOTHEN is non-nil
3892 ;;
3894 gotothen
3903 ;;
3904 ;; found 'do' => skip back to 'accept'
3905 ;;
3908 "accept" t nil nil
3914 nil
3919 "Move point to the end of a block.
3920 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3921 If NOERROR is non-nil, it only returns nil if no matching start found."
3929 found
3930 pos
3932 ;; First is used for subprograms: they are generally handled
3933 ;; recursively, but of course we do not want to do that the
3934 ;; first time (see comment below about subprograms)
3937 ;; If we are already looking at one of the keywords, this shouldn't count
3938 ;; in the nesting loop below, so we just make sure we don't count it.
3939 ;; "declare" is a special case because we need to look after the "begin"
3940 ;; keyword
3944 ;;
3945 ;; search forward for interesting keywords
3946 ;;
3951 ;;
3952 ;; calculate nest-depth
3953 ;;
3956 ;; procedures and functions need to be processed recursively, in
3957 ;; case they are defined in a declare/begin block, as in:
3958 ;; declare -- NL 0 (nested level)
3959 ;; A : Boolean;
3960 ;; procedure B (C : D) is
3961 ;; begin -- NL 1
3962 ;; null;
3963 ;; end B; -- NL 0, and we would exit
3964 ;; begin
3965 ;; end; -- we should exit here
3966 ;; processing them recursively avoids the need for any special
3967 ;; handling.
3968 ;; Nothing should be done if we have only the specs or a
3969 ;; generic instantion.
3985 ;; found block end => decrease nest depth
3989 ;; skip the following keyword
3996 ;; found package start => check if it really starts a block, and is not
3997 ;; in fact a generic instantiation for instance
4002 ;; ignore and skip it if it is only a 'new' package
4008 ;; all the other block starts
4018 t
4020 nil
4022 ))
4027 "Regexp-search for SEARCH-RE, ignoring comments, strings.
4028 Returns a cons cell of begin and end of match data or nil, if not found.
4029 If BACKWARD is non-nil, search backward; search forward otherwise.
4030 The search stops at pos LIMIT.
4031 If PARAMLISTS is nil, ignore parameter lists.
4032 The search is done using SEARCH-FUNC. SEARCH-FUNC can be optimized
4033 in case we are searching for a constant string.
4034 Point is moved at the beginning of the SEARCH-RE."
4036 begin
4037 end
4038 parse-result
4041 ;; FIXME: need to pass BACKWARD to search-func!
4045 ;;
4046 ;; search until found or end-of-buffer
4047 ;; We have to test that we do not look further than limit
4048 ;;
4063 ;;
4064 ;; If inside a string, skip it (and the following comments)
4065 ;;
4071 ;;
4072 ;; If inside a comment, skip it (and the following comments)
4073 ;; There is a special code for comments at the end of the file
4074 ;;
4083 ;; at the end of the file, it is not possible to skip a comment
4084 ;; so we just go at the end of the line
4090 ;;
4091 ;; directly in front of a comment => skip it, if searching forward
4092 ;;
4096 ;;
4097 ;; found a parameter-list but should ignore it => skip it
4098 ;;
4103 ;;
4104 ;; found what we were looking for
4105 ;;
4113 nil)))
4115 ;; -------------------------------------------------------
4116 ;; -- Testing the position of the cursor
4117 ;; -------------------------------------------------------
4120 "Return t if point is inside a declarative part.
4121 Assumes point to be at the end of a statement."
4128 "Return t if looking at an 'or' following a semicolon."
4138 "Return t if looking at the start of a private section in a package.
4139 Return nil if the private is part of the package name, as in
4140 'private package A is...' (this can only happen at top level)."
4145 ;; Make sure this is the start of a private section (ie after
4146 ;; a semicolon or just after the package declaration, but not
4147 ;; after a 'type ... is private' or 'is new ... with private'
4148 ;;
4149 ;; Note that a 'private' statement at the beginning of the buffer
4150 ;; does not indicate a private section, since this is instead a
4151 ;; 'private procedure ...'
4160 "Return t if point is inside a parameter-list."
4164 ;; inside parentheses ?
4167 ;; We could be looking at two things here:
4168 ;; operator definition: function "." (
4169 ;; subprogram definition: procedure .... (
4170 ;; Let's skip back over the first one
4176 t)
4178 ;; and now over the second one
4181 ;; We should ignore the case when the reserved keyword is in a
4182 ;; comment (for instance, when we have:
4183 ;; -- .... package
4184 ;; Test (A)
4185 ;; we should return nil
4189 ;; right keyword two words before parenthesis ?
4190 ;; Type is in this list because of discriminants
4201 "Search for REGEXP, ignoring comments, strings, 'and then', 'or else'.
4202 If BACKWARDP is non-nil, search backward; search forward otherwise."
4207 result))
4210 "Non-nil if in an open parenthesis.
4211 Return value is the position of the first non-ws behind the last unclosed
4212 parenthesis, or nil."
4218 t))
4225 ;; Skip blanks, if they are not followed by a comment
4226 ;; See:
4227 ;; type A is ( Value_0,
4228 ;; Value_1);
4229 ;; type B is ( -- comment
4230 ;; Value_2);
4238 \f
4239 ;; -----------------------------------------------------------
4240 ;; -- Behavior Of TAB Key
4241 ;; -----------------------------------------------------------
4244 "Do indenting or tabbing according to `ada-tab-policy'.
4245 In Transient Mark mode, if the mark is active, operate on the contents
4246 of the region. Otherwise, operate only on the current line."
4254 ))
4257 "Delete leading indenting according to `ada-tab-policy'."
4258 ;; FIXME: ARG is ignored
4263 ))
4266 "Ada mode version of the `indent-line-function'."
4274 ))
4277 "Indent current line to next tab stop."
4286 "Indent current line to previous tab stop."
4293 \f
4294 ;; ------------------------------------------------------------
4295 ;; -- Miscellaneous
4296 ;; ------------------------------------------------------------
4298 ;; Not needed any more for Emacs 21.2, but still needed for backward
4299 ;; compatibility
4301 "Remove trailing spaces in the whole buffer."
4312 "Clean up comments, `(' and `,' for GNAT style checking switch."
4316 ;; The \n is required, or the line after an empty comment line is
4317 ;; simply ignored.
4346 ;; Make sure there is a space after a ','.
4347 ;; Always go back to the beginning of the match, since otherwise
4348 ;; a statement like ('F','D','E') is incorrectly modified.
4356 ;; Operators should be surrounded by spaces.
4360 nil t)
4379 ))
4382 \f
4383 ;; -------------------------------------------------------------
4384 ;; -- Moving To Procedures/Packages/Statements
4385 ;; -------------------------------------------------------------
4388 "Move point to the matching start of the current Ada structure."
4397 ;;
4398 ;; do nothing if in string or comment or not on 'end ...;'
4399 ;; or if an error occurs during processing
4400 ;;
4413 ;;
4414 ;; on 'begin' => go on, according to user option
4415 ;;
4416 ada-move-to-declaration
4423 ;; now really move to the found position
4426 ;; restore syntax-table
4430 "Move point to the matching end of the block around point.
4431 Moves to 'begin' if in a declarative part."
4434 decl-start
4443 ;; Go to the beginning of the current word, and check if we are
4444 ;; directly on 'begin'
4449 )
4451 ;; on first line of subprogram body
4452 ;; Do nothing for specs or generic instantion, since these are
4453 ;; handled as the general case (find the enclosing block)
4454 ;; We also need to make sure that we ignore nested subprograms
4460 ))
4464 ;; on first line of task declaration
4473 ;; accept block start
4478 ;; package start
4484 ;; On a "declare" keyword
4490 ;; inside a 'begin' ... 'end' block
4495 ;; (hopefully ;-) everything else
4499 )
4501 ;; now really move to the position found
4504 ;; restore syntax-table
4508 "Move point to next procedure."
4516 "Move point to previous procedure."
4524 "Move point to next package."
4532 "Move point to previous package."
4539 \f
4540 ;; ------------------------------------------------------------
4541 ;; -- Define keymap and menus for Ada
4542 ;; -------------------------------------------------------------
4545 "Create the keymap associated with the Ada mode."
4547 ;; All non-standard keys go into ada-mode-extra-map
4550 ;; Indentation and Formatting
4558 ;; We don't want to make meta-characters case-specific.
4560 ;; Movement
4566 ;; Compilation
4570 ;; Casing
4576 ;; On XEmacs, you can easily specify whether DEL should deletes
4577 ;; one character forward or one character backward. Take this into
4578 ;; account
4581 'backward-delete-char-untabify)
4583 ;; Make body
4584 (define-key ada-mode-map "\C-c\C-n" 'ada-make-subprogram-body)
4586 ;; Use predefined function of Emacs19 for comments (RE)
4587 (define-key ada-mode-map "\C-c;" 'comment-region)
4588 (define-key ada-mode-map "\C-c:" 'ada-uncomment-region)
4590 ;; The following keys are bound to functions defined in ada-xref.el or
4591 ;; ada-prj,el., However, RMS rightly thinks that the code should be shared,
4592 ;; and activated only if the right compiler is used
4594 (define-key ada-mode-map (if (featurep 'xemacs) '(shift button3) [S-mouse-3])
4595 'ada-point-and-xref)
4596 (define-key ada-mode-map [(control tab)] 'ada-complete-identifier)
4598 (define-key ada-mode-extra-map "o" 'ff-find-other-file)
4599 (define-key ada-mode-map "\C-c5\C-d" 'ada-goto-declaration-other-frame)
4600 (define-key ada-mode-map "\C-c\C-d" 'ada-goto-declaration)
4601 (define-key ada-mode-map "\C-c\C-s" 'ada-xref-goto-previous-reference)
4602 (define-key ada-mode-map "\C-c\C-c" 'ada-compile-application)
4603 (define-key ada-mode-extra-map "c" 'ada-change-prj)
4604 (define-key ada-mode-extra-map "d" 'ada-set-default-project-file)
4605 (define-key ada-mode-extra-map "g" 'ada-gdb-application)
4606 (define-key ada-mode-map "\C-c\C-m" 'ada-set-main-compile-application)
4607 (define-key ada-mode-extra-map "r" 'ada-run-application)
4608 (define-key ada-mode-map "\C-c\C-o" 'ada-goto-parent)
4609 (define-key ada-mode-map "\C-c\C-r" 'ada-find-references)
4610 (define-key ada-mode-extra-map "l" 'ada-find-local-references)
4611 (define-key ada-mode-map "\C-c\C-v" 'ada-check-current)
4612 (define-key ada-mode-extra-map "f" 'ada-find-file)
4614 (define-key ada-mode-extra-map "u" 'ada-prj-edit)
4616 ;; The templates, defined in ada-stmt.el
4618 (let ((map (make-sparse-keymap)))
4619 (define-key map "h" 'ada-header)
4620 (define-key map "\C-a" 'ada-array)
4621 (define-key map "b" 'ada-exception-block)
4622 (define-key map "d" 'ada-declare-block)
4623 (define-key map "c" 'ada-case)
4624 (define-key map "\C-e" 'ada-elsif)
4625 (define-key map "e" 'ada-else)
4626 (define-key map "\C-k" 'ada-package-spec)
4627 (define-key map "k" 'ada-package-body)
4628 (define-key map "\C-p" 'ada-procedure-spec)
4629 (define-key map "p" 'ada-subprogram-body)
4630 (define-key map "\C-f" 'ada-function-spec)
4631 (define-key map "f" 'ada-for-loop)
4632 (define-key map "i" 'ada-if)
4633 (define-key map "l" 'ada-loop)
4634 (define-key map "\C-r" 'ada-record)
4635 (define-key map "\C-s" 'ada-subtype)
4636 (define-key map "S" 'ada-tabsize)
4637 (define-key map "\C-t" 'ada-task-spec)
4638 (define-key map "t" 'ada-task-body)
4639 (define-key map "\C-y" 'ada-type)
4640 (define-key map "\C-v" 'ada-private)
4641 (define-key map "u" 'ada-use)
4642 (define-key map "\C-u" 'ada-with)
4643 (define-key map "\C-w" 'ada-when)
4644 (define-key map "w" 'ada-while-loop)
4645 (define-key map "\C-x" 'ada-exception)
4646 (define-key map "x" 'ada-exit)
4647 (define-key ada-mode-extra-map "t" map))
4648 )
4651 (defun ada-create-menu ()
4652 "Create the Ada menu as shown in the menu bar."
4653 (let ((m '("Ada"
4654 ("Help"
4655 ["Ada Mode" (info "ada-mode") t]
4656 ["GNAT User's Guide" (info "gnat_ugn")
4657 (eq ada-which-compiler 'gnat)]
4658 ["GNAT Reference Manual" (info "gnat_rm")
4659 (eq ada-which-compiler 'gnat)]
4660 ["Gcc Documentation" (info "gcc")
4661 (eq ada-which-compiler 'gnat)]
4662 ["Gdb Documentation" (info "gdb")
4663 (eq ada-which-compiler 'gnat)]
4664 ["Ada95 Reference Manual" (info "arm95") t])
4665 ("Options" :included (eq major-mode 'ada-mode)
4666 ["Auto Casing" (setq ada-auto-case (not ada-auto-case))
4667 :style toggle :selected ada-auto-case]
4668 ["Auto Indent After Return"
4669 (setq ada-indent-after-return (not ada-indent-after-return))
4670 :style toggle :selected ada-indent-after-return]
4671 ["Automatically Recompile For Cross-references"
4672 (setq ada-xref-create-ali (not ada-xref-create-ali))
4673 :style toggle :selected ada-xref-create-ali
4674 :included (eq ada-which-compiler 'gnat)]
4675 ["Confirm Commands"
4676 (setq ada-xref-confirm-compile (not ada-xref-confirm-compile))
4677 :style toggle :selected ada-xref-confirm-compile
4678 :included (eq ada-which-compiler 'gnat)]
4679 ["Show Cross-references In Other Buffer"
4680 (setq ada-xref-other-buffer (not ada-xref-other-buffer))
4681 :style toggle :selected ada-xref-other-buffer
4682 :included (eq ada-which-compiler 'gnat)]
4683 ["Tight Integration With GNU Visual Debugger"
4684 (setq ada-tight-gvd-integration (not ada-tight-gvd-integration))
4685 :style toggle :selected ada-tight-gvd-integration
4686 :included (string-match "gvd" ada-prj-default-debugger)])
4687 ["Customize" (customize-group 'ada)
4688 :included (fboundp 'customize-group)]
4689 ["Check file" ada-check-current t]
4690 ["Compile file" ada-compile-current t]
4691 ["Set main and Build" ada-set-main-compile-application t]
4692 ["Show main" ada-show-current-main t]
4693 ["Build" ada-compile-application t]
4694 ["Run" ada-run-application t]
4695 ["Debug" ada-gdb-application (eq ada-which-compiler 'gnat)]
4696 ["------" nil nil]
4697 ("Project"
4698 ["Show project" ada-show-current-project t]
4699 ["Load..." ada-set-default-project-file t]
4700 ["New..." ada-prj-new t]
4701 ["Edit..." ada-prj-edit t])
4702 ("Goto" :included (eq major-mode 'ada-mode)
4703 ["Goto Declaration/Body" ada-goto-declaration
4704 (eq ada-which-compiler 'gnat)]
4705 ["Goto Body" ada-goto-body
4706 (eq ada-which-compiler 'gnat)]
4707 ["Goto Declaration Other Frame"
4708 ada-goto-declaration-other-frame
4709 (eq ada-which-compiler 'gnat)]
4710 ["Goto Previous Reference" ada-xref-goto-previous-reference
4711 (eq ada-which-compiler 'gnat)]
4712 ["List Local References" ada-find-local-references
4713 (eq ada-which-compiler 'gnat)]
4714 ["List References" ada-find-references
4715 (eq ada-which-compiler 'gnat)]
4716 ["Goto Reference To Any Entity" ada-find-any-references
4717 (eq ada-which-compiler 'gnat)]
4718 ["Goto Parent Unit" ada-goto-parent
4719 (eq ada-which-compiler 'gnat)]
4720 ["--" nil nil]
4721 ["Next compilation error" next-error t]
4722 ["Previous Package" ada-previous-package t]
4723 ["Next Package" ada-next-package t]
4724 ["Previous Procedure" ada-previous-procedure t]
4725 ["Next Procedure" ada-next-procedure t]
4726 ["Goto Start Of Statement" ada-move-to-start t]
4727 ["Goto End Of Statement" ada-move-to-end t]
4728 ["-" nil nil]
4729 ["Other File" ff-find-other-file t]
4730 ["Other File Other Window" ada-ff-other-window t])
4731 ("Edit" :included (eq major-mode 'ada-mode)
4732 ["Search File On Source Path" ada-find-file t]
4733 ["------" nil nil]
4734 ["Complete Identifier" ada-complete-identifier t]
4735 ["-----" nil nil]
4736 ["Indent Line" ada-indent-current-function t]
4737 ["Justify Current Indentation" ada-justified-indent-current t]
4738 ["Indent Lines in Selection" ada-indent-region t]
4739 ["Indent Lines in File"
4740 (ada-indent-region (point-min) (point-max)) t]
4741 ["Format Parameter List" ada-format-paramlist t]
4742 ["-" nil nil]
4743 ["Comment Selection" comment-region t]
4744 ["Uncomment Selection" ada-uncomment-region t]
4745 ["--" nil nil]
4746 ["Fill Comment Paragraph" fill-paragraph t]
4747 ["Fill Comment Paragraph Justify"
4748 ada-fill-comment-paragraph-justify t]
4749 ["Fill Comment Paragraph Postfix"
4750 ada-fill-comment-paragraph-postfix t]
4751 ["---" nil nil]
4752 ["Adjust Case Selection" ada-adjust-case-region t]
4753 ["Adjust Case in File" ada-adjust-case-buffer t]
4754 ["Create Case Exception" ada-create-case-exception t]
4755 ["Create Case Exception Substring"
4756 ada-create-case-exception-substring t]
4757 ["Reload Case Exceptions" ada-case-read-exceptions t]
4758 ["----" nil nil]
4759 ["Make body for subprogram" ada-make-subprogram-body t]
4760 ["-----" nil nil]
4761 ["Narrow to subprogram" ada-narrow-to-defun t])
4762 ("Templates"
4763 :included (eq major-mode 'ada-mode)
4764 ["Header" ada-header t]
4765 ["-" nil nil]
4766 ["Package Body" ada-package-body t]
4767 ["Package Spec" ada-package-spec t]
4768 ["Function Spec" ada-function-spec t]
4769 ["Procedure Spec" ada-procedure-spec t]
4770 ["Proc/func Body" ada-subprogram-body t]
4771 ["Task Body" ada-task-body t]
4772 ["Task Spec" ada-task-spec t]
4773 ["Declare Block" ada-declare-block t]
4774 ["Exception Block" ada-exception-block t]
4775 ["--" nil nil]
4776 ["Entry" ada-entry t]
4777 ["Entry family" ada-entry-family t]
4778 ["Select" ada-select t]
4779 ["Accept" ada-accept t]
4780 ["Or accept" ada-or-accep t]
4781 ["Or delay" ada-or-delay t]
4782 ["Or terminate" ada-or-terminate t]
4783 ["---" nil nil]
4784 ["Type" ada-type t]
4785 ["Private" ada-private t]
4786 ["Subtype" ada-subtype t]
4787 ["Record" ada-record t]
4788 ["Array" ada-array t]
4789 ["----" nil nil]
4790 ["If" ada-if t]
4791 ["Else" ada-else t]
4792 ["Elsif" ada-elsif t]
4793 ["Case" ada-case t]
4794 ["-----" nil nil]
4795 ["While Loop" ada-while-loop t]
4796 ["For Loop" ada-for-loop t]
4797 ["Loop" ada-loop t]
4798 ["------" nil nil]
4799 ["Exception" ada-exception t]
4800 ["Exit" ada-exit t]
4801 ["When" ada-when t])
4802 )))
4804 (easy-menu-define ada-mode-menu ada-mode-map "Menu keymap for Ada mode" m)
4805 (if (featurep 'xemacs)
4806 (progn
4807 (define-key ada-mode-map [menu-bar] ada-mode-menu)
4808 (set 'mode-popup-menu (cons "Ada mode" ada-mode-menu))))))
4810 \f
4811 ;; -------------------------------------------------------
4812 ;; Commenting/Uncommenting code
4813 ;; The following two calls are provided to enhance the standard
4814 ;; comment-region function, which only allows uncommenting if the
4815 ;; comment is at the beginning of a line. If the line have been re-indented,
4816 ;; we are unable to use comment-region, which makes no sense.
4817 ;;
4818 ;; In addition, we provide an interface to the standard comment handling
4819 ;; function for justifying the comments.
4820 ;; -------------------------------------------------------
4822 (defadvice comment-region (before ada-uncomment-anywhere disable)
4823 (if (and (consp arg) ;; a prefix with \C-u is of the form '(4), whereas
4824 ;; \C-u 2 sets arg to '2' (fixed by S.Leake)
4825 (derived-mode-p 'ada-mode))
4826 (save-excursion
4828 (goto-char beg)
4829 (while (re-search-forward cs end t)
4830 (replace-match comment-start))
4831 ))))
4833 (defun ada-uncomment-region (beg end &optional arg)
4834 "Uncomment region BEG .. END.
4835 ARG gives number of comment characters."
4838 ;; This advice is not needed anymore with Emacs21. However, for older
4839 ;; versions, as well as for XEmacs, we still need to enable it.
4840 (if (or (<= emacs-major-version 20) (featurep 'xemacs))
4841 (progn
4842 (ad-activate 'comment-region)
4843 (comment-region beg end (- (or arg 2)))
4844 (ad-deactivate 'comment-region))
4845 (comment-region beg end (list (- (or arg 2))))
4846 (ada-indent-region beg end)))
4848 (defun ada-fill-comment-paragraph-justify ()
4849 "Fill current comment paragraph and justify each line as well."
4850 (interactive)
4851 (ada-fill-comment-paragraph 'full))
4853 (defun ada-fill-comment-paragraph-postfix ()
4854 "Fill current comment paragraph and justify each line as well.
4855 Adds `ada-fill-comment-postfix' at the end of each line."
4856 (interactive)
4857 (ada-fill-comment-paragraph 'full t))
4859 (defun ada-fill-comment-paragraph (&optional justify postfix)
4860 "Fill the current comment paragraph.
4861 If JUSTIFY is non-nil, each line is justified as well.
4862 If POSTFIX and JUSTIFY are non-nil, `ada-fill-comment-postfix' is appended
4863 to each line filled and justified.
4864 The paragraph is indented on the first line."
4865 (interactive "P")
4867 ;; check if inside comment or just in front a comment
4868 (if (and (not (ada-in-comment-p))
4870 (error "Not inside comment"))
4872 (let* (indent from to
4873 (opos (point-marker))
4875 ;; Sets this variable to nil, otherwise it prevents
4876 ;; fill-region-as-paragraph to work on Emacs <= 20.2
4877 (parse-sexp-lookup-properties nil)
4879 fill-prefix
4880 (fill-column (current-fill-column)))
4882 ;; Find end of paragraph
4883 (back-to-indentation)
4885 (forward-line 1)
4887 ;; If we were at the last line in the buffer, create a dummy empty
4888 ;; line at the end of the buffer.
4889 (if (eobp)
4891 (back-to-indentation)))
4892 (beginning-of-line)
4893 (setq to (point-marker))
4894 (goto-char opos)
4896 ;; Find beginning of paragraph
4897 (back-to-indentation)
4899 (forward-line -1)
4900 (back-to-indentation))
4902 ;; We want one line above the first one, unless we are at the beginning
4903 ;; of the buffer
4904 (unless (bobp)
4905 (forward-line 1))
4906 (beginning-of-line)
4907 (setq from (point-marker))
4909 ;; Calculate the indentation we will need for the paragraph
4910 (back-to-indentation)
4911 (setq indent (current-column))
4912 ;; unindent the first line of the paragraph
4913 (delete-region from (point))
4915 ;; Remove the old postfixes
4916 (goto-char from)
4920 (goto-char (1- to))
4921 (setq to (point-marker))
4923 ;; Indent and justify the paragraph
4924 (setq fill-prefix ada-fill-comment-prefix)
4925 (set-left-margin from to indent)
4926 (if postfix
4927 (setq fill-column (- fill-column (length ada-fill-comment-postfix))))
4929 (fill-region-as-paragraph from to justify)
4931 ;; Add the postfixes if required
4932 (if postfix
4933 (save-restriction
4934 (goto-char from)
4935 (narrow-to-region from to)
4936 (while (not (eobp))
4937 (end-of-line)
4938 (insert-char ? (- fill-column (current-column)))
4939 (insert ada-fill-comment-postfix)
4940 (forward-line))
4941 ))
4943 ;; In Emacs <= 20.2 and XEmacs <=20.4, there is a bug, and a newline is
4944 ;; inserted at the end. Delete it
4945 (if (or (featurep 'xemacs)
4946 (<= emacs-major-version 19)
4947 (and (= emacs-major-version 20)
4948 (<= emacs-minor-version 2)))
4949 (progn
4950 (goto-char to)
4951 (end-of-line)
4952 (delete-char 1)))
4954 (goto-char opos)))
4957 ;; ---------------------------------------------------
4958 ;; support for find-file.el
4959 ;; These functions are used by find-file to guess the file names from
4960 ;; unit names, and to find the other file (spec or body) from the current
4961 ;; file (body or spec).
4962 ;; It is also used to find in which function we are, so as to put the
4963 ;; cursor at the correct position.
4964 ;; Standard Ada does not force any relation between unit names and file names,
4965 ;; so some of these functions can only be a good approximation. However, they
4966 ;; are also overridden in `ada-xref'.el when we know that the user is using
4967 ;; GNAT.
4968 ;; ---------------------------------------------------
4970 ;; Overridden when we work with GNAT, to use gnatkrunch
4971 (defun ada-make-filename-from-adaname (adaname)
4972 "Determine the filename in which ADANAME is found.
4973 This matches the GNAT default naming convention, except for
4974 pre-defined units."
4976 (setq adaname (replace-match "-" t t adaname)))
4977 (downcase adaname)
4978 )
4980 (defun ada-other-file-name ()
4981 "Return the name of the other file.
4982 The name returned is the body if `current-buffer' is the spec,
4983 or the spec otherwise."
4985 (let ((is-spec nil)
4986 (is-body nil)
4987 (suffixes ada-spec-suffixes)
4988 (name (buffer-file-name)))
4990 ;; Guess whether we have a spec or a body, and get the basename of the
4991 ;; file. Since the extension may not start with '.', we can not use
4992 ;; file-name-extension
4993 (while (and (not is-spec)
4994 suffixes)
4996 (setq is-spec t
4997 name (match-string 1 name)))
4998 (setq suffixes (cdr suffixes)))
5000 (if (not is-spec)
5001 (progn
5002 (setq suffixes ada-body-suffixes)
5003 (while (and (not is-body)
5004 suffixes)
5006 (setq is-body t
5007 name (match-string 1 name)))
5008 (setq suffixes (cdr suffixes)))))
5010 ;; If this wasn't in either list, return name itself
5011 (if (not (or is-spec is-body))
5012 name
5014 ;; Else find the other possible names
5015 (if is-spec
5016 (setq suffixes ada-body-suffixes)
5017 (setq suffixes ada-spec-suffixes))
5018 (setq is-spec name)
5020 (while suffixes
5022 ;; If we are using project file, search for the other file in all
5023 ;; the possible src directories.
5025 (if (fboundp 'ada-find-src-file-in-dir)
5026 (let ((other
5027 (ada-find-src-file-in-dir
5028 (file-name-nondirectory (concat name (car suffixes))))))
5029 (if other
5030 (set 'is-spec other)))
5032 ;; Else search in the current directory
5033 (if (file-exists-p (concat name (car suffixes)))
5034 (setq is-spec (concat name (car suffixes)))))
5035 (setq suffixes (cdr suffixes)))
5037 is-spec)))
5039 (defun ada-which-function-are-we-in ()
5040 "Return the name of the function whose definition/declaration point is in.
5041 Used in `ff-pre-load-hook'."
5042 (setq ff-function-name nil)
5043 (save-excursion
5044 (end-of-line);; make sure we get the complete name
5045 (or (if (re-search-backward ada-procedure-start-regexp nil t)
5046 (setq ff-function-name (match-string 5)))
5047 (if (re-search-backward ada-package-start-regexp nil t)
5048 (setq ff-function-name (match-string 4))))
5049 ))
5052 (defvar ada-last-which-function-line -1
5053 "Last line on which `ada-which-function' was called.")
5054 (defvar ada-last-which-function-subprog 0
5055 "Last subprogram name returned by `ada-which-function'.")
5056 (make-variable-buffer-local 'ada-last-which-function-subprog)
5057 (make-variable-buffer-local 'ada-last-which-function-line)
5060 (defun ada-which-function ()
5061 "Return the name of the function whose body the point is in.
5062 This function works even in the case of nested subprograms, whereas the
5063 standard Emacs function `which-function' does not.
5064 Since the search can be long, the results are cached."
5066 (let ((line (count-lines 1 (point)))
5067 (pos (point))
5068 end-pos
5069 func-name indent
5070 found)
5072 ;; If this is the same line as before, simply return the same result
5073 (if (= line ada-last-which-function-line)
5074 ada-last-which-function-subprog
5076 (save-excursion
5077 ;; In case the current line is also the beginning of the body
5078 (end-of-line)
5083 (condition-case nil
5084 (up-list 1)
5085 (error nil))
5088 (if (looking-at "return")
5089 (progn
5090 (forward-word 1)
5092 (skip-chars-forward "a-zA-Z0-9_'")))
5094 ;; Can't simply do forward-word, in case the "is" is not on the
5095 ;; same line as the closing parenthesis
5098 ;; No look for the closest subprogram body that has not ended yet.
5099 ;; Not that we expect all the bodies to be finished by "end <name>",
5100 ;; or a simple "end;" indented in the same column as the start of
5101 ;; the subprogram. The goal is to be as efficient as possible.
5103 (while (and (not found)
5104 (re-search-backward ada-imenu-subprogram-menu-re nil t))
5106 ;; Get the function name, but not the properties, or this changes
5107 ;; the face in the modeline on Emacs 21
5108 (setq func-name (match-string-no-properties 2))
5109 (if (and (not (ada-in-comment-p))
5110 (not (save-excursion
5111 (goto-char (match-end 0))
5113 (save-excursion
5114 (back-to-indentation)
5115 (setq indent (current-column))
5116 (if (ada-search-ignore-string-comment
5118 (make-string indent ? ) "end;"))
5119 (setq end-pos (point))
5120 (setq end-pos (point-max)))
5121 (if (>= end-pos pos)
5122 (setq found func-name))))
5123 )
5124 (setq ada-last-which-function-line line
5125 ada-last-which-function-subprog found)
5126 found))))
5128 (defun ada-ff-other-window ()
5129 "Find other file in other window using `ff-find-other-file'."
5130 (interactive)
5131 (and (fboundp 'ff-find-other-file)
5132 (ff-find-other-file t)))
5134 (defun ada-set-point-accordingly ()
5135 "Move to the function declaration that was set by `ff-which-function-are-we-in'."
5136 (if ff-function-name
5137 (progn
5138 (goto-char (point-min))
5139 (unless (ada-search-ignore-string-comment
5141 (goto-char (point-min))))))
5143 (defun ada-get-body-name (&optional spec-name)
5144 "Return the file name for the body of SPEC-NAME.
5145 If SPEC-NAME is nil, return the body for the current package.
5146 Return nil if no body was found."
5147 (interactive)
5149 (unless spec-name (setq spec-name (buffer-file-name)))
5151 ;; Remove the spec extension. We can not simply remove the file extension,
5152 ;; but we need to take into account the specific non-GNAT extensions that the
5153 ;; user might have specified.
5155 (let ((suffixes ada-spec-suffixes)
5156 end)
5157 (while suffixes
5158 (setq end (- (length spec-name) (length (car suffixes))))
5159 (if (string-equal (car suffixes) (substring spec-name end))
5160 (setq spec-name (substring spec-name 0 end)))
5161 (setq suffixes (cdr suffixes))))
5163 ;; If find-file.el was available, use its functions
5164 (if (fboundp 'ff-get-file-name)
5165 (ff-get-file-name ada-search-directories-internal
5166 (ada-make-filename-from-adaname
5167 (file-name-nondirectory
5168 (file-name-sans-extension spec-name)))
5169 ada-body-suffixes)
5170 ;; Else emulate it very simply
5171 (concat (ada-make-filename-from-adaname
5172 (file-name-nondirectory
5173 (file-name-sans-extension spec-name)))
5174 ".adb")))
5176 \f
5177 ;; ---------------------------------------------------
5178 ;; support for font-lock.el
5179 ;; Strings are a real pain in Ada because a single quote character is
5180 ;; overloaded as a string quote and type/instance delimiter. By default, a
5181 ;; single quote is given punctuation syntax in `ada-mode-syntax-table'.
5182 ;; So, for Font Lock mode purposes, we mark single quotes as having string
5183 ;; syntax when the gods that created Ada determine them to be.
5184 ;;
5185 ;; This only works in Emacs. See the comments before the grammar functions
5186 ;; at the beginning of this file for how this is done with XEmacs.
5187 ;; ----------------------------------------------------
5189 (defconst ada-font-lock-syntactic-keywords
5190 ;; Mark single quotes as having string quote syntax in 'c' instances.
5191 ;; We used to explicitly avoid ''' as a special case for fear the buffer
5192 ;; be highlighted as a string, but it seems this fear is unfounded.
5196 (defvar ada-font-lock-keywords
5197 (eval-when-compile
5198 (list
5199 ;;
5200 ;; handle "type T is access function return S;"
5203 ;; preprocessor line
5206 ;;
5207 ;; accept, entry, function, package (body), protected (body|type),
5208 ;; pragma, procedure, task (body) plus name.
5209 (list (concat
5223 "task"
5226 '(1 font-lock-keyword-face) '(2 font-lock-function-name-face nil t))
5227 ;;
5228 ;; Optional keywords followed by a type name.
5230 "\\<\\(access[ \t]+all\\|access[ \t]+constant\\|access\\|constant\\|in[ \t]+reverse\\|\\|in[ \t]+out\\|in\\|out\\)\\>"
5233 '(1 font-lock-keyword-face nil t) '(2 font-lock-type-face nil t))
5235 ;;
5236 ;; Main keywords, except those treated specially below.
5238 (regexp-opt
5239 '("abort" "abs" "abstract" "accept" "access" "aliased" "all"
5240 "and" "array" "at" "begin" "case" "declare" "delay" "delta"
5241 "digits" "do" "else" "elsif" "entry" "exception" "exit" "for"
5242 "generic" "if" "in" "interface" "is" "limited" "loop" "mod" "not"
5243 "null" "or" "others" "overriding" "private" "protected" "raise"
5244 "range" "record" "rem" "renames" "requeue" "return" "reverse"
5245 "select" "separate" "synchronized" "tagged" "task" "terminate"
5246 "then" "until" "when" "while" "with" "xor") t)
5248 ;;
5249 ;; Anything following end and not already fontified is a body name.
5251 (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
5252 ;;
5253 ;; Keywords followed by a type or function name.
5257 '(1 font-lock-keyword-face)
5258 '(2 (if (match-beginning 4)
5259 font-lock-function-name-face
5260 font-lock-type-face) nil t))
5261 ;;
5262 ;; Keywords followed by a (comma separated list of) reference.
5263 ;; Note that font-lock only works on single lines, thus we can not
5264 ;; correctly highlight a with_clause that spans multiple lines.
5267 '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
5269 ;;
5270 ;; Goto tags.
5273 ;; Highlight based-numbers (R. Reagan <robin-reply@reagans.org>)
5276 ;; Ada unnamed numerical constants
5279 ))
5280 "Default expressions to highlight in Ada mode.")
5283 ;; ---------------------------------------------------------
5284 ;; Support for outline.el
5285 ;; ---------------------------------------------------------
5287 (defun ada-outline-level ()
5288 "This is so that `current-column' DTRT in otherwise-hidden text."
5289 ;; patch from Dave Love <fx@gnu.org>
5290 (let (buffer-invisibility-spec)
5291 (save-excursion
5292 (back-to-indentation)
5293 (current-column))))
5295 ;; ---------------------------------------------------------
5296 ;; Support for narrow-to-region
5297 ;; ---------------------------------------------------------
5299 (defun ada-narrow-to-defun (&optional arg)
5300 "Make text outside current subprogram invisible.
5301 The subprogram visible is the one that contains or follow point.
5302 Optional ARG is ignored.
5305 (interactive)
5306 (save-excursion
5307 (let (end)
5308 (widen)
5309 (forward-line 1)
5310 (ada-previous-procedure)
5312 (save-excursion
5313 (beginning-of-line)
5314 (setq end (point)))
5316 (ada-move-to-end)
5317 (end-of-line)
5318 (narrow-to-region end (point))
5319 (message
5320 "Use M-x widen to get back to full visibility in the buffer"))))
5322 ;; ---------------------------------------------------------
5323 ;; Automatic generation of code
5324 ;; The Ada mode has a set of function to automatically generate a subprogram
5325 ;; or package body from its spec.
5326 ;; These function only use a primary and basic algorithm, this could use a
5327 ;; lot of improvement.
5328 ;; When the user is using GNAT, we rather use gnatstub to generate an accurate
5329 ;; body.
5330 ;; ----------------------------------------------------------
5332 (defun ada-gen-treat-proc (match)
5333 "Make dummy body of a procedure/function specification.
5334 MATCH is a cons cell containing the start and end locations of the last search
5335 for `ada-procedure-start-regexp'."
5336 (goto-char (car match))
5337 (let (func-found procname functype)
5338 (cond
5341 ;; treat it as a proc/func
5342 (forward-word 2)
5343 (forward-word -1)
5344 (setq procname (buffer-substring (point) (cdr match))) ; store proc name
5346 ;; goto end of procname
5347 (goto-char (cdr match))
5349 ;; skip over parameterlist
5351 (forward-sexp))
5353 ;; if function, skip over 'return' and result type.
5354 (if func-found
5355 (progn
5356 (forward-word 1)
5358 (setq functype (buffer-substring (point)
5359 (progn
5360 (skip-chars-forward
5361 "a-zA-Z0-9_\.")
5362 (point))))))
5363 ;; look for next non WS
5364 (cond
5366 (delete-region (match-beginning 0) (match-end 0));; delete the ';'
5367 (ada-indent-newline-indent)
5368 (insert "is")
5369 (ada-indent-newline-indent)
5370 (if func-found
5371 (progn
5372 (insert "Result : " functype ";")
5373 (ada-indent-newline-indent)))
5374 (insert "begin")
5375 (ada-indent-newline-indent)
5376 (if func-found
5377 (insert "return Result;")
5378 (insert "null;"))
5379 (ada-indent-newline-indent)
5380 (insert "end " procname ";")
5381 (ada-indent-newline-indent)
5382 )
5383 ;; else
5385 ;; do nothing
5386 )
5388 ;; do nothing
5389 )
5390 (t
5391 (message "unknown syntax"))))
5392 (t
5394 (progn
5395 (message "Task conversion is not yet implemented")
5396 (forward-word 2)
5398 (forward-line)
5399 (ada-move-to-end))
5400 ))))))
5402 (defun ada-make-body ()
5403 "Create an Ada package body in the current buffer.
5404 The spec must be the previously visited buffer.
5405 This function typically is to be hooked into `ff-file-created-hook'."
5406 (delete-region (point-min) (point-max))
5407 (insert-buffer-substring (car (cdr (buffer-list))))
5408 (goto-char (point-min))
5409 (ada-mode)
5411 (let (found ada-procedure-or-package-start-regexp)
5412 (if (setq found
5413 (ada-search-ignore-string-comment ada-package-start-regexp nil))
5414 (progn (goto-char (cdr found))
5415 (insert " body")
5416 )
5417 (error "No package"))
5419 (setq ada-procedure-or-package-start-regexp
5420 (concat ada-procedure-start-regexp
5422 ada-package-start-regexp))
5424 (while (setq found
5425 (ada-search-ignore-string-comment
5426 ada-procedure-or-package-start-regexp nil))
5427 (progn
5428 (goto-char (car found))
5429 (if (looking-at ada-package-start-regexp)
5430 (progn (goto-char (cdr found))
5431 (insert " body"))
5432 (ada-gen-treat-proc found))))))
5435 (defun ada-make-subprogram-body ()
5436 "Create a dummy subprogram body in package body file from spec surrounding point."
5437 (interactive)
5438 (let* ((found (re-search-backward ada-procedure-start-regexp nil t))
5439 (spec (match-beginning 0))
5440 body-file)
5441 (if found
5442 (progn
5443 (goto-char spec)
5445 (= (char-before) ?\())
5446 (progn
5447 (ada-search-ignore-string-comment ")" nil)
5448 (ada-search-ignore-string-comment ";" nil)))
5449 (setq spec (buffer-substring spec (point)))
5451 ;; If find-file.el was available, use its functions
5452 (setq body-file (ada-get-body-name))
5453 (if body-file
5454 (find-file body-file)
5455 (error "No body found for the package. Create it first"))
5457 (save-restriction
5458 (widen)
5459 (goto-char (point-max))
5460 (forward-comment -10000)
5462 ;; Move to the beginning of the elaboration part, if any
5463 (re-search-backward "^begin" nil t)
5464 (newline)
5465 (forward-char -1)
5466 (insert spec)
5467 (re-search-backward ada-procedure-start-regexp nil t)
5468 (ada-gen-treat-proc (cons (match-beginning 0) (match-end 0)))
5469 ))
5470 (error "Not in subprogram spec"))))
5472 ;; --------------------------------------------------------
5473 ;; Global initializations
5474 ;; --------------------------------------------------------
5476 ;; Create the keymap once and for all. If we do that in ada-mode,
5477 ;; the keys changed in the user's .emacs have to be modified
5478 ;; every time
5479 (ada-create-keymap)
5480 (ada-create-menu)
5482 ;; Create the syntax tables, but do not activate them
5483 (ada-create-syntax-table)
5485 ;; Add the default extensions (and set up speedbar)
5486 (ada-add-extensions ".ads" ".adb")
5487 ;; This two files are generated by GNAT when running with -gnatD
5488 (if (equal ada-which-compiler 'gnat)
5489 (ada-add-extensions ".ads.dg" ".adb.dg"))
5491 ;; Read the special cases for exceptions
5492 (ada-case-read-exceptions)
5494 ;; Setup auto-loading of the other Ada mode files.
5495 (autoload 'ada-change-prj "ada-xref" nil t)
5496 (autoload 'ada-check-current "ada-xref" nil t)
5497 (autoload 'ada-compile-application "ada-xref" nil t)
5498 (autoload 'ada-compile-current "ada-xref" nil t)
5499 (autoload 'ada-complete-identifier "ada-xref" nil t)
5500 (autoload 'ada-find-file "ada-xref" nil t)
5501 (autoload 'ada-find-any-references "ada-xref" nil t)
5502 (autoload 'ada-find-src-file-in-dir "ada-xref" nil t)
5503 (autoload 'ada-find-local-references "ada-xref" nil t)
5504 (autoload 'ada-find-references "ada-xref" nil t)
5505 (autoload 'ada-gdb-application "ada-xref" nil t)
5506 (autoload 'ada-goto-declaration "ada-xref" nil t)
5507 (autoload 'ada-goto-declaration-other-frame "ada-xref" nil t)
5508 (autoload 'ada-goto-parent "ada-xref" nil t)
5509 (autoload 'ada-make-body-gnatstub "ada-xref" nil t)
5510 (autoload 'ada-point-and-xref "ada-xref" nil t)
5511 (autoload 'ada-reread-prj-file "ada-xref" nil t)
5512 (autoload 'ada-run-application "ada-xref" nil t)
5513 (autoload 'ada-set-default-project-file "ada-xref" nil nil)
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
5554 (provide 'ada-mode)
5556 ;; arch-tag: 1b7d45ec-1698-43b5-8d4a-e479ea023270
5557 ;;; ada-mode.el ends here