aboutsummaryrefslogtreecommitdiff
path: root/lib/libk/stdio.h
blob: b28eb5e5ba272f1014eafc1537f41d84b03b884a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#pragma once

#include <stdarg.h>

///@defgroup libk libk
///@{
///@defgroup stdio stdio
///@{

/// An object type used for streams
typedef struct FILE {
  int id;

  /// Function that prints a character to the stream
  void (*putc)(const struct FILE *, char);

  /// Function that prints a string to the stream
  int (*puts)(const struct FILE *, const char *, int);

  /// Flush write buffers
  void (*flush)(const struct FILE *);
} FILE;

/** A FILE value corresponding to stdin, the keyboard buffer */
extern FILE *stdin;
/** A FILE value corresponding to stdout, the display */
extern FILE *stdout;
/** A FILE value corresponding to stderr, the uart */
extern FILE *stderr;

/**
 * Write the formatted string to stdout
 * Supports ``%s`` (string), ``%d`` (decimal), ``%u`` (unsigned), ``%x`` (hexadecimal)
 * @return number of bytes written
 */
int printf(const char *restrict format, ...);

/**
 * Write the formatted string to stream; see printf
 */
int fprintf(FILE *restrict stream, const char *restrict format, ...);

/**
 * Write the formatted string to stream; see printf
 */
int vfprintf(FILE *restrict stream, const char *restrict format, va_list ap);

///@}
///@}