1/* Header file to the Fortran front-end and runtime library
2 Copyright (C) 2007-2025 Free Software Foundation, Inc.
3
4This file is part of GCC.
5
6GCC is free software; you can redistribute it and/or modify it under
7the terms of the GNU General Public License as published by the Free
8Software Foundation; either version 3, or (at your option) any later
9version.
10
11GCC is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or
13FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14for more details.
15
16You should have received a copy of the GNU General Public License
17along 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 nor in F2023.
23 Nevertheless, some features available in F2018 are prohibited in F2023.
24 Please remember to keep those definitions in sync with
25 gfortran.texi. */
26#define GFC_STD_F202Y (1<<14) /* Enable proposed F202y features. */
27#define GFC_STD_UNSIGNED (1<<14) /* Not really a standard, but
28 better for error handling. */
29#define GFC_STD_F2023_DEL (1<<13) /* Prohibited in F2023. */
30#define GFC_STD_F2023 (1<<12) /* New in F2023. */
31#define GFC_STD_F2018_DEL (1<<11) /* Deleted in F2018. */
32#define GFC_STD_F2018_OBS (1<<10) /* Obsolescent in F2018. */
33#define GFC_STD_F2018 (1<<9) /* New in F2018. */
34#define GFC_STD_F2008_OBS (1<<8) /* Obsolescent in F2008. */
35#define GFC_STD_F2008 (1<<7) /* New in F2008. */
36#define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
37#define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
38#define GFC_STD_F2003 (1<<4) /* New in F2003. */
39#define GFC_STD_F95 (1<<3) /* New in F95. */
40#define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
41#define GFC_STD_F95_OBS (1<<1) /* Obsolescent in F95. */
42#define GFC_STD_F77 (1<<0) /* Included in F77, but not deleted or
43 obsolescent in later standards. */
44
45/* Combinations of the above flags that specify which classes of features
46 * are allowed with a certain -std option. */
47#define GFC_STD_OPT_F95 (GFC_STD_F77 | GFC_STD_F95 | GFC_STD_F95_OBS \
48 | GFC_STD_F2008_OBS | GFC_STD_F2018_OBS \
49 | GFC_STD_F2018_DEL | GFC_STD_F2023_DEL)
50#define GFC_STD_OPT_F03 (GFC_STD_OPT_F95 | GFC_STD_F2003)
51#define GFC_STD_OPT_F08 (GFC_STD_OPT_F03 | GFC_STD_F2008)
52#define GFC_STD_OPT_F18 ((GFC_STD_OPT_F08 | GFC_STD_F2018) \
53 & (~GFC_STD_F2018_DEL))
54#define GFC_STD_OPT_F23 ((GFC_STD_OPT_F18 | GFC_STD_F2023) \
55 & (~GFC_STD_F2023_DEL))
56
57/* Bitmasks for the various FPE that can be enabled. These need to be straight integers
58 e.g., 8 instead of (1<<3), because they will be included in Fortran source. */
59#define GFC_FPE_INVALID 1
60#define GFC_FPE_DENORMAL 2
61#define GFC_FPE_ZERO 4
62#define GFC_FPE_OVERFLOW 8
63#define GFC_FPE_UNDERFLOW 16
64#define GFC_FPE_INEXACT 32
65
66/* Defines for floating-point rounding modes. */
67#define GFC_FPE_DOWNWARD 1
68#define GFC_FPE_TONEAREST 2
69#define GFC_FPE_TOWARDZERO 3
70#define GFC_FPE_UPWARD 4
71#define GFC_FPE_AWAY 5
72
73/* Size of the buffer required to store FPU state for any target.
74 In particular, this has to be larger than fenv_t on all glibc targets.
75 Currently, the winner is x86_64 with 32 bytes. */
76#define GFC_FPE_STATE_BUFFER_SIZE 32
77
78/* Bitmasks for the various runtime checks that can be enabled. */
79#define GFC_RTCHECK_BOUNDS (1<<0)
80#define GFC_RTCHECK_ARRAY_TEMPS (1<<1)
81#define GFC_RTCHECK_RECURSION (1<<2)
82#define GFC_RTCHECK_DO (1<<3)
83#define GFC_RTCHECK_POINTER (1<<4)
84#define GFC_RTCHECK_MEM (1<<5)
85#define GFC_RTCHECK_BITS (1<<6)
86#define GFC_RTCHECK_ALL (GFC_RTCHECK_BOUNDS | GFC_RTCHECK_ARRAY_TEMPS \
87 | GFC_RTCHECK_RECURSION | GFC_RTCHECK_DO \
88 | GFC_RTCHECK_POINTER | GFC_RTCHECK_MEM \
89 | GFC_RTCHECK_BITS)
90
91/* Special unit numbers used to convey certain conditions. Numbers -4
92 thru -9 available. NEWUNIT values start at -10. */
93#define GFC_INTERNAL_UNIT -1 /* KIND=1 Internal Unit. */
94#define GFC_INTERNAL_UNIT4 -2 /* KIND=4 Internal Unit. */
95#define GFC_INVALID_UNIT -3
96
97/* Possible values for the CONVERT I/O specifier. */
98/* Keep in sync with GFC_FLAG_CONVERT_* in gcc/flag-types.h. */
99typedef enum
100{
101 GFC_CONVERT_NONE = -1,
102 GFC_CONVERT_NATIVE = 0,
103 GFC_CONVERT_SWAP,
104 GFC_CONVERT_BIG,
105 GFC_CONVERT_LITTLE,
106 GFC_CONVERT_R16_IEEE = 4,
107 GFC_CONVERT_R16_IEEE_SWAP,
108 GFC_CONVERT_R16_IEEE_BIG,
109 GFC_CONVERT_R16_IEEE_LITTLE,
110 GFC_CONVERT_R16_IBM = 8,
111 GFC_CONVERT_R16_IBM_SWAP,
112 GFC_CONVERT_R16_IBM_BIG,
113 GFC_CONVERT_R16_IBM_LITTLE,
114}
115unit_convert;
116
117
118/* Runtime errors. */
119typedef enum
120{
121 LIBERROR_FIRST = -3, /* Marker for the first error. */
122 LIBERROR_EOR = -2, /* End of record, must be negative. */
123 LIBERROR_END = -1, /* End of file, must be negative. */
124 LIBERROR_OK = 0, /* Indicates success, must be zero. */
125 LIBERROR_OS = 5000, /* OS error, more info in errno. */
126 LIBERROR_OPTION_CONFLICT,
127 LIBERROR_BAD_OPTION,
128 LIBERROR_MISSING_OPTION,
129 LIBERROR_ALREADY_OPEN,
130 LIBERROR_BAD_UNIT,
131 LIBERROR_FORMAT,
132 LIBERROR_BAD_ACTION,
133 LIBERROR_ENDFILE,
134 LIBERROR_BAD_US,
135 LIBERROR_READ_VALUE,
136 LIBERROR_READ_OVERFLOW,
137 LIBERROR_INTERNAL,
138 LIBERROR_INTERNAL_UNIT,
139 LIBERROR_ALLOCATION,
140 LIBERROR_DIRECT_EOR,
141 LIBERROR_SHORT_RECORD,
142 LIBERROR_CORRUPT_FILE,
143 LIBERROR_INQUIRE_INTERNAL_UNIT, /* Must be different from STAT_STOPPED_IMAGE. */
144 LIBERROR_BAD_WAIT_ID,
145 LIBERROR_NO_MEMORY,
146 LIBERROR_LAST /* Not a real error, the last error # + 1. */
147}
148libgfortran_error_codes;
149
150/* Must kept in sync with libgfortran/caf/libcaf.h. */
151typedef enum
152{
153 GFC_STAT_UNLOCKED = 0,
154 GFC_STAT_LOCKED,
155 GFC_STAT_LOCKED_OTHER_IMAGE,
156 GFC_STAT_STOPPED_IMAGE = 6000, /* See LIBERROR_INQUIRE_INTERNAL_UNIT above. */
157 GFC_STAT_FAILED_IMAGE = 6001,
158 GFC_STAT_UNLOCKED_FAILED_IMAGE = 6002
159}
160libgfortran_stat_codes;
161
162typedef enum
163{
164 GFC_CAF_INITIAL_TEAM = 0,
165 GFC_CAF_PARENT_TEAM,
166 GFC_CAF_CURRENT_TEAM
167} libgfortran_team_levels;
168
169typedef enum
170{
171 GFC_CAF_ATOMIC_ADD = 1,
172 GFC_CAF_ATOMIC_AND,
173 GFC_CAF_ATOMIC_OR,
174 GFC_CAF_ATOMIC_XOR
175} libcaf_atomic_codes;
176
177
178/* For CO_REDUCE. */
179#define GFC_CAF_BYREF (1<<0)
180#define GFC_CAF_HIDDENLEN (1<<1)
181#define GFC_CAF_ARG_VALUE (1<<2)
182#define GFC_CAF_ARG_DESC (1<<3)
183
184
185/* Default unit number for preconnected standard input and output. */
186#define GFC_STDIN_UNIT_NUMBER 5
187#define GFC_STDOUT_UNIT_NUMBER 6
188#define GFC_STDERR_UNIT_NUMBER 0
189
190/* F2003 onward. For std < F2003, error caught in array.cc(gfc_match_array_ref). */
191#define GFC_MAX_DIMENSIONS 15
192
193#define GFC_DTYPE_RANK_MASK 0x0F
194#define GFC_DTYPE_TYPE_SHIFT 4
195#define GFC_DTYPE_TYPE_MASK 0x70
196#define GFC_DTYPE_SIZE_SHIFT 7
197
198/* Basic types. BT_VOID is used by ISO C Binding so funcs like c_f_pointer
199 can take any arg with the pointer attribute as a param. These are also
200 used in the run-time library for IO. */
201typedef enum
202{ BT_UNKNOWN = 0, BT_INTEGER, BT_LOGICAL, BT_REAL, BT_COMPLEX,
203 BT_DERIVED, BT_CHARACTER, BT_CLASS, BT_PROCEDURE, BT_HOLLERITH, BT_VOID,
204 BT_ASSUMED, BT_UNION, BT_BOZ, BT_UNSIGNED
205}
206bt;
207
208/* Enumeration of the possible floating-point types. These values
209 correspond to the hidden arguments of the IEEE_CLASS_TYPE
210 derived-type of IEEE_ARITHMETIC. */
211
212enum {
213 IEEE_OTHER_VALUE = 0,
214 IEEE_SIGNALING_NAN,
215 IEEE_QUIET_NAN,
216 IEEE_NEGATIVE_INF,
217 IEEE_NEGATIVE_NORMAL,
218 IEEE_NEGATIVE_DENORMAL,
219 IEEE_NEGATIVE_SUBNORMAL = IEEE_NEGATIVE_DENORMAL,
220 IEEE_NEGATIVE_ZERO,
221 IEEE_POSITIVE_ZERO,
222 IEEE_POSITIVE_DENORMAL,
223 IEEE_POSITIVE_SUBNORMAL = IEEE_POSITIVE_DENORMAL,
224 IEEE_POSITIVE_NORMAL,
225 IEEE_POSITIVE_INF
226};
227

Provided by KDAB

Privacy Policy
Learn to use CMake with our Intro Training
Find out more

source code of gcc/fortran/libgfortran.h