1 \input texinfo @c -*-texinfo-*-
2 @setfilename ../info/ada-mode
6 * Ada mode: (ada-mode). The GNU Emacs mode for editing Ada.
9 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10 @comment The following lines inserts the copyright notice
11 @comment into the Info file.
12 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
15 Copyright @copyright{} 1999, 2000, 2001 Free Software Foundation, Inc.
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.1 or
19 any later version published by the Free Software Foundation; with the
20 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
21 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
22 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
23 license is included in the section entitled ``GNU Free Documentation
24 License'' in the Emacs manual.
26 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
27 this GNU Manual, like GNU software. Copies published by the Free
28 Software Foundation raise funds for GNU development.''
30 This document is part of a collection distributed under the GNU Free
31 Documentation License. If you want to distribute this document
32 separately from the collection, you can do so by adding a copy of the
33 license to the document, as described in section 6 of the license.
36 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
37 @comment TeX title page
38 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
44 @subtitle An Emacs major mode for programming Ada 95 with GNAT
45 @subtitle July 1998 for Ada Mode Version 3.0
49 @vskip 0pt plus 1filll
50 Copyright @copyright{} 1999, 2000, 2001 Free Software Foundation, Inc.
52 Permission is granted to copy, distribute and/or modify this document
53 under the terms of the GNU Free Documentation License, Version 1.1 or
54 any later version published by the Free Software Foundation; with the
55 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
56 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
57 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
58 license is included in the section entitled ``GNU Free Documentation
59 License'' in the Emacs manual.
61 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
62 this GNU Manual, like GNU software. Copies published by the Free
63 Software Foundation raise funds for GNU development.''
65 This document is part of a collection distributed under the GNU Free
66 Documentation License. If you want to distribute this document
67 separately from the collection, you can do so by adding a copy of the
68 license to the document, as described in section 6 of the license.
72 @node Top, Overview, (dir), (dir)
76 * Installation:: Installing the Ada mode on your system
77 * Customization:: Setting up the Ada mode to your taste
78 * Project files:: Describing the organization of your project
79 * Syntax highlighting:: Using specific colors and fonts to highlight
80 the structure of your files
81 * Moving Through Ada Code:: Moving easily through Ada sources
82 * Identifier completion:: Finishing words automatically
83 * Index Menu of Subprograms:: A menu of all the types and subprograms
84 defined in your application
85 * File Browser:: Easy access to your files
86 * Automatic Smart Indentation:: Indenting your code automatically as you type
87 * Formatting Parameter Lists:: Formating subprograms parameter lists
89 * Automatic Casing:: Adjusting the case of words automatically
90 * Statement Templates:: Inserting code templates
91 * Comment Handling:: Reformatting comments easily
92 * Compiling Executing:: Working with your application within Emacs
93 * Debugging:: Debugging your application
94 * Using non-standard file names:: Configuring Emacs for special file names
95 * Working Remotely:: Working on a different machine
99 @c -----------------------------------------------------------------------
100 @node Overview, Installation, Top, Top
102 @c -----------------------------------------------------------------------
104 The Emacs mode for programming in Ada 95 with GNAT helps the user in
105 understanding existing code and facilitates writing new code. It
106 furthermore provides some utility functions for easier integration of
107 standard Emacs features when programming in Ada.
109 @section General features:
112 @item full Integrated Development Environment :
114 @item support of 'project files' for the configuration (directories,
115 compilation options,...)
116 @item compiling and stepping through error messages.
117 @item running and debugging your applications within Emacs.
119 @item easy to use for beginners by pull-down menus,
120 @item user configurable by many user-option variables.
123 @section Ada mode features that help understanding code:
126 @item functions for easy and quick stepping through Ada code,
127 @item getting cross reference information for identifiers (e.g. find the
128 defining place by a keystroke),
129 @item displaying an index menu of types and subprograms and move point to
131 @item automatic color highlighting of the various entities in Ada code.
134 @section Emacs support for writing Ada code:
137 @item switching between spec and body files with eventually
138 auto-generation of body files,
139 @item automatic formating of subprograms parameter lists.
140 @item automatic smart indentation according to Ada syntax,
141 @item automatic completion of identifiers,
142 @item automatic casing of identifiers, keywords, and attributes,
143 @item insertion of statement templates,
144 @item filling comment paragraphs like filling normal text,
147 @c -----------------------------------------------------------------------
148 @node Installation, Customization, Overview, Top
149 @chapter Installation
150 @c -----------------------------------------------------------------------
152 If you got the Ada mode as a separate distribution, you should have a
153 look at the @file{README} file. It explains the basic steps necessary
154 for a good installation of the emacs Ada mode.
156 Installing the Ada mode is basically just a matter of copying a few
157 files into the Emacs library directories. Every time you open a file
158 with a file extension of @file{.ads} or @file{.adb}, Emacs will
159 automatically load and activate the Ada mode.
161 See the section @ref{Using non-standard file names}, if your files do
162 not use these extensions and if you want Emacs to automatically start the
163 Ada mode every time you edit an Ada file.
165 See also the Emacs documentation @ref{(emacs)}, for general usage
166 variables that you might want to set.
168 @c ---------------------------------------------------------------------
169 @section Required files
170 @c ---------------------------------------------------------------------
172 This Ada mode works best with Emacs 20.3 or higher (the easy editing
173 features for the project files won't work with any older version), but
174 most of the commands should work with older versions too. Please try to
175 install the most recent version of Emacs on your system before
176 installing the Ada mode.
178 Although part of the Ada mode is compiler independent, the most advanced
179 features are specific to the Gnat compiler @url{http://www.gnat.com}.
181 The following files are provided with the Ada mode distribution:
185 @item @file{ada-mode.el}: The main file for the Ada mode.
186 This is the only file which does not require Gnat. It contains the
187 functions for indentation, formatting of parameter lists, stepping
188 through code, comment handling and automatic casing. Emacs versions
189 20.2 and higher already contain Ada mode version 2.27, which is an older
190 version of this file and should be replaced. Loading @file{ada-mode.el}
191 from the current distribution supersedes the standard installation.
193 @item @file{ada-stmt.el}: Contains the statement templates feature.
195 @item @file{ada-xref.el}: This file provides the main support for Gnat.
196 This is where the functions for cross-references, completion of
197 identifiers, support for project files and compilation of your
198 application are defined.
200 @item @file{ada-prj.el}: The functions to use for easy-edition of the
201 project files. This file is the only one which really requires Emacs at
202 least 20.2. It uses the new widget features from Emacs.
206 @c --------------------------------------------------------------------
207 @node Customization, Project files, Installation, Top
208 @chapter Customizing the Ada mode
209 @c ---------------------------------------------------------------------
211 The ada-mode is fully customizable. Everything, from the file names to
212 the automatic indentation and the automatic casing can be adapted to
215 There are two different kinds of variables that control this
216 customization, both are easy to modify.
218 The first set of variables are standard Emacs variables. Of course, some
219 are defined only for the Ada mode, whereas others have a more general
220 meaning in Emacs. Please see the Emacs documentation for more
221 information on the latest. In this documentation, we will detail all the
222 variables that are specific to the Ada mode, and a few others. The names
223 will be given, as in @code{ada-case-identifier}.
225 Emacs provides an easy way to modify them, through a special mode called
226 customization. To access this mode, select the menu
227 @kbd{Ada->Customize}. This will open a new buffer with some fields that
228 you can edit. For instance, you will get something like:
230 Put below the compiler switches.
231 comp_opt= _____________________________________
233 The first line gives a brief description of the variable. The second
234 line is the name of the variable and the field where you can give a
235 value for this variable. Simply type what you want in the field.
237 When you are finished modifying the variables, you can simply click on
238 the @b{Save for future sessions} button at the top of the buffer (click
239 with the middle mouse button). This will save the values in your
240 @file{.emacs} file, so that next time you start Emacs they will have the
243 To modify a specific variable, you can directly call the function
244 @code{customize-variable} from Emacs (just type @key{M-x
245 customize-variable RET} and then type the variable name.
247 Some users might prefer to modify the variables directly in their
248 configuration file, @file{.emacs}. This file is coded in Emacs lisp, and
249 the syntax to set a variable is the following:
251 (setq variable-name value)
254 The second set of variables for customization are set through the use of
255 project files. These variables are specific to a given project, whereas
256 the first set was more general. For more information, please
257 @xref{Project files}.
259 @c ---------------------------------------------------------------------
260 @node Project files, Syntax highlighting, Customization, Top
261 @chapter Project files
262 @c ---------------------------------------------------------------------
264 @c ---------------------------------------------------------------------
265 @section General overview
266 @c ---------------------------------------------------------------------
268 Emacs provides a full Integrated Development Environment for GNAT and
269 Ada programmers. That is to say, editing, compiling, executing and
270 debugging can be performed within Emacs in a convenient and natural way.
272 To take full advantage of this features, it is possible to create a file
273 in the main directory of your application, with a '.adp' extension.
274 This file contain all needed information dealing with the way your
275 application is organized between directories, the commands to compile,
276 run and debug it etc. Creating this file is not mandatory and convenient
277 defaults are automatically provided for simple setups. It only becomes
278 necessary when those above mentioned defaults need customizing.
280 A simple way to edit this file is provided for Emacs 20.2 or newer, with
281 the following functions, that you can access also through the Ada
282 menu. It is also possible to edit the project file as a regular text
285 Once in the buffer for editing the project file, you can save your
286 modification using the '[OK]' button at the bottom of the buffer, or
287 simply use the usual @kbd{C-x C-s} binding. To cancel your
288 modifications, simply kill the buffer or click on the '[CANCEL]' button
291 Each buffer using Ada mode will be associated with one project file when
292 there is one available, so that Emacs can easily navigate through
293 related source files for instance.
295 The exact algorithm to determine which project file should be used is
296 described in the next section, but you can force the project file you
297 want to use by setting one or two variables in your @file{.emacs} file.
300 @item To set up a default project file to use for any directory, anywhere
301 on your system, set the variable @code{ada-prj-default-project-file} to
302 the name of that file.
304 (set 'ada-prj-default-project-file "/dir1/dir2/file")
307 @item For a finer controlled, you can set a per-directory project file.
308 This is done through the variable @code{ada-xref-default-prj-file}.
310 (set 'ada-xref-default-prj-file
311 '(("/dir1/dir2" . "/dir3/file1")
312 ("/dir4/dir5" . "/dir6/file2")))
314 Note: This has a higher priority than the first variable, so the first
315 choice is to use this variable settings, and otherwise
316 @code{ada-prj-default-project-file}.
321 @item C-c u ada-customize menu: Ada->Project->New/Edit
322 Create or edit the project file for the current buffer.
323 @item C-c c ada-change-prj
324 Change the project file associated with the current Ada buffer.
326 Change the default project file for the current directory. Every new
327 file opened from this directory will be associated with that file by
329 @item ada-set-default-project-file menu: Ada->Project->Set Default
330 Set the default project file to use for *any* Ada file opened anywhere
331 on your system. This sets this file only for the current Emacs session.
334 @c ---------------------------------------------------------------------
335 @section Project file variables
336 @c ---------------------------------------------------------------------
338 The following variables can be defined in a project file. They all have
339 a default value, so that small projects do not need to create a project
342 Some variables below can be referenced in other variables, using a
343 shell-like notation. For instance, if the variable @code{comp_cmd}
344 contains a sequence like @code{$@{comp_opt@}}, the value of that variable
347 Here is the list of variables:
350 @item src_dir [default: "./"]
351 This is a list of directories where the Ada mode will look for source
352 files. These directories are used mainly in two cases, both as a switch
353 for the compiler and for the cross-references.
355 @item obj_dir [default: "./"]
356 This is a list of directories where to look for object and library
357 files. The library files are the .ali files generated by Gnat and that
358 contain cross-reference informations.
360 @item comp_opt [default: ""]
361 Creates a variable which can be referred to subsequently by using the
362 @code{$@{comp_opt@}} notation. This is intended to store the default
363 switches given to `gnatmake' and `gcc'.
365 @item bind_opt=SWITCHES [default: ""]
366 Creates a variable which can be referred to subsequently by using the
367 @code{$@{bind_opt@}} notation. This is intended to store the default
368 switches given to `gnatbind'.
370 @item link_opt=SWITCHES [default: ""]
371 Creates a variable which can be referred to subsequently by using the
372 @code{$@{link_opt@}} notation. This is intended to store the default
373 switches given to `gnatlink'.
375 @item main=EXECUTABLE [default: ""]
376 Specifies the name of the executable for the application. This variable
377 can be referred to in the following lines by using the @code{$@{main@}}
380 @item cross_prefix=PREFIX [default: ""]
381 This variable should be set if you are working in a cross-compilation
382 environment. This is the prefix used in front of the gnatmake commands.
384 @item remote_machine=MACHINE [default: ""]
385 This is the name of the machine to log into before issuing the
386 compilation command. If this variable is empty, the command will be run
387 on the local machine. This will not work on Windows NT machines, since
388 the Ada mode will simply precede the compilation command with a 'rsh'
389 command, unknown on Windows.
391 @item comp_cmd=COMMAND [default: "$@{cross_prefix@}gcc -c -I$@{src_dir@} -g -gnatq"]
392 Specifies the command used to compile a single file in the application.
393 The name of the file will be added at the end of this command.
395 @item make_cmd=COMMAND [default: "$@{cross_prefix@}gnatmake $@{main@} -aI$@{src_dir@} -aO$@{obj_dir@} -g -gnatq -cargs $@{comp_opt@} -bargs $@{bind_opt@} -largs $@{link_opt@}"]'
396 Specifies the command used to recompile the whole application.
398 @item run_cmd=COMMAND [default: "$@{main@}"]
399 Specifies the command used to run the application.
401 @item debug_cmd=COMMAND [default: "$@{cross_prefix@}gdb $@{main@}"]
402 Specifies the command used to debug the application
406 @c ---------------------------------------------------------------------
407 @section Detailed algorithm
408 @c ---------------------------------------------------------------------
410 This section gives more details on the project file setup and is only of
411 interest for advanced users.
413 Usually, an Ada file is part of a larger application, whose sources and
414 objects can be spread over multiple directories. The first time emacs is
415 asked to compile, run or debug an application, or when a cross reference
416 function is used (goto declaration for instance), the following steps
420 @item find the appropriate project file, open and parse it.
421 All the fields read in the project file are then stored by emacs
422 locally. Finding the project file requires a few steps:
425 @item if a file from the same directory was already associated with
426 a project file, use the same one. This is the variable
427 @code{ada-xref-default-prj-file} described above.
428 @item if the variable @code{ada-prj-default-project-file} is set,
429 use the project file specified in this variable.
430 @item if there is a project file whose name is the same as the source file
431 except for the suffix, use this one.
432 @item if there's only one project file in the source directory, use
434 @item if there are more than one project file in the source directory,
436 @item if there are no project files in the source directory use standard
440 The first project file that is selected in a given directory becomes the
441 default project file for this directory and is used implicitly for other
442 sources unless specified otherwise by the user.
444 @item look for the corresponding .ali file in the @code{obj_dir} defined
445 in the project file. If this file can not be found, emacs proposes to
446 compile the source using the @code{comp_cmd} defined in the project file
447 in order to create the ali file.
449 @item when cross referencing is requested, the .ali file is parsed to
450 determine the file and line of the identifier definition. It is
451 possible for the .ali file to be older than the source file, in which
452 case it will be recompiled if the variable @code{ada-xref-create-ali} is
453 set, otherwise the reference is searched in the obsolete ali file with
454 possible inaccurate results.
456 @item look for the file containing the declaration using the source
457 path @code{src_dir} defined in the project file. Put the cursor at the
458 correct position and display this new cursor.
461 @c -----------------------------------------------------------------------
462 @node Syntax highlighting, Moving Through Ada Code, Project files, Top
463 @chapter Syntax highlighting
464 @c -----------------------------------------------------------------------
466 The Ada mode is made to help you understand the structure of your source
467 files. Some people like having colors or different fonts depending on
468 the context: commands should be displayed differently than keywords,
469 which should also be different from strings, ...
471 Emacs is able to display in a different way the following syntactic
478 @item gnatprep statements (preprocessor)
479 @item types (under certain conditions)
483 This is not the default behavior for Emacs. You have to explicitly
484 activate it. This requires that you add a new line in your @file{.emacs}
485 file (if this file does not exist, just create it).
488 (global-font-lock-mode t)
491 But the default colors might not be the ones you like. Fortunately,
492 there is a very easy way to change them. Just select the menu
493 @kbd{Help->Customize->Specific Face...} and press @kbd{Return}. This
494 will display a buffer will all the "faces" (the colors) that Emacs knows
495 about. You can change any of them.
498 @c -----------------------------------------------------------------------
499 @node Moving Through Ada Code, Identifier completion, Syntax highlighting, Top
500 @chapter Moving Through Ada Code
501 @c -----------------------------------------------------------------------
503 There are several easy to use commands to stroll through Ada code. All
504 these functions are available through the Ada menu, and you can also use
505 the following key bindings or the command names:
508 @item M-C-e ada-next-procedure
509 Move to the next function/procedure/task, which ever comes next.
510 @item M-C-a ada-previous-procedure
511 Move to previous function/procedure/task.
512 @item ada-next-package
513 Move to next package.
514 @item ada-prev-package
515 Move to previous package.
516 @item C-c C-a ada-move-to-start
517 Move to matching start of @code{end}. If point is at the end of a
518 subprogram, this command jumps to the corresponding @code{begin} if the
519 user option @code{ada-move-to-declaration} is @code{nil} (default), it
520 jumps to the subprogram declaration otherwise.
521 @item C-c C-e ada-move-to-end
522 Move point to end of current block.
523 @item C-c o ff-find-other-file
524 Switch between corresponding spec and body file. If the cursor is on a
525 subprogram, switch between declaration and body.
527 Move from any reference to its declaration and switch between
528 declaration and body (for procedures, tasks, private and incomplete
530 @item C-c C-r ada-find-references
531 runs the @file{gnatfind} command to search for all references to the
532 entity pointed by the cursor. Use 'next-error' function, or C-x `, to
533 visit each reference (as for compilation errors).
536 These functions use the information in the output of the Gnat Ada
537 compiler. However, if your application was compiled with the
538 @code{-gnatx} switch, these functions will not work, since no extra
539 information is generated by GNAT. See GNAT documentation for further
542 Emacs will try to run Gnat for you whenever the cross-reference
543 informations are older than your source file (provided the
544 @code{ada-xref-create-ali} variable is non nil). Gnat then produces a
545 file with the same name as the current Ada file but with the extension
546 changed to @code{.ali}. This files are normally used by the binder, but
547 they will also contain additional cross-referencing information.
549 @c -----------------------------------------------------------------------
550 @node Identifier completion, Index Menu of Subprograms, Moving Through Ada Code, Top
551 @chapter Identifier completion
552 @c -----------------------------------------------------------------------
554 @c -----------------------------------------------------------------------
556 @c -----------------------------------------------------------------------
558 Emacs and the Ada mode provide two general ways for the completion of
559 identifiers. This is an easy way to type faster: you just have to type
560 the first few letters of an identifiers, and then loop through all the
561 possible completions.
563 The first method is general for Emacs. It will work both with Ada
564 buffers, but also in C buffers, Java buffers, ... The idea is to parse
565 all the opened buffers for possible completions.
567 For instance, if the following words are present in any of the opened
568 files: my_identifier, my_subprogam, then you will have this scenario:
570 You type: my@key{M-/}
571 Emacs will display: my_identifier
572 If you press @key{M-/} once again, Emacs will replace my_identifier with
574 Pressing @key{M-/} once more will bring you back to my_identifier.
577 This is a very fast way to do completion, and the casing of words will
580 The second method is specific to Ada buffer, and even to users of the
581 Gnat compiler. Emacs will search the cross-information found in the .ali
582 files generated by Gnat for possible completions.
584 The main advantage is that this completion is more accurate: only
585 existing identifier will be suggested, you don't need to have a file
586 opened that already contains this identifiers,...
588 On the other hand, this completion is a little bit slower and requires
589 that you have compiled your file at least once since you created that
592 @c -----------------------------------------------------------------------
593 @section Summary of commands
594 @c -----------------------------------------------------------------------
597 @item C-TAB ada-complete-identifier
598 complete accurately current identifier using information in .ali file
600 complete identifier using buffer information (not ada specific)
603 @c -----------------------------------------------------------------------
604 @node Index Menu of Subprograms, File Browser, Identifier completion, Top
605 @chapter Index Menu of Subprograms
606 @c -----------------------------------------------------------------------
608 You can display a choice menu with all procedure/function/task
609 declarations in the file and choose an item by mouse click to get to its
610 declaration. This function is accessible through the 'Ada' menu when
611 editing a Ada file, or simply through the following key binding :
618 @c -----------------------------------------------------------------------
619 @node File Browser, Automatic Smart Indentation, Index Menu of Subprograms, Top
620 @chapter File Browser
621 @c -----------------------------------------------------------------------
623 Emacs provides a special mode, called @code{speedbar}. When this mode is
624 activated, a new frame is displayed, with a file browser. The files from
625 the current directory are displayed, and you can click on them as you
626 would with any file browser. The following commands are then available.
628 You can click on a directory name or file name to open it. The editor
629 will automatically select the best possible mode for this file,
630 including of course the ada-mode for files written in Ada
632 If you click on the [+] symbol near a file name, all the symbols (types,
633 variables and subprograms) defined in that file will be displayed, and
634 you can directly click on them to open the right file at the right
637 You can activate this mode by typing @key{M-x speedbar} in the editor.
638 This will open a new frame. A better way might be to assicate the
639 following key binding
642 (global-set-key [f7] 'speedbar-get-focus)
645 Every time you press @key{f7}, the mouse will automatically move to the
646 speedbar frame (which will be created if it does not exist).
648 @c -----------------------------------------------------------------------
649 @node Automatic Smart Indentation, Formatting Parameter Lists, File Browser, Top
650 @chapter Automatic Smart Indentation
651 @c -----------------------------------------------------------------------
653 The Ada mode comes with a full set of rules for automatic indentation.
654 You can of course configure the indentation as you want, by setting the
655 value of a few variables.
657 As always, the preferred way to modify variables is to use the
658 @code{Ada->Customize} menu (don't forget to save your changes!). This
659 will also show you some example of code where this variable is used, and
660 hopefully make things clearer.
662 The relevant variables are the following:
665 @item ada-broken-indent (default value: 2)
666 Number of columns to indent the continuation of a broken line
668 @item ada-indent (default value: 3)
669 Width of the default indentation
671 @item ada-indent-record-rel-type (default value: 3)
672 Indentation for 'record' relative to 'type' or 'use'
674 @item ada-indent-return (default value: 0)
675 Indentation for 'return' relative to 'function' (if ada-indent-return
676 is greater than 0), or the open parenthesis (if ada-indent-return is
677 negative or null). Note that in the second case, when there is no
678 open parenthesis, the indentation is done relative to 'function' with
679 the value of ada-broken-indent.
681 @item ada-label-indent (default value: -4)
682 Number of columns to indent a label
684 @item ada-stmt-end-indent (default value: 0)
685 Number of columns to indent a statement 'end' keyword on a separate line
687 @item ada-when-indent (default value: 3)
688 Indentation for 'when' relative to 'exception' or 'case'
690 @item ada-indent-is-separate (default value: t)
691 Non-nil means indent 'is separate' or 'is abstract' if on a single line
693 @item ada-indent-to-open-paren (default value: t)
694 Non-nil means indent according to the innermost open parenthesis
696 @item ada-indent-after-return (default value: t)
697 Non-nil means that the current line will also be re-indented before
698 inserting a newline, when you press @kbd{Return}.
702 Most of the time, the indentation will be automatic, i.e when you will
703 press @kbd{Return}, the cursor will move to the correct column on the
706 However, you might want or need sometimes to re-indent the current line
707 or a set of lines. For this, you can simply go to that line, or select
708 the lines, and then press @kbd{TAB}. This will automatically re-indent
711 Another mode of indentation exists that helps you to set up your
712 indentation scheme. If you press @kbd{C-c TAB}, the ada-mode will do the
715 @item Reindent the current line, as @kbd{TAB} would do
716 @item Temporarily move the cursor to a reference line, i.e the line that
717 was used to calculate the current indentation
718 @item Display at the bottom of the window the name of the variable that
719 provided the offset for the indentation
722 The exact indentation of the current line is the same as the one for the
723 reference line, plus an offset given by the variable.
725 Once you know the name of the variable, you can either modify it through
726 the usual @key{Ada->Customize} menu, or by typing @key{M-x
727 customize-variable RET} in the Emacs window, and then give the name of
732 indent the current line or the current region.
734 indent lines in the current selected block.
736 indent the current line and prints the name of the variable used for
742 @c -----------------------------------------------------------------------
743 @node Formatting Parameter Lists, Automatic Casing, Automatic Smart Indentation, Top
744 @chapter Formatting Parameter Lists
745 @c -----------------------------------------------------------------------
747 To help you correctly align fields in a subprogram parameter list, Emacs
748 provides one function that will do most of the work for you. This
749 function will align the declarations on the colon (':') separating
750 argument names and argument types, plus align the 'in', 'out' and 'in
751 out' keywords if required.
754 @item C-c C-f ada-format-paramlist
755 Format the parameter list.
758 @c -----------------------------------------------------------------------
759 @node Automatic Casing, Statement Templates, Formatting Parameter Lists, Top
760 @chapter Automatic Casing
761 @c -----------------------------------------------------------------------
763 Casing of identifiers, attributes and keywords is automatically
764 performed while typing when the variable @code{ada-auto-case} is set.
765 Every time you press a word separator, the previous word is
768 You can customize the automatic casing differently for keywords,
769 attributes and identifiers. The relevant variables are the following:
770 @code{ada-case-keyword}, @code{ada-case-attribute} and
771 @code{ada-case-identifier}.
773 All these variables can have one of the following values:
777 The previous word will simply be in all lower cases. For instance
778 @code{My_vARIable} is converted to @code{my_variable}.
781 The previous word will be fully converted to upper cases. For instance
782 @code{My_vARIable} is converted to @code{MY_VARIABLE}.
784 @item ada-capitalize-word
785 All letters, except the first one of the word and every letter after the
786 '_' character are lower cased. Other letters are upper cased. For
787 instance @code{My_vARIable} is converted to @code{My_Variable}.
789 @item ada-loose-case-word
790 No letters is modified in the previous word, except the ones after the
791 '_' character that are upper cased. For instance @code{My_vARIable} is
792 converted to @code{My_VARIable}.
795 These functions, although they will work in most cases, will not be
796 accurate sometimes. The Ada mode allows you to define some exceptions,
797 that will always be cased the same way.
799 The idea is to create a dictionary of exceptions, and store it in a
800 file. This file should contain one identifier per line, with the casing
801 you want to force. The default name for this file is
802 @file{~/.emacs_case_exceptions}. You can of course change this name,
803 through the variable @code{ada-case-exception-file}.
805 Note that each line in this file must start with the key word whose
806 casing you want to specify. The rest of the line can be used for
807 comments (explaining for instance what an abbreviation means, as
808 recommended in the Ada 95 Quality and Style, paragrpah 3.1.4). Thus, a
809 good example for this file could be:
812 DOD Department of Defense
814 GNAT The GNAT compiler from Ada Core Technologies
817 When working on project involving multiple programmers, we recommend
818 that every member of the team sets this variable to the same value,
819 which should point to a system-wide file that each of them can
820 write. That way, you will ensure that the casing is consistent
821 throughout your application(s).
823 There are two ways to add new items to this file: you can simply edit it
824 as you would edit any text file, and add or suppress entries in this
825 file. Remember that you should put one entity per line. The other,
826 easier way, is to position the cursor over the word you want to add, in
827 an Ada buffer. This word should have the casing you want. Then simply
828 select the menu @kbd{Ada->Edit->Create Case Exception}, or the key
829 @kbd{C-c C-y}. The word will automatically be added to the current list
830 of exceptions and to the file.
832 It is sometimes useful to have multiple exception files around (for
833 instance, one could be the standard Ada acronyms, the second some
834 company specific exceptions, and the last one some project specific
835 exceptions). If you set up the variable @code{ada-case-exception-file}
836 as a list of files, each of them will be parsed and used in your emacs
839 However, when you save a new exception through the menu, as described
840 above, the new exception will be added to the first file in the list
841 only. You can not automatically add an exception to one of the other
842 files, although you can of course edit the files by hand at any time.
844 Automatic casing can be performed on port or whole buffer using:
847 Adjust case in the whole buffer.
849 Create a new entry in the exception dictionary, with the word under
852 Rereads the exception dictionary from the file
853 @code{ada-case-exception-file}.
856 @c -----------------------------------------------------------------------
857 @node Statement Templates, Comment Handling, Automatic Casing, Top
858 @chapter Statement Templates
859 @c -----------------------------------------------------------------------
861 NOTE: This features are not available on VMS for Emacs 19.28. The
862 functions used here do not exist on Emacs 19.28.
864 Templates exist for most Ada statements. They can be inserted in the
865 buffer using the following commands:
922 @c -----------------------------------------------------------------------
923 @node Comment Handling, Compiling Executing, Statement Templates, Top
924 @chapter Comment Handling
925 @c -----------------------------------------------------------------------
927 By default, comment lines get indented like Ada code. There are a few
928 additional functions to handle comments:
933 Start a comment in default column.
935 Continue comment on next line.
936 @item C-c ; comment-region
937 Comment the selected region (add -- at the beginning of lines).
939 Uncomment the selected region
941 autofill the current comment.
944 @c -----------------------------------------------------------------------
945 @node Compiling Executing, Debugging, Comment Handling, Top
946 @chapter Compiling Executing
947 @c -----------------------------------------------------------------------
949 Ada mode provides a much complete environment for compiling, debugging
950 and running an application within Emacs.
952 All the commands used by Emacs to manipulate your application can be
953 customized in the project file. Some default values are provided, but
954 these will likely not be good enough for a big or even medium-sized
955 project. See the section on the project file for an explanation on how
956 to set up the commands to use.
958 One of the variables you can set in your project file,
959 @code{cross_prefix}, indicates whether you are using a cross-compilation
960 environment, and if yes for which target. The default command used for
961 compilation will add this @code{cross_prefix} in front of the name:
962 @code{gcc} will become @code{cross_prefix}-@code{gcc}, @code{gnatmake}
963 will become @code{cross_prefix}-@code{gnatmake}, ...
965 This will also modify the way your application is run and debugged,
966 although this is not implemented at the moment.
968 Here are the commands for building and using an Ada application
972 @item Compiling the current source
973 This command is issued when issuing the @code{compile} command from the
974 Ada menu. It compiles unconditionally the current source using the
975 @code{comp_cmd} variable of the project file. Compilation options can be
976 customized with the variable @code{comp_opt} of the project file.
978 Emacs will display a new buffer that contains the result of the
979 compilation. Each line associated with an error will become active: you
980 can simply click on it with the middle button of the mouse, or move the
981 cursor on it and press @kbd{Return}. Emacs will then display the
982 relevant source file and put the cursor on the line and column the error
985 You can also simply press the @kbd{C-x `} key and Emacs will jump to the
986 first error. If you press that key again, it will move you to the second
989 Some error messages might also include references to some files. These
990 references are also clickable in the same way.
993 @item (Re)building the whole application
994 This command is issued when you select the @code{build} command from the
995 Ada menu. It compiles all obsolete units of the current application
996 using the @code{make_cmd} variable of the project file. Compilation
997 options can be customized with the variable @code{comp_opt} of the
998 project file, binder options with @code{bind_opt} and linker options
999 with @code{link_opt}. The main unit of the application may be specified
1002 The compilation buffer is also active in the same way it was for the above
1005 @item Running the application
1006 This command is issued when you select the @code{run} command from the
1007 Ada menu. It executes the current application in an emacs
1008 buffer. Arguments can be passed through before executing. The execution
1009 buffer allows for interactive input/output.
1011 This command is not yet available in a cross-compilation
1012 toolchain. Emacs would first need to log on the target before running
1013 the application. This will be implemented in a future release of Gnat.
1017 @c ---------------------------------------------------------------------
1018 @node Debugging, Using non-standard file names, Compiling Executing, Top
1019 @chapter Debugging your application
1020 @c ---------------------------------------------------------------------
1022 You can set up in the project file a command to use to debug your
1023 application. Emacs is compatible with a lot of debuggers, and provide an
1024 easy interface to them.
1026 This selection will focus on the gdb debugger, and two of the graphical
1027 interfaces that exist for it.
1029 In all cases, the main window in Emacs will be split in two: in the
1030 upper buffer, the source code will appear, whereas the debugger
1031 input/output window is displayed at the bottom. You can enter the
1032 debugger commands as usual in the command window. Every time a new
1033 source file is selected by the debugger (for instance as a result of a
1034 @code{frame} command), the appropriate source file is displayed in the
1037 The source window is interactive: you can click on an identifier with the
1038 right mouse button, and print its value in the debugger window. You can
1039 also set a breakpoint simply by right-clicking on a line.
1041 You can easily use Emacs as the source window when you are using a
1042 graphical interface for the debugger. The interesting thing is that,
1043 whereas you still have the graphical nifties, you can also you the
1044 cross-references features that the ada-mode provides to look at the
1045 definition for the identifiers,...
1047 Here is how you can set up gdbtk and ddd for use with Emacs (These are
1048 the commands you should setup in the project file):
1052 should be used with the switch --emacs_gdbtk. It provides a nice
1053 backtrace window, as well as a tasks window. You can click interactively
1054 on both of them, and Emacs will display the source file on the correct
1057 @item ddd (Data Display Debugger)
1058 should be used with the switches --tty and -fullname. Whenever you
1059 print a variable from Emacs, it will be displayed graphically in the
1065 @c ---------------------------------------------------------------------
1066 @node Using non-standard file names, Working Remotely, Debugging, Top
1067 @chapter Using non-standard file names
1068 @c ---------------------------------------------------------------------
1070 By default, Emacs is configured to use the GNAT style file names, where
1071 file names are the package names, and the extension for spec and bodies
1072 are respectively .ads and .adb.
1074 If you want to use other types of file names, you will need to modify
1075 your .emacs configuration file.
1077 Adding new possible extensions is easy. Since the ada-mode needs to know
1078 how to go from the body to the spec (and back), you always have to
1079 specify both. A function is provided with the ada-mode to add new
1082 For instance, if your files are called <unit>_s.ada and <unit>_b.ada
1083 respectively for spec and bodies, you need to add the following to your
1087 (ada-add-extensions "_s.ada" "_b.ada")
1090 Note that it is possible to redefine the extension, even if they already
1094 (ada-add-extensions ".ads" "_b.ada")
1095 (ada-add-extensions ".ads" ".body")
1098 This simply means that whenever the ada-mode will look for the body for
1099 a file whose extension is @file{.ads}, it will take the first available
1100 file that ends with either @file{.adb} (standard), @file{_b.ada} or
1103 If the filename is not the unit name, then things are a little more
1104 complicated. You then need to rewrite the function
1105 ada-make-filename-from-adaname (see the file @file{ada-mode.el} for an
1108 @c ---------------------------------------------------------------------
1109 @node Working Remotely, ,Using non-standard file names, Top
1110 @chapter Working Remotely
1111 @c ---------------------------------------------------------------------
1113 When you work on project that involve a lot of programmers, it is
1114 generally the case that you will edit the files on your own machine, but
1115 you want to compile, run and debug your application in another buffer.
1117 Fortunately, here too Emacs provides a very convenient way to do this.
1119 @c ---------------------------------------------------------------------
1120 @section Remote editing
1121 @c ---------------------------------------------------------------------
1123 First of all, the files do not need to be on your machine. Emacs can
1124 edit any remote file, by doing transparent FTP sessions between your
1125 machine and the remote machine that stores your files. This is a special
1126 Emacs mode, called @code{ange-ftp}. To use it, you just have to use a
1127 slightly different syntax when you open a file.
1130 For instance, if you want to open the file /work/foo.adb on the machine
1131 aleph.gnu.org, where you log in as qwe, you would simply do this:
1133 @key{C-x C-f} /qwe@@aleph.gnu.org:/work/foo.adb @key{Return}
1135 i.e put your name, the name of the machine and the name of the file.
1138 The first time, Emacs will ask you for a password that it will remember
1139 until you close the current Emacs. Even if the ftp session times out,
1140 you won't need to reenter your password.
1142 Every time you save the file, Emacs will upload it to the remote machine
1143 transparently. No file is modified on the local machine.
1145 @c ---------------------------------------------------------------------
1146 @section Remote compiling
1147 @c ---------------------------------------------------------------------
1149 If the machine you want to compile on is not the one your Emacs is
1150 running on, you can set the variable @code{remote_machine} in the
1151 project file for your application.
1153 This will force Emacs to issue a rsh command for the compilation,
1154 instead of running it on the local machine. Unfortunately, this won't
1155 work on Windows workstations, since this protocol is not supported.
1158 If your @code{remote_machine} is aleph.gnu.org and the standard
1159 compilation command is @code{cd /work/ && gnatmake foo}, then Emacs will
1160 actually issue the command @code{rsh aleph.gnu.org 'cd /work/ &&
1164 The advantage of using the @code{remote_machine} variable is that it is
1165 easier to change that machine without having to modify the compilation
1168 Note that if you need to set up some environment variables before the
1169 compilation, you need to insert a call to the appropriate initialization
1170 script in the compilation command, for instance:
1173 build_cmd= initialization_script ; cd /work/ && gnatmake foo
1176 @c ---------------------------------------------------------------------
1177 @section Remote running and debugging
1178 @c ---------------------------------------------------------------------
1180 This feature is not completely implemented yet.
1182 However, most of the time, you will be able to run your application
1183 remotely simply by replacing it with a 'rsh' call on Unix.
1186 For instance, if your command was '$@{main@}', you could replace it with
1187 'rsh aleph.gnu.org $@{main@}'.
1190 However, this would not fully work for instance on vxworks, where rsh