OSDN Git Service

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