1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2013, 2014 Damien P. George
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 #ifndef MICROPY_INCLUDED_PY_MPPRINT_H
27 #define MICROPY_INCLUDED_PY_MPPRINT_H
28 
29 #include "py/mpconfig.h"
30 
31 #define PF_FLAG_LEFT_ADJUST       (0x001)
32 #define PF_FLAG_SHOW_SIGN         (0x002)
33 #define PF_FLAG_SPACE_SIGN        (0x004)
34 #define PF_FLAG_NO_TRAILZ         (0x008)
35 #define PF_FLAG_SHOW_PREFIX       (0x010)
36 #define PF_FLAG_SHOW_COMMA        (0x020)
37 #define PF_FLAG_PAD_AFTER_SIGN    (0x040)
38 #define PF_FLAG_CENTER_ADJUST     (0x080)
39 #define PF_FLAG_ADD_PERCENT       (0x100)
40 #define PF_FLAG_SHOW_OCTAL_LETTER (0x200)
41 
42 #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
43 #define MP_PYTHON_PRINTER &mp_sys_stdout_print
44 #else
45 #define MP_PYTHON_PRINTER &mp_plat_print
46 #endif
47 
48 typedef void (*mp_print_strn_t)(void *data, const char *str, size_t len);
49 
50 typedef struct _mp_print_t {
51     void *data;
52     mp_print_strn_t print_strn;
53 } mp_print_t;
54 
55 typedef struct _mp_print_ext_t {
56     mp_print_t base;
57     const char *item_separator;
58     const char *key_separator;
59 }mp_print_ext_t;
60 
61 #define MP_PRINT_GET_EXT(print) ((mp_print_ext_t *)print)
62 
63 // All (non-debug) prints go through one of the two interfaces below.
64 // 1) Wrapper for platform print function, which wraps MP_PLAT_PRINT_STRN.
65 extern const mp_print_t mp_plat_print;
66 #if MICROPY_PY_IO && MICROPY_PY_SYS_STDFILES
67 // 2) Wrapper for printing to sys.stdout.
68 extern const mp_print_t mp_sys_stdout_print;
69 #endif
70 
71 int mp_print_str(const mp_print_t *print, const char *str);
72 int mp_print_strn(const mp_print_t *print, const char *str, size_t len, int flags, char fill, int width);
73 #if MICROPY_PY_BUILTINS_FLOAT
74 int mp_print_float(const mp_print_t *print, mp_float_t f, char fmt, int flags, char fill, int width, int prec);
75 #endif
76 
77 int mp_printf(const mp_print_t *print, const char *fmt, ...);
78 #ifdef va_start
79 int mp_vprintf(const mp_print_t *print, const char *fmt, va_list args);
80 #endif
81 
82 #endif // MICROPY_INCLUDED_PY_MPPRINT_H
83