summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxHelpController.cpt
blob: 431202061f0563f8b93988cbaa3104dff640c2d4 (plain)
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd


%%	header

/**	@file	Dk4WxHelpController.h	Help controller class.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.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
#ifndef WX_CONFIG_H_INCLUDED
#include <wx/config.h>
#define	WX_CONFIG_H_INCLUDED 1
#endif
#ifndef WX_FILENAME_H_INCLUDED
#include <wx/filename.h>
#define	WX_FILENAME_H_INCLUDED 1
#endif
#ifndef WX_HELP_H_INCLUDED
#include <wx/help.h>
#define	WX_HELP_H_INCLUDED 1
#endif
#ifndef WX_FS_ZIP_H_INCLUDED
#include <wx/fs_zip.h>
#define	WX_FS_ZIP_H_INCLUDED 1
#endif
#ifndef WX_THREAD_H_INCLUDED
#include <wx/thread.h>
#define	WX_THREAD_H_INCLUDED 1
#endif

#ifndef DK4WXAPPLICATIONHELPER_H_INCLUDED
#include "Dk4WxApplicationHelper.h"
#endif


/**	Help controller dealing with both CHM and HTB files.
*/
class Dk4WxHelpController
{
  protected:

    /**	Synchronized access.
    */
    wxCriticalSection		 csProtect;

#ifdef __WXMSW__
    /**	Help controller for CHM files used on Windows.
    */
    wxCHMHelpController		 oHelpController;
#else
    /**	Help controller for HTB files used on non-Windows systems.
    */
    wxHtmlHelpController	 oHelpController;
#endif

    /**	Application helper, used for for search.
    */
    Dk4WxApplicationHelper	*pAppHelp;

    /**	Short file name of help file.
    */
    dkChar			*pdksShortFileName;

    /**	Flag: Contents was already loaded.
    */
    bool			 bLoaded;

    /**	Flag: Help file was found.
    */
    bool			 bFileFound;

  protected:

    /**	Attempt to load the help file.
    */
    void
    AttemptToLoadFile(void);

    /**	Show error message.
    */
    void
    ShowErrorMessage(size_t i_title = 0, size_t i_text = 1);

  public:

    /**	Default constructor.
	Just set the pointers to NULL.
    */
    Dk4WxHelpController();

    /**	Destructor.
    */
    ~Dk4WxHelpController();

    /**	Initialize the controller (keep pointers).
	@param	ahptr	Application helper for file search.
	@param	chmName	CHM help file name for windows.
	@param	htbName	HTB help file name for other systems.
	@return	True on success, false on error.
    */
    bool
    Initialize(
      Dk4WxApplicationHelper	*ahptr,
      const dkChar		*chmName,
      const dkChar		*htbName
    );

    /**	Clean up.
    */
    void
    Cleanup(void);

    /**	Open help system.
    */
    void
    DisplayContents(void);
    
    /**	Open help section specified by name.
	@param	name	Section name.
    */
    void
    DisplaySection(wxString const & name);

    /**	Open a help section specified by number.
	@param	number	Section number (context ID).
    */
    void
    DisplaySection(int number);

};

%%	module

#include "dk4strd.h"
#include "dk4strx.h"
#include "dk4fs.h"
#include "dk4mem.h"
#include "dk4mpl.h"
#include "Dk4WxHelpController.h"



$!trace-include



static const wxChar * const	dk4wxhc_kw_def[] = {
$!string-table	macro=wxT
Help file not found
The file containing online help text was not found on your computer!
$!end
};



Dk4WxHelpController::Dk4WxHelpController()
#ifdef __WXMSW__

#else
: oHelpController(wxHF_DEFAULT_STYLE | wxHF_MERGE_BOOKS)
#endif
{
  pAppHelp = NULL;
  pdksShortFileName = NULL;
  bLoaded = false;
  bFileFound = false;
}



Dk4WxHelpController::~Dk4WxHelpController()
{
  dk4mem_release(pdksShortFileName);
  pAppHelp = NULL;
  bLoaded = false;
  bFileFound = false;
}



bool
Dk4WxHelpController::Initialize(
  Dk4WxApplicationHelper	*ahptr,
  const dkChar			*chmName,
  const dkChar			*htbName
)
{
  const dkChar	*fn	= NULL;
  bool		 back	= false;
#ifdef __WXMSW__
  fn = chmName;
#else
  fn = htbName;
#endif
  if ((NULL != ahptr) && (NULL != fn)) {
    pAppHelp = ahptr;
    bLoaded = false;
    bFileFound = false;
    pdksShortFileName = dk4str_dup(fn, NULL);
    if (NULL != pdksShortFileName) {
      back = true;
    } else {
      /* ERROR: Memory */
      ShowErrorMessage(6, 7);
    }
  } else {
    /* ERROR: Illegal arguments to function */
    ShowErrorMessage(6, 8);
  }
  return back;
}



void
Dk4WxHelpController::Cleanup(void)
{
  {
    wxCriticalSectionLocker	lock(csProtect);
    dk4mem_release(pdksShortFileName);
    pAppHelp = NULL;
    bLoaded = false;
    bFileFound = false;
  }
}



void
Dk4WxHelpController::AttemptToLoadFile(void)
{
  wxChar	fnb[DK4_MAX_PATH];
  size_t	szfnb	= DK4_SIZEOF(fnb,wxChar);

  if (!bLoaded) {
    bLoaded = true;
    if ((NULL != pAppHelp) && (NULL != pdksShortFileName)) {
      if (pAppHelp->FindDataFile(fnb, szfnb, pdksShortFileName)) {
        bFileFound = true;
#ifdef __WXMSW__
	oHelpController.Initialize(fnb);
#else
	oHelpController.AddBook(fnb);
#endif
      }
    }
  }
}



void
Dk4WxHelpController::ShowErrorMessage(size_t i_title, size_t i_text)
{
  const wxChar	*strTitle	= NULL;
  const wxChar	*strText	= NULL;
  {
    wxCriticalSectionLocker	lock(csProtect);
    if (NULL != pAppHelp) {
      strTitle = pAppHelp->GetBasicString(i_title);
      strText  = pAppHelp->GetBasicString(i_text);
    }
  }
  if (NULL == strTitle) {
    strTitle = dk4wxhc_kw_def[i_title];
  }
  if (NULL == strText) {
    strText  = dk4wxhc_kw_def[i_text];
  }
  wxMessageBox(strText, strTitle, (wxOK | wxCENTRE | wxICON_ERROR));
}



void
Dk4WxHelpController::DisplayContents()
{
  bool	canOpenHelp	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    AttemptToLoadFile();
    if (bLoaded) {
      if (bFileFound) {
        canOpenHelp = true;
      }
    }
  }
  if (canOpenHelp) {
    oHelpController.DisplayContents();
  } else {
    ShowErrorMessage();
  }
}



void
Dk4WxHelpController::DisplaySection(wxString const & name)
{
  bool	canOpenHelp	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    AttemptToLoadFile();
    if (bLoaded) {
      if (bFileFound) {
        canOpenHelp = true;
      }
    }
  }
  if (canOpenHelp) {
    oHelpController.DisplaySection(name);
  } else {
    ShowErrorMessage();
  }
}



void
Dk4WxHelpController::DisplaySection(int number)
{
  bool	canOpenHelp	= false;
  {
    wxCriticalSectionLocker	lock(csProtect);
    AttemptToLoadFile();
    if (bLoaded) {
      if (bFileFound) {
        canOpenHelp = true;
      }
    }
  }
  if (canOpenHelp) {
    oHelpController.DisplaySection(number);
  } else {
    ShowErrorMessage();
  }
}