1 This is ada-mode.info, produced by makeinfo version 5.2 from
4 Copyright (C) 1999 - 2014 Free Software Foundation, Inc.
6 Permission is granted to copy, distribute and/or modify this
7 document under the terms of the GNU Free Documentation License,
8 Version 1.3 or any later version published by the Free Software
9 Foundation; with no Invariant Sections, with the Front-Cover texts
10 being "A GNU Manual", and with the Back-Cover Texts as in (a)
11 below. A copy of the license is included in the section entitled
12 "GNU Free Documentation License".
14 (a) The FSF's Back-Cover Text is: "You have the freedom to copy and
15 modify this GNU manual. Buying copies from the FSF supports it in
16 developing GNU and promoting software freedom."
17 INFO-DIR-SECTION Emacs editing modes
19 * Ada mode: (ada-mode). Emacs mode for editing and navigating Ada code.
23 File: ada-mode.info, Node: Top, Next: Overview, Prev: (dir), Up: (dir)
25 Copyright (C) 1999 - 2014 Free Software Foundation, Inc.
27 Permission is granted to copy, distribute and/or modify this
28 document under the terms of the GNU Free Documentation License,
29 Version 1.3 or any later version published by the Free Software
30 Foundation; with no Invariant Sections, with the Front-Cover texts
31 being "A GNU Manual", and with the Back-Cover Texts as in (a)
32 below. A copy of the license is included in the section entitled
33 "GNU Free Documentation License".
35 (a) The FSF's Back-Cover Text is: "You have the freedom to copy and
36 modify this GNU manual. Buying copies from the FSF supports it in
37 developing GNU and promoting software freedom."
42 * Installation:: Installing Ada mode on your system
43 * Customization:: Setting up Ada mode to your taste
44 * Compiling Executing:: Working with your application within Emacs
45 * Project files:: Describing the organization of your project
46 * Moving Through Ada Code:: Moving easily through Ada sources
47 * Identifier completion:: Finishing words automatically
48 * Indentation:: Indenting your code automatically as you type
49 * Statement skeletons:: Some code is written for you
50 * Aligning code:: Making it pretty
51 * Automatic casing:: Adjusting the case of words automatically
52 * Comment Handling:: Reformatting comments easily
54 * Developer overview::
55 * GNU Free Documentation License::
59 File: ada-mode.info, Node: Overview, Next: Installation, Prev: Top, Up: Top
64 The Emacs mode for programming in Ada helps the user in reading existing
65 code and facilitates developing new code.
67 Cross-reference information output by the compiler is used to provide
68 powerful code navigation (jump to definition, find all uses, etc).
70 When you open a file with a file extension of '.ads' or '.adb', Emacs
71 will automatically load and activate Ada mode.
73 Ada mode works without any customization, if you are using the GNAT
74 compiler (<https://libre2.adacore.com/>) and the GNAT default naming
77 You must customize a few things if you are using a different file
78 naming convention or compiler; *Note Non-standard file names::, *Note
81 In addition, you may want to customize the indentation,
82 capitalization, and other things; *Note Other customization::.
84 Finally, for large Ada projects, you will want to set up an Emacs Ada
85 mode project file for each project; *Note Project files::. Note that
86 these are different from the GNAT project files used by the GNAT tools.
88 *Note Debuggers: (emacs)Debuggers, for general information on
92 File: ada-mode.info, Node: Installation, Next: Customization, Prev: Overview, Up: Top
97 Ada mode requires Emacs 24.2 or greater; it also requires the Emacs lisp
98 sources (not just the compiled binaries).
100 Ada mode is distributed in the Gnu ELPA package archive; it can be
101 installed via 'M-x list-packages' (*note (emacs)Packages::). You must
102 first enable packages in your '~/.emacs', _after_ customizing
103 'Info-default-directory-list' (if you do that):
107 Ada mode is also available as a separate distribution, from the Emacs
109 <http://stephe-leake.org/emacs/ada-mode/emacs-ada-mode.html>.
111 For installing the separate distribution, see the 'README' file in
114 To see what version of Ada mode you have installed, invoke 'M-x
123 File: ada-mode.info, Node: gnatinspect, Next: Upgrading, Prev: Installation, Up: Installation
128 Ada mode has experimental support for the new AdaCore cross reference
129 tool 'gnatinspect', which supports Ada, C, C++, and any other language
130 for which gcc provices the '-fdump-xref'.
132 'gnatinspect' is distributed as part of 'gnatcoll'. Ada mode
133 requires the very latest version, in 'gnatcoll 1.7w' distributed with
136 To build 'gnatinspect', assuming GNAT GPL 2014 is installed in
137 '/usr/gnat-gpl-2014', and '/usr/gnat-gpl-2014/bin' is in PATH:
139 tar xf ~/Downloads/gnatcoll-1.7x-src.tgz
141 ./configure --prefix=/usr/gnat-gpl-2014
142 make Gnatcoll_Build=Debug
143 sudo make Gnatcoll_Build=Debug install
145 To build an sqlite3 executable that is compatible with the database
146 created by gnatinspect:
148 cd gnatcoll-1.7w-src/src/sqlite/amalgamation/
149 gcc -O2 -o sqlite3 shell.c sqlite3.c -ldl -lpthread
152 File: ada-mode.info, Node: Upgrading, Prev: gnatinspect, Up: Installation
154 2.2 Upgrading from previous versions
155 ====================================
157 See the file NEWS for more details; here we summarize only important
158 user interface changes.
164 There are many user interface and API changes between 4.01 and
165 5.0.1; we only document those that may be hard to diagnose here.
167 'prog-mode-hook' is no longer run by 'ada-mode'; 'ada-mode' is no
168 longer derived from 'prog-mode'. Use 'ada-mode-hook' instead.
171 File: ada-mode.info, Node: Customization, Next: Compiling Executing, Prev: Installation, Up: Top
173 3 Customizing Ada mode
174 **********************
176 Here we assume you are familiar with setting variables in Emacs, either
177 thru 'customize' or in elisp (in your '.emacs' file). For a basic
178 introduction to customize, elisp, and Emacs in general, see the tutorial
183 * Non-standard file names::
185 * Other cross-reference::
186 * Other customization::
189 File: ada-mode.info, Node: Non-standard file names, Next: Other compiler, Prev: Customization, Up: Customization
191 3.1 Non-standard file names
192 ===========================
194 By default, Ada mode is configured to use the GNAT file naming
195 convention, where file names are a simple modification of the Ada names,
196 and the extension for specs and bodies are '.ads' and '.adb',
199 Emacs uses the file extension to enable Ada mode; Ada mode uses the
200 file extentions to allow moving from a package body to the corresponding
203 Emacs and Ada mode support ways to use alternative file extensions
204 for specs and bodies. Note that you must also tell the compiler about
205 these extensions; doing that is beyond the scope of this manual.
207 For instance, if your spec and bodies files are called 'UNIT_s.ada'
208 and 'UNIT_b.ada', respectively, you can add the following to your
211 ;; Tell Ada mode about spec and body extensions
212 (ada-add-extensions "_s.ada" "_b.ada")
214 ;; Tell Emacs to use Ada mode for those extensions
215 (add-to-list 'auto-mode-alist '("\\.ada\\'" . ada-mode))
217 You can define additional extensions:
219 (ada-add-extensions ".ads" "_b.ada")
220 (ada-add-extensions ".ads" ".body")
222 This means that whenever Ada mode looks for the body for a file whose
223 extension is '.ads', it will take the first available file that ends
224 with either '.adb', '_b.ada' or '.body'.
226 Simililarly, if Ada mode is looking for a spec, it will look for
229 If the filename excluding the extension is not derived from the Ada
230 name following the GNAT convention, you need to provide an alternate
231 function for 'ada-file-name-from-ada-name'. Doing that is beyond the
232 scope of this manual; see the current definitions in 'ada-mode.el' and
233 'ada-gnat-xref.el' for examples.
236 File: ada-mode.info, Node: Other compiler, Next: Other cross-reference, Prev: Non-standard file names, Up: Customization
241 The project variable 'ada_compiler' (default elisp variable
242 'ada-compiler') is used to index several variables that point to the
243 compiler-specific functions for corresponding Ada mode operations.
245 To use a compiler other than GNAT, you must write Emacs lisp code
246 that provides the interface to the compiler, and set 'ada-compiler' and
247 the indirection variables.
249 See 'ada-gnat-compile.el' for an example.
252 File: ada-mode.info, Node: Other cross-reference, Next: Other customization, Prev: Other compiler, Up: Customization
254 3.3 Other cross-reference
255 =========================
257 The project variable 'ada_xref' (default elisp variable 'ada-xref-tool')
258 is used to index several variables that point to the
259 cross-reference-tool-specific functions for corresponding Ada mode
262 To use a cross reference tool other than gnatxref, you must write
263 Emacs lisp code that provides the interface to the compiler, and set
264 'ada-xref-tool' and the indirection variables. This has already been
265 done for 'gnatinspect'; set 'ada-xref-tool' to ''gnat_inspect'.
267 See 'ada-gnat-xref.el' and 'gnat-inspect.el' for examples.
270 File: ada-mode.info, Node: Other customization, Prev: Other cross-reference, Up: Customization
272 3.4 Other customization
273 =======================
275 All user-settable Ada mode variables can be set via the menu 'Ada |
276 Customize'. Click on the 'Help' button there for help on using
279 To modify a specific variable, you can directly call the function
280 'customize-variable'; just type 'M-x customize-variable <RET>
281 VARIABLE-NAME <RET>').
283 Alternately, you can specify variable settings in the Emacs
284 configuration file, '~/.emacs'. This file is coded in Emacs lisp, and
285 the syntax to set a variable is the following:
286 (setq variable-name value)
288 Some general Emacs settings that are useful for Ada files:
289 'delete-trailing-whitespace'
290 Deletes space, tab at end of line and blank lines at end of buffer.
292 Deletes tab characters that have crept into the file.
294 Don't insert tab characters when indenting.
296 Updates the copyright date in the file header comment, to the
299 Insert a matching right paren when you type a left paren.
301 Bind 'hippie-expand' to a key; it expands the word before point,
302 using words from current buffer, other buffers, file names, etc;
303 see 'hippie-expand-try-functions-list'. You can also add
304 'ada-skel-hippie-try' to that list. Note that 'ada-expand', which
305 defaults to 'ada-skel-expand', is bound to <C-c C-e> (*note
306 Statement skeletons::).
310 The above can all be set by the following code in your '~/.emacs'.
311 Note that some are functions are added to 'before-save-hook'; they run
312 just before a buffer is written to disk. Also, the order is important;
313 ada-mode does not set up the Ada-specific features of imenu and
314 which-func unless they are loaded first.
316 (setq-default indent-tabs-mode nil)
317 (electric-pair-mode 1)
319 (require 'which-func)
321 (add-to-list 'hippie-expand-try-functions-list 'ada-skel-hippie-try)
322 (define-key ada-mode-map "\C-e" 'hippie-expand)
323 (add-hook 'ada-mode-hook
325 (add-hook 'before-save-hook 'delete-trailing-whitespace nil t)
326 (add-hook 'before-save-hook 'copyright-update nil t)
327 (add-hook 'before-save-hook
328 (lambda () (untabify (point-min) (point-max)))
332 File: ada-mode.info, Node: Compiling Executing, Next: Project files, Prev: Customization, Up: Top
334 4 Compiling Executing
335 *********************
337 Ada projects can be compiled, linked, and executed using commands on the
338 Ada menu. All of these commands can be customized via a project file
339 (*note Project files::), but the defaults are sufficient for using the
340 GNAT compiler for simple projects (single files, or several files in a
343 For complex projects, you will want to use 'make' or some other build
344 tool; in that case, you will need an Emacs Ada mode project file to tell
345 Emacs about the project directory tree and other settings.
350 * Compiling Examples::
354 File: ada-mode.info, Node: Compile commands, Next: Compiling Examples, Prev: Compiling Executing, Up: Compiling Executing
359 Here are the commands for building an Ada project and running the main
362 In multi-file projects, there must be one file that is the main
363 program. That is given by the 'main' project file variable; it defaults
364 to the current file if not yet set, but is also set by the "set main and
368 Compiles the current file in syntax check mode, by running
369 'check_cmd' defined in the current project file. This typically
370 runs faster than full compile mode, speeding up finding and fixing
373 This sets 'main' only if it has not been set yet.
376 Compiles the current file, by running 'comp_cmd' from the current
379 This does not set 'main'.
382 Sets 'main' to the current file, then executes the Build command.
385 Display 'main' in the message buffer.
388 Compiles all obsolete units of the current 'main', and links
389 'main', by running 'make_cmd' from the current project.
391 This sets 'main' only if it has not been set yet.
394 Executes the main program in a shell, displayed in a separate Emacs
395 buffer. This runs 'run_cmd' from the current project. The
396 execution buffer allows for interactive input/output.
398 To modify the run command, in particular to provide or change the
399 command line arguments, type 'C-u' before invoking the command.
401 This command is not available for a cross-compilation toolchain.
403 It is important when using these commands to understand how 'main' is
406 Build runs 'gnatmake' on the main unit. During a typical
407 edit/compile session, this is the only command you need to invoke, which
408 is why it is bound to 'C-c C-c'. It will compile all files needed by
409 the main unit, and display compilation errors in any of them.
411 Note that Build can be invoked from any Ada buffer; typically you
412 will be fixing errors in files other than the main, but you don't have
413 to switch back to the main to invoke the compiler again.
415 Novices and students typically work on single-file Ada projects. In
416 this case, 'C-c C-m' will normally be the only command needed; it will
417 build the current file, rather than the last-built main.
419 There are three ways to change 'main':
421 1. Invoke 'Ada | Set main and Build', which sets 'main' to the current
424 2. Invoke 'Ada | Project | Edit', edit 'main' and 'main', and click
427 3. Invoke 'Ada | Project | Load', and load a project file that
431 File: ada-mode.info, Node: Compiling Examples, Next: Compiler errors, Prev: Compile commands, Up: Compiling Executing
433 4.2 Compiling Examples
434 ======================
436 We present several small projects, and walk thru the process of
437 compiling, linking, and running them.
439 The first example illustrates more Ada mode features than the others;
440 you should work thru that example before doing the others.
442 All of these examples assume you are using GNAT.
444 The source for these examples is available on the Emacs Ada mode
445 website mentioned in *Note Installation::.
449 * No project files:: Just menus
450 * Set compiler options:: A basic Ada mode project file
451 * Set source search path:: Source in multiple directories
452 * Use GNAT project file::
453 * Use multiple GNAT project files::
457 File: ada-mode.info, Node: No project files, Next: Set compiler options, Prev: Compiling Examples, Up: Compiling Examples
459 4.2.1 No project files
460 ----------------------
462 This example uses no project files.
464 First, create a directory 'Example_1', containing:
471 Put_Line("Hello from hello.adb");
474 Yes, this is missing "use Ada.Text_IO;" - we want to demonstrate
475 compiler error handling.
477 'hello_2.adb' has no errors:
485 'hello_pkg.ads' has no errors:
497 Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
501 Yes, this is missing the keyword 'body'; another compiler error
502 example. However, note that the indentation engine parser accepts this
503 code with no errors, making it easier to indent slightly illegal Ada
506 In buffer 'hello.adb', invoke the menu entry 'Ada | Build | Check
507 syntax'. You should get a '*compilation*' buffer containing something
508 like (the directory paths will be different):
510 -*- mode: compilation; default-directory: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/" -*-
511 Compilation started at Fri Oct 18 04:23:54
513 gnatmake -u -c -gnatc c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/hello.adb -cargs
514 gcc -c -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/ -gnatc -I- c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/hello.adb
515 hello.adb:4:04: "Put_Line" is not visible
516 hello.adb:4:04: non-visible declaration at a-textio.ads:263
517 hello.adb:4:04: non-visible declaration at a-textio.ads:259
518 gnatmake: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/hello.adb" compilation error
520 Compilation exited abnormally with code 4 at Fri Oct 18 04:23:54
522 The lines with actual errors (starting with 'hello.adb') are
523 highlighted, with the file name in red.
525 Now invoke 'Ada | Build | Next compilation error'. Or you can click
526 the middle mouse button on the first error line, or use the key binding
527 shown on the menu. The compilation buffer scrolls to put the first
528 error on the top line, and point is put at the place of the error in the
531 To fix the error, invoke 'Ada | Build | Fix compilation error'; this
532 adds "Ada.Text_Io." to the line:
534 Ada.Text_Io.Put_Line ("hello from hello.adb");
536 Now invoke 'Ada | Build | Show main'; this displays 'Ada mode main:
539 Now (in buffer 'hello.adb'), invoke 'Ada | Build | Build'. You are
540 prompted to save the file (if you haven't already). Then the
541 compilation buffer is displayed again, containing:
543 -*- mode: compilation; default-directory: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/" -*-
544 Compilation started at Fri Oct 18 20:39:33
546 gnatmake -o hello hello -cargs -bargs -largs
548 gnatbind -x hello.ali
549 gnatlink hello.ali -o hello.exe
551 Compilation finished at Fri Oct 18 20:39:34
553 The compilation has succeeded without errors; 'hello.exe' now exists
554 in the same directory as 'hello.adb'.
556 Now invoke 'Ada | Build | Run'. The '*compilation*' buffer is
557 displayed, containing
559 -*- mode: compilation; default-directory: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_1/" -*-
560 Compilation started at Fri Oct 18 20:41:53
565 Compilation finished at Fri Oct 18 20:41:53
567 That completes the first part of this example.
569 Now we will compile a multi-file project. Open the file
570 'hello_2.adb', invoke 'Ada | Build | Set main and Build'. This finds an
571 error in 'hello_pkg.adb':
573 hello_pkg.adb:2:08: keyword "body" expected here [see file name]
575 This demonstrates that gnatmake finds the files needed by the main
576 program. However, it cannot find files in a different directory, unless
577 you use an Emacs Ada mode project file or a GNAT project file to specify
578 the other directories; *Note Set source search path::, *note Use GNAT
581 Invoke 'Ada | Build | Show main'; this displays 'Ada mode main:
584 Move to the error with 'C-x `', and fix the error by adding 'body':
586 package body Hello_Pkg is
588 Now, while still in 'hello_pkg.adb', invoke 'Ada | Build | Build'.
589 gnatmake successfully builds 'hello_2'. This demonstrates that Emacs
590 has remembered the main file, in the project variable 'main', and used
591 it for the Build command.
593 Finally, again while in 'hello_pkg.adb', invoke 'Ada | Build | Run'.
594 The '*compilation*' buffer displays 'Hello from hello_pkg.adb'.
596 One final point. If you switch back to buffer 'hello.adb', and
597 invoke 'Ada | Build | Run', 'hello_2.exe' will be run. That is because
598 'main' is still set to 'hello_2', as you can see when you invoke 'Ada |
601 There are two ways to change 'main':
603 1. Invoke 'Ada | Build | Set main and Build', which sets 'main' to the
606 2. Invoke 'Ada | Build | Set Project ...', and select a project file
607 that specifies 'main'.
610 File: ada-mode.info, Node: Set compiler options, Next: Set source search path, Prev: No project files, Up: Compiling Examples
612 4.2.2 Set compiler options
613 --------------------------
615 This example illustrates using an Emacs Ada mode project file to set a
618 If you have files from 'Example_1' open in Emacs, you should close
619 them so you don't get confused. Use menu 'File | Close (current
622 In directory 'Example_2', create these files:
629 Put_Line("Hello from hello.adb");
632 This is the same as 'hello.adb' from 'Example_1'. It has two errors;
633 missing "use Ada.Text_IO;", and no space between 'Put_Line' and its
640 This tells the GNAT compiler to check for token spacing; in
641 particular, there must be a space preceding a parenthesis.
643 In buffer 'hello.adb', invoke 'Ada | Build | Set main and Build'.
644 This finds the project file 'hello.adp', uses it to set the compiler
645 options, and builds the project. You should get a '*compilation*'
646 buffer containing something like (the directory paths will be
649 cd c:/Examples/Example_2/
650 gnatmake -o hello hello -g -cargs -gnatyt -bargs -largs
651 gcc -c -g -gnatyt hello.adb
652 hello.adb:4:04: "Put_Line" is not visible
653 hello.adb:4:04: non-visible declaration at a-textio.ads:264
654 hello.adb:4:04: non-visible declaration at a-textio.ads:260
655 hello.adb:4:12: (style) space required
656 gnatmake: "hello.adb" compilation error
658 Compare this to the compiler output in *note No project files::; the
659 gnatmake option '-cargs' has been replaced by '-cargs -gnaty', and an
660 additional error is reported in 'hello.adb' on line 4. This shows that
661 'hello.adp' is being used to set the compiler options.
663 Fixing the error, linking and running the code proceed as in *note No
667 File: ada-mode.info, Node: Set source search path, Next: Use GNAT project file, Prev: Set compiler options, Up: Compiling Examples
669 4.2.3 Set source search path
670 ----------------------------
672 In this example, we show how to deal with files in more than one
673 directory, using an Emacs Ada mode project file to set the search path.
675 Create the directory 'Example_3', containing:
689 Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
693 These are the same files from example 1; 'hello_pkg.adb' has an error
696 In addition, create a directory 'Example_3/Other', containing these
702 with Ada.Text_IO; use Ada.Text_IO;
706 Put_Line ("From hello_3");
709 There are no errors in this file.
715 Note that there must be no trailing spaces.
717 In buffer 'hello_3.adb', invoke 'Ada | Project files | Find and set
718 project...', and select 'Example_3/Other/other.adp'. This tells Emacs
719 Ada mode to stop using the project file from 'Example_2', and use the
720 one for 'Example_3'. Also note that since this project file is not
721 named 'hello_3.adp', it would not be found by default.
723 Then, again in 'hello_3.adb', invoke 'Ada | Set main and Build'. You
724 should get a '*compilation*' buffer containing something like (the
725 directory paths will be different):
727 cd c:/Examples/Example_3/Other/
728 gnatmake -o hello_3 hello_3 -g -cargs -I.. -bargs -largs
729 gcc -c -g -I.. hello_3.adb
730 gcc -c -I./ -g -I.. -I- C:\Examples\Example_3\hello_pkg.adb
731 hello_pkg.adb:2:08: keyword "body" expected here [see file name]
732 gnatmake: "C:\Examples\Example_3\hello_pkg.adb" compilation error
734 Compare the '-cargs' option to the compiler output in *note Set
735 compiler options::; this shows that 'other.adp' is being used to set the
738 Move to the error with 'C-x `'. Ada mode searches the list of
739 directories given by 'src_dir' for the file mentioned in the compiler
742 Fixing the error, linking and running the code proceed as in *note No
746 File: ada-mode.info, Node: Use GNAT project file, Next: Use multiple GNAT project files, Prev: Set source search path, Up: Compiling Examples
748 4.2.4 Use GNAT project file
749 ---------------------------
751 In this example, we show how to use a GNAT project file, with no Ada
754 Create the directory 'Example_4', containing:
768 Ada.Text_IO.Put_Line ("Hello from hello_pkg.adb");
772 These are the same files from example 1; 'hello_pkg.adb' has an error
775 In addition, create a directory 'Example_4/Gnat_Project', containing
778 'Gnat_Project/hello_4.adb':
781 with Ada.Text_IO; use Ada.Text_IO;
785 Put_Line ("From hello_4");
788 There are no errors in this file.
790 'Gnat_Project/hello_4.gpr':
793 for Source_Dirs use (".", "..");
796 In buffer 'hello_4.adb', invoke 'Ada | Project | Load...', and select
797 'Example_4/Gnat_Project/hello_4.gpr'.
799 Then, again in 'hello_4.adb', invoke 'Ada | Set main and Build'. You
800 should get a '*compilation*' buffer containing something like (the
801 directory paths will be different):
803 -*- mode: compilation; default-directory: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project/" -*-
804 Compilation started at Mon Oct 21 11:28:31
806 gnatmake -Pc:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project/hello_4.gpr -o hello_4 hello_4 -cargs -I. -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4 -Ic:/Apps/GNAT-7.1.2/lib/gcc/i686-pc-mingw32/4.7.3/adainclude -bargs -largs
807 gcc -c -I. -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4 -Ic:/Apps/GNAT-7.1.2/lib/gcc/i686-pc-mingw32/4.7.3/adainclude -I- -gnatA C:\Projects\org.emacs.ada-mode.stephe-1\test\Example_4\hello_pkg.adb
808 hello_pkg.adb:2:08: keyword "body" expected here [see file name]
809 gnatmake: "C:\Projects\org.emacs.ada-mode.stephe-1\test\Example_4\hello_pkg.adb" compilation error
811 Compilation exited abnormally with code 4 at Mon Oct 21 11:28:31
813 Compare the 'gcc' options to the compiler output in *note Set
814 compiler options::; this shows that 'hello_4.gpr' is being used to set
815 the compiler options.
817 Fixing the error, linking and running the code proceed as in *note No
821 File: ada-mode.info, Node: Use multiple GNAT project files, Next: Use a Makefile, Prev: Use GNAT project file, Up: Compiling Examples
823 4.2.5 Use multiple GNAT project files
824 -------------------------------------
826 In this example, we show how to use multiple GNAT project files,
827 specifying the GNAT project search path in an Ada mode project file.
829 Create the directory 'Example_4' as specified in *note Use GNAT
832 Create the directory 'Example_5', containing:
837 with Ada.Text_IO; use Ada.Text_IO;
841 Put_Line ("From hello_5");
844 There are no errors in this file.
848 ada_project_path=../Example_4/Gnat_Project
855 for Source_Dirs use (".");
857 for Default_Switches ("Ada") use ("-g", "-gnatyt");
861 In buffer 'hello_5.adb', invoke 'Ada | Project | Find and select
862 project...', and select 'Example_5/hello_5.adp'. This would also be
863 found by default if no previous project file had been selected.
865 Then, again in 'hello_5.adb', invoke 'Ada | Build | Set main and
866 Build'. You should get a '*compilation*' buffer containing something
867 like (the directory paths will be different):
869 -*- mode: compilation; default-directory: "c:/Projects/org.emacs.ada-mode.stephe-1/test/Example_5/" -*-
870 Compilation started at Mon Oct 21 11:32:05
872 gnatmake -Pc:/Projects/org.emacs.ada-mode.stephe-1/test/Example_5/hello_5.gpr -o hello_5 hello_5 -cargs -I. -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_5 -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4 -Ic:/Apps/GNAT-7.1.2/lib/gcc/i686-pc-mingw32/4.7.3/adainclude -bargs -largs
873 gcc -c -I. -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_5 -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4/Gnat_Project -Ic:/Projects/org.emacs.ada-mode.stephe-1/test/Example_4 -Ic:/Apps/GNAT-7.1.2/lib/gcc/i686-pc-mingw32/4.7.3/adainclude -I- -gnatA C:\Projects\org.emacs.ada-mode.stephe-1\test\Example_4\hello_pkg.adb
874 hello_pkg.adb:2:08: keyword "body" expected here [see file name]
875 gnatmake: "C:\Projects\org.emacs.ada-mode.stephe-1\test\Example_4\hello_pkg.adb" compilation error
877 Compilation exited abnormally with code 4 at Mon Oct 21 11:32:05
879 Now type 'C-x `'. 'Example_4/hello_pkg.adb' is shown, demonstrating
880 that 'hello_5.gpr' and 'hello_4.gpr' are being used to set the
881 compilation search path.
884 File: ada-mode.info, Node: Use a Makefile, Prev: Use multiple GNAT project files, Up: Compiling Examples
889 In this example, we show how to use a Makefile to build an Ada project
890 with GNAT, run the result, and clean the build directories.
892 Create the directories 'Example_4, Example_5' as specified in *note
893 Use GNAT project file::, *note Use multiple GNAT project files::.
895 In 'Example_5', add the file:
899 # build and run hello_5 project
906 gprbuild -Phello_5.gpr hello_5
912 gnatclean -r -Phello_5
914 export GPR_PROJECT_PATH = ../Example_4/Gnat_Project
917 # eval:(ada-parse-prj-file "hello_5.adp")
918 # eval:(ada-select-prj-file "hello_5.adp")
921 Close and re-open 'Makefile'; the 'Local Variables' section sets the
922 project file to 'hello_5.adp' when the 'Makefile' is opened. You can
923 also use <C-x C-e> to execute the select line after the 'Makefile' is
924 opened, to change the project file back to 'hello_5.adp'.
926 In 'Makefile', invoke 'Tools | Compile...', and accept the default
927 make command. This runs the 'all' target, which builds 'hello_5' and
931 File: ada-mode.info, Node: Compiler errors, Prev: Compiling Examples, Up: Compiling Executing
936 The 'Check syntax' and 'Build' commands, or running 'make', place
937 compilation errors in a separate buffer named '*compilation*'.
939 Each line in this buffer will become active: you can simply click on
940 it with the middle button of the mouse, or move point to it and press
941 <RET>. Emacs will then display the relevant source file and put point
942 on the line and column where the error was found.
944 You can also press the 'C-x `' key ('next-error'), and Emacs will
945 jump to the first error. If you press that key again, it will move you
946 to the second error, and so on.
948 Some error messages also include references to other files. These
949 references are accessed via 'C-c `'.
952 File: ada-mode.info, Node: Project files, Next: Moving Through Ada Code, Prev: Compiling Executing, Up: Top
957 An Emacs Ada mode project file specifies what directories hold sources
958 for your project, and allows you to customize the compilation commands
959 and other things on a per-project basis.
961 The default file extension for Ada mode project files is '*.adp' or
962 '*.prj'. You can use a different extension by adding it to
963 'ada-prj-file-extensions', and a different syntax by adding a parser
964 function to 'ada-prj-parser-alist'.
966 Note that Ada mode project files '*.adp' are different than GNAT
967 compiler project files '*.gpr'. However, Emacs Ada mode can use a GNAT
968 project file to specify the project directories. If no other
969 customization is needed, a GNAT project file can be used without an
970 Emacs Ada mode project file.
972 If no Emacs Ada mode project file is specified, some Ada mode
973 functions are not available.
977 * Project file overview::
978 * Project file variables::
981 File: ada-mode.info, Node: Project file overview, Next: Project file variables, Prev: Project files, Up: Project files
983 5.1 Project file overview
984 =========================
986 Project files have a simple syntax; they may be edited directly. Each
987 line specifies a project variable name and its value, separated by "="
988 (spaces not allowed):
989 src_dir=/Projects/my_project/src_1
990 src_dir=/Projects/my_project/src_2
992 Any line that does not have an "=" is a comment.
994 Some variables (like 'src_dir') are lists; multiple occurrences are
997 There must be no space between the variable name and "=", and no
1000 The current project file is given by the lisp variable
1001 'ada-prj-default-project-file', and shown by the menu command <Ada |
1002 Project Files | Show project>.
1004 To set the project file, use the menu command 'Ada | Set Project
1005 ...', or the elisp functions 'ada-parse-prj-file, ada-select-prj-file'.
1006 The latter can be added to a Makefile:
1009 # eval: (ada-parse-prj-file "ada-mode.prj")
1010 # eval: (ada-select-prj-file ada-mode.prj")
1013 You specify either a GNAT project file or an Emacs Ada mode project
1014 file; if the file extension is '.gpr', the file is treated as a GNAT
1015 project file. Extensions given by 'ada-prj-file-extensions' (default
1016 '.adp, .prj') are treated as an Emacs Ada mode project file.
1018 After a project file is parsed, you can make it current again with
1019 just 'ada-select-prj-file', or by selecting it from the menu.
1022 File: ada-mode.info, Node: Project file variables, Prev: Project file overview, Up: Project files
1024 5.2 Project file variables
1025 ==========================
1027 To set a project variable that is a list, specify each element of the
1028 list on a separate line in the project file.
1030 Process environment variables can be referenced using the normal
1033 Most project variables have defaults that can be changed by setting
1034 elisp variables; the table below identifies the elisp variable for each
1035 project variable. Elisp variables corresponding to project variables
1036 that are lists are elisp lists.
1038 In general, project variables are evaluated when referenced in Emacs
1039 Ada mode commands. Relative file paths are expanded relative to the
1040 directory containing the project file.
1042 Ada mode defines some project variables; others are defined by the
1045 Here is the list of variables valid for all compilers. In the
1046 default values, the current directory '"."' is the directory containing
1049 'ada_compiler' [default: 'ada-compiler, gnat']
1050 Ada compiler for this project. It must occur in the project file
1051 before any compiler-specific project variable.
1053 'auto_case' [default: 'ada-auto-case, t']
1054 Non-nil means automatically change case of preceding word while
1057 'case_identifier' [default: 'ada-case-identifier, ada-mixed-case']
1058 Function to call to adjust the case of an Ada identifier.
1060 'case_keyword' [default: 'ada-case-keyword, downcase-word']
1061 Function to call to adjust the case of an Ada keyword.
1063 'case_strict' [default: 'ada-case-strict, t']
1064 If non-nil, 'ada-mixed-case' forces 'Mixed_Case' for identifiers.
1065 Otherwise, 'ada-mixed-case' allows 'UPPERCASE' for identifiers.
1067 'casing' [default: 'ada-case-exception-file, nil']
1068 List of files containing casing exceptions. *Note Automatic
1071 'el_file' [default: ]
1072 The value is a file name, which is loaded as an elisp file when the
1073 project file is parsed or selected. This allows setting Ada mode
1074 indentation variables, and any arbitrary elisp code used to
1075 customize the project.
1077 'path_sep' [default: 'path-separator']
1078 Separator character used in compiler search paths.
1080 'src_dir' [default: '"."']
1081 A list of directories to search for source files.
1083 'xref_tool' [default: 'ada-xref-tool, gnat-xref']
1084 Cross reference tool for this project.
1086 The following variables are valid with the GNAT compiler:
1088 'ada_project_path' [default: '""']
1089 A list of directories to search for GNAT project files.
1091 If set, the 'GPR_PROJECT_PATH' process environment variable is set
1092 to this value in the child process that runs GNAT tools. If not
1093 set, 'GPR_PROJECT_PATH' in the child process is inherited from the
1096 If you have the 'GPR_PROJECT_PATH' or 'ADA_PROJECT_PATH'
1097 environment variable set in the Emacs process correctly for all of
1098 your projects, you do not need to set this project variable.
1100 The project search path can also be set in GNAT aggregate projects.
1101 However, the gnat tools do not make that path available to Emacs,
1102 so you must duplicate it in an Emacs Ada project file.
1104 'gpr_file' [default: '""']
1105 The GNAT project file.
1107 If set, the source and project directories specified in the GNAT
1108 project file are appended to 'src_dir' and 'ada_project_path'.
1109 This allows specifying Ada source directories with a GNAT project
1110 file, and other source directories with the Emacs project file.
1112 'gpr_project_path' [default: '""']
1113 Same as 'ada_project_path'.
1116 File: ada-mode.info, Node: Moving Through Ada Code, Next: Identifier completion, Prev: Project files, Up: Top
1118 6 Moving Through Ada Code
1119 *************************
1121 There are several commands to navigate through Ada code. All these
1122 functions are available through the Ada menu and keybindings.
1124 Some of these commands rely on cross reference facilities provided by
1125 the compiler; the standard Emacs Ada mode only supports the GNAT
1126 compiler, but others can be added (*note Other cross-reference::).
1129 Move from any use of an identifier to its declaration, for from a
1130 declaration to its body (if there is one).
1133 Move from a child type declaration to the parent type declaration;
1134 display a list of references if there is more than one parent.
1137 Move to the next keyword in the current statement.
1139 For example, if point is on 'if', move to 'then'.
1142 Move to the previous keyword in the current statement.
1144 For example, if point is on 'then', move to 'if'.
1147 Switch between corresponding spec and body. There are several
1150 * If the region is active, it is assumed to contain an Ada
1151 package name; position point on the corresponding package
1154 * If point is in the start line of a top level child package
1155 declaration (but not package body), or a child subprogram spec
1156 or body, position point on the corresponding parent package
1159 * If point is in the start line of a top level separate body,
1160 position point on the corresponding separate stub declaration.
1162 * If point is in a subprogram declaration or body, position
1163 point on the corresponding body or declaration in the other
1166 * If point is on a 'with' clause, position point on the
1167 corresponding declaration.
1170 Show all references to the identifier surrounding point. Use 'C-x
1171 `' ('next-error') to visit each reference (as for compilation
1175 Show all declarations that override the primitive procedure at
1176 point. Use 'C-x `' ('next-error') to visit each reference (as for
1177 compilation errors).
1180 Show the declaration that the declaration at point overrides.
1183 Jump back to the previous location.
1185 'Ada | Misc | Refresh cross reference cache'
1186 Cross reference information is loaded from the compiler output when
1187 the first cross reference command is issued. If the code is
1188 recompiled after that, the cross reference information is reloaded
1189 by invoking this menu command.
1192 File: ada-mode.info, Node: Identifier completion, Next: Indentation, Prev: Moving Through Ada Code, Up: Top
1194 7 Identifier completion
1195 ***********************
1197 Emacs provides a general way of completing identifiers: 'M-/' (bound to
1198 'dabbrev-expand'). This is an easy way to type faster: you just have to
1199 type the first few letters of an identifier, and then loop through all
1200 the possible completions.
1202 'M-/' works by parsing all open Ada files for possible completions.
1204 For instance, if the words 'my_identifier' and 'my_subprogram' are
1205 the only words starting with 'my' in any of the open Ada files, then you
1206 will have this scenario:
1209 Emacs inserts: 'my_identifier'
1210 If you press M-/ once again, Emacs replaces 'my_identifier' with
1212 Pressing M-/ once more will bring you back to 'my_identifier'.
1214 This is a very fast way to do completion, and the casing of words
1215 will also be respected.
1218 File: ada-mode.info, Node: Indentation, Next: Statement skeletons, Prev: Identifier completion, Up: Top
1223 Ada mode comes with a full set of rules for automatic indentation. You
1224 can also configure the indentation, via the following variables:
1226 'ada-indent' (default value: 3)
1227 Number of columns for default indentation.
1229 'ada-indent-broken' (default value: 2)
1230 Number of columns to indent the continuation of a broken line.
1232 'ada-indent-comment-col-0' (default value: nil)
1233 If non-nil, comments currently starting in column 0 are left in
1234 column 0. Otherwise, they are indented with previous comments or
1237 'ada-indent-label' (default value: -3)
1238 Number of columns to indent a label.
1240 'ada-indent-record-rel-type' (default value: 3)
1241 Indentation for 'record' relative to 'type' or 'use'.
1243 'ada-indent-renames' (default value: 2)
1244 Indentation for 'renames' relative to the matching subprogram
1247 If the subprogram has parameters then if 'ada-indent-renames' is
1248 zero or less the indentation is abs 'ada-indent-renames' relative
1249 to the open parenthesis; if 'ada-indent-renames' is one or more the
1250 indentation is relative to the line containing the keyword.
1252 If the subprogram has no parameters then 'ada-indent-broken' the
1253 indentation is relative to the indentation of the line containing
1256 'ada-indent-return' (default value: 0)
1257 Indentation for 'return' relative to the matching 'function'.
1259 If the function has parameters, then if 'ada-indent-return' is zero
1260 or less the indentation is abs 'ada-indent-return' relative to the
1261 open parenthesis; if 'ada-indent-return' is one or more,
1262 indentation is relative to line containing 'function'.
1264 If the function has no parameters, 'ada-indent-broken' is used
1265 relative to line containing 'function'.
1267 'ada-indent-use' (default value: ada-indent-broken)
1268 Indentation for the lines in a 'use' statement.
1270 'ada-indent-when' (default value: 3)
1271 Indentation for 'when' relative to 'exception', 'case', or 'or' in
1274 'ada-indent-with' (default value: ada-indent-broken)
1275 Indentation for the lines in a 'with' context clause.
1277 The indentation variables are buffer local; the global value may be
1278 overridden in an elisp file invoked by an 'el_file' Emacs Ada mode
1279 project file statement, or in a file local variable section.
1281 The following keys indent portions of the text:
1284 Insert and indent a new line.
1287 Indent the current line, or the current region.
1290 Indent the current statement or declaration.
1292 The indentation algorithm relies on a grammar parser to identify the
1293 syntactic role for keywords and other words in the code. If the code is
1294 accepted by the parser, the indentation is done according to the rules
1295 in the indentation engine.
1297 If the code is not accepted (because it is partially complete during
1298 editing), the indentation engine falls back to the trivial algorithm of
1299 indenting each new line the same as the previous line. Once enough new
1300 text has been entered to make the code acceptable to the parser, the
1301 statement or declaration is properly indented.
1303 For example, if you are entering this code:
1309 when you type 'RET B', 'B' is indented to the same column as 'if',
1310 because the parser does not find 'end if;'. Then when you type the
1311 final ';' followed by <TAB>, all three lines are indented, putting 'B'
1314 To be more user friendly, the parser accepts a superset of the Ada
1315 grammer. For example, the parser accepts this code for an 'if'
1321 In general, any sequence of statements, and many expressions, may be
1324 One way to easily insert empty statements like this is using *note
1325 Statement skeletons::.
1327 In rare cases, the parser gets confused; it can be reset by invoking
1328 menu <Ada | Misc | Reset parser>. Please report such cases as a bug.
1331 File: ada-mode.info, Node: Statement skeletons, Next: Aligning code, Prev: Indentation, Up: Top
1333 9 Statement skeletons
1334 *********************
1336 'C-c C-e' expands the previous one or two words into a statment
1337 skeleton. For example, 'i f C-c C-e' expands to:
1344 All skeleton expansions are accepted by the indentation parser, so
1345 this is a convenient way to insert statements with correct indentation.
1347 For named statements (packages, loops, etc), the name is taken from
1348 the word before point, and the name of the statement from the word
1351 Some expansions prompt for more information, such as whether a spec
1352 or body is desired. For example, 'package A_Package C-c C-e' first
1353 prompts for "body" or "spec". If "spec" is selected, the following code
1356 package A_Package is
1360 Named blocks work similarly: 'declare A_Block C-c C-e' expands
1361 (without prompting) to:
1369 Note that the order of the keyword 'declare' and the name 'A_Block'
1370 are reversed in the expansion; this may take some getting used to.
1371 Alternately, if no name is present in the buffer, you are prompted for a
1372 name: 'declare C-c C-e' first prompts for a name, then expands to the
1375 The variable 'ada-skel-initial-string' defines what to insert in a
1376 newly created empty buffer. It defaults to '{header}', which is a
1377 placeholder defined by 'ada-skel-header', which inserts a typical header
1378 with a copyright license (choice of GPL or restricted). Users will
1379 typically want to override the definition of 'ada-skel-initial-string'
1380 and/or 'ada-skel-header', or provide more choices of copyright license.
1383 File: ada-mode.info, Node: Aligning code, Next: Automatic casing, Prev: Statement skeletons, Up: Top
1388 Aligning code adds space in each line so that similar parts of
1389 successive lines are aligned vertically. For example, a sequence of
1393 Another : Float := 1.0;
1394 More : Integer := 2;
1396 changes to this when aligned:
1399 Another : Float := 1.0;
1400 More : Integer := 2;
1402 Alignment is invoked by 'C-c C-a', which aligns the sequence of
1403 statements surrounding point, or within the selected region.
1405 Parameter lists are also aligned:
1409 Another : out Float := 1.0;
1410 More : in out Integer := 2);
1416 Another : out Float := 1.0;
1417 More : in out Integer := 2);
1420 File: ada-mode.info, Node: Automatic casing, Next: Comment Handling, Prev: Aligning code, Up: Top
1425 Casing of identifiers, attributes and keywords is automatically
1426 performed while typing when the variable 'ada-auto-case' is non-nil (the
1427 default). Every time you type a word separator, the previous word is
1428 automatically cased.
1430 You can customize the automatic casing with the following variables:
1433 Value must be one of:
1435 Ada keywords will be lowercase.
1438 Ada keywords will be uppercase.
1441 If non-nil, all identifiers are forced to 'Mixed_Case'; first
1442 letter, and letter following "_" are uppercase; rest are lowercase.
1444 If nil, the mixed case characters in identifiers are forced to
1445 upper case, but the other characters are not modified. That allows
1446 typing all uppercase identifiers without defining a casing
1449 You can define exceptions to these rules, in files specified by the
1450 variable 'ada-case-exception-file'. Each line in a case exception file
1451 specifies the casing of one word or word fragment. If an exception is
1452 defined in multiple files, the first occurrence is used.
1454 If the word starts with an asterisk ('*'), it defines the casing of a
1455 word fragemnt (or "substring"); part of a word between two underscores
1464 The word fragment '*IO' applies to any word containing "_io";
1465 'Text_IO', 'Hardware_IO', etc.
1467 There are two ways to add new items to this file: you can simply edit
1468 it as you would edit any text file. Or you can position point on the
1469 word you want to add, and select menu 'Ada | Casing | Create full
1470 exception' or 'Ada | Casing | Create partial exception'. The word will
1471 be added to the current list of exceptions and to the file.
1473 It is sometimes useful to have multiple exception files. For
1474 example, one could be the standard Ada acronyms, the second some company
1475 specific exceptions, and the last one some project specific exceptions.
1476 If you set up the variable 'ada-case-exception-file' as a list of files,
1477 each of them will be parsed and used in your emacs session. When you
1478 create a new exception, you are prompted for the file to save it in.
1480 Other keys and menu entries are defined:
1483 Adjust case of the word at point. With prefix arg, adjust case
1484 even if in comment. Normally, comments are not affected by case
1487 'Ada | Casing | Adjust case region'
1488 Adjust case in the active region.
1490 'Ada | Casing | Adjust case buffer'
1491 Adjust case in the active buffer.
1494 File: ada-mode.info, Node: Comment Handling, Next: Key summary, Prev: Automatic casing, Up: Top
1499 By default, comment lines get indented like Ada code. There are a few
1500 additional functions to handle comments:
1503 If the region is active, comment or uncomment it.
1505 If the current line is empty, start a comment.
1507 Otherwise, add a comment at the end of the line, in a column given
1508 by 'comment-column'.
1511 Fill the current comment paragraph.
1514 File: ada-mode.info, Node: Key summary, Next: Developer overview, Prev: Comment Handling, Up: Top
1519 This table summarizes the keys described in this manual. Other keys are
1520 bound by Ada mode; see <C-h b> for a complete list. The Ada menu also
1521 displays keys bound to menu operations.
1524 *Note Identifier completion::. Complete the word before point;
1525 repeat to cycle thru possible completions.
1528 *Note Comment Handling::. If the region is active, comment or
1532 *Note Comment Handling::. Fill the current comment paragraph.
1535 *Note Indentation::. Insert and indent a new line.
1538 *Note Indentation::. Indent the current line, or the current
1542 *Note Indentation::. Indent the current statement or declaration.
1545 *Note Compiler errors::. Move to the location of the secondary
1546 reference in the current compilation error.
1549 *Note Aligning code::. Align code.
1552 *Note Compile commands::. Build the current main program.
1555 *Note Moving Through Ada Code::. Move from any use of an
1556 identifier to its declaration, for from a declaration to its body.
1559 *Note Moving Through Ada Code::. Move from a child type
1560 declaration to the parent type declaration.
1563 *Note Statement skeletons::. Expand previous one or two words into
1564 a statement or declaration skeleton.
1567 *Note Compile commands::. Build the current file.
1570 *Note Moving Through Ada Code::. Move to the next keyword in the
1574 *Note Moving Through Ada Code::. Switch between corresponding spec
1575 and body, or find other spec.
1578 *Note Moving Through Ada Code::. Move to the previous keyword in
1579 the current statement.
1582 *Note Moving Through Ada Code::. Show all references to the
1583 identifier surrounding point.
1586 *Note Automatic casing::. Adjust case of the word at point. With
1587 prefix arg, adjust case even if in comment.
1590 *Note Moving Through Ada Code::. Show all declarations that
1591 override the primitive procedure at point.
1594 *Note Automatic casing::. Create case exception.
1597 *Note Compiler errors::. Move to the location of the next
1598 secondary compilation error.
1601 *Note Compiler errors::. Move to the location of the next
1602 compilation error or show result.
1605 *Note Comment Handling::. Fill the current comment paragraph.
1608 File: ada-mode.info, Node: Developer overview, Next: GNU Free Documentation License, Prev: Key summary, Up: Top
1610 14 Developer overview
1611 *********************
1613 If you'd like to contribute to Ada mode, or just understand the sources,
1618 * Directory structure::
1619 * Package organization::
1624 File: ada-mode.info, Node: Directory structure, Next: Package organization, Prev: Developer overview, Up: Developer overview
1626 14.1 Directory structure
1627 ========================
1629 'org.emacs.ada-mode'
1634 Elisp files; main code.
1637 Byte-compiled elisp files, not in the distribution. Generated
1638 by the Makefile target 'byte-compile', or by the Emacs package
1641 Compiling the parse tables ('*-wy.el') speeds up loading them
1642 significantly. Compiling other files speeds up parsing, but
1645 One reason to byte-compile files is to find errors; the byte
1646 compiler reports undefined variables, wrong argument counts,
1650 Parse tables, generated from the corresponding grammar '*.wy'
1651 by the OpenToken tool 'wisi-generate.exe'. These are in the
1652 tarball distribution and the monotone repository so users and
1653 Elisp developers don't have to install OpenToken.
1656 Diagnostic output from 'wisi-generate.exe', useful for tracing
1657 parses while debugging a grammar issue. Not in the tarball
1658 distribution or the monotone repository.
1661 Grammar files, specifying the language to be parsed. The
1662 syntax for these grammar files is similar to that for bison
1663 and wisent, but not the same; see the OpenToken documentation
1666 The wisi parser (in 'wisi-parse.el') is a generalized LALR
1667 parser, so it tolerates some conflicts and ambiguities. This
1668 makes the grammars easier to write, and in particular makes it
1669 possible to let the Ada grammar closely match Annex P of the
1670 Ada Language Reference Manual (the syntax summary).
1673 Texinfo source for the user guides.
1676 Generated user guide in HTML format.
1679 Generated user guide in Emacs info format.
1682 Makefile for building the user guides, publishing to the web page
1683 or Gnu ELPA. Test drivers.
1686 Makefile for building and testing with the wisi-based parser.
1687 Separate from 'build', because there used to be a SMIE-based
1688 parser, and there might be another parser someday.
1690 The emacs used to byte-compile and run tests is given by the 'make'
1691 variable EMACS_EXE, which defaults to 'emacs'; it can be overridden
1692 on the make command line or by an environment variable.
1695 All tests for Ada mode, gpr mode, parser.
1697 Each test is run in a separate invocation of Emacs, so it is
1698 completely independent of all other tests.
1700 The tests are driven by the elisp code in 'build/*.el'.
1702 In general, the Ada mode tests open the file, execute test actions,
1703 re-indent, and re-captialize the entire file. The result is diffed
1704 with the original, and must match.
1706 The test actions are defined by comments with the prefix
1707 '--EMACSCMD:'; they are elisp forms that invoke Ada mode functions.
1708 This is used to test navigation features and other parser effects.
1711 Starting files for examples in user guide.
1717 More tests; allows testing path search features.
1720 Tests of the elisp wisi grammar compiler and parser.
1723 File: ada-mode.info, Node: Package organization, Next: OpenToken, Prev: Directory structure, Up: Developer overview
1725 14.2 Package organization
1726 =========================
1736 File: ada-mode.info, Node: Ada mode, Next: gpr mode, Prev: Package organization, Up: Package organization
1741 Ada mode consists of all files with 'ada-' prefix in the file name.
1744 The main file, implementing the keymap, menu, and top level
1747 It allows for different backend implementations for compiling,
1748 cross-referencing, and indenting. The functions for each of these
1749 backends dispatch thru global variables that are set by Emacs Ada
1750 mode project files. They default to the GNAT compiler, the
1751 gnatxref cross reference tool, and the ada-wisi indentation engine.
1754 Provides functions for compiling Ada files without a Makefile (or
1758 Provides an interface to utilities for automatically fixing errors
1759 reported by the compiler. It dispatches to a compiler-specific
1762 'ada-gnat-compile.el'
1763 Implements the Ada mode compiler functions for the GNAT compiler.
1766 Implements the Ada mode cross reference functions for the GNAT
1770 The Ada language grammar, and files generated from it by the
1771 OpenToken tool 'wisi-generate.exe'.
1773 'ada-indent-user-options.el'
1774 All user-settable options for the Ada indentation engine.
1776 'ada-mode-compat-23.4.el'
1777 Defines functions used by Ada mode that are not in Emacs 23.4.
1779 Emacs Ada mode is written for Emacs 24.3. Emacs version 23.4 is
1780 partially supported. Earlier versions of Emacs are not supported.
1783 The Ada mode user guide source and compiled versions.
1786 Skeletons for expansion of Ada syntax (*note Statement
1787 skeletons::). Extends the Emacs skeleton functions with "tokens",
1788 inspired by the lamented Else package (which was inspired by DEC
1791 'ada-wisi-opentoken.el'
1792 Indentation functions useful when editing OpenToken code; an
1793 example of extending the Ada mode indentation engine for special
1797 Implements the Ada mode indentation functions for the wisi
1798 indentation engine backend.
1801 File: ada-mode.info, Node: gpr mode, Next: GNAT core, Prev: Ada mode, Up: Package organization
1806 gpr mode consists of all files with 'gpr-' prefix in the file name. The
1807 functions in each file are similar to the similarly-named Ada mode
1811 File: ada-mode.info, Node: GNAT core, Next: Wisi, Prev: gpr mode, Up: Package organization
1817 GNAT is actually a multi-language tool; it builds on top of the
1820 'gnat-core.el' is a start at a language-agnostic interface to the
1821 GNAT tools. It was first factored out from 'ada-gnat.el' and
1822 'ada-mode.el' to support the multi-language 'gnat-inspect.el',
1823 which is still experimental.
1825 More code currently in 'ada-mode.el' could be migrated to
1826 'gnat-core.el', in particular the project file support.
1829 Provides an experimental interface to the experimental
1830 multi-language cross-reference tool 'gnatinspect' from AdaCore,
1831 which will supercede 'gnatxref'.
1833 Implements the Ada mode cross-reference functions for the
1834 'gnatinspect' backend, and a minor mode providing similar functions
1838 File: ada-mode.info, Node: Wisi, Prev: GNAT core, Up: Package organization
1843 The "wisi" parser. "wisi" used to be an acronym, but now it's just a
1847 Implements the lexer, the main parser driver, parser actions that
1848 cache parser information in text properties, utilities for
1849 indenting and navigating using the cached information, and general
1853 Implements the parse table compiler. 'wisi-generate.exe' processes
1854 the grammar source '*.wy' into an elisp source representation of a
1855 parse table '*-wy.el'. That is compiled into an internal structure
1856 containing the state transitions and executable actions. The
1857 actions can be any elisp form; the intent is that they be calls to
1858 the action functions provided by 'wisi.el'. 'wisi-compile.el' uses
1859 some features provided by 'semantic'.
1862 Implements the generalized LALR parser.
1865 File: ada-mode.info, Node: OpenToken, Next: ELPA, Prev: Package organization, Up: Developer overview
1870 Ada mode uses the OpenToken tool 'wisi-generate.exe' to process the
1871 grammar sources into elisp parse tables. See
1872 <http://stephe-leake.org/emacs/ada-mode/emacs-ada-mode.html> for current
1873 information about which version of OpenToken is required, and how to get
1876 The Makefile variable 'WISI_OPENTOKEN' gives the path to the build
1877 directory for OpenToken; you probably need to override it with an
1878 external environment variable or on the 'make' command line.
1881 File: ada-mode.info, Node: ELPA, Prev: OpenToken, Up: Developer overview
1886 Ada mode is published via the Gnu ELPA archive. To test a new version
1887 of Ada mode, we use a local Gnu ELPA archive. That requires fetching
1891 git clone git://git.savannah.gnu.org/emacs/elpa.git
1893 If you have an Emacs Savannah developer account, you can use:
1896 git clone <login>@git.savannah.gnu.org/emacs/elpa.git
1898 'build/Makefile' contains targets for copying Ada mode source to the
1899 elpa workspace, and for building the elpa archive there.
1902 File: ada-mode.info, Node: GNU Free Documentation License, Next: Index, Prev: Developer overview, Up: Top
1904 Appendix A GNU Free Documentation License
1905 *****************************************
1907 Version 1.3, 3 November 2008
1909 Copyright (C) 2000, 2001, 2002, 2007, 2008, 2009 Free Software Foundation, Inc.
1912 Everyone is permitted to copy and distribute verbatim copies
1913 of this license document, but changing it is not allowed.
1917 The purpose of this License is to make a manual, textbook, or other
1918 functional and useful document "free" in the sense of freedom: to
1919 assure everyone the effective freedom to copy and redistribute it,
1920 with or without modifying it, either commercially or
1921 noncommercially. Secondarily, this License preserves for the
1922 author and publisher a way to get credit for their work, while not
1923 being considered responsible for modifications made by others.
1925 This License is a kind of "copyleft", which means that derivative
1926 works of the document must themselves be free in the same sense.
1927 It complements the GNU General Public License, which is a copyleft
1928 license designed for free software.
1930 We have designed this License in order to use it for manuals for
1931 free software, because free software needs free documentation: a
1932 free program should come with manuals providing the same freedoms
1933 that the software does. But this License is not limited to
1934 software manuals; it can be used for any textual work, regardless
1935 of subject matter or whether it is published as a printed book. We
1936 recommend this License principally for works whose purpose is
1937 instruction or reference.
1939 1. APPLICABILITY AND DEFINITIONS
1941 This License applies to any manual or other work, in any medium,
1942 that contains a notice placed by the copyright holder saying it can
1943 be distributed under the terms of this License. Such a notice
1944 grants a world-wide, royalty-free license, unlimited in duration,
1945 to use that work under the conditions stated herein. The
1946 "Document", below, refers to any such manual or work. Any member
1947 of the public is a licensee, and is addressed as "you". You accept
1948 the license if you copy, modify or distribute the work in a way
1949 requiring permission under copyright law.
1951 A "Modified Version" of the Document means any work containing the
1952 Document or a portion of it, either copied verbatim, or with
1953 modifications and/or translated into another language.
1955 A "Secondary Section" is a named appendix or a front-matter section
1956 of the Document that deals exclusively with the relationship of the
1957 publishers or authors of the Document to the Document's overall
1958 subject (or to related matters) and contains nothing that could
1959 fall directly within that overall subject. (Thus, if the Document
1960 is in part a textbook of mathematics, a Secondary Section may not
1961 explain any mathematics.) The relationship could be a matter of
1962 historical connection with the subject or with related matters, or
1963 of legal, commercial, philosophical, ethical or political position
1966 The "Invariant Sections" are certain Secondary Sections whose
1967 titles are designated, as being those of Invariant Sections, in the
1968 notice that says that the Document is released under this License.
1969 If a section does not fit the above definition of Secondary then it
1970 is not allowed to be designated as Invariant. The Document may
1971 contain zero Invariant Sections. If the Document does not identify
1972 any Invariant Sections then there are none.
1974 The "Cover Texts" are certain short passages of text that are
1975 listed, as Front-Cover Texts or Back-Cover Texts, in the notice
1976 that says that the Document is released under this License. A
1977 Front-Cover Text may be at most 5 words, and a Back-Cover Text may
1978 be at most 25 words.
1980 A "Transparent" copy of the Document means a machine-readable copy,
1981 represented in a format whose specification is available to the
1982 general public, that is suitable for revising the document
1983 straightforwardly with generic text editors or (for images composed
1984 of pixels) generic paint programs or (for drawings) some widely
1985 available drawing editor, and that is suitable for input to text
1986 formatters or for automatic translation to a variety of formats
1987 suitable for input to text formatters. A copy made in an otherwise
1988 Transparent file format whose markup, or absence of markup, has
1989 been arranged to thwart or discourage subsequent modification by
1990 readers is not Transparent. An image format is not Transparent if
1991 used for any substantial amount of text. A copy that is not
1992 "Transparent" is called "Opaque".
1994 Examples of suitable formats for Transparent copies include plain
1995 ASCII without markup, Texinfo input format, LaTeX input format,
1996 SGML or XML using a publicly available DTD, and standard-conforming
1997 simple HTML, PostScript or PDF designed for human modification.
1998 Examples of transparent image formats include PNG, XCF and JPG.
1999 Opaque formats include proprietary formats that can be read and
2000 edited only by proprietary word processors, SGML or XML for which
2001 the DTD and/or processing tools are not generally available, and
2002 the machine-generated HTML, PostScript or PDF produced by some word
2003 processors for output purposes only.
2005 The "Title Page" means, for a printed book, the title page itself,
2006 plus such following pages as are needed to hold, legibly, the
2007 material this License requires to appear in the title page. For
2008 works in formats which do not have any title page as such, "Title
2009 Page" means the text near the most prominent appearance of the
2010 work's title, preceding the beginning of the body of the text.
2012 The "publisher" means any person or entity that distributes copies
2013 of the Document to the public.
2015 A section "Entitled XYZ" means a named subunit of the Document
2016 whose title either is precisely XYZ or contains XYZ in parentheses
2017 following text that translates XYZ in another language. (Here XYZ
2018 stands for a specific section name mentioned below, such as
2019 "Acknowledgements", "Dedications", "Endorsements", or "History".)
2020 To "Preserve the Title" of such a section when you modify the
2021 Document means that it remains a section "Entitled XYZ" according
2024 The Document may include Warranty Disclaimers next to the notice
2025 which states that this License applies to the Document. These
2026 Warranty Disclaimers are considered to be included by reference in
2027 this License, but only as regards disclaiming warranties: any other
2028 implication that these Warranty Disclaimers may have is void and
2029 has no effect on the meaning of this License.
2033 You may copy and distribute the Document in any medium, either
2034 commercially or noncommercially, provided that this License, the
2035 copyright notices, and the license notice saying this License
2036 applies to the Document are reproduced in all copies, and that you
2037 add no other conditions whatsoever to those of this License. You
2038 may not use technical measures to obstruct or control the reading
2039 or further copying of the copies you make or distribute. However,
2040 you may accept compensation in exchange for copies. If you
2041 distribute a large enough number of copies you must also follow the
2042 conditions in section 3.
2044 You may also lend copies, under the same conditions stated above,
2045 and you may publicly display copies.
2047 3. COPYING IN QUANTITY
2049 If you publish printed copies (or copies in media that commonly
2050 have printed covers) of the Document, numbering more than 100, and
2051 the Document's license notice requires Cover Texts, you must
2052 enclose the copies in covers that carry, clearly and legibly, all
2053 these Cover Texts: Front-Cover Texts on the front cover, and
2054 Back-Cover Texts on the back cover. Both covers must also clearly
2055 and legibly identify you as the publisher of these copies. The
2056 front cover must present the full title with all words of the title
2057 equally prominent and visible. You may add other material on the
2058 covers in addition. Copying with changes limited to the covers, as
2059 long as they preserve the title of the Document and satisfy these
2060 conditions, can be treated as verbatim copying in other respects.
2062 If the required texts for either cover are too voluminous to fit
2063 legibly, you should put the first ones listed (as many as fit
2064 reasonably) on the actual cover, and continue the rest onto
2067 If you publish or distribute Opaque copies of the Document
2068 numbering more than 100, you must either include a machine-readable
2069 Transparent copy along with each Opaque copy, or state in or with
2070 each Opaque copy a computer-network location from which the general
2071 network-using public has access to download using public-standard
2072 network protocols a complete Transparent copy of the Document, free
2073 of added material. If you use the latter option, you must take
2074 reasonably prudent steps, when you begin distribution of Opaque
2075 copies in quantity, to ensure that this Transparent copy will
2076 remain thus accessible at the stated location until at least one
2077 year after the last time you distribute an Opaque copy (directly or
2078 through your agents or retailers) of that edition to the public.
2080 It is requested, but not required, that you contact the authors of
2081 the Document well before redistributing any large number of copies,
2082 to give them a chance to provide you with an updated version of the
2087 You may copy and distribute a Modified Version of the Document
2088 under the conditions of sections 2 and 3 above, provided that you
2089 release the Modified Version under precisely this License, with the
2090 Modified Version filling the role of the Document, thus licensing
2091 distribution and modification of the Modified Version to whoever
2092 possesses a copy of it. In addition, you must do these things in
2093 the Modified Version:
2095 A. Use in the Title Page (and on the covers, if any) a title
2096 distinct from that of the Document, and from those of previous
2097 versions (which should, if there were any, be listed in the
2098 History section of the Document). You may use the same title
2099 as a previous version if the original publisher of that
2100 version gives permission.
2102 B. List on the Title Page, as authors, one or more persons or
2103 entities responsible for authorship of the modifications in
2104 the Modified Version, together with at least five of the
2105 principal authors of the Document (all of its principal
2106 authors, if it has fewer than five), unless they release you
2107 from this requirement.
2109 C. State on the Title page the name of the publisher of the
2110 Modified Version, as the publisher.
2112 D. Preserve all the copyright notices of the Document.
2114 E. Add an appropriate copyright notice for your modifications
2115 adjacent to the other copyright notices.
2117 F. Include, immediately after the copyright notices, a license
2118 notice giving the public permission to use the Modified
2119 Version under the terms of this License, in the form shown in
2122 G. Preserve in that license notice the full lists of Invariant
2123 Sections and required Cover Texts given in the Document's
2126 H. Include an unaltered copy of this License.
2128 I. Preserve the section Entitled "History", Preserve its Title,
2129 and add to it an item stating at least the title, year, new
2130 authors, and publisher of the Modified Version as given on the
2131 Title Page. If there is no section Entitled "History" in the
2132 Document, create one stating the title, year, authors, and
2133 publisher of the Document as given on its Title Page, then add
2134 an item describing the Modified Version as stated in the
2137 J. Preserve the network location, if any, given in the Document
2138 for public access to a Transparent copy of the Document, and
2139 likewise the network locations given in the Document for
2140 previous versions it was based on. These may be placed in the
2141 "History" section. You may omit a network location for a work
2142 that was published at least four years before the Document
2143 itself, or if the original publisher of the version it refers
2144 to gives permission.
2146 K. For any section Entitled "Acknowledgements" or "Dedications",
2147 Preserve the Title of the section, and preserve in the section
2148 all the substance and tone of each of the contributor
2149 acknowledgements and/or dedications given therein.
2151 L. Preserve all the Invariant Sections of the Document, unaltered
2152 in their text and in their titles. Section numbers or the
2153 equivalent are not considered part of the section titles.
2155 M. Delete any section Entitled "Endorsements". Such a section
2156 may not be included in the Modified Version.
2158 N. Do not retitle any existing section to be Entitled
2159 "Endorsements" or to conflict in title with any Invariant
2162 O. Preserve any Warranty Disclaimers.
2164 If the Modified Version includes new front-matter sections or
2165 appendices that qualify as Secondary Sections and contain no
2166 material copied from the Document, you may at your option designate
2167 some or all of these sections as invariant. To do this, add their
2168 titles to the list of Invariant Sections in the Modified Version's
2169 license notice. These titles must be distinct from any other
2172 You may add a section Entitled "Endorsements", provided it contains
2173 nothing but endorsements of your Modified Version by various
2174 parties--for example, statements of peer review or that the text
2175 has been approved by an organization as the authoritative
2176 definition of a standard.
2178 You may add a passage of up to five words as a Front-Cover Text,
2179 and a passage of up to 25 words as a Back-Cover Text, to the end of
2180 the list of Cover Texts in the Modified Version. Only one passage
2181 of Front-Cover Text and one of Back-Cover Text may be added by (or
2182 through arrangements made by) any one entity. If the Document
2183 already includes a cover text for the same cover, previously added
2184 by you or by arrangement made by the same entity you are acting on
2185 behalf of, you may not add another; but you may replace the old
2186 one, on explicit permission from the previous publisher that added
2189 The author(s) and publisher(s) of the Document do not by this
2190 License give permission to use their names for publicity for or to
2191 assert or imply endorsement of any Modified Version.
2193 5. COMBINING DOCUMENTS
2195 You may combine the Document with other documents released under
2196 this License, under the terms defined in section 4 above for
2197 modified versions, provided that you include in the combination all
2198 of the Invariant Sections of all of the original documents,
2199 unmodified, and list them all as Invariant Sections of your
2200 combined work in its license notice, and that you preserve all
2201 their Warranty Disclaimers.
2203 The combined work need only contain one copy of this License, and
2204 multiple identical Invariant Sections may be replaced with a single
2205 copy. If there are multiple Invariant Sections with the same name
2206 but different contents, make the title of each such section unique
2207 by adding at the end of it, in parentheses, the name of the
2208 original author or publisher of that section if known, or else a
2209 unique number. Make the same adjustment to the section titles in
2210 the list of Invariant Sections in the license notice of the
2213 In the combination, you must combine any sections Entitled
2214 "History" in the various original documents, forming one section
2215 Entitled "History"; likewise combine any sections Entitled
2216 "Acknowledgements", and any sections Entitled "Dedications". You
2217 must delete all sections Entitled "Endorsements."
2219 6. COLLECTIONS OF DOCUMENTS
2221 You may make a collection consisting of the Document and other
2222 documents released under this License, and replace the individual
2223 copies of this License in the various documents with a single copy
2224 that is included in the collection, provided that you follow the
2225 rules of this License for verbatim copying of each of the documents
2226 in all other respects.
2228 You may extract a single document from such a collection, and
2229 distribute it individually under this License, provided you insert
2230 a copy of this License into the extracted document, and follow this
2231 License in all other respects regarding verbatim copying of that
2234 7. AGGREGATION WITH INDEPENDENT WORKS
2236 A compilation of the Document or its derivatives with other
2237 separate and independent documents or works, in or on a volume of a
2238 storage or distribution medium, is called an "aggregate" if the
2239 copyright resulting from the compilation is not used to limit the
2240 legal rights of the compilation's users beyond what the individual
2241 works permit. When the Document is included in an aggregate, this
2242 License does not apply to the other works in the aggregate which
2243 are not themselves derivative works of the Document.
2245 If the Cover Text requirement of section 3 is applicable to these
2246 copies of the Document, then if the Document is less than one half
2247 of the entire aggregate, the Document's Cover Texts may be placed
2248 on covers that bracket the Document within the aggregate, or the
2249 electronic equivalent of covers if the Document is in electronic
2250 form. Otherwise they must appear on printed covers that bracket
2251 the whole aggregate.
2255 Translation is considered a kind of modification, so you may
2256 distribute translations of the Document under the terms of section
2257 4. Replacing Invariant Sections with translations requires special
2258 permission from their copyright holders, but you may include
2259 translations of some or all Invariant Sections in addition to the
2260 original versions of these Invariant Sections. You may include a
2261 translation of this License, and all the license notices in the
2262 Document, and any Warranty Disclaimers, provided that you also
2263 include the original English version of this License and the
2264 original versions of those notices and disclaimers. In case of a
2265 disagreement between the translation and the original version of
2266 this License or a notice or disclaimer, the original version will
2269 If a section in the Document is Entitled "Acknowledgements",
2270 "Dedications", or "History", the requirement (section 4) to
2271 Preserve its Title (section 1) will typically require changing the
2276 You may not copy, modify, sublicense, or distribute the Document
2277 except as expressly provided under this License. Any attempt
2278 otherwise to copy, modify, sublicense, or distribute it is void,
2279 and will automatically terminate your rights under this License.
2281 However, if you cease all violation of this License, then your
2282 license from a particular copyright holder is reinstated (a)
2283 provisionally, unless and until the copyright holder explicitly and
2284 finally terminates your license, and (b) permanently, if the
2285 copyright holder fails to notify you of the violation by some
2286 reasonable means prior to 60 days after the cessation.
2288 Moreover, your license from a particular copyright holder is
2289 reinstated permanently if the copyright holder notifies you of the
2290 violation by some reasonable means, this is the first time you have
2291 received notice of violation of this License (for any work) from
2292 that copyright holder, and you cure the violation prior to 30 days
2293 after your receipt of the notice.
2295 Termination of your rights under this section does not terminate
2296 the licenses of parties who have received copies or rights from you
2297 under this License. If your rights have been terminated and not
2298 permanently reinstated, receipt of a copy of some or all of the
2299 same material does not give you any rights to use it.
2301 10. FUTURE REVISIONS OF THIS LICENSE
2303 The Free Software Foundation may publish new, revised versions of
2304 the GNU Free Documentation License from time to time. Such new
2305 versions will be similar in spirit to the present version, but may
2306 differ in detail to address new problems or concerns. See
2307 <http://www.gnu.org/copyleft/>.
2309 Each version of the License is given a distinguishing version
2310 number. If the Document specifies that a particular numbered
2311 version of this License "or any later version" applies to it, you
2312 have the option of following the terms and conditions either of
2313 that specified version or of any later version that has been
2314 published (not as a draft) by the Free Software Foundation. If the
2315 Document does not specify a version number of this License, you may
2316 choose any version ever published (not as a draft) by the Free
2317 Software Foundation. If the Document specifies that a proxy can
2318 decide which future versions of this License can be used, that
2319 proxy's public statement of acceptance of a version permanently
2320 authorizes you to choose that version for the Document.
2324 "Massive Multiauthor Collaboration Site" (or "MMC Site") means any
2325 World Wide Web server that publishes copyrightable works and also
2326 provides prominent facilities for anybody to edit those works. A
2327 public wiki that anybody can edit is an example of such a server.
2328 A "Massive Multiauthor Collaboration" (or "MMC") contained in the
2329 site means any set of copyrightable works thus published on the MMC
2332 "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0
2333 license published by Creative Commons Corporation, a not-for-profit
2334 corporation with a principal place of business in San Francisco,
2335 California, as well as future copyleft versions of that license
2336 published by that same organization.
2338 "Incorporate" means to publish or republish a Document, in whole or
2339 in part, as part of another Document.
2341 An MMC is "eligible for relicensing" if it is licensed under this
2342 License, and if all works that were first published under this
2343 License somewhere other than this MMC, and subsequently
2344 incorporated in whole or in part into the MMC, (1) had no cover
2345 texts or invariant sections, and (2) were thus incorporated prior
2346 to November 1, 2008.
2348 The operator of an MMC Site may republish an MMC contained in the
2349 site under CC-BY-SA on the same site at any time before August 1,
2350 2009, provided the MMC is eligible for relicensing.
2352 ADDENDUM: How to use this License for your documents
2353 ====================================================
2355 To use this License in a document you have written, include a copy of
2356 the License in the document and put the following copyright and license
2357 notices just after the title page:
2359 Copyright (C) YEAR YOUR NAME.
2360 Permission is granted to copy, distribute and/or modify this document
2361 under the terms of the GNU Free Documentation License, Version 1.3
2362 or any later version published by the Free Software Foundation;
2363 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
2364 Texts. A copy of the license is included in the section entitled ``GNU
2365 Free Documentation License''.
2367 If you have Invariant Sections, Front-Cover Texts and Back-Cover
2368 Texts, replace the "with...Texts." line with this:
2370 with the Invariant Sections being LIST THEIR TITLES, with
2371 the Front-Cover Texts being LIST, and with the Back-Cover Texts
2374 If you have Invariant Sections without Cover Texts, or some other
2375 combination of the three, merge those two alternatives to suit the
2378 If your document contains nontrivial examples of program code, we
2379 recommend releasing these examples in parallel under your choice of free
2380 software license, such as the GNU General Public License, to permit
2381 their use in free software.
2384 File: ada-mode.info, Node: Index, Prev: GNU Free Documentation License, Up: Top