util/src/TclTk/tcl8.6.12/pkgs/itcl4.2.2/doc/Stack.3

   1 '\"
   2 '\" Copyright (c) 1993-1998  Lucent Technologies, Inc.
   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 .TH Itcl_InitStack 3 3.0 itcl "[incr\ Tcl] Library Procedures"
   8 .so man.macros
   9 .BS
  10 '\" Note:  do not modify the .SH NAME line immediately below!
  11 .SH NAME
  12 Itcl_InitStack, Itcl_DeleteStack, Itcl_PushStack, Itcl_PopStack, Itcl_PeekStack, Itcl_GetStackValue, Itcl_GetStackSize \- Manipulate an Itcl stack object.
  13 .SH SYNOPSIS
  14 .nf
  15 \fB#include <itcl.h>\fR
  16
  17 int
  18 \fBItcl_InitStack\fR(\fIstack\fR)
  19
  20 int
  21 \fBItcl_DeleteStack\fR(\fIstack\fR)
  22
  23 int
  24 \fBItcl_PushStack\fR(\fIcdata, stack\fR)
  25
  26 ClientData
  27 \fBItcl_PopStack\fR(\fIstack\fR)
  28
  29 ClientData
  30 \fBItcl_PeekStack\fR(\fIstack\fR)
  31
  32 ClientData
  33 \fBItcl_GetStackValue\fR(\fIstack, pos\fR)
  34
  35 int
  36 \fBItcl_GetStackSize\fR(\fIstack\fR)
  37 .fi
  38 .SH ARGUMENTS
  39 .AP Itcl_Stack *stack in
  40 Stack info structure.
  41 .AP int pos in
  42 position in stack order from the top.
  43 .AP ClientData clientData in
  44 Arbitrary one-word value to save in the stack.
  45 .BE
  46
  47 .SH DESCRIPTION
  48 .PP
  49 \fBItcl_InitStack\fR initializes a stack structure and \fBItcl_DeleteStack\fR
  50 deletes it. \fBItcl_PushStack\fR pushes the \fIcdata\fR value onto the stack.
  51 \fBItcl_PopStack\fR removes and returns the top most \fIcdata\fR value.
  52 \fBItcl_PeekStack\fR returns the top most value, but does not remove it.
  53 \fBItcl_GetStackValue\fR gets a value at some index within the stack.  Index
  54 "0" is the first value pushed onto the stack. \fBItcl_GetStackSize\fR
  55 returns the count of entries on the stack.
  56
  57 .SH KEYWORDS
  58 stack
  59