diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/queue.n | 62 | ||||
| -rw-r--r-- | doc/stack.n | 62 | ||||
| -rw-r--r-- | doc/tree.n | 73 |
3 files changed, 197 insertions, 0 deletions
diff --git a/doc/queue.n b/doc/queue.n new file mode 100644 index 0000000..7becec7 --- /dev/null +++ b/doc/queue.n @@ -0,0 +1,62 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: queue.n,v 1.1 2000/02/05 03:20:20 ericm Exp $ +'\" +.so man.macros +.TH queue n 8.3 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +::struct::queue \- Create and manipulate queue objects +.SH SYNOPSIS +\fBpackage require struct ?1.0?\fR +.sp +\fB::struct::queue\fR \fIqueueName\fR +.sp +.BE +.SH DESCRIPTION +.PP +The \fB::struct::queue\fR command creates a new queue object with an +associated global Tcl command whose name is \fIqueueName\fR. This command +may be used to invoke various operations on the queue. It has the +following general form: +.CS +\fIqueueName option \fR?\fIarg arg ...\fR? +.CE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for queue objects: +.TP +\fIqueueName \fBclear\fR +Remove all items from the queue. +.TP +\fIqueueName \fBdestroy\fR +Destroy the queue, including its storage space and associated command. +.TP +\fIqueueName \fBget\fR ?\fIcount\fR? +Return the front \fIcount\fR items of the queue and remove them +from the queue. If \fIcount\fR is not specified, it defaults to 1. +If \fIcount\fR is 1, the result is a simple string; otherwise, it is a list. +If specified, \fIcount\fR must be greater than or equal to 1. If +there are no items in the queue, this command will return \fIcount\fR +empty strings. +.TP +\fIqueueName \fBpeek\fR ?\fIcount\fR? +Return the front \fIcount\fR items of the queue, without removing them +from the queue. If \fIcount\fR is not specified, it defaults to 1. +If \fIcount\fR is 1, the result is a simple string; otherwise, it is a list. +If specified, \fIcount\fR must be greater than or equal to 1. If +there are no items in the queue, this command will return \fIcount\fR +empty strings. +.TP +\fIqueueName \fBput\fR \fIitem\fR ?\fIitem ...\fR? +Put the item or items specified into the queue. If more than one +item is given, they will be added in the order they are listed. +.TP +\fIqueueName \fBsize\fR +Return the number of items in the queue. + +.SH KEYWORDS +stack, queue diff --git a/doc/stack.n b/doc/stack.n new file mode 100644 index 0000000..4c07e0b --- /dev/null +++ b/doc/stack.n @@ -0,0 +1,62 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: stack.n,v 1.1 2000/02/05 03:20:20 ericm Exp $ +'\" +.so man.macros +.TH stack n 8.3 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +::struct::stack \- Create and manipulate stack objects +.SH SYNOPSIS +\fBpackage require struct ?1.0?\fR +.sp +\fB::struct::stack\fR \fIstackName\fR +.sp +.BE +.SH DESCRIPTION +.PP +The \fB::struct::stack\fR command creates a new stack object with an +associated global Tcl command whose name is \fIstackName\fR. This command +may be used to invoke various operations on the stack. It has the +following general form: +.CS +\fIstackName option \fR?\fIarg arg ...\fR? +.CE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for stack objects: +.TP +\fIstackName \fBclear\fR +Remove all items from the stack. +.TP +\fIstackName \fBdestroy\fR +Destroy the stack, including its storage space and associated command. +.TP +\fIstackName \fBpeek\fR ?\fIcount\fR? +Return the top \fIcount\fR items of the stack, without removing them +from the stack. If \fIcount\fR is not specified, it defaults to 1. +If \fIcount\fR is 1, the result is a simple string; otherwise, it is a list. +If specified, \fIcount\fR must be greater than or equal to 1. If +there are no items on the stack, this command will return \fIcount\fR +empty strings. +.TP +\fIstackName \fBpop\fR ?\fIcount\fR? +Return the top \fIcount\fR items of the stack and remove them +from the stack. If \fIcount\fR is not specified, it defaults to 1. +If \fIcount\fR is 1, the result is a simple string; otherwise, it is a list. +If specified, \fIcount\fR must be greater than or equal to 1. If +there are no items on the stack, this command will return \fIcount\fR +empty strings. +.TP +\fIstackName \fBpush\fR \fIitem\fR ?\fIitem ...\fR? +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. +.TP +\fIstackName \fBsize\fR +Return the number of items on the stack. + +.SH KEYWORDS +stack, queue diff --git a/doc/tree.n b/doc/tree.n new file mode 100644 index 0000000..ff554df --- /dev/null +++ b/doc/tree.n @@ -0,0 +1,73 @@ +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: tree.n,v 1.1 2000/02/05 03:20:20 ericm Exp $ +'\" +.so man.macros +.TH tree n 8.3 Tcl "Tcl Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +::struct::tree \- Create and manipulate tree objects +.SH SYNOPSIS +\fBpackage require struct ?1.0?\fR +.sp +\fB::struct::tree\fR \fItreeName\fR +.sp +.BE +.SH DESCRIPTION +.PP +The \fB::struct::tree\fR command creates a new tree object with an +associated global Tcl command whose name is \fItreeName\fR. This command +may be used to invoke various operations on the tree. It has the +following general form: +.CS +\fItreeName option \fR?\fIarg arg ...\fR? +.CE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for tree objects: +.TP +\fItreeName \fBclear\fR +Remove all nodes from the tree. +.TP +\fItreeName \fBdestroy\fR +Destroy the tree, including its storage space and associated command. +.TP +\fItreeName \fBinsert\fR \fIindex\fR \fIparent\fR \fIchild\fR ?-value \fIvalue\fR? +Insert a node named \fIchild\fR into the tree as a child of the node +\fIparent\fR. If \fIparent\fR is \fBroot\fR, it refers to the root of +the tree. The new node will have the value given by \fIvalue\fR. The +new node will be added to the \fIparent\fR node's childlist at the +index given by \fIindex\fR. +.TP +\fItreeName\fR \fBchildren\fR \fInode\fR +Return a list of the children of \fInode\fR. +.TP +\fItreeName\fR \fBparent\fR \fInode\fR +Return the parent of \fInode\fR. +.TP +\fItreeName\fR \fBnodeconfigure\fR \fInode\fR -value \fIvalue\fR +Set the associated value of a particular node. +.TP +\fItreeName\fR \fBnodecget\fR \fInode\fR -value +Return the associated value of a particular node. +.TP +\fItreeName\fR \fBdelete\fR \fInode\fR ?\fInode\fR ...? +Remove the specified nodes from the tree. All of the nodes' children +will be removed as well to prevent orphaned nodes. An entire tree +could be removed in this fashion with the command: +.CS +\fItreeName\fR \fBdelete\fR [\fItreeName\fR \fBchildren\fR root] +.CE +.TP +\fItreeName\fR \fBmove\fR \fInode\fR \fIparent\fR \fIindex\fR +Make \fInode\fR a child of \fIparent\fR, inserting it +into the parent's child list at the index given by \fIindex\fR. +.TP +\fItreeName\fR \fBexists\fR \fInode\fR +Remove true if the specified node exists in the tree. + +.SH KEYWORDS +tree |