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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/* stdout.c (terminal output) */
/***********************************************************************
* This code is part of GLPK (GNU Linear Programming Kit).
*
* Copyright (C) 2000-2013 Andrew Makhorin, Department for Applied
* Informatics, Moscow Aviation Institute, Moscow, Russia. All rights
* reserved. E-mail: <mao@gnu.org>.
*
* GLPK 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 3 of the License, or
* (at your option) any later version.
*
* GLPK 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 GLPK. If not, see <http://www.gnu.org/licenses/>.
***********************************************************************/
#undef NDEBUG
#include <assert.h>
#include "env.h"
/***********************************************************************
* NAME
*
* glp_puts - write string on terminal
*
* SYNOPSIS
*
* void glp_puts(const char *s);
*
* The routine glp_puts writes the string s on the terminal. */
void glp_puts(const char *s)
{ ENV *env = get_env_ptr();
/* if terminal output is disabled, do nothing */
if (!env->term_out)
goto skip;
/* pass the string to the hook routine, if defined */
if (env->term_hook != NULL)
{ if (env->term_hook(env->term_info, s) != 0)
goto skip;
}
/* write the string on the terminal */
fputs(s, stdout);
fflush(stdout);
/* write the string on the tee file, if required */
if (env->tee_file != NULL)
{ fputs(s, env->tee_file);
fflush(env->tee_file);
}
skip: return;
}
/***********************************************************************
* NAME
*
* glp_printf - write formatted output on terminal
*
* SYNOPSIS
*
* void glp_printf(const char *fmt, ...);
*
* DESCRIPTION
*
* The routine glp_printf uses the format control string fmt to format
* its parameters and writes the formatted output on the terminal. */
void glp_printf(const char *fmt, ...)
{ ENV *env = get_env_ptr();
va_list arg;
/* if terminal output is disabled, do nothing */
if (!env->term_out)
goto skip;
/* format the output */
va_start(arg, fmt);
vsprintf(env->term_buf, fmt, arg);
/* (do not use xassert) */
assert(strlen(env->term_buf) < TBUF_SIZE);
va_end(arg);
/* write the formatted output on the terminal */
glp_puts(env->term_buf);
skip: return;
}
/***********************************************************************
* NAME
*
* glp_vprintf - write formatted output on terminal
*
* SYNOPSIS
*
* void glp_vprintf(const char *fmt, va_list arg);
*
* DESCRIPTION
*
* The routine glp_vprintf uses the format control string fmt to format
* its parameters specified by the list arg and writes the formatted
* output on the terminal. */
void glp_vprintf(const char *fmt, va_list arg)
{ ENV *env = get_env_ptr();
/* if terminal output is disabled, do nothing */
if (!env->term_out)
goto skip;
/* format the output */
vsprintf(env->term_buf, fmt, arg);
/* (do not use xassert) */
assert(strlen(env->term_buf) < TBUF_SIZE);
/* write the formatted output on the terminal */
glp_puts(env->term_buf);
skip: return;
}
/***********************************************************************
* NAME
*
* glp_term_out - enable/disable terminal output
*
* SYNOPSIS
*
* int glp_term_out(int flag);
*
* DESCRIPTION
*
* Depending on the parameter flag the routine glp_term_out enables or
* disables terminal output performed by glpk routines:
*
* GLP_ON - enable terminal output;
* GLP_OFF - disable terminal output.
*
* RETURNS
*
* The routine glp_term_out returns the previous value of the terminal
* output flag. */
int glp_term_out(int flag)
{ ENV *env = get_env_ptr();
int old = env->term_out;
if (!(flag == GLP_ON || flag == GLP_OFF))
xerror("glp_term_out: flag = %d; invalid parameter\n", flag);
env->term_out = flag;
return old;
}
/***********************************************************************
* NAME
*
* glp_term_hook - install hook to intercept terminal output
*
* SYNOPSIS
*
* void glp_term_hook(int (*func)(void *info, const char *s),
* void *info);
*
* DESCRIPTION
*
* The routine glp_term_hook installs a user-defined hook routine to
* intercept all terminal output performed by glpk routines.
*
* This feature can be used to redirect the terminal output to other
* destination, for example to a file or a text window.
*
* The parameter func specifies the user-defined hook routine. It is
* called from an internal printing routine, which passes to it two
* parameters: info and s. The parameter info is a transit pointer,
* specified in the corresponding call to the routine glp_term_hook;
* it may be used to pass some information to the hook routine. The
* parameter s is a pointer to the null terminated character string,
* which is intended to be written to the terminal. If the hook routine
* returns zero, the printing routine writes the string s to the
* terminal in a usual way; otherwise, if the hook routine returns
* non-zero, no terminal output is performed.
*
* To uninstall the hook routine the parameters func and info should be
* specified as NULL. */
void glp_term_hook(int (*func)(void *info, const char *s), void *info)
{ ENV *env = get_env_ptr();
if (func == NULL)
{ env->term_hook = NULL;
env->term_info = NULL;
}
else
{ env->term_hook = func;
env->term_info = info;
}
return;
}
/***********************************************************************
* NAME
*
* glp_open_tee - start copying terminal output to text file
*
* SYNOPSIS
*
* int glp_open_tee(const char *name);
*
* DESCRIPTION
*
* The routine glp_open_tee starts copying all the terminal output to
* an output text file, whose name is specified by the character string
* name.
*
* RETURNS
*
* 0 - operation successful
* 1 - copying terminal output is already active
* 2 - unable to create output file */
int glp_open_tee(const char *name)
{ ENV *env = get_env_ptr();
if (env->tee_file != NULL)
{ /* copying terminal output is already active */
return 1;
}
env->tee_file = fopen(name, "w");
if (env->tee_file == NULL)
{ /* unable to create output file */
return 2;
}
return 0;
}
/***********************************************************************
* NAME
*
* glp_close_tee - stop copying terminal output to text file
*
* SYNOPSIS
*
* int glp_close_tee(void);
*
* DESCRIPTION
*
* The routine glp_close_tee stops copying the terminal output to the
* output text file previously open by the routine glp_open_tee closing
* that file.
*
* RETURNS
*
* 0 - operation successful
* 1 - copying terminal output was not started */
int glp_close_tee(void)
{ ENV *env = get_env_ptr();
if (env->tee_file == NULL)
{ /* copying terminal output was not started */
return 1;
}
fclose(env->tee_file);
env->tee_file = NULL;
return 0;
}
/* eof */
|
