libc/docs/stdio.rst

   1 ===============
   2 StdIO Functions
   3 ===============
   4
   5 .. include:: check.rst
   6
   7 ---------------
   8 Source location
   9 ---------------
  10
  11 -   The main source for string functions is located at:
  12     ``libc/src/stdio`` with subdirectories for internal implementations.
  13
  14 ---------------------
  15 Implementation Status
  16 ---------------------
  17
  18 Formatted Input/Output Functions
  19 ================================
  20
  21 These functions take in format strings and arguments of various types and
  22 convert either to or from those arguments. These functions are the current focus
  23 (owner: michaelrj).
  24
  25 =============  =========
  26 Function Name  Available
  27 =============  =========
  28 \*printf       Mostly
  29 \*scanf        |check|
  30 =============  =========
  31
  32 ``FILE`` Access
  33 ===============
  34
  35 These functions are used to interact with the ``FILE`` object type, which is an
  36 I/O stream, often used to represent a file on the host's hard drive. Currently
  37 the ``FILE`` object is only available on linux.
  38
  39 =============  =========
  40 Function Name  Available
  41 =============  =========
  42 fopen          |check|
  43 freopen
  44 fclose         |check|
  45 fflush         |check|
  46 setbuf         |check|
  47 setvbuf        |check|
  48 ftell          |check|
  49 fgetpos
  50 fseek          |check|
  51 fsetpos
  52 rewind
  53 tmpfile
  54 clearerr       |check|
  55 feof           |check|
  56 ferror         |check|
  57 flockfile      |check|
  58 funlockfile    |check|
  59 =============  =========
  60
  61 Operations on system files
  62 ==========================
  63
  64 These functions operate on files on the host's system, without using the
  65 ``FILE`` object type. They only take the name of the file being operated on.
  66
  67 =============  =========
  68 Function_Name  Available
  69 =============  =========
  70 remove         |check|
  71 rename         |check|
  72 tmpnam
  73 =============  =========
  74
  75 Unformatted ``FILE`` Input/Output Functions
  76 ===========================================
  77
  78 The ``gets`` function was removed in C11 for having no bounds checking and
  79 therefor being impossible to use safely.
  80
  81 =============  =========
  82 Function Name  Available
  83 =============  =========
  84 (f)getc        |check|
  85 fgets          |check|
  86 getchar        |check|
  87 fread          |check|
  88 (f)putc        |check|
  89 (f)puts        |check|
  90 putchar        |check|
  91 fwrite         |check|
  92 ungetc         |check|
  93 =============  =========