libguile/vports.c

   1 /* Copyright (C) 1995,1996,1998,1999,2000,2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  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  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42
  43 \f
  44
  45 #include <stdio.h>
  46 #include <errno.h>
  47
  48 #include "libguile/_scm.h"
  49 #include "libguile/eval.h"
  50 #include "libguile/chars.h"
  51 #include "libguile/fports.h"
  52 #include "libguile/root.h"
  53 #include "libguile/strings.h"
  54 #include "libguile/vectors.h"
  55
  56 #include "libguile/validate.h"
  57 #include "libguile/vports.h"
  58
  59 #ifdef HAVE_STRING_H
  60 #include <string.h>
  61 #endif
  62
  63 \f
  64
  65 /* {Ports - soft ports}
  66  *
  67  */
  68
  69
  70 static scm_t_bits scm_tc16_sfport;
  71
  72
  73 static void
  74 sf_flush (SCM port)
  75 {
  76   scm_t_port *pt = SCM_PTAB_ENTRY (port);
  77   SCM stream = SCM_PACK (pt->stream);
  78
  79   if (pt->write_pos > pt->write_buf)
  80     {
  81       /* write the byte. */
  82       scm_call_1 (SCM_VELTS (stream)[0], SCM_MAKE_CHAR (*pt->write_buf));
  83       pt->write_pos = pt->write_buf;
  84
  85       /* flush the output.  */
  86       {
  87         SCM f = SCM_VELTS (stream)[2];
  88
  89         if (!SCM_FALSEP (f))
  90           scm_call_0 (f);
  91       }
  92     }
  93 }
  94
  95 static void
  96 sf_write (SCM port, const void *data, size_t size)
  97 {
  98   SCM p = SCM_PACK (SCM_STREAM (port));
  99
 100   scm_call_1 (SCM_VELTS (p)[1], scm_mem2string ((char *) data, size));
 101 }
 102
 103 /* calling the flush proc (element 2) is in case old code needs it,
 104    but perhaps softports could the use port buffer in the same way as
 105    fports.  */
 106
 107 /* places a single char in the input buffer.  */
 108 static int
 109 sf_fill_input (SCM port)
 110 {
 111   SCM p = SCM_PACK (SCM_STREAM (port));
 112   SCM ans;
 113
 114   ans = scm_call_0 (SCM_VELTS (p)[3]); /* get char.  */
 115   if (SCM_FALSEP (ans) || SCM_EOF_OBJECT_P (ans))
 116     return EOF;
 117   SCM_ASSERT (SCM_CHARP (ans), ans, SCM_ARG1, "sf_fill_input");
 118   {
 119     scm_t_port *pt = SCM_PTAB_ENTRY (port);
 120
 121     *pt->read_buf = SCM_CHAR (ans);
 122     pt->read_pos = pt->read_buf;
 123     pt->read_end = pt->read_buf + 1;
 124     return *pt->read_buf;
 125   }
 126 }
 127
 128
 129 static int
 130 sf_close (SCM port)
 131 {
 132   SCM p = SCM_PACK (SCM_STREAM (port));
 133   SCM f = SCM_VELTS (p)[4];
 134   if (SCM_FALSEP (f))
 135     return 0;
 136   f = scm_call_0 (f);
 137   errno = 0;
 138   return SCM_FALSEP (f) ? EOF : 0;
 139 }
 140
 141
 142
 143 SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0,
 144            (SCM pv, SCM modes),
 145             "Return a port capable of receiving or delivering characters as\n"
 146             "specified by the @var{modes} string (@pxref{File Ports,\n"
 147             "open-file}).  @var{pv} must be a vector of length 5.  Its\n"
 148             "components are as follows:\n"
 149             "\n"
 150             "@enumerate 0\n"
 151             "@item\n"
 152             "procedure accepting one character for output\n"
 153             "@item\n"
 154             "procedure accepting a string for output\n"
 155             "@item\n"
 156             "thunk for flushing output\n"
 157             "@item\n"
 158             "thunk for getting one character\n"
 159             "@item\n"
 160             "thunk for closing port (not by garbage collection)\n"
 161             "@end enumerate\n"
 162             "\n"
 163             "For an output-only port only elements 0, 1, 2, and 4 need be\n"
 164             "procedures.  For an input-only port only elements 3 and 4 need\n"
 165             "be procedures.  Thunks 2 and 4 can instead be @code{#f} if\n"
 166             "there is no useful operation for them to perform.\n"
 167             "\n"
 168             "If thunk 3 returns @code{#f} or an @code{eof-object}\n"
 169             "(@pxref{Input, eof-object?, ,r5rs, The Revised^5 Report on\n"
 170             "Scheme}) it indicates that the port has reached end-of-file.\n"
 171             "For example:\n"
 172             "\n"
 173             "@lisp\n"
 174             "(define stdout (current-output-port))\n"
 175             "(define p (make-soft-port\n"
 176             "           (vector\n"
 177             "            (lambda (c) (write c stdout))\n"
 178             "            (lambda (s) (display s stdout))\n"
 179             "            (lambda () (display \".\" stdout))\n"
 180             "            (lambda () (char-upcase (read-char)))\n"
 181             "            (lambda () (display \"@@\" stdout)))\n"
 182             "           \"rw\"))\n"
 183             "\n"
 184             "(write p p) @result{} #<input-output: soft 8081e20>\n"
 185             "@end lisp")
 186 #define FUNC_NAME s_scm_make_soft_port
 187 {
 188   scm_t_port *pt;
 189   SCM z;
 190   SCM_VALIDATE_VECTOR_LEN (1, pv,5);
 191   SCM_VALIDATE_STRING (2, modes);
 192   z = scm_cell (scm_tc16_sfport, 0);
 193   SCM_DEFER_INTS;
 194   pt = scm_add_to_port_table (z);
 195   scm_port_non_buffer (pt);
 196   SCM_SET_CELL_TYPE (z, scm_tc16_sfport | scm_mode_bits (SCM_STRING_CHARS (modes)));
 197   SCM_SETPTAB_ENTRY (z, pt);
 198   SCM_SETSTREAM (z, SCM_UNPACK (pv));
 199   SCM_ALLOW_INTS;
 200   return z;
 201 }
 202 #undef FUNC_NAME
 203
 204
 205 static scm_t_bits
 206 scm_make_sfptob ()
 207 {
 208   scm_t_bits tc = scm_make_port_type ("soft", sf_fill_input, sf_write);
 209
 210   scm_set_port_mark (tc, scm_markstream);
 211   scm_set_port_flush (tc, sf_flush);
 212   scm_set_port_close (tc, sf_close);
 213
 214   return tc;
 215 }
 216
 217 void
 218 scm_init_vports ()
 219 {
 220   scm_tc16_sfport = scm_make_sfptob ();
 221
 222 #include "libguile/vports.x"
 223 }
 224
 225 /*
 226   Local Variables:
 227   c-file-style: "gnu"
 228   End:
 229 */