]> git.sur5r.net Git - cc65/blob - doc/apple2enh.sgml
remote TABs in doc/ and test/
[cc65] / doc / apple2enh.sgml
1 <!doctype linuxdoc system>
2
3 <article>
4 <title>Enhanced&nbsp;Apple&nbsp;//e specific information for cc65
5 <author><url url="mailto:ol.sc@web.de" name="Oliver Schmidt">
6
7 <abstract>
8 An overview over the enhanced&nbsp;Apple&nbsp;//e runtime system as it is
9 implemented for the cc65 C compiler.
10 </abstract>
11
12 <!-- Table of contents -->
13 <toc>
14
15 <!-- Begin the document -->
16
17 <sect>Overview<p>
18
19 This file contains an overview of the enhanced&nbsp;Apple&nbsp;//e runtime system
20 as it comes with the cc65 C compiler. It describes the memory layout,
21 enhanced&nbsp;Apple&nbsp;//e specific header files, available drivers, and any
22 pitfalls specific to that platform.
23
24 Please note that enhanced&nbsp;Apple&nbsp;//e specific functions are just mentioned
25 here, they are described in detail in the separate <url url="funcref.html"
26 name="function reference">. Even functions marked as "platform dependent" may
27 be available on more than one platform. Please see the function reference for
28 more information.
29
30
31
32 <sect>Binary format<p>
33
34 The standard binary file format generated by the linker for the
35 enhanced&nbsp;Apple&nbsp;//e target is an <url name="AppleSingle"
36 url="http://kaiser-edv.de/documents/AppleSingle_AppleDouble.pdf"> file.
37 The default load address is &dollar;803.
38
39 <bf/AppleCommander 1.4.0/ or later (available at <url
40 url="https://applecommander.github.io/">) includes the option <tt/-as/ that
41 allows to put AppleSingle files onto disk images containing DOS 3.3 as well
42 as ProDOS 8.
43
44
45 <sect>Memory layout<p>
46
47 In the standard setup, cc65 generated programs use the memory from
48 &dollar;803 to &dollar;95FF, so 35.5 KB of RAM are available.
49
50 Special locations:
51
52 <descrip>
53
54   <tag/Stack/
55   The C runtime stack is located at HIMEM and grows downwards, regardless of
56   how your linker config file is setup.
57
58   <tag/Heap/
59   The C heap is located at the end of the program and grows towards the C
60   runtime stack.
61
62 </descrip><p>
63
64 While running <tt/main()/ the Language Card bank 2 is enabled for read access.
65 However while running module constructors/destructors the Language Card is disabled.
66
67 Enabling the Language Card allows to use it as additional memory for cc65
68 generated code. However code is never automatically placed there. Rather code
69 needs to be explicitly placed in the Language Card either per file by compiling
70 with <tt/--code-name LC/ or per function by enclosing in <tt/#pragma code-name
71 (push, "LC")/ and <tt/#pragma code-name (pop)/. In either case the cc65 runtime
72 system takes care of actually moving the code into the Language Card.
73
74 The amount of memory available in the Language Card for generated code depends
75 on the <ref id="link-configs" name="linker configuration"> parameters. There are
76 several usefull settings:
77
78 <descrip>
79
80   <tag>LC address: &dollar;D400, LC size: &dollar;C00</tag>
81   For plain vanilla ProDOS 8 which doesn't actually use the Language Card bank 2
82   memory from &dollar;D400 to &dollar;DFFF. This is the default setting.
83
84   <tag>LC address: &dollar;D000, LC size: &dollar;1000</tag>
85   For ProDOS 8 together with the function <tt/rebootafterexit()/. If a program
86   doesn't quit to the ProDOS 8 dispatcher but rather reboots the machine after
87   exit then a plain vanilla ProDOS 8 doesn't make use of the Language Card bank
88   2 at all.
89
90   <tag>LC address: &dollar;D000, LC size: &dollar;3000</tag>
91   For plain vanilla DOS 3.3 which doesn't make use of the Language Card at all.
92
93 </descrip><p>
94
95
96
97 <sect>Linker configurations<label id="link-configs"><p>
98
99 The ld65 linker comes with a default config file for the enhanced&nbsp;Apple&nbsp;//e,
100 which is used via <tt/-t apple2enh/.
101 The apple2enh package comes with additional secondary linker config files, which
102 are used via <tt/-t apple2enh -C &lt;configfile&gt;/.
103
104
105 <sect1>default config file (<tt/apple2enh.cfg/)<label id="apple-def-cfg"><p>
106
107 Default configuration for a binary program.
108
109 Parameters:
110
111 <descrip>
112
113   <tag><tt/STARTADDRESS:/ Program start address</tag>
114   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
115
116   <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
117   Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
118
119   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
120   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
121   stack size.
122
123   <tag><tt/__HIMEM__:/ Highest usable memory address presumed at link time</tag>
124   Default: &dollar;9600. Use <tt/-D __HIMEM__=&lt;addr&gt;/ to set a different
125   highest usable address.
126
127   <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
128   Default: &dollar;D400. Use <tt/-D __LCADDR__=&lt;addr&gt;/ to set a different
129   code address.
130
131   <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
132   Default: &dollar;C00. Use <tt/-D __LCSIZE__=&lt;size&gt;/ to set a different
133   code size.
134
135 </descrip><p>
136
137
138 <sect1><tt/apple2enh-system.cfg/<label id="apple-sys-cfg"><p>
139
140 Configuration for a system program running on ProDOS 8 and using the memory from
141 &dollar;2000 to &dollar;BEFF.
142
143 Parameters:
144
145 <descrip>
146
147   <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
148   Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
149
150   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
151   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
152   stack size.
153
154   <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
155   Default: &dollar;D400. Use <tt/-D __LCADDR__=&lt;addr&gt;/ to set a different
156   code address.
157
158   <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
159   Default: &dollar;C00. Use <tt/-D __LCSIZE__=&lt;size&gt;/ to set a different
160   code size.
161
162 </descrip><p>
163
164
165 <sect1><tt/apple2enh-hgr.cfg/<p>
166
167 Configuration for a program including a hires page. See <tt>testcode/lib/apple/hgrtest.c</tt>
168 for an example of such a program.
169
170 Parameters:
171
172 <descrip>
173
174   <tag><tt/STARTADDRESS:/ Program start address</tag>
175   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
176
177   <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
178   Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
179
180   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
181   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
182   stack size.
183
184   <tag><tt/__HIMEM__:/ Highest usable memory address presumed at link time</tag>
185   Default: &dollar;9600. Use <tt/-D __HIMEM__=&lt;addr&gt;/ to set a different
186   highest usable address.
187
188   <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
189   Default: &dollar;D400. Use <tt/-D __LCADDR__=&lt;addr&gt;/ to set a different
190   code address.
191
192   <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
193   Default: &dollar;C00. Use <tt/-D __LCSIZE__=&lt;size&gt;/ to set a different
194   code size.
195
196 </descrip><p>
197
198
199 <sect1><tt/apple2enh-overlay.cfg/<p>
200
201 Configuration for an overlay program with up to nine overlays. The overlay files
202 don't include the AppleSingle header. See <tt>samples/overlaydemo.c</tt> for more
203 information on overlays.
204
205 Parameters:
206
207 <descrip>
208
209   <tag><tt/STARTADDRESS:/ Program start address</tag>
210   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
211
212   <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
213   Default: Yes. Use <tt/-D __EXEHDR__=0/ to omit the AppleSingle header.
214
215   <tag><tt/__STACKSIZE__:/ C runtime stack size</tag>
216   Default: &dollar;800. Use <tt/-D __STACKSIZE__=&lt;size&gt;/ to set a different
217   stack size.
218
219   <tag><tt/__HIMEM__:/ Highest usable memory address presumed at link time</tag>
220   Default: &dollar;9600. Use <tt/-D __HIMEM__=&lt;addr&gt;/ to set a different
221   highest usable address.
222
223   <tag><tt/__LCADDR__:/ Address of code in the Language Card</tag>
224   Default: &dollar;D400. Use <tt/-D __LCADDR__=&lt;addr&gt;/ to set a different
225   code address.
226
227   <tag><tt/__LCSIZE__:/ Size of code in the Language Card</tag>
228   Default: &dollar;C00. Use <tt/-D __LCSIZE__=&lt;size&gt;/ to set a different
229   code size.
230
231   <tag><tt/__OVERLAYSIZE__:/ Size of code in the overlays</tag>
232   Default: &dollar;1000. Use <tt/-D __OVERLAYSIZE__=&lt;size&gt;/ to set a different
233   code size.
234
235 </descrip><p>
236
237
238 <sect1><tt/apple2enh-asm.cfg/<p>
239
240 Configuration for an assembler program that doesn't need a special setup.
241
242 Parameters:
243
244 <descrip>
245
246   <tag><tt/STARTADDRESS:/ Program start address</tag>
247   Default: &dollar;803. Use <tt/-S &lt;addr&gt;/ to set a different start address.
248
249   <tag><tt/__EXEHDR__:/ AppleSingle executable file header</tag>
250   Default: No. Use <tt/-u __EXEHDR__ apple2enh.lib/ to add the AppleSingle header.
251
252 </descrip><p>
253
254
255
256 <sect>ProDOS 8 system programs<p>
257
258 ProDOS 8 system programs are always loaded to the start address &dollar;2000.
259 For cc65 programs this means that the 6 KB from &dollar;800 to &dollar;2000 are
260 by default unused. There are however several options to make use of that memory
261 range.
262
263
264 <sect1>LOADER.SYSTEM<p>
265
266 The easiest (and for really large programs in fact the only) way to have a cc65
267 program use the memory from &dollar;800 to &dollar;2000 is to link it as binary
268 (as opposed to system) program using the default linker configuration
269 <ref id="apple-def-cfg" name="apple2enh.cfg"> with <tt/__HIMEM__/set to &dollar;BF00
270 and load it with the LOADER.SYSTEM utility. The program then works like a system
271 program (i.e. quits to the ProDOS dispatcher).
272
273 Using LOADER.SYSTEM is as simple as copying it to the ProDOS 8 directory of the
274 program to load under name &lt;program&gt;.SYSTEM as a system program. For
275 example the program <tt/MYPROG/ is loaded by <tt/MYPROG.SYSTEM/. The right
276 AppleCommander option to put LOADER.SYSTEM on a ProDOS 8 disk image is <tt/-p/.
277
278
279 <sect1>Heap<p>
280
281 If the cc65 program can be successfully linked as system program using the linker
282 configuration <ref id="apple-sys-cfg" name="apple2enh-system.cfg">, but
283 uses the heap either explicitly or implicitly (i.e. by loading a driver) then
284 the memory from &dollar;800 to &dollar;2000 can be added to the heap by calling
285 <tt/_heapadd ((void *) 0x0800, 0x1800);/ at the beginning of <tt/main()/.
286
287
288 <sect1>ProDOS 8 I/O buffers<p>
289
290 ProDOS 8 requires for every open file a page-aligned 1 KB I/O buffer. By default
291 these buffers are allocated by the cc65 runtime system on the heap using
292 <tt/posix_memalign()/. While this is generally the best solution it means quite
293 some overhead for (especially rather small) cc65 programs which do open files
294 but don't make use of the heap otherwise.
295
296 The apple2enh package comes with the alternative ProDOS 8 I/O buffer allocation
297 module <tt/apple2enh-iobuf-0800.o/ which uses the memory between &dollar;800 and
298 the program start address for the 1 KB I/O buffers. For system programs (with
299 start address &dollar;2000) this results in up to 6 I/O buffers and thus up to 6
300 concurrently open files.
301
302 While using <tt/_heapadd()/ as described in the section above together with the
303 default I/O buffer allocation basically yields the same placement of I/O buffers
304 in memory the primary benefit of <tt/apple2enh-iobuf-0800.o/ is a reduction in code
305 size - and thus program file size - of more than 1400 bytes.
306
307 Using <tt/apple2enh-iobuf-0800.o/ is as simple as placing it on the linker command
308 line like this:
309
310 <tscreen><verb>
311 cl65 -t apple2enh -C apple2enh-system.cfg myprog.c apple2enh-iobuf-0800.o
312 </verb></tscreen>
313
314
315
316 <sect>Platform specific header files<p>
317
318 Programs containing enhanced&nbsp;Apple&nbsp;//e specific code may use the
319 <tt/apple2enh.h/ header file.
320
321
322 <sect1>Enhanced&nbsp;Apple&nbsp;//e specific functions<p>
323
324 The functions listed below are special for the enhanced&nbsp;Apple&nbsp;//e. See
325 the <url url="funcref.html" name="function reference"> for declaration and
326 usage.
327
328 <itemize>
329 <item>_auxtype
330 <item>_dos_type
331 <item>_filetype
332 <item>get_ostype
333 <item>rebootafterexit
334 <item>ser_apple2_slot
335 <item>textframe
336 <item>textframexy
337 <item>tgi_apple2_mix
338 <item>videomode
339 </itemize>
340
341
342 <sect1>Hardware access<p>
343
344 There's currently no support for direct hardware access. This does not mean
345 you cannot do it, it just means that there's no help.
346
347
348
349 <sect>Loadable drivers<p>
350
351 The names in the parentheses denote the symbols to be used for static linking of the drivers.
352
353
354 <sect1>Graphics drivers<p>
355
356 <descrip>
357
358   <tag><tt/a2e.lo.tgi (a2e_lo_tgi)/</tag>
359   This driver features a resolution of 40&times;48 with 16 colors.
360
361   The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
362   function clears the corresponding area at the bottom of the screen.
363
364   <tag><tt/a2e.hi.tgi (a2e_hi_tgi)/</tag>
365   This driver features a resolution of 280&times;192 with 8 colors and two
366   hires pages. Note that programs using this driver will have to be linked
367   with <tt/-S $4000/ to reserve the first hires page or with <tt/-S $6000/
368   to reserve both hires pages.
369
370   Note that the second hires page is only available if the text display is not in
371   80 column mode. This can be asserted by calling <tt/videomode (VIDEOMODE_40COL);/
372   before installing the driver.
373
374   The function <tt/tgi_apple2_mix()/ allows to activate 4 lines of text. The
375   function doesn't clear the corresponding area at the bottom of the screen.
376
377   In memory constrained situations the memory from &dollar;803 to &dollar;1FFF
378   can be made available to a program by calling <tt/_heapadd ((void *) 0x0803, 0x17FD);/
379   at the beginning of <tt/main()/. Doing so is beneficial even if the program
380   doesn't use the the heap explicitly because loading the driver (and in fact
381   already opening the driver file) uses the heap implicitly.
382
383 </descrip><p>
384
385
386 <sect1>Extended memory drivers<p>
387
388 <descrip>
389
390   <tag><tt/a2e.auxmem.emd (a2e_auxmem_emd)/</tag>
391   Gives access to 47.5 KB RAM (190 pages of 256 bytes each) on an Extended
392   80-Column Text Card.
393
394   Note that this driver doesn't check for the actual existence of the memory
395   and that it doesn't check for ProDOS 8 RAM disk content!
396
397 </descrip><p>
398
399
400 <sect1>Joystick drivers<p>
401
402 <descrip>
403
404   <tag><tt/a2e.stdjoy.joy (a2e_stdjoy_joy)/</tag>
405   Supports up to two standard analog joysticks connected to the game port of
406   the enhanced&nbsp;Apple&nbsp;//e.
407
408 </descrip><p>
409
410
411 <sect1>Mouse drivers<p>
412
413 <descrip>
414
415   <tag><tt/a2e.stdmou.mou (a2e_stdmou_mou)/</tag>
416   Driver for the AppleMouse&nbsp;II Card. Searches all Apple&nbsp;II slots
417   for an AppleMouse&nbsp;II Card compatible firmware. The default bounding
418   box is &lsqb;0..279,0..191&rsqb;.
419
420   Note that the enhanced&nbsp;Apple&nbsp;//e default mouse callbacks support
421   text mode only.
422
423 </descrip><p>
424
425
426 <sect1>RS232 device drivers<p>
427
428 <descrip>
429
430   <tag><tt/a2e.ssc.ser (a2e_ssc_ser)/</tag>
431   Driver for the Apple&nbsp;II Super Serial Card. Supports up to 19200 baud,
432   hardware flow control (RTS/CTS) and interrupt driven receives. Note
433   that because of the peculiarities of the 6551 chip transmits are not
434   interrupt driven, and the transceiver blocks if the receiver asserts
435   flow control because of a full buffer.
436
437   The driver defaults to slot 2. Call <tt/ser_apple2_slot()/ prior to
438   <tt/ser_open()/ in order to select a different slot. <tt/ser_apple2_slot()/
439   succeeds for all Apple&nbsp;II slots, but <tt/ser_open()/ fails with
440   <tt/SER_ERR_NO_DEVICE/ if there's no SSC firmware found in the selected slot.
441
442 </descrip><p>
443
444
445
446 <sect>Limitations<p>
447
448
449 <sect1>DOS 3.3<p>
450
451 Although the standard binaries generated by the linker for the enhanced&nbsp;Apple&nbsp;//e
452 generally run both on DOS 3.3 (with Applesoft BASIC) and on ProDOS 8 (with
453 BASIC.SYSTEM) there are some limitations for DOS 3.3:
454
455 <descrip>
456
457   <tag>Disk file I/O</tag>
458   There's no disk file I/O support. Any attempt to use it yields an error with
459   <tt/errno/ set to <tt/ENOSYS/. This implicitly means that loadable drivers
460   are in general not functional as they depend on disk file I/O. Therefore the statically
461   linked drivers have to be used instead.
462
463   <tag/Interrupts/
464   There's no <tt/interruptor/ support. Any attempt to use it yields the message
465   'Failed to alloc interrupt' on program startup. This implicitly means that
466   mouse and RS232 device drivers are not functional as they depend on interrupts.
467
468 </descrip><p>
469
470
471 <sect1>Direct console I/O<p>
472
473 The enhanced&nbsp;Apple&nbsp;//e has no color text mode. Therefore the functions
474 <tt/textcolor()/, <tt/bgcolor()/ and <tt/bordercolor()/ have no effect.
475
476
477 <sect1>Random number generator<p>
478
479 The random number seed is generated from the time the program waits for user input.
480 Therefore it is necessary to wait for at least one user keypress either via Standard
481 I/O or via Direct console I/O before initializing the pseudo random number generator.
482
483
484 <sect1>Realtime clock<p>
485
486 There are several types of realtime clocks. It's not desirable to have specific code
487 for all of them. As ProDOS 8 supports file timestamps, realtime clock owners usually
488 use ProDOS 8 drivers for their realtime clock. Those drivers read the realtime clock
489 and write the result to the date/time location in RAM (&dollar;BF90 to &dollar;BF93).
490 ProDOS 8 reads the date/time from that RAM location. If there's no realtime clock the
491 RAM location keeps containing zeros. ProDOS 8 uses those zeros as timestamps and the
492 files show up in a directory as <tt/&lt;NO DATE&gt;/.
493
494 There's no common interface to set realtime clocks so if a realtme clock <bf/IS/
495 present there's just nothing to do. However, if there's <bf/NO/ realtime clock present,
496 the user might very well be interested to "manually" set the RAM location in order to
497 have timestamps. But he surely doesn't want to manually set the RAM location over and
498 over again. Rather he wants to set it just once after booting ProDOS 8.
499
500 From that perspective it makes most sense to not set both the date and the time but
501 rather only set the date and have the time just stay zero. Then files show up in a
502 directory as <tt/DD-MON-YY  0:00/.
503
504 So <tt/clock_settime()/ checks if the current time equals 0:00. If it does <bf/NOT/
505 then a realtime clock is supposed to be active and <tt/clock_settime()/ fails with
506 <tt/ERANGE/. Otherwise <tt/clock_settime()/ sets the date - and completely ignores
507 the time provided as parameter.
508
509 <tt/clock_getres()/ too checks if the current time equals 0:00. If it does <bf/NOT/
510 then a realtime clock is supposed to be active and <tt/clock_getres()/ returns a time
511 resolution of one minute. Otherwise <tt/clock_getres()/ presumes that the only one
512 who sets the RAM location is <tt/clock_settime()/ and therefore returns a time
513 resolution of one day.
514
515
516
517 <sect>Other hints<p>
518
519
520 <sect1>Passing arguments to the program<p>
521
522 Command line arguments can be passed to <tt/main()/ after BLOAD. Since this is not
523 supported by BASIC, the following syntax was chosen:
524
525 <tscreen><verb>
526 ]CALL2051:REM ARG1 " ARG2 IS QUOTED" ARG3 "" ARG5
527 </verb></tscreen>
528
529 <enum>
530 <item>Arguments are separated by spaces.
531 <item>Arguments may be quoted.
532 <item>Leading and trailing spaces around an argument are ignored. Spaces within
533       a quoted argument are allowed.
534 <item>The first argument passed to <tt/main/ is the program name.
535 <item>A maximum number of 10 arguments (including the program name) are
536       supported.
537 </enum>
538
539
540 <sect1>Function keys<p>
541
542 These are defined to be OpenApple + number key.
543
544
545 <sect1>Interrupts<p>
546
547 The runtime for the enhanced&nbsp;Apple&nbsp;//e uses routines marked as
548 <tt/.INTERRUPTOR/ for ProDOS 8 interrupt handlers. Such routines must be
549 written as simple machine language subroutines and will be called
550 automatically by the interrupt handler code when they are linked into a
551 program. See the discussion of the <tt/.CONDES/ feature in the <url
552 url="ca65.html" name="assembler manual">.
553
554
555 <sect1>DIO<p>
556
557 <descrip>
558
559   <tag/Drive ID/
560   The function <url url="dio.html#s1" name="dio_open()"> has the single
561   parameter <tt/device/ to identify the device to be opened. Therefore an
562   Apple&nbsp;II slot and drive pair is mapped to that <tt/device/ according
563   to the formula
564
565   <tscreen>
566     device = slot + (drive - 1) * 8
567   </tscreen>
568
569   so that for example slot 6 drive 2 is mapped to <tt/device/ 14.
570
571   <tag/Sector count/
572   The function <url url="dio.html#s3" name="dio_query_sectcount()"> returns
573   the correct sector count for all ProDOS 8 disks. However for any non-ProDOS 8
574   disk it simply always returns 280 (which is only correct for a 140 KB disk).
575   This condition is indicated by the <tt/_oserror/ value 82.
576
577 </descrip><p>
578
579
580 <sect1>Specifying file types for fopen<p>
581
582 <descrip>
583
584   <tag>Explanation of File Types</tag>
585
586   ProDOS associates a file type and an auxiliary type with each file.
587   These type specifications are separate from the file's name, unlike
588   Windows which uses the file name's suffix (a.k.a.
589   extension) to specify the file type. For example, <tt/.exe/,
590   <tt/.doc/, or <tt/.bat/.
591   The ProDOS low-level
592   Machine-Language Interface (MLI) functions for creating and opening
593   files require these types to be specified. And if they don't match
594   with the file being opened, the operation may fail.
595
596   In contrast, the ISO C function <tt/fopen()/ and the POSIX function
597   <tt/open()/ have no parameter to specify either a file type or an
598   auxiliary type. Therefore, some additional mechanism for specifying
599   the file types is needed.
600
601   <tag>Specifying the File Type and Auxiliary Type</tag>
602
603   There are two global variables provided that allow the file type
604   and auxiliary type to be specified before a call to <tt/fopen()/
605   or <tt/open()/. They are defined in <tt/apple2_filetype.h/:
606
607   <tscreen>
608   <verb>
609   extern unsigned char _filetype;  /* Default: PRODOS_T_BIN */
610   extern unsigned int _auxtype;    /* Default: 0            */
611   </verb>
612   </tscreen>
613
614   The header file <tt/apple2_filetype.h/ also defines many values
615   that can be used to set these variables. It is included in
616   <tt/apple2.h/, which is in turn included in <tt/apple2enh.h/.
617   So it isn't necessary to include it directly. Just
618   include one of <tt/apple2.h/ or <tt/apple2enh.h/.
619
620   <tag>Example</tag>
621
622   A text file cannot be created with just the
623   standard C functions because they default to the binary type
624   <tt/PRODOS_T_BIN/. The <tt/_filetype/ variable must be set to
625   <tt/PRODOS_T_TXT/ to create a text file.
626
627   For a text file,
628   <tt/_auxtype/ specifies the record length. A zero record
629   length text file is referred to as a sequential text file.
630   This is equivalent to text files on
631   other operating systems, except that the line terminator is a
632   carriage return instead of a line-feed (Linux/BSD/MacOS) or
633   carriage return, line-feed pair (Windows).
634
635   The "sequential" text file terminology is in contrast to a
636   "random-access" text file which would
637   have a fixed-length, non-zero record length, so that the
638   file position of any individual record can be calculated.
639
640   For this example, the
641   <tt/_auxtype/ does not need to be set because it defaults to
642   the desired value, which is zero. To be more explicit,
643   <tt/_auxtype/ can also be set to <tt/PRODOS_AUX_T_TXT_SEQ/
644   which is defined as zero.
645
646   <tscreen>
647   <verb>
648     &num;include &lt;stdio.h&gt;
649     &num;include &lt;string.h&gt;
650     &num;include &lt;errno.h&gt;
651     &num;include &lt;apple2.h&gt;
652
653     void main(void)
654     {
655         FILE *out;
656         char *name = "MY.FAVS";
657
658         /*-----------------------------*/
659
660         _filetype = PRODOS_T_TXT;
661         _auxtype  = PRODOS_AUX_T_TXT_SEQ;
662
663         /*-----------------------------*/
664
665         if ((out = fopen(name, "w")) != NULL) {
666             fputs("Jorah Mormont\r", out);
667             fputs("Brienne of Tarth\r", out);
668             fputs("Daenerys Targaryen\r", out);
669             fputs("Sandor Clegane\r", out);
670             if (fclose(out) == EOF) {
671                 fprintf(stderr, "fclose failed for %s: %s", name, strerror(errno));
672             }
673         }
674         else {
675             fprintf(stderr, "fopen failed for %s: %s", name, strerror(errno));
676         }
677     }
678   </verb>
679   </tscreen>
680
681 </descrip><p>
682
683
684 <sect>License<p>
685
686 This software is provided 'as-is', without any expressed or implied
687 warranty. In no event will the authors be held liable for any damages
688 arising from the use of this software.
689
690 Permission is granted to anyone to use this software for any purpose,
691 including commercial applications, and to alter it and redistribute it
692 freely, subject to the following restrictions:
693
694 <enum>
695 <item>  The origin of this software must not be misrepresented; you must not
696         claim that you wrote the original software. If you use this software
697         in a product, an acknowledgment in the product documentation would be
698         appreciated but is not required.
699 <item>  Altered source versions must be plainly marked as such, and must not
700         be misrepresented as being the original software.
701 <item>  This notice may not be removed or altered from any source
702         distribution.
703 </enum>
704
705 </article>