summaryrefslogtreecommitdiff
path: root/user/include/stdio.h
blob: 9e60f55509d2a157782c83383cbf90d252c247b5 (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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/**
 * @file stdio.h
 *
 * @author Freya Murphy <freya@freyacat.org>
 *
 * Standard I/O definitions.
 */

#ifndef _STDIO_H
#define _STDIO_H

#include <stdarg.h>
#include <stddef.h>

// TODO: implement
typedef void FILE;

extern FILE *stdin;
extern FILE *stdout;
#define stdin stdin
#define stdout stdout

/**
 * Prints out a char
 *
 * @param c - the char
 */
extern void putc(char c);

/**
 * Prints out a null terminated string
 *
 * @param s - the string
 */
extern void puts(const char *s);

/**
 * Prints out a char
 *
 * @param stream - stream to write to
 * @param c - the char
 */
extern void fputc(FILE *stream, char c);

/**
 * Prints out a null terminated string
 *
 * @param stream - stream to write to
 * @param s - the string
 */
extern void fputs(FILE *stream, const char *s);

/**
 * prints out a formatted string
 *
 * @param format - the format string
 * @param ... - variable args for the format
 */
__attribute__((format(printf, 1, 2))) extern void printf(const char *format,
														 ...);

/**
 * prints out a formatted string to a buffer
 *
 * @param s - the string to write to
 * @param format - the format string
 * @param ... - variable args for the format
 * @returns number of bytes written
 */
__attribute__((format(printf, 2, 3))) extern size_t
sprintf(char *restrict s, const char *format, ...);

/**
 * prints out a formatted string to a buffer with a given max length
 *
 * @param s - the string to write to
 * @param maxlen - the max len of the buffer
 * @param format - the format string
 * @param ... - variable args for the format
 * @returns number of bytes written
 */
__attribute__((format(printf, 3, 4))) extern size_t
snprintf(char *restrict s, size_t maxlen, const char *format, ...);

/**
 * prints out a formatted string
 *
 * @param format - the format string
 * @param args - variable arg list for the format
 */
extern void vprintf(const char *format, va_list args);

/**
 * prints out a formatted string to a buffer
 *
 * @param s - the string to write to
 * @param format - the format string
 * @param args - variable arg list for the format
 * @returns number of bytes written
 */
extern size_t vsprintf(char *restrict s, const char *format, va_list args);

/**
 * prints out a formatted string to a buffer with a given max length
 *
 * @param s - the string to write to
 * @param maxlen - the max len of the buffer
 * @param format - the format string
 * @param args - variable arg list for the format
 * @returns number of bytes written
 */
extern size_t vsnprintf(char *restrict s, size_t maxlen, const char *format,
						va_list args);

/**
 * prints out a formatted string
 *
 * @param stream - the opened stream to print to
 * @param format - the format string
 * @param ... - variable args for the format
 */
__attribute__((format(printf, 2, 3))) extern void
fprintf(FILE *stream, const char *format, ...);

/**
 * prints out a formatted string
 *
 * @param stream - the opened stream to print to
 * @param format - the format string
 * @param args - variable arg list for the format
 */
extern void vfprintf(FILE *stream, const char *format, va_list args);

/**
 * opens a file with a given file name
 *
 * @param filename - the name of the file to open
 * @returns the file pointer of success, NULL on error
 */
extern FILE *fopen(const char *filename);

/**
 * closes a opened file
 *
 * @param stream - the opened file stream
 */
extern void fclose(FILE *stream);

/**
 * reads data from a file into a pointer
 * @param ptr - the buffer to write into
 * @param size - the size of the block to read
 * @param n - the count of blocks to read
 * @param stream - the file stream to read from
 * @returns the number of blocks read
 */
extern size_t fread(void *ptr, size_t size, size_t n, FILE *stream);

/**
 * writes data from a pointer into a file
 * @param ptr - the buffer to read from
 * @param size - the size of the block to write
 * @param n - the count of blocks to write
 * @param stream - the file stream to write into
 * @returns the number of blocks written
 */
extern size_t fwrite(void *ptr, size_t size, size_t n, FILE *stream);

#endif /* stdio.h */