xref: /netbsd-src/external/gpl3/gcc.old/dist/gcc/fortran/libgfortran.h (revision 627f7eb200a4419d89b531d55fccd2ee3ffdcde0)
1 /* Header file to the Fortran front-end and runtime library
2    Copyright (C) 2007-2019 Free Software Foundation, Inc.
3 
4 This file is part of GCC.
5 
6 GCC is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 3, or (at your option) any later
9 version.
10 
11 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with GCC; see the file COPYING3.  If not see
18 <http://www.gnu.org/licenses/>.  */
19 
20 
21 /* Flags to specify which standard/extension contains a feature.
22    Note that no features were obsoleted nor deleted in F2003.
23    Please remember to keep those definitions in sync with
24    gfortran.texi.  */
25 #define GFC_STD_F2018_DEL	(1<<11)	/* Deleted in F2018.  */
26 #define GFC_STD_F2018_OBS	(1<<10)	/* Obsolescent in F2018.  */
27 #define GFC_STD_F2018		(1<<9)	/* New in F2018.  */
28 #define GFC_STD_F2008_OBS	(1<<8)	/* Obsolescent in F2008.  */
29 #define GFC_STD_F2008		(1<<7)	/* New in F2008.  */
30 #define GFC_STD_LEGACY		(1<<6)	/* Backward compatibility.  */
31 #define GFC_STD_GNU		(1<<5)	/* GNU Fortran extension.  */
32 #define GFC_STD_F2003		(1<<4)	/* New in F2003.  */
33 #define GFC_STD_F95		(1<<3)	/* New in F95.  */
34 #define GFC_STD_F95_DEL		(1<<2)	/* Deleted in F95.  */
35 #define GFC_STD_F95_OBS		(1<<1)	/* Obsolescent in F95.  */
36 #define GFC_STD_F77		(1<<0)	/* Included in F77, but not deleted or
37 					   obsolescent in later standards.  */
38 
39 /* Combinations of the above flags that specify which classes of features
40  * are allowed with a certain -std option.  */
41 #define GFC_STD_OPT_F95		(GFC_STD_F77 | GFC_STD_F95 | GFC_STD_F95_OBS  \
42 				| GFC_STD_F2008_OBS | GFC_STD_F2018_OBS \
43 				| GFC_STD_F2018_DEL)
44 #define GFC_STD_OPT_F03		(GFC_STD_OPT_F95 | GFC_STD_F2003)
45 #define GFC_STD_OPT_F08		(GFC_STD_OPT_F03 | GFC_STD_F2008)
46 #define GFC_STD_OPT_F18		((GFC_STD_OPT_F08 | GFC_STD_F2018) \
47 				& (~GFC_STD_F2018_DEL))
48 
49 /* Bitmasks for the various FPE that can be enabled.  These need to be straight integers
50    e.g., 8 instead of (1<<3), because they will be included in Fortran source.  */
51 #define GFC_FPE_INVALID      1
52 #define GFC_FPE_DENORMAL     2
53 #define GFC_FPE_ZERO         4
54 #define GFC_FPE_OVERFLOW     8
55 #define GFC_FPE_UNDERFLOW   16
56 #define GFC_FPE_INEXACT     32
57 
58 /* Defines for floating-point rounding modes.  */
59 #define GFC_FPE_DOWNWARD   1
60 #define GFC_FPE_TONEAREST  2
61 #define GFC_FPE_TOWARDZERO 3
62 #define GFC_FPE_UPWARD     4
63 
64 /* Size of the buffer required to store FPU state for any target.
65    In particular, this has to be larger than fenv_t on all glibc targets.
66    Currently, the winner is x86_64 with 32 bytes.  */
67 #define GFC_FPE_STATE_BUFFER_SIZE 32
68 
69 /* Bitmasks for the various runtime checks that can be enabled.  */
70 #define GFC_RTCHECK_BOUNDS      (1<<0)
71 #define GFC_RTCHECK_ARRAY_TEMPS (1<<1)
72 #define GFC_RTCHECK_RECURSION   (1<<2)
73 #define GFC_RTCHECK_DO          (1<<3)
74 #define GFC_RTCHECK_POINTER     (1<<4)
75 #define GFC_RTCHECK_MEM         (1<<5)
76 #define GFC_RTCHECK_ALL        (GFC_RTCHECK_BOUNDS | GFC_RTCHECK_ARRAY_TEMPS \
77 				| GFC_RTCHECK_RECURSION | GFC_RTCHECK_DO \
78 				| GFC_RTCHECK_POINTER | GFC_RTCHECK_MEM)
79 
80 /* Special unit numbers used to convey certain conditions.  Numbers -4
81    thru -9 available.  NEWUNIT values start at -10.  */
82 #define GFC_INTERNAL_UNIT  -1    /* KIND=1 Internal Unit.  */
83 #define GFC_INTERNAL_UNIT4 -2    /* KIND=4 Internal Unit.  */
84 #define GFC_INVALID_UNIT   -3
85 
86 /* Possible values for the CONVERT I/O specifier.  */
87 /* Keep in sync with GFC_FLAG_CONVERT_* in gcc/flags.h.  */
88 typedef enum
89 {
90   GFC_CONVERT_NONE = -1,
91   GFC_CONVERT_NATIVE = 0,
92   GFC_CONVERT_SWAP,
93   GFC_CONVERT_BIG,
94   GFC_CONVERT_LITTLE
95 }
96 unit_convert;
97 
98 
99 /* Runtime errors.  */
100 typedef enum
101 {
102   LIBERROR_FIRST = -3,		/* Marker for the first error.  */
103   LIBERROR_EOR = -2,		/* End of record, must be negative.  */
104   LIBERROR_END = -1,		/* End of file, must be negative.  */
105   LIBERROR_OK = 0,		/* Indicates success, must be zero.  */
106   LIBERROR_OS = 5000,		/* OS error, more info in errno.  */
107   LIBERROR_OPTION_CONFLICT,
108   LIBERROR_BAD_OPTION,
109   LIBERROR_MISSING_OPTION,
110   LIBERROR_ALREADY_OPEN,
111   LIBERROR_BAD_UNIT,
112   LIBERROR_FORMAT,
113   LIBERROR_BAD_ACTION,
114   LIBERROR_ENDFILE,
115   LIBERROR_BAD_US,
116   LIBERROR_READ_VALUE,
117   LIBERROR_READ_OVERFLOW,
118   LIBERROR_INTERNAL,
119   LIBERROR_INTERNAL_UNIT,
120   LIBERROR_ALLOCATION,
121   LIBERROR_DIRECT_EOR,
122   LIBERROR_SHORT_RECORD,
123   LIBERROR_CORRUPT_FILE,
124   LIBERROR_INQUIRE_INTERNAL_UNIT, /* Must be different from STAT_STOPPED_IMAGE.  */
125   LIBERROR_LAST			/* Not a real error, the last error # + 1.  */
126 }
127 libgfortran_error_codes;
128 
129 /* Must kept in sync with libgfortran/caf/libcaf.h.  */
130 typedef enum
131 {
132   GFC_STAT_UNLOCKED = 0,
133   GFC_STAT_LOCKED,
134   GFC_STAT_LOCKED_OTHER_IMAGE,
135   GFC_STAT_STOPPED_IMAGE = 6000, /* See LIBERROR_INQUIRE_INTERNAL_UNIT above. */
136   GFC_STAT_FAILED_IMAGE  = 6001
137 }
138 libgfortran_stat_codes;
139 
140 typedef enum
141 {
142   GFC_CAF_ATOMIC_ADD = 1,
143   GFC_CAF_ATOMIC_AND,
144   GFC_CAF_ATOMIC_OR,
145   GFC_CAF_ATOMIC_XOR
146 } libcaf_atomic_codes;
147 
148 
149 /* For CO_REDUCE.  */
150 #define GFC_CAF_BYREF      (1<<0)
151 #define GFC_CAF_HIDDENLEN  (1<<1)
152 #define GFC_CAF_ARG_VALUE  (1<<2)
153 #define GFC_CAF_ARG_DESC   (1<<3)
154 
155 
156 /* Default unit number for preconnected standard input and output.  */
157 #define GFC_STDIN_UNIT_NUMBER 5
158 #define GFC_STDOUT_UNIT_NUMBER 6
159 #define GFC_STDERR_UNIT_NUMBER 0
160 
161 /* F2003 onward. For std < F2003, error caught in array.c(gfc_match_array_ref).  */
162 #define GFC_MAX_DIMENSIONS 15
163 
164 #define GFC_DTYPE_RANK_MASK 0x0F
165 #define GFC_DTYPE_TYPE_SHIFT 4
166 #define GFC_DTYPE_TYPE_MASK 0x70
167 #define GFC_DTYPE_SIZE_SHIFT 7
168 
169 /* Basic types.  BT_VOID is used by ISO C Binding so funcs like c_f_pointer
170    can take any arg with the pointer attribute as a param.  These are also
171    used in the run-time library for IO.  */
172 typedef enum
173 { BT_UNKNOWN = 0, BT_INTEGER, BT_LOGICAL, BT_REAL, BT_COMPLEX,
174   BT_DERIVED, BT_CHARACTER, BT_CLASS, BT_PROCEDURE, BT_HOLLERITH, BT_VOID,
175   BT_ASSUMED, BT_UNION
176 }
177 bt;
178