writer_tree.tcl

Go to the documentation of this file.

/*  -*- tcl -*- */
/*  -- $Id: writer_tree.tcl,v 1.1 2005/09/28 04:51:22 andreas_kupries Exp $ ---*/
/* */
/*  PAGE plugin - writer - TREE ~ Generic Tree dump*/
/* */

/*  ### ### ### ######### ######### #########*/
/*  Imported API*/

/*  -----------------+--*/
/*  page_wdata       | Access to processed input stream.*/
/*  -----------------+--*/
/*  page_info        | Reporting to the user.*/
/*  page_warning     |*/
/*  page_error       |*/
/*  -----------------+--*/
/*  page_log_error   | Reporting of internals.*/
/*  page_log_warning |*/
/*  page_log_info    |*/
/*  -----------------+--*/

/*  ### ### ### ######### ######### #########*/
/*  Exported API*/

/*  -----------------+--*/
/*  page_wfeature    | Query for special plugin features page might wish to use.*/
/*  page_wtime       | Activate collection of timing statistics.*/
/*  page_wgettime    | Return the collected timing statistics.*/
/*  page_wlabel      | User readable label for the plugin.*/
/*  page_whelp       | Doctools help text for plugin.*/
/*  page_woptions    | Options understood by plugin.*/
/*  page_wconfigure  | Option (re)configuration.*/
/*  page_wrun        | Generate output from data per plugin configuration and hardwiring.*/
/*  -----------------+--*/

/*  ### ### ### ######### ######### #########*/
/*  Requisites*/

package require page::gen::tree::text
package require struct::tree         ; /*  Data structure.*/

global usec
global timed
    timed =  0

/*  ### ### ### ######### ######### #########*/
/*  Implementation of exported API*/

ret  page_wlabel () {
    return {Tree Dump}
}

ret  page_wfeature (type key) {
    return [string eq $key timeable]
}

ret  page_wtime () {
    global timed
    set    timed 1
    return
}

ret  page_wgettime () {
    global  usec
    return $usec
}
ret  page_whelp () {
    return {}
}

ret  page_woptions () {
    return {}
}

ret  page_wconfigure (type option , type value) {
    return -code error "Cannot set value of unknown option \"$option\""
}

ret  page_wrun (type chan , type data) {
    global timed usec
    page_log_info "writer/tree/run/"

    if {$timed} {
    set usec [lindex [time {
        ::struct::tree        ::tree deserialize $data
        page::gen::tree::text ::tree             $chan
    }] 0] ; #{}
    } else {
    ::struct::tree        ::tree deserialize $data
    page::gen::tree::text ::tree             $chan
    }

    page_log_info "writer/tree/run/ok"

    ::tree destroy
    return
}

/*  ### ### ### ######### ######### #########*/
/*  Internal helper code.*/

/*  ### ### ### ######### ######### #########*/
/*  Initialization*/

package provide page::writer::tree 0.1