rubybreaker 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/NEWS +48 -0
- data/README.md +56 -20
- data/Rakefile +9 -34
- data/TODO +10 -10
- data/VERSION +1 -0
- data/bin/gen_stub_rubylib +35 -36
- data/bin/rubybreaker +1 -4
- data/lib/rubybreaker/debug.rb +8 -4
- data/lib/rubybreaker/rubylib/core.rb +738 -571
- data/lib/rubybreaker/runtime/inspector.rb +16 -7
- data/lib/rubybreaker/runtime/monitor.rb +14 -18
- data/lib/rubybreaker/runtime/object_wrapper.rb +9 -3
- data/lib/rubybreaker/runtime/overrides.rb +51 -8
- data/lib/rubybreaker/runtime/pluggable.rb +1 -3
- data/lib/rubybreaker/runtime/type_placeholder.rb +2 -6
- data/lib/rubybreaker/runtime/type_system.rb +53 -17
- data/lib/rubybreaker/runtime/typesig_parser.rb +1 -0
- data/lib/rubybreaker/runtime/util.rb +18 -0
- data/lib/rubybreaker/runtime.rb +42 -15
- data/lib/rubybreaker/type/type_comparer.rb +10 -10
- data/lib/rubybreaker/type/type_grammar.treetop +30 -21
- data/lib/rubybreaker/type/type_unparser.rb +2 -2
- data/lib/rubybreaker/typing/subtyping.rb +21 -21
- data/lib/rubybreaker/util.rb +11 -1
- data/lib/rubybreaker.rb +75 -54
- data/test/integrated/tc_class_methods.rb +35 -0
- data/test/integrated/tc_inherit_broken.rb +29 -0
- data/test/integrated/tc_method_missing.rb +1 -1
- data/test/runtime/tc_obj_wrapper.rb +104 -4
- data/test/ts_integrated.rb +2 -0
- data/test/type/tc_comparer.rb +96 -96
- data/test/type/tc_parser.rb +18 -0
- data/test/type/tc_unparser.rb +16 -0
- data/test/typing/tc_typing.rb +20 -20
- data/webpage/footer.html +1 -1
- data/webpage/header.html +7 -7
- data/webpage/index.html +65 -28
- data/webpage/rdoc/RubyBreaker/Breakable.html +280 -0
- data/webpage/rdoc/RubyBreaker/Broken/BrokenEigen.html +304 -0
- data/webpage/rdoc/RubyBreaker/Broken.html +308 -0
- data/webpage/rdoc/RubyBreaker/Context.html +421 -0
- data/webpage/rdoc/RubyBreaker/Debug.html +411 -0
- data/webpage/rdoc/RubyBreaker/Errors/InternalError.html +263 -0
- data/webpage/rdoc/RubyBreaker/Errors/InvalidSubtypeCheck.html +263 -0
- data/webpage/rdoc/RubyBreaker/Errors/InvalidTypeConstruction.html +214 -0
- data/webpage/rdoc/RubyBreaker/Errors/SubtypeFailure.html +212 -0
- data/webpage/rdoc/RubyBreaker/Errors/TypeError.html +212 -0
- data/webpage/rdoc/RubyBreaker/Errors/UserError.html +264 -0
- data/webpage/rdoc/RubyBreaker/Errors.html +209 -0
- data/webpage/rdoc/RubyBreaker/Kernel.html +259 -0
- data/webpage/rdoc/RubyBreaker/Main.html +560 -0
- data/webpage/rdoc/RubyBreaker/ObjectPosition.html +334 -0
- data/webpage/rdoc/RubyBreaker/Position.html +463 -0
- data/webpage/rdoc/RubyBreaker/RubyTypeUtils.html +308 -0
- data/webpage/rdoc/RubyBreaker/Runtime/Inspector.html +380 -0
- data/webpage/rdoc/RubyBreaker/Runtime/MethodInfo.html +324 -0
- data/webpage/rdoc/RubyBreaker/Runtime/Monitor.html +354 -0
- data/webpage/rdoc/RubyBreaker/Runtime/MonitorInstaller.html +379 -0
- data/webpage/rdoc/RubyBreaker/Runtime/MonitorSwitch.html +382 -0
- data/webpage/rdoc/RubyBreaker/Runtime/MonitorUtils.html +400 -0
- data/webpage/rdoc/RubyBreaker/Runtime/ObjectWrapper.html +411 -0
- data/webpage/rdoc/RubyBreaker/Runtime/Pluggable.html +305 -0
- data/webpage/rdoc/RubyBreaker/Runtime/TypePlaceholder.html +280 -0
- data/webpage/rdoc/RubyBreaker/Runtime/TypeSigParser.html +283 -0
- data/webpage/rdoc/RubyBreaker/Runtime/TypeSystem.html +630 -0
- data/webpage/rdoc/RubyBreaker/Runtime.html +255 -0
- data/webpage/rdoc/RubyBreaker/TestCase.html +332 -0
- data/webpage/rdoc/RubyBreaker/TypeComparer.html +304 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/AnyType.html +260 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/BlockType.html +310 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/DuckType.html +320 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/FusionType.html +323 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/MethodListType.html +281 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/MethodType.html +282 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/NilType.html +260 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/NominalType.html +282 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/OptionalType.html +281 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/OrType.html +281 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/SelfType.html +329 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/Type.html +409 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs/VarLengthType.html +282 -0
- data/webpage/rdoc/RubyBreaker/TypeDefs.html +212 -0
- data/webpage/rdoc/RubyBreaker/TypeUnparser.html +273 -0
- data/webpage/rdoc/RubyBreaker/Typing.html +305 -0
- data/webpage/rdoc/RubyBreaker/Utilities.html +294 -0
- data/webpage/rdoc/RubyBreaker.html +337 -0
- data/webpage/rdoc/created.rid +26 -0
- data/webpage/rdoc/images/add.png +0 -0
- data/webpage/rdoc/images/brick.png +0 -0
- data/webpage/rdoc/images/brick_link.png +0 -0
- data/webpage/rdoc/images/bug.png +0 -0
- data/webpage/rdoc/images/bullet_black.png +0 -0
- data/webpage/rdoc/images/bullet_toggle_minus.png +0 -0
- data/webpage/rdoc/images/bullet_toggle_plus.png +0 -0
- data/webpage/rdoc/images/date.png +0 -0
- data/webpage/rdoc/images/delete.png +0 -0
- data/webpage/rdoc/images/find.png +0 -0
- data/webpage/rdoc/images/loadingAnimation.gif +0 -0
- data/webpage/rdoc/images/macFFBgHack.png +0 -0
- data/webpage/rdoc/images/package.png +0 -0
- data/webpage/rdoc/images/page_green.png +0 -0
- data/webpage/rdoc/images/page_white_text.png +0 -0
- data/webpage/rdoc/images/page_white_width.png +0 -0
- data/webpage/rdoc/images/plugin.png +0 -0
- data/webpage/rdoc/images/ruby.png +0 -0
- data/webpage/rdoc/images/tag_blue.png +0 -0
- data/webpage/rdoc/images/tag_green.png +0 -0
- data/webpage/rdoc/images/transparent.png +0 -0
- data/webpage/rdoc/images/wrench.png +0 -0
- data/webpage/rdoc/images/wrench_orange.png +0 -0
- data/webpage/rdoc/images/zoom.png +0 -0
- data/webpage/rdoc/index.html +165 -0
- data/webpage/rdoc/js/darkfish.js +153 -0
- data/webpage/rdoc/js/jquery.js +18 -0
- data/webpage/rdoc/js/navigation.js +142 -0
- data/webpage/rdoc/js/search.js +94 -0
- data/webpage/rdoc/js/search_index.js +1 -0
- data/webpage/rdoc/js/searcher.js +228 -0
- data/webpage/rdoc/rdoc.css +543 -0
- data/webpage/rdoc/table_of_contents.html +376 -0
- data/webpage/rubybreaker.css +31 -31
- metadata +93 -6
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>module RubyBreaker::Breakable - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
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 id="top" class="module">
|
|
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>
|
|
32
|
+
|
|
33
|
+
|
|
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
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/rubybreaker/runtime.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
<!-- Method Quickref -->
|
|
62
|
+
<nav id="method-list-section" class="section">
|
|
63
|
+
<h3 class="section-header">Methods</h3>
|
|
64
|
+
|
|
65
|
+
<ul class="link-list">
|
|
66
|
+
|
|
67
|
+
<li><a href="#method-c-included">::included</a>
|
|
68
|
+
|
|
69
|
+
</ul>
|
|
70
|
+
</nav>
|
|
71
|
+
|
|
72
|
+
</div>
|
|
73
|
+
|
|
74
|
+
<div id="project-metadata">
|
|
75
|
+
|
|
76
|
+
<nav id="classindex-section" class="section project-section">
|
|
77
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
78
|
+
|
|
79
|
+
<ul class="link-list">
|
|
80
|
+
|
|
81
|
+
<li><a href="../RubyBreaker.html">RubyBreaker</a>
|
|
82
|
+
|
|
83
|
+
<li><a href="../RubyBreaker/Breakable.html">RubyBreaker::Breakable</a>
|
|
84
|
+
|
|
85
|
+
<li><a href="../RubyBreaker/Broken.html">RubyBreaker::Broken</a>
|
|
86
|
+
|
|
87
|
+
<li><a href="../RubyBreaker/Broken/BrokenEigen.html">RubyBreaker::Broken::BrokenEigen</a>
|
|
88
|
+
|
|
89
|
+
<li><a href="../RubyBreaker/Context.html">RubyBreaker::Context</a>
|
|
90
|
+
|
|
91
|
+
<li><a href="../RubyBreaker/Debug.html">RubyBreaker::Debug</a>
|
|
92
|
+
|
|
93
|
+
<li><a href="../RubyBreaker/Errors.html">RubyBreaker::Errors</a>
|
|
94
|
+
|
|
95
|
+
<li><a href="../RubyBreaker/Errors/InternalError.html">RubyBreaker::Errors::InternalError</a>
|
|
96
|
+
|
|
97
|
+
<li><a href="../RubyBreaker/Errors/InvalidSubtypeCheck.html">RubyBreaker::Errors::InvalidSubtypeCheck</a>
|
|
98
|
+
|
|
99
|
+
<li><a href="../RubyBreaker/Errors/InvalidTypeConstruction.html">RubyBreaker::Errors::InvalidTypeConstruction</a>
|
|
100
|
+
|
|
101
|
+
<li><a href="../RubyBreaker/Errors/SubtypeFailure.html">RubyBreaker::Errors::SubtypeFailure</a>
|
|
102
|
+
|
|
103
|
+
<li><a href="../RubyBreaker/Errors/TypeError.html">RubyBreaker::Errors::TypeError</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="../RubyBreaker/Errors/UserError.html">RubyBreaker::Errors::UserError</a>
|
|
106
|
+
|
|
107
|
+
<li><a href="../RubyBreaker/Kernel.html">RubyBreaker::Kernel</a>
|
|
108
|
+
|
|
109
|
+
<li><a href="../RubyBreaker/Main.html">RubyBreaker::Main</a>
|
|
110
|
+
|
|
111
|
+
<li><a href="../RubyBreaker/ObjectPosition.html">RubyBreaker::ObjectPosition</a>
|
|
112
|
+
|
|
113
|
+
<li><a href="../RubyBreaker/Position.html">RubyBreaker::Position</a>
|
|
114
|
+
|
|
115
|
+
<li><a href="../RubyBreaker/RubyTypeUtils.html">RubyBreaker::RubyTypeUtils</a>
|
|
116
|
+
|
|
117
|
+
<li><a href="../RubyBreaker/Runtime.html">RubyBreaker::Runtime</a>
|
|
118
|
+
|
|
119
|
+
<li><a href="../RubyBreaker/Runtime/Inspector.html">RubyBreaker::Runtime::Inspector</a>
|
|
120
|
+
|
|
121
|
+
<li><a href="../RubyBreaker/Runtime/MethodInfo.html">RubyBreaker::Runtime::MethodInfo</a>
|
|
122
|
+
|
|
123
|
+
<li><a href="../RubyBreaker/Runtime/Monitor.html">RubyBreaker::Runtime::Monitor</a>
|
|
124
|
+
|
|
125
|
+
<li><a href="../RubyBreaker/Runtime/MonitorInstaller.html">RubyBreaker::Runtime::MonitorInstaller</a>
|
|
126
|
+
|
|
127
|
+
<li><a href="../RubyBreaker/Runtime/MonitorSwitch.html">RubyBreaker::Runtime::MonitorSwitch</a>
|
|
128
|
+
|
|
129
|
+
<li><a href="../RubyBreaker/Runtime/MonitorUtils.html">RubyBreaker::Runtime::MonitorUtils</a>
|
|
130
|
+
|
|
131
|
+
<li><a href="../RubyBreaker/Runtime/ObjectWrapper.html">RubyBreaker::Runtime::ObjectWrapper</a>
|
|
132
|
+
|
|
133
|
+
<li><a href="../RubyBreaker/Runtime/Pluggable.html">RubyBreaker::Runtime::Pluggable</a>
|
|
134
|
+
|
|
135
|
+
<li><a href="../RubyBreaker/Runtime/TypePlaceholder.html">RubyBreaker::Runtime::TypePlaceholder</a>
|
|
136
|
+
|
|
137
|
+
<li><a href="../RubyBreaker/Runtime/TypeSigParser.html">RubyBreaker::Runtime::TypeSigParser</a>
|
|
138
|
+
|
|
139
|
+
<li><a href="../RubyBreaker/Runtime/TypeSystem.html">RubyBreaker::Runtime::TypeSystem</a>
|
|
140
|
+
|
|
141
|
+
<li><a href="../RubyBreaker/TestCase.html">RubyBreaker::TestCase</a>
|
|
142
|
+
|
|
143
|
+
<li><a href="../RubyBreaker/TypeComparer.html">RubyBreaker::TypeComparer</a>
|
|
144
|
+
|
|
145
|
+
<li><a href="../RubyBreaker/TypeDefs.html">RubyBreaker::TypeDefs</a>
|
|
146
|
+
|
|
147
|
+
<li><a href="../RubyBreaker/TypeDefs/AnyType.html">RubyBreaker::TypeDefs::AnyType</a>
|
|
148
|
+
|
|
149
|
+
<li><a href="../RubyBreaker/TypeDefs/BlockType.html">RubyBreaker::TypeDefs::BlockType</a>
|
|
150
|
+
|
|
151
|
+
<li><a href="../RubyBreaker/TypeDefs/DuckType.html">RubyBreaker::TypeDefs::DuckType</a>
|
|
152
|
+
|
|
153
|
+
<li><a href="../RubyBreaker/TypeDefs/FusionType.html">RubyBreaker::TypeDefs::FusionType</a>
|
|
154
|
+
|
|
155
|
+
<li><a href="../RubyBreaker/TypeDefs/MethodListType.html">RubyBreaker::TypeDefs::MethodListType</a>
|
|
156
|
+
|
|
157
|
+
<li><a href="../RubyBreaker/TypeDefs/MethodType.html">RubyBreaker::TypeDefs::MethodType</a>
|
|
158
|
+
|
|
159
|
+
<li><a href="../RubyBreaker/TypeDefs/NilType.html">RubyBreaker::TypeDefs::NilType</a>
|
|
160
|
+
|
|
161
|
+
<li><a href="../RubyBreaker/TypeDefs/NominalType.html">RubyBreaker::TypeDefs::NominalType</a>
|
|
162
|
+
|
|
163
|
+
<li><a href="../RubyBreaker/TypeDefs/OptionalType.html">RubyBreaker::TypeDefs::OptionalType</a>
|
|
164
|
+
|
|
165
|
+
<li><a href="../RubyBreaker/TypeDefs/OrType.html">RubyBreaker::TypeDefs::OrType</a>
|
|
166
|
+
|
|
167
|
+
<li><a href="../RubyBreaker/TypeDefs/SelfType.html">RubyBreaker::TypeDefs::SelfType</a>
|
|
168
|
+
|
|
169
|
+
<li><a href="../RubyBreaker/TypeDefs/Type.html">RubyBreaker::TypeDefs::Type</a>
|
|
170
|
+
|
|
171
|
+
<li><a href="../RubyBreaker/TypeDefs/VarLengthType.html">RubyBreaker::TypeDefs::VarLengthType</a>
|
|
172
|
+
|
|
173
|
+
<li><a href="../RubyBreaker/TypeUnparser.html">RubyBreaker::TypeUnparser</a>
|
|
174
|
+
|
|
175
|
+
<li><a href="../RubyBreaker/Typing.html">RubyBreaker::Typing</a>
|
|
176
|
+
|
|
177
|
+
<li><a href="../RubyBreaker/Utilities.html">RubyBreaker::Utilities</a>
|
|
178
|
+
|
|
179
|
+
</ul>
|
|
180
|
+
</nav>
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
</nav>
|
|
184
|
+
|
|
185
|
+
<div id="documentation">
|
|
186
|
+
<h1 class="module">module RubyBreaker::Breakable</h1>
|
|
187
|
+
|
|
188
|
+
<div id="description" class="description">
|
|
189
|
+
|
|
190
|
+
<p>This module should be included in classes or modules that you want to
|
|
191
|
+
monitor during runtime. The concept is that once a <a
|
|
192
|
+
href="Breakable.html">Breakable</a> module is monitored and its type
|
|
193
|
+
documentation is generated, the module now becomes a <a
|
|
194
|
+
href="Broken.html">Broken</a> module. The actual implementation is a simple
|
|
195
|
+
trigger that queues the target module into the list of modules to monitor.
|
|
196
|
+
The queued modules are then modified to be monitored dynamically.</p>
|
|
197
|
+
|
|
198
|
+
</div><!-- description -->
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<!-- Constants -->
|
|
210
|
+
<section id="constants-list" class="section">
|
|
211
|
+
<h3 class="section-header">Constants</h3>
|
|
212
|
+
<dl>
|
|
213
|
+
|
|
214
|
+
<dt id="MONITOR_MAP">MONITOR_MAP
|
|
215
|
+
|
|
216
|
+
<dd class="description">
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<dt id="TYPE_PLACEHOLDER_MAP">TYPE_PLACEHOLDER_MAP
|
|
220
|
+
|
|
221
|
+
<dd class="description">
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</dl>
|
|
225
|
+
</section>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<!-- Methods -->
|
|
231
|
+
|
|
232
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
233
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<div id="method-c-included" class="method-detail ">
|
|
237
|
+
|
|
238
|
+
<div class="method-heading">
|
|
239
|
+
<span class="method-name">included</span><span
|
|
240
|
+
class="method-args">(mod)</span>
|
|
241
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
242
|
+
</div>
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div class="method-description">
|
|
246
|
+
|
|
247
|
+
<p>Simply keep track of this module and its eigen class so they are monitored
|
|
248
|
+
later on.</p>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
<div class="method-source-code" id="included-source">
|
|
253
|
+
<pre><span class="ruby-comment"># File lib/rubybreaker/runtime.rb, line 38</span>
|
|
254
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">included</span>(<span class="ruby-identifier">mod</span>)
|
|
255
|
+
<span class="ruby-constant">BREAKABLE</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">mod</span>
|
|
256
|
+
<span class="ruby-constant">BREAKABLE</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">Runtime</span>.<span class="ruby-identifier">eigen_class</span>(<span class="ruby-identifier">mod</span>)
|
|
257
|
+
<span class="ruby-keyword">end</span></pre>
|
|
258
|
+
</div><!-- included-source -->
|
|
259
|
+
|
|
260
|
+
</div>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</div><!-- included-method -->
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</section><!-- public-class-method-details -->
|
|
269
|
+
|
|
270
|
+
</section><!-- 5Buntitled-5D -->
|
|
271
|
+
|
|
272
|
+
</div><!-- documentation -->
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<footer id="validator-badges">
|
|
276
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
277
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
278
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
279
|
+
</footer>
|
|
280
|
+
|
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>module RubyBreaker::Broken::BrokenEigen - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "../../";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
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 id="top" class="module">
|
|
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>
|
|
32
|
+
|
|
33
|
+
|
|
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
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/rubybreaker/runtime.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
<!-- Included Modules -->
|
|
61
|
+
<nav id="includes-section" class="section">
|
|
62
|
+
<h3 class="section-header">Included Modules</h3>
|
|
63
|
+
|
|
64
|
+
<ul class="link-list">
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<li><a class="include" href="../TypeDefs.html">RubyBreaker::TypeDefs</a>
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
<li><a class="include" href="../Runtime.html">RubyBreaker::Runtime</a>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</ul>
|
|
75
|
+
</nav>
|
|
76
|
+
|
|
77
|
+
<!-- Method Quickref -->
|
|
78
|
+
<nav id="method-list-section" class="section">
|
|
79
|
+
<h3 class="section-header">Methods</h3>
|
|
80
|
+
|
|
81
|
+
<ul class="link-list">
|
|
82
|
+
|
|
83
|
+
<li><a href="#method-i-typesig">#typesig</a>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
</nav>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
|
|
90
|
+
<div id="project-metadata">
|
|
91
|
+
|
|
92
|
+
<nav id="classindex-section" class="section project-section">
|
|
93
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
94
|
+
|
|
95
|
+
<ul class="link-list">
|
|
96
|
+
|
|
97
|
+
<li><a href="../../RubyBreaker.html">RubyBreaker</a>
|
|
98
|
+
|
|
99
|
+
<li><a href="../../RubyBreaker/Breakable.html">RubyBreaker::Breakable</a>
|
|
100
|
+
|
|
101
|
+
<li><a href="../../RubyBreaker/Broken.html">RubyBreaker::Broken</a>
|
|
102
|
+
|
|
103
|
+
<li><a href="../../RubyBreaker/Broken/BrokenEigen.html">RubyBreaker::Broken::BrokenEigen</a>
|
|
104
|
+
|
|
105
|
+
<li><a href="../../RubyBreaker/Context.html">RubyBreaker::Context</a>
|
|
106
|
+
|
|
107
|
+
<li><a href="../../RubyBreaker/Debug.html">RubyBreaker::Debug</a>
|
|
108
|
+
|
|
109
|
+
<li><a href="../../RubyBreaker/Errors.html">RubyBreaker::Errors</a>
|
|
110
|
+
|
|
111
|
+
<li><a href="../../RubyBreaker/Errors/InternalError.html">RubyBreaker::Errors::InternalError</a>
|
|
112
|
+
|
|
113
|
+
<li><a href="../../RubyBreaker/Errors/InvalidSubtypeCheck.html">RubyBreaker::Errors::InvalidSubtypeCheck</a>
|
|
114
|
+
|
|
115
|
+
<li><a href="../../RubyBreaker/Errors/InvalidTypeConstruction.html">RubyBreaker::Errors::InvalidTypeConstruction</a>
|
|
116
|
+
|
|
117
|
+
<li><a href="../../RubyBreaker/Errors/SubtypeFailure.html">RubyBreaker::Errors::SubtypeFailure</a>
|
|
118
|
+
|
|
119
|
+
<li><a href="../../RubyBreaker/Errors/TypeError.html">RubyBreaker::Errors::TypeError</a>
|
|
120
|
+
|
|
121
|
+
<li><a href="../../RubyBreaker/Errors/UserError.html">RubyBreaker::Errors::UserError</a>
|
|
122
|
+
|
|
123
|
+
<li><a href="../../RubyBreaker/Kernel.html">RubyBreaker::Kernel</a>
|
|
124
|
+
|
|
125
|
+
<li><a href="../../RubyBreaker/Main.html">RubyBreaker::Main</a>
|
|
126
|
+
|
|
127
|
+
<li><a href="../../RubyBreaker/ObjectPosition.html">RubyBreaker::ObjectPosition</a>
|
|
128
|
+
|
|
129
|
+
<li><a href="../../RubyBreaker/Position.html">RubyBreaker::Position</a>
|
|
130
|
+
|
|
131
|
+
<li><a href="../../RubyBreaker/RubyTypeUtils.html">RubyBreaker::RubyTypeUtils</a>
|
|
132
|
+
|
|
133
|
+
<li><a href="../../RubyBreaker/Runtime.html">RubyBreaker::Runtime</a>
|
|
134
|
+
|
|
135
|
+
<li><a href="../../RubyBreaker/Runtime/Inspector.html">RubyBreaker::Runtime::Inspector</a>
|
|
136
|
+
|
|
137
|
+
<li><a href="../../RubyBreaker/Runtime/MethodInfo.html">RubyBreaker::Runtime::MethodInfo</a>
|
|
138
|
+
|
|
139
|
+
<li><a href="../../RubyBreaker/Runtime/Monitor.html">RubyBreaker::Runtime::Monitor</a>
|
|
140
|
+
|
|
141
|
+
<li><a href="../../RubyBreaker/Runtime/MonitorInstaller.html">RubyBreaker::Runtime::MonitorInstaller</a>
|
|
142
|
+
|
|
143
|
+
<li><a href="../../RubyBreaker/Runtime/MonitorSwitch.html">RubyBreaker::Runtime::MonitorSwitch</a>
|
|
144
|
+
|
|
145
|
+
<li><a href="../../RubyBreaker/Runtime/MonitorUtils.html">RubyBreaker::Runtime::MonitorUtils</a>
|
|
146
|
+
|
|
147
|
+
<li><a href="../../RubyBreaker/Runtime/ObjectWrapper.html">RubyBreaker::Runtime::ObjectWrapper</a>
|
|
148
|
+
|
|
149
|
+
<li><a href="../../RubyBreaker/Runtime/Pluggable.html">RubyBreaker::Runtime::Pluggable</a>
|
|
150
|
+
|
|
151
|
+
<li><a href="../../RubyBreaker/Runtime/TypePlaceholder.html">RubyBreaker::Runtime::TypePlaceholder</a>
|
|
152
|
+
|
|
153
|
+
<li><a href="../../RubyBreaker/Runtime/TypeSigParser.html">RubyBreaker::Runtime::TypeSigParser</a>
|
|
154
|
+
|
|
155
|
+
<li><a href="../../RubyBreaker/Runtime/TypeSystem.html">RubyBreaker::Runtime::TypeSystem</a>
|
|
156
|
+
|
|
157
|
+
<li><a href="../../RubyBreaker/TestCase.html">RubyBreaker::TestCase</a>
|
|
158
|
+
|
|
159
|
+
<li><a href="../../RubyBreaker/TypeComparer.html">RubyBreaker::TypeComparer</a>
|
|
160
|
+
|
|
161
|
+
<li><a href="../../RubyBreaker/TypeDefs.html">RubyBreaker::TypeDefs</a>
|
|
162
|
+
|
|
163
|
+
<li><a href="../../RubyBreaker/TypeDefs/AnyType.html">RubyBreaker::TypeDefs::AnyType</a>
|
|
164
|
+
|
|
165
|
+
<li><a href="../../RubyBreaker/TypeDefs/BlockType.html">RubyBreaker::TypeDefs::BlockType</a>
|
|
166
|
+
|
|
167
|
+
<li><a href="../../RubyBreaker/TypeDefs/DuckType.html">RubyBreaker::TypeDefs::DuckType</a>
|
|
168
|
+
|
|
169
|
+
<li><a href="../../RubyBreaker/TypeDefs/FusionType.html">RubyBreaker::TypeDefs::FusionType</a>
|
|
170
|
+
|
|
171
|
+
<li><a href="../../RubyBreaker/TypeDefs/MethodListType.html">RubyBreaker::TypeDefs::MethodListType</a>
|
|
172
|
+
|
|
173
|
+
<li><a href="../../RubyBreaker/TypeDefs/MethodType.html">RubyBreaker::TypeDefs::MethodType</a>
|
|
174
|
+
|
|
175
|
+
<li><a href="../../RubyBreaker/TypeDefs/NilType.html">RubyBreaker::TypeDefs::NilType</a>
|
|
176
|
+
|
|
177
|
+
<li><a href="../../RubyBreaker/TypeDefs/NominalType.html">RubyBreaker::TypeDefs::NominalType</a>
|
|
178
|
+
|
|
179
|
+
<li><a href="../../RubyBreaker/TypeDefs/OptionalType.html">RubyBreaker::TypeDefs::OptionalType</a>
|
|
180
|
+
|
|
181
|
+
<li><a href="../../RubyBreaker/TypeDefs/OrType.html">RubyBreaker::TypeDefs::OrType</a>
|
|
182
|
+
|
|
183
|
+
<li><a href="../../RubyBreaker/TypeDefs/SelfType.html">RubyBreaker::TypeDefs::SelfType</a>
|
|
184
|
+
|
|
185
|
+
<li><a href="../../RubyBreaker/TypeDefs/Type.html">RubyBreaker::TypeDefs::Type</a>
|
|
186
|
+
|
|
187
|
+
<li><a href="../../RubyBreaker/TypeDefs/VarLengthType.html">RubyBreaker::TypeDefs::VarLengthType</a>
|
|
188
|
+
|
|
189
|
+
<li><a href="../../RubyBreaker/TypeUnparser.html">RubyBreaker::TypeUnparser</a>
|
|
190
|
+
|
|
191
|
+
<li><a href="../../RubyBreaker/Typing.html">RubyBreaker::Typing</a>
|
|
192
|
+
|
|
193
|
+
<li><a href="../../RubyBreaker/Utilities.html">RubyBreaker::Utilities</a>
|
|
194
|
+
|
|
195
|
+
</ul>
|
|
196
|
+
</nav>
|
|
197
|
+
|
|
198
|
+
</div>
|
|
199
|
+
</nav>
|
|
200
|
+
|
|
201
|
+
<div id="documentation">
|
|
202
|
+
<h1 class="module">module RubyBreaker::Broken::BrokenEigen</h1>
|
|
203
|
+
|
|
204
|
+
<div id="description" class="description">
|
|
205
|
+
|
|
206
|
+
<p>-</p>
|
|
207
|
+
|
|
208
|
+
<pre class="ruby"><span class="ruby-constant">This</span> <span class="ruby-keyword">module</span> <span class="ruby-identifier">will</span> <span class="ruby-identifier">be</span> <span class="ruby-string">"extended"</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">eigen</span> <span class="ruby-keyword">class</span> <span class="ruby-identifier">of</span> <span class="ruby-identifier">the</span> <span class="ruby-keyword">class</span> <span class="ruby-identifier">that</span>
|
|
209
|
+
<span class="ruby-identifier">includes</span> <span class="ruby-constant">Broken</span> <span class="ruby-keyword">module</span>. <span class="ruby-constant">This</span> <span class="ruby-identifier">allows</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">eigen</span> <span class="ruby-keyword">class</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">call</span> <span class="ruby-string">'typesig'</span>
|
|
210
|
+
<span class="ruby-identifier">method</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">parse</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">type</span> <span class="ruby-identifier">signature</span> <span class="ruby-identifier">dynamically</span>.
|
|
211
|
+
|
|
212
|
+
<span class="ruby-constant">Usage</span><span class="ruby-operator">:</span>
|
|
213
|
+
<span class="ruby-constant">Class</span> <span class="ruby-constant">A</span>
|
|
214
|
+
<span class="ruby-identifier">include</span> <span class="ruby-constant">RubyBreaker</span><span class="ruby-operator">::</span><span class="ruby-constant">Broken</span>
|
|
215
|
+
|
|
216
|
+
<span class="ruby-identifier">typesig</span>(<span class="ruby-string">"foo(fixnum) -> fixnum"</span>)
|
|
217
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">foo</span>(<span class="ruby-identifier">x</span>) <span class="ruby-operator">...</span> <span class="ruby-keyword">end</span>
|
|
218
|
+
<span class="ruby-keyword">end</span>
|
|
219
|
+
</pre>
|
|
220
|
+
|
|
221
|
+
</div><!-- description -->
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<!-- Methods -->
|
|
236
|
+
|
|
237
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
238
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
<div id="method-i-typesig" class="method-detail ">
|
|
242
|
+
|
|
243
|
+
<div class="method-heading">
|
|
244
|
+
<span class="method-name">typesig</span><span
|
|
245
|
+
class="method-args">(str)</span>
|
|
246
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<div class="method-description">
|
|
251
|
+
|
|
252
|
+
<p>This method can be used at the eigen level of the target module to specify
|
|
253
|
+
the type of a method.</p>
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
<div class="method-source-code" id="typesig-source">
|
|
258
|
+
<pre><span class="ruby-comment"># File lib/rubybreaker/runtime.rb, line 73</span>
|
|
259
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">typesig</span>(<span class="ruby-identifier">str</span>)
|
|
260
|
+
|
|
261
|
+
<span class="ruby-comment"># This MUST BE set for self type to work in type signatures.</span>
|
|
262
|
+
<span class="ruby-constant">TypeDefs</span><span class="ruby-operator">::</span><span class="ruby-constant">SelfType</span>.<span class="ruby-identifier">set_self</span>(<span class="ruby-keyword">self</span>)
|
|
263
|
+
|
|
264
|
+
<span class="ruby-identifier">t</span> = <span class="ruby-constant">TypeSigParser</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">str</span>)
|
|
265
|
+
<span class="ruby-identifier">placeholder</span> = <span class="ruby-constant">TYPE_PLACEHOLDER_MAP</span>[<span class="ruby-keyword">self</span>]
|
|
266
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">placeholder</span>
|
|
267
|
+
<span class="ruby-identifier">meth_type</span> = <span class="ruby-identifier">placeholder</span>.<span class="ruby-identifier">meth_type_map</span>[<span class="ruby-identifier">t</span>.<span class="ruby-identifier">meth_name</span>]
|
|
268
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">meth_type</span>
|
|
269
|
+
<span class="ruby-comment"># TODO: make a method list</span>
|
|
270
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">meth_type</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">MethodListType</span>)
|
|
271
|
+
<span class="ruby-identifier">meth_type</span>.<span class="ruby-identifier">types</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">t</span>
|
|
272
|
+
<span class="ruby-keyword">else</span>
|
|
273
|
+
<span class="ruby-comment"># then upgrade it</span>
|
|
274
|
+
<span class="ruby-identifier">placeholder</span>.<span class="ruby-identifier">meth_type_map</span>[<span class="ruby-identifier">t</span>.<span class="ruby-identifier">meth_name</span>] = <span class="ruby-constant">MethodListType</span>.<span class="ruby-identifier">new</span>([<span class="ruby-identifier">meth_type</span>, <span class="ruby-identifier">t</span>])
|
|
275
|
+
<span class="ruby-keyword">end</span>
|
|
276
|
+
<span class="ruby-keyword">else</span>
|
|
277
|
+
<span class="ruby-identifier">placeholder</span>.<span class="ruby-identifier">meth_type_map</span>[<span class="ruby-identifier">t</span>.<span class="ruby-identifier">meth_name</span>] = <span class="ruby-identifier">t</span>
|
|
278
|
+
<span class="ruby-keyword">end</span>
|
|
279
|
+
<span class="ruby-keyword">end</span>
|
|
280
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">t</span>
|
|
281
|
+
<span class="ruby-keyword">end</span></pre>
|
|
282
|
+
</div><!-- typesig-source -->
|
|
283
|
+
|
|
284
|
+
</div>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</div><!-- typesig-method -->
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</section><!-- public-instance-method-details -->
|
|
293
|
+
|
|
294
|
+
</section><!-- 5Buntitled-5D -->
|
|
295
|
+
|
|
296
|
+
</div><!-- documentation -->
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<footer id="validator-badges">
|
|
300
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
301
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
|
|
302
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
303
|
+
</footer>
|
|
304
|
+
|