libgfortran/libgfortran.h

   1 /* Common declarations for all of libgfor.
   2    Copyright (C) 2002, 2003, 2004 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 (libgfor).
   7
   8 Libgfor 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 Libgfor 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., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23
  24 #ifndef LIBGFOR_H
  25 #define LIBGFOR_H
  26
  27 #include <math.h>
  28 #include <stddef.h>
  29
  30 #ifndef M_PI
  31 #define M_PI 3.14159265358979323846264338327
  32 #endif
  33
  34 #include "config.h"
  35
  36 #if HAVE_COMPLEX_H
  37 # include <complex.h>
  38 #else
  39 #define complex __complex__
  40 #endif
  41
  42 #if HAVE_STDINT_H
  43 #include <stdint.h>
  44 #endif
  45
  46 #if HAVE_INTTYPES_H
  47 #include <inttypes.h>
  48 #endif
  49
  50 #if HAVE_SYS_TYPES_H
  51 #include <sys/types.h>
  52 #endif
  53 typedef off_t gfc_offset;
  54
  55 #ifndef NULL
  56 #define NULL (void *) 0
  57 #endif
  58
  59 #ifndef __GNUC__
  60 #define __attribute__(x)
  61 #endif
  62
  63 /* For a library, a standard prefix is a requirement in order to
  64    partition the namespace.  It's ugly to look at and a pain to type,
  65    so we hide it behind macros.  */
  66 #define prefix(x) _gfortran_ ## x
  67
  68 /* The only reliable way to get the offset of a field in a struct
  69    in a system independent way is via this macro.  */
  70 #ifndef offsetof
  71 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
  72 #endif
  73
  74 /* TODO: find the C99 version of these an move into above ifdef.  */
  75 #define REALPART(z) (__real__(z))
  76 #define IMAGPART(z) (__imag__(z))
  77 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
  78
  79 typedef int32_t GFC_INTEGER_4;
  80 typedef int64_t GFC_INTEGER_8;
  81 typedef uint32_t GFC_UINTEGER_4;
  82 typedef uint64_t GFC_UINTEGER_8;
  83 typedef GFC_INTEGER_4 GFC_LOGICAL_4;
  84 typedef GFC_INTEGER_8 GFC_LOGICAL_8;
  85 typedef float GFC_REAL_4;
  86 typedef double GFC_REAL_8;
  87 typedef complex float GFC_COMPLEX_4;
  88 typedef complex double GFC_COMPLEX_8;
  89
  90 /* The following two definitions must be consistent with the types used
  91    by the compiler.  */
  92 /* The type used of array indices, amongst other things.  */
  93 typedef size_t index_type;
  94 /* The type used for the lengths of character variables.  */
  95 typedef GFC_INTEGER_4 gfc_charlen_type;
  96
  97 /* This will be 0 on little-endian machines and one on big-endian machines.  */
  98 #define l8_to_l4_offset prefix(l8_to_l4_offset)
  99 extern int l8_to_l4_offset;
 100
 101 #define GFOR_POINTER_L8_TO_L4(p8) \
 102   (l8_to_l4_offset + (GFC_LOGICAL_4 *)(p8))
 103
 104 #define GFC_INTEGER_4_HUGE \
 105   (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
 106 #define GFC_INTEGER_8_HUGE \
 107   (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
 108 #define GFC_REAL_4_HUGE FLT_MAX
 109 #define GFC_REAL_8_HUGE DBL_MAX
 110
 111 #ifndef GFC_MAX_DIMENSIONS
 112 #define GFC_MAX_DIMENSIONS 7
 113 #endif
 114
 115 typedef struct descriptor_dimension
 116 {
 117   index_type stride;
 118   index_type lbound;
 119   index_type ubound;
 120 }
 121 descriptor_dimension;
 122
 123 #define GFC_ARRAY_DESCRIPTOR(r, type) \
 124 struct {\
 125   type *data;\
 126   type *base;\
 127   index_type dtype;\
 128   descriptor_dimension dim[r];\
 129 }
 130
 131 /* Commonly used array descriptor types.  */
 132 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
 133 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
 134 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
 135 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
 136 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
 137 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
 138 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
 139 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
 140 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
 141 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
 142
 143 #define GFC_DTYPE_RANK_MASK 0x07
 144 #define GFC_DTYPE_TYPE_SHIFT 3
 145 #define GFC_DTYPE_TYPE_MASK 0x38
 146 #define GFC_DTYPE_SIZE_SHIFT 6
 147
 148 enum
 149 {
 150   GFC_DTYPE_UNKNOWN = 0,
 151   GFC_DTYPE_INTEGER,
 152   /* TODO: recognize logical types.  */
 153   GFC_DTYPE_LOGICAL,
 154   GFC_DTYPE_REAL,
 155   GFC_DTYPE_COMPLEX,
 156   GFC_DTYPE_DERIVED,
 157   GFC_DTYPE_CHARACTER
 158 };
 159
 160 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
 161 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
 162                                    >> GFC_DTYPE_TYPE_SHIFT)
 163 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
 164 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
 165 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
 166
 167 /* Runtime library include.  */
 168 #define stringize(x) expand_macro(x)
 169 #define expand_macro(x) # x
 170
 171 /* Runtime options structure.  */
 172
 173 typedef struct
 174 {
 175   int stdin_unit, stdout_unit, optional_plus;
 176   int allocate_init_flag, allocate_init_value;
 177   int locus;
 178
 179   int separator_len;
 180   const char *separator;
 181
 182   int mem_check;
 183   int use_stderr, all_unbuffered, default_recl;
 184
 185   int fpu_round, fpu_precision, fpu_invalid, fpu_denormal, fpu_zerodiv,
 186     fpu_overflow, fpu_underflow, fpu_precision_loss;
 187
 188   int sighup, sigint;
 189 }
 190 options_t;
 191
 192
 193 #define options prefix(options)
 194 extern options_t options;
 195
 196
 197 /* Structure for statement options.  */
 198
 199 typedef struct
 200 {
 201   const char *name;
 202   int value;
 203 }
 204 st_option;
 205
 206 /* Runtime errors.  The EOR and EOF errors are required to be negative.  */
 207
 208 typedef enum
 209 {
 210   ERROR_FIRST = -3,             /* Marker for the first error.  */
 211   ERROR_EOR = -2,
 212   ERROR_END = -1,
 213   ERROR_OK = 0,                 /* Indicates success, must be zero.  */
 214   ERROR_OS,                     /* Operating system error, more info in errno.  */
 215   ERROR_OPTION_CONFLICT,
 216   ERROR_BAD_OPTION,
 217   ERROR_MISSING_OPTION,
 218   ERROR_ALREADY_OPEN,
 219   ERROR_BAD_UNIT,
 220   ERROR_FORMAT,
 221   ERROR_BAD_ACTION,
 222   ERROR_ENDFILE,
 223   ERROR_BAD_US,
 224   ERROR_READ_VALUE,
 225   ERROR_READ_OVERFLOW,
 226   ERROR_LAST                    /* Not a real error, the last error # + 1.  */
 227 }
 228 error_codes;
 229
 230
 231 /* The filename and line number don't go inside the globals structure.
 232    They are set by the rest of the program and must be linked to.  */
 233
 234 #define line prefix(line)
 235 extern unsigned line;           /* Location of the current libray call (optional).  */
 236
 237 #define filename prefix(filename)
 238 extern char *filename;
 239
 240 /* Avoid conflicting prototypes of alloca() in system headers by using
 241    GCC's builtin alloca().  */
 242
 243 #define gfc_alloca(x)  __builtin_alloca(x)
 244
 245
 246 /* main.c */
 247
 248 #define library_start prefix(library_start)
 249 void library_start (void);
 250
 251 #define library_end prefix(library_end)
 252 void library_end (void);
 253
 254 #define set_args prefix(set_args)
 255 void set_args (int, char **);
 256
 257 #define get_args prefix(get_args)
 258 void get_args (int *, char ***);
 259
 260
 261 /* error.c */
 262 #define itoa prefix(itoa)
 263 char *itoa (int64_t);
 264
 265 #define xtoa prefix(xtoa)
 266 char *xtoa (uint64_t);
 267
 268 #define os_error prefix(os_error)
 269 void os_error (const char *) __attribute__ ((noreturn));
 270
 271 #define show_locus prefix(show_locus)
 272 void show_locus (void);
 273
 274 #define runtime_error prefix(runtime_error)
 275 void runtime_error (const char *) __attribute__ ((noreturn));
 276
 277 #define internal_error prefix(internal_error)
 278 void internal_error (const char *) __attribute__ ((noreturn));
 279
 280 #define get_oserror prefix(get_oserror)
 281 const char *get_oserror (void);
 282
 283 #define write_error prefix(write_error)
 284 void write_error (const char *);
 285
 286 #define sys_exit prefix(sys_exit)
 287 void sys_exit (int) __attribute__ ((noreturn));
 288
 289 #define st_printf prefix(st_printf)
 290 int st_printf (const char *, ...) __attribute__ ((format (printf, 1, 2)));
 291
 292 #define st_sprintf prefix(st_sprintf)
 293 void st_sprintf (char *, const char *, ...) __attribute__ ((format (printf, 2, 3)));
 294
 295 #define translate_error prefix(translate_error)
 296 const char *translate_error (int);
 297
 298 #define generate_error prefix(generate_error)
 299 void generate_error (int, const char *);
 300
 301
 302 /* memory.c */
 303
 304 #define memory_init     prefix(memory_init)
 305 void memory_init (void);
 306
 307 #define runtime_cleanup prefix(runtime_cleanup)
 308 void runtime_cleanup (void);
 309
 310 #define get_mem         prefix(get_mem)
 311 void *get_mem (size_t) __attribute__ ((malloc));
 312
 313 #define free_mem        prefix(free_mem)
 314 void free_mem (void *);
 315
 316 #define internal_malloc_size    prefix(internal_malloc_size)
 317 void *internal_malloc_size (size_t);
 318
 319 #define internal_malloc prefix(internal_malloc)
 320 void *internal_malloc (GFC_INTEGER_4);
 321
 322 #define internal_malloc64 prefix(internal_malloc64)
 323 void *internal_malloc64 (GFC_INTEGER_8);
 324
 325 #define internal_free   prefix(internal_free)
 326 void internal_free (void *);
 327
 328 #define allocate        prefix(allocate)
 329 void allocate (void **, GFC_INTEGER_4, GFC_INTEGER_4 *);
 330
 331 #define allocate64      prefix(allocate64)
 332 void allocate64 (void **, GFC_INTEGER_8, GFC_INTEGER_4 *);
 333
 334 #define deallocate      prefix(deallocate)
 335 void deallocate (void **, GFC_INTEGER_4 *);
 336
 337
 338 /* environ.c */
 339
 340 #define check_buffered prefix(check_buffered)
 341 int check_buffered (int);
 342
 343 #define init_variables prefix(init_variables)
 344 void init_variables (void);
 345
 346 #define show_variables prefix(show_variables)
 347 void show_variables (void);
 348
 349
 350 /* string.c */
 351
 352 #define find_option prefix(find_option)
 353 int find_option (const char *, int, st_option *, const char *);
 354
 355 #define fstrlen prefix(fstrlen)
 356 int fstrlen (const char *, int);
 357
 358 #define fstrcpy prefix(fstrcpy)
 359 void fstrcpy (char *, int, const char *, int);
 360
 361 #define cf_strcpy prefix(cf_strcpy)
 362 void cf_strcpy (char *, int, const char *);
 363
 364 /* io.c */
 365
 366 #define init_units prefix(init_units)
 367 void init_units (void);
 368
 369 #define close_units prefix(close_units)
 370 void close_units (void);
 371
 372 /* stop.c */
 373 #define stop_numeric prefix(stop_numeric)
 374 void stop_numeric (GFC_INTEGER_4);
 375
 376 /* reshape_packed.c */
 377 #define reshape_packed prefix(reshape_packed)
 378 void reshape_packed (char *, index_type, const char *, index_type,
 379                      const char *, index_type);
 380
 381 /* Repacking functions.  */
 382 #define internal_pack prefix(internal_pack)
 383 void *internal_pack (gfc_array_char *);
 384
 385 #define internal_unpack prefix(internal_unpack)
 386 void internal_unpack (gfc_array_char *, const void *);
 387
 388 #define internal_pack_4 prefix(internal_pack_4)
 389 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
 390
 391 #define internal_pack_8 prefix(internal_pack_8)
 392 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
 393
 394 #define internal_unpack_4 prefix(internal_unpack_4)
 395 void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
 396
 397 #define internal_unpack_8 prefix(internal_unpack_8)
 398 void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
 399
 400 /* date_and_time.c */
 401
 402 #define date_and_time prefix(date_and_time)
 403 void date_and_time (char *, char *, char *, gfc_array_i4 *,
 404                    GFC_INTEGER_4, GFC_INTEGER_4, GFC_INTEGER_4);
 405
 406 /* string_intrinsics.c */
 407
 408 #define compare_string prefix(compare_string)
 409 GFC_INTEGER_4 compare_string (GFC_INTEGER_4, const char *,
 410                               GFC_INTEGER_4, const char *);
 411
 412 /* random.c */
 413
 414 #define random_seed prefix(random_seed)
 415 void random_seed (GFC_INTEGER_4 * size, gfc_array_i4 * put,
 416                   gfc_array_i4 * get);
 417
 418 /* normalize.c */
 419
 420 #define normalize_r4_i4 prefix(normalize_r4_i4)
 421 GFC_REAL_4 normalize_r4_i4 (GFC_UINTEGER_4, GFC_UINTEGER_4);
 422
 423 #define normalize_r8_i8 prefix(normalize_r8_i8)
 424 GFC_REAL_8 normalize_r8_i8 (GFC_UINTEGER_8, GFC_UINTEGER_8);
 425
 426 /* size.c */
 427
 428 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
 429
 430 #define size0 prefix(size0)
 431 index_type size0 (const array_t * array);
 432
 433 #endif
 434