lib/libc/stdio/funopen.3

   1 .\"     $NetBSD: funopen.3,v 1.15 2010/03/22 19:30:54 joerg Exp $
   2 .\"
   3 .\" Copyright (c) 1990, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to Berkeley by
   7 .\" Chris Torek.
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)funopen.3   8.1 (Berkeley) 6/9/93
  33 .\"
  34 .Dd June 9, 1993
  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 "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 except 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 and
  94 .Fa seekfn
  95 uses
  96 .Li fpos_t
  97 instead of
  98 .Li off_t .
  99 .Pp
 100 Read and write
 101 .Tn I/O
 102 functions are allowed to change the underlying buffer
 103 on fully buffered or line buffered streams by calling
 104 .Xr setvbuf 3 .
 105 They are also not required to completely fill or empty the buffer.
 106 They are not, however, allowed to change streams from unbuffered to buffered
 107 or to change the state of the line buffering flag.
 108 They must also be prepared to have read or write calls occur on buffers other
 109 than the one most recently specified.
 110 .Pp
 111 All user
 112 .Tn I/O
 113 functions can report an error by returning \-1.
 114 Additionally, all of the functions should set the external variable
 115 .Va errno
 116 appropriately if an error occurs.
 117 .Pp
 118 An error on
 119 .Fn closefn
 120 does not keep the stream open.
 121 .Pp
 122 As a convenience, the include file
 123 .In stdio.h
 124 defines the macros
 125 .Fn fropen
 126 and
 127 .Fn fwopen
 128 as calls to
 129 .Fn funopen
 130 with only a read or write function specified.
 131 .Sh RETURN VALUES
 132 Upon successful completion,
 133 .Fn funopen
 134 returns a
 135 .Dv FILE
 136 pointer.
 137 Otherwise,
 138 .Dv NULL
 139 is returned and the global variable
 140 .Va errno
 141 is set to indicate the error.
 142 .Sh ERRORS
 143 .Bl -tag -width Er
 144 .It Bq Er EINVAL
 145 The
 146 .Fn funopen
 147 function
 148 was called without either a read or write function.
 149 The
 150 .Fn funopen
 151 function
 152 may also fail and set
 153 .Va errno
 154 for any of the errors
 155 specified for the routine
 156 .Xr malloc 3 .
 157 .El
 158 .Sh SEE ALSO
 159 .Xr fcntl 2 ,
 160 .Xr open 2 ,
 161 .Xr fclose 3 ,
 162 .Xr fopen 3 ,
 163 .Xr fseek 3 ,
 164 .Xr setbuf 3
 165 .Sh HISTORY
 166 The
 167 .Fn funopen
 168 functions first appeared in
 169 .Bx 4.4 .
 170 .Sh BUGS
 171 The
 172 .Fn funopen
 173 function
 174 may not be portable to systems other than
 175 .Bx .