OSDN Git Service

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