Modify _ArrayDisplay

[Xenobiologist]

HI @all,

just 2 little questions belonging to the _ArrayDisplay function from Array.au3.

1) The behaviour when "Default" ist used as parameter

2) If the header parameter is used with a smaller amount of column titles as columns in the array, those columns are not displayed.

Here is a little script to compare the results.

This is no really feature request, that is why I posted it here.

Let me hear what you think.

expandcollapse popup

#include<Array.au3>
Global $1d[9] = ['Entry 1', 'Entry 2', 'Entry 3', 'Entry 4', 'Entry 5', 'Entry 6', 'Entry 7', 'Entry 8', 'Entry 9']
Global $2d[1][9] = [['Entry 1', 'Entry 2', 'Entry 3', 'Entry 4', 'Entry 5', 'Entry 6', 'Entry 7', 'Entry 8', 'Entry 9']]
; To show the difference
; 1) old version
; 2) modified version
; Test with Default value
_ArrayDisplay($1d, Default, Default, Default, Default, Default)
__ArrayDisplay($1d, Default, Default, Default, Default, Default)
; Test with more columns in the array than specified in header
_ArrayDisplay($2d, "There are 9 columns in this array old", -1, 0, "", "|", 'NR|Column 0|Column 1|Column 2|Column 3')
__ArrayDisplay($2d, "There are 9 columns in this array new", -1, 0, "", "|", 'NR|Column 0|Column 1|Column 2|Column 3')
Exit(0)
; #FUNCTION# ====================================================================================================================
; Name...........: _ArrayDisplay
; Description ...: Displays given 1D or 2D array array in a listview.
; Syntax.........: _ArrayDisplay(Const ByRef $avArray[, $sTitle = "Array: ListView Display"[, $iItemLimit = -1[, $iTranspose = 0[, $sSeparator = ""[, $sReplace = "|"[, $sHeader = ""]]]]]])
; Parameters ....: $avArray - Array to display
;                 $sTitle    - [optional] Title to use for window
;                 $iItemLimit - [optional] Maximum number of listview items (rows) to show
;                 $iTranspose - [optional] If set differently than default, will transpose the array if 2D
;                 $sSeparator - [optional] Change Opt("GUIDataSeparatorChar") on-the-fly
;                 $sReplace   - [optional] String to replace any occurrence of $sSeparator with in each array element
;                 $sheader   - [optional] Header column names
; Return values .: Success - 1
;                 Failure - 0, sets @error:
;                 |1 - $avArray is not an array
;                 |2 - $avArray has too many dimensions (only up to 2D supported)
; Author ........: randallc, Ultima
; Modified.......: Gary Frost (gafrost), Ultima, Zedna, jpm
; Remarks .......:
; Related .......:
; Link ..........:
; Example .......: Yes
; ===============================================================================================================================
Func __ArrayDisplay(Const ByRef $avArray, $sTitle = "Array: ListView Display", $iItemLimit = -1, $iTranspose = 0, $sSeparator = "", $sReplace = "|", $sHeader = "")
    If Not IsArray($avArray) Then Return SetError(1, 0, 0)
    ; Dimension checking
    Local $iDimension = UBound($avArray, 0), $iUBound = UBound($avArray, 1) - 1, $iSubMax = UBound($avArray, 2) - 1
    If $iDimension > 2 Then Return SetError(2, 0, 0)
    ; Separator handling
    If $sSeparator = "" or $sSeparator = Default Then $sSeparator = Chr(124)
    ;  Check the separator to make sure it's not used literally in the array
    If _ArraySearch($avArray, $sSeparator, 0, 0, 0, 1) <> -1 Then
        For $x = 1 To 255
            If $x >= 32 And $x <= 127 Then ContinueLoop
            Local $sFind = _ArraySearch($avArray, Chr($x), 0, 0, 0, 1)
            If $sFind = -1 Then
                $sSeparator = Chr($x)
                ExitLoop
            EndIf
        Next
    EndIf
    ; Declare variables
    Local $vTmp, $iBuffer = 4094 ; AutoIt max item size
    Local $iColLimit = 250
    Local $iOnEventMode = Opt("GUIOnEventMode", 0), $sDataSeparatorChar = Opt("GUIDataSeparatorChar", $sSeparator)
    ; Swap dimensions if transposing
    If $iSubMax < 0 Then $iSubMax = 0
    If $iTranspose Then
        $vTmp = $iUBound
        $iUBound = $iSubMax
        $iSubMax = $vTmp
    EndIf
    ; Set limits for dimensions
    If $iSubMax > $iColLimit Then $iSubMax = $iColLimit
    If $iItemLimit < 1 Then $iItemLimit = $iUBound
    If $iUBound > $iItemLimit Then $iUBound = $iItemLimit
    ; Set header up
    If $sHeader = "" Then
        $sHeader = "Row  " ; blanks added to adjust column size for big number of rows
        For $i = 0 To $iSubMax
            $sHeader &= $sSeparator & "Col " & $i
        Next
    Else
        StringReplace($sHeader, '|', '|') ; to set a header for all columns
        For $i = @extended To $iSubMax
            $sHeader &= $sSeparator & "Col " & $i
        Next
    EndIf
    ; Convert array into text for listview
    Local $avArrayText[$iUBound + 1]
    For $i = 0 To $iUBound
        $avArrayText[$i] = "[" & $i & "]"
        For $j = 0 To $iSubMax
            ; Get current item
            If $iDimension = 1 Then
                If $iTranspose Then
                    $vTmp = $avArray[$j]
                Else
                    $vTmp = $avArray[$i]
                EndIf
            Else
                If $iTranspose Then
                    $vTmp = $avArray[$j][$i]
                Else
                    $vTmp = $avArray[$i][$j]
                EndIf
            EndIf
            ; Add to text array
            $vTmp = StringReplace($vTmp, $sSeparator, $sReplace, 0, 1)
            ; Set max buffer size
            If StringLen($vTmp) > $iBuffer Then $vTmp = StringLeft($vTmp, $iBuffer)
            $avArrayText[$i] &= $sSeparator & $vTmp
        Next
    Next
    ; GUI Constants
    Local Const $_ARRAYCONSTANT_GUI_DOCKBORDERS = 0x66
    Local Const $_ARRAYCONSTANT_GUI_DOCKBOTTOM = 0x40
    Local Const $_ARRAYCONSTANT_GUI_DOCKHEIGHT = 0x0200
    Local Const $_ARRAYCONSTANT_GUI_DOCKLEFT = 0x2
    Local Const $_ARRAYCONSTANT_GUI_DOCKRIGHT = 0x4
    Local Const $_ARRAYCONSTANT_GUI_EVENT_CLOSE = -3
    Local Const $_ARRAYCONSTANT_LVM_GETCOLUMNWIDTH = (0x1000 + 29)
    Local Const $_ARRAYCONSTANT_LVM_GETITEMCOUNT = (0x1000 + 4)
    Local Const $_ARRAYCONSTANT_LVM_GETITEMSTATE = (0x1000 + 44)
    Local Const $_ARRAYCONSTANT_LVM_SETEXTENDEDLISTVIEWSTYLE = (0x1000 + 54)
    Local Const $_ARRAYCONSTANT_LVS_EX_FULLROWSELECT = 0x20
    Local Const $_ARRAYCONSTANT_LVS_EX_GRIDLINES = 0x1
    Local Const $_ARRAYCONSTANT_LVS_SHOWSELALWAYS = 0x8
    Local Const $_ARRAYCONSTANT_WS_EX_CLIENTEDGE = 0x0200
    Local Const $_ARRAYCONSTANT_WS_MAXIMIZEBOX = 0x00010000
    Local Const $_ARRAYCONSTANT_WS_MINIMIZEBOX = 0x00020000
    Local Const $_ARRAYCONSTANT_WS_SIZEBOX = 0x00040000
    ; Set interface up
    Local $iWidth = 640, $iHeight = 480
    Local $hGUI = GUICreate($sTitle, $iWidth, $iHeight, Default, Default, BitOR($_ARRAYCONSTANT_WS_SIZEBOX, $_ARRAYCONSTANT_WS_MINIMIZEBOX, $_ARRAYCONSTANT_WS_MAXIMIZEBOX))
    Local $aiGUISize = WinGetClientSize($hGUI)
    Local $hListView = GUICtrlCreateListView($sHeader, 0, 0, $aiGUISize[0], $aiGUISize[1] - 26, $_ARRAYCONSTANT_LVS_SHOWSELALWAYS)
    Local $hCopy = GUICtrlCreateButton("Copy Selected", 3, $aiGUISize[1] - 23, $aiGUISize[0] - 6, 20)
    GUICtrlSetResizing($hListView, $_ARRAYCONSTANT_GUI_DOCKBORDERS)
    GUICtrlSetResizing($hCopy, $_ARRAYCONSTANT_GUI_DOCKLEFT + $_ARRAYCONSTANT_GUI_DOCKRIGHT + $_ARRAYCONSTANT_GUI_DOCKBOTTOM + $_ARRAYCONSTANT_GUI_DOCKHEIGHT)
    GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_SETEXTENDEDLISTVIEWSTYLE, $_ARRAYCONSTANT_LVS_EX_GRIDLINES, $_ARRAYCONSTANT_LVS_EX_GRIDLINES)
    GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_SETEXTENDEDLISTVIEWSTYLE, $_ARRAYCONSTANT_LVS_EX_FULLROWSELECT, $_ARRAYCONSTANT_LVS_EX_FULLROWSELECT)
    GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_SETEXTENDEDLISTVIEWSTYLE, $_ARRAYCONSTANT_WS_EX_CLIENTEDGE, $_ARRAYCONSTANT_WS_EX_CLIENTEDGE)
    ; Fill listview
    For $i = 0 To $iUBound
        GUICtrlCreateListViewItem($avArrayText[$i], $hListView)
    Next
    ; adjust window width
    $iWidth = 0
    For $i = 0 To $iSubMax + 1
        $iWidth += GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_GETCOLUMNWIDTH, $i, 0)
    Next
    If $iWidth < 250 Then $iWidth = 230
    $iWidth += 20
    If $iWidth > @DesktopWidth Then $iWidth = @DesktopWidth - 100
    WinMove($hGUI, "", (@DesktopWidth - $iWidth) / 2, Default, $iWidth)
    ; Show dialog
    GUISetState(@SW_SHOW, $hGUI)
    While 1
        Switch GUIGetMsg()
            Case $_ARRAYCONSTANT_GUI_EVENT_CLOSE
                ExitLoop
            Case $hCopy
                Local $sClip = ""
                ; Get selected indices [ _GUICtrlListView_GetSelectedIndices($hListView, True) ]
                Local $aiCurItems[1] = [0]
                For $i = 0 To GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_GETITEMCOUNT, 0, 0)
                    If GUICtrlSendMsg($hListView, $_ARRAYCONSTANT_LVM_GETITEMSTATE, $i, 0x2) Then
                        $aiCurItems[0] += 1
                        ReDim $aiCurItems[$aiCurItems[0] + 1]
                        $aiCurItems[$aiCurItems[0]] = $i
                    EndIf
                Next
                ; Generate clipboard text
                If Not $aiCurItems[0] Then
                    For $sItem In $avArrayText
                        $sClip &= $sItem & @CRLF
                    Next
                Else
                    For $i = 1 To UBound($aiCurItems) - 1
                        $sClip &= $avArrayText[$aiCurItems[$i]] & @CRLF
                    Next
                EndIf
                ClipPut($sClip)
        EndSwitch
    WEnd
    GUIDelete($hGUI)
    Opt("GUIOnEventMode", $iOnEventMode)
    Opt("GUIDataSeparatorChar", $sDataSeparatorChar)
    Return 1
EndFunc   ;==>__ArrayDisplay

Edited December 30, 2011 by Xenobiologist

[BrewManNH]

It looks like the original doesn't accept the "Default" keyword as a parameter. Also, isn't the normal operation for a listview, when you have less column header names than columns, if you send it too many columns it ignores them?

[Xenobiologist]

Yes, but FMPOV the _ArrayDisplay funtion is 99% debugging. Sometimes it is useful to add column headers to have a better understanding of what the function shows.

I the amount of columns changes than the function still should show the complete array and not only the columns I passed a header through as parameter.

[czardas]

That's quite a discovery.

I was recently perplexed by _ArrayDsplay() when I tried to display an element (in a 2D array) that contained a very long string. The string did not display, and I thought it was something to do with my code. Perhaps a mention of this limitation (if it is a limitation) could be added to the help file.

Edited December 30, 2011 by czardas

[BrewManNH]

Yes, but FMPOV the _ArrayDisplay funtion is 99% debugging. Sometimes it is useful to add column headers to have a better understanding of what the function shows.

I the amount of columns changes than the function still should show the complete array and not only the columns I passed a header through as parameter.

Except that the ArrayDisplay function uses a standard Listview to display that information, and a Listview with 5 column headers will only display 5 columns. It's either a limitation of the Listview, or a limitation of AutoIT's implementation of the Listview. You'd have to change the function to recognize how many subitems the array has and add/subtract header labels to accomodate that.

[Xenobiologist]

No, I do not want to change the behaviour of Listviews. The Listivew is just a function which is used in _ArrayDisplay.

Imagine, _ArrayDisplay would be a buildin function (blackbox) then you wouldn't know what is used inside.

The point is, should all columns be shown even if the columns header array/string passed as parameter hasn't got enough entries.

And that's the point where I say, while used for debugging YES, all columns should be shown.

[BrewManNH]

I didn't mean change how listviews work, I meant change the _ArrayDisplay function to look for the condition where the number of column headers and the number of array subitems don't match, and adjust the column header information before creating the Listview inside the _ArrayDisplay function.

[Xenobiologist]

Isn't that what I did?

[BrewManNH]

I saw that after I posted that, makes sense to do it so that it makes no difference how many column headers are specified.

Well done, and should probably be added to the official version.

[Xenobiologist]

And now? Do I have to create a feature request or bug report for this?

Anybody who can clearify this?

THANKS!

Edited January 2, 2012 by Xenobiologist

[BrewManNH]

It could fall under both categories, but because it affects how the function is used, it should probably be a bug report.

[Xenobiologist]

http://www.autoitscript.com/trac/autoit/ticket/2088

[Beege]

Xenobiologist, I like your ideas and agree with you about this function pretty much only being used for debugging. My only problem with the design is the same one Jpm had on track pretty much saying "what if I only want to display 2 of 9 columns."

I think a middle ground could be found to this if an extra parameter was added to the function. Maybe something like $bShowAllColumns. This would add your new idea while still holding on the previous.

Func __ArrayDisplay(Const ByRef $avArray, $sTitle = "Array: ListView Display", $iItemLimit = -1, $iTranspose = 0, $sSeparator = "", $sReplace = "|", $sHeader = "", $bShowAllColumns = False)

A good description would be needed for the new parameter clarifying how it only effects the function if $sHeader is not the default value. I have it set to false by default so that the new changes would not effect the functionality of past scripts (even though is probably just being used for debugging.)

[Xenobiologist]

Okay, that is another point.

I do not know in which case I have an array displayed for debugging and I only want to know special columns and not all columns.

Anyhow, adding another parameter to control the behaviour would do the trick.

[Valik]

I've been trying to let this die a slow death somewhere but I see it won't. This function already has 7 parameters. It does not need more. This is trivial to solve. Write a helper function that takes as input the array and the column header string. The output will be a modified column header string with columns added to ensure all columns in the array are shown. There's no need to touch _ArrayDisplay() at all. It's already complex enough.

[Xenobiologist]

D'accord.