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