Snippets ( AutoIt String ): Difference between revisions

From AutoIt Wiki
Jump to navigation Jump to search
(Added StringTrimLeftUntil & StringTrimRightUntil)
Line 215: Line 215:
[[#top | Return To Contents]]
[[#top | Return To Contents]]


== _StringRegExpSplit ==
== StringTrimLeftUntil ==


{{Snippet Header
{{Snippet Header
| AuthorURL = 69238-dany
| AuthorURL = 89462-TheDcoder
| AuthorName = dany
| AuthorName = TheDcoder
| Desc = Split a string based on a regular expression.
| Desc = Trim a string left until it reaches the delimiter character.
}}
}}


<syntaxhighlight lang="autoit">
<syntaxhighlight lang="autoit">
; Split a string based on a regular expression.
; #FUNCTION# ====================================================================================================================
; http://www.autoitscript.com/forum/topic/139260-autoit-snippets/page__st__120#entry1036533
; Name ..........: StringTrimLeftUntil
#include <Array.au3> ; Only needed for example.
; Description ...: Trim a string left until it reaches the delimiter charecter
Global $sString = 'List:' & _
; Syntax ........: StringTrimLeftUntil($sDelimiter, $sString)
        '1. Bananas' & _
; Parameters ....: $sDelimiter          - Charecter(s) to trim until
        '2. Coconuts' & _
;                  $sString            - A string value.
        '3. Apples'
;                  $iOccurrence        - Trim until which occurrence of the delimiter [Default = 1st occurrence]
_ArrayDisplay(_StringRegExpSplit($sString, '[0-9]+\. ?')) ; Use the numbering (#.) to split on.
; Return values .: Trimmed String
Global $bBinary = Binary($sString)
; Author ........: TheDcoder
_ArrayDisplay(_StringRegExpSplit($bBinary, '3[0-9]2E(20)?'))
; Modified ......: Thanks to water for the Idea
; Remarks .......: This function is not case sensitive meaning "DeLiMiTeR" is same as "Delimiter"
; Related .......: StringTrimLeft
; Link ..........: https://www.autoitscript.com/forum/topic/139260-autoit-snippets/?do=findComment&comment=1250764
; Example .......: No
; ===============================================================================================================================
Func StringTrimLeftUntil($sDelimiter, $sString, $iOccurrence = 1)
$iDelimiterLen = StringLen($sDelimiter)
    $sString = StringTrimLeft($sString, StringInStr($sString, $sDelimiter, 2, $iOccurrence) + ($iDelimiterLen - 1)) ; This is a little hard to explain:
#cs =========================================================================================================================================|
| What it does is:                                                                                                                          |
| 1. Find the delimiter's position in the string (StringInStr)                                                                               |
| 2. Add delimiter's Length to delimiters position (I remove 1 for delimiter's length because StringInStr already contains that 1 charecter) |
| 3. Trim the string :)                                                                                                                     |
#ce =========================================================================================================================================|
    Return $sString ; Return the String :D
EndFunc  ;==>StringTrimLeftUntil
</syntaxhighlight>


; #FUNCTION# ===================================================================
[[#top | Return To Contents]]
; Name...........: _StringRegExpSplit
 
; Description ...: Split a string according to a regular expression.
== StringTrimRightUntil ==
; Syntax.........: _StringRegExpSplit($sString, $sPattern)
 
; Parameters ....: $sString - String: String to split.
{{Snippet Header
;                  $sPattern - String: Regular expression to split on.
| AuthorURL = 89462-TheDcoder
; Return values .: Success - Array: Array of substrings, the total is in $array[0].
| AuthorName = TheDcoder
;                 Failure - Array: The count is 1 ($array[0]) and the full string is returned ($array[1]) and sets @error:
| Desc = Trim a string right until it reaches the delimiter character.
;                 |1 Delimiter not found.
}}
;                 |2 Bad RegExp pattern, @extended contains the offset of the error in the pattern.
 
;                  |3 No suitable placeholder delimiter could be constructed.
<syntaxhighlight lang="autoit">
; Author ........: dany
; #FUNCTION# ====================================================================================================================
; Modified ......: czardas, AZJIO
; Name ..........: StringTrimRightUntil
; Remarks .......:
; Description ...: Trim a string right until it reaches the delimiter charecter
; Related .......:
; Syntax ........: StringTrimRightUntil($sDelimiter, $sString)
; ==============================================================================
; Parameters ....: $sDelimiter          - Charecter(s) to trim until
Func _StringRegExpSplit($sString, $sPattern)
;                  $sString            - A string value.
Local $sSplit, $sDelim, $aError[2] = [1, $sString]
;                 $iOccurrence        - Trim until which occurrence of the delimiter [Default = 1st occurrence]
For $i = 1 To 31
; Return values .: Trimmed String
$sDelim &= Chr($i)
; Author ........: TheDcoder
If Not StringInStr($sString, $sDelim) Then ExitLoop
; Modified ......: Me
If 32 = StringLen($sDelim) Then Return SetError(3, 0, $aError)
; Remarks .......: This function is not case sensitive meaning "DeLiMiTeR" is same as "Delimiter"
Next
; Related .......: StringTrimRight
$sSplit = StringRegExpReplace($sString, $sPattern, $sDelim)
; Link ..........: https://www.autoitscript.com/forum/topic/139260-autoit-snippets/?do=findComment&comment=1250764
If @error Then Return SetError(2, @extended, $aError)
; Example .......: No
If @extended = 0 Then Return SetError(1, 0, $aError)
; ===============================================================================================================================
If Not IsBinary($sString) Then Return StringSplit($sSplit, $sDelim, 1)
Func StringTrimRightUntil($sDelimiter, $sString, $iOccurrence = 1)
$sSplit = StringSplit($sSplit, $sDelim, 1)
$iStringLen = StringLen($sString) ; We need string's len
For $i = 2 To $sSplit[0]
$iDelimiterLen = StringLen($sDelimiter) ; We need delimiter's len too
$sSplit[$i] = '0x' & $sSplit[$i]
    $sString = StringTrimRight($sString, ($iStringLen - StringInStr($sString, $sDelimiter, 2, $iOccurrence)) + $iDelimiterLen) ; Explanation:
Next
#cs ============================================================================================|
Return $sSplit
| 1. Find delimiters postition                                                                  |
EndFunc  ;==>_StringRegExpSplit
| 2. Remove String's len from delimiters position to invert the trimming process (to the right) |
| 3. Add the delimiter's len to trim the delimiter                                              |
| 4. Trim the string!!!                                                                        |
#ce ============================================================================================|
    Return $sString ; Return the String
EndFunc  ;==>StringTrimRightUntil
</syntaxhighlight>
</syntaxhighlight>


[[#top | Return To Contents]]
[[#top | Return To Contents]]

Revision as of 11:31, 12 June 2015

Please always credit an author in your script if you use their code. It is only polite.

_StringEqualSplit

Author: czardas 








#include <Array.au3>
Local $aArray = _StringEqualSplit("12345678910", 3)
_ArrayDisplay($aArray)

Func _StringEqualSplit($sString, $iNumChars)
    If Not IsString($sString) Or $sString = "" Then Return SetError(1, 0, 0)
    If Not IsInt($iNumChars) Or $iNumChars < 1 Then Return SetError(2, 0, 0)
    Return StringRegExp($sString, "(?s).{1," & $iNumChars & "}", 3)
EndFunc

Return To Contents

_StringGetChrCount

Author: GEOSoft







Check how many times the word 'test' appears in the string. 1 = Case-sensitive or 0 = Non Case-sensitive. 


; Check how many times the word 'test' appears in the string. 1 = Case-sensitive or 0 = Non Case-sensitive.
ConsoleWrite(_StringGetChrCount("test teste test", "TEST", 0) & @CRLF)

Func _StringGetChrCount($sStr, $sChr, $iCase = 0)
	If $iCase <> 0 Then
		$iCase = 1
	EndIf
	StringReplace($sStr, $sChr, $sChr, 0, $iCase)
	Return @extended
EndFunc   ;==>_StringGetChrCount

Return To Contents

_StringEqualSplit

Author: czardas




Modified: guinness




Splits a string into an equal number of characters. The 0th index returns the number of items. 


#include <Array.au3>
#include <String.au3>

Local $aSplitEqual = _StringEqualSplit('abcdefghijklmnopqrstuvwxyz', 5)
_ArrayDisplay($aSplitEqual)

; By czardas & modified by guinness >> http://www.autoitscript.com/forum/topic/139260-autoit-snippets/page__st__20#entry992149
; Version: 1.10. AutoIt: V3.3.8.1
; Splits a string into an equal number of characters. The 0th index returns the number of items.
Func _StringEqualSplit($sString, $iNumChars)
	If IsString($sString) = 0 Or $sString == '' Then
		Return SetError(1, 0, 0)
	EndIf

	If IsInt($iNumChars) = 0 Or $iNumChars < 1 Then
		Return SetError(2, 0, 0)
	EndIf

	Local $aReturn = StringRegExp(_StringRepeat('0', 5) & $sString, '(?s).{1,' & $iNumChars & '}', 3)
	$aReturn[0] = UBound($aReturn, 1) - 1
	Return $aReturn
EndFunc   ;==>_StringEqualSplit

Return To Contents

_StringIsNum

Author: smartee 








ConsoleWrite(StringIsNum('Example') & @CRLF)
ConsoleWrite(StringIsNum('123456') & @CRLF)
ConsoleWrite(StringIsNum('Example & 123456') & @CRLF)

Func StringIsNum($sString)
    Return StringRegExp($sString, "^([0-9]*(\.[0-9]+){1}|[0-9]+(\.[0-9]*){0,1})$") = 1
EndFunc   ;==>StringIsNum

Return To Contents

_StringRemoveLine

Author: SmOke_N 








Global $string = 'This is an example' & @CRLF & 'Of deleting a line' & @CRLF & 'If you know at least the beginning text of the line.'

MsgBox(0, 'Original', $string)

Global $deleteline = _StringRemoveLine($string, 'Of deleting')

MsgBox(0, 'Deleted Line', $deleteline)

Func _StringRemoveLine($hFile, $sDelete)
    If FileExists($hFile) Then $hFile = FileRead($hFile);Remove If FileExists($hFile) Then << only
    Local $nSNS = StringInStr($hFile, @CRLF & $sDelete) - 1
    Local $sSFH = StringLeft($hFile, $nSNS)
    Local $sRL = StringTrimLeft($hFile, StringLen($sSFH) + 2)
    Local $sLLEN = StringLen(StringLeft($sRL, StringInStr($sRL, @CRLF)))
    If Not $sLLEN Then $sLLEN = StringLen($sRL)
    Return $sSFH & StringTrimLeft($hFile, $sLLEN + $nSNS + 2)
EndFunc ;==>_StringRemoveLine()

Return To Contents

_StringReplaceBlank

Author: SmOke_N







Remove blank lines from a File 


; Remove blank lines from a File
Local $sString = "I am a string" & @CRLF & @CRLF & _
		"With Empty Lines" & @CRLF & @CRLF & _
		"Please Remove those empty lines"

MsgBox(4096, "Before", $sString)

$sString = _StringReplaceBlank($sString, 1)

MsgBox(4096, "Replaced: " & @extended & " lines.", $sString)

Func _StringReplaceBlank($sString, $sSpaces = "")
	If $sSpaces Then
		$sSpaces = "\s*"
	EndIf

	$sString = StringRegExpReplace($sString, "(?s)\r\n" & $sSpaces & "\r\n", @CRLF)

	If @extended Then
		Return SetError(0, @extended, $sString)
	EndIf

	Return SetError(1, 0, $sString)
EndFunc   ;==>_StringReplaceBlank

Return To Contents

_StringTrimLeftIsEqual

Author: guinness







Strip a character/word from the leftmost part of a string. 


ConsoleWrite(_StringTrimLeftIsEqual('C:\Test', 'C:\') & @CRLF) ; Returns Test as the string 'C:\' is stripped from the left.
ConsoleWrite(_StringTrimLeftIsEqual('C:\Test\', 'C') & @CRLF) ; Returns :\Test as the character 'C' is stripped from the left.
ConsoleWrite(_StringTrimLeftIsEqual('C:\Test\', 'Test') & @CRLF) ; Returns the initial string as the string 'Test' was not found to the leftmost part of the string.

; Version: 1.00. AutoIt: V3.3.8.1
; Strip a character/word from the leftmost part of a string.
Func _StringTrimLeftIsEqual($sString, $sStringTrim)
    Local $aStringTrim[2] = [0, StringLen($sStringTrim)]
    Return StringTrimLeft($sString, $aStringTrim[Number(StringLeft($sString, $aStringTrim[1]) == $sStringTrim)])
EndFunc   ;==>_StringTrimLeftIsEqual

Return To Contents

_StringTrimRightIsEqual

Author: guinness







Strip a character/word from the rightmost part of a string. 


ConsoleWrite(_StringTrimRightIsEqual('C:\Test', 'Test') & @CRLF) ; Returns C:\ as the string 'Test' is stripped from the right.
ConsoleWrite(_StringTrimRightIsEqual('C:\Test\', '\') & @CRLF) ; Returns C:\Test as the character '\' is stripped from the right.
ConsoleWrite(_StringTrimRightIsEqual('C:\Test\', 'Test') & @CRLF) ; Returns the initial string as the string 'Test' was not found to the rightmost part of the string.

; Version: 1.00. AutoIt: V3.3.8.1
; Strip a character/word from the rightmost part of a string.
Func _StringTrimRightIsEqual($sString, $sStringTrim)
    Local $aStringTrim[2] = [0, StringLen($sStringTrim)]
    Return StringTrimRight($sString, $aStringTrim[Number(StringRight($sString, $aStringTrim[1]) == $sStringTrim)])
EndFunc   ;==>_StringTrimRightIsEqual

Return To Contents

StringTrimLeftUntil

Author: TheDcoder







Trim a string left until it reaches the delimiter character. 


; #FUNCTION# ====================================================================================================================
; Name ..........: StringTrimLeftUntil
; Description ...: Trim a string left until it reaches the delimiter charecter
; Syntax ........: StringTrimLeftUntil($sDelimiter, $sString)
; Parameters ....: $sDelimiter          - Charecter(s) to trim until
;                  $sString             - A string value.
;                  $iOccurrence         - Trim until which occurrence of the delimiter [Default = 1st occurrence]
; Return values .: Trimmed String
; Author ........: TheDcoder
; Modified ......: Thanks to water for the Idea 
; Remarks .......: This function is not case sensitive meaning "DeLiMiTeR" is same as "Delimiter"
; Related .......: StringTrimLeft
; Link ..........: https://www.autoitscript.com/forum/topic/139260-autoit-snippets/?do=findComment&comment=1250764
; Example .......: No
; ===============================================================================================================================
Func StringTrimLeftUntil($sDelimiter, $sString, $iOccurrence = 1)
	$iDelimiterLen = StringLen($sDelimiter)
    $sString = StringTrimLeft($sString, StringInStr($sString, $sDelimiter, 2, $iOccurrence) + ($iDelimiterLen - 1)) ; This is a little hard to explain:
	#cs =========================================================================================================================================|
	| What it does is:                                                                                                                           |
	| 1. Find the delimiter's position in the string (StringInStr)                                                                               |
	| 2. Add delimiter's Length to delimiters position (I remove 1 for delimiter's length because StringInStr already contains that 1 charecter) |
	| 3. Trim the string :)                                                                                                                      |
	#ce =========================================================================================================================================|
    Return $sString ; Return the String :D
EndFunc   ;==>StringTrimLeftUntil

Return To Contents

StringTrimRightUntil

Author: TheDcoder







Trim a string right until it reaches the delimiter character. 


; #FUNCTION# ====================================================================================================================
; Name ..........: StringTrimRightUntil
; Description ...: Trim a string right until it reaches the delimiter charecter
; Syntax ........: StringTrimRightUntil($sDelimiter, $sString)
; Parameters ....: $sDelimiter          - Charecter(s) to trim until
;                  $sString             - A string value.
;                  $iOccurrence         - Trim until which occurrence of the delimiter [Default = 1st occurrence]
; Return values .: Trimmed String
; Author ........: TheDcoder
; Modified ......: Me
; Remarks .......: This function is not case sensitive meaning "DeLiMiTeR" is same as "Delimiter"
; Related .......: StringTrimRight
; Link ..........: https://www.autoitscript.com/forum/topic/139260-autoit-snippets/?do=findComment&comment=1250764
; Example .......: No
; ===============================================================================================================================
Func StringTrimRightUntil($sDelimiter, $sString, $iOccurrence = 1)
	$iStringLen = StringLen($sString) ; We need string's len
	$iDelimiterLen = StringLen($sDelimiter) ; We need delimiter's len too
    $sString = StringTrimRight($sString, ($iStringLen - StringInStr($sString, $sDelimiter, 2, $iOccurrence)) + $iDelimiterLen) ; Explanation:
	#cs ============================================================================================|
	| 1. Find delimiters postition                                                                  |
	| 2. Remove String's len from delimiters position to invert the trimming process (to the right) |
	| 3. Add the delimiter's len to trim the delimiter                                              |
	| 4. Trim the string!!!                                                                         |
	#ce ============================================================================================|
    Return $sString ; Return the String 
EndFunc   ;==>StringTrimRightUntil

Return To Contents

Retrieved from "https://www.autoitscript.com/w/index.php?title=Snippets_(_AutoIt_String_)&oldid=13116"