xref: /netbsd-src/external/gpl3/gcc/dist/gcc/fortran/libgfortran.h (revision b1e838363e3c6fc78a55519254d99869742dd33c)
1 /* Header file to the Fortran front-end and runtime library
2    Copyright (C) 2007-2022 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_BITS        (1<<6)
77 #define GFC_RTCHECK_ALL        (GFC_RTCHECK_BOUNDS | GFC_RTCHECK_ARRAY_TEMPS \
78 				| GFC_RTCHECK_RECURSION | GFC_RTCHECK_DO \
79 				| GFC_RTCHECK_POINTER | GFC_RTCHECK_MEM \
80 				| GFC_RTCHECK_BITS)
81 
82 /* Special unit numbers used to convey certain conditions.  Numbers -4
83    thru -9 available.  NEWUNIT values start at -10.  */
84 #define GFC_INTERNAL_UNIT  -1    /* KIND=1 Internal Unit.  */
85 #define GFC_INTERNAL_UNIT4 -2    /* KIND=4 Internal Unit.  */
86 #define GFC_INVALID_UNIT   -3
87 
88 /* Possible values for the CONVERT I/O specifier.  */
89 /* Keep in sync with GFC_FLAG_CONVERT_* in gcc/flag-types.h.  */
90 typedef enum
91 {
92   GFC_CONVERT_NONE = -1,
93   GFC_CONVERT_NATIVE = 0,
94   GFC_CONVERT_SWAP,
95   GFC_CONVERT_BIG,
96   GFC_CONVERT_LITTLE,
97   GFC_CONVERT_R16_IEEE = 4,
98   GFC_CONVERT_R16_IEEE_SWAP,
99   GFC_CONVERT_R16_IEEE_BIG,
100   GFC_CONVERT_R16_IEEE_LITTLE,
101   GFC_CONVERT_R16_IBM = 8,
102   GFC_CONVERT_R16_IBM_SWAP,
103   GFC_CONVERT_R16_IBM_BIG,
104   GFC_CONVERT_R16_IBM_LITTLE,
105 }
106 unit_convert;
107 
108 
109 /* Runtime errors.  */
110 typedef enum
111 {
112   LIBERROR_FIRST = -3,		/* Marker for the first error.  */
113   LIBERROR_EOR = -2,		/* End of record, must be negative.  */
114   LIBERROR_END = -1,		/* End of file, must be negative.  */
115   LIBERROR_OK = 0,		/* Indicates success, must be zero.  */
116   LIBERROR_OS = 5000,		/* OS error, more info in errno.  */
117   LIBERROR_OPTION_CONFLICT,
118   LIBERROR_BAD_OPTION,
119   LIBERROR_MISSING_OPTION,
120   LIBERROR_ALREADY_OPEN,
121   LIBERROR_BAD_UNIT,
122   LIBERROR_FORMAT,
123   LIBERROR_BAD_ACTION,
124   LIBERROR_ENDFILE,
125   LIBERROR_BAD_US,
126   LIBERROR_READ_VALUE,
127   LIBERROR_READ_OVERFLOW,
128   LIBERROR_INTERNAL,
129   LIBERROR_INTERNAL_UNIT,
130   LIBERROR_ALLOCATION,
131   LIBERROR_DIRECT_EOR,
132   LIBERROR_SHORT_RECORD,
133   LIBERROR_CORRUPT_FILE,
134   LIBERROR_INQUIRE_INTERNAL_UNIT, /* Must be different from STAT_STOPPED_IMAGE.  */
135   LIBERROR_BAD_WAIT_ID,
136   LIBERROR_LAST			/* Not a real error, the last error # + 1.  */
137 }
138 libgfortran_error_codes;
139 
140 /* Must kept in sync with libgfortran/caf/libcaf.h.  */
141 typedef enum
142 {
143   GFC_STAT_UNLOCKED = 0,
144   GFC_STAT_LOCKED,
145   GFC_STAT_LOCKED_OTHER_IMAGE,
146   GFC_STAT_STOPPED_IMAGE = 6000, /* See LIBERROR_INQUIRE_INTERNAL_UNIT above. */
147   GFC_STAT_FAILED_IMAGE  = 6001
148 }
149 libgfortran_stat_codes;
150 
151 typedef enum
152 {
153   GFC_CAF_ATOMIC_ADD = 1,
154   GFC_CAF_ATOMIC_AND,
155   GFC_CAF_ATOMIC_OR,
156   GFC_CAF_ATOMIC_XOR
157 } libcaf_atomic_codes;
158 
159 
160 /* For CO_REDUCE.  */
161 #define GFC_CAF_BYREF      (1<<0)
162 #define GFC_CAF_HIDDENLEN  (1<<1)
163 #define GFC_CAF_ARG_VALUE  (1<<2)
164 #define GFC_CAF_ARG_DESC   (1<<3)
165 
166 
167 /* Default unit number for preconnected standard input and output.  */
168 #define GFC_STDIN_UNIT_NUMBER 5
169 #define GFC_STDOUT_UNIT_NUMBER 6
170 #define GFC_STDERR_UNIT_NUMBER 0
171 
172 /* F2003 onward. For std < F2003, error caught in array.cc(gfc_match_array_ref).  */
173 #define GFC_MAX_DIMENSIONS 15
174 
175 #define GFC_DTYPE_RANK_MASK 0x0F
176 #define GFC_DTYPE_TYPE_SHIFT 4
177 #define GFC_DTYPE_TYPE_MASK 0x70
178 #define GFC_DTYPE_SIZE_SHIFT 7
179 
180 /* Basic types.  BT_VOID is used by ISO C Binding so funcs like c_f_pointer
181    can take any arg with the pointer attribute as a param.  These are also
182    used in the run-time library for IO.  */
183 typedef enum
184 { BT_UNKNOWN = 0, BT_INTEGER, BT_LOGICAL, BT_REAL, BT_COMPLEX,
185   BT_DERIVED, BT_CHARACTER, BT_CLASS, BT_PROCEDURE, BT_HOLLERITH, BT_VOID,
186   BT_ASSUMED, BT_UNION, BT_BOZ
187 }
188 bt;
189 
190 /* Enumeration of the possible floating-point types. These values
191    correspond to the hidden arguments of the IEEE_CLASS_TYPE
192    derived-type of IEEE_ARITHMETIC.  */
193 
194 enum {
195   IEEE_OTHER_VALUE = 0,
196   IEEE_SIGNALING_NAN,
197   IEEE_QUIET_NAN,
198   IEEE_NEGATIVE_INF,
199   IEEE_NEGATIVE_NORMAL,
200   IEEE_NEGATIVE_DENORMAL,
201   IEEE_NEGATIVE_SUBNORMAL = IEEE_NEGATIVE_DENORMAL,
202   IEEE_NEGATIVE_ZERO,
203   IEEE_POSITIVE_ZERO,
204   IEEE_POSITIVE_DENORMAL,
205   IEEE_POSITIVE_SUBNORMAL = IEEE_POSITIVE_DENORMAL,
206   IEEE_POSITIVE_NORMAL,
207   IEEE_POSITIVE_INF
208 };
209