Slide 1
Slide 1 text
What’s the big IDEA?
@strongolopolis @egorand
|
Writing IntelliJ plugins for Kotlin
Slide 2
Slide 2 text
Life without IDEs
Slide 3
Slide 3 text
Writing Code
• Autocompletion
• Error highlighting
• Autoimports
• Refactoring tools
Slide 4
Slide 4 text
• Switching to a different window
• Memorizing the commands
• Error reporting
Running Code
Slide 5
Slide 5 text
Debugging?
Profiling?
Slide 6
Slide 6 text
No content
Slide 7
Slide 7 text
Plugins
Slide 8
Slide 8 text
No content
Slide 9
Slide 9 text
Gradle
Slide 10
Slide 10 text
Gradle
Slide 11
Slide 11 text
Gradle
Slide 12
Slide 12 text
Plugins
• Developer experience
• Simplify how you interact with code
• Problems you can’t solve with code
• Demystifying confusing parts
• e.g. concurrency
Slide 13
Slide 13 text
Plugins that we use
(and love)
Slide 14
Slide 14 text
SQLDelight
Slide 15
Slide 15 text
Android
Slide 16
Slide 16 text
Plugins that we want
Slide 17
Slide 17 text
Wire
Slide 18
Slide 18 text
Dagger (for Kotlin)
Slide 19
Slide 19 text
Writing one
Slide 20
Slide 20 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Slide 21
Slide 21 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Slide 22
Slide 22 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
Slide 23
Slide 23 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
• Fields
Slide 24
Slide 24 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
• Fields
• Annotations
Slide 25
Slide 25 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
• Fields
• Annotations
Types
Slide 26
Slide 26 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
• Fields
• Annotations
Types
Expressions
Slide 27
Slide 27 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.printlnd();
}
}
Imports
Classes
• Fields
• Annotations
Types
Expressions
Identifiers
Slide 28
Slide 28 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Imports
Classes
• Fields
• Annotations
Types
Expressions
Identifiers
Tokens
Slide 29
Slide 29 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
Imports
Classes
• Fields
• Annotations
Types
Expressions
Identifiers
Tokens
Psi
Psi
Psi
Psi
Psi
Psi
Psi
Psi
Slide 30
Slide 30 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
PsiImports
PsiClasses
PsiFields
PsiAnnotations
PsiTypes
PsiExpressions
PsiIdentifiers
PsiTokens
Slide 31
Slide 31 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
PsiJavaToken
Slide 32
Slide 32 text
PsiJavaToken : PsiElement
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
Slide 33
Slide 33 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
PsiWhitespace : PsiElement
Slide 34
Slide 34 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
PsiType
Slide 35
Slide 35 text
PsiElementType : PsiElement
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Slide 36
Slide 36 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
val typeElement: PsiTypeElement
val type: PsiType = typeElement.type
Slide 37
Slide 37 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
val typeElement: PsiTypeElement
val type: PsiJavaCodeReferenceElement? =
typeElement.innermostComponentReferenceElement
Slide 38
Slide 38 text
PsiJavaCodeReferenceElement
: PsiElement, PsiReference
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
String
Slide 39
Slide 39 text
public interface PsiReference {
/**
* Returns the underlying (referencing) element of the reference.
*
* @return the underlying element of the reference.
*/
@NotNull
PsiElement getElement();
}
Slide 40
Slide 40 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
PsiJavaCodeReferenceElement
: PsiElement, PsiReference
Slide 41
Slide 41 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}A
}A
Slide 42
Slide 42 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
PsiFile : PsiElement
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}A
}A
Slide 43
Slide 43 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}A
}A
PsiViewer
Slide 44
Slide 44 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
PsiJavaFile : PsiElement
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}A
}A
Slide 45
Slide 45 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val element: PsiElement
val file: PsiFile = element.containingFile
Slide 46
Slide 46 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val file: PsiJavaFile
Slide 47
Slide 47 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val file: PsiJavaFile
val classes: Array = file.classes
Slide 48
Slide 48 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val file: PsiJavaFile
val classes: Array = file.classes
val fields: List = classes.flatMap { it.fields.asList() }
Slide 49
Slide 49 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val file: PsiJavaFile
val classes: Array = file.classes
val fields: List = classes.flatMap { it.fields.asList() }
val injectedFields = fields
.filter { it.hasAnnotation(“javax.inject.Inject") }
Slide 50
Slide 50 text
import javax.inject.Inject;
class SomeClass {A
@Inject String injectedString;
private void someMethod() {A
System.out.println(injectedString);
}A
}A
val file: PsiJavaFile
val classes = Array = file.classes
val fields: List = classes.flatMap { it.fields.asList() }
val injectedFields = fields
.filter { it.hasAnnotation(“javax.inject.Inject") }
val file: PsiJavaFile
Slide 51
Slide 51 text
Application
Slide 52
Slide 52 text
Project
Slide 53
Slide 53 text
Module
Slide 54
Slide 54 text
VirtualFile
Slide 55
Slide 55 text
Document
Slide 56
Slide 56 text
Editor
Slide 57
Slide 57 text
Editor Document
val editor: Editor
val document: Document = editor.document
Slide 58
Slide 58 text
Document
val document: Document
val virtualFile: VirtualFile =
FileDocumentManager.getInstance().getFile(document)
VirtualFile
Slide 59
Slide 59 text
VirtualFile
val virtualFile: VirtualFile
val document: Document =
FileDocumentManager.getInstance().getDocument(virtualFile)
Document
Slide 60
Slide 60 text
VirtualFile
val virtualFile: VirtualFile
val cachedDocument: Document =
FileDocumentManager.getInstance().getCachedDocument(virtualFile)
Document
Slide 61
Slide 61 text
java.io.File
val file: File
val virtualFile: VirtualFile =
LocalFileSystem.getInstance().findFileByIoFile(file)
VirtualFile
Slide 62
Slide 62 text
VirtualFile
val virtualFile: VirtualFile
val psiFile: PsiFile =
PsiManager.getInstance(project).findFile(virtualFile)
PsiFile
Slide 63
Slide 63 text
val virtualFile: VirtualFile
val psiFile: PsiFile =
PsiManager.getInstance(project).findFile(virtualFile)
VirtualFile
val virtualFile: VirtualFile
val psiFile: PsiFile =
PsiManager.getInstance(project).findFile(virtualFile)
PsiFile
Slide 64
Slide 64 text
plugin.xml
Slide 65
Slide 65 text
com.squareup.ideaplugin.dagger
Dagger Plugin
2.0.0
Square, Inc.
org.jetbrains.kotlin
Slide 66
Slide 66 text
com.squareup.ideaplugin.dagger
Dagger Plugin
2.0.0
Square, Inc.
org.jetbrains.kotlin
com.squareup.ideaplugin.dagger
Dagger Plugin
2.0.0
Square, Inc.
org.jetbrains.kotlin
Slide 67
Slide 67 text
com.squareup.ideaplugin.dagger
Dagger Plugin
2.0.0
Square, Inc.
org.jetbrains.kotlin
Slide 68
Slide 68 text
com.squareup.ideaplugin.dagger
Dagger Plugin
2.0.0
Square, Inc.
org.jetbrains.kotlin
com.squareup.idea.dagger.DaggerProjectComponent
com.squareup.idea.dagger.DaggerProjectComponent
Slide 69
Slide 69 text
class DaggerProjectComponent : ProjectComponent {A
override fun projectOpened() {A
println("Hello World!")
}A
override fun projectClosed() {A
println("Goodbye!")
}A
}A
Slide 70
Slide 70 text
class DaggerProjectComponent(
private val project: Project
) : ProjectComponent {A
override fun projectOpened() {A
println("Hello World!")
}A
override fun projectClosed() {A
println("Goodbye!")
}A
}A
Slide 71
Slide 71 text
com.squareup.idea.dagger.DaggerProjectComponent
Slide 72
Slide 72 text
com.squareup.idea.dagger.DaggerProjectComponent
Slide 73
Slide 73 text
class InjectionLineMarkerProvider : LineMarkerProvider {
override fun getLineMarkerInfo(
element: PsiElement
): LineMarkerInfo<*>? {
...
}
}
Slide 74
Slide 74 text
PSI in mixed codebases
Slide 75
Slide 75 text
import javax.inject.Inject;
class SomeClass {
@Inject String injectedString;
private void someMethod() {
System.out.println(injectedString);
}
}
Slide 76
Slide 76 text
import javax.inject.Inject
class SomeClass {
@Inject var injectedString: String? = null
private fun someMethod() {
println(injectedString)
}
}
Slide 77
Slide 77 text
No content
Slide 78
Slide 78 text
public class InjectionLineMarkerProvider implements LineMarkerProvider {
public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
…
} else if (element instanceof PsiField) {
// Field injection.
PsiField fieldElement = (PsiField) element;
PsiTypeElement typeElement = fieldElement.getTypeElement();
…
}
return null;
}
Slide 79
Slide 79 text
No content
Slide 80
Slide 80 text
public class InjectionLineMarkerProvider implements LineMarkerProvider {
public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
…
} else if (element instanceof PsiField) {
// Field injection.
PsiField fieldElement = (PsiField) element;
PsiTypeElement typeElement = fieldElement.getTypeElement();
…
}
return null;
}
Slide 81
Slide 81 text
No content
Slide 82
Slide 82 text
No content
Slide 83
Slide 83 text
public class InjectionLineMarkerProvider implements LineMarkerProvider {
public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
…
} else if (element instanceof PsiField) {
…
} else if (element instanceof KtProperty) {
…
}
return null;
}
Slide 84
Slide 84 text
public class InjectionLineMarkerProvider implements LineMarkerProvider {
public LineMarkerInfo getLineMarkerInfo(PsiElement element) {
…
} else if (element instanceof PsiField) {
// Field injection.
PsiField fieldElement = (PsiField) element;
PsiTypeElement typeElement = fieldElement.getTypeElement();
…
} else if (element instanceof KtProperty) {
???
}
return null;
}
Slide 85
Slide 85 text
UAST
Slide 86
Slide 86 text
Abstract
Unified
Syntax
Tree
Slide 87
Slide 87 text
PsiElement
PsiFile
PsiClass
PsiField
PsiMethod
UElement
UFile
UClass
UField
UMethod
⇨
Slide 88
Slide 88 text
val psiElement: PsiElement = ...
val uElement: UElement = psiElement.toUElement()
val uField: UField = psiElement.toUElementOfType()
Slide 89
Slide 89 text
class InjectionLineMarkerProvider : LineMarkerProvider {
fun getLineMarkerInfo(element: PsiElement): LineMarkerInfo<*>? {
val uElement = element.toUElement()
if (uElement is UField) {
// Field injection.
val typeElement = uElement.typeElement
…
}
return null
}
Slide 90
Slide 90 text
No content
Slide 91
Slide 91 text
val psiType = uElement.type
Slide 92
Slide 92 text
“The PsiElement obtained this way is ambiguous. If you
need "physical" PsiElement please use
UElementKt.getSourcePsiElement(), if you need
PsiElement that "emulates" behaviour of Java-elements
(PsiClass, PsiMethod, etc.) then please use
UElementKt.getAsJavaPsiElement().”
Slide 93
Slide 93 text
interface
UElement
interface
PsiElement
interface
PsiField
interface
UField
Slide 94
Slide 94 text
Slide 95
Slide 95 text
Slide 96
Slide 96 text
Slide 97
Slide 97 text
org.jetbrains.kotlin
org.jetbrains.kotlin
Slide 98
Slide 98 text
apply plugin: 'org.jetbrains.intellij'
Slide 99
Slide 99 text
apply plugin: 'org.jetbrains.intellij'
intellij {A
version “IC-2018.1"
pluginName = 'SQLDelight'
}A
Slide 100
Slide 100 text
apply plugin: 'org.jetbrains.intellij'
intellij {A
version “IC-2018.1"
pluginName = 'SQLDelight'
plugins = [A
“org.jetbrains.kotlin:1.2.70-release-IJ2018.1-1”
]A
}A
Slide 101
Slide 101 text
apply plugin: 'org.jetbrains.intellij'
intellij {A
version “IC-2018.1"
pluginName = 'SQLDelight'
plugins = [A
“org.jetbrains.kotlin:1.2.70-release-IJ2018.1-1”
]A
}A
// Automatically adds
tasks.create("runIde")
Slide 102
Slide 102 text
apply plugin: 'org.jetbrains.intellij'
intellij {
version “IC-2018.1"
pluginName = 'SQLDelight'
plugins = [
“org.jetbrains.kotlin:1.2.70-release-IJ2018.1-1”
]
}
// Automatically adds
tasks.create("runIde")
tasks.create("buildPlugin")
Slide 103
Slide 103 text
PSI
UAST vs
Slide 104
Slide 104 text
PSI
UAST
• JVM language analysis
• Language-agnostic types
• Language-agnostic features
• e.g. querying annotations
• APIs that accept it
• Language metadata
• Text range
Slide 105
Slide 105 text
UAST use cases
Slide 106
Slide 106 text
• Language-agnostic Intellij plugins
• Build tools
• Lint
• IDEA-based annotation processing
• Headless IDEA environment
UAST use cases
Slide 107
Slide 107 text
No content
Slide 108
Slide 108 text
No content
Slide 109
Slide 109 text
@strongolopolis @egorand
|
Thanks!