libguile/ioext.c

   1 /*      Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2003 Free Software Foundation, Inc.
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public
   5  * License as published by the Free Software Foundation; either
   6  * version 2.1 of the License, or (at your option) any later version.
   7  *
   8  * This library 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 GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16  */
  17
  18
  19 \f
  20
  21 #if HAVE_CONFIG_H
  22 #  include <config.h>
  23 #endif
  24
  25 #include <stdio.h>
  26 #include <errno.h>
  27
  28 #include "libguile/_scm.h"
  29 #include "libguile/ioext.h"
  30 #include "libguile/fports.h"
  31 #include "libguile/feature.h"
  32 #include "libguile/ports.h"
  33 #include "libguile/strings.h"
  34 #include "libguile/validate.h"
  35 #include "libguile/dynwind.h"
  36
  37 #include <fcntl.h>
  38
  39 #ifdef HAVE_IO_H
  40 #include <io.h>
  41 #endif
  42 #ifdef HAVE_UNISTD_H
  43 #include <unistd.h>
  44 #endif
  45 \f
  46
  47 SCM_DEFINE (scm_ftell, "ftell", 1, 0, 0,
  48             (SCM fd_port),
  49             "Return an integer representing the current position of\n"
  50             "@var{fd/port}, measured from the beginning.  Equivalent to:\n"
  51             "\n"
  52             "@lisp\n"
  53             "(seek port 0 SEEK_CUR)\n"
  54             "@end lisp")
  55 #define FUNC_NAME s_scm_ftell
  56 {
  57   return scm_seek (fd_port, SCM_INUM0, scm_from_int (SEEK_CUR));
  58 }
  59 #undef FUNC_NAME
  60
  61 SCM_DEFINE (scm_redirect_port, "redirect-port", 2, 0, 0,
  62             (SCM old, SCM new),
  63             "This procedure takes two ports and duplicates the underlying file\n"
  64             "descriptor from @var{old-port} into @var{new-port}.  The\n"
  65             "current file descriptor in @var{new-port} will be closed.\n"
  66             "After the redirection the two ports will share a file position\n"
  67             "and file status flags.\n\n"
  68             "The return value is unspecified.\n\n"
  69             "Unexpected behaviour can result if both ports are subsequently used\n"
  70             "and the original and/or duplicate ports are buffered.\n\n"
  71             "This procedure does not have any side effects on other ports or\n"
  72             "revealed counts.")
  73 #define FUNC_NAME s_scm_redirect_port
  74 {
  75   int ans, oldfd, newfd;
  76   scm_t_fport *fp;
  77
  78   old = SCM_COERCE_OUTPORT (old);
  79   new = SCM_COERCE_OUTPORT (new);
  80
  81   SCM_VALIDATE_OPFPORT (1, old);
  82   SCM_VALIDATE_OPFPORT (2, new);
  83   oldfd = SCM_FPORT_FDES (old);
  84   fp = SCM_FSTREAM (new);
  85   newfd = fp->fdes;
  86   if (oldfd != newfd)
  87     {
  88       scm_t_port *pt = SCM_PTAB_ENTRY (new);
  89       scm_t_port *old_pt = SCM_PTAB_ENTRY (old);
  90       scm_t_ptob_descriptor *ptob = &scm_ptobs[SCM_PTOBNUM (new)];
  91
  92       /* must flush to old fdes.  */
  93       if (pt->rw_active == SCM_PORT_WRITE)
  94         ptob->flush (new);
  95       else if (pt->rw_active == SCM_PORT_READ)
  96         scm_end_input (new);
  97       ans = dup2 (oldfd, newfd);
  98       if (ans == -1)
  99         SCM_SYSERROR;
 100       pt->rw_random = old_pt->rw_random;
 101       /* continue using existing buffers, even if inappropriate.  */
 102     }
 103   return SCM_UNSPECIFIED;
 104 }
 105 #undef FUNC_NAME
 106
 107 SCM_DEFINE (scm_dup_to_fdes, "dup->fdes", 1, 1, 0,
 108             (SCM fd_or_port, SCM fd),
 109             "Return a new integer file descriptor referring to the open file\n"
 110             "designated by @var{fd_or_port}, which must be either an open\n"
 111             "file port or a file descriptor.")
 112 #define FUNC_NAME s_scm_dup_to_fdes
 113 {
 114   int oldfd, newfd, rv;
 115
 116   fd_or_port = SCM_COERCE_OUTPORT (fd_or_port);
 117
 118   if (scm_is_integer (fd_or_port))
 119     oldfd = scm_to_int (fd_or_port);
 120   else
 121     {
 122       SCM_VALIDATE_OPFPORT (1, fd_or_port);
 123       oldfd = SCM_FPORT_FDES (fd_or_port);
 124     }
 125
 126   if (SCM_UNBNDP (fd))
 127     {
 128       newfd = dup (oldfd);
 129       if (newfd == -1)
 130         SCM_SYSERROR;
 131       fd = scm_from_int (newfd);
 132     }
 133   else
 134     {
 135       newfd = scm_to_int (fd);
 136       if (oldfd != newfd)
 137         {
 138           scm_evict_ports (newfd);      /* see scsh manual.  */
 139           rv = dup2 (oldfd, newfd);
 140           if (rv == -1)
 141             SCM_SYSERROR;
 142         }
 143     }
 144   return fd;
 145 }
 146 #undef FUNC_NAME
 147
 148
 149 SCM_DEFINE (scm_dup2, "dup2", 2, 0, 0,
 150             (SCM oldfd, SCM newfd),
 151             "A simple wrapper for the @code{dup2} system call.\n"
 152             "Copies the file descriptor @var{oldfd} to descriptor\n"
 153             "number @var{newfd}, replacing the previous meaning\n"
 154             "of @var{newfd}.  Both @var{oldfd} and @var{newfd} must\n"
 155             "be integers.\n"
 156             "Unlike for dup->fdes or primitive-move->fdes, no attempt\n"
 157             "is made to move away ports which are using @var{newfd}.\n"
 158             "The return value is unspecified.")
 159 #define FUNC_NAME s_scm_dup2
 160 {
 161   int c_oldfd;
 162   int c_newfd;
 163   int rv;
 164
 165   c_oldfd = scm_to_int (oldfd);
 166   c_newfd = scm_to_int (newfd);
 167   rv = dup2 (c_oldfd, c_newfd);
 168   if (rv == -1)
 169     SCM_SYSERROR;
 170   return SCM_UNSPECIFIED;
 171 }
 172 #undef FUNC_NAME
 173
 174 SCM_DEFINE (scm_fileno, "fileno", 1, 0, 0,
 175             (SCM port),
 176             "Return the integer file descriptor underlying @var{port}.  Does\n"
 177             "not change its revealed count.")
 178 #define FUNC_NAME s_scm_fileno
 179 {
 180   port = SCM_COERCE_OUTPORT (port);
 181   SCM_VALIDATE_OPFPORT (1, port);
 182   return scm_from_int (SCM_FPORT_FDES (port));
 183 }
 184 #undef FUNC_NAME
 185
 186 /* GJB:FIXME:: why does this not throw
 187    an error if the arg is not a port?
 188    This proc as is would be better names isattyport?
 189    if it is not going to assume that the arg is a port
 190
 191    [cmm] I don't see any problem with the above.  why should a type
 192    predicate assume _anything_ about its argument?
 193 */
 194 SCM_DEFINE (scm_isatty_p, "isatty?", 1, 0, 0,
 195             (SCM port),
 196             "Return @code{#t} if @var{port} is using a serial non--file\n"
 197             "device, otherwise @code{#f}.")
 198 #define FUNC_NAME s_scm_isatty_p
 199 {
 200   int rv;
 201
 202   port = SCM_COERCE_OUTPORT (port);
 203
 204   if (!SCM_OPFPORTP (port))
 205     return SCM_BOOL_F;
 206
 207   rv = isatty (SCM_FPORT_FDES (port));
 208   return  scm_from_bool(rv);
 209 }
 210 #undef FUNC_NAME
 211
 212
 213
 214 SCM_DEFINE (scm_fdopen, "fdopen", 2, 0, 0,
 215             (SCM fdes, SCM modes),
 216             "Return a new port based on the file descriptor @var{fdes}.\n"
 217             "Modes are given by the string @var{modes}.  The revealed count\n"
 218             "of the port is initialized to zero.  The modes string is the\n"
 219             "same as that accepted by @ref{File Ports, open-file}.")
 220 #define FUNC_NAME s_scm_fdopen
 221 {
 222   return scm_i_fdes_to_port (scm_to_int (fdes),
 223                              scm_i_mode_bits (modes), SCM_BOOL_F);
 224 }
 225 #undef FUNC_NAME
 226
 227
 228
 229 /* Move a port's underlying file descriptor to a given value.
 230  * Returns  #f if fdes is already the given value.
 231  *          #t if fdes moved.
 232  * MOVE->FDES is implemented in Scheme and calls this primitive.
 233  */
 234 SCM_DEFINE (scm_primitive_move_to_fdes, "primitive-move->fdes", 2, 0, 0,
 235             (SCM port, SCM fd),
 236             "Moves the underlying file descriptor for @var{port} to the integer\n"
 237             "value @var{fdes} without changing the revealed count of @var{port}.\n"
 238             "Any other ports already using this descriptor will be automatically\n"
 239             "shifted to new descriptors and their revealed counts reset to zero.\n"
 240             "The return value is @code{#f} if the file descriptor already had the\n"
 241             "required value or @code{#t} if it was moved.")
 242 #define FUNC_NAME s_scm_primitive_move_to_fdes
 243 {
 244   scm_t_fport *stream;
 245   int old_fd;
 246   int new_fd;
 247   int rv;
 248
 249   port = SCM_COERCE_OUTPORT (port);
 250
 251   SCM_VALIDATE_OPFPORT (1, port);
 252   stream = SCM_FSTREAM (port);
 253   old_fd = stream->fdes;
 254   new_fd = scm_to_int (fd);
 255   if  (old_fd == new_fd)
 256     {
 257       return SCM_BOOL_F;
 258     }
 259   scm_evict_ports (new_fd);
 260   rv = dup2 (old_fd, new_fd);
 261   if (rv == -1)
 262     SCM_SYSERROR;
 263   stream->fdes = new_fd;
 264   SCM_SYSCALL (close (old_fd));
 265   return SCM_BOOL_T;
 266 }
 267 #undef FUNC_NAME
 268
 269 /* Return a list of ports using a given file descriptor.  */
 270 SCM_DEFINE (scm_fdes_to_ports, "fdes->ports", 1, 0, 0,
 271            (SCM fd),
 272             "Return a list of existing ports which have @var{fdes} as an\n"
 273             "underlying file descriptor, without changing their revealed\n"
 274             "counts.")
 275 #define FUNC_NAME s_scm_fdes_to_ports
 276 {
 277   SCM result = SCM_EOL;
 278   int int_fd;
 279   long i;
 280
 281   int_fd = scm_to_int (fd);
 282
 283   scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex);
 284   for (i = 0; i < scm_i_port_table_size; i++)
 285     {
 286       if (SCM_OPFPORTP (scm_i_port_table[i]->port)
 287           && ((scm_t_fport *) scm_i_port_table[i]->stream)->fdes == int_fd)
 288         result = scm_cons (scm_i_port_table[i]->port, result);
 289     }
 290   scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex);
 291   return result;
 292 }
 293 #undef FUNC_NAME
 294
 295
 296 void
 297 scm_init_ioext ()
 298 {
 299   scm_add_feature ("i/o-extensions");
 300
 301 #include "libguile/ioext.x"
 302 }
 303
 304
 305 /*
 306   Local Variables:
 307   c-file-style: "gnu"
 308   End:
 309 */