cc65 function reference <author>Ullrich von Bassewitz, <htmlurl url="mailto:uz@cc65.org" name="uz@cc65.org"> <date>07.11.2002 <abstract> cc65 is a C compiler for 6502 based systems. This function reference describes the C functions available in the standard library. </abstract>  <toc>  <sect>Introduction cc65 is a C compiler for 6502 based systems. It implements a subset of the ISO C standard plus additional functions specially crafted for 6502 systems or just some of the supported machines. This function refrence describes the available functions together with any limitations. For an overview about the available libraries, their purpose, and any differences to the ISO standard, please have a look at the <htmlurl url="library.html" name="cc65 Library Overview">. <bf/Note:/ Standard C functions are listed here, but not described in detail. Since these functions behave identical on all standard compliant systems, they are described in any book covering standard C. Each entry for a function contains a detailed description <quote> <descrip> <tag/Function/Summary of what <bf/function/ does. <tag/Header/The header file that contains the declaration. <tag/Declaration/Describes the needed header files and declaration of the function. <tag/Description/Description of the function. <tag/Limits/Limits. <tag/Availability/The availability of the function. <tag/See also/Other related functions. <tag/Example/A piece of actual code using the function. </descrip> </quote> <sect>Functions by header file <sect1><tt/6502.h/<label id="6502.h"> <itemize> <item><ref id="BRK" name="BRK"> <item><ref id="CLI" name="CLI"> <item><ref id="SEI" name="SEI"> <item><ref id="_sys" name="_sys"> <item><ref id="getcpu" name="getcpu"> <item><ref id="reset_brk" name="reset_brk"> <item><ref id="reset_irq" name="reset_irq"> <item><ref id="set_brk" name="set_brk"> <item><ref id="set_irq" name="set_irq"> </itemize> <sect1><tt/apple2.h/<label id="apple2.h"> <itemize> <item>_dos_type <item><ref id="get_ostype" name="get_ostype"> <item>rebootafterexit </itemize> <sect1><tt/apple2enh.h/<label id="apple2enh.h"> <itemize> <item>_dos_type <item><ref id="get_ostype" name="get_ostype"> <item>rebootafterexit <item>textframe <item>textframexy <item><ref id="videomode" name="videomode"> </itemize> <sect1><tt/assert.h/<label id="assert.h"> <itemize> <item><ref id="assert" name="assert"> </itemize> <sect1><tt/atari.h/<label id="atari.h"> <itemize>         <item><ref id="get_ostype" name="get_ostype">  </itemize> (incomplete) <sect1><tt/atmos.h/<label id="atmos.h"> (incomplete) <sect1><tt/c128.h/<label id="c128.h"> <itemize> <item><ref id="c64mode" name="c64mode"> <item><ref id="fast" name="fast"> <item><ref id="slow" name="slow"> <item><ref id="toggle_videomode" name="toggle_videomode"> <item><ref id="videomode" name="videomode"> </itemize> <sect1><tt/c16.h/<label id="c16.h"> (incomplete) <sect1><tt/c64.h/<label id="c64.h"> <itemize> <item><ref id="get_ostype" name="get_ostype"> </itemize> <sect1><tt/cbm510.h/<label id="cbm510.h"> <itemize> <item><ref id="peekbsys" name="peekbsys"> <item><ref id="peekwsys" name="peekwsys"> <item><ref id="pokebsys" name="pokebsys"> <item><ref id="pokewsys" name="pokewsys"> </itemize> <sect1><tt/cbm610.h/<label id="cbm610.h"> <itemize> <item><ref id="peekbsys" name="peekbsys"> <item><ref id="peekwsys" name="peekwsys"> <item><ref id="pokebsys" name="pokebsys"> <item><ref id="pokewsys" name="pokewsys"> </itemize> <sect1><tt/cc65.h/<label id="cc65.h">            (incomplete) <sect1><tt/conio.h/<label id="conio.h"> <itemize> <item><ref id="bgcolor" name="bgcolor"> <item><ref id="bordercolor" name="bordercolor"> <item><ref id="cclear" name="cclear"> <item><ref id="cclearxy" name="cclearxy"> <item><ref id="cgetc" name="cgetc"> <item><ref id="chline" name="chline"> <item><ref id="chlinexy" name="chlinexy"> <item><ref id="clrscr" name="clrscr"> <item><ref id="cprintf" name="cprintf"> <item><ref id="cputc" name="cputc"> <item><ref id="cputcxy" name="cputcxy"> <item><ref id="cputs" name="cputs"> <item><ref id="cputsxy" name="cputsxy"> <item><ref id="cursor" name="cursor"> <item><ref id="cvline" name="cvline"> <item><ref id="cvlinexy" name="cvlinexy"> <item><ref id="gotox" name="gotox"> <item><ref id="gotoxy" name="gotoxy"> <item><ref id="gotoy" name="gotoy"> <item><ref id="kbhit" name="kbhit"> <item><ref id="revers" name="revers"> <item><ref id="screensize" name="screensize"> <item><ref id="textcolor" name="textcolor"> <item><ref id="vcprintf" name="vcprintf"> <item><ref id="wherex" name="wherex"> <item><ref id="wherey" name="wherey"> </itemize> <sect1><tt/ctype.h/<label id="ctype.h"> <itemize> <item><ref id="isalnum" name="isalnum"> <item><ref id="isalpha" name="isalpha"> <item><ref id="isascii" name="isascii"> <item><ref id="isblank" name="isblank"> <item><ref id="iscntrl" name="iscntrl"> <item><ref id="isdigit" name="isdigit"> <item><ref id="isgraph" name="isgraph"> <item><ref id="islower" name="islower"> <item><ref id="isprint" name="isprint"> <item><ref id="ispunct" name="ispunct"> <item><ref id="isspace" name="isspace"> <item><ref id="isupper" name="isupper"> <item><ref id="isxdigit" name="isxdigit"> <item><ref id="tolower" name="tolower"> <item><ref id="toupper" name="toupper"> </itemize> <sect1><tt/dbg.h/<label id="dbg.h">    (incomplete) <sect1><tt/dio.h/<label id="dio.h"> <htmlurl url="dio.html" name="dio.html"> Low-level disk I/O API. <sect1><tt/em.h/<label id="em.h"> <itemize> <item><ref id="em_commit" name="em_commit"> <item><ref id="em_copyfrom" name="em_copyfrom"> <item><ref id="em_copyto" name="em_copyto"> <item><ref id="em_install" name="em_install"> <item><ref id="em_load_driver" name="em_load_driver"> <item><ref id="em_map" name="em_map"> <item><ref id="em_pagecount" name="em_pagecount"> <item><ref id="em_uninstall" name="em_uninstall"> <item><ref id="em_unload" name="em_unload"> <item><ref id="em_use" name="em_use"> </itemize> <sect1><tt/errno.h/<label id="errno.h">       (incomplete) <sect1><tt/fcntl.h/<label id="fcntl.h"> <itemize> <item><ref id="close" name="close"> <item><ref id="creat" name="creat"> <item><ref id="open" name="open"> </itemize> <sect1><tt/geos.h/<label id="geos.h"> (incomplete) <sect1><tt/joystick.h/<label id="joystick.h"> <itemize> <item><ref id="joy_count" name="joy_count"> <item><ref id="joy_install" name="joy_install"> <item><ref id="joy_load_driver" name="joy_load_driver"> <item><ref id="joy_read" name="joy_read"> <item><ref id="joy_uninstall" name="joy_uninstall"> <item><ref id="joy_unload" name="joy_unload"> </itemize> <sect1><tt/locale.h/<label id="locale.h"> <itemize> <item><ref id="localeconv" name="localeconv"> <item><ref id="setlocale" name="setlocale"> </itemize> <sect1><tt/lynx.h/<label id="lynx.h">          (incomplete) <sect1><tt/modload.h/<label id="modload.h"> <itemize> <item><ref id="mod_load" name="mod_load"> <item><ref id="mod_free" name="mod_free"> </itemize> <sect1><tt/mouse.h/<label id="mouse.h"> <itemize> <item><ref id="mouse_buttons" name="mouse_buttons"> <item><ref id="mouse_getbox" name="mouse_getbox"> <item><ref id="mouse_geterrormsg" name="mouse_geterrormsg"> <item><ref id="mouse_hide" name="mouse_hide"> <item><ref id="mouse_info" name="mouse_info"> <item><ref id="mouse_install" name="mouse_install"> <item><ref id="mouse_ioctl" name="mouse_ioctl"> <item><ref id="mouse_load_driver" name="mouse_load_driver"> <item><ref id="mouse_move" name="mouse_move"> <item><ref id="mouse_pos" name="mouse_pos"> <item><ref id="mouse_setbox" name="mouse_setbox"> <item><ref id="mouse_show" name="mouse_show"> <item><ref id="mouse_uninstall" name="mouse_uninstall"> <item><ref id="mouse_unload" name="mouse_unload"> </itemize> <sect1><tt/nes.h/<label id="nes.h">     (incomplete) <sect1><tt/o65.h/<label id="o65.h"> The <tt/o65.h/ header file contains structure and constant definitions that may be used when dealing with files in <htmlurl url="http://www.6502.org/users/andre/o65/fileformat.html" name="o65 format">. It does not declare any functions. <sect1><tt/peekpoke.h/<label id="peekpoke.h"> <itemize> <item><ref id="PEEK" name="PEEK"> <item><ref id="PEEKW" name="PEEKW"> <item><ref id="POKE" name="POKE"> <item><ref id="POKEW" name="POKEW"> </itemize> <sect1><tt/pet.h/<label id="pet.h"> (incomplete) <sect1><tt/plus4.h/<label id="plus4.h"> (incomplete) <sect1><tt/serial.h/<label id="serial.h"> The <tt/serial.h/ header file contains definitions for initializing serial communication. <itemize> <item><ref id="ser_close" name="ser_close"> <item><ref id="ser_get" name="ser_get"> <item><ref id="ser_install" name="ser_install"> <item><ref id="ser_ioctl" name="ser_ioctl"> <item><ref id="ser_load_driver" name="ser_load_driver"> <item><ref id="ser_open" name="ser_open"> <item><ref id="ser_put" name="ser_put"> <item><ref id="ser_status" name="ser_status"> <item><ref id="ser_uninstall" name="ser_uninstall"> <item><ref id="ser_unload" name="ser_unload"> </itemize> <sect1><tt/setjmp.h/<label id="setjmp.h"> <itemize> <item><ref id="setjmp" name="setjmp"> <item><ref id="longjmp" name="longjmp"> </itemize> <sect1><tt/signal.h/<label id="signal.h"> <itemize> <item><ref id="raise" name="raise"> <item><ref id="signal" name="signal"> </itemize> <sect1><tt/stdarg.h/<label id="stdarg.h"> (incomplete) <sect1><tt/stdbool.h/<label id="stdbool.h"> (incomplete) <sect1><tt/stddef.h/<label id="stddef.h"> <itemize> <item><ref id="offsetof" name="offsetof"> </itemize> <sect1><tt/stdio.h/<label id="stdio.h"> <itemize> <item><ref id="_poserror" name="_poserror"> <item><ref id="clearerr" name="clearerr">   <item><ref id="feof" name="feof"> <item><ref id="ferror" name="ferror">     <item><ref id="fileno" name="fileno">                   <item><ref id="rename" name="rename"> <item><ref id="remove" name="remove">             </itemize> (incomplete) <sect1><tt/stdlib.h/<label id="stdlib.h"> <itemize> <item><ref id="_heapadd" name="_heapadd"> <item><ref id="_heapblocksize" name="_heapblocksize"> <item><ref id="_heapmaxavail" name="_heapmaxavail"> <item><ref id="_heapmemavail" name="_heapmemavail"> <item><ref id="_randomize" name="_randomize"> <item><ref id="_swap" name="_swap"> <item><ref id="abort" name="abort"> <item><ref id="abs" name="abs"> <item><ref id="atexit" name="atexit"> <item><ref id="atoi" name="atoi"> <item><ref id="atol" name="atol"> <item><ref id="bsearch" name="bsearch"> <item><ref id="calloc" name="calloc"> <item><ref id="div" name="div"> <item><ref id="exit" name="exit"> <item><ref id="free" name="free"> <item><ref id="getenv" name="getenv"> <item><ref id="itoa" name="itoa"> <item><ref id="labs" name="labs"> <item><ref id="ltoa" name="ltoa"> <item><ref id="malloc" name="malloc"> <item><ref id="perror" name="perror">   <item><ref id="qsort" name="qsort"> <item><ref id="rand" name="rand"> <item><ref id="realloc" name="realloc"> <item><ref id="srand" name="srand">  <item><ref id="ultoa" name="ultoa"> <item><ref id="utoa" name="utoa"> </itemize> (incomplete) <sect1><tt/string.h/<label id="string.h"> <itemize> <item><ref id="_stroserror" name="_stroserror"> <item><ref id="bzero" name="bzero"> <item><ref id="memchr" name="memchr"> <item><ref id="memcmp" name="memcmp"> <item><ref id="memcpy" name="memcpy"> <item><ref id="memmove" name="memmove"> <item><ref id="memset" name="memset"> <item><ref id="strcasecmp" name="strcasecmp"> <item><ref id="strcat" name="strcat"> <item><ref id="strchr" name="strchr"> <item><ref id="strcmp" name="strcmp"> <item><ref id="strcoll" name="strcoll"> <item><ref id="strcpy" name="strcpy"> <item><ref id="strcspn" name="strcspn"> <item><ref id="strdup" name="strdup"> <item><ref id="strerror" name="strerror"> <item><ref id="stricmp" name="stricmp"> <item><ref id="strlen" name="strlen"> <item><ref id="strlower" name="strlower"> <item><ref id="strlwr" name="strlwr"> <item><ref id="strncat" name="strncat"> <item><ref id="strncmp" name="strncmp"> <item><ref id="strncpy" name="strncpy"> <item><ref id="strrchr" name="strrchr"> <item><ref id="strspn" name="strspn"> <item><ref id="strstr" name="strstr"> <item><ref id="strtok" name="strtok"> <item><ref id="strxfrm" name="strxfrm"> <item><ref id="strupper" name="strupper"> <item><ref id="strupr" name="strupr"> </itemize> (incomplete) <sect1><tt/tgi.h/<label id="tgi.h"> <itemize> <item><ref id="tgi_arc" name="tgi_arc"> <item><ref id="tgi_bar" name="tgi_bar"> <item><ref id="tgi_circle" name="tgi_circle"> <item><ref id="tgi_clear" name="tgi_clear"> <item><ref id="tgi_done" name="tgi_done"> <item><ref id="tgi_ellipse" name="tgi_ellipse"> <item><ref id="tgi_getaspectratio" name="tgi_getaspectratio"> <item><ref id="tgi_getcolor" name="tgi_getcolor"> <item><ref id="tgi_getcolorcount" name="tgi_getcolorcount"> <item><ref id="tgi_getdefpalette" name="tgi_getdefpalette"> <item><ref id="tgi_geterror" name="tgi_geterror"> <item><ref id="tgi_geterrormsg" name="tgi_geterrormsg"> <item><ref id="tgi_getmaxcolor" name="tgi_getmaxcolor"> <item><ref id="tgi_getmaxx" name="tgi_getmaxx"> <item><ref id="tgi_getmaxy" name="tgi_getmaxy"> <item><ref id="tgi_getpagecount" name="tgi_getpagecount"> <item><ref id="tgi_getpalette" name="tgi_getpalette"> <item><ref id="tgi_getpixel" name="tgi_getpixel"> <item><ref id="tgi_getxres" name="tgi_getxres"> <item><ref id="tgi_getyres" name="tgi_getyres"> <item><ref id="tgi_gotoxy" name="tgi_gotoxy"> <item><ref id="tgi_init" name="tgi_init"> <item><ref id="tgi_install" name="tgi_install"> <item><ref id="tgi_ioctl" name="tgi_ioctl"> <item><ref id="tgi_line" name="tgi_line"> <item><ref id="tgi_lineto" name="tgi_lineto"> <item><ref id="tgi_load_driver" name="tgi_load_driver"> <item><ref id="tgi_outtext" name="tgi_outtext"> <item><ref id="tgi_outtextxy" name="tgi_outtextxy"> <item><ref id="tgi_setaspectratio" name="tgi_setaspectratio"> <item><ref id="tgi_setcolor" name="tgi_setcolor"> <item><ref id="tgi_setdrawpage" name="tgi_setdrawpage"> <item><ref id="tgi_setpalette" name="tgi_setpalette"> <item><ref id="tgi_setpixel" name="tgi_setpixel"> <item><ref id="tgi_setviewpage" name="tgi_setviewpage"> <item><ref id="tgi_gettextheight" name="tgi_gettextheight"> <item><ref id="tgi_settextstyle" name="tgi_settextstyle"> <item><ref id="tgi_gettextwidth" name="tgi_gettextwidth"> <item><ref id="tgi_uninstall" name="tgi_uninstall"> <item><ref id="tgi_unload" name="tgi_unload"> </itemize> <sect1><tt/time.h/<label id="time.h"> <itemize>   <item><ref id="clock" name="clock">      <item><ref id="time" name="time"> </itemize> (incomplete) <sect1><tt/unistd.h/<label id="unistd.h"> <itemize>  <item><ref id="exec" name="exec">  <item><ref id="getopt" name="getopt">     <item><ref id="sleep" name="sleep"> <item><ref id="unlink" name="unlink">  </itemize> (incomplete) <sect1><tt/vic20.h/<label id="vic20.h"> (incomplete) <sect1><tt/zlib.h/<label id="zlib.h">       (incomplete) <sect>Alphabetical function reference <sect1>_heapadd<label id="_heapadd"> <quote> <descrip> <tag/Function/Add a block to the heap. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ _heapadd (void* mem, size_t size);/ <tag/Description/The function adds a block of raw memory to the heap. <tag/Limits/ <itemize> <item>The minimum blocksize that can be added is 6 bytes; the function will ignore smaller blocks. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>_heapblocksize<label id="_heapblocksize"> <quote> <descrip> <tag/Function/Return the size of an allocated block. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/size_t __fastcall__ _heapblocksize (const void* block);/ <tag/Description/The function returns the size of a block that must have previously been allocated by <tt/<ref id="malloc" name="malloc">/, <tt/<ref id="calloc" name="calloc">/ or <tt/<ref id="realloc" name="realloc">/. <tag/Limits/ <itemize> <item>Passing a pointer to a block that was is not the result of one of the allocation functions, or that has been free'd will give unpredicable results. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>_heapmaxavail<label id="_heapmaxavail"> <quote> <descrip> <tag/Function/Return the largest block that is available on the heap. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/size_t _heapmaxavail (void);/ <tag/Description/The function returns the size of the largest block that may be allocated from the heap using <tt/<ref id="malloc" name="malloc">/. <tag/Availability/cc65 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>_heapmemavail<label id="_heapmemavail"> <quote> <descrip> <tag/Function/Return the total available space on the heap. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/size_t __fastcall__ _heapmemavail (void);/ <tag/Description/The function returns the total number of bytes available on the heap. <tag/Limits/ <itemize> <item>This function is of less use than usually assumed, since the returned heap space may be available but not in one block. So even if this function says that several times more heap space is available than needed, <ref id="malloc" name="malloc"> may still return <tt/NULL/. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>_poserror<label id="_poserror"> <quote> <descrip> <tag/Function/Print an error message for the error in <tt/_oserror/. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/void __fastcall__ _poserror (const char* msg);/ <tag/Description/<tt/_poserror/ prints an error message to <tt/stderr/. If <tt/msg/ is not <tt/NULL/ and not an empty string, it is printed followed by a colon and a blank. Then the error message for the current contents of <tt/_oserror/ are printed followed by a newline. The message output is the same as returned by <tt/<ref id="_stroserror" name="_stroserror">/ with an argument of <tt/_oserror/. <tag/Limits/ <itemize> <item>Since operating system specific error code are - you guessed it - operating system specific, the value in <tt/_oserror/ and the message that is printed depends on the cc65 target. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="_stroserror" name="_stroserror">, <ref id="perror" name="perror"> <tag/Example/None. </descrip> </quote> <sect1>_randomize<label id="_randomize"> <quote> <descrip> <tag/Function/Initialize the pseudo random number generator. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void _randomize (void);/ <tag/Description/The function initializes the random number generator with a seed derived from fast changing hardware events, so the seed itself can be considered random to a certain degree. <tag/Limits/<itemize> <item>The randomness of the seed depends on the machine hardware. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="rand" name="rand">, <ref id="srand" name="srand"> <tag/Example/None. </descrip> </quote> <sect1>_stroserror<label id="_stroserror"> <quote> <descrip> <tag/Function/Return a string describing an OS specific error code. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/const char* __fastcall__ _stroserror (unsigned char errcode);/ <tag/Description/<tt/_stroserror/ will return a string describing the given operating system specific error code. <tag/Limits/<itemize> <item>Since operating system specific error code are - you guessed it - operating system specific, the parameter and the string returned depend on the cc65 target. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="strerror" name="strerror"> <tag/Example/None. </descrip> </quote> <sect1>_swap<label id="_swap"> <quote> <descrip> <tag/Function/Swap the contents of memory areas. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ _swap (void* p, void* q, size_t size);/ <tag/Description/<tt/_swap/ will swap (exchange) the contents of the two memory areas pointed to by <tt/p/ and <tt/q/. Both memory areas are assumed to be <tt/size/ bytes in size. <tag/Limits/<itemize> <item>The memory areas may not overlap, otherwise the results are undefined. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="memcpy" name="memcpy">, <ref id="memmove" name="memmove"> <tag/Example/None. </descrip> </quote> <sect1>_sys<label id="_sys"> <quote> <descrip> <tag/Function/Call a subroutine passing register values. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void __fastcall__ _sys (struct regs* r);/ <tag/Description/The function will call the subroutine at the address specified in the <tt/pc/ member of the passed <tt/regs/ structure. All registers and the CPU flags are set to the values given in the <tt/regs/ structure. On return from the subroutine, the new values of the registers and flags are stored back overwriting the old values. <tag/Limits/<itemize> <item>Bits 4 and 5 of the flags value in the <tt/regs/ structure are ignored when calling the subroutine (they are unchanged from their current values). <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/Example/None. </descrip> </quote> <sect1>BRK<label id="BRK"> <quote> <descrip> <tag/Function/Insert a 6502 BRK instrunction into the code. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void BRK (void);/ <tag/Description/The function will insert a 6502 BRK instruction into the code which may be used to trigger a debugger. <tag/Limits/<itemize> <item>The function is actually a macro. <item>The inserted instruction may lead to unexpected results if no debugger is present. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="CLI" name="CLI">, <ref id="SEI" name="SEI"> <tag/Example/None. </descrip> </quote> <sect1>CLI<label id="CLI"> <quote> <descrip> <tag/Function/Insert a 6502 CLI instrunction into the code. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void CLI (void);/ <tag/Description/The function will insert a 6502 CLI instruction into the code, so interrupts are enabled. Enabling interrupts has no effects if they are already enabled (the default). <tag/Limits/<itemize> <item>The function is actually a macro. <item>Disabling interrupts may lead to unexpected results. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="BRK" name="BRK">, <ref id="SEI" name="SEI"> <tag/Example/None. </descrip> </quote> <sect1>PEEK<label id="PEEK"> <quote> <descrip> <tag/Function/Read a byte from memory. <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/ <tag/Declaration/<tt/unsigned char PEEK (unsigned addr);/ <tag/Description/The function will read the absolute memory given by <tt/addr/ and return the value read. <tag/Limits/<itemize> <item>The function is actually a macro. <item>This function depends highly on the platform and environment. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEKW" name="PEEKW">, <ref id="POKE" name="POKE"> <tag/Example/None. </descrip> </quote> <sect1>PEEKW<label id="PEEKW"> <quote> <descrip> <tag/Function/Read a word (two bytes) from memory. <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/ <tag/Declaration/<tt/unsigned PEEKW (unsigned addr);/ <tag/Description/The function will read the absolute memory given by <tt/addr/ and return the value read. The byte read from the higher address is the high byte of the return value. <tag/Limits/<itemize> <item>The function is actually a macro. <item>This function depends highly on the platform and environment. <item>The order in which the two bytes are read is unspecified and may depend of the address expression used. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEK" name="PEEK">, <ref id="POKE" name="POKE"> <tag/Example/None. </descrip> </quote> <sect1>POKE<label id="POKE"> <quote> <descrip> <tag/Function/Write a byte to memory. <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/ <tag/Declaration/<tt/void POKE (unsigned addr, unsigned char val);/ <tag/Description/The function writes the value <tt/val/ to the absolute memory address given by <tt/addr/. <tag/Limits/<itemize> <item>The function is actually a macro. <item>This function depends highly on the platform and environment. <item>Careless use will cause the program to act strange or may crash the machine. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEK" name="PEEK">, <ref id="POKEW" name="POKEW"> <tag/Example/None. </descrip> </quote> <sect1>POKEW<label id="POKEW"> <quote> <descrip> <tag/Function/Write a word (two bytes) to memory. <tag/Header/<tt/<ref id="peekpoke.h" name="peekpoke.h">/ <tag/Declaration/<tt/void POKEW (unsigned addr, unsigned val);/ <tag/Description/The function writes the value <tt/val/ to the absolute memory address given by <tt/addr/. The low byte of <tt/val/ is written to the <tt/addr/, the high byte is written to <tt/addr+1/. <tag/Limits/<itemize> <item>The function is actually a macro. <item>This function depends highly on the platform and environment. <item>Careless use will cause the program to act strange or may crash the machine. <item>The order in which the two bytes are written is unspecified and may depend of the address expression used. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEK" name="PEEK">, <ref id="POKE" name="POKE"> <tag/Example/None. </descrip> </quote> <sect1>SEI<label id="SEI"> <quote> <descrip> <tag/Function/Insert a 6502 SEI instrunction into the code. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void SEI (void);/ <tag/Description/The function will insert a 6502 SEI instruction into the code, so interrupts are disabled. Note that non maskable interrupts cannot be disabled. <tag/Limits/<itemize> <item>The function is actually a macro. <item>Disabling interrupts may lead to unexpected results. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="BRK" name="BRK">, <ref id="CLI" name="CLI"> <tag/Example/None. </descrip> </quote> <sect1>abort<label id="abort"> <quote> <descrip> <tag/Function/Terminates a program abnormally. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void abort (void);/ <tag/Description/<tt/abort/ raises <tt/SIGABRT/, writes a termination message on stderr, then terminates the program with an exit code of 3. <tag/Availability/ISO 9899 <tag/See also/ <ref id="assert" name="assert">, <ref id="exit" name="exit">, <ref id="raise" name="raise"> <tag/Example/None. </descrip> </quote> <sect1>abs<label id="abs"> <quote> <descrip> <tag/Function/Returns the absolute value of an integer. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/int __fastcall__ abs (int v);/ <tag/Description/<tt/abs/ returns the absolute value of the argument passed to the function. <tag/Limits/<itemize> <item>The return value is undefined if <tt/INT_MIN/ is passed to the function. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="labs" name="labs"> <tag/Example/None. </descrip> </quote> <sect1>assert<label id="assert"> <quote> <descrip> <tag/Function/Test a condition and possibly abort. <tag/Header/<tt/<ref id="assert.h" name="assert.h">/ <tag/Declaration/<tt/void assert (int cond);/ <tag/Description/<tt/assert/ is a macro that expands to a <tt/id/ statement. If the condition evaluates t zero (false), assert prints a message on stderr and aborts the program. <tag/Limits/<itemize> <item>The function is actually a macro. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abort" name="abort">, <ref id="exit" name="exit"> <tag/Example/None. </descrip> </quote> <sect1>atexit<label id="atexit"> <quote> <descrip> <tag/Function/Register an exit function. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/int __fastcall__ atexit (void (*exitfunc) (void));/ <tag/Description/<tt/atexit/ registers the function pointed to by <tt/exitfunc/ as an exit function. Exit functions are called when the program terminates, they are called in LIFO order (the last function registered is called first). <tt/atexit/ returns zero on success and a nonzero value on failure. <tag/Limits/<itemize> <item>A maximum of 5 exit functions can be registered. <item>There is no way to unregister an exit function. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abort" name="abort">, <ref id="exit" name="exit"> <tag/Example/None. </descrip> </quote> <sect1>atoi<label id="atoi"> <quote> <descrip> <tag/Function/Convert a string to an integer. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/int __fastcall__ atoi (const char* s);/ <tag/Description/<tt/atoi/ converts the given string into an integer. Conversion stops as soon as any invalid character is encountered. <tag/Limits/<itemize> <item>There is no way to detect any conversion errors. <item>The function does not check for an numerical overflow when converting. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="atol" name="atol">, <ref id="itoa" name="itoa">, <ref id="ltoa" name="ltoa">, <ref id="ultoa" name="ultoa">, <ref id="utoa" name="utoa"> <tag/Example/None. </descrip> </quote> <sect1>atol<label id="atol"> <quote> <descrip> <tag/Function/Convert a string to a long integer. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/long __fastcall__ atol (const char* s);/ <tag/Description/<tt/atol/ converts the given string into a long integer. Conversion stops as soon as any invalid character is encountered. <tag/Limits/<itemize> <item>There is no way to detect any conversion errors. <item>The function does not check for an numerical overflow when converting. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="atoi" name="atoi">, <ref id="itoa" name="itoa">, <ref id="ltoa" name="ltoa">, <ref id="ultoa" name="ultoa">, <ref id="utoa" name="utoa"> <tag/Example/None. </descrip> </quote> <sect1>bgcolor<label id="bgcolor"> <quote> <descrip> <tag/Function/Set the background text color. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ bgcolor (unsigned char color);/ <tag/Description/The function will set a new background color and return the old (current) one. The background color is valid for the whole text output area of the screen, not just for new text. <tag/Limits/<itemize> <item>Background colors are system dependent. The function may have no effect on systems where the background color cannot be changed. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="bordercolor" name="bordercolor">, <ref id="textcolor" name="textcolor"> <tag/Example/None. </descrip> </quote> <sect1>bordercolor<label id="bordercolor"> <quote> <descrip> <tag/Function/Set the border (frame) color. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ bordercolor (unsigned char color);/ <tag/Description/The function will set a new border color. It returns the old (current) border color. <tag/Limits/<itemize> <item>Border colors are system dependent. The function may have no effect on systems where the border color cannot be changed. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="bgcolor" name="bgcolor">, <ref id="textcolor" name="textcolor"> <tag/Example/None. </descrip> </quote> <sect1>bsearch<label id="bsearch"> <quote> <descrip> <tag/Function/Do a binary search in a sorted array. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void* __fastcall__ bsearch (const void* key, const void* base, size_t n, size_t size, int (*cmp) (const void*, const void*));/ <tag/Description/<tt/bsearch/ searches a sorted array for a member that matches the one pointed to by <tt/key/. <tt/base/ is the address of the array, <tt/n/ is the number of elements, <tt/size/ the size of an element and <tt/cmp/ the function used to compare the members against the key. The function returns a pointer to the member found, or <tt/NULL/ if there was no match. <tag/Limits/ <itemize> <item>The contents of the array must be sorted in ascending order according to the compare function given. <item>If there are multiple members that match the key, the function will return one of the members. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="qsort" name="qsort"> <tag/Example/None. </descrip> </quote> <sect1>bzero<label id="bzero"> <quote> <descrip> <tag/Function/Fill a memory area with zeroes. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/void __fastcall__ bzero (void* p, size_t count);/ <tag/Description/<tt/bzero/ fills the memory area pointed to by <tt/p/ with zero. <tag/Limits/ <itemize> <item>The function is non standard and therefore only available in non ANSI mode. You should use <tt/<ref id="memset" name="memset">/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="_swap" name="_swap">, <ref id="memcpy" name="memcpy">, <ref id="memmove" name="memmove">, <ref id="memset" name="memset">, <tag/Example/None. </descrip> </quote> <sect1>c64mode<label id="c64mode"> <quote> <descrip> <tag/Function/Switch the C128 into C64 compatible mode. <tag/Header/<tt/<ref id="c128.h" name="c128.h">/ <tag/Declaration/<tt/void c64mode (void);/ <tag/Description/The function will cause the machine to reboot into C64 mode. <tag/Limits/<itemize> <item>The function is specific to the C128. <item>The function will not return to the caller. </itemize> <tag/Availability/C128 <tag/Example/None. </descrip> </quote> <sect1>calloc<label id="calloc"> <quote> <descrip> <tag/Function/Allocate and clear memory. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void* __fastcall__ calloc (size_t n, size_t size);/ <tag/Description/<tt/calloc/ allocates memory for an array of <tt/n/ elements of size <tt/size/, clears the whole block with binary zeroes and returns a pointer to it. On error (not enough memory available), <tt/calloc/ returns <tt/NULL/. <tag/Limits/ <itemize> <item>Clearing the memory may not have the expected effect on all platforms: pointers in the block may not be <tt/NULL/ and floating point variables may not be zero (0.0). In other words: The "clearing" effect of this function should be used with care for portable programs. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="free" name="free">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>cclear<label id="cclear"> <quote> <descrip> <tag/Function/Clear part of a line (write a given number of spaces). <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cclear (unsigned char length);/ <tag/Description/The function clears part of a line by writing <tt/length/ spaces in the current text color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cclearxy" name="cclearxy">, <ref id="clrscr" name="clrscr"> <tag/Example/None. </descrip> </quote> <sect1>cclearxy<label id="cclearxy"> <quote> <descrip> <tag/Function/Clear part of a line (write a given number of spaces) starting at a specific screen position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cclearxy (unsigned char x, unsigned char y, unsigned char length);/ <tag/Description/The function moves the cursor to a specific position, and will then clear part of the line by writing <tt/length/ spaces in the current text color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cclear" name="cclear">, <ref id="clrscr" name="clrscr"> <tag/Example/None. </descrip> </quote> <sect1>cgetc<label id="cgetc"> <quote> <descrip> <tag/Function/Read a character from the keyboard. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/char cgetc (void);/ <tag/Description/The function reads a character from the keyboard. If there is no character available, <tt/cgetc/ waits until the user presses a key. If the cursor is enabled by use of the <tt/cursor/ function, a blinking cursor is displayed while waiting. <tag/Limits/<itemize> <item>If the system supports a keyboard buffer, <tt/cgetc/ will fetch a key from this buffer and wait only if the buffer is empty. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cursor" name="cursor">, <ref id="kbhit" name="kbhit"> <tag/Example/None. </descrip> </quote> <sect1>chline<label id="chline"> <quote> <descrip> <tag/Function/Output a horizontal line in text mode. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ chline (unsigned char length);/ <tag/Description/The function outputs a horizontal line with the given length starting at the current cursor position. <tag/Limits/<itemize> <item>The character used to draw the horizontal line is system dependent. If available, a line drawing character is used. Drawing a line that is partially off screen leads to undefined behaviour. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="chlinexy" name="chlinexy">, <ref id="cvline" name="cvline">, <ref id="cvlinexy" name="cvlinexy"> <tag/Example/None. </descrip> </quote> <sect1>chlinexy<label id="chlinexy"> <quote> <descrip> <tag/Function/Output a horizontal line at a given position in text mode. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ chlinexy (unsigned char x, unsigned char y, unsigned char length);/ <tag/Description/The function outputs a horizontal line with the given length starting at a given position. <tag/Limits/<itemize> <item>The character used to draw the horizontal line is system dependent. If available, a line drawing character is used. Drawing a line that is partially off screen leads to undefined behaviour. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="chline" name="chline">, <ref id="cvline" name="cvline">, <ref id="cvlinexy" name="cvlinexy"> <tag/Example/None. </descrip> </quote> <sect1>clearerr<label id="clearerr"> <quote> <descrip> <tag/Function/Clear error and end-of-file status of a stream. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/void __fastcall__ clearerr (FILE* f);/ <tag/Description/<tt/clearerr/ clears the error and end-of-file status indicators for the stream <tt/f/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="feof" name="feof">, <ref id="ferror" name="ferror"> <tag/Example/None. </descrip> </quote> <sect1>clock<label id="clock"> <quote> <descrip> <tag/Function/Determine the processor time used. <tag/Header/<tt/<ref id="time.h" name="time.h">/ <tag/Declaration/<tt/clock_t clock (void);/ <tag/Description/The <tt/clock/ function returns an approximaton of processor time used by the program. The time is returned in implementation defined units. It can be converted to seconds by dividing by the value of the macro <tt/CLOCKS_PER_SEC/. <tag/Limits/<itemize> <item>Since the machines, cc65 generated programs run on, cannot run multiple processes, the function will actually return the time since some implementation defined point in the past. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="time" name="time"> <tag/Example/None. </descrip> </quote> <sect1>clrscr<label id="clrscr"> <quote> <descrip> <tag/Function/Clear the text screen. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void clrscr (void);/ <tag/Description/The function clears the text screen and moves the cursor to the upper left corner. <tag/Availability/cc65 <tag/See also/ <ref id="cclear" name="cclear">, <ref id="cclearxy" name="cclearxy"> <tag/Example/None. </descrip> </quote> <sect1>close<label id="close"> <quote> <descrip> <tag/Function/Close a file descriptor. <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/ <tag/Declaration/<tt/int __fastcall__ close (int fd);/ <tag/Description/The function closes the given file descriptor. It returns zero on success and -1 on error. If an error occurs, the cause can be determined by reading the <tt/errno/ variable. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/POSIX 1003.1 <tag/See also/ <ref id="creat" name="creat">, <ref id="open" name="open"> <tag/Example/None. </descrip> </quote> <sect1>creat<label id="creat"> <quote> <descrip> <tag/Function/Create a file. <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/ <tag/Declaration/<tt/int __fastcall__ creat (const char* name, unsigned mode);/ <tag/Description/<tt/creat/ creates a new file and returns the file descriptor associated with it. On error, -1 is returned and an error code is stored in <tt/errno/. <tag/Limits/<itemize> <item><tt/creat/ is identical to calling <tt/<ref id="open" name="open">/ with <tt/flags/ equal to <tt/O_WRONLY | O_CREAT | O_TRUNC/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/POSIX 1003.1 <tag/See also/ <ref id="close" name="close">, <ref id="open" name="open"> <tag/Example/None. </descrip> </quote> <sect1>cprintf<label id="cprintf"> <quote> <descrip> <tag/Function/Formatted output to the console. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/int cprintf (const char* format, ...);/ <tag/Description/The arguments are converted to text where necessary and formatted according to the format string given. The resulting string is output to the console. <tt/cprintf/ supports the same format specifiers as <tt/printf/.  <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/cprintf/ distinguishes between <tt/\r/ and <tt/\n/. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cputc" name="cputc">, <ref id="cputcxy" name="cputcxy">, <ref id="cputs" name="cputs">, <ref id="cputsxy" name="cputsxy">, <ref id="vcprintf" name="vcprintf"> <tag/Example/None. </descrip> </quote> <sect1>cputc<label id="cputc"> <quote> <descrip> <tag/Function/Output a character directly to the console. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cputc (char c);/ <tag/Description/Output one character to the console at the current cursor position. <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/cputc/ distinguishes between <tt/\r/ and <tt/\n/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cprintf" name="cprintf">, <ref id="cputcxy" name="cputcxy">, <ref id="cputs" name="cputs">, <ref id="cputsxy" name="cputsxy">, <ref id="vcprintf" name="vcprintf"> <tag/Example/None. </descrip> </quote> <sect1>cputcxy<label id="cputcxy"> <quote> <descrip> <tag/Function/Output a character at a specific screen position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cputcxy (unsigned char x, unsigned char y, char c);/ <tag/Description/<tt/cputcxy/ moves the cursor to the given x/y position on the screen and outputs one character. <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/cputcxy/ distinguishes between <tt/\r/ and <tt/\n/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cprintf" name="cprintf">, <ref id="cputc" name="cputc">, <ref id="cputs" name="cputs">, <ref id="cputsxy" name="cputsxy">, <ref id="vcprintf" name="vcprintf"> <tag/Example/None. </descrip> </quote> <sect1>cputs<label id="cputs"> <quote> <descrip> <tag/Function/Output a string directly to the console. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cputs (const char* s);/ <tag/Description/The function outputs the given string on the console at the current cursor position. <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/cputs/ distinguishes between <tt/\r/ and <tt/\n/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cprintf" name="cprintf">, <ref id="cputc" name="cputc">, <ref id="cputcxy" name="cputcxy">, <ref id="cputsxy" name="cputsxy">, <ref id="vcprintf" name="vcprintf"> <tag/Example/None. </descrip> </quote> <sect1>cputsxy<label id="cputsxy"> <quote> <descrip> <tag/Function/Output a string to the console at a given position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cputsxy (unsigned char x, unsigned char y, const char* s);/ <tag/Description/<tt/cputsxy/ moves the cursor to the given x/y position, and outputs the string <tt/s/. <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/cputsxy/ distinguishes between <tt/\r/ and <tt/\n/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cprintf" name="cprintf">, <ref id="cputc" name="cputc">, <ref id="cputcxy" name="cputcxy">, <ref id="cputs" name="cputs">, <ref id="vcprintf" name="vcprintf"> <tag/Example/None. </descrip> </quote> <sect1>cursor<label id="cursor"> <quote> <descrip> <tag/Function/Enable/disable a blinking cursor when waiting for keyboard input. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ cursor (unsigned char onoff);/ <tag/Description/If the argument to the function is non zero, a blinking cursor will be enabled when the <tt/cgetc/ function waits for input from the keyboard. If the argument is zero, <tt/cgetc/ will wait without a blinking cursor. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cgetc" name="cgetc">, <ref id="kbhit" name="kbhit"> <tag/Example/None. </descrip> </quote> <sect1>cvline<label id="cvline"> <quote> <descrip> <tag/Function/Output a vertical line in text mode. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cvline (unsigned char length);/ <tag/Description/The function outputs a vertical line with the given length starting at the current cursor position. <tag/Limits/<itemize> <item>The character used to draw the vertical line is system dependent. If available, a line drawing character is used. Drawing a line that is partially off screen leads to undefined behaviour. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="chline" name="chline">, <ref id="chlinexy" name="chlinexy">, <ref id="cvlinexy" name="cvlinexy"> <tag/Example/None. </descrip> </quote> <sect1>cvlinexy<label id="cvlinexy"> <quote> <descrip> <tag/Function/Output a vertical line at a given position in text mode. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ cvlinexy (unsigned char x, unsigned char y, unsigned char length);/ <tag/Description/The function outputs a vertical line with the given length starting at a given position. <tag/Limits/<itemize> <item>The character used to draw the vertical line is system dependent. If available, a line drawing character is used. Drawing a line that is partially off screen leads to undefined behaviour. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="chline" name="chline">, <ref id="chlinexy" name="chlinexy">, <ref id="cvline" name="cvline"> <tag/Example/None. </descrip> </quote> <sect1>div<label id="div"> <quote> <descrip> <tag/Function/Divide two ints and return quotient and remainder. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/div_t __fastcall__ div (int numer, int denom);/ <tag/Description/<tt/div/ divides <tt/numer/ by <tt/denom/ and returns the quotient and remainder in a <tt/div_t/ structure. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ ldiv <tag/Example/None. </descrip> </quote> <sect1>em_commit<label id="em_commit"> <quote> <descrip> <tag/Function/Commit changes into extended memory. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void em_commit (void);/ <tag/Description/Commit changes in the memory window to extended storage. If the contents of the memory window have been changed, these changes may be lost if <tt/<ref id="em_map" name="em_map">/, <tt/<ref id="em_use" name="em_use">/, <tt/<ref id="em_copyfrom" name="em_copyfrom">/ or <tt/<ref id="em_copyto" name="em_copyto">/ are called without calling <tt/em_commit/ first. <tag/Limits/<itemize> <item>Calling <tt/em_commit/ does not necessarily mean that changes to the memory window are discarded, it does just mean that the drivers is allowed to discard it. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function produces undefined results if no extended memory driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_load_driver" name="em_load_driver">, <ref id="em_map" name="em_map">, <ref id="em_use" name="em_use"> <tag/Example/None. </descrip> </quote> <sect1>em_copyfrom<label id="em_copyfrom"> <quote> <descrip> <tag/Function/Copy from extended into normal memory. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void __fastcall__ em_copyfrom (const struct em_copy* copy_data);/ <tag/Description/Copy data from extended memory into linear memory. Source and target addresses as well as the number of bytes to transfer are specified in the <tt/em_copy/ structure that is passed as a parameter. <tag/Limits/<itemize> <item>Calling <tt/em_copyfrom/ will invalidate the memory window, so if you made any changes to the data in the window, call <tt/<ref id="em_commit" name="em_commit">/ first, or the changes are lost. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function produces undefined results if no extended memory driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_commit" name="em_commit">, <ref id="em_copyto" name="em_copyto">, <ref id="em_load_driver" name="em_load_driver"> <tag/Example/None. </descrip> </quote> <sect1>em_copyto<label id="em_copyto"> <quote> <descrip> <tag/Function/Copy from normal into extended memory. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void __fastcall__ em_copyto (const struct em_copy* copy_data);/ <tag/Description/Copy data from linear into extended memory. Source and target addresses as well as the number of bytes to transfer are specified in the <tt/em_copy/ structure that is passed as a parameter. <tag/Limits/<itemize> <item>Calling <tt/em_copyto/ will invalidate the memory window, so if you made any changes to the data in the window, call <tt/<ref id="em_commit" name="em_commit">/ first, or the changes are lost. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function produces undefined results if no extended memory driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_commit" name="em_commit">, <ref id="em_copyfrom" name="em_copyfrom">, <ref id="em_load_driver" name="em_load_driver"> <tag/Example/None. </descrip> </quote> <sect1>em_install<label id="em_install"> <quote> <descrip> <tag/Function/Install an already loaded extended memory driver. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/unsigned char _fastcall__ em_install (void* driver);/ <tag/Description/The function installs an already loaded extended memory driver and returns an error code. The function may be used to install a driver linked statically to the program. <tag/Limits/<itemize> <item>Not all drivers are able to detect if the supported hardware is really present. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_load_driver" name="em_load_driver">, <ref id="em_uninstall" name="em_uninstall">, <ref id="em_unload" name="em_unload"> <tag/Example/None. </descrip> </quote> <sect1>em_load_driver<label id="em_load_driver"> <quote> <descrip> <tag/Function/Load and initialize an extended memory driver. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void __fastcall__ em_load_driver (const char* name);/ <tag/Description/Load an extended memory driver into memory and initialize it. The function returns an error code that tells if all this has been successful. <tag/Limits/<itemize> <item>Not all drivers are able to detect if the supported hardware is really present. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The driver is loaded by name, so currently you must know the type of extended memory that should be supported. There is no autodetect capability. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_unload" name="em_unload"> <tag/Example/None. </descrip> </quote> <sect1>em_map<label id="em_map"> <quote> <descrip> <tag/Function/Make a page of extended memory accessible. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void* __fastcall__ em_map (unsigned page);/ <tag/Description/The function maps one page of extended memory into linear memory and returns a pointer to the page frame. Depending on the hardware and driver, the data is either mapped into the address space or transfered into a buffer. If you don't need the actual contents of the page (for example because you're going to overwrite it completely), it is better to call <tt/<ref id="em_use" name="em_use">/ instead. <tt/em_use/ will not transfer the data if it is possible to avoid that. <tag/Limits/<itemize> <item>Calling <tt/em_map/ will invalidate the memory window, so if you made any changes to the data in the window, call <tt/<ref id="em_commit" name="em_commit">/ first, or the changes are lost. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function produces undefined results if no extended memory driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_commit" name="em_commit">, <ref id="em_load_driver" name="em_load_driver">, <ref id="em_use" name="em_use"> <tag/Example/None. </descrip> </quote> <sect1>em_pagecount<label id="em_pagecount"> <quote> <descrip> <tag/Function/Return the number of available extended memory pages. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/unsigned em_pagecount (void);/ <tag/Description/The function returns the size of the extended memory supported by the driver in 256 byte pages. <tag/Limits/<itemize> <item>The function returns zero if no extended memory driver is loaded. <item>The function may return zero if the supported hardware was not detected. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_load_driver" name="em_load_driver"> <tag/Example/None. </descrip> </quote> <sect1>em_uninstall<label id="em_uninstall"> <quote> <descrip> <tag/Function/Uninstall an already loaded extended memory driver. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/unsigned char em_uninstall (void);/ <tag/Description/The function uninstalls an already loaded extended memory driver but doesn't remove it from memory. <tag/Limits/<itemize> <item>If the driver has been loaded using <tt/<ref id="em_load_driver" name="em_load_driver">/, <tt/<ref id="em_unload" name="em_unload">/ should be used instead of <tt/em_uninstall/ so the driver is also removed from memory. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_install" name="em_install">, <ref id="em_load_driver" name="em_load_driver">, <ref id="em_unload" name="em_unload"> <tag/Example/None. </descrip> </quote> <sect1>em_unload<label id="em_unload"> <quote> <descrip> <tag/Function/Unload an extended memory driver. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/unsigned char em_unload (void);/ <tag/Description/The function unloads a loaded extended memory driver and frees all memory allocated for the driver. <tag/Limits/<itemize> <item>The function does nothing if no driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_load_driver" name="em_load_driver"> <tag/Example/None. </descrip> </quote> <sect1>em_use<label id="em_use"> <quote> <descrip> <tag/Function/Prepare an extended memory page for use. <tag/Header/<tt/<ref id="em.h" name="em.h">/ <tag/Declaration/<tt/void* __fastcall__ em_use (unsigned page);/ <tag/Description/The function maps one page of extended memory into linear memory and returns a pointer to the page frame. This function is similar to <tt/<ref id="em_map" name="em_map">/, but will not transfer data into the actual memory window in the assumption that the existing data is wrong or will get overwritten. <tag/Limits/<itemize> <item>Calling <tt/em_use/ will invalidate the memory window, so if you made any changes to the data in the window, call <tt/<ref id="em_commit" name="em_commit">/ first, or the changes are lost. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function produces undefined results if no extended memory driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="em_commit" name="em_commit">, <ref id="em_load_driver" name="em_load_driver">, <ref id="em_map" name="em_map"> <tag/Example/None. </descrip> </quote> <sect1>exit<label id="exit"> <quote> <descrip> <tag/Function/Terminate the program. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ exit (int status);/ <tag/Description/<tt/exit/ terminates the program. The argument specifies the return code of the program. Before termination, all files are closed, buffered output is written and any functions registered with <tt/<ref id="atexit" name="atexit">/ are called. Common values for status are <tt/EXIT_SUCCESS/ and <tt/EXIT_FAILURE/ which are also defined in <tt/<ref id="stdlib.h" name="stdlib.h">/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>It depends on the host machine if the program return code can be evaluated or is ignored. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abort" name="abort">, <ref id="exit" name="exit"> <tag/Example/None. </descrip> </quote> <sect1>exec<label id="exec"> <quote> <descrip> <tag/Function/Execute a program file. <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/ <tag/Declaration/<tt/int __fastcall__ exec (const char* progname, const char* cmdline);/ <tag/Description/<tt/exec/ replaces the currently running program by a new one. Calling <tt/exec()/ is identical to calling <tt/<ref id="exit" name="exit()">/, then loading and starting the program named in the first argument, passing the command line specified as second argument. Instead of an empty string, a <tt/NULL/ pointer may be passed as second parameter. On success, the function does not return. On failure, -1 is returned and <tt/errno/ contains an error code. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>On most platforms, the function needs to copy a small stub loader to some memory area outside the program space. This may collide with other programs. See the platform specific docs on this. <item>Because it is necessary to terminate the running program before the memory can be reused to load the new one, there is a high chance that the function may not be able to return on errors. <item>The command line is passed to the new program in the same way as cc65 programs expect the command line. If the new program is not a cc65 generated program, it may not be able to read it. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="exit" name="exit"> <tag/Example/None. </descrip> </quote> <sect1>fast<label id="fast"> <quote> <descrip> <tag/Function/Switch the C128 into 2MHz mode. <tag/Header/<tt/<ref id="c128.h" name="c128.h">/ <tag/Declaration/<tt/void fast (void);/ <tag/Description/The function will switch the clock of the C128 to 2MHz. This will nearly double the speed compared to slow mode. <tag/Limits/<itemize> <item>The function is specific to the C128. <item>2MHz clock will not work in 40 column mode. </itemize> <tag/Availability/C128 <tag/See also/ <ref id="slow" name="slow">, <ref id="toggle_videomode" name="toggle_videomode">, <ref id="videomode" name="videomode"> <tag/Example/None. </descrip> </quote> <sect1>feof<label id="feof"> <quote> <descrip> <tag/Function/Return the end-of-file indicator of a stream. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/int __fastcall__ feof (FILE* f);/ <tag/Description/<tt/feof/ tests the end-of-file indicator ofthe stream <tt/f/, and returns a non zero value if it is set. <tag/Limits/<itemize> <item>The indicator is set only after a read past the end of a file is attempted. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="feof" name="clearerr">, <ref id="ferror" name="ferror"> <tag/Example/None. </descrip> </quote> <sect1>ferror<label id="ferror"> <quote> <descrip> <tag/Function/Return the error indicator of a stream. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/int __fastcall__ ferror (FILE* f);/ <tag/Description/<tt/ferror/ tests the error indicator of the stream <tt/f/, and returns a non zero value if it is set. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="feof" name="clearerr">, <ref id="ferror" name="feof"> <tag/Example/None. </descrip> </quote> <sect1>fileno<label id="fileno"> <quote> <descrip> <tag/Function/Return the file handle used by a stream. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/int __fastcall__ fileno (FILE* f);/ <tag/Description/The <tt/fileno/ function returns the file handle used internally by a C stream. This file handle (an integer) can be used as a handle for the POSIX input/output functions. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Mixing C file I/O functions and POSIX file I/O functions for the same file may have unpredictable results. </itemize> <tag/Availability/POSIX 1003.1 <tag/See also/ <ref id="creat" name="creat">, <ref id="open" name="open">    <tag/Example/None. </descrip> </quote> <sect1>free<label id="free"> <quote> <descrip> <tag/Function/Free a block of dynamic memory. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ free (void* block);/ <tag/Description/Free a block of dynamic memory previously allocated with <tt/<ref id="malloc" name="malloc">/, <tt/<ref id="calloc" name="calloc">/ or <tt/<ref id="realloc" name="realloc">/. As an exception, if the passed pointer is <tt/NULL/, no action is performed. <tag/Limits/ <itemize> <item>Passing an already free'd block to <tt/free/ again will cause undefined behaviour and may crash your program. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="malloc" name="malloc">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>get_ostype<label id="get_ostype"> <quote> <descrip> <tag/Function/The function returns the operating system, the program runs on. <tag/Header/<tt/<ref id="apple2.h" name="apple2.h">, <ref id="atari.h" name="atari.h">, <ref id="c64.h" name="c64.h">/ <tag/Declaration/<tt/unsigned char get_ostype (void);/ <tag/Description/<tt/get_ostype/ is machine dependent and does not exist for all supported targets. If it exists, it returns a number that identifies the operating system or machine type, the program runs on. The machine dependent header files define constants that can be used to check the return code. <tag/Limits/<itemize> <item>The function does not exist on all platforms. <item>The return codes are platform dependent. </itemize> <tag/Availability/cc65 (not all platforms) <tag/Example/None. </descrip> </quote> <sect1>getcpu<label id="getcpu"> <quote> <descrip> <tag/Function/Determine on which CPU the program is running. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/unsigned char getcpu (void);/ <tag/Description/The function checks on which CPU the code is running. It returns one of the constants<itemize> <item><tt/CPU_6502/ <item><tt/CPU_65C02/ <item><tt/CPU_65816/ </itemize> <tag/Limits/<itemize> <item>Other, more exotic CPU types are not disinguished. </itemize> <tag/Availability/cc65 <tag/Example/None. </descrip> </quote> <sect1>getenv<label id="getenv"> <quote> <descrip> <tag/Function/Return a value from the environment. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/char* __fastcall__ getenv (const char* name);/ <tag/Description/The function searches the environment for an entry that matches <tt/name/ and returns its value. The environment consists of a list of strings in the form <tt/name=value/. If there is no match, <tt/getenv/ returns <tt/NULL/. <tag/Limits/<itemize> <item>What exactly is stored in the environment depends on the machine the program is running on. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/Example/None. </descrip> </quote> <sect1>getopt<label id="getopt"> <quote> <descrip> <tag/Function/Parse command line options. <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/ <tag/Declaration/<tt/int __fastcall__ getopt (int argc, char* const* argv, const char* optstring);/ <tag/Description/The function parses command line arguments, <tt/argc/ and <tt/argv/ are the argument count and array passed to <tt/main/. <tt/optstring/ is a string that contains command line option characters. If a character in <tt/optstring/ is followed by a colon, the option requires an argument. An option on the command line is recognized if it is one of the option characters preceeded by a '-'. <tt/getopt/ must be called repeatedly. It will return each option character found on the command line and <tt/EOF/ (-1) if there is no other option. An option argument is placed in <tt/optarg/, the index of the next element on the command line to be processed is placed in <tt/optind/. <tag/Limits/<itemize> <item>The implementation will not reorder options. A non option on the command line will terminate option processing. All remaining arguments are not recognized as options, even if the start with a '-' character. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/POSIX.2 <tag/Example/None. </descrip> </quote> <sect1>gotox<label id="gotox"> <quote> <descrip> <tag/Function/Move the text mode cursor to a new X position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ gotox (unsigned char x);/ <tag/Description/The function moves the text mode cursor to the specified X position while leaving the Y position untouched. The leftmost position on the screen has the coordinate 0. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Invalid values for the X position (out of screen coordinates) may lead to undefined behaviour. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="gotoy" name="gotoy">, <ref id="gotoxy" name="gotoxy">, <ref id="wherex" name="wherex">, <ref id="wherey" name="wherey"> <tag/Example/None. </descrip> </quote> <sect1>gotoxy<label id="gotoxy"> <quote> <descrip> <tag/Function/Move the text mode cursor to a new position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ gotoxy (unsigned char x, unsigned char y);/ <tag/Description/The function moves the text mode cursor to the specified position. The leftmost position on the screen has the X coordinate 0, the topmost line has the Y coordinate 0. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Invalid values for any of both coordinates (out of screen positions) may lead to undefined behaviour. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="gotox" name="gotox">, <ref id="gotoy" name="gotoy">, <ref id="wherex" name="wherex">, <ref id="wherey" name="wherey"> <tag/Example/None. </descrip> </quote> <sect1>gotoy<label id="gotoy"> <quote> <descrip> <tag/Function/Move the text mode cursor to a new Y position. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ gotoy (unsigned char x);/ <tag/Description/The function moves the text mode cursor to the specified Y position while leaving the X position untouched. The uppermost position on the screen has the coordinate 0. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Invalid values for the Y position (out of screen coordinates) may lead to undefined behaviour. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="gotox" name="gotox">, <ref id="gotoxy" name="gotoxy">, <ref id="wherex" name="wherex">, <ref id="wherey" name="wherey"> <tag/Example/None. </descrip> </quote> <sect1>isalnum<label id="isalnum"> <quote> <descrip> <tag/Function/Check if a given character is a letter or digit. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isalnum (int c);/ <tag/Description/The function returns a non zero value if the given argument is a letter or digit. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isalpha<label id="isalpha"> <quote> <descrip> <tag/Function/Check if a given character is a letter. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isalpha (int c);/ <tag/Description/The function returns a non zero value if the given argument is a letter. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isascii<label id="isascii"> <quote> <descrip> <tag/Function/Check if a given character is in the ASCII (0..127) range. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isascii (int c);/ <tag/Description/The function returns a non zero value if the given argument is in the range 0..127 (the range of valid ASCII characters) and zero if not. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isblank<label id="isblank"> <quote> <descrip> <tag/Function/Check if a given character is a space or tab. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isblank (int c);/ <tag/Description/The function returns a non zero value if the given argument is a space or tab character. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>iscntrl<label id="iscntrl"> <quote> <descrip> <tag/Function/Check if a given character is a control character. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ iscntrl (int c);/ <tag/Description/The function returns a non zero value if the given argument is a control character. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isdigit<label id="isdigit"> <quote> <descrip> <tag/Function/Check if a given character is a digit. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isdigit (int c);/ <tag/Description/The function returns a non zero value if the given argument is a digit. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isgraph<label id="isgraph"> <quote> <descrip> <tag/Function/Check if a given character is a printable character (except space). <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isgraph (int c);/ <tag/Description/The function returns a non zero value if the given argument is a printable character with the exception of space. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>islower<label id="islower"> <quote> <descrip> <tag/Function/Check if a given character is a lower case letter. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ islower (int c);/ <tag/Description/The function returns a non zero value if the given argument is a lower case letter. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isprint<label id="isprint"> <quote> <descrip> <tag/Function/Check if a given character is a printable character. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isprint (int c);/ <tag/Description/The function returns a non zero value if the given argument is a printable character (this includes the space character). The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>ispunct<label id="ispunct"> <quote> <descrip> <tag/Function/Check if a given character is a printable character but not a space or an alphanumeric character. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ ispunct (int c);/ <tag/Description/The function returns a non zero value if the given argument is a printable character, but not a space or anything alphanumeric. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isspace<label id="isspace"> <quote> <descrip> <tag/Function/Check if a given character is a a white-space character. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isspace (int c);/ <tag/Description/The function returns a non zero value if the given argument is a white space character. The return value is zero if the character is anything else. The standard white space characters are: space, formfeed ('\f'), newline ('\n'), carriage return ('\r'), horizontal tab ('\t'), and vertical tab ('\v'). <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isupper" name="isupper">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isupper<label id="isupper"> <quote> <descrip> <tag/Function/Check if a given character is an upper case letter. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isupper (int c);/ <tag/Description/The function returns a non zero value if the given argument is an upper case letter. The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isxdigit" name="isxdigit"> <tag/Example/None. </descrip> </quote> <sect1>isxdigit<label id="isxdigit"> <quote> <descrip> <tag/Function/Check if a given character is a hexadecimal digit. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ isxdigit (int c);/ <tag/Description/The function returns a non zero value if the given argument is a hexadecimal digit (0..9, a..f and A..F). The return value is zero if the character is anything else. <tag/Limits/<itemize> <item>When compiling with <tt/-Os/ the function is actually a macro. The inline sequence generated by the macro will not work correctly for values outside the range 0..255. <bf/Note:/ The constant <tt/EOF/ is not part of this range. The non inline function may be accessed by <tt/#undef/'ing the macro. <item>When compiling without <tt/-Os/, the function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="isalnum" name="isalnum">, <ref id="isalpha" name="isalpha">, <ref id="isascii" name="isascii">, <ref id="isblank" name="isblank">, <ref id="iscntrl" name="iscntrl">, <ref id="isdigit" name="isdigit">, <ref id="isgraph" name="isgraph">, <ref id="islower" name="islower">, <ref id="isprint" name="isprint">, <ref id="ispunct" name="ispunct">, <ref id="isspace" name="isspace">, <ref id="isupper" name="isupper"> <tag/Example/None. </descrip> </quote> <sect1>itoa<label id="itoa"> <quote> <descrip> <tag/Function/Convert an integer into a string. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/char* __fastcall__ itoa (int val, char* buf, int radix);/ <tag/Description/<tt/itoa/ converts the integer <tt/val/ into a string using <tt/radix/ as the base. <tag/Limits/<itemize> <item>There are no provisions to prevent a buffer overflow. <item>If <tt/val/ contains <tt/INT_MIN/, the behaviour is undefined. <item>The function is non standard, so it is not available in strict ANSI mode. You should probably use <tt/sprintf/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="atoi" name="atoi">, <ref id="atol" name="atol">, <ref id="ltoa" name="ltoa">, <ref id="ultoa" name="ultoa">, <ref id="utoa" name="utoa"> <tag/Example/None. </descrip> </quote> <sect1>joy_count<label id="joy_count"> <quote> <descrip> <tag/Function/Return the number of joysticks supported by the current driver. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char joy_count (void);/ <tag/Description/The function returns a the number of joysticks supported by the current joystick driver. <tag/Limits/<itemize> <item>A joystick driver must be loaded using <ref id="joy_load_driver" name="joy_load_driver"> before calling this function. <item>The function returns the number of joysticks supported by the driver. There's no way to check for the number of actually connected joysticks. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_load_driver" name="joy_load_driver">, <ref id="joy_read" name="joy_read"> <tag/Example/None. </descrip> </quote> <sect1>joy_install<label id="joy_install"> <quote> <descrip> <tag/Function/Install an already loaded driver and return an error code. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ joy_install (void* driver);/ <tag/Description/The function installs a driver that was already loaded into memory (or linked statically to the program). It returns an error code (<tt/JOY_ERR_OK/ in case of success). <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_load_driver" name="joy_load_driver">, <ref id="joy_uninstall" name="joy_uninstall">, <ref id="joy_unload" name="joy_unload"> <tag/Example/None. </descrip> </quote> <sect1>joy_load_driver<label id="joy_load_driver"> <quote> <descrip> <tag/Function/Load a driver from disk and install it. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ joy_load_driver (const char* driver);/ <tag/Description/The function loads a driver with the given name from disk and installs it. An error code is returned, which is <tt/JOY_ERR_OK/ if the driver was successfully loaded and installed. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_install" name="joy_install">, <ref id="joy_uninstall" name="joy_uninstall">, <ref id="joy_unload" name="joy_unload"> <tag/Example/None. </descrip> </quote> <sect1>joy_read<label id="joy_read"> <quote> <descrip> <tag/Function/Read the status of a joystick. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ joy_read (unsigned char joystick);/ <tag/Description/The function reads the status bits for a joystick. The number of the joystick is passed as parameter. The result may be examined by using one of the <tt/JOY_xxx/ macros from <ref id="joystick.h" name="joystick.h">. <tag/Limits/<itemize> <item>A joystick driver must be loaded using <ref id="joy_load_driver" name="joy_load_driver"> before calling this function. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_count" name="joy_count">, <ref id="joy_load_driver" name="joy_load_driver">, <ref id="joy_unload" name="joy_unload"> <tag/Example/None. </descrip> </quote> <sect1>joy_uninstall<label id="joy_uninstall"> <quote> <descrip> <tag/Function/Uninstall the current joystick driver. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char joy_uninstall (void);/ <tag/Description/The function uninstalls the currently installed joystick driver. It does not remove the driver from memory. The function returns an error code, which is <tt/JOY_ERR_OK/ if the driver was successfully uninstalled. <tag/Limits/<itemize> <item>A joystick driver must be installed using <ref id="joy_install" name="joy_install"> before calling this function. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_install" name="joy_install">, <ref id="joy_load_driver" name="joy_load_driver">, <ref id="joy_unload" name="joy_unload"> <tag/Example/None. </descrip> </quote> <sect1>joy_unload<label id="joy_unload"> <quote> <descrip> <tag/Function/Uninstall, then unload the current joystick driver. <tag/Header/<tt/<ref id="joystick.h" name="joystick.h">/ <tag/Declaration/<tt/unsigned char joy_unload (void);/ <tag/Description/The function uninstalls the currently installed joystick driver and removes it from memory. An error code is returned, which is <tt/JOY_ERR_OK/ if the driver was successfully uninstalled. <tag/Limits/<itemize> <item>A joystick driver must be loaded using <ref id="joy_load_driver" name="joy_load_driver"> before calling this function. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="joy_load_driver" name="joy_load_driver"> <tag/Example/None. </descrip> </quote> <sect1>kbhit<label id="kbhit"> <quote> <descrip> <tag/Function/Check if there's a key waiting in the keyboard buffer. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char kbhit (void);/ <tag/Description/The function returns a value of zero if there is no character waiting to be read from the keyboard. It returns non zero otherwise. <tag/Limits/<itemize> <item>If the system does not support a keyboard buffer (most systems do), the function is rather useless. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cgetc" name="cgetc">, <ref id="cursor" name="cursor"> <tag/Example/None. </descrip> </quote> <sect1>labs<label id="labs"> <quote> <descrip> <tag/Function/Returns the absolute value of a long integer. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/long __fastcall__ labs (long v);/ <tag/Description/<tt/labs/ returns the absolute value of the argument passed to the function. <tag/Limits/<itemize> <item>The return value is undefined if <tt/LONG_MIN/ is passed to the function. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abs" name="abs"> <tag/Example/None. </descrip> </quote> <sect1>ltoa<label id="ltoa"> <quote> <descrip> <tag/Function/Convert a long integer into a string. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/char* __fastcall__ ltoa (long val, char* buf, int radix);/ <tag/Description/<tt/itoa/ converts the long integer <tt/val/ into a string using <tt/radix/ as the base. <tag/Limits/<itemize> <item>There are no provisions to prevent a buffer overflow. <item>If <tt/val/ contains <tt/LONG_MIN/, the behaviour is undefined. <item>The function is non standard, so it is not available in strict ANSI mode. You should probably use <tt/sprintf/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="atoi" name="atoi">, <ref id="atol" name="atol">, <ref id="itoa" name="itoa">, <ref id="ultoa" name="ultoa">, <ref id="utoa" name="utoa"> <tag/Example/None. </descrip> </quote> <sect1>localeconv<label id="localeconv"> <quote> <descrip> <tag/Function/Returns a pointer to the current locale structure. <tag/Header/<tt/<ref id="locale.h" name="locale.h">/ <tag/Declaration/<tt/struct lconv* localeconv (void);/ <tag/Description/<tt/localeconv/ returns a pointer to the current locale structure. <tag/Limits/<itemize> <item>cc65 supports only the "C" locale, so even after setting a new locale using <tt/<ref id="setlocale" name="setlocale">/, the structure returned will always be the same. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="setlocale" name="setlocale"> <tag/Example/None. </descrip> </quote> <sect1>longjmp<label id="longjmp"> <quote> <descrip> <tag/Function/Non local goto. <tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/ <tag/Declaration/<tt/void __fastcall__ longjmp (jmp_buf buf, int retval);/ <tag/Description/The <tt/longjmp/ function restores a program context from the data in <tt/buf/, which must have been set by a preceeding call to <tt/<ref id="setjmp" name="setjmp">/. Program execution continues as if the call to <tt/<ref id="setjmp" name="setjmp">/ has just returned the value <tt/retval/. <tag/Limits/ <itemize> <item>If the parameter <tt/retval/ is zero, the function will behave as if it was called with a value of one. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="setjmp" name="setjmp"> <tag/Example/None. </descrip> </quote> <sect1>malloc<label id="malloc"> <quote> <descrip> <tag/Function/Allocate dynamic memory. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void* __fastcall__ malloc (size_t size);/ <tag/Description/<tt/malloc/ allocates size bytes on the heap and returns a pointer to the allocated memory block. On error (not enough memory available), <tt/malloc/ returns <tt/NULL/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="realloc" name="realloc">, <ref id="strdup" name="strdup"> <tag/Example/None. </descrip> </quote> <sect1>memchr<label id="memchr"> <quote> <descrip> <tag/Function/Search for a character in a block of raw memory. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/void* __fastcall__ strchr (const void* mem, int c, size_t count);/ <tag/Description/The <tt/memchr/ function locates the first occurrence of <tt/c/ (converted to a char) in the block of raw memory string pointed to by <tt/mem/ that is of size <tt/count/. Upon completion, the function returns a pointer to the character found, or a null pointer if the character was not found. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strchr" name="strchr"> <tag/Example/None. </descrip> </quote> <sect1>memcmp<label id="memcmp"> <quote> <descrip> <tag/Function/Compare two memory areas. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ memcmp (const void* p1, const void* p2, size_t count);/ <tag/Description/<tt/memcmp/ compares <tt/count/ bytes from the memory area pointed to by <tt/p1/ into the memory area pointed to by <tt/p2/. It returns a value that is less than zero if <tt/p1/ is less than <tt/p2/, zero if <tt/p1/ is the same as <tt/p2/, and a value greater than zero if <tt/p1/ is greater than <tt/p2/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcmp" name="strcmp">, <ref id="memmove" name="memmove">, <ref id="memset" name="memset"> <tag/Example/None. </descrip> </quote> <sect1>memcpy<label id="memcpy"> <quote> <descrip> <tag/Function/Copy a memory area. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/void* __fastcall__ memcpy (void* dest, const void* src, size_t count);/ <tag/Description/<tt/memcpy/ copies <tt/count/ bytes from the memory area pointed to by <tt/src/ into the memory area pointed to by <tt/dest/. It returns <tt/dest/. <tag/Limits/ <itemize> <item>The result is undefined if the memory areas do overlap. Use <tt/<ref id="memmove" name="memmove">/ to copy overlapping memory areas. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_swap" name="_swap">, <ref id="memmove" name="memmove">, <ref id="memset" name="memset"> <tag/Example/None. </descrip> </quote> <sect1>memmove<label id="memmove"> <quote> <descrip> <tag/Function/Copy a memory area. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/void* __fastcall__ memmove (void* dest, const void* src, size_t count);/ <tag/Description/<tt/memmove/ copies <tt/count/ bytes from the memory area pointed to by <tt/src/ into the memory area pointed to by <tt/dest/. It returns <tt/dest/. <tag/Limits/ <itemize> <item>While <tt/memmove/ allows the memory areas to overlap, it has some additional overhead compared to <tt/<ref id="memcpy" name="memcpy">/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_swap" name="_swap">, <ref id="memcpy" name="memcpy">, <ref id="memset" name="memset"> <tag/Example/None. </descrip> </quote> <sect1>memset<label id="memset"> <quote> <descrip> <tag/Function/Fill a memory area. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/void* __fastcall__ memset (void* p, int val, size_t count);/ <tag/Description/<tt/memset/ fills the memory area pointed to by <tt/p/ with the value <tt/val/. The function returns <tt/p/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_swap" name="_swap">, <ref id="bzero" name="bzero">, <ref id="memcpy" name="memcpy">, <ref id="memmove" name="memmove"> <tag/Example/None. </descrip> </quote> <sect1>mod_free<label id="mod_free"> <quote> <descrip> <tag/Function/Free a relocatable module. <tag/Header/<tt/<ref id="modload.h" name="modload.h">/ <tag/Declaration/<tt/void __fastcall__ mod_free (void* module);/ <tag/Description/The function will free a module loaded into memory by use of the <tt/<ref id="mod_load" name="mod_load">/ function. <tag/Limits/<itemize> <item>The pointer passed as parameter is the pointer to the module memory, not the pointer to the control structure. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mod_load" name="mod_load"> <tag/Example/None. </descrip> </quote> <sect1>mod_load<label id="mod_load"> <quote> <descrip> <tag/Function/Load a relocatable module. <tag/Header/<tt/<ref id="modload.h" name="modload.h">/ <tag/Declaration/<tt/unsigned char mod_load (struct mod_ctrl* ctrl);/ <tag/Description/The function will load a code module into memory and relocate it. The function will return an error code. If <tt/MLOAD_OK/ is returned, the outgoing fields in the passed <tt/mod_ctrl/ struct contain information about the module just loaded. Possible error codes are: <itemize> <item><tt/MLOAD_OK/ - Module load successful <item><tt/MLOAD_ERR_READ/ - Read error <item><tt/MLOAD_ERR_HDR/ - Header error <item><tt/MLOAD_ERR_OS/ - Wrong operating system <item><tt/MLOAD_ERR_FMT/ - Data format error <item><tt/MLOAD_ERR_MEM/ - Not enough memory </itemize> <tag/Limits/<itemize> <item>The <htmlurl url="ld65.html" name="ld65"> linker is needed to create relocatable o65 modules for use with this function. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mod_free" name="mod_free"> <tag/Example/None. </descrip> </quote> <sect1>mouse_setbox<label id="mouse_setbox"> <quote> <descrip> <tag/Function/Specify a bounding box for the mouse cursor. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void __fastcall__ mouse_setbox (const struct mouse_box* box);/ <tag/Description/The function allows to set a bounding box for mouse movement. <tag/Limits/<itemize> <item>The function does not check if the mouse cursor is currently within the given rectangle. Placing the mouse cursor within the bounding box is the responsibility of the programmer. <item>While the bounding box may be larger than the actual screen size, the standard mouse cursor draw routines may fail to set the cursor to coordinates outside of the screen area. Depending on the platform, you may have to supply your own mouse cursor routines. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_getbox" name="mouse_getbox">, <ref id="mouse_move" name="mouse_move"> <tag/Example/None. </descrip> </quote> <sect1>mouse_getbox<label id="mouse_getbox"> <quote> <descrip> <tag/Function/Return the current bounding box for the mouse cursor. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void __fastcall__ mouse_getbox (struct mouse_box* box);/ <tag/Description/The function queries the current bounding box for mouse movement. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_move" name="mouse_move">, <ref id="mouse_setbox" name="mouse_setbox"> <tag/Example/None. </descrip> </quote> <sect1>mouse_buttons<label id="mouse_buttons"> <quote> <descrip> <tag/Function/Return a bit mask encoding the state of the mouse buttons. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char mouse_buttons (void);/ <tag/Description/The function returns a bit mask that encodes the state of the mouse buttons. You may use the <tt/MOUSE_BTN_XXX/ flags to decode the function return value. <tag/Availability/cc65 <tag/See also/ <ref id="mouse_info" name="mouse_info">, <ref id="mouse_pos" name="mouse_pos"> <tag/Example/None. </descrip> </quote> <sect1>mouse_geterrormsg<label id="mouse_geterrormsg"> <quote> <descrip> <tag/Function/Return a readable error message for an error code. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/const char* __fastcall__ mouse_geterrormsg (unsigned char code);/ <tag/Description/The function returns an error message (in english) for the error code passed parameter. <tag/Limits/<itemize> <item>The function will return "Unknown error" for invalid error codes. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_load_driver" name="mouse_load_driver">, <ref id="mouse_uninstall" name="mouse_uninstall">, <ref id="mouse_unload" name="mouse_unload"> <tag/Example/None. </descrip> </quote> <sect1>mouse_hide<label id="mouse_hide"> <quote> <descrip> <tag/Function/Hide the mouse pointer. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void mouse_hide (void);/ <tag/Description/The function hides the mouse pointer. It manages a counter that is shared between <tt/<ref id="mouse_show" name="mouse_show">/ and <tt/mouse_hide/ so that every call call to <tt/mouse_hide/ must be followed by a call to <tt/<ref id="mouse_show" name="mouse_show">/ to make the mouse cursor visible. <tag/Availability/cc65 <tag/See also/ <ref id="mouse_show" name="mouse_show"> <tag/Example/None. </descrip> </quote> <sect1>mouse_info<label id="mouse_info"> <quote> <descrip> <tag/Function/Return the state of the mouse buttons and the position of the mouse. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void __fastcall__ mouse_info (struct mouse_info* info);/ <tag/Description/The function returns the state of the mouse buttons and the position of the mouse in the <tt/mouse_info/ structure passed as parameter. <tag/Limits/<itemize> <item>The <tt/mouse_info/ struct is a superset of the <tt/mouse_pos/ struct, so if you just need the mouse position, call <tt/<ref id="mouse_pos" name="mouse_pos">/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_buttons" name="mouse_buttons">, <ref id="mouse_pos" name="mouse_pos"> <tag/Example/None. </descrip> </quote> <sect1>mouse_install<label id="mouse_install"> <quote> <descrip> <tag/Function/Install an already loaded mouse driver. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ mouse_install (const struct mouse_callbacks* c, void* driver);/ <tag/Description/The function installs an already loaded mouse driver and returns an error code. The <tt/mouse_callbacks/ structure passed as first parameter contains pointers to routines needed to move or hide/show the mouse pointer. Defaults for these routines are supplied by the library, so if you can live with these defaults (which are platform specific), just pass a pointer to <tt/mouse_def_callbacks/. The function may be used to install a driver linked statically to the program. <tag/Limits/<itemize> <item>Not all drivers are able to detect if the supported hardware is really present. <item>After installing a driver, the mouse cursor is hidden. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_load_driver" name="mouse_load_driver">, <ref id="mouse_uninstall" name="mouse_uninstall">, <ref id="mouse_unload" name="mouse_unload"> <tag/Example/None. </descrip> </quote> <sect1>mouse_ioctl<label id="mouse_ioctl"> <quote> <descrip> <tag/Function/Call the driver specific ioctl function. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ mouse_ioctl (unsigned char code, void* data);/ <tag/Description/The function calls the IOCTL entry in the mouse driver, which is driver specific. The <tt/code/ parameter will choose between different IOCTL functions, and the <tt/data/ depends on code. The function returns an error code. The purpose of this function is to allow for driver specific extensions. See the documentation for a specific mouse driver for supported ioctl calls. <tag/Limits/<itemize> <item>Calling this function is non portable, because each driver may implement different ioctl calls (or none at all). <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/Example/None. </descrip> </quote> <sect1>mouse_load_driver<label id="mouse_load_driver"> <quote> <descrip> <tag/Function/Load and initialize a mouse driver. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ mouse_load_driver (const struct mouse_callbacks* c, const char* driver);/ <tag/Description/Load a mouse driver into memory and initialize it. The function returns an error code that tells if the call has been successful. The <tt/mouse_callbacks/ structure passed as first parameter contains pointers to routines needed to move or hide/show the mouse pointer. Defaults for these routines are supplied by the library, so if you can live with these defaults (which are platform specific), just pass a pointer to <tt/mouse_def_callbacks/. <tag/Limits/<itemize> <item>The driver is loaded by name, so currently you must know the type of mouse that should be supported. There is no autodetect capability. <item>Not all drivers are able to detect if the supported hardware is really present. <item>After installing a driver, the mouse cursor is hidden. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_install" name="mouse_install">, <ref id="mouse_uninstall" name="mouse_uninstall">, <ref id="mouse_unload" name="mouse_unload"> <tag/Example/None. </descrip> </quote> <sect1>mouse_move<label id="mouse_move"> <quote> <descrip> <tag/Function/Move the mouse cursor to a specific position. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void __fastcall__ mouse_move (int x, int y);/ <tag/Description/The function updates the mouse position. If the mouse cursor is visible, it is shown at the new position. <tag/Limits/<itemize> <item>The function does not check if the new position is within the bounding box specified with <tt/<ref id="mouse_setbox" name="mouse_setbox">/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_getbox" name="mouse_getbox">, <ref id="mouse_setbox" name="mouse_setbox"> <tag/Example/None. </descrip> </quote> <sect1>mouse_pos<label id="mouse_pos"> <quote> <descrip> <tag/Function/Return the position of the mouse. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void __fastcall__ mouse_pos (struct mouse_pos* pos);/ <tag/Description/The function returns the position of the mouse in the <tt/mouse_pos/ structure passed as parameter. <tag/Limits/<itemize> <item>The <tt/mouse_pos/ struct is a subset of the <tt/mouse_info/ struct, so if you do also need the mouse buttons, call <tt/<ref id="mouse_info" name="mouse_info">/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_buttons" name="mouse_buttons">, <ref id="mouse_info" name="mouse_info"> <tag/Example/None. </descrip> </quote> <sect1>mouse_show<label id="mouse_show"> <quote> <descrip> <tag/Function/Show the mouse pointer. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/void mouse_show (void);/ <tag/Description/The function shows the mouse pointer. It manages a counter that is shared between <tt/<ref id="mouse_hide" name="mouse_hide">/ and <tt/mouse_show/. The mouse cursor is visible if there was one more call to <tt/mouse_show/ than to <tt/<ref id="mouse_hide" name="mouse_hide">/. <tag/Availability/cc65 <tag/See also/ <ref id="mouse_hide" name="mouse_hide"> <tag/Example/None. </descrip> </quote> <sect1>mouse_uninstall<label id="mouse_uninstall"> <quote> <descrip> <tag/Function/Uninstall an already loaded mouse driver. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char mouse_uninstall (void);/ <tag/Description/The function uninstalls an already loaded mouse driver but don't removes it from memory. <tag/Limits/<itemize> <item>If the driver has been loaded using <tt/<ref id="mouse_load_driver" name="mouse_load_driver">/, <tt/<ref id="mouse_unload" name="mouse_unload">/ should be used instead of <tt/mouse_uninstall/ so the driver is also removed from memory. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_install" name="mouse_install">, <ref id="mouse_load_driver" name="mouse_load_driver">, <ref id="mouse_unload" name="mouse_unload"> <tag/Example/None. </descrip> </quote> <sect1>mouse_unload<label id="mouse_unload"> <quote> <descrip> <tag/Function/Unload a mouse driver. <tag/Header/<tt/<ref id="mouse.h" name="mouse.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ mouse_unload (void);/ <tag/Description/The function unloads a loaded mouse driver and frees all memory allocated for the driver. <tag/Limits/<itemize> <item>The function does nothing if no driver is loaded. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="mouse_install" name="mouse_install">, <ref id="mouse_load_driver" name="mouse_load_driver">, <ref id="mouse_uninstall" name="mouse_uninstall"> <tag/Example/None. </descrip> </quote> <sect1>offsetof<label id="offsetof"> <quote> <descrip> <tag/Function/Calculate the offset of a struct or union member. <tag/Header/<tt/<ref id="stddef.h" name="stddef.h">/ <tag/Declaration/<tt/size_t offsetof (type, member);/ <tag/Description/<tt/offsetof/ calculates the address offset of a <tt/struct/ or <tt/union/ member. <tag/Limits/<itemize> <item>The function is actually a macro. </itemize> <tag/Availability/ISO 9899 <tag/Example/None. </descrip> </quote> <sect1>open<label id="open"> <quote> <descrip> <tag/Function/Open and possibly create a file. <tag/Header/<tt/<ref id="fcntl.h" name="fcntl.h">/ <tag/Declaration/<tt/int open (const char* name, int flags, ...);/ <tag/Description/<tt/open/ opens a file and returns the file descriptor associated with it. On error, -1 is returned and an error code is stored in <tt/errno/. Several flags may be passed to <tt/open/ that change the behaviour. <tag/Limits/<itemize> <item>POSIX specifies an additional <tt/mode/ argument that may be passed to open, which is used as the permission mask when a new file is created. While cc65 allows to pass this argument, it is ignored. </itemize> <tag/Availability/POSIX 1003.1 <tag/See also/ <ref id="close" name="close">, <ref id="creat" name="creat"> <tag/Example/None. </descrip> </quote> <sect1>peekbsys<label id="peekbsys"> <quote> <descrip> <tag/Function/Read one byte from a location in the system bank. <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/, <tt/<ref id="cbm510.h" name="cbm510.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ peekbsys (unsigned addr);/ <tag/Description/<tt/peekbsys/ reads one byte from the given address in the system bank (bank 15) of the CBM PET-II machines and returns it. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>This function may be a macro depending on the compiler options. The actual function is accessible by #undef'ing the macro. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEK" name="PEEK">, <ref id="PEEKW" name="PEEKW">, <ref id="peekwsys" name="peekwsys">, <ref id="pokebsys" name="pokebsys">, <ref id="pokewsys" name="pokewsys"> <tag/Example/None. </descrip> </quote> <sect1>peekwsys<label id="peekwsys"> <quote> <descrip> <tag/Function/Read one word from a location in the system bank. <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/, <tt/<ref id="cbm510.h" name="cbm510.h">/ <tag/Declaration/<tt/unsigned __fastcall__ peekwsys (unsigned addr);/ <tag/Description/<tt/peekwsys/ reads one word from the given address in the system bank (bank 15) of the CBM PET-II machines and returns it. Following the usual 6502 conventions, the low byte is read from <tt/addr/, and the high byte is read from <tt/addr+1/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The order in which the two bytes are read is undefined. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="PEEK" name="PEEK">, <ref id="PEEKW" name="PEEKW">, <ref id="peekbsys" name="peekbsys">, <ref id="pokebsys" name="pokebsys">, <ref id="pokewsys" name="pokewsys"> <tag/Example/None. </descrip> </quote> <sect1>perror<label id="perror"> <quote> <descrip> <tag/Function/Print an error message for the error in <tt/errno/. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/void __fastcall__ perror (const char* s);/ <tag/Description/<tt/perror/ prints an error message to <tt/stderr/. If <tt/s/ is not <tt/NULL/ and not an empty string, it is printed followed by a colon and a blank. Then the error message for the current contents of <tt/errno/ is printed followed by a newline. The message output is the same as returned by <tt/<ref id="strerror" name="strerror">/ with an argument of <tt/errno/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_poserror" name="_poserror">, <ref id="strerror" name="strerror"> <tag/Example/None. </descrip> </quote> <sect1>pokebsys<label id="pokebsys"> <quote> <descrip> <tag/Function/Write one byte to a location in the system bank. <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/, <tt/<ref id="cbm510.h" name="cbm510.h">/ <tag/Declaration/<tt/void __fastcall__ pokebsys (unsigned addr, unsigned char val);/ <tag/Description/<tt/pokebsys/ writes one byte to the given address in the system bank (bank 15) of the CBM PET-II machines. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="POKE" name="POKE">, <ref id="POKEW" name="POKEW">, <ref id="peekbsys" name="peekbsys">, <ref id="peekwsys" name="peekwsys">, <ref id="pokewsys" name="pokewsys"> <tag/Example/None. </descrip> </quote> <sect1>pokewsys<label id="pokewsys"> <quote> <descrip> <tag/Function/Write one word to a location in the system bank. <tag/Header/<tt/<ref id="cbm610.h" name="cbm610.h">/, <tt/<ref id="cbm510.h" name="cbm510.h">/ <tag/Declaration/<tt/void __fastcall__ pokewsys (unsigned addr, unsigned val);/ <tag/Description/<tt/pokewsys/ writes one word to the given address in the system bank (bank 15) of the CBM PET-II machines. Following the usual 6502 conventions, the low byte of <tt/val/ is written to <tt/addr/, and the high byte is written to <tt/addr+1/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The order in which the two bytes are written is undefined. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="POKE" name="POKE">, <ref id="POKEW" name="POKEW">, <ref id="peekbsys" name="peekbsys">, <ref id="peekwsys" name="peekwsys">, <ref id="pokebsys" name="pokebsys"> <tag/Example/None. </descrip> </quote> <sect1>qsort<label id="qsort"> <quote> <descrip> <tag/Function/Sort an array. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ qsort (void* base, size_t count, size_t size, int (*compare) (const void*, const void*));/ <tag/Description/<tt/qsort/ sorts an array according to a given compare function <tt/compare/. <tt/base/ is the address of the array, <tt/count/ is the number of elements, <tt/size/ the size of an element and <tt/compare/ the function used to compare the members. <tag/Limits/ <itemize> <item>If there are multiple members with the same key, the order after calling the function is undefined. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="bsearch" name="bsearch"> <tag/Example/None. </descrip> </quote> <sect1>raise<label id="raise"> <quote> <descrip> <tag/Function/Send a signal to the executing program. <tag/Header/<tt/<ref id="signal.h" name="signal.h">/ <tag/Declaration/<tt/int __fastcall__ raise (int sig);/ <tag/Description/<tt/raise/ sends the given signal to the program. If the program has installed a signal handler for the signal, this signal handler will be executed. If no handler has been installed, the default action for the raised signal will be taken. The function returns zero on success, nonzero otherwise. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abort" name="abort">, <ref id="signal" name="signal"> <tag/Example/None. </descrip> </quote> <sect1>rand<label id="rand"> <quote> <descrip> <tag/Function/Return a pseudo random number. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/int rand (void);/ <tag/Description/The function returns a pseudo random number between 0 and <tt/RAND_MAX/ (exclusive). <tag/Limits/<itemize> <item>Without using <tt><ref id="srand" name="srand"></tt>, always the same flow of numbers is generated. <item>On startup, the function behaves as if <ref id="srand" name="srand"> had been used with an argument of 1. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_randomize" name="_randomize">, <ref id="srand" name="srand"> <tag/Example/None. </descrip> </quote> <sect1>realloc<label id="realloc"> <quote> <descrip> <tag/Function/Change the size of an allocated memory block. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void* __fastcall__ realloc (void* block, size_t size);/ <tag/Description/<tt/realloc/ changes the size of the memory block pointed to by <tt/block/ to <tt/size/ bytes. If <tt/block/ is <tt/NULL/, <tt/realloc/ behaves as if <tt/malloc/ had been called. If <tt/size/ is zero, <tt/realloc/ behaves as if <tt/free/ had been called. On error (not enough memory available), <tt/realloc/ returns <tt/NULL/. <tag/Limits/ <itemize> <item>The part of the memory block that is returned will have its contents unchanged. <item>This function is somewhat dangerous to use. Be careful to save the pointer you're passing somewhere else, otherwise <tscreen><verb> ptr = realloc (ptr, size); </verb></tscreen> will loose your only copy of <tt/ptr/ if <tt/realloc/ returns <tt/NULL/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_heapadd" name="_heapadd">, <ref id="_heapblocksize" name="_heapblocksize">, <ref id="_heapmaxavail" name="_heapmaxavail">, <ref id="_heapmemavail" name="_heapmemavail">, <ref id="calloc" name="calloc">, <ref id="free" name="free">, <ref id="realloc" name="realloc"> <tag/Example/None. </descrip> </quote> <sect1>remove<label id="remove"> <quote> <descrip> <tag/Function/Delete a file. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/int __fastcall__ remove (const char* name);/ <tag/Description/<tt/remove/ deletes the file with the given name. On success, zero is returned. On error, -1 is returned and <tt/errno/ is set to an error code describing the reason for the failure. <tag/Limits/ <itemize> <item>This function is not available on all cc65 targets (depends on the availability of file I/O). <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="rename" name="rename">, <ref id="unlink" name="unlink"> <tag/Example/ <verb> #include <stdio.h> #define FILENAME "helloworld" if (remove (FILENAME) == 0) { printf ("We deleted %s successfully\n", FILENAME); } else { printf ("There was a problem deleting %s\n", FILENAME); } </verb> </descrip> </quote> <sect1>rename<label id="rename"> <quote> <descrip> <tag/Function/Rename a file. <tag/Header/<tt/<ref id="stdio.h" name="stdio.h">/ <tag/Declaration/<tt/int __fastcall__ rename (const char* oldname, const char* newname);/ <tag/Description/<tt/rename/ renames a file (gives it a new name). On success, zero is returned. On error, -1 is returned and <tt/errno/ is set to an error code describing the reason for the failure. <tag/Limits/ <itemize> <item>This function is not available on all cc65 targets (depends on the capabilities of the storage devices). <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="remove" name="remove"> <tag/Example/ <verb> #include <stdio.h> #define OLDNAME "textfile.txt" #define NEWNAME "textfile.bak" if (rename (OLDNAME, NEWNAME) == 0) { printf ("Renamed %s to %s\n", OLDNAME, NEWNAME); } else { printf ("Error renaming %s to %s\n", OLDNAME, NEWNAME); } </verb> </descrip> </quote> <sect1>reset_brk<label id="reset_brk"> <quote> <descrip> <tag/Function/Resets the break vector to its original value. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void reset_brk (void);/ <tag/Description/<tt/reset_brk/ resets the break vector to the value it had before a call to <tt/set_brk/. <tag/Limits/ <itemize> <item>Since <tt/<ref id="set_brk" name="set_brk">/ installs an exit handler, it is not strictly necessary to call this function as part of the cleanup when the program ends. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="reset_irq" name="reset_irq">, <ref id="set_brk" name="set_brk">, <ref id="set_irq" name="set_irq"> <tag/Example/None. </descrip> </quote> <sect1>reset_irq<label id="reset_irq"> <quote> <descrip> <tag/Function/Resets the C level interrupt request vector. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void reset_irq (void);/ <tag/Description/<tt/reset_irq/ resets the C level interrupt request vector. <tag/Limits/ <itemize> <item>The original IRQ vector is restored on program termination even without calling this function. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="reset_brk" name="reset_brk">, <ref id="set_brk" name="set_brk">, <ref id="set_irq" name="set_irq"> <tag/Example/None. </descrip> </quote> <sect1>revers<label id="revers"> <quote> <descrip> <tag/Function/Control revers character display. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ revers (unsigned char onoff);/ <tag/Description/If the argument is non zero, the function enables reverse character display. If the argument is zero, reverse character display is switched off. The old value of the setting is returned. <tag/Limits/<itemize> <item>The function may not be supported by the hardware, in which case the call is ignored. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="textcolor" name="textcolor"> <tag/Example/None. </descrip> </quote> <sect1>screensize<label id="screensize"> <quote> <descrip> <tag/Function/Return the dimensions of the text mode screen. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/void __fastcall__ screensize (unsigned char* x, unsigned char* y);/ <tag/Description/The function returns the dimensions of the text mode screen. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="gotox" name="gotox">, <ref id="gotoxy" name="gotoxy">, <ref id="gotoy" name="gotoy">, <ref id="wherex" name="wherex">, <ref id="wherey" name="wherey"> <tag/Example/None. </descrip> </quote> <sect1>ser_close<label id="ser_close"> <quote> <descrip> <tag/Function/Close the port and disable interrupts <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char ser_close (void);/ <tag/Description/Close the port by clearing buffers and disable interrupts. <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/ <verb> #include <serial.h> extern char comlynx[]; static void initialize(){ struct ser_params params = { SER_BAUD_9600, SER_BITS_8, SER_STOP_1, SER_PAR_MARK, SER_HS_NONE }; ser_install(&comlynx); // This will activate the ComLynx CLI(); ser_open(&params); } </verb> </descrip> </quote> <sect1>ser_get<label id="ser_get"> <quote> <descrip> <tag/Function/Read a character from serial port. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_get (char* b);/ <tag/Description/Get a character from the serial port. If no characters are available, the function will return SER_ERR_NO_DATA, so this is not a fatal error. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/ Wait for a character to be available from a serial port. <verb> char ch; while (ser_get(&ch) == SER_ERR_NO_DATA) ; </verb> </descrip> </quote> <sect1>ser_install<label id="ser_install"> <quote> <descrip> <tag/Function/Install an already loaded driver and return an error code. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_install (void* driver);/ <tag/Description/The function installs a driver that was already loaded into memory (or linked statically to the program). It returns an error code (<tt/SER_ERR_OK/ in case of success). <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="ser_load_driver" name="ser_load_driver">, <ref id="ser_uninstall" name="ser_uninstall">, <ref id="ser_unload" name="ser_unload"> <tag/Example/<verb> extern char lynxser[]; //Include the driver statically instead of loading it. ser_install(&lynxser); </verb> </descrip> </quote> <sect1>ser_ioctl<label id="ser_ioctl"> <quote> <descrip> <tag/Function/Platform dependent code extensions. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned __fastcall__ ser_ioctl (unsigned char code, void* data);/ <tag/Description/Some platforms have extra serial functions that are not supported by standard serial driver functions. You can extend the driver to support this extra functionality bt using ser_ioctl functions. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>These functions are not easily portable to other cc65 platforms. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/None </descrip> </quote> <sect1>ser_load_driver<label id="ser_load_driver"> <quote> <descrip> <tag/Function/Load and install a serial driver. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_load_driver (const char *name);/ <tag/Description/Load and install the driver by name. Will just load the driver and check if loading was successful. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/None. </descrip> </quote> <sect1>ser_open<label id="ser_open"> <quote> <descrip> <tag/Function/Open the port by setting the port parameters and enable interrupts <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_open (const struct ser_params* params);/ <tag/Description/Open the port by setting the port parameters and enable interrupts. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/ <verb> #include <serial.h> extern char comlynx[]; static void initialize(){ struct ser_params params = { SER_BAUD_9600, SER_BITS_8, SER_STOP_1, SER_PAR_MARK, SER_HS_NONE }; ser_install(&comlynx); // This will activate the ComLynx CLI(); ser_open(&params); } </verb> </descrip> </quote> <sect1>ser_put<label id="ser_put"> <quote> <descrip> <tag/Function/Write a character to a serial port. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_put (char b);/ <tag/Description/Send a character via the serial port. There is a transmit buffer, but transmitting is not done via interrupt. The function returns SER_ERR_OVERFLOW if there is no space left in the transmit buffer. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/ <verb> ser_put('A'); </verb> </descrip> </quote> <sect1>ser_status<label id="ser_status"> <quote> <descrip> <tag/Function/Return the serial port status. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ ser_status (unsigned char* status);/ <tag/Description/Return the serial port status. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/None </descrip> </quote> <sect1>ser_uninstall<label id="ser_uninstall"> <quote> <descrip> <tag/Function/Uninstall the currently loaded driver but do not unload it. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char ser_uninstall (void);/ <tag/Description/Uninstall the currently loaded driver but do not unload it. <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/None. </descrip> </quote> <sect1>ser_unload<label id="ser_unload"> <quote> <descrip> <tag/Function/Uninstall, then unload the currently loaded driver. <tag/Header/<tt/<ref id="serial.h" name="serial.h">/ <tag/Declaration/<tt/unsigned char ser_unload (void);/ <tag/Description/Uninstall, then unload the currently loaded driver. <tag/Availability/cc65 <tag/See also/Other serial functions. <tag/Example/None. </descrip> </quote> <sect1>set_brk<label id="set_brk"> <quote> <descrip> <tag/Function/Set the break vector to a user function. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void __fastcall__ set_brk (brk_handler func);/ <tag/Description/<tt/set_brk/ allows a user program to handle breaks within the program code by letting the vector point to a user written C function. The runtime library installs a small stub that saves the registers into global variables that may be accessed (and changed) by the break handler. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The stub saves the zero page registers used by the C runtime and switches to a small break handler stack. This means that it is safe to execute C code, even if C code was interrupted. Be careful however not to use too many local variables, and do not enable stack checks for the handler function or any other function called from it. <item>The <tt/brk_pc/ variable points to the <tt/BRK/ instruction. If you want the continue with the interrupted code, you have to adjust <tt/brk_pc/, otherwise the <tt/BRK/ instruction will get executed over and over again. <item>Since <tt/set_brk/ installs an exit handler, it is not strictly necessary to call <tt/<ref id="reset_brk" name="reset_brk">/ as part of the cleanup when the program terminates. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="reset_brk" name="reset_brk"> <tag/Example/None. </descrip> </quote> <sect1>set_irq<label id="set_irq"> <quote> <descrip> <tag/Function/Set the C level interrupt request vector to the given address. <tag/Header/<tt/<ref id="6502.h" name="6502.h">/ <tag/Declaration/<tt/void __fastcall__ set_irq (irq_handler f, void *stack_addr, size_t stack_size);/ <tag/Description/<tt/set_irq/ allows a user program to handle interrupt requests (IRQs) within the program code by letting the vector point to a user written C function. The runtime library installs a small stub that saves the zero page registers used by the C runtime before calling the handler function and restores them after the handler function returns. Additionally the stub temporarily switches the C runtime stack to the stack area provided as parameter. If the handler function was set up to handle a "private", "exclusive" interrupt request source it must return the value <tt/IRQ_HANDLED/ if and only if it has verified that the current interrupt request actually stems from that source. In all other cases it must return the value <tt/IRQ_NOT_HANDLED/. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The stub saves the registers and zero page locations used by the C runtime and switches to the provided stack area. As a consequence, there is some runtime overhead, but it it is safe to execute C code, even if other C code was interrupted. Be careful however not to call C library functions, and do not enable stack checks for the handler function or any other function called from it. <item>The interrupt vector is reset on function termination, so it's not strictly necessary to call <tt/<ref id="reset_irq" name="reset_irq">/ as part of the cleanup when the program terminates. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="reset_brk" name="reset_brk">, <ref id="reset_irq" name="reset_irq">, <ref id="set_brk" name="set_brk"> <tag/Example/None. </descrip> </quote> <sect1>setjmp<label id="setjmp"> <quote> <descrip> <tag/Function/Save the context for use with <tt/longjmp/. <tag/Header/<tt/<ref id="setjmp.h" name="setjmp.h">/ <tag/Declaration/<tt/int __fastcall__ setjmp (jmp_buf buf);/ <tag/Description/The <tt/setjmp/ function saves the current context in <tt/buf/ for subsequent use by the <tt/<ref id="longjmp" name="longjmp">/ function and returns zero. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item><tt/setjmp/ is actually a macro as required by the ISO standard. <item><tt/setjmp/ will not save the signal context. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="longjmp" name="longjmp"> <tag/Example/None. </descrip> </quote> <sect1>setlocale<label id="setlocale"> <quote> <descrip> <tag/Function/Selects a locale. <tag/Header/<tt/<ref id="locale.h" name="locale.h">/ <tag/Declaration/<tt/char* __fastcall__ setlocale (int category, const char* locale);/ <tag/Description/<tt/setlocale/ sets or queries the program's locale. <tag/Limits/ <itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>cc65 supports only the "C" locale, so calling this function to set a different locale has no effect. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="localeconv" name="localeconv">, <ref id="strcoll" name="strcoll"> <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>signal<label id="signal"> <quote> <descrip> <tag/Function/Install a signal handler. <tag/Header/<tt/<ref id="signal.h" name="signal.h">/ <tag/Declaration/<tt/__sigfunc __fastcall__ signal (int sig, __sigfunc func);/ <tag/Description/<tt/signal/ installs a handler for the given signal. The handler may either be a user supplied function, or one of the predefined signal handlers <tt/SIG_IGN/ or <tt/SIG_DFL/. The function returns the previous value if the signal , or the special function vector SIG_ERR in case of an error. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="abort" name="abort">, <ref id="raise" name="raise"> <tag/Example/None. </descrip> </quote> <sect1>sleep<label id="sleep"> <quote> <descrip> <tag/Function/Sleep for a specified amount of time. <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/ <tag/Declaration/<tt/void __fastcall__ sleep (unsigned seconds);/ <tag/Description/The function will return after the specified number of seconds have elapsed. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/POSIX 1003.1 <tag/Example/None. </descrip> </quote> <sect1>slow<label id="slow"> <quote> <descrip> <tag/Function/Switch the C128 into 1MHz mode. <tag/Header/<tt/<ref id="c128.h" name="c128.h">/ <tag/Declaration/<tt/void slow (void);/ <tag/Description/The function will switch the clock of the C128 to 1MHz. This will halve the speed compared to fast mode. <tag/Limits/<itemize> <item>The function is specific to the C128. </itemize> <tag/Availability/C128 <tag/See also/ <ref id="fast" name="fast">, <ref id="toggle_videomode" name="toggle_videomode">, <ref id="videomode" name="videomode"> <tag/Example/None. </descrip> </quote> <sect1>srand<label id="srand"> <quote> <descrip> <tag/Function/Initialize the pseudo random number generator. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/void __fastcall__ srand (unsigned seed);/ <tag/Description/The function initializes the random number generator using the given seed. On program startup, the generator behaves as if <tt/srand/ has been called with an argument of 1. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_randomize" name="_randomize">, <ref id="rand" name="rand"> <tag/Example/None. </descrip> </quote> <sect1>strcasecmp<label id="strcasecmp"> <quote> <descrip> <tag/Function/Compare two strings case insensitive. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ strcasecmp (const char* s1, const char* s2);/ <tag/Description/The <tt/strcasecmp/ function compares the two strings passed as parameters without case sensitivity. It returns a value that is less than zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater than zero if <tt/s1/ is greater than <tt/s2/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function is not available in strict ANSI mode. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="strcmp" name="strcmp">, <ref id="strcoll" name="strcoll">, <ref id="stricmp" name="stricmp">, <ref id="strncmp" name="strncmp">, <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>strcat<label id="strcat"> <quote> <descrip> <tag/Function/Concatentate two strings. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strcat (char* s1, const char* s2);/ <tag/Description/The <tt/strcat/ function appends a copy of the string pointed to by s2 (including the terminating null byte) to the end of the string pointed to by s1. The initial byte of s2 overwrites the null byte at the end of s1. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>If copying takes place between objects that overlap, the behaviour is undefined. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcpy" name="strcpy">, <ref id="strncat" name="strncat">, <ref id="strncpy" name="strncpy"> <tag/Example/None. </descrip> </quote> <sect1>strchr<label id="strchr"> <quote> <descrip> <tag/Function/Search for a character in a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strchr (const char* s, int c);/ <tag/Description/The <tt/strchr/ function locates the first occurrence of <tt/c/ (converted to a char) in the string pointed to by <tt/s/. The terminating null byte is considered to be part of the string. Upon completion, the function returns a pointer to the byte, or a null pointer if the byte was not found. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="memchr" name="memchr">, <ref id="strrchr" name="strrchr"> <tag/Example/None. </descrip> </quote> <sect1>strcmp<label id="strcmp"> <quote> <descrip> <tag/Function/Compare two strings. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ strcmp (const char* s1, const char* s2);/ <tag/Description/The <tt/strcmp/ function compares the two strings passed as parameters. It returns a value that is less than zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater than zero if <tt/s1/ is greater than <tt/s2/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcasecmp" name="strcasecmp">, <ref id="strcoll" name="strcoll">, <ref id="stricmp" name="stricmp">, <ref id="strncmp" name="strncmp"> <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>strcoll<label id="strcoll"> <quote> <descrip> <tag/Function/Compare two strings. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ strcoll (const char* s1, const char* s2);/ <tag/Description/The <tt/strcoll/ function compares the two strings passed as parameters, according to the collating sequence set by <tt/<ref id="setlocale" name="setlocale">/. It returns a value that is less than zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater than zero if <tt/s1/ is greater than <tt/s2/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="setlocale" name="setlocale">, <ref id="strcasecmp" name="strcasecmp">, <ref id="strcmp" name="strcmp">, <ref id="stricmp" name="stricmp">, <ref id="strncmp" name="strncmp">, <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>strcpy<label id="strcpy"> <quote> <descrip> <tag/Function/Copy a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strcpy (char* s1, const char* s2);/ <tag/Description/The <tt/strcpy/ function copies the string pointed to by <tt/s2/ (including the terminating null byte) into the array pointed to by <tt/s1/. The function will always return <tt/s1/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>If copying takes place between objects that overlap, the behaviour is undefined. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcat" name="strcat">, <ref id="strncat" name="strncat">, <ref id="strncpy" name="strncpy"> <tag/Example/ <verb> #include <string.h> static char hello[14]; strcpy (hello, "Hello world!\n"); </verb> </descrip> </quote> <sect1>strcspn<label id="strcspn"> <quote> <descrip> <tag/Function/Compute the length of a substring. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/size_t __fastcall__ strcspn (const char* s, const char* set);/ <tag/Description/The <tt/strcspn/ function computes and returns the length of the substring pointed to by <tt/s/ which does not consist of characters contained in the string <tt/set/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strspn" name="strspn">, <ref id="strstr" name="strstr">, <ref id="strtok" name="strtok"> <tag/Example/None. </descrip> </quote> <sect1>strdup<label id="strdup"> <quote> <descrip> <tag/Function/Allocate a copy of a string on the heap. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strdup (const char* s);/ <tag/Description/<tt/strdup/ allocates a memory block on the heap, big enough to hold a copy of <tt/s/ including the terminating zero. If the allocation fails, <tt/NULL/ is returned, otherwise <tt/s/ is copied into the allocated memory block, and a pointer to the block is returned. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>It is up to the caller to free the allocated memory block. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="free" name="free">, <ref id="malloc" name="malloc"> <tag/Example/None. </descrip> </quote> <sect1>strerror<label id="strerror"> <quote> <descrip> <tag/Function/Return a string describing an error code. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strerror (int errcode);/ <tag/Description/The <tt/strerror/ function returns a string describing the given error code. If an invalid error code is passed, the string "Unknown error" is returned, and <tt/errno/ is set to <tt/EINVAL/. In all other cases, <tt/errno/ is left untouched. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>While the return type of the function is a <tt/char*/, the returned string must not be modified by the caller! </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="_stroserror" name="_stroserror"> <tag/Example/None. </descrip> </quote> <sect1>stricmp<label id="stricmp"> <quote> <descrip> <tag/Function/Compare two strings case insensitive. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ stricmp (const char* s1, const char* s2);/ <tag/Description/The <tt/stricmp/ function compares the two strings passed as parameters without case sensitivity. It returns a value that is less than zero if <tt/s1/ is less than <tt/s2/, zero if <tt/s1/ is the same as <tt/s2/, and a value greater than zero if <tt/s1/ is greater than <tt/s2/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function is not available in strict ANSI mode. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="strcasecmp" name="strcasecmp">, <ref id="strcmp" name="strcmp">, <ref id="strcoll" name="strcoll">, <ref id="strncmp" name="strncmp">, <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>strlen<label id="strlen"> <quote> <descrip> <tag/Function/Return the length of a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/size_t __fastcall__ strlen (const char* s);/ <tag/Description/The <tt/strlen/ function computes the number of bytes in the string to which s points, not including the terminating null byte. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>When compiling with <tt/-Os/ (inline known standard functions), the function does not work correctly for strings with more than 255 characters. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcpy" name="strcpy"> <tag/Example/None. </descrip> </quote> <sect1>strlower<label id="strlower"> <quote> <descrip> <tag/Function/Make a string lower case. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strlower (char* s);/ <tag/Description/The <tt/strlower/ function will apply the <tt/tolower/ function to each character of a string. The function will always return <tt/s/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function prototype is unavailable when compiling in strict ANSI mode. <item>An alias name for this function is <tt/strlwr/. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="strupper" name="strupper">, <ref id="tolower" name="tolower"> <tag/Example/None. </descrip> </quote> <sect1>strlwr<label id="strlwr"> <quote> See <tt/strlower/. </quote> <sect1>strncat<label id="strncat"> <quote> <descrip> <tag/Function/Concatentate two strings. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strncat (char* s1, const char* s2, size_t n);/ <tag/Description/The <tt/strncat/ function appends not more than n characters of the string pointed to by s2 to the end of the string pointed to by s1. The terminating null character at the end of s1 is overwritten. A terminating null character is appended to the result, even if not all of s2 is appended to s1. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>If copying takes place between objects that overlap, the behaviour is undefined. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcpy" name="strcpy">, <ref id="strncat" name="strncat">, <ref id="strncpy" name="strncpy"> <tag/Example/None. </descrip> </quote> <sect1>strncmp<label id="strncmp"> <quote> <descrip> <tag/Function/Compare two strings. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/int __fastcall__ strncmp (const char* s1, const char* s2, size_t count);/ <tag/Description/The <tt/strncmp/ function compares not more than <tt/count/ characters of the two strings passed as parameters. It returns a value that is less than zero if the first <tt/count/ characters of <tt/s1/ are less than <tt/s2/, zero if they are identical, and a value greater than zero they are greater. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcasecmp" name="strcasecmp">, <ref id="strcmp" name="strcmp">, <ref id="strcoll" name="strcoll">, <ref id="stricmp" name="stricmp">, <ref id="strxfrm" name="strxfrm"> <tag/Example/None. </descrip> </quote> <sect1>strncpy<label id="strncpy"> <quote> <descrip> <tag/Function/Copy part of a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strcpy (char* s1, const char* s2, size_t n);/ <tag/Description/The <tt/strncpy/ function copies not more than n bytes from the array pointed to by <tt/s2/ to the array pointed to by <tt/s1/. If the array pointed to by <tt/s2/ is a string that is shorter than n bytes, null bytes are appended to the copy in the array pointed to by <tt/s1/, until <tt/n/ bytes are written. The function will always return <tt/s1/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. If there is no null byte in the first <tt/n/ bytes of the array pointed to by <tt/s2/, the result is not null-terminated. <item>If copying takes place between objects that overlap, the behaviour is undefined. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcat" name="strcat">, <ref id="strcpy" name="strcpy">, <ref id="strncat" name="strncat"> <tag/Example/ <verb> #include <string.h> static char hello[6]; strcpy (hello, "Hello world!\n", sizeof (hello) - 1); hello[5] = '\0'; </verb> </descrip> </quote> <sect1>strrchr<label id="strrchr"> <quote> <descrip> <tag/Function/Search for a character in a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strrchr (const char* s, int c);/ <tag/Description/The <tt/strrchr/ function locates the last occurrence of <tt/c/ (converted to a char) in the string pointed to by <tt/s/. The terminating null byte is considered to be part of the string. Upon completion, the function returns a pointer to the byte, or a null pointer if the byte was not found. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strchr" name="strchr"> <tag/Example/None. </descrip> </quote> <sect1>strspn<label id="strspn"> <quote> <descrip> <tag/Function/Compute the length of a substring. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/size_t __fastcall__ strspn (const char* s, const char* set);/ <tag/Description/The <tt/strspn/ function computes and returns the length of the substring pointed to by <tt/s/ which does consist only of characters contained in the string <tt/set/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcspn" name="strcspn">, <ref id="strstr" name="strstr"> <tag/Example/None. </descrip> </quote> <sect1>strstr<label id="strstr"> <quote> <descrip> <tag/Function/Find a substring. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strstr (const char* str, const char* substr);/ <tag/Description/<tt/strstr/ searches for the first occurance of the string <tt/substr/ within <tt/str/. If found, it returns a pointer to the copy, otherwise it returns <tt/NULL/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcspn" name="strcspn">, <ref id="strspn" name="strspn"> <tag/Example/None. </descrip> </quote> <sect1>strtok<label id="strtok"> <quote> <descrip> <tag/Function/Break a string into tokens. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strtok (char* s1, const char* s2);/ <tag/Description/<tt/strtok/ will break the string s1 into a sequence of tokens, which are delimited by characters from the string s2. The first call to <tt/strtok/ will return a pointer to the first token in the string s1. Following calls must pass a <tt/NULL/ pointer as s1 in order to get the next token in the string. Different sets of delimiters may be used for the subsequent calls to <tt/strtok/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item><tt/strtok/ will modify the string s1. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcspn" name="strcspn">,  <tag/Example/None. </descrip> </quote> <sect1>strxfrm<label id="strxfrm"> <quote> <descrip> <tag/Function/Transform a string. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/size_t __fastcall__ strxfrm (char* s1, const char* s2, size_t n);/ <tag/Description/The <tt/strxfrm/ function transforms the string pointed to by s2 and places the resulting string into the string pointed to by s1. The transformation is such that if the <tt/strcmp/ function is applied to two transformed strings, it returns a value greater than, equal to, or less than zero, corresponding to the result of the <tt/strcoll/ function applied to the same two original strings. No more than n characters are placed into the resulting array pointed to by s1, including the terminating null character. <tag/Limits/<itemize> <item><tt/s1/ and <tt/s2/ must not point to the same memory area, otherwise the behaviour is undefined. <item>If <tt/n/ is zero, <tt/s1/ may be a NULL pointer. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Since cc65 doesn't support different charcter sets, <tt/strxfrm/ will just copy s2 to s1 using <tt><ref id="strncpy" name="strncpy"></tt>. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="strcmp" name="strcmp">, <ref id="strcoll" name="strcoll">, <ref id="strncpy" name="strncpy"> <tag/Example/None. </descrip> </quote> <sect1>strupper<label id="strupper"> <quote> <descrip> <tag/Function/Make a string upper case. <tag/Header/<tt/<ref id="string.h" name="string.h">/ <tag/Declaration/<tt/char* __fastcall__ strupper (char* s);/ <tag/Description/The <tt/strupper/ function will apply the <tt/toupper/ function to each character of a string. The function will always return <tt/s/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function prototype is unavailable when compiling in strict ANSI mode. <item>An alias name for this function is <tt/strupr/. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="strlower" name="strlower"> <ref id="toupper" name="toupper"> <tag/Example/None. </descrip> </quote> <sect1>strupr<label id="strupr"> <quote> See <tt/strupper/. </quote> <sect1>textcolor<label id="textcolor"> <quote> <descrip> <tag/Function/Set the text color. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ textcolor (unsigned char color);/ <tag/Description/The function will set a new text color. It returns the old (current) text color. Text output using any <tt/conio.h/ function will use the color set by this function. <tag/Limits/<itemize> <item>Text colors are system dependent. The function may have no effect on systems where the text color cannot be changed. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="bgcolor" name="bgcolor">, <ref id="bordercolor" name="bordercolor"> <tag/Example/None. </descrip> </quote> <sect1>tgi_arc<label id="tgi_arc"> <quote> <descrip> <tag/Function/Draw an elliptic arc in the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_arc (int x, int y, unsigned char rx, unsigned char ry, unsigned sa, unsigned ea);/ <tag/Description/The function draws an elliptic arc with center at x/y and radii rx/ry using the current drawing color. The arc covers the angle between sa and ea (startangle and endangle), which must be in the range 0..360. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function behaves unexpectedly or may crash if the angles are out of range. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_bar" name="tgi_bar">, <ref id="tgi_circle" name="tgi_circle">, <ref id="tgi_ellipse" name="tgi_ellipse">, <ref id="tgi_pieslice" name="tgi_pieslice">, <ref id="tgi_setcolor" name="tgi_setcolor"> <tag/Example/<verb> /* Draw the upper half of an ellipse */ tgi_setcolor(TGI_COLOR_BLUE); tgi_arc (50, 50, 40, 20, 0, 180); </verb> </descrip> </quote> <sect1>tgi_bar<label id="tgi_bar"> <quote> <descrip> <tag/Function/The function fills a rectangle on the drawpage with the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_bar (int x1, int y1, int x2, int y2);/ <tag/Description/The function fills a rectangle on the drawpage with the current color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi function <tag/Example/<verb> tgi_setcolor(TGI_COLOR_GREEN); tgi_bar(10, 10, 100, 60); </verb> </descrip> </quote> <sect1>tgi_circle<label id="tgi_circle"> <quote> <descrip> <tag/Function/The function draws a circle in the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_circle (int x, int y, unsigned char radius);/ <tag/Description/The function draws a circle in the current color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_arc" name="tgi_arc">, <ref id="tgi_bar" name="tgi_bar">, <ref id="tgi_ellipse" name="tgi_ellipse">, <ref id="tgi_pieslice" name="tgi_pieslice">, <ref id="tgi_setcolor" name="tgi_setcolor"> <tag/Example/<verb> tgi_setcolor(TGI_COLOR_BLACK); tgi_circle(50, 40, 40); </verb> </descrip> </quote> <sect1>tgi_clear<label id="tgi_clear"> <quote> <descrip> <tag/Function/Clear the drawpage <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void tgi_clear (void);/ <tag/Description/Clear the drawpage <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_done<label id="tgi_done"> <quote> <descrip> <tag/Function/End graphics mode, switch back to text mode. Will NOT uninstall or unload the driver! <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void tgi_done (void);/ <tag/Description/End graphics mode, switch back to text mode. Will NOT uninstall or unload the driver! <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_ellipse<label id="tgi_ellipse"> <quote> <descrip> <tag/Function/The function draws an ellipse in the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_ellipse (int x, int y, unsigned char rx, unsigned char ry);/ <tag/Description/The function draws an ellipse at position x/y with radii rx and ry, using the current drawing color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_arc" name="tgi_arc">, <ref id="tgi_bar" name="tgi_bar">, <ref id="tgi_circle" name="tgi_circle">, <ref id="tgi_pieslice" name="tgi_pieslice">, <ref id="tgi_setcolor" name="tgi_setcolor"> <tag/Example/<verb> tgi_setcolor(TGI_COLOR_RED); tgi_ellipse (50, 40, 40, 20); </verb> </descrip> </quote> <sect1>tgi_getaspectratio<label id="tgi_getaspectratio"> <quote> <descrip> <tag/Function/Return the pixel aspect ratio. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getaspectratio (void);/ <tag/Description/The function returns the pixel aspect ratio for the current driver and display as an 8.8 fixed point value. It may be used to correct geometric shapes so they look correct on the display. As an example, a circle with a radius of 100 pixels may look elliptic on some driver/display combinations if the aspect ratio is not 1.00. <tag/Limits/<itemize> <item>The aspect ratio is encoded in the TGI driver which assumes a "standard" monitor for the given platform. The aspect ratio may be wrong if another monitor is used. <item>No TGI function will use the aspect ratio. It is up to the programmer to make use of it. <item>The <ref id="tgi_setaspectratio" name="tgi_setaspectratio"> function can be used to change the aspect ratio for a loaded driver. The value is not reset by <ref id="tgi_init" name="tgi_init">, so if a driver is linked statically to an application, switching into and out of graphics mode will not restore the original aspect ratio. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_setaspectratio" name="tgi_setaspectratio"> <tag/Example/None. </descrip> </quote> <sect1>tgi_getcolor<label id="tgi_getcolor"> <quote> <descrip> <tag/Function/Return the current drawing color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char tgi_getcolor (void);/ <tag/Description/The actual color is an index to a palette. During tgi_init you will get a default palette. The number of colors depend on the platform. All platforms recognize at least TGI_COLOR_BLACK and TGI_COLOR_WHITE. But some platforms have many more predefined colors. If you paint using TGI_COLOR_GREEN and then you change the green of the palette to blue using tgi_setpalette then after this painting in TGI_COLOR_GREEN will actually be blue. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/<verb> color = tgi_getcolor(); </verb> </descrip> </quote> <sect1>tgi_getcolorcount<label id="tgi_getcolorcount"> <quote> <descrip> <tag/Function/Get the number of available colors. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char tgi_getcolorcount (void);/ <tag/Description/Tgi platforms use indexed color palettes. This function returns the number of entries we can use in the palette. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/<verb> if (tgi_getcolorcount() == 2) { printf("Only monochrome graphics is supported\n"); } </verb> </descrip> </quote> <sect1>tgi_getdefpalette<label id="tgi_getdefpalette"> <quote> <descrip> <tag/Function/Get the palette installed by default. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/const unsigned char* tgi_getdefpalette (void);/ <tag/Description/The tgi driver has a default palette that is active at startup. The named colors TGI_COLOR_BLACK, TGI_COLOR_WHITE, TGI_COLOR_RED... need this palette to work correctly. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_geterror<label id="tgi_geterror"> <quote> <descrip> <tag/Function/Return the error code for the last operation. This will also clear the error. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char tgi_geterror (void);/ <tag/Description/Return the error code for the last operation. This will also clear the error. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_geterrormsg<label id="tgi_geterrormsg"> <quote> <descrip> <tag/Function/Get an error message describing the error. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/const char* __fastcall__ tgi_geterrormsg (unsigned char code);/ <tag/Description/Get an error message describing the error. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_getmaxcolor<label id="tgi_getmaxcolor"> <quote> <descrip> <tag/Function/Get the highest index of the palette. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char tgi_getmaxcolor (void);/ <tag/Description/Get the highest index of the palette. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_getmaxx<label id="tgi_getmaxx"> <quote> <descrip> <tag/Function/Get the maximum x coordinate that can be used on this screen. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getmaxx (void);/ <tag/Description/Get the maximum x coordinate that can be used on this screen. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_getmaxy<label id="tgi_getmaxy"> <quote> <descrip> <tag/Function/Get the maximum y coordinate that can be used on this screen. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getmaxy (void);/ <tag/Description/Get the maximum y coordinate that can be used on this screen. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_getpagecount<label id="tgi_getpagecount"> <quote> <descrip> <tag/Function/Return the number of screen pages available. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getpagecount (void);/ <tag/Description/Return the number of screen pages available. <tag/Availability/cc65 <tag/See also/ <ref id="tgi_setdrawpage" name="tgi_setdrawpage">, <ref id="tgi_setviewpage" name="tgi_setviewpage"> <tag/Example/None. </descrip> </quote> <sect1>tgi_getpalette<label id="tgi_getpalette"> <quote> <descrip> <tag/Function/Get the palette installed. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/const unsigned char* tgi_getpalette (void);/ <tag/Description/Get the palette installed. <tag/Availability/cc65 <tag/See also/Other tgi functions <tag/Example/None. </descrip> </quote> <sect1>tgi_getpixel<label id="tgi_getpixel"> <quote> <descrip> <tag/Function/Get the color of a pixel from the viewpage. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ tgi_getpixel (int x, int y);/ <tag/Description/Get the color of a pixel from the viewpage. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_getxres<label id="tgi_getxres"> <quote> <descrip> <tag/Function/Get number of horisontal pixels on the screen. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getxres (void);/ <tag/Description/Get number of horisontal pixels on the screen. This is same as tgi_maxx()+1. <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_getyres<label id="tgi_getyres"> <quote> <descrip> <tag/Function/Get number of vertical pixels on the screen. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned tgi_getyres (void);/ <tag/Description/Get number of vertical pixels on the screen. This is same as tgi_maxy()+1. <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_gotoxy<label id="tgi_gotoxy"> <quote> <descrip> <tag/Function/Set graphics cursor at x, y. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_gotoxy (int x, int y);/ <tag/Description/Set graphics cursor at x, y. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_init<label id="tgi_init"> <quote> <descrip> <tag/Function/Initialize the already loaded graphics driver. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void tgi_init (void);/ <tag/Description/The tgi_init function will set the default palette to the hardware. <tag/Limits/<itemize> <item><tt/tgi_init/ will not clear the screen. This allows switching between text and graphics mode on platforms that have separate memory areas for the screens. If you want the screen cleared, call <tt/<ref id="tgi_clear" name="tgi_clear">/ after <tt/tgi_init/. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/<verb> extern char lynxtgi[]; //Include the driver statically instead of loading it. tgi_install(&lynxtgi); tgi_init(); //Set up the default palette and clear the screen. </verb> </descrip> </quote> <sect1>tgi_install<label id="tgi_install"> <quote> <descrip> <tag/Function/Install an already loaded driver and return an error code. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned char __fastcall__ tgi_install (void* driver);/ <tag/Description/The function installs a driver that was already loaded into memory (or linked statically to the program). It returns an error code (<tt/TGI_ERR_OK/ in case of success). <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_load_driver" name="tgi_load_driver">, <ref id="tgi_uninstall" name="tgi_uninstall">, <ref id="tgi_unload" name="tgi_unload"> <tag/Example/<verb> extern char lynxtgi[]; //Include the driver statically instead of loading it. tgi_install(&lynxtgi); tgi_init(); //Set up the default palette and clear the screen. </verb> </descrip> </quote> <sect1>tgi_ioctl<label id="tgi_ioctl"> <quote> <descrip> <tag/Function/Platform dependent code extensions. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned __fastcall__ tgi_ioctl (unsigned char code, void* data);/ <tag/Description/Some platforms have extra display hardware that is not supported by standard tgi functions. You can extend the driver to support this extra hardware using tgi_ioctl functions. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>These functions are not easily portable to other cc65 platforms. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/<verb> #define tgi_sprite(spr) tgi_ioctl(0, (void*)(spr)) #define tgi_flip() tgi_ioctl(1, (void*)0) #define tgi_setbgcolor(bgcol) tgi_ioctl(2, (void*)(bgcol)) #define tgi_setframerate(rate) tgi_ioctl(3, (void*)(rate)) #define tgi_busy() tgi_ioctl(4, (void*)0) #define tgi_updatedisplay() tgi_ioctl(4, (void*)1) if (!tgi_busy()) { tgi_sprite(&background); tgi_setcolor(TGI_COLOR_BLUE); tgi_outttextxy(20,40,"Hello World"); tgi_updatedisplay(); } </verb> </descrip> </quote> <sect1>tgi_line<label id="tgi_line"> <quote> <descrip> <tag/Function/Draw a line in the current drawing color. The graphics cursor will be set to x2/y2 by this call. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_line (int x1, int y1, int x2, int y2);/ <tag/Description/Draw a line in the current drawing color. The graphics cursor will be set to x2/y2 by this call. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_lineto<label id="tgi_lineto"> <quote> <descrip> <tag/Function/Draw a line in the current drawing color from the graphics cursor to the new end point. The graphics cursor will be updated to x2/y2. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_lineto (int x2, int y2);/ <tag/Description/Draw a line in the current drawing color from the graphics cursor to the new end point. The graphics cursor will be updated to x2/y2. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_load_driver<label id="tgi_load_driver"> <quote> <descrip> <tag/Function/Load and install the given driver. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_load_driver (const char *name);/ <tag/Description/Load and install the driver by name. Will just load the driver and check if loading was successful. Will not switch to graphics mode. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_outtext<label id="tgi_outtext"> <quote> <descrip> <tag/Function/Output text at the current graphics cursor position. The graphics cursor is moved to the end of the text. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_outtext (const char* s);/ <tag/Description/Output text at the current graphics cursor position. The graphics cursor is moved to the end of the text. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_outtextxy<label id="tgi_outtextxy"> <quote> <descrip> <tag/Function/Output text at the given cursor position. The graphics cursor is moved to the end of the text. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_outtextxy (int x, int y, const char* s);/ <tag/Description/Output text at the given cursor position. The graphics cursor is moved to the end of the text. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_pieslice<label id="tgi_pieslice"> <quote> <descrip> <tag/Function/Draw an elliptic pie slice in the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_pie slice (int x, int y, unsigned char rx, unsigned char ry, unsigned sa, unsigned ea);/ <tag/Description/The function draws an elliptic pie slice with center at x/y and radii rx/ry using the current drawing color. The pie slice covers the angle between sa and ea (startangle and endangle), which must be in the range 0..360. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>The function behaves unexpectedly or may crash if the angles are out of range. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_bar" name="tgi_arc">, <ref id="tgi_bar" name="tgi_bar">, <ref id="tgi_circle" name="tgi_circle">, <ref id="tgi_ellipse" name="tgi_ellipse">, <ref id="tgi_setcolor" name="tgi_setcolor"> <tag/Example/<verb> /* Draw the closed upper half of an ellipse */ tgi_setcolor(TGI_COLOR_BLUE); tgi_pieslice (50, 50, 40, 20, 0, 180); </verb> </descrip> </quote> <sect1>tgi_setaspectratio<label id="tgi_setaspectratio"> <quote> <descrip> <tag/Function/Set the pixel aspect ratio. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setaspectratio (unsigned ratio);/ <tag/Description/The function sets the pixel aspect ratio for the current driver and display. The argument is an 8.8 fixed point value. The aspect ratio may be used to correct geometric shapes so they look correct on a given display. As an example, a circle with a radius of 100 pixels may look elliptic on some driver/display combinations if the aspect ratio is not 1.00. <tag/Limits/<itemize> <item>The aspect ratio is encoded in the TGI driver which assumes a "standard" monitor for the given platform. The aspect ratio may be wrong if another monitor is used. <item>No TGI function will use the aspect ratio. It is up to the programmer to make use of it. <item>The <tt/tgi_setaspectratio/ function can be used to change the aspect ratio for a loaded driver. The value is not reset by <ref id="tgi_init" name="tgi_init">, so if a driver is linked statically to an application, switching into and out of graphics mode will not restore the original aspect ratio. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="tgi_getaspectratio" name="tgi_getaspectratio"> <tag/Example/None. </descrip> </quote> <sect1>tgi_setcolor<label id="tgi_setcolor"> <quote> <descrip> <tag/Function/Set color to be used in future draw operations. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setcolor (unsigned char color);/ <tag/Description/Set color to be used in future draw operations. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/<verb> tgi_setcolor(TGI_COLOR_BLACK); tgi_bar(0,0,30,30); tgi_setcolor(TGI_COLOR_WHITE); tgi_bar(10,10,20,20); </verb> </descrip> </quote> <sect1>tgi_setdrawpage<label id="tgi_setdrawpage"> <quote> <descrip> <tag/Function/Set the page for drawing. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setdrawpage (unsigned char page);/ <tag/Description/If the drawpage and the viewpage are the same then all drawing is seen immediately as it is drawn. For double buffered games you can set the drawpage to a different page than the viewpage. This lets you draw the next screen in the background and when the screen is ready you display it. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/<verb> tgi_setdrawpage(1); tgi_outtextxy(10, 10, "Hello World"); tgi_setviewpage(1); // Show page 1 tgi_setdrawpage(0); tgi_outtextxy(10, 10, "Creating next frame"); ... tgi_setviewpage(0); // Show page 0 </verb> </descrip> </quote> <sect1>tgi_setpalette<label id="tgi_setpalette"> <quote> <descrip> <tag/Function/Set the palette (not available with all drivers/hardware). Palette is a pointer to as many entries as there are colors. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setpalette (const unsigned char* palette);/ <tag/Description/Set the palette (not available with all drivers/hardware). Palette is a pointer to as many entries as there are colors. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_setpixel<label id="tgi_setpixel"> <quote> <descrip> <tag/Function/Plot a pixel on the drawpage with the current color. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setpixel (int x, int y);/ <tag/Description/Plot a pixel on the drawpage with the current color. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_setviewpage<label id="tgi_setviewpage"> <quote> <descrip> <tag/Function/Set page to be visible on screen. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_setviewpage (unsigned char page);/ <tag/Description/If the drawpage and the viewpage are the same then all drawing is seen immediately as it is drawn. For double buffered games you can set the drawpage to a different page than the viewpage. This lets you draw the next screen in the background and when the screen is ready you display it. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/<verb> tgi_setdrawpage(1); tgi_outtextxy(10, 10, "Hello World"); tgi_setviewpage(1); // Show page 1 tgi_setdrawpage(0); tgi_outtextxy(10, 10, "Creating next frame"); ... tgi_setviewpage(0); // Show page 0 </verb> </descrip> </quote> <sect1>tgi_gettextheight<label id="tgi_gettextheight"> <quote> <descrip> <tag/Function/Calculate the height of the text in pixels according to the current text style. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned __fastcall__ tgi_gettextheight (const char* s);/ <tag/Description/Calculate the height of the text in pixels according to the current text style. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_settextstyle<label id="tgi_settextstyle"> <quote> <descrip> <tag/Function/Set the style for text output. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void __fastcall__ tgi_settextstyle (unsigned char magx, unsigned char magy, unsigned char dir);/ <tag/Description/Set the style for text output. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_gettextwidth<label id="tgi_gettextwidth"> <quote> <descrip> <tag/Function/Calculate the width of the text in pixels according to the current text style. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/unsigned __fastcall__ tgi_gettextwidth (const char* s);/ <tag/Function/Calculate the width of the text in pixels according to the current text style. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Description/Calculate the width of the text in pixels according to the current text style. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_uninstall<label id="tgi_uninstall"> <quote> <descrip> <tag/Function/Uninstall the currently loaded driver but do not unload it. Will call tgi_done if necessary. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void tgi_uninstall (void);/ <tag/Description/Uninstall the currently loaded driver but do not unload it. Will call tgi_done if necessary. <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>tgi_unload<label id="tgi_unload"> <quote> <descrip> <tag/Function/Uninstall, then unload the currently loaded driver. Will call tgi_done if necessary. <tag/Header/<tt/<ref id="tgi.h" name="tgi.h">/ <tag/Declaration/<tt/void tgi_unload (void);/ <tag/Description/Uninstall, then unload the currently loaded driver. Will call tgi_done if necessary. <tag/Availability/cc65 <tag/See also/Other tgi functions. <tag/Example/None. </descrip> </quote> <sect1>time<label id="time"> <quote> <descrip> <tag/Function/Get the time. <tag/Header/<tt/<ref id="time.h" name="time.h">/ <tag/Declaration/<tt/time_t __fastcall__ time (time_t* t);/ <tag/Description/The function returns the time since the 1970-01-01 00:00:00 measured in seconds. If the pointer <tt/t/ is not <tt/NULL/, the function result will also be stored there. If no time is available, <tt/(time_t)-1/ is returned and <tt/errno/ is set to <tt/ENOSYS/. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Many platforms supported by cc65 do not have a realtime clock, so the returned value may not be valid. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="clock" name="clock"> <tag/Example/None. </descrip> </quote> <sect1>toggle_videomode<label id="toggle_videomode"> <quote> <descrip> <tag/Function/Toggle between 40 and 80 column mode. <tag/Header/<tt/<ref id="c128.h" name="c128.h">/ <tag/Declaration/<tt/void toggle_videomode (void);/ <tag/Description/Toggle between 40 and 80 column mode. The settings for the old mode (cursor position, color and so on) are saved and restored together with the mode. <tag/Limits/<itemize> <item>The function is specific to the C128. <item>This function is deprecated. Please use <ref id="videomode" name="videomode"> instead! </itemize> <tag/Availability/C128 <tag/See also/ <ref id="fast" name="fast">, <ref id="slow" name="slow">, <ref id="videomode" name="videomode"> <tag/Example/None. </descrip> </quote> <sect1>tolower<label id="tolower"> <quote> <descrip> <tag/Function/Convert a character into its lower case representation. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ tolower (int c);/ <tag/Description/The function returns the given character converted to lower case. If the given character is not a letter, it is returned unchanged. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="islower" name="islower">, <ref id="isupper" name="isupper">, <ref id="toupper" name="toupper"> <tag/Example/None. </descrip> </quote> <sect1>toupper<label id="toupper"> <quote> <descrip> <tag/Function/Convert a character into its upper case representation. <tag/Header/<tt/<ref id="ctype.h" name="ctype.h">/ <tag/Declaration/<tt/int __fastcall__ toupper (int c);/ <tag/Description/The function returns the given character converted to upper case. If the given character is not a letter, it is returned unchanged. <tag/Limits/<itemize> <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/ISO 9899 <tag/See also/ <ref id="islower" name="islower">, <ref id="isupper" name="isupper">, <ref id="tolower" name="tolower"> <tag/Example/None. </descrip> </quote> <sect1>ultoa<label id="ultoa"> <quote> <descrip> <tag/Function/Convert an unsigned long integer into a string. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/char* __fastcall__ ultoa (unsigned long val, char* buf, int radix);/ <tag/Description/<tt/itoa/ converts the unsigned long integer <tt/val/ into a string using <tt/radix/ as the base. <tag/Limits/<itemize> <item>There are no provisions to prevent a buffer overflow. <item>The function is non standard, so it is not available in strict ANSI mode. You should probably use <tt/sprintf/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="atoi" name="atoi">, <ref id="atol" name="atol">, <ref id="itoa" name="itoa">, <ref id="ltoa" name="ltoa">, <ref id="utoa" name="utoa"> <tag/Example/None. </descrip> </quote> <sect1>unlink<label id="unlink"> <quote> <descrip> <tag/Function/Delete a file. <tag/Header/<tt/<ref id="unistd.h" name="unistd.h">/ <tag/Declaration/<tt/int __fastcall__ unlink (const char* name);/ <tag/Description/<tt/unlink/ deletes the file with the given name. On success, zero is returned. On error, -1 is returned and <tt/errno/ is set to an error code describing the reason for the failure. <tag/Limits/ <itemize> <item>The use of this function is discouraged. Please use <tt/<ref id="remove" name="remove">/ instead, which is a native ANSI C function and does the same. <item>This function is not available on all cc65 targets (depends on the availability of file I/O). <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. <item>Instead of <tt/unlink/, <tt/<ref id="remove" name="remove">/ should be used, which has the same semantics, but is more portable, because it conforms to the ISO C standard. </itemize> <tag/Availability/POSIX 1003.1 <tag/See also/ <ref id="remove" name="remove"> <tag/Example/ <verb> #include <stdio.h> #include <unistd.h> #define FILENAME "helloworld" if (unlink (FILENAME) == 0) { printf ("We deleted %s successfully\n", FILENAME); } else { printf ("There was a problem deleting %s\n", FILENAME); } </verb> </descrip> </quote> <sect1>utoa<label id="utoa"> <quote> <descrip> <tag/Function/Convert an unsigned integer into a string. <tag/Header/<tt/<ref id="stdlib.h" name="stdlib.h">/ <tag/Declaration/<tt/char* __fastcall__ utoa (unsigned val, char* buf, int radix);/ <tag/Description/<tt/itoa/ converts the unsigned integer <tt/val/ into a string using <tt/radix/ as the base. <tag/Limits/<itemize> <item>There are no provisions to prevent a buffer overflow. <item>The function is non standard, so it is not available in strict ANSI mode. You should probably use <tt/sprintf/ instead. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="atoi" name="atoi">, <ref id="atol" name="atol">, <ref id="itoa" name="itoa">, <ref id="ltoa" name="ltoa">, <ref id="ultoa" name="ultoa"> <tag/Example/None. </descrip> </quote> <sect1>vcprintf<label id="vcprintf"> <quote> <descrip> <tag/Function/Formatted output to the console. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/int __fastcall__ vcprintf (const char* format, va_list ap);/ <tag/Description/The arguments specified as a <tt/va_list/ are converted to text where necessary and formatted according to the format string given. The resulting string is output to the console. <tt/vcprintf/ supports the same format specifiers as <tt/vprintf/.  <tag/Limits/<itemize> <item>Like all other <tt/conio/ output functions, <tt/vcprintf/ distinguishes between <tt/\r/ and <tt/\n/. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/cc65 <tag/See also/ <ref id="cprintf" name="cprintf">, <ref id="cputc" name="cputc">, <ref id="cputcxy" name="cputcxy">, <ref id="cputs" name="cputs">, <ref id="cputsxy" name="cputsxy"> <tag/Example/None. </descrip> </quote> <sect1>videomode<label id="videomode"> <quote> <descrip> <tag/Function/Switch to either 40 or 80 column mode. <tag/Header/<tt/<ref id="apple2enh.h" name="apple2enh.h">, <ref id="c128.h" name="c128.h">/ <tag/Declaration/<tt/unsigned __fastcall__ videomode (unsigned Mode);/ <tag/Description/Switch to 40 or 80 column mode depending on the argument. If the requested mode is already active, nothing happens. The old mode is returned from the call. <tag/Limits/<itemize> <item>The function is specific to the C128 and enhanced Apple //e. <item>This function replaces <ref id="toggle_videomode" name="toggle_videomode">. <item>The function is only available as fastcall function, so it may only be used in presence of a prototype. </itemize> <tag/Availability/C128 and enhanced Apple //e <tag/See also/ <ref id="fast" name="fast">, <ref id="slow" name="slow">, <ref id="toggle_videomode" name="toggle_videomode"> <tag/Example/None. </descrip> </quote> <sect1>wherex<label id="wherex"> <quote> <descrip> <tag/Function/Return the current X position of the text mode cursor. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char wherex (void);/ <tag/Description/The function returns the current X position of the text mode cursor. Zero is returned for the leftmost screen position. <tag/Availability/cc65 <tag/See also/ <ref id="gotox" name="gotox">, <ref id="gotoy" name="gotoy">, <ref id="gotoxy" name="gotoxy">, <ref id="wherey" name="wherey"> <tag/Example/None. </descrip> </quote> <sect1>wherey<label id="wherey"> <quote> <descrip> <tag/Function/Return the current Y position of the text mode cursor. <tag/Header/<tt/<ref id="conio.h" name="conio.h">/ <tag/Declaration/<tt/unsigned char wherey (void);/ <tag/Description/The function returns the current Y position of the text mode cursor. Zero is returned for the uppermost screen position. <tag/Availability/cc65 <tag/See also/ <ref id="gotox" name="gotox">, <ref id="gotoy" name="gotoy">, <ref id="gotoxy" name="gotoxy">, <ref id="wherex" name="wherex"> <tag/Example/None. </descrip> </quote> </article>