Add keyword arguments to file opening procedures.
[bpt/guile.git] / 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 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 } scm_t_fport;
36
37 SCM_API scm_t_bits scm_tc16_fport;
38
39 #define SCM_FSTREAM(x) ((scm_t_fport *) SCM_STREAM (x))
40 #define SCM_FPORT_FDES(x) (SCM_FSTREAM (x)->fdes)
41
42 #define SCM_FPORTP(x) (!SCM_IMP (x) && (SCM_TYP16 (x) == scm_tc16_fport))
43 #define SCM_OPFPORTP(x) (SCM_FPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_OPN))
44 #define SCM_OPINFPORTP(x) (SCM_OPFPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_RDNG))
45 #define SCM_OPOUTFPORTP(x) (SCM_OPFPORTP (x) && (SCM_CELL_WORD_0 (x) & SCM_WRTNG))
46
47 /* test whether fdes supports random access. */
48 #define SCM_FDES_RANDOM_P(fdes) ((lseek (fdes, 0, SEEK_CUR) == -1) ? 0 : 1)
49
50 \f
51 SCM_API SCM scm_setbuf0 (SCM port);
52 SCM_API SCM scm_setvbuf (SCM port, SCM mode, SCM size);
53 SCM_API void scm_evict_ports (int fd);
54 SCM_API SCM scm_open_file_with_encoding (SCM filename, SCM modes,
55 SCM guess_encoding, SCM encoding);
56 SCM_API SCM scm_open_file (SCM filename, SCM modes);
57 SCM_API SCM scm_fdes_to_port (int fdes, char *mode, SCM name);
58 SCM_API SCM scm_file_port_p (SCM obj);
59 SCM_INTERNAL void scm_init_fports_keywords (void);
60 SCM_INTERNAL void scm_init_fports (void);
61
62 /* internal functions */
63
64 SCM_INTERNAL SCM scm_i_fdes_to_port (int fdes, long mode_bits, SCM name);
65
66
67 #endif /* SCM_FPORTS_H */
68
69 /*
70 Local Variables:
71 c-file-style: "gnu"
72 End:
73 */