summaryrefslogtreecommitdiffstats
path: root/newlib/libc/stdio/fputc.c
diff options
context:
space:
mode:
Diffstat (limited to 'newlib/libc/stdio/fputc.c')
-rw-r--r--newlib/libc/stdio/fputc.c41
1 files changed, 38 insertions, 3 deletions
diff --git a/newlib/libc/stdio/fputc.c b/newlib/libc/stdio/fputc.c
index f380717d1..0aad0a9f7 100644
--- a/newlib/libc/stdio/fputc.c
+++ b/newlib/libc/stdio/fputc.c
@@ -17,32 +17,55 @@
/*
FUNCTION
-<<fputc>>---write a character on a stream or file
+<<fputc>>, <<fputc_unlocked>>---write a character on a stream or file
INDEX
fputc
INDEX
+ fputc_unlocked
+INDEX
_fputc_r
+INDEX
+ _fputc_unlocked_r
ANSI_SYNOPSIS
#include <stdio.h>
int fputc(int <[ch]>, FILE *<[fp]>);
+ #define _BSD_SOURCE
+ #include <stdio.h>
+ int fputc_unlocked(int <[ch]>, FILE *<[fp]>);
+
#include <stdio.h>
int _fputc_r(struct _rent *<[ptr]>, int <[ch]>, FILE *<[fp]>);
+ #include <stdio.h>
+ int _fputc_unlocked_r(struct _rent *<[ptr]>, int <[ch]>, FILE *<[fp]>);
+
TRAD_SYNOPSIS
#include <stdio.h>
int fputc(<[ch]>, <[fp]>)
int <[ch]>;
FILE *<[fp]>;
+ #define _BSD_SOURCE
+ #include <stdio.h>
+ int fputc_unlocked(<[ch]>, <[fp]>)
+ int <[ch]>;
+ FILE *<[fp]>;
+
#include <stdio.h>
int _fputc_r(<[ptr]>, <[ch]>, <[fp]>)
struct _reent *<[ptr]>;
int <[ch]>;
FILE *<[fp]>;
+ #include <stdio.h>
+ int _fputc_unlocked_r(<[ptr]>, <[ch]>, <[fp]>)
+ struct _reent *<[ptr]>;
+ int <[ch]>;
+ FILE *<[fp]>;
+
DESCRIPTION
<<fputc>> converts the argument <[ch]> from an <<int>> to an
<<unsigned char>>, then writes it to the file or stream identified by
@@ -56,8 +79,18 @@ oadvances by one.
For a macro version of this function, see <<putc>>.
-The <<_fputc_r>> function is simply a reentrant version of <<fputc>>
-that takes an additional reentrant structure argument: <[ptr]>.
+<<fputc_unlocked>> is a non-thread-safe version of <<fputc>>.
+<<fputc_unlocked>> may only safely be used within a scope
+protected by flockfile() (or ftrylockfile()) and funlockfile(). This
+function may safely be used in a multi-threaded program if and only
+if they are called while the invoking thread owns the (FILE *)
+object, as is the case after a successful call to the flockfile() or
+ftrylockfile() functions. If threads are disabled, then
+<<fputc_unlocked>> is equivalent to <<fputc>>.
+
+The <<_fputc_r>> and <<_fputc_unlocked_r>> functions are simply reentrant
+versions of the above that take an additional reentrant structure
+argument: <[ptr]>.
RETURNS
If successful, <<fputc>> returns its argument <[ch]>. If an error
@@ -67,6 +100,8 @@ query for errors.
PORTABILITY
<<fputc>> is required by ANSI C.
+<<fputc_unlocked>> is a BSD extension also provided by GNU libc.
+
Supporting OS subroutines required: <<close>>, <<fstat>>, <<isatty>>,
<<lseek>>, <<read>>, <<sbrk>>, <<write>>.
*/