stdio/local.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Chris Torek.
   7  *
   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. All advertising materials mentioning features or use of this software
  17  *    must display the following acknowledgement:
  18  *      This product includes software developed by the University of
  19  *      California, Berkeley and its contributors.
  20  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)local.h     8.3 (Berkeley) 7/3/94
  37  * $FreeBSD: src/lib/libc/stdio/local.h,v 1.26 2004/07/16 05:52:51 tjr Exp $
  38  */
  39
  40 #include <sys/cdefs.h>
  41 #include "xlocale_private.h"
  42 #include <sys/types.h>  /* for off_t */
  43 #include <pthread.h>
  44 #include <limits.h>
  45 #include <string.h>
  46 #include <wchar.h>
  47
  48 /*
  49  * Information local to this implementation of stdio,
  50  * in particular, macros and private variables.
  51  */
  52
  53 extern int      _sread(FILE *, char *, int);
  54 extern int      _swrite(FILE *, char const *, int);
  55 extern fpos_t   _sseek(FILE *, fpos_t, int);
  56 extern int      _ftello(FILE *, fpos_t *);
  57 extern int      _fseeko(FILE *, off_t, int, int);
  58 extern int      __fflush(FILE *fp);
  59 extern wint_t   __fgetwc(FILE *, locale_t);
  60 extern wint_t   __fputwc(wchar_t, FILE *, locale_t);
  61 extern int      __sflush(FILE *);
  62 extern FILE     *__sfp(int);            /* arg is whether to count against STREAM_MAX or not */
  63 extern void     __sfprelease(FILE *);   /* mark free and update count as needed */
  64 extern int      __slbexpand(FILE *, size_t);
  65 extern int      __srefill(FILE *);
  66 extern int      __srefill0(FILE *);
  67 extern int      __srefill1(FILE *);
  68 extern int      __sread(void *, char *, int);
  69 extern int      __swrite(void *, char const *, int);
  70 extern fpos_t   __sseek(void *, fpos_t, int);
  71 extern int      __sclose(void *);
  72 extern void     __sinit(void);
  73 extern void     _cleanup(void);
  74 extern void     (*__cleanup)(void);
  75 extern void     __smakebuf(FILE *);
  76 extern int      __swhatbuf(FILE *, size_t *, int *);
  77 extern int      _fwalk(int (*)(FILE *));
  78 extern int      __svfscanf_l(FILE *, locale_t, const char *, __va_list) __DARWIN_LDBL_COMPAT(__svfscanf_l);
  79 extern int      __swsetup(FILE *);
  80 extern int      __sflags(const char *, int *);
  81 extern int      __ungetc(int, FILE *);
  82 extern wint_t   __ungetwc(wint_t, FILE *, locale_t);
  83 extern int      __vfprintf(FILE *, locale_t, const char *, __va_list) __DARWIN_LDBL_COMPAT(__vfprintf);
  84 extern int      __vfscanf(FILE *, const char *, __va_list) __DARWIN_LDBL_COMPAT(__vfscanf);
  85 extern int      __vfwprintf(FILE *, locale_t, const wchar_t *, __va_list) __DARWIN_LDBL_COMPAT(__vfwprintf);
  86 extern int      __vfwscanf(FILE * __restrict, locale_t, const wchar_t * __restrict,
  87                     __va_list) __DARWIN_LDBL_COMPAT(__vfwscanf);
  88
  89 extern int      __sdidinit;
  90
  91
  92 /* hold a buncha junk that would grow the ABI */
  93 struct __sFILEX {
  94         unsigned char   *_up;   /* saved _p when _p is doing ungetc data */
  95         pthread_mutex_t fl_mutex;       /* used for MT-safety */
  96         pthread_t       fl_owner;       /* current owner */
  97         int             fl_count;       /* recursive lock count */
  98         int             orientation:2;  /* orientation for fwide() */
  99         int             counted:1;      /* stream counted against STREAM_MAX */
 100         mbstate_t       mbstate;        /* multibyte conversion state */
 101 };
 102
 103 /*
 104  * Prepare the given FILE for writing, and return 0 iff it
 105  * can be written now.  Otherwise, return EOF and set errno.
 106  */
 107 #define prepwrite(fp) \
 108         ((((fp)->_flags & __SWR) == 0 || \
 109             ((fp)->_bf._base == NULL && ((fp)->_flags & __SSTR) == 0)) && \
 110          __swsetup(fp))
 111
 112 /*
 113  * Test whether the given stdio file has an active ungetc buffer;
 114  * release such a buffer, without restoring ordinary unread data.
 115  */
 116 #define HASUB(fp) ((fp)->_ub._base != NULL)
 117 #define FREEUB(fp) { \
 118         if ((fp)->_ub._base != (fp)->_ubuf) \
 119                 free((char *)(fp)->_ub._base); \
 120         (fp)->_ub._base = NULL; \
 121 }
 122
 123 /*
 124  * test for an fgetln() buffer.
 125  */
 126 #define HASLB(fp) ((fp)->_lb._base != NULL)
 127 #define FREELB(fp) { \
 128         free((char *)(fp)->_lb._base); \
 129         (fp)->_lb._base = NULL; \
 130 }
 131
 132 #define INITEXTRA(fp) { \
 133         (fp)->_extra->_up = NULL; \
 134         (fp)->_extra->fl_mutex = (pthread_mutex_t)PTHREAD_MUTEX_INITIALIZER; \
 135         (fp)->_extra->fl_owner = NULL; \
 136         (fp)->_extra->fl_count = 0; \
 137         (fp)->_extra->orientation = 0; \
 138         memset(&(fp)->_extra->mbstate, 0, sizeof(mbstate_t)); \
 139 }
 140
 141 /*
 142  * Set the orientation for a stream. If o > 0, the stream has wide-
 143  * orientation. If o < 0, the stream has byte-orientation.
 144  */
 145 #define ORIENT(fp, o)   do {                            \
 146         if ((fp)->_extra->orientation == 0)             \
 147                 (fp)->_extra->orientation = (o);        \
 148 } while (0)