OSDN Git Service

191d8d4807065801124a20bca0c7e39c9fbbb2c4
[pf3gnuchains/gcc-fork.git] / libgfortran / libgfortran.h
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>
5
6 This file is part of the GNU Fortran 95 runtime library (libgfortran).
7
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.
12
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.
17
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.  */
22
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.  */
29
30
31 #ifndef LIBGFOR_H
32 #define LIBGFOR_H
33
34 #include <math.h>
35 #include <stddef.h>
36
37 #ifndef M_PI
38 #define M_PI 3.14159265358979323846264338327
39 #endif
40
41 #if HAVE_COMPLEX_H
42 # include <complex.h>
43 #else
44 #define complex __complex__
45 #endif
46
47 #include "config.h"
48 #include "c99_protos.h"
49
50 #if HAVE_IEEEFP_H
51 #include <ieeefp.h>
52 #endif
53
54 #if HAVE_STDINT_H
55 #include <stdint.h>
56 #endif
57
58 #if HAVE_INTTYPES_H
59 #include <inttypes.h>
60 #endif
61
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
72
73 #if HAVE_SYS_TYPES_H
74 #include <sys/types.h>
75 #endif
76 typedef off_t gfc_offset;
77
78 #ifndef NULL
79 #define NULL (void *) 0
80 #endif
81
82 #ifndef __GNUC__
83 #define __attribute__(x)
84 #endif
85
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
91
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)
97
98 /* There are several classifications of routines:
99
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.
104
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.
108
109    One of the following should be used immediately after the declaration
110    of each symbol:
111
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.
116
117      export_proto       Marks a symbol to be exported, and adds PREFIX
118                         to the assembly-level symbol name.
119
120      export_proto_np    Marks a symbol to be exported without adding PREFIX.
121
122      iexport_proto      Marks a function to be exported, but with the 
123                         understanding that it can be used inside as well.
124
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.
129
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.  */
132
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
139
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
161
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
165
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
171
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.
175
176    Also, isfinite is broken on Cygwin.
177
178    When isfinite is not available, try to use one of the
179    alternatives, or bail out.  */
180
181 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
182 #undef isfinite
183 #endif
184
185 #if defined(HAVE_BROKEN_ISNAN)
186 #undef isnan
187 #endif
188
189 #if defined(HAVE_BROKEN_FPCLASSIFY)
190 #undef fpclassify
191 #endif
192
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)  */
200
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)  */
208
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_);}
213
214 #include "kinds.h"
215
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;
222
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);
226
227 #define GFOR_POINTER_L8_TO_L4(p8) \
228   (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
229
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 #define GFC_REAL_4_HUGE FLT_MAX
235 #define GFC_REAL_8_HUGE DBL_MAX
236
237 #ifndef GFC_MAX_DIMENSIONS
238 #define GFC_MAX_DIMENSIONS 7
239 #endif
240
241 typedef struct descriptor_dimension
242 {
243   index_type stride;
244   index_type lbound;
245   index_type ubound;
246 }
247 descriptor_dimension;
248
249 #define GFC_ARRAY_DESCRIPTOR(r, type) \
250 struct {\
251   type *data;\
252   size_t offset;\
253   index_type dtype;\
254   descriptor_dimension dim[r];\
255 }
256
257 /* Commonly used array descriptor types.  */
258 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
259 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
260 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
261 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
262 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
263 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
264 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
265 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
266 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
267 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
268
269 #define GFC_DTYPE_RANK_MASK 0x07
270 #define GFC_DTYPE_TYPE_SHIFT 3
271 #define GFC_DTYPE_TYPE_MASK 0x38
272 #define GFC_DTYPE_SIZE_SHIFT 6
273
274 enum
275 {
276   GFC_DTYPE_UNKNOWN = 0,
277   GFC_DTYPE_INTEGER,
278   /* TODO: recognize logical types.  */
279   GFC_DTYPE_LOGICAL,
280   GFC_DTYPE_REAL,
281   GFC_DTYPE_COMPLEX,
282   GFC_DTYPE_DERIVED,
283   GFC_DTYPE_CHARACTER
284 };
285
286 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
287 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
288                                    >> GFC_DTYPE_TYPE_SHIFT)
289 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
290 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
291 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
292
293 /* Runtime library include.  */
294 #define stringize(x) expand_macro(x)
295 #define expand_macro(x) # x
296
297 /* Runtime options structure.  */
298
299 typedef struct
300 {
301   int stdin_unit, stdout_unit, stderr_unit, optional_plus;
302   int allocate_init_flag, allocate_init_value;
303   int locus;
304
305   int separator_len;
306   const char *separator;
307
308   int mem_check;
309   int use_stderr, all_unbuffered, default_recl;
310
311   int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
312     fpu_overflow, fpu_underflow, fpu_precision_loss;
313
314   int sighup, sigint;
315 }
316 options_t;
317
318 extern options_t options;
319 internal_proto(options);
320
321
322 /* Compile-time options that will influence the library.  */
323
324 typedef struct
325 {
326   int warn_std;
327   int allow_std;
328 }
329 compile_options_t;
330
331 extern compile_options_t compile_options;
332 internal_proto(compile_options);
333
334 extern void init_compile_options (void);
335 internal_proto(init_compile_options);
336
337
338 /* Structure for statement options.  */
339
340 typedef struct
341 {
342   const char *name;
343   int value;
344 }
345 st_option;
346
347 /* Runtime errors.  The EOR and EOF errors are required to be negative.  */
348
349 typedef enum
350 {
351   ERROR_FIRST = -3,             /* Marker for the first error.  */
352   ERROR_EOR = -2,
353   ERROR_END = -1,
354   ERROR_OK = 0,                 /* Indicates success, must be zero.  */
355   ERROR_OS,                     /* Operating system error, more info in errno.  */
356   ERROR_OPTION_CONFLICT,
357   ERROR_BAD_OPTION,
358   ERROR_MISSING_OPTION,
359   ERROR_ALREADY_OPEN,
360   ERROR_BAD_UNIT,
361   ERROR_FORMAT,
362   ERROR_BAD_ACTION,
363   ERROR_ENDFILE,
364   ERROR_BAD_US,
365   ERROR_READ_VALUE,
366   ERROR_READ_OVERFLOW,
367   ERROR_ARRAY_STRIDE,
368   ERROR_LAST                    /* Not a real error, the last error # + 1.  */
369 }
370 error_codes;
371
372
373 /* Flags to specify which standard/extension contains a feature.
374    Keep them in sync with their counterparts in gcc/fortran/gfortran.h.  */
375 #define GFC_STD_LEGACY          (1<<6) /* Backward compatibility.  */
376 #define GFC_STD_GNU             (1<<5)    /* GNU Fortran extension.  */
377 #define GFC_STD_F2003           (1<<4)    /* New in F2003.  */
378 /* Note that no features were obsoleted nor deleted in F2003.  */
379 #define GFC_STD_F95             (1<<3)    /* New in F95.  */
380 #define GFC_STD_F95_DEL         (1<<2)    /* Deleted in F95.  */
381 #define GFC_STD_F95_OBS         (1<<1)    /* Obsoleted in F95.  */
382 #define GFC_STD_F77             (1<<0)    /* Up to and including F77.  */
383
384
385 /* The filename and line number don't go inside the globals structure.
386    They are set by the rest of the program and must be linked to.  */
387
388 /* Location of the current library call (optional).  */
389 extern unsigned line;
390 iexport_data_proto(line);
391
392 extern char *filename;
393 iexport_data_proto(filename);
394
395 /* Avoid conflicting prototypes of alloca() in system headers by using 
396    GCC's builtin alloca().  */
397 #define gfc_alloca(x)  __builtin_alloca(x)
398
399
400 /* main.c */
401
402 extern void library_start (void);
403 internal_proto(library_start);
404
405 extern void library_end (void);
406 internal_proto(library_end);
407
408 extern void set_args (int, char **);
409 export_proto(set_args);
410
411 extern void get_args (int *, char ***);
412 internal_proto(get_args);
413
414 /* error.c */
415
416 extern char *gfc_itoa (GFC_INTEGER_LARGEST);
417 internal_proto(gfc_itoa);
418
419 extern char *xtoa (GFC_UINTEGER_LARGEST);
420 internal_proto(xtoa);
421
422 extern void os_error (const char *) __attribute__ ((noreturn));
423 internal_proto(os_error);
424
425 extern void show_locus (void);
426 internal_proto(show_locus);
427
428 extern void runtime_error (const char *) __attribute__ ((noreturn));
429 iexport_proto(runtime_error);
430
431 extern void internal_error (const char *) __attribute__ ((noreturn));
432 internal_proto(internal_error);
433
434 extern const char *get_oserror (void);
435 internal_proto(get_oserror);
436
437 extern void sys_exit (int) __attribute__ ((noreturn));
438 internal_proto(sys_exit);
439
440 extern int st_printf (const char *, ...)
441   __attribute__ ((format (printf, 1, 2)));
442 internal_proto(st_printf);
443
444 extern void st_sprintf (char *, const char *, ...)
445   __attribute__ ((format (printf, 2, 3)));
446 internal_proto(st_sprintf);
447
448 extern const char *translate_error (int);
449 internal_proto(translate_error);
450
451 extern void generate_error (int, const char *);
452 internal_proto(generate_error);
453
454 /* memory.c */
455
456 extern void *get_mem (size_t) __attribute__ ((malloc));
457 internal_proto(get_mem);
458
459 extern void free_mem (void *);
460 internal_proto(free_mem);
461
462 extern void *internal_malloc_size (size_t);
463 internal_proto(internal_malloc_size);
464
465 extern void internal_free (void *);
466 iexport_proto(internal_free);
467
468 /* environ.c */
469
470 extern int check_buffered (int);
471 internal_proto(check_buffered);
472
473 extern void init_variables (void);
474 internal_proto(init_variables);
475
476 extern void show_variables (void);
477 internal_proto(show_variables);
478
479 /* string.c */
480
481 extern int find_option (const char *, int, st_option *, const char *);
482 internal_proto(find_option);
483
484 extern int fstrlen (const char *, int);
485 internal_proto(fstrlen);
486
487 extern void fstrcpy (char *, int, const char *, int);
488 internal_proto(fstrcpy);
489
490 extern void cf_strcpy (char *, int, const char *);
491 internal_proto(cf_strcpy);
492
493 /* io.c */
494
495 extern void init_units (void);
496 internal_proto(init_units);
497
498 extern void close_units (void);
499 internal_proto(close_units);
500
501 /* stop.c */
502
503 extern void stop_numeric (GFC_INTEGER_4);
504 iexport_proto(stop_numeric);
505
506 /* reshape_packed.c */
507
508 extern void reshape_packed (char *, index_type, const char *, index_type,
509                             const char *, index_type);
510 internal_proto(reshape_packed);
511
512 /* Repacking functions.  */
513
514 /* ??? These eight aren't currently used by the compiler, though we
515    certainly could do so.  */
516 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
517 internal_proto(internal_pack_4);
518
519 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
520 internal_proto(internal_pack_8);
521
522 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
523 internal_proto(internal_pack_c4);
524
525 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
526 internal_proto(internal_pack_c8);
527
528 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
529 internal_proto(internal_unpack_4);
530
531 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
532 internal_proto(internal_unpack_8);
533
534 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
535 internal_proto(internal_unpack_c4);
536
537 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
538 internal_proto(internal_unpack_c8);
539
540 /* string_intrinsics.c */
541
542 extern GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
543                                      GFC_INTEGER_4, const char *);
544 iexport_proto(compare_string);
545
546 /* random.c */
547
548 extern void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
549                          gfc_array_i4 * get);
550 iexport_proto(random_seed);
551
552 /* normalize.c */
553
554 extern GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
555 internal_proto(normalize_r4_i4);
556
557 extern GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
558 internal_proto(normalize_r8_i8);
559
560 /* size.c */
561
562 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
563
564 extern index_type size0 (const array_t * array); 
565 iexport_proto(size0);
566
567 #endif  /* LIBGFOR_H  */