jurjen.ladeniusandClaude Opus 4.8
f3340e86c6
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
79 lines
13 KiB
HTML
79 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>string.h</title><link rel="stylesheet" type="text/css" href="../styles/main.css" /><script type="text/javascript" src="../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../styles/");</script></head>
|
|
|
|
<!-- Generated by Natural Docs, version 2.2 -->
|
|
|
|
<!-- saved from url=(0016)http://localhost -->
|
|
|
|
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
|
|
|
|
<a name="Character"></a><a name="Topic675"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Character</div>
|
|
</div>
|
|
|
|
<a name="Char_IsNum"></a><a name="Topic676"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Char_IsNum</div>
|
|
<div id="NDPrototype676" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Char_IsNum(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">c8 </td><td class="PName last">chr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check if a given character is numeric (0-9)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>The character to check</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the given character is not a numeric.</p></div>
|
|
</div>
|
|
|
|
<a name="Char_IsAlpha"></a><a name="Topic677"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Char_IsAlpha</div>
|
|
<div id="NDPrototype677" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Char_IsAlpha(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">c8 </td><td class="PName last">chr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check if a given character is alphabetic (A-Za-z)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>The character to check</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the given character is not a alphabetic.</p></div>
|
|
</div>
|
|
|
|
<a name="Char_IsAlphaNum"></a><a name="Topic678"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">Char_IsAlphaNum</div>
|
|
<div id="NDPrototype678" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> Char_IsAlphaNum(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">c8 </td><td class="PName last">chr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Check if a given character is alphanumeric (alphabet letter and numbers)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chr<div class="CDLParameterType">c8</div></td><td class="CDLDefinition"><p>The character to check</p></td></tr></table><div class="CHeading">Return</div><p>FALSE if the given character is not a alphabetic or numeric.</p></div>
|
|
</div>
|
|
|
|
<a name="String"></a><a name="Topic679"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">String</div>
|
|
</div>
|
|
|
|
<a name="String_Length"></a><a name="Topic680"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_Length</div>
|
|
<div id="NDPrototype680" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> u8 String_Length(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">str</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Get the length of a given string</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">str<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>The string to check</p></td></tr></table><div class="CHeading">Return</div><p>String length.</p></div>
|
|
</div>
|
|
|
|
<a name="String_Copy"></a><a name="Topic681"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_Copy</div>
|
|
<div id="NDPrototype681" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> String_Copy(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">c8* </td><td class="PName last">dst,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td class="PName last">src</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Copy a source string to a destination buffer</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dst<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string (buffer must be large enough to fit the source string size)</p></td></tr><tr><td class="CDLEntry">src<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Source string</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="String_FromUInt8ZT"></a><a name="Topic682"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_FromUInt8ZT</div>
|
|
<div id="NDPrototype682" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> String_FromUInt8ZT(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">value,</td></tr><tr><td class="PType first">c8* </td><td class="PName last">string</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Create a zero-terminated string from a 8-bits unsigned integer String buffer must be at least 4 bytes length (will be padded with '0')</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Integer value to convert</p></td></tr><tr><td class="CDLEntry">string<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="String_FromUInt8"></a><a name="Topic683"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_FromUInt8</div>
|
|
<div id="NDPrototype683" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> String_FromUInt8(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8 </td><td class="PName last">value,</td></tr><tr><td class="PType first">c8* </td><td class="PName last">string</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Create a string from a 8-bits unsigned integer (string is not zero-terminated) String buffer must be at least 3 bytes length (will be padded with '0') Original version derived from Galandros work (<a href="https://wikiti.brandonw.net/index.php?title=Z80_Routines:Other:DispA" target="_top">https://​wikiti​.brandonw​.net​/index​.php​?title=Z80_Routines:Other:DispA</a>)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Integer value to convert</p></td></tr><tr><td class="CDLEntry">string<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="String_FromUInt16ZT"></a><a name="Topic684"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_FromUInt16ZT</div>
|
|
<div id="NDPrototype684" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> String_FromUInt16ZT(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">value,</td></tr><tr><td class="PType first">c8* </td><td class="PName last">string</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Create a zero-terminated string from a 16-bits unsigned integer String buffer must be at least 6 bytes length (will be padded with '0')</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Integer value to convert</p></td></tr><tr><td class="CDLEntry">string<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="String_FromUInt16"></a><a name="Topic685"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">String_FromUInt16</div>
|
|
<div id="NDPrototype685" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> String_FromUInt16(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u16 </td><td class="PName last">value,</td></tr><tr><td class="PType first">c8* </td><td class="PName last">string</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Create a string from a 16-bits unsigned integer (string is not zero-terminated) String buffer must be at least 5 bytes length (will be padded with '0') Original version by Milos "baze" Bazelides (<a href="http://map.grauw.nl/sources/external/z80bits.html#5.1" target="_top">http://​map​.grauw​.nl​/sources​/external​/z80bits​.html​#5​.1</a>)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">value<div class="CDLParameterType">u16</div></td><td class="CDLDefinition"><p>Integer value to convert</p></td></tr><tr><td class="CDLEntry">string<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="String_Format"></a><a name="Topic686"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">String_Format</div>
|
|
<div id="NDPrototype686" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> String_Format(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="first"></td><td class="PType">c8* </td><td></td><td class="PName last">dest,</td></tr><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">c8* </td><td></td><td class="PName last">format,</td></tr><tr><td class="first"></td><td></td><td class="PSymbols">...</td><td class="last"></td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Build a zero-terminated string</p><pre class="CText">Data format: %[0]<padding><type><br />Type: i 16 bits signed integer<br /> d (same)<br /> I 32 bits signed integer (need STRING_USE_INT32 flag)<br /> D (same)<br /> x 16 bits hexadecimal<br /> X 32 bits hexadecimal (need STRING_USE_INT32 flag)<br /> c 8 bits character<br /> s Zero-terminated string<br />Padding: Padding for integer and hexadecimal<br /> [0] Padding with 0 (otherwise padding with space)</pre><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">dest<div class="CDLParameterType">c8*</div></td><td class="CDLDefinition"><p>Destination string buffer (must big enough to contain the whole string)</p></td></tr><tr><td class="CDLEntry">format<div class="CDLParameterType"><span class="SHKeyword">const</span> c8*</div></td><td class="CDLDefinition"><p>Formating string</p></td></tr><tr><td class="CDLEntry">...</td><td class="CDLDefinition"><p>Variable number of parameter (must match the Formating string)</p></td></tr></table></div>
|
|
</div>
|
|
|
|
</body></html> |