Remove conflict marker.
[official-gcc.git] / libgfortran / libgfortran.h
blob174873b67a339315d5827abab140e73b533b3ad3
1 /* Common declarations for all of libgfor.
2 Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 Contributed by Paul Brook <paul@nowt.org>, and
4 Andy Vaught <andy@xena.eas.asu.edu>
6 This file is part of the GNU Fortran 95 runtime library (libgfortran).
8 Libgfortran is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Lesser General Public
10 License as published by the Free Software Foundation; either
11 version 2.1 of the License, or (at your option) any later version.
13 Libgfortran is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public
19 License along with libgfor; see the file COPYING.LIB. If not,
20 write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
23 /* As a special exception, if you link this library with other files,
24 some of which are compiled with GCC, to produce an executable,
25 this library does not by itself cause the resulting executable
26 to be covered by the GNU General Public License.
27 This exception does not however invalidate any other reasons why
28 the executable file might be covered by the GNU General Public License. */
31 #ifndef LIBGFOR_H
32 #define LIBGFOR_H
34 #include <math.h>
35 #include <stddef.h>
37 #ifndef M_PI
38 #define M_PI 3.14159265358979323846264338327
39 #endif
41 #if HAVE_COMPLEX_H
42 # include <complex.h>
43 #else
44 #define complex __complex__
45 #endif
47 #include "config.h"
48 #include "c99_protos.h"
50 #if HAVE_IEEEFP_H
51 #include <ieeefp.h>
52 #endif
54 #if HAVE_STDINT_H
55 #include <stdint.h>
56 #endif
58 #if HAVE_INTTYPES_H
59 #include <inttypes.h>
60 #endif
62 #if !defined(HAVE_STDINT_H) && !defined(HAVE_INTTYPES_H) && defined(TARGET_ILP32)
63 typedef char int8_t;
64 typedef short int16_t;
65 typedef int int32_t;
66 typedef long long int64_t;
67 typedef unsigned char uint8_t;
68 typedef unsigned short uint16_t;
69 typedef unsigned int uint32_t;
70 typedef unsigned long long uint64_t;
71 #endif
73 #if HAVE_SYS_TYPES_H
74 #include <sys/types.h>
75 #endif
76 typedef off_t gfc_offset;
78 #ifndef NULL
79 #define NULL (void *) 0
80 #endif
82 #ifndef __GNUC__
83 #define __attribute__(x)
84 #endif
86 /* For a library, a standard prefix is a requirement in order to partition
87 the namespace. IPREFIX is for symbols intended to be internal to the
88 library. */
89 #define PREFIX(x) _gfortran_ ## x
90 #define IPREFIX(x) _gfortrani_ ## x
92 /* Magic to rename a symbol at the compiler level. You continue to refer
93 to the symbol as OLD in the source, but it'll be named NEW in the asm. */
94 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
95 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
96 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
98 /* There are several classifications of routines:
100 (1) Symbols used only within the library,
101 (2) Symbols to be exported from the library,
102 (3) Symbols to be exported from the library, but
103 also used inside the library.
105 By telling the compiler about these different classifications we can
106 tightly control the interface seen by the user, and get better code
107 from the compiler at the same time.
109 One of the following should be used immediately after the declaration
110 of each symbol:
112 internal_proto Marks a symbol used only within the library,
113 and adds IPREFIX to the assembly-level symbol
114 name. The later is important for maintaining
115 the namespace partition for the static library.
117 export_proto Marks a symbol to be exported, and adds PREFIX
118 to the assembly-level symbol name.
120 export_proto_np Marks a symbol to be exported without adding PREFIX.
122 iexport_proto Marks a function to be exported, but with the
123 understanding that it can be used inside as well.
125 iexport_data_proto Similarly, marks a data symbol to be exported.
126 Unfortunately, some systems can't play the hidden
127 symbol renaming trick on data symbols, thanks to
128 the horribleness of COPY relocations.
130 If iexport_proto or iexport_data_proto is used, you must also use
131 iexport or iexport_data after the *definition* of the symbol. */
133 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
134 # define internal_proto(x) \
135 sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
136 #else
137 # define internal_proto(x) sym_rename(x, IPREFIX(x))
138 #endif
140 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
141 # define export_proto(x) sym_rename(x, PREFIX(x))
142 # define export_proto_np(x) extern char swallow_semicolon
143 # define iexport_proto(x) internal_proto(x)
144 # define iexport(x) iexport1(x, __USER_LABEL_PREFIX__, IPREFIX(x))
145 # define iexport1(x,p,y) iexport2(x,p,y)
146 # define iexport2(x,p,y) \
147 extern __typeof(x) PREFIX(x) __attribute__((__alias__(#p #y)))
148 /* ??? We're not currently building a dll, and it's wrong to add dllexport
149 to objects going into a static library archive. */
150 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
151 # define export_proto_np(x) extern __typeof(x) x __attribute__((dllexport))
152 # define export_proto(x) sym_rename(x, PREFIX(x)) __attribute__((dllexport))
153 # define iexport_proto(x) export_proto(x)
154 # define iexport(x) extern char swallow_semicolon
155 #else
156 # define export_proto(x) sym_rename(x, PREFIX(x))
157 # define export_proto_np(x) extern char swallow_semicolon
158 # define iexport_proto(x) export_proto(x)
159 # define iexport(x) extern char swallow_semicolon
160 #endif
162 /* TODO: detect the case when we *can* hide the symbol. */
163 #define iexport_data_proto(x) export_proto(x)
164 #define iexport_data(x) extern char swallow_semicolon
166 /* The only reliable way to get the offset of a field in a struct
167 in a system independent way is via this macro. */
168 #ifndef offsetof
169 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *) 0)->MEMBER)
170 #endif
172 /* The isfinite macro is only available with C99, but some non-C99
173 systems still provide fpclassify, and there is a `finite' function
174 in BSD.
176 Also, isfinite is broken on Cygwin.
178 When isfinite is not available, try to use one of the
179 alternatives, or bail out. */
181 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
182 #undef isfinite
183 #endif
185 #if defined(HAVE_BROKEN_ISNAN)
186 #undef isnan
187 #endif
189 #if defined(HAVE_BROKEN_FPCLASSIFY)
190 #undef fpclassify
191 #endif
193 #if !defined(isfinite)
194 #if !defined(fpclassify)
195 #define isfinite(x) ((x) - (x) == 0)
196 #else
197 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
198 #endif /* !defined(fpclassify) */
199 #endif /* !defined(isfinite) */
201 #if !defined(isnan)
202 #if !defined(fpclassify)
203 #define isnan(x) ((x) != (x))
204 #else
205 #define isnan(x) (fpclassify(x) == FP_NAN)
206 #endif /* !defined(fpclassify) */
207 #endif /* !defined(isfinite) */
209 /* TODO: find the C99 version of these an move into above ifdef. */
210 #define REALPART(z) (__real__(z))
211 #define IMAGPART(z) (__imag__(z))
212 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
214 #include "kinds.h"
216 /* The following two definitions must be consistent with the types used
217 by the compiler. */
218 /* The type used of array indices, amongst other things. */
219 typedef ssize_t index_type;
220 /* The type used for the lengths of character variables. */
221 typedef GFC_INTEGER_4 gfc_charlen_type;
223 /* This will be 0 on little-endian machines and one on big-endian machines. */
224 extern int l8_to_l4_offset;
225 internal_proto(l8_to_l4_offset);
227 #define GFOR_POINTER_L8_TO_L4(p8) \
228 (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
230 #define GFC_INTEGER_4_HUGE \
231 (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
232 #define GFC_INTEGER_8_HUGE \
233 (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
234 #ifdef HAVE_GFC_INTEGER_16
235 #define GFC_INTEGER_16_HUGE \
236 (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
237 #endif
239 #define GFC_REAL_4_HUGE FLT_MAX
240 #define GFC_REAL_8_HUGE DBL_MAX
241 #ifdef HAVE_GFC_REAL_10
242 #define GFC_REAL_10_HUGE LDBL_MAX
243 #endif
244 #ifdef HAVE_GFC_REAL_16
245 #define GFC_REAL_16_HUGE LDBL_MAX
246 #endif
248 #ifndef GFC_MAX_DIMENSIONS
249 #define GFC_MAX_DIMENSIONS 7
250 #endif
252 typedef struct descriptor_dimension
254 index_type stride;
255 index_type lbound;
256 index_type ubound;
258 descriptor_dimension;
260 #define GFC_ARRAY_DESCRIPTOR(r, type) \
261 struct {\
262 type *data;\
263 size_t offset;\
264 index_type dtype;\
265 descriptor_dimension dim[r];\
268 /* Commonly used array descriptor types. */
269 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
270 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
271 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
272 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
273 #ifdef HAVE_GFC_INTEGER_16
274 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_16) gfc_array_i16;
275 #endif
276 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
277 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
278 #ifdef HAVE_GFC_REAL_10
279 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_10) gfc_array_r10;
280 #endif
281 #ifdef HAVE_GFC_REAL_16
282 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_16) gfc_array_r16;
283 #endif
284 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
285 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
286 #ifdef HAVE_GFC_COMPLEX_10
287 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_10) gfc_array_c10;
288 #endif
289 #ifdef HAVE_GFC_COMPLEX_16
290 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_16) gfc_array_c16;
291 #endif
292 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
293 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
294 #ifdef HAVE_GFC_LOGICAL_16
295 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_16) gfc_array_l16;
296 #endif
298 #define GFC_DTYPE_RANK_MASK 0x07
299 #define GFC_DTYPE_TYPE_SHIFT 3
300 #define GFC_DTYPE_TYPE_MASK 0x38
301 #define GFC_DTYPE_SIZE_SHIFT 6
303 enum
305 GFC_DTYPE_UNKNOWN = 0,
306 GFC_DTYPE_INTEGER,
307 /* TODO: recognize logical types. */
308 GFC_DTYPE_LOGICAL,
309 GFC_DTYPE_REAL,
310 GFC_DTYPE_COMPLEX,
311 GFC_DTYPE_DERIVED,
312 GFC_DTYPE_CHARACTER
315 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
316 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
317 >> GFC_DTYPE_TYPE_SHIFT)
318 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
319 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
320 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
322 /* Runtime library include. */
323 #define stringize(x) expand_macro(x)
324 #define expand_macro(x) # x
326 /* Runtime options structure. */
328 typedef struct
330 int stdin_unit, stdout_unit, stderr_unit, optional_plus;
331 int allocate_init_flag, allocate_init_value;
332 int locus;
334 int separator_len;
335 const char *separator;
337 int mem_check;
338 int use_stderr, all_unbuffered, default_recl;
340 int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
341 fpu_overflow, fpu_underflow, fpu_precision_loss;
343 int sighup, sigint;
345 options_t;
347 extern options_t options;
348 internal_proto(options);
351 /* Compile-time options that will influence the library. */
353 typedef struct
355 int warn_std;
356 int allow_std;
358 compile_options_t;
360 extern compile_options_t compile_options;
361 internal_proto(compile_options);
363 extern void init_compile_options (void);
364 internal_proto(init_compile_options);
367 /* Structure for statement options. */
369 typedef struct
371 const char *name;
372 int value;
374 st_option;
376 /* Runtime errors. The EOR and EOF errors are required to be negative. */
378 typedef enum
380 ERROR_FIRST = -3, /* Marker for the first error. */
381 ERROR_EOR = -2,
382 ERROR_END = -1,
383 ERROR_OK = 0, /* Indicates success, must be zero. */
384 ERROR_OS, /* Operating system error, more info in errno. */
385 ERROR_OPTION_CONFLICT,
386 ERROR_BAD_OPTION,
387 ERROR_MISSING_OPTION,
388 ERROR_ALREADY_OPEN,
389 ERROR_BAD_UNIT,
390 ERROR_FORMAT,
391 ERROR_BAD_ACTION,
392 ERROR_ENDFILE,
393 ERROR_BAD_US,
394 ERROR_READ_VALUE,
395 ERROR_READ_OVERFLOW,
396 ERROR_ARRAY_STRIDE,
397 ERROR_LAST /* Not a real error, the last error # + 1. */
399 error_codes;
402 /* Flags to specify which standard/extension contains a feature.
403 Keep them in sync with their counterparts in gcc/fortran/gfortran.h. */
404 #define GFC_STD_LEGACY (1<<6) /* Backward compatibility. */
405 #define GFC_STD_GNU (1<<5) /* GNU Fortran extension. */
406 #define GFC_STD_F2003 (1<<4) /* New in F2003. */
407 /* Note that no features were obsoleted nor deleted in F2003. */
408 #define GFC_STD_F95 (1<<3) /* New in F95. */
409 #define GFC_STD_F95_DEL (1<<2) /* Deleted in F95. */
410 #define GFC_STD_F95_OBS (1<<1) /* Obsoleted in F95. */
411 #define GFC_STD_F77 (1<<0) /* Up to and including F77. */
414 /* The filename and line number don't go inside the globals structure.
415 They are set by the rest of the program and must be linked to. */
417 /* Location of the current library call (optional). */
418 extern unsigned line;
419 iexport_data_proto(line);
421 extern char *filename;
422 iexport_data_proto(filename);
424 /* Avoid conflicting prototypes of alloca() in system headers by using
425 GCC's builtin alloca(). */
426 #define gfc_alloca(x) __builtin_alloca(x)
429 /* main.c */
431 extern void library_start (void);
432 internal_proto(library_start);
434 extern void library_end (void);
435 internal_proto(library_end);
437 extern void set_args (int, char **);
438 export_proto(set_args);
440 extern void get_args (int *, char ***);
441 internal_proto(get_args);
443 /* error.c */
445 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
446 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
447 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
448 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
450 extern const char *gfc_itoa (GFC_INTEGER_LARGEST, char *, size_t);
451 internal_proto(gfc_itoa);
453 extern const char *xtoa (GFC_UINTEGER_LARGEST, char *, size_t);
454 internal_proto(xtoa);
456 extern void os_error (const char *) __attribute__ ((noreturn));
457 internal_proto(os_error);
459 extern void show_locus (void);
460 internal_proto(show_locus);
462 extern void runtime_error (const char *) __attribute__ ((noreturn));
463 iexport_proto(runtime_error);
465 extern void internal_error (const char *) __attribute__ ((noreturn));
466 internal_proto(internal_error);
468 extern const char *get_oserror (void);
469 internal_proto(get_oserror);
471 extern void sys_exit (int) __attribute__ ((noreturn));
472 internal_proto(sys_exit);
474 extern int st_printf (const char *, ...)
475 __attribute__ ((format (printf, 1, 2)));
476 internal_proto(st_printf);
478 extern void st_sprintf (char *, const char *, ...)
479 __attribute__ ((format (printf, 2, 3)));
480 internal_proto(st_sprintf);
482 extern const char *translate_error (int);
483 internal_proto(translate_error);
485 extern void generate_error (int, const char *);
486 internal_proto(generate_error);
488 /* memory.c */
490 extern void *get_mem (size_t) __attribute__ ((malloc));
491 internal_proto(get_mem);
493 extern void free_mem (void *);
494 internal_proto(free_mem);
496 extern void *internal_malloc_size (size_t);
497 internal_proto(internal_malloc_size);
499 extern void internal_free (void *);
500 iexport_proto(internal_free);
502 /* environ.c */
504 extern int check_buffered (int);
505 internal_proto(check_buffered);
507 extern void init_variables (void);
508 internal_proto(init_variables);
510 extern void show_variables (void);
511 internal_proto(show_variables);
513 /* string.c */
515 extern int find_option (const char *, int, const st_option *, const char *);
516 internal_proto(find_option);
518 extern int fstrlen (const char *, int);
519 internal_proto(fstrlen);
521 extern void fstrcpy (char *, int, const char *, int);
522 internal_proto(fstrcpy);
524 extern void cf_strcpy (char *, int, const char *);
525 internal_proto(cf_strcpy);
527 /* io.c */
529 extern void init_units (void);
530 internal_proto(init_units);
532 extern void close_units (void);
533 internal_proto(close_units);
535 /* stop.c */
537 extern void stop_numeric (GFC_INTEGER_4);
538 iexport_proto(stop_numeric);
540 /* reshape_packed.c */
542 extern void reshape_packed (char *, index_type, const char *, index_type,
543 const char *, index_type);
544 internal_proto(reshape_packed);
546 /* Repacking functions. */
548 /* ??? These eight aren't currently used by the compiler, though we
549 certainly could do so. */
550 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
551 internal_proto(internal_pack_4);
553 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
554 internal_proto(internal_pack_8);
556 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
557 internal_proto(internal_pack_c4);
559 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
560 internal_proto(internal_pack_c8);
562 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
563 internal_proto(internal_unpack_4);
565 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
566 internal_proto(internal_unpack_8);
568 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
569 internal_proto(internal_unpack_c4);
571 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
572 internal_proto(internal_unpack_c8);
574 /* string_intrinsics.c */
576 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
577 GFC_INTEGER_4, const char *);
578 iexport_proto(compare_string);
580 /* random.c */
582 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
583 gfc_array_i4 * get);
584 iexport_proto(random_seed);
586 /* normalize.c */
588 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
589 internal_proto(normalize_r4_i4);
591 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
592 internal_proto(normalize_r8_i8);
594 /* size.c */
596 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
598 extern index_type size0 (const array_t * array);
599 iexport_proto(size0);
601 #endif /* LIBGFOR_H */