libgfortran/libgfortran.h

   1 /* Common declarations for all of libgfortran.
   2    Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 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 <stdio.h>
  35 #include <math.h>
  36 #include <stddef.h>
  37 #include <float.h>
  38 #include <stdarg.h>
  39
  40 #ifndef M_PI
  41 #define M_PI 3.14159265358979323846264338327
  42 #endif
  43
  44 #if HAVE_COMPLEX_H
  45 # include <complex.h>
  46 #else
  47 #define complex __complex__
  48 #endif
  49
  50 #include "config.h"
  51 #include "c99_protos.h"
  52
  53 #if HAVE_IEEEFP_H
  54 #include <ieeefp.h>
  55 #endif
  56
  57 #include "gstdint.h"
  58
  59 #if HAVE_SYS_TYPES_H
  60 #include <sys/types.h>
  61 #endif
  62 typedef off_t gfc_offset;
  63
  64 #ifndef NULL
  65 #define NULL (void *) 0
  66 #endif
  67
  68 #ifndef __GNUC__
  69 #define __attribute__(x)
  70 #endif
  71
  72
  73 /* On mingw, work around the buggy Windows snprintf() by using the one
  74    mingw provides, __mingw_snprintf().  We also provide a prototype for
  75    __mingw_snprintf(), because the mingw headers currently don't have one.  */
  76 #if HAVE_MINGW_SNPRINTF
  77 extern int __mingw_snprintf (char *, size_t, const char *, ...);
  78 #undef snprintf
  79 #define snprintf __mingw_snprintf
  80 #endif
  81
  82
  83 /* For a library, a standard prefix is a requirement in order to partition
  84    the namespace.  IPREFIX is for symbols intended to be internal to the
  85    library.  */
  86 #define PREFIX(x)       _gfortran_ ## x
  87 #define IPREFIX(x)      _gfortrani_ ## x
  88
  89 /* Magic to rename a symbol at the compiler level.  You continue to refer
  90    to the symbol as OLD in the source, but it'll be named NEW in the asm.  */
  91 #define sym_rename(old, new) sym_rename1(old, __USER_LABEL_PREFIX__, new)
  92 #define sym_rename1(old, ulp, new) sym_rename2(old, ulp, new)
  93 #define sym_rename2(old, ulp, new) extern __typeof(old) old __asm__(#ulp #new)
  94
  95 /* There are several classifications of routines:
  96
  97      (1) Symbols used only within the library,
  98      (2) Symbols to be exported from the library,
  99      (3) Symbols to be exported from the library, but
 100          also used inside the library.
 101
 102    By telling the compiler about these different classifications we can
 103    tightly control the interface seen by the user, and get better code
 104    from the compiler at the same time.
 105
 106    One of the following should be used immediately after the declaration
 107    of each symbol:
 108
 109      internal_proto     Marks a symbol used only within the library,
 110                         and adds IPREFIX to the assembly-level symbol
 111                         name.  The later is important for maintaining
 112                         the namespace partition for the static library.
 113
 114      export_proto       Marks a symbol to be exported, and adds PREFIX
 115                         to the assembly-level symbol name.
 116
 117      export_proto_np    Marks a symbol to be exported without adding PREFIX.
 118
 119      iexport_proto      Marks a function to be exported, but with the
 120                         understanding that it can be used inside as well.
 121
 122      iexport_data_proto Similarly, marks a data symbol to be exported.
 123                         Unfortunately, some systems can't play the hidden
 124                         symbol renaming trick on data symbols, thanks to
 125                         the horribleness of COPY relocations.
 126
 127    If iexport_proto or iexport_data_proto is used, you must also use
 128    iexport or iexport_data after the *definition* of the symbol.  */
 129
 130 #if defined(HAVE_ATTRIBUTE_VISIBILITY)
 131 # define internal_proto(x) \
 132         sym_rename(x, IPREFIX (x)) __attribute__((__visibility__("hidden")))
 133 #else
 134 # define internal_proto(x)      sym_rename(x, IPREFIX(x))
 135 #endif
 136
 137 #if defined(HAVE_ATTRIBUTE_VISIBILITY) && defined(HAVE_ATTRIBUTE_ALIAS)
 138 # define export_proto(x)        sym_rename(x, PREFIX(x))
 139 # define export_proto_np(x)     extern char swallow_semicolon
 140 # define iexport_proto(x)       internal_proto(x)
 141 # define iexport(x)             iexport1(x, IPREFIX(x))
 142 # define iexport1(x,y)          iexport2(x,y)
 143 # define iexport2(x,y) \
 144         extern __typeof(x) PREFIX(x) __attribute__((__alias__(#y)))
 145 /* ??? We're not currently building a dll, and it's wrong to add dllexport
 146    to objects going into a static library archive.  */
 147 #elif 0 && defined(HAVE_ATTRIBUTE_DLLEXPORT)
 148 # define export_proto_np(x)     extern __typeof(x) x __attribute__((dllexport))
 149 # define export_proto(x)    sym_rename(x, PREFIX(x)) __attribute__((dllexport))
 150 # define iexport_proto(x)       export_proto(x)
 151 # define iexport(x)             extern char swallow_semicolon
 152 #else
 153 # define export_proto(x)        sym_rename(x, PREFIX(x))
 154 # define export_proto_np(x)     extern char swallow_semicolon
 155 # define iexport_proto(x)       export_proto(x)
 156 # define iexport(x)             extern char swallow_semicolon
 157 #endif
 158
 159 /* TODO: detect the case when we *can* hide the symbol.  */
 160 #define iexport_data_proto(x)   export_proto(x)
 161 #define iexport_data(x)         extern char swallow_semicolon
 162
 163 /* The only reliable way to get the offset of a field in a struct
 164    in a system independent way is via this macro.  */
 165 #ifndef offsetof
 166 #define offsetof(TYPE, MEMBER)  ((size_t) &((TYPE *) 0)->MEMBER)
 167 #endif
 168
 169 /* The isfinite macro is only available with C99, but some non-C99
 170    systems still provide fpclassify, and there is a `finite' function
 171    in BSD.
 172
 173    Also, isfinite is broken on Cygwin.
 174
 175    When isfinite is not available, try to use one of the
 176    alternatives, or bail out.  */
 177
 178 #if defined(HAVE_BROKEN_ISFINITE) || defined(__CYGWIN__)
 179 #undef isfinite
 180 #endif
 181
 182 #if defined(HAVE_BROKEN_ISNAN)
 183 #undef isnan
 184 #endif
 185
 186 #if defined(HAVE_BROKEN_FPCLASSIFY)
 187 #undef fpclassify
 188 #endif
 189
 190 #if !defined(isfinite)
 191 #if !defined(fpclassify)
 192 #define isfinite(x) ((x) - (x) == 0)
 193 #else
 194 #define isfinite(x) (fpclassify(x) != FP_NAN && fpclassify(x) != FP_INFINITE)
 195 #endif /* !defined(fpclassify) */
 196 #endif /* !defined(isfinite)  */
 197
 198 #if !defined(isnan)
 199 #if !defined(fpclassify)
 200 #define isnan(x) ((x) != (x))
 201 #else
 202 #define isnan(x) (fpclassify(x) == FP_NAN)
 203 #endif /* !defined(fpclassify) */
 204 #endif /* !defined(isfinite)  */
 205
 206 /* TODO: find the C99 version of these an move into above ifdef.  */
 207 #define REALPART(z) (__real__(z))
 208 #define IMAGPART(z) (__imag__(z))
 209 #define COMPLEX_ASSIGN(z_, r_, i_) {__real__(z_) = (r_); __imag__(z_) = (i_);}
 210
 211 #include "kinds.h"
 212
 213 /* Define the type used for the current record number for large file I/O.
 214    The size must be consistent with the size defined on the compiler side.  */
 215 #ifdef HAVE_GFC_INTEGER_8
 216 typedef GFC_INTEGER_8 GFC_IO_INT;
 217 #else
 218 #ifdef HAVE_GFC_INTEGER_4
 219 typedef GFC_INTEGER_4 GFC_IO_INT;
 220 #else
 221 #error "GFC_INTEGER_4 should be available for the library to compile".
 222 #endif
 223 #endif
 224
 225 /* The following two definitions must be consistent with the types used
 226    by the compiler.  */
 227 /* The type used of array indices, amongst other things.  */
 228 typedef ssize_t index_type;
 229 /* The type used for the lengths of character variables.  */
 230 typedef GFC_INTEGER_4 gfc_charlen_type;
 231
 232 /* This will be 0 on little-endian machines and one on big-endian machines.  */
 233 extern int l8_to_l4_offset;
 234 internal_proto(l8_to_l4_offset);
 235
 236 #define GFOR_POINTER_TO_L1(p, kind) \
 237   (l8_to_l4_offset * (kind - 1) + (GFC_LOGICAL_1 *)(p))
 238
 239 #define GFC_INTEGER_1_HUGE \
 240   (GFC_INTEGER_1)((((GFC_UINTEGER_1)1) << 7) - 1)
 241 #define GFC_INTEGER_2_HUGE \
 242   (GFC_INTEGER_2)((((GFC_UINTEGER_2)1) << 15) - 1)
 243 #define GFC_INTEGER_4_HUGE \
 244   (GFC_INTEGER_4)((((GFC_UINTEGER_4)1) << 31) - 1)
 245 #define GFC_INTEGER_8_HUGE \
 246   (GFC_INTEGER_8)((((GFC_UINTEGER_8)1) << 63) - 1)
 247 #ifdef HAVE_GFC_INTEGER_16
 248 #define GFC_INTEGER_16_HUGE \
 249   (GFC_INTEGER_16)((((GFC_UINTEGER_16)1) << 127) - 1)
 250 #endif
 251
 252 #define GFC_REAL_4_HUGE FLT_MAX
 253 #define GFC_REAL_8_HUGE DBL_MAX
 254 #ifdef HAVE_GFC_REAL_10
 255 #define GFC_REAL_10_HUGE LDBL_MAX
 256 #endif
 257 #ifdef HAVE_GFC_REAL_16
 258 #define GFC_REAL_16_HUGE LDBL_MAX
 259 #endif
 260
 261 #define GFC_REAL_4_DIGITS FLT_MANT_DIG
 262 #define GFC_REAL_8_DIGITS DBL_MANT_DIG
 263 #ifdef HAVE_GFC_REAL_10
 264 #define GFC_REAL_10_DIGITS LDBL_MANT_DIG
 265 #endif
 266 #ifdef HAVE_GFC_REAL_16
 267 #define GFC_REAL_16_DIGITS LDBL_MANT_DIG
 268 #endif
 269
 270 #define GFC_REAL_4_RADIX FLT_RADIX
 271 #define GFC_REAL_8_RADIX FLT_RADIX
 272 #ifdef HAVE_GFC_REAL_10
 273 #define GFC_REAL_10_RADIX FLT_RADIX
 274 #endif
 275 #ifdef HAVE_GFC_REAL_16
 276 #define GFC_REAL_16_RADIX FLT_RADIX
 277 #endif
 278
 279 #ifndef GFC_MAX_DIMENSIONS
 280 #define GFC_MAX_DIMENSIONS 7
 281 #endif
 282
 283 typedef struct descriptor_dimension
 284 {
 285   index_type stride;
 286   index_type lbound;
 287   index_type ubound;
 288 }
 289 descriptor_dimension;
 290
 291 #define GFC_ARRAY_DESCRIPTOR(r, type) \
 292 struct {\
 293   type *data;\
 294   size_t offset;\
 295   index_type dtype;\
 296   descriptor_dimension dim[r];\
 297 }
 298
 299 /* Commonly used array descriptor types.  */
 300 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) gfc_array_void;
 301 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, char) gfc_array_char;
 302 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_1) gfc_array_i1;
 303 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_2) gfc_array_i2;
 304 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_4) gfc_array_i4;
 305 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_8) gfc_array_i8;
 306 #ifdef HAVE_GFC_INTEGER_16
 307 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_INTEGER_16) gfc_array_i16;
 308 #endif
 309 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_4) gfc_array_r4;
 310 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_8) gfc_array_r8;
 311 #ifdef HAVE_GFC_REAL_10
 312 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_10) gfc_array_r10;
 313 #endif
 314 #ifdef HAVE_GFC_REAL_16
 315 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_REAL_16) gfc_array_r16;
 316 #endif
 317 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_4) gfc_array_c4;
 318 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_8) gfc_array_c8;
 319 #ifdef HAVE_GFC_COMPLEX_10
 320 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_10) gfc_array_c10;
 321 #endif
 322 #ifdef HAVE_GFC_COMPLEX_16
 323 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_COMPLEX_16) gfc_array_c16;
 324 #endif
 325 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_1) gfc_array_l1;
 326 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_2) gfc_array_l2;
 327 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_4) gfc_array_l4;
 328 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_8) gfc_array_l8;
 329 #ifdef HAVE_GFC_LOGICAL_16
 330 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, GFC_LOGICAL_16) gfc_array_l16;
 331 #endif
 332
 333 #define GFC_DTYPE_RANK_MASK 0x07
 334 #define GFC_DTYPE_TYPE_SHIFT 3
 335 #define GFC_DTYPE_TYPE_MASK 0x38
 336 #define GFC_DTYPE_SIZE_SHIFT 6
 337
 338 /* added for f03.  --Rickett, 02.28.06 */
 339 #define GFC_NUM_RANK_BITS 3
 340
 341 enum
 342 {
 343   GFC_DTYPE_UNKNOWN = 0,
 344   GFC_DTYPE_INTEGER,
 345   /* TODO: recognize logical types.  */
 346   GFC_DTYPE_LOGICAL,
 347   GFC_DTYPE_REAL,
 348   GFC_DTYPE_COMPLEX,
 349   GFC_DTYPE_DERIVED,
 350   GFC_DTYPE_CHARACTER
 351 };
 352
 353 #define GFC_DESCRIPTOR_RANK(desc) ((desc)->dtype & GFC_DTYPE_RANK_MASK)
 354 #define GFC_DESCRIPTOR_TYPE(desc) (((desc)->dtype & GFC_DTYPE_TYPE_MASK) \
 355                                    >> GFC_DTYPE_TYPE_SHIFT)
 356 #define GFC_DESCRIPTOR_SIZE(desc) ((desc)->dtype >> GFC_DTYPE_SIZE_SHIFT)
 357 #define GFC_DESCRIPTOR_DATA(desc) ((desc)->data)
 358 #define GFC_DESCRIPTOR_DTYPE(desc) ((desc)->dtype)
 359
 360 /* Runtime library include.  */
 361 #define stringize(x) expand_macro(x)
 362 #define expand_macro(x) # x
 363
 364 /* Runtime options structure.  */
 365
 366 typedef struct
 367 {
 368   int stdin_unit, stdout_unit, stderr_unit, optional_plus;
 369   int allocate_init_flag, allocate_init_value;
 370   int locus;
 371
 372   int separator_len;
 373   const char *separator;
 374
 375   int mem_check;
 376   int use_stderr, all_unbuffered, default_recl;
 377
 378   int fpu_round, fpu_precision, fpe;
 379
 380   int sighup, sigint;
 381   int dump_core, backtrace;
 382 }
 383 options_t;
 384
 385 extern options_t options;
 386 internal_proto(options);
 387
 388 extern void handler (int);
 389 internal_proto(handler);
 390
 391
 392 /* Compile-time options that will influence the library.  */
 393
 394 typedef struct
 395 {
 396   int warn_std;
 397   int allow_std;
 398   int pedantic;
 399   int convert;
 400   int dump_core;
 401   int backtrace;
 402   int sign_zero;
 403   size_t record_marker;
 404   int max_subrecord_length;
 405   int bounds_check;
 406 }
 407 compile_options_t;
 408
 409 extern compile_options_t compile_options;
 410 internal_proto(compile_options);
 411
 412 extern void init_compile_options (void);
 413 internal_proto(init_compile_options);
 414
 415 #define GFC_MAX_SUBRECORD_LENGTH 2147483639   /* 2**31 - 9 */
 416
 417 /* Structure for statement options.  */
 418
 419 typedef struct
 420 {
 421   const char *name;
 422   int value;
 423 }
 424 st_option;
 425
 426 /* Runtime errors.  The EOR and EOF errors are required to be negative.
 427    These codes must be kept sychronized with their equivalents in
 428    gcc/fortran/gfortran.h .  */
 429
 430 typedef enum
 431 {
 432   ERROR_FIRST = -3,             /* Marker for the first error.  */
 433   ERROR_EOR = -2,
 434   ERROR_END = -1,
 435   ERROR_OK = 0,                 /* Indicates success, must be zero.  */
 436   ERROR_OS = 5000,              /* Operating system error, more info in errno.  */
 437   ERROR_OPTION_CONFLICT,
 438   ERROR_BAD_OPTION,
 439   ERROR_MISSING_OPTION,
 440   ERROR_ALREADY_OPEN,
 441   ERROR_BAD_UNIT,
 442   ERROR_FORMAT,
 443   ERROR_BAD_ACTION,
 444   ERROR_ENDFILE,
 445   ERROR_BAD_US,
 446   ERROR_READ_VALUE,
 447   ERROR_READ_OVERFLOW,
 448   ERROR_INTERNAL,
 449   ERROR_INTERNAL_UNIT,
 450   ERROR_ALLOCATION,             /* Keep in sync with value used in
 451                                    gcc/fortran/trans.c
 452                                    (gfc_allocate_array_with_status).  */
 453   ERROR_DIRECT_EOR,
 454   ERROR_SHORT_RECORD,
 455   ERROR_CORRUPT_FILE,
 456   ERROR_LAST                    /* Not a real error, the last error # + 1.  */
 457 }
 458 error_codes;
 459
 460
 461 /* Flags to specify which standard/extension contains a feature.
 462    Keep them in sync with their counterparts in gcc/fortran/gfortran.h.  */
 463 #define GFC_STD_LEGACY          (1<<6) /* Backward compatibility.  */
 464 #define GFC_STD_GNU             (1<<5)    /* GNU Fortran extension.  */
 465 #define GFC_STD_F2003           (1<<4)    /* New in F2003.  */
 466 /* Note that no features were obsoleted nor deleted in F2003.  */
 467 #define GFC_STD_F95             (1<<3)    /* New in F95.  */
 468 #define GFC_STD_F95_DEL         (1<<2)    /* Deleted in F95.  */
 469 #define GFC_STD_F95_OBS         (1<<1)    /* Obsoleted in F95.  */
 470 #define GFC_STD_F77             (1<<0)    /* Up to and including F77.  */
 471
 472 /* Bitmasks for the various FPE that can be enabled.
 473    Keep them in sync with their counterparts in gcc/fortran/gfortran.h.  */
 474 #define GFC_FPE_INVALID    (1<<0)
 475 #define GFC_FPE_DENORMAL   (1<<1)
 476 #define GFC_FPE_ZERO       (1<<2)
 477 #define GFC_FPE_OVERFLOW   (1<<3)
 478 #define GFC_FPE_UNDERFLOW  (1<<4)
 479 #define GFC_FPE_PRECISION  (1<<5)
 480
 481 /* This is returned by notification_std to know if, given the flags
 482    that were given (-std=, -pedantic) we should issue an error, a warning
 483    or nothing.  */
 484 typedef enum
 485 { SILENT, WARNING, ERROR }
 486 notification;
 487
 488 /* This is returned by notify_std and several io functions.  */
 489 typedef enum
 490 { SUCCESS = 1, FAILURE }
 491 try;
 492
 493 /* The filename and line number don't go inside the globals structure.
 494    They are set by the rest of the program and must be linked to.  */
 495
 496 /* Location of the current library call (optional).  */
 497 extern unsigned line;
 498 iexport_data_proto(line);
 499
 500 extern char *filename;
 501 iexport_data_proto(filename);
 502
 503 /* Avoid conflicting prototypes of alloca() in system headers by using
 504    GCC's builtin alloca().  */
 505 #define gfc_alloca(x)  __builtin_alloca(x)
 506
 507
 508 /* Various I/O stuff also used in other parts of the library.  */
 509
 510 #define DEFAULT_TEMPDIR "/tmp"
 511
 512 /* The default value of record length for preconnected units is defined
 513    here. This value can be overriden by an environment variable.
 514    Default value is 1 Gb.  */
 515 #define DEFAULT_RECL 1073741824
 516
 517 typedef enum
 518 { CONVERT_NONE=-1, CONVERT_NATIVE, CONVERT_SWAP, CONVERT_BIG, CONVERT_LITTLE }
 519 unit_convert;
 520
 521 #define CHARACTER2(name) \
 522               gfc_charlen_type name ## _len; \
 523               char * name
 524
 525 typedef struct st_parameter_common
 526 {
 527   GFC_INTEGER_4 flags;
 528   GFC_INTEGER_4 unit;
 529   const char *filename;
 530   GFC_INTEGER_4 line;
 531   CHARACTER2 (iomsg);
 532   GFC_INTEGER_4 *iostat;
 533 }
 534 st_parameter_common;
 535
 536 #undef CHARACTER2
 537
 538 #define IOPARM_LIBRETURN_MASK           (3 << 0)
 539 #define IOPARM_LIBRETURN_OK             (0 << 0)
 540 #define IOPARM_LIBRETURN_ERROR          (1 << 0)
 541 #define IOPARM_LIBRETURN_END            (2 << 0)
 542 #define IOPARM_LIBRETURN_EOR            (3 << 0)
 543 #define IOPARM_ERR                      (1 << 2)
 544 #define IOPARM_END                      (1 << 3)
 545 #define IOPARM_EOR                      (1 << 4)
 546 #define IOPARM_HAS_IOSTAT               (1 << 5)
 547 #define IOPARM_HAS_IOMSG                (1 << 6)
 548
 549 #define IOPARM_COMMON_MASK              ((1 << 7) - 1)
 550
 551 #define IOPARM_OPEN_HAS_RECL_IN         (1 << 7)
 552 #define IOPARM_OPEN_HAS_FILE            (1 << 8)
 553 #define IOPARM_OPEN_HAS_STATUS          (1 << 9)
 554 #define IOPARM_OPEN_HAS_ACCESS          (1 << 10)
 555 #define IOPARM_OPEN_HAS_FORM            (1 << 11)
 556 #define IOPARM_OPEN_HAS_BLANK           (1 << 12)
 557 #define IOPARM_OPEN_HAS_POSITION        (1 << 13)
 558 #define IOPARM_OPEN_HAS_ACTION          (1 << 14)
 559 #define IOPARM_OPEN_HAS_DELIM           (1 << 15)
 560 #define IOPARM_OPEN_HAS_PAD             (1 << 16)
 561 #define IOPARM_OPEN_HAS_CONVERT         (1 << 17)
 562
 563 /* library start function and end macro.  These can be expanded if needed
 564    in the future.  cmp is st_parameter_common *cmp  */
 565
 566 extern void library_start (st_parameter_common *);
 567 internal_proto(library_start);
 568
 569 #define library_end()
 570
 571 /* main.c */
 572
 573 extern void stupid_function_name_for_static_linking (void);
 574 internal_proto(stupid_function_name_for_static_linking);
 575
 576 extern void set_args (int, char **);
 577 export_proto(set_args);
 578
 579 extern void get_args (int *, char ***);
 580 internal_proto(get_args);
 581
 582 extern void store_exe_path (const char *);
 583 export_proto(store_exe_path);
 584
 585 extern char * full_exe_path (void);
 586 internal_proto(full_exe_path);
 587
 588 /* backtrace.c */
 589
 590 extern void show_backtrace (void);
 591 internal_proto(show_backtrace);
 592
 593 /* error.c */
 594
 595 #define GFC_ITOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 2)
 596 #define GFC_XTOA_BUF_SIZE (sizeof (GFC_UINTEGER_LARGEST) * 2 + 1)
 597 #define GFC_OTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 3 + 1)
 598 #define GFC_BTOA_BUF_SIZE (sizeof (GFC_INTEGER_LARGEST) * 8 + 1)
 599
 600 extern void sys_exit (int) __attribute__ ((noreturn));
 601 internal_proto(sys_exit);
 602
 603 extern const char *gfc_itoa (GFC_INTEGER_LARGEST, char *, size_t);
 604 internal_proto(gfc_itoa);
 605
 606 extern const char *xtoa (GFC_UINTEGER_LARGEST, char *, size_t);
 607 internal_proto(xtoa);
 608
 609 extern void os_error (const char *) __attribute__ ((noreturn));
 610 iexport_proto(os_error);
 611
 612 extern void show_locus (st_parameter_common *);
 613 internal_proto(show_locus);
 614
 615 extern void runtime_error (const char *, ...)
 616      __attribute__ ((noreturn, format (printf, 1, 2)));
 617 iexport_proto(runtime_error);
 618
 619 extern void runtime_error_at (const char *, const char *, ...)
 620      __attribute__ ((noreturn, format (printf, 2, 3)));
 621 iexport_proto(runtime_error_at);
 622
 623 extern void internal_error (st_parameter_common *, const char *)
 624   __attribute__ ((noreturn));
 625 internal_proto(internal_error);
 626
 627 extern const char *get_oserror (void);
 628 internal_proto(get_oserror);
 629
 630 extern const char *translate_error (int);
 631 internal_proto(translate_error);
 632
 633 extern void generate_error (st_parameter_common *, int, const char *);
 634 iexport_proto(generate_error);
 635
 636 extern try notify_std (st_parameter_common *, int, const char *);
 637 internal_proto(notify_std);
 638
 639 extern notification notification_std(int);
 640 internal_proto(notification_std);
 641
 642 /* fpu.c */
 643
 644 extern void set_fpu (void);
 645 internal_proto(set_fpu);
 646
 647 /* memory.c */
 648
 649 extern void *get_mem (size_t) __attribute__ ((malloc));
 650 internal_proto(get_mem);
 651
 652 extern void free_mem (void *);
 653 internal_proto(free_mem);
 654
 655 extern void *internal_malloc_size (size_t) __attribute__ ((malloc));
 656 internal_proto(internal_malloc_size);
 657
 658 /* environ.c */
 659
 660 extern int check_buffered (int);
 661 internal_proto(check_buffered);
 662
 663 extern void init_variables (void);
 664 internal_proto(init_variables);
 665
 666 extern void show_variables (void);
 667 internal_proto(show_variables);
 668
 669 unit_convert get_unformatted_convert (int);
 670 internal_proto(get_unformatted_convert);
 671
 672 /* string.c */
 673
 674 extern int find_option (st_parameter_common *, const char *, gfc_charlen_type,
 675                         const st_option *, const char *);
 676 internal_proto(find_option);
 677
 678 extern gfc_charlen_type fstrlen (const char *, gfc_charlen_type);
 679 internal_proto(fstrlen);
 680
 681 extern gfc_charlen_type fstrcpy (char *, gfc_charlen_type, const char *, gfc_charlen_type);
 682 internal_proto(fstrcpy);
 683
 684 extern gfc_charlen_type cf_strcpy (char *, gfc_charlen_type, const char *);
 685 internal_proto(cf_strcpy);
 686
 687 /* io/intrinsics.c */
 688
 689 extern void flush_all_units (void);
 690 internal_proto(flush_all_units);
 691
 692 /* io.c */
 693
 694 extern void init_units (void);
 695 internal_proto(init_units);
 696
 697 extern void close_units (void);
 698 internal_proto(close_units);
 699
 700 extern int unit_to_fd (int);
 701 internal_proto(unit_to_fd);
 702
 703 extern int st_printf (const char *, ...)
 704   __attribute__ ((format (printf, 1, 2)));
 705 internal_proto(st_printf);
 706
 707 extern int st_vprintf (const char *, va_list);
 708 internal_proto(st_vprintf);
 709
 710 extern char * filename_from_unit (int);
 711 internal_proto(filename_from_unit);
 712
 713 /* stop.c */
 714
 715 extern void stop_numeric (GFC_INTEGER_4) __attribute__ ((noreturn));
 716 iexport_proto(stop_numeric);
 717
 718 /* reshape_packed.c */
 719
 720 extern void reshape_packed (char *, index_type, const char *, index_type,
 721                             const char *, index_type);
 722 internal_proto(reshape_packed);
 723
 724 /* Repacking functions.  */
 725
 726 /* ??? These aren't currently used by the compiler, though we
 727    certainly could do so.  */
 728 GFC_INTEGER_4 *internal_pack_4 (gfc_array_i4 *);
 729 internal_proto(internal_pack_4);
 730
 731 GFC_INTEGER_8 *internal_pack_8 (gfc_array_i8 *);
 732 internal_proto(internal_pack_8);
 733
 734 #if defined HAVE_GFC_INTEGER_16
 735 GFC_INTEGER_16 *internal_pack_16 (gfc_array_i16 *);
 736 internal_proto(internal_pack_16);
 737 #endif
 738
 739 GFC_COMPLEX_4 *internal_pack_c4 (gfc_array_c4 *);
 740 internal_proto(internal_pack_c4);
 741
 742 GFC_COMPLEX_8 *internal_pack_c8 (gfc_array_c8 *);
 743 internal_proto(internal_pack_c8);
 744
 745 #if defined HAVE_GFC_COMPLEX_10
 746 GFC_COMPLEX_10 *internal_pack_c10 (gfc_array_c10 *);
 747 internal_proto(internal_pack_c10);
 748 #endif
 749
 750 extern void internal_unpack_4 (gfc_array_i4 *, const GFC_INTEGER_4 *);
 751 internal_proto(internal_unpack_4);
 752
 753 extern void internal_unpack_8 (gfc_array_i8 *, const GFC_INTEGER_8 *);
 754 internal_proto(internal_unpack_8);
 755
 756 #if defined HAVE_GFC_INTEGER_16
 757 extern void internal_unpack_16 (gfc_array_i16 *, const GFC_INTEGER_16 *);
 758 internal_proto(internal_unpack_16);
 759 #endif
 760
 761 extern void internal_unpack_c4 (gfc_array_c4 *, const GFC_COMPLEX_4 *);
 762 internal_proto(internal_unpack_c4);
 763
 764 extern void internal_unpack_c8 (gfc_array_c8 *, const GFC_COMPLEX_8 *);
 765 internal_proto(internal_unpack_c8);
 766
 767 #if defined HAVE_GFC_COMPLEX_10
 768 extern void internal_unpack_c10 (gfc_array_c10 *, const GFC_COMPLEX_10 *);
 769 internal_proto(internal_unpack_c10);
 770 #endif
 771
 772 #if defined HAVE_GFC_COMPLEX_16
 773 extern void internal_unpack_c16 (gfc_array_c16 *, const GFC_COMPLEX_16 *);
 774 internal_proto(internal_unpack_c16);
 775 #endif
 776
 777 /* string_intrinsics.c */
 778
 779 extern int compare_string (GFC_INTEGER_4, const char *,
 780                            GFC_INTEGER_4, const char *);
 781 iexport_proto(compare_string);
 782
 783 /* random.c */
 784
 785 extern void random_seed_i4 (GFC_INTEGER_4 * size, gfc_array_i4 * put,
 786                             gfc_array_i4 * get);
 787 iexport_proto(random_seed_i4);
 788 extern void random_seed_i8 (GFC_INTEGER_8 * size, gfc_array_i8 * put,
 789                             gfc_array_i8 * get);
 790 iexport_proto(random_seed_i8);
 791
 792 /* size.c */
 793
 794 typedef GFC_ARRAY_DESCRIPTOR (GFC_MAX_DIMENSIONS, void) array_t;
 795
 796 extern index_type size0 (const array_t * array);
 797 iexport_proto(size0);
 798
 799 #endif  /* LIBGFOR_H  */