[Swift-commit] r8044 - www/Swift-T
wozniak at ci.uchicago.edu
wozniak at ci.uchicago.edu
Fri Jul 18 16:07:47 CDT 2014
Author: wozniak
Date: 2014-07-18 16:07:47 -0500 (Fri, 18 Jul 2014)
New Revision: 8044
Added:
www/Swift-T/blob.html
Modified:
www/Swift-T/leaf.html
Log:
New blobs doc
Added: www/Swift-T/blob.html
===================================================================
--- www/Swift-T/blob.html (rev 0)
+++ www/Swift-T/blob.html 2014-07-18 21:07:47 UTC (rev 8044)
@@ -0,0 +1,1187 @@
+<!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.9" />
+<title>Blob Utilities</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;
+}
+pre {
+ white-space: pre-wrap;
+}
+
+#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; vertical-align: text-bottom; }
+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;
+}
+
+ at 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;
+}
+
+ at 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(2);
+/*]]>*/
+</script>
+</head>
+<body class="article">
+<div id="header">
+<h1>Blob Utilities</h1>
+<div id="toc">
+ <div id="toctitle">Table of Contents</div>
+ <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>
+</div>
+<div id="content">
+<div id="preamble">
+<div class="sectionbody">
+<div class="paragraph"><p>The blob utilities are intended to allow users to convert Swift
+blobs into C pointer and length arguments for C leaf functions.</p></div>
+<div class="paragraph"><p>The blob utilities are SWIG-wrapped C functions, thus accessible
+from Tcl functions called by Swift.</p></div>
+<div class="paragraph"><p>For usage examples, see the <a href="leaf.html">Swift/T Leaf Function Guide</a>.</p></div>
+<div class="paragraph"><p>The blob utilities may also be used by user C leaf functions.
+Simply include <code>turbine/include/blob.h</code>.</p></div>
+<div class="paragraph"><p>This documentation is generated from <code>blob.h</code> by <code>maint/doc.sh</code>.
+The functions are implemented in <code>blob.c</code>.</p></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_struct_code_turbine_blob_code">Struct <code>turbine_blob</code></h2>
+<div class="sectionbody">
+<div class="paragraph"><p>Simple struct for variable-length data blob.</p></div>
+<div class="paragraph"><p>This data type is represented by SWIG in Tcl as a regular pointer-
+you can pass it in and out of functions, display it, etc.</p></div>
+<div class="paragraph"><p>Based on this struct, SWIG will generate the following
+Tcl functions, assuming <code>blob</code> is a <code>blob*</code>:</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>new_turbine_blob</code>
+</dt>
+<dd>
+<p>
+Returns a fresh <code>turbine_blob*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>delete_turbine_blob blob</code>
+</dt>
+<dd>
+<p>
+<code>free()</code> the <code>blob</code>. Cf. <code>blobutils_destroy()</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>turbine_blob_pointer_set blob p</code>
+</dt>
+<dd>
+<p>
+Set <code>blob→pointer=p</code>, where <code>p</code> is a <code>void*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>turbine_blob_pointer_get blob</code>
+</dt>
+<dd>
+<p>
+Returns <code>blob→pointer</code>, a <code>void*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>turbine_blob_length_set blob i</code>
+</dt>
+<dd>
+<p>
+Set <code>blob→pointer=i</code>, where <code>i</code> is an integer.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>turbine_blob_length_get blob</code>
+</dt>
+<dd>
+<p>
+Returns <code>blob→length</code>, an <code>int</code>.
+</p>
+</dd>
+</dl></div>
+<div class="listingblock">
+<div class="content">
+<pre><code>typedef struct
+{
+ void* pointer;
+ int length;
+} turbine_blob;</code></pre>
+</div></div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="_functions">Functions</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="_pointers_and_sizes">Pointers and sizes</h3>
+<div class="paragraph"><p>Functions for blob creation, memory allocation/deallocation,
+pointer arithmetic, and <code>sizeof()</code>.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>blobutils_create pointer length</code>
+</dt>
+<dd>
+<p>
+Create a turbine_blob from
+ an long integer representing the pointer and the length.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_create_ptr pointer length</code>
+</dt>
+<dd>
+<p>
+Create a turbine_blob from
+ the pointer and the length.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_malloc length</code>
+</dt>
+<dd>
+<p>
+Allocate memory (not a blob) of given size.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_free pointer</code>
+</dt>
+<dd>
+<p>
+Call <code>free()</code> on the given pointer.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_destroy</code>
+</dt>
+<dd>
+<p>
+Deallocate a blob <em>and</em> frees the data pointer.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_ptr_add pointer offset</code>
+</dt>
+<dd>
+<p>
+Return the result of
+ adding offset to pointer.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_sizeof_ptr</code>
+</dt>
+<dd>
+<p>
+Obtain <code>sizeof(void*)</code>
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_sizeof_int</code>
+</dt>
+<dd>
+<p>
+Obtain <code>sizeof(int)</code>
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_sizeof_int32</code>
+</dt>
+<dd>
+<p>
+Obtain <code>sizeof(int32)</code>
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_sizeof_float</code>
+</dt>
+<dd>
+<p>
+Obtain <code>sizeof(double)</code>.
+ (In Swift/T, all floats are 64-bit)
+</p>
+</dd>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_casts">Casts</h3>
+<div class="paragraph"><p>Cast functions for simple SWIG type transformations.
+Not all possible type pairs are yet implemented.
+In our naming scheme, if a type is not given, <code>void*</code> is assumed.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>blobutils_cast_to_ptr i</code>
+</dt>
+<dd>
+<p>
+Integer to <code>void*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_int64_to_ptr i</code>
+</dt>
+<dd>
+<p>
+Integer (64-bit) to <code>void*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_ptrptr p</code>
+</dt>
+<dd>
+<p>
+Integer to <code>void**</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_char_ptrptr p</code>
+</dt>
+<dd>
+<p>
+Integer to <code>char**</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_ptrptr s</code>
+</dt>
+<dd>
+<p>
+<code>char*</code> to <code>void*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_int p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>int</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_long p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>long</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_long_long p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>long long</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_int64 p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>int64_t</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_int_to_int_ptr i</code>
+</dt>
+<dd>
+<p>
+<code>int</code> to <code>int*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_int_to_const_int_ptr i</code>
+</dt>
+<dd>
+<p>
+<code>int</code> to <code>const int*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_int_to_dbl_ptr i</code>
+</dt>
+<dd>
+<p>
+<code>int</code> to <code>double*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_int_to_const_dbl_ptr i</code>
+</dt>
+<dd>
+<p>
+<code>int</code> to <code>const double*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_int_ptr p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>int*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_int64_ptr p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>int64_t*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_int32_ptr p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>int32_t*</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_cast_to_dbl_ptr p</code>
+</dt>
+<dd>
+<p>
+<code>void*</code> to <code>double*</code>.
+</p>
+</dd>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_array_manipulation">Array manipulation</h3>
+<div class="paragraph"><p>These functions treat their inputs as arrays and do manipulation.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>blobutils_zeroes_float p n</code>
+</dt>
+<dd>
+<p>
+Set all <code>n</code> entries of <code>double</code> array <code>p</code> to 0.0.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_get_ptr pointer index</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>void*</code> - do array lookup.
+ That is, return <code>pointer[index]</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_set_ptr pointer index p</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>void*</code> - do array store.
+ That is, set <code>pointer[index]=p</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_get_float pointer index</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of double- do array lookup.
+ That is, return <code>pointer[index]</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_set_float p index d</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>double</code> - do array store.
+ That is, set <code>p[index]=d</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_get_int pointer index</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>int</code> - do array lookup.
+ That is, return <code>pointer[index]</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_get_int32 pointer index</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>int32_t</code> - do array lookup.
+ That is, return <code>pointer[index]</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_set_int pointer index i</code>
+</dt>
+<dd>
+<p>
+Assume blob is array of <code>int</code> - do array store.
+ That is, set <code>pointer[index]=i</code>.
+</p>
+</dd>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_i_o">I/O</h3>
+<div class="paragraph"><p>Blob I/O functions.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>blobutils_write output blob</code>
+</dt>
+<dd>
+<p>
+Write blob <code>blob</code> to file with name given in <code>output</code>.
+ Returns <code>true</code> on success, else <code>false</code>.
+</p>
+</dd>
+<dt class="hdlist1">
+<code>blobutils_read input blob</code>
+</dt>
+<dd>
+<p>
+Read blob <code>blob</code> from file with name given in <code>output</code>.
+ Returns <code>true</code> on success, else <code>false</code>.
+</p>
+</dd>
+</dl></div>
+</div>
+<div class="sect2">
+<h3 id="_string_utilities">String utilities</h3>
+<div class="paragraph"><p>Functions for string operations.</p></div>
+<div class="dlist"><dl>
+<dt class="hdlist1">
+<code>blobutils_strdup s</code>
+</dt>
+<dd>
+<p>
+Duplicate s.
+</p>
+</dd>
+</dl></div>
+</div>
+</div>
+</div>
+</div>
+<div id="footnotes"><hr /></div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2014-07-18 16:05:25 CDT
+</div>
+</div>
+</body>
+</html>
Modified: www/Swift-T/leaf.html
===================================================================
--- www/Swift-T/leaf.html 2014-07-18 21:04:16 UTC (rev 8043)
+++ www/Swift-T/leaf.html 2014-07-18 21:07:47 UTC (rev 8044)
@@ -1276,10 +1276,8 @@
}</code></pre>
</div></div>
<div class="paragraph"><p>Thus, Swift calls the Tcl wrapper, which calls the C function.
-Additional documentation for writing Tcl wrappers that use the Turbine API
-may be found in the <a href="internals.html">Turbine Internals Guide</a>;
-the <code>blobutils</code> tools are described in the
-<a href="internals.html#_blob_manipulation">blobs section</a>.</p></div>
+Additional information about blobs is found in the
+<a href="blob.html">Blob Utilities Guide</a>.</p></div>
<div class="paragraph"><p>Note that we return blob containing a pointer to freshly allocated
memory to Swift. The system will release this memory.</p></div>
</div>
@@ -1868,7 +1866,7 @@
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2014-07-18 16:03:30 CDT
+Last updated 2014-07-18 16:07:23 CDT
</div>
</div>
</body>
More information about the Swift-commit
mailing list