lib/libc/stdio/funopen.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek.
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 4. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)funopen.3   8.1 (Berkeley) 6/9/93
  31 .\" $FreeBSD: src/lib/libc/stdio/funopen.3,v 1.16 2007/01/09 00:28:06 imp Exp $
  32 .\" $DragonFly: src/lib/libc/stdio/funopen.3,v 1.3 2006/05/26 19:39:37 swildner Exp $
  33 .\"
  34 .Dd March 19, 2004
  35 .Dt FUNOPEN 3
  36 .Os
  37 .Sh NAME
  38 .Nm funopen ,
  39 .Nm fropen ,
  40 .Nm fwopen
  41 .Nd open a stream
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In stdio.h
  46 .Ft FILE *
  47 .Fn funopen "const void *cookie" "int (*readfn)(void *, char *, int)" "int (*writefn)(void *, const char *, int)" "fpos_t (*seekfn)(void *, fpos_t, int)" "int (*closefn)(void *)"
  48 .Ft FILE *
  49 .Fn fropen "void *cookie" "int (*readfn)(void *, char *, int)"
  50 .Ft FILE *
  51 .Fn fwopen "void *cookie" "int (*writefn)(void *, const char *, int)"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn funopen
  55 function
  56 associates a stream with up to four
  57 .Dq Tn I/O No functions .
  58 Either
  59 .Fa readfn
  60 or
  61 .Fa writefn
  62 must be specified;
  63 the others can be given as an appropriately-typed
  64 .Dv NULL
  65 pointer.
  66 These
  67 .Tn I/O
  68 functions will be used to read, write, seek and
  69 close the new stream.
  70 .Pp
  71 In general, omitting a function means that any attempt to perform the
  72 associated operation on the resulting stream will fail.
  73 If the close function is omitted, closing the stream will flush
  74 any buffered output and then succeed.
  75 .Pp
  76 The calling conventions of
  77 .Fa readfn ,
  78 .Fa writefn ,
  79 .Fa seekfn
  80 and
  81 .Fa closefn
  82 must match those, respectively, of
  83 .Xr read 2 ,
  84 .Xr write 2 ,
  85 .Xr lseek 2 ,
  86 and
  87 .Xr close 2
  88 with the single exception that they are passed the
  89 .Fa cookie
  90 argument specified to
  91 .Fn funopen
  92 in place of the traditional file descriptor argument.
  93 .Pp
  94 Read and write
  95 .Tn I/O
  96 functions are allowed to change the underlying buffer
  97 on fully buffered or line buffered streams by calling
  98 .Xr setvbuf 3 .
  99 They are also not required to completely fill or empty the buffer.
 100 They are not, however, allowed to change streams from unbuffered to buffered
 101 or to change the state of the line buffering flag.
 102 They must also be prepared to have read or write calls occur on buffers other
 103 than the one most recently specified.
 104 .Pp
 105 All user
 106 .Tn I/O
 107 functions can report an error by returning \-1.
 108 Additionally, all of the functions should set the external variable
 109 .Va errno
 110 appropriately if an error occurs.
 111 .Pp
 112 An error on
 113 .Fn closefn
 114 does not keep the stream open.
 115 .Pp
 116 As a convenience, the include file
 117 .In stdio.h
 118 defines the macros
 119 .Fn fropen
 120 and
 121 .Fn fwopen
 122 as calls to
 123 .Fn funopen
 124 with only a read or write function specified.
 125 .Sh RETURN VALUES
 126 Upon successful completion,
 127 .Fn funopen
 128 returns a
 129 .Dv FILE
 130 pointer.
 131 Otherwise,
 132 .Dv NULL
 133 is returned and the global variable
 134 .Va errno
 135 is set to indicate the error.
 136 .Sh ERRORS
 137 .Bl -tag -width Er
 138 .It Bq Er EINVAL
 139 The
 140 .Fn funopen
 141 function
 142 was called without either a read or write function.
 143 The
 144 .Fn funopen
 145 function
 146 may also fail and set
 147 .Va errno
 148 for any of the errors
 149 specified for the routine
 150 .Xr malloc 3 .
 151 .El
 152 .Sh SEE ALSO
 153 .Xr fcntl 2 ,
 154 .Xr open 2 ,
 155 .Xr fclose 3 ,
 156 .Xr fopen 3 ,
 157 .Xr fseek 3 ,
 158 .Xr setbuf 3
 159 .Sh HISTORY
 160 The
 161 .Fn funopen
 162 functions first appeared in
 163 .Bx 4.4 .
 164 .Sh BUGS
 165 The
 166 .Fn funopen
 167 function
 168 may not be portable to systems other than
 169 .Bx .
 170 .Pp
 171 The
 172 .Fn funopen
 173 interface erroneously assumes that
 174 .Vt fpos_t
 175 is an integral type; see
 176 .Xr fseek 3
 177 for a discussion of this issue.