Associative array UDF

[b47chguru]

Few days back i made an associative array UDF for a project as autoit does not have associative array/PHP style array support.it does not keep up to the quality of the example scripts posted in this forum.
I hope it may be useful to other amateur developers like me.
 
 
Main UDF file:
associative_arrays.au3
 
 


 




 
CHM help file:
 
associativearray_chm.zip
 
 
list of main functions:

_SetAssociativeArray()
_AddAssociativeArray()
_AssociativeArray()
print_r()
array2json()
Json2Array()

example script:

expandcollapse popup

#include <associative_arrays.au3>

$datas = '' ; creates a variable

;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;                                            ;;
;;  Associative_array exmples                 ;;
;;                                            ;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;


;first example: seting an array value
$value = _SetAssociativeArray($datas, 'roger->royal->datar', '','changedatata=>>inprogressd', True)
    ConsoleWrite(@CR&'first example: seting an array value'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf


$value = _AddAssociativeArray($datas, 'roger->royal->datar->0',  -1, 'changedatata=>>inprogress', True) ;makes a sub array
ConsoleWrite(@CR&'creating a non existent array path roger->royal->datar->0'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf

;second example: pushing an element to the end of an array
$value = _AddAssociativeArray($datas, 'roger->royal->datar',  -1, 'changedatata=>>inpro', True)
ConsoleWrite(@CR&'second example: pushing an element to the end of an array'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf

;third example: adding an element to the 2nd index position in the associative array
$value = _AddAssociativeArray($datas, 'roger->royal->datar',  2, 'added element to 2nd position', True)
ConsoleWrite(@CR&'third example: adding an element to the 2nd index position in the associative array'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf

;fourth example: changing the element in the 2nd index position in the associative array
$value = _SetAssociativeArray($datas, 'roger->royal->datar',  2, '2nd element changed')
ConsoleWrite(@CR&'fourth example: changing the element in the 2nd index position in the associative array'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf

;fifth example:  changing the element in the first index position in the associative array
$value = _SetAssociativeArray($datas, 'roger->royal->datar',  1, 'first element changed')
ConsoleWrite(@CR&'fifth example: changing the element in the first index position in the associative array'&@CR)
If $value > -1 Then 
    print_r($datas)
Else
    ConsoleWrite("Failed: " & $value)
EndIf

_SetAssociativeArray($datas, 'list', '', 'echo', True);makes another array in the root

$value = _AssociativeArray($datas, 'roger->royal->datar')
_ArrayDisplay($value, 'sixth example: reading an array at the position roger->royal->datar')

ConsoleWrite(@CR & 'seventh example: reading the second element of an array'& @CR &_AssociativeArray($datas, 'roger->royal->datar', 2))

$value = _AssociativeArray($datas, 'roger->royal->data')
_ArrayDisplay($value, 'eighth example: trying to read an array which doesnt exist')
;print_r($datas)

$test_json = '{"0":"again0","1":"again1","5":{"0":"test1","male":["asf","s:dfs,f"," boo\r\n hoo"],"1":"test2","2":"test\t3","3":"dgdg \\n fdgd"},"6":"test4","7":"test5"}'
$json_test_array = ''

$value = Json2Array($json_test_array, $test_json)
ConsoleWrite(@CR&'Converting a json to an associative array'&@CR)
If $value > -1 Then 
    print_r($json_test_array)
Else
    ConsoleWrite("Failed: " & $value)
EndIf


ConsoleWrite(@crlf&'Converting an associative array to json'&@CR& array2json($json_test_array)&@CRLF)
ConsoleWrite(Get_Ass_Array($json_test_array, '0', 0, True)&@CR) 

Do let me know if there are any bugs..
Thank you..

Edited September 27, 2013 by b47chguru

[BrewManNH]

You're using Dim in the functions, you shouldn't. Especially since the variable names that you're using it with are fairly common names and I can easily foresee a name clash if someone declared a global with the same name. You should always check your script with this directive in it to see if there are any issues.

#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w- 4 -w 6

[b47chguru]

 

You're using Dim in the functions, you shouldn't. Especially since the variable names that you're using it with are fairly common names and I can easily foresee a name clash if someone declared a global with the same name. You should always check your script with this directive in it to see if there are any issues.

#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w- 4 -w 6

Thankyou brewman for the reply,

i am new to autoit.can you show with an example how using dim on a variable declared locally in a function change it if declared globally later...

 

[guinness]

AutoIt beta help file!

#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w- 3 -w- 6 ; already declared var=off , warn when using Dim=off

#include <Constants.au3>

Dim $vVariableThatIsGlobal = "This is a variable that has ""Program Scope"" aka Global."

MsgBox($MB_SYSTEMMODAL, "", "An example of why Dim can cause more problems than solve them.")

Example()

Func Example()
    ; That looks alright to me as it displays the following text: This is a variable that has "Program Scope" aka Global.
    MsgBox($MB_SYSTEMMODAL, "", $vVariableThatIsGlobal)

    ; Call some random function.
    Local $vReturn = SomeFunc()

    ; The Global variable ($vVariableThatIsGlobal) changed because I totally forgot I had a duplicate variable name in "SomeFunc".
    MsgBox($MB_SYSTEMMODAL, $vReturn, "The variable has now changed: " & $vVariableThatIsGlobal)
EndFunc   ;==>Example

Func SomeFunc()
    ; This should create a variable in Local scope if the variable name doesn"t already exist.
    ; For argument sake I totally forgot that I declared a variable already with the same name.
    ; Well I only want this to be changed in the function and not the variable at the top of the script.
    ; Should be OK right? Think again.
    Dim $vVariableThatIsGlobal = ""

    For $i = 1 To 10
        $vVariableThatIsGlobal &= $i ; This will return 12345678910 totally wiping the previous contents of $vVariableThatIsGlobal.
    Next
    Return $vVariableThatIsGlobal
EndFunc   ;==>SomeFunc

[guinness]

I'm wondering did you test you own example and did it work for you?

[b47chguru]

 

AutoIt beta help file!

#AutoIt3Wrapper_Au3Check_Parameters=-q -d -w- 3 -w- 6 ; already declared var=off , warn when using Dim=off

#include <Constants.au3>

Dim $vVariableThatIsGlobal = "This is a variable that has ""Program Scope"" aka Global."

MsgBox($MB_SYSTEMMODAL, "", "An example of why Dim can cause more problems than solve them.")

Example()

Func Example()
    ; That looks alright to me as it displays the following text: This is a variable that has "Program Scope" aka Global.
    MsgBox($MB_SYSTEMMODAL, "", $vVariableThatIsGlobal)

    ; Call some random function.
    Local $vReturn = SomeFunc()

    ; The Global variable ($vVariableThatIsGlobal) changed because I totally forgot I had a duplicate variable name in "SomeFunc".
    MsgBox($MB_SYSTEMMODAL, $vReturn, "The variable has now changed: " & $vVariableThatIsGlobal)
EndFunc   ;==>Example

Func SomeFunc()
    ; This should create a variable in Local scope if the variable name doesn"t already exist.
    ; For argument sake I totally forgot that I declared a variable already with the same name.
    ; Well I only want this to be changed in the function and not the variable at the top of the script.
    ; Should be OK right? Think again.
    Dim $vVariableThatIsGlobal = ""

    For $i = 1 To 10
        $vVariableThatIsGlobal &= $i ; This will return 12345678910 totally wiping the previous contents of $vVariableThatIsGlobal.
    Next
    Return $vVariableThatIsGlobal
EndFunc   ;==>SomeFunc

 

I'm wondering did you test you own example and did it work for you?

 

 

Hi guinness, first of all sorry for the late reply..

and thanks for the example, i get the point...but is there any alternative to Dim?

yes i have tested and my example works perfectly..

i am using autoit version v3.3.6.1

[guinness]

i am using autoit version v3.3.6.1

Well the majority of us are using v3.3.8.1 (as well as the beta) and I don't think it does, because _ArrayDisplay requires a variable to be passed as a reference. Unless _ArrayDisplay was coded differently in that version?

[b47chguru]

yes _ArrayDisplay function in this version also requires array passed as reference but somehow it works even if it is not supplied in that way...

_ArrayDisplay(Const ByRef $avArray [, $sTitle = "Array: ListView Display" [, $iItemLimit = -1 [, $iTranspose = 0 [, $sSeparator = "" [, $sReplace = "|" [, $sHeader = ""]]]]]])

[guinness]

That's a bug then that was fixed in v3.3.8.1, strange as I didn't see anything in the changelog. Anyway, I'm just telling you the example doesn't work for those of us who use the current version.

Edited July 20, 2013 by guinness

[b47chguru]

ok
modified the example code.