1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<link rel="stylesheet" href="rivescript.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body>
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#JAVASCRIPT-HANDLER">JAVASCRIPT HANDLER</a></li>
<li><a href="#SEE-ALSO">SEE ALSO</a></li>
<li><a href="#AUTHOR">AUTHOR</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>RiveScript::Docs::JavaScript</p>
<h1 id="DESCRIPTION">DESCRIPTION</h1>
<p>To clean up the primary manpage for <a>RiveScript</a>, the JavaScript example was moved here.</p>
<p>With <code>$rs->setHandler()</code>, you can specify your own custom code to handle RiveScript object macros using programming languages other than Perl.</p>
<p>For example, if you're implementing a RiveScript bot that runs on the web, you might like to support JavaScript objects in your code, because your user's browser would be able to execute it.</p>
<h1 id="JAVASCRIPT-HANDLER">JAVASCRIPT HANDLER</h1>
<p>Here's an example of defining a handler for JavaScript objects:</p>
<pre><code> my $scripts = {}; # Place to store JS code.
$rs->setHandler (javascript => sub {
my ($self,$action,$name,$data) = @_;
# Loading the object.
if ($action eq "load") {
# Just store the code.
$scripts->{$name} = $data;
}
else {
# Turn the args into a JavaScript array.
my $code = "var fields = new Array();\n";
for (my $i = 0; $i < scalar @{$data}; $i++) {
$code .= "fields[$i] = \"$data->[$i]\";\n";
}
# Come up with code for the web browser.
$code .= "function rsobject (args) {\n"
. "$scripts->{$name}\n"
. "}"
. "document.writeln( rsobject(fields) );\n";
return "<script type=\"text/javascript\">\n"
. $code
. "</script>";
}
});</code></pre>
<p>So, the above example just loads the JavaScript source code into a hash reference named $scripts, and then when called it creates some JavaScript code to put the call's arguments into an array, creates a function that accepts the args, then calls this function in a <code>document.writeln</code>. Here's an example of how this would be used in the RiveScript code:</p>
<pre><code> // Define an object to encode text into rot13 to be executed by the web browser
> object rot13 javascript
var txt = args.join(" "); // Turn the args array into a string
var result = "";
for (var i = 0; i < txt.length; i++) {
var b = txt.charCodeAt(i);
// 65 = A 97 = a
// 77 = M 109 = m
// 78 = N 110 = n
// 90 = Z 122 = z
var isLetter = 0;
if (b >= 65 && b <= 77) {
isLetter = 1;
b += 13;
}
else if (b >= 97 && b <= 109) {
isLetter = 1;
b += 13;
}
else if (b >= 78 && b <= 90) {
isLetter = 1;
b -= 13;
}
else if (b >= 110 && b <= 122) {
isLetter = 1;
b -= 13;
}
if (isLetter) {
result += String.fromCharCode(b);
}
else {
result += String.fromCharCode(b);
}
}
return result;
< object
// Use the object
+ say * in rot13
- "<star>" in rot13 is: <call>rot13 <star></call>.</code></pre>
<p>Now, when the user at the web browser provokes this reply, it will get back a bunch of JavaScript code as part of the response. It might be like this:</p>
<pre><code> <b>User:</b> say hello world in rot13<br>
<b>Bot:</b> "hello world" in rot13 is: <script type="text/javascript">
var fields = new Array();
fields[0] = "hello";
fields[1] = "world";
function rsobject (args) {
var txt = args.join(" "); // Turn the args array into a string
var result = "";
for (var i = 0; i < txt.length; i++) {
var b = txt.charCodeAt(i);
// 65 = A 97 = a
// 77 = M 109 = m
// 78 = N 110 = n
// 90 = Z 122 = z
var isLetter = 0;
if (b >= 65 && b <= 77) {
isLetter = 1;
b += 13;
}
else if (b >= 97 && b <= 109) {
isLetter = 1;
b += 13;
}
else if (b >= 78 && b <= 90) {
isLetter = 1;
b -= 13;
}
else if (b >= 110 && b <= 122) {
isLetter = 1;
b -= 13;
}
if (isLetter) {
result += String.fromCharCode(b);
}
else {
result += String.fromCharCode(b);
}
}
return result;
}
document.writeln(rsobject(fields));
</script>.</code></pre>
<p>And so, the JavaScript gets executed inside the bot's response by the web browser.</p>
<p>In this case, Perl itself can't handle JavaScript code, but considering the environment the bot is running in (CGI served to a web browser), the web browser is capable of executing JavaScript. So, we set up a custom object handler so that JavaScript objects are given directly to the browser to be executed there.</p>
<h1 id="SEE-ALSO">SEE ALSO</h1>
<p><a>RiveScript</a>.</p>
<h1 id="AUTHOR">AUTHOR</h1>
<p>Noah Petherbridge</p>
</body>
</html>
|