1/* Header file to the Fortran front-end and runtime library
2 Copyright (C) 2007-2017 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.
23 Please remember to keep those definitions in sync with
24 gfortran.texi. */
25/* For now, use F2015 = GFC_STD_GNU. */
26#define GFC_STD_F2015 (1<<5) /* PLACEHOLDER for Fortran 2015. */
27#define GFC_STD_F2008_TS (1<<9) /* POST-F2008 technical reports. */
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
40/* Bitmasks for the various FPE that can be enabled. These need to be straight integers
41 e.g., 8 instead of (1<<3), because they will be included in Fortran source. */
42#define GFC_FPE_INVALID 1
43#define GFC_FPE_DENORMAL 2
44#define GFC_FPE_ZERO 4
45#define GFC_FPE_OVERFLOW 8
46#define GFC_FPE_UNDERFLOW 16
47#define GFC_FPE_INEXACT 32
48
49/* Defines for floating-point rounding modes. */
50#define GFC_FPE_DOWNWARD 1
51#define GFC_FPE_TONEAREST 2
52#define GFC_FPE_TOWARDZERO 3
53#define GFC_FPE_UPWARD 4
54
55/* Size of the buffer required to store FPU state for any target.
56 In particular, this has to be larger than fenv_t on all glibc targets.
57 Currently, the winner is x86_64 with 32 bytes. */
58#define GFC_FPE_STATE_BUFFER_SIZE 32
59
60/* Bitmasks for the various runtime checks that can be enabled. */
61#define GFC_RTCHECK_BOUNDS (1<<0)
62#define GFC_RTCHECK_ARRAY_TEMPS (1<<1)
63#define GFC_RTCHECK_RECURSION (1<<2)
64#define GFC_RTCHECK_DO (1<<3)
65#define GFC_RTCHECK_POINTER (1<<4)
66#define GFC_RTCHECK_MEM (1<<5)
67#define GFC_RTCHECK_ALL (GFC_RTCHECK_BOUNDS | GFC_RTCHECK_ARRAY_TEMPS \
68 | GFC_RTCHECK_RECURSION | GFC_RTCHECK_DO \
69 | GFC_RTCHECK_POINTER | GFC_RTCHECK_MEM)
70
71/* Special unit numbers used to convey certain conditions. Numbers -4
72 thru -9 available. NEWUNIT values start at -10. */
73#define GFC_INTERNAL_UNIT -1 /* KIND=1 Internal Unit. */
74#define GFC_INTERNAL_UNIT4 -2 /* KIND=4 Internal Unit. */
75#define GFC_INVALID_UNIT -3
76
77/* Possible values for the CONVERT I/O specifier. */
78/* Keep in sync with GFC_FLAG_CONVERT_* in gcc/flags.h. */
79typedef enum
80{
81 GFC_CONVERT_NONE = -1,
82 GFC_CONVERT_NATIVE = 0,
83 GFC_CONVERT_SWAP,
84 GFC_CONVERT_BIG,
85 GFC_CONVERT_LITTLE
86}
87unit_convert;
88
89
90/* Runtime errors. */
91typedef enum
92{
93 LIBERROR_FIRST = -3, /* Marker for the first error. */
94 LIBERROR_EOR = -2, /* End of record, must be negative. */
95 LIBERROR_END = -1, /* End of file, must be negative. */
96 LIBERROR_OK = 0, /* Indicates success, must be zero. */
97 LIBERROR_OS = 5000, /* OS error, more info in errno. */
98 LIBERROR_OPTION_CONFLICT,
99 LIBERROR_BAD_OPTION,
100 LIBERROR_MISSING_OPTION,
101 LIBERROR_ALREADY_OPEN,
102 LIBERROR_BAD_UNIT,
103 LIBERROR_FORMAT,
104 LIBERROR_BAD_ACTION,
105 LIBERROR_ENDFILE,
106 LIBERROR_BAD_US,
107 LIBERROR_READ_VALUE,
108 LIBERROR_READ_OVERFLOW,
109 LIBERROR_INTERNAL,
110 LIBERROR_INTERNAL_UNIT,
111 LIBERROR_ALLOCATION,
112 LIBERROR_DIRECT_EOR,
113 LIBERROR_SHORT_RECORD,
114 LIBERROR_CORRUPT_FILE,
115 LIBERROR_INQUIRE_INTERNAL_UNIT, /* Must be different from STAT_STOPPED_IMAGE. */
116 LIBERROR_LAST /* Not a real error, the last error # + 1. */
117}
118libgfortran_error_codes;
119
120/* Must kept in sync with libgfortran/caf/libcaf.h. */
121typedef enum
122{
123 GFC_STAT_UNLOCKED = 0,
124 GFC_STAT_LOCKED,
125 GFC_STAT_LOCKED_OTHER_IMAGE,
126 GFC_STAT_STOPPED_IMAGE = 6000, /* See LIBERROR_INQUIRE_INTERNAL_UNIT above. */
127 GFC_STAT_FAILED_IMAGE = 6001
128}
129libgfortran_stat_codes;
130
131typedef enum
132{
133 GFC_CAF_ATOMIC_ADD = 1,
134 GFC_CAF_ATOMIC_AND,
135 GFC_CAF_ATOMIC_OR,
136 GFC_CAF_ATOMIC_XOR
137} libcaf_atomic_codes;
138
139
140/* For CO_REDUCE. */
141#define GFC_CAF_BYREF (1<<0)
142#define GFC_CAF_HIDDENLEN (1<<1)
143#define GFC_CAF_ARG_VALUE (1<<2)
144#define GFC_CAF_ARG_DESC (1<<3)
145
146
147/* Default unit number for preconnected standard input and output. */
148#define GFC_STDIN_UNIT_NUMBER 5
149#define GFC_STDOUT_UNIT_NUMBER 6
150#define GFC_STDERR_UNIT_NUMBER 0
151
152
153/* FIXME: Increase to 15 for Fortran 2008. Also needs changes to
154 GFC_DTYPE_RANK_MASK. See PR 36825. */
155#define GFC_MAX_DIMENSIONS 7
156
157#define GFC_DTYPE_RANK_MASK 0x07
158#define GFC_DTYPE_TYPE_SHIFT 3
159#define GFC_DTYPE_TYPE_MASK 0x38
160#define GFC_DTYPE_SIZE_SHIFT 6
161
162/* Basic types. BT_VOID is used by ISO C Binding so funcs like c_f_pointer
163 can take any arg with the pointer attribute as a param. These are also
164 used in the run-time library for IO. */
165typedef enum
166{ BT_UNKNOWN = 0, BT_INTEGER, BT_LOGICAL, BT_REAL, BT_COMPLEX,
167 BT_DERIVED, BT_CHARACTER, BT_CLASS, BT_PROCEDURE, BT_HOLLERITH, BT_VOID,
168 BT_ASSUMED, BT_UNION
169}
170bt;
171