annotate man/ada-mode.texi @ 52097:bcffc07ec8d2

*** empty log message ***
author John Paul Wallington <jpw@pobox.com>
date Fri, 01 Aug 2003 00:32:34 +0000
parents 23a1cea22d13
children 695cf19ef79e d7ddb3e565de
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
25913
2552233fdd74 Set file name to ../info/ada-mode
Gerd Moellmann <gerd@gnu.org>
parents: 25906
diff changeset
2 @setfilename ../info/ada-mode
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
3 @settitle Ada Mode
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
4
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
5 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
6 @comment The following lines inserts the copyright notice
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
7 @comment into the Info file.
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
8 @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
9
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
10 @copying
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
11 Copyright @copyright{} 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
12
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
13 @quotation
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
14 Permission is granted to copy, distribute and/or modify this document
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
15 under the terms of the GNU Free Documentation License, Version 1.1 or
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
16 any later version published by the Free Software Foundation; with the
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
17 Invariant Sections being ``The GNU Manifesto'', ``Distribution'' and
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
18 ``GNU GENERAL PUBLIC LICENSE'', with the Front-Cover texts being ``A GNU
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
19 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
20 license is included in the section entitled ``GNU Free Documentation
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
21 License'' in the Emacs manual.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
22
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
23 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
24 this GNU Manual, like GNU software. Copies published by the Free
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
25 Software Foundation raise funds for GNU development.''
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
26
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
27 This document is part of a collection distributed under the GNU Free
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
28 Documentation License. If you want to distribute this document
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
29 separately from the collection, you can do so by adding a copy of the
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
30 license to the document, as described in section 6 of the license.
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
31 @end quotation
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
32 @end copying
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
33
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
34 @dircategory Emacs
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
35 @direntry
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
36 * Ada mode: (ada-mode). Emacs mode for editing Ada code.
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
37 @end direntry
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
38
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
39 @titlepage
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
40 @sp 10
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
41 @title{Ada Mode}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
42 @sp 2
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
43 @subtitle An Emacs major mode for programming Ada 95 with GNAT
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
44 @subtitle July 1998 for Ada Mode Version 3.0
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
45 @sp 2
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
46 @page
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
47 @vskip 0pt plus 1filll
47737
0a70200bde27 use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents: 46918
diff changeset
48 @insertcopying
37403
aa94142b7f02 Add copyright notices.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
49 @end titlepage
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
50
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
51
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
52 @node Top, Overview, (dir), (dir)
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
53
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
54 @menu
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
55 * Overview::
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
56 * Installation:: Installing Ada mode on your system
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
57 * Customization:: Setting up Ada mode to your taste
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
58 * Project files:: Describing the organization of your project
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
59 * Syntax highlighting:: Using specific colors and fonts to highlight
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
60 the structure of your files
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
61 * Moving Through Ada Code:: Moving easily through Ada sources
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
62 * Identifier completion:: Finishing words automatically
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
63 * Index Menu of Subprograms:: A menu of all the types and subprograms
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
64 defined in your application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
65 * File Browser:: Easy access to your files
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
66 * Automatic Smart Indentation:: Indenting your code automatically as you type
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 43961
diff changeset
67 * Formatting Parameter Lists:: Formatting subprograms' parameter lists
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
68 automatically
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
69 * Automatic Casing:: Adjusting the case of words automatically
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
70 * Statement Templates:: Inserting code templates
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
71 * Comment Handling:: Reformatting comments easily
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
72 * Compiling Executing:: Working with your application within Emacs
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
73 * Debugging:: Debugging your application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
74 * Using non-standard file names:: Configuring Emacs for special file names
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
75 * Working Remotely:: Working on a different machine
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
76 * Index::
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
77 @end menu
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
78
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
79
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
80 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
81 @node Overview, Installation, Top, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
82 @chapter Overview
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
83 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
84
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
85 The Emacs mode for programming in Ada 95 with GNAT helps the user in
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
86 understanding existing code and facilitates writing new code. It
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
87 furthermore provides some utility functions for easier integration of
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
88 standard Emacs features when programming in Ada.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
89
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
90 @section General features:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
91
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
92 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
93 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
94 full Integrated Development Environment:
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
95 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
96 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
97 support of ``project files'' for the configuration (directories,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
98 compilation options,...)
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
99 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
100 compiling and stepping through error messages.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
101 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
102 running and debugging your applications within Emacs.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
103 @end itemize
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
104 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
105 easy to use for beginners by pull-down menus,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
106 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
107 user configurable by many user-option variables.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
108 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
109
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
110 @section Ada mode features that help understanding code:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
111
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
112 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
113 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
114 functions for easy and quick stepping through Ada code,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
115 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
116 getting cross reference information for identifiers (e.g. find the
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
117 defining place by a keystroke),
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
118 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
119 displaying an index menu of types and subprograms and move point to
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
120 the chosen one,
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
121 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
122 automatic color highlighting of the various entities in Ada code.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
123 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
124
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
125 @section Emacs support for writing Ada code:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
126
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
127 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
128 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
129 switching between spec and body files with eventually
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
130 auto-generation of body files,
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
131 @item
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 43961
diff changeset
132 automatic formatting of subprograms' parameter lists.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
133 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
134 automatic smart indentation according to Ada syntax,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
135 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
136 automatic completion of identifiers,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
137 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
138 automatic casing of identifiers, keywords, and attributes,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
139 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
140 insertion of statement templates,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
141 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
142 filling comment paragraphs like filling normal text,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
143 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
144
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
145 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
146 @node Installation, Customization, Overview, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
147 @chapter Installation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
148 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
149
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
150 If you got Ada mode as a separate distribution, you should have a
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
151 look at the @file{README} file. It explains the basic steps necessary
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
152 for a good installation of the emacs Ada mode.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
153
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
154 Installing the Ada mode is basically just a matter of copying a few
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
155 files into the Emacs library directories. Every time you open a file
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
156 with a file extension of @file{.ads} or @file{.adb}, Emacs will
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
157 automatically load and activate Ada mode.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
158
42326
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
159 @xref{Using non-standard file names}, if your files do
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
160 not use these extensions and if you want Emacs to automatically start the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
161 Ada mode every time you edit an Ada file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
162
42326
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
163 Also, for general usage variables that you might want to set,
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47737
diff changeset
164 see
42326
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
165 @iftex
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
166 @cite{The GNU Emacs Manual}.
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
167 @end iftex
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
168 @ifhtml
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
169 @cite{The GNU Emacs Manual}.
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
170 @end ifhtml
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
171 @ifinfo
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
172 @ref{Top, , The GNU Emacs Manual, emacs, The GNU Emacs Manual}.
939fbbfd59d8 Fix typo in cross-reference for `Using non-standard file names'
Robert J. Chassell <bob@rattlesnake.com>
parents: 40705
diff changeset
173 @end ifinfo
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
174
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
175 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
176 @section Required files
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
177 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
178
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
179 This Ada mode works best with Emacs 20.3 or higher (the easy editing
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
180 features for the project files won't work with any older version), but
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
181 most of the commands should work with older versions too. Please try to
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
182 install the most recent version of Emacs on your system before
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
183 installing Ada mode.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
184
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
185 Although part of Ada mode is compiler-independent, the most advanced
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
186 features are specific to the Gnat compiler @url{http://www.gnat.com}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
187
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
188 The following files are provided with the Ada mode distribution:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
189
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
190 @itemize @bullet
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
191
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
192 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
193 @file{ada-mode.el}: The main file for Ada mode.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
194 This is the only file which does not require Gnat. It contains the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
195 functions for indentation, formatting of parameter lists, stepping
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
196 through code, comment handling and automatic casing. Emacs versions
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
197 20.2 and higher already contain Ada mode version 2.27, which is an older
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
198 version of this file and should be replaced. Loading @file{ada-mode.el}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
199 from the current distribution supersedes the standard installation.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
200
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
201 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
202 @file{ada-stmt.el}: Contains the statement templates feature.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
203
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
204 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
205 @file{ada-xref.el}: This file provides the main support for Gnat.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
206 This is where the functions for cross-references, completion of
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
207 identifiers, support for project files and compilation of your
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
208 application are defined.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
209
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
210 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
211 @file{ada-prj.el}: The functions to use for easy-edition of the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
212 project files. This file is the only one which really requires Emacs
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
213 at least 20.2. It uses the new widget features from Emacs.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
214
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
215 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
216
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
217 @c --------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
218 @node Customization, Project files, Installation, Top
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
219 @chapter Customizing Ada mode
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
220 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
221
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
222 Ada mode is fully customizable. Everything, from the file names to
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
223 the automatic indentation and the automatic casing can be adapted to
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
224 your own needs.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
225
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
226 There are two different kinds of variables that control this
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
227 customization, both are easy to modify.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
228
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
229 The first set of variables are standard Emacs variables. Of course, some
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
230 are defined only for Ada mode, whereas others have a more general
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
231 meaning in Emacs. Please see the Emacs documentation for more
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
232 information on the latest. In this documentation, we will detail all the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
233 variables that are specific to Ada mode, and a few others. The names
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
234 will be given, as in @code{ada-case-identifier}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
235
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
236 Emacs provides an easy way to modify them, through a special mode called
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
237 customization. To access this mode, select the menu
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
238 @samp{Ada->Customize}. This will open a new buffer with some fields that
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
239 you can edit. For instance, you will get something like:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
240 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
241 Put below the compiler switches.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
242 comp_opt= _____________________________________
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
243 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
244 The first line gives a brief description of the variable. The second
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
245 line is the name of the variable and the field where you can give a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
246 value for this variable. Simply type what you want in the field.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
247
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
248 When you are finished modifying the variables, you can simply click on
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
249 the @b{Save for future sessions} button at the top of the buffer (click
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
250 with the middle mouse button). This will save the values in your
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
251 @file{.emacs} file, so that next time you start Emacs they will have the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
252 same values.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
253
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
254 To modify a specific variable, you can directly call the function
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
255 @code{customize-variable} from Emacs (just type @kbd{M-x
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
256 customize-variable @key{RET} @var{variable-name} @key{RET}}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
257
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
258 Some users might prefer to modify the variables directly in their
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
259 configuration file, @file{.emacs}. This file is coded in Emacs lisp, and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
260 the syntax to set a variable is the following:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
261 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
262 (setq variable-name value)
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
263 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
264
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
265 The second set of variables for customization are set through the use of
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
266 project files. These variables are specific to a given project, whereas
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
267 the first set was more general. For more information, please
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
268 @xref{Project files}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
269
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
270 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
271 @node Project files, Syntax highlighting, Customization, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
272 @chapter Project files
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
273 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
274
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
275 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
276 @section General overview
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
277 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
278
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
279 Emacs provides a full Integrated Development Environment for GNAT and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
280 Ada programmers. That is to say, editing, compiling, executing and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
281 debugging can be performed within Emacs in a convenient and natural way.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
282
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
283 To take full advantage of this features, it is possible to create a file
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
284 in the main directory of your application, with a @samp{.adp} extension.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
285 This file contain all needed information dealing with the way your
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
286 application is organized between directories, the commands to compile,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
287 run and debug it etc. Creating this file is not mandatory and convenient
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
288 defaults are automatically provided for simple setups. It only becomes
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
289 necessary when those above mentioned defaults need customizing.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
290
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
291 A simple way to edit this file is provided for Emacs 20.2 or newer, with
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
292 the following functions, that you can access also through the Ada
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
293 menu. It is also possible to edit the project file as a regular text
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
294 file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
295
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
296 Once in the buffer for editing the project file, you can save your
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
297 modification using the @samp{[OK]} button at the bottom of the buffer, or
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
298 simply use the usual @kbd{C-x C-s} binding. To cancel your
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
299 modifications, simply kill the buffer or click on the @samp{[CANCEL]} button
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
300 at the button.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
301
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
302 Each buffer using Ada mode will be associated with one project file when
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
303 there is one available, so that Emacs can easily navigate through
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
304 related source files for instance.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
305
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
306 The exact algorithm to determine which project file should be used is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
307 described in the next section, but you can force the project file you
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
308 want to use by setting one or two variables in your @file{.emacs} file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
309
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
310 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
311 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
312 To set up a default project file to use for any directory, anywhere
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
313 on your system, set the variable @code{ada-prj-default-project-file} to
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
314 the name of that file.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
315
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
316 @example
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
317 (set 'ada-prj-default-project-file "/dir1/dir2/file")
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
318 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
319
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
320 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
321 For finer control, you can set a per-directory project file.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
322 This is done through the variable @code{ada-xref-default-prj-file}.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
323
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
324 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
325 (set 'ada-xref-default-prj-file
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
326 '(("/dir1/dir2" . "/dir3/file1")
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
327 ("/dir4/dir5" . "/dir6/file2")))
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
328 @end example
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
329
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
330 Note: This has a higher priority than the first variable, so the first
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
331 choice is to use this variable settings, and otherwise
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
332 @code{ada-prj-default-project-file}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
333 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
334
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
335
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
336 @table @kbd
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
337 @item C-c u
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
338 @findex ada-customize
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
339 Create or edit the project file for the current buffer (@code{ada-customize}).
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 47737
diff changeset
340 @item C-c c
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
341 @findex ada-change-prj
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
342 Change the project file associated with the current Ada buffer (@code{ada-change-prj}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
343 @item C-c d
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
344 @findex ada-change-default-project
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
345 Change the default project file for the current directory
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
346 (@code{ada-change-default-project}). Every new file opened from this
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
347 directory will be associated with that file by default.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
348 @item ada-set-default-project-file
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
349 @findex ada-set-default-project-file
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
350 Set the default project file to use for *any* Ada file opened anywhere
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
351 on your system. This sets this file only for the current Emacs session.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
352 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
353
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
354 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
355 @section Project file variables
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
356 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
357
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
358 The following variables can be defined in a project file. They all have
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
359 a default value, so that small projects do not need to create a project
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
360 file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
361
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
362 Some variables below can be referenced in other variables, using a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
363 shell-like notation. For instance, if the variable @code{comp_cmd}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
364 contains a sequence like @code{$@{comp_opt@}}, the value of that variable
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
365 will be substituted.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
366
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
367 Here is the list of variables:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
368
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
369 @table @asis
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
370 @item @code{src_dir} [default: @code{"./"}]
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
371 This is a list of directories where Ada mode will look for source
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
372 files. These directories are used mainly in two cases, both as a switch
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
373 for the compiler and for the cross-references.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
374
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
375 @item @code{obj_dir} [default: @code{"./"}]
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
376 This is a list of directories where to look for object and library
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
377 files. The library files are the @samp{.ali} files generated by Gnat
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
378 and that contain cross-reference informations.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
379
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
380 @item @code{comp_opt} [default: @code{""}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
381 Creates a variable which can be referred to subsequently by using the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
382 @code{$@{comp_opt@}} notation. This is intended to store the default
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
383 switches given to @command{gnatmake} and @command{gcc}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
384
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
385 @item @code{bind_opt=@var{switches}} [default: @code{""}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
386 Creates a variable which can be referred to subsequently by using the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
387 @code{$@{bind_opt@}} notation. This is intended to store the default
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
388 switches given to @command{gnatbind}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
389
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
390 @item @code{link_opt=@var{switches}} [default: @code{""}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
391 Creates a variable which can be referred to subsequently by using the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
392 @code{$@{link_opt@}} notation. This is intended to store the default
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
393 switches given to @command{gnatlink}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
394
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
395 @item @code{main=@var{executable}} [default: @code{""}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
396 Specifies the name of the executable for the application. This variable
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
397 can be referred to in the following lines by using the @code{$@{main@}}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
398 notation.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
399
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
400 @item @code{cross_prefix=@var{prefix}} [default: @code{""}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
401 This variable should be set if you are working in a cross-compilation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
402 environment. This is the prefix used in front of the gnatmake commands.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
403
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
404 @item @code{remote_machine=@var{machine}} [default: @code{""}]
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
405 This is the name of the machine to log into before issuing the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
406 compilation command. If this variable is empty, the command will be
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
407 run on the local machine. This will not work on Windows NT machines,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
408 since Ada mode will simply precede the compilation command with a
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
409 @command{rsh} command, unknown on Windows.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
410
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
411 @item @code{comp_cmd=@var{command}} [default: @code{"$@{cross_prefix@}gcc -c -I$@{src_dir@} -g -gnatq"}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
412 Specifies the command used to compile a single file in the application.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
413 The name of the file will be added at the end of this command.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
414
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
415 @item @code{make_cmd=@var{command}} [default: @code{"$@{cross_prefix@}gnatmake $@{main@} -aI$@{src_dir@} -aO$@{obj_dir@} -g -gnatq -cargs $@{comp_opt@} -bargs $@{bind_opt@} -largs $@{link_opt@}"]}'
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
416 Specifies the command used to recompile the whole application.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
417
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
418 @item @code{run_cmd=@var{command}} [default: @code{"$@{main@}"}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
419 Specifies the command used to run the application.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
420
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
421 @item @code{debug_cmd=@var{command}} [default: @code{"$@{cross_prefix@}gdb $@{main@}"}]
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
422 Specifies the command used to debug the application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
423
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
424 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
425
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
426 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
427 @section Detailed algorithm
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
428 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
429
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
430 This section gives more details on the project file setup and is only of
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
431 interest for advanced users.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
432
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
433 Usually, an Ada file is part of a larger application, whose sources and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
434 objects can be spread over multiple directories. The first time emacs is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
435 asked to compile, run or debug an application, or when a cross reference
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
436 function is used (goto declaration for instance), the following steps
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
437 are taken:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
438
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
439 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
440 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
441 find the appropriate project file, open and parse it.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
442 All the fields read in the project file are then stored by emacs
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
443 locally. Finding the project file requires a few steps:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
444
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
445 @itemize @minus
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
446 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
447 if a file from the same directory was already associated with
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
448 a project file, use the same one. This is the variable
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
449 @code{ada-xref-default-prj-file} described above.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
450 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
451 if the variable @code{ada-prj-default-project-file} is set,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
452 use the project file specified in this variable.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
453 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
454 if there is a project file whose name is the same as the source file
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
455 except for the suffix, use this one.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
456 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
457 if there's only one project file in the source directory, use
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
458 that one.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
459 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
460 if there are more than one project file in the source directory,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
461 ask the user.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
462 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
463 if there are no project files in the source directory use standard
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
464 default values.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
465 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
466
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
467 The first project file that is selected in a given directory becomes the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
468 default project file for this directory and is used implicitly for other
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
469 sources unless specified otherwise by the user.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
470
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
471 @item
38881
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
472 look for the corresponding @samp{.ali} file in the @code{obj_dir} defined
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
473 in the project file. If this file can not be found, emacs proposes to
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
474 compile the source using the @code{comp_cmd} defined in the project file
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
475 in order to create the ali file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
476
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
477 @item
38881
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
478 when cross referencing is requested, the @samp{.ali} file is parsed to
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
479 determine the file and line of the identifier definition. It is
38881
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
480 possible for the @samp{.ali} file to be older than the source file,
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
481 in which case it will be recompiled if the variable
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
482 @code{ada-xref-create-ali} is set, otherwise the reference is searched
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
483 in the obsolete ali file with possible inaccurate results.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
484
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
485 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
486 look for the file containing the declaration using the source
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
487 path @code{src_dir} defined in the project file. Put the cursor at the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
488 correct position and display this new cursor.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
489 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
490
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
491 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
492 @node Syntax highlighting, Moving Through Ada Code, Project files, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
493 @chapter Syntax highlighting
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
494 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
495
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
496 Ada mode is made to help you understand the structure of your source
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
497 files. Some people like having colors or different fonts depending on
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
498 the context: commands should be displayed differently than keywords,
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
499 which should also be different from strings, @dots{}
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
500
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
501 Emacs is able to display in a different way the following syntactic
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
502 entities:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
503
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
504 @itemize @bullet
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
505 @item keywords
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
506 @item commands
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
507 @item strings
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
508 @item gnatprep statements (preprocessor)
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
509 @item types (under certain conditions)
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
510 @item other words
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
511 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
512
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
513 This is not the default behavior for Emacs. You have to explicitly
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
514 activate it. This requires that you add a new line in your @file{.emacs}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
515 file (if this file does not exist, just create it).
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
516
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
517 @example
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
518 (global-font-lock-mode t)
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
519 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
520
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
521 But the default colors might not be the ones you like. Fortunately,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
522 there is a very easy way to change them. Just select the menu
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
523 @samp{Help->Customize->Specific Face...} and press @key{RET}. This
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
524 will display a buffer will all the ``faces'' (the colors) that Emacs knows
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
525 about. You can change any of them.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
526
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
527
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
528 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
529 @node Moving Through Ada Code, Identifier completion, Syntax highlighting, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
530 @chapter Moving Through Ada Code
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
531 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
532
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
533 There are several easy to use commands to stroll through Ada code. All
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
534 these functions are available through the Ada menu, and you can also use
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
535 the following key bindings or the command names:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
536
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
537 @table @kbd
40705
421e0a91a1d1 Replace M-C- with C-M-
Eli Zaretskii <eliz@gnu.org>
parents: 39367
diff changeset
538 @item C-M-e
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
539 @findex ada-next-procedure
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
540 Move to the next function/procedure/task, which ever comes next
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
541 (@code{ada-next-procedure}).
40705
421e0a91a1d1 Replace M-C- with C-M-
Eli Zaretskii <eliz@gnu.org>
parents: 39367
diff changeset
542 @item C-M-a
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
543 @findex ada-previous-procedure
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
544 Move to previous function/procedure/task
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
545 (@code{ada-previous-procedure}).
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
546 @item M-x ada-next-package
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
547 @findex ada-next-package
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
548 Move to next package.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
549 @item M-x ada-prev-package
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
550 @findex ada-prev-package
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
551 Move to previous package.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
552 @item C-c C-a
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
553 @findex ada-move-to-start
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
554 Move to matching start of @code{end} (@code{ada-move-to-start}). If
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
555 point is at the end of a subprogram, this command jumps to the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
556 corresponding @code{begin} if the user option
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
557 @code{ada-move-to-declaration} is @code{nil} (default), it jumps to
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
558 the subprogram declaration otherwise.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
559 @item C-c C-e
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
560 @findex ada-move-to-end
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
561 Move point to end of current block (@code{ada-move-to-end}).
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
562 @item C-c o
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
563 Switch between corresponding spec and body file
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
564 (@code{ff-find-other-file}). If the cursor is on a subprogram, switch
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
565 between declaration and body.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
566 @item C-c c-d
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
567 @findex ada-goto-declaration
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
568 Move from any reference to its declaration and switch between
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
569 declaration and body (for procedures, tasks, private and incomplete
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
570 types).
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
571 @item C-c C-r
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
572 @findex ada-find-references
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
573 runs the @file{gnatfind} command to search for all references to the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
574 entity pointed by the cursor (@code{ada-find-references}). Use
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
575 @kbd{C-x `} (@code{next-error}) to visit each reference (as for
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
576 compilation errors).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
577 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
578
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
579 These functions use the information in the output of the Gnat Ada
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
580 compiler. However, if your application was compiled with the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
581 @samp{-gnatx} switch, these functions will not work, since no extra
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
582 information is generated by GNAT. See GNAT documentation for further
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
583 information.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
584
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
585 Emacs will try to run Gnat for you whenever the cross-reference
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
586 informations are older than your source file (provided the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
587 @code{ada-xref-create-ali} variable is non-@code{nil}). Gnat then produces a
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
588 file with the same name as the current Ada file but with the extension
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
589 changed to @file{.ali}. This files are normally used by the binder, but
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
590 they will also contain additional cross-referencing information.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
591
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
592 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
593 @node Identifier completion, Index Menu of Subprograms, Moving Through Ada Code, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
594 @chapter Identifier completion
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
595 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
596
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
597 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
598 @section Overview
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
599 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
600
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
601 Emacs and Ada mode provide two general ways for the completion of
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
602 identifiers. This is an easy way to type faster: you just have to type
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
603 the first few letters of an identifiers, and then loop through all the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
604 possible completions.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
605
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
606 The first method is general for Emacs. It will work both with Ada
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
607 buffers, but also in C buffers, Java buffers, @enddots{} The idea is to parse
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
608 all the opened buffers for possible completions.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
609
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
610 For instance, if the words @samp{my_identifier}, @samp{my_subprogram}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
611 are the only words starting with @samp{my} in any of the opened files,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
612 then you will have this scenario:
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
613
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
614 @quotation
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
615 You type: my@key{M-/}
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
616 Emacs inserts: @samp{my_identifier}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
617 If you press @key{M-/} once again, Emacs replaces @samp{my_identifier} with
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
618 @samp{my_subprogram}.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
619 Pressing @key{M-/} once more will bring you back to @samp{my_identifier}.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
620 @end quotation
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
621
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
622 This is a very fast way to do completion, and the casing of words will
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
623 also be respected.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
624
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
625 The second method is specific to Ada buffer, and even to users of the
38881
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
626 Gnat compiler. Emacs will search the cross-information found in the
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
627 @samp{.ali} files generated by Gnat for possible completions.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
628
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
629 The main advantage is that this completion is more accurate: only
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
630 existing identifier will be suggested, you don't need to have a file
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
631 opened that already contains this identifiers, @enddots{}
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
632
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
633 On the other hand, this completion is a little bit slower and requires
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
634 that you have compiled your file at least once since you created that
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
635 identifier.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
636
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
637 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
638 @section Summary of commands
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
639 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
640
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
641 @table @kbd
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
642 @item C-@key{TAB}
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
643 @findex ada-complete-identifier
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
644 Complete accurately current identifier using information in @samp{.ali} file
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
645 (@code{ada-complete-identifier}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
646 @item M-/
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
647 Complete identifier using buffer information (not Ada-specific).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
648 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
649
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
650 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
651 @node Index Menu of Subprograms, File Browser, Identifier completion, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
652 @chapter Index Menu of Subprograms
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
653 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
654
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
655 You can display a choice menu with all procedure/function/task
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
656 declarations in the file and choose an item by mouse click to get to its
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
657 declaration. This function is accessible through the @samp{Ada} menu when
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
658 editing a Ada file, or simply through the following key binding:
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
659
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
660 @table @kbd
36509
45500c80145f Fix case convention for mouse click.
Richard M. Stallman <rms@gnu.org>
parents: 30009
diff changeset
661 @item C-S-Mouse-3
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
662 display index menu
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
663 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
664
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
665 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
666 @node File Browser, Automatic Smart Indentation, Index Menu of Subprograms, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
667 @chapter File Browser
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
668 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
669
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
670 Emacs provides a special mode, called @code{speedbar}. When this mode is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
671 activated, a new frame is displayed, with a file browser. The files from
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
672 the current directory are displayed, and you can click on them as you
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
673 would with any file browser. The following commands are then available.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
674
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
675 You can click on a directory name or file name to open it. The editor
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
676 will automatically select the best possible mode for this file,
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
677 including of course Ada mode for files written in Ada.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
678
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
679 If you click on the @samp{[+]} symbol near a file name, all the symbols (types,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
680 variables and subprograms) defined in that file will be displayed, and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
681 you can directly click on them to open the right file at the right
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
682 place.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
683
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
684 You can activate this mode by typing @key{M-x speedbar} in the editor.
46918
82d113655734 Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents: 43961
diff changeset
685 This will open a new frame. A better way might be to associate the
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
686 following key binding
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
687
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
688 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
689 (global-set-key [f7] 'speedbar-get-focus)
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
690 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
691
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
692 Every time you press @key{F7}, the mouse will automatically move to the
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
693 speedbar frame (which will be created if it does not exist).
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
694
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
695 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
696 @node Automatic Smart Indentation, Formatting Parameter Lists, File Browser, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
697 @chapter Automatic Smart Indentation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
698 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
699
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
700 Ada mode comes with a full set of rules for automatic indentation.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
701 You can of course configure the indentation as you want, by setting the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
702 value of a few variables.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
703
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
704 As always, the preferred way to modify variables is to use the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
705 @samp{Ada->Customize} menu (don't forget to save your changes!). This
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
706 will also show you some example of code where this variable is used, and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
707 hopefully make things clearer.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
708
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
709 The relevant variables are the following:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
710
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
711 @table @asis
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
712 @item @code{ada-broken-indent} (default value: 2)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
713 Number of columns to indent the continuation of a broken line.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
714
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
715 @item @code{ada-indent} (default value: 3)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
716 Width of the default indentation.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
717
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
718 @item @code{ada-indent-record-rel-type} (default value: 3)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
719 Indentation for @code{record} relative to @code{type} or @code{use}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
720
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
721 @item @code{ada-indent-return} (default value: 0)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
722 Indentation for @code{return} relative to @code{function} (if
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
723 @code{ada-indent-return} is greater than 0), or the open parenthesis
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
724 (if @code{ada-indent-return} is negative or null). Note that in the second
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
725 case, when there is no open parenthesis, the indentation is done
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
726 relative to @code{function} with the value of @code{ada-broken-indent}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
727
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
728 @item @code{ada-label-indent} (default value: -4)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
729 Number of columns to indent a label.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
730
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
731 @item @code{ada-stmt-end-indent} (default value: 0)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
732 Number of columns to indent a statement @code{end} keyword on a separate line.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
733
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
734 @item @code{ada-when-indent} (default value: 3)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
735 Indentation for @code{when} relative to @code{exception} or @code{case}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
736
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
737 @item @code{ada-indent-is-separate} (default value: t)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
738 Non-@code{nil} means indent @code{is separate} or @code{is abstract} if on a single line.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
739
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
740 @item @code{ada-indent-to-open-paren} (default value: t)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
741 Non-@code{nil} means indent according to the innermost open parenthesis.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
742
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
743 @item @code{ada-indent-after-return} (default value: t)
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
744 Non-@code{nil} means that the current line will also be re-indented before
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
745 inserting a newline, when you press @key{RET}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
746 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
747
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
748 Most of the time, the indentation will be automatic, i.e when you will
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
749 press @key{RET}, the cursor will move to the correct column on the
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
750 next line.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
751
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
752 However, you might want or need sometimes to re-indent the current line
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
753 or a set of lines. For this, you can simply go to that line, or select
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
754 the lines, and then press @key{TAB}. This will automatically re-indent
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
755 the lines.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
756
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
757 Another mode of indentation exists that helps you to set up your
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
758 indentation scheme. If you press @kbd{C-c @key{TAB}}, Ada mode will do
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
759 the following:
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
760
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
761 @itemize @bullet
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
762 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
763 Reindent the current line, as @key{TAB} would do.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
764 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
765 Temporarily move the cursor to a reference line, i.e., the line that
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
766 was used to calculate the current indentation.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
767 @item
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
768 Display at the bottom of the window the name of the variable that
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
769 provided the offset for the indentation.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
770 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
771
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
772 The exact indentation of the current line is the same as the one for the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
773 reference line, plus an offset given by the variable.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
774
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
775 Once you know the name of the variable, you can either modify it
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
776 through the usual @samp{Ada->Customize} menu, or by typing @kbd{M-x
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
777 customize-variable @key{RET}} in the Emacs window, and then give the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
778 name of the variable.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
779
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
780 @table @kbd
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
781 @item @key{TAB}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
782 Indent the current line or the current region.
40705
421e0a91a1d1 Replace M-C- with C-M-
Eli Zaretskii <eliz@gnu.org>
parents: 39367
diff changeset
783 @item C-M-\
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
784 Indent lines in the current selected block.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
785 @item C-c @key{TAB}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
786 Indent the current line and prints the name of the variable used for
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
787 indentation.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
788 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
789
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
790
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
791
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
792 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
793 @node Formatting Parameter Lists, Automatic Casing, Automatic Smart Indentation, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
794 @chapter Formatting Parameter Lists
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
795 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
796
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
797 To help you correctly align fields in a subprogram parameter list,
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
798 Emacs provides one function that will do most of the work for you.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
799 This function will align the declarations on the colon (@samp{:})
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
800 separating argument names and argument types, plus align the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
801 @code{in}, @code{out} and @code{in out} keywords if required.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
802
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
803 @table @kbd
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
804 @item C-c C-f
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
805 @findex ada-format-paramlist
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
806 Format the parameter list (@code{ada-format-paramlist}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
807 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
808
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
809 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
810 @node Automatic Casing, Statement Templates, Formatting Parameter Lists, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
811 @chapter Automatic Casing
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
812 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
813
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
814 Casing of identifiers, attributes and keywords is automatically
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
815 performed while typing when the variable @code{ada-auto-case} is set.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
816 Every time you press a word separator, the previous word is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
817 automatically cased.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
818
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
819 You can customize the automatic casing differently for keywords,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
820 attributes and identifiers. The relevant variables are the following:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
821 @code{ada-case-keyword}, @code{ada-case-attribute} and
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
822 @code{ada-case-identifier}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
823
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
824 All these variables can have one of the following values:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
825
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
826 @table @code
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
827 @item downcase-word
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
828 The previous word will simply be in all lower cases. For instance
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
829 @code{My_vARIable} is converted to @code{my_variable}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
830
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
831 @item upcase-word
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
832 The previous word will be fully converted to upper cases. For instance
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
833 @code{My_vARIable} is converted to @code{MY_VARIABLE}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
834
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
835 @item ada-capitalize-word
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
836 All letters, except the first one of the word and every letter after the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
837 @samp{_} character are lower cased. Other letters are upper cased. For
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
838 instance @code{My_vARIable} is converted to @code{My_Variable}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
839
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
840 @item ada-loose-case-word
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
841 No letters is modified in the previous word, except the ones after the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
842 @samp{_} character that are upper cased. For instance @code{My_vARIable} is
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
843 converted to @code{My_VARIable}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
844 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
845
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
846 These functions, although they will work in most cases, will not be
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
847 accurate sometimes. The Ada mode allows you to define some exceptions,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
848 that will always be cased the same way.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
849
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
850 The idea is to create a dictionary of exceptions, and store it in a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
851 file. This file should contain one identifier per line, with the casing
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
852 you want to force. The default name for this file is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
853 @file{~/.emacs_case_exceptions}. You can of course change this name,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
854 through the variable @code{ada-case-exception-file}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
855
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
856 Note that each line in this file must start with the key word whose
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
857 casing you want to specify. The rest of the line can be used for
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
858 comments (explaining for instance what an abbreviation means, as
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
859 recommended in the Ada 95 Quality and Style, paragraph 3.1.4). Thus, a
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
860 good example for this file could be:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
861
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
862 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
863 DOD Department of Defense
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
864 Text_IO
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
865 GNAT The GNAT compiler from Ada Core Technologies
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
866 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
867
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
868 When working on project involving multiple programmers, we recommend
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
869 that every member of the team sets this variable to the same value,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
870 which should point to a system-wide file that each of them can
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
871 write. That way, you will ensure that the casing is consistent
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
872 throughout your application(s).
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
873
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
874 @findex ada-create-case-exception
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
875 There are two ways to add new items to this file: you can simply edit it
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
876 as you would edit any text file, and add or suppress entries in this
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
877 file. Remember that you should put one entity per line. The other,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
878 easier way, is to position the cursor over the word you want to add, in
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
879 an Ada buffer. This word should have the casing you want. Then simply
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
880 select the menu @samp{Ada->Edit->Create Case Exception}, or the key
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
881 @kbd{C-c C-y} (@code{ada-create-case-exception}). The word will
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
882 automatically be added to the current list of exceptions and to the file.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
883
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
884 It is sometimes useful to have multiple exception files around (for
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
885 instance, one could be the standard Ada acronyms, the second some
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
886 company specific exceptions, and the last one some project specific
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
887 exceptions). If you set up the variable @code{ada-case-exception-file}
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
888 as a list of files, each of them will be parsed and used in your emacs
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
889 session.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
890
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
891 However, when you save a new exception through the menu, as described
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
892 above, the new exception will be added to the first file in the list
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
893 only. You can not automatically add an exception to one of the other
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
894 files, although you can of course edit the files by hand at any time.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
895
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
896 Automatic casing can be performed on port or whole buffer using:
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
897
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
898 @table @kbd
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
899 @item C-c C-b
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
900 @findex ada-adjust-case-buffer
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
901 Adjust case in the whole buffer (@code{ada-adjust-case-buffer}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
902 @item C-c C-y
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
903 Create a new entry in the exception dictionary, with the word under
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
904 the cursor (@code{ada-create-case-exception})
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
905 @item C-c C-t
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
906 @findex ada-case-read-exceptions
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
907 Rereads the exception dictionary from the file
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
908 @code{ada-case-exception-file} (@code{ada-case-read-exceptions}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
909 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
910
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
911 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
912 @node Statement Templates, Comment Handling, Automatic Casing, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
913 @chapter Statement Templates
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
914 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
915
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
916 NOTE: This features are not available on VMS for Emacs 19.28. The
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
917 functions used here do not exist on Emacs 19.28.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
918
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
919 Templates exist for most Ada statements. They can be inserted in the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
920 buffer using the following commands:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
921
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
922 @table @kbd
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
923 @item C-c t b
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
924 @findex ada-exception-block
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
925 exception Block (@code{ada-exception-block}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
926 @item C-c t c
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
927 @findex ada-case
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
928 case (@code{ada-case}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
929 @item C-c t d
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
930 @findex ada-declare-block
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
931 declare Block (@code{ada-declare-block}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
932 @item C-c t e
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
933 @findex ada-else
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
934 else (@code{ada-else}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
935 @item C-c t f
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
936 @findex ada-for-loop
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
937 for Loop (@code{ada-for-loop}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
938 @item C-c t h
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
939 @findex ada-header
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
940 Header (@code{ada-header}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
941 @item C-c t i
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
942 @findex ada-if
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
943 if (@code{ada-if}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
944 @item C-c t k
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
945 @findex ada-package-body
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
946 package Body (@code{ada-package-body}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
947 @item C-c t l
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
948 @findex ada-loop
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
949 loop (@code{ada-loop}).
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
950 @item C-c p
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
951 @findex ada-subprogram-body
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
952 subprogram body (@code{ada-subprogram-body}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
953 @item C-c t t
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
954 @findex ada-task-body
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
955 task Body (@code{ada-task-body}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
956 @item C-c t w
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
957 @findex ada-while
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
958 while Loop (@code{ada-while}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
959 @item C-c t u
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
960 @findex ada-use
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
961 use (@code{ada-use}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
962 @item C-c t x
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
963 @findex ada-exit
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
964 exit (@code{ada-exit}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
965 @item C-c t C-a
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
966 @findex ada-array
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
967 array (@code{ada-array}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
968 @item C-c t C-e
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
969 @findex ada-elsif
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
970 elsif (@code{ada-elsif}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
971 @item C-c t C-f
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
972 @findex ada-function-spec
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
973 function Spec (@code{ada-function-spec}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
974 @item C-c t C-k
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
975 @findex ada-package-spec
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
976 package Spec (@code{ada-package-spec}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
977 @item C-c t C-p
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
978 @findex ada-procedure-spec
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
979 procedure Spec (@code{ada-package-spec}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
980 @item C-c t C-r
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
981 @findex ada-record
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
982 record (@code{ada-record}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
983 @item C-c t C-s
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
984 @findex ada-subtype
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
985 subtype (@code{ada-subtype}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
986 @item C-c t C-t
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
987 @findex ada-task-spec
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
988 task Spec (@code{ada-task-spec}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
989 @item C-c t C-u
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
990 @findex ada-with
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
991 with (@code{ada-with}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
992 @item C-c t C-v
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
993 @findex ada-private
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
994 private (@code{ada-private}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
995 @item C-c t C-w
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
996 @findex ada-when
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
997 when (@code{ada-when}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
998 @item C-c t C-x
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
999 @findex ada-exception
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1000 exception (@code{ada-exception}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1001 @item C-c t C-y
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1002 @findex ada-type
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1003 type (@code{ada-type}).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1004 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1005
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1006 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1007 @node Comment Handling, Compiling Executing, Statement Templates, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1008 @chapter Comment Handling
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1009 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1010
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1011 By default, comment lines get indented like Ada code. There are a few
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1012 additional functions to handle comments:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1013
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1014
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1015 @table @kbd
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1016 @item M-;
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1017 Start a comment in default column.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1018 @item M-j
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1019 Continue comment on next line.
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1020 @item C-c ;
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1021 Comment the selected region (add -- at the beginning of lines).
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1022 @item C-c :
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1023 Uncomment the selected region
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1024 @item M-q
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1025 autofill the current comment.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1026 @end table
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1027
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1028 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1029 @node Compiling Executing, Debugging, Comment Handling, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1030 @chapter Compiling Executing
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1031 @c -----------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1032
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1033 Ada mode provides a much complete environment for compiling, debugging
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1034 and running an application within Emacs.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1035
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1036 All the commands used by Emacs to manipulate your application can be
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1037 customized in the project file. Some default values are provided, but
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1038 these will likely not be good enough for a big or even medium-sized
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1039 project. See the section on the project file for an explanation on how
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1040 to set up the commands to use.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1041
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1042 One of the variables you can set in your project file,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1043 @code{cross_prefix}, indicates whether you are using a cross-compilation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1044 environment, and if yes for which target. The default command used for
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1045 compilation will add this @code{cross_prefix} in front of the name:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1046 @code{gcc} will become @code{cross_prefix}-@code{gcc}, @code{gnatmake}
38881
ef5cc490984d Fix a few minor markup errors.
Eli Zaretskii <eliz@gnu.org>
parents: 38864
diff changeset
1047 will become @code{cross_prefix}-@code{gnatmake}, @enddots{}
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1048
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1049 This will also modify the way your application is run and debugged,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1050 although this is not implemented at the moment.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1051
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1052 Here are the commands for building and using an Ada application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1053
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1054 @itemize @bullet
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1055
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1056 @item Compiling the current source
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1057 This command is issued when issuing the @code{compile} command from the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1058 Ada menu. It compiles unconditionally the current source using the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1059 @code{comp_cmd} variable of the project file. Compilation options can be
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1060 customized with the variable @code{comp_opt} of the project file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1061
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1062 Emacs will display a new buffer that contains the result of the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1063 compilation. Each line associated with an error will become active: you
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1064 can simply click on it with the middle button of the mouse, or move the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1065 cursor on it and press @key{RET}. Emacs will then display the
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1066 relevant source file and put the cursor on the line and column the error
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1067 was found at.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1068
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1069 You can also simply press the @kbd{C-x `} key and Emacs will jump to the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1070 first error. If you press that key again, it will move you to the second
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1071 error, and so on.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1072
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1073 Some error messages might also include references to some files. These
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1074 references are also clickable in the same way.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1075
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1076
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1077 @item (Re)building the whole application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1078 This command is issued when you select the @code{build} command from the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1079 Ada menu. It compiles all obsolete units of the current application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1080 using the @code{make_cmd} variable of the project file. Compilation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1081 options can be customized with the variable @code{comp_opt} of the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1082 project file, binder options with @code{bind_opt} and linker options
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1083 with @code{link_opt}. The main unit of the application may be specified
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1084 with @code{main}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1085
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1086 The compilation buffer is also active in the same way it was for the above
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1087 command.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1088
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1089 @item Running the application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1090 This command is issued when you select the @code{run} command from the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1091 Ada menu. It executes the current application in an emacs
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1092 buffer. Arguments can be passed through before executing. The execution
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1093 buffer allows for interactive input/output.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1094
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1095 This command is not yet available in a cross-compilation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1096 toolchain. Emacs would first need to log on the target before running
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1097 the application. This will be implemented in a future release of Gnat.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1098
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1099 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1100
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1101 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1102 @node Debugging, Using non-standard file names, Compiling Executing, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1103 @chapter Debugging your application
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1104 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1105
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1106 You can set up in the project file a command to use to debug your
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1107 application. Emacs is compatible with a lot of debuggers, and provide an
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1108 easy interface to them.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1109
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1110 This selection will focus on the gdb debugger, and two of the graphical
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1111 interfaces that exist for it.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1112
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1113 In all cases, the main window in Emacs will be split in two: in the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1114 upper buffer, the source code will appear, whereas the debugger
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1115 input/output window is displayed at the bottom. You can enter the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1116 debugger commands as usual in the command window. Every time a new
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1117 source file is selected by the debugger (for instance as a result of a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1118 @code{frame} command), the appropriate source file is displayed in the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1119 upper buffer.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1120
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1121 The source window is interactive: you can click on an identifier with the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1122 right mouse button, and print its value in the debugger window. You can
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1123 also set a breakpoint simply by right-clicking on a line.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1124
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1125 You can easily use Emacs as the source window when you are using a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1126 graphical interface for the debugger. The interesting thing is that,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1127 whereas you still have the graphical nifties, you can also you the
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1128 cross-references features that Ada mode provides to look at the
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1129 definition for the identifiers, @enddots{}
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1130
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1131 Here is how you can set up gdbtk and ddd for use with Emacs (These are
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1132 the commands you should setup in the project file):
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1133
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1134 @itemize @bullet
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1135 @item gdbtk
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1136 should be used with the switch @samp{--emacs_gdbtk}. It provides a nice
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1137 backtrace window, as well as a tasks window. You can click interactively
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1138 on both of them, and Emacs will display the source file on the correct
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1139 line.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1140
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1141 @item ddd (Data Display Debugger)
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1142 should be used with the switches @samp{--tty} and
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1143 @samp{--fullname}. Whenever you print a variable from Emacs, it will
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1144 be displayed graphically in the data window.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1145
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1146 @end itemize
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1147
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1148
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1149 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1150 @node Using non-standard file names, Working Remotely, Debugging, Top
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1151 @chapter Using non-standard file names
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1152 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1153
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1154 By default, Emacs is configured to use the GNAT style file names, where
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1155 file names are the package names, and the extension for spec and bodies
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1156 are respectively @samp{.ads} and @samp{.adb}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1157
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1158 If you want to use other types of file names, you will need to modify
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1159 your @file{.emacs} file.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1160
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1161 Adding new possible extensions is easy. Since Ada mode needs to know
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1162 how to go from the body to the spec (and back), you always have to
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1163 specify both. A function is provided with Ada mode to add new
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1164 extensions.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1165
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1166 For instance, if your spec and bodies files are called
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1167 @file{@var{unit}_s.ada} and @file{@var{unit}_b.ada}, respectively, you
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1168 need to add the following to your @file{.emacs} file:
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1169
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1170 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1171 (ada-add-extensions "_s.ada" "_b.ada")
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1172 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1173
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1174 Note that it is possible to redefine the extension, even if they already
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1175 exist, as in:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1176
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1177 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1178 (ada-add-extensions ".ads" "_b.ada")
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1179 (ada-add-extensions ".ads" ".body")
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1180 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1181
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1182 This simply means that whenever the ada-mode will look for the body for
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1183 a file whose extension is @file{.ads}, it will take the first available
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1184 file that ends with either @file{.adb} (standard), @file{_b.ada} or
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1185 @file{.body}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1186
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1187 If the filename is not the unit name, then things are a little more
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1188 complicated. You then need to rewrite the function
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1189 @code{ada-make-filename-from-adaname} (see the file @file{ada-mode.el}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1190 for an example).
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1191
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1192 @c ---------------------------------------------------------------------
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1193 @node Working Remotely, Index, Using non-standard file names, Top
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1194 @chapter Working Remotely
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1195 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1196
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1197 When you work on project that involve a lot of programmers, it is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1198 generally the case that you will edit the files on your own machine, but
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1199 you want to compile, run and debug your application in another buffer.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1200
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1201 Fortunately, here too Emacs provides a very convenient way to do this.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1202
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1203 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1204 @section Remote editing
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1205 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1206
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1207 First of all, the files do not need to be on your machine. Emacs can
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1208 edit any remote file, by doing transparent FTP sessions between your
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1209 machine and the remote machine that stores your files. This is a special
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1210 Emacs mode, called @code{ange-ftp}. To use it, you just have to use a
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1211 slightly different syntax when you open a file.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1212
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1213 For instance, if you want to open the file @file{/work/foo.adb} on the machine
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1214 aleph.gnu.org, where you log in as qwe, you would simply do this:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1215
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1216 @example
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1217 C-x C-f /qwe@@aleph.gnu.org:/work/foo.adb @key{RET}
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1218 @end example
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1219
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1220 @noindent
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1221 i.e., use your name, the name of the machine and the name of the file.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1222
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1223 The first time, Emacs will ask you for a password that it will remember
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1224 until you close the current Emacs. Even if the ftp session times out,
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1225 you won't need to reenter your password.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1226
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1227 Every time you save the file, Emacs will upload it to the remote machine
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1228 transparently. No file is modified on the local machine.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1229
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1230 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1231 @section Remote compiling
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1232 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1233
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1234 If the machine you want to compile on is not the one your Emacs is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1235 running on, you can set the variable @code{remote_machine} in the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1236 project file for your application.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1237
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1238 This will force Emacs to issue a @command{rsh} command for the compilation,
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1239 instead of running it on the local machine. Unfortunately, this won't
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1240 work on Windows workstations, since this protocol is not supported.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1241
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1242 @example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1243 If your @code{remote_machine} is aleph.gnu.org and the standard
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1244 compilation command is @code{cd /work/ && gnatmake foo}, then Emacs will
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1245 actually issue the command @code{rsh aleph.gnu.org 'cd /work/ &&
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1246 gnatmake foo'}.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1247 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1248
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1249 The advantage of using the @code{remote_machine} variable is that it is
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1250 easier to change that machine without having to modify the compilation
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1251 command.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1252
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1253 Note that if you need to set up some environment variables before the
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1254 compilation, you need to insert a call to the appropriate initialization
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1255 script in the compilation command, for instance:
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1256
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1257 @example
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1258 build_cmd= initialization_script; cd /work/ && gnatmake foo
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1259 @end example
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1260
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1261 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1262 @section Remote running and debugging
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1263 @c ---------------------------------------------------------------------
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1264
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1265 This feature is not completely implemented yet.
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1266
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1267 However, most of the time, you will be able to run your application
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1268 remotely simply by replacing it with a @command{rsh} call.
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1269 For instance, if your command was @code{$@{main@}}, you could replace it with
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1270 @code{rsh aleph.gnu.org $@{main@}}.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1271
38864
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1272 However, this would not work on vxworks, for instance, where
c656fc177008 Many corrections in Texinfo usage and English usage.
Richard M. Stallman <rms@gnu.org>
parents: 37403
diff changeset
1273 @command{rsh} is not supported.
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1274
39367
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1275 @node Index, , Working Remotely, Top
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1276 @unnumbered Index
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1277
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1278 @printindex fn
88b1d99e92ad Add an Index and index all commands. This is so C-h C-f works.
Eli Zaretskii <eliz@gnu.org>
parents: 38881
diff changeset
1279
25906
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1280 @contents
3a06267f733d New file.
Gerd Moellmann <gerd@gnu.org>
parents:
diff changeset
1281 @bye