OSDN Git Service

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