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
|
/**
* @file util.c
* @author Gertjan van den Burg
* @date January, 2014
* @brief Utility functions
*
* @details
* This file contains several utility functions for coordinating input and
* output of data and model files. It also contains string functions.
*
*/
#include "gensvm_print.h"
FILE *GENSVM_OUTPUT_FILE = NULL; ///< The #GENSVM_OUTPUT_FILE specifies the
///< output stream to which all output is
///< written. This is done through the
///< internal (!)
///< function gensvm_print_string(). The
///< advantage of using a global output
///< stream variable is that the output can
///< temporarily be suppressed by importing
///< this variable through @c extern and
///< (temporarily) setting it to NULL.
FILE *GENSVM_ERROR_FILE = NULL; ///< The #GENSVM_ERROR_FILE specifies the
///< output stream to use when writing an
///< error. Typically this is stderr, but
///< when unit testing we can temporarily
///< redirect this to check if the correct
///< output is written.
/**
* @brief Print a given string to the specified output stream
*
* @details
* This function is used to print a given string to the output stream
* specified by #GENSVM_OUTPUT_FILE. The stream is flushed after the string
* is written to the stream. If #GENSVM_OUTPUT_FILE is NULL, nothing is
* written. Note that this function is only used by note(), it should never be
* used directly.
*
* @param[in] s string to write to the stream
*
*/
static void gensvm_print_string(const char *s)
{
if (GENSVM_OUTPUT_FILE != NULL) {
fputs(s, GENSVM_OUTPUT_FILE);
fflush(GENSVM_OUTPUT_FILE);
}
}
/**
* @brief Parse a formatted string and write to the output stream
*
* @details
* This function is a replacement of fprintf(), such that the output stream
* does not have to be specified at each function call. The functionality is
* exactly the same however. Writing the formatted string to the output stream
* is handled by gensvm_print_string().
*
* @param[in] fmt String format
* @param[in] ... variable argument list for the string format
*
*/
void note(const char *fmt,...)
{
char buf[BUFSIZ];
va_list ap;
va_start(ap,fmt);
vsprintf(buf,fmt,ap);
va_end(ap);
(*gensvm_print_string)(buf);
}
/**
* @brief Parse a formatted string and write it to standard error
*
* @details
* Shorthand for fprintf(GENSVM_ERROR_FILE, ...)
*
* @param[in] fmt string format
* @param[in] ... variable argument list for the string format
*/
void err(const char *fmt, ...)
{
char buf[BUFSIZ];
va_list ap;
va_start(ap, fmt);
vsprintf(buf, fmt, ap);
va_end(ap);
if (GENSVM_ERROR_FILE != NULL) {
fputs(buf, GENSVM_ERROR_FILE);
fflush(GENSVM_ERROR_FILE);
}
}
|
