Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man3 / Tcl_StackChannel.3
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1999-2000 Ajuba Solutions.
3'\"
4'\" See the file "license.terms" for information on usage and redistribution
5'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
6'\"
7'\" RCS: @(#) $Id: ChnlStack.3,v 1.4.4.1 2004/07/16 20:10:58 andreas_kupries Exp $
8'\" The definitions below are for supplemental macros used in Tcl/Tk
9'\" manual entries.
10'\"
11'\" .AP type name in/out ?indent?
12'\" Start paragraph describing an argument to a library procedure.
13'\" type is type of argument (int, etc.), in/out is either "in", "out",
14'\" or "in/out" to describe whether procedure reads or modifies arg,
15'\" and indent is equivalent to second arg of .IP (shouldn't ever be
16'\" needed; use .AS below instead)
17'\"
18'\" .AS ?type? ?name?
19'\" Give maximum sizes of arguments for setting tab stops. Type and
20'\" name are examples of largest possible arguments that will be passed
21'\" to .AP later. If args are omitted, default tab stops are used.
22'\"
23'\" .BS
24'\" Start box enclosure. From here until next .BE, everything will be
25'\" enclosed in one large box.
26'\"
27'\" .BE
28'\" End of box enclosure.
29'\"
30'\" .CS
31'\" Begin code excerpt.
32'\"
33'\" .CE
34'\" End code excerpt.
35'\"
36'\" .VS ?version? ?br?
37'\" Begin vertical sidebar, for use in marking newly-changed parts
38'\" of man pages. The first argument is ignored and used for recording
39'\" the version when the .VS was added, so that the sidebars can be
40'\" found and removed when they reach a certain age. If another argument
41'\" is present, then a line break is forced before starting the sidebar.
42'\"
43'\" .VE
44'\" End of vertical sidebar.
45'\"
46'\" .DS
47'\" Begin an indented unfilled display.
48'\"
49'\" .DE
50'\" End of indented unfilled display.
51'\"
52'\" .SO
53'\" Start of list of standard options for a Tk widget. The
54'\" options follow on successive lines, in four columns separated
55'\" by tabs.
56'\"
57'\" .SE
58'\" End of list of standard options for a Tk widget.
59'\"
60'\" .OP cmdName dbName dbClass
61'\" Start of description of a specific option. cmdName gives the
62'\" option's name as specified in the class command, dbName gives
63'\" the option's name in the option database, and dbClass gives
64'\" the option's class in the option database.
65'\"
66'\" .UL arg1 arg2
67'\" Print arg1 underlined, then print arg2 normally.
68'\"
69'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
70'\"
71'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
72.if t .wh -1.3i ^B
73.nr ^l \n(.l
74.ad b
75'\" # Start an argument description
76.de AP
77.ie !"\\$4"" .TP \\$4
78.el \{\
79. ie !"\\$2"" .TP \\n()Cu
80. el .TP 15
81.\}
82.ta \\n()Au \\n()Bu
83.ie !"\\$3"" \{\
84\&\\$1 \\fI\\$2\\fP (\\$3)
85.\".b
86.\}
87.el \{\
88.br
89.ie !"\\$2"" \{\
90\&\\$1 \\fI\\$2\\fP
91.\}
92.el \{\
93\&\\fI\\$1\\fP
94.\}
95.\}
96..
97'\" # define tabbing values for .AP
98.de AS
99.nr )A 10n
100.if !"\\$1"" .nr )A \\w'\\$1'u+3n
101.nr )B \\n()Au+15n
102.\"
103.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
104.nr )C \\n()Bu+\\w'(in/out)'u+2n
105..
106.AS Tcl_Interp Tcl_CreateInterp in/out
107'\" # BS - start boxed text
108'\" # ^y = starting y location
109'\" # ^b = 1
110.de BS
111.br
112.mk ^y
113.nr ^b 1u
114.if n .nf
115.if n .ti 0
116.if n \l'\\n(.lu\(ul'
117.if n .fi
118..
119'\" # BE - end boxed text (draw box now)
120.de BE
121.nf
122.ti 0
123.mk ^t
124.ie n \l'\\n(^lu\(ul'
125.el \{\
126.\" Draw four-sided box normally, but don't draw top of
127.\" box if the box started on an earlier page.
128.ie !\\n(^b-1 \{\
129\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
130.\}
131.el \}\
132\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133.\}
134.\}
135.fi
136.br
137.nr ^b 0
138..
139'\" # VS - start vertical sidebar
140'\" # ^Y = starting y location
141'\" # ^v = 1 (for troff; for nroff this doesn't matter)
142.de VS
143.if !"\\$2"" .br
144.mk ^Y
145.ie n 'mc \s12\(br\s0
146.el .nr ^v 1u
147..
148'\" # VE - end of vertical sidebar
149.de VE
150.ie n 'mc
151.el \{\
152.ev 2
153.nf
154.ti 0
155.mk ^t
156\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
157.sp -1
158.fi
159.ev
160.\}
161.nr ^v 0
162..
163'\" # Special macro to handle page bottom: finish off current
164'\" # box/sidebar if in box/sidebar mode, then invoked standard
165'\" # page bottom macro.
166.de ^B
167.ev 2
168'ti 0
169'nf
170.mk ^t
171.if \\n(^b \{\
172.\" Draw three-sided box if this is the box's first page,
173.\" draw two sides but no top otherwise.
174.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
175.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
176.\}
177.if \\n(^v \{\
178.nr ^x \\n(^tu+1v-\\n(^Yu
179\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
180.\}
181.bp
182'fi
183.ev
184.if \\n(^b \{\
185.mk ^y
186.nr ^b 2
187.\}
188.if \\n(^v \{\
189.mk ^Y
190.\}
191..
192'\" # DS - begin display
193.de DS
194.RS
195.nf
196.sp
197..
198'\" # DE - end display
199.de DE
200.fi
201.RE
202.sp
203..
204'\" # SO - start of list of standard options
205.de SO
206.SH "STANDARD OPTIONS"
207.LP
208.nf
209.ta 5.5c 11c
210.ft B
211..
212'\" # SE - end of list of standard options
213.de SE
214.fi
215.ft R
216.LP
217See the \\fBoptions\\fR manual entry for details on the standard options.
218..
219'\" # OP - start of full description for a single option
220.de OP
221.LP
222.nf
223.ta 4c
224Command-Line Name: \\fB\\$1\\fR
225Database Name: \\fB\\$2\\fR
226Database Class: \\fB\\$3\\fR
227.fi
228.IP
229..
230'\" # CS - begin code excerpt
231.de CS
232.RS
233.nf
234.ta .25i .5i .75i 1i
235..
236'\" # CE - end code excerpt
237.de CE
238.fi
239.RE
240..
241.de UL
242\\$1\l'|0\(ul'\\$2
243..
244.TH Tcl_StackChannel 3 8.3 Tcl "Tcl Library Procedures"
245.BS
246'\" Note: do not modify the .SH NAME line immediately below!
247.SH NAME
248Tcl_StackChannel, Tcl_UnstackChannel, Tcl_GetStackedChannel, Tcl_GetTopChannel \- stack an I/O channel on top of another, and undo it
249.SH SYNOPSIS
250.nf
251.nf
252\fB#include <tcl.h>\fR
253.sp
254Tcl_Channel
255\fBTcl_StackChannel\fR(\fIinterp, typePtr, clientData, mask, channel\fR)
256.sp
257int
258\fBTcl_UnstackChannel\fR(\fIinterp, channel\fR)
259.sp
260Tcl_Channel
261\fBTcl_GetStackedChannel\fR(\fIchannel\fR)
262.sp
263Tcl_Channel
264\fBTcl_GetTopChannel\fR(\fIchannel\fR)
265.sp
266.SH ARGUMENTS
267.AS Tcl_ChannelType
268.AP Tcl_Interp *interp in
269Interpreter for error reporting.
270.AP Tcl_ChannelType *typePtr in
271The new channel I/O procedures to use for \fIchannel\fP.
272.AP ClientData clientData in
273Arbitrary one-word value to pass to channel I/O procedures.
274.AP int mask in
275Conditions under which \fIchannel\fR will be used: OR-ed combination of
276\fBTCL_READABLE\fR, \fBTCL_WRITABLE\fR and \fBTCL_EXCEPTION\fR.
277This can be a subset of the operations currently allowed on \fIchannel\fP.
278.AP Tcl_Channel channel in
279An existing Tcl channel such as returned by \fBTcl_CreateChannel\fR.
280.BE
281
282.SH DESCRIPTION
283.PP
284These functions are for use by extensions that add processing layers to Tcl
285I/O channels. Examples include compression and encryption modules. These
286functions transparently stack and unstack a new channel on top of an
287existing one. Any number of channels can be stacked together.
288.PP
289The implementation of the Tcl channel code was rewritten in 8.3.2 to
290correct some problems with the previous implementation with regard to
291stacked channels. Anyone using stacked channels or creating stacked
292channel drivers should update to the new \fBTCL_CHANNEL_VERSION_2\fR
293\fBTcl_ChannelType\fR structure. See \fBTcl_CreateChannel\fR for details.
294.PP
295\fBTcl_StackChannel\fR stacks a new \fIchannel\fP on an existing channel
296with the same name that was registered for \fIchannel\fP by
297\fBTcl_RegisterChannel\fP.
298.PP
299\fBTcl_StackChannel\fR works by creating a new channel structure and
300placing itself on top of the channel stack. EOL translation, encoding and
301buffering options are shared between all channels in the stack. The hidden
302channel does no buffering, newline translations, or character set encoding.
303Instead, the buffering, newline translations, and encoding functions all
304remain at the top of the channel stack. A pointer to the new top channel
305structure is returned. If an error occurs when stacking the channel, NULL
306is returned instead.
307.PP
308The \fImask\fP parameter specifies the operations that are allowed on the
309new channel. These can be a subset of the operations allowed on the
310original channel. For example, a read-write channel may become read-only
311after the \fBTcl_StackChannel\fR call.
312.PP
313Closing a channel closes the channels stacked below it. The close of
314stacked channels is executed in a way that allows buffered data to be
315properly flushed.
316.PP
317\fBTcl_UnstackChannel\fP reverses the process. The old channel is
318associated with the channel name, and the processing module added by
319\fBTcl_StackChannel\fR is destroyed. If there is no old channel, then
320\fBTcl_UnstackChannel\fP is equivalent to \fBTcl_Close\fP. If an error
321occurs unstacking the channel, \fBTCL_ERROR\fR is returned, otherwise
322\fBTCL_OK\fR is returned.
323.PP
324\fBTcl_GetTopChannel\fR returns the top channel in the stack of
325channels the supplied channel is part of.
326.PP
327\fBTcl_GetStackedChannel\fR returns the channel in the stack of
328channels which is just below the supplied channel.
329
330.SH "SEE ALSO"
331Notifier(3), Tcl_CreateChannel(3), Tcl_OpenFileChannel(3), vwait(n).
332
333.SH KEYWORDS
334channel, compression