Home » Archimedes archive » Archimedes World » archimedes_world_volume_15_issue_1_scp.adf » !ProFiler_ProFiler » !ProFiler/Dox/SysVars

!ProFiler/Dox/SysVars

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 » Archimedes World » archimedes_world_volume_15_issue_1_scp.adf » !ProFiler_ProFiler
Filename: !ProFiler/Dox/SysVars
Read OK:
File size: 0696 bytes
Load address: 0000
Exec address: 0000
File contents
<html><head><title>ProFiler system variables</title></head>

<body>
<h1><center><u>ProFiler system variables</u></center></h1>

There are several system variables in use. Some of them are documented elsewhere, the rest of them below.

<h2>Filer$Selected</h2>

This variable contains the first selected file in the current viewer. The
'current viewer' in this context is the latest one with the input focus. If no such file can be determined, the variable contains "null:".
Setting this variable to a filename causes the file to be selected if
a viewer is showing it.

This variable is most useful when defining custom filer keys. For example:<br>
<kbd>SetMacro Filer$Key_1DD IconSprites &lt;Filer$Selected&gt;</kbd><br>
�will cause Shift-Insert to load the selected file into the wimp sprite pool.

<h2>Filer$Viewer</h2>

This variable contains the name of the current viewer. If there is no current viewer, the variable contains "null:".

This variable can be used for the same kind of things as Filer$Selected. I also use it as an easy way of outputting files from simple Basic programs.

<h2>Filer$Key_xxx</h2>

When a key is pressed in a filer viewer, the configured action is taken. If there is no configured action, the variable <code>Filer$Key_kkk</code> is checked. If it exists, the contents of it is executed as a task. If not, the key is passed on to the remaining applications. See Filer$Selected above for an example key definition.

<h2>File$Type_xxx</h2>
<h2>Dir$Type_xxxx</h2>
See <a href="./ExtTypes">ExtTypes</a>.

<h2>Alias$@BootDir_xxxx</h2>
<h2>Alias$@RunDir_xxxx</h2>
<h2>Alias$@RunType_xxx</h2>
See <a href="./RunAndBoot">Running and booting</a>.

</body></html>
00000000  3c 68 74 6d 6c 3e 3c 68  65 61 64 3e 3c 74 69 74  |<html><head><tit|
00000010  6c 65 3e 50 72 6f 46 69  6c 65 72 20 73 79 73 74  |le>ProFiler syst|
00000020  65 6d 20 76 61 72 69 61  62 6c 65 73 3c 2f 74 69  |em variables</ti|
00000030  74 6c 65 3e 3c 2f 68 65  61 64 3e 0a 0a 3c 62 6f  |tle></head>..<bo|
00000040  64 79 3e 0a 3c 68 31 3e  3c 63 65 6e 74 65 72 3e  |dy>.<h1><center>|
00000050  3c 75 3e 50 72 6f 46 69  6c 65 72 20 73 79 73 74  |<u>ProFiler syst|
00000060  65 6d 20 76 61 72 69 61  62 6c 65 73 3c 2f 75 3e  |em variables</u>|
00000070  3c 2f 63 65 6e 74 65 72  3e 3c 2f 68 31 3e 0a 0a  |</center></h1>..|
00000080  54 68 65 72 65 20 61 72  65 20 73 65 76 65 72 61  |There are severa|
00000090  6c 20 73 79 73 74 65 6d  20 76 61 72 69 61 62 6c  |l system variabl|
000000a0  65 73 20 69 6e 20 75 73  65 2e 20 53 6f 6d 65 20  |es in use. Some |
000000b0  6f 66 20 74 68 65 6d 20  61 72 65 20 64 6f 63 75  |of them are docu|
000000c0  6d 65 6e 74 65 64 20 65  6c 73 65 77 68 65 72 65  |mented elsewhere|
000000d0  2c 20 74 68 65 20 72 65  73 74 20 6f 66 20 74 68  |, the rest of th|
000000e0  65 6d 20 62 65 6c 6f 77  2e 0a 0a 3c 68 32 3e 46  |em below...<h2>F|
000000f0  69 6c 65 72 24 53 65 6c  65 63 74 65 64 3c 2f 68  |iler$Selected</h|
00000100  32 3e 0a 0a 54 68 69 73  20 76 61 72 69 61 62 6c  |2>..This variabl|
00000110  65 20 63 6f 6e 74 61 69  6e 73 20 74 68 65 20 66  |e contains the f|
00000120  69 72 73 74 20 73 65 6c  65 63 74 65 64 20 66 69  |irst selected fi|
00000130  6c 65 20 69 6e 20 74 68  65 20 63 75 72 72 65 6e  |le in the curren|
00000140  74 20 76 69 65 77 65 72  2e 20 54 68 65 0a 27 63  |t viewer. The.'c|
00000150  75 72 72 65 6e 74 20 76  69 65 77 65 72 27 20 69  |urrent viewer' i|
00000160  6e 20 74 68 69 73 20 63  6f 6e 74 65 78 74 20 69  |n this context i|
00000170  73 20 74 68 65 20 6c 61  74 65 73 74 20 6f 6e 65  |s the latest one|
00000180  20 77 69 74 68 20 74 68  65 20 69 6e 70 75 74 20  | with the input |
00000190  66 6f 63 75 73 2e 20 49  66 20 6e 6f 20 73 75 63  |focus. If no suc|
000001a0  68 20 66 69 6c 65 20 63  61 6e 20 62 65 20 64 65  |h file can be de|
000001b0  74 65 72 6d 69 6e 65 64  2c 20 74 68 65 20 76 61  |termined, the va|
000001c0  72 69 61 62 6c 65 20 63  6f 6e 74 61 69 6e 73 20  |riable contains |
000001d0  22 6e 75 6c 6c 3a 22 2e  0a 53 65 74 74 69 6e 67  |"null:"..Setting|
000001e0  20 74 68 69 73 20 76 61  72 69 61 62 6c 65 20 74  | this variable t|
000001f0  6f 20 61 20 66 69 6c 65  6e 61 6d 65 20 63 61 75  |o a filename cau|
00000200  73 65 73 20 74 68 65 20  66 69 6c 65 20 74 6f 20  |ses the file to |
00000210  62 65 20 73 65 6c 65 63  74 65 64 20 69 66 0a 61  |be selected if.a|
00000220  20 76 69 65 77 65 72 20  69 73 20 73 68 6f 77 69  | viewer is showi|
00000230  6e 67 20 69 74 2e 0a 0a  54 68 69 73 20 76 61 72  |ng it...This var|
00000240  69 61 62 6c 65 20 69 73  20 6d 6f 73 74 20 75 73  |iable is most us|
00000250  65 66 75 6c 20 77 68 65  6e 20 64 65 66 69 6e 69  |eful when defini|
00000260  6e 67 20 63 75 73 74 6f  6d 20 66 69 6c 65 72 20  |ng custom filer |
00000270  6b 65 79 73 2e 20 46 6f  72 20 65 78 61 6d 70 6c  |keys. For exampl|
00000280  65 3a 3c 62 72 3e 0a 3c  6b 62 64 3e 53 65 74 4d  |e:<br>.<kbd>SetM|
00000290  61 63 72 6f 20 46 69 6c  65 72 24 4b 65 79 5f 31  |acro Filer$Key_1|
000002a0  44 44 20 49 63 6f 6e 53  70 72 69 74 65 73 20 26  |DD IconSprites &|
000002b0  6c 74 3b 46 69 6c 65 72  24 53 65 6c 65 63 74 65  |lt;Filer$Selecte|
000002c0  64 26 67 74 3b 3c 2f 6b  62 64 3e 3c 62 72 3e 0a  |d&gt;</kbd><br>.|
000002d0  8c 77 69 6c 6c 20 63 61  75 73 65 20 53 68 69 66  |.will cause Shif|
000002e0  74 2d 49 6e 73 65 72 74  20 74 6f 20 6c 6f 61 64  |t-Insert to load|
000002f0  20 74 68 65 20 73 65 6c  65 63 74 65 64 20 66 69  | the selected fi|
00000300  6c 65 20 69 6e 74 6f 20  74 68 65 20 77 69 6d 70  |le into the wimp|
00000310  20 73 70 72 69 74 65 20  70 6f 6f 6c 2e 0a 0a 3c  | sprite pool...<|
00000320  68 32 3e 46 69 6c 65 72  24 56 69 65 77 65 72 3c  |h2>Filer$Viewer<|
00000330  2f 68 32 3e 0a 0a 54 68  69 73 20 76 61 72 69 61  |/h2>..This varia|
00000340  62 6c 65 20 63 6f 6e 74  61 69 6e 73 20 74 68 65  |ble contains the|
00000350  20 6e 61 6d 65 20 6f 66  20 74 68 65 20 63 75 72  | name of the cur|
00000360  72 65 6e 74 20 76 69 65  77 65 72 2e 20 49 66 20  |rent viewer. If |
00000370  74 68 65 72 65 20 69 73  20 6e 6f 20 63 75 72 72  |there is no curr|
00000380  65 6e 74 20 76 69 65 77  65 72 2c 20 74 68 65 20  |ent viewer, the |
00000390  76 61 72 69 61 62 6c 65  20 63 6f 6e 74 61 69 6e  |variable contain|
000003a0  73 20 22 6e 75 6c 6c 3a  22 2e 0a 0a 54 68 69 73  |s "null:"...This|
000003b0  20 76 61 72 69 61 62 6c  65 20 63 61 6e 20 62 65  | variable can be|
000003c0  20 75 73 65 64 20 66 6f  72 20 74 68 65 20 73 61  | used for the sa|
000003d0  6d 65 20 6b 69 6e 64 20  6f 66 20 74 68 69 6e 67  |me kind of thing|
000003e0  73 20 61 73 20 46 69 6c  65 72 24 53 65 6c 65 63  |s as Filer$Selec|
000003f0  74 65 64 2e 20 49 20 61  6c 73 6f 20 75 73 65 20  |ted. I also use |
00000400  69 74 20 61 73 20 61 6e  20 65 61 73 79 20 77 61  |it as an easy wa|
00000410  79 20 6f 66 20 6f 75 74  70 75 74 74 69 6e 67 20  |y of outputting |
00000420  66 69 6c 65 73 20 66 72  6f 6d 20 73 69 6d 70 6c  |files from simpl|
00000430  65 20 42 61 73 69 63 20  70 72 6f 67 72 61 6d 73  |e Basic programs|
00000440  2e 0a 0a 3c 68 32 3e 46  69 6c 65 72 24 4b 65 79  |...<h2>Filer$Key|
00000450  5f 78 78 78 3c 2f 68 32  3e 0a 0a 57 68 65 6e 20  |_xxx</h2>..When |
00000460  61 20 6b 65 79 20 69 73  20 70 72 65 73 73 65 64  |a key is pressed|
00000470  20 69 6e 20 61 20 66 69  6c 65 72 20 76 69 65 77  | in a filer view|
00000480  65 72 2c 20 74 68 65 20  63 6f 6e 66 69 67 75 72  |er, the configur|
00000490  65 64 20 61 63 74 69 6f  6e 20 69 73 20 74 61 6b  |ed action is tak|
000004a0  65 6e 2e 20 49 66 20 74  68 65 72 65 20 69 73 20  |en. If there is |
000004b0  6e 6f 20 63 6f 6e 66 69  67 75 72 65 64 20 61 63  |no configured ac|
000004c0  74 69 6f 6e 2c 20 74 68  65 20 76 61 72 69 61 62  |tion, the variab|
000004d0  6c 65 20 3c 63 6f 64 65  3e 46 69 6c 65 72 24 4b  |le <code>Filer$K|
000004e0  65 79 5f 6b 6b 6b 3c 2f  63 6f 64 65 3e 20 69 73  |ey_kkk</code> is|
000004f0  20 63 68 65 63 6b 65 64  2e 20 49 66 20 69 74 20  | checked. If it |
00000500  65 78 69 73 74 73 2c 20  74 68 65 20 63 6f 6e 74  |exists, the cont|
00000510  65 6e 74 73 20 6f 66 20  69 74 20 69 73 20 65 78  |ents of it is ex|
00000520  65 63 75 74 65 64 20 61  73 20 61 20 74 61 73 6b  |ecuted as a task|
00000530  2e 20 49 66 20 6e 6f 74  2c 20 74 68 65 20 6b 65  |. If not, the ke|
00000540  79 20 69 73 20 70 61 73  73 65 64 20 6f 6e 20 74  |y is passed on t|
00000550  6f 20 74 68 65 20 72 65  6d 61 69 6e 69 6e 67 20  |o the remaining |
00000560  61 70 70 6c 69 63 61 74  69 6f 6e 73 2e 20 53 65  |applications. Se|
00000570  65 20 46 69 6c 65 72 24  53 65 6c 65 63 74 65 64  |e Filer$Selected|
00000580  20 61 62 6f 76 65 20 66  6f 72 20 61 6e 20 65 78  | above for an ex|
00000590  61 6d 70 6c 65 20 6b 65  79 20 64 65 66 69 6e 69  |ample key defini|
000005a0  74 69 6f 6e 2e 0a 0a 3c  68 32 3e 46 69 6c 65 24  |tion...<h2>File$|
000005b0  54 79 70 65 5f 78 78 78  3c 2f 68 32 3e 0a 3c 68  |Type_xxx</h2>.<h|
000005c0  32 3e 44 69 72 24 54 79  70 65 5f 78 78 78 78 3c  |2>Dir$Type_xxxx<|
000005d0  2f 68 32 3e 0a 53 65 65  20 3c 61 20 68 72 65 66  |/h2>.See <a href|
000005e0  3d 22 2e 2f 45 78 74 54  79 70 65 73 22 3e 45 78  |="./ExtTypes">Ex|
000005f0  74 54 79 70 65 73 3c 2f  61 3e 2e 0a 0a 3c 68 32  |tTypes</a>...<h2|
00000600  3e 41 6c 69 61 73 24 40  42 6f 6f 74 44 69 72 5f  |>Alias$@BootDir_|
00000610  78 78 78 78 3c 2f 68 32  3e 0a 3c 68 32 3e 41 6c  |xxxx</h2>.<h2>Al|
00000620  69 61 73 24 40 52 75 6e  44 69 72 5f 78 78 78 78  |ias$@RunDir_xxxx|
00000630  3c 2f 68 32 3e 0a 3c 68  32 3e 41 6c 69 61 73 24  |</h2>.<h2>Alias$|
00000640  40 52 75 6e 54 79 70 65  5f 78 78 78 3c 2f 68 32  |@RunType_xxx</h2|
00000650  3e 0a 53 65 65 20 3c 61  20 68 72 65 66 3d 22 2e  |>.See <a href=".|
00000660  2f 52 75 6e 41 6e 64 42  6f 6f 74 22 3e 52 75 6e  |/RunAndBoot">Run|
00000670  6e 69 6e 67 20 61 6e 64  20 62 6f 6f 74 69 6e 67  |ning and booting|
00000680  3c 2f 61 3e 2e 0a 0a 3c  2f 62 6f 64 79 3e 3c 2f  |</a>...</body></|
00000690  68 74 6d 6c 3e 0a                                 |html>.|
00000696