Home » Archimedes archive » Acorn User » Acorn User - Shareware Collection (1993).adf » Zap » !Zap/Docs/E-Vars

!Zap/Docs/E-Vars

This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.

Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.

Tape/disk: Home » Archimedes archive » Acorn User » Acorn User - Shareware Collection (1993).adf » Zap
Filename: !Zap/Docs/E-Vars
Read OK:
File size: 06E5 bytes
Load address: 0000
Exec address: 0000
File contents
*************************************************************************
* >E-Vars	Documents the variable numbers used by Zap_ReadVar	*
*************************************************************************

This documents the variable numbers used by the Zap_ReadVar and Zap_WriteVar
calls. Please note that the variables with names beginning 'opt_' are stored
in the !Config file and thus saved when the user clicks 'Options.Save'. Each
mode is assigned one word in the !Config file called opt_moden where 'n' is
your mode number. This corresponds to the default setting of w_moden, the
mode word for a window. See E-Flags for the suggested format of your mode
word.

Number:	Variable name:	Contents:

0	scn_xos		Screen horizontal size (in os coords)
1	scn_yos		Screen vertical size (in os coords)
2	opt_flags	Config file flags word  (see E-Flags)
3	opt_format	Config file format word (see E-Format)
4	wimp_task	Zaps task handle
5	car_cursor	Cursor caret block pointer (see E-Cursors)
6	car_input	Input caret block pointer (see E-Cursors)
7	car_selection	Selection caret block pointer (see E-Cursors)
8	wind_num	Number of window blocks (see E-Windows)
9	file_num	Number of file blocks (see E-File)
10	car_mode	Current cursor editing mode (see E-Cursors)

&100	opt_mode0	Text mode word (see E-Flags for format)
&101	opt_mode1	Byte mode word
&102	opt_mode2	Word mode word
&103	opt_mode3	Ascii mode word
&104	opt_mode4	Code mode word
&105	opt_mode5	Basic mode word
&106	opt_mode6	Mode 6 word
&107	opt_mode7	Mode 7 word
&108	opt_mode8	Mode 8 word
&109	opt_mode9	Mode 9 word
&10A	opt_mode10	Mode 10 word
&10B	opt_mode11	Throwback mode word
&10C	opt_mode12	Taskwindow mode word
&10D	opt_mode13	Mode 13 word
&10E	opt_mode14	Mode 14 word
&10F	opt_mode15	Mode 15 word
00000000  2a 2a 2a 2a 2a 2a 2a 2a  2a 2a 2a 2a 2a 2a 2a 2a  |****************|
*
00000040  2a 2a 2a 2a 2a 2a 2a 2a  2a 0a 2a 20 3e 45 2d 56  |*********.* >E-V|
00000050  61 72 73 09 44 6f 63 75  6d 65 6e 74 73 20 74 68  |ars.Documents th|
00000060  65 20 76 61 72 69 61 62  6c 65 20 6e 75 6d 62 65  |e variable numbe|
00000070  72 73 20 75 73 65 64 20  62 79 20 5a 61 70 5f 52  |rs used by Zap_R|
00000080  65 61 64 56 61 72 09 2a  0a 2a 2a 2a 2a 2a 2a 2a  |eadVar.*.*******|
00000090  2a 2a 2a 2a 2a 2a 2a 2a  2a 2a 2a 2a 2a 2a 2a 2a  |****************|
*
000000d0  2a 2a 0a 0a 54 68 69 73  20 64 6f 63 75 6d 65 6e  |**..This documen|
000000e0  74 73 20 74 68 65 20 76  61 72 69 61 62 6c 65 20  |ts the variable |
000000f0  6e 75 6d 62 65 72 73 20  75 73 65 64 20 62 79 20  |numbers used by |
00000100  74 68 65 20 5a 61 70 5f  52 65 61 64 56 61 72 20  |the Zap_ReadVar |
00000110  61 6e 64 20 5a 61 70 5f  57 72 69 74 65 56 61 72  |and Zap_WriteVar|
00000120  0a 63 61 6c 6c 73 2e 20  50 6c 65 61 73 65 20 6e  |.calls. Please n|
00000130  6f 74 65 20 74 68 61 74  20 74 68 65 20 76 61 72  |ote that the var|
00000140  69 61 62 6c 65 73 20 77  69 74 68 20 6e 61 6d 65  |iables with name|
00000150  73 20 62 65 67 69 6e 6e  69 6e 67 20 27 6f 70 74  |s beginning 'opt|
00000160  5f 27 20 61 72 65 20 73  74 6f 72 65 64 0a 69 6e  |_' are stored.in|
00000170  20 74 68 65 20 21 43 6f  6e 66 69 67 20 66 69 6c  | the !Config fil|
00000180  65 20 61 6e 64 20 74 68  75 73 20 73 61 76 65 64  |e and thus saved|
00000190  20 77 68 65 6e 20 74 68  65 20 75 73 65 72 20 63  | when the user c|
000001a0  6c 69 63 6b 73 20 27 4f  70 74 69 6f 6e 73 2e 53  |licks 'Options.S|
000001b0  61 76 65 27 2e 20 45 61  63 68 0a 6d 6f 64 65 20  |ave'. Each.mode |
000001c0  69 73 20 61 73 73 69 67  6e 65 64 20 6f 6e 65 20  |is assigned one |
000001d0  77 6f 72 64 20 69 6e 20  74 68 65 20 21 43 6f 6e  |word in the !Con|
000001e0  66 69 67 20 66 69 6c 65  20 63 61 6c 6c 65 64 20  |fig file called |
000001f0  6f 70 74 5f 6d 6f 64 65  6e 20 77 68 65 72 65 20  |opt_moden where |
00000200  27 6e 27 20 69 73 0a 79  6f 75 72 20 6d 6f 64 65  |'n' is.your mode|
00000210  20 6e 75 6d 62 65 72 2e  20 54 68 69 73 20 63 6f  | number. This co|
00000220  72 72 65 73 70 6f 6e 64  73 20 74 6f 20 74 68 65  |rresponds to the|
00000230  20 64 65 66 61 75 6c 74  20 73 65 74 74 69 6e 67  | default setting|
00000240  20 6f 66 20 77 5f 6d 6f  64 65 6e 2c 20 74 68 65  | of w_moden, the|
00000250  0a 6d 6f 64 65 20 77 6f  72 64 20 66 6f 72 20 61  |.mode word for a|
00000260  20 77 69 6e 64 6f 77 2e  20 53 65 65 20 45 2d 46  | window. See E-F|
00000270  6c 61 67 73 20 66 6f 72  20 74 68 65 20 73 75 67  |lags for the sug|
00000280  67 65 73 74 65 64 20 66  6f 72 6d 61 74 20 6f 66  |gested format of|
00000290  20 79 6f 75 72 20 6d 6f  64 65 0a 77 6f 72 64 2e  | your mode.word.|
000002a0  0a 0a 4e 75 6d 62 65 72  3a 09 56 61 72 69 61 62  |..Number:.Variab|
000002b0  6c 65 20 6e 61 6d 65 3a  09 43 6f 6e 74 65 6e 74  |le name:.Content|
000002c0  73 3a 0a 0a 30 09 73 63  6e 5f 78 6f 73 09 09 53  |s:..0.scn_xos..S|
000002d0  63 72 65 65 6e 20 68 6f  72 69 7a 6f 6e 74 61 6c  |creen horizontal|
000002e0  20 73 69 7a 65 20 28 69  6e 20 6f 73 20 63 6f 6f  | size (in os coo|
000002f0  72 64 73 29 0a 31 09 73  63 6e 5f 79 6f 73 09 09  |rds).1.scn_yos..|
00000300  53 63 72 65 65 6e 20 76  65 72 74 69 63 61 6c 20  |Screen vertical |
00000310  73 69 7a 65 20 28 69 6e  20 6f 73 20 63 6f 6f 72  |size (in os coor|
00000320  64 73 29 0a 32 09 6f 70  74 5f 66 6c 61 67 73 09  |ds).2.opt_flags.|
00000330  43 6f 6e 66 69 67 20 66  69 6c 65 20 66 6c 61 67  |Config file flag|
00000340  73 20 77 6f 72 64 20 20  28 73 65 65 20 45 2d 46  |s word  (see E-F|
00000350  6c 61 67 73 29 0a 33 09  6f 70 74 5f 66 6f 72 6d  |lags).3.opt_form|
00000360  61 74 09 43 6f 6e 66 69  67 20 66 69 6c 65 20 66  |at.Config file f|
00000370  6f 72 6d 61 74 20 77 6f  72 64 20 28 73 65 65 20  |ormat word (see |
00000380  45 2d 46 6f 72 6d 61 74  29 0a 34 09 77 69 6d 70  |E-Format).4.wimp|
00000390  5f 74 61 73 6b 09 5a 61  70 73 20 74 61 73 6b 20  |_task.Zaps task |
000003a0  68 61 6e 64 6c 65 0a 35  09 63 61 72 5f 63 75 72  |handle.5.car_cur|
000003b0  73 6f 72 09 43 75 72 73  6f 72 20 63 61 72 65 74  |sor.Cursor caret|
000003c0  20 62 6c 6f 63 6b 20 70  6f 69 6e 74 65 72 20 28  | block pointer (|
000003d0  73 65 65 20 45 2d 43 75  72 73 6f 72 73 29 0a 36  |see E-Cursors).6|
000003e0  09 63 61 72 5f 69 6e 70  75 74 09 49 6e 70 75 74  |.car_input.Input|
000003f0  20 63 61 72 65 74 20 62  6c 6f 63 6b 20 70 6f 69  | caret block poi|
00000400  6e 74 65 72 20 28 73 65  65 20 45 2d 43 75 72 73  |nter (see E-Curs|
00000410  6f 72 73 29 0a 37 09 63  61 72 5f 73 65 6c 65 63  |ors).7.car_selec|
00000420  74 69 6f 6e 09 53 65 6c  65 63 74 69 6f 6e 20 63  |tion.Selection c|
00000430  61 72 65 74 20 62 6c 6f  63 6b 20 70 6f 69 6e 74  |aret block point|
00000440  65 72 20 28 73 65 65 20  45 2d 43 75 72 73 6f 72  |er (see E-Cursor|
00000450  73 29 0a 38 09 77 69 6e  64 5f 6e 75 6d 09 4e 75  |s).8.wind_num.Nu|
00000460  6d 62 65 72 20 6f 66 20  77 69 6e 64 6f 77 20 62  |mber of window b|
00000470  6c 6f 63 6b 73 20 28 73  65 65 20 45 2d 57 69 6e  |locks (see E-Win|
00000480  64 6f 77 73 29 0a 39 09  66 69 6c 65 5f 6e 75 6d  |dows).9.file_num|
00000490  09 4e 75 6d 62 65 72 20  6f 66 20 66 69 6c 65 20  |.Number of file |
000004a0  62 6c 6f 63 6b 73 20 28  73 65 65 20 45 2d 46 69  |blocks (see E-Fi|
000004b0  6c 65 29 0a 31 30 09 63  61 72 5f 6d 6f 64 65 09  |le).10.car_mode.|
000004c0  43 75 72 72 65 6e 74 20  63 75 72 73 6f 72 20 65  |Current cursor e|
000004d0  64 69 74 69 6e 67 20 6d  6f 64 65 20 28 73 65 65  |diting mode (see|
000004e0  20 45 2d 43 75 72 73 6f  72 73 29 0a 0a 26 31 30  | E-Cursors)..&10|
000004f0  30 09 6f 70 74 5f 6d 6f  64 65 30 09 54 65 78 74  |0.opt_mode0.Text|
00000500  20 6d 6f 64 65 20 77 6f  72 64 20 28 73 65 65 20  | mode word (see |
00000510  45 2d 46 6c 61 67 73 20  66 6f 72 20 66 6f 72 6d  |E-Flags for form|
00000520  61 74 29 0a 26 31 30 31  09 6f 70 74 5f 6d 6f 64  |at).&101.opt_mod|
00000530  65 31 09 42 79 74 65 20  6d 6f 64 65 20 77 6f 72  |e1.Byte mode wor|
00000540  64 0a 26 31 30 32 09 6f  70 74 5f 6d 6f 64 65 32  |d.&102.opt_mode2|
00000550  09 57 6f 72 64 20 6d 6f  64 65 20 77 6f 72 64 0a  |.Word mode word.|
00000560  26 31 30 33 09 6f 70 74  5f 6d 6f 64 65 33 09 41  |&103.opt_mode3.A|
00000570  73 63 69 69 20 6d 6f 64  65 20 77 6f 72 64 0a 26  |scii mode word.&|
00000580  31 30 34 09 6f 70 74 5f  6d 6f 64 65 34 09 43 6f  |104.opt_mode4.Co|
00000590  64 65 20 6d 6f 64 65 20  77 6f 72 64 0a 26 31 30  |de mode word.&10|
000005a0  35 09 6f 70 74 5f 6d 6f  64 65 35 09 42 61 73 69  |5.opt_mode5.Basi|
000005b0  63 20 6d 6f 64 65 20 77  6f 72 64 0a 26 31 30 36  |c mode word.&106|
000005c0  09 6f 70 74 5f 6d 6f 64  65 36 09 4d 6f 64 65 20  |.opt_mode6.Mode |
000005d0  36 20 77 6f 72 64 0a 26  31 30 37 09 6f 70 74 5f  |6 word.&107.opt_|
000005e0  6d 6f 64 65 37 09 4d 6f  64 65 20 37 20 77 6f 72  |mode7.Mode 7 wor|
000005f0  64 0a 26 31 30 38 09 6f  70 74 5f 6d 6f 64 65 38  |d.&108.opt_mode8|
00000600  09 4d 6f 64 65 20 38 20  77 6f 72 64 0a 26 31 30  |.Mode 8 word.&10|
00000610  39 09 6f 70 74 5f 6d 6f  64 65 39 09 4d 6f 64 65  |9.opt_mode9.Mode|
00000620  20 39 20 77 6f 72 64 0a  26 31 30 41 09 6f 70 74  | 9 word.&10A.opt|
00000630  5f 6d 6f 64 65 31 30 09  4d 6f 64 65 20 31 30 20  |_mode10.Mode 10 |
00000640  77 6f 72 64 0a 26 31 30  42 09 6f 70 74 5f 6d 6f  |word.&10B.opt_mo|
00000650  64 65 31 31 09 54 68 72  6f 77 62 61 63 6b 20 6d  |de11.Throwback m|
00000660  6f 64 65 20 77 6f 72 64  0a 26 31 30 43 09 6f 70  |ode word.&10C.op|
00000670  74 5f 6d 6f 64 65 31 32  09 54 61 73 6b 77 69 6e  |t_mode12.Taskwin|
00000680  64 6f 77 20 6d 6f 64 65  20 77 6f 72 64 0a 26 31  |dow mode word.&1|
00000690  30 44 09 6f 70 74 5f 6d  6f 64 65 31 33 09 4d 6f  |0D.opt_mode13.Mo|
000006a0  64 65 20 31 33 20 77 6f  72 64 0a 26 31 30 45 09  |de 13 word.&10E.|
000006b0  6f 70 74 5f 6d 6f 64 65  31 34 09 4d 6f 64 65 20  |opt_mode14.Mode |
000006c0  31 34 20 77 6f 72 64 0a  26 31 30 46 09 6f 70 74  |14 word.&10F.opt|
000006d0  5f 6d 6f 64 65 31 35 09  4d 6f 64 65 20 31 35 20  |_mode15.Mode 15 |
000006e0  77 6f 72 64 0a                                    |word.|
000006e5