annotate printf.h @ 0:e3088565a6b8 default tip

*: initial commit kinda dumb, but wifi was out and I was bored. most of this code is shit.
author Paper <paper@tflc.us>
date Wed, 03 Dec 2025 03:04:39 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
1 /**
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
2 * "Portable" printf implementation, with some extras.
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
3 *
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
4 * Copyright (c) Paper 2025
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
5 *
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
7 * purpose with or without fee is hereby granted.
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
8 *
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
10 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
11 * AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
12 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
13 * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
14 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
15 * PERFORMANCE OF THIS SOFTWARE.
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
16 *
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
17 * NOTE: Floating point support is very scuffed, and doesn't
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
18 * work for many numbers. It also depends on math.h. If you don't
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
19 * care or don't want floating point support, toggle the #define
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
20 * to disable it.
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
21 *
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
22 * EXTRA NOTE: You don't need malloc() if you turn off wide character
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
23 * support :)
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
24 **/
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
25
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
26 #ifndef MY_PRINTF_H_
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
27 #define MY_PRINTF_H_
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
28
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
29 #include <stdarg.h>
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
30 #include <stddef.h>
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
31 #include <stdio.h>
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
32 #include <limits.h>
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
33
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
34 /* XXX maybe we shouldn't use int as a return type. */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
35
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
36 enum {
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
37 MY_ENOMEM = -1, /* Out of memory */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
38 MY_EINVAL = -2, /* Invalid format string */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
39 MY_EENCOD = -3, /* Invalid wide character */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
40 MY_EOVERFLOW = -4, /* Return value overflows */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
41 };
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
42
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
43 /* Get string representation of error */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
44 const char *my_strerror(int err);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
45
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
46 /* Free dynamically allocated memory */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
47 void my_free(void *x);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
48
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
49 /* ------ Actual printf stuff */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
50
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
51 /* put function spec */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
52 typedef void (*put_spec)(void *opaque, unsigned char c);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
53
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
54 /* iprintf: my invention. it's basically the function that actually
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
55 * implements everything :) */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
56 int my_viprintf(put_spec put, void *opaque, const char *format, va_list ap);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
57 int my_iprintf(put_spec put, void *opaque, const char *format, ...);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
58
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
59 /* Equivalent to C99 [v]snprintf */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
60 int my_vsnprintf(char *s, size_t n, const char *format, va_list ap);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
61 int my_snprintf(char *s, size_t n, const char *format, ...);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
62
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
63 /* Puts an allocated printf'd string into '*ps'. Use my_free to deallocate. */
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
64 int my_vasprintf(char **ps, const char *format, va_list ap);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
65 int my_asprintf(char **ps, const char *format, ...);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
66
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
67 int my_vfprintf(FILE *f, const char *fmt, va_list ap);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
68 int my_fprintf(FILE *f, const char *fmt, ...);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
69
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
70 int my_vprintf(const char *fmt, va_list ap);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
71 int my_printf(const char *fmt, ...);
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
72
e3088565a6b8 *: initial commit
Paper <paper@tflc.us>
parents:
diff changeset
73 #endif