2289 lines
112 KiB
HTML
2289 lines
112 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<!-- Copyright (C) 1999-2019 Free Software Foundation, Inc.
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, with the Front-Cover Texts being "A GNU Manual",
|
|
and with the Back-Cover Texts as in (a) below. A copy of the license
|
|
is included in the section entitled "GNU Free Documentation License".
|
|
|
|
(a) The FSF's Back-Cover Text is: "You have the freedom to copy and
|
|
modify this GNU manual." -->
|
|
<title>Ada Mode</title>
|
|
|
|
<meta name="description" content="Ada Mode">
|
|
<meta name="keywords" content="Ada Mode">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content="texi2any">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<link href="#Top" rel="start" title="Top">
|
|
<link href="#Index" rel="index" title="Index">
|
|
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
|
|
<link href="#Overview" rel="next" title="Overview">
|
|
<style type="text/css">
|
|
<!--
|
|
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
|
|
a.summary-letter {text-decoration: none}
|
|
blockquote.indentedblock {margin-right: 0em}
|
|
div.display {margin-left: 3.2em}
|
|
div.example {margin-left: 3.2em}
|
|
kbd {font-style: oblique}
|
|
pre.display {font-family: inherit}
|
|
pre.format {font-family: inherit}
|
|
pre.menu-comment {font-family: serif}
|
|
pre.menu-preformatted {font-family: serif}
|
|
span.nolinebreak {white-space: nowrap}
|
|
span.roman {font-family: initial; font-weight: normal}
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
span:hover a.copiable-anchor {visibility: visible}
|
|
ul.no-bullet {list-style: none}
|
|
-->
|
|
</style>
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<h1 class="settitle" align="center">Ada Mode</h1>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="top" id="Top">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Overview" accesskey="n" rel="next">Overview</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Ada-Mode"></span><h1 class="top">Ada Mode</h1>
|
|
|
|
<p>Copyright © 1999–2019 Free Software Foundation, Inc.
|
|
</p>
|
|
<blockquote>
|
|
<p>Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, with the Front-Cover Texts being “A GNU Manual”,
|
|
and with the Back-Cover Texts as in (a) below. A copy of the license
|
|
is included in the section entitled “GNU Free Documentation License”.
|
|
</p>
|
|
<p>(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and
|
|
modify this GNU manual.”
|
|
</p></blockquote>
|
|
|
|
|
|
|
|
<div class="Contents_element" id="SEC_Contents">
|
|
<h2 class="contents-heading">Table of Contents</h2>
|
|
|
|
<div class="contents">
|
|
|
|
<ul class="no-bullet">
|
|
<li><a id="toc-Overview-1" href="#Overview">1 Overview</a></li>
|
|
<li><a id="toc-Installation-1" href="#Installation">2 Installation</a></li>
|
|
<li><a id="toc-Customizing-Ada-mode" href="#Customization">3 Customizing Ada mode</a>
|
|
<ul class="no-bullet">
|
|
<li><a id="toc-Non_002dstandard-file-names-1" href="#Non_002dstandard-file-names">3.1 Non-standard file names</a></li>
|
|
<li><a id="toc-Other-compiler-1" href="#Other-compiler">3.2 Other compiler</a></li>
|
|
<li><a id="toc-Other-customization-1" href="#Other-customization">3.3 Other customization</a></li>
|
|
</ul></li>
|
|
<li><a id="toc-Compiling-Executing-1" href="#Compiling-Executing">4 Compiling Executing</a>
|
|
<ul class="no-bullet">
|
|
<li><a id="toc-Compile-commands-1" href="#Compile-commands">4.1 Compile commands</a></li>
|
|
<li><a id="toc-Compiler-errors-1" href="#Compiler-errors">4.2 Compiler errors</a></li>
|
|
</ul></li>
|
|
<li><a id="toc-Project-files-1" href="#Project-files">5 Project files</a>
|
|
<ul class="no-bullet">
|
|
<li><a id="toc-Project-File-Overview-1" href="#Project-File-Overview">5.1 Project File Overview</a></li>
|
|
<li><a id="toc-GUI-Editor-1" href="#GUI-Editor">5.2 GUI Editor</a></li>
|
|
<li><a id="toc-Project-file-variables-1" href="#Project-file-variables">5.3 Project file variables</a></li>
|
|
</ul></li>
|
|
<li><a id="toc-Compiling-Examples-1" href="#Compiling-Examples">6 Compiling Examples</a>
|
|
<ul class="no-bullet">
|
|
<li><a id="toc-No-project-files-1" href="#No-project-files">6.1 No project files</a></li>
|
|
<li><a id="toc-Set-compiler-options-1" href="#Set-compiler-options">6.2 Set compiler options</a></li>
|
|
<li><a id="toc-Set-source-search-path-1" href="#Set-source-search-path">6.3 Set source search path</a></li>
|
|
<li><a id="toc-Use-GNAT-project-file-1" href="#Use-GNAT-project-file">6.4 Use GNAT project file</a></li>
|
|
<li><a id="toc-Use-multiple-GNAT-project-files-1" href="#Use-multiple-GNAT-project-files">6.5 Use multiple GNAT project files</a></li>
|
|
</ul></li>
|
|
<li><a id="toc-Moving-Through-Ada-Code-1" href="#Moving-Through-Ada-Code">7 Moving Through Ada Code</a></li>
|
|
<li><a id="toc-Identifier-completion-1" href="#Identifier-completion">8 Identifier completion</a></li>
|
|
<li><a id="toc-Automatic-Smart-Indentation-1" href="#Automatic-Smart-Indentation">9 Automatic Smart Indentation</a></li>
|
|
<li><a id="toc-Formatting-Parameter-Lists-1" href="#Formatting-Parameter-Lists">10 Formatting Parameter Lists</a></li>
|
|
<li><a id="toc-Automatic-Casing-1" href="#Automatic-Casing">11 Automatic Casing</a></li>
|
|
<li><a id="toc-Statement-Templates-1" href="#Statement-Templates">12 Statement Templates</a></li>
|
|
<li><a id="toc-Comment-Handling-1" href="#Comment-Handling">13 Comment Handling</a></li>
|
|
<li><a id="toc-GNU-Free-Documentation-License-1" href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a></li>
|
|
<li><a id="toc-Index-1" href="#Index" rel="index">Index</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<hr>
|
|
<div class="chapter" id="Overview">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Ada Mode</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Overview-1"></span><h2 class="chapter">1 Overview</h2>
|
|
|
|
<p>The Emacs mode for programming in Ada helps the user in understanding
|
|
existing code and facilitates writing new code.
|
|
</p>
|
|
<p>When the GNU Ada compiler GNAT is used, the cross-reference
|
|
information output by the compiler is used to provide powerful code
|
|
navigation (jump to definition, find all uses, etc.).
|
|
</p>
|
|
<p>When you open a file with a file extension of <samp>.ads</samp> or
|
|
<samp>.adb</samp>, Emacs will automatically load and activate Ada mode.
|
|
</p>
|
|
<p>Ada mode works without any customization, if you are using the GNAT
|
|
compiler (<a href="https://libre2.adacore.com/">https://libre2.adacore.com/</a>) and the GNAT default
|
|
naming convention.
|
|
</p>
|
|
<p>You must customize a few things if you are using a different compiler
|
|
or file naming convention; See <a href="#Other-compiler">Other compiler</a>, See <a href="#Non_002dstandard-file-names">Non-standard file names</a>.
|
|
</p>
|
|
<p>In addition, you may want to customize the indentation,
|
|
capitalization, and other things; See <a href="#Other-customization">Other customization</a>.
|
|
</p>
|
|
<p>Finally, for large Ada projects, you will want to set up an Emacs
|
|
Ada mode project file for each project; See <a href="#Project-files">Project files</a>. Note
|
|
that these are different from the GNAT project files used by gnatmake
|
|
and other GNAT commands.
|
|
</p>
|
|
<p>See the Emacs info manual, section ’Running Debuggers Under Emacs’,
|
|
for general information on debugging.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Installation">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Customization" accesskey="n" rel="next">Customizing Ada mode</a>, Previous: <a href="#Overview" accesskey="p" rel="prev">Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Installation-1"></span><h2 class="chapter">2 Installation</h2>
|
|
|
|
<p>Ada mode is part of the standard Emacs distribution; if you use that,
|
|
no files need to be installed.
|
|
</p>
|
|
<p>Ada mode is also available as a separate distribution, from the Emacs
|
|
Ada mode website
|
|
<a href="http://stephe-leake.org/emacs/ada-mode/emacs-ada-mode.html">http://stephe-leake.org/emacs/ada-mode/emacs-ada-mode.html</a>. The
|
|
separate distribution may be more recent.
|
|
</p>
|
|
<p>For installing the separate distribution, see the <samp>README</samp> file
|
|
in the distribution.
|
|
</p>
|
|
<p>To see what version of Ada mode you have installed, do <kbd>M-x
|
|
ada-mode-version</kbd>.
|
|
</p>
|
|
<p>The following files are provided with the Ada mode distribution:
|
|
</p>
|
|
<ul>
|
|
<li> <samp>ada-mode.el</samp>: The main file for Ada mode, providing indentation,
|
|
formatting of parameter lists, moving through code, comment handling
|
|
and automatic casing.
|
|
|
|
</li><li> <samp>ada-prj.el</samp>: GUI editing of Ada mode project files, using Emacs
|
|
widgets.
|
|
|
|
</li><li> <samp>ada-stmt.el</samp>: Ada statement templates.
|
|
|
|
</li><li> <samp>ada-xref.el</samp>: GNAT cross-references, completion of identifiers,
|
|
and compilation. Also provides project files (which are not
|
|
GNAT-specific).
|
|
|
|
</li></ul>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Customization">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Compiling-Executing" accesskey="n" rel="next">Compiling Executing</a>, Previous: <a href="#Installation" accesskey="p" rel="prev">Installation</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Customizing-Ada-mode"></span><h2 class="chapter">3 Customizing Ada mode</h2>
|
|
|
|
<p>Here we assume you are familiar with setting variables in Emacs,
|
|
either thru ’customize’ or in elisp (in your <samp>.emacs</samp> file). For
|
|
a basic introduction to customize, elisp, and Emacs in general, see
|
|
the tutorial in
|
|
<cite>The GNU Emacs Manual</cite>.
|
|
</p>
|
|
<p>These global Emacs settings are strongly recommended (put them in your
|
|
.emacs):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">(global-font-lock-mode t)
|
|
(transient-mark-mode t)
|
|
</pre></div>
|
|
|
|
<p>‘<samp>(global-font-lock-mode t)</samp>’ turns on syntax
|
|
highlighting for all buffers (it is off by default because it may be
|
|
too slow for some machines).
|
|
</p>
|
|
<p>‘<samp>(transient-mark-mode t)</samp>’ highlights selected text.
|
|
</p>
|
|
<p>See the Emacs help for each of these variables for more information.
|
|
</p>
|
|
|
|
<ul class="section-toc">
|
|
<li><a href="#Non_002dstandard-file-names" accesskey="1">Non-standard file names</a></li>
|
|
<li><a href="#Other-compiler" accesskey="2">Other compiler</a></li>
|
|
<li><a href="#Other-customization" accesskey="3">Other customization</a></li>
|
|
</ul>
|
|
<hr>
|
|
<div class="section" id="Non_002dstandard-file-names">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Other-compiler" accesskey="n" rel="next">Other compiler</a>, Up: <a href="#Customization" accesskey="u" rel="up">Customizing Ada mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Non_002dstandard-file-names-1"></span><h3 class="section">3.1 Non-standard file names</h3>
|
|
|
|
<p>By default, Ada mode is configured to use the GNAT file naming
|
|
convention, where file names are a simple modification of the Ada
|
|
names, and the extension for specs and bodies are
|
|
‘<samp>.ads</samp>’ and ‘<samp>.adb</samp>’, respectively.
|
|
</p>
|
|
<p>Ada mode uses the file extensions to allow moving from a package body
|
|
to the corresponding spec and back.
|
|
</p>
|
|
<p>Ada mode supports a list of alternative file extensions for specs and bodies.
|
|
</p>
|
|
<p>For instance, if your spec and bodies files are called
|
|
<samp><var>unit</var>_s.ada</samp> and <samp><var>unit</var>_b.ada</samp>, respectively, you
|
|
can add the following to your <samp>.emacs</samp> file:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">(ada-add-extensions "_s.ada" "_b.ada")
|
|
</pre></div>
|
|
|
|
<p>You can define additional extensions:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">(ada-add-extensions ".ads" "_b.ada")
|
|
(ada-add-extensions ".ads" ".body")
|
|
</pre></div>
|
|
|
|
<p>This means that whenever Ada mode looks for the body for a file
|
|
whose extension is <samp>.ads</samp>, it will take the first available file
|
|
that ends with either <samp>.adb</samp>, <samp>_b.ada</samp> or
|
|
<samp>.body</samp>.
|
|
</p>
|
|
<p>Similarly, if Ada mode is looking for a spec, it will look for
|
|
<samp>.ads</samp> or <samp>_s.ada</samp>.
|
|
</p>
|
|
<p>If the filename is not derived from the Ada name following the GNAT
|
|
convention, things are a little more complicated. You then need to
|
|
rewrite the function <code>ada-make-filename-from-adaname</code>. Doing that
|
|
is beyond the scope of this manual; see the current definitions in
|
|
<samp>ada-mode.el</samp> and <samp>ada-xref.el</samp> for examples.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Other-compiler">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Other-customization" accesskey="n" rel="next">Other customization</a>, Previous: <a href="#Non_002dstandard-file-names" accesskey="p" rel="prev">Non-standard file names</a>, Up: <a href="#Customization" accesskey="u" rel="up">Customizing Ada mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Other-compiler-1"></span><h3 class="section">3.2 Other compiler</h3>
|
|
|
|
<p>By default, Ada mode is configured to use the GNU Ada compiler GNAT.
|
|
</p>
|
|
<p>To use a different Ada compiler, you must specify the command lines
|
|
used to run that compiler, either in lisp variables or in Emacs
|
|
Ada mode project files. See <a href="#Project-file-variables">Project file variables</a> for the list
|
|
of project variables, and the corresponding lisp variables.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Other-customization">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="#Other-compiler" accesskey="p" rel="prev">Other compiler</a>, Up: <a href="#Customization" accesskey="u" rel="up">Customizing Ada mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Other-customization-1"></span><h3 class="section">3.3 Other customization</h3>
|
|
|
|
<p>All user-settable Ada mode variables can be set via the menu
|
|
‘<samp>Ada | Customize</samp>’. Click on the ‘<samp>Help</samp>’ button there for help
|
|
on using customize.
|
|
</p>
|
|
<p>To modify a specific variable, you can directly call the function
|
|
<code>customize-variable</code>; just type <kbd>M-x customize-variable
|
|
<span class="key">RET</span> <var>variable-name</var> <span class="key">RET</span></kbd>).
|
|
</p>
|
|
<p>Alternately, you can specify variable settings in the Emacs
|
|
configuration file, <samp>.emacs</samp>. This file is coded in Emacs lisp,
|
|
and the syntax to set a variable is the following:
|
|
</p><div class="example">
|
|
<pre class="example">(setq variable-name value)
|
|
</pre></div>
|
|
|
|
<hr>
|
|
</div>
|
|
</div>
|
|
<div class="chapter" id="Compiling-Executing">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Project-files" accesskey="n" rel="next">Project files</a>, Previous: <a href="#Customization" accesskey="p" rel="prev">Customizing Ada mode</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Compiling-Executing-1"></span><h2 class="chapter">4 Compiling Executing</h2>
|
|
|
|
<p>Ada projects can be compiled, linked, and executed using commands on
|
|
the Ada menu. All of these commands can be customized via a project
|
|
file (see <a href="#Project-files">Project files</a>), but the defaults are sufficient for using
|
|
the GNAT compiler for simple projects (single files, or several files
|
|
in a single directory).
|
|
</p>
|
|
<p>Even when no project file is used, the GUI project editor (menu
|
|
‘<samp>Ada | Project | Edit</samp>’) shows the settings of the various project
|
|
file variables referenced here.
|
|
</p>
|
|
|
|
<ul class="section-toc">
|
|
<li><a href="#Compile-commands" accesskey="1">Compile commands</a></li>
|
|
<li><a href="#Compiler-errors" accesskey="2">Compiler errors</a></li>
|
|
</ul>
|
|
<hr>
|
|
<div class="section" id="Compile-commands">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Compiler-errors" accesskey="n" rel="next">Compiler errors</a>, Up: <a href="#Compiling-Executing" accesskey="u" rel="up">Compiling Executing</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Compile-commands-1"></span><h3 class="section">4.1 Compile commands</h3>
|
|
|
|
<p>Here are the commands for building and using an Ada project, as
|
|
listed in the Ada menu.
|
|
</p>
|
|
<p>In multi-file projects, there must be one file that is the main
|
|
program. That is given by the <code>main</code> project file variable;
|
|
it defaults to the current file if not yet set, but is also set by the
|
|
“set main and build” command.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><code>Check file</code></span></dt>
|
|
<dd><p>Compiles the current file in syntax check mode, by running
|
|
<code>check_cmd</code> defined in the current project file. This typically
|
|
runs faster than full compile mode, speeding up finding and fixing
|
|
compilation errors.
|
|
</p>
|
|
<p>This sets <code>main</code> only if it has not been set yet.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>Compile file</code></span></dt>
|
|
<dd><p>Compiles the current file, by running <code>comp_cmd</code> from the current
|
|
project file.
|
|
</p>
|
|
<p>This does not set <code>main</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>Set main and Build</code></span></dt>
|
|
<dd><p>Sets <code>main</code> to the current file, then executes the Build
|
|
command.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>Show main</code></span></dt>
|
|
<dd><p>Display <code>main</code> in the message buffer.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>Build</code></span></dt>
|
|
<dd><p>Compiles all obsolete units of the current <code>main</code>, and links
|
|
<code>main</code>, by running <code>make_cmd</code> from the current project.
|
|
</p>
|
|
<p>This sets <code>main</code> only if it has not been set yet.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>Run</code></span></dt>
|
|
<dd><p>Executes the main program in a shell, displayed in a separate Emacs
|
|
buffer. This runs <code>run_cmd</code> from the current project. The
|
|
execution buffer allows for interactive input/output.
|
|
</p>
|
|
<p>To modify the run command, in particular to provide or change the
|
|
command line arguments, type <kbd>C-u</kbd> before invoking the command.
|
|
</p>
|
|
<p>This command is not available for a cross-compilation toolchain.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
<p>It is important when using these commands to understand how
|
|
<code>main</code> is used and changed.
|
|
</p>
|
|
<p>Build runs ’gnatmake’ on the main unit. During a typical edit/compile
|
|
session, this is the only command you need to invoke, which is why it
|
|
is bound to <kbd>C-c C-c</kbd>. It will compile all files needed by the
|
|
main unit, and display compilation errors in any of them.
|
|
</p>
|
|
<p>Note that Build can be invoked from any Ada buffer; typically you will
|
|
be fixing errors in files other than the main, but you don’t have to
|
|
switch back to the main to invoke the compiler again.
|
|
</p>
|
|
<p>Novices and students typically work on single-file Ada projects. In
|
|
this case, <kbd>C-c C-m</kbd> will normally be the only command needed; it
|
|
will build the current file, rather than the last-built main.
|
|
</p>
|
|
<p>There are three ways to change <code>main</code>:
|
|
</p>
|
|
<ol>
|
|
<li> Invoke ‘<samp>Ada | Set main and Build</samp>’, which sets <code>main</code> to
|
|
the current file.
|
|
|
|
</li><li> Invoke ‘<samp>Ada | Project | Edit</samp>’, edit <code>main</code> and
|
|
<code>main</code>, and click ‘<samp>[save]</samp>’
|
|
|
|
</li><li> Invoke ‘<samp>Ada | Project | Load</samp>’, and load a project file that specifies <code>main</code>
|
|
|
|
</li></ol>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Compiler-errors">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="#Compile-commands" accesskey="p" rel="prev">Compile commands</a>, Up: <a href="#Compiling-Executing" accesskey="u" rel="up">Compiling Executing</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Compiler-errors-1"></span><h3 class="section">4.2 Compiler errors</h3>
|
|
|
|
<p>The <code>Check file</code>, <code>Compile file</code>, and <code>Build</code> commands
|
|
all place compilation errors in a separate buffer named
|
|
<samp>*compilation*</samp>.
|
|
</p>
|
|
<p>Each line in this buffer will become active: you can simply click on
|
|
it with the middle button of the mouse, or move point to it and press
|
|
<tt class="key">RET</tt>. Emacs will then display the relevant source file and put
|
|
point on the line and column where the error was found.
|
|
</p>
|
|
<p>You can also press the <kbd>C-x `</kbd> key (<code>next-error</code>), and Emacs
|
|
will jump to the first error. If you press that key again, it will
|
|
move you to the second error, and so on.
|
|
</p>
|
|
<p>Some error messages might also include references to other files. These
|
|
references are also clickable in the same way, or put point after the
|
|
line number and press <tt class="key">RET</tt>.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
</div>
|
|
<div class="chapter" id="Project-files">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Compiling-Examples" accesskey="n" rel="next">Compiling Examples</a>, Previous: <a href="#Compiling-Executing" accesskey="p" rel="prev">Compiling Executing</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Project-files-1"></span><h2 class="chapter">5 Project files</h2>
|
|
|
|
<p>An Emacs Ada mode project file specifies what directories hold sources
|
|
for your project, and allows you to customize the compilation commands
|
|
and other things on a per-project basis.
|
|
</p>
|
|
<p>Note that Ada mode project files <samp>*.adp</samp> are different than GNAT
|
|
compiler project files <samp>*.gpr</samp>. However, Emacs Ada mode can use a
|
|
GNAT project file to specify the project directories. If no
|
|
other customization is needed, a GNAT project file can be used without
|
|
an Emacs Ada mode project file.
|
|
</p>
|
|
|
|
<ul class="section-toc">
|
|
<li><a href="#Project-File-Overview" accesskey="1">Project File Overview</a></li>
|
|
<li><a href="#GUI-Editor" accesskey="2">GUI Editor</a></li>
|
|
<li><a href="#Project-file-variables" accesskey="3">Project file variables</a></li>
|
|
</ul>
|
|
<hr>
|
|
<div class="section" id="Project-File-Overview">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#GUI-Editor" accesskey="n" rel="next">GUI Editor</a>, Up: <a href="#Project-files" accesskey="u" rel="up">Project files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Project-File-Overview-1"></span><h3 class="section">5.1 Project File Overview</h3>
|
|
|
|
<p>Project files have a simple syntax; they may be edited directly. Each
|
|
line specifies a project variable name and its value, separated by “=”:
|
|
</p><div class="example">
|
|
<pre class="example">src_dir=/Projects/my_project/src_1
|
|
src_dir=/Projects/my_project/src_2
|
|
</pre></div>
|
|
|
|
<p>Some variables (like <code>src_dir</code>) are lists; multiple occurrences
|
|
are concatenated.
|
|
</p>
|
|
<p>There must be no space between the variable name and “=”, and no
|
|
trailing spaces.
|
|
</p>
|
|
<p>Alternately, a GUI editor for project files is available (see <a href="#GUI-Editor">GUI Editor</a>). It uses Emacs widgets, similar to Emacs customize.
|
|
</p>
|
|
<p>The GUI editor also provides a convenient way to view current project
|
|
settings, if they have been modified using menu commands rather than
|
|
by editing the project file.
|
|
</p>
|
|
<p>After the first Ada mode build command is invoked, there is always a
|
|
current project file, given by the lisp variable
|
|
<code>ada-prj-default-project-file</code>. Currently, the only way to show
|
|
the current project file is to invoke the GUI editor.
|
|
</p>
|
|
<p>To find the project file the first time, Ada mode uses the following
|
|
search algorithm:
|
|
</p>
|
|
<ul>
|
|
<li> If <code>ada-prj-default-project-file</code> is set, use that.
|
|
|
|
</li><li> Otherwise, search for a file in the current directory with
|
|
the same base name as the Ada file, but extension given by
|
|
<code>ada-prj-file-extension</code> (default <code>".adp"</code>).
|
|
|
|
</li><li> If not found, search for <samp>*.adp</samp> in the current directory; if
|
|
several are found, prompt the user to select one.
|
|
|
|
</li><li> If none are found, use <samp>default.adp</samp> in the current directory (even
|
|
if it does not exist).
|
|
|
|
</li></ul>
|
|
|
|
<p>This algorithm always sets <code>ada-prj-default-project-file</code>, even
|
|
when the file does not actually exist.
|
|
</p>
|
|
<p>To change the project file before or after the first one is found,
|
|
invoke ‘<samp>Ada | Project | Load ...</samp>’.
|
|
</p>
|
|
<p>Or, in lisp, evaluate <code>(ada-set-default-project-file "/path/file.adp")</code>.
|
|
This sets <code>ada-prj-default-project-file</code>, and reads the project file.
|
|
</p>
|
|
<p>You can also specify a GNAT project file to ‘<samp>Ada | Project | Load
|
|
...</samp>’ or <code>ada-set-default-project-file</code>. Emacs Ada mode checks the
|
|
file extension; if it is <code>.gpr</code>, the file is treated as a GNAT
|
|
project file. Any other extension is treated as an Emacs Ada mode
|
|
project file.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="GUI-Editor">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Project-file-variables" accesskey="n" rel="next">Project file variables</a>, Previous: <a href="#Project-File-Overview" accesskey="p" rel="prev">Project File Overview</a>, Up: <a href="#Project-files" accesskey="u" rel="up">Project files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="GUI-Editor-1"></span><h3 class="section">5.2 GUI Editor</h3>
|
|
|
|
<p>The project file editor is invoked with the menu ‘<samp>Ada | Projects
|
|
| Edit</samp>’.
|
|
</p>
|
|
<p>Once in the buffer for editing the project file, you can save your
|
|
modification using the ‘<samp>[save]</samp>’ button at the bottom of the
|
|
buffer, or the <kbd>C-x C-s</kbd> binding. To cancel your modifications,
|
|
kill the buffer or click on the ‘<samp>[cancel]</samp>’ button.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Project-file-variables">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="#GUI-Editor" accesskey="p" rel="prev">GUI Editor</a>, Up: <a href="#Project-files" accesskey="u" rel="up">Project files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Project-file-variables-1"></span><h3 class="section">5.3 Project file variables</h3>
|
|
|
|
<p>The following variables can be defined in a project file; some can
|
|
also be defined in lisp variables.
|
|
</p>
|
|
<p>To set a project variable that is a list, specify each element of the
|
|
list on a separate line in the project file.
|
|
</p>
|
|
<p>Any project variable can be referenced in other project variables,
|
|
using a shell-like notation. For instance, if the variable
|
|
<code>comp_cmd</code> contains <code>${comp_opt}</code>, the value of the
|
|
<code>comp_opt</code> variable will be substituted when <code>comp_cmd</code> is
|
|
used.
|
|
</p>
|
|
<p>In addition, process environment variables can be referenced using the
|
|
same syntax, or the normal <code>$var</code> syntax.
|
|
</p>
|
|
<p>Most project variables have defaults that can be changed by setting
|
|
lisp variables; the table below identifies the lisp variable for each
|
|
project variable. Lisp variables corresponding to project variables
|
|
that are lists are lisp lists.
|
|
</p>
|
|
<p>In general, project variables are evaluated when referenced in
|
|
Emacs Ada mode commands. Relative file paths are expanded to
|
|
absolute relative to <code>${build_dir}</code>.
|
|
</p>
|
|
<p>Here is the list of variables. In the default values, the current
|
|
directory <code>"."</code> is the project file directory.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><code>ada_project_path_sep</code> [default: <code>":" or ";"</code>]</span></dt>
|
|
<dd><p>Path separator for <code>ADA_PROJECT_PATH</code>. It defaults to the correct
|
|
value for a native implementation of GNAT for the current operating
|
|
system. The user must override this when using Windows native GNAT
|
|
with Cygwin Emacs, and perhaps in other cases.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-ada-project-path-sep</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada_project_path</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>A list of directories to search for GNAT project files.
|
|
</p>
|
|
<p>If set, the <code>ADA_PROJECT_PATH</code> process environment variable is
|
|
set to this value in the Emacs process when the Emacs Ada mode project
|
|
is selected via menu ‘<samp>Ada | Project | Load</samp>’.
|
|
</p>
|
|
<p>For <code>ada_project_path</code>, relative file paths are expanded to
|
|
absolute when the Emacs Ada project file is read, rather than when the
|
|
project file is selected.
|
|
</p>
|
|
<p>For example if the project file is in the directory
|
|
<samp>/home/myproject</samp>, the environment variable <code>GDS_ROOT</code> is
|
|
set to <code>/home/shared</code>, and the project file contains:
|
|
</p><div class="example">
|
|
<pre class="example">ada_project_path_sep=:
|
|
ada_project_path=$GDS_ROOT/makerules
|
|
ada_project_path=../opentoken
|
|
</pre></div>
|
|
<p>then as a result the environment variable <code>ADA_PROJECT_PATH</code> will
|
|
be set to <code>"/home/shared/makerules:/home/opentoken/"</code>.
|
|
</p>
|
|
<p>The default value is not the current value of this environment
|
|
variable, because that will typically have been set by another
|
|
project, and will therefore be incorrect for this project.
|
|
</p>
|
|
<p>If you have the environment variable set correctly for all of your
|
|
projects, you do not need to set this project variable.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>bind_opt</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Holds user binder options; used in the default build commands.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-bind-opt</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>build_dir</code> [default: <code>"."</code>]</span></dt>
|
|
<dd><p>The compile commands will be issued in this directory.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>casing</code> [default: <code>("~/.emacs_case_exceptions")</code>]</span></dt>
|
|
<dd><p>List of files containing casing exceptions. See the help on
|
|
<code>ada-case-exception-file</code> for more info.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-case-exception-file</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>check_cmd</code> [default: <code>"${cross_prefix}gnatmake -u -c -gnatc ${gnatmake_opt} ${full_current} -cargs ${comp_opt}"</code>]</span></dt>
|
|
<dd><p>Command used to syntax check a single file.
|
|
The name of the file is substituted for <code>full_current</code>.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-check-cmd</code>
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>comp_cmd</code> [default: <code>"${cross_prefix}gnatmake -u -c ${gnatmake_opt} ${full_current} -cargs ${comp_opt}"</code>]</span></dt>
|
|
<dd><p>Command used to compile a single file.
|
|
The name of the file is substituted for <code>full_current</code>.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-comp-cmd</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>comp_opt</code> [default: <code>"-gnatq -gnatQ"</code>]</span></dt>
|
|
<dd><p>Holds user compiler options; used in the default compile commands. The
|
|
default value tells gnatmake to generate library files for
|
|
cross-referencing even when there are errors.
|
|
</p>
|
|
<p>If source code for the project is in multiple directories, the
|
|
appropriate compiler options must be added here. <a href="#Set-source-search-path">Set source search path</a> for examples of this. Alternately, GNAT project files may
|
|
be used; <a href="#Use-GNAT-project-file">Use GNAT project file</a>.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-comp-opt</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>cross_prefix</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Name of target machine in a cross-compilation environment. Used in
|
|
default compile and build commands.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>debug_cmd</code> [default: <code>"${cross_prefix}gdb ${main}"</code>]</span></dt>
|
|
<dd><p>Command used to debug the application
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-debugger</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>debug_post_cmd</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Command executed after <code>debug_cmd</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>debug_pre_cmd</code> [default: <code>"cd ${build_dir}"</code>]</span></dt>
|
|
<dd><p>Command executed before <code>debug_cmd</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>gnatfind_opt</code> [default: <code>"-rf"</code>]</span></dt>
|
|
<dd><p>Holds user gnatfind options; used in the default find commands.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-gnatfind-switches</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>gnatmake_opt</code> [default: <code>"-g"</code>]</span></dt>
|
|
<dd><p>Holds user gnatmake options; used in the default build commands.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-gnatmake-opt</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>gpr_file</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Specify GNAT project file.
|
|
</p>
|
|
<p>If set, the source and object directories specified in the GNAT
|
|
project file are appended to <code>src_dir</code> and <code>obj_dir</code>. This
|
|
allows specifying Ada source directories with a GNAT project file, and
|
|
other source directories with the Emacs project file.
|
|
</p>
|
|
<p>In addition, <code>-P{gpr_file}</code> is added to the project variable
|
|
<code>gnatmake_opt</code> whenever it is referenced. With the default
|
|
project variables, this passes the project file to all gnatmake
|
|
commands.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-gpr-file</code>.
|
|
</p>
|
|
|
|
</dd>
|
|
<dt><span><code>link_opt</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Holds user linker options; used in the default build commands.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-link-opt</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>main</code> [default: current file]</span></dt>
|
|
<dd><p>Specifies the name of the executable file for the project; used in the
|
|
default build commands.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>make_cmd</code> [default: <code>"${cross_prefix}gnatmake -o ${main} ${main} ${gnatmake_opt} -cargs ${comp_opt} -bargs ${bind_opt} -largs ${link_opt}"</code>]</span></dt>
|
|
<dd><p>Command used to build the application.
|
|
</p>
|
|
<p>Lisp variable: <code>ada-prj-default-make-cmd</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>obj_dir</code> [default: <code>"."</code>]</span></dt>
|
|
<dd><p>A list of directories to search for library files. Ada mode searches
|
|
this list for the ‘<samp>.ali</samp>’ files generated by GNAT that contain
|
|
cross-reference information.
|
|
</p>
|
|
<p>The compiler commands must place the ‘<samp>.ali</samp>’ files in one of these
|
|
directories; the default commands do that.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>remote_machine</code> [default: <code>""</code>]</span></dt>
|
|
<dd><p>Name of the machine to log into before issuing the compile and build
|
|
commands. If this variable is empty, the command will be run on the
|
|
local machine.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>run_cmd</code> [default: <code>"./${main}"</code>]</span></dt>
|
|
<dd><p>Command used to run the application.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>src_dir</code> [default: <code>"."</code>]</span></dt>
|
|
<dd><p>A list of directories to search for source files, both for compile
|
|
commands and source navigation.
|
|
</p>
|
|
</dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
</div>
|
|
<div class="chapter" id="Compiling-Examples">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Moving-Through-Ada-Code" accesskey="n" rel="next">Moving Through Ada Code</a>, Previous: <a href="#Project-files" accesskey="p" rel="prev">Project files</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Compiling-Examples-1"></span><h2 class="chapter">6 Compiling Examples</h2>
|
|
|
|
<p>We present several small projects, and walk thru the process of
|
|
compiling, linking, and running them.
|
|
</p>
|
|
<p>The first example illustrates more Ada mode features than the others;
|
|
you should work thru that example before doing the others.
|
|
</p>
|
|
<p>All of these examples assume you are using GNAT.
|
|
</p>
|
|
<p>The source for these examples is available on the Emacs Ada mode
|
|
website mentioned in See <a href="#Installation">Installation</a>.
|
|
</p>
|
|
|
|
<ul class="section-toc">
|
|
<li><a href="#No-project-files" accesskey="1">No project files</a></li>
|
|
<li><a href="#Set-compiler-options" accesskey="2">Set compiler options</a></li>
|
|
<li><a href="#Set-source-search-path" accesskey="3">Set source search path</a></li>
|
|
<li><a href="#Use-GNAT-project-file" accesskey="4">Use GNAT project file</a></li>
|
|
<li><a href="#Use-multiple-GNAT-project-files" accesskey="5">Use multiple GNAT project files</a></li>
|
|
</ul>
|
|
<hr>
|
|
<div class="section" id="No-project-files">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Set-compiler-options" accesskey="n" rel="next">Set compiler options</a>, Up: <a href="#Compiling-Examples" accesskey="u" rel="up">Compiling Examples</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="No-project-files-1"></span><h3 class="section">6.1 No project files</h3>
|
|
<p>This example uses no project files.
|
|
</p>
|
|
<p>First, create a directory <samp>Example_1</samp>, containing:
|
|
</p>
|
|
<p><samp>hello.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Ada.Text_IO;
|
|
procedure Hello
|
|
is begin
|
|
Put_Line("Hello from hello.adb");
|
|
end Hello;
|
|
</pre></div>
|
|
|
|
<p>Yes, this is missing “use Ada.Text_IO;” - we want to demonstrate
|
|
compiler error handling.
|
|
</p>
|
|
<p><samp>hello_2.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Hello_Pkg;
|
|
procedure Hello_2
|
|
is begin
|
|
Hello_Pkg.Say_Hello;
|
|
end Hello_2;
|
|
</pre></div>
|
|
|
|
<p>This file has no errors.
|
|
</p>
|
|
<p><samp>hello_pkg.ads</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">package Hello_Pkg is
|
|
procedure Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p>This file has no errors.
|
|
</p>
|
|
<p><samp>hello_pkg.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Ada.Text_IO;
|
|
package Hello_Pkg is
|
|
procedure Say_Hello
|
|
is begin
|
|
Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
|
|
end Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p>Yes, this is missing the keyword <code>body</code>; another compiler error
|
|
example.
|
|
</p>
|
|
<p>In buffer <samp>hello.adb</samp>, invoke ‘<samp>Ada | Check file</samp>’. You should
|
|
get a <samp>*compilation*</samp> buffer containing something like (the
|
|
directory paths will be different):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_1/
|
|
gnatmake -u -c -gnatc -g c:/Examples/Example_1/hello.adb -cargs -gnatq -gnatQ
|
|
gcc -c -Ic:/Examples/Example_1/ -gnatc -g -gnatq -gnatQ -I- c:/Examples/Example_1/hello.adb
|
|
hello.adb:4:04: "Put_Line" is not visible
|
|
hello.adb:4:04: non-visible declaration at a-textio.ads:264
|
|
hello.adb:4:04: non-visible declaration at a-textio.ads:260
|
|
gnatmake: "c:/Examples/Example_1/hello.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>If you have enabled font-lock, the lines with actual errors (starting
|
|
with <samp>hello.adb</samp>) are highlighted, with the file name in red.
|
|
</p>
|
|
<p>Now type <kbd>C-x `</kbd> (on a PC keyboard, <tt class="key">`</tt> is next to <tt class="key">1</tt>).
|
|
Or you can click the middle mouse button on the first error line. The
|
|
compilation buffer scrolls to put the first error on the top line, and
|
|
point is put at the place of the error in the <samp>hello.adb</samp> buffer.
|
|
</p>
|
|
<p>To fix the error, change the line to be
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example"> Ada.Text_IO.Put_Line ("hello from hello.adb");
|
|
</pre></div>
|
|
|
|
<p>Now invoke ‘<samp>Ada | Show main</samp>’; this displays ‘<samp>Ada mode main: hello</samp>’.
|
|
</p>
|
|
<p>Now (in buffer <samp>hello.adb</samp>), invoke ‘<samp>Ada | Build</samp>’. You are
|
|
prompted to save the file (if you haven’t already). Then the
|
|
compilation buffer is displayed again, containing:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_1/
|
|
gnatmake -o hello hello -g -cargs -gnatq -gnatQ -bargs -largs
|
|
gcc -c -g -gnatq -gnatQ hello.adb
|
|
gnatbind -x hello.ali
|
|
gnatlink hello.ali -o hello.exe -g
|
|
</pre></div>
|
|
|
|
<p>The compilation has succeeded without errors; <samp>hello.exe</samp> now
|
|
exists in the same directory as <samp>hello.adb</samp>.
|
|
</p>
|
|
<p>Now invoke ‘<samp>Ada | Run</samp>’. A <samp>*run*</samp> buffer is displayed,
|
|
containing
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">Hello from hello.adb
|
|
|
|
Process run finished
|
|
</pre></div>
|
|
|
|
<p>That completes the first part of this example.
|
|
</p>
|
|
<p>Now we will compile a multi-file project. Open the file
|
|
<samp>hello_2.adb</samp>, and invoke ‘<samp>Ada | Set main and Build</samp>’. This
|
|
finds an error in <samp>hello_pkg.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_1/
|
|
gnatmake -o hello_2 hello_2 -g -cargs -gnatq -gnatQ -bargs -largs
|
|
gcc -c -g -gnatq -gnatQ hello_pkg.adb
|
|
hello_pkg.adb:2:08: keyword "body" expected here [see file name]
|
|
gnatmake: "hello_pkg.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>This demonstrates that gnatmake finds the files needed by the main
|
|
program. However, it cannot find files in a different directory,
|
|
unless you use an Emacs Ada mode project file to specify the other directories;
|
|
See <a href="#Set-source-search-path">Set source search path</a>, or a GNAT project file; <a href="#Use-GNAT-project-file">Use GNAT project file</a>.
|
|
</p>
|
|
<p>Invoke ‘<samp>Ada | Show main</samp>’; this displays <samp>Ada mode main: hello_2</samp>.
|
|
</p>
|
|
<p>Move to the error with <kbd>C-x `</kbd>, and fix the error by adding <code>body</code>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">package body Hello_Pkg is
|
|
</pre></div>
|
|
|
|
<p>Now, while still in <samp>hello_pkg.adb</samp>, invoke ‘<samp>Ada | Build</samp>’.
|
|
gnatmake successfully builds <samp>hello_2</samp>. This demonstrates that
|
|
Emacs has remembered the main file, in the project variable
|
|
<code>main</code>, and used it for the Build command.
|
|
</p>
|
|
<p>Finally, again while in <samp>hello_pkg.adb</samp>, invoke ‘<samp>Ada | Run</samp>’.
|
|
The <samp>*run*</samp> buffer displays <code>Hello from hello_pkg.adb</code>.
|
|
</p>
|
|
<p>One final point. If you switch back to buffer <samp>hello.adb</samp>, and
|
|
invoke ‘<samp>Ada | Run</samp>’, <samp>hello_2.exe</samp> will be run. That is
|
|
because <code>main</code> is still set to <code>hello_2</code>, as you can
|
|
see when you invoke ‘<samp>Ada | Project | Edit</samp>’.
|
|
</p>
|
|
<p>There are three ways to change <code>main</code>:
|
|
</p>
|
|
<ol>
|
|
<li> Invoke ‘<samp>Ada | Set main and Build</samp>’, which sets <code>main</code> to
|
|
the current file.
|
|
|
|
</li><li> Invoke ‘<samp>Ada | Project | Edit</samp>’, edit <code>main</code>, and click ‘<samp>[save]</samp>’
|
|
|
|
</li><li> Invoke ‘<samp>Ada | Project | Load</samp>’, and load a project file that specifies <code>main</code>
|
|
|
|
</li></ol>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Set-compiler-options">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Set-source-search-path" accesskey="n" rel="next">Set source search path</a>, Previous: <a href="#No-project-files" accesskey="p" rel="prev">No project files</a>, Up: <a href="#Compiling-Examples" accesskey="u" rel="up">Compiling Examples</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Set-compiler-options-1"></span><h3 class="section">6.2 Set compiler options</h3>
|
|
|
|
<p>This example illustrates using an Emacs Ada mode project file to set a
|
|
compiler option.
|
|
</p>
|
|
<p>If you have files from <samp>Example_1</samp> open in Emacs, you should
|
|
close them so you don’t get confused. Use menu ‘<samp>File | Close
|
|
(current buffer)</samp>’.
|
|
</p>
|
|
<p>In directory <samp>Example_2</samp>, create these files:
|
|
</p>
|
|
<p><samp>hello.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Ada.Text_IO;
|
|
procedure Hello
|
|
is begin
|
|
Put_Line("Hello from hello.adb");
|
|
end Hello;
|
|
</pre></div>
|
|
|
|
<p>This is the same as <samp>hello.adb</samp> from <samp>Example_1</samp>. It has two
|
|
errors; missing “use Ada.Text_IO;”, and no space between
|
|
<code>Put_Line</code> and its argument list.
|
|
</p>
|
|
<p><samp>hello.adp</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">comp_opt=-gnatyt
|
|
</pre></div>
|
|
|
|
<p>This tells the GNAT compiler to check for token spacing; in
|
|
particular, there must be a space preceding a parenthesis.
|
|
</p>
|
|
<p>In buffer <samp>hello.adb</samp>, invoke ‘<samp>Ada | Project | Load...</samp>’, and
|
|
select <samp>Example_2/hello.adp</samp>.
|
|
</p>
|
|
<p>Then, again in buffer <samp>hello.adb</samp>, invoke ‘<samp>Ada | Set main and
|
|
Build</samp>’. You should get a <samp>*compilation*</samp> buffer containing
|
|
something like (the directory paths will be different):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_2/
|
|
gnatmake -o hello hello -g -cargs -gnatyt -bargs -largs
|
|
gcc -c -g -gnatyt hello.adb
|
|
hello.adb:4:04: "Put_Line" is not visible
|
|
hello.adb:4:04: non-visible declaration at a-textio.ads:264
|
|
hello.adb:4:04: non-visible declaration at a-textio.ads:260
|
|
hello.adb:4:12: (style) space required
|
|
gnatmake: "hello.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>Compare this to the compiler output in <a href="#No-project-files">No project files</a>; the
|
|
gnatmake option <code>-cargs -gnatq -gnatQ</code> has been replaced by
|
|
<code>-cargs -gnaty</code>, and an additional error is reported in
|
|
<samp>hello.adb</samp> on line 4. This shows that <samp>hello.adp</samp> is being
|
|
used to set the compiler options.
|
|
</p>
|
|
<p>Fixing the error, linking and running the code proceed as in <a href="#No-project-files">No project files</a>.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Set-source-search-path">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Use-GNAT-project-file" accesskey="n" rel="next">Use GNAT project file</a>, Previous: <a href="#Set-compiler-options" accesskey="p" rel="prev">Set compiler options</a>, Up: <a href="#Compiling-Examples" accesskey="u" rel="up">Compiling Examples</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Set-source-search-path-1"></span><h3 class="section">6.3 Set source search path</h3>
|
|
|
|
<p>In this example, we show how to deal with files in more than one
|
|
directory. We start with the same code as in <a href="#No-project-files">No project files</a>;
|
|
create those files (with the errors present)
|
|
</p>
|
|
<p>Create the directory <samp>Example_3</samp>, containing:
|
|
</p>
|
|
<p><samp>hello_pkg.ads</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">package Hello_Pkg is
|
|
procedure Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p><samp>hello_pkg.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Ada.Text_IO;
|
|
package Hello_Pkg is
|
|
procedure Say_Hello
|
|
is begin
|
|
Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
|
|
end Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p>These are the same files from example 1; <samp>hello_pkg.adb</samp> has an
|
|
error on line 2.
|
|
</p>
|
|
<p>In addition, create a directory <samp>Example_3/Other</samp>, containing these files:
|
|
</p>
|
|
<p><samp>Other/hello_3.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Hello_Pkg;
|
|
with Ada.Text_IO; use Ada.Text_IO;
|
|
procedure Hello_3
|
|
is begin
|
|
Hello_Pkg.Say_Hello;
|
|
Put_Line ("From hello_3");
|
|
end Hello_3;
|
|
</pre></div>
|
|
|
|
<p>There are no errors in this file.
|
|
</p>
|
|
<p><samp>Other/other.adp</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">src_dir=..
|
|
comp_opt=-I..
|
|
</pre></div>
|
|
|
|
<p>Note that there must be no trailing spaces.
|
|
</p>
|
|
<p>In buffer <samp>hello_3.adb</samp>, invoke ‘<samp>Ada | Project | Load...</samp>’, and
|
|
select <samp>Example_3/Other/other.adp</samp>.
|
|
</p>
|
|
<p>Then, again in <samp>hello_3.adb</samp>, invoke ‘<samp>Ada | Set main and
|
|
Build</samp>’. You should get a <samp>*compilation*</samp> buffer containing
|
|
something like (the directory paths will be different):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_3/Other/
|
|
gnatmake -o hello_3 hello_3 -g -cargs -I.. -bargs -largs
|
|
gcc -c -g -I.. hello_3.adb
|
|
gcc -c -I./ -g -I.. -I- C:\Examples\Example_3\hello_pkg.adb
|
|
hello_pkg.adb:2:08: keyword "body" expected here [see file name]
|
|
gnatmake: "C:\Examples\Example_3\hello_pkg.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>Compare the <code>-cargs</code> option to the compiler output in <a href="#Set-compiler-options">Set compiler options</a>; this shows that <samp>other.adp</samp> is being used to
|
|
set the compiler options.
|
|
</p>
|
|
<p>Move to the error with <kbd>C-x `</kbd>. Ada mode searches the list of
|
|
directories given by <code>src_dir</code> for the file mentioned in the
|
|
compiler error message.
|
|
</p>
|
|
<p>Fixing the error, linking and running the code proceed as in <a href="#No-project-files">No project files</a>.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Use-GNAT-project-file">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Use-multiple-GNAT-project-files" accesskey="n" rel="next">Use multiple GNAT project files</a>, Previous: <a href="#Set-source-search-path" accesskey="p" rel="prev">Set source search path</a>, Up: <a href="#Compiling-Examples" accesskey="u" rel="up">Compiling Examples</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Use-GNAT-project-file-1"></span><h3 class="section">6.4 Use GNAT project file</h3>
|
|
|
|
<p>In this example, we show how to use a GNAT project file, with no Ada
|
|
mode project file.
|
|
</p>
|
|
<p>Create the directory <samp>Example_4</samp>, containing:
|
|
</p>
|
|
<p><samp>hello_pkg.ads</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">package Hello_Pkg is
|
|
procedure Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p><samp>hello_pkg.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Ada.Text_IO;
|
|
package Hello_Pkg is
|
|
procedure Say_Hello
|
|
is begin
|
|
Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
|
|
end Say_Hello;
|
|
end Hello_Pkg;
|
|
</pre></div>
|
|
|
|
<p>These are the same files from example 1; <samp>hello_pkg.adb</samp> has an
|
|
error on line 2.
|
|
</p>
|
|
<p>In addition, create a directory <samp>Example_4/Gnat_Project</samp>,
|
|
containing these files:
|
|
</p>
|
|
<p><samp>Gnat_Project/hello_4.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Hello_Pkg;
|
|
with Ada.Text_IO; use Ada.Text_IO;
|
|
procedure Hello_4
|
|
is begin
|
|
Hello_Pkg.Say_Hello;
|
|
Put_Line ("From hello_4");
|
|
end Hello_4;
|
|
</pre></div>
|
|
|
|
<p>There are no errors in this file.
|
|
</p>
|
|
<p><samp>Gnat_Project/hello_4.gpr</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">Project Hello_4 is
|
|
for Source_Dirs use (".", "..");
|
|
end Hello_4;
|
|
</pre></div>
|
|
|
|
<p>In buffer <samp>hello_4.adb</samp>, invoke ‘<samp>Ada | Project | Load...</samp>’, and
|
|
select <samp>Example_4/Gnat_Project/hello_4.gpr</samp>.
|
|
</p>
|
|
<p>Then, again in <samp>hello_4.adb</samp>, invoke ‘<samp>Ada | Set main and
|
|
Build</samp>’. You should get a <samp>*compilation*</samp> buffer containing
|
|
something like (the directory paths will be different):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_4/Gnat_Project/
|
|
gnatmake -o hello_4 hello_4 -Phello_4.gpr -cargs -gnatq -gnatQ -bargs -largs
|
|
gcc -c -g -gnatyt -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\Gnat_Project\hello_4.adb
|
|
gcc -c -g -gnatyt -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\hello_pkg.adb
|
|
hello_pkg.adb:2:08: keyword "body" expected here [see file name]
|
|
gnatmake: "c:\examples\example_4\hello_pkg.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>Compare the <code>gcc</code> options to the compiler output in <a href="#Set-compiler-options">Set compiler options</a>; this shows that <samp>hello_4.gpr</samp> is being used to
|
|
set the compiler options.
|
|
</p>
|
|
<p>Fixing the error, linking and running the code proceed as in <a href="#No-project-files">No project files</a>.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="section" id="Use-multiple-GNAT-project-files">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="#Use-GNAT-project-file" accesskey="p" rel="prev">Use GNAT project file</a>, Up: <a href="#Compiling-Examples" accesskey="u" rel="up">Compiling Examples</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Use-multiple-GNAT-project-files-1"></span><h3 class="section">6.5 Use multiple GNAT project files</h3>
|
|
|
|
<p>In this example, we show how to use multiple GNAT project files,
|
|
specifying the GNAT project search path in an Ada mode project file.
|
|
</p>
|
|
<p>Create the directory <samp>Example_4</samp> as specified in <a href="#Use-GNAT-project-file">Use GNAT project file</a>.
|
|
</p>
|
|
<p>Create the directory <samp>Example_5</samp>, containing:
|
|
</p>
|
|
<p><samp>hello_5.adb</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with Hello_Pkg;
|
|
with Ada.Text_IO; use Ada.Text_IO;
|
|
procedure Hello_5
|
|
is begin
|
|
Hello_Pkg.Say_Hello;
|
|
Put_Line ("From hello_5");
|
|
end Hello_5;
|
|
</pre></div>
|
|
|
|
<p>There are no errors in this file.
|
|
</p>
|
|
<p><samp>hello_5.adp</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">ada_project_path=../Example_4/Gnat_Project
|
|
gpr_file=hello_5.gpr
|
|
</pre></div>
|
|
|
|
<p><samp>hello_5.gpr</samp>:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">with "hello_4";
|
|
Project Hello_5 is
|
|
for Source_Dirs use (".");
|
|
package Compiler is
|
|
for Default_Switches ("Ada") use ("-g", "-gnatyt");
|
|
end Compiler;
|
|
end Hello_5;
|
|
</pre></div>
|
|
|
|
<p>In buffer <samp>hello_5.adb</samp>, invoke ‘<samp>Ada | Project | Load...</samp>’, and
|
|
select <samp>Example_5/hello_5.adp</samp>.
|
|
</p>
|
|
<p>Then, again in <samp>hello_5.adb</samp>, invoke ‘<samp>Ada | Set main and
|
|
Build</samp>’. You should get a <samp>*compilation*</samp> buffer containing
|
|
something like (the directory paths will be different):
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">cd c:/Examples/Example_5/
|
|
gnatmake -o hello_5 hello_5 -Phello_5.gpr -g -cargs -gnatq -gnatQ -bargs -largs
|
|
gcc -c -g -gnatyt -g -gnatq -gnatQ -I- -gnatA c:\Examples\Example_5\hello_5.adb
|
|
gcc -c -g -gnatyt -g -gnatq -gnatQ -I- -gnatA c:\Examples\Example_4\hello_pkg.adb
|
|
hello_pkg.adb:2:08: keyword "body" expected here [see file name]
|
|
gnatmake: "c:\examples\example_4\hello_pkg.adb" compilation error
|
|
</pre></div>
|
|
|
|
<p>Now type <kbd>C-x `</kbd>. <samp>Example_4/hello_pkg.adb</samp> is shown,
|
|
demonstrating that <samp>hello_5.gpr</samp> and <samp>hello_4.gpr</samp> are being
|
|
used to set the compilation search path.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
</div>
|
|
<div class="chapter" id="Moving-Through-Ada-Code">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Identifier-completion" accesskey="n" rel="next">Identifier completion</a>, Previous: <a href="#Compiling-Examples" accesskey="p" rel="prev">Compiling Examples</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Moving-Through-Ada-Code-1"></span><h2 class="chapter">7 Moving Through Ada Code</h2>
|
|
|
|
<p>There are several easy to use commands to navigate through Ada code. All
|
|
these functions are available through the Ada menu, and you can also
|
|
use the following key bindings or the command names. Some of these
|
|
menu entries are available only if the GNAT compiler is used, since
|
|
the implementation relies on the GNAT cross-referencing information.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt id='index-ada_002dnext_002dprocedure'><span><kbd>M-C-e</kbd><a href='#index-ada_002dnext_002dprocedure' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move to the next function/procedure/task, which ever comes next
|
|
(<code>ada-next-procedure</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dprevious_002dprocedure'><span><kbd>M-C-a</kbd><a href='#index-ada_002dprevious_002dprocedure' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move to previous function/procedure/task
|
|
(<code>ada-previous-procedure</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dnext_002dpackage'><span><kbd>M-x ada-next-package</kbd><a href='#index-ada_002dnext_002dpackage' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move to next package.
|
|
</p></dd>
|
|
<dt id='index-ada_002dprevious_002dpackage'><span><kbd>M-x ada-previous-package</kbd><a href='#index-ada_002dprevious_002dpackage' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move to previous package.
|
|
</p></dd>
|
|
<dt id='index-ada_002dmove_002dto_002dstart'><span><kbd>C-c C-a</kbd><a href='#index-ada_002dmove_002dto_002dstart' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move to matching start of <code>end</code> (<code>ada-move-to-start</code>). If
|
|
point is at the end of a subprogram, this command jumps to the
|
|
corresponding <code>begin</code> if the user option
|
|
<code>ada-move-to-declaration</code> is <code>nil</code> (default), otherwise it jumps to
|
|
the subprogram declaration.
|
|
</p></dd>
|
|
<dt id='index-ada_002dmove_002dto_002dend'><span><kbd>C-c C-e</kbd><a href='#index-ada_002dmove_002dto_002dend' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move point to end of current block (<code>ada-move-to-end</code>).
|
|
</p></dd>
|
|
<dt><span><kbd>C-c o</kbd></span></dt>
|
|
<dd><p>Switch between corresponding spec and body file
|
|
(<code>ff-find-other-file</code>). If point is in a subprogram, position
|
|
point on the corresponding declaration or body in the other file.
|
|
</p></dd>
|
|
<dt id='index-ada_002dgoto_002ddeclaration'><span><kbd>C-c c-d</kbd><a href='#index-ada_002dgoto_002ddeclaration' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Move from any reference to its declaration, for from a declaration to
|
|
its body (for procedures, tasks, private and incomplete types).
|
|
</p></dd>
|
|
<dt id='index-ada_002dfind_002dreferences'><span><kbd>C-c C-r</kbd><a href='#index-ada_002dfind_002dreferences' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Runs the <samp>gnatfind</samp> command to search for all references to the
|
|
identifier surrounding point (<code>ada-find-references</code>). Use
|
|
<kbd>C-x `</kbd> (<code>next-error</code>) to visit each reference (as for
|
|
compilation errors).
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<p>If the <code>ada-xref-create-ali</code> variable is non-<code>nil</code>, Emacs
|
|
will try to run GNAT for you whenever cross-reference information is
|
|
needed, and is older than the current source file.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Identifier-completion">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Automatic-Smart-Indentation" accesskey="n" rel="next">Automatic Smart Indentation</a>, Previous: <a href="#Moving-Through-Ada-Code" accesskey="p" rel="prev">Moving Through Ada Code</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Identifier-completion-1"></span><h2 class="chapter">8 Identifier completion</h2>
|
|
|
|
<p>Emacs and Ada mode provide two general ways for the completion of
|
|
identifiers. This is an easy way to type faster: you just have to type
|
|
the first few letters of an identifiers, and then loop through all the
|
|
possible completions.
|
|
</p>
|
|
<p>The first method is general for Emacs. It works by parsing all open
|
|
files for possible completions.
|
|
</p>
|
|
<p>For instance, if the words ‘<samp>my_identifier</samp>’, ‘<samp>my_subprogram</samp>’
|
|
are the only words starting with ‘<samp>my</samp>’ in any of the opened files,
|
|
then you will have this scenario:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">You type: my<kbd>M-/</kbd>
|
|
Emacs inserts: ‘<samp>my_identifier</samp>’
|
|
If you press <kbd>M-/</kbd> once again, Emacs replaces ‘<samp>my_identifier</samp>’ with
|
|
‘<samp>my_subprogram</samp>’.
|
|
Pressing <kbd>M-/</kbd> once more will bring you back to ‘<samp>my_identifier</samp>’.
|
|
</pre></div>
|
|
|
|
<p>This is a very fast way to do completion, and the casing of words will
|
|
also be respected.
|
|
</p>
|
|
<p>The second method (<kbd>C-<span class="key">TAB</span></kbd>) is specific to Ada mode and the GNAT
|
|
compiler. Emacs will search the cross-information for possible
|
|
completions.
|
|
</p>
|
|
<p>The main advantage is that this completion is more accurate: only
|
|
existing identifier will be suggested.
|
|
</p>
|
|
<p>On the other hand, this completion is a little bit slower and requires
|
|
that you have compiled your file at least once since you created that
|
|
identifier.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt id='index-ada_002dcomplete_002didentifier'><span><kbd>C-<span class="key">TAB</span></kbd><a href='#index-ada_002dcomplete_002didentifier' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Complete current identifier using cross-reference information.
|
|
</p></dd>
|
|
<dt><span><kbd>M-/</kbd></span></dt>
|
|
<dd><p>Complete identifier using buffer information (not Ada-specific).
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Automatic-Smart-Indentation">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Formatting-Parameter-Lists" accesskey="n" rel="next">Formatting Parameter Lists</a>, Previous: <a href="#Identifier-completion" accesskey="p" rel="prev">Identifier completion</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Automatic-Smart-Indentation-1"></span><h2 class="chapter">9 Automatic Smart Indentation</h2>
|
|
|
|
<p>Ada mode comes with a full set of rules for automatic indentation. You
|
|
can also configure the indentation, via the following variables:
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><code>ada-broken-indent</code> (default value: 2)</span></dt>
|
|
<dd><p>Number of columns to indent the continuation of a broken line.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent</code> (default value: 3)</span></dt>
|
|
<dd><p>Number of columns for default indentation.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent-record-rel-type</code> (default value: 3)</span></dt>
|
|
<dd><p>Indentation for <code>record</code> relative to <code>type</code> or <code>use</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent-return</code> (default value: 0)</span></dt>
|
|
<dd><p>Indentation for <code>return</code> relative to <code>function</code> (if
|
|
<code>ada-indent-return</code> is greater than 0), or the open parenthesis
|
|
(if <code>ada-indent-return</code> is negative or 0). Note that in the second
|
|
case, when there is no open parenthesis, the indentation is done
|
|
relative to <code>function</code> with the value of <code>ada-broken-indent</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-label-indent</code> (default value: -4)</span></dt>
|
|
<dd><p>Number of columns to indent a label.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-stmt-end-indent</code> (default value: 0)</span></dt>
|
|
<dd><p>Number of columns to indent a statement <code>end</code> keyword on a separate line.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-when-indent</code> (default value: 3)</span></dt>
|
|
<dd><p>Indentation for <code>when</code> relative to <code>exception</code> or <code>case</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent-is-separate</code> (default value: t)</span></dt>
|
|
<dd><p>Non-<code>nil</code> means indent <code>is separate</code> or <code>is abstract</code> if on a single line.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent-to-open-paren</code> (default value: t)</span></dt>
|
|
<dd><p>Non-<code>nil</code> means indent according to the innermost open parenthesis.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-indent-after-return</code> (default value: t)</span></dt>
|
|
<dd><p>Non-<code>nil</code> means that the current line will also be re-indented
|
|
before inserting a newline, when you press <tt class="key">RET</tt>.
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<p>Most of the time, the indentation will be automatic, i.e., when you
|
|
press <tt class="key">RET</tt>, the cursor will move to the correct column on the
|
|
next line.
|
|
</p>
|
|
<p>You can also indent single lines, or the current region, with <tt class="key">TAB</tt>.
|
|
</p>
|
|
<p>Another mode of indentation exists that helps you to set up your
|
|
indentation scheme. If you press <kbd>C-c <span class="key">TAB</span></kbd>, Ada mode will do
|
|
the following:
|
|
</p>
|
|
<ul>
|
|
<li> Reindent the current line, as <tt class="key">TAB</tt> would do.
|
|
</li><li> Temporarily move the cursor to a reference line, i.e., the line that
|
|
was used to calculate the current indentation.
|
|
</li><li> Display in the message window the name of the variable that provided
|
|
the offset for the indentation.
|
|
</li></ul>
|
|
|
|
<p>The exact indentation of the current line is the same as the one for the
|
|
reference line, plus an offset given by the variable.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><kbd><span class="key">TAB</span></kbd></span></dt>
|
|
<dd><p>Indent the current line or the current region.
|
|
</p></dd>
|
|
<dt><span><kbd>C-M-\</kbd></span></dt>
|
|
<dd><p>Indent lines in the current region.
|
|
</p></dd>
|
|
<dt><span><kbd>C-c <span class="key">TAB</span></kbd></span></dt>
|
|
<dd><p>Indent the current line and display the name of the variable used for
|
|
indentation.
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Formatting-Parameter-Lists">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Automatic-Casing" accesskey="n" rel="next">Automatic Casing</a>, Previous: <a href="#Automatic-Smart-Indentation" accesskey="p" rel="prev">Automatic Smart Indentation</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Formatting-Parameter-Lists-1"></span><h2 class="chapter">10 Formatting Parameter Lists</h2>
|
|
|
|
<dl compact="compact">
|
|
<dt id='index-ada_002dformat_002dparamlist'><span><kbd>C-c C-f</kbd><a href='#index-ada_002dformat_002dparamlist' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Format the parameter list (<code>ada-format-paramlist</code>).
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<p>This aligns the declarations on the colon (‘<samp>:</samp>’) separating
|
|
argument names and argument types, and aligns the <code>in</code>,
|
|
<code>out</code> and <code>in out</code> keywords.
|
|
</p>
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Automatic-Casing">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Statement-Templates" accesskey="n" rel="next">Statement Templates</a>, Previous: <a href="#Formatting-Parameter-Lists" accesskey="p" rel="prev">Formatting Parameter Lists</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Automatic-Casing-1"></span><h2 class="chapter">11 Automatic Casing</h2>
|
|
|
|
<p>Casing of identifiers, attributes and keywords is automatically
|
|
performed while typing when the variable <code>ada-auto-case</code> is set.
|
|
Every time you press a word separator, the previous word is
|
|
automatically cased.
|
|
</p>
|
|
<p>You can customize the automatic casing differently for keywords,
|
|
attributes and identifiers. The relevant variables are the following:
|
|
<code>ada-case-keyword</code>, <code>ada-case-attribute</code> and
|
|
<code>ada-case-identifier</code>.
|
|
</p>
|
|
<p>All these variables can have one of the following values:
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><code>downcase-word</code></span></dt>
|
|
<dd><p>The word will be lowercase. For instance <code>My_vARIable</code> is
|
|
converted to <code>my_variable</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>upcase-word</code></span></dt>
|
|
<dd><p>The word will be uppercase. For instance <code>My_vARIable</code> is
|
|
converted to <code>MY_VARIABLE</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-capitalize-word</code></span></dt>
|
|
<dd><p>The first letter and each letter following an underscore (‘<samp>_</samp>’)
|
|
are uppercase, others are lowercase. For instance <code>My_vARIable</code>
|
|
is converted to <code>My_Variable</code>.
|
|
</p>
|
|
</dd>
|
|
<dt><span><code>ada-loose-case-word</code></span></dt>
|
|
<dd><p>Characters after an underscore ‘<samp>_</samp>’ character are uppercase,
|
|
others are not modified. For instance <code>My_vARIable</code> is converted
|
|
to <code>My_VARIable</code>.
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<p>Ada mode allows you to define exceptions to these rules, in a file
|
|
specified by the variable <code>ada-case-exception-file</code>
|
|
(default <samp>~/.emacs_case_exceptions</samp>). Each line in this file
|
|
specifies the casing of one word or word fragment. Comments may be
|
|
included, separated from the word by a space.
|
|
</p>
|
|
<p>If the word starts with an asterisk (‘<samp>*</samp>’), it defines the casing
|
|
as a word fragment (or “substring”); part of a word between two
|
|
underscores or word boundary.
|
|
</p>
|
|
<p>For example:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example">DOD Department of Defense
|
|
*IO
|
|
GNAT The GNAT compiler from Ada Core Technologies
|
|
</pre></div>
|
|
|
|
<p>The word fragment <code>*IO</code> applies to any word containing “_io”;
|
|
<code>Text_IO</code>, <code>Hardware_IO</code>, etc.
|
|
</p>
|
|
<span id="index-ada_002dcreate_002dcase_002dexception"></span>
|
|
<p>There are two ways to add new items to this file: you can simply edit
|
|
it as you would edit any text file. Or you can position point on the
|
|
word you want to add, and select menu ‘<samp>Ada | Edit | Create Case
|
|
Exception</samp>’, or press <kbd>C-c C-y</kbd> (<code>ada-create-case-exception</code>).
|
|
The word will automatically be added to the current list of exceptions
|
|
and to the file.
|
|
</p>
|
|
<p>To define a word fragment case exception, select the word fragment,
|
|
then select menu ‘<samp>Ada | Edit | Create Case Exception Substring</samp>’.
|
|
</p>
|
|
<p>It is sometimes useful to have multiple exception files around (for
|
|
instance, one could be the standard Ada acronyms, the second some
|
|
company specific exceptions, and the last one some project specific
|
|
exceptions). If you set up the variable <code>ada-case-exception-file</code>
|
|
as a list of files, each of them will be parsed and used in your emacs
|
|
session. However, when you save a new exception through the menu, as
|
|
described above, the new exception will be added to the first file in
|
|
the list.
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt id='index-ada_002dadjust_002dcase_002dbuffer'><span><kbd>C-c C-b</kbd><a href='#index-ada_002dadjust_002dcase_002dbuffer' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Adjust case in the whole buffer (<code>ada-adjust-case-buffer</code>).
|
|
</p></dd>
|
|
<dt><span><kbd>C-c C-y</kbd></span></dt>
|
|
<dd><p>Create a new entry in the exception dictionary, with the word under
|
|
the cursor (<code>ada-create-case-exception</code>)
|
|
</p></dd>
|
|
<dt id='index-ada_002dcase_002dread_002dexceptions'><span><kbd>C-c C-t</kbd><a href='#index-ada_002dcase_002dread_002dexceptions' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Rereads the exception dictionary from the file
|
|
<code>ada-case-exception-file</code> (<code>ada-case-read-exceptions</code>).
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Statement-Templates">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Comment-Handling" accesskey="n" rel="next">Comment Handling</a>, Previous: <a href="#Automatic-Casing" accesskey="p" rel="prev">Automatic Casing</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Statement-Templates-1"></span><h2 class="chapter">12 Statement Templates</h2>
|
|
|
|
<p>Templates are defined for most Ada statements, using the Emacs
|
|
“skeleton” package. They can be inserted in the buffer using the
|
|
following commands:
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt id='index-ada_002dexception_002dblock'><span><kbd>C-c t b</kbd><a href='#index-ada_002dexception_002dblock' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>exception Block (<code>ada-exception-block</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dcase'><span><kbd>C-c t c</kbd><a href='#index-ada_002dcase' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>case (<code>ada-case</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002ddeclare_002dblock'><span><kbd>C-c t d</kbd><a href='#index-ada_002ddeclare_002dblock' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>declare Block (<code>ada-declare-block</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002delse'><span><kbd>C-c t e</kbd><a href='#index-ada_002delse' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>else (<code>ada-else</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dfor_002dloop'><span><kbd>C-c t f</kbd><a href='#index-ada_002dfor_002dloop' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>for Loop (<code>ada-for-loop</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dheader'><span><kbd>C-c t h</kbd><a href='#index-ada_002dheader' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>Header (<code>ada-header</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dif'><span><kbd>C-c t i</kbd><a href='#index-ada_002dif' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>if (<code>ada-if</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dpackage_002dbody'><span><kbd>C-c t k</kbd><a href='#index-ada_002dpackage_002dbody' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>package Body (<code>ada-package-body</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dloop'><span><kbd>C-c t l</kbd><a href='#index-ada_002dloop' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>loop (<code>ada-loop</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dsubprogram_002dbody'><span><kbd>C-c p</kbd><a href='#index-ada_002dsubprogram_002dbody' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>subprogram body (<code>ada-subprogram-body</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dtask_002dbody'><span><kbd>C-c t t</kbd><a href='#index-ada_002dtask_002dbody' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>task Body (<code>ada-task-body</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dwhile'><span><kbd>C-c t w</kbd><a href='#index-ada_002dwhile' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>while Loop (<code>ada-while</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002duse'><span><kbd>C-c t u</kbd><a href='#index-ada_002duse' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>use (<code>ada-use</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dexit'><span><kbd>C-c t x</kbd><a href='#index-ada_002dexit' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>exit (<code>ada-exit</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002darray'><span><kbd>C-c t C-a</kbd><a href='#index-ada_002darray' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>array (<code>ada-array</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002delsif'><span><kbd>C-c t C-e</kbd><a href='#index-ada_002delsif' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>elsif (<code>ada-elsif</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dfunction_002dspec'><span><kbd>C-c t C-f</kbd><a href='#index-ada_002dfunction_002dspec' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>function Spec (<code>ada-function-spec</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dpackage_002dspec'><span><kbd>C-c t C-k</kbd><a href='#index-ada_002dpackage_002dspec' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>package Spec (<code>ada-package-spec</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dprocedure_002dspec'><span><kbd>C-c t C-p</kbd><a href='#index-ada_002dprocedure_002dspec' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>procedure Spec (<code>ada-package-spec</code>.
|
|
</p></dd>
|
|
<dt id='index-ada_002drecord'><span><kbd>C-c t C-r</kbd><a href='#index-ada_002drecord' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>record (<code>ada-record</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dsubtype'><span><kbd>C-c t C-s</kbd><a href='#index-ada_002dsubtype' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>subtype (<code>ada-subtype</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dtask_002dspec'><span><kbd>C-c t C-t</kbd><a href='#index-ada_002dtask_002dspec' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>task Spec (<code>ada-task-spec</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dwith'><span><kbd>C-c t C-u</kbd><a href='#index-ada_002dwith' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>with (<code>ada-with</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dprivate'><span><kbd>C-c t C-v</kbd><a href='#index-ada_002dprivate' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>private (<code>ada-private</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dwhen'><span><kbd>C-c t C-w</kbd><a href='#index-ada_002dwhen' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>when (<code>ada-when</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dexception'><span><kbd>C-c t C-x</kbd><a href='#index-ada_002dexception' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>exception (<code>ada-exception</code>).
|
|
</p></dd>
|
|
<dt id='index-ada_002dtype'><span><kbd>C-c t C-y</kbd><a href='#index-ada_002dtype' class='copiable-anchor'> ¶</a></span></dt>
|
|
<dd><p>type (<code>ada-type</code>).
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="chapter" id="Comment-Handling">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="#Statement-Templates" accesskey="p" rel="prev">Statement Templates</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Comment-Handling-1"></span><h2 class="chapter">13 Comment Handling</h2>
|
|
|
|
<p>By default, comment lines get indented like Ada code. There are a few
|
|
additional functions to handle comments:
|
|
</p>
|
|
<dl compact="compact">
|
|
<dt><span><kbd>M-;</kbd></span></dt>
|
|
<dd><p>Start a comment in default column.
|
|
</p></dd>
|
|
<dt><span><kbd>M-j</kbd></span></dt>
|
|
<dd><p>Continue comment on next line.
|
|
</p></dd>
|
|
<dt><span><kbd>C-c ;</kbd></span></dt>
|
|
<dd><p>Comment the selected region (add ‘<samp>--</samp>’ at the beginning of lines).
|
|
</p></dd>
|
|
<dt><span><kbd>C-c :</kbd></span></dt>
|
|
<dd><p>Uncomment the selected region
|
|
</p></dd>
|
|
<dt><span><kbd>M-q</kbd></span></dt>
|
|
<dd><p>autofill the current comment.
|
|
</p></dd>
|
|
</dl>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="appendix" id="GNU-Free-Documentation-License">
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Comment-Handling" accesskey="p" rel="prev">Comment Handling</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="GNU-Free-Documentation-License-1"></span><h2 class="appendix">Appendix A GNU Free Documentation License</h2>
|
|
<div align="center">Version 1.3, 3 November 2008
|
|
</div>
|
|
|
|
<div class="display">
|
|
<pre class="display">Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
|
|
<a href="https://fsf.org/">https://fsf.org/</a>
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies
|
|
of this license document, but changing it is not allowed.
|
|
</pre></div>
|
|
|
|
<ol start="0">
|
|
<li> PREAMBLE
|
|
|
|
<p>The purpose of this License is to make a manual, textbook, or other
|
|
functional and useful document <em>free</em> in the sense of freedom: to
|
|
assure everyone the effective freedom to copy and redistribute it,
|
|
with or without modifying it, either commercially or noncommercially.
|
|
Secondarily, this License preserves for the author and publisher a way
|
|
to get credit for their work, while not being considered responsible
|
|
for modifications made by others.
|
|
</p>
|
|
<p>This License is a kind of “copyleft”, which means that derivative
|
|
works of the document must themselves be free in the same sense. It
|
|
complements the GNU General Public License, which is a copyleft
|
|
license designed for free software.
|
|
</p>
|
|
<p>We have designed this License in order to use it for manuals for free
|
|
software, because free software needs free documentation: a free
|
|
program should come with manuals providing the same freedoms that the
|
|
software does. But this License is not limited to software manuals;
|
|
it can be used for any textual work, regardless of subject matter or
|
|
whether it is published as a printed book. We recommend this License
|
|
principally for works whose purpose is instruction or reference.
|
|
</p>
|
|
</li><li> APPLICABILITY AND DEFINITIONS
|
|
|
|
<p>This License applies to any manual or other work, in any medium, that
|
|
contains a notice placed by the copyright holder saying it can be
|
|
distributed under the terms of this License. Such a notice grants a
|
|
world-wide, royalty-free license, unlimited in duration, to use that
|
|
work under the conditions stated herein. The “Document”, below,
|
|
refers to any such manual or work. Any member of the public is a
|
|
licensee, and is addressed as “you”. You accept the license if you
|
|
copy, modify or distribute the work in a way requiring permission
|
|
under copyright law.
|
|
</p>
|
|
<p>A “Modified Version” of the Document means any work containing the
|
|
Document or a portion of it, either copied verbatim, or with
|
|
modifications and/or translated into another language.
|
|
</p>
|
|
<p>A “Secondary Section” is a named appendix or a front-matter section
|
|
of the Document that deals exclusively with the relationship of the
|
|
publishers or authors of the Document to the Document’s overall
|
|
subject (or to related matters) and contains nothing that could fall
|
|
directly within that overall subject. (Thus, if the Document is in
|
|
part a textbook of mathematics, a Secondary Section may not explain
|
|
any mathematics.) The relationship could be a matter of historical
|
|
connection with the subject or with related matters, or of legal,
|
|
commercial, philosophical, ethical or political position regarding
|
|
them.
|
|
</p>
|
|
<p>The “Invariant Sections” are certain Secondary Sections whose titles
|
|
are designated, as being those of Invariant Sections, in the notice
|
|
that says that the Document is released under this License. If a
|
|
section does not fit the above definition of Secondary then it is not
|
|
allowed to be designated as Invariant. The Document may contain zero
|
|
Invariant Sections. If the Document does not identify any Invariant
|
|
Sections then there are none.
|
|
</p>
|
|
<p>The “Cover Texts” are certain short passages of text that are listed,
|
|
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
|
|
the Document is released under this License. A Front-Cover Text may
|
|
be at most 5 words, and a Back-Cover Text may be at most 25 words.
|
|
</p>
|
|
<p>A “Transparent” copy of the Document means a machine-readable copy,
|
|
represented in a format whose specification is available to the
|
|
general public, that is suitable for revising the document
|
|
straightforwardly with generic text editors or (for images composed of
|
|
pixels) generic paint programs or (for drawings) some widely available
|
|
drawing editor, and that is suitable for input to text formatters or
|
|
for automatic translation to a variety of formats suitable for input
|
|
to text formatters. A copy made in an otherwise Transparent file
|
|
format whose markup, or absence of markup, has been arranged to thwart
|
|
or discourage subsequent modification by readers is not Transparent.
|
|
An image format is not Transparent if used for any substantial amount
|
|
of text. A copy that is not “Transparent” is called “Opaque”.
|
|
</p>
|
|
<p>Examples of suitable formats for Transparent copies include plain
|
|
ASCII without markup, Texinfo input format, LaTeX input
|
|
format, SGML or XML using a publicly available
|
|
DTD, and standard-conforming simple HTML,
|
|
PostScript or PDF designed for human modification. Examples
|
|
of transparent image formats include PNG, XCF and
|
|
JPG. Opaque formats include proprietary formats that can be
|
|
read and edited only by proprietary word processors, SGML or
|
|
XML for which the DTD and/or processing tools are
|
|
not generally available, and the machine-generated HTML,
|
|
PostScript or PDF produced by some word processors for
|
|
output purposes only.
|
|
</p>
|
|
<p>The “Title Page” means, for a printed book, the title page itself,
|
|
plus such following pages as are needed to hold, legibly, the material
|
|
this License requires to appear in the title page. For works in
|
|
formats which do not have any title page as such, “Title Page” means
|
|
the text near the most prominent appearance of the work’s title,
|
|
preceding the beginning of the body of the text.
|
|
</p>
|
|
<p>The “publisher” means any person or entity that distributes copies
|
|
of the Document to the public.
|
|
</p>
|
|
<p>A section “Entitled XYZ” means a named subunit of the Document whose
|
|
title either is precisely XYZ or contains XYZ in parentheses following
|
|
text that translates XYZ in another language. (Here XYZ stands for a
|
|
specific section name mentioned below, such as “Acknowledgements”,
|
|
“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title”
|
|
of such a section when you modify the Document means that it remains a
|
|
section “Entitled XYZ” according to this definition.
|
|
</p>
|
|
<p>The Document may include Warranty Disclaimers next to the notice which
|
|
states that this License applies to the Document. These Warranty
|
|
Disclaimers are considered to be included by reference in this
|
|
License, but only as regards disclaiming warranties: any other
|
|
implication that these Warranty Disclaimers may have is void and has
|
|
no effect on the meaning of this License.
|
|
</p>
|
|
</li><li> VERBATIM COPYING
|
|
|
|
<p>You may copy and distribute the Document in any medium, either
|
|
commercially or noncommercially, provided that this License, the
|
|
copyright notices, and the license notice saying this License applies
|
|
to the Document are reproduced in all copies, and that you add no other
|
|
conditions whatsoever to those of this License. You may not use
|
|
technical measures to obstruct or control the reading or further
|
|
copying of the copies you make or distribute. However, you may accept
|
|
compensation in exchange for copies. If you distribute a large enough
|
|
number of copies you must also follow the conditions in section 3.
|
|
</p>
|
|
<p>You may also lend copies, under the same conditions stated above, and
|
|
you may publicly display copies.
|
|
</p>
|
|
</li><li> COPYING IN QUANTITY
|
|
|
|
<p>If you publish printed copies (or copies in media that commonly have
|
|
printed covers) of the Document, numbering more than 100, and the
|
|
Document’s license notice requires Cover Texts, you must enclose the
|
|
copies in covers that carry, clearly and legibly, all these Cover
|
|
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
|
|
the back cover. Both covers must also clearly and legibly identify
|
|
you as the publisher of these copies. The front cover must present
|
|
the full title with all words of the title equally prominent and
|
|
visible. You may add other material on the covers in addition.
|
|
Copying with changes limited to the covers, as long as they preserve
|
|
the title of the Document and satisfy these conditions, can be treated
|
|
as verbatim copying in other respects.
|
|
</p>
|
|
<p>If the required texts for either cover are too voluminous to fit
|
|
legibly, you should put the first ones listed (as many as fit
|
|
reasonably) on the actual cover, and continue the rest onto adjacent
|
|
pages.
|
|
</p>
|
|
<p>If you publish or distribute Opaque copies of the Document numbering
|
|
more than 100, you must either include a machine-readable Transparent
|
|
copy along with each Opaque copy, or state in or with each Opaque copy
|
|
a computer-network location from which the general network-using
|
|
public has access to download using public-standard network protocols
|
|
a complete Transparent copy of the Document, free of added material.
|
|
If you use the latter option, you must take reasonably prudent steps,
|
|
when you begin distribution of Opaque copies in quantity, to ensure
|
|
that this Transparent copy will remain thus accessible at the stated
|
|
location until at least one year after the last time you distribute an
|
|
Opaque copy (directly or through your agents or retailers) of that
|
|
edition to the public.
|
|
</p>
|
|
<p>It is requested, but not required, that you contact the authors of the
|
|
Document well before redistributing any large number of copies, to give
|
|
them a chance to provide you with an updated version of the Document.
|
|
</p>
|
|
</li><li> MODIFICATIONS
|
|
|
|
<p>You may copy and distribute a Modified Version of the Document under
|
|
the conditions of sections 2 and 3 above, provided that you release
|
|
the Modified Version under precisely this License, with the Modified
|
|
Version filling the role of the Document, thus licensing distribution
|
|
and modification of the Modified Version to whoever possesses a copy
|
|
of it. In addition, you must do these things in the Modified Version:
|
|
</p>
|
|
<ol type="A" start="1">
|
|
<li> Use in the Title Page (and on the covers, if any) a title distinct
|
|
from that of the Document, and from those of previous versions
|
|
(which should, if there were any, be listed in the History section
|
|
of the Document). You may use the same title as a previous version
|
|
if the original publisher of that version gives permission.
|
|
|
|
</li><li> List on the Title Page, as authors, one or more persons or entities
|
|
responsible for authorship of the modifications in the Modified
|
|
Version, together with at least five of the principal authors of the
|
|
Document (all of its principal authors, if it has fewer than five),
|
|
unless they release you from this requirement.
|
|
|
|
</li><li> State on the Title page the name of the publisher of the
|
|
Modified Version, as the publisher.
|
|
|
|
</li><li> Preserve all the copyright notices of the Document.
|
|
|
|
</li><li> Add an appropriate copyright notice for your modifications
|
|
adjacent to the other copyright notices.
|
|
|
|
</li><li> Include, immediately after the copyright notices, a license notice
|
|
giving the public permission to use the Modified Version under the
|
|
terms of this License, in the form shown in the Addendum below.
|
|
|
|
</li><li> Preserve in that license notice the full lists of Invariant Sections
|
|
and required Cover Texts given in the Document’s license notice.
|
|
|
|
</li><li> Include an unaltered copy of this License.
|
|
|
|
</li><li> Preserve the section Entitled “History”, Preserve its Title, and add
|
|
to it an item stating at least the title, year, new authors, and
|
|
publisher of the Modified Version as given on the Title Page. If
|
|
there is no section Entitled “History” in the Document, create one
|
|
stating the title, year, authors, and publisher of the Document as
|
|
given on its Title Page, then add an item describing the Modified
|
|
Version as stated in the previous sentence.
|
|
|
|
</li><li> Preserve the network location, if any, given in the Document for
|
|
public access to a Transparent copy of the Document, and likewise
|
|
the network locations given in the Document for previous versions
|
|
it was based on. These may be placed in the “History” section.
|
|
You may omit a network location for a work that was published at
|
|
least four years before the Document itself, or if the original
|
|
publisher of the version it refers to gives permission.
|
|
|
|
</li><li> For any section Entitled “Acknowledgements” or “Dedications”, Preserve
|
|
the Title of the section, and preserve in the section all the
|
|
substance and tone of each of the contributor acknowledgements and/or
|
|
dedications given therein.
|
|
|
|
</li><li> Preserve all the Invariant Sections of the Document,
|
|
unaltered in their text and in their titles. Section numbers
|
|
or the equivalent are not considered part of the section titles.
|
|
|
|
</li><li> Delete any section Entitled “Endorsements”. Such a section
|
|
may not be included in the Modified Version.
|
|
|
|
</li><li> Do not retitle any existing section to be Entitled “Endorsements” or
|
|
to conflict in title with any Invariant Section.
|
|
|
|
</li><li> Preserve any Warranty Disclaimers.
|
|
</li></ol>
|
|
|
|
<p>If the Modified Version includes new front-matter sections or
|
|
appendices that qualify as Secondary Sections and contain no material
|
|
copied from the Document, you may at your option designate some or all
|
|
of these sections as invariant. To do this, add their titles to the
|
|
list of Invariant Sections in the Modified Version’s license notice.
|
|
These titles must be distinct from any other section titles.
|
|
</p>
|
|
<p>You may add a section Entitled “Endorsements”, provided it contains
|
|
nothing but endorsements of your Modified Version by various
|
|
parties—for example, statements of peer review or that the text has
|
|
been approved by an organization as the authoritative definition of a
|
|
standard.
|
|
</p>
|
|
<p>You may add a passage of up to five words as a Front-Cover Text, and a
|
|
passage of up to 25 words as a Back-Cover Text, to the end of the list
|
|
of Cover Texts in the Modified Version. Only one passage of
|
|
Front-Cover Text and one of Back-Cover Text may be added by (or
|
|
through arrangements made by) any one entity. If the Document already
|
|
includes a cover text for the same cover, previously added by you or
|
|
by arrangement made by the same entity you are acting on behalf of,
|
|
you may not add another; but you may replace the old one, on explicit
|
|
permission from the previous publisher that added the old one.
|
|
</p>
|
|
<p>The author(s) and publisher(s) of the Document do not by this License
|
|
give permission to use their names for publicity for or to assert or
|
|
imply endorsement of any Modified Version.
|
|
</p>
|
|
</li><li> COMBINING DOCUMENTS
|
|
|
|
<p>You may combine the Document with other documents released under this
|
|
License, under the terms defined in section 4 above for modified
|
|
versions, provided that you include in the combination all of the
|
|
Invariant Sections of all of the original documents, unmodified, and
|
|
list them all as Invariant Sections of your combined work in its
|
|
license notice, and that you preserve all their Warranty Disclaimers.
|
|
</p>
|
|
<p>The combined work need only contain one copy of this License, and
|
|
multiple identical Invariant Sections may be replaced with a single
|
|
copy. If there are multiple Invariant Sections with the same name but
|
|
different contents, make the title of each such section unique by
|
|
adding at the end of it, in parentheses, the name of the original
|
|
author or publisher of that section if known, or else a unique number.
|
|
Make the same adjustment to the section titles in the list of
|
|
Invariant Sections in the license notice of the combined work.
|
|
</p>
|
|
<p>In the combination, you must combine any sections Entitled “History”
|
|
in the various original documents, forming one section Entitled
|
|
“History”; likewise combine any sections Entitled “Acknowledgements”,
|
|
and any sections Entitled “Dedications”. You must delete all
|
|
sections Entitled “Endorsements.”
|
|
</p>
|
|
</li><li> COLLECTIONS OF DOCUMENTS
|
|
|
|
<p>You may make a collection consisting of the Document and other documents
|
|
released under this License, and replace the individual copies of this
|
|
License in the various documents with a single copy that is included in
|
|
the collection, provided that you follow the rules of this License for
|
|
verbatim copying of each of the documents in all other respects.
|
|
</p>
|
|
<p>You may extract a single document from such a collection, and distribute
|
|
it individually under this License, provided you insert a copy of this
|
|
License into the extracted document, and follow this License in all
|
|
other respects regarding verbatim copying of that document.
|
|
</p>
|
|
</li><li> AGGREGATION WITH INDEPENDENT WORKS
|
|
|
|
<p>A compilation of the Document or its derivatives with other separate
|
|
and independent documents or works, in or on a volume of a storage or
|
|
distribution medium, is called an “aggregate” if the copyright
|
|
resulting from the compilation is not used to limit the legal rights
|
|
of the compilation’s users beyond what the individual works permit.
|
|
When the Document is included in an aggregate, this License does not
|
|
apply to the other works in the aggregate which are not themselves
|
|
derivative works of the Document.
|
|
</p>
|
|
<p>If the Cover Text requirement of section 3 is applicable to these
|
|
copies of the Document, then if the Document is less than one half of
|
|
the entire aggregate, the Document’s Cover Texts may be placed on
|
|
covers that bracket the Document within the aggregate, or the
|
|
electronic equivalent of covers if the Document is in electronic form.
|
|
Otherwise they must appear on printed covers that bracket the whole
|
|
aggregate.
|
|
</p>
|
|
</li><li> TRANSLATION
|
|
|
|
<p>Translation is considered a kind of modification, so you may
|
|
distribute translations of the Document under the terms of section 4.
|
|
Replacing Invariant Sections with translations requires special
|
|
permission from their copyright holders, but you may include
|
|
translations of some or all Invariant Sections in addition to the
|
|
original versions of these Invariant Sections. You may include a
|
|
translation of this License, and all the license notices in the
|
|
Document, and any Warranty Disclaimers, provided that you also include
|
|
the original English version of this License and the original versions
|
|
of those notices and disclaimers. In case of a disagreement between
|
|
the translation and the original version of this License or a notice
|
|
or disclaimer, the original version will prevail.
|
|
</p>
|
|
<p>If a section in the Document is Entitled “Acknowledgements”,
|
|
“Dedications”, or “History”, the requirement (section 4) to Preserve
|
|
its Title (section 1) will typically require changing the actual
|
|
title.
|
|
</p>
|
|
</li><li> TERMINATION
|
|
|
|
<p>You may not copy, modify, sublicense, or distribute the Document
|
|
except as expressly provided under this License. Any attempt
|
|
otherwise to copy, modify, sublicense, or distribute it is void, and
|
|
will automatically terminate your rights under this License.
|
|
</p>
|
|
<p>However, if you cease all violation of this License, then your license
|
|
from a particular copyright holder is reinstated (a) provisionally,
|
|
unless and until the copyright holder explicitly and finally
|
|
terminates your license, and (b) permanently, if the copyright holder
|
|
fails to notify you of the violation by some reasonable means prior to
|
|
60 days after the cessation.
|
|
</p>
|
|
<p>Moreover, your license from a particular copyright holder is
|
|
reinstated permanently if the copyright holder notifies you of the
|
|
violation by some reasonable means, this is the first time you have
|
|
received notice of violation of this License (for any work) from that
|
|
copyright holder, and you cure the violation prior to 30 days after
|
|
your receipt of the notice.
|
|
</p>
|
|
<p>Termination of your rights under this section does not terminate the
|
|
licenses of parties who have received copies or rights from you under
|
|
this License. If your rights have been terminated and not permanently
|
|
reinstated, receipt of a copy of some or all of the same material does
|
|
not give you any rights to use it.
|
|
</p>
|
|
</li><li> FUTURE REVISIONS OF THIS LICENSE
|
|
|
|
<p>The Free Software Foundation may publish new, revised versions
|
|
of the GNU Free Documentation License from time to time. Such new
|
|
versions will be similar in spirit to the present version, but may
|
|
differ in detail to address new problems or concerns. See
|
|
<a href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
|
|
</p>
|
|
<p>Each version of the License is given a distinguishing version number.
|
|
If the Document specifies that a particular numbered version of this
|
|
License “or any later version” applies to it, you have the option of
|
|
following the terms and conditions either of that specified version or
|
|
of any later version that has been published (not as a draft) by the
|
|
Free Software Foundation. If the Document does not specify a version
|
|
number of this License, you may choose any version ever published (not
|
|
as a draft) by the Free Software Foundation. If the Document
|
|
specifies that a proxy can decide which future versions of this
|
|
License can be used, that proxy’s public statement of acceptance of a
|
|
version permanently authorizes you to choose that version for the
|
|
Document.
|
|
</p>
|
|
</li><li> RELICENSING
|
|
|
|
<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
|
|
World Wide Web server that publishes copyrightable works and also
|
|
provides prominent facilities for anybody to edit those works. A
|
|
public wiki that anybody can edit is an example of such a server. A
|
|
“Massive Multiauthor Collaboration” (or “MMC”) contained in the
|
|
site means any set of copyrightable works thus published on the MMC
|
|
site.
|
|
</p>
|
|
<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
|
|
license published by Creative Commons Corporation, a not-for-profit
|
|
corporation with a principal place of business in San Francisco,
|
|
California, as well as future copyleft versions of that license
|
|
published by that same organization.
|
|
</p>
|
|
<p>“Incorporate” means to publish or republish a Document, in whole or
|
|
in part, as part of another Document.
|
|
</p>
|
|
<p>An MMC is “eligible for relicensing” if it is licensed under this
|
|
License, and if all works that were first published under this License
|
|
somewhere other than this MMC, and subsequently incorporated in whole
|
|
or in part into the MMC, (1) had no cover texts or invariant sections,
|
|
and (2) were thus incorporated prior to November 1, 2008.
|
|
</p>
|
|
<p>The operator of an MMC Site may republish an MMC contained in the site
|
|
under CC-BY-SA on the same site at any time before August 1, 2009,
|
|
provided the MMC is eligible for relicensing.
|
|
</p>
|
|
</li></ol>
|
|
|
|
<span id="ADDENDUM_003a-How-to-use-this-License-for-your-documents"></span><h3 class="heading">ADDENDUM: How to use this License for your documents</h3>
|
|
|
|
<p>To use this License in a document you have written, include a copy of
|
|
the License in the document and put the following copyright and
|
|
license notices just after the title page:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example"> Copyright (C) <var>year</var> <var>your name</var>.
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3
|
|
or any later version published by the Free Software Foundation;
|
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
|
|
Texts. A copy of the license is included in the section entitled ``GNU
|
|
Free Documentation License''.
|
|
</pre></div>
|
|
|
|
<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
|
|
replace the “with…Texts.” line with this:
|
|
</p>
|
|
<div class="example">
|
|
<pre class="example"> with the Invariant Sections being <var>list their titles</var>, with
|
|
the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
|
|
being <var>list</var>.
|
|
</pre></div>
|
|
|
|
<p>If you have Invariant Sections without Cover Texts, or some other
|
|
combination of the three, merge those two alternatives to suit the
|
|
situation.
|
|
</p>
|
|
<p>If your document contains nontrivial examples of program code, we
|
|
recommend releasing these examples in parallel under your choice of
|
|
free software license, such as the GNU General Public License,
|
|
to permit their use in free software.
|
|
</p>
|
|
|
|
<hr>
|
|
</div>
|
|
<div class="unnumbered" id="Index">
|
|
<div class="header">
|
|
<p>
|
|
Previous: <a href="#GNU-Free-Documentation-License" accesskey="p" rel="prev">GNU Free Documentation License</a>, Up: <a href="#Top" accesskey="u" rel="up">Ada Mode</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
|
|
</div>
|
|
<span id="Index-1"></span><h2 class="unnumbered">Index</h2>
|
|
|
|
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_fn_letter-A"><b>A</b></a>
|
|
|
|
</td></tr></table>
|
|
<table class="index-fn" border="0">
|
|
<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr>
|
|
<tr><td colspan="4"> <hr></td></tr>
|
|
<tr><th id="Index_fn_letter-A">A</th><td></td><td></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dadjust_002dcase_002dbuffer"><code>ada-adjust-case-buffer</code></a>:</td><td> </td><td valign="top"><a href="#Automatic-Casing">Automatic Casing</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002darray"><code>ada-array</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dcase"><code>ada-case</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dcase_002dread_002dexceptions"><code>ada-case-read-exceptions</code></a>:</td><td> </td><td valign="top"><a href="#Automatic-Casing">Automatic Casing</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dcomplete_002didentifier"><code>ada-complete-identifier</code></a>:</td><td> </td><td valign="top"><a href="#Identifier-completion">Identifier completion</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dcreate_002dcase_002dexception"><code>ada-create-case-exception</code></a>:</td><td> </td><td valign="top"><a href="#Automatic-Casing">Automatic Casing</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002ddeclare_002dblock"><code>ada-declare-block</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002delse"><code>ada-else</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002delsif"><code>ada-elsif</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dexception"><code>ada-exception</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dexception_002dblock"><code>ada-exception-block</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dexit"><code>ada-exit</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dfind_002dreferences"><code>ada-find-references</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dfor_002dloop"><code>ada-for-loop</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dformat_002dparamlist"><code>ada-format-paramlist</code></a>:</td><td> </td><td valign="top"><a href="#Formatting-Parameter-Lists">Formatting Parameter Lists</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dfunction_002dspec"><code>ada-function-spec</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dgoto_002ddeclaration"><code>ada-goto-declaration</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dheader"><code>ada-header</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dif"><code>ada-if</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dloop"><code>ada-loop</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dmove_002dto_002dend"><code>ada-move-to-end</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dmove_002dto_002dstart"><code>ada-move-to-start</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dnext_002dpackage"><code>ada-next-package</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dnext_002dprocedure"><code>ada-next-procedure</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dpackage_002dbody"><code>ada-package-body</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dpackage_002dspec"><code>ada-package-spec</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dprevious_002dpackage"><code>ada-previous-package</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dprevious_002dprocedure"><code>ada-previous-procedure</code></a>:</td><td> </td><td valign="top"><a href="#Moving-Through-Ada-Code">Moving Through Ada Code</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dprivate"><code>ada-private</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dprocedure_002dspec"><code>ada-procedure-spec</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002drecord"><code>ada-record</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dsubprogram_002dbody"><code>ada-subprogram-body</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dsubtype"><code>ada-subtype</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dtask_002dbody"><code>ada-task-body</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dtask_002dspec"><code>ada-task-spec</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dtype"><code>ada-type</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002duse"><code>ada-use</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dwhen"><code>ada-when</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dwhile"><code>ada-while</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td></td><td valign="top"><a href="#index-ada_002dwith"><code>ada-with</code></a>:</td><td> </td><td valign="top"><a href="#Statement-Templates">Statement Templates</a></td></tr>
|
|
<tr><td colspan="4"> <hr></td></tr>
|
|
</table>
|
|
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Index_fn_letter-A"><b>A</b></a>
|
|
|
|
</td></tr></table>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|