libguile/inline.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_INLINE_H
   4 #define SCM_INLINE_H
   5
   6 /* Copyright (C) 2001, 2002, 2003, 2004, 2006, 2008, 2009, 2010,
   7  *   2011 Free Software Foundation, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public License
  11  * as published by the Free Software Foundation; either version 3 of
  12  * the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA
  23  */
  24
  25 /* This file is for inline functions.  On platforms that don't support
  26    inlining functions, they are turned into ordinary functions.  On
  27    platforms that do support inline functions, the definitions are still
  28    compiled into the library, once, in inline.c.  */
  29
  30 #include <stdio.h>
  31 #include <string.h>
  32
  33 #include "libguile/__scm.h"
  34
  35 #include "libguile/pairs.h"
  36 #include "libguile/gc.h"
  37 #include "libguile/threads.h"
  38 #include "libguile/array-handle.h"
  39 #include "libguile/ports.h"
  40 #include "libguile/numbers.h"
  41 #include "libguile/error.h"
  42
  43
  44 SCM_INLINE SCM scm_array_handle_ref (scm_t_array_handle *h, ssize_t pos);
  45 SCM_INLINE void scm_array_handle_set (scm_t_array_handle *h, ssize_t pos, SCM val);
  46
  47 SCM_INLINE int scm_is_pair (SCM x);
  48 SCM_INLINE int scm_is_string (SCM x);
  49
  50 SCM_INLINE int scm_get_byte_or_eof (SCM port);
  51 SCM_INLINE int scm_peek_byte_or_eof (SCM port);
  52 SCM_INLINE void scm_putc (char c, SCM port);
  53 SCM_INLINE void scm_puts (const char *str_data, SCM port);
  54
  55
  56 SCM_INLINE SCM scm_cell (scm_t_bits car, scm_t_bits cdr);
  57 SCM_INLINE SCM scm_double_cell (scm_t_bits car, scm_t_bits cbr,
  58                              scm_t_bits ccr, scm_t_bits cdr);
  59 SCM_INLINE SCM scm_words (scm_t_bits car, scm_t_uint16 n_words);
  60
  61 #if SCM_CAN_INLINE || defined SCM_INLINE_C_IMPLEMENTING_INLINES
  62 /* Either inlining, or being included from inline.c.  */
  63
  64 SCM_INLINE_IMPLEMENTATION SCM
  65 scm_array_handle_ref (scm_t_array_handle *h, ssize_t p)
  66 {
  67   if (SCM_UNLIKELY (p < 0 && ((size_t)-p) > h->base))
  68     /* catch overflow */
  69     scm_out_of_range (NULL, scm_from_ssize_t (p));
  70   /* perhaps should catch overflow here too */
  71   return h->impl->vref (h, h->base + p);
  72 }
  73
  74 SCM_INLINE_IMPLEMENTATION void
  75 scm_array_handle_set (scm_t_array_handle *h, ssize_t p, SCM v)
  76 {
  77   if (SCM_UNLIKELY (p < 0 && ((size_t)-p) > h->base))
  78     /* catch overflow */
  79     scm_out_of_range (NULL, scm_from_ssize_t (p));
  80   /* perhaps should catch overflow here too */
  81   h->impl->vset (h, h->base + p, v);
  82 }
  83
  84 SCM_INLINE_IMPLEMENTATION int
  85 scm_is_pair (SCM x)
  86 {
  87   /* The following "workaround_for_gcc_295" avoids bad code generated by
  88      i386 gcc 2.95.4 (the Debian packaged 2.95.4-24 at least).
  89
  90      Under the default -O2 the inlined SCM_I_CONSP test gets "optimized" so
  91      the fetch of the tag word from x is done before confirming it's a
  92      non-immediate (SCM_NIMP).  Needless to say that bombs badly if x is a
  93      immediate.  This was seen to afflict scm_srfi1_split_at and something
  94      deep in the bowels of ceval().  In both cases segvs resulted from
  95      deferencing a random immediate value.  srfi-1.test exposes the problem
  96      through a short list, the immediate being SCM_EOL in that case.
  97      Something in syntax.test exposed the ceval() problem.
  98
  99      Just "volatile SCM workaround_for_gcc_295 = lst" is enough to avoid the
 100      problem, without even using that variable.  The "w=w" is just to
 101      prevent a warning about it being unused.
 102      */
 103 #if defined (__GNUC__) && __GNUC__ == 2 && __GNUC_MINOR__ == 95
 104   volatile SCM workaround_for_gcc_295 = x;
 105   workaround_for_gcc_295 = workaround_for_gcc_295;
 106 #endif
 107
 108   return SCM_I_CONSP (x);
 109 }
 110
 111 SCM_INLINE_IMPLEMENTATION int
 112 scm_is_string (SCM x)
 113 {
 114   return SCM_HAS_TYP7 (x, scm_tc7_string);
 115 }
 116
 117 /* Port I/O.  */
 118
 119 SCM_INLINE_IMPLEMENTATION int
 120 scm_get_byte_or_eof (SCM port)
 121 {
 122   int c;
 123   scm_t_port *pt = SCM_PTAB_ENTRY (port);
 124
 125   if (pt->rw_active == SCM_PORT_WRITE)
 126     /* may be marginally faster than calling scm_flush.  */
 127     scm_ptobs[SCM_PTOBNUM (port)].flush (port);
 128
 129   if (pt->rw_random)
 130     pt->rw_active = SCM_PORT_READ;
 131
 132   if (pt->read_pos >= pt->read_end)
 133     {
 134       if (SCM_UNLIKELY (scm_fill_input (port) == EOF))
 135         return EOF;
 136     }
 137
 138   c = *(pt->read_pos++);
 139
 140   return c;
 141 }
 142
 143 /* Like `scm_get_byte_or_eof' but does not change PORT's `read_pos'.  */
 144 SCM_INLINE_IMPLEMENTATION int
 145 scm_peek_byte_or_eof (SCM port)
 146 {
 147   int c;
 148   scm_t_port *pt = SCM_PTAB_ENTRY (port);
 149
 150   if (pt->rw_active == SCM_PORT_WRITE)
 151     /* may be marginally faster than calling scm_flush.  */
 152     scm_ptobs[SCM_PTOBNUM (port)].flush (port);
 153
 154   if (pt->rw_random)
 155     pt->rw_active = SCM_PORT_READ;
 156
 157   if (pt->read_pos >= pt->read_end)
 158     {
 159       if (SCM_UNLIKELY (scm_fill_input (port) == EOF))
 160         return EOF;
 161     }
 162
 163   c = *pt->read_pos;
 164
 165   return c;
 166 }
 167
 168 SCM_INLINE_IMPLEMENTATION void
 169 scm_putc (char c, SCM port)
 170 {
 171   SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port");
 172   scm_lfwrite (&c, 1, port);
 173 }
 174
 175 SCM_INLINE_IMPLEMENTATION void
 176 scm_puts (const char *s, SCM port)
 177 {
 178   SCM_ASSERT_TYPE (SCM_OPOUTPORTP (port), port, 0, NULL, "output port");
 179   scm_lfwrite (s, strlen (s), port);
 180 }
 181
 182
 183 #endif
 184 #endif