StdLib/LibC/Stdio/local.h

   1 /** @file
   2     Information local to this implementation of stdio,
   3     in particular, function declarations and macros.
   4
   5     Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>
   6     This program and the accompanying materials are licensed and made available
   7     under the terms and conditions of the BSD License that accompanies this
   8     distribution.  The full text of the license may be found at
   9     http://opensource.org/licenses/bsd-license.php.
  10
  11     THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12     WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14     Copyright (c) 1990, 1993
  15     The Regents of the University of California.  All rights reserved.
  16
  17     This code is derived from software contributed to Berkeley by
  18     Chris Torek.
  19
  20     Redistribution and use in source and binary forms, with or without
  21     modification, are permitted provided that the following conditions
  22     are met:
  23       - Redistributions of source code must retain the above copyright
  24         notice, this list of conditions and the following disclaimer.
  25       - Redistributions in binary form must reproduce the above copyright
  26         notice, this list of conditions and the following disclaimer in the
  27         documentation and/or other materials provided with the distribution.
  28       - Neither the name of the University nor the names of its contributors
  29         may be used to endorse or promote products derived from this software
  30         without specific prior written permission.
  31
  32     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  33     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  34     IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  35     ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  36     LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  37     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  38     SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  39     INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  40     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  41     ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42     POSSIBILITY OF SUCH DAMAGE.
  43
  44     NetBSD: local.h,v 1.20 2005/05/14 23:51:02 christos Exp
  45     local.h 8.3 (Berkeley) 7/3/94
  46 **/
  47
  48 #include "wcio.h"
  49 #include "fileext.h"
  50
  51 extern int      __sflush(FILE *);
  52 extern FILE    *__sfp(void);
  53 extern int      __srefill(FILE *);
  54 extern int      __sread(void *, char *, int);
  55 extern int      __swrite(void *, char const *, int);
  56 extern fpos_t   __sseek(void *, fpos_t, int);
  57 extern int      __sclose(void *);
  58 extern void     __sinit(void);
  59 extern void     _cleanup(void);
  60 //extern void   (*__cleanup)(void);   // Now in MainData.h.  Ref. as gMD->cleanup
  61 extern void     __smakebuf(FILE *);
  62 extern int      __swhatbuf(FILE *, size_t *, int *);
  63 extern int      _fwalk(int (*)(FILE *));
  64 extern char    *_mktemp(char *);
  65 extern int      __swsetup(FILE *);
  66 extern int      __sflags(const char *, int *);
  67 extern int      __svfscanf(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_)
  68                             __attribute__((__format__(__scanf__, 2, 0)));
  69 extern int      __svfscanf_unlocked(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_)
  70                             __attribute__((__format__(__scanf__, 2, 0)));
  71 extern int      __vfprintf_unlocked(FILE * __restrict, const char * __restrict, _BSD_VA_LIST_);
  72
  73
  74 extern int      __sdidinit;
  75
  76 extern int      __gettemp(char *, int *, int);
  77
  78 extern wint_t   __fgetwc_unlock(FILE *);
  79 extern wint_t   __fputwc_unlock(wchar_t, FILE *);
  80
  81 extern char    *__fgetstr(FILE * __restrict, size_t * __restrict, int);
  82 extern int      __slbexpand(FILE *, size_t);
  83 extern int      __vfwprintf_unlocked(FILE *, const wchar_t *, _BSD_VA_LIST_);
  84 extern int      __vfwscanf_unlocked(FILE * __restrict, const wchar_t * __restrict, _BSD_VA_LIST_);
  85
  86 /*
  87  * Return true iff the given FILE cannot be written now.
  88  */
  89 #define cantwrite(fp) \
  90   ((((fp)->_flags & __SWR) == 0 || (fp)->_bf._base == NULL) && __swsetup(fp))
  91
  92 /*
  93  * Test whether the given stdio file has an active ungetc buffer;
  94  * release such a buffer, without restoring ordinary unread data.
  95  */
  96 #define HASUB(fp) (_UB(fp)._base != NULL)
  97 #define FREEUB(fp) { \
  98     if (_UB(fp)._base != (fp)->_ubuf) \
  99       free((char *)_UB(fp)._base); \
 100     _UB(fp)._base = NULL; \
 101   }
 102
 103 /*
 104  * test for an fgetln() buffer.
 105  */
 106 #define HASLB(fp) ((fp)->_lb._base != NULL)
 107 #define FREELB(fp) { \
 108     free((char *)(fp)->_lb._base); \
 109     (fp)->_lb._base = NULL; \
 110   }
 111
 112 extern void __flockfile_internal  (FILE *, int);
 113 extern void __funlockfile_internal(FILE *, int);