diff options
Diffstat (limited to 'itcl/itcl/doc/Stack.3')
| -rw-r--r-- | itcl/itcl/doc/Stack.3 | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/itcl/itcl/doc/Stack.3 b/itcl/itcl/doc/Stack.3 new file mode 100644 index 00000000000..e5ce2101515 --- /dev/null +++ b/itcl/itcl/doc/Stack.3 @@ -0,0 +1,60 @@ +'\" +'\" Copyright (c) 1993-1998 Lucent Technologies, Inc. +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: $Id$ +'\" +.so man.macros +.TH Itcl_InitStack 3 3.0 itcl "[incr\ Tcl] Library Procedures" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +Itcl_InitStack, Itcl_DeleteStack, Itcl_PushStack, Itcl_PopStack, Itcl_PeekStack, Itcl_GetStackValue, Itcl_GetStackSize \- Manipulate an Itcl stack object. +.SH SYNOPSIS +.nf +\fB#include <itcl.h>\fR +.sp +int +\fBItcl_InitStack\fR(\fIstack\fR) +.sp +int +\fBItcl_DeleteStack\fR(\fIstack\fR) +.sp +int +\fBItcl_PushStack\fR(\fIcdata, stack\fR) +.sp +ClientData +\fBItcl_PopStack\fR(\fIstack\fR) +.sp +ClientData +\fBItcl_PeekStack\fR(\fIstack\fR) +.sp +ClientData +\fBItcl_GetStackValue\fR(\fIstack, pos\fR) +.sp +int +\fBItcl_GetStackSize\fR(\fIstack\fR) +.SH ARGUMENTS +.AP Itcl_Stack *stack in +Stack info structure. +.AP int pos in +position in stack order from the top. +.AP ClientData clientData in +Arbitrary one-word value to save in the stack. +.BE + +.SH DESCRIPTION +.PP +\fBItcl_InitStack\fR initializes a stack structure and \fBItcl_DeleteStack\fR +deletes it. \fBItcl_PushStack\fR pushes the \fIcdata\fR value onto the stack. +\fBItcl_PopStack\fR removes and returns the top most \fIcdata\fR value. +\fBItcl_PeekStack\fR returns the top most value, but does not remove it. +\fBItcl_GetStackValue\fR gets a value at some index within the stack. Index +"0" is the first value pushed onto the stack. \fBItcl_GetStackSize\fR +returns the count of entries on the stack. + +.SH KEYWORDS +stack + |