libguile/fports.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_FPORTS_H
   4 #define SCM_FPORTS_H
   5
   6 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2006, 2008, 2009, 2011, 2012 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 #include "libguile/__scm.h"
  27
  28 #include "libguile/ports.h"
  29
  30 \f
  31
  32 /* struct allocated for each buffered FPORT.  */
  33 typedef struct scm_t_fport {
  34   int fdes;                     /* file descriptor.  */
  35   int revealed;                 /* 0 not revealed, > 1 revealed.
  36                                  * Revealed ports do not get GC'd.
  37                                  */
  38 } scm_t_fport;
  39
  40 SCM_API scm_t_bits scm_tc16_fport;
  41
  42 #define SCM_FSTREAM(x) ((scm_t_fport *) SCM_STREAM (x))
  43 #define SCM_FPORT_FDES(x) (SCM_FSTREAM (x)->fdes)
  44
  45 #define SCM_FPORTP(x) (SCM_HAS_TYP16 (x, scm_tc16_fport))
  46 #define SCM_OPFPORTP(x) (SCM_FPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_OPN))
  47 #define SCM_OPINFPORTP(x) (SCM_OPFPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_RDNG))
  48 #define SCM_OPOUTFPORTP(x) (SCM_OPFPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_WRTNG))
  49
  50 /* test whether fdes supports random access.  */
  51 #define SCM_FDES_RANDOM_P(fdes) ((lseek (fdes, 0, SEEK_CUR) == -1) ? 0 : 1)
  52
  53 \f
  54 SCM_API SCM scm_setbuf0 (SCM port);
  55 SCM_API SCM scm_setvbuf (SCM port, SCM mode, SCM size);
  56 SCM_API void scm_evict_ports (int fd);
  57 SCM_API SCM scm_open_file_with_encoding (SCM filename, SCM modes,
  58                                          SCM guess_encoding, SCM encoding);
  59 SCM_API SCM scm_open_file (SCM filename, SCM modes);
  60 SCM_API SCM scm_fdes_to_port (int fdes, char *mode, SCM name);
  61 SCM_API SCM scm_file_port_p (SCM obj);
  62
  63 \f
  64 /* Revealed counts.  */
  65 SCM_API int scm_revealed_count (SCM port);
  66 SCM_API SCM scm_port_revealed (SCM port);
  67 SCM_API SCM scm_set_port_revealed_x (SCM port, SCM rcount);
  68 SCM_API SCM scm_adjust_port_revealed_x (SCM port, SCM addend);
  69
  70 \f
  71 SCM_INTERNAL void scm_init_fports_keywords (void);
  72 SCM_INTERNAL void scm_init_fports (void);
  73
  74 /* internal functions */
  75
  76 SCM_INTERNAL SCM scm_i_fdes_to_port (int fdes, long mode_bits, SCM name);
  77
  78
  79 #endif  /* SCM_FPORTS_H */
  80
  81 /*
  82   Local Variables:
  83   c-file-style: "gnu"
  84   End:
  85 */