gcc/fortran/misc.c

   1 /* Miscellaneous stuff that doesn't fit anywhere else.
   2    Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
   3    Free Software Foundation, Inc.
   4    Contributed by Andy Vaught
   5
   6 This file is part of GCC.
   7
   8 GCC is free software; you can redistribute it and/or modify it under
   9 the terms of the GNU General Public License as published by the Free
  10 Software Foundation; either version 3, or (at your option) any later
  11 version.
  12
  13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with GCC; see the file COPYING3.  If not see
  20 <http://www.gnu.org/licenses/>.  */
  21
  22 #include "config.h"
  23 #include "system.h"
  24 #include "gfortran.h"
  25
  26 /* Get a block of memory.  Many callers assume that the memory we
  27    return is zeroed.  */
  28
  29 void *
  30 gfc_getmem (size_t n)
  31 {
  32   void *p;
  33
  34   if (n == 0)
  35     return NULL;
  36
  37   p = xmalloc (n);
  38   if (p == NULL)
  39     gfc_fatal_error ("Out of memory-- malloc() failed");
  40   memset (p, 0, n);
  41   return p;
  42 }
  43
  44
  45 /* gfortran.h defines free to something that triggers a syntax error,
  46    but we need free() here.  */
  47
  48 #define temp free
  49 #undef free
  50
  51 void
  52 gfc_free (void *p)
  53 {
  54   if (p != NULL)
  55     free (p);
  56 }
  57
  58 #define free temp
  59 #undef temp
  60
  61
  62 /* Get terminal width.  */
  63
  64 int
  65 gfc_terminal_width (void)
  66 {
  67   return 80;
  68 }
  69
  70
  71 /* Initialize a typespec to unknown.  */
  72
  73 void
  74 gfc_clear_ts (gfc_typespec *ts)
  75 {
  76   ts->type = BT_UNKNOWN;
  77   ts->derived = NULL;
  78   ts->kind = 0;
  79   ts->cl = NULL;
  80   ts->interface = NULL;
  81   /* flag that says if the type is C interoperable */
  82   ts->is_c_interop = 0;
  83   /* says what f90 type the C kind interops with */
  84   ts->f90_type = BT_UNKNOWN;
  85   /* flag that says whether it's from iso_c_binding or not */
  86   ts->is_iso_c = 0;
  87 }
  88
  89
  90 /* Open a file for reading.  */
  91
  92 FILE *
  93 gfc_open_file (const char *name)
  94 {
  95   struct stat statbuf;
  96
  97   if (!*name)
  98     return stdin;
  99
 100   if (stat (name, &statbuf) < 0)
 101     return NULL;
 102
 103   if (!S_ISREG (statbuf.st_mode))
 104     return NULL;
 105
 106   return fopen (name, "r");
 107 }
 108
 109
 110 /* Return a string for each type.  */
 111
 112 const char *
 113 gfc_basic_typename (bt type)
 114 {
 115   const char *p;
 116
 117   switch (type)
 118     {
 119     case BT_INTEGER:
 120       p = "INTEGER";
 121       break;
 122     case BT_REAL:
 123       p = "REAL";
 124       break;
 125     case BT_COMPLEX:
 126       p = "COMPLEX";
 127       break;
 128     case BT_LOGICAL:
 129       p = "LOGICAL";
 130       break;
 131     case BT_CHARACTER:
 132       p = "CHARACTER";
 133       break;
 134     case BT_HOLLERITH:
 135       p = "HOLLERITH";
 136       break;
 137     case BT_DERIVED:
 138       p = "DERIVED";
 139       break;
 140     case BT_PROCEDURE:
 141       p = "PROCEDURE";
 142       break;
 143     case BT_VOID:
 144       p = "VOID";
 145       break;
 146     case BT_UNKNOWN:
 147       p = "UNKNOWN";
 148       break;
 149     default:
 150       gfc_internal_error ("gfc_basic_typename(): Undefined type");
 151     }
 152
 153   return p;
 154 }
 155
 156
 157 /* Return a string describing the type and kind of a typespec.  Because
 158    we return alternating buffers, this subroutine can appear twice in
 159    the argument list of a single statement.  */
 160
 161 const char *
 162 gfc_typename (gfc_typespec *ts)
 163 {
 164   static char buffer1[GFC_MAX_SYMBOL_LEN + 7];  /* 7 for "TYPE()" + '\0'.  */
 165   static char buffer2[GFC_MAX_SYMBOL_LEN + 7];
 166   static int flag = 0;
 167   char *buffer;
 168
 169   buffer = flag ? buffer1 : buffer2;
 170   flag = !flag;
 171
 172   switch (ts->type)
 173     {
 174     case BT_INTEGER:
 175       sprintf (buffer, "INTEGER(%d)", ts->kind);
 176       break;
 177     case BT_REAL:
 178       sprintf (buffer, "REAL(%d)", ts->kind);
 179       break;
 180     case BT_COMPLEX:
 181       sprintf (buffer, "COMPLEX(%d)", ts->kind);
 182       break;
 183     case BT_LOGICAL:
 184       sprintf (buffer, "LOGICAL(%d)", ts->kind);
 185       break;
 186     case BT_CHARACTER:
 187       sprintf (buffer, "CHARACTER(%d)", ts->kind);
 188       break;
 189     case BT_HOLLERITH:
 190       sprintf (buffer, "HOLLERITH");
 191       break;
 192     case BT_DERIVED:
 193       sprintf (buffer, "TYPE(%s)", ts->derived->name);
 194       break;
 195     case BT_PROCEDURE:
 196       strcpy (buffer, "PROCEDURE");
 197       break;
 198     case BT_UNKNOWN:
 199       strcpy (buffer, "UNKNOWN");
 200       break;
 201     default:
 202       gfc_internal_error ("gfc_typename(): Undefined type");
 203     }
 204
 205   return buffer;
 206 }
 207
 208
 209 /* Given an mstring array and a code, locate the code in the table,
 210    returning a pointer to the string.  */
 211
 212 const char *
 213 gfc_code2string (const mstring *m, int code)
 214 {
 215   while (m->string != NULL)
 216     {
 217       if (m->tag == code)
 218         return m->string;
 219       m++;
 220     }
 221
 222   gfc_internal_error ("gfc_code2string(): Bad code");
 223   /* Not reached */
 224 }
 225
 226
 227 /* Given an mstring array and a string, returns the value of the tag
 228    field.  Returns the final tag if no matches to the string are found.  */
 229
 230 int
 231 gfc_string2code (const mstring *m, const char *string)
 232 {
 233   for (; m->string != NULL; m++)
 234     if (strcmp (m->string, string) == 0)
 235       return m->tag;
 236
 237   return m->tag;
 238 }
 239
 240
 241 /* Convert an intent code to a string.  */
 242 /* TODO: move to gfortran.h as define.  */
 243
 244 const char *
 245 gfc_intent_string (sym_intent i)
 246 {
 247   return gfc_code2string (intents, i);
 248 }
 249
 250
 251 /***************** Initialization functions ****************/
 252
 253 /* Top level initialization.  */
 254
 255 void
 256 gfc_init_1 (void)
 257 {
 258   gfc_error_init_1 ();
 259   gfc_scanner_init_1 ();
 260   gfc_arith_init_1 ();
 261   gfc_intrinsic_init_1 ();
 262 }
 263
 264
 265 /* Per program unit initialization.  */
 266
 267 void
 268 gfc_init_2 (void)
 269 {
 270   gfc_symbol_init_2 ();
 271   gfc_module_init_2 ();
 272 }
 273
 274
 275 /******************* Destructor functions ******************/
 276
 277 /* Call all of the top level destructors.  */
 278
 279 void
 280 gfc_done_1 (void)
 281 {
 282   gfc_scanner_done_1 ();
 283   gfc_intrinsic_done_1 ();
 284   gfc_arith_done_1 ();
 285 }
 286
 287
 288 /* Per program unit destructors.  */
 289
 290 void
 291 gfc_done_2 (void)
 292 {
 293   gfc_symbol_done_2 ();
 294   gfc_module_done_2 ();
 295 }
 296
 297
 298 /* Returns the index into the table of C interoperable kinds where the
 299    kind with the given name (c_kind_name) was found.  */
 300
 301 int
 302 get_c_kind(const char *c_kind_name, CInteropKind_t kinds_table[])
 303 {
 304   int index = 0;
 305
 306   for (index = 0; index < ISOCBINDING_LAST; index++)
 307     if (strcmp (kinds_table[index].name, c_kind_name) == 0)
 308       return index;
 309
 310   return ISOCBINDING_INVALID;
 311 }