newlib/libc/stdio/putc.c

   1 /*
   2  * Copyright (c) 1990 The Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted
   6  * provided that the above copyright notice and this paragraph are
   7  * duplicated in all such forms and that any documentation,
   8  * advertising materials, and other materials related to such
   9  * distribution and use acknowledge that the software was developed
  10  * by the University of California, Berkeley.  The name of the
  11  * University may not be used to endorse or promote products derived
  12  * from this software without specific prior written permission.
  13  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16  */
  17
  18 /*
  19 FUNCTION
  20 <<putc>>---write a character (macro)
  21
  22 INDEX
  23         putc
  24 INDEX
  25         _putc_r
  26
  27 ANSI_SYNOPSIS
  28         #include <stdio.h>
  29         int putc(int <[ch]>, FILE *<[fp]>);
  30
  31         #include <stdio.h>
  32         int _putc_r(struct _reent *<[ptr]>, int <[ch]>, FILE *<[fp]>);
  33
  34 TRAD_SYNOPSIS
  35         #include <stdio.h>
  36         int putc(<[ch]>, <[fp]>)
  37         int <[ch]>;
  38         FILE *<[fp]>;
  39
  40         #include <stdio.h>
  41         int _putc_r(<[ptr]>, <[ch]>, <[fp]>)
  42         struct _reent *<[ptr]>;
  43         int <[ch]>;
  44         FILE *<[fp]>;
  45
  46 DESCRIPTION
  47 <<putc>> is a macro, defined in <<stdio.h>>.  <<putc>>
  48 writes the argument <[ch]> to the file or stream identified by
  49 <[fp]>, after converting it from an <<int>> to an <<unsigned char>>.
  50
  51 If the file was opened with append mode (or if the stream cannot
  52 support positioning), then the new character goes at the end of the
  53 file or stream.  Otherwise, the new character is written at the
  54 current value of the position indicator, and the position indicator
  55 advances by one.
  56
  57 For a subroutine version of this macro, see <<fputc>>.
  58
  59 The <<_putc_r>> function is simply the reentrant version of
  60 <<putc>> that takes an additional reentrant structure argument: <[ptr]>.
  61
  62 RETURNS
  63 If successful, <<putc>> returns its argument <[ch]>.  If an error
  64 intervenes, the result is <<EOF>>.  You can use `<<ferror(<[fp]>)>>' to
  65 query for errors.
  66
  67 PORTABILITY
  68 ANSI C requires <<putc>>; it suggests, but does not require, that
  69 <<putc>> be implemented as a macro.  The standard explicitly permits
  70 macro implementations of <<putc>> to use the <[fp]> argument more than once;
  71 therefore, in a portable program, you should not use an expression
  72 with side effects as this argument.
  73
  74 Supporting OS subroutines required: <<close>>, <<fstat>>, <<isatty>>,
  75 <<lseek>>, <<read>>, <<sbrk>>, <<write>>.
  76 */
  77
  78 #if defined(LIBC_SCCS) && !defined(lint)
  79 static char sccsid[] = "%W% (Berkeley) %G%";
  80 #endif /* LIBC_SCCS and not lint */
  81
  82 #include <_ansi.h>
  83 #include <stdio.h>
  84 #include "local.h"
  85
  86 /*
  87  * A subroutine version of the macro putc.
  88  */
  89
  90 #undef putc
  91
  92 int
  93 _DEFUN(_putc_r, (ptr, c, fp),
  94        struct _reent *ptr _AND
  95        int c _AND
  96        register FILE *fp)
  97 {
  98   int result;
  99   CHECK_INIT (ptr, fp);
 100   _flockfile (fp);
 101   result = __sputc_r (ptr, c, fp);
 102   _funlockfile (fp);
 103   return result;
 104 }
 105
 106 #ifndef _REENT_ONLY
 107 int
 108 _DEFUN(putc, (c, fp),
 109        int c _AND
 110        register FILE *fp)
 111 {
 112 #if !defined(PREFER_SIZE_OVER_SPEED) && !defined(__OPTIMIZE_SIZE__)
 113   int result;
 114   CHECK_INIT (_REENT, fp);
 115   _flockfile (fp);
 116   result = __sputc_r (_REENT, c, fp);
 117   _funlockfile (fp);
 118   return result;
 119 #else
 120   return _putc_r (_REENT, c, fp);
 121 #endif
 122 }
 123 #endif /* !_REENT_ONLY */
 124