BitXorString (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
Line 49: Line 49:


==See also==
==See also==
<table>
<tr>
<td>
<ul>
<ul>
<li><var>[[BitAndString (String function)|BitAndString]]</var>
<li><var>[[BitAndString (String function)|BitAndString]]</var>
Line 55: Line 58:
<li><var>[[BitOrString (String function)|BitOrString]]</var>
<li><var>[[BitOrString (String function)|BitOrString]]</var>
</ul>
</ul>
</td>
<td>
<ul>
<li><var>[[BitClearString, BitFlipString, and BitSetString (String functions)|BitClearString, BitFlipString, and BitSetString]]</var>
<li><var>[[BitValueString (String function)|BitValueString]]</var>
<li><var>[[BitCountString (String function)|BitCountString]]</var>
</ul>
</td>
</table>
[[Category:Bit manipulation methods]]
[[Category:Bit manipulation methods]]
{{Template:String:BitXorString footer}}
{{Template:String:BitXorString footer}}

Revision as of 23:32, 21 March 2013

Do bitwise exclusive Or of strings (String class)

[Introduced in Sirius Mods 7.9]


BitXorString does a logical XOR (exclusive OR) of the bits in two strings.

Syntax

%result = string:BitXorString( xorBits, [Pad= c])

Syntax terms

%resultA string to receive the result of XORing together the bits in string and xorBits.
string One of the strings to be XORed.
xorBits The other string to be XORed.
Pad A single character that indicates the character with which the shorter of the two input strings is to be extended. As many copies of c are used as is required to make the shorter string as long as the longer. If both strings are of equal length, no padding is required. The default value of c is '00':x.

Usage notes

  • Using a null string or xorBits is an easy way of XORing each byte in a string with a specific byte value (the Pad value).
  • BitXorString is most useful for working with binary data, for example binary data being sent or received with Janus Sockets.

Examples

The following example compares the result of BitXorString (logical exclusive OR) versus BitOrString (logical inclusive OR):

b printText {~='Ale':stringToHex} printText {~='Lager':stringToHex} print '======================' printText {~='Ale':bitOrString('Lager', pad='40':x)} printText {~='Ale':bitOrString('Lager', pad='40':x):stringToHex} print '======================' printText {~='Ale':bitXorString('Lager', pad='40':x)} printText {~='Ale':bitXorString('Lager', pad='40':x):stringToHex} end

The result is:

'Ale':stringToHex=C19385 'Lager':stringToHex=D381878599 ====================== 'Ale':bitOrString('Lager', pad='40':x)=LlgER 'Ale':bitOrString('Lager', pad='40':x):stringToHex=D39387C5D9 ====================== 'Ale':bitXorString('Lager', pad='40':x)=???ER 'Ale':bitXorString('Lager', pad='40':x):stringToHex=121202C5D9

See also