1 <!doctype linuxdoc system> <!-- -*- text-mode -*- -->
4 <title>cc65 function reference
5 <author><url url="mailto:uz@cc65.org" name="Ullrich von Bassewitz">,<newline>
6 <url url="mailto:greg.king5@verizon.net" name="Greg King">
10 cc65 is a C compiler for 6502 based systems. This function reference describes
11 the C functions available in the standard library.
14 <!-- Table of contents -->
17 <!-- Begin the document -->
21 cc65 is a C compiler for 6502 based systems. It implements a subset of the ISO
22 C standard plus additional functions specially crafted for 6502 systems or
23 just some of the supported machines. This function refrence describes the
24 available functions together with any limitations.
26 For an overview about the available libraries, their purpose, and any
27 differences to the ISO standard, please have a look at the <url
28 url="library.html" name="cc65 Library Overview">.
30 <em/Note:/ Standard C functions are listed here, but not described in detail.
31 Since these functions behave identical on all standard compliant systems, they
32 are described in any book covering standard C.
34 Each entry for a function contains a detailed description
38 <tag/Function/Summary of what <bf/function/ does.
39 <tag/Header/The header file that contains the declaration.
40 <tag/Declaration/Describes the needed header files and declaration of the
42 <tag/Description/Description of the function.
43 <tag/Notes/Notes on the function.
44 <tag/Availability/The availability of the function.
45 <tag/See also/Other related functions.
46 <tag/Example/A piece of actual code using the function.
51 <sect>Functions by header file<p>
53 <sect1><tt/6502.h/<label id="6502.h"><p>
56 <item><ref id="BRK" name="BRK">
57 <item><ref id="CLI" name="CLI">
58 <item><ref id="SEI" name="SEI">
59 <item><ref id="_sys" name="_sys">
60 <item><ref id="getcpu" name="getcpu">
61 <item><ref id="reset_brk" name="reset_brk">
62 <item><ref id="reset_irq" name="reset_irq">
63 <item><ref id="set_brk" name="set_brk">
64 <item><ref id="set_irq" name="set_irq">
68 <sect1><tt/apple2.h/<label id="apple2.h"><p>
72 <item><ref id="get_ostype" name="get_ostype">
77 <sect1><tt/apple2enh.h/<label id="apple2enh.h"><p>
81 <item><ref id="get_ostype" name="get_ostype">
85 <item><ref id="videomode" name="videomode">
89 <sect1><tt/assert.h/<label id="assert.h"><p>
92 <item><ref id="assert" name="assert">
96 <sect1><tt/atari.h/<label id="atari.h"><p>
99 <!-- <item><ref id="_getcolor" name="_getcolor"> -->
100 <!-- <item><ref id="_getdefdev" name="_getdefdev"> -->
101 <!-- <item><ref id="_graphics" name="_graphics"> -->
102 <item><ref id="_is_cmdline_dos" name="_is_cmdline_dos">
103 <!-- <item><ref id="_rest_vecs" name="_rest_vecs"> -->
104 <!-- <item><ref id="_save_vecs" name="_save_vecs"> -->
105 <!-- <item><ref id="_scroll" name="_scroll"> -->
106 <!-- <item><ref id="_setcolor" name="_setcolor"> -->
107 <!-- <item><ref id="_setcolor_low" name="_setcolor_low"> -->
108 <item><ref id="get_ostype" name="get_ostype">
109 <!-- <item><ref id="get_tv" name="get_tv"> -->
115 <sect1><tt/atmos.h/<label id="atmos.h"><p>
118 <item><ref id="atmos_explode" name="atmos_explode">
119 <item><ref id="atmos_load" name="atmos_load">
120 <item><ref id="atmos_ping" name="atmos_ping">
121 <item><ref id="atmos_save" name="atmos_save">
122 <item><ref id="atmos_shoot" name="atmos_shoot">
123 <item><ref id="atmos_tick" name="atmos_tick">
124 <item><ref id="atmos_tock" name="atmos_tock">
125 <item><ref id="atmos_zap" name="atmos_zap">
129 <sect1><tt/c128.h/<label id="c128.h"><p>
132 <item><ref id="c64mode" name="c64mode">
133 <item><ref id="fast" name="fast">
134 <item><ref id="slow" name="slow">
135 <item><ref id="toggle_videomode" name="toggle_videomode">
136 <item><ref id="videomode" name="videomode">
140 <sect1><tt/c16.h/<label id="c16.h"><p>
145 <sect1><tt/c64.h/<label id="c64.h"><p>
148 <item><ref id="get_ostype" name="get_ostype">
152 <sect1><tt/cbm.h/<label id="cbm.h"><p>
155 <item><ref id="cbm_k_acptr" name="cbm_k_acptr">
156 <item><ref id="cbm_k_basin" name="cbm_k_basin">
157 <item><ref id="cbm_k_bsout" name="cbm_k_bsout">
158 <item><ref id="cbm_k_chkin" name="cbm_k_chkin">
159 <item><ref id="cbm_k_ciout" name="cbm_k_ciout">
160 <item><ref id="cbm_k_ckout" name="cbm_k_ckout">
161 <item><ref id="cbm_k_clall" name="cbm_k_clall">
162 <item><ref id="cbm_k_close" name="cbm_k_close">
163 <item><ref id="cbm_k_clrch" name="cbm_k_clrch">
164 <item><ref id="cbm_k_getin" name="cbm_k_getin">
165 <item><ref id="cbm_k_iobase" name="cbm_k_iobase">
166 <item><ref id="cbm_k_listen" name="cbm_k_listen">
167 <item><ref id="cbm_k_load" name="cbm_k_load">
168 <item><ref id="cbm_k_open" name="cbm_k_open">
169 <item><ref id="cbm_k_readst" name="cbm_k_readst">
170 <item><ref id="cbm_k_save" name="cbm_k_save">
171 <item><ref id="cbm_k_scnkey" name="cbm_k_scnkey">
172 <item><ref id="cbm_k_setlfs" name="cbm_k_setlfs">
173 <item><ref id="cbm_k_setnam" name="cbm_k_setnam">
174 <item><ref id="cbm_k_talk" name="cbm_k_talk">
175 <item><ref id="cbm_k_udtim" name="cbm_k_udtim">
176 <item><ref id="cbm_k_unlsn" name="cbm_k_unlsn">
177 <!-- <item><ref id="cbm_load" name="cbm_load"> -->
178 <!-- <item><ref id="cbm_open" name="cbm_open"> -->
179 <!-- <item><ref id="cbm_opendir" name="cbm_opendir"> -->
180 <!-- <item><ref id="cbm_read" name="cbm_read"> -->
181 <!-- <item><ref id="cbm_readdir" name="cbm_readdir"> -->
182 <!-- <item><ref id="cbm_save" name="cbm_save"> -->
183 <!-- <item><ref id="cbm_write" name="cbm_write"> -->
184 <!-- <item><ref id="get_tv" name="get_tv"> -->
185 <item><ref id="waitvsync" name="waitvsync">
186 <item><ref id="kbrepeat" name="kbrepeat">
192 <sect1><tt/cbm510.h/<label id="cbm510.h"><p>
195 <item><ref id="peekbsys" name="peekbsys">
196 <item><ref id="peekwsys" name="peekwsys">
197 <item><ref id="pokebsys" name="pokebsys">
198 <item><ref id="pokewsys" name="pokewsys">
202 <sect1><tt/cbm610.h/<label id="cbm610.h"><p>
205 <item><ref id="peekbsys" name="peekbsys">
206 <item><ref id="peekwsys" name="peekwsys">
207 <item><ref id="pokebsys" name="pokebsys">
208 <item><ref id="pokewsys" name="pokewsys">
212 <sect1><tt/cc65.h/<label id="cc65.h"><p>
215 <!-- <item><ref id="cc65_cos" name="cc65_cos"> -->
216 <!-- <item><ref id="cc65_idiv32by16r16" name="cc65_idiv32by16r16"> -->
217 <!-- <item><ref id="cc65_imul16x16r32" name="cc65_imul16x16r32"> -->
218 <!-- <item><ref id="cc65_imul8x8r16" name="cc65_imul8x8r16"> -->
219 <!-- <item><ref id="cc65_sin" name="cc65_sin"> -->
220 <!-- <item><ref id="cc65_udiv32by16r16" name="cc65_udiv32by16r16"> -->
221 <!-- <item><ref id="cc65_umul16x16r32" name="cc65_umul16x16r32"> -->
222 <!-- <item><ref id="cc65_umul16x8r32" name="cc65_umul16x8r32"> -->
223 <!-- <item><ref id="cc65_umul8x8r16" name="cc65_umul8x8r16"> -->
224 <item><ref id="doesclrscrafterexit" name="doesclrscrafterexit">
230 <sect1><tt/conio.h/<label id="conio.h"><p>
233 <item><ref id="bgcolor" name="bgcolor">
234 <item><ref id="bordercolor" name="bordercolor">
235 <item><ref id="cclear" name="cclear">
236 <item><ref id="cclearxy" name="cclearxy">
237 <item><ref id="cgetc" name="cgetc">
238 <item><ref id="chline" name="chline">
239 <item><ref id="chlinexy" name="chlinexy">
240 <item><ref id="clrscr" name="clrscr">
241 <item><ref id="cpeekc" name="cpeekc">
242 <item><ref id="cpeekcolor" name="cpeekcolor">
243 <item><ref id="cpeekrevers" name="cpeekrevers">
244 <item><ref id="cpeeks" name="cpeeks">
245 <item><ref id="cprintf" name="cprintf">
246 <item><ref id="cputc" name="cputc">
247 <item><ref id="cputcxy" name="cputcxy">
248 <item><ref id="cputs" name="cputs">
249 <item><ref id="cputsxy" name="cputsxy">
250 <item><ref id="cursor" name="cursor">
251 <item><ref id="cvline" name="cvline">
252 <item><ref id="cvlinexy" name="cvlinexy">
253 <item><ref id="gotox" name="gotox">
254 <item><ref id="gotoxy" name="gotoxy">
255 <item><ref id="gotoy" name="gotoy">
256 <item><ref id="kbhit" name="kbhit">
257 <item><ref id="revers" name="revers">
258 <item><ref id="screensize" name="screensize">
259 <item><ref id="textcolor" name="textcolor">
260 <item><ref id="vcprintf" name="vcprintf">
261 <item><ref id="wherex" name="wherex">
262 <item><ref id="wherey" name="wherey">
266 <sect1><tt/ctype.h/<label id="ctype.h"><p>
269 <item><ref id="isalnum" name="isalnum">
270 <item><ref id="isalpha" name="isalpha">
271 <item><ref id="isascii" name="isascii">
272 <item><ref id="isblank" name="isblank">
273 <item><ref id="iscntrl" name="iscntrl">
274 <item><ref id="isdigit" name="isdigit">
275 <item><ref id="isgraph" name="isgraph">
276 <item><ref id="islower" name="islower">
277 <item><ref id="isprint" name="isprint">
278 <item><ref id="ispunct" name="ispunct">
279 <item><ref id="isspace" name="isspace">
280 <item><ref id="isupper" name="isupper">
281 <item><ref id="isxdigit" name="isxdigit">
282 <item><ref id="tolower" name="tolower">
283 <item><ref id="toupper" name="toupper">
287 <sect1><tt/dbg.h/<label id="dbg.h"><p>
290 <!-- <item><ref id="DbgInit" name="DbgInit"> -->
296 <sect1><tt/device.h/<label id="device.h"><p>
299 <item><ref id="getcurrentdevice" name="getcurrentdevice">
300 <item><ref id="getdevicedir" name="getdevicedir">
301 <item><ref id="getfirstdevice" name="getfirstdevice">
302 <item><ref id="getnextdevice" name="getnextdevice">
306 <sect1><tt/dio.h/<label id="dio.h"><p>
308 <url url="dio.html" name="Low-level disk I/O API">.
311 <sect1><tt/dirent.h/<label id="dirent.h"><p>
314 <item><ref id="_DE_ISDIR" name="_DE_ISDIR">
315 <item><ref id="_DE_ISLBL" name="_DE_ISLBL">
316 <item><ref id="_DE_ISLNK" name="_DE_ISLNK">
317 <item><ref id="_DE_ISREG" name="_DE_ISREG">
318 <item><ref id="closedir" name="closedir">
319 <item><ref id="opendir" name="opendir">
320 <item><ref id="readdir" name="readdir">
321 <item><ref id="rewinddir" name="rewinddir">
322 <item><ref id="seekdir" name="seekdir">
323 <item><ref id="telldir" name="telldir">
327 <sect1><tt/em.h/<label id="em.h"><p>
330 <item><ref id="em_commit" name="em_commit">
331 <item><ref id="em_copyfrom" name="em_copyfrom">
332 <item><ref id="em_copyto" name="em_copyto">
333 <item><ref id="em_install" name="em_install">
334 <item><ref id="em_load_driver" name="em_load_driver">
335 <item><ref id="em_map" name="em_map">
336 <item><ref id="em_pagecount" name="em_pagecount">
337 <item><ref id="em_uninstall" name="em_uninstall">
338 <item><ref id="em_unload" name="em_unload">
339 <item><ref id="em_use" name="em_use">
343 <sect1><tt/errno.h/<label id="errno.h"><p>
346 <!-- <item><ref id="_directerrno" name="_directerrno"> -->
347 <!-- <item><ref id="_mappederrno" name="_mappederrno"> -->
348 <!-- <item><ref id="_osmaperrno" name="_osmaperrno"> -->
349 <!-- <item><ref id="_seterrno" name="_seterrno"> -->
355 <sect1><tt/fcntl.h/<label id="fcntl.h"><p>
358 <item><ref id="close" name="close">
359 <item><ref id="creat" name="creat">
360 <item><ref id="open" name="open">
364 <sect1><tt/gamate.h/<label id="gamate.h"><p>
367 <!-- <item><ref id="get_tv" name="get_tv"> -->
368 <item><ref id="waitvsync" name="waitvsync">
374 <sect1><tt/geos.h/<label id="geos.h"><p>
376 <url url="geos.html" name="GEOS API">.
379 <sect1><tt/joystick.h/<label id="joystick.h"><p>
382 <item><ref id="joy_count" name="joy_count">
383 <item><ref id="joy_install" name="joy_install">
384 <item><ref id="joy_load_driver" name="joy_load_driver">
385 <item><ref id="joy_read" name="joy_read">
386 <item><ref id="joy_uninstall" name="joy_uninstall">
387 <item><ref id="joy_unload" name="joy_unload">
391 <sect1><tt/locale.h/<label id="locale.h"><p>
394 <item><ref id="localeconv" name="localeconv">
395 <item><ref id="setlocale" name="setlocale">
399 <sect1><tt/lynx.h/<label id="lynx.h"><p>
402 <!-- <item><ref id="lynx_eeprom_erase" name="lynx_eeprom_erase"> -->
403 <!-- <item><ref id="lynx_eeprom_read" name="lynx_eeprom_read"> -->
404 <!-- <item><ref id="lynx_eeprom_write" name="lynx_eeprom_write"> -->
405 <!-- <item><ref id="lynx_eeread" name="lynx_eeread"> -->
406 <!-- <item><ref id="lynx_eewrite" name="lynx_eewrite"> -->
407 <!-- <item><ref id="lynx_exec" name="lynx_exec"> -->
408 <!-- <item><ref id="lynx_load" name="lynx_load"> -->
414 <sect1><tt/lz4.h/<label id="lz4.h"><p>
417 <item><ref id="decompress_lz4" name="decompress_lz4">
421 <sect1><tt/modload.h/<label id="modload.h"><p>
424 <item><ref id="mod_load" name="mod_load">
425 <item><ref id="mod_free" name="mod_free">
429 <sect1><tt/mouse.h/<label id="mouse.h"><p>
432 <item><ref id="mouse_buttons" name="mouse_buttons">
433 <item><ref id="mouse_getbox" name="mouse_getbox">
434 <item><ref id="mouse_geterrormsg" name="mouse_geterrormsg">
435 <item><ref id="mouse_hide" name="mouse_hide">
436 <item><ref id="mouse_info" name="mouse_info">
437 <item><ref id="mouse_install" name="mouse_install">
438 <item><ref id="mouse_ioctl" name="mouse_ioctl">
439 <item><ref id="mouse_load_driver" name="mouse_load_driver">
440 <item><ref id="mouse_move" name="mouse_move">
441 <item><ref id="mouse_pos" name="mouse_pos">
442 <item><ref id="mouse_setbox" name="mouse_setbox">
443 <item><ref id="mouse_show" name="mouse_show">
444 <item><ref id="mouse_uninstall" name="mouse_uninstall">
445 <item><ref id="mouse_unload" name="mouse_unload">
449 <sect1><tt/nes.h/<label id="nes.h"><p>
452 <!-- <item><ref id="get_tv" name="get_tv"> -->
453 <item><ref id="waitvsync" name="waitvsync">
459 <sect1><tt/o65.h/<label id="o65.h"><p>
461 The <tt/o65.h/ header file contains structure and constant definitions that
462 may be used when dealing with files in <url
463 url="http://www.6502.org/users/andre/o65/fileformat.html" name="the o65 format">.
464 It does not declare any functions.
467 <sect1><tt/pce.h/<label id="pce.h"><p>
470 <!-- <item><ref id="get_tv" name="get_tv"> -->
471 <item><ref id="waitvsync" name="waitvsync">
477 <sect1><tt/peekpoke.h/<label id="peekpoke.h"><p>
480 <item><ref id="PEEK" name="PEEK">
481 <item><ref id="PEEKW" name="PEEKW">
482 <item><ref id="POKE" name="POKE">
483 <item><ref id="POKEW" name="POKEW">
487 <sect1><tt/pen.h/<label id="pen.h"><p>
490 <!-- <item><ref id="pen_adjust" name="pen_adjust"> -->
491 <!-- <item><ref id="pen_calibrate" name="pen_calibrate"> -->
497 <sect1><tt/pet.h/<label id="pet.h"><p>
502 <sect1><tt/plus4.h/<label id="plus4.h"><p>
507 <sect1><tt/serial.h/<label id="serial.h"><p>
509 The <tt/serial.h/ header file contains definitions for initializing serial
513 <item><ref id="ser_close" name="ser_close">
514 <item><ref id="ser_get" name="ser_get">
515 <item><ref id="ser_install" name="ser_install">
516 <item><ref id="ser_ioctl" name="ser_ioctl">
517 <item><ref id="ser_load_driver" name="ser_load_driver">
518 <item><ref id="ser_open" name="ser_open">
519 <item><ref id="ser_put" name="ser_put">
520 <item><ref id="ser_status" name="ser_status">
521 <item><ref id="ser_uninstall" name="ser_uninstall">
522 <item><ref id="ser_unload" name="ser_unload">
526 <sect1><tt/setjmp.h/<label id="setjmp.h"><p>
529 <item><ref id="setjmp" name="setjmp">
530 <item><ref id="longjmp" name="longjmp">
534 <sect1><tt/signal.h/<label id="signal.h"><p>
537 <item><ref id="raise" name="raise">
538 <item><ref id="signal" name="signal">
542 <sect1><tt/stdarg.h/<label id="stdarg.h"><p>
547 <sect1><tt/stdbool.h/<label id="stdbool.h"><p>
552 <sect1><tt/stddef.h/<label id="stddef.h"><p>
555 <item><ref id="offsetof" name="offsetof">
559 <sect1><tt/stdio.h/<label id="stdio.h"><p>
562 <item><ref id="_poserror" name="_poserror">
563 <item><ref id="clearerr" name="clearerr">
564 <!-- <item><ref id="fclose" name="fclose"> -->
565 <!-- <item><ref id="fdopen" name="fdopen"> -->
566 <item><ref id="feof" name="feof">
567 <item><ref id="ferror" name="ferror">
568 <!-- <item><ref id="fflush" name="fflush"> -->
569 <!-- <item><ref id="fgetc" name="fgetc"> -->
570 <!-- <item><ref id="fgetpos" name="fgetpos"> -->
571 <!-- <item><ref id="fgets" name="fgets"> -->
572 <item><ref id="fileno" name="fileno">
573 <!-- <item><ref id="fopen" name="fopen"> -->
574 <!-- <item><ref id="fprintf" name="fprintf"> -->
575 <!-- <item><ref id="fputc" name="fputc"> -->
576 <!-- <item><ref id="fputs" name="fputs"> -->
577 <!-- <item><ref id="fread" name="fread"> -->
578 <!-- <item><ref id="freopen" name="freopen"> -->
579 <!-- <item><ref id="fscanf" name="fscanf"> -->
580 <!-- <item><ref id="fseek" name="fseek"> -->
581 <!-- <item><ref id="fsetpos" name="fsetpos"> -->
582 <!-- <item><ref id="ftell" name="ftell"> -->
583 <!-- <item><ref id="fwrite" name="fwrite"> -->
584 <!-- <item><ref id="getc" name="getc"> -->
585 <!-- <item><ref id="getchar" name="getchar"> -->
586 <!-- <item><ref id="gets" name="gets"> -->
587 <!-- <item><ref id="printf" name="printf"> -->
588 <!-- <item><ref id="putc" name="putc"> -->
589 <!-- <item><ref id="putchar" name="putchar"> -->
590 <!-- <item><ref id="puts" name="puts"> -->
591 <item><ref id="rename" name="rename">
592 <item><ref id="remove" name="remove">
593 <!-- <item><ref id="rewind" name="rewind"> -->
594 <!-- <item><ref id="scanf" name="scanf"> -->
595 <!-- <item><ref id="snprintf" name="snprintf"> -->
596 <!-- <item><ref id="sprintf" name="sprintf"> -->
597 <!-- <item><ref id="sscanf" name="sscanf"> -->
598 <!-- <item><ref id="vfprintf" name="vfprintf"> -->
599 <!-- <item><ref id="vfscanf" name="vfscanf"> -->
600 <!-- <item><ref id="vprintf" name="vprintf"> -->
601 <!-- <item><ref id="vscanf" name="vscanf"> -->
602 <!-- <item><ref id="vsnprintf" name="vsnprintf"> -->
603 <!-- <item><ref id="vsprintf" name="vsprintf"> -->
604 <!-- <item><ref id="vsscanf" name="vsscanf"> -->
610 <sect1><tt/stdlib.h/<label id="stdlib.h"><p>
613 <item><ref id="_heapadd" name="_heapadd">
614 <item><ref id="_heapblocksize" name="_heapblocksize">
615 <item><ref id="_heapmaxavail" name="_heapmaxavail">
616 <item><ref id="_heapmemavail" name="_heapmemavail">
617 <item><ref id="_randomize" name="_randomize">
618 <item><ref id="_swap" name="_swap">
619 <item><ref id="abort" name="abort">
620 <item><ref id="abs" name="abs">
621 <item><ref id="atexit" name="atexit">
622 <item><ref id="atoi" name="atoi">
623 <item><ref id="atol" name="atol">
624 <item><ref id="bsearch" name="bsearch">
625 <item><ref id="calloc" name="calloc">
626 <item><ref id="div" name="div">
627 <item><ref id="exit" name="exit">
628 <item><ref id="free" name="free">
629 <item><ref id="getenv" name="getenv">
630 <item><ref id="itoa" name="itoa">
631 <item><ref id="labs" name="labs">
632 <item><ref id="ltoa" name="ltoa">
633 <item><ref id="malloc" name="malloc">
634 <item><ref id="perror" name="perror">
635 <!-- <item><ref id="posix_memalign" name="posix_memalign"> -->
636 <!-- <item><ref id="putenv" name="putenv"> -->
637 <item><ref id="qsort" name="qsort">
638 <item><ref id="rand" name="rand">
639 <item><ref id="realloc" name="realloc">
640 <item><ref id="srand" name="srand">
641 <!-- <item><ref id="system" name="system"> -->
642 <item><ref id="ultoa" name="ultoa">
643 <item><ref id="utoa" name="utoa">
649 <sect1><tt/string.h/<label id="string.h"><p>
652 <item><ref id="_stroserror" name="_stroserror">
653 <item><ref id="bzero" name="bzero">
654 <item><ref id="memchr" name="memchr">
655 <item><ref id="memcmp" name="memcmp">
656 <item><ref id="memcpy" name="memcpy">
657 <item><ref id="memmove" name="memmove">
658 <item><ref id="memset" name="memset">
659 <item><ref id="strcasecmp" name="strcasecmp">
660 <item><ref id="strcat" name="strcat">
661 <item><ref id="strchr" name="strchr">
662 <item><ref id="strcmp" name="strcmp">
663 <item><ref id="strcoll" name="strcoll">
664 <item><ref id="strcpy" name="strcpy">
665 <item><ref id="strcspn" name="strcspn">
666 <item><ref id="strdup" name="strdup">
667 <item><ref id="strerror" name="strerror">
668 <item><ref id="stricmp" name="stricmp">
669 <item><ref id="strlen" name="strlen">
670 <item><ref id="strlower" name="strlower">
671 <item><ref id="strlwr" name="strlwr">
672 <item><ref id="strncasecmp" name="strncasecmp">
673 <item><ref id="strncat" name="strncat">
674 <item><ref id="strncmp" name="strncmp">
675 <item><ref id="strncpy" name="strncpy">
676 <item><ref id="strnicmp" name="strnicmp">
677 <item><ref id="strqtok" name="strqtok">
678 <item><ref id="strrchr" name="strrchr">
679 <item><ref id="strspn" name="strspn">
680 <item><ref id="strstr" name="strstr">
681 <item><ref id="strtok" name="strtok">
682 <item><ref id="strxfrm" name="strxfrm">
683 <item><ref id="strupper" name="strupper">
684 <item><ref id="strupr" name="strupr">
688 <sect1><tt/telestrat.h/<label id="telestrat.h"><p>
691 <item><ref id="atmos_explode" name="explode">
692 <item><ref id="atmos_ping" name="ping">
693 <item><ref id="atmos_shoot" name="shoot">
694 <item><ref id="atmos_zap" name="zap">
695 <!-- <item><ref id="kbdclick1" name="kbdclick1"> -->
696 <!-- <item><ref id="oups" name="oups"> -->
702 <sect1><tt/tgi.h/<label id="tgi.h"><p>
704 <url url="tgi.html" name="Tiny Graphics Interface">.
707 <sect1><tt/time.h/<label id="time.h"><p>
710 <!-- <item><ref id="_systime" name="_systime"> -->
711 <!-- <item><ref id="asctime" name="asctime"> -->
712 <item><ref id="clock" name="clock">
713 <!-- <item><ref id="ctime" name="ctime"> -->
714 <!-- <item><ref id="gmtime" name="gmtime"> -->
715 <!-- <item><ref id="localtime" name="localtime"> -->
716 <!-- <item><ref id="mktime" name="mktime"> -->
717 <!-- <item><ref id="strftime" name="strftime"> -->
718 <item><ref id="time" name="time">
724 <sect1><tt/unistd.h/<label id="unistd.h"><p>
727 <!-- <item><ref id="chdir" name="chdir"> -->
728 <item><ref id="exec" name="exec">
729 <item><ref id="getcwd" name="getcwd">
730 <item><ref id="getopt" name="getopt">
731 <!-- <item><ref id="lseek" name="lseek"> -->
732 <!-- <item><ref id="mkdir" name="mkdir"> -->
733 <!-- <item><ref id="read" name="read"> -->
734 <!-- <item><ref id="rmdir" name="rmdir"> -->
735 <item><ref id="sleep" name="sleep">
736 <item><ref id="unlink" name="unlink">
737 <!-- <item><ref id="write" name="write"> -->
743 <sect1><tt/vic20.h/<label id="vic20.h"><p>
748 <sect1><tt/zlib.h/<label id="zlib.h"><p>
751 <!-- <item><ref id="adler32" name="adler32"> -->
752 <!-- <item><ref id="crc32" name="crc32"> -->
753 <!-- <item><ref id="inflatemem" name="inflatemem"> -->
754 <!-- <item><ref id="uncompress" name="uncompress"> -->
760 <sect>Alphabetical function reference<p>
762 <sect1>_DE_ISDIR<label id="_DE_ISDIR"><p>
766 <tag/Function/Determine if a directory entry specifies a directory.
767 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
768 <tag/Declaration/<tt/int _DE_ISDIR(unsigned char type);/
769 <tag/Description/The function is called with the type of a directory entry
770 taken from a <tt/struct dirent/ and returns true if the entry designates
773 <item>The function is actually a macro.
775 <tag/Availability/cc65
777 <ref id="_DE_ISLBL" name="_DE_ISLBL">,
778 <ref id="_DE_ISLNK" name="_DE_ISLNK">,
779 <ref id="_DE_ISREG" name="_DE_ISREG">
785 <sect1>_DE_ISLBL<label id="_DE_ISLBL"><p>
789 <tag/Function/Determine if a directory entry specifies a disk label.
790 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
791 <tag/Declaration/<tt/int _DE_ISLBL(unsigned char type);/
792 <tag/Description/The function is called with the type of a directory entry
793 taken from a <tt/struct dirent/ and returns true if the entry designates
796 <item>The function is actually a macro.
798 <tag/Availability/cc65
800 <ref id="_DE_ISDIR" name="_DE_ISDIR">,
801 <ref id="_DE_ISLNK" name="_DE_ISLNK">,
802 <ref id="_DE_ISREG" name="_DE_ISREG">
808 <sect1>_DE_ISLNK<label id="_DE_ISLNK"><p>
812 <tag/Function/Determine if a directory entry specifies a link.
813 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
814 <tag/Declaration/<tt/int _DE_ISLNK(unsigned char type);/
815 <tag/Description/The function is called with the type of a directory entry
816 taken from a <tt/struct dirent/ and returns true if the entry designates
819 <item>The function is actually a macro.
821 <tag/Availability/cc65
823 <ref id="_DE_ISDIR" name="_DE_ISDIR">,
824 <ref id="_DE_ISLBL" name="_DE_ISLBL">,
825 <ref id="_DE_ISREG" name="_DE_ISREG">
831 <sect1>_DE_ISREG<label id="_DE_ISREG"><p>
835 <tag/Function/Determine if a directory entry specifies a regular file.
836 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
837 <tag/Declaration/<tt/int _DE_ISREG(unsigned char type);/
838 <tag/Description/The function is called with the type of a directory entry
839 taken from a <tt/struct dirent/ and returns true if the entry designates
842 <item>The function is actually a macro.
843 <item>A "regular file" means anything with data in it. This might still mean
844 that special processing is needed, when accessing the file. Relative files of
845 the CBM systems are classified as being "regular" files, for example.
847 <tag/Availability/cc65
849 <ref id="_DE_ISDIR" name="_DE_ISDIR">,
850 <ref id="_DE_ISLBL" name="_DE_ISLBL">,
851 <ref id="_DE_ISLNK" name="_DE_ISLNK">
857 <sect1>_heapadd<label id="_heapadd"><p>
861 <tag/Function/Add a block to the heap.
862 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
863 <tag/Declaration/<tt/void __fastcall__ _heapadd (void* mem, size_t size);/
864 <tag/Description/The function adds a block of raw memory to the heap.
866 <item>The minimum blocksize that can be added is 6 bytes; the function will
867 ignore smaller blocks.
868 <item>The function is available only as a fastcall function; so, it may be used
869 only in the presence of a prototype.
871 <tag/Availability/cc65
873 <ref id="_heapblocksize" name="_heapblocksize">,
874 <ref id="_heapmaxavail" name="_heapmaxavail">,
875 <ref id="_heapmemavail" name="_heapmemavail">,
876 <ref id="calloc" name="calloc">,
877 <ref id="free" name="free">,
878 <ref id="malloc" name="malloc">,
879 <ref id="realloc" name="realloc">
885 <sect1>_heapblocksize<label id="_heapblocksize"><p>
889 <tag/Function/Return the size of an allocated block.
890 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
891 <tag/Declaration/<tt/size_t __fastcall__ _heapblocksize (const void* block);/
892 <tag/Description/The function returns the size of a block that must have
893 previously been allocated by <tt/<ref id="malloc" name="malloc">/, <tt/<ref
894 id="calloc" name="calloc">/ or <tt/<ref id="realloc" name="realloc">/.
896 <item>Passing a pointer to a block that was is not the result of one of the
897 allocation functions, or that has been free'd will give unpredicable results.
898 <item>The function is available only as a fastcall function; so, it may be used
899 only in the presence of a prototype.
901 <tag/Availability/cc65
903 <ref id="_heapadd" name="_heapadd">,
904 <ref id="_heapmaxavail" name="_heapmaxavail">,
905 <ref id="_heapmemavail" name="_heapmemavail">,
906 <ref id="calloc" name="calloc">,
907 <ref id="free" name="free">,
908 <ref id="malloc" name="malloc">,
909 <ref id="realloc" name="realloc">
915 <sect1>_heapmaxavail<label id="_heapmaxavail"><p>
919 <tag/Function/Return the largest block that is available on the heap.
920 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
921 <tag/Declaration/<tt/size_t _heapmaxavail (void);/
922 <tag/Description/The function returns the size of the largest block that may
923 be allocated from the heap using <tt/<ref id="malloc" name="malloc">/.
924 <tag/Availability/cc65
926 <ref id="_heapadd" name="_heapadd">,
927 <ref id="_heapblocksize" name="_heapblocksize">,
928 <ref id="_heapmemavail" name="_heapmemavail">,
929 <ref id="calloc" name="calloc">,
930 <ref id="free" name="free">,
931 <ref id="malloc" name="malloc">,
932 <ref id="realloc" name="realloc">
938 <sect1>_heapmemavail<label id="_heapmemavail"><p>
942 <tag/Function/Return the total available space on the heap.
943 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
944 <tag/Declaration/<tt/size_t _heapmemavail (void);/
945 <tag/Description/The function returns the total number of bytes available on
948 <item>This function is of less use than usually assumed, since the returned
949 heap space may be available but not in one block. So even if this function
950 says that several times more heap space is available than needed, <ref
951 id="malloc" name="malloc"> may still return <tt/NULL/.
953 <tag/Availability/cc65
955 <ref id="_heapadd" name="_heapadd">,
956 <ref id="_heapblocksize" name="_heapblocksize">,
957 <ref id="_heapmaxavail" name="_heapmaxavail">,
958 <ref id="calloc" name="calloc">,
959 <ref id="free" name="free">,
960 <ref id="malloc" name="malloc">,
961 <ref id="realloc" name="realloc">
967 <sect1>_is_cmdline_dos<label id="_is_cmdline_dos"><p>
971 <tag/Function/Determines whether the underlying DOS supports command line arguments.
972 <tag/Header/<tt/<ref id="atari.h" name="atari.h">/
973 <tag/Declaration/<tt/unsigned char _is_cmdline_dos (void);/
974 <tag/Description/The function returns 0 if the DOS doesn't support command line arguments.
975 It returns 1 if it does.
976 <tag/Availability/cc65 (<tt/atari/ and <tt/atarixl/ platforms)
981 <sect1>_poserror<label id="_poserror"><p>
985 <tag/Function/Print an error message for the error in <tt/_oserror/.
986 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
987 <tag/Declaration/<tt/void __fastcall__ _poserror (const char* msg);/
988 <tag/Description/<tt/_poserror/ prints an error message to <tt/stderr/. If
989 <tt/msg/ is not <tt/NULL/ and not an empty string, it is printed followed by
990 a colon and a blank. Then the error message for the current contents of
991 <tt/_oserror/ are printed followed by a newline. The message output is the
992 same as returned by <tt/<ref id="_stroserror" name="_stroserror">/ with an
993 argument of <tt/_oserror/.
995 <item>Since operating system specific error code are - you guessed it -
996 operating system specific, the value in <tt/_oserror/ and the message that is
997 printed depends on the cc65 target.
998 <item>The function is only available as fastcall function, so it may only
999 be used in presence of a prototype.
1001 <tag/Availability/cc65
1003 <ref id="_stroserror" name="_stroserror">,
1004 <ref id="perror" name="perror">
1010 <sect1>_randomize<label id="_randomize"><p>
1014 <tag/Function/Initialize the pseudo random number generator.
1015 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1016 <tag/Declaration/<tt/void _randomize (void);/
1017 <tag/Description/The function initializes the random number generator with
1018 a seed derived from fast changing hardware events, so the seed itself can be
1019 considered random to a certain degree.
1020 <tag/Notes/<itemize>
1021 <item>The randomness of the seed depends on the machine hardware.
1023 <tag/Availability/cc65
1025 <ref id="rand" name="rand">,
1026 <ref id="srand" name="srand">
1032 <sect1>_stroserror<label id="_stroserror"><p>
1036 <tag/Function/Return a string describing an OS specific error code.
1037 <tag/Header/<tt/<ref id="string.h" name="string.h">/
1038 <tag/Declaration/<tt/const char* __fastcall__ _stroserror (unsigned char errcode);/
1039 <tag/Description/<tt/_stroserror/ will return a string describing the given
1040 operating system specific error code.
1041 <tag/Notes/<itemize>
1042 <item>Since operating system specific error code are - you guessed it -
1043 operating system specific, the parameter and the string returned depend on the
1045 <item>The function is only available as fastcall function, so it may only be
1046 used in presence of a prototype.
1048 <tag/Availability/cc65
1050 <ref id="strerror" name="strerror">
1056 <sect1>_swap<label id="_swap"><p>
1060 <tag/Function/Swap the contents of memory areas.
1061 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1062 <tag/Declaration/<tt/void __fastcall__ _swap (void* p, void* q, size_t size);/
1063 <tag/Description/<tt/_swap/ will swap (exchange) the contents of the two memory
1064 areas pointed to by <tt/p/ and <tt/q/. Both memory areas are assumed to be
1065 <tt/size/ bytes in size.
1066 <tag/Notes/<itemize>
1067 <item>The memory areas may not overlap, otherwise the results are undefined.
1068 <item>The function is only available as fastcall function, so it may only be
1069 used in presence of a prototype.
1071 <tag/Availability/cc65
1073 <ref id="memcpy" name="memcpy">,
1074 <ref id="memmove" name="memmove">
1080 <sect1>_sys<label id="_sys"><p>
1084 <tag/Function/Call a subroutine passing register values.
1085 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
1086 <tag/Declaration/<tt/void __fastcall__ _sys (struct regs* r);/
1087 <tag/Description/The function will call the subroutine at the address
1088 specified in the <tt/pc/ member of the passed <tt/regs/ structure. All
1089 registers and the CPU flags are set to the values given in the <tt/regs/
1090 structure. On return from the subroutine, the new values of the registers and
1091 flags are stored back overwriting the old values.
1092 <tag/Notes/<itemize>
1093 <item>Bits 4 and 5 of the flags value in the <tt/regs/ structure are ignored
1094 when calling the subroutine (they are unchanged from their current values).
1095 <item>The function is only available as fastcall function, so it may only be
1096 used in presence of a prototype.
1098 <tag/Availability/cc65
1104 <sect1>BRK<label id="BRK"><p>
1108 <tag/Function/Insert a 6502 BRK instrunction into the code.
1109 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
1110 <tag/Declaration/<tt/void BRK (void);/
1111 <tag/Description/The function will insert a 6502 BRK instruction into the code
1112 which may be used to trigger a debugger.
1113 <tag/Notes/<itemize>
1114 <item>The function is actually a macro.
1115 <item>The inserted instruction may lead to unexpected results if no debugger
1118 <tag/Availability/cc65
1120 <ref id="CLI" name="CLI">,
1121 <ref id="SEI" name="SEI">
1127 <sect1>CLI<label id="CLI"><p>
1131 <tag/Function/Insert a 6502 CLI instrunction into the code.
1132 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
1133 <tag/Declaration/<tt/void CLI (void);/
1134 <tag/Description/The function will insert a 6502 CLI instruction into the code,
1135 so interrupts are enabled. Enabling interrupts has no effects if they are
1136 already enabled (the default).
1137 <tag/Notes/<itemize>
1138 <item>The function is actually a macro.
1139 <item>Disabling interrupts may lead to unexpected results.
1141 <tag/Availability/cc65
1143 <ref id="BRK" name="BRK">,
1144 <ref id="SEI" name="SEI">
1150 <sect1>PEEK<label id="PEEK"><p>
1154 <tag/Function/Read a byte from memory.
1155 <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/
1156 <tag/Declaration/<tt/unsigned char PEEK (unsigned addr);/
1157 <tag/Description/The function will read the absolute memory given by <tt/addr/
1158 and return the value read.
1159 <tag/Notes/<itemize>
1160 <item>The function is actually a macro.
1161 <item>This function depends highly on the platform and environment.
1163 <tag/Availability/cc65
1165 <ref id="PEEKW" name="PEEKW">,
1166 <ref id="POKE" name="POKE">
1172 <sect1>PEEKW<label id="PEEKW"><p>
1176 <tag/Function/Read a word (two bytes) from memory.
1177 <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/
1178 <tag/Declaration/<tt/unsigned PEEKW (unsigned addr);/
1179 <tag/Description/The function will read the absolute memory given by <tt/addr/
1180 and return the value read. The byte read from the higher address is the high
1181 byte of the return value.
1182 <tag/Notes/<itemize>
1183 <item>The function is actually a macro.
1184 <item>This function depends highly on the platform and environment.
1185 <item>The order in which the two bytes are read is unspecified and may
1186 depend of the address expression used.
1188 <tag/Availability/cc65
1190 <ref id="PEEK" name="PEEK">,
1191 <ref id="POKE" name="POKE">
1197 <sect1>POKE<label id="POKE"><p>
1201 <tag/Function/Write a byte to memory.
1202 <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/
1203 <tag/Declaration/<tt/void POKE (unsigned addr, unsigned char val);/
1204 <tag/Description/The function writes the value <tt/val/ to the absolute
1205 memory address given by <tt/addr/.
1206 <tag/Notes/<itemize>
1207 <item>The function is actually a macro.
1208 <item>This function depends highly on the platform and environment.
1209 <item>Careless use will cause the program to act strange or may crash the
1212 <tag/Availability/cc65
1214 <ref id="PEEK" name="PEEK">,
1215 <ref id="POKEW" name="POKEW">
1221 <sect1>POKEW<label id="POKEW"><p>
1225 <tag/Function/Write a word (two bytes) to memory.
1226 <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/
1227 <tag/Declaration/<tt/void POKEW (unsigned addr, unsigned val);/
1228 <tag/Description/The function writes the value <tt/val/ to the absolute
1229 memory address given by <tt/addr/. The low byte of <tt/val/ is written to
1230 the <tt/addr/, the high byte is written to <tt/addr+1/.
1231 <tag/Notes/<itemize>
1232 <item>The function is actually a macro.
1233 <item>This function depends highly on the platform and environment.
1234 <item>Careless use will cause the program to act strange or may crash the
1236 <item>The order in which the two bytes are written is unspecified and may
1237 depend of the address expression used.
1239 <tag/Availability/cc65
1241 <ref id="PEEK" name="PEEK">,
1242 <ref id="POKE" name="POKE">
1248 <sect1>SEI<label id="SEI"><p>
1252 <tag/Function/Insert a 6502 SEI instrunction into the code.
1253 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
1254 <tag/Declaration/<tt/void SEI (void);/
1255 <tag/Description/The function will insert a 6502 SEI instruction into the code,
1256 so interrupts are disabled. Note that non maskable interrupts cannot be
1258 <tag/Notes/<itemize>
1259 <item>The function is actually a macro.
1260 <item>Disabling interrupts may lead to unexpected results.
1262 <tag/Availability/cc65
1264 <ref id="BRK" name="BRK">,
1265 <ref id="CLI" name="CLI">
1271 <sect1>abort<label id="abort"><p>
1275 <tag/Function/Terminates a program abnormally.
1276 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1277 <tag/Declaration/<tt/void abort (void);/
1278 <tag/Description/<tt/abort/ raises <tt/SIGABRT/, writes a termination message
1279 on stderr, then terminates the program with an exit code of 3.
1280 <tag/Availability/ISO 9899
1282 <ref id="assert" name="assert">,
1283 <ref id="exit" name="exit">,
1284 <ref id="raise" name="raise">
1290 <sect1>abs<label id="abs"><p>
1294 <tag/Function/Returns the absolute value of an integer.
1295 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1296 <tag/Declaration/<tt/int __fastcall__ abs (int v);/
1297 <tag/Description/<tt/abs/ returns the absolute value of the argument passed to
1299 <tag/Notes/<itemize>
1300 <item>The return value is undefined if <tt/INT_MIN/ is passed to the function.
1301 <item>The function is only available as fastcall function, so it may only be
1302 used in presence of a prototype.
1304 <tag/Availability/ISO 9899
1306 <ref id="labs" name="labs">
1312 <sect1>assert<label id="assert"><p>
1316 <tag/Function/Test a condition and possibly abort.
1317 <tag/Header/<tt/<ref id="assert.h" name="assert.h">/
1318 <tag/Declaration/<tt/void assert (int cond);/
1319 <tag/Description/<tt/assert/ is a macro that expands to a <tt/id/
1320 statement. If the condition evaluates t zero (false), assert prints a message
1321 on stderr and aborts the program.
1322 <tag/Notes/<itemize>
1323 <item>The function is actually a macro.
1325 <tag/Availability/ISO 9899
1327 <ref id="abort" name="abort">,
1328 <ref id="exit" name="exit">
1334 <sect1>atexit<label id="atexit"><p>
1338 <tag/Function/Register an exit function.
1339 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1340 <tag/Declaration/<tt/int __fastcall__ atexit (void (*exitfunc) (void));/
1341 <tag/Description/<tt/atexit/ registers the function pointed to by
1342 <tt/exitfunc/ as an exit function. Exit functions are called when the program
1343 terminates, they are called in LIFO order (the last function registered is
1344 called first). <tt/atexit/ returns zero on success and a nonzero value on
1346 <tag/Notes/<itemize>
1347 <item>A maximum of 5 exit functions can be registered.
1348 <item>There is no way to unregister an exit function.
1349 <item>The function is only available as fastcall function, so it may only be
1350 used in presence of a prototype.
1352 <tag/Availability/ISO 9899
1354 <ref id="abort" name="abort">,
1355 <ref id="exit" name="exit">
1361 <sect1>atmos_explode<label id="atmos_explode"><p>
1365 <tag/Function/Bomb sound effect.
1366 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1367 <tag/Declaration/<tt/void __fastcall__ atmos_explode(void);/
1368 <tag/Description/<tt/atmos_explode/ plays the BASIC sound.
1369 <tag/Notes/<itemize>
1370 <item>The function is available only as a fastcall function; so, it may be used
1371 only in the presence of a prototype.
1373 <tag/Availability/cc65
1375 <ref id="atmos_ping" name="atmos_ping">,
1376 <ref id="atmos_shoot" name="atmos_shoot">,
1377 <ref id="atmos_tick" name="atmos_tick">,
1378 <ref id="atmos_tock" name="atmos_tock">,
1379 <ref id="atmos_zap" name="atmos_zap">
1385 <sect1>atmos_load<label id="atmos_load"><p>
1389 <tag/Function/Load Atmos tape.
1390 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1391 <tag/Declaration/<tt/void __fastcall__ atmos_load(const char* name);/
1392 <tag/Description/<tt/atmos_load/ reads a memory block from tape.
1393 <tag/Notes/<itemize>
1394 <item>The function is available only as a fastcall function; so, it may be used
1395 only in the presence of a prototype.
1397 <tag/Availability/cc65
1399 <ref id="atmos_save" name="atmos_save">
1405 <sect1>atmos_ping<label id="atmos_ping"><p>
1409 <tag/Function/Bell or ricochet sound effect.
1410 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1411 <tag/Declaration/<tt/void __fastcall__ atmos_ping(void);/
1412 <tag/Description/<tt/atmos_ping/ plays the BASIC sound.
1413 <tag/Notes/<itemize>
1414 <item>The function is available only as a fastcall function; so, it may be used
1415 only in the presence of a prototype.
1417 <tag/Availability/cc65
1419 <ref id="atmos_explode" name="atmos_explode">,
1420 <ref id="atmos_shoot" name="atmos_shoot">,
1421 <ref id="atmos_tick" name="atmos_tick">,
1422 <ref id="atmos_tock" name="atmos_tock">,
1423 <ref id="atmos_zap" name="atmos_zap">
1429 <sect1>atmos_save<label id="atmos_save"><p>
1433 <tag/Function/Save Atmos tape.
1434 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1435 <tag/Declaration/<tt/void __fastcall__ atmos_save(const char* name, const void* start, const void* end);/
1436 <tag/Description/<tt/atmos_save/ writes a memory block to tape.
1437 <tag/Notes/<itemize>
1438 <item>The function is available only as a fastcall function; so, it may be used
1439 only in the presence of a prototype.
1441 <tag/Availability/cc65
1443 <ref id="atmos_load" name="atmos_load">
1445 atmos_save("hires", 0xa000, 0xc000);
1451 <sect1>atmos_shoot<label id="atmos_shoot"><p>
1455 <tag/Function/Pistol sound effect.
1456 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1457 <tag/Declaration/<tt/void __fastcall__ atmos_shoot(void);/
1458 <tag/Description/<tt/atmos_shoot/ plays the BASIC sound.
1459 <tag/Notes/<itemize>
1460 <item>The function is available only as a fastcall function; so, it may be used
1461 only in the presence of a prototype.
1463 <tag/Availability/cc65
1465 <ref id="atmos_explode" name="atmos_explode">,
1466 <ref id="atmos_ping" name="atmos_ping">,
1467 <ref id="atmos_tick" name="atmos_tick">,
1468 <ref id="atmos_tock" name="atmos_tock">,
1469 <ref id="atmos_zap" name="atmos_zap">
1475 <sect1>atmos_tick<label id="atmos_tick"><p>
1479 <tag/Function/High-pitch click.
1480 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1481 <tag/Declaration/<tt/void __fastcall__ atmos_tick(void);/
1482 <tag/Description/<tt/atmos_tick/ plays the system sound.
1483 <tag/Notes/<itemize>
1484 <item>The function is available only as a fastcall function; so, it may be used
1485 only in the presence of a prototype.
1487 <tag/Availability/cc65
1489 <ref id="atmos_explode" name="atmos_explode">,
1490 <ref id="atmos_ping" name="atmos_ping">,
1491 <ref id="atmos_shoot" name="atmos_shoot">,
1492 <ref id="atmos_tock" name="atmos_tock">,
1493 <ref id="atmos_zap" name="atmos_zap">
1499 <sect1>atmos_tock<label id="atmos_tock"><p>
1503 <tag/Function/Low-pitch click.
1504 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1505 <tag/Declaration/<tt/void __fastcall__ atmos_tock(void);/
1506 <tag/Description/<tt/atmos_tock/ plays the system sound.
1507 <tag/Notes/<itemize>
1508 <item>The function is available only as a fastcall function; so, it may be used
1509 only in the presence of a prototype.
1511 <tag/Availability/cc65
1513 <ref id="atmos_explode" name="atmos_explode">,
1514 <ref id="atmos_ping" name="atmos_ping">,
1515 <ref id="atmos_shoot" name="atmos_shoot">,
1516 <ref id="atmos_tick" name="atmos_tick">,
1517 <ref id="atmos_zap" name="atmos_zap">
1523 <sect1>atmos_zap<label id="atmos_zap"><p>
1527 <tag/Function/Raygun sound effect.
1528 <tag/Header/<tt/<ref id="atmos.h" name="atmos.h">/
1529 <tag/Declaration/<tt/void __fastcall__ atmos_zap(void);/
1530 <tag/Description/<tt/atmos_zap/ plays the BASIC sound.
1531 <tag/Notes/<itemize>
1532 <item>The function is available only as a fastcall function; so, it may be used
1533 only in the presence of a prototype.
1535 <tag/Availability/cc65
1537 <ref id="atmos_explode" name="atmos_explode">,
1538 <ref id="atmos_ping" name="atmos_ping">,
1539 <ref id="atmos_shoot" name="atmos_shoot">,
1540 <ref id="atmos_tick" name="atmos_tick">,
1541 <ref id="atmos_tock" name="atmos_tock">
1547 <sect1>atoi<label id="atoi"><p>
1551 <tag/Function/Convert a string to an integer.
1552 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1553 <tag/Declaration/<tt/int __fastcall__ atoi (const char* s);/
1554 <tag/Description/<tt/atoi/ converts the given string into an integer.
1555 Conversion stops as soon as any invalid character is encountered.
1556 <tag/Notes/<itemize>
1557 <item>There is no way to detect any conversion errors.
1558 <item>The function does not check for an numerical overflow when converting.
1559 <item>The function is only available as fastcall function, so it may only be
1560 used in presence of a prototype.
1562 <tag/Availability/ISO 9899
1564 <ref id="atol" name="atol">,
1565 <ref id="itoa" name="itoa">,
1566 <ref id="ltoa" name="ltoa">,
1567 <ref id="ultoa" name="ultoa">,
1568 <ref id="utoa" name="utoa">
1574 <sect1>atol<label id="atol"><p>
1578 <tag/Function/Convert a string to a long integer.
1579 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1580 <tag/Declaration/<tt/long __fastcall__ atol (const char* s);/
1581 <tag/Description/<tt/atol/ converts the given string into a long integer.
1582 Conversion stops as soon as any invalid character is encountered.
1583 <tag/Notes/<itemize>
1584 <item>There is no way to detect any conversion errors.
1585 <item>The function does not check for an numerical overflow when converting.
1586 <item>The function is only available as fastcall function, so it may only be
1587 used in presence of a prototype.
1589 <tag/Availability/ISO 9899
1591 <ref id="atoi" name="atoi">,
1592 <ref id="itoa" name="itoa">,
1593 <ref id="ltoa" name="ltoa">,
1594 <ref id="ultoa" name="ultoa">,
1595 <ref id="utoa" name="utoa">
1601 <sect1>bgcolor<label id="bgcolor"><p>
1605 <tag/Function/Set the background text color.
1606 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
1607 <tag/Declaration/<tt/unsigned char __fastcall__ bgcolor (unsigned char color);/
1608 <tag/Description/The function will set a new background color and return the
1609 old (current) one. The background color is valid for the whole text output
1610 area of the screen, not just for new text.
1611 <tag/Notes/<itemize>
1612 <item>Background colors are system dependent. The function may have no effect
1613 on systems where the background color cannot be changed.
1614 <item>The function is only available as fastcall function, so it may only be
1615 used in presence of a prototype.
1617 <tag/Availability/cc65
1619 <ref id="bordercolor" name="bordercolor">,
1620 <ref id="textcolor" name="textcolor">
1626 <sect1>bordercolor<label id="bordercolor"><p>
1630 <tag/Function/Set the border (frame) color.
1631 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
1632 <tag/Declaration/<tt/unsigned char __fastcall__ bordercolor (unsigned char color);/
1633 <tag/Description/The function will set a new border color. It returns the old
1634 (current) border color.
1635 <tag/Notes/<itemize>
1636 <item>Border colors are system dependent. The function may have no effect
1637 on systems where the border color cannot be changed.
1638 <item>The function is only available as fastcall function, so it may only
1639 be used in presence of a prototype.
1641 <tag/Availability/cc65
1643 <ref id="bgcolor" name="bgcolor">,
1644 <ref id="textcolor" name="textcolor">
1650 <sect1>bsearch<label id="bsearch"><p>
1654 <tag/Function/Do a binary search in a sorted array.
1655 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1656 <tag/Declaration/<tt/void* __fastcall__ bsearch (const void* key,
1657 const void* base, size_t n, size_t size,
1658 int __fastcall__ (* cmp) (const void*, const void*));/
1659 <tag/Description/<tt/bsearch/ searches a sorted array for a member that
1660 matches the one pointed to by <tt/key/. <tt/base/ is the address of the array,
1661 <tt/n/ is the number of elements, <tt/size/ the size of an element and <tt/cmp/
1662 the function used to compare the members against the key. The function returns
1663 a pointer to the member found, or <tt/NULL/ if there was no match.
1664 <tag/Notes/<itemize>
1665 <item>The contents of the array must be sorted in ascending order according to
1666 the compare function given.
1667 <item>If there are multiple members that match the key, the function will
1668 return one of the members.
1669 <item>The function is only available as fastcall function, so it may only
1670 be used in presence of a prototype.
1671 <item>The function to which <tt/cmp/ points must have the <tt/fastcall/ calling
1674 <tag/Availability/ISO 9899
1676 <ref id="qsort" name="qsort">
1682 <sect1>bzero<label id="bzero"><p>
1686 <tag/Function/Fill a memory area with zeroes.
1687 <tag/Header/<tt/<ref id="string.h" name="string.h">/
1688 <tag/Declaration/<tt/void __fastcall__ bzero (void* p, size_t count);/
1689 <tag/Description/<tt/bzero/ fills the memory area pointed to by <tt/p/ with
1691 <tag/Notes/<itemize>
1692 <item>The function is non standard and therefore only available in non ANSI
1693 mode. You should use <tt/<ref id="memset" name="memset">/ instead.
1694 <item>The function is only available as fastcall function, so it may only
1695 be used in presence of a prototype.
1697 <tag/Availability/cc65
1699 <ref id="_swap" name="_swap">,
1700 <ref id="memcpy" name="memcpy">,
1701 <ref id="memmove" name="memmove">,
1702 <ref id="memset" name="memset">,
1708 <sect1>c64mode<label id="c64mode"><p>
1712 <tag/Function/Switch the C128 into C64 compatible mode.
1713 <tag/Header/<tt/<ref id="c128.h" name="c128.h">/
1714 <tag/Declaration/<tt/void c64mode (void);/
1715 <tag/Description/The function will cause the machine to reboot into C64 mode.
1716 <tag/Notes/<itemize>
1717 <item>The function is specific to the C128.
1718 <item>The function will not return to the caller.
1720 <tag/Availability/C128
1726 <sect1>calloc<label id="calloc"><p>
1730 <tag/Function/Allocate and clear memory.
1731 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
1732 <tag/Declaration/<tt/void* __fastcall__ calloc (size_t n, size_t size);/
1733 <tag/Description/<tt/calloc/ allocates memory for an array of <tt/n/ elements
1734 of size <tt/size/, clears the whole block with binary zeroes and returns a
1735 pointer to it. On error (not enough memory available), <tt/calloc/ returns
1737 <tag/Notes/<itemize>
1738 <item>Clearing the memory may not have the expected effect on all platforms:
1739 pointers in the block may not be <tt/NULL/ and floating point variables may
1740 not be zero (0.0). In other words: The "clearing" effect of this function
1741 should be used with care for portable programs.
1742 <item>The function is only available as fastcall function, so it may only
1743 be used in presence of a prototype.
1745 <tag/Availability/ISO 9899
1747 <ref id="_heapadd" name="_heapadd">,
1748 <ref id="_heapblocksize" name="_heapblocksize">,
1749 <ref id="_heapmaxavail" name="_heapmaxavail">,
1750 <ref id="_heapmemavail" name="_heapmemavail">,
1751 <ref id="free" name="free">,
1752 <ref id="malloc" name="malloc">,
1753 <ref id="realloc" name="realloc">
1759 <sect1>cbm_k_acptr<label id="cbm_k_acptr"><p>
1763 <tag/Function/Input byte from serial bus
1764 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1765 <tag/Declaration/<tt/unsigned char cbm_k_acptr (void);/
1766 <tag/Description/The function returns a byte of data, which it
1767 gets from the current TALKer on the serial bus.
1768 In order to receive the data, the device must have previously been
1769 sent a command to TALK and a secondary address if it needs one.
1770 <tag/Notes/<itemize>
1773 <tag/Availability/cc65
1775 <ref id="cbm_k_talk" name="cbm_k_talk">,
1781 <sect1>cbm_k_basin<label id="cbm_k_basin"><p>
1785 <tag/Function/Input a Character from the Current Device
1786 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1787 <tag/Declaration/<tt/unsigned char cbm_k_basin (void);/
1788 <tag/Description/The function returns a character from the current input device.
1789 Device must first have been OPENed and then designated as the input channel by the CHKIN routine.
1790 When this function is called, the next byte of data available from the device is returned.
1791 Exception is the routine for the keyboard device (which is the default input device).
1792 <tag/Notes/<itemize>
1795 <tag/Availability/cc65
1797 <ref id="cbm_k_open" name="cbm_k_open">,
1798 <ref id="cbm_k_chkin" name="cbm_k_chkin">
1804 <sect1>cbm_k_bsout<label id="cbm_k_bsout"><p>
1808 <tag/Function/Output a byte
1809 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1810 <tag/Declaration/<tt/void __fastcall__ cbm_k_bsout (unsigned char C);/
1811 <tag/Description/Function sends the character to the current output device.
1812 Unless a device has been OPENed and designated as the
1813 current output channel using the CHKOUT routine, the character is
1814 printed to the screen, which is the default output device. If the
1815 cassette is the current device, outputting a byte will only add it to
1816 the buffer. No actual transmission of data will occur until the
1817 192-byte buffer is full.
1818 <tag/Notes/<itemize>
1819 <item>The function is only available as fastcall function, so it may
1820 only be used in presence of a prototype.
1822 <tag/Availability/cc65
1824 <ref id="cbm_k_open" name="cbm_k_open">,
1825 <ref id="cbm_k_chkin" name="cbm_k_chkout">
1831 <sect1>cbm_k_chkin<label id="cbm_k_chkin"><p>
1835 <tag/Function/Designate a Logical File As the Current Input Channel
1836 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1837 <tag/Declaration/<tt/unsigned char __fastcall__ cbm_k_chkin (unsigned char FN);/
1838 <tag/Description/If you wish to
1839 get data from any device other than the keyboard, this function must be
1840 called after OPENing the device, before you can get a data byte with
1841 the cbm_k_basin or cbm_k_getin routine. When called, the routine will designate
1842 the logical file whose file number was supplied as the
1843 current file, its device as the current device, and its secondary
1844 address as the current secondary address. If the device on the
1845 channel is a serial device, which requires a TALK command and
1846 sometimes a secondary address, function will send them over the
1848 <tag/Notes/<itemize>
1849 <item>The function is only available as fastcall function, so it may
1850 only be used in presence of a prototype.
1852 <tag/Availability/cc65
1854 <ref id="cbm_k_open" name="cbm_k_open">,
1855 <ref id="cbm_k_basin" name="cbm_k_basin">,
1856 <ref id="cbm_k_getin" name="cbm_k_getin">
1862 <sect1>cbm_k_ciout<label id="cbm_k_ciout"><p>
1866 <tag/Function/Transmit a byte over the serial bus
1867 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1868 <tag/Declaration/<tt/void __fastcall__ cbm_k_ciout (unsigned char C);/
1869 <tag/Description/Purpose of this function is to send a byte of data over
1870 the serial bus. In order for the data to be received, the serial
1871 device must have first been commanded to LISTEN and been given a
1872 secondary address if necessary. This routine always buffers the
1873 current character, and defers sending it until the next byte is
1874 buffered. When the UNLISTEN command is sent, the last byte will be
1875 sent with an End or Identify (EOI).
1876 <tag/Notes/<itemize>
1877 <item>The function is only available as fastcall function, so it may
1878 only be used in presence of a prototype.
1880 <tag/Availability/cc65
1882 <ref id="cbm_k_listen" name="cbm_k_listen">,
1883 <ref id="cbm_k_unlsn" name="cbm_k_unlsn">
1889 <sect1>cbm_k_ckout<label id="cbm_k_ckout"><p>
1893 <tag/Function/Designate a Logical File As the Current Output Channel
1894 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1895 <tag/Declaration/<tt/unsigned char __fastcall__ cbm_k_ckout (unsigned char FN);/
1896 <tag/Description/If you wish to
1897 output data to any device other than the screen, this routine must be
1898 called after OPENing the device, and before you output a data byte
1899 with the cbm_k_bsout() function. When called, the function will designate the
1900 logical file whose file number was supplied as the current
1901 file, its device as the current device, and its secondary address as
1902 the current secondary address. If the device on the channel uses the
1903 serial bus, and therefore requires a LISTEN command and possibly a
1904 secondary address, this information will be sent on the bus.
1905 <tag/Notes/<itemize>
1906 <item>The function is only available as fastcall function, so it may
1907 only be used in presence of a prototype.
1909 <tag/Availability/cc65
1911 <ref id="cbm_k_bsout" name="cbm_k_bsout">,
1912 <ref id="cbm_k_listen" name="cbm_k_listen">
1918 <sect1>cbm_k_clall<label id="cbm_k_clall"><p>
1922 <tag/Function/Close All Logical I/O Files
1923 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1924 <tag/Declaration/<tt/void cbm_k_clall (void);/
1925 <tag/Description/It closes all
1926 open files, by resetting the index into open files to
1927 zero and restores the default I/O devices.
1928 <tag/Notes/<itemize>
1931 <tag/Availability/cc65
1933 <ref id="cbm_k_open" name="cbm_k_open">,
1934 <ref id="cbm_k_close" name="cbm_k_close">
1940 <sect1>cbm_k_close<label id="cbm_k_close"><p>
1944 <tag/Function/Close a Logical I/O File
1945 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1946 <tag/Declaration/<tt/void __fastcall__ cbm_k_close (unsigned char FN);/
1947 <tag/Description/It is used to
1948 close a logical file after all I/O operations involving that file have
1950 <tag/Notes/<itemize>
1951 <item>The function is only available as fastcall function, so it may
1952 only be used in presence of a prototype.
1954 <tag/Availability/cc65
1956 <ref id="cbm_k_open" name="cbm_k_open">,
1957 <ref id="cbm_k_clall" name="cbm_k_clall">
1963 <sect1>cbm_k_clrch<label id="cbm_k_clrch"><p>
1967 <tag/Function/Restore Current Input and Output Devices to the Default Devices
1968 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1969 <tag/Declaration/<tt/void cbm_k_clrch (void);/
1970 <tag/Description/It sets the
1971 current input device to the keyboard, and the current output device to
1972 the screen. Also, if the current input device was formerly a serial
1973 device, the routine sends it an UNTALK command on the serial bus, and
1974 if a serial device was formerly the current output device, the routine
1975 sends it an UNLISTEN command.
1976 <tag/Notes/<itemize>
1979 <tag/Availability/cc65
1981 <ref id="cbm_k_chkin" name="cbm_k_chkin">,
1982 <ref id="cbm_k_ckout" name="cbm_k_ckout">
1988 <sect1>cbm_k_getin<label id="cbm_k_getin"><p>
1992 <tag/Function/Get One Byte from the Input Device
1993 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
1994 <tag/Declaration/<tt/unsigned char cbm_k_getin (void);/
1995 <tag/Description/Function gets a character from the current input device.
1996 <tag/Notes/<itemize>
1999 <tag/Availability/cc65
2001 <ref id="cbm_k_basin" name="cbm_k_basin">
2007 <sect1>cbm_k_iobase<label id="cbm_k_iobase"><p>
2011 <tag/Function/Return Base Address of Memory-Mapped I/O Devices
2012 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2013 <tag/Declaration/<tt/unsigned cbm_k_iobase (void);/
2014 <tag/Description/This function returns the address of
2015 the memory section where the memory mapped I/O devices are located. This
2016 address can then be used with an offset to access the memory mapped I/O
2017 devices in the Commodore 64. The offset is the number of locations from
2018 the beginning of the page on which the I/O register you want is located.
2019 This function exists to provide compatibility between the Commodore 64,
2020 VIC-20, and future models of the Commodore 64. If the I/O locations for
2021 a program are set by a call to this function, they should
2022 still remain compatible with future versions of the Commodore 64, the
2024 <tag/Notes/<itemize>
2027 <tag/Availability/cc65
2035 <sect1>cbm_k_listen<label id="cbm_k_listen"><p>
2039 <tag/Function/Command a device on the serial bus to LISTEN
2040 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2041 <tag/Declaration/<tt/void __fastcall__ cbm_k_listen (unsigned char dev);/
2042 <tag/Description/This function will command a device on the serial bus to
2043 receive data. The KERNAL routine will OR the supplied device number bit by bit
2044 to convert it to a listen address, then transmits this data as a command on
2045 the serial bus. The specified device will then go into listen mode, and
2046 be ready to accept information.
2047 <tag/Notes/<itemize>
2048 <item>The function is only available as fastcall function, so it may
2049 only be used in presence of a prototype.
2051 <tag/Availability/cc65
2053 <ref id="cbm_k_unlsn" name="cbm_k_unlsn">,
2059 <sect1>cbm_k_load<label id="cbm_k_load"><p>
2063 <tag/Function/Load RAM from a Device
2064 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2065 <tag/Declaration/<tt/unsigned int __fastcall__ cbm_k_load(unsigned char flag, unsigned addr);/
2066 <tag/Description/This function LOADs data bytes from any input device directly into the memory.
2067 It can also be used for a verify operation, comparing data from a device with the data already in
2068 memory, while leaving the data stored in RAM unchanged.
2069 The flag must be set to 0 for a LOAD operation, or 1 for a
2070 verify, If the input device is OPENed with a secondary address (SA) of 0
2071 the header information from the device is ignored. In this case, the starting address for the load must be supplied.
2072 If the device is addressed with a secondary address of 1, then the data is
2073 loaded into memory starting at the location specified by the header.
2074 Function returns the address of the highest RAM location loaded.
2075 Before this function can be called, the KERNAL SETLFS, and SETNAM
2076 routines must be called.
2077 <tag/Notes/<itemize>
2078 <item>The function is only available as fastcall function, so it may
2079 only be used in presence of a prototype.
2081 <tag/Availability/cc65
2083 <ref id="cbm_k_save" name="cbm_k_save">,
2084 <ref id="cbm_k_setlfs" name="cbm_k_setlfs">,
2085 <ref id="cbm_k_setnam" name="cbm_k_setnam">
2091 <sect1>cbm_k_open<label id="cbm_k_open"><p>
2095 <tag/Function/Open a Logical I/O File
2096 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2097 <tag/Declaration/<tt/unsigned char cbm_k_open (void);/
2098 <tag/Description/This function assigns a logical file to a device, so that it can be used for
2099 Input/Output operations. In order to specify the logical file number,
2100 the device number, and the secondary address if any, the cbm_k_setlfs() function must first be called.
2101 Likewise, in order to designate the filename, the cbm_k_setnam() function must be used first. After these two
2102 functions are called, cbm_k_open() is then called.
2103 <tag/Notes/<itemize>
2106 <tag/Availability/cc65
2108 <ref id="cbm_k_close" name="cbm_k_close">,
2109 <ref id="cbm_k_setlfs" name="cbm_k_setlfs">,
2110 <ref id="cbm_k_setnam" name="cbm_k_setnam">
2116 <sect1>cbm_k_readst<label id="cbm_k_readst"><p>
2120 <tag/Function/Read status word
2121 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2122 <tag/Declaration/<tt/unsigned char cbm_k_readst (void);/
2123 <tag/Description/This function returns the current status of the I/O devices. It is usually called after new communication to an I/O device and gives information about device status, or errors that have occurred during the I/O operation.
2124 <tag/Notes/<itemize>
2127 <tag/Availability/cc65
2135 <sect1>cbm_k_save<label id="cbm_k_save"><p>
2139 <tag/Function/Save RAM to a Device
2140 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2141 <tag/Declaration/<tt/unsigned char __fastcall__ cbm_k_save(unsigned int start, unsigned int end)/
2142 <tag/Description/This function saves a section of memory. The cbm_k_setlfs() and cbm_k_setnam() functions must be
2143 used before calling this function. However, a file name is not required to
2144 SAVE to device 1 (the Datassette(TM) recorder). Any attempt to save to
2145 other devices without using a file name results in an error. NOTE: Device 0 (the keyboard), device 2 (RS-232), and device 3 (the screen) cannot be SAVEd to. If the attempt is made, an error occurs, and the SAVE is stopped.
2146 <tag/Notes/<itemize>
2147 <item>The function is only available as fastcall function, so it may
2148 only be used in presence of a prototype.
2150 <tag/Availability/cc65
2152 <ref id="cbm_k_load" name="cbm_k_load">,
2153 <ref id="cbm_k_setlfs" name="cbm_k_setlfs">,
2154 <ref id="cbm_k_setnam" name="cbm_k_setnam">
2160 <sect1>cbm_k_scnkey<label id="cbm_k_scnkey"><p>
2164 <tag/Function/Scan the keyboard matrix.
2165 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2166 <tag/Declaration/<tt/void cbm_k_scnkey (void);/
2167 <tag/Description/This function looks at the switches in the keyboard, to see
2168 if any of them are being pressed. If they are, then code numbers for them are
2169 stored in RAM. Other functions use those numbers to input text. Normally,
2170 the keyboard is scanned by the Kernal's Interrupt Service Routine. But, if
2171 you divert the "Jiffy interrupt" to a C-code ISR, then that ISR must call this
2172 function, in order to provide input from the keyboard.
2173 <tag/Availability/cc65
2175 <ref id="cbm_k_getin" name="cbm_k_getin">,
2176 <ref id="cbm_k_udtim" name="cbm_k_udtim">,
2177 <ref id="cgetc" name="cgetc">,
2178 <!-- <ref id="getc" name="getc"> -->
2179 <!-- <ref id="getchar" name="getchar"> -->
2185 <sect1>cbm_k_setlfs<label id="cbm_k_setlfs"><p>
2189 <tag/Function/Set up a logical file
2190 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2191 <tag/Declaration/<tt/void __fastcall__ cbm_k_setlfs (unsigned char LFN, unsigned char DEV, unsigned char SA);/
2192 <tag/Description/This functions sets up the logical file by setting its number, device address,
2193 and secondary address.
2194 <tag/Notes/<itemize>
2195 <item>The function is only available as fastcall function, so it may
2196 only be used in presence of a prototype.
2198 <tag/Availability/cc65
2200 <ref id="cbm_k_setnam" name="cbm_k_setnam">
2206 <sect1>cbm_k_setnam<label id="cbm_k_setnam"><p>
2210 <tag/Function/Set Filename Parameters
2211 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2212 <tag/Declaration/<tt/void __fastcall__ cbm_k_setnam (const char* Name);/
2213 <tag/Description/This function is used to set up the file name for the OPEN,
2214 SAVE, or LOAD operations.
2215 <tag/Notes/<itemize>
2216 <item>The function is only available as fastcall function, so it may
2217 only be used in presence of a prototype.
2219 <tag/Availability/cc65
2221 <ref id="cbm_k_open" name="cbm_k_open">,
2222 <ref id="cbm_k_load" name="cbm_k_load">,
2223 <ref id="cbm_k_save" name="cbm_k_save">
2229 <sect1>cbm_k_talk<label id="cbm_k_talk"><p>
2233 <tag/Function/Commands device to TALK
2234 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2235 <tag/Declaration/<tt/void __fastcall__ cbm_k_talk (unsigned char dev);/
2236 <tag/Description/When called, it ORs the device number with the TALK code (64, $40) and sends it on the serial
2237 bus. This commands the device to TALK.
2238 <tag/Notes/<itemize>
2239 <item>The function is only available as fastcall function, so it may
2240 only be used in presence of a prototype.
2242 <tag/Availability/cc65
2244 <ref id="cbm_k_acptr" name="cbm_k_acptr">
2250 <sect1>cbm_k_udtim<label id="cbm_k_udtim"><p>
2254 <tag/Function/Update the Jiffy clock.
2255 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2256 <tag/Declaration/<tt/void cbm_k_udtim (void);/
2257 <tag/Description/This function adds one count to the Jiffy clock. That clock
2258 counts sixtieths of a second. It is used by the library's <tt/clock()/
2259 function. Normally, the Jiffy clock is updated by the Kernal's Interrupt
2260 Service Routine. But, if you divert the "Jiffy interrupt" to a C-code ISR,
2261 then that ISR must call this function, in order to keep the clock valid.
2262 <tag/Availability/cc65
2264 <ref id="cbm_k_scnkey" name="cbm_k_scnkey">,
2265 <ref id="clock" name="clock">
2271 <sect1>cbm_k_unlsn<label id="cbm_k_unlsn"><p>
2275 <tag/Function/Send an UNLISTEN command
2276 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
2277 <tag/Declaration/<tt/void cbm_k_unlsn (void);/
2278 <tag/Description/This function commands all devices on the serial bus to
2279 stop receiving data from the host computer (i.e., UNLISTEN). Calling this
2280 function results in an UNLISTEN command being transmitted on the serial
2281 bus. Only devices previously commanded to LISTEN are affected. This
2282 function is normally used after the host computer is finished sending data
2283 to external devices. Sending the UNLISTEN commands the listening devices
2284 to get off the serial bus so it can be used for other purposes.
2285 <tag/Notes/<itemize>
2288 <tag/Availability/cc65
2290 <ref id="cbm_k_listen" name="cbm_k_listen">
2296 <sect1>cclear<label id="cclear"><p>
2300 <tag/Function/Clear part of a line (write a given number of spaces).
2301 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2302 <tag/Declaration/<tt/void __fastcall__ cclear (unsigned char length);/
2303 <tag/Description/The function clears part of a line by writing <tt/length/
2304 spaces in the current text color.
2305 <tag/Notes/<itemize>
2306 <item>The function is only available as fastcall function, so it may
2307 only be used in presence of a prototype.
2309 <tag/Availability/cc65
2311 <ref id="cclearxy" name="cclearxy">,
2312 <ref id="clrscr" name="clrscr">
2318 <sect1>cclearxy<label id="cclearxy"><p>
2322 <tag/Function/Clear part of a line (write a given number of spaces) starting
2323 at a specific screen position.
2324 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2325 <tag/Declaration/<tt/void __fastcall__ cclearxy (unsigned char x, unsigned char y, unsigned char length);/
2326 <tag/Description/The function moves the cursor to a specific position, and
2327 will then clear part of the line by writing <tt/length/ spaces in the current
2329 <tag/Notes/<itemize>
2330 <item>The function is only available as fastcall function, so it may
2331 only be used in presence of a prototype.
2333 <tag/Availability/cc65
2335 <ref id="cclear" name="cclear">,
2336 <ref id="clrscr" name="clrscr">
2342 <sect1>cgetc<label id="cgetc"><p>
2346 <tag/Function/Read a character from the keyboard.
2347 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2348 <tag/Declaration/<tt/char cgetc (void);/
2349 <tag/Description/The function reads a character from the keyboard. If there is
2350 no character available, <tt/cgetc()/ waits until the user presses a key. If the
2351 cursor is enabled by use of the <tt/cursor/ function, a blinking cursor is
2352 displayed while waiting.
2353 <tag/Notes/<itemize>
2354 <item>If the system supports a keyboard buffer, <tt/cgetc()/ will fetch a key
2355 from that buffer; and, wait only if the buffer is empty.
2356 <item>The keyboard must be scanned periodically, in order for this function to
2357 see anything that you type. (See the description of <tt/cbm_k_scnkey()/.)
2359 <tag/Availability/cc65
2361 <ref id="cbm_k_scnkey" name="cbm_k_scnkey">,
2362 <ref id="cursor" name="cursor">,
2363 <ref id="kbhit" name="kbhit">
2369 <sect1>chline<label id="chline"><p>
2373 <tag/Function/Output a horizontal line in text mode.
2374 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2375 <tag/Declaration/<tt/void __fastcall__ chline (unsigned char length);/
2376 <tag/Description/The function outputs a horizontal line with the given length
2377 starting at the current cursor position.
2378 <tag/Notes/<itemize>
2379 <item>The character used to draw the horizontal line is system dependent.
2380 If available, a line drawing character is used. Drawing a line that is partially
2381 off screen leads to undefined behaviour.
2382 <item>The function is only available as fastcall function, so it may only be
2383 used in presence of a prototype.
2385 <tag/Availability/cc65
2387 <ref id="chlinexy" name="chlinexy">,
2388 <ref id="cvline" name="cvline">,
2389 <ref id="cvlinexy" name="cvlinexy">
2395 <sect1>chlinexy<label id="chlinexy"><p>
2399 <tag/Function/Output a horizontal line at a given position in text mode.
2400 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2401 <tag/Declaration/<tt/void __fastcall__ chlinexy (unsigned char x, unsigned char y, unsigned char length);/
2402 <tag/Description/The function outputs a horizontal line with the given length
2403 starting at a given position.
2404 <tag/Notes/<itemize>
2405 <item>The character used to draw the horizontal line is system dependent.
2406 If available, a line drawing character is used. Drawing a line that is partially
2407 off screen leads to undefined behaviour.
2408 <item>The function is only available as fastcall function, so it may only be
2409 used in presence of a prototype.
2411 <tag/Availability/cc65
2413 <ref id="chline" name="chline">,
2414 <ref id="cvline" name="cvline">,
2415 <ref id="cvlinexy" name="cvlinexy">
2421 <sect1>clearerr<label id="clearerr"><p>
2425 <tag/Function/Clear error and end-of-file status of a stream.
2426 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
2427 <tag/Declaration/<tt/void __fastcall__ clearerr (FILE* f);/
2428 <tag/Description/<tt/clearerr/ clears the error and end-of-file status
2429 indicators for the stream <tt/f/.
2430 <tag/Notes/<itemize>
2431 <item>The function is only available as fastcall function, so it may only be
2432 used in presence of a prototype.
2434 <tag/Availability/ISO 9899
2436 <ref id="feof" name="feof">,
2437 <ref id="ferror" name="ferror">
2443 <sect1>clock<label id="clock"><p>
2447 <tag/Function/Determine the processor time used.
2448 <tag/Header/<tt/<ref id="time.h" name="time.h">/
2449 <tag/Declaration/<tt/clock_t clock (void);/
2450 <tag/Description/The <tt/clock/ function returns an approximaton of processor
2451 time used by the program. The time is returned in implementation-defined
2452 units. It can be converted to seconds by dividing by the value of the macro
2453 <tt/CLOCKS_PER_SEC/.
2454 <tag/Notes/<itemize>
2455 <item>Since the machines that cc65-generated programs run on cannot run multiple
2456 processes, the function actually will return the time since some
2457 implementation-defined point in the past.
2458 <item>The Jiffy clock must be "running", in order for this function to return
2459 changing values. (See the description of <tt/cbm_k_udtim()/.)
2461 <tag/Availability/ISO 9899
2463 <ref id="cbm_k_udtim" name="cbm_k_udtim">,
2464 <ref id="time" name="time">
2470 <sect1>clrscr<label id="clrscr"><p>
2474 <tag/Function/Clear the text screen.
2475 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2476 <tag/Declaration/<tt/void clrscr (void);/
2477 <tag/Description/The function clears the text screen and moves the cursor to
2478 the upper left corner.
2479 <tag/Availability/cc65
2481 <ref id="cclear" name="cclear">,
2482 <ref id="cclearxy" name="cclearxy">
2488 <sect1>close<label id="close"><p>
2492 <tag/Function/Close a file descriptor.
2493 <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/
2494 <tag/Declaration/<tt/int __fastcall__ close (int fd);/
2495 <tag/Description/The function closes the given file descriptor. It returns zero
2496 on success and -1 on error. If an error occurs, the cause can be determined by
2497 reading the <tt/errno/ variable.
2498 <tag/Notes/<itemize>
2499 <item>The function is only available as fastcall function, so it may only
2500 be used in presence of a prototype.
2502 <tag/Availability/POSIX 1003.1
2504 <ref id="creat" name="creat">,
2505 <ref id="open" name="open">
2511 <sect1>closedir<label id="closedir"><p>
2515 <tag/Function/Close a directory.
2516 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
2517 <tag/Declaration/<tt/int __fastcall__ closedir (DIR* dir);/
2518 <tag/Description/The function closes the given directory descriptor. It returns
2519 zero on success and -1 on error. If an error occurs, the cause can be determined
2520 by reading the <tt/errno/ variable.
2521 <tag/Notes/<itemize>
2522 <item>The function is only available as fastcall function, so it may only
2523 be used in presence of a prototype.
2525 <tag/Availability/POSIX 1003.1
2527 <ref id="opendir" name="opendir">,
2528 <ref id="readdir" name="readdir">
2534 <sect1>cpeekc<label id="cpeekc"><p>
2538 <tag/Function/Get a character from the display memory.
2539 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2540 <tag/Declaration/<tt/char cpeekc (void);/
2541 <tag/Description/The function gets the character that's at the current location
2542 of the cursor in the display screen RAM. That character is converted, if
2543 needed, into the encoding that can be passed to <tt/cputc()/.
2544 <tag/Notes/<itemize>
2545 <item>Conio peek functions don't have <tt/cpeek...xy()/ versions. That was
2546 done to make it obvious that peeking doesn't move the cursor in any way. Your
2547 program must place the cursor where it wants to peek before it calls any of
2550 <tag/Availability/cc65
2552 <ref id="cpeekcolor" name="cpeekcolor">,
2553 <ref id="cpeekrevers" name="cpeekrevers">,
2554 <ref id="cpeeks" name="cpeeks">,
2555 <ref id="cputc" name="cputc">
2561 <sect1>cpeekcolor<label id="cpeekcolor"><p>
2565 <tag/Function/Get a color from the display memory.
2566 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2567 <tag/Declaration/<tt/unsigned char cpeekcolor (void);/
2568 <tag/Description/The function gets the color number that's at the current
2569 location of the cursor in the display screen RAM. That number can be passed to
2571 <tag/Notes/<itemize>
2572 <item>Conio peek functions don't have <tt/cpeek...xy()/ versions. That was
2573 done to make it obvious that peeking doesn't move the cursor in any way. Your
2574 program must place the cursor where it wants to peek before it calls any of
2577 <tag/Availability/cc65
2579 <ref id="cpeekc" name="cpeekc">,
2580 <ref id="cpeekrevers" name="cpeekrevers">,
2581 <ref id="cpeeks" name="cpeeks">,
2582 <ref id="cputc" name="cputc">,
2583 <ref id="textcolor" name="textcolor">
2589 <sect1>cpeekrevers<label id="cpeekrevers"><p>
2593 <tag/Function/Get a reverse-character attribute from the display memory.
2594 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2595 <tag/Declaration/<tt/unsigned char cpeekrevers (void);/
2596 <tag/Description/The function gets the "reverse-mode" attribute of the
2597 character that's at the current location of the cursor in the display screen
2598 RAM. It returns a boolean value (0/1) that can be passed to <tt/revers()/.
2599 <tag/Notes/<itemize>
2600 <item>Conio peek functions don't have <tt/cpeek...xy()/ versions. That was
2601 done to make it obvious that peeking doesn't move the cursor in any way. Your
2602 program must place the cursor where it wants to peek before it calls any of
2605 <tag/Availability/cc65
2607 <ref id="cpeekc" name="cpeekc">,
2608 <ref id="cpeekcolor" name="cpeekcolor">,
2609 <ref id="cpeeks" name="cpeeks">,
2610 <ref id="cputc" name="cputc">,
2611 <ref id="revers" name="revers">
2617 <sect1>cpeeks<label id="cpeeks"><p>
2621 <tag/Function/Get a string from the display memory.
2622 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2623 <tag/Declaration/<tt/void __fastcall__ cpeeks (char* s, unsigned length);/
2624 <tag/Description/The function gets a fixed-length string ('\0'-terminated) of
2625 characters that start at the current location of the cursor in the display
2626 screen RAM. Those characters are converted, if needed, into the encoding that
2627 can be passed to <tt/cputs()/. The first argument must point to a RAM area
2628 that's large enough to hold "length + 1" bytes.
2629 <tag/Notes/<itemize>
2630 <item>Conio peek functions don't have <tt/cpeek...xy()/ versions. That was
2631 done to make it obvious that peeking doesn't move the cursor in any way. Your
2632 program must place the cursor where it wants to peek before it calls any of
2634 <item>The function is available as only a fastcall function;
2635 so, it may be used only in the presence of a prototype.
2637 <tag/Availability/cc65
2639 <ref id="cpeekc" name="cpeekc">,
2640 <ref id="cpeekcolor" name="cpeekcolor">,
2641 <ref id="cpeekrevers" name="cpeekrevers">,
2642 <ref id="cputc" name="cputc">,
2643 <ref id="cputs" name="cputs">
2649 <sect1>creat<label id="creat"><p>
2653 <tag/Function/Create a file.
2654 <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/
2655 <tag/Declaration/<tt/int __fastcall__ creat (const char* name, unsigned mode);/
2656 <tag/Description/<tt/creat/ creates a new file and returns the file descriptor
2657 associated with it. On error, -1 is returned and an error code is stored in
2659 <tag/Notes/<itemize>
2660 <item><tt/creat/ is identical to calling <tt/<ref id="open" name="open">/ with
2661 <tt/flags/ equal to <tt/O_WRONLY | O_CREAT | O_TRUNC/.
2662 <item>The function is only available as fastcall function, so it may only
2663 be used in presence of a prototype.
2665 <tag/Availability/POSIX 1003.1
2667 <ref id="close" name="close">,
2668 <ref id="open" name="open">
2674 <sect1>cprintf<label id="cprintf"><p>
2678 <tag/Function/Formatted output to the console.
2679 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2680 <tag/Declaration/<tt/int cprintf (const char* format, ...);/
2681 <tag/Description/The arguments are converted to text where necessary and
2682 formatted according to the format string given. The resulting string is output
2683 to the console. <tt/cprintf/ supports the same format specifiers as
2684 <tt/printf/. <!-- <tt/<ref id="printf" name="printf">/. -->
2685 <tag/Notes/<itemize>
2686 <item>Like all other <tt/conio/ output functions, <tt/cprintf/ distinguishes
2687 between <tt/\r/ and <tt/\n/.
2689 <tag/Availability/cc65
2691 <ref id="cputc" name="cputc">,
2692 <ref id="cputcxy" name="cputcxy">,
2693 <ref id="cputs" name="cputs">,
2694 <ref id="cputsxy" name="cputsxy">,
2695 <ref id="vcprintf" name="vcprintf">
2701 <sect1>cputc<label id="cputc"><p>
2705 <tag/Function/Output a character directly to the console.
2706 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2707 <tag/Declaration/<tt/void __fastcall__ cputc (char c);/
2708 <tag/Description/Output one character to the console at the current cursor
2710 <tag/Notes/<itemize>
2711 <item>Like all other <tt/conio/ output functions, <tt/cputc/ distinguishes
2712 between <tt/\r/ and <tt/\n/.
2713 <item>The function is only available as fastcall function, so it may only
2714 be used in presence of a prototype.
2716 <tag/Availability/cc65
2718 <ref id="cprintf" name="cprintf">,
2719 <ref id="cputcxy" name="cputcxy">,
2720 <ref id="cputs" name="cputs">,
2721 <ref id="cputsxy" name="cputsxy">,
2722 <ref id="vcprintf" name="vcprintf">
2728 <sect1>cputcxy<label id="cputcxy"><p>
2732 <tag/Function/Output a character at a specific screen position.
2733 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2734 <tag/Declaration/<tt/void __fastcall__ cputcxy (unsigned char x, unsigned char y, char c);/
2735 <tag/Description/<tt/cputcxy/ moves the cursor to the given x/y position on
2736 the screen and outputs one character.
2737 <tag/Notes/<itemize>
2738 <item>Like all other <tt/conio/ output functions, <tt/cputcxy/ distinguishes
2739 between <tt/\r/ and <tt/\n/.
2740 <item>The function is only available as fastcall function, so it may only
2741 be used in presence of a prototype.
2743 <tag/Availability/cc65
2745 <ref id="cprintf" name="cprintf">,
2746 <ref id="cputc" name="cputc">,
2747 <ref id="cputs" name="cputs">,
2748 <ref id="cputsxy" name="cputsxy">,
2749 <ref id="vcprintf" name="vcprintf">
2755 <sect1>cputs<label id="cputs"><p>
2759 <tag/Function/Output a string directly to the console.
2760 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2761 <tag/Declaration/<tt/void __fastcall__ cputs (const char* s);/
2762 <tag/Description/The function outputs the given string on the console at the
2763 current cursor position.
2764 <tag/Notes/<itemize>
2765 <item>Like all other <tt/conio/ output functions, <tt/cputs/ distinguishes
2766 between <tt/\r/ and <tt/\n/.
2767 <item>The function is only available as fastcall function, so it may only
2768 be used in presence of a prototype.
2770 <tag/Availability/cc65
2772 <ref id="cprintf" name="cprintf">,
2773 <ref id="cputc" name="cputc">,
2774 <ref id="cputcxy" name="cputcxy">,
2775 <ref id="cputsxy" name="cputsxy">,
2776 <ref id="vcprintf" name="vcprintf">
2782 <sect1>cputsxy<label id="cputsxy"><p>
2786 <tag/Function/Output a string to the console at a given position.
2787 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2788 <tag/Declaration/<tt/void __fastcall__ cputsxy (unsigned char x, unsigned char y, const char* s);/
2789 <tag/Description/<tt/cputsxy/ moves the cursor to the given x/y position,
2790 and outputs the string <tt/s/.
2791 <tag/Notes/<itemize>
2792 <item>Like all other <tt/conio/ output functions, <tt/cputsxy/ distinguishes
2793 between <tt/\r/ and <tt/\n/.
2794 <item>The function is only available as fastcall function, so it may only
2795 be used in presence of a prototype.
2797 <tag/Availability/cc65
2799 <ref id="cprintf" name="cprintf">,
2800 <ref id="cputc" name="cputc">,
2801 <ref id="cputcxy" name="cputcxy">,
2802 <ref id="cputs" name="cputs">,
2803 <ref id="vcprintf" name="vcprintf">
2809 <sect1>cursor<label id="cursor"><p>
2813 <tag/Function/Enable/disable a blinking cursor when waiting for keyboard input.
2814 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2815 <tag/Declaration/<tt/unsigned char __fastcall__ cursor (unsigned char onoff);/
2816 <tag/Description/If the argument to the function is non zero, a blinking cursor
2817 will be enabled when the <tt/cgetc/ function waits for input from the keyboard.
2818 If the argument is zero, <tt/cgetc/ will wait without a blinking cursor.
2819 <tag/Notes/<itemize>
2820 <item>The function is only available as fastcall function, so it may only
2821 be used in presence of a prototype.
2823 <tag/Availability/cc65
2825 <ref id="cgetc" name="cgetc">,
2826 <ref id="kbhit" name="kbhit">
2832 <sect1>cvline<label id="cvline"><p>
2836 <tag/Function/Output a vertical line in text mode.
2837 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2838 <tag/Declaration/<tt/void __fastcall__ cvline (unsigned char length);/
2839 <tag/Description/The function outputs a vertical line with the given length
2840 starting at the current cursor position.
2841 <tag/Notes/<itemize>
2842 <item>The character used to draw the vertical line is system dependent.
2843 If available, a line drawing character is used. Drawing a line that is partially
2844 off screen leads to undefined behaviour.
2845 <item>The function is only available as fastcall function, so it may only be
2846 used in presence of a prototype.
2848 <tag/Availability/cc65
2850 <ref id="chline" name="chline">,
2851 <ref id="chlinexy" name="chlinexy">,
2852 <ref id="cvlinexy" name="cvlinexy">
2858 <sect1>cvlinexy<label id="cvlinexy"><p>
2862 <tag/Function/Output a vertical line at a given position in text mode.
2863 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
2864 <tag/Declaration/<tt/void __fastcall__ cvlinexy (unsigned char x, unsigned char y, unsigned char length);/
2865 <tag/Description/The function outputs a vertical line with the given length
2866 starting at a given position.
2867 <tag/Notes/<itemize>
2868 <item>The character used to draw the vertical line is system dependent.
2869 If available, a line drawing character is used. Drawing a line that is partially
2870 off screen leads to undefined behaviour.
2871 <item>The function is only available as fastcall function, so it may only be
2872 used in presence of a prototype.
2874 <tag/Availability/cc65
2876 <ref id="chline" name="chline">,
2877 <ref id="chlinexy" name="chlinexy">,
2878 <ref id="cvline" name="cvline">
2884 <sect1>decompress_lz4<label id="decompress_lz4"><p>
2888 <tag/Function/Uncompress a LZ4-compressed buffer.
2889 <tag/Header/<tt/<ref id="lz4.h" name="lz4.h">/
2890 <tag/Declaration/<tt/void decompress_lz4 (const unsigned char* src, unsigned char* const dst, const unsigned short uncompressed_size);/
2891 <tag/Description/<tt/decompress_lz4/ uncompresses a LZ4-compressed buffer.
2892 <tag/Notes/<itemize>
2893 <item>Use LZ4_compress_HC with compression level 16 for best compression.
2895 <tag/Availability/cc65
2901 <sect1>div<label id="div"><p>
2905 <tag/Function/Divide two ints and return quotient and remainder.
2906 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
2907 <tag/Declaration/<tt/div_t __fastcall__ div (int numer, int denom);/
2908 <tag/Description/<tt/div/ divides <tt/numer/ by <tt/denom/ and returns the
2909 quotient and remainder in a <tt/div_t/ structure.
2910 <tag/Notes/<itemize>
2911 <item>The function is only available as fastcall function, so it may only
2912 be used in presence of a prototype.
2914 <tag/Availability/ISO 9899
2922 <sect1>doesclrscrafterexit<label id="doesclrscrafterexit"><p>
2926 <tag/Function/Determines whether the screen is going to be cleared after program exit.
2927 <tag/Header/<tt/<ref id="cc65.h" name="cc65.h">/
2928 <tag/Declaration/<tt/unsigned char doesclrscrafterexit (void);/
2929 <tag/Description/The function returns zero if the screen won't be cleared immediately after
2930 program termination. It returns a non-zero value if it will.
2931 <tag/Notes/<itemize>
2932 <item>Some systems, maybe depending on configuration, immediately clear the screen
2933 after a program exits. Therefore it might be difficult to read
2934 the last messages printed by the program prior to its exit. This function can be used
2935 to decide if a delay or wait for a key press should be executed when then program
2938 <tag/Availability/cc65
2941 #include <stdio.h>
2942 #include <unistd.h>
2943 #include <cc65.h>
2946 printf("Hello World\n");
2947 if (doesclrscrafterexit())
2956 <sect1>em_commit<label id="em_commit"><p>
2960 <tag/Function/Commit changes into extended memory.
2961 <tag/Header/<tt/<ref id="em.h" name="em.h">/
2962 <tag/Declaration/<tt/void em_commit (void);/
2963 <tag/Description/Commit changes in the memory window to extended storage. If
2964 the contents of the memory window have been changed, these changes may be lost
2965 if <tt/<ref id="em_map" name="em_map">/, <tt/<ref id="em_use" name="em_use">/,
2966 <tt/<ref id="em_copyfrom" name="em_copyfrom">/ or <tt/<ref id="em_copyto"
2967 name="em_copyto">/ are called without calling <tt/em_commit/ first.
2968 <tag/Notes/<itemize>
2969 <item>Calling <tt/em_commit/ does not necessarily mean that changes to the
2970 memory window are discarded, it does just mean that the drivers is allowed
2972 <item>The function is only available as fastcall function, so it may only be
2973 used in presence of a prototype.
2974 <item>The function produces undefined results if no extended memory driver is
2977 <tag/Availability/cc65
2979 <ref id="em_load_driver" name="em_load_driver">,
2980 <ref id="em_map" name="em_map">,
2981 <ref id="em_use" name="em_use">
2987 <sect1>em_copyfrom<label id="em_copyfrom"><p>
2991 <tag/Function/Copy from extended into normal memory.
2992 <tag/Header/<tt/<ref id="em.h" name="em.h">/
2993 <tag/Declaration/<tt/void __fastcall__ em_copyfrom (const struct em_copy* copy_data);/
2994 <tag/Description/Copy data from extended memory into linear memory. Source and
2995 target addresses as well as the number of bytes to transfer are specified in
2996 the <tt/em_copy/ structure that is passed as a parameter.
2997 <tag/Notes/<itemize>
2998 <item>Calling <tt/em_copyfrom/ will invalidate the memory window, so if you
2999 made any changes to the data in the window, call <tt/<ref id="em_commit"
3000 name="em_commit">/ first, or the changes are lost.
3001 <item>The function is only available as fastcall function, so it may only be
3002 used in presence of a prototype.
3003 <item>The function produces undefined results if no extended memory driver is
3006 <tag/Availability/cc65
3008 <ref id="em_commit" name="em_commit">,
3009 <ref id="em_copyto" name="em_copyto">,
3010 <ref id="em_load_driver" name="em_load_driver">
3016 <sect1>em_copyto<label id="em_copyto"><p>
3020 <tag/Function/Copy from normal into extended memory.
3021 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3022 <tag/Declaration/<tt/void __fastcall__ em_copyto (const struct em_copy* copy_data);/
3023 <tag/Description/Copy data from linear into extended memory. Source and
3024 target addresses as well as the number of bytes to transfer are specified in
3025 the <tt/em_copy/ structure that is passed as a parameter.
3026 <tag/Notes/<itemize>
3027 <item>Calling <tt/em_copyto/ will invalidate the memory window, so if you
3028 made any changes to the data in the window, call <tt/<ref id="em_commit"
3029 name="em_commit">/ first, or the changes are lost.
3030 <item>The function is only available as fastcall function, so it may only be
3031 used in presence of a prototype.
3032 <item>The function produces undefined results if no extended memory driver is
3035 <tag/Availability/cc65
3037 <ref id="em_commit" name="em_commit">,
3038 <ref id="em_copyfrom" name="em_copyfrom">,
3039 <ref id="em_load_driver" name="em_load_driver">
3045 <sect1>em_install<label id="em_install"><p>
3049 <tag/Function/Install an already loaded extended memory driver.
3050 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3051 <tag/Declaration/<tt/unsigned char _fastcall__ em_install (void* driver);/
3052 <tag/Description/The function installs an already loaded extended memory driver
3053 and returns an error code. The function may be used to install a driver linked
3054 statically to the program.
3055 <tag/Notes/<itemize>
3056 <item>Not all drivers are able to detect if the supported hardware is really
3058 <item>The function is only available as fastcall function, so it may only be
3059 used in presence of a prototype.
3061 <tag/Availability/cc65
3063 <ref id="em_load_driver" name="em_load_driver">,
3064 <ref id="em_uninstall" name="em_uninstall">,
3065 <ref id="em_unload" name="em_unload">
3071 <sect1>em_load_driver<label id="em_load_driver"><p>
3075 <tag/Function/Load and initialize an extended memory driver.
3076 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3077 <tag/Declaration/<tt/void __fastcall__ em_load_driver (const char* name);/
3078 <tag/Description/Load an extended memory driver into memory and initialize
3079 it. The function returns an error code that tells if all this has been
3081 <tag/Notes/<itemize>
3082 <item>Not all drivers are able to detect if the supported hardware is really
3084 <item>The function is only available as fastcall function, so it may only be
3085 used in presence of a prototype.
3086 <item>The driver is loaded by name, so currently you must know the type of
3087 extended memory that should be supported. There is no autodetect capability.
3089 <tag/Availability/cc65
3091 <ref id="em_unload" name="em_unload">
3097 <sect1>em_map<label id="em_map"><p>
3101 <tag/Function/Make a page of extended memory accessible.
3102 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3103 <tag/Declaration/<tt/void* __fastcall__ em_map (unsigned page);/
3104 <tag/Description/The function maps one page of extended memory into linear
3105 memory and returns a pointer to the page frame. Depending on the hardware
3106 and driver, the data is either mapped into the address space or transfered
3107 into a buffer. If you don't need the actual contents of the page (for example
3108 because you're going to overwrite it completely), it is better to call
3109 <tt/<ref id="em_use" name="em_use">/ instead. <tt/em_use/ will not transfer the
3110 data if it is possible to avoid that.
3111 <tag/Notes/<itemize>
3112 <item>Calling <tt/em_map/ will invalidate the memory window, so if you
3113 made any changes to the data in the window, call <tt/<ref id="em_commit"
3114 name="em_commit">/ first, or the changes are lost.
3115 <item>The function is only available as fastcall function, so it may only be
3116 used in presence of a prototype.
3117 <item>The function produces undefined results if no extended memory driver is
3120 <tag/Availability/cc65
3122 <ref id="em_commit" name="em_commit">,
3123 <ref id="em_load_driver" name="em_load_driver">,
3124 <ref id="em_use" name="em_use">
3130 <sect1>em_pagecount<label id="em_pagecount"><p>
3134 <tag/Function/Return the number of available extended memory pages.
3135 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3136 <tag/Declaration/<tt/unsigned em_pagecount (void);/
3137 <tag/Description/The function returns the size of the extended memory supported
3138 by the driver in 256 byte pages.
3139 <tag/Notes/<itemize>
3140 <item>The function returns zero if no extended memory driver is loaded.
3141 <item>The function may return zero if the supported hardware was not detected.
3143 <tag/Availability/cc65
3145 <ref id="em_load_driver" name="em_load_driver">
3151 <sect1>em_uninstall<label id="em_uninstall"><p>
3155 <tag/Function/Uninstall an already loaded extended memory driver.
3156 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3157 <tag/Declaration/<tt/unsigned char em_uninstall (void);/
3158 <tag/Description/The function uninstalls an already loaded extended memory
3159 driver but doesn't remove it from memory.
3160 <tag/Notes/<itemize>
3161 <item>If the driver has been loaded using <tt/<ref id="em_load_driver"
3162 name="em_load_driver">/, <tt/<ref id="em_unload" name="em_unload">/
3163 should be used instead of <tt/em_uninstall/ so the driver is also removed
3166 <tag/Availability/cc65
3168 <ref id="em_install" name="em_install">,
3169 <ref id="em_load_driver" name="em_load_driver">,
3170 <ref id="em_unload" name="em_unload">
3176 <sect1>em_unload<label id="em_unload"><p>
3180 <tag/Function/Unload an extended memory driver.
3181 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3182 <tag/Declaration/<tt/unsigned char em_unload (void);/
3183 <tag/Description/The function unloads a loaded extended memory driver and
3184 frees all memory allocated for the driver.
3185 <tag/Notes/<itemize>
3186 <item>The function does nothing if no driver is loaded.
3188 <tag/Availability/cc65
3190 <ref id="em_load_driver" name="em_load_driver">
3196 <sect1>em_use<label id="em_use"><p>
3200 <tag/Function/Prepare an extended memory page for use.
3201 <tag/Header/<tt/<ref id="em.h" name="em.h">/
3202 <tag/Declaration/<tt/void* __fastcall__ em_use (unsigned page);/
3203 <tag/Description/The function maps one page of extended memory into linear
3204 memory and returns a pointer to the page frame. This function is similar to
3205 <tt/<ref id="em_map" name="em_map">/, but will not transfer data into the
3206 actual memory window in the assumption that the existing data is wrong or
3207 will get overwritten.
3208 <tag/Notes/<itemize>
3209 <item>Calling <tt/em_use/ will invalidate the memory window, so if you
3210 made any changes to the data in the window, call <tt/<ref id="em_commit"
3211 name="em_commit">/ first, or the changes are lost.
3212 <item>The function is only available as fastcall function, so it may only be
3213 used in presence of a prototype.
3214 <item>The function produces undefined results if no extended memory driver is
3217 <tag/Availability/cc65
3219 <ref id="em_commit" name="em_commit">,
3220 <ref id="em_load_driver" name="em_load_driver">,
3221 <ref id="em_map" name="em_map">
3227 <sect1>exit<label id="exit"><p>
3231 <tag/Function/Terminate the program.
3232 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
3233 <tag/Declaration/<tt/void __fastcall__ exit (int status);/
3234 <tag/Description/<tt/exit/ terminates the program. The argument specifies the
3235 return code of the program. Before termination, all files are closed, buffered
3236 output is written and any functions registered with <tt/<ref id="atexit"
3237 name="atexit">/ are called. Common values for status are <tt/EXIT_SUCCESS/ and
3238 <tt/EXIT_FAILURE/ which are also defined in <tt/<ref id="stdlib.h"
3240 <tag/Notes/<itemize>
3241 <item>The function is only available as fastcall function, so it may only
3242 be used in presence of a prototype.
3243 <item>It depends on the host machine if the program return code can be
3244 evaluated or is ignored.
3246 <tag/Availability/ISO 9899
3248 <ref id="abort" name="abort">,
3249 <ref id="exit" name="exit">
3255 <sect1>exec<label id="exec"><p>
3259 <tag/Function/Execute a program file.
3260 <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/
3261 <tag/Declaration/<tt/int __fastcall__ exec (const char* progname, const char* cmdline);/
3262 <tag/Description/<tt/exec/ replaces the currently running program by a new one.
3263 Calling <tt/exec()/ is identical to calling <tt/<ref id="exit" name="exit()">/,
3264 then loading and starting the program named in the first argument, passing
3265 the command line specified as second argument. Instead of an empty string,
3266 a <tt/NULL/ pointer may be passed as second parameter.
3267 On success, the function does not return. On failure, -1 is returned and
3268 <tt/errno/ contains an error code.
3269 <tag/Notes/<itemize>
3270 <item>The function is only available as fastcall function, so it may only
3271 be used in presence of a prototype.
3272 <item>On most platforms, the function needs to copy a small stub loader to
3273 some memory area outside the program space. This may collide with other
3274 programs. See the platform specific docs on this.
3275 <item>Because it is necessary to terminate the running program before the
3276 memory can be reused to load the new one, there is a high chance that the
3277 function may not be able to return on errors.
3278 <item>The command line is passed to the new program in the same way as cc65
3279 programs expect the command line. If the new program is not a cc65 generated
3280 program, it may not be able to read it.
3282 <tag/Availability/cc65
3284 <ref id="exit" name="exit">
3290 <sect1>fast<label id="fast"><p>
3294 <tag/Function/Switch the C128 into 2MHz mode.
3295 <tag/Header/<tt/<ref id="c128.h" name="c128.h">/
3296 <tag/Declaration/<tt/void fast (void);/
3297 <tag/Description/The function will switch the clock of the C128 to 2MHz. This
3298 will nearly double the speed compared to slow mode.
3299 <tag/Notes/<itemize>
3300 <item>The function is specific to the C128.
3301 <item>2MHz clock will not work in 40 column mode.
3303 <tag/Availability/C128
3305 <ref id="slow" name="slow">,
3306 <ref id="toggle_videomode" name="toggle_videomode">,
3307 <ref id="videomode" name="videomode">
3313 <sect1>feof<label id="feof"><p>
3317 <tag/Function/Return the end-of-file indicator of a stream.
3318 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
3319 <tag/Declaration/<tt/int __fastcall__ feof (FILE* f);/
3320 <tag/Description/<tt/feof/ tests the end-of-file indicator ofthe stream
3321 <tt/f/, and returns a non zero value if it is set.
3322 <tag/Notes/<itemize>
3323 <item>The indicator is set only after a read past the end of a file is
3325 <item>The function is only available as fastcall function, so it may only be
3326 used in presence of a prototype.
3328 <tag/Availability/ISO 9899
3330 <ref id="feof" name="clearerr">,
3331 <ref id="ferror" name="ferror">
3337 <sect1>ferror<label id="ferror"><p>
3341 <tag/Function/Return the error indicator of a stream.
3342 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
3343 <tag/Declaration/<tt/int __fastcall__ ferror (FILE* f);/
3344 <tag/Description/<tt/ferror/ tests the error indicator of the stream
3345 <tt/f/, and returns a non zero value if it is set.
3346 <tag/Notes/<itemize>
3347 <item>The function is only available as fastcall function, so it may only be
3348 used in presence of a prototype.
3350 <tag/Availability/ISO 9899
3352 <ref id="feof" name="clearerr">,
3353 <ref id="ferror" name="feof">
3359 <sect1>fileno<label id="fileno"><p>
3363 <tag/Function/Return the file handle used by a stream.
3364 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
3365 <tag/Declaration/<tt/int __fastcall__ fileno (FILE* f);/
3366 <tag/Description/The <tt/fileno/ function returns the file handle used
3367 internally by a C stream. This file handle (an integer) can be used as a
3368 handle for the POSIX input/output functions.
3369 <tag/Notes/<itemize>
3370 <item>The function is only available as fastcall function, so it may only be
3371 used in presence of a prototype.
3372 <item>Mixing C file I/O functions and POSIX file I/O functions for the same
3373 file may have unpredictable results.
3375 <tag/Availability/POSIX 1003.1
3377 <ref id="creat" name="creat">,
3378 <ref id="open" name="open"> <!-- , -->
3379 <!-- <ref id="read" name="read">, -->
3380 <!-- <ref id="write" name="write"> -->
3386 <sect1>free<label id="free"><p>
3390 <tag/Function/Free a block of dynamic memory.
3391 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
3392 <tag/Declaration/<tt/void __fastcall__ free (void* block);/
3393 <tag/Description/Free a block of dynamic memory previously allocated with
3394 <tt/<ref id="malloc" name="malloc">/, <tt/<ref id="calloc" name="calloc">/
3395 or <tt/<ref id="realloc" name="realloc">/. As an exception, if the passed
3396 pointer is <tt/NULL/, no action is performed.
3397 <tag/Notes/<itemize>
3398 <item>Passing an already free'd block to <tt/free/ again will cause undefined
3399 behaviour and may crash your program.
3400 <item>The function is only available as fastcall function, so it may only
3401 be used in presence of a prototype.
3403 <tag/Availability/ISO 9899
3405 <ref id="_heapadd" name="_heapadd">,
3406 <ref id="_heapblocksize" name="_heapblocksize">,
3407 <ref id="_heapmaxavail" name="_heapmaxavail">,
3408 <ref id="_heapmemavail" name="_heapmemavail">,
3409 <ref id="calloc" name="calloc">,
3410 <ref id="malloc" name="malloc">,
3411 <ref id="realloc" name="realloc">
3417 <sect1>get_ostype<label id="get_ostype"><p>
3421 <tag/Function/The function returns the operating system, the program runs on.
3422 <tag/Header/<tt/<ref id="apple2.h" name="apple2.h">,
3423 <ref id="atari.h" name="atari.h">, <ref id="c64.h" name="c64.h">/
3424 <tag/Declaration/<tt/unsigned char get_ostype (void);/
3425 <tag/Description/<tt/get_ostype/ is machine dependent and does not exist for
3426 all supported targets. If it exists, it returns a number that identifies the
3427 operating system or machine type, the program runs on. The machine dependent
3428 header files define constants that can be used to check the return code.
3429 <tag/Notes/<itemize>
3430 <item>The function does not exist on all platforms.
3431 <item>The return codes are platform dependent.
3433 <tag/Availability/cc65 (not all platforms)
3439 <sect1>getcpu<label id="getcpu"><p>
3443 <tag/Function/Determine on which CPU the program is running.
3444 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
3445 <tag/Declaration/<tt/unsigned char getcpu (void);/
3446 <tag/Description/The function checks on which CPU the code is running. It
3447 returns one of the constants<itemize>
3449 <item><tt/CPU_65C02/
3450 <item><tt/CPU_65816/
3452 <tag/Notes/<itemize>
3453 <item>Other, more exotic CPU types are not disinguished.
3455 <tag/Availability/cc65
3461 <sect1>getcurrentdevice<label id="getcurrentdevice"><p>
3465 <tag/Function/Get current device.
3466 <tag/Header/<tt/<ref id="device.h" name="device.h">/
3467 <tag/Declaration/<tt/unsigned char getcurrentdevice (void);/
3468 <tag/Description/The function returns the current device.
3469 It allows to access the current device with the <ref id="dio.h"
3470 name="Low-level disk I/O API"> or <ref id="cbm.h" name="cbm_* I/O
3471 functions"> requiring a 'device' parameter.
3472 <tag/Notes/<itemize>
3475 <tag/Availability/cc65
3477 <ref id="getdevicedir" name="getdevicedir">,
3478 <ref id="getfirstdevice" name="getfirstdevice">,
3479 <ref id="getnextdevice" name="getnextdevice">
3481 dio_open (getcurrentdevice ());
3487 <sect1>getcwd<label id="getcwd"><p>
3491 <tag/Function/Get current working directory.
3492 <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/
3493 <tag/Declaration/<tt/char* __fastcall__ getcwd (char* buf, size_t size);/
3494 <tag/Description/The function will return the current working directory.
3495 <tag/Notes/<itemize>
3496 <item>The function is only available as fastcall function, so it may only
3497 be used in presence of a prototype.
3499 <tag/Availability/POSIX 1003.1
3505 <sect1>getdevicedir<label id="getdevicedir"><p>
3509 <tag/Function/Get device directory.
3510 <tag/Header/<tt/<ref id="device.h" name="device.h">/
3511 <tag/Declaration/<tt/char* __fastcall__ getdevicedir (unsigned char device, char* buf, size_t size);/
3512 <tag/Description/The function returns the directory representing <tt/device/.
3513 It allows to access the device on filesystem level by calling chdir() with
3514 the directory returned.
3515 <tag/Notes/<itemize>
3516 <item>The function is only available as fastcall function, so it may only
3517 be used in presence of a prototype.
3519 <tag/Availability/cc65
3521 <ref id="getcwd" name="getcwd">,
3522 <ref id="getcurrentdevice" name="getcurrentdevice">,
3523 <ref id="getfirstdevice" name="getfirstdevice">,
3524 <ref id="getnextdevice" name="getnextdevice">
3526 chdir (getdevicedir (device, buf, sizeof buf));
3532 <sect1>getenv<label id="getenv"><p>
3536 <tag/Function/Return a value from the environment.
3537 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
3538 <tag/Declaration/<tt/char* __fastcall__ getenv (const char* name);/
3539 <tag/Description/The function searches the environment for an entry that
3540 matches <tt/name/ and returns its value. The environment consists of a list
3541 of strings in the form <tt/name=value/. If there is no match, <tt/getenv/
3543 <tag/Notes/<itemize>
3544 <item>What exactly is stored in the environment depends on the machine the
3545 program is running on.
3546 <item>The function is only available as fastcall function, so it may only
3547 be used in presence of a prototype.
3549 <tag/Availability/ISO 9899
3555 <sect1>getfirstdevice<label id="getfirstdevice"><p>
3559 <tag/Function/Get first device.
3560 <tag/Header/<tt/<ref id="device.h" name="device.h">/
3561 <tag/Declaration/<tt/unsigned char getfirstdevice (void);/
3562 <tag/Description/The function returns the first device.
3563 The constant <tt/INVALID_DEVICE/ indicates no device.
3564 <tag/Notes/<itemize>
3567 <tag/Availability/cc65
3569 <ref id="getcurrentdevice" name="getcurrentdevice">,
3570 <ref id="getdevicedir" name="getdevicedir">,
3571 <ref id="getnextdevice" name="getnextdevice">
3573 unsigned char dev = getfirstdevice ();
3574 while (dev != INVALID_DEVICE) {
3575 printf ("%d\n", dev);
3576 dev = getnextdevice (dev);
3583 <sect1>getnextdevice<label id="getnextdevice"><p>
3587 <tag/Function/Get next device.
3588 <tag/Header/<tt/<ref id="device.h" name="device.h">/
3589 <tag/Declaration/<tt/unsigned char __fastcall__ getnextdevice (unsigned char device);/
3590 <tag/Description/The function returns the next device after <tt/device/.
3591 The constant <tt/INVALID_DEVICE/ indicates no further device.
3592 <tag/Notes/<itemize>
3593 <item>The function is only available as fastcall function, so it may only
3594 be used in presence of a prototype.
3596 <tag/Availability/cc65
3598 <ref id="getcurrentdevice" name="getcurrentdevice">,
3599 <ref id="getdevicedir" name="getdevicedir">,
3600 <ref id="getfirstdevice" name="getfirstdevice">
3602 unsigned char dev = getfirstdevice ();
3603 while (dev != INVALID_DEVICE) {
3604 printf ("%d\n", dev);
3605 dev = getnextdevice (dev);
3612 <sect1>getopt<label id="getopt"><p>
3616 <tag/Function/Parse command line options.
3617 <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/
3618 <tag/Declaration/<tt/int __fastcall__ getopt (int argc, char* const* argv,
3619 const char* optstring);/
3620 <tag/Description/The function parses command line arguments, <tt/argc/ and
3621 <tt/argv/ are the argument count and array passed to <tt/main/. <tt/optstring/
3622 is a string that contains command line option characters. If a character in
3623 <tt/optstring/ is followed by a colon, the option requires an argument. An
3624 option on the command line is recognized if it is one of the option characters
3626 <tt/getopt/ must be called repeatedly. It will return each option character
3627 found on the command line and <tt/EOF/ (-1) if there is no other option. An
3628 option argument is placed in <tt/optarg/, the index of the next element on the
3629 command line to be processed is placed in <tt/optind/.
3630 <tag/Notes/<itemize>
3631 <item>The implementation will not reorder options. A non option on the command
3632 line will terminate option processing. All remaining arguments are not
3633 recognized as options, even if the start with a '-' character.
3634 <item>The function is only available as fastcall function, so it may only
3635 be used in presence of a prototype.
3637 <tag/Availability/POSIX.2
3643 <sect1>gotox<label id="gotox"><p>
3647 <tag/Function/Move the text mode cursor to a new X position.
3648 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
3649 <tag/Declaration/<tt/void __fastcall__ gotox (unsigned char x);/
3650 <tag/Description/The function moves the text mode cursor to the specified X
3651 position while leaving the Y position untouched. The leftmost position on the
3652 screen has the coordinate 0.
3653 <tag/Notes/<itemize>
3654 <item>The function is only available as fastcall function, so it may
3655 only be used in presence of a prototype.
3656 <item>Invalid values for the X position (out of screen coordinates) may
3657 lead to undefined behaviour.
3659 <tag/Availability/cc65
3661 <ref id="gotoy" name="gotoy">,
3662 <ref id="gotoxy" name="gotoxy">,
3663 <ref id="wherex" name="wherex">,
3664 <ref id="wherey" name="wherey">
3670 <sect1>gotoxy<label id="gotoxy"><p>
3674 <tag/Function/Move the text mode cursor to a new position.
3675 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
3676 <tag/Declaration/<tt/void __fastcall__ gotoxy (unsigned char x, unsigned char y);/
3677 <tag/Description/The function moves the text mode cursor to the specified
3678 position. The leftmost position on the screen has the X coordinate 0, the
3679 topmost line has the Y coordinate 0.
3680 <tag/Notes/<itemize>
3681 <item>The function is only available as fastcall function, so it may only be
3682 used in presence of a prototype.
3683 <item>Invalid values for any of both coordinates (out of screen positions) may
3684 lead to undefined behaviour.
3686 <tag/Availability/cc65
3688 <ref id="gotox" name="gotox">,
3689 <ref id="gotoy" name="gotoy">,
3690 <ref id="wherex" name="wherex">,
3691 <ref id="wherey" name="wherey">
3697 <sect1>gotoy<label id="gotoy"><p>
3701 <tag/Function/Move the text mode cursor to a new Y position.
3702 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
3703 <tag/Declaration/<tt/void __fastcall__ gotoy (unsigned char x);/
3704 <tag/Description/The function moves the text mode cursor to the specified Y
3705 position while leaving the X position untouched. The uppermost position on the
3706 screen has the coordinate 0.
3707 <tag/Notes/<itemize>
3708 <item>The function is only available as fastcall function, so it may
3709 only be used in presence of a prototype.
3710 <item>Invalid values for the Y position (out of screen coordinates) may lead
3711 to undefined behaviour.
3713 <tag/Availability/cc65
3715 <ref id="gotox" name="gotox">,
3716 <ref id="gotoxy" name="gotoxy">,
3717 <ref id="wherex" name="wherex">,
3718 <ref id="wherey" name="wherey">
3724 <sect1>isalnum<label id="isalnum"><p>
3728 <tag/Function/Check if a given character is a letter or digit.
3729 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3730 <tag/Declaration/<tt/int __fastcall__ isalnum (int c);/
3731 <tag/Description/The function returns a non zero value if the given argument
3732 is a letter or digit. The return value is zero if the character is anything
3734 <tag/Notes/<itemize>
3735 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3736 inline sequence generated by the macro will not work correctly for values
3737 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3738 this range. The non inline function may be accessed by <tt/#undef/'ing
3740 <item>When compiling without <tt/-Os/, the function is only available as
3741 fastcall function, so it may only be used in presence of a prototype.
3743 <tag/Availability/ISO 9899
3745 <ref id="isalpha" name="isalpha">,
3746 <ref id="isascii" name="isascii">,
3747 <ref id="isblank" name="isblank">,
3748 <ref id="iscntrl" name="iscntrl">,
3749 <ref id="isdigit" name="isdigit">,
3750 <ref id="isgraph" name="isgraph">,
3751 <ref id="islower" name="islower">,
3752 <ref id="isprint" name="isprint">,
3753 <ref id="ispunct" name="ispunct">,
3754 <ref id="isspace" name="isspace">,
3755 <ref id="isupper" name="isupper">,
3756 <ref id="isxdigit" name="isxdigit">
3762 <sect1>isalpha<label id="isalpha"><p>
3766 <tag/Function/Check if a given character is a letter.
3767 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3768 <tag/Declaration/<tt/int __fastcall__ isalpha (int c);/
3769 <tag/Description/The function returns a non zero value if the given argument
3770 is a letter. The return value is zero if the character is anything else.
3771 <tag/Notes/<itemize>
3772 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3773 inline sequence generated by the macro will not work correctly for values
3774 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3775 this range. The non inline function may be accessed by <tt/#undef/'ing the
3777 <item>When compiling without <tt/-Os/, the function is only available as
3778 fastcall function, so it may only be used in presence of a prototype.
3780 <tag/Availability/ISO 9899
3782 <ref id="isalnum" name="isalnum">,
3783 <ref id="isascii" name="isascii">,
3784 <ref id="isblank" name="isblank">,
3785 <ref id="iscntrl" name="iscntrl">,
3786 <ref id="isdigit" name="isdigit">,
3787 <ref id="isgraph" name="isgraph">,
3788 <ref id="islower" name="islower">,
3789 <ref id="isprint" name="isprint">,
3790 <ref id="ispunct" name="ispunct">,
3791 <ref id="isspace" name="isspace">,
3792 <ref id="isupper" name="isupper">,
3793 <ref id="isxdigit" name="isxdigit">
3799 <sect1>isascii<label id="isascii"><p>
3803 <tag/Function/Check if a given character is in the ASCII (0..127) range.
3804 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3805 <tag/Declaration/<tt/int __fastcall__ isascii (int c);/
3806 <tag/Description/The function returns a non zero value if the given argument
3807 is in the range 0..127 (the range of valid ASCII characters) and zero if not.
3808 <tag/Notes/<itemize>
3809 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3810 inline sequence generated by the macro will not work correctly for values
3811 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3812 this range. The non inline function may be accessed by <tt/#undef/'ing the
3814 <item>When compiling without <tt/-Os/, the function is only available as
3815 fastcall function, so it may only be used in presence of a prototype.
3817 <tag/Availability/ISO 9899
3819 <ref id="isalnum" name="isalnum">,
3820 <ref id="isalpha" name="isalpha">,
3821 <ref id="isblank" name="isblank">,
3822 <ref id="iscntrl" name="iscntrl">,
3823 <ref id="isdigit" name="isdigit">,
3824 <ref id="isgraph" name="isgraph">,
3825 <ref id="islower" name="islower">,
3826 <ref id="isprint" name="isprint">,
3827 <ref id="ispunct" name="ispunct">,
3828 <ref id="isspace" name="isspace">,
3829 <ref id="isupper" name="isupper">,
3830 <ref id="isxdigit" name="isxdigit">
3836 <sect1>isblank<label id="isblank"><p>
3840 <tag/Function/Check if a given character is a space or tab.
3841 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3842 <tag/Declaration/<tt/int __fastcall__ isblank (int c);/
3843 <tag/Description/The function returns a non zero value if the given argument
3844 is a space or tab character. The return value is zero if the character is
3846 <tag/Notes/<itemize>
3847 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3848 inline sequence generated by the macro will not work correctly for values
3849 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3850 this range. The non inline function may be accessed by <tt/#undef/'ing the
3852 <item>When compiling without <tt/-Os/, the function is only available as
3853 fastcall function, so it may only be used in presence of a prototype.
3855 <tag/Availability/ISO 9899
3857 <ref id="isalnum" name="isalnum">,
3858 <ref id="isalpha" name="isalpha">,
3859 <ref id="isascii" name="isascii">,
3860 <ref id="iscntrl" name="iscntrl">,
3861 <ref id="isdigit" name="isdigit">,
3862 <ref id="isgraph" name="isgraph">,
3863 <ref id="islower" name="islower">,
3864 <ref id="isprint" name="isprint">,
3865 <ref id="ispunct" name="ispunct">,
3866 <ref id="isspace" name="isspace">,
3867 <ref id="isupper" name="isupper">,
3868 <ref id="isxdigit" name="isxdigit">
3874 <sect1>iscntrl<label id="iscntrl"><p>
3878 <tag/Function/Check if a given character is a control character.
3879 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3880 <tag/Declaration/<tt/int __fastcall__ iscntrl (int c);/
3881 <tag/Description/The function returns a non zero value if the given argument
3882 is a control character. The return value is zero if the character is anything
3884 <tag/Notes/<itemize>
3885 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3886 inline sequence generated by the macro will not work correctly for values
3887 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3888 this range. The non inline function may be accessed by <tt/#undef/'ing the
3890 <item>When compiling without <tt/-Os/, the function is only available as
3891 fastcall function, so it may only be used in presence of a prototype.
3893 <tag/Availability/ISO 9899
3895 <ref id="isalnum" name="isalnum">,
3896 <ref id="isalpha" name="isalpha">,
3897 <ref id="isascii" name="isascii">,
3898 <ref id="isblank" name="isblank">,
3899 <ref id="isdigit" name="isdigit">,
3900 <ref id="isgraph" name="isgraph">,
3901 <ref id="islower" name="islower">,
3902 <ref id="isprint" name="isprint">,
3903 <ref id="ispunct" name="ispunct">,
3904 <ref id="isspace" name="isspace">,
3905 <ref id="isupper" name="isupper">,
3906 <ref id="isxdigit" name="isxdigit">
3912 <sect1>isdigit<label id="isdigit"><p>
3916 <tag/Function/Check if a given character is a digit.
3917 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3918 <tag/Declaration/<tt/int __fastcall__ isdigit (int c);/
3919 <tag/Description/The function returns a non zero value if the given argument
3920 is a digit. The return value is zero if the character is anything else.
3921 <tag/Notes/<itemize>
3922 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3923 inline sequence generated by the macro will not work correctly for values
3924 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3925 this range. The non inline function may be accessed by <tt/#undef/'ing the
3927 <item>When compiling without <tt/-Os/, the function is only available as
3928 fastcall function, so it may only be used in presence of a prototype.
3930 <tag/Availability/ISO 9899
3932 <ref id="isalnum" name="isalnum">,
3933 <ref id="isalpha" name="isalpha">,
3934 <ref id="isascii" name="isascii">,
3935 <ref id="isblank" name="isblank">,
3936 <ref id="iscntrl" name="iscntrl">,
3937 <ref id="isgraph" name="isgraph">,
3938 <ref id="islower" name="islower">,
3939 <ref id="isprint" name="isprint">,
3940 <ref id="ispunct" name="ispunct">,
3941 <ref id="isspace" name="isspace">,
3942 <ref id="isupper" name="isupper">,
3943 <ref id="isxdigit" name="isxdigit">
3949 <sect1>isgraph<label id="isgraph"><p>
3953 <tag/Function/Check if a given character is a printable character (except
3955 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3956 <tag/Declaration/<tt/int __fastcall__ isgraph (int c);/
3957 <tag/Description/The function returns a non zero value if the given argument
3958 is a printable character with the exception of space. The return value is zero
3959 if the character is anything else.
3960 <tag/Notes/<itemize>
3961 <item>When compiling with <tt/-Os/ the function is actually a macro. The
3962 inline sequence generated by the macro will not work correctly for values
3963 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
3964 this range. The non inline function may be accessed by <tt/#undef/'ing the
3966 <item>When compiling without <tt/-Os/, the function is only available as
3967 fastcall function, so it may only be used in presence of a prototype.
3969 <tag/Availability/ISO 9899
3971 <ref id="isalnum" name="isalnum">,
3972 <ref id="isalpha" name="isalpha">,
3973 <ref id="isascii" name="isascii">,
3974 <ref id="isblank" name="isblank">,
3975 <ref id="iscntrl" name="iscntrl">,
3976 <ref id="isdigit" name="isdigit">,
3977 <ref id="islower" name="islower">,
3978 <ref id="isprint" name="isprint">,
3979 <ref id="ispunct" name="ispunct">,
3980 <ref id="isspace" name="isspace">,
3981 <ref id="isupper" name="isupper">,
3982 <ref id="isxdigit" name="isxdigit">
3988 <sect1>islower<label id="islower"><p>
3992 <tag/Function/Check if a given character is a lower case letter.
3993 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
3994 <tag/Declaration/<tt/int __fastcall__ islower (int c);/
3995 <tag/Description/The function returns a non zero value if the given argument
3996 is a lower case letter. The return value is zero if the character is anything
3998 <tag/Notes/<itemize>
3999 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4000 inline sequence generated by the macro will not work correctly for values
4001 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4002 this range. The non inline function may be accessed by <tt/#undef/'ing the
4004 <item>When compiling without <tt/-Os/, the function is only available as
4005 fastcall function, so it may only be used in presence of a prototype.
4007 <tag/Availability/ISO 9899
4009 <ref id="isalnum" name="isalnum">,
4010 <ref id="isalpha" name="isalpha">,
4011 <ref id="isascii" name="isascii">,
4012 <ref id="isblank" name="isblank">,
4013 <ref id="iscntrl" name="iscntrl">,
4014 <ref id="isdigit" name="isdigit">,
4015 <ref id="isgraph" name="isgraph">,
4016 <ref id="isprint" name="isprint">,
4017 <ref id="ispunct" name="ispunct">,
4018 <ref id="isspace" name="isspace">,
4019 <ref id="isupper" name="isupper">,
4020 <ref id="isxdigit" name="isxdigit">
4026 <sect1>isprint<label id="isprint"><p>
4030 <tag/Function/Check if a given character is a printable character.
4031 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
4032 <tag/Declaration/<tt/int __fastcall__ isprint (int c);/
4033 <tag/Description/The function returns a non zero value if the given argument
4034 is a printable character (this includes the space character). The return value
4035 is zero if the character is anything else.
4036 <tag/Notes/<itemize>
4037 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4038 inline sequence generated by the macro will not work correctly for values
4039 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4040 this range. The non inline function may be accessed by <tt/#undef/'ing the
4042 <item>When compiling without <tt/-Os/, the function is only available as
4043 fastcall function, so it may only be used in presence of a prototype.
4045 <tag/Availability/ISO 9899
4047 <ref id="isalnum" name="isalnum">,
4048 <ref id="isalpha" name="isalpha">,
4049 <ref id="isascii" name="isascii">,
4050 <ref id="isblank" name="isblank">,
4051 <ref id="iscntrl" name="iscntrl">,
4052 <ref id="isdigit" name="isdigit">,
4053 <ref id="isgraph" name="isgraph">,
4054 <ref id="islower" name="islower">,
4055 <ref id="ispunct" name="ispunct">,
4056 <ref id="isspace" name="isspace">,
4057 <ref id="isupper" name="isupper">,
4058 <ref id="isxdigit" name="isxdigit">
4064 <sect1>ispunct<label id="ispunct"><p>
4068 <tag/Function/Check if a given character is a printable character but not a
4069 space or an alphanumeric character.
4070 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
4071 <tag/Declaration/<tt/int __fastcall__ ispunct (int c);/
4072 <tag/Description/The function returns a non zero value if the given argument
4073 is a printable character, but not a space or anything alphanumeric. The return
4074 value is zero if the character is anything else.
4075 <tag/Notes/<itemize>
4076 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4077 inline sequence generated by the macro will not work correctly for values
4078 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4079 this range. The non inline function may be accessed by <tt/#undef/'ing the
4081 <item>When compiling without <tt/-Os/, the function is only available as
4082 fastcall function, so it may only be used in presence of a prototype.
4084 <tag/Availability/ISO 9899
4086 <ref id="isalnum" name="isalnum">,
4087 <ref id="isalpha" name="isalpha">,
4088 <ref id="isascii" name="isascii">,
4089 <ref id="isblank" name="isblank">,
4090 <ref id="iscntrl" name="iscntrl">,
4091 <ref id="isdigit" name="isdigit">,
4092 <ref id="isgraph" name="isgraph">,
4093 <ref id="islower" name="islower">,
4094 <ref id="isprint" name="isprint">,
4095 <ref id="isspace" name="isspace">,
4096 <ref id="isupper" name="isupper">,
4097 <ref id="isxdigit" name="isxdigit">
4103 <sect1>isspace<label id="isspace"><p>
4107 <tag/Function/Check if a given character is a white-space character.
4108 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
4109 <tag/Declaration/<tt/int __fastcall__ isspace (int c);/
4110 <tag/Description/The function returns a non zero value if the given argument
4111 is a white space character. The return value is zero if the character is
4112 anything else. The standard white space characters are: space, formfeed ('\f'),
4113 newline ('\n'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab
4115 <tag/Notes/<itemize>
4116 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4117 inline sequence generated by the macro will not work correctly for values
4118 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4119 this range. The non inline function may be accessed by <tt/#undef/'ing the
4121 <item>When compiling without <tt/-Os/, the function is only available as
4122 fastcall function, so it may only be used in presence of a prototype.
4124 <tag/Availability/ISO 9899
4126 <ref id="isalnum" name="isalnum">,
4127 <ref id="isalpha" name="isalpha">,
4128 <ref id="isascii" name="isascii">,
4129 <ref id="isblank" name="isblank">,
4130 <ref id="iscntrl" name="iscntrl">,
4131 <ref id="isdigit" name="isdigit">,
4132 <ref id="isgraph" name="isgraph">,
4133 <ref id="islower" name="islower">,
4134 <ref id="isprint" name="isprint">,
4135 <ref id="ispunct" name="ispunct">,
4136 <ref id="isupper" name="isupper">,
4137 <ref id="isxdigit" name="isxdigit">
4143 <sect1>isupper<label id="isupper"><p>
4147 <tag/Function/Check if a given character is an upper case letter.
4148 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
4149 <tag/Declaration/<tt/int __fastcall__ isupper (int c);/
4150 <tag/Description/The function returns a non zero value if the given argument
4151 is an upper case letter. The return value is zero if the character is anything
4153 <tag/Notes/<itemize>
4154 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4155 inline sequence generated by the macro will not work correctly for values
4156 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4157 this range. The non inline function may be accessed by <tt/#undef/'ing the
4159 <item>When compiling without <tt/-Os/, the function is only available as
4160 fastcall function, so it may only be used in presence of a prototype.
4162 <tag/Availability/ISO 9899
4164 <ref id="isalnum" name="isalnum">,
4165 <ref id="isalpha" name="isalpha">,
4166 <ref id="isascii" name="isascii">,
4167 <ref id="isblank" name="isblank">,
4168 <ref id="iscntrl" name="iscntrl">,
4169 <ref id="isdigit" name="isdigit">,
4170 <ref id="isgraph" name="isgraph">,
4171 <ref id="islower" name="islower">,
4172 <ref id="isprint" name="isprint">,
4173 <ref id="ispunct" name="ispunct">,
4174 <ref id="isspace" name="isspace">,
4175 <ref id="isxdigit" name="isxdigit">
4181 <sect1>isxdigit<label id="isxdigit"><p>
4185 <tag/Function/Check if a given character is a hexadecimal digit.
4186 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
4187 <tag/Declaration/<tt/int __fastcall__ isxdigit (int c);/
4188 <tag/Description/The function returns a non zero value if the given argument
4189 is a hexadecimal digit (0..9, a..f and A..F). The return value is zero if the
4190 character is anything else.
4191 <tag/Notes/<itemize>
4192 <item>When compiling with <tt/-Os/ the function is actually a macro. The
4193 inline sequence generated by the macro will not work correctly for values
4194 outside the range 0..255. <em/Note:/ The constant <tt/EOF/ is not part of
4195 this range. The non inline function may be accessed by <tt/#undef/'ing the
4197 <item>When compiling without <tt/-Os/, the function is only available as
4198 fastcall function, so it may only be used in presence of a prototype.
4200 <tag/Availability/ISO 9899
4202 <ref id="isalnum" name="isalnum">,
4203 <ref id="isalpha" name="isalpha">,
4204 <ref id="isascii" name="isascii">,
4205 <ref id="isblank" name="isblank">,
4206 <ref id="iscntrl" name="iscntrl">,
4207 <ref id="isdigit" name="isdigit">,
4208 <ref id="isgraph" name="isgraph">,
4209 <ref id="islower" name="islower">,
4210 <ref id="isprint" name="isprint">,
4211 <ref id="ispunct" name="ispunct">,
4212 <ref id="isspace" name="isspace">,
4213 <ref id="isupper" name="isupper">
4219 <sect1>itoa<label id="itoa"><p>
4223 <tag/Function/Convert an integer into a string.
4224 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
4225 <tag/Declaration/<tt/char* __fastcall__ itoa (int val, char* buf, int radix);/
4226 <tag/Description/<tt/itoa/ converts the integer <tt/val/ into a string using
4227 <tt/radix/ as the base.
4228 <tag/Notes/<itemize>
4229 <item>There are no provisions to prevent a buffer overflow.
4230 <item>If <tt/val/ contains <tt/INT_MIN/, the behaviour is undefined.
4231 <item>The function is non standard, so it is not available in strict ANSI mode.
4232 You should probably use <tt/sprintf/ instead.
4233 <item>The function is only available as fastcall function, so it may only be
4234 used in presence of a prototype.
4236 <tag/Availability/cc65
4238 <ref id="atoi" name="atoi">,
4239 <ref id="atol" name="atol">,
4240 <ref id="ltoa" name="ltoa">,
4241 <ref id="ultoa" name="ultoa">,
4242 <ref id="utoa" name="utoa">
4248 <sect1>joy_count<label id="joy_count"><p>
4252 <tag/Function/Return the number of joysticks supported by the current driver.
4253 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4254 <tag/Declaration/<tt/unsigned char joy_count (void);/
4255 <tag/Description/The function returns a the number of joysticks supported
4256 by the current joystick driver.
4257 <tag/Notes/<itemize>
4258 <item>A joystick driver must be loaded using <ref id="joy_load_driver"
4259 name="joy_load_driver"> before calling this function.
4260 <item>The function returns the number of joysticks supported by the driver.
4261 There's no way to check for the number of actually connected joysticks.
4263 <tag/Availability/cc65
4265 <ref id="joy_load_driver" name="joy_load_driver">,
4266 <ref id="joy_read" name="joy_read">
4272 <sect1>joy_install<label id="joy_install"><p>
4276 <tag/Function/Install an already loaded driver and return an error code.
4277 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4278 <tag/Declaration/<tt/unsigned char __fastcall__ joy_install (void* driver);/
4279 <tag/Description/The function installs a driver that was already loaded into
4280 memory (or linked statically to the program). It returns an error code
4281 (<tt/JOY_ERR_OK/ in case of success).
4282 <tag/Notes/<itemize>
4283 <item>The function is only available as fastcall function, so it may only be
4284 used in presence of a prototype.
4286 <tag/Availability/cc65
4288 <ref id="joy_load_driver" name="joy_load_driver">,
4289 <ref id="joy_uninstall" name="joy_uninstall">,
4290 <ref id="joy_unload" name="joy_unload">
4296 <sect1>joy_load_driver<label id="joy_load_driver"><p>
4300 <tag/Function/Load a driver from disk and install it.
4301 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4302 <tag/Declaration/<tt/unsigned char __fastcall__ joy_load_driver (const char* driver);/
4303 <tag/Description/The function loads a driver with the given name from disk
4304 and installs it. An error code is returned, which is <tt/JOY_ERR_OK/ if the
4305 driver was successfully loaded and installed.
4306 <tag/Notes/<itemize>
4307 <item>The function is only available as fastcall function, so it may only be
4308 used in presence of a prototype.
4310 <tag/Availability/cc65
4312 <ref id="joy_install" name="joy_install">,
4313 <ref id="joy_uninstall" name="joy_uninstall">,
4314 <ref id="joy_unload" name="joy_unload">
4320 <sect1>joy_read<label id="joy_read"><p>
4324 <tag/Function/Read the status of a joystick.
4325 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4326 <tag/Declaration/<tt/unsigned char __fastcall__ joy_read (unsigned char joystick);/
4327 <tag/Description/The function reads the status bits for a joystick. The number
4328 of the joystick is passed as parameter. The result may be examined by using one
4329 of the <tt/JOY_xxx/ macros from <ref id="joystick.h" name="joystick.h">.
4330 <tag/Notes/<itemize>
4331 <item>A joystick driver must be loaded using <ref id="joy_load_driver"
4332 name="joy_load_driver"> before calling this function.
4333 <item>The function is only available as fastcall function, so it may only be
4334 used in presence of a prototype.
4336 <tag/Availability/cc65
4338 <ref id="joy_count" name="joy_count">,
4339 <ref id="joy_load_driver" name="joy_load_driver">,
4340 <ref id="joy_unload" name="joy_unload">
4346 <sect1>joy_uninstall<label id="joy_uninstall"><p>
4350 <tag/Function/Uninstall the current joystick driver.
4351 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4352 <tag/Declaration/<tt/unsigned char joy_uninstall (void);/
4353 <tag/Description/The function uninstalls the currently installed joystick
4354 driver. It does not remove the driver from memory. The function returns an
4355 error code, which is <tt/JOY_ERR_OK/ if the driver was successfully uninstalled.
4356 <tag/Notes/<itemize>
4357 <item>A joystick driver must be installed using <ref id="joy_install"
4358 name="joy_install"> before calling this function.
4360 <tag/Availability/cc65
4362 <ref id="joy_install" name="joy_install">,
4363 <ref id="joy_load_driver" name="joy_load_driver">,
4364 <ref id="joy_unload" name="joy_unload">
4370 <sect1>joy_unload<label id="joy_unload"><p>
4374 <tag/Function/Uninstall, then unload the current joystick driver.
4375 <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/
4376 <tag/Declaration/<tt/unsigned char joy_unload (void);/
4377 <tag/Description/The function uninstalls the currently installed joystick
4378 driver and removes it from memory. An error code is returned, which is
4379 <tt/JOY_ERR_OK/ if the driver was successfully uninstalled.
4380 <tag/Notes/<itemize>
4381 <item>A joystick driver must be loaded using <ref id="joy_load_driver"
4382 name="joy_load_driver"> before calling this function.
4384 <tag/Availability/cc65
4386 <ref id="joy_load_driver" name="joy_load_driver">
4392 <sect1>kbhit<label id="kbhit"><p>
4396 <tag/Function/Check if there's a key waiting in the keyboard buffer.
4397 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
4398 <tag/Declaration/<tt/unsigned char kbhit (void);/
4399 <tag/Description/The function returns a value of zero if there is no character
4400 waiting to be read from the keyboard. It returns non zero otherwise.
4401 <tag/Notes/<itemize>
4402 <item>If the system does not support a keyboard buffer (most systems
4403 do), the function is rather useless.
4405 <tag/Availability/cc65
4407 <ref id="cgetc" name="cgetc">,
4408 <ref id="cursor" name="cursor">
4414 <sect1>kbrepeat<label id="kbrepeat"><p>
4418 <tag/Function/Set the keyboard repeat mode.
4419 <tag/Header/<tt/<ref id="cbm.h" name="cbm.h">/
4420 <tag/Declaration/<tt/unsigned char __fastcall__ kbrepeat (unsigned char mode);/
4421 <tag/Description/This function changes which keys have automatic repeat when
4422 being held down for a certain time. Possible values are <tt/KBREPEAT_CURSOR/
4423 (repeat only cursor-related keys), <tt/KBREPEAT_NONE/ (no repeat for any
4424 keys), and <tt/KBREPEAT_ALL/ (repeat all keys). The old mode is returned, so
4425 it can be restored later.
4426 <tag/Notes/<itemize>
4427 <item>The function is available only as a fastcall function; so, it may be used
4428 only in the presence of a prototype.
4430 <tag/Availability/cc65
4436 <sect1>labs<label id="labs"><p>
4440 <tag/Function/Returns the absolute value of a long integer.
4441 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
4442 <tag/Declaration/<tt/long __fastcall__ labs (long v);/
4443 <tag/Description/<tt/labs/ returns the absolute value of the argument passed to
4445 <tag/Notes/<itemize>
4446 <item>The return value is undefined if <tt/LONG_MIN/ is passed to the function.
4447 <item>The function is only available as fastcall function, so it may only be
4448 used in presence of a prototype.
4450 <tag/Availability/ISO 9899
4452 <ref id="abs" name="abs">
4458 <sect1>ltoa<label id="ltoa"><p>
4462 <tag/Function/Convert a long integer into a string.
4463 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
4464 <tag/Declaration/<tt/char* __fastcall__ ltoa (long val, char* buf, int radix);/
4465 <tag/Description/<tt/itoa/ converts the long integer <tt/val/ into a string
4466 using <tt/radix/ as the base.
4467 <tag/Notes/<itemize>
4468 <item>There are no provisions to prevent a buffer overflow.
4469 <item>If <tt/val/ contains <tt/LONG_MIN/, the behaviour is undefined.
4470 <item>The function is non standard, so it is not available in strict ANSI mode.
4471 You should probably use <tt/sprintf/ instead.
4472 <item>The function is only available as fastcall function, so it may only be
4473 used in presence of a prototype.
4475 <tag/Availability/cc65
4477 <ref id="atoi" name="atoi">,
4478 <ref id="atol" name="atol">,
4479 <ref id="itoa" name="itoa">,
4480 <ref id="ultoa" name="ultoa">,
4481 <ref id="utoa" name="utoa">
4487 <sect1>localeconv<label id="localeconv"><p>
4491 <tag/Function/Returns a pointer to the current locale structure.
4492 <tag/Header/<tt/<ref id="locale.h" name="locale.h">/
4493 <tag/Declaration/<tt/struct lconv* localeconv (void);/
4494 <tag/Description/<tt/localeconv/ returns a pointer to the current locale
4496 <tag/Notes/<itemize>
4497 <item>cc65 supports only the "C" locale, so even after setting a new locale
4498 using <tt/<ref id="setlocale" name="setlocale">/, the structure returned will
4501 <tag/Availability/ISO 9899
4503 <ref id="setlocale" name="setlocale">
4509 <sect1>longjmp<label id="longjmp"><p>
4513 <tag/Function/Non local goto.
4514 <tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/
4515 <tag/Declaration/<tt/void __fastcall__ longjmp (jmp_buf buf, int retval);/
4516 <tag/Description/The <tt/longjmp/ function restores a program context from the
4517 data in <tt/buf/, which must have been set by a preceeding call to
4518 <tt/<ref id="setjmp" name="setjmp">/. Program execution continues as if the
4519 call to <tt/<ref id="setjmp" name="setjmp">/ has just returned the value
4521 <tag/Notes/<itemize>
4522 <item>If the parameter <tt/retval/ is zero, the function will behave as if it
4523 was called with a value of one.
4524 <item>The function is only available as fastcall function, so it may only
4525 be used in presence of a prototype.
4527 <tag/Availability/ISO 9899
4529 <ref id="setjmp" name="setjmp">
4535 <sect1>malloc<label id="malloc"><p>
4539 <tag/Function/Allocate dynamic memory.
4540 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
4541 <tag/Declaration/<tt/void* __fastcall__ malloc (size_t size);/
4542 <tag/Description/<tt/malloc/ allocates size bytes on the heap and returns a
4543 pointer to the allocated memory block. On error (not enough memory available),
4544 <tt/malloc/ returns <tt/NULL/.
4545 <tag/Notes/<itemize>
4546 <item>The function is only available as fastcall function, so it may only
4547 be used in presence of a prototype.
4549 <tag/Availability/ISO 9899
4551 <ref id="_heapadd" name="_heapadd">,
4552 <ref id="_heapblocksize" name="_heapblocksize">,
4553 <ref id="_heapmaxavail" name="_heapmaxavail">,
4554 <ref id="_heapmemavail" name="_heapmemavail">,
4555 <ref id="calloc" name="calloc">,
4556 <ref id="free" name="free">,
4557 <ref id="realloc" name="realloc">,
4558 <ref id="strdup" name="strdup">
4564 <sect1>memchr<label id="memchr"><p>
4568 <tag/Function/Search for a character in a block of raw memory.
4569 <tag/Header/<tt/<ref id="string.h" name="string.h">/
4570 <tag/Declaration/<tt/void* __fastcall__ strchr (const void* mem, int c, size_t count);/
4571 <tag/Description/The <tt/memchr/ function locates the first occurrence of <tt/c/
4572 (converted to a char) in the block of raw memory string pointed to by <tt/mem/
4573 that is of size <tt/count/. Upon completion, the function returns a pointer to
4574 the character found, or a null pointer if the character was not found.
4575 <tag/Notes/<itemize>
4576 <item>The function is only available as fastcall function, so it may only
4577 be used in presence of a prototype.
4579 <tag/Availability/ISO 9899
4581 <ref id="strchr" name="strchr">
4587 <sect1>memcmp<label id="memcmp"><p>
4591 <tag/Function/Compare two memory areas.
4592 <tag/Header/<tt/<ref id="string.h" name="string.h">/
4593 <tag/Declaration/<tt/int __fastcall__ memcmp (const void* p1, const void* p2, size_t count);/
4594 <tag/Description/<tt/memcmp/ compares <tt/count/ bytes from the memory area
4595 pointed to by <tt/p1/ into the memory area pointed to by <tt/p2/. It returns a value that is less than
4596 zero if <tt/p1/ is less than <tt/p2/, zero if <tt/p1/ is the same as <tt/p2/,
4597 and a value greater than zero if <tt/p1/ is greater than <tt/p2/.
4598 <tag/Notes/<itemize>
4599 <item>The function is only available as fastcall function, so it may only
4600 be used in presence of a prototype.
4602 <tag/Availability/ISO 9899
4604 <ref id="strcmp" name="strcmp">,
4605 <ref id="memmove" name="memmove">,
4606 <ref id="memset" name="memset">
4612 <sect1>memcpy<label id="memcpy"><p>
4616 <tag/Function/Copy a memory area.
4617 <tag/Header/<tt/<ref id="string.h" name="string.h">/
4618 <tag/Declaration/<tt/void* __fastcall__ memcpy (void* dest, const void* src, size_t count);/
4619 <tag/Description/<tt/memcpy/ copies <tt/count/ bytes from the memory area
4620 pointed to by <tt/src/ into the memory area pointed to by <tt/dest/. It returns
4622 <tag/Notes/<itemize>
4623 <item>The result is undefined if the memory areas do overlap. Use
4624 <tt/<ref id="memmove" name="memmove">/ to copy overlapping memory areas.
4625 <item>The function is only available as fastcall function, so it may only
4626 be used in presence of a prototype.
4628 <tag/Availability/ISO 9899
4630 <ref id="_swap" name="_swap">,
4631 <ref id="memmove" name="memmove">,
4632 <ref id="memset" name="memset">
4638 <sect1>memmove<label id="memmove"><p>
4642 <tag/Function/Copy a memory area.
4643 <tag/Header/<tt/<ref id="string.h" name="string.h">/
4644 <tag/Declaration/<tt/void* __fastcall__ memmove (void* dest, const void* src, size_t count);/
4645 <tag/Description/<tt/memmove/ copies <tt/count/ bytes from the memory area
4646 pointed to by <tt/src/ into the memory area pointed to by <tt/dest/. It returns
4648 <tag/Notes/<itemize>
4649 <item>While <tt/memmove/ allows the memory areas to overlap, it has some
4650 additional overhead compared to <tt/<ref id="memcpy" name="memcpy">/.
4651 <item>The function is only available as fastcall function, so it may only
4652 be used in presence of a prototype.
4654 <tag/Availability/ISO 9899
4656 <ref id="_swap" name="_swap">,
4657 <ref id="memcpy" name="memcpy">,
4658 <ref id="memset" name="memset">
4664 <sect1>memset<label id="memset"><p>
4668 <tag/Function/Fill a memory area.
4669 <tag/Header/<tt/<ref id="string.h" name="string.h">/
4670 <tag/Declaration/<tt/void* __fastcall__ memset (void* p, int val, size_t count);/
4671 <tag/Description/<tt/memset/ fills the memory area pointed to by <tt/p/ with
4672 the value <tt/val/. The function returns <tt/p/.
4673 <tag/Notes/<itemize>
4674 <item>The function is only available as fastcall function, so it may only
4675 be used in presence of a prototype.
4677 <tag/Availability/ISO 9899
4679 <ref id="_swap" name="_swap">,
4680 <ref id="bzero" name="bzero">,
4681 <ref id="memcpy" name="memcpy">,
4682 <ref id="memmove" name="memmove">
4688 <sect1>mod_free<label id="mod_free"><p>
4692 <tag/Function/Free a relocatable module.
4693 <tag/Header/<tt/<ref id="modload.h" name="modload.h">/
4694 <tag/Declaration/<tt/void __fastcall__ mod_free (void* module);/
4695 <tag/Description/The function will free a module loaded into memory by use of
4696 the <tt/<ref id="mod_load" name="mod_load">/ function.
4697 <tag/Notes/<itemize>
4698 <item>The pointer passed as parameter is the pointer to the module memory,
4699 not the pointer to the control structure.
4700 <item>The function is available only as a fastcall function; so, it may be used
4701 only in the presence of a prototype.
4703 <tag/Availability/cc65
4705 <ref id="mod_load" name="mod_load">
4711 <sect1>mod_load<label id="mod_load"><p>
4715 <tag/Function/Load a relocatable module.
4716 <tag/Header/<tt/<ref id="modload.h" name="modload.h">/
4717 <tag/Declaration/<tt/unsigned char __fastcall__ mod_load (struct mod_ctrl* ctrl);/
4718 <tag/Description/The function will load a code module into memory and relocate
4719 it. The function will return an error code. If <tt/MLOAD_OK/ is returned, the
4720 outgoing fields in the passed <tt/mod_ctrl/ struct contain information about
4721 the module just loaded. Possible error codes are:
4723 <item><tt/MLOAD_OK/ - Module load successful
4724 <item><tt/MLOAD_ERR_READ/ - Read error
4725 <item><tt/MLOAD_ERR_HDR/ - Header error
4726 <item><tt/MLOAD_ERR_OS/ - Wrong operating system
4727 <item><tt/MLOAD_ERR_FMT/ - Data format error
4728 <item><tt/MLOAD_ERR_MEM/ - Not enough memory
4730 <tag/Notes/<itemize>
4731 <item>The <htmlurl url="ld65.html" name="ld65"> linker is needed to create
4732 relocatable o65 modules for use with this function.
4733 <item>The function is available only as a fastcall function; so, it may be used
4734 only in the presence of a prototype.
4736 <tag/Availability/cc65
4738 <ref id="mod_free" name="mod_free">
4744 <sect1>mouse_setbox<label id="mouse_setbox"><p>
4748 <tag/Function/Specify a bounding box for the mouse cursor.
4749 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4750 <tag/Declaration/<tt/void __fastcall__ mouse_setbox (const struct mouse_box* box);/
4751 <tag/Description/The function allows to set a bounding box for mouse movement.
4752 <tag/Notes/<itemize>
4753 <item>The function does not check if the mouse cursor is currently within the
4754 given rectangle. Placing the mouse cursor within the bounding box is the
4755 responsibility of the programmer.
4756 <item>While the bounding box may be larger than the actual screen size, the
4757 standard mouse cursor draw routines may fail to set the cursor to coordinates
4758 outside of the screen area. Depending on the platform, you may have to supply
4759 your own mouse cursor routines.
4760 <item>The function is only available as fastcall function, so it may only be
4761 used in presence of a prototype.
4763 <tag/Availability/cc65
4765 <ref id="mouse_getbox" name="mouse_getbox">,
4766 <ref id="mouse_move" name="mouse_move">
4772 <sect1>mouse_getbox<label id="mouse_getbox"><p>
4776 <tag/Function/Return the current bounding box for the mouse cursor.
4777 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4778 <tag/Declaration/<tt/void __fastcall__ mouse_getbox (struct mouse_box* box);/
4779 <tag/Description/The function queries the current bounding box for mouse
4781 <tag/Notes/<itemize>
4782 <item>The function is only available as fastcall function, so it may only be
4783 used in presence of a prototype.
4785 <tag/Availability/cc65
4787 <ref id="mouse_move" name="mouse_move">,
4788 <ref id="mouse_setbox" name="mouse_setbox">
4794 <sect1>mouse_buttons<label id="mouse_buttons"><p>
4798 <tag/Function/Return a bit mask encoding the state of the mouse buttons.
4799 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4800 <tag/Declaration/<tt/unsigned char mouse_buttons (void);/
4801 <tag/Description/The function returns a bit mask that encodes the state of the
4802 mouse buttons. You may use the <tt/MOUSE_BTN_XXX/ flags to decode the function
4804 <tag/Availability/cc65
4806 <ref id="mouse_info" name="mouse_info">,
4807 <ref id="mouse_pos" name="mouse_pos">
4813 <sect1>mouse_geterrormsg<label id="mouse_geterrormsg"><p>
4817 <tag/Function/Return a readable error message for an error code.
4818 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4819 <tag/Declaration/<tt/const char* __fastcall__ mouse_geterrormsg (unsigned char
4821 <tag/Description/The function returns an error message (in english) for the
4822 error code passed parameter.
4823 <tag/Notes/<itemize>
4824 <item>The function will return "Unknown error" for invalid error codes.
4825 <item>The function is only available as fastcall function, so it may only be
4826 used in presence of a prototype.
4828 <tag/Availability/cc65
4830 <ref id="mouse_load_driver" name="mouse_load_driver">,
4831 <ref id="mouse_uninstall" name="mouse_uninstall">,
4832 <ref id="mouse_unload" name="mouse_unload">
4838 <sect1>mouse_hide<label id="mouse_hide"><p>
4842 <tag/Function/Hide the mouse pointer.
4843 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4844 <tag/Declaration/<tt/void mouse_hide (void);/
4845 <tag/Description/The function hides the mouse pointer. It manages a counter
4846 that is shared between <tt/<ref id="mouse_show" name="mouse_show">/ and
4847 <tt/mouse_hide/ so that every call call to <tt/mouse_hide/ must be followed by
4848 a call to <tt/<ref id="mouse_show" name="mouse_show">/ to make the mouse cursor
4850 <tag/Availability/cc65
4852 <ref id="mouse_show" name="mouse_show">
4858 <sect1>mouse_info<label id="mouse_info"><p>
4862 <tag/Function/Return the state of the mouse buttons and the position of the
4864 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4865 <tag/Declaration/<tt/void __fastcall__ mouse_info (struct mouse_info* info);/
4866 <tag/Description/The function returns the state of the mouse buttons and the
4867 position of the mouse in the <tt/mouse_info/ structure passed as parameter.
4868 <tag/Notes/<itemize>
4869 <item>The <tt/mouse_info/ struct is a superset of the <tt/mouse_pos/ struct,
4870 so if you just need the mouse position, call <tt/<ref id="mouse_pos"
4871 name="mouse_pos">/ instead.
4872 <item>The function is only available as fastcall function, so it may only be
4873 used in presence of a prototype.
4875 <tag/Availability/cc65
4877 <ref id="mouse_buttons" name="mouse_buttons">,
4878 <ref id="mouse_pos" name="mouse_pos">
4884 <sect1>mouse_install<label id="mouse_install"><p>
4888 <tag/Function/Install an already loaded mouse driver.
4889 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4890 <tag/Declaration/<tt/unsigned char __fastcall__ mouse_install (const struct
4891 mouse_callbacks* c, void* driver);/
4892 <tag/Description/The function installs an already loaded mouse driver and
4893 returns an error code. The <tt/mouse_callbacks/ structure passed as first
4894 parameter contains pointers to routines needed to move or hide/show the mouse
4895 pointer. Defaults for these routines are supplied by the library, so if you
4896 can live with these defaults (which are platform specific), just pass a
4897 pointer to <tt/mouse_def_callbacks/. The function may be used to install a
4898 driver linked statically to the program.
4899 <tag/Notes/<itemize>
4900 <item>Not all drivers are able to detect if the supported hardware is really
4902 <item>After installing a driver, the mouse cursor is hidden.
4903 <item>The function is only available as fastcall function, so it may only be
4904 used in presence of a prototype.
4906 <tag/Availability/cc65
4908 <ref id="mouse_load_driver" name="mouse_load_driver">,
4909 <ref id="mouse_uninstall" name="mouse_uninstall">,
4910 <ref id="mouse_unload" name="mouse_unload">
4916 <sect1>mouse_ioctl<label id="mouse_ioctl"><p>
4920 <tag/Function/Call the driver specific ioctl function.
4921 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4922 <tag/Declaration/<tt/unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);/
4923 <tag/Description/The function calls the IOCTL entry in the mouse driver,
4924 which is driver specific. The <tt/code/ parameter will choose between
4925 different IOCTL functions, and the <tt/data/ depends on code. The
4926 function returns an error code. The purpose of this function is to allow
4927 for driver specific extensions. See the documentation for a specific mouse
4928 driver for supported ioctl calls.
4929 <tag/Notes/<itemize>
4930 <item>Calling this function is non portable, because each driver may
4931 implement different ioctl calls (or none at all).
4932 <item>The function is only available as fastcall function, so it may only be
4933 used in presence of a prototype.
4935 <tag/Availability/cc65
4941 <sect1>mouse_load_driver<label id="mouse_load_driver"><p>
4945 <tag/Function/Load and initialize a mouse driver.
4946 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4947 <tag/Declaration/<tt/unsigned char __fastcall__ mouse_load_driver (const struct
4948 mouse_callbacks* c, const char* driver);/
4949 <tag/Description/Load a mouse driver into memory and initialize it. The
4950 function returns an error code that tells if the call has been successful. The
4951 <tt/mouse_callbacks/ structure passed as first parameter contains pointers to
4952 routines needed to move or hide/show the mouse pointer. Defaults for these
4953 routines are supplied by the library, so if you can live with these defaults
4954 (which are platform specific), just pass a pointer to <tt/mouse_def_callbacks/.
4955 <tag/Notes/<itemize>
4956 <item>The driver is loaded by name, so currently you must know the type of
4957 mouse that should be supported. There is no autodetect capability.
4958 <item>Not all drivers are able to detect if the supported hardware is really
4960 <item>After installing a driver, the mouse cursor is hidden.
4961 <item>The function is only available as fastcall function, so it may only be
4962 used in presence of a prototype.
4964 <tag/Availability/cc65
4966 <ref id="mouse_install" name="mouse_install">,
4967 <ref id="mouse_uninstall" name="mouse_uninstall">,
4968 <ref id="mouse_unload" name="mouse_unload">
4974 <sect1>mouse_move<label id="mouse_move"><p>
4978 <tag/Function/Move the mouse cursor to a specific position.
4979 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
4980 <tag/Declaration/<tt/void __fastcall__ mouse_move (int x, int y);/
4981 <tag/Description/The function updates the mouse position. If the mouse cursor
4982 is visible, it is shown at the new position.
4983 <tag/Notes/<itemize>
4984 <item>The function does not check if the new position is within the bounding
4985 box specified with <tt/<ref id="mouse_setbox" name="mouse_setbox">/.
4986 <item>The function is only available as fastcall function, so it may only be
4987 used in presence of a prototype.
4989 <tag/Availability/cc65
4991 <ref id="mouse_getbox" name="mouse_getbox">,
4992 <ref id="mouse_setbox" name="mouse_setbox">
4998 <sect1>mouse_pos<label id="mouse_pos"><p>
5002 <tag/Function/Return the position of the mouse.
5003 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
5004 <tag/Declaration/<tt/void __fastcall__ mouse_pos (struct mouse_pos* pos);/
5005 <tag/Description/The function returns the position of the mouse in the
5006 <tt/mouse_pos/ structure passed as parameter.
5007 <tag/Notes/<itemize>
5008 <item>The <tt/mouse_pos/ struct is a subset of the <tt/mouse_info/ struct,
5009 so if you do also need the mouse buttons, call <tt/<ref id="mouse_info"
5010 name="mouse_info">/ instead.
5011 <item>The function is only available as fastcall function, so it may only be
5012 used in presence of a prototype.
5014 <tag/Availability/cc65
5016 <ref id="mouse_buttons" name="mouse_buttons">,
5017 <ref id="mouse_info" name="mouse_info">
5023 <sect1>mouse_show<label id="mouse_show"><p>
5027 <tag/Function/Show the mouse pointer.
5028 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
5029 <tag/Declaration/<tt/void mouse_show (void);/
5030 <tag/Description/The function shows the mouse pointer. It manages a counter
5031 that is shared between <tt/<ref id="mouse_hide" name="mouse_hide">/ and
5032 <tt/mouse_show/. The mouse cursor is visible if there was one more call to
5033 <tt/mouse_show/ than to <tt/<ref id="mouse_hide" name="mouse_hide">/.
5034 <tag/Availability/cc65
5036 <ref id="mouse_hide" name="mouse_hide">
5042 <sect1>mouse_uninstall<label id="mouse_uninstall"><p>
5046 <tag/Function/Uninstall an already loaded mouse driver.
5047 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
5048 <tag/Declaration/<tt/unsigned char mouse_uninstall (void);/
5049 <tag/Description/The function uninstalls an already loaded mouse driver but
5050 don't removes it from memory.
5051 <tag/Notes/<itemize>
5052 <item>If the driver has been loaded using <tt/<ref id="mouse_load_driver"
5053 name="mouse_load_driver">/, <tt/<ref id="mouse_unload" name="mouse_unload">/
5054 should be used instead of <tt/mouse_uninstall/ so the driver is also removed
5057 <tag/Availability/cc65
5059 <ref id="mouse_install" name="mouse_install">,
5060 <ref id="mouse_load_driver" name="mouse_load_driver">,
5061 <ref id="mouse_unload" name="mouse_unload">
5067 <sect1>mouse_unload<label id="mouse_unload"><p>
5071 <tag/Function/Unload a mouse driver.
5072 <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/
5073 <tag/Declaration/<tt/unsigned char mouse_unload (void);/
5074 <tag/Description/The function unloads a loaded mouse driver and frees all
5075 memory allocated for the driver.
5076 <tag/Notes/<itemize>
5077 <item>The function does nothing if no driver is loaded.
5079 <tag/Availability/cc65
5081 <ref id="mouse_install" name="mouse_install">,
5082 <ref id="mouse_load_driver" name="mouse_load_driver">,
5083 <ref id="mouse_uninstall" name="mouse_uninstall">
5089 <sect1>offsetof<label id="offsetof"><p>
5093 <tag/Function/Calculate the offset of a struct or union member.
5094 <tag/Header/<tt/<ref id="stddef.h" name="stddef.h">/
5095 <tag/Declaration/<tt/size_t offsetof (type, member);/
5096 <tag/Description/<tt/offsetof/ calculates the address offset of a <tt/struct/
5097 or <tt/union/ member.
5098 <tag/Notes/<itemize>
5099 <item>The function is actually a macro.
5101 <tag/Availability/ISO 9899
5107 <sect1>open<label id="open"><p>
5111 <tag/Function/Open and possibly create a file.
5112 <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/
5113 <tag/Declaration/<tt/int open (const char* name, int flags, ...);/
5114 <tag/Description/<tt/open/ opens a file and returns the file descriptor
5115 associated with it. On error, -1 is returned and an error code is stored in
5116 <tt/errno/. Several flags may be passed to <tt/open/ that change the behaviour.
5117 <tag/Notes/<itemize>
5118 <item>POSIX specifies an additional <tt/mode/ argument that may be passed to
5119 open, which is used as the permission mask when a new file is created. While
5120 cc65 allows to pass this argument, it is ignored.
5122 <tag/Availability/POSIX 1003.1
5124 <ref id="close" name="close">,
5125 <ref id="creat" name="creat">
5131 <sect1>opendir<label id="opendir"><p>
5135 <tag/Function/Open a directory.
5136 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
5137 <tag/Declaration/<tt/DIR* __fastcall__ opendir (const char* name);/
5138 <tag/Description/<tt/opendir/ opens a directory and returns the direcory
5139 descriptor associated with it. On error, NULL is returned and an error code is
5140 stored in <tt/errno/.
5141 <tag/Notes/<itemize>
5142 <item>The function is only available as fastcall function, so it may only
5143 be used in presence of a prototype.
5145 <tag/Availability/POSIX 1003.1
5147 <ref id="closedir" name="closedir">,
5148 <ref id="readdir" name="readdir">
5154 <sect1>peekbsys<label id="peekbsys"><p>
5158 <tag/Function/Read one byte from a location in the system bank.
5159 <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/,
5160 <tt/<ref id="cbm510.h" name="cbm510.h">/
5161 <tag/Declaration/<tt/unsigned char __fastcall__ peekbsys (unsigned addr);/
5162 <tag/Description/<tt/peekbsys/ reads one byte from the given address in the
5163 system bank (bank 15) of the CBM PET-II machines and returns it.
5164 <tag/Notes/<itemize>
5165 <item>The function is only available as fastcall function, so it may only
5166 be used in presence of a prototype.
5167 <item>This function may be a macro depending on the compiler options. The
5168 actual function is accessible by #undef'ing the macro.
5170 <tag/Availability/cc65
5172 <ref id="PEEK" name="PEEK">,
5173 <ref id="PEEKW" name="PEEKW">,
5174 <ref id="peekwsys" name="peekwsys">,
5175 <ref id="pokebsys" name="pokebsys">,
5176 <ref id="pokewsys" name="pokewsys">
5182 <sect1>peekwsys<label id="peekwsys"><p>
5186 <tag/Function/Read one word from a location in the system bank.
5187 <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/,
5188 <tt/<ref id="cbm510.h" name="cbm510.h">/
5189 <tag/Declaration/<tt/unsigned __fastcall__ peekwsys (unsigned addr);/
5190 <tag/Description/<tt/peekwsys/ reads one word from the given address in the
5191 system bank (bank 15) of the CBM PET-II machines and returns it. Following
5192 the usual 6502 conventions, the low byte is read from <tt/addr/, and the
5193 high byte is read from <tt/addr+1/.
5194 <tag/Notes/<itemize>
5195 <item>The function is only available as fastcall function, so it may only
5196 be used in presence of a prototype.
5197 <item>The order in which the two bytes are read is undefined.
5199 <tag/Availability/cc65
5201 <ref id="PEEK" name="PEEK">,
5202 <ref id="PEEKW" name="PEEKW">,
5203 <ref id="peekbsys" name="peekbsys">,
5204 <ref id="pokebsys" name="pokebsys">,
5205 <ref id="pokewsys" name="pokewsys">
5211 <sect1>perror<label id="perror"><p>
5215 <tag/Function/Print an error message for the error in <tt/errno/.
5216 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
5217 <tag/Declaration/<tt/void __fastcall__ perror (const char* s);/
5218 <tag/Description/<tt/perror/ prints an error message to <tt/stderr/. If <tt/s/
5219 is not <tt/NULL/ and not an empty string, it is printed followed by a colon and
5220 a blank. Then the error message for the current contents of <tt/errno/ is
5221 printed followed by a newline. The message output is the same as returned by
5222 <tt/<ref id="strerror" name="strerror">/ with an argument of <tt/errno/.
5223 <tag/Notes/<itemize>
5224 <item>The function is only available as fastcall function, so it may only
5225 be used in presence of a prototype.
5227 <tag/Availability/ISO 9899
5229 <ref id="_poserror" name="_poserror">,
5230 <ref id="strerror" name="strerror">
5236 <sect1>pokebsys<label id="pokebsys"><p>
5240 <tag/Function/Write one byte to a location in the system bank.
5241 <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/,
5242 <tt/<ref id="cbm510.h" name="cbm510.h">/
5243 <tag/Declaration/<tt/void __fastcall__ pokebsys (unsigned addr, unsigned char val);/
5244 <tag/Description/<tt/pokebsys/ writes one byte to the given address in the
5245 system bank (bank 15) of the CBM PET-II machines.
5246 <tag/Notes/<itemize>
5247 <item>The function is only available as fastcall function, so it may only
5248 be used in presence of a prototype.
5250 <tag/Availability/cc65
5252 <ref id="POKE" name="POKE">,
5253 <ref id="POKEW" name="POKEW">,
5254 <ref id="peekbsys" name="peekbsys">,
5255 <ref id="peekwsys" name="peekwsys">,
5256 <ref id="pokewsys" name="pokewsys">
5262 <sect1>pokewsys<label id="pokewsys"><p>
5266 <tag/Function/Write one word to a location in the system bank.
5267 <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/,
5268 <tt/<ref id="cbm510.h" name="cbm510.h">/
5269 <tag/Declaration/<tt/void __fastcall__ pokewsys (unsigned addr, unsigned val);/
5270 <tag/Description/<tt/pokewsys/ writes one word to the given address in the
5271 system bank (bank 15) of the CBM PET-II machines. Following the usual 6502
5272 conventions, the low byte of <tt/val/ is written to <tt/addr/, and the
5273 high byte is written to <tt/addr+1/.
5274 <tag/Notes/<itemize>
5275 <item>The function is only available as fastcall function, so it may only
5276 be used in presence of a prototype.
5277 <item>The order in which the two bytes are written is undefined.
5279 <tag/Availability/cc65
5281 <ref id="POKE" name="POKE">,
5282 <ref id="POKEW" name="POKEW">,
5283 <ref id="peekbsys" name="peekbsys">,
5284 <ref id="peekwsys" name="peekwsys">,
5285 <ref id="pokebsys" name="pokebsys">
5291 <sect1>qsort<label id="qsort"><p>
5295 <tag/Function/Sort an array.
5296 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
5297 <tag/Declaration/<tt/void __fastcall__ qsort (void* base, size_t count,
5298 size_t size, int __fastcall__ (* compare) (const void*, const void*));/
5299 <tag/Description/<tt/qsort/ sorts an array according to a given compare
5300 function <tt/compare/. <tt/base/ is the address of the array, <tt/count/
5301 is the number of elements, <tt/size/ the size of an element and <tt/compare/
5302 the function used to compare the members.
5303 <tag/Notes/<itemize>
5304 <item>If there are multiple members with the same key, the order after calling
5305 the function is undefined.
5306 <item>The function is only available as fastcall function, so it may only
5307 be used in presence of a prototype.
5308 <item>The function to which <tt/compare/ points must have the <tt/fastcall/
5311 <tag/Availability/ISO 9899
5313 <ref id="bsearch" name="bsearch">
5319 <sect1>raise<label id="raise"><p>
5323 <tag/Function/Send a signal to the executing program.
5324 <tag/Header/<tt/<ref id="signal.h" name="signal.h">/
5325 <tag/Declaration/<tt/int __fastcall__ raise (int sig);/
5326 <tag/Description/<tt/raise/ sends the given signal to the program. If the
5327 program has installed a signal handler for the signal, this signal handler
5328 will be executed. If no handler has been installed, the default action for
5329 the raised signal will be taken. The function returns zero on success,
5331 <tag/Notes/<itemize>
5332 <item>The function is only available as fastcall function, so it may only
5333 be used in presence of a prototype.
5335 <tag/Availability/ISO 9899
5337 <ref id="abort" name="abort">,
5338 <ref id="signal" name="signal">
5344 <sect1>rand<label id="rand"><p>
5348 <tag/Function/Return a pseudo random number.
5349 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
5350 <tag/Declaration/<tt/int rand (void);/
5351 <tag/Description/The function returns a pseudo random number
5352 between 0 and <tt/RAND_MAX/ (exclusive).
5353 <tag/Notes/<itemize>
5354 <item>Without using <tt><ref id="srand" name="srand"></tt>, always the same
5355 flow of numbers is generated.
5356 <item>On startup, the function behaves as if <ref id="srand" name="srand">
5357 had been used with an argument of 1.
5359 <tag/Availability/ISO 9899
5361 <ref id="_randomize" name="_randomize">,
5362 <ref id="srand" name="srand">
5368 <sect1>readdir<label id="readdir"><p>
5372 <tag/Function/Read a directory.
5373 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
5374 <tag/Declaration/<tt/struct dirent* __fastcall__ readdir (DIR* dir);/
5375 <tag/Description/<tt/readdir/ reads the next directory entry from the directory
5376 stream pointed to by <tt/dir/. It stores the data in a <tt/dirent/ structure
5377 and returns a pointer to it. If the end of directory is reached, or an error
5378 occurs, NULL is returned. In case of errors, an error code is stored into
5380 <tag/Notes/<itemize>
5381 <item>The function is only available as fastcall function, so it may only
5382 be used in presence of a prototype.
5383 <item>The returned pointer may point to a statically allocated instance of
5384 <tt/struct dirent/, so it may get overwritten by subsequent calls to
5386 <item>On several platforms, namely the CBMs and the Atari, the disk drives get
5387 confused when opening/closing files between directory reads. So for example a
5388 program that reads the list of files on a disk, and after each call to
5389 <tt/readdir/, opens the file to process it, will fail.<newline>
5390 Possible solutions are reading the directory into memory before processing the
5391 file list, or to reset the directory by seeking to the correct position after
5392 opening/closing a file:
5394 seekdir (DIR, telldir (DIR));
5396 Platforms known to work without problems are: Apple.
5398 <tag/Availability/POSIX 1003.1
5400 <ref id="closedir" name="closedir">,
5401 <ref id="opendir" name="opendir">
5407 <sect1>realloc<label id="realloc"><p>
5411 <tag/Function/Change the size of an allocated memory block.
5412 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
5413 <tag/Declaration/<tt/void* __fastcall__ realloc (void* block, size_t size);/
5414 <tag/Description/<tt/realloc/ changes the size of the memory block pointed to
5415 by <tt/block/ to <tt/size/ bytes. If <tt/block/ is <tt/NULL/, <tt/realloc/
5416 behaves as if <tt/malloc/ had been called. If <tt/size/ is zero, <tt/realloc/
5417 behaves as if <tt/free/ had been called. On error (not enough memory
5418 available), <tt/realloc/ returns <tt/NULL/.
5419 <tag/Notes/<itemize>
5420 <item>The part of the memory block that is returned will have its contents
5422 <item>This function is somewhat dangerous to use. Be careful to save the
5423 pointer you're passing somewhere else, otherwise
5425 ptr = realloc (ptr, size);
5427 will loose your only copy of <tt/ptr/ if <tt/realloc/ returns <tt/NULL/.
5428 <item>The function is only available as fastcall function, so it may only
5429 be used in presence of a prototype.
5431 <tag/Availability/ISO 9899
5433 <ref id="_heapadd" name="_heapadd">,
5434 <ref id="_heapblocksize" name="_heapblocksize">,
5435 <ref id="_heapmaxavail" name="_heapmaxavail">,
5436 <ref id="_heapmemavail" name="_heapmemavail">,
5437 <ref id="calloc" name="calloc">,
5438 <ref id="free" name="free">,
5439 <ref id="realloc" name="realloc">
5445 <sect1>remove<label id="remove"><p>
5449 <tag/Function/Delete a file.
5450 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
5451 <tag/Declaration/<tt/int __fastcall__ remove (const char* name);/
5452 <tag/Description/<tt/remove/ deletes the file with the given name. On success,
5453 zero is returned. On error, -1 is returned and <tt/errno/ is set to an error
5454 code describing the reason for the failure.
5455 <tag/Notes/<itemize>
5456 <item>This function is not available on all cc65 targets (depends on the
5457 availability of file I/O).
5458 <item>The function is only available as fastcall function, so it may only
5459 be used in presence of a prototype.
5461 <tag/Availability/ISO 9899
5463 <ref id="rename" name="rename">,
5464 <ref id="unlink" name="unlink">
5467 #include <stdio.h>
5469 #define FILENAME "helloworld"
5471 if (remove (FILENAME) == 0) {
5472 printf ("We deleted %s successfully\n", FILENAME);
5474 printf ("There was a problem deleting %s\n", FILENAME);
5481 <sect1>rename<label id="rename"><p>
5485 <tag/Function/Rename a file.
5486 <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/
5487 <tag/Declaration/<tt/int __fastcall__ rename (const char* oldname, const char* newname);/
5488 <tag/Description/<tt/rename/ renames a file (gives it a new name). On success,
5489 zero is returned. On error, -1 is returned and <tt/errno/ is set to an error
5490 code describing the reason for the failure.
5491 <tag/Notes/<itemize>
5492 <item>This function is not available on all cc65 targets (depends on the
5493 capabilities of the storage devices).
5494 <item>The function is only available as fastcall function, so it may only
5495 be used in presence of a prototype.
5497 <tag/Availability/ISO 9899
5499 <ref id="remove" name="remove">
5502 #include <stdio.h>
5504 #define OLDNAME "textfile.txt"
5505 #define NEWNAME "textfile.bak"
5507 if (rename (OLDNAME, NEWNAME) == 0) {
5508 printf ("Renamed %s to %s\n", OLDNAME, NEWNAME);
5510 printf ("Error renaming %s to %s\n", OLDNAME, NEWNAME);
5517 <sect1>reset_brk<label id="reset_brk"><p>
5521 <tag/Function/Resets the break vector to its original value.
5522 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
5523 <tag/Declaration/<tt/void reset_brk (void);/
5524 <tag/Description/<tt/reset_brk/ resets the break vector to the value it had
5525 before a call to <tt/set_brk/.
5526 <tag/Notes/<itemize>
5527 <item>The break vector is reset on program termination, so it's not strictly
5528 necessary to call this function as a part of your clean-up when exitting the program.
5530 <tag/Availability/cc65
5532 <ref id="reset_irq" name="reset_irq">,
5533 <ref id="set_brk" name="set_brk">,
5534 <ref id="set_irq" name="set_irq">
5540 <sect1>reset_irq<label id="reset_irq"><p>
5544 <tag/Function/Resets the C level interrupt request vector.
5545 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
5546 <tag/Declaration/<tt/void reset_irq (void);/
5547 <tag/Description/<tt/reset_irq/ resets the C level interrupt request vector.
5548 <tag/Notes/<itemize>
5549 <item>The interrupt vector is reset on program termination, so it's not strictly
5550 necessary to call this function as a part of your clean-up when exitting the program.
5552 <tag/Availability/cc65
5554 <ref id="reset_brk" name="reset_brk">,
5555 <ref id="set_brk" name="set_brk">,
5556 <ref id="set_irq" name="set_irq">
5562 <sect1>revers<label id="revers"><p>
5566 <tag/Function/Control revers character display.
5567 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
5568 <tag/Declaration/<tt/unsigned char __fastcall__ revers (unsigned char onoff);/
5569 <tag/Description/If the argument is non zero, the function enables reverse
5570 character display. If the argument is zero, reverse character display is
5571 switched off. The old value of the setting is returned.
5572 <tag/Notes/<itemize>
5573 <item>The function may not be supported by the hardware, in which case
5574 the call is ignored.
5575 <item>The function is only available as fastcall function, so it may only
5576 be used in presence of a prototype.
5578 <tag/Availability/cc65
5580 <ref id="textcolor" name="textcolor">
5586 <sect1>rewinddir<label id="rewinddir"><p>
5590 <tag/Function/Reset a directory stream.
5591 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
5592 <tag/Declaration/<tt/void __fastcall__ rewinddir (DIR* dir);/
5593 <tag/Description/<tt/rewinddir/ sets the position of the directory stream
5594 pointed to by <tt/dir/ to the start of the directory.
5595 <tag/Notes/<itemize>
5596 <item>The function is only available as fastcall function, so it may only
5597 be used in presence of a prototype.
5599 <tag/Availability/POSIX 1003.1
5601 <ref id="seekdir" name="seekdir">,
5602 <ref id="telldir" name="telldir">
5608 <sect1>screensize<label id="screensize"><p>
5612 <tag/Function/Return the dimensions of the text mode screen.
5613 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
5614 <tag/Declaration/<tt/void __fastcall__ screensize (unsigned char* x, unsigned char* y);/
5615 <tag/Description/The function returns the dimensions of the text mode screen.
5616 <tag/Notes/<itemize>
5617 <item>The function is only available as fastcall function, so it may only
5618 be used in presence of a prototype.
5620 <tag/Availability/cc65
5622 <ref id="gotox" name="gotox">,
5623 <ref id="gotoxy" name="gotoxy">,
5624 <ref id="gotoy" name="gotoy">,
5625 <ref id="wherex" name="wherex">,
5626 <ref id="wherey" name="wherey">
5632 <sect1>seekdir<label id="seekdir"><p>
5636 <tag/Function/Set the position of a directory stream.
5637 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
5638 <tag/Declaration/<tt/void __fastcall__ seekdir (DIR* dir, long offset);/
5639 <tag/Description/<tt/seekdir/ sets the position of the directory stream
5640 pointed to by <tt/dir/ to the value given in <tt/offset/, which should be a
5641 value returned by <tt/<ref id="telldir" name="telldir">/.
5642 <tag/Notes/<itemize>
5643 <item>The function is only available as fastcall function, so it may only
5644 be used in presence of a prototype.
5646 <tag/Availability/POSIX 1003.1
5648 <ref id="rewinddir" name="rewinddir">,
5649 <ref id="telldir" name="telldir">
5655 <sect1>ser_close<label id="ser_close"><p>
5659 <tag/Function/Close the port and disable interrupts
5660 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5661 <tag/Declaration/<tt/unsigned char ser_close (void);/
5662 <tag/Description/Close the port by clearing buffers and disable interrupts.
5663 <tag/Availability/cc65
5664 <tag/See also/Other serial functions.
5669 static void initialize(){
5670 struct ser_params params = {
5677 ser_install(lynx_comlynx); // This will activate the ComLynx
5679 ser_open(&params);
5686 <sect1>ser_get<label id="ser_get"><p>
5690 <tag/Function/Read a character from serial port.
5691 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5692 <tag/Declaration/<tt/unsigned char __fastcall__ ser_get (char* b);/
5693 <tag/Description/Get a character from the serial port. If no characters are
5694 available, the function will return SER_ERR_NO_DATA, so this is not a fatal
5696 <tag/Notes/<itemize>
5697 <item>The function is only available as fastcall function, so it may only
5698 be used in presence of a prototype.
5700 <tag/Availability/cc65
5701 <tag/See also/Other serial functions.
5703 Wait for a character to be available from a serial port.
5706 while (ser_get(&ch) == SER_ERR_NO_DATA)
5713 <sect1>ser_install<label id="ser_install"><p>
5717 <tag/Function/Install an already loaded driver and return an error code.
5718 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5719 <tag/Declaration/<tt/unsigned char __fastcall__ ser_install (void* driver);/
5720 <tag/Description/The function installs a driver that was already loaded into
5721 memory (or linked statically to the program). It returns an error code
5722 (<tt/SER_ERR_OK/ in case of success).
5723 <tag/Notes/<itemize>
5724 <item>The function is only available as fastcall function, so it may only be
5725 used in presence of a prototype.
5727 <tag/Availability/cc65
5729 <ref id="ser_load_driver" name="ser_load_driver">,
5730 <ref id="ser_uninstall" name="ser_uninstall">,
5731 <ref id="ser_unload" name="ser_unload">
5733 ser_install(lynx_comlynx); //Include the driver statically instead of loading it.
5739 <sect1>ser_ioctl<label id="ser_ioctl"><p>
5743 <tag/Function/Platform dependent code extensions.
5744 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5745 <tag/Declaration/<tt/unsigned __fastcall__ ser_ioctl (unsigned char code, void* data);/
5746 <tag/Description/Some platforms have extra serial functions that are not
5747 supported by standard serial driver functions. You can extend the driver to support
5748 this extra functionality bt using ser_ioctl functions.
5749 <tag/Notes/<itemize>
5750 <item>The function is only available as fastcall function, so it may only
5751 be used in presence of a prototype.
5752 <item>These functions are not easily portable to other cc65 platforms.
5754 <tag/Availability/cc65
5755 <tag/See also/Other serial functions.
5760 <sect1>ser_load_driver<label id="ser_load_driver"><p>
5764 <tag/Function/Load and install a serial driver.
5765 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5766 <tag/Declaration/<tt/unsigned char __fastcall__ ser_load_driver (const char *name);/
5767 <tag/Description/Load and install the driver by name.
5768 Will just load the driver and check if loading was successful.
5769 <tag/Notes/<itemize>
5770 <item>The function is only available as fastcall function, so it may only
5771 be used in presence of a prototype.
5773 <tag/Availability/cc65
5774 <tag/See also/Other serial functions.
5780 <sect1>ser_open<label id="ser_open"><p>
5784 <tag/Function/Open the port by setting the port parameters and enable interrupts
5785 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5786 <tag/Declaration/<tt/unsigned char __fastcall__ ser_open (const struct ser_params* params);/
5787 <tag/Description/Open the port by setting the port parameters and enable interrupts.
5788 <tag/Notes/<itemize>
5789 <item>The function is only available as fastcall function, so it may only
5790 be used in presence of a prototype.
5792 <tag/Availability/cc65
5793 <tag/See also/Other serial functions.
5798 static void initialize(){
5799 struct ser_params params = {
5806 ser_install(lynx_comlynx); // This will activate the ComLynx
5808 ser_open(&params);
5815 <sect1>ser_put<label id="ser_put"><p>
5819 <tag/Function/Write a character to a serial port.
5820 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5821 <tag/Declaration/<tt/unsigned char __fastcall__ ser_put (char b);/
5822 <tag/Description/Send a character via the serial port. There is a transmit
5823 buffer, but transmitting is not done via interrupt. The function returns
5824 SER_ERR_OVERFLOW if there is no space left in the transmit buffer.
5825 <tag/Notes/<itemize>
5826 <item>The function is only available as fastcall function, so it may only
5827 be used in presence of a prototype.
5829 <tag/Availability/cc65
5830 <tag/See also/Other serial functions.
5839 <sect1>ser_status<label id="ser_status"><p>
5843 <tag/Function/Return the serial port status.
5844 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5845 <tag/Declaration/<tt/unsigned char __fastcall__ ser_status (unsigned char* status);/
5846 <tag/Description/Return the serial port status.
5847 <tag/Notes/<itemize>
5848 <item>The function is only available as fastcall function, so it may only
5849 be used in presence of a prototype.
5851 <tag/Availability/cc65
5852 <tag/See also/Other serial functions.
5858 <sect1>ser_uninstall<label id="ser_uninstall"><p>
5862 <tag/Function/Uninstall the currently loaded driver but do not unload it.
5863 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5864 <tag/Declaration/<tt/unsigned char ser_uninstall (void);/
5865 <tag/Description/Uninstall the currently loaded driver but do not unload it.
5866 <tag/Availability/cc65
5867 <tag/See also/Other serial functions.
5872 <sect1>ser_unload<label id="ser_unload"><p>
5876 <tag/Function/Uninstall, then unload the currently loaded driver.
5877 <tag/Header/<tt/<ref id="serial.h" name="serial.h">/
5878 <tag/Declaration/<tt/unsigned char ser_unload (void);/
5879 <tag/Description/Uninstall, then unload the currently loaded driver.
5880 <tag/Availability/cc65
5881 <tag/See also/Other serial functions.
5887 <sect1>set_brk<label id="set_brk"><p>
5891 <tag/Function/Set the break vector to a user function.
5892 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
5893 <tag/Declaration/<tt/void __fastcall__ set_brk (brk_handler func);/
5894 <tag/Description/<tt/set_brk/ allows a user program to handle breaks within the
5895 program code by letting the vector point to a user written C function. The
5896 runtime library installs a small stub that saves the registers into global
5897 variables that may be accessed (and changed) by the break handler.
5898 <tag/Notes/<itemize>
5899 <item>The function is only available as fastcall function, so it may only
5900 be used in presence of a prototype.
5901 <item>The stub saves the zero page registers used by the C runtime and switches
5902 to a small break handler stack. This means that it is safe to execute C code,
5903 even if C code was interrupted. Be careful however not to use too many local
5904 variables, and do not enable stack checks for the handler function or any other
5905 function called from it.
5906 <item>The <tt/brk_pc/ variable points to the <tt/BRK/ instruction. If you want
5907 the continue with the interrupted code, you have to adjust <tt/brk_pc/,
5908 otherwise the <tt/BRK/ instruction will get executed over and over again.
5909 <item>The break vector is reset on program termination, so it's not strictly
5910 necessary to call <tt/<ref id="reset_brk" name="reset_brk">/ as a part of your
5911 clean-up when exitting the program.
5913 <tag/Availability/cc65
5915 <ref id="reset_brk" name="reset_brk">
5921 <sect1>set_irq<label id="set_irq"><p>
5925 <tag/Function/Set the C level interrupt request vector to the given address.
5926 <tag/Header/<tt/<ref id="6502.h" name="6502.h">/
5927 <tag/Declaration/<tt/void __fastcall__ set_irq (irq_handler f, void *stack_addr, size_t stack_size);/
5928 <tag/Description/<tt/set_irq/ allows a user program to handle interrupt requests
5929 (IRQs) within the program code by letting the vector point to a user written C
5930 function. The runtime library installs a small stub that saves the zero page
5931 registers used by the C runtime before calling the handler function and restores
5932 them after the handler function returns. Additionally the stub temporarily switches
5933 the C runtime stack to the stack area provided as parameter. If the handler function
5934 was set up to handle a "private", "exclusive" interrupt request source it must
5935 return the value <tt/IRQ_HANDLED/ if and only if it has verified that the current
5936 interrupt request actually stems from that source. In all other cases it must return
5937 the value <tt/IRQ_NOT_HANDLED/.
5938 <tag/Notes/<itemize>
5939 <item>The function is only available as fastcall function, so it may only
5940 be used in presence of a prototype.
5941 <item>The stub saves the registers and zero page locations used by the C runtime
5942 and switches to the provided stack area. As a consequence, there is some
5943 runtime overhead, but it it is safe to execute C code, even if other C code
5944 was interrupted. Be careful however not to call C library functions, and do not
5945 enable stack checks for the handler function or any other function called from
5947 <item>The interrupt vector is reset on program termination, so it's not strictly
5948 necessary to call <tt/<ref id="reset_irq" name="reset_irq">/ as a part of your
5949 clean-up when exitting the program.
5951 <tag/Availability/cc65
5953 <ref id="reset_brk" name="reset_brk">,
5954 <ref id="reset_irq" name="reset_irq">,
5955 <ref id="set_brk" name="set_brk">
5961 <sect1>setjmp<label id="setjmp"><p>
5965 <tag/Function/Save the context for use with <tt/longjmp/.
5966 <tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/
5967 <tag/Declaration/<tt/int __fastcall__ setjmp (jmp_buf buf);/
5968 <tag/Description/The <tt/setjmp/ function saves the current context in <tt/buf/
5969 for subsequent use by the <tt/<ref id="longjmp" name="longjmp">/ function and
5971 <tag/Notes/<itemize>
5972 <item>The function is only available as fastcall function, so it may only
5973 be used in presence of a prototype.
5974 <item><tt/setjmp/ is actually a macro as required by the ISO standard.
5975 <item><tt/setjmp/ will not save the signal context.
5977 <tag/Availability/ISO 9899
5979 <ref id="longjmp" name="longjmp">
5985 <sect1>setlocale<label id="setlocale"><p>
5989 <tag/Function/Selects a locale.
5990 <tag/Header/<tt/<ref id="locale.h" name="locale.h">/
5991 <tag/Declaration/<tt/char* __fastcall__ setlocale (int category, const char* locale);/
5992 <tag/Description/<tt/setlocale/ sets or queries the program's locale.
5993 <tag/Notes/<itemize>
5994 <item>The function is only available as fastcall function, so it may only
5995 be used in presence of a prototype.
5996 <item>cc65 supports only the "C" locale, so calling this function to set a
5997 different locale has no effect.
5999 <tag/Availability/ISO 9899
6001 <ref id="localeconv" name="localeconv">,
6002 <ref id="strcoll" name="strcoll">
6003 <ref id="strxfrm" name="strxfrm">
6009 <sect1>signal<label id="signal"><p>
6013 <tag/Function/Install a signal handler.
6014 <tag/Header/<tt/<ref id="signal.h" name="signal.h">/
6015 <tag/Declaration/<tt/__sigfunc __fastcall__ signal (int sig, __sigfunc func);/
6016 <tag/Description/<tt/signal/ installs a handler for the given signal. The
6017 handler may either be a user supplied function, or one of the predefined
6018 signal handlers <tt/SIG_IGN/ or <tt/SIG_DFL/. The function returns the
6019 previous value if the signal , or the special function vector SIG_ERR in
6021 <tag/Notes/<itemize>
6022 <item>The function is only available as fastcall function, so it may only
6023 be used in presence of a prototype.
6025 <tag/Availability/ISO 9899
6027 <ref id="abort" name="abort">,
6028 <ref id="raise" name="raise">
6034 <sect1>sleep<label id="sleep"><p>
6038 <tag/Function/Sleep for a specified amount of time.
6039 <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/
6040 <tag/Declaration/<tt/void __fastcall__ sleep (unsigned seconds);/
6041 <tag/Description/The function will return after the specified number of
6042 seconds have elapsed.
6043 <tag/Notes/<itemize>
6044 <item>The function is only available as fastcall function, so it may only
6045 be used in presence of a prototype.
6047 <tag/Availability/POSIX 1003.1
6053 <sect1>slow<label id="slow"><p>
6057 <tag/Function/Switch the C128 into 1MHz mode.
6058 <tag/Header/<tt/<ref id="c128.h" name="c128.h">/
6059 <tag/Declaration/<tt/void slow (void);/
6060 <tag/Description/The function will switch the clock of the C128 to 1MHz. This
6061 will halve the speed compared to fast mode.
6062 <tag/Notes/<itemize>
6063 <item>The function is specific to the C128.
6065 <tag/Availability/C128
6067 <ref id="fast" name="fast">,
6068 <ref id="toggle_videomode" name="toggle_videomode">,
6069 <ref id="videomode" name="videomode">
6075 <sect1>srand<label id="srand"><p>
6079 <tag/Function/Initialize the pseudo random number generator.
6080 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
6081 <tag/Declaration/<tt/void __fastcall__ srand (unsigned seed);/
6082 <tag/Description/The function initializes the random number generator using
6083 the given seed. On program startup, the generator behaves as if <tt/srand/ has
6084 been called with an argument of 1.
6085 <tag/Notes/<itemize>
6086 <item>The function is only available as fastcall function, so it may only
6087 be used in presence of a prototype.
6089 <tag/Availability/ISO 9899
6091 <ref id="_randomize" name="_randomize">,
6092 <ref id="rand" name="rand">
6098 <sect1>strcasecmp<label id="strcasecmp"><p>
6102 <tag/Function/Compare two strings case insensitive.
6103 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6104 <tag/Declaration/<tt/int __fastcall__ strcasecmp (const char* s1, const char* s2);/
6105 <tag/Description/The <tt/strcasecmp/ function compares the two strings passed
6106 as parameters without case sensitivity. It returns a value that is less than
6107 zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/,
6108 and a value greater than zero if <tt/s1/ is greater than <tt/s2/.
6109 <tag/Notes/<itemize>
6110 <item>The function is only available as fastcall function, so it may only
6111 be used in presence of a prototype.
6112 <item>The function is not available in strict ANSI mode.
6114 <tag/Availability/cc65
6116 <ref id="strcmp" name="strcmp">,
6117 <ref id="strcoll" name="strcoll">,
6118 <ref id="stricmp" name="stricmp">,
6119 <ref id="strncmp" name="strncmp">,
6120 <ref id="strxfrm" name="strxfrm">
6126 <sect1>strcat<label id="strcat"><p>
6130 <tag/Function/Concatentate two strings.
6131 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6132 <tag/Declaration/<tt/char* __fastcall__ strcat (char* s1, const char* s2);/
6133 <tag/Description/The <tt/strcat/ function appends a copy of the string
6134 pointed to by s2 (including the terminating null byte) to the end of the
6135 string pointed to by s1. The initial byte of s2 overwrites the null byte at
6137 <tag/Notes/<itemize>
6138 <item>The function is only available as fastcall function, so it may only
6139 be used in presence of a prototype.
6140 <item>If copying takes place between objects that overlap, the behaviour
6143 <tag/Availability/ISO 9899
6145 <ref id="strcpy" name="strcpy">,
6146 <ref id="strncat" name="strncat">,
6147 <ref id="strncpy" name="strncpy">
6153 <sect1>strchr<label id="strchr"><p>
6157 <tag/Function/Search for a character in a string.
6158 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6159 <tag/Declaration/<tt/char* __fastcall__ strchr (const char* s, int c);/
6160 <tag/Description/The <tt/strchr/ function locates the first occurrence of <tt/c/
6161 (converted to a char) in the string pointed to by <tt/s/. The terminating null
6162 byte is considered to be part of the string. Upon completion, the function
6163 returns a pointer to the byte, or a null pointer if the byte was not found.
6164 <tag/Notes/<itemize>
6165 <item>The function is only available as fastcall function, so it may only
6166 be used in presence of a prototype.
6168 <tag/Availability/ISO 9899
6170 <ref id="memchr" name="memchr">,
6171 <ref id="strrchr" name="strrchr">
6177 <sect1>strcmp<label id="strcmp"><p>
6181 <tag/Function/Compare two strings.
6182 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6183 <tag/Declaration/<tt/int __fastcall__ strcmp (const char* s1, const char* s2);/
6184 <tag/Description/The <tt/strcmp/ function compares the two strings passed as
6185 parameters. It returns a value that is less than zero if <tt/s1/ is less than
6186 <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater than zero
6187 if <tt/s1/ is greater than <tt/s2/.
6188 <tag/Notes/<itemize>
6189 <item>The function is only available as fastcall function, so it may only
6190 be used in presence of a prototype.
6192 <tag/Availability/ISO 9899
6194 <ref id="strcasecmp" name="strcasecmp">,
6195 <ref id="strcoll" name="strcoll">,
6196 <ref id="stricmp" name="stricmp">,
6197 <ref id="strncmp" name="strncmp">
6198 <ref id="strxfrm" name="strxfrm">
6204 <sect1>strcoll<label id="strcoll"><p>
6208 <tag/Function/Compare two strings.
6209 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6210 <tag/Declaration/<tt/int __fastcall__ strcoll (const char* s1, const char* s2);/
6211 <tag/Description/The <tt/strcoll/ function compares the two strings passed as
6212 parameters, according to the collating sequence set by <tt/<ref id="setlocale"
6213 name="setlocale">/. It returns a value that is less than zero if <tt/s1/ is
6214 less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater
6215 than zero if <tt/s1/ is greater than <tt/s2/.
6216 <tag/Notes/<itemize>
6217 <item>The function is only available as fastcall function, so it may only
6218 be used in presence of a prototype.
6220 <tag/Availability/ISO 9899
6222 <ref id="setlocale" name="setlocale">,
6223 <ref id="strcasecmp" name="strcasecmp">,
6224 <ref id="strcmp" name="strcmp">,
6225 <ref id="stricmp" name="stricmp">,
6226 <ref id="strncmp" name="strncmp">,
6227 <ref id="strxfrm" name="strxfrm">
6233 <sect1>strcpy<label id="strcpy"><p>
6237 <tag/Function/Copy a string.
6238 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6239 <tag/Declaration/<tt/char* __fastcall__ strcpy (char* s1, const char* s2);/
6240 <tag/Description/The <tt/strcpy/ function copies the string pointed to by
6241 <tt/s2/ (including the terminating null byte) into the array pointed to by
6242 <tt/s1/. The function will always return <tt/s1/.
6243 <tag/Notes/<itemize>
6244 <item>The function is only available as fastcall function, so it may only
6245 be used in presence of a prototype.
6246 <item>If copying takes place between objects that overlap, the behaviour
6249 <tag/Availability/ISO 9899
6251 <ref id="strcat" name="strcat">,
6252 <ref id="strncat" name="strncat">,
6253 <ref id="strncpy" name="strncpy">
6256 #include <string.h>
6258 static char hello[14];
6260 strcpy (hello, "Hello world!\n");
6266 <sect1>strcspn<label id="strcspn"><p>
6270 <tag/Function/Compute the length of a substring.
6271 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6272 <tag/Declaration/<tt/size_t __fastcall__ strcspn (const char* s, const char* set);/
6273 <tag/Description/The <tt/strcspn/ function computes and returns the length of
6274 the substring pointed to by <tt/s/ which does <em>not</em> consist of
6275 characters contained in the string <tt/set/.
6276 <tag/Notes/<itemize>
6277 <item>The function is only available as fastcall function, so it may only
6278 be used in presence of a prototype.
6280 <tag/Availability/ISO 9899
6282 <ref id="strqtok" name="strqtok">,
6283 <ref id="strspn" name="strspn">,
6284 <ref id="strstr" name="strstr">,
6285 <ref id="strtok" name="strtok">
6291 <sect1>strdup<label id="strdup"><p>
6295 <tag/Function/Allocate a copy of a string on the heap.
6296 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6297 <tag/Declaration/<tt/char* __fastcall__ strdup (const char* s);/
6298 <tag/Description/<tt/strdup/ allocates a memory block on the heap, big enough
6299 to hold a copy of <tt/s/ including the terminating zero. If the allocation
6300 fails, <tt/NULL/ is returned, otherwise <tt/s/ is copied into the allocated
6301 memory block, and a pointer to the block is returned.
6302 <tag/Notes/<itemize>
6303 <item>The function is only available as fastcall function, so it may only
6304 be used in presence of a prototype.
6305 <item>It is up to the caller to free the allocated memory block.
6307 <tag/Availability/ISO 9899
6309 <ref id="free" name="free">,
6310 <ref id="malloc" name="malloc">
6316 <sect1>strerror<label id="strerror"><p>
6320 <tag/Function/Return a string describing an error code.
6321 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6322 <tag/Declaration/<tt/char* __fastcall__ strerror (int errcode);/
6323 <tag/Description/The <tt/strerror/ function returns a string describing the
6324 given error code. If an invalid error code is passed, the string "Unknown
6325 error" is returned, and <tt/errno/ is set to <tt/EINVAL/. In all other cases,
6326 <tt/errno/ is left untouched.
6327 <tag/Notes/<itemize>
6328 <item>The function is only available as fastcall function, so it may only
6329 be used in presence of a prototype.
6330 <item>While the return type of the function is a <tt/char*/, the returned
6331 string must not be modified by the caller!
6333 <tag/Availability/ISO 9899
6335 <ref id="_stroserror" name="_stroserror">
6341 <sect1>stricmp<label id="stricmp"><p>
6345 <tag/Function/Compare two strings case insensitive.
6346 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6347 <tag/Declaration/<tt/int __fastcall__ stricmp (const char* s1, const char* s2);/
6348 <tag/Description/The <tt/stricmp/ function compares the two strings passed as
6349 parameters without case sensitivity. It returns a value that is less than zero
6350 if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a
6351 value greater than zero if <tt/s1/ is greater than <tt/s2/.
6352 <tag/Notes/<itemize>
6353 <item>The function is only available as fastcall function, so it may only
6354 be used in presence of a prototype.
6355 <item>The function is not available in strict ANSI mode.
6357 <tag/Availability/cc65
6359 <ref id="strcasecmp" name="strcasecmp">,
6360 <ref id="strcmp" name="strcmp">,
6361 <ref id="strcoll" name="strcoll">,
6362 <ref id="strncmp" name="strncmp">,
6363 <ref id="strxfrm" name="strxfrm">
6369 <sect1>strlen<label id="strlen"><p>
6373 <tag/Function/Return the length of a string.
6374 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6375 <tag/Declaration/<tt/size_t __fastcall__ strlen (const char* s);/
6376 <tag/Description/The <tt/strlen/ function computes the number of bytes in the
6377 string to which s points, not including the terminating null byte.
6378 <tag/Notes/<itemize>
6379 <item>The function is only available as fastcall function, so it may only
6380 be used in presence of a prototype.
6381 <item>When compiling with <tt/-Os/ (inline known standard functions), the
6382 function does not work correctly for strings with more than 255 characters.
6384 <tag/Availability/ISO 9899
6386 <ref id="strcpy" name="strcpy">
6392 <sect1>strlower<label id="strlower"><p>
6396 <tag/Function/Make a string lower case.
6397 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6398 <tag/Declaration/<tt/char* __fastcall__ strlower (char* s);/
6399 <tag/Description/The <tt/strlower/ function will apply the <tt/tolower/
6400 function to each character of a string. The function will always return <tt/s/.
6401 <tag/Notes/<itemize>
6402 <item>The function is only available as fastcall function, so it may only
6403 be used in presence of a prototype.
6404 <item>The function prototype is unavailable when compiling in strict ANSI mode.
6405 <item>An alias name for this function is <tt/strlwr/.
6407 <tag/Availability/cc65
6409 <ref id="strupper" name="strupper">,
6410 <ref id="tolower" name="tolower">
6416 <sect1>strlwr<label id="strlwr"><p>
6423 <sect1>strncasecmp<label id="strncasecmp"><p>
6427 <tag/Function/Compare two strings case insensitive.
6428 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6429 <tag/Declaration/<tt/int __fastcall__ strncasecmp (const char* s1, const char* s2, size_t count);/
6430 <tag/Description/The <tt/strncasecmp/ function compares the two strings passed
6431 as parameters without case sensitivity. It returns a value that is less than
6432 zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/,
6433 and a value greater than zero if <tt/s1/ is greater than <tt/s2/.
6434 <tag/Notes/<itemize>
6435 <item>The function is only available as fastcall function, so it may only
6436 be used in presence of a prototype.
6437 <item>The function is not available in strict ANSI mode.
6439 <tag/Availability/cc65
6441 <ref id="strcmp" name="strcmp">,
6442 <ref id="strcoll" name="strcoll">,
6443 <ref id="stricmp" name="stricmp">,
6444 <ref id="strncmp" name="strncmp">,
6445 <ref id="strxfrm" name="strxfrm">
6451 <sect1>strncat<label id="strncat"><p>
6455 <tag/Function/Concatentate two strings.
6456 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6457 <tag/Declaration/<tt/char* __fastcall__ strncat (char* s1, const char* s2, size_t n);/
6458 <tag/Description/The <tt/strncat/ function appends not more than n characters
6459 of the string pointed to by s2 to the end of the string pointed to by s1. The
6460 terminating null character at the end of s1 is overwritten. A terminating null
6461 character is appended to the result, even if not all of s2 is appended to s1.
6462 <tag/Notes/<itemize>
6463 <item>The function is only available as fastcall function, so it may only
6464 be used in presence of a prototype.
6465 <item>If copying takes place between objects that overlap, the behaviour
6468 <tag/Availability/ISO 9899
6470 <ref id="strcpy" name="strcpy">,
6471 <ref id="strncat" name="strncat">,
6472 <ref id="strncpy" name="strncpy">
6478 <sect1>strncmp<label id="strncmp"><p>
6482 <tag/Function/Compare two strings.
6483 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6484 <tag/Declaration/<tt/int __fastcall__ strncmp (const char* s1, const char* s2, size_t count);/
6485 <tag/Description/The <tt/strncmp/ function compares not more than <tt/count/
6486 characters of the two strings passed as parameters. It returns a value that is
6487 less than zero if the first <tt/count/ characters of <tt/s1/ are less than
6488 <tt/s2/, zero if they are identical, and a value greater than zero they are
6490 <tag/Notes/<itemize>
6491 <item>The function is only available as fastcall function, so it may only
6492 be used in presence of a prototype.
6494 <tag/Availability/ISO 9899
6496 <ref id="strcasecmp" name="strcasecmp">,
6497 <ref id="strcmp" name="strcmp">,
6498 <ref id="strcoll" name="strcoll">,
6499 <ref id="stricmp" name="stricmp">,
6500 <ref id="strxfrm" name="strxfrm">
6506 <sect1>strncpy<label id="strncpy"><p>
6510 <tag/Function/Copy part of a string.
6511 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6512 <tag/Declaration/<tt/char* __fastcall__ strncpy (char* s1, const char* s2, size_t n);/
6513 <tag/Description/The <tt/strncpy/ function copies not more than <tt/n/ bytes from
6514 the array pointed to by <tt/s2/ to the array pointed to by <tt/s1/. If the array
6515 pointed to by <tt/s2/ is a string that is shorter than <tt/n/ bytes, null bytes are
6516 appended to the copy in the array pointed to by <tt/s1/, until <tt/n/ bytes are
6517 written. The function always will return <tt/s1/.
6518 <tag/Notes/<itemize>
6519 <item>The function is available only as a fastcall function; so, it may be used
6520 only in the presence of a prototype.
6521 <item>If there is no null byte in the first <tt/n/ bytes of the array pointed
6522 to by <tt/s2/, the result is <em/not/ null-terminated!
6523 <item>If copying takes place between objects that overlap, the behaviour is
6526 <tag/Availability/ISO 9899
6528 <ref id="memcpy" name="memcpy">,
6529 <ref id="strcat" name="strcat">,
6530 <ref id="strcpy" name="strcpy">,
6531 <ref id="strncat" name="strncat">
6536 static char hello[6];
6538 strncpy (hello, "Hello world!\n", sizeof hello - 1)[5] = '\0';
6544 <sect1>strnicmp<label id="strnicmp"><p>
6548 <tag/Function/Compare two strings case insensitive.
6549 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6550 <tag/Declaration/<tt/int __fastcall__ strnicmp (const char* s1, const char* s2, size_t count);/
6551 <tag/Description/The <tt/strnicmp/ function compares the two strings passed as
6552 parameters without case sensitivity. It returns a value that is less than zero
6553 if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a
6554 value greater than zero if <tt/s1/ is greater than <tt/s2/.
6555 <tag/Notes/<itemize>
6556 <item>The function is only available as fastcall function, so it may only
6557 be used in presence of a prototype.
6558 <item>The function is not available in strict ANSI mode.
6560 <tag/Availability/cc65
6562 <ref id="strcasecmp" name="strcasecmp">,
6563 <ref id="strcmp" name="strcmp">,
6564 <ref id="strcoll" name="strcoll">,
6565 <ref id="strncmp" name="strncmp">,
6566 <ref id="strxfrm" name="strxfrm">
6572 <sect1>strqtok<label id="strqtok"><p>
6576 <tag/Function/Break a string into tokens.
6577 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6578 <tag/Declaration/<tt/char* __fastcall__ strqtok (char* s1, const char* s2);/
6579 <tag/Description/<tt/strqtok()/ will break the string <tt/s1/ into a sequence of
6580 tokens, which are delimited by either quotation marks or characters from the
6581 string <tt/s2/. Tokens inside quotation marks may contain characters from <tt/s2/
6582 (they aren't delimiters there). The first call to <tt/strqtok()/ will return a
6583 pointer to the first token in the string <tt/s1/. The following calls must pass
6584 a <tt/NULL/ pointer as <tt/s1/, in order to get the next token in the string.
6585 Different sets of delimiters may be used for the subsequent calls to <tt/strqtok()/.
6586 <tag/Notes/<itemize>
6587 <item>The function is available only as a fastcall function; so, it may be used
6588 only in the presence of a prototype.
6589 <item><tt/strqtok()/ will modify the string <tt/s1/.
6590 <item>The function will forget where it is in the <tt/s1/ string if it is given
6591 a second <tt/s1/ string before it finishes the first one.
6593 <tag/Availability/cc65
6595 <ref id="strcspn" name="strcspn">,
6596 <!-- <ref id="strpbrk" name="strpbrk">, -->
6597 <ref id="strspn" name="strspn">,
6598 <ref id="strtok" name="strtok">
6604 <sect1>strrchr<label id="strrchr"><p>
6608 <tag/Function/Search for a character in a string.
6609 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6610 <tag/Declaration/<tt/char* __fastcall__ strrchr (const char* s, int c);/
6611 <tag/Description/The <tt/strrchr/ function locates the last occurrence of <tt/c/
6612 (converted to a char) in the string pointed to by <tt/s/. The terminating null
6613 byte is considered to be part of the string. Upon completion, the function
6614 returns a pointer to the byte, or a null pointer if the byte was not found.
6615 <tag/Notes/<itemize>
6616 <item>The function is only available as fastcall function, so it may only
6617 be used in presence of a prototype.
6619 <tag/Availability/ISO 9899
6621 <ref id="strchr" name="strchr">
6627 <sect1>strspn<label id="strspn"><p>
6631 <tag/Function/Compute the length of a substring.
6632 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6633 <tag/Declaration/<tt/size_t __fastcall__ strspn (const char* s, const char* set);/
6634 <tag/Description/The <tt/strspn/ function computes and returns the length of
6635 the substring pointed to by <tt/s/ which does consist only of characters
6636 contained in the string <tt/set/.
6637 <tag/Notes/<itemize>
6638 <item>The function is only available as fastcall function, so it may only
6639 be used in presence of a prototype.
6641 <tag/Availability/ISO 9899
6643 <ref id="strcspn" name="strcspn">,
6644 <ref id="strstr" name="strstr">
6650 <sect1>strstr<label id="strstr"><p>
6654 <tag/Function/Find a substring.
6655 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6656 <tag/Declaration/<tt/char* __fastcall__ strstr (const char* str, const char* substr);/
6657 <tag/Description/<tt/strstr/ searches for the first occurance of the string
6658 <tt/substr/ within <tt/str/. If found, it returns a pointer to the copy,
6659 otherwise it returns <tt/NULL/.
6660 <tag/Notes/<itemize>
6661 <item>The function is only available as fastcall function, so it may only
6662 be used in presence of a prototype.
6664 <tag/Availability/ISO 9899
6666 <ref id="strcspn" name="strcspn">,
6667 <ref id="strspn" name="strspn">
6673 <sect1>strtok<label id="strtok"><p>
6677 <tag/Function/Break a string into tokens.
6678 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6679 <tag/Declaration/<tt/char* __fastcall__ strtok (char* s1, const char* s2);/
6680 <tag/Description/<tt/strtok()/ will break the string <tt/s1/ into a sequence of
6681 tokens, which are delimited by characters from the string <tt/s2/. The first call
6682 to <tt/strtok()/ will return a pointer to the first token in the string <tt/s1/.
6683 The following calls must pass a <tt/NULL/ pointer as <tt/s1/, in order to get
6684 the next token in the string. Different sets of delimiters may be used for the
6685 subsequent calls to <tt/strtok()/.
6686 <tag/Notes/<itemize>
6687 <item>The function is only available as fastcall function, so it may only
6688 be used in presence of a prototype.
6689 <item><tt/strtok()/ will modify the string <tt/s1/.
6690 <item>The function will forget where it is in the <tt/s1/ string if it is given
6691 a second <tt/s1/ string before it finishes the first one.
6693 <tag/Availability/ISO 9899
6695 <ref id="strcspn" name="strcspn">,
6696 <!-- <ref id="strpbrk" name="strpbrk">, -->
6697 <ref id="strqtok" name="strqtok">,
6698 <ref id="strspn" name="strspn">
6704 <sect1>strxfrm<label id="strxfrm"><p>
6708 <tag/Function/Transform a string.
6709 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6710 <tag/Declaration/<tt/size_t __fastcall__ strxfrm (char* s1, const char* s2, size_t n);/
6711 <tag/Description/The <tt/strxfrm/ function transforms the string pointed to by
6712 s2 and places the resulting string into the string pointed to by s1. The
6713 transformation is such that if the <tt/strcmp/ function is applied to two
6714 transformed strings, it returns a value greater than, equal to, or less than
6715 zero, corresponding to the result of the <tt/strcoll/ function applied to the
6716 same two original strings. No more than n characters are placed into the
6717 resulting array pointed to by s1, including the terminating null character.
6718 <tag/Notes/<itemize>
6719 <item><tt/s1/ and <tt/s2/ must not point to the same memory area, otherwise
6720 the behaviour is undefined.
6721 <item>If <tt/n/ is zero, <tt/s1/ may be a NULL pointer.
6722 <item>The function is only available as fastcall function, so it may only
6723 be used in presence of a prototype.
6724 <item>Since cc65 doesn't support different charcter sets, <tt/strxfrm/ will
6725 just copy s2 to s1 using <tt><ref id="strncpy" name="strncpy"></tt>.
6727 <tag/Availability/ISO 9899
6729 <ref id="strcmp" name="strcmp">,
6730 <ref id="strcoll" name="strcoll">,
6731 <ref id="strncpy" name="strncpy">
6737 <sect1>strupper<label id="strupper"><p>
6741 <tag/Function/Make a string upper case.
6742 <tag/Header/<tt/<ref id="string.h" name="string.h">/
6743 <tag/Declaration/<tt/char* __fastcall__ strupper (char* s);/
6744 <tag/Description/The <tt/strupper/ function will apply the <tt/toupper/
6745 function to each character of a string. The function will always return <tt/s/.
6746 <tag/Notes/<itemize>
6747 <item>The function is only available as fastcall function, so it may only
6748 be used in presence of a prototype.
6749 <item>The function prototype is unavailable when compiling in strict ANSI mode.
6750 <item>An alias name for this function is <tt/strupr/.
6752 <tag/Availability/cc65
6754 <ref id="strlower" name="strlower">
6755 <ref id="toupper" name="toupper">
6761 <sect1>strupr<label id="strupr"><p>
6768 <sect1>telldir<label id="telldir"><p>
6772 <tag/Function/Return the current position of a directory stream.
6773 <tag/Header/<tt/<ref id="dirent.h" name="dirent.h">/
6774 <tag/Declaration/<tt/long __fastcall__ telldir (DIR* dir);/
6775 <tag/Description/<tt/telldir/ returns the current position of a directory
6776 stream. The return value may be used in subsequent calls to
6777 <tt/<ref id="seekdir" name="seekdir">/.
6778 <tag/Notes/<itemize>
6779 <item>The function is only available as fastcall function, so it may only
6780 be used in presence of a prototype.
6782 <tag/Availability/POSIX 1003.1
6784 <ref id="seekdir" name="seekdir">,
6785 <ref id="telldir" name="telldir">
6791 <sect1>textcolor<label id="textcolor"><p>
6795 <tag/Function/Set the text color.
6796 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
6797 <tag/Declaration/<tt/unsigned char __fastcall__ textcolor (unsigned char color);/
6798 <tag/Description/The function will set a new text color. It returns the old
6799 (current) text color. Text output using any <tt/conio.h/ function will use
6800 the color set by this function.
6801 <tag/Notes/<itemize>
6802 <item>Text colors are system dependent. The function may have no effect
6803 on systems where the text color cannot be changed.
6804 <item>The function is only available as fastcall function, so it may only
6805 be used in presence of a prototype.
6807 <tag/Availability/cc65
6809 <ref id="bgcolor" name="bgcolor">,
6810 <ref id="bordercolor" name="bordercolor">
6816 <sect1>time<label id="time"><p>
6820 <tag/Function/Get the time.
6821 <tag/Header/<tt/<ref id="time.h" name="time.h">/
6822 <tag/Declaration/<tt/time_t __fastcall__ time (time_t* t);/
6823 <tag/Description/The function returns the time since the 1970-01-01 00:00:00
6824 measured in seconds. If the pointer <tt/t/ is not <tt/NULL/, the function
6825 result will also be stored there. If no time is available, <tt/(time_t)-1/ is
6826 returned and <tt/errno/ is set to <tt/ENOSYS/.
6827 <tag/Notes/<itemize>
6828 <item>The function is only available as fastcall function, so it may
6829 only be used in presence of a prototype.
6830 <item>Many platforms supported by cc65 do not have a realtime clock, so the
6831 returned value may not be valid.
6833 <tag/Availability/ISO 9899
6835 <ref id="clock" name="clock">
6841 <sect1>toggle_videomode<label id="toggle_videomode"><p>
6845 <tag/Function/Toggle between 40 and 80 column mode.
6846 <tag/Header/<tt/<ref id="c128.h" name="c128.h">/
6847 <tag/Declaration/<tt/void toggle_videomode (void);/
6848 <tag/Description/Toggle between 40 and 80 column mode. The settings for the
6849 old mode (cursor position, color and so on) are saved and restored together
6851 <tag/Notes/<itemize>
6852 <item>The function is specific to the C128.
6853 <item>This function is deprecated. Please use <ref id="videomode"
6854 name="videomode"> instead!
6856 <tag/Availability/C128
6858 <ref id="fast" name="fast">,
6859 <ref id="slow" name="slow">,
6860 <ref id="videomode" name="videomode">
6866 <sect1>tolower<label id="tolower"><p>
6870 <tag/Function/Convert a character into its lower case representation.
6871 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
6872 <tag/Declaration/<tt/int __fastcall__ tolower (int c);/
6873 <tag/Description/The function returns the given character converted to lower
6874 case. If the given character is not a letter, it is returned unchanged.
6875 <tag/Notes/<itemize>
6876 <item>The function is only available as fastcall function, so it may
6877 only be used in presence of a prototype.
6879 <tag/Availability/ISO 9899
6881 <ref id="islower" name="islower">,
6882 <ref id="isupper" name="isupper">,
6883 <ref id="toupper" name="toupper">
6889 <sect1>toupper<label id="toupper"><p>
6893 <tag/Function/Convert a character into its upper case representation.
6894 <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/
6895 <tag/Declaration/<tt/int __fastcall__ toupper (int c);/
6896 <tag/Description/The function returns the given character converted to upper
6897 case. If the given character is not a letter, it is returned unchanged.
6898 <tag/Notes/<itemize>
6899 <item>The function is only available as fastcall function, so it may
6900 only be used in presence of a prototype.
6902 <tag/Availability/ISO 9899
6904 <ref id="islower" name="islower">,
6905 <ref id="isupper" name="isupper">,
6906 <ref id="tolower" name="tolower">
6912 <sect1>ultoa<label id="ultoa"><p>
6916 <tag/Function/Convert an unsigned long integer into a string.
6917 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
6918 <tag/Declaration/<tt/char* __fastcall__ ultoa (unsigned long val, char* buf, int radix);/
6919 <tag/Description/<tt/itoa/ converts the unsigned long integer <tt/val/ into a
6920 string using <tt/radix/ as the base.
6921 <tag/Notes/<itemize>
6922 <item>There are no provisions to prevent a buffer overflow.
6923 <item>The function is non standard, so it is not available in strict ANSI mode.
6924 You should probably use <tt/sprintf/ instead.
6925 <item>The function is only available as fastcall function, so it may only be
6926 used in presence of a prototype.
6928 <tag/Availability/cc65
6930 <ref id="atoi" name="atoi">,
6931 <ref id="atol" name="atol">,
6932 <ref id="itoa" name="itoa">,
6933 <ref id="ltoa" name="ltoa">,
6934 <ref id="utoa" name="utoa">
6940 <sect1>unlink<label id="unlink"><p>
6944 <tag/Function/Delete a file.
6945 <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/
6946 <tag/Declaration/<tt/int __fastcall__ unlink (const char* name);/
6947 <tag/Description/<tt/unlink/ deletes the file with the given name. On success,
6948 zero is returned. On error, -1 is returned and <tt/errno/ is set to an error
6949 code describing the reason for the failure.
6950 <tag/Notes/<itemize>
6951 <item>The use of this function is discouraged. Please use <tt/<ref id="remove"
6952 name="remove">/ instead, which is a native ANSI C function and does the same.
6953 <item>This function is not available on all cc65 targets (depends on the
6954 availability of file I/O).
6955 <item>The function is only available as fastcall function, so it may only
6956 be used in presence of a prototype.
6957 <item>Instead of <tt/unlink/, <tt/<ref id="remove" name="remove">/ should be
6958 used, which has the same semantics, but is more portable, because it conforms
6959 to the ISO C standard.
6961 <tag/Availability/POSIX 1003.1
6963 <ref id="remove" name="remove">
6966 #include <stdio.h>
6967 #include <unistd.h>
6969 #define FILENAME "helloworld"
6971 if (unlink (FILENAME) == 0) {
6972 printf ("We deleted %s successfully\n", FILENAME);
6974 printf ("There was a problem deleting %s\n", FILENAME);
6981 <sect1>utoa<label id="utoa"><p>
6985 <tag/Function/Convert an unsigned integer into a string.
6986 <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/
6987 <tag/Declaration/<tt/char* __fastcall__ utoa (unsigned val, char* buf, int radix);/
6988 <tag/Description/<tt/itoa/ converts the unsigned integer <tt/val/ into a string
6989 using <tt/radix/ as the base.
6990 <tag/Notes/<itemize>
6991 <item>There are no provisions to prevent a buffer overflow.
6992 <item>The function is non standard, so it is not available in strict ANSI mode.
6993 You should probably use <tt/sprintf/ instead.
6994 <item>The function is only available as fastcall function, so it may only be
6995 used in presence of a prototype.
6997 <tag/Availability/cc65
6999 <ref id="atoi" name="atoi">,
7000 <ref id="atol" name="atol">,
7001 <ref id="itoa" name="itoa">,
7002 <ref id="ltoa" name="ltoa">,
7003 <ref id="ultoa" name="ultoa">
7009 <sect1>vcprintf<label id="vcprintf"><p>
7013 <tag/Function/Formatted output to the console.
7014 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
7015 <tag/Declaration/<tt/int __fastcall__ vcprintf (const char* format, va_list ap);/
7016 <tag/Description/The arguments specified as a <tt/va_list/ are converted to
7017 text where necessary and formatted according to the format string given. The
7018 resulting string is output to the console. <tt/vcprintf/ supports the same
7019 format specifiers as <tt/vprintf/. <!-- <tt/<ref id="vprintf" name="vprintf">/. -->
7020 <tag/Notes/<itemize>
7021 <item>Like all other <tt/conio/ output functions, <tt/vcprintf/ distinguishes
7022 between <tt/\r/ and <tt/\n/.
7023 <item>The function is only available as fastcall function, so it may only be
7024 used in presence of a prototype.
7026 <tag/Availability/cc65
7028 <ref id="cprintf" name="cprintf">,
7029 <ref id="cputc" name="cputc">,
7030 <ref id="cputcxy" name="cputcxy">,
7031 <ref id="cputs" name="cputs">,
7032 <ref id="cputsxy" name="cputsxy">
7038 <sect1>videomode<label id="videomode"><p>
7042 <tag/Function/Switch to either 40 or 80 column mode.
7043 <tag/Header/<tt/<ref id="apple2enh.h" name="apple2enh.h">,
7044 <ref id="c128.h" name="c128.h">/
7045 <tag/Declaration/<tt/unsigned __fastcall__ videomode (unsigned Mode);/
7046 <tag/Description/Switch to 40 or 80 column mode depending on the argument. If
7047 the requested mode is already active, nothing happens. The old mode is returned
7049 <tag/Notes/<itemize>
7050 <item>The function is specific to the C128 and enhanced Apple //e.
7051 <item>This function replaces <ref id="toggle_videomode"
7052 name="toggle_videomode">.
7053 <item>The function is only available as fastcall function, so it may only be
7054 used in presence of a prototype.
7056 <tag/Availability/C128 and enhanced Apple //e
7058 <ref id="fast" name="fast">,
7059 <ref id="slow" name="slow">,
7060 <ref id="toggle_videomode" name="toggle_videomode">
7066 <sect1>waitvsync<label id="waitvsync"><p>
7070 <tag/Function/Wait until the start of the next frame.
7072 <tt/<ref id="cbm.h" name="cbm.h">/,
7073 <tt/<ref id="gamate.h" name="gamate.h">/,
7074 <tt/<ref id="nes.h" name="nes.h">/,
7075 <tt/<ref id="pce.h" name="pce.h">/
7076 <tag/Declaration/<tt/void waitvsync (void);/
7077 <tag/Description/Wait for vertical sync to reduce flickering.
7078 <tag/Availability/Platforms above
7084 <sect1>wherex<label id="wherex"><p>
7088 <tag/Function/Return the current X position of the text mode cursor.
7089 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
7090 <tag/Declaration/<tt/unsigned char wherex (void);/
7091 <tag/Description/The function returns the current X position of the text mode
7092 cursor. Zero is returned for the leftmost screen position.
7093 <tag/Availability/cc65
7095 <ref id="gotox" name="gotox">,
7096 <ref id="gotoy" name="gotoy">,
7097 <ref id="gotoxy" name="gotoxy">,
7098 <ref id="wherey" name="wherey">
7104 <sect1>wherey<label id="wherey"><p>
7108 <tag/Function/Return the current Y position of the text mode cursor.
7109 <tag/Header/<tt/<ref id="conio.h" name="conio.h">/
7110 <tag/Declaration/<tt/unsigned char wherey (void);/
7111 <tag/Description/The function returns the current Y position of the text mode
7112 cursor. Zero is returned for the uppermost screen position.
7113 <tag/Availability/cc65
7115 <ref id="gotox" name="gotox">,
7116 <ref id="gotoy" name="gotoy">,
7117 <ref id="gotoxy" name="gotoxy">,
7118 <ref id="wherex" name="wherex">