OSDN Git Service

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