mirror of
https://github.com/troydhanson/tpl.git
synced 2024-12-26 07:31:09 +08:00
1104 lines
28 KiB
HTML
1104 lines
28 KiB
HTML
<!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>tpl Perl API</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; 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;
|
|
}
|
|
|
|
@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; }
|
|
}
|
|
|
|
|
|
@media screen {
|
|
body {
|
|
max-width: 50em; /* approximately 80 characters wide */
|
|
margin-left: 16em;
|
|
}
|
|
|
|
#toc {
|
|
position: fixed;
|
|
top: 0;
|
|
left: 0;
|
|
bottom: 0;
|
|
width: 13em;
|
|
padding: 0.5em;
|
|
padding-bottom: 1.5em;
|
|
margin: 0;
|
|
overflow: auto;
|
|
border-right: 3px solid #f8f8f8;
|
|
background-color: white;
|
|
}
|
|
|
|
#toc .toclevel1 {
|
|
margin-top: 0.5em;
|
|
}
|
|
|
|
#toc .toclevel2 {
|
|
margin-top: 0.25em;
|
|
display: list-item;
|
|
color: #aaaaaa;
|
|
}
|
|
|
|
#toctitle {
|
|
margin-top: 0.5em;
|
|
}
|
|
}
|
|
</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>tpl Perl API</h1>
|
|
<span id="author">Troy D. Hanson</span><br />
|
|
<span id="email"><code><<a href="mailto:tdh@tkhanson.net">tdh@tkhanson.net</a>></code></span><br />
|
|
<span id="revnumber">version 1.1,</span>
|
|
<span id="revdate">April 2007</span>
|
|
<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 class="sect1">
|
|
<h2 id="_perl_api">Perl API</h2>
|
|
<div class="sectionbody">
|
|
<div class="paragraph"><p>The Perl API for reading and writing tpl is nearly identical to the C API. This
|
|
document will briefly explain the Perl API and provide examples. The chief
|
|
motivation for having a Perl API is to communicate with C programs that use tpl.</p></div>
|
|
<div class="admonitionblock">
|
|
<table><tr>
|
|
<td class="icon">
|
|
<div class="title">Tip</div>
|
|
</td>
|
|
<td class="content">
|
|
<div class="title">Start with the C API</div>This document assumes familiarity with the C API. The concepts of using tpl
|
|
are not explained here. For an introduction to tpl and its C API, see the
|
|
<a href="userguide.html">User Guide</a>.</td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_pm">Tpl.pm</h3>
|
|
<div class="paragraph"><p>The <code>Tpl.pm</code> file (in the <code>lang/perl</code>) directory contains the Perl module. You
|
|
can copy it to another directory if you wish. Your Perl program may need to
|
|
include a <code>use lib</code> statement to find the module.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>#!/usr/bin/perl
|
|
use lib "/some/directory";
|
|
use Tpl;</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_map">tpl_map</h3>
|
|
<div class="paragraph"><p>This function resembles the C version, except that it’s invoked via the <code>Tpl</code>
|
|
module, and it takes references to Perl variables after the format string.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>my $i;
|
|
my $tpl = Tpl->tpl_map("A(i)",\$i);</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>The return value is a tpl object; all other API calls are object methods.
|
|
Incidentally, there is no <code>tpl_free()</code> method corresponding to the C API.</p></div>
|
|
<div class="sect3">
|
|
<h4 id="_fixed_length_arrays">Fixed-length arrays</h4>
|
|
<div class="paragraph"><p>Format strings such as <code>i#</code> denote a fixed-length array. In the Perl API,
|
|
fixed-length arrays require two arguments: a list reference, and the fixed
|
|
length. For example:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>my @x;
|
|
my $tpl = Tpl->tpl_map("i#", \@x, 10);</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>When fixed-length arrays are packed or unpacked, the specified number of
|
|
elements will be copied from (or placed into) the designated list.</p></div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_structures">Structures</h4>
|
|
<div class="paragraph"><p>Format strings containing <code>S(...)</code> are handled in the Perl API as if only the
|
|
interior, parenthesized part was present. (It does not work like the C API). So
|
|
simply ignore the <code>S(...)</code> and consider only its interior format characters when
|
|
constructing the argument list:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>my ($str, $int);
|
|
my $tpl = Tpl->tpl_map("S(si)", \$str, \$int);</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>It really only makes sense to use <code>S(...)</code> in a format string in the Perl API if
|
|
you are communicating with a C program that uses structures.</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_pack">tpl_pack</h3>
|
|
<div class="paragraph"><p>This is nearly identical to the C version. The only argument is the index
|
|
number to pack.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>$tpl->tpl_pack(1);</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_dump">tpl_dump</h3>
|
|
<div class="paragraph"><p>This method is a little different than the C version. Given no arguments, it
|
|
returns the tpl image; given one argument it writes a file with that name.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>$tpl->tpl_dump("demo.tpl"); # writes demo.tpl</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Or,</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>my $img = $tpl->tpl_dump();</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>The tpl image is a binary buffer. You can do whatever you want with it, such as
|
|
write it to a socket or pipe (probably to C program listening on the other end),
|
|
or save it somewhere and later re-load it using <code>tpl_load()</code>.</p></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_load">tpl_load</h3>
|
|
<div class="paragraph"><p>This method loads a tpl image from a file or from a Perl variable. It takes
|
|
one argument. If it’s not a reference, it’s assumed to be a filename to load.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>$tpl->tpl_load("demo.tpl");</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Otherwise, if the argument is a Perl reference, it’s construed as a variable
|
|
containing the tpl image:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>$tpl->tpl_load(\$img);</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>The method will <code>die</code> if the image is invalid or the file doesn’t exist. You
|
|
can wrap it with <code>eval</code> to catch such errors:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>eval { $tpl->tpl_load(\$img); };
|
|
print "failed to load\n" if $@;</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_tpl_unpack">tpl_unpack</h3>
|
|
<div class="paragraph"><p>This is nearly identical to the C version. The only argument is the index
|
|
number to unpack.</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>$tpl->tpl_unpack(1);</code></pre>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sect1">
|
|
<h2 id="_examples">Examples</h2>
|
|
<div class="sectionbody">
|
|
<div class="sect2">
|
|
<h3 id="_integer_array">Integer array</h3>
|
|
<div class="listingblock">
|
|
<div class="title">Packing A(i) to file</div>
|
|
<div class="content">
|
|
<pre><code>#!/usr/bin/perl
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use Tpl;
|
|
|
|
my $i;
|
|
my $tpl = Tpl->tpl_map("A(i)",\$i);
|
|
for($i=0; $i<10; $i++) {
|
|
$tpl->tpl_pack(1);
|
|
}
|
|
$tpl->tpl_dump("demo.tpl");</code></pre>
|
|
</div></div>
|
|
<div class="listingblock">
|
|
<div class="title">Unpacking A(i) from file</div>
|
|
<div class="content">
|
|
<pre><code>#!/usr/bin/perl
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use Tpl;
|
|
|
|
my $j;
|
|
my $tpl2 = Tpl->tpl_map("A(i)",\$j);
|
|
$tpl2->tpl_load("demo.tpl");
|
|
while($tpl2->tpl_unpack(1) > 0) {
|
|
print "$j\n";
|
|
}</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect2">
|
|
<h3 id="_message_passing">Message-passing</h3>
|
|
<div class="paragraph"><p>While the bulk of this example is socket handling, it demonstrates how you can
|
|
use tpl as a message-passing format. In the real-world, you might have a C
|
|
server and a Perl client, for example. In this example, we’ll code both a client
|
|
and a server in Perl.</p></div>
|
|
<div class="sidebarblock">
|
|
<div class="content">
|
|
<div class="title">A server that sums integers</div>
|
|
<div class="paragraph"><p>Programming literature is rife with contrived examples so we will follow in that
|
|
tradition. Our server will do no more than sum a list of integers. But in doing
|
|
so it will demonstrate message passing adequately. Both its input (the integer
|
|
array) and its output (an integer) are tpl images, passed over a TCP/IP socket.</p></div>
|
|
</div></div>
|
|
<div class="sect3">
|
|
<h4 id="_server">Server</h4>
|
|
<div class="paragraph"><p>The server waits for a connection from a client. When it gets one, it accepts
|
|
the connection and immediately forks a child process to handle it. Then it goes
|
|
back to waiting for another new connection.</p></div>
|
|
<div class="paragraph"><p>The server child process handles the client by loading and unpacking the tpl
|
|
image sent by the client (containing an array of integers). It calculates their
|
|
sum and constructs a new tpl image containing the sum, which it sends back to
|
|
the client.</p></div>
|
|
<div class="listingblock">
|
|
<div class="title">Server</div>
|
|
<div class="content">
|
|
<pre><code>#!/usr/bin/perl
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use IO::Socket::INET;
|
|
use Tpl;
|
|
|
|
$SIG{CHLD} = "IGNORE"; # don't create zombies
|
|
|
|
our $port = 2000;
|
|
|
|
sub handle_client {
|
|
my $client = shift;
|
|
|
|
undef $/;
|
|
my $request = <$client>; # get request (slurp)
|
|
|
|
# read input array, and calculate total
|
|
my ($i,$total);
|
|
my $tpl = Tpl->tpl_map("A(i)", \$i);
|
|
eval { $tpl->tpl_load(\$request); };
|
|
die "received invalid tpl" if $@;
|
|
$total += $i while $tpl->tpl_unpack(1) > 0;
|
|
|
|
# formulate response and send
|
|
my $tpl2 = Tpl->tpl_map("i", \$total);
|
|
$tpl2->tpl_pack(0);
|
|
my $response = $tpl2->tpl_dump();
|
|
print $client $response;
|
|
close $client;
|
|
}
|
|
|
|
my $server = IO::Socket::INET->new(LocalPort => $port,
|
|
Type => SOCK_STREAM,
|
|
Reuse => 1,
|
|
Listen => 10 )
|
|
or die "Can't listen on port $port: $!\n";
|
|
|
|
while (1) {
|
|
my $client = $server->accept();
|
|
next unless $client;
|
|
# new connection
|
|
my $pid = fork;
|
|
die "can't fork: $!\n" unless defined $pid;
|
|
if ($pid > 0) {
|
|
# parent
|
|
close $client;
|
|
} elsif ($pid == 0) {
|
|
# child
|
|
handle_client($client);
|
|
exit(0);
|
|
}
|
|
}
|
|
close ($server);</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_client">Client</h4>
|
|
<div class="paragraph"><p>The client is a simpler program. It constructs the tpl image containing the
|
|
integer array (taken from its command-line arguments), connects to the server
|
|
and sends the tpl image to it, and then awaits the response tpl. The response
|
|
containing the sum is loaded, unpacked and printed.</p></div>
|
|
<div class="listingblock">
|
|
<div class="title">Client</div>
|
|
<div class="content">
|
|
<pre><code>#!/usr/bin/perl
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
use IO::Socket::INET;
|
|
use Tpl;
|
|
|
|
our $port = 2000;
|
|
|
|
# construct tpl
|
|
my $i;
|
|
my $tpl = Tpl->tpl_map("A(i)",\$i);
|
|
$tpl->tpl_pack(1) while ($i=shift @ARGV);
|
|
my $request = $tpl->tpl_dump();
|
|
|
|
# send to server, get response
|
|
my $socket = IO::Socket::INET->new("localhost:$port") or die "can't connect";
|
|
print $socket $request;
|
|
shutdown($socket,1); # done writing (half-close)
|
|
undef $/;
|
|
my $response = <$socket>; # get reply (slurp)
|
|
|
|
# decode response (or print error)
|
|
my $total;
|
|
my $tpl2 = Tpl->tpl_map("i", \$total);
|
|
eval { $tpl2->tpl_load(\$response); };
|
|
die "invalid response\n" if $@;
|
|
$tpl2->tpl_unpack(0);
|
|
print "total is $total\n";</code></pre>
|
|
</div></div>
|
|
</div>
|
|
<div class="sect3">
|
|
<h4 id="_running_thise_example">Running thise example</h4>
|
|
<div class="paragraph"><p>If the client and server programs are in <code>client.pl</code> and <code>server.pl</code>, then
|
|
you can run the example by starting the server in one window:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>./server.pl</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>Then run the client in another window. E.g.,</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>./client.pl 1 2 3 4 5</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>The client runs and then exits, printing:</p></div>
|
|
<div class="literalblock">
|
|
<div class="content">
|
|
<pre><code>total is 15</code></pre>
|
|
</div></div>
|
|
<div class="paragraph"><p>You can re-run the client with different arguments. When done, type <code>Ctrl-C</code> in
|
|
the server window to terminate it.</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Version 1.1<br />
|
|
Last updated 2013-03-12 17:20:17 EDT
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|