| blob | 26b68bf9c2b85129374c73a934f186f535f3b1da |
1 ;;; ada-mode.el --- major-mode for editing Ada sources
3 ;; Copyright (C) 1994, 1995, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 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.
135 "Return Ada mode version."
140 version-string)))
143 "*List of functions to call when Ada mode is invoked.
144 This hook is automatically executed after the `ada-mode' is
145 fully loaded.
149 "Major mode for editing and compiling Ada source in Emacs."
154 "*Non-nil means automatically change case of preceding word while typing.
155 Casing is done according to `ada-case-keyword', `ada-case-identifier'
156 and `ada-case-attribute'."
160 "*Number of columns to indent a broken declaration.
162 An example is :
163 declare
164 A,
165 >>>>>B : Integer;"
169 "*Number of columns to indent the continuation of a broken line.
171 An example is :
172 My_Var : My_Type := (Field1 =>
173 >>>>>>>>>Value);"
177 "*Number of columns to indent the continuation of broken lines in parenthesis.
179 An example is :
180 Func (Param1,
181 >>>>>Param2);"
185 "*Function to call to adjust the case of Ada attributes.
186 It may be `downcase-word', `upcase-word', `ada-loose-case-word',
187 `ada-capitalize-word' or `ada-no-auto-case'."
197 "*List of special casing exceptions dictionaries for identifiers.
198 The first file is the one where new exceptions will be saved by Emacs
199 when you call `ada-create-case-exception'.
201 These files should contain one word per line, that gives the casing
202 to be used for that word in Ada files. If the line starts with the
203 character *, then the exception will be used for substrings that either
204 start at the beginning of a word or after a _ character, and end either
205 at the end of the word or at a _ character. Each line can be terminated
206 by a comment."
211 "*Function to call to adjust the case of an Ada keywords.
212 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
213 `ada-capitalize-word'."
222 "*Function to call to adjust the case of an Ada identifier.
223 It may be `downcase-word', `upcase-word', `ada-loose-case-word' or
224 `ada-capitalize-word'."
232 ;; FIXME If this is not something required by the ada language, this
233 ;; should be removed.
235 "*Non-nil means remove trailing spaces and untabify the buffer before saving."
239 "*Size of Ada indentation.
241 An example is :
242 procedure Foo is
243 begin
244 >>>>>>>>>>null;"
248 "*Non-nil means automatically indent after RET or LFD."
252 "*Non-nil means align comments on previous line comments, if any.
253 If nil, indentation is calculated as usual.
254 Note that indentation is calculated only if `ada-indent-comment-as-code' is t.
256 For instance:
257 A := 1; -- A multi-line comment
258 -- aligned if ada-indent-align-comments is t"
262 "*Non-nil means indent comment lines as code.
263 A nil value means do not auto-indent comments."
267 "*Non-nil if comment lines should be handled specially inside parenthesis.
268 By default, if the line that contains the open parenthesis has some
269 text following it, then the following lines will be indented in the
270 same column as this text. This will not be true if the first line is
271 a comment and `ada-indent-handle-comment-special' is t.
273 type A is
274 ( Value_1, -- common behavior, when not a comment
275 Value_2);
277 type A is
278 ( -- `ada-indent-handle-comment-special' is nil
279 Value_1,
280 Value_2);
282 type A is
283 ( -- `ada-indent-handle-comment-special' is non-nil
284 Value_1,
285 Value_2);"
289 "*Non-nil means indent 'is separate' or 'is abstract' if on a single line."
293 "*Indentation for 'record' relative to 'type' or 'use'.
295 An example is:
296 type A is
297 >>>>>>>>>>>record"
301 "*Indentation for renames relative to the matching function statement.
302 If `ada-indent-return' is null or negative, the indentation is done relative to
303 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
305 An example is:
306 function A (B : Integer)
307 return C;
308 >>>renames Foo;"
312 "*Indentation for 'return' relative to the matching 'function' statement.
313 If `ada-indent-return' is null or negative, the indentation is done relative to
314 the open parenthesis (if there is no parenthesis, `ada-broken-indent' is used).
316 An example is:
317 function A (B : Integer)
318 >>>>>return C;"
322 "*Non-nil means indent according to the innermost open parenthesis."
326 "*Text inserted in the first columns when filling a comment paragraph.
327 Note: if you modify this variable, you will have to invoke `ada-mode'
328 again to take account of the new value."
332 "*Text inserted at the end of each line when filling a comment paragraph.
333 Used by `ada-fill-comment-paragraph-postfix'."
337 "*Number of columns to indent a label.
339 An example is:
340 procedure Foo is
341 begin
342 >>>>Label:
344 This is also used for <<..>> labels"
348 "*Ada language version; one of `ada83', `ada95', `ada2005'."
352 "*Non-nil means `ada-move-to-start' moves to the subprogram declaration, not to 'begin'."
356 "*Key used for binding the contextual menu.
357 If nil, no contextual menu is available."
366 "*Default list of directories to search for Ada files.
367 See the description for the `ff-search-directories' variable. This variable
368 is the initial value of `ada-search-directories-internal'."
375 "Internal version of `ada-search-directories'.
376 Its value is the concatenation of the search path as read in the project file
377 and the standard runtime location, and the value of the user-defined
381 "*Number of columns to indent the end of a statement on a separate line.
383 An example is:
384 if A = B
385 >>>>then"
389 "*Control the behavior of the TAB key.
390 Must be one of :
391 `indent-rigidly' : always adds `ada-indent' blanks at the beginning of the line.
392 `indent-auto' : use indentation functions in this file.
393 `always-tab' : do `indent-relative'."
400 "*Indentation for the lines in a 'use' statement.
402 An example is:
403 use Ada.Text_IO,
404 >>>>Ada.Numerics;"
408 "*Indentation for 'when' relative to 'exception' or 'case'.
410 An example is:
411 case A is
412 >>>>when B =>"
416 "*Indentation for the lines in a 'with' statement.
418 An example is:
419 with Ada.Text_IO,
420 >>>>Ada.Numerics;"
424 "*Name of the compiler to use.
425 This will determine what features are made available through the Ada mode.
426 The possible choices are:
427 `gnat': Use Ada Core Technologies' GNAT compiler. Add some cross-referencing
428 features.
429 `generic': Use a generic compiler."
435 ;;; ---- end of user configurable variables
436 \f
439 "List of possible suffixes for Ada body files.
443 "List of possible suffixes for Ada spec files.
455 ;; default is C-c C-q because it's free in ada-mode-map
469 ;; These values are used in eval-when-compile expressions.
479 "List of Ada 83 keywords.
484 "List of keywords new in Ada 95.
489 "List of keywords new in Ada 2005.
499 "Alist of substrings (entities) that have special casing.
500 The substrings are detected for word constituant when the word
501 is not itself in `ada-case-exception', and only for substrings that
508 "Variable used by `find-file' to find the name of the other package.
516 "Ada support for align.el <= 2.2.
517 This variable provides regular expressions on which to align different lines.
536 )
537 "Ada support for align.el >= 2.8.
558 "when"
562 ;;; ---- Below are the regexp used in this package for parsing
573 ada-95-string-keywords
581 ada-2005-string-keywords
582 ada-83-string-keywords
588 ;; FIXME: make this customizable
594 ;; "with" needs to be included in the regexp, to match generic subprogram parameters
595 ;; Similarly, we put '[not] overriding' on the same line with 'procedure' etc.
598 "^[ \t]*\\(with[ \t]+\\)?\\(\\(not[ \t]+\\)?overriding[ \t]+\\)?\\(procedure\\|function\\|task\\)[ \t\n]+"
600 ;; subprogram name: operator ("[+/=*]")
604 ;; subprogram name: name
608 "Regexp matching Ada subprogram start.
617 "Regexp matching start of package.
625 ;;; ---- regexps for indentation functions
649 "Regexp of possible ends for a non-broken statement.
687 "Position of point just before displaying the menu.
688 This is a list (point buffer).
689 Since `ada-popup-menu' moves the point where the user clicked, the region
690 is modified. Therefore no command from the menu knows what the user selected
691 before displaying the contextual menu.
692 To get the original region, restore the point to this position before
693 calling `region-end' and `region-beginning'.
697 "Menu to use when the user presses the right mouse button.
698 The variable `ada-contextual-menu-on-identifier' will be set to t before
699 displaying the menu if point was on an identifier."
714 \f
715 ;;------------------------------------------------------------------
716 ;; Support for imenu (see imenu.el)
717 ;;------------------------------------------------------------------
724 ada-imenu-comment-re
744 "Imenu generic expression for Ada mode.
745 See `imenu-generic-expression'. This variable will create several submenus for
748 \f
749 ;;------------------------------------------------------------
750 ;; Support for compile.el
751 ;;------------------------------------------------------------
754 "Mouse interface for `ada-compile-goto-error'."
758 )
761 "Replace `compile-goto-error' from compile.el.
762 If POS is on a file and line location, go to this position. It adds
763 to compile.el the capacity to go to a reference in an error message.
764 For instance, on these lines:
765 foo.adb:61:11: [...] in call to size declared at foo.ads:11
766 foo.adb:61:11: [...] in call to local declared at line 20
767 the 4 file locations can be clicked on and jumped to."
773 ;; special case: looking at a filename:line not at the beginning of a line
774 ;; or a simple line reference "at line ..."
784 )
791 source)
793 ;; set source marker
806 ))
808 ;; otherwise, default behavior
811 )
814 \f
815 ;;-------------------------------------------------------------------------
816 ;; Grammar related function
817 ;; The functions below work with the syntax class of the characters in an Ada
818 ;; buffer. Two syntax tables are created, depending on whether we want '_'
819 ;; to be considered as part of a word or not.
820 ;; Some characters may have multiple meanings depending on the context:
821 ;; - ' is either the beginning of a constant character or an attribute
822 ;; - # is either part of a based litteral or a gnatprep statement.
823 ;; - " starts a string, but not if inside a constant character.
824 ;; - ( and ) should be ignored if inside a constant character.
825 ;; Thus their syntax property is changed automatically, and we can still use
826 ;; the standard Emacs functions for sexp (see `ada-in-string-p')
827 ;;
828 ;; On Emacs, this is done through the `syntax-table' text property. The
829 ;; corresponding action is applied automatically each time the buffer
830 ;; changes. If `font-lock-mode' is enabled (the default) the action is
831 ;; set up by `font-lock-syntactic-keywords'. Otherwise, we do it
832 ;; manually in `ada-after-change-function'. The proper method is
833 ;; installed by `ada-handle-syntax-table-properties'.
834 ;;
835 ;; on XEmacs, the `syntax-table' property does not exist and we have to use a
836 ;; slow advice to `parse-partial-sexp' to do the same thing.
837 ;; When executing parse-partial-sexp, we simply modify the strings before and
838 ;; after, so that the special constants '"', '(' and ')' do not interact
839 ;; with parse-partial-sexp.
840 ;; Note: this code is slow and needs to be rewritten as soon as something
841 ;; better is available on XEmacs.
842 ;;-------------------------------------------------------------------------
845 "Create the two syntax tables use in the Ada mode.
846 The standard table declares `_' as a symbol constituent, the second one
847 declares it as a word constituent."
851 ;; define string brackets (`%' is alternative string bracket, but
852 ;; almost never used as such and throws font-lock and indentation
853 ;; off the track.)
876 ;; a single hyphen is punctuation, but a double hyphen starts a comment
879 ;; See the comment above on grammar related function for the special
880 ;; setup for '#'.
885 ;; and \f and \n end a comment
889 ;; define what belongs in Ada symbols
892 ;; define parentheses to match
898 )
900 ;; Support of special characters in XEmacs (see the comments at the beginning
901 ;; of the section on Grammar related functions).
905 "Handles special character constants and gnatprep statements."
914 1
916 change))
923 change))
925 ad-do-it
934 "Assign `syntax-table' properties in accessible part of buffer.
935 In particular, character constants are said to be strings, #...#
936 are treated as numbers instead of gnatprep comments."
945 ;; The following regexp was adapted from
946 ;; `ada-font-lock-syntactic-keywords'.
948 nil t)
960 "Called when the region between BEG and END was changed in the buffer.
961 OLD-LEN indicates what the length of the replaced text was."
971 "Assign `syntax-table' properties in current buffer."
980 "Handle `syntax-table' properties."
982 ;; `font-lock-mode' will take care of `syntax-table' properties.
984 ;; Take care of `syntax-table' properties manually.
987 ;;------------------------------------------------------------------
988 ;; Testing the grammatical context
989 ;;------------------------------------------------------------------
992 "Return t if inside a comment.
993 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
999 "Return t if point is inside a string.
1000 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1006 "Return t if inside a comment or string.
1007 If PARSE-RESULT is non-nil, use it instead of calling `parse-partial-sexp'."
1014 ;;------------------------------------------------------------------
1015 ;; Contextual menus
1016 ;; The Ada mode comes with contextual menus, bound by default to the right
1017 ;; mouse button.
1018 ;; Add items to this menu by modifying `ada-contextual-menu'. Note that the
1019 ;; variable `ada-contextual-menu-on-identifier' is set automatically to t
1020 ;; if the mouse button was pressed on an identifier.
1021 ;;------------------------------------------------------------------
1024 "Execute FUNCTION when called from the contextual menu.
1025 It forces Emacs to change the cursor position."
1032 "Pops up a contextual menu, depending on where the user clicked.
1033 POSITION is the location the mouse was clicked on.
1034 Sets `ada-contextual-menu-last-point' to the current position before
1035 displaying the menu. When a function from the menu is called, the
1036 point is where the mouse button was clicked."
1039 ;; declare this as a local variable, so that the function called
1040 ;; in the contextual menu does not hide the region in
1041 ;; transient-mark-mode.
1054 ))
1064 ))
1067 ;;------------------------------------------------------------------
1068 ;; Misc functions
1069 ;;------------------------------------------------------------------
1071 ;;;###autoload
1073 "Define SPEC and BODY as being valid extensions for Ada files.
1074 Going from body to spec with `ff-find-other-file' used these
1075 extensions.
1076 SPEC and BODY are two regular expressions that must match against
1077 the file name."
1098 ;; Support for speedbar (Specifies that we want to see these files in
1099 ;; speedbar)
1103 spec)
1105 body)))
1106 )
1109 ;;;###autoload
1111 "Ada mode is the major mode for editing Ada code."
1120 ;; Set the paragraph delimiters so that one can select a whole block
1121 ;; simply with M-h
1125 ;; comment end must be set because it may hold a wrong value if
1126 ;; this buffer had been in another mode before. RE
1129 ;; used by autofill and indent-new-comment-line
1132 ;; used by autofill to break a comment line and continue it on another line.
1133 ;; The reason we need this one is that the default behavior does not work
1134 ;; correctly with the definition of paragraph-start above when the comment
1135 ;; is right after a multi-line subprogram declaration (the comments are
1136 ;; aligned under the latest parameter, not under the declaration start).
1146 ;; Emacs 20.3 defines a comment-padding to insert spaces between
1147 ;; the comment and the text. We do not want any, this is already
1148 ;; included in comment-start
1161 ;; Support for compile.el
1162 ;; We just substitute our own functions to go to the error.
1165 ;; FIXME: This has global impact! -stef
1173 ;; font-lock support :
1177 nil t
1179 beginning-of-line
1182 ;; Set up support for find-file.el.
1194 ;; Top level child package declaration; go to the parent package.
1201 ada-search-directories-internal
1203 ada-spec-suffixes)))
1205 ;; A "separate" clause.
1209 ada-search-directories-internal
1211 ada-spec-suffixes)))
1213 ;; A "with" clause.
1217 ada-search-directories-internal
1219 ada-spec-suffixes)))
1220 ))
1222 ;; Support for outline-minor-mode
1224 "\\([ \t]*\\(procedure\\|function\\|package\\|if\\|while\\|for\\|declare\\|case\\|end\\|begin\\|loop\\)\\|--\\)")
1227 ;; Support for imenu : We want a sorted index
1232 ;; Support for ispell : Check only comments
1235 ;; Support for align
1240 ;; Exclude comments alone on line from alignment.
1279 ;; Set up the contextual menu
1283 ;; Support for Abbreviations (the user still need to "M-x abbrev-mode"
1287 ;; Support for which-function mode
1291 ;; Support for indent-new-comment-line (Especially for XEmacs)
1294 ;; Support for add-log
1308 ;; remove all spaces at the end of lines in the whole buffer.
1310 ;; convert all tabs to the correct number of spaces.
1321 ;; To be run after the hook, in case the user modified
1322 ;; ada-fill-comment-prefix
1328 ;; Run this after the hook to give the users a chance to activate
1329 ;; font-lock-mode
1335 ;; the following has to be done after running the ada-mode-hook
1336 ;; because users might want to set the values of these variable
1337 ;; inside the hook
1350 "Adjust the case of the text inserted by a skeleton."
1358 "Should we operate on an active region?"
1362 \f
1363 ;;-----------------------------------------------------------------
1364 ;; auto-casing
1365 ;; Since Ada is case-insensitive, the Ada mode provides an extensive set of
1366 ;; functions to auto-case identifiers, keywords, ...
1367 ;; The basic rules for autocasing are defined through the variables
1368 ;; `ada-case-attribute', `ada-case-keyword' and `ada-case-identifier'. These
1369 ;; are references to the functions that will do the actual casing.
1370 ;;
1371 ;; However, in most cases, the user will want to define some exceptions to
1372 ;; these casing rules. This is done through a list of files, that contain
1373 ;; one word per line. These files are stored in `ada-case-exception-file'.
1374 ;; For backward compatibility, this variable can also be a string.
1375 ;;-----------------------------------------------------------------
1378 "Save the casing exception lists to the file FILE-NAME.
1379 Casing exception lists are `ada-case-exception' and `ada-case-exception-substring'."
1390 )
1393 "Define WORD as an exception for the casing system.
1394 If WORD is not given, then the current word in the buffer is used instead.
1395 The new word is added to the first file in `ada-case-exception-file'.
1396 The standard casing rules will no longer apply to this word."
1399 file-name
1400 )
1418 ;; Reread the exceptions file, in case it was modified by some other,
1421 ;; If the word is already in the list, even with a different casing
1422 ;; we simply want to replace it.
1427 )
1430 ))
1433 "Define the substring WORD as an exception for the casing system.
1434 If WORD is not given, then the current word in the buffer is used instead,
1435 or the selected region if any is active.
1436 The new word is added to the first file in `ada-case-exception-file'.
1437 When auto-casing a word, this substring will be special-cased, unless the
1438 word itself has a special casing."
1442 ada-case-exception-file)
1449 ;; Find the substring to define as an exception. Order is: the parameter,
1450 ;; if any, or the selected region, or the word under the cursor
1471 ;; Reread the exceptions file, in case it was modified by some other,
1474 ;; If the word is already in the list, even with a different casing
1475 ;; we simply want to replace it.
1480 )
1487 "Read the content of the casing exception file FILE-NAME."
1496 ;; If the item is already in the list, even with an other casing,
1497 ;; do not add it again. This way, the user can easily decide which
1498 ;; priority should be applied to each casing exception
1502 ;; Handling a substring ?
1514 )
1517 "Read all the casing exception files from `ada-case-exception-file'."
1520 ;; Reinitialize the casing exception list
1522 ada-case-exception-substring '())
1529 ada-case-exception-file))))
1532 "Adjust case of substrings in the previous word."
1538 re)
1554 )
1555 )
1557 )))
1560 "Adjust case of the previous identifier.
1561 The auto-casing is done according to the value of `ada-case-identifier'
1562 and the exceptions defined in `ada-case-exception-file'."
1574 match)
1575 ;; If we have an exception, replace the word by the correct casing
1577 ada-case-exception t))
1583 ;; Else simply re-case the word
1588 "Return t if cursor is after a keyword that is not an attribute."
1597 "Adjust the case of the word before the character just typed.
1598 If FORCE-IDENTIFIER is non-nil then also adjust keyword as identifier."
1603 ;; or if at the end of a character constant
1606 ;; or if the previous character was not part of a word
1608 ;; if in a string or a comment
1610 )
1623 ))
1624 )
1627 "Adjust the case of the previous word, and process the character just typed.
1640 ;; horrible kludge
1643 ;; horrible dekludge
1645 ;; some special keys and their bindings
1652 ;; Else just insert the character
1654 ;; if there is a keyword in front of the underscore
1655 ;; then it should be part of an identifier (MH)
1659 )
1660 ;; Restore the syntax table
1662 )
1664 ;; Else, no auto-casing
1672 ))
1675 "Modify the key bindings for all the keys that should readjust the casing."
1677 ;; Save original key-bindings to allow swapping ret/lfd
1678 ;; when casing is activated.
1679 ;; The 'or ...' is there to be sure that the value will not
1680 ;; be changed again when Ada mode is called more than once
1684 ;; Call case modifying function after certain keys.
1686 ada-mode-map
1690 ?| ?\; ?: ?' ?\" ?< ?, ?. ?> ?/ ?\n 32 ?\r )))
1693 "Upcase first letter and letters following `_' in the following word.
1694 No other letter is modified.
1695 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1709 "Do nothing. ARG is ignored.
1710 This function can be used for the auto-casing variables in Ada mode, to
1711 adapt to unusal auto-casing schemes. Since it does nothing, you can for
1712 instance use it for `ada-case-identifier' if you don't want any special
1713 auto-casing for identifiers, whereas keywords have to be lower-cased.
1714 See also `ada-auto-case' to disable auto casing altogether."
1715 nil)
1718 "Upcase first letter and letters following '_', lower case other letters.
1719 ARG is ignored, and is there for compatibility with `capitalize-word' only."
1728 "Adjust the case of all words in the region between FROM and TO.
1729 Attention: This function might take very long for big regions!"
1741 ;;
1742 ;; loop: look for all identifiers, keywords, and attributes
1743 ;;
1752 ;; do nothing if it is a string or comment
1755 ;;
1756 ;; get the identifier or keyword or attribute
1757 ;;
1761 ;;
1762 ;; casing according to user-option
1763 ;;
1774 "Adjust the case of all words in the whole buffer.
1775 ATTENTION: This function might take very long for big buffers!"
1779 \f
1780 ;;--------------------------------------------------------------
1781 ;; Format Parameter Lists
1782 ;; Some special algorithms are provided to indent the parameter lists in
1783 ;; subprogram declarations. This is done in two steps:
1784 ;; - First parses the parameter list. The returned list has the following
1785 ;; format:
1786 ;; ( (<Param_Name> in? out? access? <Type_Name> <Default_Expression>)
1787 ;; ... )
1788 ;; This is done in `ada-scan-paramlist'.
1789 ;; - Delete and recreate the parameter list in function
1790 ;; `ada-insert-paramlist'.
1791 ;; Both steps are called from `ada-format-paramlist'.
1792 ;; Note: Comments inside the parameter list are lost.
1793 ;; The syntax has to be correct, or the reformating will fail.
1794 ;;--------------------------------------------------------------
1797 "Reformat the parameter list point is in."
1808 ;; check if really inside parameter list
1812 ;; find start of current parameter-list
1819 ;; find end of parameter-list
1825 ;; find end of last parameter-declaration
1829 ;; build a list of all elements of the parameter-list
1832 ;; delete the original parameter-list
1835 ;; insert the new parameter-list
1839 ;; restore syntax-table
1841 )))
1844 "Scan the parameter list found in between BEGIN and END.
1845 Return the equivalent internal parameter list."
1856 ;; loop until end of last parameter
1859 ;; find first character of parameter-declaration
1863 ;; find last character of parameter-declaration
1871 ;; read name(s) of parameter(s)
1878 ;; look for 'in'
1887 ;; look for 'out'
1896 ;; look for 'access'
1905 ;; skip 'in'/'out'/'access'
1912 ;; read type of parameter
1913 ;; We accept spaces in the name, since some software like Rose
1914 ;; generates something like: "A : B 'Class"
1920 ;; read default-expression, if there is one
1929 nil))))
1931 ;; add this parameter-declaration to the list
1934 ;; check if it was the last parameter
1938 )
1942 "Insert a formatted PARAMLIST in the buffer."
1952 ;; loop until last parameter
1956 ;; get max length of parameter-name
1959 ;; get max length of type-name
1962 ;; is there any 'in' ?
1965 ;; is there any 'out' ?
1968 ;; is there any 'access' ?
1970 )
1972 ;; does paramlist already start on a separate line ?
1976 ;; yes => re-indent it
1983 ;; no => insert it where we are after removing any whitespace
1999 ;; loop until last parameter
2004 ;; insert parameter-name, space and colon
2010 ;; insert 'in' or space
2015 accessp)
2019 ;; insert 'out' or space
2024 accessp)
2028 ;; insert 'access'
2034 ;; insert type-name and, if necessary, space and default-expression
2041 ;; check if it was the last parameter
2044 ;; no => insert ';' and newline and indent
2048 )
2050 ;; if anything follows, except semicolon, newline, is or return
2051 ;; put it in a new line and indent it
2054 ))
2057 \f
2058 ;;;----------------------------------------------------------------
2059 ;; Indentation Engine
2060 ;; All indentations are indicated as a two-element string:
2061 ;; - position of reference in the buffer
2062 ;; - offset to indent from this position (can also be a symbol or a list
2063 ;; that are evaluated)
2064 ;; Thus the total indentation for a line is the column number of the reference
2065 ;; position plus whatever value the evaluation of the second element provides.
2066 ;; This mechanism is used so that the Ada mode can "explain" how the
2067 ;; indentation was calculated, by showing which variables were used.
2068 ;;
2069 ;; The indentation itself is done in only one pass: first we try to guess in
2070 ;; what context we are by looking at the following keyword or punctuation
2071 ;; sign. If nothing remarkable is found, just try to guess the indentation
2072 ;; based on previous lines.
2073 ;;
2074 ;; The relevant functions for indentation are:
2075 ;; - `ada-indent-region': Re-indent a region of text
2076 ;; - `ada-justified-indent-current': Re-indent the current line and shows the
2077 ;; calculation that were done
2078 ;; - `ada-indent-current': Re-indent the current line
2079 ;; - `ada-get-current-indent': Calculate the indentation for the current line,
2080 ;; based on the context (see above).
2081 ;; - `ada-get-indent-*': Calculate the indentation in a specific context.
2082 ;; For efficiency, these functions do not check they are in the correct
2083 ;; context.
2084 ;;;----------------------------------------------------------------
2087 "Indent the region between BEG end END."
2095 ;; catch errors while indenting
2109 "Indent the current line, insert a newline and then indent the new line."
2116 "Insert a newline and indent it.
2117 The original line is indented first if `ada-indent-after-return' is non-nil."
2124 "Indent the current line and explain how the calculation was done."
2143 ))
2151 "Re-indent and re-case all the files found on the command line.
2152 This function should be used from the command line, with a
2153 command like:
2154 emacs -batch -l ada-mode -f ada-batch-reformat file1 file2 ..."
2168 "Move point to the beginning of the previous word of Ada code.
2169 Return the new position of point or nil if not found."
2173 "Indent current line as Ada code.
2174 Return the calculation that was done, including the reference point
2175 and the offset."
2179 cur-indent tmp-indent
2180 prev-indent)
2186 ;; This need to be done here so that the advice is not always
2187 ;; activated (this might interact badly with other modes)
2194 ;; Not First line in the buffer ?
2200 ;; first line in the buffer
2203 ;; Evaluate the list to get the column to indent to
2204 ;; prev-indent contains the column to indent to
2217 )
2220 ;; only re-indent if indentation is different then the current
2222 nil
2226 ;;
2227 ;; restore position of point
2228 ;;
2233 ;; restore syntax-table
2237 )
2239 cur-indent
2240 ))
2243 "Return the indentation to use for the current line."
2245 pos
2246 match-cons
2247 result
2257 ;;-----------------------------
2258 ;; in open parenthesis, but not in parameter-list
2259 ;;-----------------------------
2265 ;; check if we have something like this (Table_Component_Type =>
2266 ;; Source_File_Record)
2269 ;; Align the closing parenthesis on the opening one
2280 ;; ??? Could use a different variable
2283 ;; We want all continuation lines to be indented the same
2284 ;; (ada-broken-line from the opening parenthesis. However, in
2285 ;; parameter list, each new parameter should be indented at the
2286 ;; column as the opening parenthesis.
2288 ;; A special case to handle nested boolean expressions, as in
2289 ;; ((B
2290 ;; and then C) -- indented by ada-broken-indent
2291 ;; or else D) -- indenting this line.
2292 ;; ??? This is really a hack, we should have a proper way to go to
2293 ;; ??? the beginning of the statement
2301 )))))
2303 ;;---------------------------
2304 ;; at end of buffer
2305 ;;---------------------------
2310 ;;---------------------------
2311 ;; starting with e
2312 ;;---------------------------
2317 ;; ------- end ------
2321 limit)
2325 ;;
2326 ;; found 'loop' => skip back to 'while' or 'for'
2327 ;; if 'loop' is not on a separate line
2328 ;; Stop the search for 'while' and 'for' when a ';' is encountered.
2329 ;;
2348 ;; found 'record' =>
2349 ;; if the keyword is found at the beginning of a line (or just
2350 ;; after limited, we indent on it, otherwise we indent on the
2351 ;; beginning of the type declaration)
2352 ;; type A is (B : Integer;
2353 ;; C : Integer) is record
2354 ;; end record; -- This is badly indented otherwise
2364 ;; Else keep the same indentation as the beginning statement
2367 ;; ------ exception ----
2374 ;; else
2384 ;; elsif
2391 ))
2393 ;;---------------------------
2394 ;; starting with w (when)
2395 ;;---------------------------
2404 ;;---------------------------
2405 ;; starting with t (then)
2406 ;;---------------------------
2414 ;; Select has been added for the statement: "select ... then abort"
2420 ;;---------------------------
2421 ;; starting with l (loop)
2422 ;;---------------------------
2434 nil pos))
2439 ;;----------------------------
2440 ;; starting with l (limited) or r (record)
2441 ;;----------------------------
2457 ;;---------------------------
2458 ;; starting with b (begin)
2459 ;;---------------------------
2468 ;;---------------------------
2469 ;; starting with i (is)
2470 ;;---------------------------
2490 ;;---------------------------
2491 ;; starting with r (return, renames)
2492 ;;---------------------------
2499 ;; If looking at a renames, skip the 'return' statement too
2514 ;; If there is a parameter list, and we have a function declaration
2515 ;; or a access to subprogram declaration
2527 ;; The indentation depends of the value of ada-indent-return
2531 var))
2533 ;; Else there is no parameter list, but we have a function
2534 ;; Only do something special if the user want to indent
2535 ;; relative to the "function" keyword
2541 ;; Else...
2544 ;;--------------------------------
2545 ;; starting with 'o' or 'p'
2546 ;; 'or' as statement-start
2547 ;; 'private' as statement-start
2548 ;;--------------------------------
2555 ;; ??? Wasn't this done already in ada-looking-at-semi-or ?
2559 ;;--------------------------------
2560 ;; starting with 'd' (do)
2561 ;;--------------------------------
2569 ;;--------------------------------
2570 ;; starting with '-' (comment)
2571 ;;--------------------------------
2576 ;; Indent comments on previous line comments if required
2577 ;; We must use a search-forward (even if the code is more complex),
2578 ;; since we want to find the beginning of the comment.
2589 t))
2592 pos))
2595 ;; Else always on previous line
2598 ;; Else same indentation as the previous line
2601 ;;--------------------------------
2602 ;; starting with '#' (preprocessor line)
2603 ;;--------------------------------
2610 ;;--------------------------------
2611 ;; starting with ')' (end of a parameter list)
2612 ;;--------------------------------
2620 ;;---------------------------------
2621 ;; new/abstract/separate
2622 ;;---------------------------------
2627 ;;---------------------------------
2628 ;; package/function/procedure
2629 ;;---------------------------------
2634 ;; Go up until we find either a generic section, or the end of the
2635 ;; previous subprogram/package
2641 ;; avoid "with procedure"... in generic parts
2650 ;;---------------------------------
2651 ;; label
2652 ;;---------------------------------
2660 ))
2662 ;;---------------------------------
2663 ;; Other syntaxes
2664 ;;---------------------------------
2668 "Calculate the indentation for the new line after ORGPOINT.
2669 The result list is based on the previous lines in the buffer.
2670 If NOMOVE is nil, moves point to the beginning of the current statement.
2671 if INITIAL-POS is non-nil, moves point to INITIAL-POS before calculation."
2676 ;; Is inside a parameter-list ?
2680 ;; move to beginning of current statement
2684 ;; no beginning found => don't change indentation
2690 ;;
2692 ada-indent-to-open-paren
2695 ;;
2698 ;;
2701 ;;
2704 ;;
2707 ;;
2710 ;;
2711 ;; "then" has to be included in the case of "select...then abort"
2712 ;; statements, since (goto-stmt-start) at the beginning of
2713 ;; the current function would leave the cursor on that position
2716 ;;
2719 ;;
2722 ;;
2725 ;;
2729 ;; A label
2734 ;;
2736 ;; Are we still in that statement, or are we in fact looking at
2737 ;; the previous one ?
2741 'ada-with-indent
2743 ;;
2746 ))
2749 "Calculate the indentation when point is behind an unclosed parenthesis."
2753 "Return the current indentation of the previous line."
2760 "Calculate the indentation when point is inside a parameter list."
2764 ;; in front of the first parameter
2769 ;; in front of another parameter
2775 ;; After an affectation (default parameter value in subprogram
2776 ;; declaration)
2781 ;; inside a parameter declaration
2788 "Calculate the indentation when point is just before an end statement.
2789 ORGPOINT is the limit position used in the calculation."
2793 ;; is the line already terminated by ';' ?
2798 ;; yes, look what's following 'end'
2803 ;;
2804 ;; loop/select/if/case/return
2805 ;;
2810 ;;
2811 ;; record
2812 ;;
2816 ;; we are now looking at the matching "record" statement
2819 ;; now on the matching type declaration, or use clause
2823 ;;
2824 ;; a named block end
2825 ;;
2832 ;;
2833 ;; a block-end without name
2834 ;;
2843 indent))
2845 )))
2846 ;;
2847 ;; anything else - should maybe signal an error ?
2848 ;;
2857 "Calculate the indentation when point is just before a case statement.
2858 ORGPOINT is the limit position used in the calculation."
2862 ;;
2863 ;; case..is..when..=>
2864 ;;
2867 ;; the `=>' must be after the keyword `is'.
2877 ;;
2878 ;; case..is..when
2879 ;;
2885 ;;
2886 ;; case..is
2887 ;;
2892 ;;
2893 ;; incomplete case
2894 ;;
2900 "Calculate the indentation when point is just before a when statement.
2901 ORGPOINT is the limit position used in the calculation."
2908 "Calculate the indentation when point is just before an if statement.
2909 ORGPOINT is the limit position used in the calculation."
2912 ;;
2913 ;; Move to the correct then (ignore all "and then")
2914 ;;
2917 nil orgpoint))
2919 ;; If "then" was found (we are looking at it)
2922 ;;
2923 ;; 'then' first in separate line ?
2924 ;; => indent according to 'then',
2925 ;; => else indent according to 'if'
2926 ;;
2931 ;; skip 'then'
2938 "Calculate the indentation when point is at the start of a block.
2939 ORGPOINT is the limit position used in the calculation."
2949 ;; Special case for record types, for instance for:
2950 ;; type A is (B : Integer;
2951 ;; C : Integer) is record
2952 ;; null; -- This is badly indented otherwise
2955 ;; If record is at the beginning of the line, indent from there
2961 ;; else indent relative to the type command
2966 ;; nothing follows the block-start
2971 "Calculate the indentation when point is just before a subprogram.
2972 ORGPOINT is the limit position used in the calculation."
2976 ;;
2977 ;; is there an 'is' in front of point ?
2978 ;;
2983 ;;
2984 ;; yes, then skip to its end
2985 ;;
2989 ;;
2990 ;; no, then goto next non-ws, if there is one in front of point
2991 ;;
2997 ;;
2998 ;; nothing follows 'is'
2999 ;;
3001 foundis
3006 ;;
3007 ;; is abstract/separate/new ...
3008 ;;
3010 foundis
3015 nil orgpoint))))
3019 ;;
3020 ;; something follows 'is'
3021 ;;
3023 foundis
3027 ;;
3028 ;; no 'is' but ';'
3029 ;;
3033 ;;
3034 ;; no 'is' or ';'
3035 ;;
3040 "Calculate the indentation when point is just before a 'noindent stmt'.
3041 ORGPOINT is the limit position used in the calculation."
3048 ;; This one is called when indenting a line preceded by a multi-line
3049 ;; subprogram declaration (in that case, we are at this point inside
3050 ;; the parameter declaration list)
3055 ;; This one is called when indenting the second line of a multi-line
3056 ;; declaration section, in a declare block or a record declaration
3061 ;; This one is called in every over case when indenting a line at the
3062 ;; top level
3069 ;; "with private" or "null record" cases
3094 "Calculate the indentation when before a label or variable declaration.
3095 ORGPOINT is the limit position used in the calculation."
3100 ;; loop label
3103 ada-loop-start-re nil orgpoint)))
3107 ;; declare label
3114 ;; variable declaration
3121 ;; nothing follows colon
3126 "Calculate the indentation when just before a loop or a for ... use.
3127 ORGPOINT is the limit position used in the calculation."
3131 ;; If looking at a named block, skip the label
3140 ;;
3141 ;; statement complete
3142 ;;
3147 ;;
3148 ;; simple loop
3149 ;;
3153 pos
3156 ;;
3157 ;; 'for'- loop (or also a for ... use statement)
3158 ;;
3161 ;;
3162 ;; for ... use
3163 ;;
3172 ;;
3173 ;; check if there is a 'record' before point
3174 ;;
3178 t)))
3184 )
3186 ;;
3187 ;; for..loop
3188 ;;
3193 ;;
3194 ;; indent according to 'loop', if it's first in the line;
3195 ;; otherwise to 'for'
3196 ;;
3203 ;;
3204 ;; for-statement is broken
3205 ;;
3210 ;;
3211 ;; 'while'-loop
3212 ;;
3214 ;;
3215 ;; while..loop ?
3216 ;;
3223 ;;
3224 ;; indent according to 'loop', if it's first in the line;
3225 ;; otherwise to 'while'.
3226 ;;
3238 "Calculate the indentation when before a type statement.
3239 ORGPOINT is the limit position used in the calculation."
3242 ;;
3243 ;; complete record declaration
3244 ;;
3256 ;;
3257 ;; record type
3258 ;;
3264 ;;
3265 ;; complete type declaration
3266 ;;
3271 ;;
3272 ;; "type ... is", but not "type ... is ...", which is broken
3273 ;;
3280 ;;
3281 ;; broken statement
3282 ;;
3287 \f
3288 ;; -----------------------------------------------------------
3289 ;; -- searching and matching
3290 ;; -----------------------------------------------------------
3293 "Move point to the beginning of the statement that point is in or after.
3294 Return the new position of point.
3295 As a special case, if we are looking at a closing parenthesis, skip to the
3296 open parenthesis."
3303 ;;
3304 ;; found a previous end-statement => check if anything follows
3305 ;;
3311 ;;
3312 ;; nothing follows => it's the end-statement directly in
3313 ;; front of point => search again
3314 ;;
3316 ;;
3317 ;; if found the correct end-statement => goto next non-ws
3318 ;;
3322 ))
3324 ;;
3325 ;; no previous end-statement => we are at the beginning of the
3326 ;; accessible part of the buffer
3327 ;;
3330 ;;
3331 ;; skip to the very first statement, if there is one
3332 ;;
3339 "Move point to previous end statement.
3340 Return a cons cell whose car is the beginning and whose cdr
3341 is the end of the match."
3345 ;; search until found or beginning-of-buffer
3350 ada-end-stmt-re t)))
3371 ;; words that can go after an 'is'
3387 )))
3390 match-dat
3391 nil)))
3395 "Skip white spaces, newlines and comments to next non-ws character.
3396 Stop the search at LIMIT.
3397 Do not call this function from within a string."
3408 nil)
3409 )
3413 "Move point to the end of the statement that point is in or before.
3414 Return the new position of point or nil if not found.
3415 Stop the search at LIMIT."
3418 nil))
3422 "Move point to the beginning of the next word of Ada code.
3423 If BACKWARD is non-nil, jump to the beginning of the previous word.
3424 Return the new position of point or nil if not found."
3435 ;;
3436 ;; move to the beginning of the word found
3437 ;;
3442 ;;
3443 ;; if not found, restore old position of point
3444 ;;
3448 )
3452 "Signal an error if matching block start is not KEYWORD.
3453 Moves point to the matching block start."
3460 "Check if the name of the matching defun really is DEFUN-NAME.
3461 Assumes point to be already positioned by `ada-goto-matching-start'.
3462 Moves point to the beginning of the declaration."
3464 ;; named block without a `declare'; ada-goto-matching-start leaves
3465 ;; point at start of 'begin' for a block.
3469 t ; do nothing
3470 ;; else
3471 ;;
3472 ;; 'accept' or 'package' ?
3473 ;;
3476 ;;
3477 ;; 'begin' of 'procedure'/'function'/'task' or 'declare'
3478 ;;
3480 ;;
3481 ;; a named 'declare'-block ? => jump to the label
3482 ;;
3487 ;;
3488 ;; no, => 'procedure'/'function'/'task'/'protected'
3489 ;;
3493 ;;
3494 ;; skip 'body' 'type'
3495 ;;
3500 ;;
3501 ;; should be looking-at the correct name
3502 ;;
3509 "Move point to the matching declaration start of the current 'begin'.
3510 If NOERROR is non-nil, it only returns nil if no match was found."
3513 ;; first should be set to t if we should stop at the first
3514 ;; "begin" we encounter.
3518 )
3520 ;; Ignore "when" most of the time, except if we are looking at the
3521 ;; beginning of a block (structure: case .. is
3522 ;; when ... =>
3523 ;; begin ...
3524 ;; exception ... )
3536 ;; search backward for interesting keywords
3540 ;;
3541 ;; calculate nest-depth
3542 ;;
3544 ;;
3548 ;; In some case, two begin..end block can follow each other closely,
3549 ;; which we have to detect, as in
3550 ;; procedure P is
3551 ;; procedure Q is
3552 ;; begin
3553 ;; end;
3554 ;; begin -- here we should go to procedure, not begin
3555 ;; end
3561 ;; If begin was just there as the beginning of a block
3562 ;; (with no declare) then do nothing, otherwise just
3563 ;; register that we have to find the statement that
3564 ;; required the begin
3568 t)
3572 ;; (ada-goto-matching-decl-start noerror t)
3577 ))
3578 )))
3579 ;;
3585 ;;
3594 ;;
3598 ;;
3600 ;; check if it is only a type definition, but not a protected
3601 ;; type definition, which should be handled like a procedure.
3607 ;; Detect if we have a closing parenthesis (Could be
3608 ;; either the end of subprogram parameters or (<>)
3609 ;; in a type definition
3615 ))
3629 ;;
3635 ;;
3639 ;;
3647 ))))
3648 ;;
3651 ;;
3658 ;; check if declaration-start is really found
3664 t
3667 ))
3670 "Move point to the beginning of a block-start.
3671 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3672 If NOERROR is non-nil, it only returns nil if no matching start was found.
3673 If GOTOTHEN is non-nil, point moves to the 'then' following 'if'."
3678 ;; List all keywords encountered while traversing
3679 ;; something like '("end" "end" "begin")
3680 ;; This is removed from the list when "package", "procedure",...
3681 ;; are seen. The goal is to find whether a package has an elaboration
3682 ;; part
3686 ;; search backward for interesting keywords
3696 ;; calculate nest-depth
3698 ;; found block end => increase nest depth
3703 ;; found loop/select/record/case/if => check if it starts or
3704 ;; ends a block
3708 ;; check if keyword follows 'end'
3712 ;; it ends a block => increase nest depth
3717 ;; it starts a block => decrease nest depth
3720 ;; Some nested "begin .. end" blocks with no "declare"?
3721 ;; => remove those entries
3726 ))
3728 )
3730 ;; found package start => check if it really is a block
3733 ;; ignore if this is just a renames statement
3740 "No matching 'is' or 'renames' for 'package' at"
3741 " line "
3747 ;; ignore it if it is only a declaration with 'new'
3748 ;; We could have package Foo is new ....
3749 ;; or package Foo is separate;
3750 ;; or package Foo is begin null; end Foo
3751 ;; for elaboration code (elaboration)
3757 )
3758 ;; found task start => check if it has a body
3766 ;; In that case, do nothing if there is a "is"
3770 ;; Do nothing if we are simply looking at a simple
3771 ;; "task type name;" statement with no block
3774 ;; Skip the parameters
3785 ;; Check if that task declaration had a block attached to
3786 ;; it (i.e do nothing if we have just "task name;")
3791 )
3794 ;; remove entry for begin and end (include nested begin..end
3795 ;; groups)
3803 )))
3806 ;; Ignore if this is just a declaration
3813 ;; remove entry for end
3819 ;; Ignore if this is just a declaration
3826 ;; remove entry for begin and end
3828 )
3830 ;; all the other block starts
3835 )
3837 ;; match is found, if nest-depth is zero
3843 ;;
3844 ;; match found => is there anything else to do ?
3845 ;;
3848 ;;
3849 ;; found 'if' => skip to 'then', if it's on a separate line
3850 ;; and GOTOTHEN is non-nil
3851 ;;
3853 gotothen
3862 ;;
3863 ;; found 'do' => skip back to 'accept' or 'return'
3864 ;;
3872 nil
3877 "Move point to the end of a block.
3878 Which block depends on the value of NEST-LEVEL, which defaults to zero.
3879 If NOERROR is non-nil, it only returns nil if no matching start found."
3887 found
3888 pos
3890 ;; First is used for subprograms: they are generally handled
3891 ;; recursively, but of course we do not want to do that the
3892 ;; first time (see comment below about subprograms)
3895 ;; If we are already looking at one of the keywords, this shouldn't count
3896 ;; in the nesting loop below, so we just make sure we don't count it.
3897 ;; "declare" is a special case because we need to look after the "begin"
3898 ;; keyword
3902 ;;
3903 ;; search forward for interesting keywords
3904 ;;
3909 ;;
3910 ;; calculate nest-depth
3911 ;;
3914 ;; procedures and functions need to be processed recursively, in
3915 ;; case they are defined in a declare/begin block, as in:
3916 ;; declare -- NL 0 (nested level)
3917 ;; A : Boolean;
3918 ;; procedure B (C : D) is
3919 ;; begin -- NL 1
3920 ;; null;
3921 ;; end B; -- NL 0, and we would exit
3922 ;; begin
3923 ;; end; -- we should exit here
3924 ;; processing them recursively avoids the need for any special
3925 ;; handling.
3926 ;; Nothing should be done if we have only the specs or a
3927 ;; generic instantion.
3943 ;; found block end => decrease nest depth
3947 ;; skip the following keyword
3954 ;; found package start => check if it really starts a block, and is not
3955 ;; in fact a generic instantiation for instance
3960 ;; ignore and skip it if it is only a 'new' package
3966 ;; all the other block starts
3976 t
3978 nil
3980 ))
3985 "Regexp-search for SEARCH-RE, ignoring comments, strings.
3986 Returns a cons cell of begin and end of match data or nil, if not found.
3987 If BACKWARD is non-nil, search backward; search forward otherwise.
3988 The search stops at pos LIMIT.
3989 If PARAMLISTS is nil, ignore parameter lists.
3990 The search is done using SEARCH-FUNC. SEARCH-FUNC can be optimized
3991 in case we are searching for a constant string.
3992 Point is moved at the beginning of the SEARCH-RE."
3994 begin
3995 end
3996 parse-result
3999 ;; FIXME: need to pass BACKWARD to search-func!
4003 ;;
4004 ;; search until found or end-of-buffer
4005 ;; We have to test that we do not look further than limit
4006 ;;
4021 ;;
4022 ;; If inside a string, skip it (and the following comments)
4023 ;;
4029 ;;
4030 ;; If inside a comment, skip it (and the following comments)
4031 ;; There is a special code for comments at the end of the file
4032 ;;
4041 ;; at the end of the file, it is not possible to skip a comment
4042 ;; so we just go at the end of the line
4048 ;;
4049 ;; directly in front of a comment => skip it, if searching forward
4050 ;;
4054 ;;
4055 ;; found a parameter-list but should ignore it => skip it
4056 ;;
4061 ;;
4062 ;; found what we were looking for
4063 ;;
4071 nil)))
4073 ;; -------------------------------------------------------
4074 ;; -- Testing the position of the cursor
4075 ;; -------------------------------------------------------
4078 "Return t if point is inside a declarative part.
4079 Assumes point to be at the end of a statement."
4086 "Return t if looking at an 'or' following a semicolon."
4096 "Return t if looking at the start of a private section in a package.
4097 Return nil if the private is part of the package name, as in
4098 'private package A is...' (this can only happen at top level)."
4103 ;; Make sure this is the start of a private section (ie after
4104 ;; a semicolon or just after the package declaration, but not
4105 ;; after a 'type ... is private' or 'is new ... with private'
4106 ;;
4107 ;; Note that a 'private' statement at the beginning of the buffer
4108 ;; does not indicate a private section, since this is instead a
4109 ;; 'private procedure ...'
4118 "Return t if point is inside a parameter-list."
4122 ;; inside parentheses ?
4125 ;; We could be looking at two things here:
4126 ;; operator definition: function "." (
4127 ;; subprogram definition: procedure .... (
4128 ;; Let's skip back over the first one
4134 t)
4136 ;; and now over the second one
4139 ;; We should ignore the case when the reserved keyword is in a
4140 ;; comment (for instance, when we have:
4141 ;; -- .... package
4142 ;; Test (A)
4143 ;; we should return nil
4147 ;; right keyword two words before parenthesis ?
4148 ;; Type is in this list because of discriminants
4159 "Search for REGEXP, ignoring comments, strings, 'and then', 'or else'.
4160 If BACKWARDP is non-nil, search backward; search forward otherwise."
4165 result))
4168 "Non-nil if in an open parenthesis.
4169 Return value is the position of the first non-ws behind the last unclosed
4170 parenthesis, or nil."
4176 t))
4183 ;; Skip blanks, if they are not followed by a comment
4184 ;; See:
4185 ;; type A is ( Value_0,
4186 ;; Value_1);
4187 ;; type B is ( -- comment
4188 ;; Value_2);
4196 \f
4197 ;; -----------------------------------------------------------
4198 ;; -- Behavior Of TAB Key
4199 ;; -----------------------------------------------------------
4202 "Do indenting or tabbing according to `ada-tab-policy'.
4203 In Transient Mark mode, if the mark is active, operate on the contents
4204 of the region. Otherwise, operate only on the current line."
4212 ))
4215 "Delete leading indenting according to `ada-tab-policy'."
4216 ;; FIXME: ARG is ignored
4221 ))
4224 "Ada mode version of the `indent-line-function'."
4232 ))
4235 "Indent current line to next tab stop."
4244 "Indent current line to previous tab stop."
4251 \f
4252 ;; ------------------------------------------------------------
4253 ;; -- Miscellaneous
4254 ;; ------------------------------------------------------------
4256 ;; Not needed any more for Emacs 21.2, but still needed for backward
4257 ;; compatibility
4259 "Remove trailing spaces in the whole buffer."
4270 "Clean up comments, `(' and `,' for GNAT style checking switch."
4274 ;; The \n is required, or the line after an empty comment line is
4275 ;; simply ignored.
4304 ;; Make sure there is a space after a ','.
4305 ;; Always go back to the beginning of the match, since otherwise
4306 ;; a statement like ('F','D','E') is incorrectly modified.
4314 ;; Operators should be surrounded by spaces.
4318 nil t)
4337 ))
4340 \f
4341 ;; -------------------------------------------------------------
4342 ;; -- Moving To Procedures/Packages/Statements
4343 ;; -------------------------------------------------------------
4346 "Move point to the matching start of the current Ada structure."
4355 ;;
4356 ;; do nothing if in string or comment or not on 'end ...;'
4357 ;; or if an error occurs during processing
4358 ;;
4371 ;;
4372 ;; on 'begin' => go on, according to user option
4373 ;;
4374 ada-move-to-declaration
4381 ;; now really move to the found position
4384 ;; restore syntax-table
4388 "Move point to the matching end of the block around point.
4389 Moves to 'begin' if in a declarative part."
4392 decl-start
4401 ;; Go to the beginning of the current word, and check if we are
4402 ;; directly on 'begin'
4407 )
4409 ;; on first line of subprogram body
4410 ;; Do nothing for specs or generic instantion, since these are
4411 ;; handled as the general case (find the enclosing block)
4412 ;; We also need to make sure that we ignore nested subprograms
4418 ))
4422 ;; on first line of task declaration
4431 ;; accept block start
4436 ;; package start
4442 ;; On a "declare" keyword
4448 ;; inside a 'begin' ... 'end' block
4453 ;; (hopefully ;-) everything else
4457 )
4459 ;; now really move to the position found
4462 ;; restore syntax-table
4466 "Move point to next procedure."
4474 "Move point to previous procedure."
4482 "Move point to next package."
4490 "Move point to previous package."
4497 \f
4498 ;; ------------------------------------------------------------
4499 ;; -- Define keymap and menus for Ada
4500 ;; -------------------------------------------------------------
4503 "Create the keymap associated with the Ada mode."
4505 ;; All non-standard keys go into ada-mode-extra-map
4508 ;; Indentation and Formatting
4516 ;; We don't want to make meta-characters case-specific.
4518 ;; Movement
4524 ;; Compilation
4528 ;; Casing
4534 ;; On XEmacs, you can easily specify whether DEL should deletes
4535 ;; one character forward or one character backward. Take this into
4536 ;; account
4539 'backward-delete-char-untabify)
4541 ;; Make body
4542 (define-key ada-mode-map "\C-c\C-n" 'ada-make-subprogram-body)
4544 ;; Use predefined function of Emacs19 for comments (RE)
4545 (define-key ada-mode-map "\C-c;" 'comment-region)
4546 (define-key ada-mode-map "\C-c:" 'ada-uncomment-region)
4548 ;; The following keys are bound to functions defined in ada-xref.el or
4549 ;; ada-prj,el., However, RMS rightly thinks that the code should be shared,
4550 ;; and activated only if the right compiler is used
4552 (define-key ada-mode-map (if (featurep 'xemacs) '(shift button3) [S-mouse-3])
4553 'ada-point-and-xref)
4554 (define-key ada-mode-map [(control tab)] 'ada-complete-identifier)
4556 (define-key ada-mode-extra-map "o" 'ff-find-other-file)
4557 (define-key ada-mode-map "\C-c5\C-d" 'ada-goto-declaration-other-frame)
4558 (define-key ada-mode-map "\C-c\C-d" 'ada-goto-declaration)
4559 (define-key ada-mode-map "\C-c\C-s" 'ada-xref-goto-previous-reference)
4560 (define-key ada-mode-map "\C-c\C-c" 'ada-compile-application)
4561 (define-key ada-mode-extra-map "c" 'ada-change-prj)
4562 (define-key ada-mode-extra-map "d" 'ada-set-default-project-file)
4563 (define-key ada-mode-extra-map "g" 'ada-gdb-application)
4564 (define-key ada-mode-map "\C-c\C-m" 'ada-set-main-compile-application)
4565 (define-key ada-mode-extra-map "r" 'ada-run-application)
4566 (define-key ada-mode-map "\C-c\C-o" 'ada-goto-parent)
4567 (define-key ada-mode-map "\C-c\C-r" 'ada-find-references)
4568 (define-key ada-mode-extra-map "l" 'ada-find-local-references)
4569 (define-key ada-mode-map "\C-c\C-v" 'ada-check-current)
4570 (define-key ada-mode-extra-map "f" 'ada-find-file)
4572 (define-key ada-mode-extra-map "u" 'ada-prj-edit)
4574 ;; The templates, defined in ada-stmt.el
4576 (let ((map (make-sparse-keymap)))
4577 (define-key map "h" 'ada-header)
4578 (define-key map "\C-a" 'ada-array)
4579 (define-key map "b" 'ada-exception-block)
4580 (define-key map "d" 'ada-declare-block)
4581 (define-key map "c" 'ada-case)
4582 (define-key map "\C-e" 'ada-elsif)
4583 (define-key map "e" 'ada-else)
4584 (define-key map "\C-k" 'ada-package-spec)
4585 (define-key map "k" 'ada-package-body)
4586 (define-key map "\C-p" 'ada-procedure-spec)
4587 (define-key map "p" 'ada-subprogram-body)
4588 (define-key map "\C-f" 'ada-function-spec)
4589 (define-key map "f" 'ada-for-loop)
4590 (define-key map "i" 'ada-if)
4591 (define-key map "l" 'ada-loop)
4592 (define-key map "\C-r" 'ada-record)
4593 (define-key map "\C-s" 'ada-subtype)
4594 (define-key map "S" 'ada-tabsize)
4595 (define-key map "\C-t" 'ada-task-spec)
4596 (define-key map "t" 'ada-task-body)
4597 (define-key map "\C-y" 'ada-type)
4598 (define-key map "\C-v" 'ada-private)
4599 (define-key map "u" 'ada-use)
4600 (define-key map "\C-u" 'ada-with)
4601 (define-key map "\C-w" 'ada-when)
4602 (define-key map "w" 'ada-while-loop)
4603 (define-key map "\C-x" 'ada-exception)
4604 (define-key map "x" 'ada-exit)
4605 (define-key ada-mode-extra-map "t" map))
4606 )
4609 (defun ada-create-menu ()
4610 "Create the Ada menu as shown in the menu bar."
4611 (let ((m '("Ada"
4612 ("Help"
4613 ["Ada Mode" (info "ada-mode") t]
4614 ["GNAT User's Guide" (info "gnat_ugn")
4615 (eq ada-which-compiler 'gnat)]
4616 ["GNAT Reference Manual" (info "gnat_rm")
4617 (eq ada-which-compiler 'gnat)]
4618 ["Gcc Documentation" (info "gcc")
4619 (eq ada-which-compiler 'gnat)]
4620 ["Gdb Documentation" (info "gdb")
4621 (eq ada-which-compiler 'gnat)]
4622 ["Ada95 Reference Manual" (info "arm95") t])
4623 ("Options" :included (eq major-mode 'ada-mode)
4624 ["Auto Casing" (setq ada-auto-case (not ada-auto-case))
4625 :style toggle :selected ada-auto-case]
4626 ["Auto Indent After Return"
4627 (setq ada-indent-after-return (not ada-indent-after-return))
4628 :style toggle :selected ada-indent-after-return]
4629 ["Automatically Recompile For Cross-references"
4630 (setq ada-xref-create-ali (not ada-xref-create-ali))
4631 :style toggle :selected ada-xref-create-ali
4632 :included (eq ada-which-compiler 'gnat)]
4633 ["Confirm Commands"
4634 (setq ada-xref-confirm-compile (not ada-xref-confirm-compile))
4635 :style toggle :selected ada-xref-confirm-compile
4636 :included (eq ada-which-compiler 'gnat)]
4637 ["Show Cross-references In Other Buffer"
4638 (setq ada-xref-other-buffer (not ada-xref-other-buffer))
4639 :style toggle :selected ada-xref-other-buffer
4640 :included (eq ada-which-compiler 'gnat)]
4641 ["Tight Integration With GNU Visual Debugger"
4642 (setq ada-tight-gvd-integration (not ada-tight-gvd-integration))
4643 :style toggle :selected ada-tight-gvd-integration
4644 :included (string-match "gvd" ada-prj-default-debugger)])
4645 ["Customize" (customize-group 'ada)
4646 :included (fboundp 'customize-group)]
4647 ["Check file" ada-check-current t]
4648 ["Compile file" ada-compile-current t]
4649 ["Set main and Build" ada-set-main-compile-application t]
4650 ["Show main" ada-show-current-main t]
4651 ["Build" ada-compile-application t]
4652 ["Run" ada-run-application t]
4653 ["Debug" ada-gdb-application (eq ada-which-compiler 'gnat)]
4654 ["------" nil nil]
4655 ("Project"
4656 ["Show project" ada-show-current-project t]
4657 ["Load..." ada-set-default-project-file t]
4658 ["New..." ada-prj-new t]
4659 ["Edit..." ada-prj-edit t])
4660 ("Goto" :included (eq major-mode 'ada-mode)
4661 ["Goto Declaration/Body" ada-goto-declaration
4662 (eq ada-which-compiler 'gnat)]
4663 ["Goto Body" ada-goto-body
4664 (eq ada-which-compiler 'gnat)]
4665 ["Goto Declaration Other Frame"
4666 ada-goto-declaration-other-frame
4667 (eq ada-which-compiler 'gnat)]
4668 ["Goto Previous Reference" ada-xref-goto-previous-reference
4669 (eq ada-which-compiler 'gnat)]
4670 ["List Local References" ada-find-local-references
4671 (eq ada-which-compiler 'gnat)]
4672 ["List References" ada-find-references
4673 (eq ada-which-compiler 'gnat)]
4674 ["Goto Reference To Any Entity" ada-find-any-references
4675 (eq ada-which-compiler 'gnat)]
4676 ["Goto Parent Unit" ada-goto-parent
4677 (eq ada-which-compiler 'gnat)]
4678 ["--" nil nil]
4679 ["Next compilation error" next-error t]
4680 ["Previous Package" ada-previous-package t]
4681 ["Next Package" ada-next-package t]
4682 ["Previous Procedure" ada-previous-procedure t]
4683 ["Next Procedure" ada-next-procedure t]
4684 ["Goto Start Of Statement" ada-move-to-start t]
4685 ["Goto End Of Statement" ada-move-to-end t]
4686 ["-" nil nil]
4687 ["Other File" ff-find-other-file t]
4688 ["Other File Other Window" ada-ff-other-window t])
4689 ("Edit" :included (eq major-mode 'ada-mode)
4690 ["Search File On Source Path" ada-find-file t]
4691 ["------" nil nil]
4692 ["Complete Identifier" ada-complete-identifier t]
4693 ["-----" nil nil]
4694 ["Indent Line" ada-indent-current-function t]
4695 ["Justify Current Indentation" ada-justified-indent-current t]
4696 ["Indent Lines in Selection" ada-indent-region t]
4697 ["Indent Lines in File"
4698 (ada-indent-region (point-min) (point-max)) t]
4699 ["Format Parameter List" ada-format-paramlist t]
4700 ["-" nil nil]
4701 ["Comment Selection" comment-region t]
4702 ["Uncomment Selection" ada-uncomment-region t]
4703 ["--" nil nil]
4704 ["Fill Comment Paragraph" fill-paragraph t]
4705 ["Fill Comment Paragraph Justify"
4706 ada-fill-comment-paragraph-justify t]
4707 ["Fill Comment Paragraph Postfix"
4708 ada-fill-comment-paragraph-postfix t]
4709 ["---" nil nil]
4710 ["Adjust Case Selection" ada-adjust-case-region t]
4711 ["Adjust Case in File" ada-adjust-case-buffer t]
4712 ["Create Case Exception" ada-create-case-exception t]
4713 ["Create Case Exception Substring"
4714 ada-create-case-exception-substring t]
4715 ["Reload Case Exceptions" ada-case-read-exceptions t]
4716 ["----" nil nil]
4717 ["Make body for subprogram" ada-make-subprogram-body t]
4718 ["-----" nil nil]
4719 ["Narrow to subprogram" ada-narrow-to-defun t])
4720 ("Templates"
4721 :included (eq major-mode 'ada-mode)
4722 ["Header" ada-header t]
4723 ["-" nil nil]
4724 ["Package Body" ada-package-body t]
4725 ["Package Spec" ada-package-spec t]
4726 ["Function Spec" ada-function-spec t]
4727 ["Procedure Spec" ada-procedure-spec t]
4728 ["Proc/func Body" ada-subprogram-body t]
4729 ["Task Body" ada-task-body t]
4730 ["Task Spec" ada-task-spec t]
4731 ["Declare Block" ada-declare-block t]
4732 ["Exception Block" ada-exception-block t]
4733 ["--" nil nil]
4734 ["Entry" ada-entry t]
4735 ["Entry family" ada-entry-family t]
4736 ["Select" ada-select t]
4737 ["Accept" ada-accept t]
4738 ["Or accept" ada-or-accep t]
4739 ["Or delay" ada-or-delay t]
4740 ["Or terminate" ada-or-terminate t]
4741 ["---" nil nil]
4742 ["Type" ada-type t]
4743 ["Private" ada-private t]
4744 ["Subtype" ada-subtype t]
4745 ["Record" ada-record t]
4746 ["Array" ada-array t]
4747 ["----" nil nil]
4748 ["If" ada-if t]
4749 ["Else" ada-else t]
4750 ["Elsif" ada-elsif t]
4751 ["Case" ada-case t]
4752 ["-----" nil nil]
4753 ["While Loop" ada-while-loop t]
4754 ["For Loop" ada-for-loop t]
4755 ["Loop" ada-loop t]
4756 ["------" nil nil]
4757 ["Exception" ada-exception t]
4758 ["Exit" ada-exit t]
4759 ["When" ada-when t])
4760 )))
4762 (easy-menu-define ada-mode-menu ada-mode-map "Menu keymap for Ada mode" m)
4763 (if (featurep 'xemacs)
4764 (progn
4765 (define-key ada-mode-map [menu-bar] ada-mode-menu)
4766 (set 'mode-popup-menu (cons "Ada mode" ada-mode-menu))))))
4768 \f
4769 ;; -------------------------------------------------------
4770 ;; Commenting/Uncommenting code
4771 ;; The following two calls are provided to enhance the standard
4772 ;; comment-region function, which only allows uncommenting if the
4773 ;; comment is at the beginning of a line. If the line have been re-indented,
4774 ;; we are unable to use comment-region, which makes no sense.
4775 ;;
4776 ;; In addition, we provide an interface to the standard comment handling
4777 ;; function for justifying the comments.
4778 ;; -------------------------------------------------------
4780 (defadvice comment-region (before ada-uncomment-anywhere disable)
4781 (if (and (consp arg) ;; a prefix with \C-u is of the form '(4), whereas
4782 ;; \C-u 2 sets arg to '2' (fixed by S.Leake)
4783 (derived-mode-p 'ada-mode))
4784 (save-excursion
4786 (goto-char beg)
4787 (while (re-search-forward cs end t)
4788 (replace-match comment-start))
4789 ))))
4791 (defun ada-uncomment-region (beg end &optional arg)
4792 "Uncomment region BEG .. END.
4793 ARG gives number of comment characters."
4796 ;; This advice is not needed anymore with Emacs21. However, for older
4797 ;; versions, as well as for XEmacs, we still need to enable it.
4798 (if (or (<= emacs-major-version 20) (featurep 'xemacs))
4799 (progn
4800 (ad-activate 'comment-region)
4801 (comment-region beg end (- (or arg 2)))
4802 (ad-deactivate 'comment-region))
4803 (comment-region beg end (list (- (or arg 2))))
4804 (ada-indent-region beg end)))
4806 (defun ada-fill-comment-paragraph-justify ()
4807 "Fill current comment paragraph and justify each line as well."
4808 (interactive)
4809 (ada-fill-comment-paragraph 'full))
4811 (defun ada-fill-comment-paragraph-postfix ()
4812 "Fill current comment paragraph and justify each line as well.
4813 Adds `ada-fill-comment-postfix' at the end of each line."
4814 (interactive)
4815 (ada-fill-comment-paragraph 'full t))
4817 (defun ada-fill-comment-paragraph (&optional justify postfix)
4818 "Fill the current comment paragraph.
4819 If JUSTIFY is non-nil, each line is justified as well.
4820 If POSTFIX and JUSTIFY are non-nil, `ada-fill-comment-postfix' is appended
4821 to each line filled and justified.
4822 The paragraph is indented on the first line."
4823 (interactive "P")
4825 ;; check if inside comment or just in front a comment
4826 (if (and (not (ada-in-comment-p))
4828 (error "Not inside comment"))
4830 (let* (indent from to
4831 (opos (point-marker))
4833 ;; Sets this variable to nil, otherwise it prevents
4834 ;; fill-region-as-paragraph to work on Emacs <= 20.2
4835 (parse-sexp-lookup-properties nil)
4837 fill-prefix
4838 (fill-column (current-fill-column)))
4840 ;; Find end of paragraph
4841 (back-to-indentation)
4843 (forward-line 1)
4845 ;; If we were at the last line in the buffer, create a dummy empty
4846 ;; line at the end of the buffer.
4847 (if (eobp)
4849 (back-to-indentation)))
4850 (beginning-of-line)
4851 (setq to (point-marker))
4852 (goto-char opos)
4854 ;; Find beginning of paragraph
4855 (back-to-indentation)
4857 (forward-line -1)
4858 (back-to-indentation))
4860 ;; We want one line above the first one, unless we are at the beginning
4861 ;; of the buffer
4862 (unless (bobp)
4863 (forward-line 1))
4864 (beginning-of-line)
4865 (setq from (point-marker))
4867 ;; Calculate the indentation we will need for the paragraph
4868 (back-to-indentation)
4869 (setq indent (current-column))
4870 ;; unindent the first line of the paragraph
4871 (delete-region from (point))
4873 ;; Remove the old postfixes
4874 (goto-char from)
4878 (goto-char (1- to))
4879 (setq to (point-marker))
4881 ;; Indent and justify the paragraph
4882 (setq fill-prefix ada-fill-comment-prefix)
4883 (set-left-margin from to indent)
4884 (if postfix
4885 (setq fill-column (- fill-column (length ada-fill-comment-postfix))))
4887 (fill-region-as-paragraph from to justify)
4889 ;; Add the postfixes if required
4890 (if postfix
4891 (save-restriction
4892 (goto-char from)
4893 (narrow-to-region from to)
4894 (while (not (eobp))
4895 (end-of-line)
4896 (insert-char ? (- fill-column (current-column)))
4897 (insert ada-fill-comment-postfix)
4898 (forward-line))
4899 ))
4901 ;; In Emacs <= 20.2 and XEmacs <=20.4, there is a bug, and a newline is
4902 ;; inserted at the end. Delete it
4903 (if (or (featurep 'xemacs)
4904 (<= emacs-major-version 19)
4905 (and (= emacs-major-version 20)
4906 (<= emacs-minor-version 2)))
4907 (progn
4908 (goto-char to)
4909 (end-of-line)
4910 (delete-char 1)))
4912 (goto-char opos)))
4915 ;; ---------------------------------------------------
4916 ;; support for find-file.el
4917 ;; These functions are used by find-file to guess the file names from
4918 ;; unit names, and to find the other file (spec or body) from the current
4919 ;; file (body or spec).
4920 ;; It is also used to find in which function we are, so as to put the
4921 ;; cursor at the correct position.
4922 ;; Standard Ada does not force any relation between unit names and file names,
4923 ;; so some of these functions can only be a good approximation. However, they
4924 ;; are also overridden in `ada-xref'.el when we know that the user is using
4925 ;; GNAT.
4926 ;; ---------------------------------------------------
4928 ;; Overridden when we work with GNAT, to use gnatkrunch
4929 (defun ada-make-filename-from-adaname (adaname)
4930 "Determine the filename in which ADANAME is found.
4931 This matches the GNAT default naming convention, except for
4932 pre-defined units."
4934 (setq adaname (replace-match "-" t t adaname)))
4935 (downcase adaname)
4936 )
4938 (defun ada-other-file-name ()
4939 "Return the name of the other file.
4940 The name returned is the body if `current-buffer' is the spec,
4941 or the spec otherwise."
4943 (let ((is-spec nil)
4944 (is-body nil)
4945 (suffixes ada-spec-suffixes)
4946 (name (buffer-file-name)))
4948 ;; Guess whether we have a spec or a body, and get the basename of the
4949 ;; file. Since the extension may not start with '.', we can not use
4950 ;; file-name-extension
4951 (while (and (not is-spec)
4952 suffixes)
4954 (setq is-spec t
4955 name (match-string 1 name)))
4956 (setq suffixes (cdr suffixes)))
4958 (if (not is-spec)
4959 (progn
4960 (setq suffixes ada-body-suffixes)
4961 (while (and (not is-body)
4962 suffixes)
4964 (setq is-body t
4965 name (match-string 1 name)))
4966 (setq suffixes (cdr suffixes)))))
4968 ;; If this wasn't in either list, return name itself
4969 (if (not (or is-spec is-body))
4970 name
4972 ;; Else find the other possible names
4973 (if is-spec
4974 (setq suffixes ada-body-suffixes)
4975 (setq suffixes ada-spec-suffixes))
4976 (setq is-spec name)
4978 (while suffixes
4980 ;; If we are using project file, search for the other file in all
4981 ;; the possible src directories.
4983 (if (fboundp 'ada-find-src-file-in-dir)
4984 (let ((other
4985 (ada-find-src-file-in-dir
4986 (file-name-nondirectory (concat name (car suffixes))))))
4987 (if other
4988 (set 'is-spec other)))
4990 ;; Else search in the current directory
4991 (if (file-exists-p (concat name (car suffixes)))
4992 (setq is-spec (concat name (car suffixes)))))
4993 (setq suffixes (cdr suffixes)))
4995 is-spec)))
4997 (defun ada-which-function-are-we-in ()
4998 "Return the name of the function whose definition/declaration point is in.
4999 Used in `ff-pre-load-hook'."
5000 (setq ff-function-name nil)
5001 (save-excursion
5002 (end-of-line);; make sure we get the complete name
5003 (or (if (re-search-backward ada-procedure-start-regexp nil t)
5004 (setq ff-function-name (match-string 5)))
5005 (if (re-search-backward ada-package-start-regexp nil t)
5006 (setq ff-function-name (match-string 4))))
5007 ))
5010 (defvar ada-last-which-function-line -1
5011 "Last line on which `ada-which-function' was called.")
5012 (defvar ada-last-which-function-subprog 0
5013 "Last subprogram name returned by `ada-which-function'.")
5014 (make-variable-buffer-local 'ada-last-which-function-subprog)
5015 (make-variable-buffer-local 'ada-last-which-function-line)
5018 (defun ada-which-function ()
5019 "Return the name of the function whose body the point is in.
5020 This function works even in the case of nested subprograms, whereas the
5021 standard Emacs function `which-function' does not.
5022 Since the search can be long, the results are cached."
5024 (let ((line (count-lines 1 (point)))
5025 (pos (point))
5026 end-pos
5027 func-name indent
5028 found)
5030 ;; If this is the same line as before, simply return the same result
5031 (if (= line ada-last-which-function-line)
5032 ada-last-which-function-subprog
5034 (save-excursion
5035 ;; In case the current line is also the beginning of the body
5036 (end-of-line)
5041 (condition-case nil
5042 (up-list 1)
5043 (error nil))
5046 (if (looking-at "return")
5047 (progn
5048 (forward-word 1)
5050 (skip-chars-forward "a-zA-Z0-9_'")))
5052 ;; Can't simply do forward-word, in case the "is" is not on the
5053 ;; same line as the closing parenthesis
5056 ;; No look for the closest subprogram body that has not ended yet.
5057 ;; Not that we expect all the bodies to be finished by "end <name>",
5058 ;; or a simple "end;" indented in the same column as the start of
5059 ;; the subprogram. The goal is to be as efficient as possible.
5061 (while (and (not found)
5062 (re-search-backward ada-imenu-subprogram-menu-re nil t))
5064 ;; Get the function name, but not the properties, or this changes
5065 ;; the face in the modeline on Emacs 21
5066 (setq func-name (match-string-no-properties 2))
5067 (if (and (not (ada-in-comment-p))
5068 (not (save-excursion
5069 (goto-char (match-end 0))
5071 (save-excursion
5072 (back-to-indentation)
5073 (setq indent (current-column))
5074 (if (ada-search-ignore-string-comment
5076 (make-string indent ? ) "end;"))
5077 (setq end-pos (point))
5078 (setq end-pos (point-max)))
5079 (if (>= end-pos pos)
5080 (setq found func-name))))
5081 )
5082 (setq ada-last-which-function-line line
5083 ada-last-which-function-subprog found)
5084 found))))
5086 (defun ada-ff-other-window ()
5087 "Find other file in other window using `ff-find-other-file'."
5088 (interactive)
5089 (and (fboundp 'ff-find-other-file)
5090 (ff-find-other-file t)))
5092 (defun ada-set-point-accordingly ()
5093 "Move to the function declaration that was set by `ff-which-function-are-we-in'."
5094 (if ff-function-name
5095 (progn
5096 (goto-char (point-min))
5097 (unless (ada-search-ignore-string-comment
5099 (goto-char (point-min))))))
5101 (defun ada-get-body-name (&optional spec-name)
5102 "Return the file name for the body of SPEC-NAME.
5103 If SPEC-NAME is nil, return the body for the current package.
5104 Return nil if no body was found."
5105 (interactive)
5107 (unless spec-name (setq spec-name (buffer-file-name)))
5109 ;; Remove the spec extension. We can not simply remove the file extension,
5110 ;; but we need to take into account the specific non-GNAT extensions that the
5111 ;; user might have specified.
5113 (let ((suffixes ada-spec-suffixes)
5114 end)
5115 (while suffixes
5116 (setq end (- (length spec-name) (length (car suffixes))))
5117 (if (string-equal (car suffixes) (substring spec-name end))
5118 (setq spec-name (substring spec-name 0 end)))
5119 (setq suffixes (cdr suffixes))))
5121 ;; If find-file.el was available, use its functions
5122 (if (fboundp 'ff-get-file-name)
5123 (ff-get-file-name ada-search-directories-internal
5124 (ada-make-filename-from-adaname
5125 (file-name-nondirectory
5126 (file-name-sans-extension spec-name)))
5127 ada-body-suffixes)
5128 ;; Else emulate it very simply
5129 (concat (ada-make-filename-from-adaname
5130 (file-name-nondirectory
5131 (file-name-sans-extension spec-name)))
5132 ".adb")))
5134 \f
5135 ;; ---------------------------------------------------
5136 ;; support for font-lock.el
5137 ;; Strings are a real pain in Ada because a single quote character is
5138 ;; overloaded as a string quote and type/instance delimiter. By default, a
5139 ;; single quote is given punctuation syntax in `ada-mode-syntax-table'.
5140 ;; So, for Font Lock mode purposes, we mark single quotes as having string
5141 ;; syntax when the gods that created Ada determine them to be.
5142 ;;
5143 ;; This only works in Emacs. See the comments before the grammar functions
5144 ;; at the beginning of this file for how this is done with XEmacs.
5145 ;; ----------------------------------------------------
5147 (defconst ada-font-lock-syntactic-keywords
5148 ;; Mark single quotes as having string quote syntax in 'c' instances.
5149 ;; We used to explicitly avoid ''' as a special case for fear the buffer
5150 ;; be highlighted as a string, but it seems this fear is unfounded.
5151 ;;
5152 ;; This sets the properties of the characters, so that ada-in-string-p
5153 ;; correctly handles '"' too...
5157 (defvar ada-font-lock-keywords
5158 (eval-when-compile
5159 (list
5160 ;;
5161 ;; handle "type T is access function return S;"
5164 ;; preprocessor line
5167 ;;
5168 ;; accept, entry, function, package (body), protected (body|type),
5169 ;; pragma, procedure, task (body) plus name.
5170 (list (concat
5184 "task"
5187 '(1 font-lock-keyword-face) '(2 font-lock-function-name-face nil t))
5188 ;;
5189 ;; Optional keywords followed by a type name.
5191 "\\<\\(access[ \t]+all\\|access[ \t]+constant\\|access\\|constant\\|in[ \t]+reverse\\|\\|in[ \t]+out\\|in\\|out\\)\\>"
5194 '(1 font-lock-keyword-face nil t) '(2 font-lock-type-face nil t))
5196 ;;
5197 ;; Main keywords, except those treated specially below.
5199 (regexp-opt
5200 '("abort" "abs" "abstract" "accept" "access" "aliased" "all"
5201 "and" "array" "at" "begin" "case" "declare" "delay" "delta"
5202 "digits" "do" "else" "elsif" "entry" "exception" "exit" "for"
5203 "generic" "if" "in" "interface" "is" "limited" "loop" "mod" "not"
5204 "null" "or" "others" "overriding" "private" "protected" "raise"
5205 "range" "record" "rem" "renames" "requeue" "return" "reverse"
5206 "select" "separate" "synchronized" "tagged" "task" "terminate"
5207 "then" "until" "when" "while" "with" "xor") t)
5209 ;;
5210 ;; Anything following end and not already fontified is a body name.
5212 (1 font-lock-keyword-face) (3 font-lock-function-name-face nil t))
5213 ;;
5214 ;; Keywords followed by a type or function name.
5218 '(1 font-lock-keyword-face)
5219 '(2 (if (match-beginning 4)
5220 font-lock-function-name-face
5221 font-lock-type-face) nil t))
5222 ;;
5223 ;; Keywords followed by a (comma separated list of) reference.
5224 ;; Note that font-lock only works on single lines, thus we can not
5225 ;; correctly highlight a with_clause that spans multiple lines.
5228 '(1 font-lock-keyword-face) '(2 font-lock-reference-face nil t))
5230 ;;
5231 ;; Goto tags.
5234 ;; Highlight based-numbers (R. Reagan <robin-reply@reagans.org>)
5237 ;; Ada unnamed numerical constants
5240 ))
5241 "Default expressions to highlight in Ada mode.")
5244 ;; ---------------------------------------------------------
5245 ;; Support for outline.el
5246 ;; ---------------------------------------------------------
5248 (defun ada-outline-level ()
5249 "This is so that `current-column' DTRT in otherwise-hidden text."
5250 ;; patch from Dave Love <fx@gnu.org>
5251 (let (buffer-invisibility-spec)
5252 (save-excursion
5253 (back-to-indentation)
5254 (current-column))))
5256 ;; ---------------------------------------------------------
5257 ;; Support for narrow-to-region
5258 ;; ---------------------------------------------------------
5260 (defun ada-narrow-to-defun (&optional arg)
5261 "Make text outside current subprogram invisible.
5262 The subprogram visible is the one that contains or follow point.
5263 Optional ARG is ignored.
5266 (interactive)
5267 (save-excursion
5268 (let (end)
5269 (widen)
5270 (forward-line 1)
5271 (ada-previous-procedure)
5273 (save-excursion
5274 (beginning-of-line)
5275 (setq end (point)))
5277 (ada-move-to-end)
5278 (end-of-line)
5279 (narrow-to-region end (point))
5280 (message
5281 "Use M-x widen to get back to full visibility in the buffer"))))
5283 ;; ---------------------------------------------------------
5284 ;; Automatic generation of code
5285 ;; The Ada mode has a set of function to automatically generate a subprogram
5286 ;; or package body from its spec.
5287 ;; These function only use a primary and basic algorithm, this could use a
5288 ;; lot of improvement.
5289 ;; When the user is using GNAT, we rather use gnatstub to generate an accurate
5290 ;; body.
5291 ;; ----------------------------------------------------------
5293 (defun ada-gen-treat-proc (match)
5294 "Make dummy body of a procedure/function specification.
5295 MATCH is a cons cell containing the start and end locations of the last search
5296 for `ada-procedure-start-regexp'."
5297 (goto-char (car match))
5298 (let (func-found procname functype)
5299 (cond
5302 ;; treat it as a proc/func
5303 (forward-word 2)
5304 (forward-word -1)
5305 (setq procname (buffer-substring (point) (cdr match))) ; store proc name
5307 ;; goto end of procname
5308 (goto-char (cdr match))
5310 ;; skip over parameterlist
5312 (forward-sexp))
5314 ;; if function, skip over 'return' and result type.
5315 (if func-found
5316 (progn
5317 (forward-word 1)
5319 (setq functype (buffer-substring (point)
5320 (progn
5321 (skip-chars-forward
5322 "a-zA-Z0-9_\.")
5323 (point))))))
5324 ;; look for next non WS
5325 (cond
5327 (delete-region (match-beginning 0) (match-end 0));; delete the ';'
5328 (ada-indent-newline-indent)
5329 (insert "is")
5330 (ada-indent-newline-indent)
5331 (if func-found
5332 (progn
5333 (insert "Result : " functype ";")
5334 (ada-indent-newline-indent)))
5335 (insert "begin")
5336 (ada-indent-newline-indent)
5337 (if func-found
5338 (insert "return Result;")
5339 (insert "null;"))
5340 (ada-indent-newline-indent)
5341 (insert "end " procname ";")
5342 (ada-indent-newline-indent)
5343 )
5346 ;; do nothing
5347 )
5350 ;; do nothing
5351 )
5353 (t
5354 (message "unknown syntax"))))
5355 (t
5357 (progn
5358 (message "Task conversion is not yet implemented")
5359 (forward-word 2)
5361 (forward-line)
5362 (ada-move-to-end))
5363 ))))))
5365 (defun ada-make-body ()
5366 "Create an Ada package body in the current buffer.
5367 The spec must be the previously visited buffer.
5368 This function typically is to be hooked into `ff-file-created-hook'."
5369 (delete-region (point-min) (point-max))
5370 (insert-buffer-substring (car (cdr (buffer-list))))
5371 (goto-char (point-min))
5372 (ada-mode)
5374 (let (found ada-procedure-or-package-start-regexp)
5375 (if (setq found
5376 (ada-search-ignore-string-comment ada-package-start-regexp nil))
5377 (progn (goto-char (cdr found))
5378 (insert " body")
5379 )
5380 (error "No package"))
5382 (setq ada-procedure-or-package-start-regexp
5383 (concat ada-procedure-start-regexp
5385 ada-package-start-regexp))
5387 (while (setq found
5388 (ada-search-ignore-string-comment
5389 ada-procedure-or-package-start-regexp nil))
5390 (progn
5391 (goto-char (car found))
5392 (if (looking-at ada-package-start-regexp)
5393 (progn (goto-char (cdr found))
5394 (insert " body"))
5395 (ada-gen-treat-proc found))))))
5398 (defun ada-make-subprogram-body ()
5399 "Create a dummy subprogram body in package body file from spec surrounding point."
5400 (interactive)
5401 (let* ((found (re-search-backward ada-procedure-start-regexp nil t))
5402 (spec (match-beginning 0))
5403 body-file)
5404 (if found
5405 (progn
5406 (goto-char spec)
5408 (= (char-before) ?\())
5409 (progn
5410 (ada-search-ignore-string-comment ")" nil)
5411 (ada-search-ignore-string-comment ";" nil)))
5412 (setq spec (buffer-substring spec (point)))
5414 ;; If find-file.el was available, use its functions
5415 (setq body-file (ada-get-body-name))
5416 (if body-file
5417 (find-file body-file)
5418 (error "No body found for the package. Create it first"))
5420 (save-restriction
5421 (widen)
5422 (goto-char (point-max))
5423 (forward-comment -10000)
5425 ;; Move to the beginning of the elaboration part, if any
5426 (re-search-backward "^begin" nil t)
5427 (newline)
5428 (forward-char -1)
5429 (insert spec)
5430 (re-search-backward ada-procedure-start-regexp nil t)
5431 (ada-gen-treat-proc (cons (match-beginning 0) (match-end 0)))
5432 ))
5433 (error "Not in subprogram spec"))))
5435 ;; --------------------------------------------------------
5436 ;; Global initializations
5437 ;; --------------------------------------------------------
5439 ;; Create the keymap once and for all. If we do that in ada-mode,
5440 ;; the keys changed in the user's .emacs have to be modified
5441 ;; every time
5442 (ada-create-keymap)
5443 (ada-create-menu)
5445 ;; Create the syntax tables, but do not activate them
5446 (ada-create-syntax-table)
5448 ;; Add the default extensions (and set up speedbar)
5449 (ada-add-extensions ".ads" ".adb")
5450 ;; This two files are generated by GNAT when running with -gnatD
5451 (if (equal ada-which-compiler 'gnat)
5452 (ada-add-extensions ".ads.dg" ".adb.dg"))
5454 ;; Read the special cases for exceptions
5455 (ada-case-read-exceptions)
5457 ;; Setup auto-loading of the other Ada mode files.
5458 (autoload 'ada-change-prj "ada-xref" nil t)
5459 (autoload 'ada-check-current "ada-xref" nil t)
5460 (autoload 'ada-compile-application "ada-xref" nil t)
5461 (autoload 'ada-compile-current "ada-xref" nil t)
5462 (autoload 'ada-complete-identifier "ada-xref" nil t)
5463 (autoload 'ada-find-file "ada-xref" nil t)
5464 (autoload 'ada-find-any-references "ada-xref" nil t)
5465 (autoload 'ada-find-src-file-in-dir "ada-xref" nil t)
5466 (autoload 'ada-find-local-references "ada-xref" nil t)
5467 (autoload 'ada-find-references "ada-xref" nil t)
5468 (autoload 'ada-gdb-application "ada-xref" nil t)
5469 (autoload 'ada-goto-declaration "ada-xref" nil t)
5470 (autoload 'ada-goto-declaration-other-frame "ada-xref" nil t)
5471 (autoload 'ada-goto-parent "ada-xref" nil t)
5472 (autoload 'ada-make-body-gnatstub "ada-xref" nil t)
5473 (autoload 'ada-point-and-xref "ada-xref" nil t)
5474 (autoload 'ada-reread-prj-file "ada-xref" nil t)
5475 (autoload 'ada-run-application "ada-xref" nil t)
5476 (autoload 'ada-set-default-project-file "ada-xref" nil t)
5477 (autoload 'ada-xref-goto-previous-reference "ada-xref" nil t)
5478 (autoload 'ada-set-main-compile-application "ada-xref" nil t)
5479 (autoload 'ada-show-current-main "ada-xref" nil t)
5481 (autoload 'ada-customize "ada-prj" nil t)
5482 (autoload 'ada-prj-edit "ada-prj" nil t)
5483 (autoload 'ada-prj-new "ada-prj" nil t)
5484 (autoload 'ada-prj-save "ada-prj" nil t)
5486 (autoload 'ada-array "ada-stmt" nil t)
5487 (autoload 'ada-case "ada-stmt" nil t)
5488 (autoload 'ada-declare-block "ada-stmt" nil t)
5489 (autoload 'ada-else "ada-stmt" nil t)
5490 (autoload 'ada-elsif "ada-stmt" nil t)
5491 (autoload 'ada-exception "ada-stmt" nil t)
5492 (autoload 'ada-exception-block "ada-stmt" nil t)
5493 (autoload 'ada-exit "ada-stmt" nil t)
5494 (autoload 'ada-for-loop "ada-stmt" nil t)
5495 (autoload 'ada-function-spec "ada-stmt" nil t)
5496 (autoload 'ada-header "ada-stmt" nil t)
5497 (autoload 'ada-if "ada-stmt" nil t)
5498 (autoload 'ada-loop "ada-stmt" nil t)
5499 (autoload 'ada-package-body "ada-stmt" nil t)
5500 (autoload 'ada-package-spec "ada-stmt" nil t)
5501 (autoload 'ada-private "ada-stmt" nil t)
5502 (autoload 'ada-procedure-spec "ada-stmt" nil t)
5503 (autoload 'ada-record "ada-stmt" nil t)
5504 (autoload 'ada-subprogram-body "ada-stmt" nil t)
5505 (autoload 'ada-subtype "ada-stmt" nil t)
5506 (autoload 'ada-tabsize "ada-stmt" nil t)
5507 (autoload 'ada-task-body "ada-stmt" nil t)
5508 (autoload 'ada-task-spec "ada-stmt" nil t)
5509 (autoload 'ada-type "ada-stmt" nil t)
5510 (autoload 'ada-use "ada-stmt" nil t)
5511 (autoload 'ada-when "ada-stmt" nil t)
5512 (autoload 'ada-while-loop "ada-stmt" nil t)
5513 (autoload 'ada-with "ada-stmt" nil t)
5515 ;;; provide ourselves
5516 (provide 'ada-mode)
5518 ;; arch-tag: 1b7d45ec-1698-43b5-8d4a-e479ea023270
5519 ;;; ada-mode.el ends here