gcc/fortran/libgfortran.h

   1 /* Header file to the Fortran front-end and runtime library
   2    Copyright (C) 2007, 2008, 2009, 2010, 2011
   3    Free Software Foundation, Inc.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21
  22 /* Flags to specify which standard/extension contains a feature.
  23    Note that no features were obsoleted nor deleted in F2003.
  24    Please remember to keep those definitions in sync with
  25    gfortran.texi.  */
  26 #define GFC_STD_F2008_TR        (1<<9)  /* POST-F2008 technical reports.  */
  27 #define GFC_STD_F2008_OBS       (1<<8)  /* Obsolescent in F2008.  */
  28 #define GFC_STD_F2008           (1<<7)  /* New in F2008.  */
  29 #define GFC_STD_LEGACY          (1<<6)  /* Backward compatibility.  */
  30 #define GFC_STD_GNU             (1<<5)  /* GNU Fortran extension.  */
  31 #define GFC_STD_F2003           (1<<4)  /* New in F2003.  */
  32 #define GFC_STD_F95             (1<<3)  /* New in F95.  */
  33 #define GFC_STD_F95_DEL         (1<<2)  /* Deleted in F95.  */
  34 #define GFC_STD_F95_OBS         (1<<1)  /* Obsolescent in F95.  */
  35 #define GFC_STD_F77             (1<<0)  /* Included in F77, but not deleted or
  36                                            obsolescent in later standards.  */
  37
  38
  39 /* Bitmasks for the various FPE that can be enabled.  */
  40 #define GFC_FPE_INVALID    (1<<0)
  41 #define GFC_FPE_DENORMAL   (1<<1)
  42 #define GFC_FPE_ZERO       (1<<2)
  43 #define GFC_FPE_OVERFLOW   (1<<3)
  44 #define GFC_FPE_UNDERFLOW  (1<<4)
  45 #define GFC_FPE_INEXACT    (1<<5)
  46
  47
  48 /* Bitmasks for the various runtime checks that can be enabled.  */
  49 #define GFC_RTCHECK_BOUNDS      (1<<0)
  50 #define GFC_RTCHECK_ARRAY_TEMPS (1<<1)
  51 #define GFC_RTCHECK_RECURSION   (1<<2)
  52 #define GFC_RTCHECK_DO          (1<<3)
  53 #define GFC_RTCHECK_POINTER     (1<<4)
  54 #define GFC_RTCHECK_MEM         (1<<5)
  55 #define GFC_RTCHECK_ALL        (GFC_RTCHECK_BOUNDS | GFC_RTCHECK_ARRAY_TEMPS \
  56                                 | GFC_RTCHECK_RECURSION | GFC_RTCHECK_DO \
  57                                 | GFC_RTCHECK_POINTER | GFC_RTCHECK_MEM)
  58
  59
  60 /* Possible values for the CONVERT I/O specifier.  */
  61 typedef enum
  62 {
  63   GFC_CONVERT_NONE = -1,
  64   GFC_CONVERT_NATIVE = 0,
  65   GFC_CONVERT_SWAP,
  66   GFC_CONVERT_BIG,
  67   GFC_CONVERT_LITTLE
  68 }
  69 unit_convert;
  70
  71
  72 /* Runtime errors.  */
  73 typedef enum
  74 {
  75   LIBERROR_FIRST = -3,          /* Marker for the first error.  */
  76   LIBERROR_EOR = -2,            /* End of record, must be negative.  */
  77   LIBERROR_END = -1,            /* End of file, must be negative.  */
  78   LIBERROR_OK = 0,              /* Indicates success, must be zero.  */
  79   LIBERROR_OS = 5000,           /* OS error, more info in errno.  */
  80   LIBERROR_OPTION_CONFLICT,
  81   LIBERROR_BAD_OPTION,
  82   LIBERROR_MISSING_OPTION,
  83   LIBERROR_ALREADY_OPEN,
  84   LIBERROR_BAD_UNIT,
  85   LIBERROR_FORMAT,
  86   LIBERROR_BAD_ACTION,
  87   LIBERROR_ENDFILE,
  88   LIBERROR_BAD_US,
  89   LIBERROR_READ_VALUE,
  90   LIBERROR_READ_OVERFLOW,
  91   LIBERROR_INTERNAL,
  92   LIBERROR_INTERNAL_UNIT,
  93   LIBERROR_ALLOCATION,
  94   LIBERROR_DIRECT_EOR,
  95   LIBERROR_SHORT_RECORD,
  96   LIBERROR_CORRUPT_FILE,
  97   LIBERROR_INQUIRE_INTERNAL_UNIT, /* Must be different from STAT_STOPPED_IMAGE.  */
  98   LIBERROR_LAST                 /* Not a real error, the last error # + 1.  */
  99 }
 100 libgfortran_error_codes;
 101
 102 /* Must kept in sync with libgfortrancaf.h.  */
 103 typedef enum
 104 {
 105   GFC_STAT_UNLOCKED = 0,
 106   GFC_STAT_LOCKED,
 107   GFC_STAT_LOCKED_OTHER_IMAGE,
 108   GFC_STAT_STOPPED_IMAGE /* See LIBERROR_INQUIRE_INTERNAL_UNIT above. */
 109 }
 110 libgfortran_stat_codes;
 111
 112 /* Default unit number for preconnected standard input and output.  */
 113 #define GFC_STDIN_UNIT_NUMBER 5
 114 #define GFC_STDOUT_UNIT_NUMBER 6
 115 #define GFC_STDERR_UNIT_NUMBER 0
 116
 117
 118 /* FIXME: Increase to 15 for Fortran 2008. Also needs changes to
 119    GFC_DTYPE_RANK_MASK. See PR 36825.  */
 120 #define GFC_MAX_DIMENSIONS 7
 121
 122 #define GFC_DTYPE_RANK_MASK 0x07
 123 #define GFC_DTYPE_TYPE_SHIFT 3
 124 #define GFC_DTYPE_TYPE_MASK 0x38
 125 #define GFC_DTYPE_SIZE_SHIFT 6
 126
 127 /* Basic types.  BT_VOID is used by ISO C Binding so funcs like c_f_pointer
 128    can take any arg with the pointer attribute as a param.  These are also
 129    used in the run-time library for IO.  */
 130 typedef enum
 131 { BT_UNKNOWN = 0, BT_INTEGER, BT_LOGICAL, BT_REAL, BT_COMPLEX,
 132   BT_DERIVED, BT_CHARACTER, BT_CLASS, BT_PROCEDURE, BT_HOLLERITH, BT_VOID
 133 }
 134 bt;