gfortran.texi: Document the GFORTRAN_ERROR_DUMPCORE and GFORTRAN_ERROR_BACKTRACE...
[gcc.git] / gcc / fortran / gfortran.texi
1 \input texinfo @c -*-texinfo-*-
2 @c %**start of header
3 @setfilename gfortran.info
4 @set copyrights-gfortran 1999-2007
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.1 or
84 any later version published by the Free Software Foundation; with the
85 Invariant Sections being ``GNU General Public License'' and ``Funding
86 Free Software'', the Front-Cover
87 texts being (a) (see below), and with the Back-Cover Texts being (b)
88 (see below). A copy of the license is included in the section entitled
89 ``GNU Free Documentation License''.
90
91 (a) The FSF's Front-Cover Text is:
92
93 A GNU Manual
94
95 (b) The FSF's Back-Cover Text is:
96
97 You have freedom to copy and modify this GNU Manual, like GNU
98 software. Copies published by the Free Software Foundation raise
99 funds for GNU development.
100 @end copying
101
102 @ifinfo
103 @dircategory Software development
104 @direntry
105 * gfortran: (gfortran). The GNU Fortran Compiler.
106 @end direntry
107 This file documents the use and the internals of
108 the GNU Fortran compiler, (@command{gfortran}).
109
110 Published by the Free Software Foundation
111 51 Franklin Street, Fifth Floor
112 Boston, MA 02110-1301 USA
113
114 @insertcopying
115 @end ifinfo
116
117
118 @setchapternewpage odd
119 @titlepage
120 @title Using GNU Fortran
121 @versionsubtitle
122 @author The @t{gfortran} team
123 @page
124 @vskip 0pt plus 1filll
125 Published by the Free Software Foundation@*
126 51 Franklin Street, Fifth Floor@*
127 Boston, MA 02110-1301, USA@*
128 @c Last printed ??ber, 19??.@*
129 @c Printed copies are available for $? each.@*
130 @c ISBN ???
131 @sp 1
132 @insertcopying
133 @end titlepage
134
135 @c TODO: The following "Part" definitions are included here temporarily
136 @c until they are incorporated into the official Texinfo distribution.
137
138 @tex
139 \global\let\partentry=\dosmallpartentry
140 \global\let\blankpartentry=\dosmallblankpartentry
141 @end tex
142 @summarycontents
143
144 @tex
145 \global\let\partentry=\dopartentry
146 \global\let\blankpartentry=\doblankpartentry
147 @end tex
148 @contents
149
150 @page
151
152 @c ---------------------------------------------------------------------
153 @c TexInfo table of contents.
154 @c ---------------------------------------------------------------------
155
156 @ifnottex
157 @node Top
158 @top Introduction
159 @cindex Introduction
160
161 This manual documents the use of @command{gfortran},
162 the GNU Fortran compiler. You can find in this manual how to invoke
163 @command{gfortran}, as well as its features and incompatibilities.
164
165 @ifset DEVELOPMENT
166 @emph{Warning:} This document, and the compiler it describes, are still
167 under development. While efforts are made to keep it up-to-date, it might
168 not accurately reflect the status of the most recent GNU Fortran compiler.
169 @end ifset
170
171 @comment
172 @comment When you add a new menu item, please keep the right hand
173 @comment aligned to the same column. Do not use tabs. This provides
174 @comment better formatting.
175 @comment
176 @menu
177 * Introduction::
178
179 Part I: Invoking GNU Fortran
180 * Invoking GNU Fortran:: Command options supported by @command{gfortran}.
181 * Runtime:: Influencing runtime behavior with environment variables.
182
183 Part II: Language Reference
184 * Fortran 2003 status:: Fortran 2003 features supported by GNU Fortran.
185 * Extensions:: Language extensions implemented by GNU Fortran.
186 * Intrinsic Procedures:: Intrinsic procedures supported by GNU Fortran.
187
188 * Contributing:: How you can help.
189 * Copying:: GNU General Public License says
190 how you can copy and share GNU Fortran.
191 * GNU Free Documentation License::
192 How you can copy and share this manual.
193 * Funding:: How to help assure continued work for free software.
194 * Option Index:: Index of command line options
195 * Keyword Index:: Index of concepts
196 @end menu
197 @end ifnottex
198
199 @c ---------------------------------------------------------------------
200 @c Introduction
201 @c ---------------------------------------------------------------------
202
203 @node Introduction
204 @chapter Introduction
205
206 @c The following duplicates the text on the TexInfo table of contents.
207 @iftex
208 This manual documents the use of @command{gfortran}, the GNU Fortran
209 compiler. You can find in this manual how to invoke @command{gfortran},
210 as well as its features and incompatibilities.
211
212 @ifset DEVELOPMENT
213 @emph{Warning:} This document, and the compiler it describes, are still
214 under development. While efforts are made to keep it up-to-date, it
215 might not accurately reflect the status of the most recent GNU Fortran
216 compiler.
217 @end ifset
218 @end iftex
219
220 The GNU Fortran compiler front end was
221 designed initially as a free replacement for,
222 or alternative to, the unix @command{f95} command;
223 @command{gfortran} is the command you'll use to invoke the compiler.
224
225 @menu
226 * About GNU Fortran:: What you should know about the GNU Fortran compiler.
227 * GNU Fortran and GCC:: You can compile Fortran, C, or other programs.
228 * GNU Fortran and G77:: Why we chose to start from scratch.
229 * Project Status:: Status of GNU Fortran, roadmap, proposed extensions.
230 * Standards:: Standards supported by GNU Fortran.
231 @end menu
232
233
234 @c ---------------------------------------------------------------------
235 @c About GNU Fortran
236 @c ---------------------------------------------------------------------
237
238 @node About GNU Fortran
239 @section About GNU Fortran
240
241 The GNU Fortran compiler is still in an early state of development.
242 It can generate code for most constructs and expressions,
243 but much work remains to be done.
244
245 When the GNU Fortran compiler is finished,
246 it will do everything you expect from any decent compiler:
247
248 @itemize @bullet
249 @item
250 Read a user's program,
251 stored in a file and containing instructions written
252 in Fortran 77, Fortran 90, Fortran 95 or Fortran 2003.
253 This file contains @dfn{source code}.
254
255 @item
256 Translate the user's program into instructions a computer
257 can carry out more quickly than it takes to translate the
258 instructions in the first
259 place. The result after compilation of a program is
260 @dfn{machine code},
261 code designed to be efficiently translated and processed
262 by a machine such as your computer.
263 Humans usually aren't as good writing machine code
264 as they are at writing Fortran (or C++, Ada, or Java),
265 because is easy to make tiny mistakes writing machine code.
266
267 @item
268 Provide the user with information about the reasons why
269 the compiler is unable to create a binary from the source code.
270 Usually this will be the case if the source code is flawed.
271 When writing Fortran, it is easy to make big mistakes.
272 The Fortran 90 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{.f90}, @file{.f95},
370 and @file{.f03} extensions as Fortran source code, and compile it
371 accordingly. A @command{gfortran} driver program is also provided,
372 which is identical to @command{gcc} except that it automatically links
373 the Fortran runtime libraries into the compiled program.
374
375 This manual specifically documents the Fortran front end, which handles
376 the programming language's syntax and semantics. The aspects of GCC
377 which relate to the optimization passes and the back-end code generation
378 are documented in the GCC manual; see
379 @ref{Top,,Introduction,gcc,Using the GNU Compiler Collection (GCC)}.
380 The two manuals together provide a complete reference for the GNU
381 Fortran compiler.
382
383
384 @c ---------------------------------------------------------------------
385 @c GNU Fortran and G77
386 @c ---------------------------------------------------------------------
387
388 @node GNU Fortran and G77
389 @section GNU Fortran and G77
390 @cindex Fortran 77
391 @cindex @command{g77}
392
393 The GNU Fortran compiler is the successor to @command{g77}, the Fortran
394 77 front end included in GCC prior to version 4. It is an entirely new
395 program that has been designed to provide Fortran 95 support and
396 extensibility for future Fortran language standards, as well as providing
397 backwards compatibility for Fortran 77 and nearly all of the GNU language
398 extensions supported by @command{g77}.
399
400
401 @c ---------------------------------------------------------------------
402 @c Project Status
403 @c ---------------------------------------------------------------------
404
405 @node Project Status
406 @section Project Status
407
408 @quotation
409 As soon as @command{gfortran} can parse all of the statements correctly,
410 it will be in the ``larva'' state.
411 When we generate code, the ``puppa'' state.
412 When @command{gfortran} is done,
413 we'll see if it will be a beautiful butterfly,
414 or just a big bug....
415
416 --Andy Vaught, April 2000
417 @end quotation
418
419 The start of the GNU Fortran 95 project was announced on
420 the GCC homepage in March 18, 2000
421 (even though Andy had already been working on it for a while,
422 of course).
423
424 The GNU Fortran compiler is able to compile nearly all
425 standard-compliant Fortran 95, Fortran 90, and Fortran 77 programs,
426 including a number of standard and non-standard extensions, and can be
427 used on real-world programs. In particular, the supported extensions
428 include OpenMP, Cray-style pointers, and several Fortran 2003 features
429 such as enumeration, stream I/O, and some of the enhancements to
430 allocatable array support from TR 15581. However, it is still under
431 development and has a few remaining rough edges.
432
433 At present, the GNU Fortran compiler passes the
434 @uref{http://www.fortran-2000.com/ArnaudRecipes/fcvs21_f95.html,
435 NIST Fortran 77 Test Suite}, and produces acceptable results on the
436 @uref{http://www.netlib.org/lapack/faq.html#1.21, LAPACK Test Suite}.
437 It also provides respectable performance on
438 the @uref{http://www.polyhedron.com/pb05.html, Polyhedron Fortran
439 compiler benchmarks} and the
440 @uref{http://www.llnl.gov/asci_benchmarks/asci/limited/lfk/README.html,
441 Livermore Fortran Kernels test}. It has been used to compile a number of
442 large real-world programs, including
443 @uref{http://mysite.verizon.net/serveall/moene.pdf, the HIRLAM
444 weather-forecasting code} and
445 @uref{http://www.theochem.uwa.edu.au/tonto/, the Tonto quantum
446 chemistry package}; see @url{http://gcc.gnu.org/wiki/GfortranApps} for an
447 extended list.
448
449 Among other things, the GNU Fortran compiler is intended as a replacement
450 for G77. At this point, nearly all programs that could be compiled with
451 G77 can be compiled with GNU Fortran, although there are a few minor known
452 regressions.
453
454 The primary work remaining to be done on GNU Fortran falls into three
455 categories: bug fixing (primarily regarding the treatment of invalid code
456 and providing useful error messages), improving the compiler optimizations
457 and the performance of compiled code, and extending the compiler to support
458 future standards---in particular, Fortran 2003.
459
460
461 @c ---------------------------------------------------------------------
462 @c Standards
463 @c ---------------------------------------------------------------------
464
465 @node Standards
466 @section Standards
467 @cindex Standards
468
469 The GNU Fortran compiler implements
470 ISO/IEC 1539:1997 (Fortran 95). As such, it can also compile essentially all
471 standard-compliant Fortran 90 and Fortran 77 programs. It also supports
472 the ISO/IEC TR-15581 enhancements to allocatable arrays, and
473 the @uref{http://www.openmp.org/drupal/mp-documents/spec25.pdf,
474 OpenMP Application Program Interface v2.5} specification.
475
476 In the future, the GNU Fortran compiler may also support other standard
477 variants of and extensions to the Fortran language. These include
478 ISO/IEC 1539-1:2004 (Fortran 2003).
479
480
481 @c =====================================================================
482 @c PART I: INVOCATION REFERENCE
483 @c =====================================================================
484
485 @tex
486 \part{I}{Invoking GNU Fortran}
487 @end tex
488
489 @c ---------------------------------------------------------------------
490 @c Compiler Options
491 @c ---------------------------------------------------------------------
492
493 @include invoke.texi
494
495
496 @c ---------------------------------------------------------------------
497 @c Runtime
498 @c ---------------------------------------------------------------------
499
500 @node Runtime
501 @chapter Runtime: Influencing runtime behavior with environment variables
502 @cindex environment variable
503
504 The behavior of the @command{gfortran} can be influenced by
505 environment variables.
506
507 Malformed environment variables are silently ignored.
508
509 @menu
510 * GFORTRAN_STDIN_UNIT:: Unit number for standard input
511 * GFORTRAN_STDOUT_UNIT:: Unit number for standard output
512 * GFORTRAN_STDERR_UNIT:: Unit number for standard error
513 * GFORTRAN_USE_STDERR:: Send library output to standard error
514 * GFORTRAN_TMPDIR:: Directory for scratch files
515 * GFORTRAN_UNBUFFERED_ALL:: Don't buffer output
516 * GFORTRAN_SHOW_LOCUS:: Show location for runtime errors
517 * GFORTRAN_OPTIONAL_PLUS:: Print leading + where permitted
518 * GFORTRAN_DEFAULT_RECL:: Default record length for new files
519 * GFORTRAN_LIST_SEPARATOR:: Separator for list output
520 * GFORTRAN_CONVERT_UNIT:: Set endianness for unformatted I/O
521 * GFORTRAN_ERROR_DUMPCORE:: Dump core on run-time errors
522 * GFORTRAN_ERROR_BACKTRACE:: Show backtrace on run-time errors
523 @end menu
524
525 @node GFORTRAN_STDIN_UNIT
526 @section @env{GFORTRAN_STDIN_UNIT}---Unit number for standard input
527
528 This environment variable can be used to select the unit number
529 preconnected to standard input. This must be a positive integer.
530 The default value is 5.
531
532 @node GFORTRAN_STDOUT_UNIT
533 @section @env{GFORTRAN_STDOUT_UNIT}---Unit number for standard output
534
535 This environment variable can be used to select the unit number
536 preconnected to standard output. This must be a positive integer.
537 The default value is 6.
538
539 @node GFORTRAN_STDERR_UNIT
540 @section @env{GFORTRAN_STDERR_UNIT}---Unit number for standard error
541
542 This environment variable can be used to select the unit number
543 preconnected to standard error. This must be a positive integer.
544 The default value is 0.
545
546 @node GFORTRAN_USE_STDERR
547 @section @env{GFORTRAN_USE_STDERR}---Send library output to standard error
548
549 This environment variable controls where library output is sent.
550 If the first letter is @samp{y}, @samp{Y} or @samp{1}, standard
551 error is used. If the first letter is @samp{n}, @samp{N} or
552 @samp{0}, standard output is used.
553
554 @node GFORTRAN_TMPDIR
555 @section @env{GFORTRAN_TMPDIR}---Directory for scratch files
556
557 This environment variable controls where scratch files are
558 created. If this environment variable is missing,
559 GNU Fortran searches for the environment variable @env{TMP}. If
560 this is also missing, the default is @file{/tmp}.
561
562 @node GFORTRAN_UNBUFFERED_ALL
563 @section @env{GFORTRAN_UNBUFFERED_ALL}---Don't buffer output
564
565 This environment variable controls whether all output is unbuffered.
566 If the first letter is @samp{y}, @samp{Y} or @samp{1}, all output is
567 unbuffered. This will slow down large writes. If the first letter is
568 @samp{n}, @samp{N} or @samp{0}, output is buffered. This is the
569 default.
570
571 @node GFORTRAN_SHOW_LOCUS
572 @section @env{GFORTRAN_SHOW_LOCUS}---Show location for runtime errors
573
574 If the first letter is @samp{y}, @samp{Y} or @samp{1}, filename and
575 line numbers for runtime errors are printed. If the first letter is
576 @samp{n}, @samp{N} or @samp{0}, don't print filename and line numbers
577 for runtime errors. The default is to print the location.
578
579 @node GFORTRAN_OPTIONAL_PLUS
580 @section @env{GFORTRAN_OPTIONAL_PLUS}---Print leading + where permitted
581
582 If the first letter is @samp{y}, @samp{Y} or @samp{1},
583 a plus sign is printed
584 where permitted by the Fortran standard. If the first letter
585 is @samp{n}, @samp{N} or @samp{0}, a plus sign is not printed
586 in most cases. Default is not to print plus signs.
587
588 @node GFORTRAN_DEFAULT_RECL
589 @section @env{GFORTRAN_DEFAULT_RECL}---Default record length for new files
590
591 This environment variable specifies the default record length, in
592 bytes, for files which are opened without a @code{RECL} tag in the
593 @code{OPEN} statement. This must be a positive integer. The
594 default value is 1073741824 bytes (1 GB).
595
596 @node GFORTRAN_LIST_SEPARATOR
597 @section @env{GFORTRAN_LIST_SEPARATOR}---Separator for list output
598
599 This environment variable specifies the separator when writing
600 list-directed output. It may contain any number of spaces and
601 at most one comma. If you specify this on the command line,
602 be sure to quote spaces, as in
603 @smallexample
604 $ GFORTRAN_LIST_SEPARATOR=' , ' ./a.out
605 @end smallexample
606 when @command{a.out} is the compiled Fortran program that you want to run.
607 Default is a single space.
608
609 @node GFORTRAN_CONVERT_UNIT
610 @section @env{GFORTRAN_CONVERT_UNIT}---Set endianness for unformatted I/O
611
612 By setting the @env{GFORTRAN_CONVERT_UNIT} variable, it is possible
613 to change the representation of data for unformatted files.
614 The syntax for the @env{GFORTRAN_CONVERT_UNIT} variable is:
615 @smallexample
616 GFORTRAN_CONVERT_UNIT: mode | mode ';' exception | exception ;
617 mode: 'native' | 'swap' | 'big_endian' | 'little_endian' ;
618 exception: mode ':' unit_list | unit_list ;
619 unit_list: unit_spec | unit_list unit_spec ;
620 unit_spec: INTEGER | INTEGER '-' INTEGER ;
621 @end smallexample
622 The variable consists of an optional default mode, followed by
623 a list of optional exceptions, which are separated by semicolons
624 from the preceding default and each other. Each exception consists
625 of a format and a comma-separated list of units. Valid values for
626 the modes are the same as for the @code{CONVERT} specifier:
627
628 @itemize @w{}
629 @item @code{NATIVE} Use the native format. This is the default.
630 @item @code{SWAP} Swap between little- and big-endian.
631 @item @code{LITTLE_ENDIAN} Use the little-endian format
632 for unformatted files.
633 @item @code{BIG_ENDIAN} Use the big-endian format for unformatted files.
634 @end itemize
635 A missing mode for an exception is taken to mean @code{BIG_ENDIAN}.
636 Examples of values for @env{GFORTRAN_CONVERT_UNIT} are:
637 @itemize @w{}
638 @item @code{'big_endian'} Do all unformatted I/O in big_endian mode.
639 @item @code{'little_endian;native:10-20,25'} Do all unformatted I/O
640 in little_endian mode, except for units 10 to 20 and 25, which are in
641 native format.
642 @item @code{'10-20'} Units 10 to 20 are big-endian, the rest is native.
643 @end itemize
644
645 Setting the environment variables should be done on the command
646 line or via the @command{export}
647 command for @command{sh}-compatible shells and via @command{setenv}
648 for @command{csh}-compatible shells.
649
650 Example for @command{sh}:
651 @smallexample
652 $ gfortran foo.f90
653 $ GFORTRAN_CONVERT_UNIT='big_endian;native:10-20' ./a.out
654 @end smallexample
655
656 Example code for @command{csh}:
657 @smallexample
658 % gfortran foo.f90
659 % setenv GFORTRAN_CONVERT_UNIT 'big_endian;native:10-20'
660 % ./a.out
661 @end smallexample
662
663 Using anything but the native representation for unformatted data
664 carries a significant speed overhead. If speed in this area matters
665 to you, it is best if you use this only for data that needs to be
666 portable.
667
668 @xref{CONVERT specifier}, for an alternative way to specify the
669 data representation for unformatted files. @xref{Runtime Options}, for
670 setting a default data representation for the whole program. The
671 @code{CONVERT} specifier overrides the @option{-fconvert} compile options.
672
673 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
674 environment variable will override the CONVERT specifier in the
675 open statement}. This is to give control over data formats to
676 users who do not have the source code of their program available.
677
678 @node GFORTRAN_ERROR_DUMPCORE
679 @section @env{GFORTRAN_ERROR_DUMPCORE}---Dump core on run-time errors
680
681 If the @env{GFORTRAN_ERROR_DUMPCORE} variable is set to
682 @samp{y}, @samp{Y} or @samp{1} (only the first letter is relevant)
683 then library run-time errors cause core dumps. To disable the core
684 dumps, set the variable to @samp{n}, @samp{N}, @samp{0}. Default
685 is not to core dump unless the @option{-fdump-core} compile option
686 was used.
687
688 @node GFORTRAN_ERROR_BACKTRACE
689 @section @env{GFORTRAN_ERROR_BACKTRACE}---Show backtrace on run-time errors
690
691 If the @env{GFORTRAN_ERROR_BACKTRACE} variable is set to
692 @samp{y}, @samp{Y} or @samp{1} (only the first letter is relevant)
693 then a backtrace is printed when a run-time error occurs.
694 To disable the backtracing, set the variable to
695 @samp{n}, @samp{N}, @samp{0}. Default is not to print a backtrace
696 unless the @option{-fbacktrace} compile option
697 was used.
698
699 @c =====================================================================
700 @c PART II: LANGUAGE REFERENCE
701 @c =====================================================================
702
703 @tex
704 \part{II}{Language Reference}
705 @end tex
706
707 @c ---------------------------------------------------------------------
708 @c Fortran 2003 Status
709 @c ---------------------------------------------------------------------
710
711 @node Fortran 2003 status
712 @chapter Fortran 2003 Status
713
714 Although GNU Fortran focuses on implementing the Fortran 95
715 standard for the time being, a few Fortran 2003 features are currently
716 available.
717
718 @itemize
719 @item
720 Intrinsics @code{command_argument_count}, @code{get_command},
721 @code{get_command_argument}, @code{get_environment_variable}, and
722 @code{move_alloc}.
723
724 @item
725 @cindex array, constructors
726 @cindex @code{[...]}
727 Array constructors using square brackets. That is, @code{[...]} rather
728 than @code{(/.../)}.
729
730 @item
731 @cindex @code{FLUSH} statement
732 @cindex statement, @code{FLUSH}
733 @code{FLUSH} statement.
734
735 @item
736 @cindex @code{IOMSG=} specifier
737 @code{IOMSG=} specifier for I/O statements.
738
739 @item
740 @cindex @code{ENUM} statement
741 @cindex @code{ENUMERATOR} statement
742 @cindex statement, @code{ENUM}
743 @cindex statement, @code{ENUMERATOR}
744 @opindex @code{fshort-enums}
745 Support for the declaration of enumeration constants via the
746 @code{ENUM} and @code{ENUMERATOR} statements. Interoperability with
747 @command{gcc} is guaranteed also for the case where the
748 @command{-fshort-enums} command line option is given.
749
750 @item
751 @cindex TR 15581
752 TR 15581:
753 @itemize
754 @item
755 @cindex @code{ALLOCATABLE} dummy arguments
756 @code{ALLOCATABLE} dummy arguments.
757 @item
758 @cindex @code{ALLOCATABLE} function results
759 @code{ALLOCATABLE} function results
760 @item
761 @cindex @code{ALLOCATABLE} components of derived types
762 @code{ALLOCATABLE} components of derived types
763 @end itemize
764
765 @item
766 @cindex @code{STREAM} I/O
767 @cindex @code{ACCESS='STREAM'} I/O
768 The @code{OPEN} statement supports the @code{ACCESS='STREAM'} specifier,
769 allowing I/O without any record structure.
770
771 @item
772 Namelist input/output for internal files.
773
774 @item
775 @cindex @code{PROTECTED} statement
776 @cindex statement, @code{PROTECTED}
777 The @code{PROTECTED} statement and attribute.
778
779 @item
780 @cindex @code{VALUE} statement
781 @cindex statement, @code{VALUE}
782 The @code{VALUE} statement and attribute.
783
784 @item
785 @cindex @code{VOLATILE} statement
786 @cindex statement, @code{VOLATILE}
787 The @code{VOLATILE} statement and attribute.
788
789 @item
790 @cindex @code{IMPORT} statement
791 @cindex statement, @code{IMPORT}
792 The @code{IMPORT} statement, allowing to import
793 host-associated derived types.
794
795 @item
796 @cindex @code{USE, INTRINSIC} statement
797 @cindex statement, @code{USE, INTRINSIC}
798 @cindex @code{ISO_FORTRAN_ENV} statement
799 @cindex statement, @code{ISO_FORTRAN_ENV}
800 @code{USE} statement with @code{INTRINSIC} and @code{NON_INTRINSIC}
801 attribute; supported intrinsic modules: @code{ISO_FORTRAN_ENV},
802 @code{OMP_LIB} and @code{OMP_LIB_KINDS}.
803
804 @item
805 Renaming of operators in the @code{USE} statement.
806
807 @end itemize
808
809
810 @c ---------------------------------------------------------------------
811 @c Extensions
812 @c ---------------------------------------------------------------------
813
814 @c Maybe this chapter should be merged with the 'Standards' section,
815 @c whenever that is written :-)
816
817 @node Extensions
818 @chapter Extensions
819 @cindex Extension
820
821 GNU Fortran implements a number of extensions over standard
822 Fortran. This chapter contains information on their syntax and
823 meaning. There are currently two categories of GNU Fortran
824 extensions, those that provide functionality beyond that provided
825 by any standard, and those that are supported by GNU Fortran
826 purely for backward compatibility with legacy compilers. By default,
827 @option{-std=gnu} allows the compiler to accept both types of
828 extensions, but to warn about the use of the latter. Specifying
829 either @option{-std=f95} or @option{-std=f2003} disables both types
830 of extensions, and @option{-std=legacy} allows both without warning.
831
832 @menu
833 * Old-style kind specifications::
834 * Old-style variable initialization::
835 * Extensions to namelist::
836 * X format descriptor without count field::
837 * Commas in FORMAT specifications::
838 * Missing period in FORMAT specifications::
839 * I/O item lists::
840 * BOZ literal constants::
841 * Real array indices::
842 * Unary operators::
843 * Implicitly convert LOGICAL and INTEGER values::
844 * Hollerith constants support::
845 * Cray pointers::
846 * CONVERT specifier::
847 * OpenMP::
848 * Argument list functions::
849 @end menu
850
851 @node Old-style kind specifications
852 @section Old-style kind specifications
853 @cindex kind, old-style
854
855 GNU Fortran allows old-style kind specifications in declarations. These
856 look like:
857 @smallexample
858 TYPESPEC*size x,y,z
859 @end smallexample
860 @noindent
861 where @code{TYPESPEC} is a basic type (@code{INTEGER}, @code{REAL},
862 etc.), and where @code{size} is a byte count corresponding to the
863 storage size of a valid kind for that type. (For @code{COMPLEX}
864 variables, @code{size} is the total size of the real and imaginary
865 parts.) The statement then declares @code{x}, @code{y} and @code{z} to
866 be of type @code{TYPESPEC} with the appropriate kind. This is
867 equivalent to the standard-conforming declaration
868 @smallexample
869 TYPESPEC(k) x,y,z
870 @end smallexample
871 @noindent
872 where @code{k} is equal to @code{size} for most types, but is equal to
873 @code{size/2} for the @code{COMPLEX} type.
874
875 @node Old-style variable initialization
876 @section Old-style variable initialization
877
878 GNU Fortran allows old-style initialization of variables of the
879 form:
880 @smallexample
881 INTEGER i/1/,j/2/
882 REAL x(2,2) /3*0.,1./
883 @end smallexample
884 The syntax for the initializers is as for the @code{DATA} statement, but
885 unlike in a @code{DATA} statement, an initializer only applies to the
886 variable immediately preceding the initialization. In other words,
887 something like @code{INTEGER I,J/2,3/} is not valid. This style of
888 initialization is only allowed in declarations without double colons
889 (@code{::}); the double colons were introduced in Fortran 90, which also
890 introduced a standard syntax for initializing variables in type
891 declarations.
892
893 Examples of standard-conforming code equivalent to the above example
894 are:
895 @smallexample
896 ! Fortran 90
897 INTEGER :: i = 1, j = 2
898 REAL :: x(2,2) = RESHAPE((/0.,0.,0.,1./),SHAPE(x))
899 ! Fortran 77
900 INTEGER i, j
901 REAL x(2,2)
902 DATA i/1/, j/2/, x/3*0.,1./
903 @end smallexample
904
905 Note that variables which are explicitly initialized in declarations
906 or in @code{DATA} statements automatically acquire the @code{SAVE}
907 attribute.
908
909 @node Extensions to namelist
910 @section Extensions to namelist
911 @cindex Namelist
912
913 GNU Fortran fully supports the Fortran 95 standard for namelist I/O
914 including array qualifiers, substrings and fully qualified derived types.
915 The output from a namelist write is compatible with namelist read. The
916 output has all names in upper case and indentation to column 1 after the
917 namelist name. Two extensions are permitted:
918
919 Old-style use of @samp{$} instead of @samp{&}
920 @smallexample
921 $MYNML
922 X(:)%Y(2) = 1.0 2.0 3.0
923 CH(1:4) = "abcd"
924 $END
925 @end smallexample
926
927 It should be noted that the default terminator is @samp{/} rather than
928 @samp{&END}.
929
930 Querying of the namelist when inputting from stdin. After at least
931 one space, entering @samp{?} sends to stdout the namelist name and the names of
932 the variables in the namelist:
933 @smallexample
934 ?
935
936 &mynml
937 x
938 x%y
939 ch
940 &end
941 @end smallexample
942
943 Entering @samp{=?} outputs the namelist to stdout, as if
944 @code{WRITE(*,NML = mynml)} had been called:
945 @smallexample
946 =?
947
948 &MYNML
949 X(1)%Y= 0.000000 , 1.000000 , 0.000000 ,
950 X(2)%Y= 0.000000 , 2.000000 , 0.000000 ,
951 X(3)%Y= 0.000000 , 3.000000 , 0.000000 ,
952 CH=abcd, /
953 @end smallexample
954
955 To aid this dialog, when input is from stdin, errors send their
956 messages to stderr and execution continues, even if @code{IOSTAT} is set.
957
958 @code{PRINT} namelist is permitted. This causes an error if
959 @option{-std=f95} is used.
960 @smallexample
961 PROGRAM test_print
962 REAL, dimension (4) :: x = (/1.0, 2.0, 3.0, 4.0/)
963 NAMELIST /mynml/ x
964 PRINT mynml
965 END PROGRAM test_print
966 @end smallexample
967
968 Expanded namelist reads are permitted. This causes an error if
969 @option{-std=f95} is used. In the following example, the first element
970 of the array will be given the value 0.00 and the two succeeding
971 elements will be given the values 1.00 and 2.00.
972 @smallexample
973 &MYNML
974 X(1,1) = 0.00 , 1.00 , 2.00
975 /
976 @end smallexample
977
978 @node X format descriptor without count field
979 @section @code{X} format descriptor without count field
980
981 To support legacy codes, GNU Fortran permits the count field of the
982 @code{X} edit descriptor in @code{FORMAT} statements to be omitted.
983 When omitted, the count is implicitly assumed to be one.
984
985 @smallexample
986 PRINT 10, 2, 3
987 10 FORMAT (I1, X, I1)
988 @end smallexample
989
990 @node Commas in FORMAT specifications
991 @section Commas in @code{FORMAT} specifications
992
993 To support legacy codes, GNU Fortran allows the comma separator
994 to be omitted immediately before and after character string edit
995 descriptors in @code{FORMAT} statements.
996
997 @smallexample
998 PRINT 10, 2, 3
999 10 FORMAT ('FOO='I1' BAR='I2)
1000 @end smallexample
1001
1002
1003 @node Missing period in FORMAT specifications
1004 @section Missing period in @code{FORMAT} specifications
1005
1006 To support legacy codes, GNU Fortran allows missing periods in format
1007 specifications if and only if @option{-std=legacy} is given on the
1008 command line. This is considered non-conforming code and is
1009 discouraged.
1010
1011 @smallexample
1012 REAL :: value
1013 READ(*,10) value
1014 10 FORMAT ('F4')
1015 @end smallexample
1016
1017 @node I/O item lists
1018 @section I/O item lists
1019 @cindex I/O item lists
1020
1021 To support legacy codes, GNU Fortran allows the input item list
1022 of the @code{READ} statement, and the output item lists of the
1023 @code{WRITE} and @code{PRINT} statements, to start with a comma.
1024
1025 @node BOZ literal constants
1026 @section BOZ literal constants
1027 @cindex BOZ literal constants
1028
1029 As an extension, GNU Fortran allows hexadecimal BOZ literal constants to
1030 be specified using the X prefix, in addition to the standard Z prefix.
1031 BOZ literal constants can also be specified by adding a suffix to the
1032 string. For example, @code{Z'ABC'} and @code{'ABC'Z} are equivalent.
1033
1034 The Fortran standard restricts the appearance of a BOZ literal constant
1035 to the @code{DATA} statement, and it is expected to be assigned to an
1036 @code{INTEGER} variable. GNU Fortran permits a BOZ literal to appear in
1037 any initialization expression as well as assignment statements.
1038
1039 Attempts to use a BOZ literal constant to do a bitwise initialization of
1040 a variable can lead to confusion. A BOZ literal constant is converted
1041 to an @code{INTEGER} value with the kind type with the largest decimal
1042 representation, and this value is then converted numerically to the type
1043 and kind of the variable in question. Thus, one should not expect a
1044 bitwise copy of the BOZ literal constant to be assigned to a @code{REAL}
1045 variable.
1046
1047 Similarly, initializing an @code{INTEGER} variable with a statement such
1048 as @code{DATA i/Z'FFFFFFFF'/} will produce an integer overflow rather
1049 than the desired result of @math{-1} when @code{i} is a 32-bit integer
1050 on a system that supports 64-bit integers. The @samp{-fno-range-check}
1051 option can be used as a workaround for legacy code that initializes
1052 integers in this manner.
1053
1054 @node Real array indices
1055 @section Real array indices
1056 @cindex array, indices of type real
1057
1058 As an extension, GNU Fortran allows the use of @code{REAL} expressions
1059 or variables as array indices.
1060
1061 @node Unary operators
1062 @section Unary operators
1063 @cindex operators, unary
1064
1065 As an extension, GNU Fortran allows unary plus and unary minus operators
1066 to appear as the second operand of binary arithmetic operators without
1067 the need for parenthesis.
1068
1069 @smallexample
1070 X = Y * -Z
1071 @end smallexample
1072
1073 @node Implicitly convert LOGICAL and INTEGER values
1074 @section Implicitly convert @code{LOGICAL} and @code{INTEGER} values
1075 @cindex conversion, to integer
1076 @cindex conversion, to logical
1077
1078 As an extension for backwards compatibility with other compilers, GNU
1079 Fortran allows the implicit conversion of @code{LOGICAL} values to
1080 @code{INTEGER} values and vice versa. When converting from a
1081 @code{LOGICAL} to an @code{INTEGER}, @code{.FALSE.} is interpreted as
1082 zero, and @code{.TRUE.} is interpreted as one. When converting from
1083 @code{INTEGER} to @code{LOGICAL}, the value zero is interpreted as
1084 @code{.FALSE.} and any nonzero value is interpreted as @code{.TRUE.}.
1085
1086 @smallexample
1087 INTEGER :: i = 1
1088 IF (i) PRINT *, 'True'
1089 @end smallexample
1090
1091 @node Hollerith constants support
1092 @section Hollerith constants support
1093 @cindex Hollerith constants
1094
1095 GNU Fortran supports Hollerith constants in assignments, function
1096 arguments, and @code{DATA} and @code{ASSIGN} statements. A Hollerith
1097 constant is written as a string of characters preceded by an integer
1098 constant indicating the character count, and the letter @code{H} or
1099 @code{h}, and stored in bytewise fashion in a numeric (@code{INTEGER},
1100 @code{REAL}, or @code{complex}) or @code{LOGICAL} variable. The
1101 constant will be padded or truncated to fit the size of the variable in
1102 which it is stored.
1103
1104 Examples of valid uses of Hollerith constants:
1105 @smallexample
1106 complex*16 x(2)
1107 data x /16Habcdefghijklmnop, 16Hqrstuvwxyz012345/
1108 x(1) = 16HABCDEFGHIJKLMNOP
1109 call foo (4h abc)
1110 @end smallexample
1111
1112 Invalid Hollerith constants examples:
1113 @smallexample
1114 integer*4 a
1115 a = 8H12345678 ! Valid, but the Hollerith constant will be truncated.
1116 a = 0H ! At least one character is needed.
1117 @end smallexample
1118
1119 In general, Hollerith constants were used to provide a rudimentary
1120 facility for handling character strings in early Fortran compilers,
1121 prior to the introduction of @code{CHARACTER} variables in Fortran 77;
1122 in those cases, the standard-compliant equivalent is to convert the
1123 program to use proper character strings. On occasion, there may be a
1124 case where the intent is specifically to initialize a numeric variable
1125 with a given byte sequence. In these cases, the same result can be
1126 obtained by using the @code{TRANSFER} statement, as in this example.
1127 @smallexample
1128 INTEGER(KIND=4) :: a
1129 a = TRANSFER ("abcd", a) ! equivalent to: a = 4Habcd
1130 @end smallexample
1131
1132
1133 @node Cray pointers
1134 @section Cray pointers
1135 @cindex pointer, cray
1136
1137 Cray pointers are part of a non-standard extension that provides a
1138 C-like pointer in Fortran. This is accomplished through a pair of
1139 variables: an integer "pointer" that holds a memory address, and a
1140 "pointee" that is used to dereference the pointer.
1141
1142 Pointer/pointee pairs are declared in statements of the form:
1143 @smallexample
1144 pointer ( <pointer> , <pointee> )
1145 @end smallexample
1146 or,
1147 @smallexample
1148 pointer ( <pointer1> , <pointee1> ), ( <pointer2> , <pointee2> ), ...
1149 @end smallexample
1150 The pointer is an integer that is intended to hold a memory address.
1151 The pointee may be an array or scalar. A pointee can be an assumed
1152 size array---that is, the last dimension may be left unspecified by
1153 using a @code{*} in place of a value---but a pointee cannot be an
1154 assumed shape array. No space is allocated for the pointee.
1155
1156 The pointee may have its type declared before or after the pointer
1157 statement, and its array specification (if any) may be declared
1158 before, during, or after the pointer statement. The pointer may be
1159 declared as an integer prior to the pointer statement. However, some
1160 machines have default integer sizes that are different than the size
1161 of a pointer, and so the following code is not portable:
1162 @smallexample
1163 integer ipt
1164 pointer (ipt, iarr)
1165 @end smallexample
1166 If a pointer is declared with a kind that is too small, the compiler
1167 will issue a warning; the resulting binary will probably not work
1168 correctly, because the memory addresses stored in the pointers may be
1169 truncated. It is safer to omit the first line of the above example;
1170 if explicit declaration of ipt's type is omitted, then the compiler
1171 will ensure that ipt is an integer variable large enough to hold a
1172 pointer.
1173
1174 Pointer arithmetic is valid with Cray pointers, but it is not the same
1175 as C pointer arithmetic. Cray pointers are just ordinary integers, so
1176 the user is responsible for determining how many bytes to add to a
1177 pointer in order to increment it. Consider the following example:
1178 @smallexample
1179 real target(10)
1180 real pointee(10)
1181 pointer (ipt, pointee)
1182 ipt = loc (target)
1183 ipt = ipt + 1
1184 @end smallexample
1185 The last statement does not set @code{ipt} to the address of
1186 @code{target(1)}, as it would in C pointer arithmetic. Adding @code{1}
1187 to @code{ipt} just adds one byte to the address stored in @code{ipt}.
1188
1189 Any expression involving the pointee will be translated to use the
1190 value stored in the pointer as the base address.
1191
1192 To get the address of elements, this extension provides an intrinsic
1193 function @code{LOC()}. The @code{LOC()} function is equivalent to the
1194 @code{&} operator in C, except the address is cast to an integer type:
1195 @smallexample
1196 real ar(10)
1197 pointer(ipt, arpte(10))
1198 real arpte
1199 ipt = loc(ar) ! Makes arpte is an alias for ar
1200 arpte(1) = 1.0 ! Sets ar(1) to 1.0
1201 @end smallexample
1202 The pointer can also be set by a call to the @code{MALLOC} intrinsic
1203 (see @ref{MALLOC}).
1204
1205 Cray pointees often are used to alias an existing variable. For
1206 example:
1207 @smallexample
1208 integer target(10)
1209 integer iarr(10)
1210 pointer (ipt, iarr)
1211 ipt = loc(target)
1212 @end smallexample
1213 As long as @code{ipt} remains unchanged, @code{iarr} is now an alias for
1214 @code{target}. The optimizer, however, will not detect this aliasing, so
1215 it is unsafe to use @code{iarr} and @code{target} simultaneously. Using
1216 a pointee in any way that violates the Fortran aliasing rules or
1217 assumptions is illegal. It is the user's responsibility to avoid doing
1218 this; the compiler works under the assumption that no such aliasing
1219 occurs.
1220
1221 Cray pointers will work correctly when there is no aliasing (i.e., when
1222 they are used to access a dynamically allocated block of memory), and
1223 also in any routine where a pointee is used, but any variable with which
1224 it shares storage is not used. Code that violates these rules may not
1225 run as the user intends. This is not a bug in the optimizer; any code
1226 that violates the aliasing rules is illegal. (Note that this is not
1227 unique to GNU Fortran; any Fortran compiler that supports Cray pointers
1228 will ``incorrectly'' optimize code with illegal aliasing.)
1229
1230 There are a number of restrictions on the attributes that can be applied
1231 to Cray pointers and pointees. Pointees may not have the
1232 @code{ALLOCATABLE}, @code{INTENT}, @code{OPTIONAL}, @code{DUMMY},
1233 @code{TARGET}, @code{INTRINSIC}, or @code{POINTER} attributes. Pointers
1234 may not have the @code{DIMENSION}, @code{POINTER}, @code{TARGET},
1235 @code{ALLOCATABLE}, @code{EXTERNAL}, or @code{INTRINSIC} attributes.
1236 Pointees may not occur in more than one pointer statement. A pointee
1237 cannot be a pointer. Pointees cannot occur in equivalence, common, or
1238 data statements.
1239
1240 A Cray pointer may also point to a function or a subroutine. For
1241 example, the following excerpt is valid:
1242 @smallexample
1243 implicit none
1244 external sub
1245 pointer (subptr,subpte)
1246 external subpte
1247 subptr = loc(sub)
1248 call subpte()
1249 [...]
1250 subroutine sub
1251 [...]
1252 end subroutine sub
1253 @end smallexample
1254
1255 A pointer may be modified during the course of a program, and this
1256 will change the location to which the pointee refers. However, when
1257 pointees are passed as arguments, they are treated as ordinary
1258 variables in the invoked function. Subsequent changes to the pointer
1259 will not change the base address of the array that was passed.
1260
1261 @node CONVERT specifier
1262 @section CONVERT specifier
1263 @cindex CONVERT specifier
1264
1265 GNU Fortran allows the conversion of unformatted data between little-
1266 and big-endian representation to facilitate moving of data
1267 between different systems. The conversion can be indicated with
1268 the @code{CONVERT} specifier on the @code{OPEN} statement.
1269 @xref{GFORTRAN_CONVERT_UNIT}, for an alternative way of specifying
1270 the data format via an environment variable.
1271
1272 Valid values for @code{CONVERT} are:
1273 @itemize @w{}
1274 @item @code{CONVERT='NATIVE'} Use the native format. This is the default.
1275 @item @code{CONVERT='SWAP'} Swap between little- and big-endian.
1276 @item @code{CONVERT='LITTLE_ENDIAN'} Use the little-endian representation
1277 for unformatted files.
1278 @item @code{CONVERT='BIG_ENDIAN'} Use the big-endian representation for
1279 unformatted files.
1280 @end itemize
1281
1282 Using the option could look like this:
1283 @smallexample
1284 open(file='big.dat',form='unformatted',access='sequential', &
1285 convert='big_endian')
1286 @end smallexample
1287
1288 The value of the conversion can be queried by using
1289 @code{INQUIRE(CONVERT=ch)}. The values returned are
1290 @code{'BIG_ENDIAN'} and @code{'LITTLE_ENDIAN'}.
1291
1292 @code{CONVERT} works between big- and little-endian for
1293 @code{INTEGER} values of all supported kinds and for @code{REAL}
1294 on IEEE systems of kinds 4 and 8. Conversion between different
1295 ``extended double'' types on different architectures such as
1296 m68k and x86_64, which GNU Fortran
1297 supports as @code{REAL(KIND=10)} and @code{REAL(KIND=16)}, will
1298 probably not work.
1299
1300 @emph{Note that the values specified via the GFORTRAN_CONVERT_UNIT
1301 environment variable will override the CONVERT specifier in the
1302 open statement}. This is to give control over data formats to
1303 users who do not have the source code of their program available.
1304
1305 Using anything but the native representation for unformatted data
1306 carries a significant speed overhead. If speed in this area matters
1307 to you, it is best if you use this only for data that needs to be
1308 portable.
1309
1310 @node OpenMP
1311 @section OpenMP
1312 @cindex OpenMP
1313
1314 GNU Fortran attempts to be OpenMP Application Program Interface v2.5
1315 compatible when invoked with the @option{-fopenmp} option. GNU Fortran
1316 then generates parallelized code according to the OpenMP directives
1317 used in the source. The OpenMP Fortran runtime library
1318 routines are provided both in a form of a Fortran 90 module named
1319 @code{omp_lib} and in a form of a Fortran @code{include} file named
1320 @file{omp_lib.h}.
1321
1322 For details refer to the actual
1323 @uref{http://www.openmp.org/drupal/mp-documents/spec25.pdf,
1324 OpenMP Application Program Interface v2.5} specification.
1325
1326 @node Argument list functions
1327 @section Argument list functions %VAL, %REF and %LOC
1328 @cindex argument list functions
1329 @cindex %VAL
1330 @cindex %REF
1331 @cindex %LOC
1332
1333 GNU Fortran supports argument list functions @code{%VAL}, @code{%REF}
1334 and @code{%LOC} statements, for backward compatibility with g77.
1335 It is recommended that these should be used only for code that is
1336 accessing facilities outside of GNU Fortran, such as operating system
1337 or windowing facilities. It is best to constrain such uses to isolated
1338 portions of a program--portions that deal specifically and exclusively
1339 with low-level, system-dependent facilities. Such portions might well
1340 provide a portable interface for use by the program as a whole, but are
1341 themselves not portable, and should be thoroughly tested each time they
1342 are rebuilt using a new compiler or version of a compiler.
1343
1344 @code{%VAL} passes a scalar argument by value, @code{%REF} passes it by
1345 reference and @code{%LOC} passes its memory location. Since gfortran
1346 already passes scalar arguments by reference, @code{%REF} is in effect
1347 a do-nothing. @code{%LOC} has the same effect as a fortran pointer.
1348
1349 An example of passing an argument by value to a C subroutine foo.:
1350 @smallexample
1351 C
1352 C prototype void foo_ (float x);
1353 C
1354 external foo
1355 real*4 x
1356 x = 3.14159
1357 call foo (%VAL (x))
1358 end
1359 @end smallexample
1360
1361 For details refer to the g77 manual
1362 @uref{http://gcc.gnu.org/onlinedocs/gcc-3.4.6/g77/index.html#Top}.
1363
1364 Also, the gfortran testsuite c_by_val.f and its partner c_by_val.c are
1365 worth a look.
1366
1367 @c ---------------------------------------------------------------------
1368 @c Intrinsic Procedures
1369 @c ---------------------------------------------------------------------
1370
1371 @include intrinsic.texi
1372
1373
1374 @tex
1375 \blankpart
1376 @end tex
1377
1378 @c ---------------------------------------------------------------------
1379 @c Contributing
1380 @c ---------------------------------------------------------------------
1381
1382 @node Contributing
1383 @unnumbered Contributing
1384 @cindex Contributing
1385
1386 Free software is only possible if people contribute to efforts
1387 to create it.
1388 We're always in need of more people helping out with ideas
1389 and comments, writing documentation and contributing code.
1390
1391 If you want to contribute to GNU Fortran,
1392 have a look at the long lists of projects you can take on.
1393 Some of these projects are small,
1394 some of them are large;
1395 some are completely orthogonal to the rest of what is
1396 happening on GNU Fortran,
1397 but others are ``mainstream'' projects in need of enthusiastic hackers.
1398 All of these projects are important!
1399 We'll eventually get around to the things here,
1400 but they are also things doable by someone who is willing and able.
1401
1402 @menu
1403 * Contributors::
1404 * Projects::
1405 * Proposed Extensions::
1406 @end menu
1407
1408
1409 @node Contributors
1410 @section Contributors to GNU Fortran
1411 @cindex Contributors
1412 @cindex Credits
1413 @cindex Authors
1414
1415 Most of the parser was hand-crafted by @emph{Andy Vaught}, who is
1416 also the initiator of the whole project. Thanks Andy!
1417 Most of the interface with GCC was written by @emph{Paul Brook}.
1418
1419 The following individuals have contributed code and/or
1420 ideas and significant help to the GNU Fortran project
1421 (in no particular order):
1422
1423 @itemize @minus
1424 @item Andy Vaught
1425 @item Katherine Holcomb
1426 @item Tobias Schl@"uter
1427 @item Steven Bosscher
1428 @item Toon Moene
1429 @item Tim Prince
1430 @item Niels Kristian Bech Jensen
1431 @item Steven Johnson
1432 @item Paul Brook
1433 @item Feng Wang
1434 @item Bud Davis
1435 @item Paul Thomas
1436 @item Fran@,{c}ois-Xavier Coudert
1437 @item Steven G. Kargl
1438 @item Jerry Delisle
1439 @item Janne Blomqvist
1440 @item Erik Edelmann
1441 @item Thomas Koenig
1442 @item Asher Langton
1443 @item Jakub Jelinek
1444 @item Roger Sayle
1445 @item H.J. Lu
1446 @item Richard Henderson
1447 @item Richard Sandiford
1448 @item Richard Guenther
1449 @item Bernhard Fischer
1450 @end itemize
1451
1452 The following people have contributed bug reports,
1453 smaller or larger patches,
1454 and much needed feedback and encouragement for the
1455 GNU Fortran project:
1456
1457 @itemize @minus
1458 @item Erik Schnetter
1459 @item Bill Clodius
1460 @item Kate Hedstrom
1461 @end itemize
1462
1463 Many other individuals have helped debug,
1464 test and improve the GNU Fortran compiler over the past few years,
1465 and we welcome you to do the same!
1466 If you already have done so,
1467 and you would like to see your name listed in the
1468 list above, please contact us.
1469
1470
1471 @node Projects
1472 @section Projects
1473
1474 @table @emph
1475
1476 @item Help build the test suite
1477 Solicit more code for donation to the test suite.
1478 We can keep code private on request.
1479
1480 @item Bug hunting/squishing
1481 Find bugs and write more test cases!
1482 Test cases are especially very welcome,
1483 because it allows us to concentrate on fixing bugs
1484 instead of isolating them.
1485
1486 @item Smaller projects (``bug'' fixes):
1487 @itemize @minus
1488 @item Allow init exprs to be numbers raised to integer powers.
1489 @item Implement correct rounding.
1490 @item Implement F restrictions on Fortran 95 syntax.
1491 @item See about making Emacs-parsable error messages.
1492 @end itemize
1493 @end table
1494
1495 If you wish to work on the runtime libraries,
1496 please contact a project maintainer.
1497 @c TODO: email!
1498
1499
1500 @node Proposed Extensions
1501 @section Proposed Extensions
1502
1503 Here's a list of proposed extensions for the GNU Fortran compiler, in no particular
1504 order. Most of these are necessary to be fully compatible with
1505 existing Fortran compilers, but they are not part of the official
1506 J3 Fortran 95 standard.
1507
1508 @subsection Compiler extensions:
1509 @itemize @bullet
1510 @item
1511 User-specified alignment rules for structures.
1512
1513 @item
1514 Flag to generate @code{Makefile} info.
1515
1516 @item
1517 Automatically extend single precision constants to double.
1518
1519 @item
1520 Compile code that conserves memory by dynamically allocating common and
1521 module storage either on stack or heap.
1522
1523 @item
1524 Compile flag to generate code for array conformance checking (suggest -CC).
1525
1526 @item
1527 User control of symbol names (underscores, etc).
1528
1529 @item
1530 Compile setting for maximum size of stack frame size before spilling
1531 parts to static or heap.
1532
1533 @item
1534 Flag to force local variables into static space.
1535
1536 @item
1537 Flag to force local variables onto stack.
1538
1539 @item
1540 Flag for maximum errors before ending compile.
1541
1542 @item
1543 Option to initialize otherwise uninitialized integer and floating
1544 point variables.
1545 @end itemize
1546
1547
1548 @subsection Environment Options
1549 @itemize @bullet
1550 @item
1551 Pluggable library modules for random numbers, linear algebra.
1552 LA should use BLAS calling conventions.
1553
1554 @item
1555 Environment variables controlling actions on arithmetic exceptions like
1556 overflow, underflow, precision loss---Generate NaN, abort, default.
1557 action.
1558
1559 @item
1560 Set precision for fp units that support it (i387).
1561
1562 @item
1563 Variable for setting fp rounding mode.
1564
1565 @item
1566 Variable to fill uninitialized variables with a user-defined bit
1567 pattern.
1568
1569 @item
1570 Environment variable controlling filename that is opened for that unit
1571 number.
1572
1573 @item
1574 Environment variable to clear/trash memory being freed.
1575
1576 @item
1577 Environment variable to control tracing of allocations and frees.
1578
1579 @item
1580 Environment variable to display allocated memory at normal program end.
1581
1582 @item
1583 Environment variable for filename for * IO-unit.
1584
1585 @item
1586 Environment variable for temporary file directory.
1587
1588 @item
1589 Environment variable forcing standard output to be line buffered (unix).
1590
1591 @end itemize
1592
1593
1594 @c ---------------------------------------------------------------------
1595 @c GNU General Public License
1596 @c ---------------------------------------------------------------------
1597
1598 @include gpl.texi
1599
1600
1601
1602 @c ---------------------------------------------------------------------
1603 @c GNU Free Documentation License
1604 @c ---------------------------------------------------------------------
1605
1606 @include fdl.texi
1607
1608
1609
1610 @c ---------------------------------------------------------------------
1611 @c Funding Free Software
1612 @c ---------------------------------------------------------------------
1613
1614 @include funding.texi
1615
1616 @c ---------------------------------------------------------------------
1617 @c Indices
1618 @c ---------------------------------------------------------------------
1619
1620 @node Option Index
1621 @unnumbered Option Index
1622 @command{gfortran}'s command line options are indexed here without any
1623 initial @samp{-} or @samp{--}. Where an option has both positive and
1624 negative forms (such as -foption and -fno-option), relevant entries in
1625 the manual are indexed under the most appropriate form; it may sometimes
1626 be useful to look up both forms.
1627 @printindex op
1628
1629 @node Keyword Index
1630 @unnumbered Keyword Index
1631 @printindex cp
1632
1633 @bye