Editing mirc/operators

{{mIRC Guide}}
{{DISPLAYTITLE:Operators - mIRC}}
By now, you should have a pretty good idea of what variables are and how to use them. Now, all you need to be able to do is operate on them. That's exactly what '''mIRC Operators''' lets you do. ''Operators'' are special symbols or keywords that perform specific operations on two or three operands in mIRC.

== Operators ==
mIRC provides the following types of operators:

* Arithmetic Operators
* Math Comparison Operators
* String Comparison Operators
* Lexicographical String Comparison Operators
* Logical Operators
* Channel-related Operators
* List-related Operators

=== Arithmetic Operators ===
{| class="wikitable" style="float: right" 
! Operator !! Syntax
|-
| Addition || a + b
|-
| Subtraction || a - b
|-
| Multiplication || a * b
|-
| Division || a / b
|-
| Modulo || a % b
|-
| Power || a ^ b
|}

mIRC supports the following arithmetic operators. They can be used in conjunction with the /var or /set commands as well as using the $calc Identifier. One special feature of the $calc identifier over the /var and /set commands is that it supports combination of operators as well as parenthesis to be able to change the order of operations.

<syntaxhighlight lang="mirc">alias example {
  var %x = 5
  ;5 * 5 = 25
  %x = %x * 5
  echo -a %x

  ;remainder of 25 / 9 = 7
  var %y = %x % 9
  echo -a %y

  ;25 + 7 - 2 = 30
  %x = $calc(%x + %y - 2)
  echo -a %x
}</syntaxhighlight>

== Math Comparison Operators ==
Math Comparison operators allow you to compare two values

{| class="wikitable" style="float: right" 
! Syntax !! Name !! Result
|-
|%x == %y || Equal || True, if %x is equal to %y.
|-
|%x != %y || Not equal || True, if %x is not equal to %y.
|-
|%x &lt; %y || Less than || True, if %x is strictly less than %y.
|-
|%x &gt; %y || Greater than || True, if %x is strictly greater than %y.
|-
|%x &lt;= %y || Less than or equal to || True, if %x is less than or equal to %y.
|-
|%x &gt;= %y || Greater than or equal to || True, if %x is greater than or equal to %y.
|-
|%x // %y || Multiple Of (Divides) || True, if %x divides %y.
|-
|%x \\ %y || Not Multiple Of (Not Divides) || True, if %x does not divides %y.
|-
|%x & %y || Bitwise And || True, if (bit representation of) %x AND %y is a none zero.
|}

Example:

<syntaxhighlight lang="mirc">alias example2 {
  ;true (3 a multiple of 9)
  if (3 // 9) echo yes!
  ;false
  if (4 < 4) echo no
  ;00001010 = 10
  ;00000100 = 4
  ;00000000 = 0
  ;true, we used the '!' to negate the operator
  if (10 !& 4) echo yes
}</syntaxhighlight>

== String Comparison Operators ==
mIRC provides a set of operators that can be used to compare two strings. The two iswm and iswmcs operators support two wildcard characters as well, the question mark (?) substitutes for any one character and the asterisk character ("*") substitutes for any zero or more characters.


Example:

<syntaxhighlight lang="mirc">alias example3 {
  var %x = Hello!
  if (?ell?? iswm %x) echo true
  ;false, because of '!'
  if (%x isalpha) echo no
  %x = 5
  if (%x isnum 1-10) echo true
  if (%x isnum)  echo true
}</syntaxhighlight>

Operators

{| class="wikitable"
! Syntax !! Name !! Result
|-
|%x isin %y || Is In || True, if %x is fully found inside %y.
|-
|%x isincs %y || Is In (case sensitive) || True, if %x is fully found inside (case sensitive) %y.
|-
|%x iswm %y || Wildcard Matching || True, if wildcard string %x matches %y.
|-
|%x iswmcs %y || Wildcard Matching (case sensitive) || True, if wildcard string %x matches (case sensitive) %y.
|-
|%x isnum<br />%x isnum N<br />%x isnum N-<br />%x isnum N-M<br /> || Is Digit<br />Is Digit, Equal to<br />Is Digit, Greater than or equal to<br />Is Digit, in Range || True, if %x is a number<br /> True, if %x is number N<br />True, if %x is number N or greater<br />True, if %x is a number between N and M (inclusively)
|-
|%x isletter<br />%x isletter N<br /> || Is a Letter<br />Is a Letter In A List<br /> || True, if %x is a letter<br />True, if %x is a letter in a list of letters
|-
|%x isalnum || Alphanumeric Characters || True, if %x contains only alphabetic or numeric characters.
|-
|%x isalpha || Alphabetic Characters || True, if %x contains only alphabetic characters.
|-
|%x islower || All lower case letters || True, if %x contains only lower case letters.
|-
|%x isupper || All upper case letters || True, if %x contains only upper case letters.
|}

{{clear}}
<h3 id="LexStringCompOper">Lexicographical String Comparison Operators</h3>
A lexicographical comparison is a comparison generally used to sort words alphabetically in dictionaries and indexes. If both strings are equal but one is shorter than the other, the shorter string is ''lexicographically less'' than the longer one.

{| class="wikitable" style="float: right" 
! Syntax !! Name !! Result
|-
|a == b || Case insensitive character comparison || True, if character a is equal to character b, case insensitive.
|-
|a === b || Case sensitive character comparison || True, if character a is equal to character b, case sensitive.
|-
|str1 == str2 || Case insensitive String comparison || True, if str1 equals str2 in a case insensitive manner.
|-
|str1 === str2 || Case sensitive String comparison || True, if str1 equals str2 in a case insensitive manner.
|-
|a < b || Lexicographically Less Than || True, if the $asc(a) comes before $asc(b)
|-
|a > b || Lexicographically Greater Than || True, if the $asc(a) comes after $asc(b)
|-
|str1 < str2 || Lexicographically Less Than || True, if str1 comes before str2
|-
|str1 > str2 || Lexicographically Greater Than || True, if str1 comes after str2
|}

== Logical Operators ==
In an if statement, you are allowed to have more than one condition. Each condition has to be connected to the other using a logical operator. There are two logical operators: || meaning OR and && meaning AND.

For example:

<syntaxhighlight lang="mirc">if ((%x < 0) || (%x >  10)) {</syntaxhighlight>

In the if statement above, %x has to be less than 0 OR greater than 10 to make the if statement be true.

<syntaxhighlight lang="mirc">if ((%input isupper) && ($len(%input) < 10)) {</syntaxhighlight>

The if statement above will only be true if %a contains only upper case letters and its total length is less than 10.

=== Short-circuit evaluation ===
mIRC will only evaluate as much of the condition has it needs. Consider the AND example from above, if %input doesn't contain only upper case letters, the second condition will never even evaluate. This is important to keep in mind when using custom identifiers inside an if statement.


== Channel-related Operators ==
mIRC also provides a set of commands to involve IRC channels.

{| class="wikitable" style="float: right" 
! Syntax !! Name !! Result
|-
|%x ison %y || Is On || True, if nick %x is on channel %y.
|-
|%x isop %y || Is an Operator || True, if nick %x is an operators on channel %y.
|-
|%x ishop %y || Is a Halfop || True, if nick %x is a halfop on channel %y.
|-
|%x isvoice %y || Is a Voice || True, if nick %x is a voice on channel %y.
|-
|%x isreg %y || Is a Regular || True, if nick %x is a regular user on channel %y.
|-
|%x ischan || Is a Channel || True, if channel %x is a channel you are on.
|-
|%x isban %y || Is a ban || True, if ban address %x is a ban on channel %y. (taken from IBL)
|}

Example:

<syntaxhighlight lang="mirc">alias example4 {
  ;am I on #mIRC
  if (#mIRC ischan) echo yes
  ;is that ban on #mSL's internal ban list?
  if (*!*@example.com isban #offTopic) echo yes
  ;am I an OP on #mIRC?
  if ($me isop #mIRC) echo yes
}</syntaxhighlight>

== List-related Operators ==
mIRC has 5 additional operators to check mIRC internal lists.

{| class="wikitable" style="float: right" 
! Syntax !! Name !! Result
|-
|%x isaop<br />%x isaop %y || In Auto-Op List<br />In Auto-Op List For Chan || True, if host %x is in the auto-op list.<br />True, if host %x is in the auto-op list for channel %y.
|-
|%x isavoice<br />%x isavoice %y || In Auto-Voice List<br />In Auto-Voice List For Chan || True, if host %x is in the auto-voice list.<br /> True, if host %x is in the auto-voice list for channel %y.
|-
| %x isignore<br />%x isignore %y || In Ignore List<br />In Ignore List For Type || True, if host %x is in the ignore list.<br />True, if host %x is in the ignore list for type %y.
|-
%x isprotect<br />%x isprotect %y || In Protect List<br />In Protect List For Chan || True, if host %x is in the protect list.<br />True, if host %x is in the protect list for channel %y.
|-
|%x isnotify || In Notify List || True, if host %x is in the notify list.
|}

Example:
<syntaxhighlight lang="mirc">Alias example5 {
  ;is the host in the auto-op list
  if (dave101!*@* isaop) echo yes

  ;assume we have ignore all ctcps: /ignore -tw *!*@*
  ;check if *!*@* in the ignore list for CTCPs:
  if (*!*@* isignore ctcp) echo yes
}</syntaxhighlight>

[[Category:mIRC]]