The ::struct namespace contains a commands for processing finite stacks.
It exports a single command, ::struct::stack. All functionality provided here can be reached through a
subcommand of this command.
Note: As of version 1.3.3 of this package a critcl based C implementation is available. This
implementation however requires Tcl 8.4 to run.
The ::struct::stack command creates a new stack object with an associated global Tcl command whose name
is stackName. This command may be used to invoke various operations on the stack. It has the following
general form:
stackNameoption ?argarg...?
Option and the args determine the exact behavior of the command. The following commands are
possible for stack objects:
stackNameclear
Remove all items from the stack.
stackNamedestroy
Destroy the stack, including its storage space and associated command.
stackNameget
Returns the whole contents of the stack as a list, without removing them from the stack.
stackNamegetr
A variant of get, which returns the contents in reversed order.
stackNamepeek ?count?
Return the top count items of the stack, without removing them from the stack. If count is not
specified, it defaults to 1. If count is 1, the result is a simple string; otherwise, it is a
list. If specified, count must be greater than or equal to 1. If there are not enoughs items on
the stack to fulfull the request, this command will throw an error.
stackNamepeekr ?count?
A variant of peek, which returns the items in reversed order.
stackNametrim ?newsize?
Shrinks the stack to contain at most newsize elements and returns a list containing the elements
which were removed. Nothing is done if the stack is already at the specified size, or smaller. In
that case the result is the empty list.
stackNametrim* ?newsize?
A variant of trim which performs the shrinking, but does not return the removed elements.
stackNamepop ?count?
Return the top count items of the stack, and remove them from the stack. If count is not
specified, it defaults to 1. If count is 1, the result is a simple string; otherwise, it is a
list. If specified, count must be greater than or equal to 1. If there are not enoughs items on
the stack to fulfull the request, this command will throw an error.
stackNamepushitem ?item...?
Push the item or items specified onto the stack. If more than one item is given, they will be
pushed in the order they are listed.
stackNamesize
Return the number of items on the stack.