OSDN Git Service

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