<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.8" />
<title>Listing of doc/example-scripts/container.tcl</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Listing of doc/example-scripts/container.tcl</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>This example is a small design study to implement container classes
with different features, namely a <code>SimpleContainer</code>, an
<code>OrderedContainer</code> and a <code>SortedContainer</code>. First of all, we require NX:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>package</span> req nx
nx::test <span class='nx-keyword'>configure</span> -count 1</pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_simple_container">Simple Container</h2>
<div class="sectionbody">
<div class="paragraph"><p>The first container class presented here is called
<code>SimpleContainer</code>, which manages its contained items. As all
container classes presented here, the items are created as child
objects embedded in the container. If the container is deleted, all
items are deleted as well. The items, which will be put into the
container, should be instances of a certain class. We define here
for this purpose an arbitrary class <code>C</code>:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>nx::Class</span> <span class='nx-keyword'>create</span> C</pre></div></div>
<div class="paragraph"><p>The class <code>SimpleContainer</code> keeps and manages items added to it.
Every instance of this class might have different item classes. We
might provide a prefix for naming the items, otherwise the default
is <code>member</code>.</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>nx::Class</span> <span class='nx-keyword'>create</span> SimpleContainer {
<span class='nx-keyword'>:property</span> {memberClass ::MyItem}
<span class='nx-keyword'>:property</span> {prefix member}
<span class='nx-comment'># Require the method "autoname" for generating nice names
</span> <span class='nx-keyword'>:require</span> <span class='nx-keyword'>method</span> autoname
<span class='nx-comment'># The method new is responsible for creating a child of the current
</span> <span class='nx-comment'># container.
</span> <span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> <span class='nx-keyword'>new</span> {args} {
<span class='nx-keyword'>set</span> item [<span class='nx-variable'>${</span><span class='nx-variable'>:memberClass}</span> <span class='nx-keyword'>create</span> [:]::[:autoname <span class='nx-variable'>${</span><span class='nx-variable'>:prefix}</span>] {*}<span class='nx-variable'>$args</span>]
<span class='nx-keyword'>return</span> <span class='nx-variable'>$item</span>
}
}</pre></div></div>
<div class="paragraph"><p>Create and instance of the class <code>SimpleContainer</code> …</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% SimpleContainer <span class='nx-keyword'>create</span> container1 -memberClass ::C
::container1</pre></div></div>
<div class="paragraph"><p>and add a few items:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container1 <span class='nx-keyword'>new</span>
::container1::member1
% container1 <span class='nx-keyword'>new</span>
::container1::member2
% container1 <span class='nx-keyword'>new</span>
::container1::member3</pre></div></div>
<div class="paragraph"><p>The elements of the container can be obtained via <code>info children</code>:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container1 <span class='nx-keyword'>info</span> children
::container1::member1 ::container1::member2 ::container1::member3</pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_ordered_container">Ordered Container</h2>
<div class="sectionbody">
<div class="paragraph"><p>In the example with <code>SimpleContainer</code>, the order of the results of
<code>info children</code> just happens to be in the order of the added items,
but in general, this order is not guaranteed, but depends on the
population of the hash tables. In the next step, we extend the
example above by preserving the order of the elements.</p></div>
<div class="paragraph"><p>The class <code>OrderedContainer</code> is similar to <code>SimpleContainer</code>, but
keeps a list of items that were added to the container. The item
list is managed in a property <code>items</code> which is defined as
<code>incremental</code> to make use of the <code>add</code> and <code>delete</code> methods provided
by the slots.</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>nx::Class</span> <span class='nx-keyword'>create</span> OrderedContainer -superclass SimpleContainer {
<span class='nx-keyword'>:property</span> -incremental {items:0..n {}}
<span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> <span class='nx-keyword'>new</span> {args} {
<span class='nx-keyword'>set</span> item [<span class='nx-variable'>${</span><span class='nx-variable'>:memberClass}</span> <span class='nx-keyword'>create</span> [:]::[:autoname <span class='nx-variable'>${</span><span class='nx-variable'>:prefix}</span>] {*}<span class='nx-variable'>$args</span>]
:items add <span class='nx-variable'>$item</span> end
<span class='nx-keyword'>return</span> <span class='nx-variable'>$item</span>
}
<span class='nx-comment'># Since we keep the list of items, we have to maintain it in case
</span> <span class='nx-comment'># items are deleted.
</span> <span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> <span class='nx-keyword'>delete</span> {item<span class='nx-keyword'>:object</span>} {
:items <span class='nx-keyword'>delete</span> <span class='nx-variable'>$item</span>
<span class='nx-variable'>$item</span> <span class='nx-keyword'>destroy</span>
}
}</pre></div></div>
<div class="paragraph"><p>Create an instance of <code>OrderedContainer</code> …</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% OrderedContainer <span class='nx-keyword'>create</span> container2 -memberClass ::C
::container2</pre></div></div>
<div class="paragraph"><p>and add a few items:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container2 <span class='nx-keyword'>new</span>
::container2::member1
% container2 <span class='nx-keyword'>new</span>
::container2::member2
% container2 <span class='nx-keyword'>new</span>
::container2::member3</pre></div></div>
<div class="paragraph"><p>The elements of the container are obtained via the method <code>items</code>.</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container2 items
::container2::member1 ::container2::member2 ::container2::member3</pre></div></div>
<div class="paragraph"><p>When we delete an item in the container …</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container2 <span class='nx-keyword'>delete</span> ::container2::member2</pre></div></div>
<div class="paragraph"><p>the item is as well removed from the <code>items</code> list.</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container2 items
::container2::member1 ::container2::member3</pre></div></div>
</div>
</div>
<div class="sect1">
<h2 id="_sorted_container">Sorted Container</h2>
<div class="sectionbody">
<div class="paragraph"><p>In the next step, we define a <code>SortedContainer</code>, that keeps
additionally a sorted list for iterating through the items without
needing to sort the items when needed. The implementation maintains
an additional sorted list. The implementation of the SortedContainer
depends on "lsearch -bisect" which requires Tcl 8.6. Therefore, if
we have no Tcl 8.6, just return here.</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>if</span> {[<span class='nx-keyword'>info</span> command yield] eq <span class='nx-string'>""</span>} <span class='nx-keyword'>return</span></pre></div></div>
<div class="paragraph"><p>For sorting, we require the item class to have a key, that can be
freely specified. We use there the property <code>name</code> of Class <code>D</code>:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'><span class='nx-keyword'>nx::Class</span> <span class='nx-keyword'>create</span> D {
<span class='nx-keyword'>:property</span> name:required
}
<span class='nx-keyword'>nx::Class</span> <span class='nx-keyword'>create</span> SortedContainer -superclass OrderedContainer {
<span class='nx-comment'># In order to keep the index consisting of just the objects and to
</span> <span class='nx-comment'># ease sorting, we maintain two list, one list of values and one
</span> <span class='nx-comment'># list of objects. We assume for the time being, that the keys are
</span> <span class='nx-comment'># not changing.
</span>
<span class='nx-keyword'>:variable</span> values {}
<span class='nx-keyword'>:variable</span> index {}
<span class='nx-keyword'>:property</span> key
<span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> index {} { <span class='nx-keyword'>return</span> <span class='nx-variable'>${</span><span class='nx-variable'>:index}</span>}
<span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> <span class='nx-keyword'>new</span> {args} {
<span class='nx-keyword'>set</span> item [<span class='nx-variable'>${</span><span class='nx-variable'>:memberClass}</span> <span class='nx-keyword'>create</span> [:]::[:autoname <span class='nx-variable'>${</span><span class='nx-variable'>:prefix}</span>] {*}<span class='nx-variable'>$args</span>]
<span class='nx-keyword'>if</span> {[<span class='nx-keyword'>info</span> exists :key]} {
<span class='nx-keyword'>set</span> value [<span class='nx-variable'>$item</span> <span class='nx-keyword'>cget</span> -<span class='nx-variable'>${</span><span class='nx-variable'>:key}</span>]
<span class='nx-keyword'>set</span> pos [<span class='nx-keyword'>lsearch</span> -bisect <span class='nx-variable'>${</span><span class='nx-variable'>:values}</span> <span class='nx-variable'>$value</span>]
<span class='nx-keyword'>set</span> :values [<span class='nx-keyword'>linsert</span> <span class='nx-variable'>${</span><span class='nx-variable'>:values}</span> [<span class='nx-keyword'>expr</span> {<span class='nx-variable'>$pos</span> + 1}] <span class='nx-variable'>$value</span>]
<span class='nx-keyword'>set</span> :index [<span class='nx-keyword'>linsert</span> <span class='nx-variable'>${</span><span class='nx-variable'>:index}</span> [<span class='nx-keyword'>expr</span> {<span class='nx-variable'>$pos</span> + 1}] <span class='nx-variable'>$item</span>]
}
<span class='nx-keyword'>lappend</span> :items <span class='nx-variable'>$item</span>
<span class='nx-keyword'>return</span> <span class='nx-variable'>$item</span>
}
<span class='nx-comment'># Since we keep the list of items, we have to maintain it in case
</span> <span class='nx-comment'># items are deleted.
</span> <span class='nx-keyword'>:public</span> <span class='nx-keyword'>method</span> <span class='nx-keyword'>delete</span> {item<span class='nx-keyword'>:object</span>} {
<span class='nx-keyword'>set</span> pos [<span class='nx-keyword'>lsearch</span> <span class='nx-variable'>${</span><span class='nx-variable'>:index}</span> <span class='nx-variable'>$item</span>]
<span class='nx-keyword'>if</span> {<span class='nx-variable'>$pos</span> == -1} {<span class='nx-keyword'>error</span> <span class='nx-string'>"item $item not found in container; items: ${:index}"</span>}
<span class='nx-keyword'>set</span> :values [<span class='nx-keyword'>lreplace</span> <span class='nx-variable'>${</span><span class='nx-variable'>:values}</span> <span class='nx-variable'>$pos</span> <span class='nx-variable'>$pos</span>]
<span class='nx-keyword'>set</span> :index [<span class='nx-keyword'>lreplace</span> <span class='nx-variable'>${</span><span class='nx-variable'>:index}</span> <span class='nx-variable'>$pos</span> <span class='nx-variable'>$pos</span>]
<span class='nx-keyword'>next</span>
}
}</pre></div></div>
<div class="paragraph"><p>Create a container for class <code>D</code> with key <code>name</code>:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>SortedContainer <span class='nx-keyword'>create</span> container3 -memberClass ::D -key name</pre></div></div>
<div class="paragraph"><p>Add a few items</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container3 <span class='nx-keyword'>new</span> -name victor
::container3::member1
% container3 <span class='nx-keyword'>new</span> -name stefan
::container3::member2
% container3 <span class='nx-keyword'>new</span> -name gustaf
::container3::member3</pre></div></div>
<div class="paragraph"><p>The method <code>items</code> returns the items in the order of insertion (as before):</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container3 items
::container3::member1 ::container3::member2 ::container3::member3</pre></div></div>
<div class="paragraph"><p>The method <code>index</code> returns the items in sorting order (sorted by the <code>name</code> member):</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container3 index
::container3::member3 ::container3::member2 ::container3::member1</pre></div></div>
<div class="paragraph"><p>Now we delete an item:</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container3 <span class='nx-keyword'>delete</span> ::container3::member2</pre></div></div>
<div class="paragraph"><p>The item is as well removed from the result lists</p></div>
<div class="listingblock">
<div class="content"><style type='text/css'>
.nx {color: #000000; font-weight: normal; font-style: normal; padding-left: 10px}
table.nx {border-collapse: collapse; border-spacing: 3px;}
.nx-linenr {border-right: 1px solid #DDDDDD;padding-right: 5px; color: #2B547D;font-style: italic;}
.nx-string {color: #779977; font-weight: normal; font-style: italic;}
.nx-comment {color: #717ab3; font-weight: normal; font-style: italic;}
.nx-keyword {color: #7f0055; font-weight: normal; font-style: normal;}
.nx-placeholder {color: #AF663F; font-weight: normal; font-style: italic;}
.nx-variable {color: #AF663F; font-weight: normal; font-style: normal;}
</style>
<pre class='nx'>% container3 items
::container3::member1 ::container3::member3
% container3 index
::container3::member3 ::container3::member1</pre></div></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2013-06-07 00:17:05 CEST
</div>
</div>
</body>
</html>