Eclipse Code Recommenders. Do you s/ll read [source code]? Or are you programming already? Eclipse Day Del,

Transcription

1 Eclipse Code Recommenders Do you s/ll read [source code]? Or are you programming already? Eclipse Day Del,

2 about.me/mbruch Project Lead of Eclipse Code Recommenders Project Researcher at Darmstadt University of Technology, Eclipse 4 Trainer at vogella.com, Speaker at JavaOne, JAX, EclipseCon US/EU, CEO of Codetrails GmbH in progress (commercial support for Code Recommenders) 2

3 3

4 Project History: Started in 2006 as Framework Understanding Tool - or FrUiT for short Published in 2009 as Eclipse Code Recommenders Became an Eclipse Incubator Project in 2011 Graduated in June own Incubator Part of Eclipse Juno (4.2) - Java and RCP Developer Package Eclipse Marketplace Top 100 3

5 Project History: Started in 2006 as Framework Understanding Tool - or FrUiT for short Published in 2009 as Eclipse Code Recommenders Became an Eclipse Incubator Project in 2011 Graduated in June own Incubator Part of Eclipse Juno (4.2) - Java and RCP Developer Package Eclipse Marketplace Top 100 Awards: Eclipse Community Award as Most InnovaSve Eclipse Project 2012 GFFT Förderpreis für Hervorragende InnovaSonen 2012 Uni- TechSpin IdeenweYbewerb 2010 IBM InnovaSon Award 2006 Nominee JAX InnovaSon Award

6 4

7 Eclipse Code Recommenders All Frameworks Code Code Eclipse Code Recommenders Developers Who Called new Text() Method Also Called settext() addlistener() setlayout() setfont() 89% 53% 99% 35% What Do Developers Ultimately Override After Extending This Class? 100 % overwrote PreferencePage.createContents() 96 % overwrote PreferencePage.performOk() 5 % overwrote PreferencePage.performCancel() 5

8 Other developers frequently bought used the following methods INTELLIGENT CODE COMPLETION

9 Code protected Control createdialogarea(final Composite parent) { Composite container = (Composite) super.createdialogarea(parent); } swttextwidget = new Text(container, SWT.BORDER); swttextwidget. return container; What does the developer need, i.e., which methods should the code comple/on present to the user? 7

10

11 All 164 Methods of Text?

12 JBuVon? 381 Methods.

13 Code protected Control createdialogarea(final Composite parent) { Composite container = (Composite) super.createdialogarea(parent); } swttextwidget = new Text(container, SWT.BORDER); swttextwidget. return container; What does the developer need, i.e., which methods should the code comple/on present to the user? 10

14 Intelligent Code CompleSon or just the three missing ones? 11

15 Oh SWT - your style bits... RETHINKING ARGUMENT GUESSING

16 Oh SWT, your style protected Control createcontrol(final Composite parent) {!! textwidget = new Text(parent, SWT.BORDER);!! textwidget.addlistener(eventtype, listener) Which event type, i.e., which int constant defined somewhere, should he insert here? 0? 13

17

18 SWT.<^Space>? 454

19 SWT.<^Space>? 454 ± 3

20 What you d like to see protected Control createcontrol(final Composite parent) {!! textwidget = new Text(parent, SWT.BORDER);!! textwidget.addlistener(swt.modify, listener) 15

21 BecausePureCamelCaseMatching****s! SUBWORDS COMPLETION

22 Use speaking names...?

23 When leyers become just guidelines... Source: hyp://vimeo.com/ I Like? 18

24 When leyers become just guidelines... Source: hyp://vimeo.com/ I Like? 18

25 Welcome to the jungle... CALL- CHAIN COMPLETION

26 How to obtain an instance of... public class MyView extends ViewPart { public void updatemessage(final String newmessage) { } // How do I get an instance of IStatusLineManager? final IStatusLineManager manager = There is no trivial solution anymore. Again, what should code completion return?

27 What we need... ViewPart public void updatemessage(final String newmessage) { getviewsite() } // How do I get an instance of final IStatusLineManager manager = this.getviewsite().getactionbars().getstatuslinemanager(); manager.setmessage(newmessage); IViewSite getac-onbars() IAc-onBars getstatuslinemanager() IStatusLineManager 21

28 ViewPart Image IConfigura9onElemen IWorkbenchPartSite IViewSite Color ImageData Device Rectangle IContributor IExtension Shell IWorkbenchPart IKeyBindingService IWorkbenchPage ISelec9onProvider IWorkbenchWindow IAc9onBars Point Region Composite Menu Listener Layout IME Display ScrollBar Control IEditorPart IMenuManager IServiceLocator IAdaptable ISelec9on IWorkbenchWindow INaviga9onHistory IWorkingSet IExtensionTracker IViewReference IViewPart IEditorReference IPartService IWorkbench ISelec9onService IServiceLocator IMenuManager IStatusLineManager IAc9on IToolBarManager

29 However, somesmes you get... Here, implicit user feedbacks ( clicks ) help to find the right (i.e. the most commonly used ) paths.

30 Developers who bought overwrote this method typically also overwrote... EXTENDING API DOCUMENTATION

31 In good documentason we trust... /** * Rollsback the transaction if any and clears different lists to * start with an empty resource again. * Note that the super.dounload is not called because that clears * the list resulting in all kinds of undesirable inverseremoves. protected void dounload() { super.dounload(); } 25

32 In good documentason we trust... /** * Rollsback the transaction if any and clears different lists to * start with an empty resource again. * Note that the super.dounload is not called because that clears * the list resulting in all kinds of undesirable inverseremoves. protected void dounload() { super.dounload(); } 25

33 In good documentason we trust... /** * Rollsback the transaction if any and clears different lists to * start with an empty resource again. * Note that the super.dounload is not called because that clears * the list resulting in all kinds of undesirable inverseremoves. protected void dounload() { super.dounload(); } No? Are you sure? 25

34 In good documentason we trust... /** * Rollsback the transaction if any and clears different lists to * start with an empty resource again. * Note that the super.dounload is not called because that clears * the list resulting in all kinds of undesirable inverseremoves. protected void dounload() { super.dounload(); } No? Are you sure? 25

35 GeneraSng high- quality API documentason 26

36 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

37 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

38 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

39 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

40 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

41 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

42 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 26

43 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 27

44 GeneraSng high- quality API documentason /** * The number of questions. */ private int numberofquestions; /** * Sets the number of questions. * numberofquestions the number of questions IllegalArgumentException the illegal argument exception */ public void setnumberofquestions(int numberofquestions) throws IllegalArgumentException { if (numberofquestions < 0) { throw new IllegalArgumentException("numberOfQuestions < 0"); } this.numberofquestions = numberofquestions; } 27

45 What people say about JAutodoc... 28

46 What people say about JAutodoc... User: Anonymous Rating: :32:37 Wow exactly what I needed! 28

47 What people say about JAutodoc... User: Anonymous Rating: :32:37 Wow exactly what I needed! User: Anonymous Rating: :58:32 Thank you... this plugin rocks! 28

48 What people say about JAutodoc... User: Anonymous Rating: :32:37 Wow exactly what I needed! User: Anonymous Rating: :58:32 Thank you... this plugin rocks! User: Anonymous Rating: :58:32 Works perfectly. Smarter than I expected! 28

49 What people say about JAutodoc... User: Anonymous Rating: :32:37 Wow exactly what I needed! User: Anonymous Rating: :58:32 Thank you... this plugin rocks! User: Anonymous Rating: :58:32 Works perfectly. Smarter than I expected! WTH? What did you expect?! 28

50 How Recommenders is coming to rescue... 29

51 What documentason would you expect when subclassing Dialog? package org.eclipse.recommenders.examples.demo; import org.eclipse.jface.*; public class MyDialog extends Dialog { } protected MyDialog(final IShellProvider parentshell) { super(parentshell); } 30

52 What Javadoc gives you... org.eclipse.jface.dialogs.dialog 31

53 What Javadoc gives you... org.eclipse.jface.dialogs.dialog A dialog is a specialized window used for narrow- focused communicason with the user. 31

54 What Javadoc gives you... org.eclipse.jface.dialogs.dialog A dialog is a specialized window used for narrow- focused communicason with the user. Dialogs are usually modal. Consequently, it is generally bad pracsce to open a dialog without a parent. A modal dialog without a parent is not prevented from disappearing behind the applicason's other windows, making it very confusing for the user. 31

55 What Javadoc gives you... org.eclipse.jface.dialogs.dialog A dialog is a specialized window used for narrow- focused communicason with the user. Dialogs are usually modal. Consequently, it is generally bad pracsce to open a dialog without a parent. A modal dialog without a parent is not prevented from disappearing behind the applicason's other windows, making it very confusing for the user. If there is more than one modal dialog is open the second one should be parented off of the shell of the first one otherwise it is possible that the OS will cus to the first dialog potensally blocking the UI. 31

56 What Javadoc gives you... org.eclipse.jface.dialogs.dialog A dialog is a specialized window used for narrow- focused communicason with the user. Dialogs are usually modal. Consequently, it is generally bad pracsce to open a dialog without a parent. A modal dialog without a parent is not prevented from disappearing behind the applicason's other windows, making it very confusing for the user. But what are the hot-spots of Dialog? If there is more than one modal dialog is open the second one should be parented off of the shell of the first one otherwise it is possible that the OS will cus to the first dialog potensally blocking the UI. 31

57 What code compleson offers... 32

58 What code compleson offers... Which of the 56 methods should we override? 32

59 Recommending method overrides... public class MyDialog extends Dialog { 33

60 Recommending Self- Calls public class MyWizard extends Wizard public void addpages() { }; 34

61 Mining for Subclassing payerns public class MyViewerSorter extends ViewerComparator { 35

62 Mining example code snippets public class MyDialog extends Dialog protected Control createdialogarea(composite parent) { 36

63 Extended (API) DocumentaSon 37

64 So Code Recommenders is mining code repositories. Why do you call it IDE IDE AMAZON FOR SOFTWARE DEVELOPERS

65 So much code out there that shows how to use an API correctly... ❶ Analyze source code ❷ Mine data, extract code payerns, create recommendason models Code Recommenders Knowledge Base ❸ deliver mined knowledge to Eclipse users 39

66 but in future we could leverage... 40

67 but in future we could leverage... project environment 40

68 but in future we could leverage... context project environment 40

69 but in future we could leverage... context object usage project environment 40

70 but in future we could leverage... context object usage project environment selected proposals 40

71 but in future we could leverage... context object usage project environment selected proposals click feedback 40

72 but in future we could leverage... context object usage project environment selected proposals click feedback stacktraces 40

73 Leverage what happens in your IDE to build IDE 2.0. That s Amazon for Soqware Developers! Code Recommenders Knowledge Base ❹ users share implicit usage data (clicks, selecsons, stacktraces...) 41

74 Crowd- sourcing... 42

75 Code Recommenders is... Intelligent Code CompleSon Usage- Driven Javadocs Stacktrace Search Engine Smart Bug DetecSon Code Example Recommender What have I missed? x= What caused that stacktrace? How do I get an instance of? 43

76 Q & A 44

77 hyp://eclipse.org/recommenders/ Follow me on google+: +Marcel Bruch 45