From: Bruno Haible <bruno@clisp.org>
Date: Sun, 19 Aug 2007 17:42:40 +0000 (+0000)
Subject: New module 'freadahead'.
X-Git-Tag: cvs-readonly~60
X-Git-Url: http://erislabs.net/gitweb/?a=commitdiff_plain;h=865db7af4d69d7e9f3421420008f1cee41b2f622;p=gnulib.git

New module 'freadahead'.
---

diff --git a/ChangeLog b/ChangeLog
index 699b954a9..c5dc31e57 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2007-08-19  Bruno Haible  <bruno@clisp.org>
+
+	* modules/freadahead: New file.
+	* lib/freadahead.h: New file.
+	* lib/freadahead.c: New file.
+	* MODULES.html.sh (File stream based Input/Output): Add freadahead,
+	fbufmode, fpurge, freadable, fwritable.
+
 2007-08-19  Eric Blake  <ebb9@byu.net>
 
 	Test yesno in combination with closein.
diff --git a/MODULES.html.sh b/MODULES.html.sh
index 3d1cbccfe..3bf56abff 100755
--- a/MODULES.html.sh
+++ b/MODULES.html.sh
@@ -2194,9 +2194,14 @@ func_all_modules ()
   func_module close-stream
   func_module closein
   func_module closeout
+  func_module fbufmode
   func_module fopen-safer
   func_module fpending
+  func_module fpurge
+  func_module freadable
+  func_module freadahead
   func_module freading
+  func_module fwritable
   func_module fwriting
   func_module getpass
   func_module getpass-gnu
diff --git a/lib/freadahead.c b/lib/freadahead.c
new file mode 100644
index 000000000..4d52f633a
--- /dev/null
+++ b/lib/freadahead.c
@@ -0,0 +1,62 @@
+/* Retrieve information about a FILE stream.
+   Copyright (C) 2007 Free Software Foundation, Inc.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License along
+   with this program; if not, write to the Free Software Foundation,
+   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
+
+#include <config.h>
+
+/* Specification.  */
+#include "freadahead.h"
+
+size_t
+freadahead (FILE *fp)
+{
+#if defined _IO_ferror_unlocked     /* GNU libc, BeOS */
+  if (fp->_IO_write_ptr > fp->_IO_write_base)
+    return 0;
+  return fp->_IO_read_end - fp->_IO_read_ptr;
+#elif defined __sferror             /* FreeBSD, NetBSD, OpenBSD, MacOS X, Cygwin */
+  if ((fp->_flags & __SWR) != 0 || fp->_r < 0)
+    return 0;
+  return fp->_r;
+#elif defined _IOERR                /* AIX, HP-UX, IRIX, OSF/1, Solaris, mingw */
+# if defined __sun && defined _LP64 /* Solaris/{SPARC,AMD64} 64-bit */
+#  define fp_ ((struct { unsigned char *_ptr; \
+			 unsigned char *_base; \
+			 unsigned char *_end; \
+			 long _cnt; \
+			 int _file; \
+			 unsigned int _flag; \
+		       } *) fp)
+  if ((fp_->_flag & _IOWRT) != 0)
+    return 0;
+  return fp_->_cnt;
+# else
+  if ((fp->_flag & _IOWRT) != 0)
+    return 0;
+  return fp->_cnt;
+# endif
+#elif defined __UCLIBC__            /* uClibc */
+# ifdef __STDIO_BUFFERS
+  if (fp->__modeflags & __FLAG_WRITING)
+    return 0;
+  return fp->__bufread - fp->__bufpos;
+# else
+  return 0;
+# endif
+#else
+ #error "Please port gnulib freadahead.c to your platform! Look at the definition of fflush, fread on your system, then report this to bug-gnulib."
+#endif
+}
diff --git a/lib/freadahead.h b/lib/freadahead.h
new file mode 100644
index 000000000..56e1ed0b8
--- /dev/null
+++ b/lib/freadahead.h
@@ -0,0 +1,37 @@
+/* Retrieve information about a FILE stream.
+   Copyright (C) 2007 Free Software Foundation, Inc.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2, or (at your option)
+   any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License along
+   with this program; if not, write to the Free Software Foundation,
+   Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
+
+#include <stddef.h>
+#include <stdio.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Assuming the stream STREAM is open for reading:
+   Return the number of bytes waiting in the input buffer of STREAM.
+
+   If this number is 0 and the stream is not currently writing,
+   fflush (STREAM) is known to be a no-op.
+
+   STREAM must not be wide-character oriented.  */
+
+extern size_t freadahead (FILE *stream);
+
+#ifdef __cplusplus
+}
+#endif
diff --git a/modules/freadahead b/modules/freadahead
new file mode 100644
index 000000000..824759b96
--- /dev/null
+++ b/modules/freadahead
@@ -0,0 +1,24 @@
+Description:
+freadahead() function: Determine the number of bytes waiting in the input
+buffer of a stream.
+
+Files:
+lib/freadahead.h
+lib/freadahead.c
+
+Depends-on:
+
+configure.ac:
+
+Makefile.am:
+lib_SOURCES += freadahead.c
+
+Include:
+"freadahead.h"
+
+License:
+LGPL
+
+Maintainer:
+Bruno Haible
+