Skip to main content

Serialize/Deserialize a Gnocl Tree Widget

The options and command set of the gnocl::tree widget allow for easy creation and editing of data arranged and displayed in a tree structure. What is lacking in the Gtk api is an equivalent of the GtkTreeView serialize and deserialize functionality.

Creating a similar offering for the gnocl::tree is not altogether difficult to implement because it is possible to sequentially extract data from a tree which can then be saved for later use (serialize). When the data is next needed for use, it can be sequentially added to a new tree widget (deserialize).

The sampe code below will produce the following,  the tree on the left is created through the direct addtion of data, whereas the tree on the right (with treelines) is created by deserializing the data set of the first tree.





When data contained in a tree was serialzed the following list was returned and save to disk. Each line of list represents a row in the tree where the first item is the node path, and the second item, the data itself. More specifically, the data contains the valued held in each cel on each row. Hence, 2 values for 2 columns per row. 

0 {Mamals 0}
{0 0} {Cat 4}
{0 1} {Dog 4}
{0 2} {Human 2}
1 {ABC 0}
{1 0} {Parrots 0}
{1 0 0} {Cockatoo 2}
{1 0 1} {Amazone 2}
{1 1} {Predator 0}
{1 1 0} {Hawk 2}
{1 1 1} {Eagle 2}
2 {Bugs 0}
{2 0} {Beetle 6}
{2 1} {Spider 8}
{2 2} {Worm 0}

The path ids in the above form provide a means of identifying a specific row in the tree. The number of digits in the path id indicate the level of depth within the tree. In this example there are in fact three tree structures  displayed simulaneously, namely Mammals (0), Birds (1) and Insects (2).

Whenever an entry is added, the target doesn't exist and so, when deserializing the final element of the path id is ignored. In the case of the tree roots, (Mammals, Birds and Insects in the above example), the first and last nodes are the same, hence the path id set to "".



#---------------
# simple-tree.tcl
#---------------
#!/bin/sh
#\
exec tclsh "$0" "$@"

package require Gnocl

# TODO: Perhaps these two procs can be embedded into the C code?

proc serialize { wid } {
    foreach node [$wid nodeList] {
        ::lappend nodes $node [$wid getRow $node]
    }
    foreach key [::dict keys $nodes] {
        append res "[::list $key] [::list [::dict get $nodes $key]]\n"
    }
    return $res
}

proc deserialize {wid data} {
    foreach { pos val } $data {
        if { [::llength $pos] == 1 } { set pos "" }
        $wid add [::lrange $pos 0 end-1] [::list $val]   
    }
}

#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

# its necessary to have similar trees, i.e. same number of columns and data types.
set tree(1) [gnocl::tree \
    -ruleHint 1 \
    -onSelectionChanged {
        # use join to safely convert the list to a string.
        puts [ %w get [join %p] 0]
        # to get an entire row:
        puts [join %p]~~~[%w getRow [join %p] ]
       } \
    -types {string string} \
    -titles {"Type" "# of Legs"}]

set tree(2) [gnocl::tree \
    -treeLines 1 \
    -onSelectionChanged {
        # use join to safely convert the list to a string.
        puts [ %w get [join %p] 0]
        # to get an entire row:
        puts [join %p]~~~[%w getRow [join %p] ]
       } \
    -types {string string} \
    -titles {"Type" "# of Legs"}]

# add some items in a hap-hazard sort of way ;-)

$tree(1) add {} {Mammals Birds Insects}
$tree(1) add 0 {{Cat 4} {Dog 4} {Human 2}}

foreach {paro pred} [$tree(1) add 1 {Parrots Raptor}] {}

$tree(1) add $paro {{Cockatoo 2} {Sparrow 2}}
$tree(1) add $pred {{Hawk 2} {Eagle 2}}
$tree(1) add 2 {{Beetle 6} {Spider 8} {Centipede ?}}

set fp [open treeData.dat w]
puts $fp [serialize $tree(1)]
close $fp

set fp [open treeData.dat r]
deserialize $tree(2) [read $fp]
close $fp

set box1 [gnocl::vBox -label TreeView-1 -children $tree(1) -fill 1 -expand 1]
set box2 [gnocl::vBox -label TreeView-2 -children $tree(2) -fill 1 -expand 1]
set box [gnocl::hBox -children [list $box1 $box2] -fill 1 -expand 1]

foreach pid {0 1 2} {
    $tree(1) expand -path $pid -recursive 1
    $tree(2) expand -path $pid -recursive 1
}

gnocl::window -child $box -setSize 0.35

Comments

Popular posts from this blog

gnocl::calendar

Given this module some attention today. Added some of the more package wide options to the module and created customised handler for setting the month. (For some odd reason months are are counted 0-11 whereas days are 1-31.) There's still a little more to do to this one including the addition of code to store diary details. Here's the working test script to show the range of options at work. The percentage substitution string item %e explores something that I've been toying with, the name of the signal/event that initiated the call. Ok, a script can keep its own internal trace but who knows, it might prove useful. #--------------- # calendarTest.tcl #--------------- # Author:   William J Giddings # Date:     07/05/09 #--------------- #!/bin/sh # the next line restarts using tclsh \ exec tclsh "$0" "$@" #--------------- package require Gnocl set cal [gnocl::calendar] $cal configure -day 8 -month 7 -year 1956 $cal configure -rowHeight 1 -colWidth 1 $ca...

Gnocl Dashboard

Over the past few programming sessions I've been working on producing a central point, a dashboard, around which it's possible to see the various Gnocl widgets and commands in operation. In many ways like the demo script which shipped with the earlier releases of Gnocl but offers much more. The introspection functionality provides details of the various options and sub-commands of each Gnocl procedure which are displayed under the associated tab. Sample scripts are included for each item which offers newcomers a clearer insight into how make the most of what's on offer.

Getting Widget Style Properties

Until the move over to Gtk4, Gnocl is still built against the Gtk 2.21 libraries. One of the inconveniences of Gtk is getting and setting widget style settings which are considered to be set globally by the desktop style settings and not for the programmer to tinker around with. Needless to say, there are times when different defaults are preferred, largely to draw the users attention to 'something a bit different'. The function gtk_widget_modify_font  is a convenience function to set the widget basefont as shown in this snippet from the button.c module,  if ( options[baseFontIdx].status == GNOCL_STATUS_CHANGED ) { GtkWidget *label; label = gnoclFindChild ( GTK_WIDGET ( para->button ), GTK_TYPE_LABEL ); PangoFontDescription *font_desc = pango_font_description_from_string ( Tcl_GetString ( options[baseFontIdx].val.obj ) ); gtk_widget_modify_font ( GTK_WIDGET ( label ), font_desc ); pango_font_description_free ( font_desc ); } Unfortunately, there's no d...