Skip to main content

Read / Save and Creating config files using gnocl::keyFile

I'm pretty well satisfied that this module is in a usable form. This morning I put together some Tcl proc to manage the creation of application config files. This is what I came up with;

#---------------
# test-keyfile.tcl
#---------------
# William J Giddings
# 21/12/2010
#---------------

#!/bin/sh
#\
exec tclsh "$0" "$@"

package require Gnocl

#---------------
# read named ini file and create global config array
#---------------
# args:
#    fname    name of file to load
# notes:
#    resets any existing config array
# returns:
#    id of the created keyframe object
#---------------
proc config:read { {fname app.ini} } {
    global config
    array unset config

    set i 0
    set kf [gnocl::keyFile load $fname]

    foreach group [$kf get groups] {
        foreach key  [$kf get keys -group $group ] {
            set config($key) [$kf get value -group $group -key $key]
            incr i
        }
    }
    return $kf
}

#---------------
# Write current configuration setting to .ini file
#---------------
# args:
#    kf        keyfile object id
#    fname    name of the ini file to create
# notes:
#    key group memberships checked internally
# returns:
#    number of items written to keyfile
#---------------
proc config:write {kf {fname app.ini} } {
    global config
    set i 0

    foreach key [array names config] {
        foreach group [$kf get groups] {
            if { [$kf has -group $group -key $key ] } {
                $kf set value -group $group -key $key -value $config($key)
                incr i
            }
        }
    }
    $kf write $fname
    return i
}

#---------------
# Sets default configuration settings.
#---------------
# args:
#    fname        name of the ini file to create
#    defaults    list of entries in the form <group:key value>
# notes:
#    if no values set, then an empty ini file will be created
# returns:
#    id of newly created keyfile object
#---------------
proc config:new { {fname app.ini} {defaults {} } } {
    global config

    array unset config

    set kf [gnocl::keyFile new $fname]

    if {$defaults == {}} {return $kf}

    foreach {a b} $defaults {
        foreach {group key} [split $a :] {}
        $kf set value -group $group -key $key -value $b
        set config($key) $b
    }

    return $kf
}


#----------
# test code
#----------

set defaults {
    group_1:key_a 1
    group_1:key_b 2
    group_2:key_c 3
    group_2:key_d 4
    group_3:key_e 5
    group_3:key_f 6
    group_3:key_g 7
    }

set kf [config:new test.ini $defaults ]

config:write $kf test.ini



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.

Simple Runtime Debugging Message Dialog

At times it's useful to see what values variables hold, or offer some pause point before the code goes elsewhere before causing havoc. Its possible to write output to the terminal but this can get lost in copious forms of other outputs, besides, there's no pausing the script execution either. The following proc creates a custom dialog which displays ad message along with the point in the calling script from which it was invoked. ## simple runtime debugging feedback dialog, alternative to console based gnocl::msg # @param msg message to display # @returns none # proc xxx::msg {txt} { set frame [info frame -1] append msg "Message:\n\n" append msg " $txt \n\n\n" append msg "Called from:\n\n" append msg "Proc:\t[lindex [info level -1] 0]\n" append msg "File:\t[file tail [dict get $frame file]]\n" append msg "Line:\t[dict get $frame line]\n" gnocl::dialog \ -type info \ -text $msg