_ExpandVarStrings!

[MrCreatoR]

Hi all,

Here is a custom function to expand the strings/macros - it can expand even variables with one $ symbol, i.e - "Some $Var"

And also, this function bypassing the bug(?) i found recently ...

expandcollapse popup

$Var = "Our Value"
$Str = "Our String"

;================= Example with $iMode = -1, default - Only $String$ expanded =================
$sString = "This is <$Var$> and this is <$Str$>"
$ExpandedStr = _ExpandVarStrings($sString, -1)

MsgBox(64, "Expand Var Strings", "Was:" & @LF & $sString & @LF & @LF & "Expanded:" & @LF & $ExpandedStr)
;==========================================================================================================


;================= Example with $iMode = 1, Only $String expanded =================
$sString = "$Var goes here, and $Str goes here"
$ExpandedStr = _ExpandVarStrings($sString, 1)

MsgBox(64, "Expand Var Strings", "Was:" & @LF & $sString & @LF & @LF & "Expanded:" & @LF & $ExpandedStr)
;==========================================================================================================


;================= Example with $iMode = 2, All strings expanded ($String and $String$) =================
$sString = "$Var not equel $Str$"
$ExpandedStr = _ExpandVarStrings($sString, 2)

MsgBox(64, "Expand Var Strings", "Was:" & @LF & $sString & @LF & @LF & "Expanded:" & @LF & $ExpandedStr)
;==========================================================================================================


;===============================================================================
; Function Name:    _ExpandVarStrings()
; Description:      Expand string variable/macro inside string (using different modes).
; Parameter(s):        $sString - String that contain variables that need to be expanded.
;                      $iMode - Define the expand mode...
;                               -1 - (default) will expand only $Var$/@Macro@.
;                               1 - will expand only $Var/@Macro.
;                               2 - will expand $Var$/@Macro@ and $Var/@Macro.
; Requirement(s):   None.
; Return Value(s):  On success - Return initial string with expanded variables.
;
;                   On failure - If $sString not contain string variables that need to be expanded (according to $iMode), 
;                                will returned initial $sString.
;
; Note(s):          Only Global Scope variables are expanded.
; Author(s):        G.Sandler (a.k.a CreatoR)
;===============================================================================
Func _ExpandVarStrings($sString, $iMode=-1)
    Local $aExtractStrs, $sPattern, $sEval, $Old_Opt_EVS
    Local $sRetStr = $sString, $sExpndStr = ""
    Local $aSymbExpnd[2] = ["$", "@"]
    
    Local $Old_Func_Opt_EVS = Opt("ExpandVarStrings", 0)
    
    For $i = 0 To 1
        Switch $iMode
            Case 1
                $sPattern = "(?i)(\" & $aSymbExpnd[$i] & "[0-9a-z_]+)"
            Case 2
                $sPattern = "(?i)(\" & $aSymbExpnd[$i] & "[0-9a-z_]+\" & $aSymbExpnd[$i] & ")|(\" & $aSymbExpnd[$i] & "[0-9a-z_]+)"
            Case Else
                $sPattern = "(?i)(\" & $aSymbExpnd[$i] & "[0-9a-z_]+\" & $aSymbExpnd[$i] & ")"
        EndSwitch
        
        Local $aExtractStrs = StringRegExp($sString, $sPattern, 3)
        If Not IsArray($aExtractStrs) Then ContinueLoop
        
        For $iE = 0 To UBound($aExtractStrs)-1
            If $i = 0 Then
                $sEval = Eval(StringReplace($aExtractStrs[$iE], $aSymbExpnd[$i], ""))
                If $sEval <> "" Then $sRetStr = StringReplace($sRetStr, $aExtractStrs[$iE], $sEval)
            ElseIf $iMode <> -1 Or StringRight($aExtractStrs[$iE], 1) = $aSymbExpnd[$i] Then
                $sExpndStr = $aExtractStrs[$iE]
                If StringRight($sExpndStr, 1) <> $aSymbExpnd[$i] Then $sExpndStr &= $aSymbExpnd[$i]
                $Old_Opt_EVS = Opt("ExpandVarStrings", 1)
                $sExpndStr = $sExpndStr
                Opt("ExpandVarStrings", $Old_Opt_EVS)
                If $aExtractStrs[$iE] <> "" Then $sRetStr = StringReplace($sRetStr, $aExtractStrs[$iE], $sExpndStr)
            EndIf
        Next
    Next
    
    Opt("ExpandVarStrings", $Old_Func_Opt_EVS)
    Return $sRetStr
EndFunc

Edit 1: Fixed small problem when Opt("ExpandVarStrings", 1) was previously set by user.

Edit 2: Added note to the func comment about the usage limitation of this function.

Edited December 11, 2007 by MsCreatoR

[piccaso]

Maybe i don't get it right, but why not let execute do all the work?

Func _Expand($s)
   Local $o = Opt("ExpandVarStrings",1)
   $s = StringReplace($s,'"','""')
   Local $r = Execute('"' & $s & '"')
   Opt("ExpandVarStrings",$o)
   Return $r
EndFunc

$a = "aa"
$x = "xx"
ConsoleWrite(_Expand("@AutoItVersion@, $a$, $x$") & @CRLF)

Please don't get me wrong, i don't want to criticize your code...

[MrCreatoR]

why not let execute do all the work?

Well, this will not work then:

$a = "aa"
$x = "xx"
ConsoleWrite(_Expand("3.2.8.1, $a, $x") & @CRLF)oÝ÷ ٩ݺ¹

[MrCreatoR]

Btw, there is no need to use Execute in that case..

Func _Expand($s)
    Local $o = Opt("ExpandVarStrings",1)
    $s = $s
    Opt("ExpandVarStrings",$o)
    Return $s
EndFunc

$a = "aa"
$x = "xx"
ConsoleWrite(_Expand("@AutoItVersion@, $a$, $x$") & @CRLF)

Or i am not fully understand of what you mean by this example :">

Edited December 11, 2007 by MsCreatoR

[piccaso]

I Could swear it didnt work when i tried it a minute ago...

Well even better

This is no bug, you need some kind of terminator.

or how would you threat that?

$Where = "Here"
Expand("$WhereDoesTheVariableNameEnd?")

[piccaso]

Ok it was just a rhetorical question, no need to answer, i read your patterns.

I know now what functionality your after

But anyway, this will never work:

Func whatever()
   $x = "some val"
   ConsoleWrite(_ExpandVarStrings("$x$") & @CRLF)
EndFunc
whatever()

Because $x is not in the global scope, thus Eval() cant reach it.

Same goes for my suggested concept...

[MrCreatoR]

But anyway, this will never work:

Too bad - i thoght that Eval() can handle all kind of variables.

I added note to the comments of the function, because i can not see a solution for that one.