[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# tcl::transform::spacer(n) 1 tcllib "Reflected/virtual channel support"

## Name

tcl::transform::spacer - Space insertation and removal

## Synopsis

- package require Tcl 8.6
- package require tcl::transform::core ?1?
- package require tcl::transform::spacer ?1?

- ::tcl::transform::spacer chan n ?space?

## Description

The tcl::transform::spacer package provides a command creating a channel transformation which adds spacing to the data written to it, and removes such spacing from the data read from it.

The internal TclOO class implementing the transform handler is a sub-class of the tcl::transform::core framework.

## API

::tcl::transform::spacer chan n ?space?

  This command creates a spacer transformation on top of the channel chan and returns its handle.

  The space character sequence will be added every n bytes of data written, and on the read side the same is done in reverse, removing the spacing. If space is not specified it defaults to a single space character (ASCII 32).

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category virtchannel of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## Keywords

channel transformation, reflected channel, spacing, tip 230, transformation, virtual channel

## Category

Channels

## Copyright

Copyright © 2009 Andreas Kupries <andreas_kupries@users.sourceforge.net>