X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=doc%2Ffuncref.sgml;h=ccb15df9b6945406d3f5802699b42c639805dd53;hb=c70af3a36b86a926add81128b47870bfd633a50d;hp=8055285cb590b16fde96738de5d13df54f6dca81;hpb=7910ebfacfda11ee9964cd17907e18a8ffe654f2;p=cc65 diff --git a/doc/funcref.sgml b/doc/funcref.sgml index 8055285cb..ccb15df9b 100644 --- a/doc/funcref.sgml +++ b/doc/funcref.sgml @@ -64,12 +64,23 @@ function.

-(incomplete) + +_dos_type + +rebootafterexit +

-(incomplete) + +_dos_type + +rebootafterexit +textframe +textframexy + +

@@ -81,6 +92,10 @@ function.

+ + + + (incomplete) @@ -94,8 +109,9 @@ function. - + + @@ -106,17 +122,29 @@ function.

-(incomplete) + + +

-(incomplete) + + + + + +

-(incomplete) + + + + + +

@@ -188,9 +216,11 @@ function. + + @@ -245,23 +275,24 @@ function.

- - - - - - - - - - - - - - + + + + + + + + + + + + + + + (incomplete) - +

@@ -362,7 +393,6 @@ It does not declare any functions. - @@ -381,7 +411,8 @@ It does not declare any functions. - + + @@ -426,7 +457,6 @@ It does not declare any functions. - @@ -461,8 +491,8 @@ It does not declare any functions. - - + + @@ -785,8 +815,8 @@ is present. / The function is actually a macro. Disabling interrupts may lead to unexpected results. @@ -906,10 +936,11 @@ depend of the address expression used. / The function is actually a macro. +Disabling interrupts may lead to unexpected results. +em_install

+ + + +/ + +Not all drivers are able to detect if the supported hardware is really +present. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + em_load_driver

@@ -1791,7 +1848,7 @@ extended memory that should be supported. There is no autodetect capability. 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 +because you're going to overwrite it completely), it is better to call / instead. @@ -1834,13 +1891,40 @@ by the driver in 256 byte pages. +em_uninstall

+ + + +/ + +If the driver has been loaded using /, / +should be used instead of The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + em_unload

/ - @@ -1929,7 +2013,8 @@ will nearly double the speed compared to slow mode. , - +, + @@ -2040,6 +2125,28 @@ be used in presence of a prototype. +get_ostype

+ + + +, +, / + +The function does not exist on all platforms. +The return codes are platform dependent. + + + + + getenv

@@ -2825,7 +2932,7 @@ used in presence of a prototype. / A joystick driver must be loaded using +mouse_setbox

+ + + +/ + +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. +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. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_getbox

+ + + +/ + +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_buttons

+ + + +/ + +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_geterrormsg

+ + + +/ + +The function will return "Unknown error" for invalid error codes. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + +mouse_hide

+ + + +/ +/ and +/ to make the mouse cursor +visible. + +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + + + + + + +mouse_info

+ + + +/ + +The / instead. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_install

+ + + +/ + +Not all drivers are able to detect if the supported hardware is really +present. +After installing a driver, the mouse cursor is hidden. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + +mouse_ioctl

+ + + +/ + +Calling this function is non portable, because each driver may +implement different ioctl calls (or none at all). +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + + + + + +mouse_load_driver

+ + + +/ + +The driver is loaded by name, so currently you must know the type of +mouse that should be supported. There is no autodetect capability. +Not all drivers are able to detect if the supported hardware is really +present. +After installing a driver, the mouse cursor is hidden. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + +mouse_move

+ + + +/ + +The function does not check if the new position is within the bounding +box specified with /. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_pos

+ + + +/ + +The / instead. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, + + + + + +mouse_show

+ + + +/ +/ and +/. + +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + + + + + + +mouse_uninstall

+ + + +/ + +If the driver has been loaded using /, / +should be used instead of The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + +mouse_unload

+ + + +/ + +The function does nothing if no driver is loaded. + +, +, + + + + + offsetof

@@ -3189,6 +3655,65 @@ cc65 allows to pass this argument, it is ignored. +peekbsys

+ + + +/, +/ + +The function is only available as fastcall function, so it may only +be used in presence of a prototype. +This function may be a macro depending on the compiler options. The +actual function is accessible by #undef'ing the macro. + +, +, +, +, + + + + + +peekwsys

+ + + +/, +/ + +The function is only available as fastcall function, so it may only +be used in presence of a prototype. +The order in which the two bytes are read is undefined. + +, +, +, +, + + + + + perror

@@ -3209,7 +3734,64 @@ be used in presence of a prototype. , -, + + + + + +pokebsys

+ + + +/, +/ + +The function is only available as fastcall function, so it may only +be used in presence of a prototype. + +, +, +, +, + + + + + +pokewsys

+ + + +/, +/ + +The function is only available as fastcall function, so it may only +be used in presence of a prototype. +The order in which the two bytes are written is undefined. + +, +, +, +, + @@ -3349,8 +3931,10 @@ be used in presence of a prototype. , #include <stdio.h> #define FILENAME "helloworld" @@ -3360,6 +3944,44 @@ if (remove (FILENAME) == 0) { } else { printf ("There was a problem deleting %s\n", FILENAME); } + + + + + +rename

+ + + +/ + +This function is not available on all cc65 targets (depends on the +capabilities of the storage devices). +The function is only available as fastcall function, so it may only +be used in presence of a prototype. + + + +#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); +} + @@ -3514,6 +4136,7 @@ different locale has no effect. , + @@ -3578,7 +4201,8 @@ will halve the speed compared to fast mode. , - +, + @@ -3629,6 +4253,7 @@ be used in presence of a prototype. , , + @@ -3706,6 +4331,7 @@ be used in presence of a prototype. , , + @@ -3734,6 +4360,7 @@ be used in presence of a prototype. , , + @@ -3789,7 +4416,8 @@ be used in presence of a prototype. , - +, + @@ -3867,6 +4495,7 @@ be used in presence of a prototype. , , + @@ -3975,6 +4604,7 @@ be used in presence of a prototype. , , + @@ -4086,6 +4716,66 @@ be used in presence of a prototype. +strtok

+ + + +/ + +The function is only available as fastcall function, so it may only +be used in presence of a prototype. + +, + + + + + +strxfrm

+ + + +/ + +If The function is only available as fastcall function, so it may only +be used in presence of a prototype. +Since cc65 doesn't support different charcter sets, . + +, +, +, + + + + strupper

@@ -4177,11 +4867,14 @@ old mode (cursor position, color and so on) are saved and restored together with the mode. The function is specific to the C128. +This function is deprecated. Please use instead! , - +, + @@ -4287,6 +4980,7 @@ to the ISO C standard. #include <stdio.h> #include <unistd.h> @@ -4297,6 +4991,7 @@ if (unlink (FILENAME) == 0) { } else { printf ("There was a problem deleting %s\n", FILENAME); } + @@ -4358,6 +5053,34 @@ used in presence of a prototype. +videomode

+ + + +, +/ + +The function is specific to the C128 and enhanced Apple //e. +This function replaces . +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + +, +, + + + + + wherex

@@ -4399,5 +5122,3 @@ cursor. Zero is returned for the uppermost screen position. - -