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
|
// This file is part of Golly.
// See docs/License.html for the copyright notice.
#ifndef _WXPREFS_H_
#define _WXPREFS_H_
// Routines for getting, saving and changing user preferences:
void GetPrefs();
// Read preferences from the GollyPrefs file.
void SavePrefs();
// Write preferences to the GollyPrefs file.
bool ChangePrefs(const wxString& page);
// Open a modal dialog so user can change various preferences.
// Returns true if the user hits OK (so client can call SavePrefs).
void ChooseTextEditor(wxWindow* parent, wxString& result);
// Let user select their preferred text editor. The result is the
// path to the application or empty if the user cancels the dialog.
char* ReplaceDeprecatedAlgo(char* algoname);
// If given algo name is deprecated then return replacement name,
// otherwise return same name.
// Global preference data:
extern wxString gollydir; // path of directory containing app
extern wxString datadir; // path of directory for user-specific data
extern wxString tempdir; // path of directory for temporary data
extern wxString rulesdir; // path of directory for app's rule data
extern wxString userrules; // path of directory for user's rule data
extern wxString downloaddir; // path of directory for downloaded data
extern int debuglevel; // for displaying debug info if > 0
extern int mainx; // main window's location
extern int mainy;
extern int mainwd; // main window's size
extern int mainht;
extern bool maximize; // maximize main window?
extern int helpx; // help window's location
extern int helpy;
extern int helpwd; // help window's size
extern int helpht;
extern int helpfontsize; // font size in help window
extern int infox; // info window's location
extern int infoy;
extern int infowd; // info window's size
extern int infoht;
extern int rulex; // rule dialog's location
extern int ruley;
extern int ruleexwd; // rule dialog's extra size
extern int ruleexht;
extern bool showalgohelp; // show algorithm help in rule dialog?
extern char initrule[]; // initial rule
extern bool initautofit; // initial autofit setting
extern bool inithyperspeed; // initial hyperspeed setting
extern bool initshowhashinfo; // initial showhashinfo setting
extern bool showpopulation; // show population counts while generating?
extern bool savexrle; // save RLE file using XRLE format?
extern bool showtips; // show button tips?
extern bool showtool; // show tool bar?
extern bool showlayer; // show layer bar?
extern bool showedit; // show edit bar?
extern bool showallstates; // show all cell states in edit bar?
extern bool showstatus; // show status bar?
extern bool showexact; // show exact numbers in status bar?
extern bool showscrollbars; // show scroll bars?
extern bool showtimeline; // show timeline bar?
extern bool showgridlines; // display grid lines?
extern bool showoverlay; // display the current overlay?
extern bool showicons; // display icons for cell states?
extern bool smartscale; // smarter scaling when zoomed out?
extern bool swapcolors; // swap colors used for cell states?
extern bool scrollpencil; // scroll if pencil cursor is dragged outside view?
extern bool scrollcross; // scroll if cross cursor is dragged outside view?
extern bool scrollhand; // scroll if hand cursor is dragged outside view?
extern bool allowundo; // allow undo/redo?
extern bool restoreview; // should reset/undo restore view?
extern bool allowbeep; // okay to play beep sound?
extern int controlspos; // position of translucent controls
extern int canchangerule; // if > 0 then paste can change rule
extern int randomfill; // random fill percentage
extern int opacity; // percentage opacity of live cells in overlays
extern int tileborder; // width of tiled window borders
extern int mingridmag; // minimum mag to draw grid lines
extern int boldspacing; // spacing of bold grid lines
extern bool showboldlines; // show bold grid lines?
extern bool mathcoords; // show Y values increasing upwards?
extern bool cellborders; // should zoomed cells have borders?
extern bool syncviews; // synchronize viewports?
extern bool synccursors; // synchronize cursors?
extern bool stacklayers; // stack all layers?
extern bool tilelayers; // tile all layers?
extern bool askonnew; // ask to save changes before creating new pattern?
extern bool askonload; // ask to save changes before loading pattern file?
extern bool askondelete; // ask to save changes before deleting layer?
extern bool askonquit; // ask to save changes before quitting app?
extern bool warn_on_save; // warn if saving non-starting generation?
extern int newmag; // mag setting for new pattern
extern bool newremovesel; // new pattern removes selection?
extern bool openremovesel; // opening pattern removes selection?
extern wxCursor* newcurs; // cursor after creating new pattern
extern wxCursor* opencurs; // cursor after opening pattern
extern int mousewheelmode; // 0:Ignore, 1:forward=ZoomOut, 2:forward=ZoomIn
extern int thumbrange; // thumb box scrolling range in terms of view wd/ht
extern int wheelsens; // mouse wheel sensitivity
extern int mindelay; // minimum millisec delay
extern int maxdelay; // maximum millisec delay
extern wxString opensavedir; // directory for Open/Save Pattern dialogs
extern wxString overlaydir; // directory for Save Overlay dialog
extern wxString rundir; // directory for Run Script dialog
extern wxString choosedir; // directory used by Choose File button
extern wxString filedir; // directory used by Show Files
extern wxString texteditor; // path of user's preferred text editor
extern wxString perllib; // name of Perl library (loaded at runtime)
extern wxString pythonlib; // name of Python library (loaded at runtime)
extern int dirwinwd; // width of file directory window
extern bool showfiles; // show file directory?
extern wxMenu* patternSubMenu; // submenu of recent pattern files
extern wxMenu* scriptSubMenu; // submenu of recent script files
extern int numpatterns; // current number of recent pattern files
extern int numscripts; // current number of recent script files
extern int maxpatterns; // maximum number of recent pattern files
extern int maxscripts; // maximum number of recent script files
extern wxArrayString namedrules;
// We maintain an array of named rules, where each string is of the form
// "name of rule|B.../S...". The first string is always "Life|B3/S23".
// Keyboard shortcuts:
// define the actions that can be invoked by various key combinations
typedef enum {
DO_NOTHING = 0, // null action must be zero
DO_OPENFILE, // open a chosen pattern/script/rule/html file
// rest are in alphabetical order (well, almost)
DO_ABOUT, // about Golly
DO_ADD, // add layer
DO_ADVANCEOUT, // advance outside
DO_ADVANCE, // advance selection
DO_AUTOFIT, // auto fit
DO_CHANGE00, // change origin
DO_CLEAROUT, // clear outside
DO_CLEAR, // clear selection
DO_CLONE, // clone layer
DO_COPY, // copy selection
DO_CURSDRAW, // cursor mode: draw
DO_CURSMOVE, // cursor mode: move
DO_CURSPICK, // cursor mode: pick
DO_CURSSEL, // cursor mode: select
DO_CURSIN, // cursor mode: zoom in
DO_CURSOUT, // cursor mode: zoom out
DO_CUT, // cut selection
DO_CURSCYCLE, // cycle cursor mode
DO_PASTELOC, // cycle paste location
DO_PASTEMODE, // cycle paste mode
DO_DELETE, // delete layer
DO_DELOTHERS, // delete other layers
DO_DELOVERLAY, // delete overlay
DO_DELTIME, // delete timeline
DO_DISABLE, // disable undo/redo
DO_DUPLICATE, // duplicate layer
DO_FASTER, // faster
DO_FIT, // fit pattern
DO_FITSEL, // fit selection
DO_FLIPLR, // flip left-right
DO_FLIPTB, // flip top-bottom
DO_FULLSCREEN, // full screen
DO_HYPER, // hyperspeed
DO_INVERT, // invert colors
DO_MIDDLE, // middle
DO_MOVELAYER, // move layer...
DO_NAMELAYER, // name layer...
DO_NEWPATT, // new pattern
DO_NEXTGEN, // next generation
DO_NEXTSTEP, // next step
DO_NEXTHIGHER, // next higher state
DO_NEXTLOWER, // next lower state
DO_OPENCLIP, // open clipboard
DO_OPENPATT, // open pattern...
DO_PASTE, // paste
DO_PASTESEL, // paste to selection
DO_INFO, // pattern info
DO_PLAYBACK, // play timeline backwards
DO_PREFS, // preferences...
DO_QUIT, // quit Golly
DO_RANDFILL, // random fill
DO_REDO, // redo
DO_REMOVESEL, // remove selection
DO_RESET, // reset
DO_RESTORE00, // restore origin
DO_ROTATEACW, // rotate anticlockwise
DO_ROTATECW, // rotate clockwise
DO_RUNCLIP, // run clipboard
DO_RUNSCRIPT, // run script...
DO_SAVEXRLE, // save extended rle
DO_SAVEOVERLAY, // save overlay...
DO_SAVE, // save pattern...
DO_DOWN, // scroll down
DO_LEFT, // scroll left
DO_RIGHT, // scroll right
DO_UP, // scroll up
DO_NE, // scroll NE
DO_NW, // scroll NW
DO_SE, // scroll SE
DO_SW, // scroll SW
DO_SELALL, // select all
DO_SETBASE, // set base step...
DO_FILEDIR, // set file folder...
DO_SETGEN, // set generation...
DO_SETCOLORS, // set layer colors...
DO_SETRULE, // set rule...
DO_SCALE1, // set scale 1:1
DO_SCALE2, // set scale 1:2
DO_SCALE4, // set scale 1:4
DO_SCALE8, // set scale 1:8
DO_SCALE16, // set scale 1:16
DO_SCALE32, // set scale 1:32
DO_SHOWSTATES, // show all states
DO_SHOWICONS, // show cell icons
DO_SHOWEDIT, // show edit bar
DO_SHOWEXACT, // show exact numbers
DO_SHOWFILES, // show files
DO_SHOWGRID, // show grid lines
DO_HASHINFO, // show hash info
DO_HELP, // show help
DO_SHOWLAYER, // show layer bar
DO_SHOWOVERLAY, // show overlay
DO_SHOWPOP, // show population
DO_SHOWSCROLL, // show scroll bars
DO_SHOWSTATUS, // show status bar
DO_SHOWTIME, // show timeline
DO_TIMING, // show timing
DO_SHOWTOOL, // show tool bar
DO_SHRINKFIT, // shrink and fit
DO_SHRINK, // shrink selection
DO_SLOWER, // slower
DO_SMARTSCALE, // smarter scaling
DO_STACK, // stack layers
DO_STARTSTOP, // start/stop generating
DO_RECORD, // start/stop recording
DO_SYNCCURS, // synchronize cursors
DO_SYNCVIEWS, // synchronize views
DO_TILE, // tile layers
DO_UNDO, // undo
DO_HASHING, // use hashing
DO_ZOOMIN, // zoom in
DO_ZOOMOUT, // zoom out
MAX_ACTIONS
} action_id;
typedef struct {
action_id id; // one of the above
wxString file; // non-empty if id is DO_OPENFILE
} action_info;
action_info FindAction(int key, int modifiers);
// return the action info for the given key and modifier set
wxString GetAccelerator(action_id action);
// return a string, possibly empty, containing the menu item
// accelerator(s) for the given action
void RemoveAccelerator(wxMenuBar* mbar, int item, action_id action);
// remove any accelerator from given menu item
void SetAccelerator(wxMenuBar* mbar, int item, action_id action);
// update accelerator for given menu item using given action
wxString GetShortcutTable();
// return HTML data to display current keyboard shortcuts
// Colors:
extern wxColor* borderrgb; // color for border around bounded grid
extern wxColor* selectrgb; // color for selected cells
extern wxColor* pastergb; // color for pasted pattern
void UpdateStatusBrushes(); // update colors in status brushes
void FreeDefaultColors(); // deallocate memory allocated by CreateDefaultColors()
// Various constants:
const int minmainwd = 200; // main window's minimum width
const int minmainht = 100; // main window's minimum height
const int minhelpwd = 400; // help window's minimum width
const int minhelpht = 100; // help window's minimum height
const int minfontsize = 6; // minimum value of helpfontsize
const int maxfontsize = 30; // maximum value of helpfontsize
const int mininfowd = 400; // info window's minimum width
const int mininfoht = 100; // info window's minimum height
const int MAX_RECENT = 100; // maximum value of maxpatterns and maxscripts
const int MAX_SPACING = 1000; // maximum value of boldspacing
const int MIN_MEM_MB = 0; // minimum value of maximum memory
const int MAX_MEM_MB = // maximum value of maximum memory
sizeof(char*) <= 4 ? 4000 : 100000000;
const int MAX_BASESTEP = 2000000000; // maximum base step
const int MAX_DELAY = 5000; // maximum mindelay or maxdelay
const int MAX_THUMBRANGE = 500; // maximum thumbrange
const int MAX_SENSITIVITY = 10; // maximum wheelsens
const int MIN_DIRWD = 10; // minimum dirwinwd
// Golly uses wxTimers to control the speed of generating patterns, drawing cells,
// playing timelines, etc. The value defined below will cause the timers to fire
// at approximately 60 times per sec (to match the refresh rate of most screens).
#ifdef __WXMSW__
// It seems that wxTimers on Windows only have a resolution of about 15.6ms
// so we need to set SIXTY_HERTZ to a value below 16, based on Tim Hutton's
// test results (using a 64-bit build of Golly on Windows 10):
// interval=5 : 63.9gps = 15.6ms actual interval
// interval=10 : 63.9gps = 15.6ms actual interval
// interval=15 : 63.9gps = 15.6ms actual interval
// interval=16 : 40.0gps = 25.0ms actual interval
// interval=17 : 31.9gps = 31.3ms actual interval (= 2 times 15.6ms)
// interval=20 : 31.9gps = 31.3ms actual interval
// interval=25 : 31.9gps = 31.3ms actual interval
const int SIXTY_HERTZ = 15;
#else
// Mac and Linux
const int SIXTY_HERTZ = 16; // 1000/60
#endif
// Following are used by GetPrefs() before the view window is created:
typedef enum {
TopLeft, TopRight, BottomRight, BottomLeft, Middle
} paste_location;
typedef enum {
And, Copy, Or, Xor
} paste_mode;
extern paste_location plocation; // location of cursor in paste rectangle
extern paste_mode pmode; // logical paste mode
// get/set plocation
const char* GetPasteLocation();
void SetPasteLocation(const char* s);
// get/set pmode
const char* GetPasteMode();
void SetPasteMode(const char* s);
// Cursor modes:
extern wxCursor* curs_pencil; // for drawing cells
extern wxCursor* curs_pick; // for picking cell states
extern wxCursor* curs_cross; // for selecting cells
extern wxCursor* curs_hand; // for moving view by dragging
extern wxCursor* curs_zoomin; // for zooming in to a clicked cell
extern wxCursor* curs_zoomout; // for zooming out from a clicked cell
extern wxCursor* curs_wait; // for indicating a lengthy task is in progress
extern wxCursor* curs_hidden; // for hiding cursor when mouse is in overlay
void FreeCursors();
// deallocate memory allocated by CreateCursors()
const char* CursorToString(wxCursor* curs);
// convert given cursor to corresponding string in Cursor Mode submenu
wxCursor* StringToCursor(const char* s);
// convert given string to a cursor (NULL if s is not valid)
int CursorToIndex(wxCursor* curs);
// convert given cursor to an index: 0 for curs_pencil, etc
wxCursor* IndexToCursor(int i);
// convert given index to a cursor (NULL if i is not in valid range)
#endif
|
