From 5e493842f002c16eb3688257b02a543ca53e794d Mon Sep 17 00:00:00 2001 From: cuz Date: Wed, 27 Nov 2002 23:06:59 +0000 Subject: [PATCH] A few more functions git-svn-id: svn://svn.cc65.org/cc65/trunk@1664 b7a2c559-68d2-44c3-8de9-860c34a00d81 --- doc/Makefile | 3 + doc/funcref.sgml | 488 ++++++++++++++++++++++++++++++++--------------- 2 files changed, 337 insertions(+), 154 deletions(-) diff --git a/doc/Makefile b/doc/Makefile index 73660d5cf..f90918b97 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -43,6 +43,9 @@ TEX = $(SGML:.sgml=.tex) %.tex: %.sgml sgml2latex --output=tex $< +funcref.html: funcref.sgml + sgml2html --split=2 $< + # ------------------------------------------------------------------------------ # Targets diff --git a/doc/funcref.sgml b/doc/funcref.sgml index 4d637dd12..3ee8da784 100644 --- a/doc/funcref.sgml +++ b/doc/funcref.sgml @@ -138,8 +138,12 @@ function. + + + + @@ -156,8 +160,11 @@ function. +The function is actually a macro. +The inserted instruction may lead to unexpected results if no debugger +is present. + , @@ -177,8 +184,10 @@ to unexpected results if no debugger is present. +The function is actually a macro. +Disabling interrupts may lead to unexpected results. + , @@ -198,7 +207,9 @@ unexpected results. +The function is actually a macro. + , @@ -236,7 +247,9 @@ terminates the program with an exit code of 3. +The function is actually a macro. + , @@ -258,9 +271,12 @@ on stderr and aborts the program. terminates, they are called in LIFO order (the last function registered is called first). +A maximum of 5 exit functions can be registered. +There is no way to unregister an exit function. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -279,10 +295,12 @@ function, so it may only be used in presence of a prototype. +Background colors are system dependent. The function may have no effect +on systems where the background color cannot be changed. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -301,10 +319,12 @@ prototype. +Border colors are system dependent. The function may have no effect +on systems where the border color cannot be changed. +The function is only available as fastcall function, so it may only +be used in presence of a prototype. + , @@ -323,8 +343,10 @@ prototype. +The function is only available as fastcall function, so it may only be used in presence of a prototype. + , @@ -345,8 +367,10 @@ at a specific screen position. +The function is only available as fastcall function, so it may only be used in presence of a prototype. + , @@ -367,8 +391,10 @@ only be used in presence of a prototype. no character available, +If the system supports a keyboard buffer, , @@ -387,10 +413,13 @@ key from this buffer and wait only if the buffer is empty. +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. The function is only available -as fastcall function, so it may only be used in presence of a prototype. +off screen leads to undefined behaviour. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -410,10 +439,13 @@ as fastcall function, so it may only be used in presence of a prototype. +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. The function is only available -as fastcall function, so it may only be used in presence of a prototype. +off screen leads to undefined behaviour. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -452,8 +484,10 @@ the upper left corner. +The function is only available as fastcall function, so it may only be used in presence of a prototype. + , @@ -472,10 +506,13 @@ be used in presence of a prototype. +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. The function is only available -as fastcall function, so it may only be used in presence of a prototype. +off screen leads to undefined behaviour. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -495,10 +532,13 @@ as fastcall function, so it may only be used in presence of a prototype. +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. The function is only available -as fastcall function, so it may only be used in presence of a prototype. +off screen leads to undefined behaviour. +The function is only available as fastcall function, so it may only be +used in presence of a prototype. + , @@ -522,9 +562,12 @@ output is written and any functions registered with / are called. Common values for status are /. - +The function is only available as fastcall function, so it may only +be used in presence of a prototype. +It depends on the host machine if the program return code can be +evaluated or is ignored. + , @@ -544,9 +587,12 @@ program return code can be evaluated or is ignored. +The function is only available as fastcall function, so it may +only be used in presence of a prototype. +Invalid values for the X position (out of screen coordinates) may +lead to undefined behaviour. + , @@ -568,9 +614,12 @@ only be used in presence of a prototype. Invalid values for the X position +The function is only available as fastcall function, so it may only be +used in presence of a prototype. +Invalid values for any of both coordinates (out of screen positions) may +lead to undefined behaviour. + , @@ -592,9 +641,12 @@ coordinates (out of screen positions) may lead to undefined behaviour. +The function is only available as fastcall function, so it may +only be used in presence of a prototype. +Invalid values for the Y position (out of screen coordinates) may lead +to undefined behaviour. + , @@ -616,12 +668,15 @@ only be used in presence of a prototype. Invalid values for the Y position +When compiling with When compiling without , @@ -650,12 +705,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -685,12 +743,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -720,12 +781,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -755,12 +819,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -789,12 +856,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -825,12 +895,15 @@ space). +When compiling with When compiling without , @@ -860,12 +933,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -895,12 +971,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -931,12 +1010,15 @@ space or an alphanumeric character. +When compiling with When compiling without , @@ -968,12 +1050,15 @@ is a white space character. The return value is non 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'). - +When compiling with When compiling without , @@ -1003,12 +1088,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -1038,12 +1126,15 @@ may only be used in presence of a prototype. +When compiling with When compiling without , @@ -1072,8 +1163,10 @@ may only be used in presence of a prototype. +If the system does not support a keyboard buffer (most systems do), the function is rather useless. + , @@ -1093,9 +1186,12 @@ do), the function is rather useless. +The function may not be supported by the hardware, in which case +the call is ignored. +The function is only available as fastcall function, so it may only +be used in presence of a prototype. + @@ -1112,8 +1208,10 @@ may only be used in presence of a prototype. / +The function is only available as fastcall function, so it may only be used in presence of a prototype. + , @@ -1136,10 +1234,13 @@ be used in presence of a prototype. +The function is only available as fastcall function, so it may only be used in presence of a prototype. +If copying takes place between objects that overlap, the behavior +is undefined. + @@ -1160,8 +1261,10 @@ be used in presence of a prototype. (converted to a char) in the string pointed to by +The function is only available as fastcall function, so it may only be used in presence of a prototype. + @@ -1179,10 +1282,13 @@ be used in presence of a prototype. +The function is only available as fastcall function, so it may only be used in presence of a prototype. +If copying takes place between objects that overlap, the behavior +is undefined. + @@ -1208,10 +1314,12 @@ strcpy (hello, "Hello world!\n"); +The function is only available as fastcall function, so it may only +be used in presence of a prototype. +When compiling with @@ -1220,6 +1328,37 @@ then 255 characters. +strlower