libguile/_scm.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM__SCM_H
   4 #define SCM__SCM_H
   5
   6 /* Copyright (C) 1995,1996,2000,2001, 2002, 2006, 2008, 2009, 2010 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * 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 this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 /**********************************************************************
  27  This file is Guile's central private header.
  28
  29  When included by other files, this file should preceed any include
  30  other than __scm.h.  See __scm.h for details regarding the purpose of
  31  and differences between _scm.h and __scm.h.
  32  **********************************************************************/
  33
  34 #if defined(__ia64) && !defined(__ia64__)
  35 # define __ia64__
  36 #endif
  37
  38 #if HAVE_CONFIG_H
  39 #  include <config.h>
  40 #endif
  41
  42 /* The size of `scm_t_bits'.  */
  43 #define SIZEOF_SCM_T_BITS SIZEOF_VOID_P
  44
  45 /* Undefine HAVE_STRUCT_TIMESPEC, because the libguile C code doesn't
  46    need it anymore, and because on MinGW:
  47
  48    - the definition of struct timespec is provided (if at all) by
  49      pthread.h
  50
  51    - pthread.h will _not_ define struct timespec if
  52      HAVE_STRUCT_TIMESPEC is 1, because then it thinks that it doesn't
  53      need to.
  54
  55    The libguile C code doesn't need HAVE_STRUCT_TIMESPEC anymore,
  56    because the value of HAVE_STRUCT_TIMESPEC has already been
  57    incorporated in how scm_t_timespec is defined (in scmconfig.h), and
  58    the rest of the libguile C code now just uses scm_t_timespec.
  59  */
  60 #ifdef HAVE_STRUCT_TIMESPEC
  61 #undef HAVE_STRUCT_TIMESPEC
  62 #endif
  63
  64 #include <errno.h>
  65 #include <verify.h>
  66 #include <alignof.h>
  67 #include "libguile/__scm.h"
  68
  69 /* Include headers for those files central to the implementation.  The
  70    rest should be explicitly #included in the C files themselves.  */
  71 #include "libguile/error.h"     /* Everyone signals errors.  */
  72 #include "libguile/print.h"     /* Everyone needs to print.  */
  73 #include "libguile/pairs.h"     /* Everyone conses.  */
  74 #include "libguile/list.h"      /* Everyone makes lists.  */
  75 #include "libguile/gc.h"        /* Everyone allocates.  */
  76 #include "libguile/gsubr.h"     /* Everyone defines global functions.  */
  77 #include "libguile/procs.h"     /* Same.  */
  78 #include "libguile/numbers.h"   /* Everyone deals with fixnums.  */
  79 #include "libguile/symbols.h"   /* For length, chars, values, miscellany.  */
  80 #include "libguile/boolean.h"   /* Everyone wonders about the truth.  */
  81 #include "libguile/threads.h"   /* You are not alone. */
  82 #include "libguile/snarf.h"     /* Everyone snarfs. */
  83 #include "libguile/foreign.h"   /* Snarfing needs the foreign data structures. */
  84 #include "libguile/programs.h"  /* ... and program.h. */
  85 #include "libguile/variable.h"
  86 #include "libguile/modules.h"
  87 #include "libguile/inline.h"
  88 #include "libguile/strings.h"
  89
  90 #ifndef SCM_SYSCALL
  91 #ifdef vms
  92 # ifndef __GNUC__
  93 #  include <ssdef.h>
  94 #  define SCM_SYSCALL(line) do{errno = 0;line;} \
  95         while(EVMSERR==errno && (vaxc$errno>>3)==(SS$_CONTROLC>>3))
  96 # endif /* ndef __GNUC__ */
  97 #endif /* def vms */
  98 #endif /* ndef SCM_SYSCALL  */
  99
 100 #ifndef SCM_SYSCALL
 101 # ifdef EINTR
 102 #  if (EINTR > 0)
 103 #   define SCM_SYSCALL(line) do{errno = 0;line;}while(EINTR==errno)
 104 #  endif /*  (EINTR > 0) */
 105 # endif /* def EINTR */
 106 #endif /* ndef SCM_SYSCALL */
 107
 108 #ifndef SCM_SYSCALL
 109 # define SCM_SYSCALL(line) line;
 110 #endif /* ndef SCM_SYSCALL */
 111
 112 \f
 113
 114 #ifndef min
 115 #define min(A, B) ((A) <= (B) ? (A) : (B))
 116 #endif
 117 #ifndef max
 118 #define max(A, B) ((A) >= (B) ? (A) : (B))
 119 #endif
 120
 121
 122
 123 #if GUILE_USE_64_CALLS && HAVE_STAT64
 124 #define CHOOSE_LARGEFILE(foo,foo64)     foo64
 125 #else
 126 #define CHOOSE_LARGEFILE(foo,foo64)     foo
 127 #endif
 128
 129 /* These names are a bit long, but they make it clear what they represent. */
 130 #if SCM_HAVE_STRUCT_DIRENT64 == 1
 131 # define dirent_or_dirent64             CHOOSE_LARGEFILE(dirent,dirent64)
 132 #else
 133 # define dirent_or_dirent64             dirent
 134 #endif
 135 #define fstat_or_fstat64                CHOOSE_LARGEFILE(fstat,fstat64)
 136 #define ftruncate_or_ftruncate64        CHOOSE_LARGEFILE(ftruncate,ftruncate64)
 137 #define lseek_or_lseek64                CHOOSE_LARGEFILE(lseek,lseek64)
 138 #define lstat_or_lstat64                CHOOSE_LARGEFILE(lstat,lstat64)
 139 #define off_t_or_off64_t                CHOOSE_LARGEFILE(off_t,off64_t)
 140 #define open_or_open64                  CHOOSE_LARGEFILE(open,open64)
 141 #define readdir_or_readdir64            CHOOSE_LARGEFILE(readdir,readdir64)
 142 #if SCM_HAVE_READDIR64_R == 1
 143 # define readdir_r_or_readdir64_r       CHOOSE_LARGEFILE(readdir_r,readdir64_r)
 144 #else
 145 # define readdir_r_or_readdir64_r       readdir_r
 146 #endif
 147 #define stat_or_stat64                  CHOOSE_LARGEFILE(stat,stat64)
 148 #define truncate_or_truncate64          CHOOSE_LARGEFILE(truncate,truncate64)
 149 #define scm_from_off_t_or_off64_t       CHOOSE_LARGEFILE(scm_from_off_t,scm_from_int64)
 150 #define scm_from_ino_t_or_ino64_t       CHOOSE_LARGEFILE(scm_from_ulong,scm_from_uint64)
 151 #define scm_from_blkcnt_t_or_blkcnt64_t CHOOSE_LARGEFILE(scm_from_ulong,scm_from_uint64)
 152 #define scm_to_off_t_or_off64_t         CHOOSE_LARGEFILE(scm_to_off_t,scm_to_int64)
 153
 154 #if SIZEOF_OFF_T == 4
 155 #  define scm_to_off_t    scm_to_int32
 156 #  define scm_from_off_t  scm_from_int32
 157 #elif SIZEOF_OFF_T == 8
 158 #  define scm_to_off_t    scm_to_int64
 159 #  define scm_from_off_t  scm_from_int64
 160 #else
 161 #  error sizeof(off_t) is not 4 or 8.
 162 #endif
 163 #define scm_to_off64_t    scm_to_int64
 164 #define scm_from_off64_t  scm_from_int64
 165
 166
 167 /* The endianness marker in objcode.  */
 168 #ifdef WORDS_BIGENDIAN
 169 # define SCM_OBJCODE_ENDIANNESS "BE"
 170 #else
 171 # define SCM_OBJCODE_ENDIANNESS "LE"
 172 #endif
 173
 174 #define _SCM_CPP_STRINGIFY(x)  # x
 175 #define SCM_CPP_STRINGIFY(x)   _SCM_CPP_STRINGIFY (x)
 176
 177 /* The word size marker in objcode.  */
 178 #define SCM_OBJCODE_WORD_SIZE  SCM_CPP_STRINGIFY (SIZEOF_VOID_P)
 179
 180 /* Major and minor versions must be single characters. */
 181 #define SCM_OBJCODE_MAJOR_VERSION 0
 182 #define SCM_OBJCODE_MINOR_VERSION Q
 183 #define SCM_OBJCODE_MAJOR_VERSION_STRING        \
 184   SCM_CPP_STRINGIFY(SCM_OBJCODE_MAJOR_VERSION)
 185 #define SCM_OBJCODE_MINOR_VERSION_STRING        \
 186   SCM_CPP_STRINGIFY(SCM_OBJCODE_MINOR_VERSION)
 187 #define SCM_OBJCODE_VERSION_STRING                                      \
 188   SCM_OBJCODE_MAJOR_VERSION_STRING "." SCM_OBJCODE_MINOR_VERSION_STRING
 189 #define SCM_OBJCODE_MACHINE_VERSION_STRING                              \
 190   SCM_OBJCODE_VERSION_STRING "-" SCM_OBJCODE_ENDIANNESS "-" SCM_OBJCODE_WORD_SIZE
 191
 192 /* The objcode magic header.  */
 193 #define SCM_OBJCODE_COOKIE                              \
 194   "GOOF-" SCM_OBJCODE_MACHINE_VERSION_STRING "---"
 195
 196 \f
 197 /* Cells have to be 8-byte aligned.  Use `scm_t_aligned_cell' when not
 198    allocating on the heap to have this guarantee.  This is similar to the
 199    `SCM_ALIGNED' macro but provides an option likely to work with compilers
 200    other than GCC.  */
 201
 202 #ifdef __GNUC__
 203
 204 struct scm_aligned_cell
 205 {
 206   scm_t_cell cell __attribute__ ((__aligned__ (8)));
 207 };
 208
 209 typedef struct scm_aligned_cell scm_t_aligned_cell;
 210
 211 #else /* !__GNUC__ */
 212
 213 union scm_aligned_cell
 214 {
 215   double alignment;
 216   scm_t_cell cell;
 217 };
 218
 219 typedef union scm_aligned_cell scm_t_aligned_cell;
 220
 221 #endif /* !__GNUC__ */
 222
 223 /* Make sure we get the right alignment.  */
 224 verify (alignof (scm_t_aligned_cell) >= 8);
 225
 226 #endif  /* SCM__SCM_H */
 227
 228 /*
 229   Local Variables:
 230   c-file-style: "gnu"
 231   End:
 232 */