safubot 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.yardoc/checksums +9 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/README.md +52 -1
- data/doc/Safubot/Bot.html +1287 -652
- data/doc/Safubot/Evented.html +409 -276
- data/doc/Safubot/KnownUser.html +476 -254
- data/doc/Safubot/Log.html +184 -192
- data/doc/Safubot/Query.html +131 -164
- data/doc/Safubot/Request.html +158 -147
- data/doc/Safubot/Response.html +92 -135
- data/doc/Safubot/Test.html +166 -187
- data/doc/Safubot/Twitter/Bot.html +1005 -455
- data/doc/Safubot/Twitter/DirectMessage.html +417 -238
- data/doc/Safubot/Twitter/Tweet.html +725 -398
- data/doc/Safubot/Twitter.html +69 -116
- data/doc/Safubot/XMPP/Bot.html +625 -303
- data/doc/Safubot/XMPP/Message.html +372 -217
- data/doc/Safubot/XMPP.html +69 -116
- data/doc/Safubot.html +155 -126
- data/doc/_index.html +294 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +140 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +129 -101
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +3 -5
- data/doc/method_list.html +638 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/safubot/bot.rb +22 -20
- data/lib/safubot/known_user.rb +2 -0
- data/lib/safubot/twitter.rb +30 -26
- data/lib/safubot/version.rb +1 -1
- data/lib/safubot/xmpp.rb +20 -14
- data/safubot.gemspec +1 -0
- metadata +50 -71
- data/doc/Gemfile.html +0 -119
- data/doc/Object.html +0 -171
- data/doc/Rakefile.html +0 -117
- data/doc/created.rid +0 -14
- data/doc/foo_rb.html +0 -115
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/js/darkfish.js +0 -153
- data/doc/js/navigation.js +0 -142
- data/doc/js/search.js +0 -94
- data/doc/js/search_index.js +0 -1
- data/doc/js/searcher.js +0 -228
- data/doc/lib/safubot/bot_rb.html +0 -115
- data/doc/lib/safubot/evented_rb.html +0 -115
- data/doc/lib/safubot/known_user_rb.html +0 -115
- data/doc/lib/safubot/log_rb.html +0 -115
- data/doc/lib/safubot/safubot_rb.html +0 -115
- data/doc/lib/safubot/spec/bot_spec_rb.html +0 -115
- data/doc/lib/safubot/spec/twitter_spec_rb.html +0 -137
- data/doc/lib/safubot/test_helper_rb.html +0 -115
- data/doc/lib/safubot/twitter_rb.html +0 -115
- data/doc/lib/safubot/version_rb.html +0 -115
- data/doc/lib/safubot/xmpp_rb.html +0 -115
- data/doc/lib/safubot_rb.html +0 -115
- data/doc/rdoc.css +0 -543
- data/doc/table_of_contents.html +0 -224
data/doc/index.html
CHANGED
|
@@ -1,112 +1,140 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta content="text/html; charset=UTF-8"
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.7.3
|
|
10
|
+
|
|
11
|
+
</title>
|
|
6
12
|
|
|
7
|
-
<
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
14
|
|
|
9
|
-
<link type="text/css" media="screen"
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
16
|
|
|
11
|
-
<script type="text/javascript">
|
|
12
|
-
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
relpath = '';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
13
20
|
</script>
|
|
14
21
|
|
|
15
|
-
<script type="text/javascript" charset="utf-8" src="
|
|
16
|
-
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
|
17
|
-
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
|
18
|
-
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
|
19
|
-
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
|
20
|
-
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
<body>
|
|
24
|
-
<nav id="metadata">
|
|
25
|
-
<nav id="home-section" class="section">
|
|
26
|
-
<h3 class="section-header">
|
|
27
|
-
<a href="./index.html">Home</a>
|
|
28
|
-
<a href="./table_of_contents.html#classes">Classes</a>
|
|
29
|
-
<a href="./table_of_contents.html#methods">Methods</a>
|
|
30
|
-
</h3>
|
|
31
|
-
</nav>
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
32
23
|
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
33
25
|
|
|
34
|
-
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
-
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
-
<h3 class="section-header">
|
|
37
|
-
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
-
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
-
</h3>
|
|
40
|
-
</form>
|
|
41
26
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
<ul>
|
|
51
|
-
|
|
52
|
-
<li class="file"><a href="./Gemfile.html">Gemfile</a>
|
|
53
|
-
|
|
54
|
-
<li class="file"><a href="./Rakefile.html">Rakefile</a>
|
|
55
|
-
|
|
56
|
-
</ul>
|
|
57
|
-
</nav>
|
|
58
|
-
|
|
59
|
-
<nav id="classindex-section" class="section project-section">
|
|
60
|
-
<h3 class="section-header">Class and Module Index</h3>
|
|
61
|
-
|
|
62
|
-
<ul class="link-list">
|
|
63
|
-
|
|
64
|
-
<li><a href="./Safubot.html">Safubot</a>
|
|
65
|
-
|
|
66
|
-
<li><a href="./Safubot/Bot.html">Safubot::Bot</a>
|
|
67
|
-
|
|
68
|
-
<li><a href="./Safubot/Evented.html">Safubot::Evented</a>
|
|
69
|
-
|
|
70
|
-
<li><a href="./Safubot/KnownUser.html">Safubot::KnownUser</a>
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
71
35
|
|
|
72
|
-
<
|
|
36
|
+
<a href="_index.html" title="Index">Index</a> »
|
|
37
|
+
<span class="title">File: README</span>
|
|
73
38
|
|
|
74
|
-
<li><a href="./Safubot/Query.html">Safubot::Query</a>
|
|
75
39
|
|
|
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
|
-
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
46
|
+
|
|
47
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
48
|
+
|
|
49
|
+
<a id="file_list_link" href="#">File List</a>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
<div class="clear"></div>
|
|
53
|
+
</div>
|
|
54
|
+
|
|
55
|
+
<iframe id="search_frame"></iframe>
|
|
56
|
+
|
|
57
|
+
<div id="content"><div id='filecontents'><h1>safubot - an evented chatbot framework for Ruby</h1>
|
|
58
|
+
|
|
59
|
+
<h2><a name="overview">Overview</a></h2>
|
|
60
|
+
|
|
61
|
+
<p>Safubot is a chatbot framework for Twitter and XMPP which aims to abstract away the idiosyncracies of the underlying APIs, allowing you to focus on writing request-processing logic. Of course, if you want to use service-specific features (such as responding to timeline tweets) it lets you do that too!</p>
|
|
62
|
+
|
|
63
|
+
<h2><a name="installation">Installation</a></h2>
|
|
64
|
+
|
|
65
|
+
<pre class="code"><span class='id gem'>gem</span> <span class='id install'>install</span> <span class='id safubot'>safubot</span>
|
|
66
|
+
</pre>
|
|
67
|
+
|
|
68
|
+
<h2><a name="requirements">Requirements</a></h2>
|
|
69
|
+
|
|
70
|
+
<p>Safubot uses <a href="http://www.mongodb.org">MongoDB</a> for storage. It's <a href="http://www.mongodb.org/display/DOCS/Quickstart+Unix">easy to install</a> and pretty awesome!</p>
|
|
71
|
+
|
|
72
|
+
<h2><a name="documentation">Documentation</a></h2>
|
|
73
|
+
|
|
74
|
+
<p><a href="http://rdoc.info/gems/safubot">http://rdoc.info/gems/safubot</a></p>
|
|
75
|
+
|
|
76
|
+
<h2><a name="example">Example Usage</a></h2>
|
|
77
|
+
|
|
78
|
+
<pre class="code"><span class='id require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>safubot</span><span class='tstring_end'>'</span></span>
|
|
79
|
+
|
|
80
|
+
<span class='kw'>class</span> <span class='const'>NiftyBot</span> <span class='op'><</span> <span class='const'>Safubot</span><span class='op'>::</span><span class='const'>Bot</span>
|
|
81
|
+
<span class='kw'>def</span> <span class='id initialize'>initialize</span>
|
|
82
|
+
<span class='comment'># Check the MongoMapper docs (http://www.mongomapper.com/documentation/) if you want
|
|
83
|
+
</span> <span class='comment'># to do something more sophisticated than an authless localhost connection.
|
|
84
|
+
</span> <span class='kw'>super</span><span class='lparen'>(</span><span class='symbol'>:database</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>niftybot</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
85
|
+
|
|
86
|
+
<span class='comment'># To access the underlying delegation targets:
|
|
87
|
+
</span> <span class='comment'># Safubot::Twitter::Bot bot.twitter
|
|
88
|
+
</span> <span class='comment'># ::Twitter::Client bot.twitter.client
|
|
89
|
+
</span> <span class='comment'># ::TweetStream::Client bot.twitter.stream
|
|
90
|
+
</span> <span class='id enable_twitter'>enable_twitter</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
91
|
+
<span class='symbol'>:username</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>niftybot</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
92
|
+
<span class='symbol'>:consumer_key</span> <span class='op'>=></span> <span class='const'>CONSUMER_KEY</span><span class='comma'>,</span>
|
|
93
|
+
<span class='symbol'>:consumer_secret</span> <span class='op'>=></span> <span class='const'>CONSUMER_SECRET</span><span class='comma'>,</span>
|
|
94
|
+
<span class='symbol'>:oauth_token</span> <span class='op'>=></span> <span class='const'>OAUTH_TOKEN</span><span class='comma'>,</span>
|
|
95
|
+
<span class='symbol'>:oauth_token_secret</span> <span class='op'>=></span> <span class='const'>OAUTH_TOKEN_SECRET</span>
|
|
96
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
97
|
+
|
|
98
|
+
<span class='comment'># Similarly, for XMPP:
|
|
99
|
+
</span> <span class='comment'># Safubot::XMPP::Bot bot.xmpp
|
|
100
|
+
</span> <span class='comment'># ::Blather::Client bot.xmpp.client
|
|
101
|
+
</span> <span class='id enable_xmpp'>enable_xmpp</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
|
102
|
+
<span class='symbol'>:jid</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>niftybot@jabber.org/niftyhost</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
103
|
+
<span class='symbol'>:password</span> <span class='op'>=></span> <span class='const'>JABBER_PASSWORD</span>
|
|
104
|
+
<span class='rbrace'>}</span><span class='rparen'>)</span>
|
|
105
|
+
|
|
106
|
+
<span class='comment'># A Request can be sourced from a:
|
|
107
|
+
</span> <span class='comment'># * Twitter mention
|
|
108
|
+
</span> <span class='comment'># * Twitter DM
|
|
109
|
+
</span> <span class='comment'># * XMPP chat message
|
|
110
|
+
</span> <span class='comment'># The "respond" method will reply using the appropriate medium.
|
|
111
|
+
</span> <span class='id on'>on</span><span class='lparen'>(</span><span class='symbol'>:request</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id req'>req</span><span class='op'>|</span>
|
|
112
|
+
<span class='kw'>if</span> <span class='id req'>req</span><span class='period'>.</span><span class='id text'>text</span><span class='period'>.</span><span class='id match'>match</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>nifty</span><span class='regexp_end'>/i</span></span>
|
|
113
|
+
<span class='id respond'>respond</span> <span class='id req'>req</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Yep, I'm a nifty bot! :3</span><span class='tstring_end'>"</span></span>
|
|
114
|
+
<span class='kw'>else</span>
|
|
115
|
+
<span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>This isn't nifty at all! :(</span><span class='tstring_end'>"</span></span>
|
|
116
|
+
<span class='kw'>end</span>
|
|
117
|
+
<span class='kw'>end</span>
|
|
118
|
+
|
|
119
|
+
<span class='comment'># Any unhandled errors encountered during request processing
|
|
120
|
+
</span> <span class='comment'># will come through here.
|
|
121
|
+
</span> <span class='id on'>on</span><span class='lparen'>(</span><span class='symbol'>:request_error</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id req'>req</span><span class='comma'>,</span> <span class='id e'>e</span><span class='op'>|</span>
|
|
122
|
+
<span class='id respond'>respond</span> <span class='id req'>req</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id e'>e</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span>
|
|
123
|
+
<span class='kw'>end</span>
|
|
124
|
+
<span class='kw'>end</span>
|
|
125
|
+
<span class='kw'>end</span>
|
|
126
|
+
|
|
127
|
+
<span class='comment'># You can run this from inside another EventMachine loop if
|
|
128
|
+
</span><span class='comment'># you don't want it to block indefinitely.
|
|
129
|
+
</span><span class='const'>NiftyBot</span><span class='period'>.</span><span class='id new'>new</span><span class='period'>.</span><span class='id run'>run</span>
|
|
130
|
+
</pre>
|
|
131
|
+
</div></div>
|
|
132
|
+
|
|
133
|
+
<div id="footer">
|
|
134
|
+
Generated on Mon Nov 28 20:20:03 2011 by
|
|
135
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
136
|
+
0.7.3 (ruby-1.9.2).
|
|
137
|
+
</div>
|
|
138
|
+
|
|
139
|
+
</body>
|
|
140
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
function createSourceLinks() {
|
|
2
|
+
$('.method_details_list .source_code').
|
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
4
|
+
$('.toggleSource').toggle(function() {
|
|
5
|
+
$(this).parent().next().slideDown(100);
|
|
6
|
+
$(this).text("Hide source");
|
|
7
|
+
},
|
|
8
|
+
function() {
|
|
9
|
+
$(this).parent().next().slideUp(100);
|
|
10
|
+
$(this).text("View source");
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function createDefineLinks() {
|
|
15
|
+
var tHeight = 0;
|
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
17
|
+
$('.toggleDefines').toggle(function() {
|
|
18
|
+
tHeight = $(this).parent().prev().height();
|
|
19
|
+
$(this).prev().show();
|
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
21
|
+
$(this).text("(less)");
|
|
22
|
+
},
|
|
23
|
+
function() {
|
|
24
|
+
$(this).prev().hide();
|
|
25
|
+
$(this).parent().prev().height(tHeight);
|
|
26
|
+
$(this).text("more...");
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function createFullTreeLinks() {
|
|
31
|
+
var tHeight = 0;
|
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
|
33
|
+
tHeight = $(this).parent().prev().height();
|
|
34
|
+
$(this).parent().toggleClass('showAll');
|
|
35
|
+
$(this).text("(hide)");
|
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
37
|
+
},
|
|
38
|
+
function() {
|
|
39
|
+
$(this).parent().toggleClass('showAll');
|
|
40
|
+
$(this).parent().prev().height(tHeight);
|
|
41
|
+
$(this).text("show all");
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function fixBoxInfoHeights() {
|
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
|
47
|
+
$(this).prev().height($(this).height());
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameLinks() {
|
|
52
|
+
$('#method_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, relpath + 'method_list.html');
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
$('#class_list_link').click(function() {
|
|
57
|
+
toggleSearchFrame(this, relpath + 'class_list.html');
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
$('#file_list_link').click(function() {
|
|
61
|
+
toggleSearchFrame(this, relpath + 'file_list.html');
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function toggleSearchFrame(id, link) {
|
|
66
|
+
var frame = $('#search_frame');
|
|
67
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
68
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
|
69
|
+
frame.slideUp(100);
|
|
70
|
+
$('#search a').removeClass('active inactive');
|
|
71
|
+
}
|
|
72
|
+
else {
|
|
73
|
+
$(id).addClass('active').removeClass('inactive');
|
|
74
|
+
frame.attr('src', link).slideDown(100);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
function linkSummaries() {
|
|
79
|
+
$('.summary_signature').click(function() {
|
|
80
|
+
document.location = $(this).find('a').attr('href');
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function framesInit() {
|
|
85
|
+
if (window.top.frames.main) {
|
|
86
|
+
document.body.className = 'frames';
|
|
87
|
+
$('#menu .noframes a').attr('href', document.location);
|
|
88
|
+
$('html head title', window.parent.document).text($('html head title').text());
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
function keyboardShortcuts() {
|
|
93
|
+
if (window.top.frames.main) return;
|
|
94
|
+
$(document).keypress(function(evt) {
|
|
95
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
96
|
+
if (typeof evt.target !== "undefined" &&
|
|
97
|
+
(evt.target.nodeName == "INPUT" ||
|
|
98
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
99
|
+
switch (evt.charCode) {
|
|
100
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
101
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
102
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
103
|
+
default: break;
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function summaryToggle() {
|
|
109
|
+
$('.summary_toggle').click(function() {
|
|
110
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
111
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
112
|
+
var next = $(this).parent().parent().next();
|
|
113
|
+
if (next.hasClass('compact')) {
|
|
114
|
+
next.toggle();
|
|
115
|
+
next.next().toggle();
|
|
116
|
+
}
|
|
117
|
+
else if (next.hasClass('summary')) {
|
|
118
|
+
var list = $('<ul class="summary compact" />');
|
|
119
|
+
list.html(next.html());
|
|
120
|
+
list.find('.summary_desc, .note').remove();
|
|
121
|
+
list.find('a').each(function() {
|
|
122
|
+
$(this).html($(this).find('strong').html());
|
|
123
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
124
|
+
});
|
|
125
|
+
next.before(list);
|
|
126
|
+
next.toggle();
|
|
127
|
+
}
|
|
128
|
+
return false;
|
|
129
|
+
});
|
|
130
|
+
if (localStorage) {
|
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
|
132
|
+
else localStorage.summaryCollapsed = "expand";
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
function fixOutsideWorldLinks() {
|
|
137
|
+
$('a').each(function() {
|
|
138
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function generateTOC() {
|
|
143
|
+
if ($('#filecontents').length === 0) return;
|
|
144
|
+
var _toc = $('<ol class="top"></ol>');
|
|
145
|
+
var show = false;
|
|
146
|
+
var toc = _toc;
|
|
147
|
+
var counter = 0;
|
|
148
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
149
|
+
var i;
|
|
150
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
151
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
152
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
153
|
+
$(tags.join(', ')).each(function() {
|
|
154
|
+
if (this.id == "filecontents") return;
|
|
155
|
+
show = true;
|
|
156
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
157
|
+
if (this.id.length === 0) {
|
|
158
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
159
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
160
|
+
this.id = proposedId;
|
|
161
|
+
}
|
|
162
|
+
if (thisTag > lastTag) {
|
|
163
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
164
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
if (thisTag < lastTag) {
|
|
168
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
169
|
+
}
|
|
170
|
+
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
|
171
|
+
lastTag = thisTag;
|
|
172
|
+
});
|
|
173
|
+
if (!show) return;
|
|
174
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
|
175
|
+
$('#content').prepend(html);
|
|
176
|
+
$('#toc').append(_toc);
|
|
177
|
+
$('#toc .hide_toc').toggle(function() {
|
|
178
|
+
$('#toc .top').slideUp('fast');
|
|
179
|
+
$('#toc').toggleClass('hidden');
|
|
180
|
+
$('#toc .title small').toggle();
|
|
181
|
+
}, function() {
|
|
182
|
+
$('#toc .top').slideDown('fast');
|
|
183
|
+
$('#toc').toggleClass('hidden');
|
|
184
|
+
$('#toc .title small').toggle();
|
|
185
|
+
});
|
|
186
|
+
$('#toc .float_toc').toggle(function() {
|
|
187
|
+
$(this).text('float');
|
|
188
|
+
$('#toc').toggleClass('nofloat');
|
|
189
|
+
}, function() {
|
|
190
|
+
$(this).text('left');
|
|
191
|
+
$('#toc').toggleClass('nofloat');
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
$(framesInit);
|
|
196
|
+
$(createSourceLinks);
|
|
197
|
+
$(createDefineLinks);
|
|
198
|
+
$(createFullTreeLinks);
|
|
199
|
+
$(fixBoxInfoHeights);
|
|
200
|
+
$(searchFrameLinks);
|
|
201
|
+
$(linkSummaries);
|
|
202
|
+
$(keyboardShortcuts);
|
|
203
|
+
$(summaryToggle);
|
|
204
|
+
$(fixOutsideWorldLinks);
|
|
205
|
+
$(generateTOC);
|
data/doc/js/full_list.js
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
var inSearch = null;
|
|
2
|
+
var searchIndex = 0;
|
|
3
|
+
var searchCache = [];
|
|
4
|
+
var searchString = '';
|
|
5
|
+
var regexSearchString = '';
|
|
6
|
+
var caseSensitiveMatch = false;
|
|
7
|
+
|
|
8
|
+
RegExp.escape = function(text) {
|
|
9
|
+
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
function fullListSearch() {
|
|
13
|
+
// generate cache
|
|
14
|
+
searchCache = [];
|
|
15
|
+
$('#full_list li').each(function() {
|
|
16
|
+
var link = $(this).find('.object_link a');
|
|
17
|
+
var fullName = link.attr('title').split(' ')[0];
|
|
18
|
+
searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
$('#search input').keyup(function() {
|
|
22
|
+
searchString = this.value;
|
|
23
|
+
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
|
|
24
|
+
regexSearchString = RegExp.escape(searchString);
|
|
25
|
+
if (caseSensitiveMatch) {
|
|
26
|
+
regexSearchString += "|" +
|
|
27
|
+
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
|
|
28
|
+
join('.+?');
|
|
29
|
+
}
|
|
30
|
+
if (searchString === "") {
|
|
31
|
+
clearTimeout(inSearch);
|
|
32
|
+
inSearch = null;
|
|
33
|
+
$('ul .search_uncollapsed').removeClass('search_uncollapsed');
|
|
34
|
+
$('#full_list, #content').removeClass('insearch');
|
|
35
|
+
$('#full_list li').removeClass('found').each(function() {
|
|
36
|
+
|
|
37
|
+
var link = $(this).find('.object_link a');
|
|
38
|
+
link.text(link.text());
|
|
39
|
+
});
|
|
40
|
+
if (clicked) {
|
|
41
|
+
clicked.parents('ul').each(function() {
|
|
42
|
+
$(this).removeClass('collapsed').prev().removeClass('collapsed');
|
|
43
|
+
});
|
|
44
|
+
}
|
|
45
|
+
highlight();
|
|
46
|
+
}
|
|
47
|
+
else {
|
|
48
|
+
if (inSearch) clearTimeout(inSearch);
|
|
49
|
+
searchIndex = 0;
|
|
50
|
+
lastRowClass = '';
|
|
51
|
+
$('#full_list, #content').addClass('insearch');
|
|
52
|
+
$('#noresults').text('');
|
|
53
|
+
searchItem();
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
|
|
57
|
+
$('#search input').focus();
|
|
58
|
+
$('#full_list').after("<div id='noresults'></div>");
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
var lastRowClass = '';
|
|
62
|
+
function searchItem() {
|
|
63
|
+
for (var i = 0; i < searchCache.length / 50; i++) {
|
|
64
|
+
var item = searchCache[searchIndex];
|
|
65
|
+
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
|
|
66
|
+
var matchString = regexSearchString;
|
|
67
|
+
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
|
|
68
|
+
if (searchName.match(matchRegexp) == null) {
|
|
69
|
+
item.node.removeClass('found');
|
|
70
|
+
}
|
|
71
|
+
else {
|
|
72
|
+
item.node.css('padding-left', '10px').addClass('found');
|
|
73
|
+
item.node.parents().addClass('search_uncollapsed');
|
|
74
|
+
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
|
|
75
|
+
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
|
|
76
|
+
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
if (searchCache.length === searchIndex + 1) {
|
|
80
|
+
searchDone();
|
|
81
|
+
return;
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
searchIndex++;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
inSearch = setTimeout('searchItem()', 0);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
function searchDone() {
|
|
91
|
+
highlight(true);
|
|
92
|
+
if ($('#full_list li:visible').size() === 0) {
|
|
93
|
+
$('#noresults').text('No results were found.').hide().fadeIn();
|
|
94
|
+
}
|
|
95
|
+
else {
|
|
96
|
+
$('#noresults').text('');
|
|
97
|
+
}
|
|
98
|
+
$('#content').removeClass('insearch');
|
|
99
|
+
clearTimeout(inSearch);
|
|
100
|
+
inSearch = null;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
clicked = null;
|
|
104
|
+
function linkList() {
|
|
105
|
+
$('#full_list li, #full_list li a:last').click(function(evt) {
|
|
106
|
+
if ($(this).hasClass('toggle')) return true;
|
|
107
|
+
if (this.tagName.toLowerCase() == "li") {
|
|
108
|
+
var toggle = $(this).children('a.toggle');
|
|
109
|
+
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
|
|
110
|
+
toggle.click();
|
|
111
|
+
return false;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
if (clicked) clicked.removeClass('clicked');
|
|
115
|
+
var win = window.top.frames.main ? window.top.frames.main : window.parent;
|
|
116
|
+
if (this.tagName.toLowerCase() == "a") {
|
|
117
|
+
clicked = $(this).parent('li').addClass('clicked');
|
|
118
|
+
win.location = this.href;
|
|
119
|
+
}
|
|
120
|
+
else {
|
|
121
|
+
clicked = $(this).addClass('clicked');
|
|
122
|
+
win.location = $(this).find('a:last').attr('href');
|
|
123
|
+
}
|
|
124
|
+
return false;
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
function collapse() {
|
|
129
|
+
if (!$('#full_list').hasClass('class')) return;
|
|
130
|
+
$('#full_list.class a.toggle').click(function() {
|
|
131
|
+
$(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
|
|
132
|
+
highlight();
|
|
133
|
+
return false;
|
|
134
|
+
});
|
|
135
|
+
$('#full_list.class ul').each(function() {
|
|
136
|
+
$(this).addClass('collapsed').prev().addClass('collapsed');
|
|
137
|
+
});
|
|
138
|
+
$('#full_list.class').children().removeClass('collapsed');
|
|
139
|
+
highlight();
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function highlight(no_padding) {
|
|
143
|
+
var n = 1;
|
|
144
|
+
$('#full_list li:visible').each(function() {
|
|
145
|
+
var next = n == 1 ? 2 : 1;
|
|
146
|
+
$(this).removeClass("r" + next).addClass("r" + n);
|
|
147
|
+
if (!no_padding && $('#full_list').hasClass('class')) {
|
|
148
|
+
$(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
|
|
149
|
+
}
|
|
150
|
+
n = next;
|
|
151
|
+
});
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
function escapeShortcut() {
|
|
155
|
+
$(document).keydown(function(evt) {
|
|
156
|
+
if (evt.which == 27) {
|
|
157
|
+
$('#search_frame', window.top.document).slideUp(100);
|
|
158
|
+
$('#search a', window.top.document).removeClass('active inactive');
|
|
159
|
+
$(window.top).focus();
|
|
160
|
+
}
|
|
161
|
+
});
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
$(escapeShortcut);
|
|
165
|
+
$(fullListSearch);
|
|
166
|
+
$(linkList);
|
|
167
|
+
$(collapse);
|