TABLE OF CONTENTS


readfilter

NAME

::guib::moduleObj::readfilter -- the "readfilter" GUIB keyword

USAGE

readfilter cmd

DESCRIPTION

-- GUIB keyword !!!

    Keyword "readfilter" is used for telling the GUIB that when an

input-file is open, it should first be parsed by the proc specified by "readfilter" keyword. A typical usage of readfilter keyword is in situations where GUIB cannot handle well the input-file, and we need some pre-processing of the input. Usually when the "readfilter" is used for input pre-processing, then the "writefilter" should be used for post-processing the outout.

The readfilter "cmd" proc should be of the following form:

proc myReadFilter {moduleObj channel} {

    ... code here ...
    return $myChannel

}

Where "moduleObj" is object-name of the moduleObj, and "channel" is the input-file channel (i.e. set channel [open $myInput r]). The proc MUST return a file-channel of the pre-processed input.

RETURN VALUE

Returns the "cmd".

SOURCE

body ::guib::moduleObj::readfilter  {cmd}    { set readFilter $cmd }