LogicLib: Difference between revisions
(Correction) |
(- grammar) |
||
Line 19: | Line 19: | ||
=== Statements === | === Statements === | ||
<highlight-nsis>If|IfNot|Unless..{ElseIf|ElseIfNot|ElseUnless}..[Else]..EndIf|EndUnless</highlight-nsis> | <highlight-nsis>If|IfNot|Unless..{ElseIf|ElseIfNot|ElseUnless}..[Else]..EndIf|EndUnless</highlight-nsis> | ||
Conditionally executes a block of statements, depending on the value of | Conditionally executes a block of statements, depending on the value of an expression. IfNot and Unless are equivalent and interchangeable, as are ElseIfNot and ElseUnless. | ||
Line 62: | Line 62: | ||
${Next}</highlight-nsis> | ${Next}</highlight-nsis> | ||
The code above will count backwards from 10 to 0, in steps of 2. Both ends will be reached: 10, 8, 6, 4, 2, 0. | The code above will count backwards from 10 to 0, in steps of 2. Both ends will be reached: 10, 8, 6, 4, 2, 0. | ||
=== Expressions === | === Expressions === |
Revision as of 21:05, 2 October 2009
Description
Logic Lib adds some more familiar flow control and logic to NSI Scripts. Things like if, else, while loops, for loops and similar. It is also known as the NSIS Logic Library.
It is appallingly non-documented, but certainly handy if you want to do anything more than very basic logic without having complete Spaghetti Code.
Additionally, since variable assignment doesn't take place within LogicLib, conditional operators do not conform to "programmatic standards." For example, a single equals sign (=) is used as a comparative operator for integers, rather than the traditional double equals sign (==), which is only valid for string comparisons.
It was created by dselkirk@hotmail.com and eccles@users.sf.net. Shipped with NSIS is version 2.6, which added IfNot support to the otherwise unchanged code from 2004.
A thread exists for discussion of this on the winamp forums at http://forums.winamp.com/showthread.php?s=&postid=1116241
Some Reference
These have been deduced from actually viewing the header file itself, which has a little help info at the top.
The include file for this is LogicLib.nsh. It can be included with:
!include 'LogicLib.nsh'
Statements
If|IfNot|Unless..{ElseIf|ElseIfNot|ElseUnless}..[Else]..EndIf|EndUnless
Conditionally executes a block of statements, depending on the value of an expression. IfNot and Unless are equivalent and interchangeable, as are ElseIfNot and ElseUnless.
AndIf|AndIfNot|AndUnless|OrIf|OrIfNot|OrUnless
Adds any number of extra conditions to If, IfNot, Unless, ElseIf, ElseIfNot and ElseUnless statements.
IfThen..|..|
Conditionally executes an inline statement, depending on the value of an expression.
IfCmd..||..|
Conditionally executes an inline statement, depending on a true value of the provided NSIS function.
Select..{Case[2|3|4|5]}..[CaseElse|Default]..EndSelect
Executes one of several blocks of statements, depending on the value of an expression.
Switch..{Case|CaseElse|Default}..EndSwitch
Jumps to one of several labels, depending on the value of an expression. Like in the majority of high-level programming languages, if you do not use ${Break} the execution will 'fall through' the proceeding ${Case} blocks.
Do[While|Until]..{ExitDo|Continue|Break}..Loop[While|Until]
Repeats a block of statements until stopped, or depending on the value of an expression. Example:
FileRead $fp $line ${DoUntil} ${Errors} MessageBox MB_OK $line FileRead $fp $line ${LoopUntil} 1 = 0
The expression at the start and end of the loop are required, but need not match. This means you can exit the loop with diferent conditions, or use a constant condition on either the begingin or the end, to obtain a classical "C-like" while(){} or do{}while() loop.
While..{ExitWhile|Continue|Break}..EndWhile
An alias for DoWhile..Loop (for backwards-compatibility)
For[Each]..{ExitFor|Continue|Break}..Next
Repeats a block of statements varying the value of a variable. Example:
Var i ${ForEach} $i 10 0 - 2 MessageBox MB_OK $i ${Next}
The code above will count backwards from 10 to 0, in steps of 2. Both ends will be reached: 10, 8, 6, 4, 2, 0.
Expressions
The following "expressions" are available:
- Standard (built-in) string tests (which are case-insensitive):
a == b; a != b
- Additional case-insensitive string tests (using System.dll):
a S< b; a S>= b; a S> b; a S<= b
- Case-sensitive string tests (using System.dll):
a S== b; a S!= b
- Standard (built-in) signed integer tests:
a = b; a <> b; a < b; a >= b; a > b; a <= b
- Standard (built-in) unsigned integer tests:
a U< b; a U>= b; a U> b; a U<= b
- 64-bit integer tests (using System.dll):
a L= b; a L<> b; a L< b; a L>= b; a L> b; a L<= b
- Built-in NSIS flag tests:
${Abort}; ${Errors}; ${RebootFlag}; ${Silent}
- Built-in NSIS other tests:
${FileExists} a
Any conditional NSIS instruction test:
${Cmd} a
- Section flag tests:
${SectionIsSelected} ${secA}; ${SectionIsSectionGroup} ${secA}; ${SectionIsSectionGroupEnd} ${secA}; ${SectionIsBold} ${secA}; ${SectionIsReadOnly} ${secA}; ${SectionIsExpanded} ${secA}; ${SectionIsPartiallySelected} ${secA}