blob: 141efe04b1481d5fc4c8688774b5f0a2d69937c4 [file] [log] [blame]
Stephan Herrmann01664412010-04-01 20:28:43 +00001<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "../../dtd/xhtml1-strict.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3 <head>
4 <meta name="copyright" content="Copyright Technical University Berlin and others 2004, 2010. This page is made available under the Eclipse Public License v1.0. For full details see http://www.eclipse.org/legal/epl-v10.html" />
5 <link rel="stylesheet" href="otjld/css/ot.css" type="text/css" />
6 <link rel="stylesheet" href="otjld/css/otjld.css" type="text/css" />
7 <title>OTDT Feature List</title>
8 <!-- special padding for the table of tests. -->
9 <style type="text/css">
10 td,th { padding-left:15px; padding-right:15px; padding-top:2px; padding-bottom:2px; }
11 </style>
12 </head>
13 <body>
14 <div id="head">
Stephan Herrmanna3efd5f2012-01-29 22:52:12 +010015 <h1>Features of the OTDT (version 2.1)</h1>
Stephan Herrmann01664412010-04-01 20:28:43 +000016 </div>
Stephan Herrmann7736a712010-07-01 16:47:30 +000017 <div style="margin:10px;margin-top:100px;">
18 <div style="margin-left:40px;padding:2px;float:left;background-color:#D0D0D0;">
19 <div style="padding:4px;background-color:#def4fe;">
Stephan Herrmann2be84c12012-06-04 01:02:48 +020020 The release 2.1 is based on Eclipse SDK 3.8 / 4.2.<br/>
Stephan Herrmann7736a712010-07-01 16:47:30 +000021 The OTDT contains a modified version of the JDT core and several added plugins.
22 </div>
23 </div>
24 <br style="clear:both;"/><br/>
Stephan Herrmann01664412010-04-01 20:28:43 +000025
26 The following components are available:
27
28 <ul>
29 <li><a href="#compiler">Compiler</a></li>
30 <li><a href="#wizards">Wizards</a></li>
31 <li><a href="#editor">Editor</a></li>
32 <li><a href="#bindingEditor">Binding Editor</a></li>
33 <li><a href="#refactoring">Refactoring</a></li>
34 <li><a href="#structureViewers">Structure Viewers</a></li>
Stephan Herrmann2be84c12012-06-04 01:02:48 +020035 <li><a href="#search">Search</a></li>
Stephan Herrmann01664412010-04-01 20:28:43 +000036 <li><a href="#execution">Execution Environment</a></li>
37 <li><a href="#otequinox">OT/Equinox</a></li>
38 <li><a href="#debugging">Debugging</a></li>
39 <li><a href="#help">Help and additional Information</a></li>
40 </ul>
41
42
43 <p></p>
44
45 <div id="compiler" class="headl"><div class="headr">
46 <h1>Compiler</h1>
47 </div></div>
48
49 The Object Teams Compiler is an incremental compiler, based on the Eclipse Compiler for Java.
50 <dl>
51 <dt><strong>Language Definition</strong></dt>
52 <dd>The compiler implements the language as defined in the OT/J
Stephan Herrmann7736a712010-07-01 16:47:30 +000053 <a href="otjld/def/index.html">language definition</a> version 1.3 (OTJLD).
Stephan Herrmann01664412010-04-01 20:28:43 +000054 The language definition has continuously been revised to precisely specify the language
55 including various corner cases and combinations of features.
56 </dd>
57 <dt><strong>Language Implementation</strong></dt>
58 <dd>
59 The compiler supports all features of OT/J according to the
Stephan Herrmann7736a712010-07-01 16:47:30 +000060 <a href="otjld/def/index.html"><img alt="otjld" src="../images/ot_paragraph.png"/> OTJLD v1.3</a>
61 &sect;&sect;1-7,9.
62 Support for the join point sub-language (<a href="http://www.objectteams.org/def/0.9/joinpoints.html"><img alt="otjld" src="../images/ot_paragraph.png"/> OTJLD &#167; 8</a>) is not included.
Stephan Herrmann01664412010-04-01 20:28:43 +000063 <p></p>
64 The compiler can be <strong>configured</strong> using global <code>Preferences</code> or project
65 specific <code>Properties</code>.
66 <ul>
67 <li>Configure OT/J-specific compiler diagnostics as "ignore", "warning" or "error".<br/>
68 Any warnings configured on this property sheet can also be suppressed in the
69 source code using the <code>@SuppressWarnings</code> annotation.</li>
70 <li>Scoped keywords <a href="otjld/def/sA.html#sA.0.1"><img alt="otjld" src="../images/ot_paragraph.png"/> OTJLD &#167; A.0.1</a> can be disabled (default is enabled).
71 </li>
Stephan Herrmann01664412010-04-01 20:28:43 +000072 </ul>
73 </dd>
Stephan Herrmann01664412010-04-01 20:28:43 +000074 </dl>
75
76 <div id="wizards" class="headl"><div class="headr">
77 <h1>Wizards</h1>
78 </div></div>
79 <ul>
80
Stephan Herrmann7736a712010-07-01 16:47:30 +000081 <li>The first step to developing with Object Teams in Eclipse is creating an <img class="inline" alt="" src="../images/newprj_wiz.gif"/><code>&nbsp;Object&nbsp;Teams&nbsp;Project</code>. A wizard will guide you through that process. It will also add the Object Teams Runtime Environment (<tt>otre.jar</tt>) to your project's classpath.
Stephan Herrmann01664412010-04-01 20:28:43 +000082 </li>
83
84 <li>
85
86 Having done that, you can start adding classes &mdash; be it regular classes, or <img class="inline" alt="" src="../images/team_obj.gif"/> team or <img class="inline" alt="" src="../images/role_obj.png"/> role classes &mdash; wizards will assist you in creating the classes properly.
87 </li>
88 </ul>
89
90
91 <div id="editor" class="headl"><div class="headr">
92 <h1>Editor</h1>
93 </div></div>
94 <ul>
95
96 <li>Editing Object Teams source code is supported by an outline view, showing the structure of the edited source file. This includes the Object Teams specific constructs,
97 <em>teams</em> (<img class="inline" alt="" src="../images/team_obj.gif"/>),
98 <em>roles</em> (<img class="inline" alt="" src="../images/role_obj.png"/>),
99 and <em>method bindings</em> (<img class="inline" alt="" src="../images/callinbindingbefore_obj.gif"/>,
100 <img class="inline" alt="" src="../images/callinbindingreplace_obj.gif"/>,
101 <img class="inline" alt="" src="../images/callinbindingafter_obj.gif"/>,
102 <img class="inline" alt="" src="../images/calloutbinding_obj.gif"/>).</li>
103
104 <li>The editor highlights the Object Teams keywords like "<code class="keyword">team</code>" the same way standard Java keywords are highlighted.</li>
105 <li>All constructs referencing other code elements are navigable. E.g. you can navigate <tt>super()</tt>, <tt>tsuper()</tt>, <tt>base()</tt> calls, as well as <em>callin</em> and <em>callout bindings</em>.
106 The name in a <code class="keyword">team package</code> declaration lets you navigate from a role file
107 (<a href="otjld/def/s1.html#s1.2.5"><img alt="otjld" src="../images/ot_paragraph.png"/> OTJLD &#167; 1.2.5</a>) to its enclosing team.</li>
108
109 <li>Classes to which one or more roles are bound using <code class="keyword">playedBy</code> are
110 annotated with a marker (<img class="inline" alt="" src="../images/playedBy_obj.gif"/>),
111 that allows navigating to the role declaration(s).
112 Similarly, methods in a base class that are bound with a <em>callin binding</em> are
113 annotated with a marker (<img class="inline" alt="" src="../images/callinbinding_obj.gif"/>),
114 that allows navigating to the method binding declaration(s).
115
116 <br/>
117 Because this feature may be resource-consuming in a large workspace the global Object Teams preferences page allows to completely disable the generation of callin markers.</li>
118
119 <li>Semantic highlighting (checkbox "mark occurrences") is fully supported.</li>
120 <li>Code completion (Ctrl-space) is widely supported. It is, e.g., possible to use completion in order to create a callout binding.</li>
121 <li>Content assist provides quick-fixes (Ctrl-1) for a number of OT/J specific errors and warnings.
122 Also a few templates for specific OT/J language constructs &mdash;
123 namely <code>with{}</code> and <code>within (<em>Expression</em>){}</code> &mdash; are available.</li>
124 </ul>
125
126 <div id="bindingEditor" class="headl"><div class="headr">
127 <h1>Binding Editor</h1>
128 </div></div>
129 <ul>
130 <li>Supports easy creation of connector definitions using a table based graphical user interface. In this context, a <b>connector</b> is meant to be a team that inherits structure
131 (roles) and functionality (methods) from its super-team, and its main purpose is to bind
132 the inherited structure and functionality using <code class="keyword">playedBy</code>
133 declarations and callin/callout method bindings.</li>
134 <li>Type bindings (<code class="keyword">playedBy</code>) can be defined by choosing a provided role type and the desired base type with a type selection dialog.</li>
135 <li>Method bindings (either callin or callout) can be established by choosing a role method and a base method from the provided role and base method list respectively.
136 <ul>
137 <li>Only appropriate binding kinds are selectable in the corresponding context (callin or callout).</li>
138 <li>Besides the provided role methods, a new role method can be implemented by selecting a provided base method, thus creating a callout binding.</li>
139 </ul>
140 </li>
141 <li>Parameter and result mappings are definable by typing in an expression in the corresponding text field of the parameter mapping configuration tab.</li>
142 </ul>
143 The binding editor can be opened either from the new team wizard or using the package explore's context menu (<code><img class="inline" alt="" src="../images/calloutbinding_obj.gif"/>&nbsp;Open&nbsp;Binding&nbsp;Editor</code>).
144 <p></p>
145 <div id="refactoring" class="headl"><div class="headr">
146 <h1>Refactoring</h1>
147 </div></div>
148 <p></p>
Stephan Herrmann01664412010-04-01 20:28:43 +0000149 Significant work has been put into supporting the automated refactoring of OT/J code.
150 The following refactorings take into account the Object Teams-specific
151 relationships (implicit role inheritance, team nesting, role-base bindings and method
152 bindings).
153 <ul>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000154 <li><b>Extract Method</b></li>
155 <li><b>Move Method</b></li>
156 <li><b>Pull Up</b> applicable to method or field</li>
157 <li><b>Push Down</b> applicable to method or field</li>
158 <li><b>Rename</b> applicable to: project, source folder, package, type, method, field.<br/>
159 <i>When trying to rename a team package you'll be asked to rename the team class instead.</i></li>
Stephan Herrmann01664412010-04-01 20:28:43 +0000160 </ul>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000161 Additionally, specific refactorings for OT/J are being developed. Currently these are implemented:
162 <ul>
163 <li><b>Extract Callin</b></li>
164 <li><b>Inline Callin</b></li>
165 </ul>
Stephan Herrmann01664412010-04-01 20:28:43 +0000166 <p></p>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000167
Stephan Herrmann01664412010-04-01 20:28:43 +0000168
169 <div id="structureViewers" class="headl"><div class="headr">
170 <h1>Structure Viewers</h1>
171 </div></div>
172 <dl>
173 <dt><strong>The Package Explorer</strong></dt>
174 <dd>
175 <ul>
176 <li>
177 provides access to all project artifacts and their structure, i.e. source files, used libraries (<em>jar</em>-files), and other documents. Note that team and role classes are annotated with distinct icons (<img class="inline" alt="" src="../images/team_obj.gif"/> for teams and <img class="inline" alt="" src="../images/role_obj.png"/> for roles). (The same icons are used throughout the IDE, whenever a team or role is visible.)
178 </li>
179 <li>
180 If "Java Type Indicators" is enabled under general preferences/label decorations, OT-specific decorations will also be applied to compilation units (files) and team packages.
181 </li>
182 <li>
183 By opening the tree-branches, you can peek at the structure of e.g. classes.
184 </li>
185 <li>For team classes, there is special support for <b>role files</b> (<a href="otjld/def/s1.html#s1.2.5"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 1.2.5</a>):<br/>
186 Role files are separate files and can be shown either
187 <em>physically</em> (<img class="inline" alt="" src="../images/team_package.gif"/>) as (separate) files in the team package or
188 <em>logically</em> (<img class="inline" alt="" src="../images/external_roles.gif"/>) as member types of the enclosing team.
189 </li>
190 <li>
191 Furthermore, the Package Explorer provides the current context for other operations. The Team- and Role-Wizards, for example, have a pre-set source folder, package and enclosing class when a team is selected in the Package Explorer.
192 </li>
193 </ul></dd>
194 <dt><strong>The Hierarchy View</strong></dt>
195 <dd><ul>
196 <li>Object Teams intruduce a new type hierarchy. Besides the normal ("<code>extends</code>") inheritance, there is an additional "<em>implicit</em>" role inheritance, established by role name equality in a team hierarchy. In conjunction with team nesting roles support a controlled form of multiple inheritance.
197 </li>
198 <li>
199 The new implicit inheritance has been integrated completely into the standard JDT
200 <em>Hierarchy View</em>.
Stephan Herrmann01664412010-04-01 20:28:43 +0000201 </li>
202 </ul></dd>
203 </dl>
204
205
206 <div id="search" class="headl"><div class="headr">
207 <h1>Search</h1>
208 </div></div>
209 <p></p>
210 <dl>
211 <dt><strong>Search references</strong></dt>
212 <dd><ul><li>The Java Search functionality has been extended to include search results of
213 Object Teams code, that is, callin and callout bindings, and
214 playedBy-relationships.</li></ul></dd>
215 <dt><strong>Call hierarchy</strong></dt>
216 <dd><ul><li>Also the call hierarchy has been extended for browsing control flows passing
217 through method bindings (callin and callout).</li>
218 <li>The OTDT introduced support for call hierarchies regarding field accesses (read, write, any) and class instantiations. As of version 3.4 this functionality has been adopted by Eclipse.</li>
Stephan Herrmann2be84c12012-06-04 01:02:48 +0200219 <li>OT/J constructs that may cause role creation due to lifting are considered by the call hierarchy as calling the role's lifting constructor.</li>
Stephan Herrmann01664412010-04-01 20:28:43 +0000220 </ul>
221 </dd>
222 </dl>
223 <p></p>
224
225 <div id="execution" class="headl"><div class="headr">
226 <h1>Execution Environment</h1>
227 </div></div>
228 <dl>
229 <dt><strong>Aspect weaving</strong></dt><dd>
230 <ul><li>
231 All aspect oriented languages have some kind of <em>weaving process</em>, where the aspect code is combined with the other (<em>base</em>) code.
232 </li>
233 <li>
Stephan Herrmann2be84c12012-06-04 01:02:48 +0200234 Object Teams programs perform the weaving at application <em>startup time</em>, i.e. at the moment, the program is launched. In order to do this, there is the so-called <em>Object Teams Runtime Environment (OTRE)</em>, that hooks into the class-loading process.
Stephan Herrmann01664412010-04-01 20:28:43 +0000235 </li>
236 <li>
237 All this is handled transparently using the standard Eclipse "Run" feature.
238 Running any main class of an Object Teams project automatically includes
239 the OTRE (This feature has been <a href="new_in_1.3.html#launch">changed in the OTDT 1.2.2</a>).
240 </li>
241 </ul></dd>
242 <dt><strong>Aspect deployment/activation</strong></dt>
243 <dd><ul>
244 <li>A new "Team Activation" tab in the "Run-Configuration" allows to instantiate and activate teams without modifying the program's source code.
245 </li>
246 <li>
247 Teams that cause aspect code to be woven into an application can be added to a program
248 <ul>
249 <li> by explicit reference within the program source code or</li>
250 <li> by a configuration file which is mentioned as a parameter to the VM or</li>
251 <li> by adding them via the aforementioned "Team Activation" tab.</li>
252 </ul>
253 No such configuration is needed for compilation.
254 </li>
255 </ul>
256 </dd>
257 <dt><strong>Technology used</strong></dt>
258 <dd><ul>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000259 <li id="JPLIS">Integrating the weaver into the JVM leverages the Java-agent concept of Java 5
260 (<a href="http://java.sun.com/developer/technicalArticles/releases/j2se15/index.html">JPLIS</a>).
261 (<i>The original implementation using the JMangler framework is no longer maintained</i>).<br/>
262 In the future this integration will support aspect weaving not only at load time
263 but also while an application is running.
Stephan Herrmann01664412010-04-01 20:28:43 +0000264 </li>
265 </ul></dd>
266 </dl>
267 <p></p>
268
269 <div id="otequinox" class="headl"><div class="headr">
270 <h1>OT/Equinox</h1>
Stephan Herrmann01664412010-04-01 20:28:43 +0000271 </div></div>
272 <p></p>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000273 Starting with the OTDT version 0.9.9 (2006) it is possible to develop Eclipse plugins using
Stephan Herrmann01664412010-04-01 20:28:43 +0000274 OT/J as the implementation language.
275 <ul>
276 <li>Using the plugin <code>org.eclipse.objectteams.otequinox</code>, a plugin ("aspect plugin")
277 may declare that it adapts classes from a specified other plugin ("base plugin").</li>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000278 <li>By an integration of the Object Teams Runtime Environment with hooks in the
Stephan Herrmann01664412010-04-01 20:28:43 +0000279 Equinox implementation a <code class="keyword">team</code> class from an <em>aspect plugin</em>
280 can trigger byte-code aspect weaving into its <em>base plugin</em> at load-time.
281 As a result an aspect plugin can indeed adapt the behaviour of another plugin.
282 These bindings are declared using the extension point <code>aspectBindings</code> from
283 the mentioned plugin <code>org.eclipse.objectteams.otequinox</code>.</li>
284 <li>The initial client of the OT/Equinox technology is a tiny plugin which extends Eclipse's
285 "about plugins" dialog by additionally displaying which plugins are being adapted by
286 which aspect plugins. This information is found in the version column of the mentioned dialog.
287 This way a user of the OTDT can always check whether a given plugin performs as shipped,
288 or whether it has been adapted by another plugin.</li>
Stephan Herrmann7736a712010-07-01 16:47:30 +0000289 <li>The OTDT uses the capabilities of OT/Equinox for its own implementation.
Stephan Herrmann01664412010-04-01 20:28:43 +0000290 The technology is mainly used for making the JDT-UI aware of Object Teams without having
291 to copy source code or modifying source code of the JDT-UI in place.</li>
292 <li>A new project nature <img class="inline" alt="" src="../images/newpprj_wiz.gif"/>
293 <code>Object Teams Plugin Project</code> is provided, supporting the
294 development of plugins written in OT/J.</li>
295 <li>Support for OT/Equinox is added to the run/debug dialogs for all Equinox related launches.</li>
296 <li>If desired the load-time weaver can be disabled by commenting out or removing the following
297 line from the file <code>configuration/config.ini</code>:
298 <div class="ttindent" style="font-size:small;">
Stephan Herrmann7736a712010-07-01 16:47:30 +0000299 osgi.hook.configurators.include=org.eclipse.objectteams.otequinox.hook.HookConfigurator</div>
Stephan Herrmann01664412010-04-01 20:28:43 +0000300 Ideally, disabling OT/Equinox will be handled by temporarily uninstalling this feature,
301 but the required support by the p2 provisioning system is not yet stable enough to do this.</li>
302 </ul>
303 <p></p>
304
305 <div id="debugging" class="headl"><div class="headr">
306 <h1>Debugging</h1>
307 </div></div>
308 <p></p>
309 The debugger has been enhanced to support debugging of OT/J programs at the
310 source code level. It is possible to set breakpoints and step through Object Teams code.
311
312 <dl>
313 <dt><b>Stepping through Code</b></dt>
314 <dd>The following language features produce byte codes for which a standard Java debugger
315 is not able to display appropriate source locations:
316 <ul>
317 <li>Role files (<a href="otjld/def/s1.html#s1.2.5"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 1.2.5</a>)</li>
318 <li>Implicit inheritance (<a href="otjld/def/s1.html#s1.3.1"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 1.3.1</a>)</li>
319 <li>Callout bindings (<a href="otjld/def/s3.html"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 3</a>)
320 (including callout override (<a href="otjld/def/s3.html#s3.1.e"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 3.1(e)</a>))</li>
321 <li>Callin bindings (<a href="otjld/def/s4.html"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 4</a>)</li>
322 </ul>
323 The OTDT-Debugger re-maps the byte codes produced by all this constructs to the
324 appropriate source locations.
325 As a result stepping through these sections of a program completely hides
326 the internal translations from the user.<p></p>
327 The following features are not yet fully supported by the debugger:
328 <ul>
329 <li>Role constructors (see <a href="otjld/def/s2.html#s2.4"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 2.4</a>)</li>
330 <li>Parameters with declared lifting (<a href="otjld/def/s2.html#s2.3.2"><img alt="" src="../images/ot_paragraph.png"/>
331 OTJLD &sect; 2.3.2</a> &mdash; code for lifting is not filtered out yet)</li>
332 </ul></dd>
333 <dt><b>Setting Breakpoints</b></dt>
334 <dd>Use double click on ruler or context menu <code>Toggle Breakpoint</code> to set
335 breakpoints in OT/J-Code. Setting breakpoint in role files is supported, too.</dd>
336 <dt id="team_monitor"><b>New View: "Team Monitor"</b></dt>
337 <dd>The team monitor (<img src="../images/tm.gif" alt="" class="inline"/>)
338 view helps to debug issues related to team activation
339 (<a href="otjld/def/s5.html#s5"><img alt="" src="../images/ot_paragraph.png"/> OTJLD &sect; 5</a>).
340 For this purpose it displays all known team instances and shows their activation status as one of
341 <ul>
342 <li>inactive <img src="../images/team_inact.gif" alt="" class="inline"/>,</li>
343 <li>active <img src="../images/team_act.gif" alt="" class="inline"/>
344 (either globally or for the thread selected in the debug view), or</li>
345 <li>implicitly active
346 <img src="../images/team_act_implicit.gif" alt="" class="inline"/>
347 (temporarily active because the team or one of its roles is currently executing code).
348 </li></ul>
349 Also, a selected team can be (de)activated interactively via the context menu.</dd>
350 <dt id="variables_filter"><b>Filtering variables</b></dt>
351 <dd>The OT/J compiler and the loadtime weaver both add some internal variables to the code.
352 By default such internal variables are hidden within the Team Monitor as well
353 as in the standard variables view. Both views can be configured to also show these internal
354 variables if so desired.</dd>
355 <dt><b>Known Issues and Limitations</b></dt>
356 <dd><ul>
357 <li>Dynamic code evaluation is not supported yet,
358 make sure to clear the Expression view.</li>
Stephan Herrmann01664412010-04-01 20:28:43 +0000359 </ul></dd>
360 </dl>
361
362 <div id="help" class="headl"><div class="headr">
363 <h1>Help and additional Information</h1>
364 </div></div>
365 <p></p>
366 The following sources for help and for further information are bundled with the release:
367 <ul>
368 <li>A Tutorial (available via the welcome page) guiding through the first steps of using the OTDT.</li>
369 <li>Example programs demonstrating key features of Object Teams (also via the welcome page).</li>
370 <li>A detailed <a href="guide/webindex.html">guide</a> on using the OTDT via the Help Index, including a link to the
371 language definition (which is also bundled).</li>
372 <li>Problems that are listed in the problem view are linked (when possible) to a corresponding explanatory entry in the language definition.
373 (Context menu -&gt; <img alt="" src="../images/ot_paragraph.png"/><code>&nbsp;Go&nbsp;to&nbsp;Language&nbsp;Definition</code>).</li>
374 </ul>
Stephan Herrmann01664412010-04-01 20:28:43 +0000375 </div><!-- content -->
376 </body>
377</html>