niansa-misc/glibc
1
0
Fork 0
mirror of git://sourceware.org/git/glibc.git synced 2025-03-06 20:58:33 +01:00
Code Issues Projects Releases Packages Wiki Activity

manual/stdio: Further clarify putc, putwc, getc, and getwc

Browse source 
This is a follow-up to 10de4a47ef that
reworded the manual entries for putc and putwc and removed any
performance claims.

This commit further clarifies these entries and brings getc and getwc in
line with the descriptions of putc and putwc, removing any performance
claims from them as well.
Reviewed-by: Florian Weimer <fweimer@redhat.com>
This commit is contained in:
Arjun Shankar 2024-07-30 11:37:57 +02:00
parent d7eca2714f
commit 942670c81d
1 changed files with 10 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
manual/stdio.texi
View file

@ -904,20 +904,16 @@ This function is a GNU extension.
@standards{ISO, stdio.h} @standards{ISO, stdio.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{} @aculock{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{} @aculock{}}}
This is just like @code{fputc}, except that it may be implemented as This is just like @code{fputc}, except that it may be implemented as
a macro, making it faster. One consequence is that it may evaluate the a macro and may evaluate the @var{stream} argument more than once.
@var{stream} argument more than once, which is an exception to the Therefore, @var{stream} should never be an expression with side-effects.
general rule for macros. Therefore, @var{stream} should never be an
expression with side-effects.
@end deftypefun @end deftypefun
@deftypefun wint_t putwc (wchar_t @var{wc}, FILE *@var{stream}) @deftypefun wint_t putwc (wchar_t @var{wc}, FILE *@var{stream})
@standards{ISO, wchar.h} @standards{ISO, wchar.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{} @aculock{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@acucorrupt{} @aculock{}}}
This is just like @code{fputwc}, except that it may be implemented as This is just like @code{fputwc}, except that it may be implemented as
a macro, making it faster. One consequence is that it may evaluate the a macro and may evaluate the @var{stream} argument more than once.
@var{stream} argument more than once, which is an exception to the Therefore, @var{stream} should never be an expression with side-effects.
general rule for macros. Therefore, @var{stream} should never be an
expression with side-effects.
@end deftypefun @end deftypefun
@deftypefun int putc_unlocked (int @var{c}, FILE *@var{stream}) @deftypefun int putc_unlocked (int @var{c}, FILE *@var{stream})
@ -1110,20 +1106,17 @@ This function is a GNU extension.
@deftypefun int getc (FILE *@var{stream}) @deftypefun int getc (FILE *@var{stream})
@standards{ISO, stdio.h} @standards{ISO, stdio.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@aculock{} @acucorrupt{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@aculock{} @acucorrupt{}}}
This is just like @code{fgetc}, except that it is permissible (and This is just like @code{fgetc}, except that it may be implemented as
typical) for it to be implemented as a macro that evaluates the a macro and may evaluate the @var{stream} argument more than once.
@var{stream} argument more than once. @code{getc} is often highly Therefore, @var{stream} should never be an expression with side-effects.
optimized, so it is usually the best function to use to read a single
character.
@end deftypefun @end deftypefun
@deftypefun wint_t getwc (FILE *@var{stream}) @deftypefun wint_t getwc (FILE *@var{stream})
@standards{ISO, wchar.h} @standards{ISO, wchar.h}
@safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@aculock{} @acucorrupt{}}} @safety{@prelim{}@mtsafe{}@asunsafe{@asucorrupt{}}@acunsafe{@aculock{} @acucorrupt{}}}
This is just like @code{fgetwc}, except that it is permissible for it to This is just like @code{fgetwc}, except that it may be implemented as
be implemented as a macro that evaluates the @var{stream} argument more a macro and may evaluate the @var{stream} argument more than once.
than once. @code{getwc} can be highly optimized, so it is usually the Therefore, @var{stream} should never be an expression with side-effects.
best function to use to read a single wide character.
@end deftypefun @end deftypefun
@deftypefun int getc_unlocked (FILE *@var{stream}) @deftypefun int getc_unlocked (FILE *@var{stream})