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
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
|
/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program 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 2
* of the License, or (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef GARGOYLE_WINDOWS_H
#define GARGOYLE_WINDOWS_H
#include "common/array.h"
#include "common/list.h"
#include "common/rect.h"
#include "graphics/screen.h"
#include "gargoyle/draw.h"
#include "gargoyle/events.h"
#include "gargoyle/glk_types.h"
#include "gargoyle/fonts.h"
#include "gargoyle/picture.h"
#include "gargoyle/streams.h"
#include "gargoyle/window_mask.h"
namespace Gargoyle {
class Window;
class PairWindow;
#define HISTORYLEN 100
#define SCROLLBACK 512
#define TBLINELEN 300
/**
* Main windows manager
*/
class Windows {
friend class Window;
public:
class iterator {
private:
Window *_current;
public:
/**
* Constructor
*/
iterator(Window *start) : _current(start) {}
/**
* Dereference
*/
Window *operator*() const { return _current; }
/**
* Move to next
*/
iterator &operator++();
/**
* Equality test
*/
bool operator==(const iterator &i) { return _current == i._current; }
/**
* Inequality test
*/
bool operator!=(const iterator &i) { return _current != i._current; }
};
private:
Graphics::Screen *_screen;
Window * _windowList; ///< List of all windows
Window *_rootWin; ///< The topmost window
Window *_focusWin; ///< The window selected by the player
bool _moreFocus;
bool _claimSelect;
WindowMask *_mask;
private:
/**
* Create a new window
*/
Window *newWindow(glui32 type, glui32 rock);
/**
* Create a new pair window
*/
PairWindow *newPairWindow(glui32 method, Window *key, glui32 size);
/**
* Rearrange windows
*/
void rearrange();
public:
static bool _overrideReverse;
static bool _overrideFgSet;
static bool _overrideBgSet;
static bool _forceRedraw;
static int _overrideFgVal;
static int _overrideBgVal;
static int _zcolor_fg, _zcolor_bg;
static byte _zcolor_LightGrey[3];
static byte _zcolor_Foreground[3];
static byte _zcolor_Background[3];
static byte _zcolor_Bright[3];
static byte *rgbShift(byte *rgb);
public:
/**
* Constructor
*/
Windows(Graphics::Screen *screen);
/**
* Destructor
*/
~Windows();
/**
* Open a new window
*/
Window *windowOpen(Window *splitwin, glui32 method, glui32 size,
glui32 wintype, glui32 rock);
/**
* Return the root window
*/
Window *getRoot() const { return _rootWin; }
/**
* Gets the focused window
*/
Window *getFocusWindow() const { return _focusWin; }
/**
* Setst the focused window
*/
void setFocus(Window *win) { _focusWin = win; }
void clearSelection();
void selectionChanged();
void clearClaimSelect() { _claimSelect = false; }
void redraw();
/**
* Repaint an area of the windows
*/
void repaint(const Common::Rect &box);
/**
* Draw an area of the windows
*/
void drawRect(int x0, int y0, int w, int h, const byte *rgb);
/**
* Get an iterator that will move over the tree
*/
iterator begin() { return iterator(_windowList); }
/**
* Returns the end point of window iteration
*/
iterator end() { return iterator(nullptr); }
/**
* Gets a hyperlink
*/
glui32 getHyperlink(const Common::Point &pos) { return _mask->getHyperlink(pos); }
/**
* Sets a hyperlink
*/
void setHyperlink(glui32 linkval, uint x0, uint y0, uint x1, uint y1) {
return _mask->putHyperlink(linkval, x0, y0, x1, y1);
}
};
/**
* Window styles
*/
struct WindowStyle {
FACES font;
byte bg[3];
byte fg[3];
int reverse;
};
/**
* Window attributes
*/
struct Attributes {
unsigned fgset : 1;
unsigned bgset : 1;
unsigned reverse : 1;
unsigned : 1;
unsigned style : 4;
unsigned fgcolor : 24;
unsigned bgcolor : 24;
unsigned hyper : 32;
/**
* Constructor
*/
Attributes() {
clear();
}
/**
* Clear
*/
void clear();
/**
* Set the style
*/
void set(glui32 s) {
clear();
style = s;
}
/**
* Equality comparison
*/
bool operator==(const Attributes &src) {
return fgset == src.fgset && bgset == src.bgset && reverse == src.reverse
&& style == src.style && fgcolor == src.fgcolor && bgcolor == src.bgcolor
&& hyper == src.hyper;
}
byte *attrBg(WindowStyle *styles);
byte *attrFg(WindowStyle *styles);
/**
* Get the font from the attribute's style
*/
FACES attrFont(WindowStyle *styles) const { return styles[style].font; }
};
/**
* Window definition
*/
class Window : public Draw {
public:
Windows *_windows;
glui32 _magicnum;
glui32 _rock;
glui32 _type;
Window *_parent; ///< pair window which contains this one
Window *_next, *_prev; ///< in the big linked list of windows
Common::Rect _bbox;
int _yAdj;
Stream *_stream; ///< the window stream.
Stream *_echoStream; ///< the window's echo stream, if any.
int _lineRequest;
int _lineRequestUni;
int _charRequest;
int _charRequestUni;
int _mouseRequest;
int _hyperRequest;
int _moreRequest;
int _scrollRequest;
int _imageLoaded;
glui32 _echoLineInput;
glui32 *_lineTerminatorsBase;
glui32 _termCt;
Attributes _attr;
byte _bgColor[3];
byte _fgColor[3];
gidispatch_rock_t _dispRock;
protected:
bool checkTerminator(glui32 ch);
public:
/**
* Constructor
*/
Window(Windows *windows, uint32 rock);
/**
* Destructor
*/
virtual ~Window();
/**
* Rearranges the window
*/
virtual void rearrange(const Common::Rect &box) { _bbox = box; }
/**
* Get window split size within parent pair window
*/
virtual glui32 getSplit(glui32 size, bool vertical) const { return 0; }
/**
* Write a character
*/
virtual void putChar(unsigned char ch) {}
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) {}
/**
* Unput a unicode character
*/
virtual bool unputCharUni(uint32 ch) { return false; }
/**
* Write a buffer
*/
virtual void putBuffer(const unsigned char *buf, size_t len) {}
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) {}
/**
* Move the cursor
*/
virtual void moveCursor(const Common::Point &newPos) {}
/**
* Clear the window
*/
virtual void clear() {}
/**
* Click the window
*/
virtual void click(const Common::Point &newPos) {}
/**
* Prepare for inputing a line
*/
virtual void requestLineEvent(char *buf, glui32 maxlen, glui32 initlen);
/**
* Prepare for inputing a line
*/
virtual void requestLineEventUni(glui32 *buf, glui32 maxlen, glui32 initlen);
/**
* Cancel an input line event
*/
virtual void cancelLineEvent(Event *ev);
/**
* Cancel a mouse event
*/
virtual void cancelMouseEvent() {}
/**
* Cancel a hyperlink event
*/
virtual void cancelHyperlinkEvent() {}
/**
* Redraw the window
*/
virtual void redraw();
};
typedef Window *winid_t;
/**
* Blank window
*/
class BlankWindow : public Window {
public:
/**
* Constructor
*/
BlankWindow(Windows *windows, uint32 rock);
};
/**
* Text Grid window
*/
class TextGridWindow : public Window {
/**
* Structure for a row within the grid window
*/
struct TextGridRow {
Common::Array<uint32> _chars;
Common::Array<Attributes> _attrs;
bool dirty;
/**
* Constructor
*/
TextGridRow() : dirty(false) {}
/**
* Resize the row
*/
void resize(size_t newSize);
};
typedef Common::Array<TextGridRow> TextGridRows;
private:
/**
* Mark a given text row as modified
*/
void touch(int line);
void acceptReadChar(glui32 arg);
/**
* Return or enter, during line input. Ends line input.
*/
void acceptLine(glui32 keycode);
/**
* Any regular key, during line input.
*/
void acceptReadLine(glui32 arg);
public:
int _width, _height;
TextGridRows _lines;
int _curX, _curY; ///< the window cursor position
///< for line input
void *_inBuf; ///< unsigned char* for latin1, glui32* for unicode
int _inOrgX, _inOrgY;
int _inMax;
int _inCurs, _inLen;
Attributes _origAttr;
gidispatch_rock_t _inArrayRock;
glui32 *_lineTerminators;
WindowStyle styles[style_NUMSTYLES]; ///< style hints and settings
public:
/**
* Constructor
*/
TextGridWindow(Windows *windows, uint32 rock);
/**
* Destructor
*/
virtual ~TextGridWindow();
/**
* Rearranges the window
*/
virtual void rearrange(const Common::Rect &box) override;
/**
* Get window split size within parent pair window
*/
virtual glui32 getSplit(glui32 size, bool vertical) const override;
/**
* Write a character
*/
virtual void putChar(unsigned char ch) override;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) override;
/**
* Unput a unicode character
*/
virtual bool unputCharUni(uint32 ch) override;
/**
* Write a buffer
*/
virtual void putBuffer(const unsigned char *buf, size_t len) override;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) override;
/**
* Move the cursor
*/
virtual void moveCursor(const Common::Point &newPos) override;
/**
* Clear the window
*/
virtual void clear() override;
/**
* Click the window
*/
virtual void click(const Common::Point &newPos) override;
/**
* Prepare for inputing a line
*/
virtual void requestLineEvent(char *buf, glui32 maxlen, glui32 initlen) override;
/**
* Prepare for inputing a line
*/
virtual void requestLineEventUni(glui32 *buf, glui32 maxlen, glui32 initlen) override;
/**
* Cancel an input line event
*/
virtual void cancelLineEvent(Event *ev) override;
/**
* Cancel a mouse event
*/
virtual void cancelMouseEvent() override { _mouseRequest = false; }
/**
* Cancel a hyperlink event
*/
virtual void cancelHyperlinkEvent() override { _hyperRequest = false; }
/**
* Redraw the window
*/
virtual void redraw() override;
};
/**
* Text Buffer window
*/
class TextBufferWindow : public Window {
/**
* Structure for a row within the window
*/
struct TextBufferRow {
Common::Array<uint32> chars;
Common::Array<Attributes> attr;
int len, newline;
bool dirty, repaint;
Picture *lpic, *rpic;
glui32 lhyper, rhyper;
int lm, rm;
/**
* Constructor
*/
TextBufferRow();
/**
* Resize the row
*/
void resize(size_t newSize);
};
typedef Common::Array<TextBufferRow> TextBufferRows;
private:
void reflow();
void touchScroll();
bool putPicture(Picture *pic, glui32 align, glui32 linkval);
void putTextUni(const glui32 *buf, int len, int pos, int oldlen);
void flowBreak();
/**
* Mark a given text row as modified
*/
void touch(int line);
public:
int _width, _height;
int _spaced;
int _dashed;
TextBufferRows _lines;
int _scrollBack;
int _numChars; ///< number of chars in last line: lines[0]
glui32 *_chars; ///< alias to lines[0].chars
Attributes *_attrs; ///< alias to lines[0].attrs
///< adjust margins temporarily for images
int _ladjw;
int _ladjn;
int _radjw;
int _radjn;
/* Command history. */
glui32 *_history[HISTORYLEN];
int _historyPos;
int _historyFirst, _historyPresent;
/* for paging */
int _lastSeen;
int _scrollPos;
int _scrollMax;
/* for line input */
void *_inBuf; ///< unsigned char* for latin1, glui32* for unicode
int _inMax;
long _inFence;
long _inCurs;
Attributes _origAttr;
gidispatch_rock_t _inArrayRock;
glui32 _echoLineInput;
glui32 *_lineTerminators;
/* style hints and settings */
WindowStyle styles[style_NUMSTYLES];
/* for copy selection */
glui32 *_copyBuf;
int _copyPos;
public:
/**
* Constructor
*/
TextBufferWindow(Windows *windows, uint32 rock);
/**
* Destructor
*/
virtual ~TextBufferWindow();
/**
* Rearranges the window
*/
virtual void rearrange(const Common::Rect &box) override;
/**
* Get window split size within parent pair window
*/
virtual glui32 getSplit(glui32 size, bool vertical) const override;
/**
* Write a character
*/
virtual void putChar(unsigned char ch) override;
/**
* Write a unicode character
*/
virtual void putCharUni(uint32 ch) override;
/**
* Unput a unicode character
*/
virtual bool unputCharUni(uint32 ch) override;
/**
* Write a buffer
*/
virtual void putBuffer(const unsigned char *buf, size_t len) override;
/**
* Write a unicode character
*/
virtual void putBufferUni(const uint32 *buf, size_t len) override;
/**
* Move the cursor
*/
virtual void moveCursor(const Common::Point &newPos) override;
/**
* Clear the window
*/
virtual void clear() override;
/**
* Prepare for inputing a line
*/
virtual void requestLineEvent(char *buf, glui32 maxlen, glui32 initlen) override;
/**
* Prepare for inputing a line
*/
virtual void requestLineEventUni(glui32 *buf, glui32 maxlen, glui32 initlen) override;
/**
* Cancel an input line event
*/
virtual void cancelLineEvent(Event *ev) override;
/**
* Cancel a hyperlink event
*/
virtual void cancelHyperlinkEvent() override { _hyperRequest = false; }
/**
* Redraw the window
*/
virtual void redraw() override;
};
/**
* Graphics window
*/
class GraphicsWindow : public Window {
private:
void touch();
public:
unsigned char _bgnd[3];
bool _dirty;
glui32 _w, _h;
Graphics::ManagedSurface *_surface;
public:
/**
* Constructor
*/
GraphicsWindow(Windows *windows, uint32 rock);
/**
* Destructor
*/
virtual ~GraphicsWindow();
/**
* Rearranges the window
*/
virtual void rearrange(const Common::Rect &box) override;
/**
* Get window split size within parent pair window
*/
virtual glui32 getSplit(glui32 size, bool vertical) const override {
return size;
}
/**
* Cancel a mouse event
*/
virtual void cancelMouseEvent() override { _mouseRequest = false; }
/**
* Cancel a hyperlink event
*/
virtual void cancelHyperlinkEvent() override { _hyperRequest = false; }
/**
* Redraw the window
*/
virtual void redraw() override;
/**
* Get the window dimensions
*/
void getSize(glui32 *w, glui32 *h) {
*w = _w;
*h = _h;
}
};
/**
* Pair window
*/
class PairWindow : public Window {
public:
Window *_child1, *_child2;
/* split info... */
glui32 _dir; ///< winmethod_Left, Right, Above, or Below
bool _vertical, _backward; ///< flags
glui32 _division; ///< winmethod_Fixed or winmethod_Proportional
Window *_key; ///< NULL or a leaf-descendant (not a Pair)
int _keyDamage; ///< used as scratch space in window closing
glui32 _size; ///< size value
glui32 _wBorder; ///< winMethod_Border, NoBorder
public:
/**
* Constructor
*/
PairWindow(Windows *windows, glui32 method, Window *key, glui32 size);
/**
* Rearranges the window
*/
virtual void rearrange(const Common::Rect &box) override;
/**
* Redraw the window
*/
virtual void redraw() override;
};
} // End of namespace Gargoyle
#endif
|