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
|
#ifndef __BFT_PRINTF_H__
#define __BFT_PRINTF_H__
/*============================================================================
* Base user-definable printf() wrapper or replacement
*============================================================================*/
/*
This file is part of Code_Saturne, a general-purpose CFD tool.
Copyright (C) 1998-2016 EDF S.A.
This program is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.
This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details.
You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*----------------------------------------------------------------------------*/
#include "cs_defs.h"
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
* Standard C library headers
*----------------------------------------------------------------------------*/
#include <stdarg.h>
/*----------------------------------------------------------------------------
* Local headers
*----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/
BEGIN_C_DECLS
/*============================================================================
* Public types
*============================================================================*/
/* Function pointers for printf() and fflush(stdout) type functions */
typedef int (bft_printf_proxy_t) (const char *const format,
va_list arg_ptr);
typedef int (bft_printf_flush_proxy_t) (void);
/*============================================================================
* Public function prototypes
*============================================================================*/
/*
* Replacement for printf() with modifiable behavior.
*
* This function calls vprintf() by default, or a function with similar
* arguments indicated by bft_printf_proxy_set().
*
* parameters:
* format: <-- format string, as printf() and family.
* ... : <-- variable arguments based on format string.
*
* returns:
* number of characters printed, not counting the trailing '\0' used
* to end output strings
*/
#if defined(__GNUC__)
int
bft_printf(const char *const format,
...)
__attribute__((format(printf, 1, 2)));
#else
int
bft_printf(const char *const format,
...);
#endif
/*
* Flush for output of bft_printf() with modifiable behavior.
*
* This function calls fflush(stdout) if bft_printf()'s default behavior is
* used. If bft_printf's behavior is modified with bft_printf_proxy_set(),
* bft_printf_flush()'s behavior may have to be also adjusted with
* bft_printf_flush_proxy_set().
*
* returns:
* using the default behavior, the return value is that of
* fflush(stdout): O upon successful completion, EOF otherwise
* (with errno set to indicate the error).
*/
int
bft_printf_flush(void);
/*
* Returns function associated with the bft_printf() function.
*
* returns:
* pointer to the vprintf() or replacement function.
*/
bft_printf_proxy_t *
bft_printf_proxy_get(void);
/*
* Associates a vprintf() type function with the bft_printf() function.
*
* parameters:
* fct: <-- pointer to a vprintf() type function.
*/
void
bft_printf_proxy_set(bft_printf_proxy_t *const fct);
/*
* Returns function associated with bft_printf_flush().
*
* returns:
* pointer to the bft_printf_flush() proxy.
*/
bft_printf_flush_proxy_t *
bft_printf_flush_proxy_get(void);
/*
* Associates a proxy function with bft_printf_flush().
*
* warning:
* bft_printf() is called by the default bft_error() error handler
* (so as to ensure that the error text appears at the end of the
* program output), so a bft_print_flush replacement must not itself
* call (directly or indirectly) bft_error() if the default error
* handler is used.
*
* parameter:
* fct <-- pointer to a function similar to {return fflush(stdout)}.
*/
void
bft_printf_flush_proxy_set(bft_printf_flush_proxy_t *const fct);
/*----------------------------------------------------------------------------*/
END_C_DECLS
#endif /* __BFT_PRINTF_H__ */
|
