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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
/*
Copyright (C) 2011-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/
/*
WARNING: This file was generated by the dkct program (see
http://dktools.sourceforge.net/ for details).
Changes you make here will be lost if dkct is run again!
You should modify the original source and run dkct on it.
Original source: DkWxCommunicator.cpt
*/
/** @file DkWxCommunicator.h Header file for the DkWxCommunicator module.
*/
#ifndef DKWXCOMMUNICATOR_H_INCLUDED
/** Avoid multiple inclusions. */
#define DKWXCOMMUNICATOR_H_INCLUDED 1
#line 10 "DkWxCommunicator.cpt"
#if 0
ifndef DK4CONF_H_INCLUDED
include "dk4conf.h"
endif
#endif
#ifndef DK3CONF_H_INCLUDED
#include "dk3conf.h"
#endif
#ifndef WX_WXPREC_H_INCLUDED
#include <wx/wxprec.h>
#define WX_WXPREC_H_INCLUDED 1
#endif
#ifdef __BORLANDC__
#pragma hdrstop
#endif
#ifndef WX_PRECOMP
#ifndef WX_WX_H_INCLUDED
#include <wx/wx.h>
#define WX_WX_H_INCLUDED 1
#endif
#endif
/** Synchronized communication between a worker thread and a
progress dialog (ie DkWxProgressDialog).
*/
class DkWxCommunicator
{
protected:
/** Grant access to only one thread at a time to other members.
*/
wxCriticalSection csProtect;
/** Flag: Thread is still running.
*/
int iRunning;
/** Autostart state.
*/
int iAutostart;
/** Flag: Worker thread can continue.
*/
int iCanContinue;
/** String containing all the messages produced by worker thread.
*/
wxString *sMessages;
/** Current file name processed.
*/
wxChar *sFilename;
/** Current gauge value (0-1000).
*/
int iGauge;
/** Flag: Update required.
*/
int iUpdated;
/** Encoding for wxChar.
*/
int wxe;
/** Encoding for dkChar.
*/
int dke;
/** Most significant log level.
*/
int iLogLevelMax;
/** Change file name, set iUpdated if new file name differs from
previous one.
@param newFileName New file name.
@return 1 on success (new file name saved), 0 on error.
*/
int
internalSetFilename(wxChar const *newFileName);
/** Change gauge value, set iUpdated if new value differs
from previous one.
@param newValue New gauge value.
*/
void
internalSetGauge(int newValue);
public:
/** Constructor.
@param we Encoding used for wxChar strings.
@param de Encoding used for dkChar strings.
*/
DkWxCommunicator(int we, int de);
/** Destructor.
*/
~DkWxCommunicator();
/** Check whether the object has set up correctly and is ready to use.
@return 1 if setup is ok, 0 for error.
*/
int
checkSetup() const;
/** Update GUI elements.
@param wDialog Progress dialog.
@param tFilename Static text to show file name.
@param gProgress Progress bar.
@return Or-combination of DK_WX_COMMUNICATOR_STATUS_RUNNING
and DK_WX_COMMUNICATOR_STATUS_UPDATE.
If the thread is no longer running, you can close the progress
dialog. If there was an update to file name or progress bar
value you need to call Refresh() and Update().
*/
int
getUpdates(
wxWindow *wDialog,
wxStaticText *tFilename,
wxGauge *gProgress
);
/** Set new file name and gauge value, may be used by a worker thread.
@param fn New file name.
@param nv New gauge value.
@return 1 on success, 0 on error.
*/
int
setUpdates(wxChar const *fn, int nv);
/** Update gauge value only, leave file name untouched.
@param nv New gauge value.
*/
void
updateGauge(int nv);
/** Set text to text control.
@param tc Text control to use for log messages from
worker thread.
*/
void
getText(
wxTextCtrl *tc
);
/** Prepare to run a worker thread.
*/
void
prepareRun();
/** Set can-continue flag.
@param nv New flag value (1=can continue, 0=must stop).
Set to 0 if a "Cancel" button was pressed in the
progress dialog.
*/
void
setCanContinue(int nv);
/** Get can-continue flag, used by the worker thread to react
on "Cancel" button.
@return 1 on success (can continue), 0 on error (cancel button pressed).
*/
int
getCanContinue();
/** Set iRunning.
A worker thread uses setRunning(0) to inidicate it is finished.
@param nv New iRunning value.
*/
void
setRunning(int nv);
/** Check whether the thread is still running.
@return 1 for thread still running, 0 for thread finished.
*/
int
getRunning();
/** Enable/disable autostart job.
@param nv New autostart flag.
*/
void
autostartEnable(bool nv = true);
/** Check whether we can run an autostart job.
On success we change the internal autostart variable to indicate
that an autostart job is currently running.
@return 1 to run autostart job, 0 otherwise.
*/
int
autostartCanRun();
/** Mark autostart job as finished. This is typically invoked
at the end of the autostart worker thread.
*/
void
autostartSetFinished();
/** Check whether the autostart job is completed so we can close the
window.
@return 1 to close the window, 0 otherwise.
*/
int
autostartIsFinished();
/** Add text to log messages string.
@param t Text to add.
*/
void
addWxText(wxChar const *t);
/** Add text to log messages string.
@param t Text to add.
*/
void
addDkText(dkChar const * t);
/** Add text to log messages string.
@param t Text to add.
*/
void
addCharText(char const *t);
/** Add newline to log messages string.
*/
void
nl();
/** Set most significant log level.
@param nv Log level occured.
*/
void
setLogLevel(int nv);
/** Retrieve most significant log level.
@return Log level.
*/
int
getLogLevel();
/** Retrieve autostart information.
@return Current iAutostart value.
*/
int
autostartGet();
/** Get current messages text.
@return Current text stored.
*/
wxString getText();
};
/** Status: Thread is still running.
*/
#define DK_WX_COMMUNICATOR_STATUS_RUNNING 1
/** Status: Thread updated data since last request.
*/
#define DK_WX_COMMUNICATOR_STATUS_UPDATE 2
#endif
|