]> git.sur5r.net Git - cc65/blob - doc/geos.sgml
some cleanup, checked usage of __bgcolor and __textcolor
[cc65] / doc / geos.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4
5 <!-- Title information -->
6
7 <title>GEOSLib docs
8 <author><url url="mailto:ytm@elysium.pl" name="Maciej Witkowiak">
9 <date>2014-04-11
10 <abstract>
11 This is the documentation of cc65's GEOSLib, but information contained here may be also
12 useful for writing GEOS applications in general.
13 </abstract>
14
15 <!-- Table of contents -->
16 <toc>
17
18 <!-- Begin the document -->
19
20 <sect>Introduction
21 <p>
22 As we all know that the best computers in the world are the C64 and C128. They have their GUI too -
23 the excellent GEOS. GEOS seems very difficult and cryptic for many people, from programmer's point
24 of view. That's not true. The designers of GEOS created a flexible and powerful system, which
25 is easy to use and program.
26 <p>
27 Coding GEOS in C? That's something new. It is possible now - with Ulrich von Bassewitz's cc65
28 package and my GEOSLib you are able to create GEOS applications in no time.
29 <p>
30 GEOSLib supports a subset of the standard cc65 libraries. Whenever possible native Kernal functions
31 are used (e.g. <tt/memset/ is an alias for <tt/FillRam/), however not all are supported. E.g.
32 string functions like <tt/strcmp/, <tt/strcpy/ are doubled with native <tt/CmpString/,
33 <tt/CopyString/ because the latter can handle only 256 byte strings. Keep this in mind when
34 you write your program. If you don't need long strings simply use functions from the Kernal,
35 the resulting code will be smaller.
36 <p>
37 <tt/dio/ - direct disk access is available, but you might have problems with devices other
38 than 1541, 1571 or 1581. RAM drives emulating these should work.
39 <p>
40 <tt/conio/ - simple console input-output is available for command line applications.
41 This implementation assumes that one character does fit in 8x8 cell, so output with
42 default BSW font, which is has 9 points, might be a bit messy. There is no color support in
43 GEOS 2.0 so color functions are disabled. Both 40 and 80 column modes are supported
44 and automatically detected.
45 <p>
46 <tt/tgi/ - TGI driver for GEOS that supports both 40 and 80 column modes but mode can not be
47 changed between <tt/tgi_init/ and <tt/tgi_done/.
48 <p>
49 <tt/joy/ - JOY driver for GEOS that supports only joystick, not current pointing device.
50 <p>
51 It is safe to use these standard includes and their contents:
52 <tt/assert.h, conio.h, dio.h, errno.h, em.h, geos.h, joystick.h, modload.h, mouse.h, stdlib.h, string.h, tgi.h, time.h/
53 <p>
54 For <tt/time.h/ functions <tt/systime()/ and <tt/clock()/ note that the resolution is one second.
55 <p>
56 Functions from the headers above are either standard C library functions or cc65-specific, in
57 either case they are not GEOS specific and so they are not described here.
58 <p>
59 I am an assembler programmer and GEOSLib was designed in such way that cc65 could emit the best
60 available code (well, the best as for machine :-). Many of the <tt/void foo (void)/ functions are
61 just raw calls to the Kernal (assembled just as <tt/jsr _foo/), look in <tt/gsym.h/, where you
62 can find many definitions of standard GEOS locations. Access to these addresses is optimized by
63 cc65 to simple <tt/lda/ and <tt/sta/. Don't be afraid to use C syntax.
64
65 <sect1>Requirements
66 <p>
67 You don't need a C64 or C128 for development. The only hardware requirement is a PC capable of
68 running cc65. You do however need C64 or C128 emulator and GEOS disk images (.d64) to test your
69 programs.
70
71 The software needed:
72 <itemize>
73     <item><em/cc65/ Excellent package containing a C crosscompiler, a crossassembler and a linker, you
74                 can get it from: <url url="http://cc65.github.io/cc65/">.
75     <item><em/VICE/ This is a portable C64, C128 and few other Commodore computers emulator, you
76                 can obtain it from: <url url="http://vice-emu.sourceforge.net/">.
77                 The VICE package contains the <em/c1541/ program that is able
78                 to convert/unconvert GEOS files to disk images.
79     <item><em/The Star Commander/ This tool is only for DOS. You will need it for transferring
80                 object files from a PC to a 1541. There's also one important ability of this
81                 tool - it automatically un-converts .cvt files into GEOS native format on
82                 disk image files. Check out: <url url="http://sta.c64.org/sc.html">.
83     <item><em/opencbm/ A package that allows for communication directly with a 1541 and
84                 other Commodore IEC bus drives. It can be a replacement for Star Commander if
85                 you only want to transfer files to a disk and unconvert using GEOS program for
86                 this purpose. Check out: <url url="http://opencbm.sourceforge.net/">.
87 </itemize>
88 <p>
89 VICE and cc65 are portable - they run on variety of platforms - DOS, Win32 and UNIX. GEOSLib only
90 needs cc65.
91 <p>
92 <em/Update:/ starting from v2.5.0 GEOSLib is a part of the cc65 package as its GEOS support library.
93
94 <sect1>Legal
95 <p>
96 I want to thank Uz for his cc65 package, Alexander Boyce for his excellent GEOS Programmer's
97 Reference Guide and BSW for GEOS.
98 <p>
99 GEOSLib is covered by the same license as cc65. You can find the whole text
100 among documentation. I would really appreciate if you would like to send me
101 your comments, suggestions, questions, changes, bug reports etc. I will also
102 appreciate if you will just give me a sign that you are using GEOSLib - not
103 especially something big and important, mail me even if you are just playing
104 with it.
105 <p>
106 You can send postcards with hellos to:
107 <p>
108 Maciej Witkowiak, ul. Slowackiego 6/57, 77-400 ZLOTOW
109 <p>
110 POLAND
111 <p>
112 e-mail: <tt/ytm@elysium.pl/
113
114 <sect>What do you have and what to do with it?
115 <p>
116 This chapter describes some rules you ought to obey, and how to use GEOSLib.
117
118 <sect1>Usage
119 <p>
120 Apart from this file, which merely describes only standard GEOS library
121 functions, you should read the <tt/grc65/ (GEOS resource compiler) documentation.
122 There is information about necessary resource files (each GEOS application
123 needs at least one) and the build process - what should be done and in what
124 order. Please also read the cc65 documentation on how to compile C, assembler
125 and link everything together.
126 <p>
127 All in all, you just need to place
128 <tscreen><verb>
129 &num;include &lt;geos.h&gt;
130 </verb></tscreen>
131 at the top of your source.
132 <p>
133 As a general rule read the sources of the example programs and read the headers.
134 These are the most reliable sources of knowledge ;-). You will also find there
135 many C macros representing various arguments passed to the functions. Please use
136 them. You will find your sources easier to understand, and it will be easier
137 to find bugs.
138 <p>
139 All types used in GEOSLib are <tt/unsigned/.
140 <p>
141 Screen coordinates are given in pixels unless stated differently.
142
143 <sect1>Notes on style
144 <p>
145 Contrary to a typical GEOS assembly program which has a main function called after loading that
146 setups the screen, menus, icons etc. exiting from the <tt/main/ function in C is equivalent to
147 calling <tt/exit()/. These two are the only safe methods of terminating applications. DO NOT
148 USE <tt/EnterDeskTop/! Your data may be lost as library destructors and functions registered
149 with <tt/atexit/ are not called.
150 <p>
151 For GEOS GUI applications the recommended program structure is to have everything initialized
152 in the <tt/main/ function and at the end of it a call to the <tt/MainLoop()/ function. WARNING! This
153 function never returns, any code between <tt/MainLoop();/ and the end of <tt/main/ will not
154 be executed. You have to call <tt/exit()/ explicitly somewhere in your code (e.g. in a menu
155 handler or via DialogBox action).
156 <p>
157 Whenever possible use definitions from <tt/gsym.h/. The resulting code is translated by cc65 into
158 series of <tt/lda/ and <tt/sta/, so you can't do it better :-).
159 <p>
160 Don't hesitate to use library functions. Everything was written with size and speed in mind. In
161 fact many calls are just redirections to the GEOS Kernal which results in a simple <tt/jsr/.
162 <p>
163 The <tt/main/ function receives the standard <tt/argc/ and <tt/argv/ parameters. There are
164 always either 1 or 3 parameters. The DOS application name is always set as <tt/argv[0]/.
165 If present, <tt/argv[1]/ and <tt/argv[2]/ will be set to the data filename and data diskname (it only
166 works if the user double-clicks on a data file associated with your application). Note that it is up
167 to your application to determine which of the available (up to four) disk drives has the disk
168 with given diskname inside. If this fails your program should ask to insert the proper disk into
169 one of available drives.
170 <p>
171 You might wonder why I have chosen a sometimes weird order of arguments in functions. I just
172 wanted to avoid unnecessary pushing and popping of arguments from the stack because cc65 can pass a single
173 <tt/unsigned int/ through CPU registers.
174 <p>
175 Do not try to compile in strict ANSI mode. The library uses cc65 extensions which are not available in
176 ANSI.
177 <p>
178 It is possible to use dynamically loaded modules, three such modules are provided:
179 A GEOS TGI driver, a GEOS EMD driver (for VDC extended memory) and a GEOS JOY driver.
180 Just make sure that their filenames appear UPPERCASE in DeskTop. There are no more special
181 recommendations, read the cc65 documentation about modules and the demo programs source code.
182
183 <sect>Library Functions
184 <p>
185 Functions here are sorted more or less in the way they appear in the header files. This way I am able
186 to keep functions covering similar tasks near each other. All function names are identical to those
187 from the <tt/geosSym/ file provided with the GeoProgrammer package. Only my extensions to <tt/geosSym/
188 are covered by new names, but I tried to keep them in the naming convention.
189
190 <sect1>Graphics
191 <p>
192 This section covers the drawing package of GEOS along with text output routines.
193
194 <sect2>SetPattern
195 <p>
196 <tt/void SetPattern (char pattern)/
197 <p>
198 This function sets the current pattern to the given. There are 32 different patterns in GEOS. You can
199 see them together in the filling box in GeoPaint.
200
201 <sect2>GraphicsString
202 <p>
203 <tt/void GraphicsString (char *myGString)/
204 <p>
205 One of the more powerfull routines of GEOS. This function calls other graphic functions depending
206 on the given command string. See the structures chapter for a more detailed description.
207
208 <sect2>Rectangle functions
209 <p>
210 Parameters to those functions are grouped in the <tt/struct window drawWindow/. To speed up things and
211 reduce overhead this structure is bound to zero page locations, where all rectangle functions
212 expect their parameters. You can modify the data directly (e.g. <tt/drawWindow.top=10/) or via the
213 <tt/InitDrawWindow/ function. Contents of <tt/drawWindow/ are guaranteed not to change when only
214 using graphics functions. In other cases you should keep your data in separate <tt/struct window/
215 and use <tt/InitDrawWindow/ before the first call to one of the rectangle functions.
216
217 <sect3>InitDrawWindow
218 <p>
219 <tt/void InitDrawWindow (struct window *myWindow)/
220 <p>
221 This function only copies the contents of <tt/myWindow/ into the system area of <tt/drawWindow/. Use it
222 if for some reason you have to keep your window data out of the zero page space.
223
224 <sect3>Rectangle
225 <p>
226 <tt/void Rectangle (void)/
227 <p>
228 This draws on screen a rectangle filled with the current pattern.
229
230 <sect3>FrameRectangle
231 <p>
232 <tt/void FrameRectangle (char pattern)/
233 <p>
234 This one draws a frame with the given bit pattern (not a pattern from the GEOS palette).
235
236 <sect3>InvertRectangle
237 <p>
238 <tt/void InvertRectangle (void)/
239 <p>
240 Just as the name says...
241
242 <sect3>ImprintRectangle and RecoverRectangle
243 <p>
244 <tt/void ImprintRectangle (void)/
245 <p>
246 <tt/void RecoverRectangle (void)/
247 <p>
248 These two functions are for copying parts of the screen to (<tt/Imprint/) and from (<tt/Recover/) the
249 backbuffer of the screen. For example when drawing a new menu box GEOS first uses
250 <tt/ImprintRectangle/ to save the area under the box, and restores it by <tt/RecoverRectangle/ upon
251 destroying the menu.
252
253 <sect2>Line Functions
254 <p>
255 The GEOS drawing package is optimized so there are different functions for drawing vertical and
256 horizontal lines.
257
258 <sect3>HorizontalLine
259 <p>
260 <tt/void HorizontalLine (char pattern, char y, unsigned xStart, unsigned xEnd)/
261 <p>
262 This function draws a horizontal line using the given pattern. Note that <tt/pattern/ is not a pattern
263 number as set in <tt/SetPattern/ but a true bit pattern.
264
265 <sect3>InvertLine
266 <p>
267 <tt/void InvertLine (char y, unsigned xStart, unsigned xEnd)/
268 <p>
269 There is only a horizontal version.
270
271 <sect3>RecoverLine
272 <p>
273 <tt/void RecoverLine (char y, unsigned xStart, unsigned xEnd)/
274 <p>
275 This function recovers a single line. It is utilized by <tt/RecoverRectangle/. See its description
276 for more details.
277
278 <sect3>VerticalLine
279 <p>
280 <tt/void VerticalLine (char pattern, char yStart, char yEnd, unsigned x)/
281 <p>
282 This function draws a vertical line using the given pattern. Note that <tt/pattern/ is not a pattern
283 number as set in <tt/SetPattern/ but a true bit pattern.
284
285 <sect3>DrawLine
286 <p>
287 <tt/void DrawLine (char mode, struct window *myWindow)/
288 <p>
289 The <tt/top/ parameters of <tt/struct window/ describe the starting point of the line, while
290 <tt/bottom/ ones are for the ending point. If <tt/mode/ is <tt/DRAW_DRAW/ then the current pattern from
291 <tt/SetPattern/ is used for drawing. If <tt/mode/ is <tt/DRAW_ERASE/ then the line is erased from the
292 screen. If <tt/mode/ is <tt/DRAW_COPY/ then the line is copied from/to back/frontbuffer, according to
293 the <tt/dispBufferOn/ setting.
294
295 <sect2>Point Functions
296 <p>
297 The parameters to these two functions are passed by a pointer to an own <tt/struct pixel/ filled with
298 proper values.
299
300 <sect3>DrawPoint
301 <p>
302 <tt/void DrawPoint (char mode, struct pixel *myPixel)/
303 <p>
304 Depending on <tt/mode/ (see <tt/DrawLine/) draws/erases/copies a single point
305 on the screen.
306
307 <sect3>TestPoint
308 <p>
309 <tt/char TestPoint (struct pixel *myPixel)/
310 <p>
311 This function tests if the given pixel is set and returns <tt/true/ (non-zero) or <tt/false/ (zero).
312
313 <sect2>Character and string output
314
315 <sect3>PutChar
316 <p>
317 <tt/void PutChar (char character, char y, unsigned x)/
318 <p>
319 This function outputs a single character using the current style and font to the screen.
320
321 <sect3>PutString
322 <p>
323 <tt/void PutString (char *myString, char y, unsigned x)/
324 <p>
325 Same as <tt/PutChar/ except the fact that you can output a whole <tt/NULL/-terminated string.
326 See <tt/ggraph.h/ for the list of tokens that you can also place in the string - like <tt/CBOLDON/ or
327 <tt/COUTLINEON/.
328
329 <sect3>PutDecimal
330 <p>
331 <tt/void PutDecimal (char parameter, unsigned value, char y, unsigned x)/
332 <p>
333 This function converts <tt/value/ to its decimal representation and outputs it to the screen.
334 The <tt/parameter/ is the field width in pixels (range 1-31) and the mode bits. Depending on them
335 the string can be filled with zeroes (the string is always 5 characters long) or not and left or right
336 justified to the given pixel. See <tt/ggraph.h/ for predefined values for <tt/parameter/.
337
338 <sect2>Font Handling
339
340 <sect3>GetCharWidth
341 <p>
342 <tt/char GetCharWidth (char character)/
343 <p>
344 This function returns the real width (in pixels) of the given character with the current font. It can be used
345 for counting the length of a string on the screen, allowing for indentation or justification.
346
347 <sect3>LoadCharSet
348 <p>
349 <tt/void LoadCharSet (struct fontdesc *myFont)/
350 <p>
351 This function forces GEOS to use the given font. <tt/myFont/ should be casted from a
352 pointer to the start of the area where a record from a font file (VLIR structure) was loaded.
353
354 <sect3>UseSystemFont
355 <p>
356 <tt/void UseSystemFont (void)/
357 <p>
358 This function forces GEOS to use the built-in BSW font.
359
360 <sect2>Bitmap handling
361 <p>
362 I'm not quite sure how these functions are working (except <tt/BitmapUp/) so you should
363 probably look into the library sources and compare it with your knowledge. Please let me know
364 if something is wrong or broken.
365
366 <sect3>BitmapUp
367 <p>
368 <tt/void BitmapUp (struct iconpic *myPic)/
369 <p>
370 This function unpacks the bitmap and places it on the screen - just as you set it in the
371 <tt/struct iconpic/ pointer which you pass. See <tt/gstruct.h/ for a description of this
372 structure. Note that you can only use packed GEOS bitmaps - a simple Photo Scrap is in this format.
373
374 <sect3>BitmapClip
375 <p>
376 <tt/void BitmapClip (char skipLeft, char skipRight, unsigned skipTop, struct iconpic *myPic)/
377 <p>
378 This function acts similar to <tt/BitmapUp/ but you can also define which parts of the bitmap are
379 to be drawn - you give the number of columns (8-pixel) to skip on the right and left of the bitmap,
380 and the number of rows to skip from the top if it.
381
382 <sect3>BitOtherClip
383 <p>
384 <tt/void BitOtherClip (void *proc1, void *proc2, char skipLeft, char skip Right, unsigned skipTop,
385         struct iconpic *myPic)/
386 <p>
387 Similar to the previous one with some extension. <tt/proc1/ is called before reading a byte (it
388 returns in .A the next value), and <tt/proc2/ is called every time the parser reads a byte which is
389 not a piece of a pattern (byte of code greater than 219). Both procedures should be written
390 separately in assembler and declared as <tt/__fastcall__/ returning char.
391
392 <sect1>Menus and Icons
393 <p>
394 Here you will find information about functions related with menus and icons.
395
396 <sect2>Menus
397 <p>
398 Menus are essential for a GUI. GEOS can handle only one menu at a time, but each menu can call
399 another one, which results in a submenu tree. There can be up to 8 menu levels, each one with up
400 to 32 items.
401 <p>
402 Menus are initialized with <tt/DoMenu/ and then the Kernal takes care of everything. Your code
403 (called from an event handler) should be a function without parameters, returning void. You should
404 use <tt/DoPreviousMenu/ or <tt/GotoFirstMenu/ at least once in its code to have the screen clean.
405
406 <sect3>DoMenu
407 <p>
408 <tt/void DoMenu (struct menu *myMenu)/
409 <p>
410 This function initializes the GEOS menu processor and exits. See <tt/DoMenu structure/ for more
411 information about it. Know that many GEOS applications just initialize the screen, menu and
412 exit to the main Kernal loop, this proves the power of <tt/DoMenu/.
413
414 <sect3>ReDoMenu
415 <p>
416 <tt/void ReDoMenu (void)/
417 <p>
418 This simply redraws the menu at the lowest level. It works like calling <tt/DoMenu/ again with
419 the same parameters.
420
421 <sect3>RecoverMenu
422 <p>
423 <tt/void RecoverMenu (void)/
424 <p>
425 This function erases the current menu from the screen. It doesn't change the menu level.
426
427 <sect3>RecoverAllMenus
428 <p>
429 <tt/void RecoverAllMenus (void)/
430 <p>
431 This calls <tt/RecoverMenu/ and erases all menus from the screen. Then the menu level is
432 set to 0 (topmost).
433
434 <sect3>DoPreviousMenu
435 <p>
436 <tt/void DoPreviousMenu (void)/
437 <p>
438 This functions causes the menu processor to go back one menu level. You should use it in menu
439 handler code to have the screen clean.
440
441 <sect3>GotoFirstMenu
442 <p>
443 <tt/void GotoFirstMenu (void)/
444 <p>
445 This one jumps back to the topmost menu. If there is only a menu and one submenu it works the
446 same as <tt/DoPreviousMenu/.
447
448 <sect2>Icon Functions
449 <p>
450 Icons are working similar to menus except the fact that there is only one level. Icons are
451 defined as a screen area filled with a bitmap, but if you would setup icons and erase the
452 screen they would still be active and clicking in the place where formerly an icon was would cause
453 an effect. Similarly if you would setup icons and then turn them off with <tt/ClearMouseMode/
454 the bitmap would still be on the screen but clicking on it would not cause any action.
455 There is only one, but powerful icon function.
456
457 <sect3>DoIcons
458 <p>
459 <tt/void DoIcons (struct icontab *myIconTab)/
460 <p>
461 This function initializes all icons that are present on the screen at once. For more information
462 look at the <tt/Icons/ chapter in this manual.
463
464 <sect1>DialogBoxes
465 <p>
466 This chapter covers the most powerful GEOS user interface function - <tt/DoDlgBox/.
467
468 <sect2>GEOS standard
469
470 <sect3>DoDlgBox
471 <p>
472 <tt/char DoDlgBox (char *dialogString)/
473 <p>
474 This function returns one byte. It can be the value of one of six standard icons (see <tt/gdlgbox.h/)
475 or whatever the closing routine passes. Register <tt/r0L/ also contains this value.
476 <p>
477 Read the structures chapter for the specs of the <tt/dialogString/.
478
479 <sect3>RstrFrmDialogue
480 <p>
481 <tt/char RstrFrmDialogue/
482 <p>
483 This function is called from within DoDlgBox event. It immediately closes the DialogBox and returns
484 the owner ID (or whatever caller has in the .A register).
485
486 <sect2>GEOSLib extensions
487 <p>
488 To simplify the usage of DoDlgBox from C I wrote some helper functions - wrappers for DoDlgBox,
489 with predefined data. In one word - these are standard DialogBoxes you can see in almost every
490 GEOS application.
491
492 <sect3>DlgBoxYesNo, DlgBoxOkCancel, DlgBoxOk
493 <p>
494 <tt/char DlgBoxYesNo (char *line1, char *line2)/
495 <p>
496 <tt/char DlgBoxOkCancel (char *line1, char *line2)/
497 <p>
498 <tt/void DlgBoxOk (char *line1, char *line2)/
499 <p>
500 These function show two lines of text in a standard-sized DialogBox. You can read the code of the
501 pressed icon from the return value. E.g. for <tt/DlgBoxYesNo/ it can only be <tt/YES/ or <tt/NO/.
502 You can pass an empty string or NULL to get a blank line.
503
504 <sect3>DlgBoxGetString
505 <p>
506 <tt/char DlgBoxGetString (char *string, char strlen, char *line1, char *line2)/
507 <p>
508 This function prompts the user to enter a string of at most <tt/strlen/ characters. It is returned
509 in <tt/string/. The two given lines of text are shown above the input line. Please remember
510 that there is also a <tt/CANCEL/ icon in the DialogBox and you should test if user confirmed his
511 input or gave up. The <tt/string/ is also shown so you can place a default input there or remember
512 to place <tt/NULL/ at start.
513
514 <sect3>DlgBoxFileSelect
515 <p>
516 <tt/char DlgBoxFileSelect (char *class, char filetype, char *filename)/
517 <p>
518 This routine is the standard file selector. It can return <tt/OPEN/, <tt/CANCEL/ or disk error
519 on reading the directory or opening the disk.
520 There is also a <tt/DISK/ icon shown, but it is handled internally. You pass as input parameters
521 <tt/filetype/ and a pointer to a string containing the first part of a file's class. If this string is
522 empty (<tt/NULL/ at the start), then all files with given filetype will be shown.
523 <p>
524 At present this file selector handles only first 16 files of given type and supports only one
525 (current) drive.
526
527 <sect3>MessageBox
528 <p>
529 <tt/char MessageBox (char mode, const char *format, ...)/
530 <p>
531 This function is a more general one. It works very much like <tt/printf/ in a
532 box. The only difference is the <tt/mode/ parameter which allows for placing
533 default icons (see <tt/gdlgbox.h/ for list of possible <tt/MB_/ values).
534 Any too wide text will be clipped to the size of the default window. If <tt/mode/
535 is invalid or equal to <tt/MB_EMPTY/ then the window will be closed
536 after a click. Otherwise the user must choose an icon.
537 <p>
538 Note: Use it if you really need (or if you use it in many places) as
539 it adds quite amount of code to your program.
540 <p>
541 Note: the formatted text <em/cannot exceed/ 255 bytes in length, there is no check
542 for that.
543
544 <sect1>Mouse, Sprites and Cursors
545 <p>
546 You will find here functions related to sprite and mouse drawing and handling.
547
548 <sect2>Mouse related functions
549 <p>
550 These cover the mouse - as a general pointing device, but expect users to utilize as different devices
551 as a digital or analog joystick, a mouse, a lightpen or a koalapad (whatever it is).
552
553 <sect3>StartMouseMode
554 <p>
555 <tt/void StartMouseMode (void)/
556 <p>
557 This function initializes the mouse vectors - <tt/mouseVector/ and <tt/mouseFaultVec/, and then
558 calls <tt/MouseUp/.
559
560 <sect3>ClearMouseMode
561 <p>
562 <tt/void ClearMouseMode (void)/
563 <p>
564 This function disables all mouse activities - icons and menus stop to respond to mouse events,
565 but they are not cleared from the screen.
566
567 <sect3>MouseUp and MouseOff
568 <p>
569 <tt/void MouseUp (void)/
570 <p>
571 <tt/void MouseOff (void)/
572 <p>
573 The first function turns the mouse pointer on. It appears on the next IRQ. The second one does
574 the opposite - it turns off the pointer, but its position is still updated by the input driver.
575
576 <sect3>IsMseInRegion
577 <p>
578 <tt/char IsMseInRegion (struct window *myWindow)/
579 <p>
580 This function tests if the mouse pointer is actually in the given range of the screen. See <tt/gsprite.h/ for
581 a description of the bits in the return values - they describe the position in detail.
582
583 <sect2>Sprites
584 <p>
585 You are free to use any of the eight sprites, but keep in mind that sprite 0 is actually the mouse
586 pointer and sprite 1 can be overwritten when using a text prompt. You don't have to worry about
587 40/80 column issues because GEOS128 has a pretty good sprite emulator for the VDC.
588
589 <sect3>DrawSprite
590 <p>
591 <tt/void DrawSprite (char sprite, char *mySprite)/
592 <p>
593 This function initializes the sprite data. <tt/mySprite/ is a 63-byte table with bitmap data, which
594 is copied to the system sprite area (at <tt/sprpic/ - see <tt/gsym.h/). Hardware sprite registers are
595 not initialized and the sprite is not yet visible.
596
597 <sect3>PosSprite
598 <p>
599 <tt/void PosSprite (char sprite, struct pixel *myPixel)/
600 <p>
601 This function positions the sprite on the screen. The given coordinates are screen ones - they are
602 converted to sprite coordinates by GEOS. Due to this you cannot use this function to position your
603 sprite off the left or top to the screen.
604
605 <sect3>EnablSprite and DisablSprite
606 <p>
607 <tt/void EnablSprite (char sprite)/
608 <p>
609 <tt/void DisablSprite (char sprite)/
610 <p>
611 These two functions are responsible for making the sprite visible or not.
612
613 <sect2>Cursors and Console
614
615 <sect3>InitTextPrompt
616 <p>
617 <tt/void InitTextPrompt (char height)/
618 <p>
619 This function initializes sprite 1 for a text prompt with given <tt/height/. This parameter can be in
620 range 1-48.
621
622 <sect3>PromptOn and PromptOff
623 <p>
624 <tt/void PromptOn (struct pixel *myPixel)/
625 <p>
626 <tt/void PromptOff (void)/
627 <p>
628 The first function places a text prompt in given place and enables blinking.
629 The second one is pretty self-explanatory.
630
631 <sect3>GetNextChar
632 <p>
633 <tt/char GetNextChar (void)/
634 <p>
635 This function gets the next character from the keyboard queue. If the queue is empty it returns
636 <tt/NULL/, otherwise you receive the true ASCII code of a character or the value of a special (function)
637 key. See <tt/gsprite.h/ for the list of them.
638
639 <sect1>Disk
640 <p>
641 This chapter covers rather low-level disk routines. You should use them with care, because
642 you may easily corrupt data on disks. Also remember that contemporary GEOS supports many various
643 devices and sticking to 1541 track layout (e.g. expecting the directory on track 18) might be
644 dangerous.
645 <p>
646 For some purposes you might consider using the <tt/dio.h/ interface to disk access. It is native.
647 <p>
648 All GEOS disk functions return an error code in the X register. In some cases this is returned by the
649 GEOSLib function (if its type is <tt/char/), but in all cases the last error is saved in the <tt/__oserror/
650 location. If it is nonzero - an error occured. See <tt/gdisk.h/ for the list of possible errorcodes.
651 You need to include <tt/errno.h/ to get <tt/__oserror/, together with the standard <tt/errno/. The
652 latter gives less verbose, but still usable information and can be used with <tt/strerror/.
653 Probably you will get more information using <tt/_stroserror/ in a similar way.
654 <p>
655 For passing parameters use almost always a pointer to your data e.g. <tt/ReadBuff (&amp;myTrSe)/.
656
657 <sect2>Buffer functions
658 <p>
659 These functions take a single data sector (256 bytes) to read or write on the disk.
660
661 <sect3>ReadBuff and Writebuff
662 <p>
663 <tt/char ReadBuff (struct tr_se *myTrSe)/
664 <p>
665 <tt/char WriteBuff (struct tr_se *myTrSe)/
666 <p>
667 These functions read and write a sector placed at <tt/diskBlkBuf/.
668
669 <sect3>GetBlock and ReadBlock
670 <p>
671 <tt/char GetBlock (struct tr_se *myTrSe, char *buffer)/
672 <p>
673 <tt/char ReadBlock (struct tr_se *myTrSe, char *buffer)/
674 <p>
675 These two functions read a single block directly to the 256 byte array placed at <tt/buffer/.
676 The difference between them is that <tt/GetBlock/ initializes TurboDos in the drive if it was not
677 enabled. <tt/ReadBlock/ assumes that it is already enabled thus being slightly faster.
678
679 <sect3>PutBlock, WriteBlock, VerWriteBlock
680 <p>
681 <tt/char PutBlock (struct tr_se *myTrSe, char *buffer)/
682 <p>
683 <tt/char WriteBlock (struct tr_se *myTrSe, char *buffer)/
684 <p>
685 <tt/char VerWriteBlock (struct tr_se *myTrSe, char *buffer)/
686 <p>
687 Similar to previous but needed for writing the disk. <tt/VerWriteBlock/ verifies the data after
688 writing. In case of an error five tries are attempted before an error code is returned.
689
690 <sect2>Directory header
691 <p>
692 The functions described here operate on <tt/curDirHeader/ where the current disk header is stored.
693 On larger (than 1541) capacity drives the second part of the directory header is in <tt/dir2Head/.
694
695 <sect3>GetPtrCurDkNm
696 <p>
697 <tt/void GetPtrCurDkNm (char *diskName)/
698 <p>
699 This function fills the given character string with the name of current disk. It is converted to C
700 standard - the string is terminated with <tt/NULL/ character instead of code 160 as in Commodore DOS.
701 Note that the passed pointer must point to an array of at least 17 bytes.
702
703 <sect3>GetDirHead and PutDirHead
704 <p>
705 <tt/char GetDirHead (void)/
706 <p>
707 <tt/char PutDirHead (void)/
708 <p>
709 These functions read and write the directory header. You should use <tt/GetDirHead/ before
710 using any functions described below, and you should use <tt/PutDirHead/ to save the changes on the
711 disk. Otherwise they will be lost. Operating area is the <tt/curDirHead/.
712
713 <sect3>CalcBlksFree
714 <p>
715 <tt/unsigned CalcBlksFree (void)/
716 <p>
717 This function returns the number of free blocks on the current disk. It is counted using data in
718 <tt/curDirHead/ so you must initialize the disk before calling it.
719
720 <sect3>ChkDskGEOS
721 <p>
722 <tt/char ChkDskGEOS (void)/
723 <p>
724 This functions checks <tt/curDirHead/ for the GEOS Format identifier. It returns either true or false,
725 and also sets <tt/isGEOS/ properly. You must initialize the disk before using this.
726
727 <sect3>SetGEOSDisk
728 <p>
729 <tt/char SetGEOSDisk (void)/
730 <p>
731 This function initializes disk for use with GEOS. It sets the indicator in directory header and
732 allocates a sector for the directory of border files. You don't need to initialize the disk before
733 using.
734
735 <sect3>FindBAMBit
736 <p>
737 <tt/char FindBAMBit (struct tr_se *myTrSe)/
738 <p>
739 This function returns the bit value from the BAM (Block Allocation Map) for the given sector. The bit is
740 set if the sector is free to use. The returned value is always zero if the sector is already allocated.
741 In fact, this function could be used in a following way:
742 <tscreen><verb>
743 &num;define BlockInUse FindBAMBit
744 ...
745 if (!BlockInUse(&amp;myTrSe)) &lcub;
746 ... block not allocated ...
747 &rcub;
748 </verb></tscreen>
749 <p>
750 Anyway, I feel that this function is too low-level.
751
752 <sect3>BlkAlloc and NxtBlkAlloc
753 <p>
754 <tt/char BlkAlloc (struct tr_se output&lsqb;&rsqb, unsigned length)/
755 <p>
756 <tt/char NxtBlkAlloc (struct tr_se *myTrSe, struct tr_se output&lsqb;&rsqb, unsigned length)/
757 <p>
758 Both functions allocate enough disk sectors to fit <tt/length/ bytes in them. You
759 find the output in <tt/output/ which is a table of <tt/struct tr_se/. The last entry will have the
760 track equal to 0 and sector equal to 255. The simplest way of using them is to use
761 predefined space in the GEOS data space and pass <tt/fileTrScTab/, which is a predefined table.
762 <p>
763 The difference between those two is that <tt/NextBlkAlloc/ starts allocating from the given sector,
764 and <tt/BlkAlloc/ starts from the first nonused sector.
765 <p>
766 You need to use <tt/PutDirHead/ later to save any changes in BAM.
767
768 <sect3>FreeBlock
769 <p>
770 <tt/char FreeBlock (struct tr_se *myTrSe)/
771 <p>
772 Simply deallocates a block in the BAM. You need to update the BAM with <tt/PutDirHead/.
773
774 <sect3>SetNextFree
775 <p>
776 <tt/struct tr_se SetNextFree (struct tr_se *myTrSe)/
777 <p>
778 This function finds the first free sector starting from given track and sector and allocates it.
779 It might return the same argument if the given block is not allocated. I wanted it to be type
780 clean, but this made the usage a bit tricky. To assign a value to your own <tt/struct tr_se/ you have to
781 cast both variables to <tt/unsigned/. E.g.
782 <tscreen><verb>
783 struct tr_se myTrSe;
784 ...
785 (unsigned)myTrSe=(unsigned)SetNextFree(&amp;otherTrSe);
786 </verb></tscreen>
787 <p>
788 In this example <tt/otherTrSe/ can be replaced by <tt/myTrSe/.
789 <p>
790 Note: you <em/must/ use casting to have the correct values.
791
792 <sect2>Low-level disk IO
793 <p>
794 Functions described here are more usable in Kernal or drivers code, less common in applications,
795 but who knows, maybe someone will need them.
796
797 <sect3>EnterTurbo, ExitTurbo, PurgeTurbo
798 <p>
799 <tt/void EnterTurbo (void)/
800 <p>
801 <tt/void ExitTurbo (void)/
802 <p>
803 <tt/void PurgeTurbo (void)/
804 <p>
805 These functions are the interface to the GEOS TurboDos feature which makes slow Commodore drives a bit
806 more usable. <tt/EnterTurbo/ enables TurboDos unless it is already enabled. If not, then you will
807 have to wait a bit to transfer the TurboDos code into disk drive RAM. <tt/ExitTurbo/ disables TurboDos.
808 This is useful for sending some DOS commands to a drive e.g. for formatting. Note that before any
809 interaction with the Kernal in ROM you have to call <tt/InitForIO/. You don't have to worry about speed.
810 <tt/EnterTurbo/ will only enable TurboDos (no code transfer) if TurboDos was disabled with
811 <tt/ExitTurbo/. <tt/PurgeTurbo/ acts differently from <tt/ExitTurbo/ - it not only disables TurboDos,
812 but also removes it from drive RAM (not quite true, but it works like that). After using
813 <tt/PurgeTurbo/ the next call to <tt/EnterTurbo/ will reload drive RAM.
814
815 <sect3>ChangeDiskDevice
816 <p>
817 <tt/char ChangeDiskDevice (char newDevice)/
818 <p>
819 This function changes the device number of the current device (in fact drives only) to the given one. It is
820 usable for swapping drives. There's no check if the given <tt/newDevice/ already exist, so if you want
821 to change the logical number of drive 8 to 9 and you already have a drive number 9 then GEOS will probably
822 hang on disk access. Use safe, large numbers. Note that the safe IEC range is 8-30.
823
824 <sect2>Disk Initialization
825 <p>
826 GEOS has two functions for initialization ('logging in' as they say on CP/M) of a disk.
827 <sect3>OpenDisk
828 <p>
829 <tt/char OpenDisk (void)/
830 <p>
831 This function initializes everything for a new disk. It loads and enables TurboDos if needed.
832 Then the disk is initialized with <tt/NewDisk/. Next, <tt/GetDirHead/ initializes <tt/curDirHead/.
833 Disk names are compared and if they differ then the disk cache on REU is cleared. Finally the format is
834 checked with <tt/ChkDkGEOS/ and the disk name is updated in the internal tables.
835
836 <sect3>NewDisk
837 <p>
838 <tt/char NewDisk (void)/
839 <p>
840 This function is similar to the DOS command I. It clears the REU cache and enables TurboDos if needed.
841
842 <sect1>Files
843 <p>
844 This section covers the GEOS file interface.
845
846 <sect2>Directory handling
847 <p>
848 The functions described here are common for SEQ and VLIR structures.
849
850 <sect3>Get1stDirEntry and GetNxtDirEntry
851 <p>
852 <tt/struct filehandle *Get1stDirEntry (void)/
853 <p>
854 <tt/struct filehandle *GetNxtDirEntry (void)/
855 <p>
856 These two functions are best suited for scanning the whole directory for particular files. Note that
857 the returned filehandles describe all file slots in the directory - even those with deleted files.
858 The return value can be obtained by casting both sides to <tt/unsigned/ - as in the <tt/SetNextFree/
859 function or read directly after a call to those two functions from <tt/r5/. The current sector number
860 is in <tt/r1/ and the sector data itself is in <tt/diskBlkBuf/.
861
862 <sect3>FindFile
863 <p>
864 <tt/char FindFile (char *fName)/
865 <p>
866 This function scans the whole directory for the given filename. It returns either 0 (success) or 5
867 (FILE_NOT_FOUND, defined in <tt/gdisk.h/) or any other fatal disk read error. After a successful
868 <tt/FindFile/ you will have <tt/struct filehandle/ at <tt/dirEntryBuf/ filled with the file's data and
869 other registers set as described in <tt/GetNxtDirEntry/.
870
871 <sect3>FindFTypes
872 <p>
873 <tt/char FindFTypes (char *buffer, char fType, char fMaxNum, char *classTxt)/
874 <p>
875 This function scans the directory and fills a table at <tt/buffer/ with <tt/char &lsqb;17&rsqb;/ entries.
876 <tt/fType/ is the GEOS type of the searched files and <tt/classTxt/ is a string for the Class field in the file
877 header. Class matches if the given string is equal or shorter than that found in the file's header block.
878 If you want just to find all files with the given GEOS type you should pass an empty string or <tt/NULL/ as
879 <tt/classTxt/. Be warned that for searching <tt/NON_GEOS/ files you must pass <tt/NULL/ as <tt/classTxt/.
880 <tt/fMaxNum/ is the maximal number of files to find, thus the <tt/buffer/ must provide an area of size
881 equal to <tt/17 * fMaxNum/. This function returns the number of found files, ranging from 0 to number
882 passed as <tt/fMaxNum/. The return value can be also restored from <tt/r7H/.
883
884 <sect3>DeleteFile
885 <p>
886 <tt/char DeleteFile (char *fName)/
887 <p>
888 This function deletes a file by its name. It works for SEQ and VLIR files.
889
890 <sect3>RenameFile
891 <p>
892 <tt/char RenameFile (char *oldName, char *newName)/
893 <p>
894 I think it is obvious...
895
896 <sect3>GetFHdrInfo
897 <p>
898 <tt/char GetFHdrInfo (struct filehandle *myFile)/
899 <p>
900 This function loads the file header into the <tt/fileHeader/ buffer. Using after e.g. <tt/FindFile/
901 you can pass the address of <tt/dirEntryBuf/.
902
903 <sect2>Common and SEQ structure
904 <p>
905 Functions described here are common for SEQ and VLIR structures because the arguments passed are the
906 starting track and sector which may point either to the start of a chain for VLIR or the data for SEQ.
907
908 <sect3>GetFile
909 <p>
910 <tt/char __fastcall__ GetFile(char flag, const char *fname, const char *loadaddr, const char *datadname, const char *datafname)/
911 <p>
912 This routine loads and runs a given file <tt/fname/. The file must be one of following types:
913 <tt/SYSTEM, DESK_ACC, APPLICATION, APPL_DATA, PRINTER,/ or <tt/INPUT_DEVICE/. The execution
914 address is taken from the file header. If it is zero, then the file is only loaded. Only the first chain
915 from VLIR files is loaded. If <tt/flag/ has bit 0 set then the load address is taken from <tt/loadaddr/
916 and not from the file header. In this case <tt/APPLICATION/ files will be only loaded, not executed.
917 This does not apply to <tt/DESK_ACC/. If either bit 6 or 7 of <tt/flag/ are set, then 16 bytes from
918 <tt/datadname/ are copied to <tt/dataDiskName/ and 16 bytes from <tt/datafname/ go to <tt/dataFileName/
919 thus becoming parameters for the new application. Pass <tt/NULL/ for any unused parameter.
920
921 <sect3>ReadFile
922 <p>
923 <tt/char ReadFile (struct tr_se *myTrSe, char *buffer, unsigned fLength)/
924 <p>
925 This function reads at most <tt/fLength/ bytes into <tt/buffer/ from chained sectors starting at
926 <tt/myTrSe/.
927
928 <sect3>ReadByte
929 <p>
930 <tt/char ReadByte (void)/
931 <p>
932 This function returns the next byte from a file. Before the first call to it you must load <tt/r5/
933 with <tt/NULL/, <tt/r4/ with the sector buffer address and <tt/r1/ with the track and sector of the
934 first block of a file.
935 Remember to not modify <tt/r1/, <tt/r4/ and <tt/r5/. These registers must be preserved between
936 calls to <tt/ReadByte/.
937 <p>
938 The returned value is valid only if there was no error. The end of file is marked as <tt/BFR_OVERFLOW/
939 in <tt/__oserror/, this is set when trying to read one byte after the end of file, in this case the
940 returned value is invalid.
941
942 <sect3>SaveFile
943 <p>
944 <tt/char SaveFile (char skip, struct fileheader *myHeader)/
945 <p>
946 <tt/SaveFile/ will take care of everything needed to create a GEOS file, no matter if VLIR of SEQ
947 structure. All you need to do is to place the data in the proper place and prepare a header which will
948 contain all information about a file. The <tt/skip/ parameter says how many directory pages you
949 want to skip before searching for a free slot for the directory entry. In most cases you will put
950 <tt/0/ there.
951 <p>
952 You have to declare a <tt/struct fileheader/ and fill it with proper values. There is only one
953 difference - the first two bytes which are a link to a nonexistent next sector are replaced by a
954 pointer to the DOS filename of the file.
955 <p>
956 When saving sequential files the two most important fields in <tt/struct fileheader/ are <tt/fileheader.load_address/
957 and <tt/fileheader.end_address/.
958
959 <sect3>FreeFile
960 <p>
961 <tt/char FreeFile (struct tr_se myTable&lsqb;&rsqb;)/
962 <p>
963 This function deallocates all sectors contained in the passed table.
964
965 <sect3>FollowChain
966 <p>
967 <tt/char FollowChain(struct tr_se *myTrSe, char *buffer)/
968 <p>
969 This function fills a <tt/struct tr_se/ table at <tt/buffer/ with the sector numbers for a chain of
970 sectors starting with <tt/myTrSe/. You can pass such data (<tt/buffer/) to e.g. <tt/FreeFile/.
971
972 <sect2>VLIR structure
973 <p>
974 Here is information about VLIR files (later called RecordFiles) and functions.
975 <p>
976 A VLIR structure file consists of up to 127 SEQ-like files called records. Each record is like one
977 SEQ structure file. Records are grouped together, described by a common name - the VLIR file name and
978 an own number. Each record pointed to by its number is described by the starting track and sector numbers.
979 VLIR structures allow records to be empty (<tt/tr_se/ of such record is equal to <tt/&lcub;NULL,$ff&rcub;/),
980 or even non-exist (<tt/&lcub;NULL,NULL&rcub;/). Any other numbers represent the starting track and sector of
981 a particular file.
982 <p>
983 In GEOS there can be only one file opened at a time. Upon opening a VLIR file some information
984 about it is copied into memory. You can retrieve the records table at <tt/fileTrScTab/ (table of
985 128 <tt/struct tr_se/) and from <tt/VLIRInfo/ (<tt/struct VLIR_info/.
986 E.g. the size of whole VLIR file can be retrieved by reading <tt/VLIRInfo.fileSize/.
987
988 <sect3>OpenRecordFile
989 <p>
990 <tt/char OpenRecordFile (char *fName)/
991 <p>
992 This function finds and opens a given file. An error is returned if the file is not found or if it is not
993 in VLIR format. Information in <tt/VLIRInfo/ is initialized. VLIR track and sector table is
994 loaded at <tt/fileTrScTab/ and will be valid until a call to <tt/CloseRecordFile/ so don't modify it.
995 You should call <tt/PointRecord/ before trying to do something with the file.
996
997 <sect3>CloseRecordFile
998 <p>
999 <tt/char CloseRecordFile (void)/
1000 <p>
1001 This function calls <tt/UpdateRecordFile/ and clears internal GEOS variables.
1002
1003 <sect3>UpdateRecordFile
1004 <p>
1005 <tt/char UpdateRecordFile (void)/
1006 <p>
1007 This function will check the <tt/VLIRInfo.fileWritten/ flag and if it is set, then <tt/curDirHead/ is
1008 updated along with size and date stamps in the directory entry.
1009
1010 <sect3>PointRecord
1011 <p>
1012 <tt/char PointRecord (char recordNumber)/
1013 <p>
1014 This function will setup internal variables (and <tt/VLIRInfo.curRecord/) and return the track and
1015 sector of the given record in <tt/r1/. Note that the data may not be valid (if the record is non-existing
1016 you will get 0,0 and if it is empty - 255,0).
1017
1018 <sect3>NextRecord and PreviousRecord
1019 <p>
1020 <tt/char NextRecord (void)/
1021 <p>
1022 <tt/char PreviousRecord (void)/
1023 <p>
1024 These two work like <tt/PointRecord/. Names are self-explanatory.
1025
1026 <sect3>AppendRecord
1027 <p>
1028 <tt/char AppendRecord (void)/
1029 <p>
1030 This function will append an empty record (pair of 255,0) to the current VLIR track and sector
1031 table. It will also set <tt/VLIRInfo.curRecord/ to its number.
1032
1033 <sect3>DeleteRecord
1034 <p>
1035 <tt/char DeleteRecord (void)/
1036 <p>
1037 This function will remove the current record from the table, and move all current+1 records one place
1038 back (in the table). Note that there's no BAM update and you must call <tt/UpdateRecordFile/ to
1039 commit changes.
1040
1041 <sect3>InsertRecord
1042 <p>
1043 <tt/char InsertRecord (void)/
1044 <p>
1045 This function will insert an empty record in place of <tt/VLIRInfo.curRecord/ and move all following
1046 records in the table one place forward (contents of <tt/VLIRInfo.curRecord/ after a call to <tt/InsertRecord/
1047 can be found in <tt/VLIRInfo.curRecord + 1/).
1048
1049 <sect3>ReadRecord and WriteRecord
1050 <p>
1051 <tt/char ReadRecord (char *buffer, unsigned fLength)/
1052 <p>
1053 <tt/char WriteRecord (char *buffer, unsigned fLength)/
1054 <p>
1055 This function will load or save at most <tt/fLength/ bytes from the currently pointed record into or from
1056 <tt/buffer/.
1057
1058 <sect1>Memory and Strings
1059 <p>
1060 The functions covered in this section are common for the whole C world - copying memory parts and
1061 strings is one of the main computer tasks. GEOS also has an interface to do this. These functions
1062 are replacements for those like <tt/memset, memcpy, strcpy/ etc. from standard libraries.
1063 If you are dealing with short strings (up to 255 characters) you should use these functions
1064 instead of standard ones, e.g. <tt/CopyString/ instead of <tt/strcpy/. It will work faster.
1065 <p>
1066 However some of them have slightly different calling conventions (order of arguments to be specific),
1067 so please check their syntax here before a direct replacement.
1068 <p>
1069 Please note that the memory areas described here as <em/strings/ are up to 255 characters (without
1070 counting the terminating <tt/NULL/), and <em/regions/ can cover the whole 64K of memory.
1071
1072 <sect2>CopyString
1073 <p>
1074 <tt/void CopyString (char *dest, char *src)/
1075 <p>
1076 This function copies the string from <tt/src/ to <tt/dest/, until it reaches <tt/NULL/. The <tt/NULL/
1077 is also copied.
1078
1079 <sect2>CmpString
1080 <p>
1081 <tt/char CmpString (char *s1, char *s2)/
1082 <p>
1083 This function compares the strings <tt/s1/ to <tt/s2/ for equality - this is case sensitive, and both
1084 strings have to have the same length. It returns either <tt/true/ (non-zero) or <tt/false/ (zero).
1085
1086 <sect2>CopyFString and CmpFString
1087 <p>
1088 <tt/void CopyFString (char length, char *dest, char *src)/
1089 <p>
1090 <tt/char CmpFString (char length, char *s1, char *s2)/
1091 <p>
1092 These two are similar to <tt/CopyString/ and <tt/CmpString/ except the fact, that you provide
1093 the length of the copied or compared strings. The strings can also contain several <tt/NULL/
1094 characters - they are not treated as delimiters.
1095
1096 <sect2>CRC
1097 <p>
1098 <tt/unsigned CRC (char *src, unsigned length)/
1099 <p>
1100 This function calculates the CRC checksum for the given memory range. I don't know if it is
1101 compatible with standard CRC routines.
1102
1103 <sect2>FillRam and ClearRam
1104 <p>
1105 <tt/void *FillRam (char *dest, char value, unsigned length)/
1106 <p>
1107 <tt/void *ClearRam (char *dest, unsigned length)/
1108 <p>
1109 Both functions are filling the given memory range. <tt/ClearRam/ fills with <tt/0s/, while
1110 <tt/FillRam/ uses the given <tt/value/. Be warned that these functions destroy <tt/r0, r1 and
1111 r2L/ registers. The functions are aliases for <tt/memset/ and <tt/bzero/, respectively.
1112
1113 <sect2>MoveData
1114 <p>
1115 <tt/void *MoveData (char *dest, char *src, unsigned length)/
1116 <p>
1117 This functions copies one memory region to another. There are checks for an overlap and the
1118 non-destructive method is chosen. Be warned that this function destroys contents of the
1119 <tt/r0, r1 and r2/ registers. This function is an alias for <tt/memcpy/.
1120
1121 <sect2>InitRam
1122 <p>
1123 <tt/void InitRam (char *table)/
1124 <p>
1125 This function allows to initialize multiple memory locations with single bytes or strings.
1126 This is done with a <tt/table/ where everything is defined. See the structures chapter for a description of
1127 <tt/InitRam's/ command string.
1128
1129 <sect2>StashRAM, FetchRAM, SwapRAM, and VerifyRAM
1130 <p>
1131 <tt/void StashRAM (char bank, unsigned length, char *reuAddress, char *cpuAddress)/
1132 <p>
1133 <tt/void FetchRAM (char bank, unsigned length, char *reuAddress, char *cpuAddress)/
1134 <p>
1135 <tt/void SwapRAM (char bank, unsigned length, char *reuAddress, char *cpuAddress)/
1136 <p>
1137 <tt/ char VerifyRAM (char bank, unsigned length, char *reuAddress, char *cpuAddress)/
1138 <p>
1139 These functions are the interface to a REU - Ram Expansion Unit. I think that they are self-explanatory.
1140 You can check for REU presence by taking the value of <tt/ramExpSize/. You have to do it before
1141 using any of these functions.
1142
1143 <sect1>Processes and Multitasking
1144 <p>
1145 Weird? Not at all. GEOS has some limited multitasking ability. You can set up a chain of functions
1146 called in specified intervals and you can put the main program to sleep without disturbing other
1147 tasks and making the user interface unresponsive.
1148
1149 <sect2>InitProcesses
1150 <p>
1151 <tt/void InitProcesses (char number, struct process *processTab)/
1152 <p>
1153 This is the main initialization routine. After calling it processes are set up, but not
1154 enabled. The parameters for <tt/InitProcesses/ are:
1155 <itemize>
1156     <item><tt/number/ - number of processes
1157     <item><tt/processTab/ - a table of <tt/struct process/, with size equal to <tt/number/
1158 </itemize>
1159 <p>
1160 A single task is described by an entry in <tt/processTab/, it contains two values - a <tt/pointer/ to
1161 the task function and a number of <tt/jiffies/ which describe the delay between calls to task. On PAL
1162 systems there are 50 jiffies per second, while on NTSC there are 60.
1163 <p>
1164 The maximum number of tasks is 20. Be warned that GEOS doesn't check if parameters are valid and
1165 if <tt/processTab/ would be too large it would overwrite existing data in GEOS space.
1166 <p>
1167 There's one important thing - the last entry in <tt/processTab/ has to be <tt/NULL,NULL/, so the
1168 maximum size of <tt/processTab/ is equal to 21.
1169 <p>
1170 See the description of <tt/process/ structure for a more detailed discussion on this.
1171
1172 <sect2>RestartProcess and EnableProcess
1173 <p>
1174 <tt/void RestartProcess (char processNumber)/
1175 <p>
1176 <tt/void EnableProcess (char processNumber)/
1177 <p>
1178 These two functions start the task counter. <tt/RestartProcess/ should be called for each process
1179 after <tt/InitProcesses/, because it resets all flags and counters and it starts the counters.
1180 <p>
1181 <tt/RestartProcess/ enables the counters and sets their initial value to that given in <tt/processTab/.
1182 <p>
1183 <tt/EnableProcess/ forces the given process to execute by simulating the timer expiring.
1184
1185 <sect2>BlockProcess and UnblockProcess
1186 <p>
1187 <tt/void BlockProcess (char processNumber)/
1188 <p>
1189 <tt/void UnblockProcess (char processNumber)/
1190 <p>
1191 <tt/BlockProcess/ disables the execution of the given process, but this does not disable the timers.
1192 It means that if you call <tt/UnblockProcess/ before the timer runs out, the process will be executed.
1193 <p>
1194 <tt/UnblockProcess/ does the opposite.
1195
1196 <sect2>FreezeProcess and UnfreezeProcess
1197 <p>
1198 <tt/void FreezeProcess (char processNumber)/
1199 <p>
1200 <tt/void UnfreezeProcess (char processNumber)/
1201 <p>
1202 <tt/FreezeProcess/ disables timer for given process. <tt/UnfreezeProcess/ does the opposite.
1203 This is not equal to <tt/RestartProcess/ as timers are not reloaded with initial value.
1204
1205 <sect2>Sleep
1206 <p>
1207 <tt/void Sleep (unsigned jiffies)/
1208 <p>
1209 This function is a multitasking sleep - the program is halted, but it doesn't block other functions
1210 e.g. callbacks from menus and icons.
1211 The only argument here is the number of jiffies to wait until the app will wake up. It depends on the
1212 video mode (PAL or NTSC) how many jiffies there are per second (50 or 60, respectively).
1213 If you don't want to worry about it and need only full second resolution, call the standard
1214 <tt/sleep/ function from <tt/unistd.h/.
1215
1216 <sect1>System Functions
1217
1218 <sect2>FirstInit
1219 <p>
1220 <tt/void FirstInit (void)/
1221 <p>
1222 This function initializes some GEOS variables and mouse parameters. This is called on GEOS boot
1223 up. You shouldn't use this unless you know what you are doing.
1224
1225 <sect2>InitForIO and DoneWithIO
1226 <p>
1227 <tt/void InitForIO (void)/
1228 <p>
1229 <tt/void DoneWithIO (void)/
1230 <p>
1231 These functions are called by some disk routines. You should call them only if you want to
1232 do something with IO registers or call one of the Kernal ROM routines. Note that this is rather an
1233 expensive way of turning off IRQs and enabling IO.
1234
1235 <sect2>MainLoop
1236 <p>
1237 <tt/void MainLoop (void)/
1238 <p>
1239 Returns control to the system. Any code between call to <tt/MainLoop/ and the end of current
1240 function will never be executed. When in <tt/MainLoop/ the system waits for your action - using
1241 icons, keyboard or menus to force some specific action from the program. You have to define
1242 proper handlers before that.
1243
1244 <sect2>EnterDeskTop
1245 <p>
1246 <tt/void EnterDeskTop (void)/
1247 <p>
1248 This is an alias for <tt/exit(0)/ so you will never burn yourself. Anyway, you should not
1249 use it. Always use <tt/exit()/ instead. Library destructors and functions registered with
1250 <tt/atexit()/ are called.
1251
1252 <sect2>ToBASIC
1253 <p>
1254 <tt/void ToBASIC (void)/
1255 <p>
1256 This one is another way of terminating an application - forcing GEOS to shutdown and exit to BASIC.
1257 I was considering whether to include it or not, but maybe someone will need it - which I doubt.
1258 <p>
1259 <em/WARNING:/ library destructors and functions registered with <tt/atexit()/ will not be called
1260 so it is quite unsafe way to terminate your program.
1261
1262 <sect2>Panic
1263 <p>
1264 <tt/void Panic (void)/
1265 <p>
1266 This calls system's <tt/Panic/ handler - it shows a dialog box with the message
1267 <tscreen><verb>
1268 System error at:xxxx
1269 </verb></tscreen>
1270 where <tt/xxxx/ is last known execution address (caller). By default this is bound to the <tt/BRK/
1271 instruction, but it might be usable in debugging as kind of <tt/assert/. (Note that <tt/assert/
1272 is available as a separate function and will give you more information than that).
1273 <p>
1274 The system is halted after a call to <tt/Panic/ which means that library destructors will not be
1275 called and some data may be lost (no wonder you're panicking).
1276
1277 <sect2>CallRoutine
1278 <p>
1279 <tt/void CallRoutine (void &ast;myFunct)/
1280 <p>
1281 This is a system caller routine. You need to provide a pointer to a function and it will be immediately
1282 called, unless the pointer is equal to <tt/NULL/. This is the main functionality of this function -
1283 you don't need to check if the pointer is valid.
1284
1285 <sect2>GetSerialNumber
1286 <p>
1287 <tt/unsigned GetSerialNumber (void)/
1288 <p>
1289 This function returns the serial number of the system. It might be used for copy-protection.
1290 However, please remember that Free Software is a true power and you are using it right now.
1291
1292 <sect2>GetRandom
1293 <p>
1294 <tt/char GetRandom (void)/
1295 <p>
1296 This function returns a random number. It can be also read from <tt/random/ e.g.
1297 <tscreen><verb>
1298 a=random;
1299 </verb></tscreen>
1300 but by calling this function you are sure that the results will be always different.
1301 <tt/random/ is updated once a frame (50Hz PAL) and on every call to <tt/GetRandom/.
1302 <p>
1303 Note that this is not the same as the <tt/rand/ function from the standard library. <tt/GetRandom/
1304 will give you unpredictable results (if IRQs occur between calls to it) while
1305 <tt/rand/ conforms to the standard and for a given seed (<tt/srand/) always returns with the
1306 same sequence of values.
1307
1308 <sect2>SetDevice
1309 <p>
1310 <tt/void SetDevice (char device)/
1311 <p>
1312 This function sets the current device to the given. It might be used together with <tt/InitForIO/,
1313 <tt/DoneWithIO/ and some Kernal routines. Unless the new device is a disk drive this only sets
1314 new value in <tt/curDevice/, in the other case new disk driver is loaded from REU or internal RAM.
1315
1316 <sect2>get_ostype
1317 <p>
1318 <tt/char get_ostype (void)/
1319 <p>
1320 This function returns the GEOS Kernal version combined (by logical OR) with the machine type. Read
1321 <tt/gsys.h/ for definitions of the returned values.
1322
1323 <sect2>get_tv
1324 <p>
1325 <tt/char get_tv (void)/
1326 <p>
1327 This function returns the PAL/NTSC flag combined (by logical OR) with the 40/80 columns flag. This is
1328 not the best way to check if the screen has 40 or 80 columns since a PAL/NTSC check is always
1329 performed and it can take as long as a full raster frame. If you just want to know if the 
1330 screen has 40 or 80 columns use the expression <tt/graphMode & 0x80/ which returns <tt/0/ for
1331 40 columns and <tt/0x80/ for 80 columns. Remember that this value can be changed during
1332 runtime. It is unclear if this will work for GEOS 64 so you probably do not want to test
1333 anything if not running under GEOS128. Use <tt/get_ostype/ to check it. Read <tt/gsys.h/ for
1334 definitions of the returned values.
1335
1336 <sect>Library Structures
1337 <p>
1338 To simplify usage and optimize passing parameters to functions I have declared several structures
1339 which describe the most common objects. Some of these structures are bound to static addresses in
1340 the GEOS data space (<tt/$8000-$8fff/), so you can use their fields directly in an optimized way.
1341 Please see <tt/gsym.h/ to find them. All structures are defined in <tt/gstruct.h/ and you may
1342 find also some comments there.
1343
1344 <sect1>Graphics Structures
1345
1346 <sect2>pixel
1347 <p>
1348 A simple structure describing a point on the screen.
1349
1350 <sect2>fontdesc
1351 <p>
1352 This structure describes a font in one pointsize. There is the current font - <tt/struct fontdesc/
1353 bound to <tt/curFontDesc/. You can also force GEOS to use your own fonts by calling
1354 <tt/LoadCharSet/. You just need to open a VLIR font file and load one record - one pointsize -
1355 somewhere. At the start of this area you already have all data for <tt/fontdesc/ so you can
1356 pass a pointer to the load address of that pointsize to <tt/LoadCharSet/. (Note that although
1357 it has 'Load' in the name, that function loads only GEOS internal data structures, not data
1358 from disk).
1359
1360 <sect2>window
1361 <p>
1362 This widely used structure holds the description of a region of the screen. It describes the top-left and
1363 bottom-right corners of a window.
1364
1365 <sect2>iconpic
1366 <p>
1367 Maybe the name isn't the best - it has nothing with <tt/DoIcons/ but with bitmap functions -
1368 <tt/BitmapUp/ for example. This structure holds the parameters needed to properly decode and show
1369 a bitmap on the screen. The bitmap has to be encoded - if you have some non-GEOS bitmaps simply
1370 convert them to Photo Scraps - this is the format used by all GEOS bitmap functions - <tt/DoIcons/
1371 too.
1372
1373 <sect1>Icons
1374 <p>
1375 These structures describe click boxes (icons) that can be placed on screen or in a dialog box.
1376
1377 <sect2>icondef
1378 <p>
1379 This is the definition of a single click box. Please see <tt/gstruct.h/ for a description of its fields.
1380
1381 <sect2>icontab
1382 <p>
1383 This is the toplevel description of icons to be placed and enabled on the screen. This structure
1384 has the following fields:
1385 <itemize>
1386     <item><tt/char number/ - total number of icons declared here
1387     <item><tt/struct pixel mousepos/ - after finishing <tt/DoIcons/ the mouse pointer will be placed in
1388         this point allowing you to have a hint for the user what the default action is
1389     <item><tt/struct icondef tab&lsqb;&rsqb/ - this table of size equal to <tt/icontab.number/ contains
1390         descriptions for all icons
1391 </itemize>
1392
1393 <sect1>File and Disk
1394
1395 <sect2>tr_se
1396 <p>
1397 This simple structure holds the track and sector number of something. Do not expect the track to be
1398 in range 1-35, as GEOS can support many various and weird devices. For example my C128 256K
1399 expansion is utilized as RAMDisk with a layout of 4 tracks of 128 sectors each. However assuming that
1400 a track number equal to 0 is illegal might be wise.
1401
1402 <sect2>f_date
1403 <p>
1404 This is a placeholder for a file datestamp. This structure is also present in <tt/struct filehandle/.
1405 GEOS is not Y2K compliant, so if the current file has in <tt/filehandle.date.year/ a value less than 86
1406 you can safely assume that it is e.g. 2004 and not 1904.
1407
1408 <sect2>filehandle
1409 <p>
1410 This is the main file descriptor. It is either an entry in the directory (returned from file functions)
1411 or its copy in <tt/dirEntryBuf/. This is optimized so you can safely get to the file's year e.g.
1412 by testing <tt/dirEntryBuf.date.year/ - it will be compiled to simple <tt/LDA, STA/.
1413
1414 <sect2>fileheader
1415 <p>
1416 This structure holds the fileheader description. You can load a file's header into the <tt/fileHeader/
1417 fixed area using <tt/GetFHdrInfo/. (note that <tt/fileHeader/ is a place in memory while
1418 <tt/fileheader/ is a structure).
1419 You will also need your own fileheader for <tt/SaveFile/.
1420
1421 <sect1>System Structures
1422
1423 <sect2>s_date
1424 <p>
1425 This structure is defined only for <tt/system_date/. It is slightly different from <tt/f_date/
1426 so I prepared this one. You can e.g. get or set the current time using <tt/system_date.s_hour/ and
1427 <tt/system_date.s_minute/. Accesses to these will be optimized to simple <tt/LDA/ and <tt/STA/
1428 pair.
1429
1430 <sect2>process
1431 <p>
1432 You should declare a table of that type to prepare data for <tt/InitProcesses/. The maximum number
1433 of processes is 20, and the last entry has to be equal to <tt/&lcub;NULL,NULL&rcub;/, so this table may hold
1434 only 21 entries. The first member of this structure (<tt/pointer/) holds the pointer to the called
1435 function (void returning void), you will probably have to cast that pointer into <tt/unsigned int/.
1436 The second field <tt/jiffies/ holds the amount of time between calls to that function.
1437 On PAL systems there are 50 jiffies per second, while NTSC have 60 of them.
1438
1439 <sect1>A few things in detail...
1440 <p>
1441 GEOSLib uses cc65 non-ANSI extensions to easily initialize data in memory. This is done with a
1442 kind of array of unspecified length and unspecified type. Here is how it works:
1443 <tscreen><verb>
1444 void example = &lcub;
1445     (char)3, (unsigned)3, (char)0 &rcub;;
1446 </verb></tscreen>
1447 Which will be compiled to following string of bytes:
1448 <tscreen><verb>
1449 _example:
1450         .byte 3
1451         .word 3
1452         .byte 0
1453 </verb></tscreen>
1454 As you see this way it is possible to define data of any type in any order. You must remember to
1455 cast each member to proper type.
1456
1457 <sect2>DoMenu structure
1458 <p>
1459 <tt/DoMenu/ is responsible for everything concerned with menu processing. Many, many GEOS programs
1460 are just initializing the screen and menu and returning to <tt/MainLoop/. In GEOSLib it is the same as
1461 returning from <tt/main/ function without using <tt/exit(0)/.
1462 <p>
1463 A menu is described by two types of data - menu descriptors and menu items. A descriptor contains
1464 information about the following menu items, and items contain names of entries and either
1465 pointers to functions to execute or, in case of nested menus, pointers to submenu descriptors.
1466 Note that submenu descriptor can be top-level descriptor, there's no difference in structure,
1467 just in the content.
1468 <p>
1469 Here is how a single descriptor looks like:
1470 <tscreen><verb>
1471 void myMenu = &lcub;
1472         (char)top, (char)bottom,                // this is the size of the menubox
1473         (unsigned)left, (unsigned)right,        // counting all items in the current descriptor
1474         (char)number_of_items | type_of_menu,   // number of following items ORed with
1475                                                 // type of this menu, it can be either
1476         // HORIZONTAL or VERTICAL if you will have also bit 6 set then menu won't be closed
1477         // after moving mouse pointer outside the menubox. You can have at most 31 items.
1478 </verb></tscreen>
1479 This is followed by <tt/number_of_items/ of following item description.
1480 <tscreen><verb>
1481         ...
1482         "menuitemname", (char)item_type, (unsigned)pointer,
1483         "nextitemname", (char)item_type, (unsigned)pointer,
1484         ...
1485         "lastitemname", (char)item_type, (unsigned)pointer &rcub;;
1486         // Note that there isn't ending <tt/NULL/ or something like that.
1487 </verb></tscreen>
1488 <tt/pointer/ is a pointer to something, what it points for depends from <tt/item_type/. This one
1489 can have following values:
1490 <p>
1491 <tt/MENU_ACTION/ - a function pointed by <tt/pointer/ will be called after clicking on the menu item
1492 <p>
1493 <tt/SUB_MENU/ - <tt/pointer/ points to next menu descriptor - a submenu
1494 <p>
1495 Both of them can be ORed with <tt/DYN_SUB_MENU/ and then the <tt/pointer/ points to a function
1496 which will return in <tt/r0/ the needed pointer (to function to execute or a submenu).
1497 <p>
1498 For creating nested menus (you can have at most 8 levels of submenus) you need to declare such
1499 a structure for each submenu and top level menu.
1500
1501 <sect2>DoDlgBox command string
1502 <p>
1503 <tt/DoDlgBox/ is together with <tt/DoMenu/ one of the most powerful routines in GEOS. It is
1504 responsible for creating dialog boxes, that is windows which task is to interact with the user.
1505 The format of the command string is following:
1506 <tscreen><verb>
1507     (window size and position)
1508     (commands and parameters)
1509     NULL
1510 </verb></tscreen>
1511 There is a custom type defined for the command string: <tt/dlgBoxStr/.
1512
1513 <sect3>Size and position
1514 <p>
1515 The first element can be specified in two ways - by using the default size and position or specifying
1516 your own. The first case results in
1517 <tscreen><verb>
1518 const dlgBoxStr example = &lcub;
1519         DB_DEFPOS (pattern_of_shadow),
1520         ...             // commands
1521         DB_END &rcub;;
1522 </verb></tscreen>
1523 And the own size and position would be:
1524 <tscreen><verb>
1525 const dlgBoxStr example = &lcub;
1526         DB_SETPOS (pattern, top, bottom, left, right)
1527         ...             // commands
1528         DB_END &rcub;;
1529 </verb></tscreen>
1530
1531 <sect3>Commands
1532 <p>
1533 The next element of the <tt/DoDlgBox/ command string are the commands themselves. The first six commands are
1534 default icons and the number of the selected icon will be returned from window processor. The icons are
1535 <tt/OK, CANCEL, YES, NO, OPEN/, and <tt/DISK/. You can use predefined macros for using them, e.g.:
1536 <tscreen><verb>
1537         ...
1538         DB_ICON(OK, DBI_X_0, DBI_Y_0),
1539         ...
1540 </verb></tscreen>
1541 Note that the position is counted from top left corner of window, not entire screen and that the 'x'
1542 position is counted in cards (8-pixel) and not in pixels. This is also true for all following commands.
1543 <tt/DBI_X_0/ and <tt/DBI_Y_0/ are predefined (see <tt/gdlgbox.h/ for more), the default positions
1544 which will cause icons to appear on a default window exactly where you would expect them.
1545 <p>
1546 <tt/DB_TXTSTR (x, y, text)/ will cause to show the given text in the window.
1547 <p>
1548 <tt/DB_VARSTR (x, y, ptr)/ works as above, but here you are passing a pointer to a zero page location
1549 where the address of the text is stored. This is useful for information windows where only the text content
1550 is variable. Consider following:
1551 <tscreen><verb>
1552 char text = "foo";
1553         ...
1554         r15=(unsigned)text;             // in code just before call to DoDlgBox
1555         ...
1556         DB_VARSTR (TXT_LN_X, TXT_LN_1_Y, &amp;r15),
1557         ...
1558 </verb></tscreen>
1559 will cause the word ``foo'' to appear in the window, but you may store the pointer to any text in
1560 <tt/r15/ (in this case) before the call to DoDlgBox.
1561 <p>
1562 <tt/DB_GETSTR(x, y, ptr, length)/ - will add a input-from-keyboard feature. <tt/ptr/ works as in the
1563 previous example and points to the location where the text is to be stored. Note that the contents of this
1564 location will be shown upon creating the window. <tt/length/ is the maximum number of characters to input.
1565 <p>
1566 <tt/DB_SYSOPV(ptr)/ - this sets <tt/otherPressVec/ to the given pointer. It is called on every keypress.
1567 <p>
1568 <tt/DB_GRPHSTR(ptr)/ - the data for this command is a pointer for <tt/GraphicsString/ commands.
1569 <p>
1570 <tt/DB_GETFILES(x, y)/ - for a standard window you should pass 4 for both x and y. This function
1571 draws a file selection box and searches the current drive for files. Before the call to <tt/DoDlgBox/ you
1572 must load <tt/r7L/ with the GEOS filetype of searched files and <tt/r10/ with the class text. In <tt/r5/
1573 you have to load a pointer to a <tt/char&lsqb;17&rsqb;/ where the selected filename will be copied. It works
1574 like <tt/FindFTypes/ but is limited to first 16 files.
1575 <p>
1576 <tt/DB_OPVEC(ptr)/ - this sets a new pointer for the button press function, if you pass
1577 <tt/RstrFrmDialogue/ here you will cause the window to close after pressing mouse button.
1578 <p>
1579 <tt/DB_USRICON(x, y, ptr)/ - places a single user icon (click box) on the window, <tt/ptr/ points at a
1580 <tt/struct icondef/ but fields <tt/x/ and <tt/y/ are not used here. You can have at most 8 click
1581 boxes in a window, this is an internal limit of the GEOS Kernal.
1582 <p>
1583 <tt/DB_USRROUT(ptr)/ - this command causes to immediately call the user routine pointed by <tt/ptr/.
1584
1585 <sect2>GraphicsString command string
1586 <p>
1587 <tt/GraphicsString/ is a very powerful routine to initialize the whole screen at once. There are
1588 predefined macros for all commands, names are self-explanatory, see them in <tt/ggraph.h/. The last
1589 command has to be <tt/GSTR_END/. There is a custom type defined for the command string: <tt/graphicStr/.
1590 <p>
1591 Here is an example for clearing the screen:
1592 <tscreen><verb>
1593 const graphicStr example = &lcub;
1594         MOVEPENTO(0,0),
1595         NEWPATTERN(0),
1596         RECTANGLETO(319,199)
1597         GSTR_END &rcub;;
1598 </verb></tscreen>
1599
1600 <sect2>InitRam table
1601 <p>
1602 This type of data is used to initialize one or more bytes in different locations at once. The format is
1603 the following:
1604 <tscreen><verb>
1605 void example = &lcub;
1606     (unsigned)address_to_store_values_at,
1607     (char)number_of_bytes_that_follow,
1608     (char)data,(char)data (...)
1609     // more such definitions
1610     (unsigned)NULL // address of 0 ends the table
1611     &rcub;;
1612 </verb></tscreen>
1613
1614 <sect2>Intercepting system vectors
1615 <p>
1616 It is possible to intercept events and hook into the GEOS Kernal using vectors. Here is a little example:
1617 <tscreen><verb>
1618 void_func oldVector;
1619
1620 void NewVectorHandler(void) &lcub;
1621         // do something and at the end call the old vector routine
1622         oldVector();
1623 &rcub;
1624
1625 void hook_into_system(void) &lcub;
1626         oldVector = mouseVector;
1627         mouseVector = NewVectorHandler;
1628 &rcub;
1629
1630 void remove_hook(void) &lcub;
1631         mouseVector = oldVector;
1632 &rcub;
1633 </verb></tscreen>
1634 <p>
1635 In your <tt/main/ function you should call <tt/hook_into_system()/ but <em/after/ all calls to the GEOS
1636 Kernal (like <tt/DoMenu/, <tt/DoIcons/, etc.) - right before passing control to the <tt/MainLoop()/.
1637 Be warned that vectors are most likely to be changed by the GEOS Kernal also via other functions (like
1638 <tt/GotoFirstMenu/, <tt/DoDlgBox/ and its derivatives etc.). It depends on what Kernal functions
1639 you use and which vectors you altered. Unfortunately there is no exact list for GEOS 2.0, a complete
1640 list for GEOS 1.x can be found in A. Boyce's Programmers' Reference Guide mentioned before. Most of the
1641 information contained there should be still valid for GEOS 2.0. When calling a function that restores
1642 the vector you should add a <tt/hook_into_system()/ call right after it.
1643 <p>
1644 It is critical to restore old vector values before exiting the program. If you have more than one
1645 place where you call <tt/exit()/ then it might be worth to register <tt/remove_hook/ function to
1646 be called upon exiting with <tt/atexit(&amp;remove_hook);/ call. This way you will ensure that
1647 such destructor will be always called.
1648 <p>
1649 That little example above intercepts <tt/mouseVector/. The <tt/NewVectorHandler/ function will be
1650 called every time the mouse button changes status. Other important vectors you should know about
1651 are:
1652 <itemize>
1653         <item><tt/appMain/ - this is called from within the <tt/MainLoop/ system loop
1654         <item><tt/keyVector/ - called whenever a keypress occurs
1655         <item><tt/intTopVector/ - called at the start of the IRQ routine
1656         <item><tt/intBotVector/ - called at the end of the IRQ routine
1657 </itemize>
1658
1659 </article>