summaryrefslogtreecommitdiff
path: root/support/dktools/Dk4WxFrame.cpt
blob: 32daba6bf9abfd2773dc187bdcc4b8def56dc1b7 (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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
SPDX-License-Identifier:	BSD-3-Clause


%%	header

/**	@file	Dk4WxFrame.h	Base class for top level frames.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#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 DK4WXAPPLICATIONHELPER_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "Dk4WxApplicationHelper.h"
#else
#include <dktools-4/Dk4WxApplicationHelper.h>
#endif
#endif

#ifndef	DK4WXHELPCONTROLLER_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "Dk4WxHelpController.h"
#else
#include <dktools-4/Dk4WxHelpController.h>
#endif
#endif



/**	Frame (top level window).
*/
class Dk4WxFrame : public wxFrame
{
  protected:

    /**	Application helper.
    */
    Dk4WxApplicationHelper	*pAppHelp;

    /**	Help controller for online help.
    */
    Dk4WxHelpController		*pHelp;

    /**	Application name.
    */
    wxString			 sAppName;


    /**	Synchronize access to iInstances.
    */
    static wxCriticalSection	 csInstances;

    /**	Number of instances.
    */
    static int			 iInstances;

  public:

    /**	Constructor.
	@param	appName		Application name.
	@param	appHelper	Application helper.
	@param	helpController	Help controller.
	@param	wxid		Window ID.
    */
    Dk4WxFrame(
      const wxString	&	 appName,
      Dk4WxApplicationHelper	*appHelper,
      Dk4WxHelpController	*helpController,
      int			 wxid
    );

    /**	Restore previously saved window position.
    */
    void
    RestorePosition(void);

    /**	Handler for close event.
	@param	event	Event to process.
    */
    void
    OnClose(wxCloseEvent & event);

    /**	Decide whether we can close the frame.
	@param	isFinal	Flag: Final frame.
	@return	True to close the frame, false to keep it.
    */
    virtual
    bool
    CanClose(bool isFinal);


    /**	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);

    /**	Find data file and launch default application
    	or web browser on it.
	@param	fn		File name to search for and use.
	@param	bIsHelp		Flag: File is a help file.
	@param	bVerbose	Flag: Show diagnostics on errors.
	@return	Success indicator.
    */
    bool
    FindFileAndLaunch(
    	dkChar const	*fn,
	bool		 bIsHelp	= false,
	bool		 bVerbose	= false
    );

  protected:

    /**	Save current window position.
    */
    void
    SavePosition(void);

};



%%	module


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

#ifndef	DK4WXFRAME_H_INCLUDED
#include "Dk4WxFrame.h"
#endif

#ifndef	DK4MPL_H_INCLUDED
#include "dk4mpl.h"
#endif

#ifndef	DK4MEM_H_INCLUDED
#include "dk4mem.h"
#endif

#ifndef	DK4STRD_H_INCLUDED
#include "dk4strd.h"
#endif

#ifndef	DK4PATHD_H_INCLUDED
#include "dk4pathd.h"
#endif

#ifndef	DK4STRX_H_INCLUDED
#include "dk4strx.h"
#endif

#ifndef	DK4RECWX_H_INCLUDED
#include "dk4recwx.h"
#endif


$!trace-include




/**	Protection for number of instances.
*/
wxCriticalSection	Dk4WxFrame::csInstances;



/**	Number of instances.
*/
int			Dk4WxFrame::iInstances = 0;



/**	Keywords to save and restore window size and position.
*/
static const wxChar * const	dk4wxframe_kw_size[] = {
$!string-table	macro=wxT
window.x
window.y
window.w
window.h
window.maximized
window.iconized
$!end
};



/**	Keywords to restore maximized and iconized state.
*/
static const wxChar * const	dk4wxframe_kw_restore[] = {
$!string-table	macro=wxT
window.restore-maximized
window.restore-iconized
window.restore-size
$!end
};



/**	File name suffixes indicating to open file in web browser.
*/
static const wxChar * const	dk4wxframe_suffix_web[] = {
$!string-table	macro=wxT
.html
.htm
$!end
};



/**	Static text fragments, not localized.
*/
static const wxChar * const	dk4wxframe_kwnl_wx[] = {
$!string-table	macro=wxT
#
#	0	URL suffix for local files.
#
file://
$!end
};



Dk4WxFrame::Dk4WxFrame(
  const wxString	&	 appName,
  Dk4WxApplicationHelper	*appHelper,
  Dk4WxHelpController		*helpController,
  int				 wxid
)
: wxFrame(NULL, wxid, appName)
{
  pAppHelp = appHelper;
  pHelp    = helpController;
  sAppName = appName;
  {
    wxCriticalSectionLocker	lock(csInstances);
    iInstances++;
  }
  Connect(wxid, wxEVT_CLOSE_WINDOW, wxCloseEventHandler(Dk4WxFrame::OnClose));
}



void
Dk4WxFrame::OnClose(wxCloseEvent & event)
{
  bool		doClose = true;
  bool		isFinal	= false;
  bool		savePos	= false;

  {
    wxCriticalSectionLocker	lock(csInstances);
    if (1 == iInstances) {
      isFinal = true;
    }
  }
  if (event.CanVeto()) {
    doClose = CanClose(isFinal);
  } else {
    (void)CanClose(isFinal);
  }
  if (doClose) {
    {
      wxCriticalSectionLocker	lock(csInstances);
      if (1 == iInstances--) { savePos = true; }
    }
    if (savePos) {
      SavePosition();
    }
    event.Skip();
  } else {
    event.Veto();
  }
}



bool
Dk4WxFrame::CanClose(bool WXUNUSED(isFinal))
{
  return true;
}


void
Dk4WxFrame::SavePosition(void)
{
  int	iv[6];
  $? "+ Dk4WxFrame::SavePosition"
  if (NULL != pAppHelp) {
    iv[4] = iv[5] = 0;
    if (IsIconized()) {
      iv[5] = 1;
      Iconize(false);
    }
    if (IsMaximized()) {
      iv[4] = 1;
      Maximize(false);
    }
    GetPosition(&(iv[0]), &(iv[1]));
    GetSize(&(iv[2]), &(iv[3]));
    $? ". saving current size"
    $? ". x = %d", iv[0]
    $? ". y = %d", iv[1]
    $? ". w = %d", iv[2]
    $? ". h = %d", iv[3]
    pAppHelp->SetMultiple(dk4wxframe_kw_size, iv, 6);
  }
  $? "- Dk4WxFrame::SavePosition"
}



void
Dk4WxFrame::RestorePosition(void)
{
  int	iv[6];		/* Values stored in config */
  bool	bv[3];		/* Feature restore: maximized, iconized, position */
  int	x;		/* X position */
  int	y;		/* Y position */
  int	w;		/* Width */
  int	h;		/* Height */

  $? "+ Dk4WxFrame::RestorePosition"

  /*	Restore position by default.
  */
  bv[2] = true;

  /* Initialize variables.
  */
  iv[0] = iv[1] = -1;
  iv[2] = iv[3] = iv[4] = iv[5] = 0;
  bv[0] = bv[1] = false;

  /*	Retrieve stored values if found.
  */
  if (NULL != pAppHelp) {
    pAppHelp->GetMultiple(dk4wxframe_kw_size, iv, 6);
    $? ". iv[0] = %d", iv[0]
    $? ". iv[1] = %d", iv[1]
    $? ". iv[2] = %d", iv[2]
    $? ". iv[3] = %d", iv[3]
    $? ". iv[4] = %d", iv[4]
    $? ". iv[5] = %d", iv[5]
    pAppHelp->GetMultiple(dk4wxframe_kw_restore, bv, 3);
    $? ". bv[0] = %d", (bv[0] ? 1 : 0)
    $? ". bv[1] = %d", (bv[1] ? 1 : 0)
    $? ". bv[2] = %d", (bv[2] ? 1 : 0)
  }

  /*	Find size if not stored.
  */
  GetSize(&w, &h);
  x = iv[0];
  y = iv[1];
  $? ". x = %d", x
  $? ". y = %d", y
  $? ". w = %d", w
  $? ". h = %d", h

  /*	Correct size if size restoration wanted, increase if necessary.
  */
  if (bv[2]) {	$? ". bv[2]"
    if (iv[2] > w) {
      w = iv[2];	$? ". w = %d", w
    }
    if (iv[3] > h) {
      h = iv[3];	$? ". h = %d", h
    }
  }

  /*	Correct values, no parts of window should be outside screen.
  */
  Dk4WxApplicationHelper::CorrectPosition(x, y, w, h);
  $? ". x = %d", x
  $? ". y = %d", y
  $? ". w = %d", w
  $? ". h = %d", h

  /*	Set position and optionally size.
  */
  if (bv[2]) {	$? ". bv[2] active -> restore position and size"
    SetSize(x, y, w, h);
#if wxCHECK_VERSION(3,0,0)
    {
      int t1 = 0;
      int t2 = 0;
      GetSize(&t1, &t2);
      if ((t1 > w) || (t2 > h)) {	$? ". correction required"
        if (t1 > w) {
	  w = w - (t1 - w);		$? ". width correction required"
	}
	if (t2 > h) {
	  h = h - (t2 - h);		$? ". height correction required"
	}				$? ". doing correction"
	SetSize(x, y, w, h);
	GetSize(&t1, &t2);
	$? ". width now %d", t1
	$? ". height now %d", t2
      }
    }
#endif
  } else {	$? ". bv[2] not active -> restore position only"
    SetPosition( wxPoint(x,y) );
  }

  /*	Restore maximized or iconized state if required.
  */
  if (bv[0]) {	$? ". bv[0] active -> maximize window"
    Maximize(0 != iv[4]);
  }
#if TRACE_DEBUG
  else {	$? ". bv[0] not active"
  }
#endif
  if (bv[1]) {	$? ". bv[1] active -> iconize"
    Iconize(0 != iv[5]);
  }
#if TRACE_DEBUG
  else {	$? ". bv[1] not active"
  }
#endif

  $? "- Dk4WxFrame::RestorePosition"
}



void
Dk4WxFrame::DisplayContents(void)
{
  if (NULL != pHelp) {
    pHelp->DisplayContents();
  }
}


    
void
Dk4WxFrame::DisplaySection(wxString const & name)
{
  if (NULL != pHelp) {
    pHelp->DisplaySection(name);
  }
}



void
Dk4WxFrame::DisplaySection(int number)
{
  if (NULL != pHelp) {
    pHelp->DisplaySection(number);
  }
}



bool
Dk4WxFrame::FindFileAndLaunch(dkChar const *fn, bool bIsHelp, bool bVerbose)
{
  wxChar	 bw[2 * DK4_MAX_PATH];		/* Full path in wxChar */
  wxChar	 b2[2 * DK4_MAX_PATH];
  dkChar	 b1[DK4_MAX_PATH];		/* Search result (full path) */
  wxChar const	*psuffix;			/* File name suffix */
  wxChar	*pmod;
  size_t	 szb1 = DK4_SIZEOF(b1,dkChar);	/* Size of b1 (num of dkChar) */
  size_t	 szb2 = DK4_SIZEOF(b2,wxChar);	/* Size of b2 (num of wxChar) */
  size_t	 szbw = DK4_SIZEOF(bw,wxChar);	/* Size of bw (num of wxChar) */
  int		 res;				/* Operation result */
  int		 de;				/* Destination encoding  */
  int		 se;				/* Source encoding */
  bool		 isweb;				/* Use web browser */
  bool		 done;				/* Successfully done */
  bool		 back;				/* Result */
  $? "+ FindFileAndLaunch \"%!ds\"", fn
  back = false;
  if ((NULL != fn) && (NULL != pAppHelp)) {
    done = false;
    /*
    	Check for absolute path.
	Use absolute path unchanged.
	For a relative path do file search.
    */
    if (0 != dk4path_is_absolute(fn)) {			$? ". absolute path"
      if (0 != dk4str_cpy_s(b1, szb1, fn, NULL)) {	$? ". found"
        done = true;
      }
#if	TRACE_DEBUG
      else {						$? "! buffer too small"
      }
#endif
    }
    else {						$? ". relative path"
      if (bIsHelp) {
        if (pAppHelp->FindHelpFile(b1, szb1, fn)) {	$? ". found"
          done = true;	$? ". file name \"%!ds\"", b1
        }
#if	TRACE_DEBUG
        else {						$? "! not found"
        }
#endif
      }
      else {
        if (pAppHelp->FindDataFile(b1, szb1, fn)) {	$? ". found"
          done = true;	$? ". file name \"%!ds\"", b1
        }
#if	TRACE_DEBUG
        else {						$? "! not found"
        }
#endif
      }
    }
    if (done) {
      done = false;
      de = pAppHelp->GetWxEncoding();
      se = pAppHelp->GetDkEncoding();
      res = dk4recwx_dkchar_to_wxchar(bw, szbw, de, b1, se, NULL);
      if (0 != res) {					$? ". recoding ok"
        isweb = false;	$? ". file name \"%!ws\"", bw
	psuffix = dk4strx_get_path_suffix(bw, NULL);
	if (NULL != psuffix) {				$? ". suffix found"
	  if (0 <= dk4strx_array_index(dk4wxframe_suffix_web, psuffix, 0)) {
	    isweb = true;				$? ". is web"
	  }
	}
	if (isweb) {					$? ". is web"
	  if (::wxLaunchDefaultBrowser(bw)) {
	    done = true;				$? ". launched (1)"
	    back = true;
	  }
	  else {					$? "! not launched (1)"
	    if (0 != dk4strx_cpy_s(b2, szb2, dk4wxframe_kwnl_wx[0], NULL)) {
	      $? ". url prefix"
	      if (0 != dk4strx_cat_s(b2, szb2, bw, NULL)) { $? ". url constr"
	        $? ". file name \"%!ws\"", b2
	        if (::wxLaunchDefaultBrowser(bw)) {	$? ". launched (2)"
		  done = true;
		  back = true;
		}
		else {					$? "! not launched (2)"
		  pmod = &(b2[dk4strx_len(dk4wxframe_kwnl_wx[0])]);
		  while (wxT('\0') != *pmod) {
		    if (wxT('\\') == *pmod) { *pmod = wxT('/'); }
		    pmod++;
		  }			$? ". url corrected \"%!ws\"", b2
		  $? ". file name \"%!ws\"", b2
		  if (::wxLaunchDefaultBrowser(bw)) {
		    done = true;			$? ". launched (3)"
		    back = true;
		  }
#if	TRACE_DEBUG
		  else {				$? "! no launched (3)"
		  }
#endif
		}
	      }
	      else {					$? "! url construction"
	        /* ##### ERROR: BUG */
	      }
	    }
	    else {					$? "! url prefix"
	      /* ##### ERROR: BUG */
	    }
	  }
	}
	if (!(done)) {					$? ". try application"
#if	wxCHECK_VERSION(3,0,0)
	  if (::wxLaunchDefaultApplication(bw)) {	$? ". launched (4)"
	    done = true;
	    back = true;
	  }
#if	TRACE_DEBUG
	  else {					$? "! not launched (4)"
	  }
#endif
#endif
	}
	if (!(done)) {
	  /* ERROR: Failed to start application */
	  if (bVerbose) {
	    wxString t;
	    t.Append(pAppHelp->GetBasicString(12));
	    t.Append(bw);
	    t.Append(pAppHelp->GetBasicString(13));
	    ::wxMessageBox(
	      t, pAppHelp->GetBasicString(11), (wxOK | wxCENTRE | wxICON_ERROR)
	    );
	  }
	}
      }
      else {						$? "! recoding"
        /* ERROR: Recoding failed */
	if (bVerbose) {
          ::wxMessageBox(
      	    pAppHelp->GetBasicString(10), pAppHelp->GetBasicString(9),
	    (wxOK | wxCENTRE | wxICON_ERROR)
          );
	}
      }
    }
    else {						$? "! not found"
      /* ERROR: File not found */
      if (bVerbose) {
        ::wxMessageBox(
      	  pAppHelp->GetBasicString(10), pAppHelp->GetBasicString(9),
	  (wxOK | wxCENTRE | wxICON_ERROR)
        );
      }
    }
  }
#if	TRACE_DEBUG
  else {						$? "! args"
  }
#endif
  $? "- FindFileAndLaunch"
  return back;
}