StrStrAdv - Revision history

Deguix: Corrected link to LogicLib header file.

2005-12-03T06:20:40Z

â† Older revision		Revision as of 06:20, 3 December 2005
Line 3:		Line 3:
	== Description ==		== Description ==

	'''Requires:''' [[LogicLib]] and [[System plug-in]].		'''Requires:''' [[LogicLib header file]] and [[System plug-in]].

	'''Version:''' 2.0.		'''Version:''' 2.0.

Deguix: Corrected link to System plug-in.

2005-12-03T06:13:42Z

Corrected link to System plug-in.

â† Older revision		Revision as of 06:13, 3 December 2005
Line 3:		Line 3:
	== Description ==		== Description ==

	'''Requires:''' [[LogicLib]] and [[System]] ~~plugin~~.		'''Requires:''' [[LogicLib]] and [[System plug-in]].

	'''Version:''' 2.0.		'''Version:''' 2.0.

Deguix: Corrected comments in the code.

2005-07-10T11:31:46Z

Corrected comments in the code.

â† Older revision		Revision as of 11:31, 10 July 2005
Line 86:		Line 86:
	------------------------------------------		------------------------------------------
	$0 = String (input)		$0 = String (input)
	$1 = ~~StringToSearch~~ (input)		$1 = SubString (input)
	$2 = ~~DirectionOfSearch~~ (input)		$2 = SearchDirection (input)
	$3 = ~~DirectionOfReturn~~ (input)		$3 = StrInclusionDirection (input)
	$4 = ~~ShowStrToSearch~~ (input)		$4 = IncludeSubString (input)
	$5 = ~~NumLoops~~ (input)		$5 = Loops (input)
	$6 = CaseSensitive (input)		$6 = CaseSensitive (input)
	$7 = StringLength (temp)		$7 = StringLength (temp)
Line 97:		Line 97:
	$R0 = EndCharPos (temp)		$R0 = EndCharPos (temp)
	$R1 = StartCharPos (temp)		$R1 = StartCharPos (temp)
	$R2 = ~~OutVar~~ (output)		$R2 = ResultVar (output)
	$R3 = Temp (temp)*/		$R3 = Temp (temp)*/

Line 169:		Line 169:
	StrLen $7 $0		StrLen $7 $0

	; Then find "~~AdvStrStr_StrToSearch~~" length		; Then find "AdvStrStr_SubString" length
	StrLen $8 $1		StrLen $8 $1

Line 195:		Line 195:
	StrCpy $R2 ``		StrCpy $R2 ``
	StrCpy $R3 ``		StrCpy $R3 ``
	SetErrors ;~~AdvStrStr_StrToSearch~~ not found		SetErrors ;AdvStrStr_SubString not found
	Goto AdvStrStr_End		Goto AdvStrStr_End
	${ElseIf} $R2 > $7		${ElseIf} $R2 > $7
Line 201:		Line 201:
	StrCpy $R2 ``		StrCpy $R2 ``
	StrCpy $R3 ``		StrCpy $R3 ``
	SetErrors ;~~AdvStrStr_StrToSearch~~ not found		SetErrors ;AdvStrStr_SubString not found
	Goto AdvStrStr_End		Goto AdvStrStr_End
	${EndIf}		${EndIf}

	; Step 2: Start the search depending on		; Step 2: Start the search depending on
	; ~~AdvStrStr_DirectionOfSearch~~. Chop down not needed		; AdvStrStr_SearchDirection. Chop down not needed
	; characters.		; characters.

Line 252:		Line 252:

	;Now, let's see if the user wants		;Now, let's see if the user wants
	;~~AdvStrStr_StrToSearch~~ to appear:		;AdvStrStr_SubString to appear:
	${If} $4 == 0		${If} $4 == 0
	;Return depends on ~~AdvStrStr_DirectionOfReturn~~		;Return depends on AdvStrStr_StrInclusionDirection
	${If} $3 == <		${If} $3 == <
	; RTL		; RTL
Line 264:		Line 264:
	${Break}		${Break}
	${Else}		${Else}
	;Return depends on ~~AdvStrStr_DirectionOfReturn~~		;Return depends on AdvStrStr_StrInclusionDirection
	${If} $3 == <		${If} $3 == <
	; RTL		; RTL

Deguix: Version: 2.0.

2005-07-10T11:27:43Z

Version: 2.0.

New page

{{PageAuthor|deguix}}

== Description ==

'''Requires:''' [[LogicLib]] and [[System]] plugin.

'''Version:''' 2.0.

This function searches for a substring on a string in a specified search direction and number of loops. This function also supports case-sensitivity of searches.

== How To Use ==

=== Syntax ===

<highlight-nsis>
${StrStrAdv} "ResultVar" "String" "SubString" "SearchDirection" \
"StrInclusionDirection" "IncludeSubString" "Loops" \
"CaseSensitive"
</highlight-nsis>
or
<highlight-nsis>
Push "String"
Push "SubString"
Push "SearchDirection"
Push "StrInclusionDirection"
Push "IncludeSubString"
Push "Loops"
Push "CaseSensitive"
Call StrStrAdv
Pop "ResultVar"
</highlight-nsis>

=== Parameters ===

; ResultVar
: Variable where the part of the ''String'' specified is returned. If ''SubString'' is not found, then an empty string will be returned. If ''SubString'' is empty, then ''String'' will be returned, along with the error flag. If ''String'' is empty, then an empty string will be returned, along with the error flag.

; String
: String where to search for ''SubString''.

; SubString
: String to search in ''String''.

; SearchDirection
: Specifies the direction of the search to go towards. ">" = right, "<" = left. Default is ">" (right).

; StrInclusionDirection
: Specifies which part of the string should be returned to "ResultVar" relating to the position of the ''SubString'' found in ''String''. ">" = right, "<" = left. Default is ">" (right).

; IncludeSubString
: Specifies if ''SubString'' should be included in the string returned by the ''ResultVar'' parameter. "1" = true, "0" = false. Default is "1" (True).

; Loops
: Specifies the number of times the code will search "SubString" in "String" not including the original code execution itself. Default is "0" (1 code execution).

; CaseSensitive
: Specifies if the search should be case-sensitive or not. "1" = true, "0" = false. Default is "0" (case-insensitive).

=== Example ===

<highlight-nsis>
${StrStrAdv} $0 "This is just an example" " is" ">" "<" "0" "0" "0"
;$0 = "This"
</highlight-nsis>

== Function Code ==

<highlight-nsis>
!define StrStrAdv "!insertmacro StrStrAdv"

!macro StrStrAdv ResultVar String SubString SearchDirection \
StrInclusionDirection IncludeSubString Loops CaseSensitive
Push `${String}`
Push `${SubString}`
Push `${SearchDirection}`
Push `${StrInclusionDirection}`
Push `${IncludeSubString}`
Push `${Loops}`
Push `${CaseSensitive}`
Call StrStrAdv
Pop `${ResultVar}`
!macroend

Function StrStrAdv
/*After this point:
------------------------------------------
$0 = String (input)
$1 = StringToSearch (input)
$2 = DirectionOfSearch (input)
$3 = DirectionOfReturn (input)
$4 = ShowStrToSearch (input)
$5 = NumLoops (input)
$6 = CaseSensitive (input)
$7 = StringLength (temp)
$8 = StrToSearchLength (temp)
$9 = CurrentLoop (temp)
$R0 = EndCharPos (temp)
$R1 = StartCharPos (temp)
$R2 = OutVar (output)
$R3 = Temp (temp)*/

;Get input from user

Exch $6
Exch
Exch $5
Exch
Exch 2
Exch $4
Exch 2
Exch 3
Exch $3
Exch 3
Exch 4
Exch $2
Exch 4
Exch 5
Exch $1
Exch 5
Exch 6
Exch $0
Exch 6
Push $7
Push $8
Push $9
Push $R3
Push $R2
Push $R1
Push $R0

; Clean $R0-$R3 variables
StrCpy $R0 ""
StrCpy $R1 ""
StrCpy $R2 ""
StrCpy $R3 ""

; Verify if we have the correct values on the variables
${If} $0 == ``
SetErrors ;AdvStrStr_StrToSearch not found
Goto AdvStrStr_End
${EndIf}

${If} $1 == ``
SetErrors ;No text to search
Goto AdvStrStr_End
${EndIf}

${If} $2 != <
StrCpy $2 >
${EndIf}

${If} $3 != <
StrCpy $3 >
${EndIf}

${If} $4 <> 0
StrCpy $4 1
${EndIf}

${If} $5 <= 0
StrCpy $5 0
${EndIf}

${If} $6 <> 1
StrCpy $6 0
${EndIf}

; Find "AdvStrStr_String" length
StrLen $7 $0

; Then find "AdvStrStr_StrToSearch" length
StrLen $8 $1

; Now set up basic variables

${If} $2 == <
IntOp $R1 $7 - $8
StrCpy $R2 $7
${Else}
StrCpy $R1 0
StrCpy $R2 $8
${EndIf}

StrCpy $9 0 ; First loop

;Let's begin the search

${Do}
; Step 1: If the starting or ending numbers are negative
; or more than AdvStrStr_StringLen, we return
; error

${If} $R1 < 0
StrCpy $R1 ``
StrCpy $R2 ``
StrCpy $R3 ``
SetErrors ;AdvStrStr_StrToSearch not found
Goto AdvStrStr_End
${ElseIf} $R2 > $7
StrCpy $R1 ``
StrCpy $R2 ``
StrCpy $R3 ``
SetErrors ;AdvStrStr_StrToSearch not found
Goto AdvStrStr_End
${EndIf}

; Step 2: Start the search depending on
; AdvStrStr_DirectionOfSearch. Chop down not needed
; characters.

${If} $R1 <> 0
StrCpy $R3 $0 `` $R1
${EndIf}

${If} $R2 <> $7
${If} $R1 = 0
StrCpy $R3 $0 $8
${Else}
StrCpy $R3 $R3 $8
${EndIf}
${EndIf}

; Step 3: Make sure that's the string we want

; Case-Sensitive Support <- Use "AdvStrStr_Temp"
; variable because it won't be used anymore

${If} $6 == 1
System::Call `kernel32::lstrcmpA(ts, ts) i.s` `$R3` `$1`
Pop $R3
${If} $R3 = 0
StrCpy $R3 1 ; Continue
${Else}
StrCpy $R3 0 ; Break
${EndIf}
${Else}
${If} $R3 == $1
StrCpy $R3 1 ; Continue
${Else}
StrCpy $R3 0 ; Break
${EndIf}
${EndIf}

; After the comparasion, confirm that it is the
; value we want.

${If} $R3 = 1

;We found it, return except if the user has set up to
;search for another one:
${If} $9 >= $5

;Now, let's see if the user wants
;AdvStrStr_StrToSearch to appear:
${If} $4 == 0
;Return depends on AdvStrStr_DirectionOfReturn
${If} $3 == <
; RTL
StrCpy $R0 $0 $R1
${Else}
; LTR
StrCpy $R0 $0 `` $R2
${EndIf}
${Break}
${Else}
;Return depends on AdvStrStr_DirectionOfReturn
${If} $3 == <
; RTL
StrCpy $R0 $0 $R2
${Else}
; LTR
StrCpy $R0 $0 `` $R1
${EndIf}
${Break}
${EndIf}
${Else}
;If the user wants to have more loops, let's do it so!
IntOp $9 $9 + 1

${If} $2 == <
IntOp $R1 $R1 - 1
IntOp $R2 $R2 - 1
${Else}
IntOp $R1 $R1 + 1
IntOp $R2 $R2 + 1
${EndIf}
${EndIf}
${Else}
; Step 4: We didn't find it, so do steps 1 thru 3 again

${If} $2 == <
IntOp $R1 $R1 - 1
IntOp $R2 $R2 - 1
${Else}
IntOp $R1 $R1 + 1
IntOp $R2 $R2 + 1
${EndIf}
${EndIf}
${Loop}

AdvStrStr_End:

;Add 1 to AdvStrStr_EndCharPos to be supportable
;by "StrCpy"

IntOp $R2 $R2 - 1

;Return output to user

Exch $R0
Exch
Pop $R1
Exch
Pop $R2
Exch
Pop $R3
Exch
Pop $9
Exch
Pop $8
Exch
Pop $7
Exch
Pop $6
Exch
Pop $5
Exch
Pop $4
Exch
Pop $3
Exch
Pop $2
Exch
Pop $1
Exch
Pop $0

FunctionEnd
</highlight-nsis>

== Credits ==
Author: Diego Pedroso ([[User:deguix|deguix]])<br>
Based on [[StrStr]] function.

[[Category:String Functions]]