Squirrel Operators - Revision history

Mince at 23:00, 31 October 2023

2023-10-31T23:00:52Z

← Older revision		Revision as of 23:00, 31 October 2023
Line 408:		Line 408:
	printl( (mybitflags & FL_ONTRAIN) != 0 ) // false		printl( (mybitflags & FL_ONTRAIN) != 0 ) // false
	</syntaxhighlight>		</syntaxhighlight>

	~~<span style="font-size:120%">'''Other Operators'''</span>~~

	~~in, instanceof, typeof, comma, ternary~~


	~~<span style="font-size:120%">'''Operator Precedence'''</span>~~

	~~-, ~, !, typeof , ++, -- highest~~
	~~/, *, % …~~
	~~+, -~~
	~~<<, >>, >>>~~
	~~<, <=, >, >=, instanceof~~
	~~==, !=, <=>~~
	&
	^
	~~&&, in~~
	~~+=, =, -=, /=, *=, %= …~~
	~~, (comma operator) lowest~~

Mince at 22:08, 31 October 2023

2023-10-31T22:08:41Z

Show changes

Mince at 20:47, 31 October 2023

2023-10-31T20:47:55Z

← Older revision		Revision as of 20:47, 31 October 2023
Line 286:		Line 286:

	Logical OR will return the '''first''' operand that evaluates to '''true''', if none do, it will return the '''last''' operand.		Logical OR will return the '''first''' operand that evaluates to '''true''', if none do, it will return the '''last''' operand.

			A common use case of this functionality with the logical OR operator is to fill a variable with the first value that evaluates to true.

			<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
			local var = othervar \|\| otherothervar \|\| 1;
			</syntaxhighlight>

			In some cases we may have access to variables that we don't know if they are null or not. This is a good way of providing "backup" values to use in our program.

Mince at 21:55, 27 October 2023

2023-10-27T21:55:37Z

← Older revision		Revision as of 21:55, 27 October 2023
Line 9:		Line 9:

	<span style="font-size:120%">'''Arithmetic'''</span>		<span style="font-size:120%">'''Arithmetic'''</span>

			The arithmetic operators <code>'''+, -, *, /, %'''</code> are used for, well, arithmetic! Technically we can use them on certain object types (more on in future sections), however by default they're for use with the integer, float, and (partially) string types. You should be familiar with most of these already.


	'''Unary Operators'''		'''Unary Operators'''
Line 72:		Line 75:
	</syntaxhighlight>		</syntaxhighlight>

	The addition operators <code>'''+'''</code> and <code>'''+='''</code> are ~~also~~ able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.		The addition operators <code>'''+'''</code> and <code>'''+='''</code> are the only operators able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.
	This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.		This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.

Line 89:		Line 92:

	<span style="font-size:120%">'''Assignment'''</span>		<span style="font-size:120%">'''Assignment'''</span>

			The assignment operator (<code>'''='''</code>) is used for assigning values to variables. It can be combined with the arithmetic operators to create arithmetic assignment operators (e.g. <code>'''x += 5'''</code>), which is a shortened version of: <code>'''x = x + 5'''</code>.


	{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"		{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
Line 143:		Line 149:

	<span style="font-size:120%">'''Increment/Decrement'''</span>		<span style="font-size:120%">'''Increment/Decrement'''</span>

			The increment and decrement operators are used (respectively) to increase or decrease a variable by 1. This can be done '''before''' the variable is returned in the case of the prefixed operators, or it can be done '''after''' the variable has been returned in the case of the postfixed operators.


	{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"		{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
	\|+		\|+
Line 176:		Line 186:

	y = x++; // y = 1, it got the value of x and then x got incremented, x = 2		y = x++; // y = 1, it got the value of x and then x got incremented, x = 2
	y = ++x; // y = 3, x got incremented and then y got x's value		y = ++x; // y = 3, x got incremented and then y got x's value, x = 3
	</syntaxhighlight>		</syntaxhighlight>

Line 184:		Line 194:

	<span style="font-size:120%">'''Relational'''</span>		<span style="font-size:120%">'''Relational'''</span>

			The relational operators compare the values of their operands and return a boolean based on their result.


	{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"		{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
	\|+		\|+
Line 234:		Line 248:
	z = x <= y; // true		z = x <= y; // true
	</syntaxhighlight>		</syntaxhighlight>


			<hr>


	<span style="font-size:120%">'''Logical'''</span>		<span style="font-size:120%">'''Logical'''</span>

			The logical operators are primarily used in control flow to create condition based code. We'll go over control flow in a future section, for now just know that they exist and that you can reference back here if you forget what one does.


	{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"		{\| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
	\|+		\|+
Line 247:		Line 268:
	\| !		\| !
	\| !x		\| !x
	\|true if x evaluates to false, otherwise ~~false~~		\|true if x evaluates to false, otherwise true
	\|- style="text-align:center"		\|- style="text-align:center"
	\|Logical AND		\|Logical AND
Line 262:		Line 283:
	For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.		For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.

	Logical AND will return the '''first''' operand that evaluates to false, if none do ~~and both evaluate true the operator~~ will return the '''last''' operand.		Logical AND will return the '''first''' operand that evaluates to '''false''', if none do, it will return the '''last''' operand.

	Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.		Logical OR will return the '''first''' operand that evaluates to '''true''', if none do, it will return the '''last''' operand.


Line 276:		Line 297:
	local z = 5 && "0" // "0"		local z = 5 && "0" // "0"
	</syntaxhighlight>		</syntaxhighlight>


			<hr>


	<span style="font-size:120%">'''Bitwise'''</span>		<span style="font-size:120%">'''Bitwise'''</span>

			All data in computer memory is stored as sequences of bits; 0's and 1's. The bitwise operators work directly with the bits of variables and literals in Squirrel. These operators are rarely used unless you have very specific needs within your program. For day to day use, you're mostly going to be using bitwise AND & bitwise OR to manipulate '''bit flags''', which are variables where each of the 32 bits (or however big the variable is) represents a boolean flag. So instead of having 32 different boolean variables, you can have 1 variable that represents 32 booleans!
	&, \|, ^, ~, <<, >>, >>>		&, \|, ^, ~, <<, >>, >>>

Mince at 20:45, 27 October 2023

2023-10-27T20:45:52Z

← Older revision		Revision as of 20:45, 27 October 2023
Line 262:		Line 262:
	For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.		For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.

	Logical AND~~, if either operand evaluates to false,~~ will return the '''first''' operand that evaluates to false~~. Otherwise~~ if both evaluate true the operator will return the '''last''' operand.		Logical AND will return the '''first''' operand that evaluates to false, if none do and both evaluate true the operator will return the '''last''' operand.

	Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.		Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.

Mince at 03:46, 27 October 2023

2023-10-27T03:46:14Z

← Older revision		Revision as of 03:46, 27 October 2023
Line 1:		Line 1:
	<div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div>		<div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; z-index: 1; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div>

	Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.		Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.

Mince at 03:24, 27 October 2023

2023-10-27T03:24:54Z

← Older revision		Revision as of 03:24, 27 October 2023
Line 1:		Line 1:
			<div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align: center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Data_Types BACK]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/An_Introduction_to_Squirrel HOME]</div><div style="width:33.333%; top: 0px; position: sticky; height: 30px; display: inline-block; text-align:center; line-height: 30px; background-color:#BBBBBB;">[https://sigwiki.potato.tf/index.php/Squirrel_Expressions NEXT]</div>

	Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.		Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.
	This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.		This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.

Mince: Created page with "Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators. This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar wit..."

2023-10-26T23:04:41Z

Created page with "Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators. This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar wit..."

New page

Now that you know how to create data and store it into variables, we can now go over how to modify and operate on that data. Operators are used for this purpose, they take one or more operands and produce a result value. Operators which take one operand are called unary operators, two operands are binary operators, and three are ternary operators.
This section is quite long so don't worry about memorizing every single operator, just browse through and become familiar with the various types of operators and their uses, you'll have plenty of examples throughout the rest of the guide to work with.

<hr>

'''Arithmetic'''

'''Unary Operators'''
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Unary minus
| -
| -x
|Negation of x
|}

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local x = 50;
x = -x; // -50
</syntaxhighlight>

'''Binary Operators'''
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Addition
| +
| x + y
|x plus y
|- style="text-align:center"
|Subtraction
| -
| x - y
|x minus y
|- style="text-align:center"
|Multiplication
| *
| x * y
|x multiplied by y
|- style="text-align:center"
|Division
| /
| x / y
|x divided by y
|- style="text-align:center"
|Remainder
| %
| x % y
|the remainder from: x divided by y
|}

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local v = 100 + 100; // 200
local w = 0 - 2; // -2
local x = 5.5 * 100; // 550.0
local y = 20 / 2; // 10
local z = 23 % 2; // 1
</syntaxhighlight>

The addition operators <code>'''+'''</code> and <code>'''+='''</code> are also able to handle string operands. If one operand is a string, Squirrel will try to convert the other operand to a string as well.
This same type conversion happens between floats and integers for any arithmetic operator (not just addition). If one operand is a float and the other an integer, the resulting value will be a float.

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local str1 = "Hello,";
local str2 = " World!";
str1 += str2; // Hello World!
// See next section for +=

local float = 10 - 7.0 // 3.0
</syntaxhighlight>

<hr>

'''Assignment'''

{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Assignment
| =
| x = y
|assign value y to variable x
|- style="text-align:center"
|Addition Assignment
| +=
| x += y
|assign x + y to variable x
|- style="text-align:center"
|Subtraction Assignment
| -=
| x -= y
|assign x - y to variable x
|- style="text-align:center"
|Multiplication Assignment
| *=
| x *= y
|assign x * y to variable x
|- style="text-align:center"
|Division Assignment
| /=
| x /= y
|assign x / y to variable x
|- style="text-align:center"
|Remainder Assignment
| %=
| x %= y
|assign x % y to variable x
|- style="text-align:center"
|}

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local x = 100;
x += 5; // equivalent to: x = x + 5
x -= 5; // 100
x *= 100; // 10,000
x /= 2; // 5,000
x %= 2; // 0
</syntaxhighlight>

<hr>

'''Increment/Decrement'''
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Pre-increment
| ++
| ++x
|increment x by 1, then return x
|- style="text-align:center"
|Post-increment
| ++
| x++
|copy x, increment variable x by 1, then return the copy
|- style="text-align:center"
|Pre-decrement
| --
| --x
|decrement x by 1, then return x
|- style="text-align:center"
|Post-decrement
| --
| x--
|copy x, decrement variable x by 1, then return the copy
|}

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local x = 1;
local y;

y = x++; // y = 1, it got the value of x and then x got incremented, x = 2
y = ++x; // y = 3, x got incremented and then y got x's value
</syntaxhighlight>

<hr>

'''Relational'''
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Equality
| ==
| x == y
|true if x equals y, false otherwise
|- style="text-align:center"
|Inequality
| !=
| x != y
|true if x does not equal y, false otherwise
|- style="text-align:center"
|Less than
| <
| x < y
|true if x is less than y, false otherwise
|- style="text-align:center"
|Greater than
| >
| x > y
|true if x is greater than y, false otherwise
|- style="text-align:center"
|Less than or equal to
| <=
| x <= y
|true if x is less than or equal to y, false otherwise
|- style="text-align:center"
|Greater than or equal to
| >=
| x >= y
|true if x is greater than or equal to y, false otherwise
|}

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local x = 5;
local y = 5;
local z;

z = x == y; // true
z = x != y; // false
z = x > y; // false
z = x >= y; // true
z = x < y; // false
z = x <= y; // true
</syntaxhighlight>

'''Logical'''
{| class="wikitable" style="width:100%; margin:auto; text-align:center font-weight:bold; font-size:110%"
|+
!Operator
!Symbol
!Form
!Operation
|- style="text-align:center"
|Logical NOT
| !
| !x
|true if x evaluates to false, otherwise false
|- style="text-align:center"
|Logical AND
| &&
| x && y
|true if both operands evaluate to true, otherwise false
|- style="text-align:center"
|Logical OR
| <nowiki>||</nowiki>
| x <nowiki>||</nowiki> y
|true if either operand evaluates to true, otherwise false
|}

For most purposes the above definitions for AND & OR are sufficient, however Squirrel does not simply return boolean true or false for these operators, rather it returns a specific operand passed to the operator based on the result.

Logical AND, if either operand evaluates to false, will return the '''first''' operand that evaluates to false. Otherwise if both evaluate true the operator will return the '''last''' operand.

Logical OR will return the first operand that evaluates to true, if none do, it will return the '''last''' operand.

Certain values evaluate to false, these are: <code>'''false, null, 0, 0.0'''</code>. Everything else evaluates to true.

<syntaxhighlight lang="c#" line="1" start="1" style="font-weight:bold;>
local v = 0 && 1; // 0
local w = null || "bark"; // "bark"
local x = "" || true; // ""
local y = !0; // true
local z = 5 && "0" // "0"
</syntaxhighlight>

'''Bitwise'''

&, |, ^, ~, <<, >>, >>>

'''Other Operators'''

in, instanceof, typeof, comma, ternary

'''Operator Precedence'''

-, ~, !, typeof , ++, -- highest
/, *, % …
+, -
<<, >>, >>>
<, <=, >, >=, instanceof
==, !=, <=>
&
^
&&, in
+=, =, -=, /=, *=, %= …
, (comma operator) lowest

IntegerLiteral ::= [1-9][0-9]* | '0x' [0-9A-Fa-f]+ | ''' [.]+ ''' | 0[0-7]+
FloatLiteral ::= [0-9]+ '.' [0-9]+
FloatLiteral ::= [0-9]+ '.' 'e'|'E' '+'|'-' [0-9]+
StringLiteral ::= '"'[.]* '"'
VerbatimStringLiteral ::= '@''"'[.]* '"'