OSDN Git Service

54f245755a77a54c6fa12e51f0bad00f38e2fd65
[pf3gnuchains/gcc-fork.git] / gcc / fortran / gfortran.texi
1 \input texinfo  @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gfortran.info
4 @set copyrights-gfortran 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
5
6 @include gcc-common.texi
7
8 @settitle The GNU Fortran Compiler
9
10 @c Create a separate index for command line options
11 @defcodeindex op
12 @c Merge the standard indexes into a single one.
13 @syncodeindex fn cp
14 @syncodeindex vr cp
15 @syncodeindex ky cp
16 @syncodeindex pg cp
17 @syncodeindex tp cp
18
19 @c TODO: The following "Part" definitions are included here temporarily
20 @c until they are incorporated into the official Texinfo distribution.
21 @c They borrow heavily from Texinfo's \unnchapentry definitions.
22
23 @tex
24 \gdef\part#1#2{%
25   \pchapsepmacro
26   \gdef\thischapter{}
27   \begingroup
28     \vglue\titlepagetopglue
29     \titlefonts \rm
30     \leftline{Part #1:@* #2}
31     \vskip4pt \hrule height 4pt width \hsize \vskip4pt
32   \endgroup
33   \writetocentry{part}{#2}{#1}
34 }
35 \gdef\blankpart{%
36   \writetocentry{blankpart}{}{}
37 }
38 % Part TOC-entry definition for summary contents.
39 \gdef\dosmallpartentry#1#2#3#4{%
40   \vskip .5\baselineskip plus.2\baselineskip
41   \begingroup
42     \let\rm=\bf \rm
43     \tocentry{Part #2: #1}{\doshortpageno\bgroup#4\egroup}
44   \endgroup
45 }
46 \gdef\dosmallblankpartentry#1#2#3#4{%
47   \vskip .5\baselineskip plus.2\baselineskip
48 }
49 % Part TOC-entry definition for regular contents.  This has to be
50 % equated to an existing entry to not cause problems when the PDF
51 % outline is created.
52 \gdef\dopartentry#1#2#3#4{%
53   \unnchapentry{Part #2: #1}{}{#3}{#4}
54 }
55 \gdef\doblankpartentry#1#2#3#4{}
56 @end tex
57
58 @c %**end of header
59
60 @c Use with @@smallbook.
61
62 @c %** start of document
63
64 @c Cause even numbered pages to be printed on the left hand side of
65 @c the page and odd numbered pages to be printed on the right hand
66 @c side of the page.  Using this, you can print on both sides of a
67 @c sheet of paper and have the text on the same part of the sheet.
68
69 @c The text on right hand pages is pushed towards the right hand
70 @c margin and the text on left hand pages is pushed toward the left
71 @c hand margin.
72 @c (To provide the reverse effect, set bindingoffset to -0.75in.)
73
74 @c @tex
75 @c \global\bindingoffset=0.75in
76 @c \global\normaloffset =0.75in
77 @c @end tex
78
79 @copying
80 Copyright @copyright{} @value{copyrights-gfortran} Free Software Foundation, Inc.
81
82 Permission is granted to copy, distribute and/or modify this document
83 under the terms of the GNU Free Documentation License, Version 1.3 or
84 any later version published by the Free Software Foundation; with the
85 Invariant Sections being ``Funding Free Software'', the Front-Cover
86 Texts being (a) (see below), and with the Back-Cover Texts being (b)
87 (see below).  A copy of the license is included in the section entitled
88 ``GNU Free Documentation License''.
89
90 (a) The FSF's Front-Cover Text is:
91
92      A GNU Manual
93
94 (b) The FSF's Back-Cover Text is:
95
96      You have freedom to copy and modify this GNU Manual, like GNU
97      software.  Copies published by the Free Software Foundation raise
98      funds for GNU development.
99 @end copying
100
101 @ifinfo
102 @dircategory Software development
103 @direntry
104 * gfortran: (gfortran).                  The GNU Fortran Compiler.
105 @end direntry
106 This file documents the use and the internals of
107 the GNU Fortran compiler, (@command{gfortran}).
108
109 Published by the Free Software Foundation
110 51 Franklin Street, Fifth Floor
111 Boston, MA 02110-1301 USA
112
113 @insertcopying
114 @end ifinfo
115
116
117 @setchapternewpage odd
118 @titlepage
119 @title Using GNU Fortran
120 @versionsubtitle
121 @author The @t{gfortran} team
122 @page
123 @vskip 0pt plus 1filll
124 Published by the Free Software Foundation@*
125 51 Franklin Street, Fifth Floor@*
126 Boston, MA 02110-1301, USA@*
127 @c Last printed ??ber, 19??.@*
128 @c Printed copies are available for $? each.@*
129 @c ISBN ???
130 @sp 1
131 @insertcopying
132 @end titlepage
133
134 @c TODO: The following "Part" definitions are included here temporarily
135 @c until they are incorporated into the official Texinfo distribution.
136
137 @tex
138 \global\let\partentry=\dosmallpartentry
139 \global\let\blankpartentry=\dosmallblankpartentry
140 @end tex
141 @summarycontents
142
143 @tex
144 \global\let\partentry=\dopartentry
145 \global\let\blankpartentry=\doblankpartentry
146 @end tex
147 @contents
148
149 @page
150
151 @c ---------------------------------------------------------------------
152 @c TexInfo table of contents.
153 @c ---------------------------------------------------------------------
154
155 @ifnottex
156 @node Top
157 @top Introduction
158 @cindex Introduction
159
160 This manual documents the use of @command{gfortran}, 
161 the GNU Fortran compiler.  You can find in this manual how to invoke
162 @command{gfortran}, as well as its features and incompatibilities.
163
164 @ifset DEVELOPMENT
165 @emph{Warning:} This document, and the compiler it describes, are still
166 under development.  While efforts are made to keep it up-to-date, it might
167 not accurately reflect the status of the most recent GNU Fortran compiler.
168 @end ifset
169
170 @comment
171 @comment  When you add a new menu item, please keep the right hand
172 @comment  aligned to the same column.  Do not use tabs.  This provides
173 @comment  better formatting.
174 @comment
175 @menu
176 * Introduction::
177
178 Part I: Invoking GNU Fortran
179 * Invoking GNU Fortran:: Command options supported by @command{gfortran}.
180 * Runtime::              Influencing runtime behavior with environment variables.
181
182 Part II: Language Reference
183 * Fortran 2003 and 2008 status::  Fortran 2003 and 2008 features supported by GNU Fortran.
184 * Compiler Characteristics::      User-visible implementation details.
185 * Mixed-Language Programming::    Interoperability with C
186 * Extensions::           Language extensions implemented by GNU Fortran.
187 * Intrinsic Procedures:: Intrinsic procedures supported by GNU Fortran.
188 * Intrinsic Modules::    Intrinsic modules supported by GNU Fortran.
189
190 * Contributing::         How you can help.
191 * Copying::              GNU General Public License says
192                          how you can copy and share GNU Fortran.
193 * GNU Free Documentation License::
194                          How you can copy and share this manual.
195 * Funding::              How to help assure continued work for free software.
196 * Option Index::         Index of command line options
197 * Keyword Index::        Index of concepts
198 @end menu
199 @end ifnottex
200
201 @c ---------------------------------------------------------------------
202 @c Introduction
203 @c ---------------------------------------------------------------------
204
205 @node Introduction
206 @chapter Introduction
207
208 @c The following duplicates the text on the TexInfo table of contents.
209 @iftex
210 This manual documents the use of @command{gfortran}, the GNU Fortran
211 compiler.  You can find in this manual how to invoke @command{gfortran},
212 as well as its features and incompatibilities.
213
214 @ifset DEVELOPMENT
215 @emph{Warning:} This document, and the compiler it describes, are still
216 under development.  While efforts are made to keep it up-to-date, it
217 might not accurately reflect the status of the most recent GNU Fortran
218 compiler.
219 @end ifset
220 @end iftex
221
222 The GNU Fortran compiler front end was
223 designed initially as a free replacement for,
224 or alternative to, the unix @command{f95} command;
225 @command{gfortran} is the command you'll use to invoke the compiler.
226
227 @menu
228 * About GNU Fortran::    What you should know about the GNU Fortran compiler.
229 * GNU Fortran and GCC::  You can compile Fortran, C, or other programs.
230 * Preprocessing and conditional compilation:: The Fortran preprocessor
231 * GNU Fortran and G77::  Why we chose to start from scratch.
232 * Project Status::       Status of GNU Fortran, roadmap, proposed extensions.
233 * Standards::            Standards supported by GNU Fortran.
234 @end menu
235
236
237 @c ---------------------------------------------------------------------
238 @c About GNU Fortran
239 @c ---------------------------------------------------------------------
240
241 @node About GNU Fortran
242 @section About GNU Fortran
243
244 The GNU Fortran compiler supports the Fortran 77, 90 and 95 standards
245 completely, parts of the Fortran 2003 and Fortran 2008 standards, and
246 several vendor extensions.  The development goal is to provide the
247 following features:
248
249 @itemize @bullet
250 @item
251 Read a user's program,
252 stored in a file and containing instructions written
253 in Fortran 77, Fortran 90, Fortran 95, Fortran 2003 or Fortran 2008.
254 This file contains @dfn{source code}.
255
256 @item
257 Translate the user's program into instructions a computer
258 can carry out more quickly than it takes to translate the
259 instructions in the first
260 place.  The result after compilation of a program is
261 @dfn{machine code},
262 code designed to be efficiently translated and processed
263 by a machine such as your computer.
264 Humans usually aren't as good writing machine code
265 as they are at writing Fortran (or C++, Ada, or Java),
266 because it is easy to make tiny mistakes writing machine code.
267
268 @item
269 Provide the user with information about the reasons why
270 the compiler is unable to create a binary from the source code.
271 Usually this will be the case if the source code is flawed.
272 The Fortran 90 standard requires that the compiler can point out
273 mistakes to the user.
274 An incorrect usage of the language causes an @dfn{error message}.
275
276 The compiler will also attempt to diagnose cases where the
277 user's program contains a correct usage of the language,
278 but instructs the computer to do something questionable.
279 This kind of diagnostics message is called a @dfn{warning message}.
280
281 @item
282 Provide optional information about the translation passes
283 from the source code to machine code.
284 This can help a user of the compiler to find the cause of
285 certain bugs which may not be obvious in the source code,
286 but may be more easily found at a lower level compiler output.
287 It also helps developers to find bugs in the compiler itself.
288
289 @item
290 Provide information in the generated machine code that can
291 make it easier to find bugs in the program (using a debugging tool,
292 called a @dfn{debugger}, such as the GNU Debugger @command{gdb}). 
293
294 @item
295 Locate and gather machine code already generated to
296 perform actions requested by statements in the user's program.
297 This machine code is organized into @dfn{modules} and is located
298 and @dfn{linked} to the user program. 
299 @end itemize
300
301 The GNU Fortran compiler consists of several components:
302
303 @itemize @bullet
304 @item
305 A version of the @command{gcc} command
306 (which also might be installed as the system's @command{cc} command)
307 that also understands and accepts Fortran source code.
308 The @command{gcc} command is the @dfn{driver} program for
309 all the languages in the GNU Compiler Collection (GCC);
310 With @command{gcc},
311 you can compile the source code of any language for
312 which a front end is available in GCC.
313
314 @item
315 The @command{gfortran} command itself,
316 which also might be installed as the
317 system's @command{f95} command.
318 @command{gfortran} is just another driver program,
319 but specifically for the Fortran compiler only.
320 The difference with @command{gcc} is that @command{gfortran}
321 will automatically link the correct libraries to your program.
322
323 @item
324 A collection of run-time libraries.
325 These libraries contain the machine code needed to support
326 capabilities of the Fortran language that are not directly
327 provided by the machine code generated by the
328 @command{gfortran} compilation phase,
329 such as intrinsic functions and subroutines,
330 and routines for interaction with files and the operating system.
331 @c and mechanisms to spawn,
332 @c unleash and pause threads in parallelized code.
333
334 @item
335 The Fortran compiler itself, (@command{f951}).
336 This is the GNU Fortran parser and code generator,
337 linked to and interfaced with the GCC backend library.
338 @command{f951} ``translates'' the source code to
339 assembler code.  You would typically not use this
340 program directly;
341 instead, the @command{gcc} or @command{gfortran} driver
342 programs will call it for you.
343 @end itemize
344
345
346 @c ---------------------------------------------------------------------
347 @c GNU Fortran and GCC
348 @c ---------------------------------------------------------------------
349
350 @node GNU Fortran and GCC
351 @section GNU Fortran and GCC
352 @cindex GNU Compiler Collection
353 @cindex GCC
354
355 GNU Fortran is a part of GCC, the @dfn{GNU Compiler Collection}.  GCC
356 consists of a collection of front ends for various languages, which
357 translate the source code into a language-independent form called
358 @dfn{GENERIC}.  This is then processed by a common middle end which
359 provides optimization, and then passed to one of a collection of back
360 ends which generate code for different computer architectures and
361 operating systems.
362
363 Functionally, this is implemented with a driver program (@command{gcc})
364 which provides the command-line interface for the compiler.  It calls
365 the relevant compiler front-end program (e.g., @command{f951} for
366 Fortran) for each file in the source code, and then calls the assembler
367 and linker as appropriate to produce the compiled output.  In a copy of
368 GCC which has been compiled with Fortran language support enabled,
369 @command{gcc} will recognize files with @file{.f}, @file{.for}, @file{.ftn},
370 @file{.f90}, @file{.f95}, @file{.f03} and @file{.f08} extensions as
371 Fortran source code, and compile it accordingly.  A @command{gfortran}
372 driver program is also provided, which is identical to @command{gcc}
373 except that it automatically links the Fortran runtime libraries into the
374 compiled program.
375
376 Source files with @file{.f}, @file{.for}, @file{.fpp}, @file{.ftn}, @file{.F},
377 @file{.FOR}, @file{.FPP}, and @file{.FTN} extensions are treated as fixed form.
378 Source files with @file{.f90}, @file{.f95}, @file{.f03}, @file{.f08},
379 @file{.F90}, @file{.F95}, @file{.F03} and @file{.F08} extensions are
380 treated as free form.  The capitalized versions of either form are run
381 through preprocessing.  Source files with the lower case @file{.fpp}
382 extension are also run through preprocessing.
383
384 This manual specifically documents the Fortran front end, which handles
385 the programming language's syntax and semantics.  The aspects of GCC
386 which relate to the optimization passes and the back-end code generation
387 are documented in the GCC manual; see 
388 @ref{Top,,Introduction,gcc,Using the GNU Compiler Collection (GCC)}.
389 The two manuals together provide a complete reference for the GNU
390 Fortran compiler.
391
392
393 @c ---------------------------------------------------------------------
394 @c Preprocessing and conditional compilation
395 @c ---------------------------------------------------------------------
396
397 @node Preprocessing and conditional compilation
398 @section Preprocessing and conditional compilation
399 @cindex CPP
400 @cindex FPP
401 @cindex Conditional compilation
402 @cindex Preprocessing
403 @cindex preprocessor, include file handling
404
405 Many Fortran compilers including GNU Fortran allow passing the source code
406 through a C preprocessor (CPP; sometimes also called the Fortran preprocessor,
407 FPP) to allow for conditional compilation.  In the case of GNU Fortran,
408 this is the GNU C Preprocessor in the traditional mode.  On systems with
409 case-preserving file names, the preprocessor is automatically invoked if the
410 filename extension is @file{.F}, @file{.FOR}, @file{.FTN}, @file{.fpp},
411 @file{.FPP}, @file{.F90}, @file{.F95}, @file{.F03} or @file{.F08}.  To manually
412 invoke the preprocessor on any file, use @option{-cpp}, to disable
413 preprocessing on files where the preprocessor is run automatically, use
414 @option{-nocpp}.
415
416 If a preprocessed file includes another file with the Fortran @code{INCLUDE}
417 statement, the included file is not preprocessed.  To preprocess included
418 files, use the equivalent preprocessor statement @code{#include}.
419
420 If GNU Fortran invokes the preprocessor, @code{__GFORTRAN__}
421 is defined and @code{__GNUC__}, @code{__GNUC_MINOR__} and
422 @code{__GNUC_PATCHLEVEL__} can be used to determine the version of the
423 compiler.  See @ref{Top,,Overview,cpp,The C Preprocessor} for details.
424
425 While CPP is the de-facto standard for preprocessing Fortran code,
426 Part 3 of the Fortran 95 standard (ISO/IEC 1539-3:1998) defines
427 Conditional Compilation, which is not widely used and not directly
428 supported by the GNU Fortran compiler.  You can use the program coco
429 to preprocess such files (@uref{http://www.daniellnagle.com/coco.html}).
430
431
432 @c ---------------------------------------------------------------------
433 @c GNU Fortran and G77
434 @c ---------------------------------------------------------------------
435
436 @node GNU Fortran and G77
437 @section GNU Fortran and G77
438 @cindex Fortran 77
439 @cindex @command{g77}
440
441 The GNU Fortran compiler is the successor to @command{g77}, the Fortran 
442 77 front end included in GCC prior to version 4.  It is an entirely new 
443 program that has been designed to provide Fortran 95 support and 
444 extensibility for future Fortran language standards, as well as providing 
445 backwards compatibility for Fortran 77 and nearly all of the GNU language 
446 extensions supported by @command{g77}.
447
448
449 @c ---------------------------------------------------------------------
450 @c Project Status
451 @c ---------------------------------------------------------------------
452
453 @node Project Status
454 @section Project Status
455
456 @quotation
457 As soon as @command{gfortran} can parse all of the statements correctly,
458 it will be in the ``larva'' state.
459 When we generate code, the ``puppa'' state.
460 When @command{gfortran} is done,
461 we'll see if it will be a beautiful butterfly,
462 or just a big bug....
463
464 --Andy Vaught, April 2000
465 @end quotation
466
467 The start of the GNU Fortran 95 project was announced on
468 the GCC homepage in March 18, 2000
469 (even though Andy had already been working on it for a while,
470 of course).
471
472 The GNU Fortran compiler is able to compile nearly all
473 standard-compliant Fortran 95, Fortran 90, and Fortran 77 programs,
474 including a number of standard and non-standard extensions, and can be
475 used on real-world programs.  In particular, the supported extensions
476 include OpenMP, Cray-style pointers, and several Fortran 2003 and Fortran
477 2008 features, including TR 15581.  However, it is still under
478 development and has a few remaining rough edges.
479
480 At present, the GNU Fortran compiler passes the
481 @uref{http://www.fortran-2000.com/ArnaudRecipes/fcvs21_f95.html, 
482 NIST Fortran 77 Test Suite}, and produces acceptable results on the
483 @uref{http://www.netlib.org/lapack/faq.html#1.21, LAPACK Test Suite}.
484 It also provides respectable performance on 
485 the @uref{http://www.polyhedron.com/pb05.html, Polyhedron Fortran
486 compiler benchmarks} and the
487 @uref{http://www.llnl.gov/asci_benchmarks/asci/limited/lfk/README.html,
488 Livermore Fortran Kernels test}.  It has been used to compile a number of
489 large real-world programs, including
490 @uref{http://mysite.verizon.net/serveall/moene.pdf, the HIRLAM
491 weather-forecasting code} and
492 @uref{http://www.theochem.uwa.edu.au/tonto/, the Tonto quantum 
493 chemistry package}; see @url{http://gcc.gnu.org/@/wiki/@/GfortranApps} for an
494 extended list.
495
496 Among other things, the GNU Fortran compiler is intended as a replacement
497 for G77.  At this point, nearly all programs that could be compiled with
498 G77 can be compiled with GNU Fortran, although there are a few minor known
499 regressions.
500
501 The primary work remaining to be done on GNU Fortran falls into three
502 categories: bug fixing (primarily regarding the treatment of invalid code
503 and providing useful error messages), improving the compiler optimizations
504 and the performance of compiled code, and extending the compiler to support
505 future standards---in particular, Fortran 2003 and Fortran 2008.
506
507
508 @c ---------------------------------------------------------------------
509 @c Standards
510 @c ---------------------------------------------------------------------
511
512 @node Standards
513 @section Standards
514 @cindex Standards
515
516 @menu
517 * Varying Length Character Strings::
518 @end menu
519
520 The GNU Fortran compiler implements
521 ISO/IEC 1539:1997 (Fortran 95).  As such, it can also compile essentially all
522 standard-compliant Fortran 90 and Fortran 77 programs.   It also supports
523 the ISO/IEC TR-15581 enhancements to allocatable arrays.
524
525 In the future, the GNU Fortran compiler will also support ISO/IEC
526 1539-1:2004 (Fortran 2003), ISO/IEC 1539-1:2010 (Fortran 2008) and
527 future Fortran standards.  Partial support of the Fortran 2003 and
528 Fortran 2008 standard is already provided; the current status of the
529 support is reported in the @ref{Fortran 2003 status} and
530 @ref{Fortran 2008 status} sections of the documentation.
531
532 Additionally, the GNU Fortran compilers supports the OpenMP specification
533 (version 3.0, @url{http://openmp.org/@/wp/@/openmp-specifications/}).
534
535 @node Varying Length Character Strings
536 @subsection Varying Length Character Strings
537 @cindex Varying length character strings
538 @cindex Varying length strings
539 @cindex strings, varying length
540
541 The Fortran 95 standard specifies in Part 2 (ISO/IEC 1539-2:2000)
542 varying length character strings.  While GNU Fortran currently does not
543 support such strings directly, there exist two Fortran implementations
544 for them, which work with GNU Fortran.  They can be found at
545 @uref{http://www.fortran.com/@/iso_varying_string.f95} and at
546 @uref{ftp://ftp.nag.co.uk/@/sc22wg5/@/ISO_VARYING_STRING/}.
547
548
549
550 @c =====================================================================
551 @c PART I: INVOCATION REFERENCE
552 @c =====================================================================
553
554 @tex
555 \part{I}{Invoking GNU Fortran}
556 @end tex
557
558 @c ---------------------------------------------------------------------
559 @c Compiler Options
560 @c ---------------------------------------------------------------------
561
562 @include invoke.texi
563
564
565 @c ---------------------------------------------------------------------
566 @c Runtime
567 @c ---------------------------------------------------------------------
568
569 @node Runtime
570 @chapter Runtime:  Influencing runtime behavior with environment variables
571 @cindex environment variable
572
573 The behavior of the @command{gfortran} can be influenced by
574 environment variables.
575
576 Malformed environment variables are silently ignored.
577
578 @menu
579 * GFORTRAN_STDIN_UNIT:: Unit number for standard input
580 * GFORTRAN_STDOUT_UNIT:: Unit number for standard output
581 * GFORTRAN_STDERR_UNIT:: Unit number for standard error
582 * GFORTRAN_USE_STDERR:: Send library output to standard error
583 * GFORTRAN_TMPDIR:: Directory for scratch files
584 * GFORTRAN_UNBUFFERED_ALL:: Don't buffer I/O for all units.
585 * GFORTRAN_UNBUFFERED_PRECONNECTED:: Don't buffer I/O for preconnected units.
586 * GFORTRAN_SHOW_LOCUS::  Show location for runtime errors
587 * GFORTRAN_OPTIONAL_PLUS:: Print leading + where permitted
588 * GFORTRAN_DEFAULT_RECL:: Default record length for new files
589 * GFORTRAN_LIST_SEPARATOR::  Separator for list output
590 * GFORTRAN_CONVERT_UNIT::  Set endianness for unformatted I/O
591 * GFORTRAN_ERROR_DUMPCORE:: Dump core on run-time errors
592 * GFORTRAN_ERROR_BACKTRACE:: Show backtrace on run-time errors
593 @end menu
594
595 @node GFORTRAN_STDIN_UNIT
596 @section @env{GFORTRAN_STDIN_UNIT}---Unit number for standard input
597
598 This environment variable can be used to select the unit number
599 preconnected to standard input.  This must be a positive integer.
600 The default value is 5.
601
602 @node GFORTRAN_STDOUT_UNIT
603 @section @env{GFORTRAN_STDOUT_UNIT}---Unit number for standard output
604
605 This environment variable can be used to select the unit number
606 preconnected to standard output.  This must be a positive integer.
607 The default value is 6.
608
609 @node GFORTRAN_STDERR_UNIT
610 @section @env{GFORTRAN_STDERR_UNIT}---Unit number for standard error
611
612 This environment variable can be used to select the unit number
613 preconnected to standard error.  This must be a positive integer.
614 The default value is 0.
615
616 @node GFORTRAN_USE_STDERR
617 @section @env{GFORTRAN_USE_STDERR}---Send library output to standard error
618
619 This environment variable controls where library output is sent.
620 If the first letter is @samp{y}, @samp{Y} or @samp{1}, standard
621 error is used.  If the first letter is @samp{n}, @samp{N} or
622 @samp{0}, standard output is used.
623
624 @node GFORTRAN_TMPDIR
625 @section @env{GFORTRAN_TMPDIR}---Directory for scratch files
626
627 This environment variable controls where scratch files are
628 created.  If this environment variable is missing,
629 GNU Fortran searches for the environment variable @env{TMP}, then @env{TEMP}.
630 If these are missing, the default is @file{/tmp}.
631
632 @node GFORTRAN_UNBUFFERED_ALL
633 @section @env{GFORTRAN_UNBUFFERED_ALL}---Don't buffer I/O on all units
634
635 This environment variable controls whether all I/O is unbuffered.  If
636 the first letter is @samp{y}, @samp{Y} or @samp{1}, all I/O is
637 unbuffered.  This will slow down small sequential reads and writes.  If
638 the first letter is @samp{n}, @samp{N} or @samp{0}, I/O is buffered.
639 This is the default.
640
641 @node GFORTRAN_UNBUFFERED_PRECONNECTED
642 @section @env{GFORTRAN_UNBUFFERED_PRECONNECTED}---Don't buffer I/O on preconnected units
643
644 The environment variable named @env{GFORTRAN_UNBUFFERED_PRECONNECTED} controls
645 whether I/O on a preconnected unit (i.e.@: STDOUT or STDERR) is unbuffered.  If 
646 the first letter is @samp{y}, @samp{Y} or @samp{1}, I/O is unbuffered.  This
647 will slow down small sequential reads and writes.  If the first letter
648 is @samp{n}, @samp{N} or @samp{0}, I/O is buffered.  This is the default.
649
650 @node GFORTRAN_SHOW_LOCUS
651 @section @env{GFORTRAN_SHOW_LOCUS}---Show location for runtime errors
652
653 If the first letter is @samp{y}, @samp{Y} or @samp{1}, filename and
654 line numbers for runtime errors are printed.  If the first letter is
655 @samp{n}, @samp{N} or @samp{0}, don't print filename and line numbers
656 for runtime errors.  The default is to print the location.
657
658 @node GFORTRAN_OPTIONAL_PLUS
659 @section @env{GFORTRAN_OPTIONAL_PLUS}---Print leading + where permitted
660
661 If the first letter is @samp{y}, @samp{Y} or @samp{1},
662 a plus sign is printed
663 where permitted by the Fortran standard.  If the first letter
664 is @samp{n}, @samp{N} or @samp{0}, a plus sign is not printed
665 in most cases.  Default is not to print plus signs.
666
667 @node GFORTRAN_DEFAULT_RECL
668 @section @env{GFORTRAN_DEFAULT_RECL}---Default record length for new files
669
670 This environment variable specifies the default record length, in
671 bytes, for files which are opened without a @code{RECL} tag in the
672 @code{OPEN} statement.  This must be a positive integer.  The
673 default value is 1073741824 bytes (1 GB).
674
675 @node GFORTRAN_LIST_SEPARATOR
676 @section @env{GFORTRAN_LIST_SEPARATOR}---Separator for list output
677
678 This environment variable specifies the separator when writing
679 list-directed output.  It may contain any number of spaces and
680 at most one comma.  If you specify this on the command line,
681 be sure to quote spaces, as in
682 @smallexample
683 $ GFORTRAN_LIST_SEPARATOR='  ,  ' ./a.out
684 @end smallexample
685 when @command{a.out} is the compiled Fortran program that you want to run.
686 Default is a single space.
687
688 @node GFORTRAN_CONVERT_UNIT
689 @section @env{GFORTRAN_CONVERT_UNIT}---Set endianness for unformatted I/O
690
691 By setting the @env{GFORTRAN_CONVERT_UNIT} variable, it is possible
692 to change the representation of data for unformatted files.
693 The syntax for the @env{GFORTRAN_CONVERT_UNIT} variable is:
694 @smallexample
695 GFORTRAN_CONVERT_UNIT: mode | mode ';' exception | exception ;
696 mode: 'native' | 'swap' | 'big_endian' | 'little_endian' ;
697 exception: mode ':' unit_list | unit_list ;
698 unit_list: unit_spec | unit_list unit_spec ;
699 unit_spec: INTEGER | INTEGER '-' INTEGER ;
700 @end smallexample
701 The variable consists of an optional default mode, followed by
702 a list of optional exceptions, which are separated by semicolons
703 from the preceding default and each other.  Each exception consists
704 of a format and a comma-separated list of units.  Valid values for
705 the modes are the same as for the @code{CONVERT} specifier:
706
707 @itemize @w{}
708 @item @code{NATIVE} Use the native format.  This is the default.
709 @item @code{SWAP} Swap between little- and big-endian.
710 @item @code{LITTLE_ENDIAN} Use the little-endian format
711 for unformatted files.
712 @item @code{BIG_ENDIAN} Use the big-endian format for unformatted files.
713 @end itemize
714 A missing mode for an exception is taken to mean @code{BIG_ENDIAN}.
715 Examples of values for @env{GFORTRAN_CONVERT_UNIT} are:
716 @itemize @w{}
717 @item @code{'big_endian'}  Do all unformatted I/O in big_endian mode.
718 @item @code{'little_endian;native:10-20,25'}  Do all unformatted I/O 
719 in little_endian mode, except for units 10 to 20 and 25, which are in
720 native format.
721 @item @code{'10-20'}  Units 10 to 20 are big-endian, the rest is native.
722 @end itemize
723
724 Setting the environment variables should be done on the command
725 line or via the @command{export}
726 command for @command{sh}-compatible shells and via @command{setenv}
727 for @command{csh}-compatible shells.
728
729 Example for @command{sh}:
730 @smallexample
731 $ gfortran foo.f90
732 $ GFORTRAN_CONVERT_UNIT='big_endian;native:10-20' ./a.out
733 @end smallexample
734
735 Example code for @command{csh}:
736 @smallexample
737 % gfortran foo.f90
738 % setenv GFORTRAN_CONVERT_UNIT 'big_endian;native:10-20'
739 % ./a.out
740 @end smallexample
741
742 Using anything but the native representation for unformatted data
743 carries a significant speed overhead.  If speed in this area matters
744 to you, it is best if you use this only for data that needs to be
745 portable.
746
747 @xref{CONVERT specifier}, for an alternative way to specify the
748 data representation for unformatted files.  @xref{Runtime Options}, for
749 setting a default data representation for the whole program.  The
750 @code{CONVERT} specifier overrides the @option{-fconvert} compile options.
751
752 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
753 environment variable will override the CONVERT specifier in the
754 open statement}.  This is to give control over data formats to
755 users who do not have the source code of their program available.
756
757 @node GFORTRAN_ERROR_DUMPCORE
758 @section @env{GFORTRAN_ERROR_DUMPCORE}---Dump core on run-time errors
759
760 If the @env{GFORTRAN_ERROR_DUMPCORE} variable is set to
761 @samp{y}, @samp{Y} or @samp{1} (only the first letter is relevant)
762 then library run-time errors cause core dumps.  To disable the core
763 dumps, set the variable to @samp{n}, @samp{N}, @samp{0}.  Default
764 is not to core dump unless the @option{-fdump-core} compile option
765 was used.
766
767 @node GFORTRAN_ERROR_BACKTRACE
768 @section @env{GFORTRAN_ERROR_BACKTRACE}---Show backtrace on run-time errors
769
770 If the @env{GFORTRAN_ERROR_BACKTRACE} variable is set to
771 @samp{y}, @samp{Y} or @samp{1} (only the first letter is relevant)
772 then a backtrace is printed when a run-time error occurs.
773 To disable the backtracing, set the variable to
774 @samp{n}, @samp{N}, @samp{0}.  Default is not to print a backtrace
775 unless the @option{-fbacktrace} compile option
776 was used.
777
778 @c =====================================================================
779 @c PART II: LANGUAGE REFERENCE
780 @c =====================================================================
781
782 @tex
783 \part{II}{Language Reference}
784 @end tex
785
786 @c ---------------------------------------------------------------------
787 @c Fortran 2003 and 2008 Status
788 @c ---------------------------------------------------------------------
789
790 @node Fortran 2003 and 2008 status
791 @chapter Fortran 2003 and 2008 Status
792
793 @menu
794 * Fortran 2003 status::
795 * Fortran 2008 status::
796 @end menu
797
798 @node Fortran 2003 status
799 @section Fortran 2003 status
800
801 GNU Fortran supports several Fortran 2003 features; an incomplete
802 list can be found below.  See also the
803 @uref{http://gcc.gnu.org/wiki/Fortran2003, wiki page} about Fortran 2003.
804
805 @itemize
806 @item Procedure pointers including procedure-pointer components with
807 @code{PASS} attribute.
808
809 @item Procedures which are bound to a derived type (type-bound procedures)
810 including @code{PASS}, @code{PROCEDURE} and @code{GENERIC}, and
811 operators bound to a type.
812
813 @item Abstract interfaces and and type extension with the possibility to
814 override type-bound procedures or to have deferred binding.
815
816 @item Polymorphic entities (``@code{CLASS}'') for derived types -- including
817 @code{SAME_TYPE_AS}, @code{EXTENDS_TYPE_OF} and @code{SELECT TYPE}.
818 Note that the support for array-valued polymorphic entities is incomplete
819 and unlimited polymophism is currently not supported.
820
821 @item The @code{ASSOCIATE} construct.
822
823 @item Interoperability with C including enumerations, 
824
825 @item In structure constructors the components with default values may be
826 omitted.
827
828 @item Extensions to the @code{ALLOCATE} statement, allowing for a
829 type-specification with type parameter and for allocation and initialization
830 from a @code{SOURCE=} expression; @code{ALLOCATE} and @code{DEALLOCATE}
831 optionally return an error message string via @code{ERRMSG=}.
832
833 @item Reallocation on assignment: If an intrinsic assignment is
834 used, an allocatable variable on the left-hand side is automatically allocated
835 (if unallocated) or reallocated (if the shape is different). Currently, scalar
836 deferred character length left-hand sides are correctly handled but arrays
837 are not yet fully implemented.
838
839 @item Transferring of allocations via @code{MOVE_ALLOC}.
840
841 @item The @code{PRIVATE} and @code{PUBLIC} attributes may be given individually
842 to derived-type components.
843
844 @item In pointer assignments, the lower bound may be specified and
845 the remapping of elements is supported.
846
847 @item For pointers an @code{INTENT} may be specified which affect the
848 association status not the value of the pointer target.
849
850 @item Intrinsics @code{command_argument_count}, @code{get_command},
851 @code{get_command_argument}, and @code{get_environment_variable}.
852
853 @item Support for unicode characters (ISO 10646) and UTF-8, including
854 the @code{SELECTED_CHAR_KIND} and @code{NEW_LINE} intrinsic functions.
855
856 @item Support for binary, octal and hexadecimal (BOZ) constants in the
857 intrinsic functions @code{INT}, @code{REAL}, @code{CMPLX} and @code{DBLE}.
858
859 @item Support for namelist variables with allocatable and pointer
860 attribute and nonconstant length type parameter.
861
862 @item
863 @cindex array, constructors
864 @cindex @code{[...]}
865 Array constructors using square brackets.  That is, @code{[...]} rather
866 than @code{(/.../)}.  Type-specification for array constructors like
867 @code{(/ some-type :: ... /)}.
868
869 @item Extensions to the specification and initialization expressions,
870 including the support for intrinsics with real and complex arguments.
871
872 @item Support for the asynchronous input/output syntax; however, the
873 data transfer is currently always synchronously performed. 
874
875 @item
876 @cindex @code{FLUSH} statement
877 @cindex statement, @code{FLUSH}
878 @code{FLUSH} statement.
879
880 @item
881 @cindex @code{IOMSG=} specifier
882 @code{IOMSG=} specifier for I/O statements.
883
884 @item
885 @cindex @code{ENUM} statement
886 @cindex @code{ENUMERATOR} statement
887 @cindex statement, @code{ENUM}
888 @cindex statement, @code{ENUMERATOR}
889 @opindex @code{fshort-enums}
890 Support for the declaration of enumeration constants via the
891 @code{ENUM} and @code{ENUMERATOR} statements.  Interoperability with
892 @command{gcc} is guaranteed also for the case where the
893 @command{-fshort-enums} command line option is given.
894
895 @item
896 @cindex TR 15581
897 TR 15581:
898 @itemize
899 @item
900 @cindex @code{ALLOCATABLE} dummy arguments
901 @code{ALLOCATABLE} dummy arguments.
902 @item
903 @cindex @code{ALLOCATABLE} function results
904 @code{ALLOCATABLE} function results
905 @item
906 @cindex @code{ALLOCATABLE} components of derived types
907 @code{ALLOCATABLE} components of derived types
908 @end itemize
909
910 @item
911 @cindex @code{STREAM} I/O
912 @cindex @code{ACCESS='STREAM'} I/O
913 The @code{OPEN} statement supports the @code{ACCESS='STREAM'} specifier,
914 allowing I/O without any record structure.
915
916 @item
917 Namelist input/output for internal files.
918
919 @item Further I/O extensions: Rounding during formatted output, using of
920 a decimal comma instead of a decimal point, setting whether a plus sign
921 should appear for positive numbers.
922
923 @item
924 @cindex @code{PROTECTED} statement
925 @cindex statement, @code{PROTECTED}
926 The @code{PROTECTED} statement and attribute.
927
928 @item
929 @cindex @code{VALUE} statement
930 @cindex statement, @code{VALUE}
931 The @code{VALUE} statement and attribute.
932
933 @item
934 @cindex @code{VOLATILE} statement
935 @cindex statement, @code{VOLATILE}
936 The @code{VOLATILE} statement and attribute.
937
938 @item
939 @cindex @code{IMPORT} statement
940 @cindex statement, @code{IMPORT}
941 The @code{IMPORT} statement, allowing to import
942 host-associated derived types.
943
944 @item The intrinsic modules @code{ISO_FORTRAN_ENVIRONMENT} is supported,
945 which contains parameters of the I/O units, storage sizes. Additionally,
946 procedures for C interoperability are available in the @code{ISO_C_BINDING}
947 module.
948
949 @item
950 @cindex @code{USE, INTRINSIC} statement
951 @cindex statement, @code{USE, INTRINSIC}
952 @cindex @code{ISO_FORTRAN_ENV} statement
953 @cindex statement, @code{ISO_FORTRAN_ENV}
954 @code{USE} statement with @code{INTRINSIC} and @code{NON_INTRINSIC}
955 attribute; supported intrinsic modules: @code{ISO_FORTRAN_ENV},
956 @code{ISO_C_BINDING}, @code{OMP_LIB} and @code{OMP_LIB_KINDS}.
957
958 @item
959 Renaming of operators in the @code{USE} statement.
960
961 @end itemize
962
963
964 @node Fortran 2008 status
965 @section Fortran 2008 status
966
967 The latest version of the Fortran standard is ISO/IEC 1539-1:2010, informally
968 known as Fortran 2008.  The official version is available from International
969 Organization for Standardization (ISO) or its national member organizations.
970 The the final draft (FDIS) can be downloaded free of charge from
971 @url{http://www.nag.co.uk/@/sc22wg5/@/links.html}.  Fortran is developed by the
972 Working Group 5 of Sub-Committee 22 of the Joint Technical Committee 1 of the
973 International Organization for Standardization and the International
974 Electrotechnical Commission (IEC).  This group is known as
975 @uref{http://www.nag.co.uk/sc22wg5/, WG5}.
976
977 The GNU Fortran supports several of the new features of Fortran 2008; the
978 @uref{http://gcc.gnu.org/wiki/Fortran2008Status, wiki} has some information
979 about the current Fortran 2008 implementation status.  In particular, the
980 following is implemented.
981
982 @itemize
983 @item The @option{-std=f2008} option and support for the file extensions 
984 @file{.f08} and @file{.F08}.
985
986 @item The @code{OPEN} statement now supports the @code{NEWUNIT=} option,
987 which returns a unique file unit, thus preventing inadvertent use of the
988 same unit in different parts of the program.
989
990 @item The @code{g0} format descriptor and unlimited format items.
991
992 @item The mathematical intrinsics @code{ASINH}, @code{ACOSH}, @code{ATANH},
993 @code{ERF}, @code{ERFC}, @code{GAMMA}, @code{LOG_GAMMA}, @code{BESSEL_J0},
994 @code{BESSEL_J1}, @code{BESSEL_JN}, @code{BESSEL_Y0}, @code{BESSEL_Y1},
995 @code{BESSEL_YN}, @code{HYPOT}, @code{NORM2}, and @code{ERFC_SCALED}.
996
997 @item Using complex arguments with @code{TAN}, @code{SINH}, @code{COSH},
998 @code{TANH}, @code{ASIN}, @code{ACOS}, and @code{ATAN} is now possible;
999 @code{ATAN}(@var{Y},@var{X}) is now an alias for @code{ATAN2}(@var{Y},@var{X}).
1000
1001 @item Support of the @code{PARITY} intrinsic functions.
1002
1003 @item The following bit intrinsics: @code{LEADZ} and @code{TRAILZ} for
1004 counting the number of leading and trailing zero bits, @code{POPCNT} and
1005 @code{POPPAR} for counting the number of one bits and returning the parity;
1006 @code{BGE}, @code{BGT}, @code{BLE}, and @code{BLT} for bitwise comparisons;
1007 @code{DSHIFTL} and @code{DSHIFTR} for combined left and right shifts,
1008 @code{MASKL} and @code{MASKR} for simple left and right justified masks,
1009 @code{MERGE_BITS} for a bitwise merge using a mask, @code{SHIFTA},
1010 @code{SHIFTL} and @code{SHIFTR} for shift operations, and the
1011 transformational bit intrinsics @code{IALL}, @code{IANY} and @code{IPARITY}.
1012
1013 @item Support of the @code{EXECUTE_COMMAND_LINE} intrinsic subroutine.
1014
1015 @item Support for the @code{STORAGE_SIZE} intrinsic inquiry function.
1016
1017 @item The @code{INT@{8,16,32@}} and @code{REAL@{32,64,128@}} kind type
1018 parameters and the array-valued named constants @code{INTEGER_KINDS},
1019 @code{LOGICAL_KINDS}, @code{REAL_KINDS} and @code{CHARACTER_KINDS} of
1020 the intrinsic module @code{ISO_FORTRAN_ENV}.
1021
1022 @item The module procedures @code{C_SIZEOF} of the intrinsic module
1023 @code{ISO_C_BINDINGS} and @code{COMPILER_VERSION} and @code{COMPILER_OPTIONS}
1024 of @code{ISO_FORTRAN_ENV}.
1025
1026 @item Experimental coarray support (for one image only), use the
1027 @option{-fcoarray=single} flag to enable it.
1028
1029 @item The @code{BLOCK} construct is supported.
1030
1031 @item The @code{STOP} and the new @code{ERROR STOP} statements now
1032 support all constant expressions.
1033
1034 @item Support for the @code{CONTIGUOUS} attribute.
1035
1036 @item Support for @code{ALLOCATE} with @code{MOLD}.
1037
1038 @item Support for the @code{IMPURE} attribute for procedures, which
1039 allows for @code{ELEMENTAL} procedures without the restrictions of
1040 @code{PURE}.
1041
1042 @item Null pointers (including @code{NULL()}) and not-allocated variables
1043 can be used as actual argument to optional non-pointer, non-allocatable
1044 dummy arguments, denoting an absent argument.
1045
1046 @item Non-pointer variables with @code{TARGET} attribute can be used as
1047 actual argument to @code{POINTER} dummies with @code{INTENT(IN)}.
1048
1049 @item Pointers including procedure pointers and those in a derived
1050 type (pointer components) can now be initialized by a target instead
1051 of only by @code{NULL}.
1052
1053 @item The @code{EXIT} statement (with construct-name) can be now be
1054 used to leave not only the @code{DO} but also the @code{ASSOCIATE},
1055 @code{BLOCK}, @code{IF}, @code{SELECT CASE} and @code{SELECT TYPE}
1056 constructs.
1057
1058 @item Internal procedures can now be used as actual argument.
1059
1060 @item Minor features: obsolesce diagnostics for @code{ENTRY} with
1061 @option{-std=f2008}; a line may start with a semicolon; for internal
1062 and module procedures @code{END} can be used instead of
1063 @code{END SUBROUTINE} and @code{END FUNCTION}; @code{SELECTED_REAL_KIND}
1064 now also takes a @code{RADIX} argument; intrinsic types are supported
1065 for @code{TYPE}(@var{intrinsic-type-spec}); multiple type-bound procedures
1066 can be declared in a single @code{PROCEDURE} statement; implied-shape
1067 arrays are supported for named constants (@code{PARAMETER}).
1068 @end itemize
1069
1070
1071
1072 @c ---------------------------------------------------------------------
1073 @c Compiler Characteristics
1074 @c ---------------------------------------------------------------------
1075
1076 @node Compiler Characteristics
1077 @chapter Compiler Characteristics
1078
1079 This chapter describes certain characteristics of the GNU Fortran
1080 compiler, that are not specified by the Fortran standard, but which
1081 might in some way or another become visible to the programmer.
1082
1083 @menu
1084 * KIND Type Parameters::
1085 * Internal representation of LOGICAL variables::
1086 @end menu
1087
1088
1089 @node KIND Type Parameters
1090 @section KIND Type Parameters
1091 @cindex kind
1092
1093 The @code{KIND} type parameters supported by GNU Fortran for the primitive
1094 data types are:
1095
1096 @table @code
1097
1098 @item INTEGER
1099 1, 2, 4, 8*, 16*, default: 4 (1)
1100
1101 @item LOGICAL
1102 1, 2, 4, 8*, 16*, default: 4 (1)
1103
1104 @item REAL
1105 4, 8, 10*, 16*, default: 4 (2)
1106
1107 @item COMPLEX
1108 4, 8, 10*, 16*, default: 4 (2)
1109
1110 @item CHARACTER
1111 1, 4, default: 1
1112
1113 @end table
1114
1115 @noindent
1116 * = not available on all systems @*
1117 (1) Unless -fdefault-integer-8 is used @*
1118 (2) Unless -fdefault-real-8 is used
1119
1120 @noindent
1121 The @code{KIND} value matches the storage size in bytes, except for
1122 @code{COMPLEX} where the storage size is twice as much (or both real and
1123 imaginary part are a real value of the given size).  It is recommended to use
1124 the @code{SELECTED_CHAR_KIND}, @code{SELECTED_INT_KIND} and
1125 @code{SELECTED_REAL_KIND} intrinsics or the @code{INT8}, @code{INT16},
1126 @code{INT32}, @code{INT64}, @code{REAL32}, @code{REAL64}, and @code{REAL128}
1127 parameters of the @code{ISO_FORTRAN_ENV} module instead of the concrete values.
1128 The available kind parameters can be found in the constant arrays
1129 @code{CHARACTER_KINDS}, @code{INTEGER_KINDS}, @code{LOGICAL_KINDS} and
1130 @code{REAL_KINDS} in the @code{ISO_FORTRAN_ENV} module
1131 (see @ref{ISO_FORTRAN_ENV}).
1132
1133
1134 @node Internal representation of LOGICAL variables
1135 @section Internal representation of LOGICAL variables
1136 @cindex logical, variable representation
1137
1138 The Fortran standard does not specify how variables of @code{LOGICAL}
1139 type are represented, beyond requiring that @code{LOGICAL} variables
1140 of default kind have the same storage size as default @code{INTEGER}
1141 and @code{REAL} variables.  The GNU Fortran internal representation is
1142 as follows.
1143
1144 A @code{LOGICAL(KIND=N)} variable is represented as an
1145 @code{INTEGER(KIND=N)} variable, however, with only two permissible
1146 values: @code{1} for @code{.TRUE.} and @code{0} for
1147 @code{.FALSE.}.  Any other integer value results in undefined behavior.
1148
1149 Note that for mixed-language programming using the
1150 @code{ISO_C_BINDING} feature, there is a @code{C_BOOL} kind that can
1151 be used to create @code{LOGICAL(KIND=C_BOOL)} variables which are
1152 interoperable with the C99 _Bool type.  The C99 _Bool type has an
1153 internal representation described in the C99 standard, which is
1154 identical to the above description, i.e. with 1 for true and 0 for
1155 false being the only permissible values.  Thus the internal
1156 representation of @code{LOGICAL} variables in GNU Fortran is identical
1157 to C99 _Bool, except for a possible difference in storage size
1158 depending on the kind.
1159
1160
1161 @node Thread-safety of the runtime library
1162 @section Thread-safety of the runtime library
1163 @cindex thread-safety, threads
1164
1165 GNU Fortran can be used in programs with multiple threads, e.g. by
1166 using OpenMP, by calling OS thread handling functions via the
1167 @code{ISO_C_BINDING} facility, or by GNU Fortran compiled library code
1168 being called from a multi-threaded program.
1169
1170 The GNU Fortran runtime library, (@var{libgfortran}), supports being
1171 called concurrently from multiple threads with the following
1172 exceptions. 
1173
1174 During library initialization, the C @code{getenv()} function is used,
1175 which need not be thread-safe.  Similarly, the @code{getenv()}
1176 function is used to implement the @code{GET_ENVIRONMENT_VARIABLE} and
1177 @code{GETENV} intrinsics.  It is the responsibility of the user to
1178 ensure that the environment is not being updated concurrently when any
1179 of these actions are taking place.
1180
1181 The @code{EXECUTE_COMMAND_LINE} and @code{SYSTEM} intrinsics are
1182 implemented with the @code{system()} function, which need not be
1183 thread-safe.  It is the responsibility of the user to ensure that
1184 @code{system()} is not called concurrently.
1185
1186 Finally, for platforms not supporting thread-safe @code{POSIX}
1187 functions, further functionality might not be thread-safe.  For
1188 details, please consult the documentation for your operating system.
1189
1190 @c ---------------------------------------------------------------------
1191 @c Extensions
1192 @c ---------------------------------------------------------------------
1193
1194 @c Maybe this chapter should be merged with the 'Standards' section,
1195 @c whenever that is written :-)
1196
1197 @node Extensions
1198 @chapter Extensions
1199 @cindex extensions
1200
1201 The two sections below detail the extensions to standard Fortran that are
1202 implemented in GNU Fortran, as well as some of the popular or
1203 historically important extensions that are not (or not yet) implemented.
1204 For the latter case, we explain the alternatives available to GNU Fortran
1205 users, including replacement by standard-conforming code or GNU
1206 extensions.
1207
1208 @menu
1209 * Extensions implemented in GNU Fortran::
1210 * Extensions not implemented in GNU Fortran::
1211 @end menu
1212
1213
1214 @node Extensions implemented in GNU Fortran
1215 @section Extensions implemented in GNU Fortran
1216 @cindex extensions, implemented
1217
1218 GNU Fortran implements a number of extensions over standard
1219 Fortran.  This chapter contains information on their syntax and
1220 meaning.  There are currently two categories of GNU Fortran
1221 extensions, those that provide functionality beyond that provided
1222 by any standard, and those that are supported by GNU Fortran
1223 purely for backward compatibility with legacy compilers.  By default,
1224 @option{-std=gnu} allows the compiler to accept both types of
1225 extensions, but to warn about the use of the latter.  Specifying
1226 either @option{-std=f95}, @option{-std=f2003} or @option{-std=f2008}
1227 disables both types of extensions, and @option{-std=legacy} allows both
1228 without warning.
1229
1230 @menu
1231 * Old-style kind specifications::
1232 * Old-style variable initialization::
1233 * Extensions to namelist::
1234 * X format descriptor without count field::
1235 * Commas in FORMAT specifications::
1236 * Missing period in FORMAT specifications::
1237 * I/O item lists::
1238 * BOZ literal constants::
1239 * Real array indices::
1240 * Unary operators::
1241 * Implicitly convert LOGICAL and INTEGER values::
1242 * Hollerith constants support::
1243 * Cray pointers::
1244 * CONVERT specifier::
1245 * OpenMP::
1246 * Argument list functions::
1247 @end menu
1248
1249 @node Old-style kind specifications
1250 @subsection Old-style kind specifications
1251 @cindex kind, old-style
1252
1253 GNU Fortran allows old-style kind specifications in declarations.  These
1254 look like:
1255 @smallexample
1256       TYPESPEC*size x,y,z
1257 @end smallexample
1258 @noindent
1259 where @code{TYPESPEC} is a basic type (@code{INTEGER}, @code{REAL},
1260 etc.), and where @code{size} is a byte count corresponding to the
1261 storage size of a valid kind for that type.  (For @code{COMPLEX}
1262 variables, @code{size} is the total size of the real and imaginary
1263 parts.)  The statement then declares @code{x}, @code{y} and @code{z} to
1264 be of type @code{TYPESPEC} with the appropriate kind.  This is
1265 equivalent to the standard-conforming declaration
1266 @smallexample
1267       TYPESPEC(k) x,y,z
1268 @end smallexample
1269 @noindent
1270 where @code{k} is the kind parameter suitable for the intended precision.  As
1271 kind parameters are implementation-dependent, use the @code{KIND},
1272 @code{SELECTED_INT_KIND} and @code{SELECTED_REAL_KIND} intrinsics to retrieve
1273 the correct value, for instance @code{REAL*8 x} can be replaced by:
1274 @smallexample
1275 INTEGER, PARAMETER :: dbl = KIND(1.0d0)
1276 REAL(KIND=dbl) :: x
1277 @end smallexample
1278
1279 @node Old-style variable initialization
1280 @subsection Old-style variable initialization
1281
1282 GNU Fortran allows old-style initialization of variables of the
1283 form:
1284 @smallexample
1285       INTEGER i/1/,j/2/
1286       REAL x(2,2) /3*0.,1./
1287 @end smallexample
1288 The syntax for the initializers is as for the @code{DATA} statement, but
1289 unlike in a @code{DATA} statement, an initializer only applies to the
1290 variable immediately preceding the initialization.  In other words,
1291 something like @code{INTEGER I,J/2,3/} is not valid.  This style of
1292 initialization is only allowed in declarations without double colons
1293 (@code{::}); the double colons were introduced in Fortran 90, which also
1294 introduced a standard syntax for initializing variables in type
1295 declarations.
1296
1297 Examples of standard-conforming code equivalent to the above example
1298 are:
1299 @smallexample
1300 ! Fortran 90
1301       INTEGER :: i = 1, j = 2
1302       REAL :: x(2,2) = RESHAPE((/0.,0.,0.,1./),SHAPE(x))
1303 ! Fortran 77
1304       INTEGER i, j
1305       REAL x(2,2)
1306       DATA i/1/, j/2/, x/3*0.,1./
1307 @end smallexample
1308
1309 Note that variables which are explicitly initialized in declarations
1310 or in @code{DATA} statements automatically acquire the @code{SAVE}
1311 attribute.
1312
1313 @node Extensions to namelist
1314 @subsection Extensions to namelist
1315 @cindex Namelist
1316
1317 GNU Fortran fully supports the Fortran 95 standard for namelist I/O
1318 including array qualifiers, substrings and fully qualified derived types.
1319 The output from a namelist write is compatible with namelist read.  The
1320 output has all names in upper case and indentation to column 1 after the
1321 namelist name.  Two extensions are permitted:
1322
1323 Old-style use of @samp{$} instead of @samp{&}
1324 @smallexample
1325 $MYNML
1326  X(:)%Y(2) = 1.0 2.0 3.0
1327  CH(1:4) = "abcd"
1328 $END
1329 @end smallexample
1330
1331 It should be noted that the default terminator is @samp{/} rather than
1332 @samp{&END}.
1333
1334 Querying of the namelist when inputting from stdin.  After at least
1335 one space, entering @samp{?} sends to stdout the namelist name and the names of
1336 the variables in the namelist:
1337 @smallexample
1338  ?
1339
1340 &mynml
1341  x
1342  x%y
1343  ch
1344 &end
1345 @end smallexample
1346
1347 Entering @samp{=?} outputs the namelist to stdout, as if
1348 @code{WRITE(*,NML = mynml)} had been called:
1349 @smallexample
1350 =?
1351
1352 &MYNML
1353  X(1)%Y=  0.000000    ,  1.000000    ,  0.000000    ,
1354  X(2)%Y=  0.000000    ,  2.000000    ,  0.000000    ,
1355  X(3)%Y=  0.000000    ,  3.000000    ,  0.000000    ,
1356  CH=abcd,  /
1357 @end smallexample
1358
1359 To aid this dialog, when input is from stdin, errors send their
1360 messages to stderr and execution continues, even if @code{IOSTAT} is set.
1361
1362 @code{PRINT} namelist is permitted.  This causes an error if
1363 @option{-std=f95} is used.
1364 @smallexample
1365 PROGRAM test_print
1366   REAL, dimension (4)  ::  x = (/1.0, 2.0, 3.0, 4.0/)
1367   NAMELIST /mynml/ x
1368   PRINT mynml
1369 END PROGRAM test_print
1370 @end smallexample
1371
1372 Expanded namelist reads are permitted.  This causes an error if 
1373 @option{-std=f95} is used.  In the following example, the first element
1374 of the array will be given the value 0.00 and the two succeeding
1375 elements will be given the values 1.00 and 2.00.
1376 @smallexample
1377 &MYNML
1378   X(1,1) = 0.00 , 1.00 , 2.00
1379 /
1380 @end smallexample
1381
1382 @node X format descriptor without count field
1383 @subsection @code{X} format descriptor without count field
1384
1385 To support legacy codes, GNU Fortran permits the count field of the
1386 @code{X} edit descriptor in @code{FORMAT} statements to be omitted.
1387 When omitted, the count is implicitly assumed to be one.
1388
1389 @smallexample
1390        PRINT 10, 2, 3
1391 10     FORMAT (I1, X, I1)
1392 @end smallexample
1393
1394 @node Commas in FORMAT specifications
1395 @subsection Commas in @code{FORMAT} specifications
1396
1397 To support legacy codes, GNU Fortran allows the comma separator
1398 to be omitted immediately before and after character string edit
1399 descriptors in @code{FORMAT} statements.
1400
1401 @smallexample
1402        PRINT 10, 2, 3
1403 10     FORMAT ('FOO='I1' BAR='I2)
1404 @end smallexample
1405
1406
1407 @node Missing period in FORMAT specifications
1408 @subsection Missing period in @code{FORMAT} specifications
1409
1410 To support legacy codes, GNU Fortran allows missing periods in format
1411 specifications if and only if @option{-std=legacy} is given on the
1412 command line.  This is considered non-conforming code and is
1413 discouraged.
1414
1415 @smallexample
1416        REAL :: value
1417        READ(*,10) value
1418 10     FORMAT ('F4')
1419 @end smallexample
1420
1421 @node I/O item lists
1422 @subsection I/O item lists
1423 @cindex I/O item lists
1424
1425 To support legacy codes, GNU Fortran allows the input item list
1426 of the @code{READ} statement, and the output item lists of the
1427 @code{WRITE} and @code{PRINT} statements, to start with a comma.
1428
1429 @node BOZ literal constants
1430 @subsection BOZ literal constants
1431 @cindex BOZ literal constants
1432
1433 Besides decimal constants, Fortran also supports binary (@code{b}),
1434 octal (@code{o}) and hexadecimal (@code{z}) integer constants.  The
1435 syntax is: @samp{prefix quote digits quote}, were the prefix is
1436 either @code{b}, @code{o} or @code{z}, quote is either @code{'} or
1437 @code{"} and the digits are for binary @code{0} or @code{1}, for
1438 octal between @code{0} and @code{7}, and for hexadecimal between
1439 @code{0} and @code{F}.  (Example: @code{b'01011101'}.)
1440
1441 Up to Fortran 95, BOZ literals were only allowed to initialize
1442 integer variables in DATA statements.  Since Fortran 2003 BOZ literals
1443 are also allowed as argument of @code{REAL}, @code{DBLE}, @code{INT}
1444 and @code{CMPLX}; the result is the same as if the integer BOZ
1445 literal had been converted by @code{TRANSFER} to, respectively,
1446 @code{real}, @code{double precision}, @code{integer} or @code{complex}.
1447 As GNU Fortran extension the intrinsic procedures @code{FLOAT},
1448 @code{DFLOAT}, @code{COMPLEX} and @code{DCMPLX} are treated alike.
1449
1450 As an extension, GNU Fortran allows hexadecimal BOZ literal constants to
1451 be specified using the @code{X} prefix, in addition to the standard
1452 @code{Z} prefix.  The BOZ literal can also be specified by adding a
1453 suffix to the string, for example, @code{Z'ABC'} and @code{'ABC'Z} are
1454 equivalent.
1455
1456 Furthermore, GNU Fortran allows using BOZ literal constants outside
1457 DATA statements and the four intrinsic functions allowed by Fortran 2003.
1458 In DATA statements, in direct assignments, where the right-hand side
1459 only contains a BOZ literal constant, and for old-style initializers of
1460 the form @code{integer i /o'0173'/}, the constant is transferred
1461 as if @code{TRANSFER} had been used; for @code{COMPLEX} numbers, only
1462 the real part is initialized unless @code{CMPLX} is used.  In all other
1463 cases, the BOZ literal constant is converted to an @code{INTEGER} value with
1464 the largest decimal representation.  This value is then converted
1465 numerically to the type and kind of the variable in question.
1466 (For instance, @code{real :: r = b'0000001' + 1} initializes @code{r}
1467 with @code{2.0}.) As different compilers implement the extension
1468 differently, one should be careful when doing bitwise initialization
1469 of non-integer variables.
1470
1471 Note that initializing an @code{INTEGER} variable with a statement such
1472 as @code{DATA i/Z'FFFFFFFF'/} will give an integer overflow error rather
1473 than the desired result of @math{-1} when @code{i} is a 32-bit integer
1474 on a system that supports 64-bit integers.  The @samp{-fno-range-check}
1475 option can be used as a workaround for legacy code that initializes
1476 integers in this manner.
1477
1478 @node Real array indices
1479 @subsection Real array indices
1480 @cindex array, indices of type real
1481
1482 As an extension, GNU Fortran allows the use of @code{REAL} expressions
1483 or variables as array indices.
1484
1485 @node Unary operators
1486 @subsection Unary operators
1487 @cindex operators, unary
1488
1489 As an extension, GNU Fortran allows unary plus and unary minus operators
1490 to appear as the second operand of binary arithmetic operators without
1491 the need for parenthesis.
1492
1493 @smallexample
1494        X = Y * -Z
1495 @end smallexample
1496
1497 @node Implicitly convert LOGICAL and INTEGER values
1498 @subsection Implicitly convert @code{LOGICAL} and @code{INTEGER} values
1499 @cindex conversion, to integer
1500 @cindex conversion, to logical
1501
1502 As an extension for backwards compatibility with other compilers, GNU
1503 Fortran allows the implicit conversion of @code{LOGICAL} values to
1504 @code{INTEGER} values and vice versa.  When converting from a
1505 @code{LOGICAL} to an @code{INTEGER}, @code{.FALSE.} is interpreted as
1506 zero, and @code{.TRUE.} is interpreted as one.  When converting from
1507 @code{INTEGER} to @code{LOGICAL}, the value zero is interpreted as
1508 @code{.FALSE.} and any nonzero value is interpreted as @code{.TRUE.}.
1509
1510 @smallexample
1511         LOGICAL :: l
1512         l = 1
1513 @end smallexample
1514 @smallexample
1515         INTEGER :: i
1516         i = .TRUE.
1517 @end smallexample
1518
1519 However, there is no implicit conversion of @code{INTEGER} values in
1520 @code{if}-statements, nor of @code{LOGICAL} or @code{INTEGER} values
1521 in I/O operations.
1522
1523 @node Hollerith constants support
1524 @subsection Hollerith constants support
1525 @cindex Hollerith constants
1526
1527 GNU Fortran supports Hollerith constants in assignments, function
1528 arguments, and @code{DATA} and @code{ASSIGN} statements.  A Hollerith
1529 constant is written as a string of characters preceded by an integer
1530 constant indicating the character count, and the letter @code{H} or
1531 @code{h}, and stored in bytewise fashion in a numeric (@code{INTEGER},
1532 @code{REAL}, or @code{complex}) or @code{LOGICAL} variable.  The
1533 constant will be padded or truncated to fit the size of the variable in
1534 which it is stored.
1535
1536 Examples of valid uses of Hollerith constants:
1537 @smallexample
1538       complex*16 x(2)
1539       data x /16Habcdefghijklmnop, 16Hqrstuvwxyz012345/
1540       x(1) = 16HABCDEFGHIJKLMNOP
1541       call foo (4h abc)
1542 @end smallexample
1543
1544 Invalid Hollerith constants examples:
1545 @smallexample
1546       integer*4 a
1547       a = 8H12345678 ! Valid, but the Hollerith constant will be truncated.
1548       a = 0H         ! At least one character is needed.
1549 @end smallexample
1550
1551 In general, Hollerith constants were used to provide a rudimentary
1552 facility for handling character strings in early Fortran compilers,
1553 prior to the introduction of @code{CHARACTER} variables in Fortran 77;
1554 in those cases, the standard-compliant equivalent is to convert the
1555 program to use proper character strings.  On occasion, there may be a
1556 case where the intent is specifically to initialize a numeric variable
1557 with a given byte sequence.  In these cases, the same result can be
1558 obtained by using the @code{TRANSFER} statement, as in this example.
1559 @smallexample
1560       INTEGER(KIND=4) :: a
1561       a = TRANSFER ("abcd", a)     ! equivalent to: a = 4Habcd
1562 @end smallexample
1563
1564
1565 @node Cray pointers
1566 @subsection Cray pointers
1567 @cindex pointer, Cray
1568
1569 Cray pointers are part of a non-standard extension that provides a
1570 C-like pointer in Fortran.  This is accomplished through a pair of
1571 variables: an integer "pointer" that holds a memory address, and a
1572 "pointee" that is used to dereference the pointer.
1573
1574 Pointer/pointee pairs are declared in statements of the form:
1575 @smallexample
1576         pointer ( <pointer> , <pointee> )
1577 @end smallexample
1578 or,
1579 @smallexample
1580         pointer ( <pointer1> , <pointee1> ), ( <pointer2> , <pointee2> ), ...
1581 @end smallexample
1582 The pointer is an integer that is intended to hold a memory address.
1583 The pointee may be an array or scalar.  A pointee can be an assumed
1584 size array---that is, the last dimension may be left unspecified by
1585 using a @code{*} in place of a value---but a pointee cannot be an
1586 assumed shape array.  No space is allocated for the pointee.
1587
1588 The pointee may have its type declared before or after the pointer
1589 statement, and its array specification (if any) may be declared
1590 before, during, or after the pointer statement.  The pointer may be
1591 declared as an integer prior to the pointer statement.  However, some
1592 machines have default integer sizes that are different than the size
1593 of a pointer, and so the following code is not portable:
1594 @smallexample
1595         integer ipt
1596         pointer (ipt, iarr)
1597 @end smallexample
1598 If a pointer is declared with a kind that is too small, the compiler
1599 will issue a warning; the resulting binary will probably not work
1600 correctly, because the memory addresses stored in the pointers may be
1601 truncated.  It is safer to omit the first line of the above example;
1602 if explicit declaration of ipt's type is omitted, then the compiler
1603 will ensure that ipt is an integer variable large enough to hold a
1604 pointer.
1605
1606 Pointer arithmetic is valid with Cray pointers, but it is not the same
1607 as C pointer arithmetic.  Cray pointers are just ordinary integers, so
1608 the user is responsible for determining how many bytes to add to a
1609 pointer in order to increment it.  Consider the following example:
1610 @smallexample
1611         real target(10)
1612         real pointee(10)
1613         pointer (ipt, pointee)
1614         ipt = loc (target)
1615         ipt = ipt + 1       
1616 @end smallexample
1617 The last statement does not set @code{ipt} to the address of
1618 @code{target(1)}, as it would in C pointer arithmetic.  Adding @code{1}
1619 to @code{ipt} just adds one byte to the address stored in @code{ipt}.
1620
1621 Any expression involving the pointee will be translated to use the
1622 value stored in the pointer as the base address.
1623
1624 To get the address of elements, this extension provides an intrinsic
1625 function @code{LOC()}.  The @code{LOC()} function is equivalent to the
1626 @code{&} operator in C, except the address is cast to an integer type:
1627 @smallexample
1628         real ar(10)
1629         pointer(ipt, arpte(10))
1630         real arpte
1631         ipt = loc(ar)  ! Makes arpte is an alias for ar
1632         arpte(1) = 1.0 ! Sets ar(1) to 1.0
1633 @end smallexample
1634 The pointer can also be set by a call to the @code{MALLOC} intrinsic
1635 (see @ref{MALLOC}).
1636
1637 Cray pointees often are used to alias an existing variable.  For
1638 example:
1639 @smallexample
1640         integer target(10)
1641         integer iarr(10)
1642         pointer (ipt, iarr)
1643         ipt = loc(target)
1644 @end smallexample
1645 As long as @code{ipt} remains unchanged, @code{iarr} is now an alias for
1646 @code{target}.  The optimizer, however, will not detect this aliasing, so
1647 it is unsafe to use @code{iarr} and @code{target} simultaneously.  Using
1648 a pointee in any way that violates the Fortran aliasing rules or
1649 assumptions is illegal.  It is the user's responsibility to avoid doing
1650 this; the compiler works under the assumption that no such aliasing
1651 occurs.
1652
1653 Cray pointers will work correctly when there is no aliasing (i.e., when
1654 they are used to access a dynamically allocated block of memory), and
1655 also in any routine where a pointee is used, but any variable with which
1656 it shares storage is not used.  Code that violates these rules may not
1657 run as the user intends.  This is not a bug in the optimizer; any code
1658 that violates the aliasing rules is illegal.  (Note that this is not
1659 unique to GNU Fortran; any Fortran compiler that supports Cray pointers
1660 will ``incorrectly'' optimize code with illegal aliasing.)
1661
1662 There are a number of restrictions on the attributes that can be applied
1663 to Cray pointers and pointees.  Pointees may not have the
1664 @code{ALLOCATABLE}, @code{INTENT}, @code{OPTIONAL}, @code{DUMMY},
1665 @code{TARGET}, @code{INTRINSIC}, or @code{POINTER} attributes.  Pointers
1666 may not have the @code{DIMENSION}, @code{POINTER}, @code{TARGET},
1667 @code{ALLOCATABLE}, @code{EXTERNAL}, or @code{INTRINSIC} attributes, nor
1668 may they be function results.  Pointees may not occur in more than one
1669 pointer statement.  A pointee cannot be a pointer.  Pointees cannot occur
1670 in equivalence, common, or data statements.
1671
1672 A Cray pointer may also point to a function or a subroutine.  For
1673 example, the following excerpt is valid:
1674 @smallexample
1675   implicit none
1676   external sub
1677   pointer (subptr,subpte)
1678   external subpte
1679   subptr = loc(sub)
1680   call subpte()
1681   [...]
1682   subroutine sub
1683   [...]
1684   end subroutine sub
1685 @end smallexample
1686
1687 A pointer may be modified during the course of a program, and this
1688 will change the location to which the pointee refers.  However, when
1689 pointees are passed as arguments, they are treated as ordinary
1690 variables in the invoked function.  Subsequent changes to the pointer
1691 will not change the base address of the array that was passed.
1692
1693 @node CONVERT specifier
1694 @subsection @code{CONVERT} specifier
1695 @cindex @code{CONVERT} specifier
1696
1697 GNU Fortran allows the conversion of unformatted data between little-
1698 and big-endian representation to facilitate moving of data
1699 between different systems.  The conversion can be indicated with
1700 the @code{CONVERT} specifier on the @code{OPEN} statement.
1701 @xref{GFORTRAN_CONVERT_UNIT}, for an alternative way of specifying
1702 the data format via an environment variable.
1703
1704 Valid values for @code{CONVERT} are:
1705 @itemize @w{}
1706 @item @code{CONVERT='NATIVE'} Use the native format.  This is the default.
1707 @item @code{CONVERT='SWAP'} Swap between little- and big-endian.
1708 @item @code{CONVERT='LITTLE_ENDIAN'} Use the little-endian representation
1709 for unformatted files.
1710 @item @code{CONVERT='BIG_ENDIAN'} Use the big-endian representation for
1711 unformatted files.
1712 @end itemize
1713
1714 Using the option could look like this:
1715 @smallexample
1716   open(file='big.dat',form='unformatted',access='sequential', &
1717        convert='big_endian')
1718 @end smallexample
1719
1720 The value of the conversion can be queried by using
1721 @code{INQUIRE(CONVERT=ch)}.  The values returned are
1722 @code{'BIG_ENDIAN'} and @code{'LITTLE_ENDIAN'}.
1723
1724 @code{CONVERT} works between big- and little-endian for
1725 @code{INTEGER} values of all supported kinds and for @code{REAL}
1726 on IEEE systems of kinds 4 and 8.  Conversion between different
1727 ``extended double'' types on different architectures such as
1728 m68k and x86_64, which GNU Fortran
1729 supports as @code{REAL(KIND=10)} and @code{REAL(KIND=16)}, will
1730 probably not work.
1731
1732 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
1733 environment variable will override the CONVERT specifier in the
1734 open statement}.  This is to give control over data formats to
1735 users who do not have the source code of their program available.
1736
1737 Using anything but the native representation for unformatted data
1738 carries a significant speed overhead.  If speed in this area matters
1739 to you, it is best if you use this only for data that needs to be
1740 portable.
1741
1742 @node OpenMP
1743 @subsection OpenMP
1744 @cindex OpenMP
1745
1746 OpenMP (Open Multi-Processing) is an application programming
1747 interface (API) that supports multi-platform shared memory 
1748 multiprocessing programming in C/C++ and Fortran on many 
1749 architectures, including Unix and Microsoft Windows platforms.
1750 It consists of a set of compiler directives, library routines,
1751 and environment variables that influence run-time behavior.
1752
1753 GNU Fortran strives to be compatible to the 
1754 @uref{http://www.openmp.org/mp-documents/spec30.pdf,
1755 OpenMP Application Program Interface v3.0}.
1756
1757 To enable the processing of the OpenMP directive @code{!$omp} in
1758 free-form source code; the @code{c$omp}, @code{*$omp} and @code{!$omp}
1759 directives in fixed form; the @code{!$} conditional compilation sentinels
1760 in free form; and the @code{c$}, @code{*$} and @code{!$} sentinels
1761 in fixed form, @command{gfortran} needs to be invoked with the
1762 @option{-fopenmp}.  This also arranges for automatic linking of the
1763 GNU OpenMP runtime library @ref{Top,,libgomp,libgomp,GNU OpenMP
1764 runtime library}.
1765
1766 The OpenMP Fortran runtime library routines are provided both in a
1767 form of a Fortran 90 module named @code{omp_lib} and in a form of
1768 a Fortran @code{include} file named @file{omp_lib.h}.
1769
1770 An example of a parallelized loop taken from Appendix A.1 of
1771 the OpenMP Application Program Interface v2.5:
1772 @smallexample
1773 SUBROUTINE A1(N, A, B)
1774   INTEGER I, N
1775   REAL B(N), A(N)
1776 !$OMP PARALLEL DO !I is private by default
1777   DO I=2,N
1778     B(I) = (A(I) + A(I-1)) / 2.0
1779   ENDDO
1780 !$OMP END PARALLEL DO
1781 END SUBROUTINE A1
1782 @end smallexample
1783
1784 Please note:
1785 @itemize
1786 @item
1787 @option{-fopenmp} implies @option{-frecursive}, i.e., all local arrays
1788 will be allocated on the stack.  When porting existing code to OpenMP,
1789 this may lead to surprising results, especially to segmentation faults
1790 if the stacksize is limited.
1791
1792 @item
1793 On glibc-based systems, OpenMP enabled applications cannot be statically
1794 linked due to limitations of the underlying pthreads-implementation.  It
1795 might be possible to get a working solution if 
1796 @command{-Wl,--whole-archive -lpthread -Wl,--no-whole-archive} is added
1797 to the command line.  However, this is not supported by @command{gcc} and
1798 thus not recommended.
1799 @end itemize
1800
1801 @node Argument list functions
1802 @subsection Argument list functions @code{%VAL}, @code{%REF} and @code{%LOC}
1803 @cindex argument list functions
1804 @cindex @code{%VAL}
1805 @cindex @code{%REF}
1806 @cindex @code{%LOC}
1807
1808 GNU Fortran supports argument list functions @code{%VAL}, @code{%REF} 
1809 and @code{%LOC} statements, for backward compatibility with g77. 
1810 It is recommended that these should be used only for code that is 
1811 accessing facilities outside of GNU Fortran, such as operating system 
1812 or windowing facilities.  It is best to constrain such uses to isolated 
1813 portions of a program--portions that deal specifically and exclusively 
1814 with low-level, system-dependent facilities.  Such portions might well 
1815 provide a portable interface for use by the program as a whole, but are 
1816 themselves not portable, and should be thoroughly tested each time they 
1817 are rebuilt using a new compiler or version of a compiler.
1818
1819 @code{%VAL} passes a scalar argument by value, @code{%REF} passes it by 
1820 reference and @code{%LOC} passes its memory location.  Since gfortran 
1821 already passes scalar arguments by reference, @code{%REF} is in effect 
1822 a do-nothing.  @code{%LOC} has the same effect as a Fortran pointer.
1823
1824 An example of passing an argument by value to a C subroutine foo.:
1825 @smallexample
1826 C
1827 C prototype      void foo_ (float x);
1828 C
1829       external foo
1830       real*4 x
1831       x = 3.14159
1832       call foo (%VAL (x))
1833       end
1834 @end smallexample
1835
1836 For details refer to the g77 manual
1837 @uref{http://gcc.gnu.org/@/onlinedocs/@/gcc-3.4.6/@/g77/@/index.html#Top}.
1838
1839 Also, @code{c_by_val.f} and its partner @code{c_by_val.c} of the
1840 GNU Fortran testsuite are worth a look.
1841
1842
1843 @node Extensions not implemented in GNU Fortran
1844 @section Extensions not implemented in GNU Fortran
1845 @cindex extensions, not implemented
1846
1847 The long history of the Fortran language, its wide use and broad
1848 userbase, the large number of different compiler vendors and the lack of
1849 some features crucial to users in the first standards have lead to the
1850 existence of a number of important extensions to the language.  While
1851 some of the most useful or popular extensions are supported by the GNU
1852 Fortran compiler, not all existing extensions are supported.  This section
1853 aims at listing these extensions and offering advice on how best make
1854 code that uses them running with the GNU Fortran compiler.
1855
1856 @c More can be found here:
1857 @c   -- http://gcc.gnu.org/onlinedocs/gcc-3.4.6/g77/Missing-Features.html
1858 @c   -- the list of Fortran and libgfortran bugs closed as WONTFIX:
1859 @c      http://tinyurl.com/2u4h5y
1860
1861 @menu
1862 * STRUCTURE and RECORD::
1863 @c * UNION and MAP::
1864 * ENCODE and DECODE statements::
1865 * Variable FORMAT expressions::
1866 @c * Q edit descriptor::
1867 @c * AUTOMATIC statement::
1868 @c * TYPE and ACCEPT I/O Statements::
1869 @c * .XOR. operator::
1870 @c * CARRIAGECONTROL, DEFAULTFILE, DISPOSE and RECORDTYPE I/O specifiers::
1871 @c * Omitted arguments in procedure call::
1872 * Alternate complex function syntax::
1873 @end menu
1874
1875
1876 @node STRUCTURE and RECORD
1877 @subsection @code{STRUCTURE} and @code{RECORD}
1878 @cindex @code{STRUCTURE}
1879 @cindex @code{RECORD}
1880
1881 Structures are user-defined aggregate data types; this functionality was
1882 standardized in Fortran 90 with an different syntax, under the name of
1883 ``derived types''.  Here is an example of code using the non portable
1884 structure syntax:
1885
1886 @example
1887 ! Declaring a structure named ``item'' and containing three fields:
1888 ! an integer ID, an description string and a floating-point price.
1889 STRUCTURE /item/
1890   INTEGER id
1891   CHARACTER(LEN=200) description
1892   REAL price
1893 END STRUCTURE
1894
1895 ! Define two variables, an single record of type ``item''
1896 ! named ``pear'', and an array of items named ``store_catalog''
1897 RECORD /item/ pear, store_catalog(100)
1898
1899 ! We can directly access the fields of both variables
1900 pear.id = 92316
1901 pear.description = "juicy D'Anjou pear"
1902 pear.price = 0.15
1903 store_catalog(7).id = 7831
1904 store_catalog(7).description = "milk bottle"
1905 store_catalog(7).price = 1.2
1906
1907 ! We can also manipulate the whole structure
1908 store_catalog(12) = pear
1909 print *, store_catalog(12)
1910 @end example
1911
1912 @noindent
1913 This code can easily be rewritten in the Fortran 90 syntax as following:
1914
1915 @example
1916 ! ``STRUCTURE /name/ ... END STRUCTURE'' becomes
1917 ! ``TYPE name ... END TYPE''
1918 TYPE item
1919   INTEGER id
1920   CHARACTER(LEN=200) description
1921   REAL price
1922 END TYPE
1923
1924 ! ``RECORD /name/ variable'' becomes ``TYPE(name) variable''
1925 TYPE(item) pear, store_catalog(100)
1926
1927 ! Instead of using a dot (.) to access fields of a record, the
1928 ! standard syntax uses a percent sign (%)
1929 pear%id = 92316
1930 pear%description = "juicy D'Anjou pear"
1931 pear%price = 0.15
1932 store_catalog(7)%id = 7831
1933 store_catalog(7)%description = "milk bottle"
1934 store_catalog(7)%price = 1.2
1935
1936 ! Assignments of a whole variable don't change
1937 store_catalog(12) = pear
1938 print *, store_catalog(12)
1939 @end example
1940
1941
1942 @c @node UNION and MAP
1943 @c @subsection @code{UNION} and @code{MAP}
1944 @c @cindex @code{UNION}
1945 @c @cindex @code{MAP}
1946 @c
1947 @c For help writing this one, see
1948 @c http://www.eng.umd.edu/~nsw/ench250/fortran1.htm#UNION and
1949 @c http://www.tacc.utexas.edu/services/userguides/pgi/pgiws_ug/pgi32u06.htm
1950
1951
1952 @node ENCODE and DECODE statements
1953 @subsection @code{ENCODE} and @code{DECODE} statements
1954 @cindex @code{ENCODE}
1955 @cindex @code{DECODE}
1956
1957 GNU Fortran doesn't support the @code{ENCODE} and @code{DECODE}
1958 statements.  These statements are best replaced by @code{READ} and
1959 @code{WRITE} statements involving internal files (@code{CHARACTER}
1960 variables and arrays), which have been part of the Fortran standard since
1961 Fortran 77.  For example, replace a code fragment like
1962
1963 @smallexample
1964       INTEGER*1 LINE(80)
1965       REAL A, B, C
1966 c     ... Code that sets LINE
1967       DECODE (80, 9000, LINE) A, B, C
1968  9000 FORMAT (1X, 3(F10.5))
1969 @end smallexample
1970
1971 @noindent
1972 with the following:
1973
1974 @smallexample
1975       CHARACTER(LEN=80) LINE
1976       REAL A, B, C
1977 c     ... Code that sets LINE
1978       READ (UNIT=LINE, FMT=9000) A, B, C
1979  9000 FORMAT (1X, 3(F10.5))
1980 @end smallexample
1981
1982 Similarly, replace a code fragment like
1983
1984 @smallexample
1985       INTEGER*1 LINE(80)
1986       REAL A, B, C
1987 c     ... Code that sets A, B and C
1988       ENCODE (80, 9000, LINE) A, B, C
1989  9000 FORMAT (1X, 'OUTPUT IS ', 3(F10.5))
1990 @end smallexample
1991
1992 @noindent
1993 with the following:
1994
1995 @smallexample
1996       CHARACTER(LEN=80) LINE
1997       REAL A, B, C
1998 c     ... Code that sets A, B and C
1999       WRITE (UNIT=LINE, FMT=9000) A, B, C
2000  9000 FORMAT (1X, 'OUTPUT IS ', 3(F10.5))
2001 @end smallexample
2002
2003
2004 @node Variable FORMAT expressions
2005 @subsection Variable @code{FORMAT} expressions
2006 @cindex @code{FORMAT}
2007
2008 A variable @code{FORMAT} expression is format statement which includes
2009 angle brackets enclosing a Fortran expression: @code{FORMAT(I<N>)}.  GNU
2010 Fortran does not support this legacy extension.  The effect of variable
2011 format expressions can be reproduced by using the more powerful (and
2012 standard) combination of internal output and string formats.  For example,
2013 replace a code fragment like this:
2014
2015 @smallexample
2016       WRITE(6,20) INT1
2017  20   FORMAT(I<N+1>)
2018 @end smallexample
2019
2020 @noindent
2021 with the following:
2022
2023 @smallexample
2024 c     Variable declaration
2025       CHARACTER(LEN=20) FMT
2026 c     
2027 c     Other code here...
2028 c
2029       WRITE(FMT,'("(I", I0, ")")') N+1
2030       WRITE(6,FMT) INT1
2031 @end smallexample
2032
2033 @noindent
2034 or with:
2035
2036 @smallexample
2037 c     Variable declaration
2038       CHARACTER(LEN=20) FMT
2039 c     
2040 c     Other code here...
2041 c
2042       WRITE(FMT,*) N+1
2043       WRITE(6,"(I" // ADJUSTL(FMT) // ")") INT1
2044 @end smallexample
2045
2046
2047 @node Alternate complex function syntax
2048 @subsection Alternate complex function syntax
2049 @cindex Complex function
2050
2051 Some Fortran compilers, including @command{g77}, let the user declare
2052 complex functions with the syntax @code{COMPLEX FUNCTION name*16()}, as
2053 well as @code{COMPLEX*16 FUNCTION name()}.  Both are non-standard, legacy
2054 extensions.  @command{gfortran} accepts the latter form, which is more
2055 common, but not the former.
2056
2057
2058
2059 @c ---------------------------------------------------------------------
2060 @c Mixed-Language Programming
2061 @c ---------------------------------------------------------------------
2062
2063 @node Mixed-Language Programming
2064 @chapter Mixed-Language Programming
2065 @cindex Interoperability
2066 @cindex Mixed-language programming
2067
2068 @menu
2069 * Interoperability with C::
2070 * GNU Fortran Compiler Directives::
2071 * Non-Fortran Main Program::
2072 @end menu
2073
2074 This chapter is about mixed-language interoperability, but also applies
2075 if one links Fortran code compiled by different compilers.  In most cases,
2076 use of the C Binding features of the Fortran 2003 standard is sufficient,
2077 and their use is highly recommended.
2078
2079
2080 @node Interoperability with C
2081 @section Interoperability with C
2082
2083 @menu
2084 * Intrinsic Types::
2085 * Derived Types and struct::
2086 * Interoperable Global Variables::
2087 * Interoperable Subroutines and Functions::
2088 * Working with Pointers::
2089 * Further Interoperability of Fortran with C::
2090 @end menu
2091
2092 Since Fortran 2003 (ISO/IEC 1539-1:2004(E)) there is a
2093 standardized way to generate procedure and derived-type
2094 declarations and global variables which are interoperable with C
2095 (ISO/IEC 9899:1999).  The @code{bind(C)} attribute has been added
2096 to inform the compiler that a symbol shall be interoperable with C;
2097 also, some constraints are added.  Note, however, that not
2098 all C features have a Fortran equivalent or vice versa.  For instance,
2099 neither C's unsigned integers nor C's functions with variable number
2100 of arguments have an equivalent in Fortran.
2101
2102 Note that array dimensions are reversely ordered in C and that arrays in
2103 C always start with index 0 while in Fortran they start by default with
2104 1.  Thus, an array declaration @code{A(n,m)} in Fortran matches
2105 @code{A[m][n]} in C and accessing the element @code{A(i,j)} matches
2106 @code{A[j-1][i-1]}.  The element following @code{A(i,j)} (C: @code{A[j-1][i-1]};
2107 assuming @math{i < n}) in memory is @code{A(i+1,j)} (C: @code{A[j-1][i]}).
2108
2109 @node Intrinsic Types
2110 @subsection Intrinsic Types
2111
2112 In order to ensure that exactly the same variable type and kind is used
2113 in C and Fortran, the named constants shall be used which are defined in the
2114 @code{ISO_C_BINDING} intrinsic module.  That module contains named constants
2115 for kind parameters and character named constants for the escape sequences
2116 in C.  For a list of the constants, see @ref{ISO_C_BINDING}.
2117
2118 @node Derived Types and struct
2119 @subsection Derived Types and struct
2120
2121 For compatibility of derived types with @code{struct}, one needs to use
2122 the @code{BIND(C)} attribute in the type declaration.  For instance, the
2123 following type declaration
2124
2125 @smallexample
2126  USE ISO_C_BINDING
2127  TYPE, BIND(C) :: myType
2128    INTEGER(C_INT) :: i1, i2
2129    INTEGER(C_SIGNED_CHAR) :: i3
2130    REAL(C_DOUBLE) :: d1
2131    COMPLEX(C_FLOAT_COMPLEX) :: c1
2132    CHARACTER(KIND=C_CHAR) :: str(5)
2133  END TYPE
2134 @end smallexample
2135
2136 matches the following @code{struct} declaration in C
2137
2138 @smallexample
2139  struct @{
2140    int i1, i2;
2141    /* Note: "char" might be signed or unsigned.  */
2142    signed char i3;
2143    double d1;
2144    float _Complex c1;
2145    char str[5];
2146  @} myType;
2147 @end smallexample
2148
2149 Derived types with the C binding attribute shall not have the @code{sequence}
2150 attribute, type parameters, the @code{extends} attribute, nor type-bound
2151 procedures.  Every component must be of interoperable type and kind and may not
2152 have the @code{pointer} or @code{allocatable} attribute.  The names of the
2153 variables are irrelevant for interoperability.
2154
2155 As there exist no direct Fortran equivalents, neither unions nor structs
2156 with bit field or variable-length array members are interoperable.
2157
2158 @node Interoperable Global Variables
2159 @subsection Interoperable Global Variables
2160
2161 Variables can be made accessible from C using the C binding attribute,
2162 optionally together with specifying a binding name.  Those variables
2163 have to be declared in the declaration part of a @code{MODULE},
2164 be of interoperable type, and have neither the @code{pointer} nor
2165 the @code{allocatable} attribute.
2166
2167 @smallexample
2168   MODULE m
2169     USE myType_module
2170     USE ISO_C_BINDING
2171     integer(C_INT), bind(C, name="_MyProject_flags") :: global_flag
2172     type(myType), bind(C) :: tp
2173   END MODULE
2174 @end smallexample
2175
2176 Here, @code{_MyProject_flags} is the case-sensitive name of the variable
2177 as seen from C programs while @code{global_flag} is the case-insensitive
2178 name as seen from Fortran.  If no binding name is specified, as for
2179 @var{tp}, the C binding name is the (lowercase) Fortran binding name.
2180 If a binding name is specified, only a single variable may be after the
2181 double colon.  Note of warning: You cannot use a global variable to
2182 access @var{errno} of the C library as the C standard allows it to be
2183 a macro.  Use the @code{IERRNO} intrinsic (GNU extension) instead.
2184
2185 @node Interoperable Subroutines and Functions
2186 @subsection Interoperable Subroutines and Functions
2187
2188 Subroutines and functions have to have the @code{BIND(C)} attribute to
2189 be compatible with C.  The dummy argument declaration is relatively
2190 straightforward.  However, one needs to be careful because C uses
2191 call-by-value by default while Fortran behaves usually similar to
2192 call-by-reference.  Furthermore, strings and pointers are handled
2193 differently.  Note that only explicit size and assumed-size arrays are
2194 supported but not assumed-shape or allocatable arrays.
2195
2196 To pass a variable by value, use the @code{VALUE} attribute.
2197 Thus the following C prototype
2198
2199 @smallexample
2200 @code{int func(int i, int *j)}
2201 @end smallexample
2202
2203 matches the Fortran declaration
2204
2205 @smallexample
2206   integer(c_int) function func(i,j)
2207     use iso_c_binding, only: c_int
2208     integer(c_int), VALUE :: i
2209     integer(c_int) :: j
2210 @end smallexample
2211
2212 Note that pointer arguments also frequently need the @code{VALUE} attribute,
2213 see @ref{Working with Pointers}.
2214
2215 Strings are handled quite differently in C and Fortran.  In C a string
2216 is a @code{NUL}-terminated array of characters while in Fortran each string
2217 has a length associated with it and is thus not terminated (by e.g.
2218 @code{NUL}).  For example, if one wants to use the following C function,
2219
2220 @smallexample
2221   #include <stdio.h>
2222   void print_C(char *string) /* equivalent: char string[]  */
2223   @{
2224      printf("%s\n", string);
2225   @}
2226 @end smallexample
2227
2228 to print ``Hello World'' from Fortran, one can call it using
2229
2230 @smallexample
2231   use iso_c_binding, only: C_CHAR, C_NULL_CHAR
2232   interface
2233     subroutine print_c(string) bind(C, name="print_C")
2234       use iso_c_binding, only: c_char
2235       character(kind=c_char) :: string(*)
2236     end subroutine print_c
2237   end interface
2238   call print_c(C_CHAR_"Hello World"//C_NULL_CHAR)
2239 @end smallexample
2240
2241 As the example shows, one needs to ensure that the
2242 string is @code{NUL} terminated.  Additionally, the dummy argument
2243 @var{string} of @code{print_C} is a length-one assumed-size
2244 array; using @code{character(len=*)} is not allowed.  The example
2245 above uses @code{c_char_"Hello World"} to ensure the string
2246 literal has the right type; typically the default character
2247 kind and @code{c_char} are the same and thus @code{"Hello World"}
2248 is equivalent.  However, the standard does not guarantee this.
2249
2250 The use of strings is now further illustrated using the C library
2251 function @code{strncpy}, whose prototype is
2252
2253 @smallexample
2254   char *strncpy(char *restrict s1, const char *restrict s2, size_t n);
2255 @end smallexample
2256
2257 The function @code{strncpy} copies at most @var{n} characters from
2258 string @var{s2} to @var{s1} and returns @var{s1}.  In the following
2259 example, we ignore the return value:
2260
2261 @smallexample
2262   use iso_c_binding
2263   implicit none
2264   character(len=30) :: str,str2
2265   interface
2266     ! Ignore the return value of strncpy -> subroutine
2267     ! "restrict" is always assumed if we do not pass a pointer
2268     subroutine strncpy(dest, src, n) bind(C)
2269       import
2270       character(kind=c_char),  intent(out) :: dest(*)
2271       character(kind=c_char),  intent(in)  :: src(*)
2272       integer(c_size_t), value, intent(in) :: n
2273     end subroutine strncpy
2274   end interface
2275   str = repeat('X',30) ! Initialize whole string with 'X'
2276   call strncpy(str, c_char_"Hello World"//C_NULL_CHAR, &
2277                len(c_char_"Hello World",kind=c_size_t))
2278   print '(a)', str ! prints: "Hello WorldXXXXXXXXXXXXXXXXXXX"
2279   end
2280 @end smallexample
2281
2282 The intrinsic procedures are described in @ref{Intrinsic Procedures}.
2283
2284 @node Working with Pointers
2285 @subsection Working with Pointers
2286
2287 C pointers are represented in Fortran via the special opaque derived type
2288 @code{type(c_ptr)} (with private components).  Thus one needs to
2289 use intrinsic conversion procedures to convert from or to C pointers.
2290 For example,
2291
2292 @smallexample
2293   use iso_c_binding
2294   type(c_ptr) :: cptr1, cptr2
2295   integer, target :: array(7), scalar
2296   integer, pointer :: pa(:), ps
2297   cptr1 = c_loc(array(1)) ! The programmer needs to ensure that the
2298                           ! array is contiguous if required by the C
2299                           ! procedure
2300   cptr2 = c_loc(scalar)
2301   call c_f_pointer(cptr2, ps)
2302   call c_f_pointer(cptr2, pa, shape=[7])
2303 @end smallexample
2304
2305 When converting C to Fortran arrays, the one-dimensional @code{SHAPE} argument
2306 has to be passed.
2307
2308 If a pointer is a dummy-argument of an interoperable procedure, it usually
2309 has to be declared using the @code{VALUE} attribute.  @code{void*}
2310 matches @code{TYPE(C_PTR), VALUE}, while @code{TYPE(C_PTR)} alone
2311 matches @code{void**}.
2312
2313 Procedure pointers are handled analogously to pointers; the C type is
2314 @code{TYPE(C_FUNPTR)} and the intrinsic conversion procedures are
2315 @code{C_F_PROCPOINTER} and @code{C_FUNLOC}.
2316
2317 Let's consider two examples of actually passing a procedure pointer from
2318 C to Fortran and vice versa.  Note that these examples are also very
2319 similar to passing ordinary pointers between both languages.
2320 First, consider this code in C:
2321
2322 @smallexample
2323 /* Procedure implemented in Fortran.  */
2324 void get_values (void (*)(double));
2325
2326 /* Call-back routine we want called from Fortran.  */
2327 void
2328 print_it (double x)
2329 @{
2330   printf ("Number is %f.\n", x);
2331 @}
2332
2333 /* Call Fortran routine and pass call-back to it.  */
2334 void
2335 foobar ()
2336 @{
2337   get_values (&print_it);
2338 @}
2339 @end smallexample
2340
2341 A matching implementation for @code{get_values} in Fortran, that correctly
2342 receives the procedure pointer from C and is able to call it, is given
2343 in the following @code{MODULE}:
2344
2345 @smallexample
2346 MODULE m
2347   IMPLICIT NONE
2348
2349   ! Define interface of call-back routine.
2350   ABSTRACT INTERFACE
2351     SUBROUTINE callback (x)
2352       USE, INTRINSIC :: ISO_C_BINDING
2353       REAL(KIND=C_DOUBLE), INTENT(IN), VALUE :: x
2354     END SUBROUTINE callback
2355   END INTERFACE
2356
2357 CONTAINS
2358
2359   ! Define C-bound procedure.
2360   SUBROUTINE get_values (cproc) BIND(C)
2361     USE, INTRINSIC :: ISO_C_BINDING
2362     TYPE(C_FUNPTR), INTENT(IN), VALUE :: cproc
2363
2364     PROCEDURE(callback), POINTER :: proc
2365
2366     ! Convert C to Fortran procedure pointer.
2367     CALL C_F_PROCPOINTER (cproc, proc)
2368
2369     ! Call it.
2370     CALL proc (1.0_C_DOUBLE)
2371     CALL proc (-42.0_C_DOUBLE)
2372     CALL proc (18.12_C_DOUBLE)
2373   END SUBROUTINE get_values
2374
2375 END MODULE m
2376 @end smallexample
2377
2378 Next, we want to call a C routine that expects a procedure pointer argument
2379 and pass it a Fortran procedure (which clearly must be interoperable!).
2380 Again, the C function may be:
2381
2382 @smallexample
2383 int
2384 call_it (int (*func)(int), int arg)
2385 @{
2386   return func (arg);
2387 @}
2388 @end smallexample
2389
2390 It can be used as in the following Fortran code:
2391
2392 @smallexample
2393 MODULE m
2394   USE, INTRINSIC :: ISO_C_BINDING
2395   IMPLICIT NONE
2396
2397   ! Define interface of C function.
2398   INTERFACE
2399     INTEGER(KIND=C_INT) FUNCTION call_it (func, arg) BIND(C)
2400       USE, INTRINSIC :: ISO_C_BINDING
2401       TYPE(C_FUNPTR), INTENT(IN), VALUE :: func
2402       INTEGER(KIND=C_INT), INTENT(IN), VALUE :: arg
2403     END FUNCTION call_it
2404   END INTERFACE
2405
2406 CONTAINS
2407
2408   ! Define procedure passed to C function.
2409   ! It must be interoperable!
2410   INTEGER(KIND=C_INT) FUNCTION double_it (arg) BIND(C)
2411     INTEGER(KIND=C_INT), INTENT(IN), VALUE :: arg
2412     double_it = arg + arg
2413   END FUNCTION double_it
2414
2415   ! Call C function.
2416   SUBROUTINE foobar ()
2417     TYPE(C_FUNPTR) :: cproc
2418     INTEGER(KIND=C_INT) :: i
2419
2420     ! Get C procedure pointer.
2421     cproc = C_FUNLOC (double_it)
2422
2423     ! Use it.
2424     DO i = 1_C_INT, 10_C_INT
2425       PRINT *, call_it (cproc, i)
2426     END DO
2427   END SUBROUTINE foobar
2428
2429 END MODULE m
2430 @end smallexample
2431
2432 @node Further Interoperability of Fortran with C
2433 @subsection Further Interoperability of Fortran with C
2434
2435 Assumed-shape and allocatable arrays are passed using an array descriptor
2436 (dope vector).  The internal structure of the array descriptor used
2437 by GNU Fortran is not yet documented and will change.  There will also be
2438 a Technical Report (TR 29113) which standardizes an interoperable
2439 array descriptor.  Until then, you can use the Chasm Language
2440 Interoperability Tools, @url{http://chasm-interop.sourceforge.net/},
2441 which provide an interface to GNU Fortran's array descriptor.
2442
2443 The technical report 29113 will presumably also include support for
2444 C-interoperable @code{OPTIONAL} and for assumed-rank and assumed-type
2445 dummy arguments.  However, the TR has neither been approved nor implemented
2446 in GNU Fortran; therefore, these features are not yet available.
2447
2448
2449
2450 @node GNU Fortran Compiler Directives
2451 @section GNU Fortran Compiler Directives
2452
2453 The Fortran standard standard describes how a conforming program shall
2454 behave; however, the exact implementation is not standardized.  In order
2455 to allow the user to choose specific implementation details, compiler
2456 directives can be used to set attributes of variables and procedures
2457 which are not part of the standard.  Whether a given attribute is
2458 supported and its exact effects depend on both the operating system and
2459 on the processor; see
2460 @ref{Top,,C Extensions,gcc,Using the GNU Compiler Collection (GCC)}
2461 for details.
2462
2463 For procedures and procedure pointers, the following attributes can
2464 be used to change the calling convention:
2465
2466 @itemize
2467 @item @code{CDECL} -- standard C calling convention
2468 @item @code{STDCALL} -- convention where the called procedure pops the stack
2469 @item @code{FASTCALL} -- part of the arguments are passed via registers
2470 instead using the stack
2471 @end itemize
2472
2473 Besides changing the calling convention, the attributes also influence
2474 the decoration of the symbol name, e.g., by a leading underscore or by
2475 a trailing at-sign followed by the number of bytes on the stack.  When
2476 assigning a procedure to a procedure pointer, both should use the same
2477 calling convention.
2478
2479 On some systems, procedures and global variables (module variables and
2480 @code{COMMON} blocks) need special handling to be accessible when they
2481 are in a shared library.  The following attributes are available:
2482
2483 @itemize
2484 @item @code{DLLEXPORT} -- provide a global pointer to a pointer in the DLL
2485 @item @code{DLLIMPORT} -- reference the function or variable using a global pointer 
2486 @end itemize
2487
2488 The attributes are specified using the syntax
2489
2490 @code{!GCC$ ATTRIBUTES} @var{attribute-list} @code{::} @var{variable-list}
2491
2492 where in free-form source code only whitespace is allowed before @code{!GCC$}
2493 and in fixed-form source code @code{!GCC$}, @code{cGCC$} or @code{*GCC$} shall
2494 start in the first column.
2495
2496 For procedures, the compiler directives shall be placed into the body
2497 of the procedure; for variables and procedure pointers, they shall be in
2498 the same declaration part as the variable or procedure pointer.
2499
2500
2501
2502 @node Non-Fortran Main Program
2503 @section Non-Fortran Main Program
2504
2505 @menu
2506 * _gfortran_set_args:: Save command-line arguments
2507 * _gfortran_set_options:: Set library option flags
2508 * _gfortran_set_convert:: Set endian conversion
2509 * _gfortran_set_record_marker:: Set length of record markers
2510 * _gfortran_set_max_subrecord_length:: Set subrecord length
2511 * _gfortran_set_fpe:: Set when a Floating Point Exception should be raised
2512 @end menu
2513
2514 Even if you are doing mixed-language programming, it is very
2515 likely that you do not need to know or use the information in this
2516 section.  Since it is about the internal structure of GNU Fortran,
2517 it may also change in GCC minor releases.
2518
2519 When you compile a @code{PROGRAM} with GNU Fortran, a function
2520 with the name @code{main} (in the symbol table of the object file)
2521 is generated, which initializes the libgfortran library and then
2522 calls the actual program which uses the name @code{MAIN__}, for
2523 historic reasons.  If you link GNU Fortran compiled procedures
2524 to, e.g., a C or C++ program or to a Fortran program compiled by
2525 a different compiler, the libgfortran library is not initialized
2526 and thus a few intrinsic procedures do not work properly, e.g.
2527 those for obtaining the command-line arguments.
2528
2529 Therefore, if your @code{PROGRAM} is not compiled with
2530 GNU Fortran and the GNU Fortran compiled procedures require
2531 intrinsics relying on the library initialization, you need to
2532 initialize the library yourself.  Using the default options,
2533 gfortran calls @code{_gfortran_set_args} and
2534 @code{_gfortran_set_options}.  The initialization of the former
2535 is needed if the called procedures access the command line
2536 (and for backtracing); the latter sets some flags based on the
2537 standard chosen or to enable backtracing.  In typical programs,
2538 it is not necessary to call any initialization function.
2539
2540 If your @code{PROGRAM} is compiled with GNU Fortran, you shall
2541 not call any of the following functions.  The libgfortran
2542 initialization functions are shown in C syntax but using C
2543 bindings they are also accessible from Fortran.
2544
2545
2546 @node _gfortran_set_args
2547 @subsection @code{_gfortran_set_args} --- Save command-line arguments
2548 @fnindex _gfortran_set_args
2549 @cindex libgfortran initialization, set_args
2550
2551 @table @asis
2552 @item @emph{Description}:
2553 @code{_gfortran_set_args} saves the command-line arguments; this
2554 initialization is required if any of the command-line intrinsics
2555 is called.  Additionally, it shall be called if backtracing is
2556 enabled (see @code{_gfortran_set_options}).
2557
2558 @item @emph{Syntax}:
2559 @code{void _gfortran_set_args (int argc, char *argv[])}
2560
2561 @item @emph{Arguments}:
2562 @multitable @columnfractions .15 .70
2563 @item @var{argc} @tab number of command line argument strings
2564 @item @var{argv} @tab the command-line argument strings; argv[0]
2565 is the pathname of the executable itself.
2566 @end multitable
2567
2568 @item @emph{Example}:
2569 @smallexample
2570 int main (int argc, char *argv[])
2571 @{
2572   /* Initialize libgfortran.  */
2573   _gfortran_set_args (argc, argv);
2574   return 0;
2575 @}
2576 @end smallexample
2577 @end table
2578
2579
2580 @node _gfortran_set_options
2581 @subsection @code{_gfortran_set_options} --- Set library option flags
2582 @fnindex _gfortran_set_options
2583 @cindex libgfortran initialization, set_options
2584
2585 @table @asis
2586 @item @emph{Description}:
2587 @code{_gfortran_set_options} sets several flags related to the Fortran
2588 standard to be used, whether backtracing or core dumps should be enabled
2589 and whether range checks should be performed.  The syntax allows for
2590 upward compatibility since the number of passed flags is specified; for
2591 non-passed flags, the default value is used.  See also
2592 @pxref{Code Gen Options}.  Please note that not all flags are actually
2593 used.
2594
2595 @item @emph{Syntax}:
2596 @code{void _gfortran_set_options (int num, int options[])}
2597
2598 @item @emph{Arguments}:
2599 @multitable @columnfractions .15 .70
2600 @item @var{num} @tab number of options passed
2601 @item @var{argv} @tab The list of flag values
2602 @end multitable
2603
2604 @item @emph{option flag list}:
2605 @multitable @columnfractions .15 .70
2606 @item @var{option}[0] @tab Allowed standard; can give run-time errors
2607 if e.g. an input-output edit descriptor is invalid in a given standard.
2608 Possible values are (bitwise or-ed) @code{GFC_STD_F77} (1),
2609 @code{GFC_STD_F95_OBS} (2), @code{GFC_STD_F95_DEL} (4), @code{GFC_STD_F95}
2610 (8), @code{GFC_STD_F2003} (16), @code{GFC_STD_GNU} (32),
2611 @code{GFC_STD_LEGACY} (64), @code{GFC_STD_F2008} (128), and
2612 @code{GFC_STD_F2008_OBS} (256).  Default: @code{GFC_STD_F95_OBS
2613 | GFC_STD_F95_DEL | GFC_STD_F95 | GFC_STD_F2003 | GFC_STD_F2008
2614 | GFC_STD_F2008_OBS | GFC_STD_F77 | GFC_STD_GNU | GFC_STD_LEGACY}.
2615 @item @var{option}[1] @tab Standard-warning flag; prints a warning to
2616 standard error.  Default: @code{GFC_STD_F95_DEL | GFC_STD_LEGACY}.
2617 @item @var{option}[2] @tab If non zero, enable pedantic checking.
2618 Default: off.
2619 @item @var{option}[3] @tab If non zero, enable core dumps on run-time
2620 errors.  Default: off.
2621 @item @var{option}[4] @tab If non zero, enable backtracing on run-time
2622 errors.  Default: off.
2623 Note: Installs a signal handler and requires command-line
2624 initialization using @code{_gfortran_set_args}.
2625 @item @var{option}[5] @tab If non zero, supports signed zeros.
2626 Default: enabled.
2627 @item @var{option}[6] @tab Enables run-time checking.  Possible values
2628 are (bitwise or-ed): GFC_RTCHECK_BOUNDS (1), GFC_RTCHECK_ARRAY_TEMPS (2),
2629 GFC_RTCHECK_RECURSION (4), GFC_RTCHECK_DO (16), GFC_RTCHECK_POINTER (32).
2630 Default: disabled.
2631 @item @var{option}[7] @tab If non zero, range checking is enabled.
2632 Default: enabled.  See -frange-check (@pxref{Code Gen Options}).
2633 @end multitable
2634
2635 @item @emph{Example}:
2636 @smallexample
2637   /* Use gfortran 4.5 default options.  */
2638   static int options[] = @{68, 255, 0, 0, 0, 1, 0, 1@};
2639   _gfortran_set_options (8, &options);
2640 @end smallexample
2641 @end table
2642
2643
2644 @node _gfortran_set_convert
2645 @subsection @code{_gfortran_set_convert} --- Set endian conversion
2646 @fnindex _gfortran_set_convert
2647 @cindex libgfortran initialization, set_convert
2648
2649 @table @asis
2650 @item @emph{Description}:
2651 @code{_gfortran_set_convert} set the representation of data for
2652 unformatted files.
2653
2654 @item @emph{Syntax}:
2655 @code{void _gfortran_set_convert (int conv)}
2656
2657 @item @emph{Arguments}:
2658 @multitable @columnfractions .15 .70
2659 @item @var{conv} @tab Endian conversion, possible values:
2660 GFC_CONVERT_NATIVE (0, default), GFC_CONVERT_SWAP (1),
2661 GFC_CONVERT_BIG (2), GFC_CONVERT_LITTLE (3).
2662 @end multitable
2663
2664 @item @emph{Example}:
2665 @smallexample
2666 int main (int argc, char *argv[])
2667 @{
2668   /* Initialize libgfortran.  */
2669   _gfortran_set_args (argc, argv);
2670   _gfortran_set_convert (1);
2671   return 0;
2672 @}
2673 @end smallexample
2674 @end table
2675
2676
2677 @node _gfortran_set_record_marker
2678 @subsection @code{_gfortran_set_record_marker} --- Set length of record markers
2679 @fnindex _gfortran_set_record_marker
2680 @cindex libgfortran initialization, set_record_marker
2681
2682 @table @asis
2683 @item @emph{Description}:
2684 @code{_gfortran_set_record_marker} sets the length of record markers
2685 for unformatted files.
2686
2687 @item @emph{Syntax}:
2688 @code{void _gfortran_set_record_marker (int val)}
2689
2690 @item @emph{Arguments}:
2691 @multitable @columnfractions .15 .70
2692 @item @var{val} @tab Length of the record marker; valid values
2693 are 4 and 8.  Default is 4.
2694 @end multitable
2695
2696 @item @emph{Example}:
2697 @smallexample
2698 int main (int argc, char *argv[])
2699 @{
2700   /* Initialize libgfortran.  */
2701   _gfortran_set_args (argc, argv);
2702   _gfortran_set_record_marker (8);
2703   return 0;
2704 @}
2705 @end smallexample
2706 @end table
2707
2708
2709 @node _gfortran_set_fpe
2710 @subsection @code{_gfortran_set_fpe} --- Set when a Floating Point Exception should be raised
2711 @fnindex _gfortran_set_fpe
2712 @cindex libgfortran initialization, set_fpe
2713
2714 @table @asis
2715 @item @emph{Description}:
2716 @code{_gfortran_set_fpe} sets the IEEE exceptions for which a
2717 Floating Point Exception (FPE) should be raised.  On most systems,
2718 this will result in a SIGFPE signal being sent and the program
2719 being interrupted.
2720
2721 @item @emph{Syntax}:
2722 @code{void _gfortran_set_fpe (int val)}
2723
2724 @item @emph{Arguments}:
2725 @multitable @columnfractions .15 .70
2726 @item @var{option}[0] @tab IEEE exceptions.  Possible values are
2727 (bitwise or-ed) zero (0, default) no trapping,
2728 @code{GFC_FPE_INVALID} (1), @code{GFC_FPE_DENORMAL} (2),
2729 @code{GFC_FPE_ZERO} (4), @code{GFC_FPE_OVERFLOW} (8),
2730 @code{GFC_FPE_UNDERFLOW} (16), and @code{GFC_FPE_PRECISION} (32).
2731 @end multitable
2732
2733 @item @emph{Example}:
2734 @smallexample
2735 int main (int argc, char *argv[])
2736 @{
2737   /* Initialize libgfortran.  */
2738   _gfortran_set_args (argc, argv);
2739   /* FPE for invalid operations such as SQRT(-1.0).  */
2740   _gfortran_set_fpe (1);
2741   return 0;
2742 @}
2743 @end smallexample
2744 @end table
2745
2746
2747 @node _gfortran_set_max_subrecord_length
2748 @subsection @code{_gfortran_set_max_subrecord_length} --- Set subrecord length
2749 @fnindex _gfortran_set_max_subrecord_length
2750 @cindex libgfortran initialization, set_max_subrecord_length
2751
2752 @table @asis
2753 @item @emph{Description}:
2754 @code{_gfortran_set_max_subrecord_length} set the maximum length
2755 for a subrecord.  This option only makes sense for testing and
2756 debugging of unformatted I/O.
2757
2758 @item @emph{Syntax}:
2759 @code{void _gfortran_set_max_subrecord_length (int val)}
2760
2761 @item @emph{Arguments}:
2762 @multitable @columnfractions .15 .70
2763 @item @var{val} @tab the maximum length for a subrecord;
2764 the maximum permitted value is 2147483639, which is also
2765 the default.
2766 @end multitable
2767
2768 @item @emph{Example}:
2769 @smallexample
2770 int main (int argc, char *argv[])
2771 @{
2772   /* Initialize libgfortran.  */
2773   _gfortran_set_args (argc, argv);
2774   _gfortran_set_max_subrecord_length (8);
2775   return 0;
2776 @}
2777 @end smallexample
2778 @end table
2779
2780
2781
2782 @c Intrinsic Procedures
2783 @c ---------------------------------------------------------------------
2784
2785 @include intrinsic.texi
2786
2787
2788 @tex
2789 \blankpart
2790 @end tex
2791
2792 @c ---------------------------------------------------------------------
2793 @c Contributing
2794 @c ---------------------------------------------------------------------
2795
2796 @node Contributing
2797 @unnumbered Contributing
2798 @cindex Contributing
2799
2800 Free software is only possible if people contribute to efforts
2801 to create it.
2802 We're always in need of more people helping out with ideas
2803 and comments, writing documentation and contributing code.
2804
2805 If you want to contribute to GNU Fortran,
2806 have a look at the long lists of projects you can take on.
2807 Some of these projects are small,
2808 some of them are large;
2809 some are completely orthogonal to the rest of what is
2810 happening on GNU Fortran,
2811 but others are ``mainstream'' projects in need of enthusiastic hackers.
2812 All of these projects are important!
2813 We'll eventually get around to the things here,
2814 but they are also things doable by someone who is willing and able.
2815
2816 @menu
2817 * Contributors::
2818 * Projects::
2819 * Proposed Extensions::
2820 @end menu
2821
2822
2823 @node Contributors
2824 @section Contributors to GNU Fortran
2825 @cindex Contributors
2826 @cindex Credits
2827 @cindex Authors
2828
2829 Most of the parser was hand-crafted by @emph{Andy Vaught}, who is
2830 also the initiator of the whole project.  Thanks Andy!
2831 Most of the interface with GCC was written by @emph{Paul Brook}.
2832
2833 The following individuals have contributed code and/or
2834 ideas and significant help to the GNU Fortran project
2835 (in alphabetical order):
2836
2837 @itemize @minus
2838 @item Janne Blomqvist
2839 @item Steven Bosscher
2840 @item Paul Brook
2841 @item Tobias Burnus
2842 @item Fran@,{c}ois-Xavier Coudert
2843 @item Bud Davis
2844 @item Jerry DeLisle
2845 @item Erik Edelmann
2846 @item Bernhard Fischer
2847 @item Daniel Franke
2848 @item Richard Guenther
2849 @item Richard Henderson
2850 @item Katherine Holcomb
2851 @item Jakub Jelinek
2852 @item Niels Kristian Bech Jensen
2853 @item Steven Johnson
2854 @item Steven G. Kargl
2855 @item Thomas Koenig
2856 @item Asher Langton
2857 @item H. J. Lu
2858 @item Toon Moene
2859 @item Brooks Moses
2860 @item Andrew Pinski
2861 @item Tim Prince
2862 @item Christopher D. Rickett
2863 @item Richard Sandiford
2864 @item Tobias Schl@"uter
2865 @item Roger Sayle
2866 @item Paul Thomas
2867 @item Andy Vaught
2868 @item Feng Wang
2869 @item Janus Weil
2870 @item Daniel Kraft
2871 @end itemize
2872
2873 The following people have contributed bug reports,
2874 smaller or larger patches,
2875 and much needed feedback and encouragement for the
2876 GNU Fortran project: 
2877
2878 @itemize @minus
2879 @item Bill Clodius
2880 @item Dominique d'Humi@`eres
2881 @item Kate Hedstrom
2882 @item Erik Schnetter
2883 @item Joost VandeVondele
2884 @end itemize
2885
2886 Many other individuals have helped debug,
2887 test and improve the GNU Fortran compiler over the past few years,
2888 and we welcome you to do the same!
2889 If you already have done so,
2890 and you would like to see your name listed in the
2891 list above, please contact us.
2892
2893
2894 @node Projects
2895 @section Projects
2896
2897 @table @emph
2898
2899 @item Help build the test suite
2900 Solicit more code for donation to the test suite: the more extensive the
2901 testsuite, the smaller the risk of breaking things in the future! We can
2902 keep code private on request.
2903
2904 @item Bug hunting/squishing
2905 Find bugs and write more test cases! Test cases are especially very
2906 welcome, because it allows us to concentrate on fixing bugs instead of
2907 isolating them.  Going through the bugzilla database at
2908 @url{http://gcc.gnu.org/@/bugzilla/} to reduce testcases posted there and
2909 add more information (for example, for which version does the testcase
2910 work, for which versions does it fail?) is also very helpful.
2911
2912 @end table
2913
2914
2915 @node Proposed Extensions
2916 @section Proposed Extensions
2917
2918 Here's a list of proposed extensions for the GNU Fortran compiler, in no particular
2919 order.  Most of these are necessary to be fully compatible with
2920 existing Fortran compilers, but they are not part of the official
2921 J3 Fortran 95 standard.
2922
2923 @subsection Compiler extensions: 
2924 @itemize @bullet
2925 @item
2926 User-specified alignment rules for structures.
2927
2928 @item
2929 Automatically extend single precision constants to double.
2930
2931 @item
2932 Compile code that conserves memory by dynamically allocating common and
2933 module storage either on stack or heap.
2934
2935 @item
2936 Compile flag to generate code for array conformance checking (suggest -CC).
2937
2938 @item
2939 User control of symbol names (underscores, etc).
2940
2941 @item
2942 Compile setting for maximum size of stack frame size before spilling
2943 parts to static or heap.
2944
2945 @item
2946 Flag to force local variables into static space.
2947
2948 @item
2949 Flag to force local variables onto stack.
2950 @end itemize
2951
2952
2953 @subsection Environment Options
2954 @itemize @bullet
2955 @item
2956 Pluggable library modules for random numbers, linear algebra.
2957 LA should use BLAS calling conventions.
2958
2959 @item
2960 Environment variables controlling actions on arithmetic exceptions like
2961 overflow, underflow, precision loss---Generate NaN, abort, default.
2962 action.
2963
2964 @item
2965 Set precision for fp units that support it (i387).
2966
2967 @item
2968 Variable for setting fp rounding mode.
2969
2970 @item
2971 Variable to fill uninitialized variables with a user-defined bit
2972 pattern.
2973
2974 @item
2975 Environment variable controlling filename that is opened for that unit
2976 number.
2977
2978 @item
2979 Environment variable to clear/trash memory being freed.
2980
2981 @item
2982 Environment variable to control tracing of allocations and frees.
2983
2984 @item
2985 Environment variable to display allocated memory at normal program end.
2986
2987 @item
2988 Environment variable for filename for * IO-unit.
2989
2990 @item
2991 Environment variable for temporary file directory.
2992
2993 @item
2994 Environment variable forcing standard output to be line buffered (unix).
2995
2996 @end itemize
2997
2998
2999 @c ---------------------------------------------------------------------
3000 @c GNU General Public License
3001 @c ---------------------------------------------------------------------
3002
3003 @include gpl_v3.texi
3004
3005
3006
3007 @c ---------------------------------------------------------------------
3008 @c GNU Free Documentation License
3009 @c ---------------------------------------------------------------------
3010
3011 @include fdl.texi
3012
3013
3014
3015 @c ---------------------------------------------------------------------
3016 @c Funding Free Software
3017 @c ---------------------------------------------------------------------
3018
3019 @include funding.texi
3020
3021 @c ---------------------------------------------------------------------
3022 @c Indices
3023 @c ---------------------------------------------------------------------
3024
3025 @node Option Index
3026 @unnumbered Option Index
3027 @command{gfortran}'s command line options are indexed here without any
3028 initial @samp{-} or @samp{--}.  Where an option has both positive and
3029 negative forms (such as -foption and -fno-option), relevant entries in
3030 the manual are indexed under the most appropriate form; it may sometimes
3031 be useful to look up both forms.
3032 @printindex op
3033
3034 @node Keyword Index
3035 @unnumbered Keyword Index
3036 @printindex cp
3037
3038 @bye