1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
// Copyright 2000-2018 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file.
package com.intellij.codeInsight.template.postfix.templates;
import com.intellij.codeInsight.CodeInsightBundle;
import com.intellij.codeInsight.template.postfix.settings.PostfixTemplateMetaData;
import com.intellij.codeInsight.template.postfix.settings.PostfixTemplatesSettings;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.util.NlsContexts;
import com.intellij.openapi.util.NlsSafe;
import com.intellij.openapi.util.NotNullLazyValue;
import com.intellij.psi.PsiElement;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.io.IOException;
import java.util.Objects;
/**
* Represents a postfix template.
* Postfix templates are live template that applicable to a specific code fragment e.g. "sout" template:
* <code>
* "hello".sout
* </code>
* is expanded to:
* <code>
* System.out.println("hello")
* <code/>
* <br>
* Editable templates:
* editable postfix template MUST know the provider that created it.
* <p>
* Editable postfix templates MUST provide proper equals/hashCode implementation.
* Equal postfix templates produces by the very same provider will overwrite each other.
*/
public abstract class PostfixTemplate {
private final @NotNull @NonNls String myId;
private final @NotNull @NlsSafe String myPresentableName;
private final @NotNull @NlsSafe String myKey;
private final @NotNull NotNullLazyValue<@NlsContexts.DetailedDescription String> myLazyDescription =
NotNullLazyValue.createValue(() -> calcDescription());
private final @NotNull @NlsSafe String myExample;
private final @Nullable PostfixTemplateProvider myProvider;
/**
* @deprecated use {@link #PostfixTemplate(String, String, String, PostfixTemplateProvider)}
*/
@Deprecated(forRemoval = true)
protected PostfixTemplate(@NotNull @NlsSafe String name, @NotNull @NlsSafe String example) {
this(null, name, "." + name, example, null);
}
protected PostfixTemplate(@Nullable @NonNls String id,
@NotNull @NlsSafe String name,
@NotNull @NlsSafe String example,
@Nullable PostfixTemplateProvider provider) {
this(id, name, "." + name, example, provider);
}
/**
* @deprecated use {@link #PostfixTemplate(String, String, String, String, PostfixTemplateProvider)}
*/
@Deprecated(forRemoval = true)
protected PostfixTemplate(@NotNull String name, @NotNull String key, @NotNull String example) {
this(null, name, key, example, null);
}
protected PostfixTemplate(@Nullable String id,
@NotNull String name,
@NotNull String key,
@NotNull String example,
@Nullable PostfixTemplateProvider provider) {
myId = id != null ? id : getClass().getName() + "#" + key;
myPresentableName = name;
myKey = key;
myExample = example;
myProvider = provider;
}
@NotNull
protected @NlsContexts.DetailedDescription String calcDescription() {
String defaultDescription = CodeInsightBundle.message("postfix.template.description.under.construction");
try {
return PostfixTemplateMetaData.createMetaData(this).getDescription().getText();
}
catch (IOException e) {
//ignore
}
return defaultDescription;
}
/**
* Template's identifier. Used for saving the settings related to this templates.
*/
@NotNull
public @NonNls String getId() {
return myId;
}
/**
* Template's key. Used while expanding template in editor.
*
* @return
*/
@NotNull
public final @NlsSafe String getKey() {
return myKey;
}
@NotNull
public @NlsSafe String getPresentableName() {
return myPresentableName;
}
@NotNull
public @NlsContexts.DetailedDescription String getDescription() {
return myLazyDescription.getValue();
}
@NotNull
public @NlsSafe String getExample() {
return myExample;
}
public boolean startInWriteAction() {
return true;
}
public boolean isEnabled(PostfixTemplateProvider provider) {
final PostfixTemplatesSettings settings = PostfixTemplatesSettings.getInstance();
return settings.isPostfixTemplatesEnabled() && settings.isTemplateEnabled(this, provider);
}
public abstract boolean isApplicable(@NotNull PsiElement context, @NotNull Document copyDocument, int newOffset);
public abstract void expand(@NotNull PsiElement context, @NotNull Editor editor);
@Nullable
public PostfixTemplateProvider getProvider() {
return myProvider;
}
/**
* Builtin templates cannot be removed.
* If they are editable, they can be restored to default.
*/
public boolean isBuiltin() {
return true;
}
/**
* Template can be edit. Template can be editable if its provider is not null and its key starts with . can be edited.
*/
public boolean isEditable() {
return true;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof PostfixTemplate)) return false;
PostfixTemplate template = (PostfixTemplate)o;
return Objects.equals(myId, template.myId) &&
Objects.equals(myPresentableName, template.myPresentableName) &&
Objects.equals(myKey, template.myKey) &&
Objects.equals(getDescription(), template.getDescription()) &&
Objects.equals(myExample, template.myExample) &&
Objects.equals(myProvider, template.myProvider);
}
@Override
public int hashCode() {
return Objects.hash(myId, myPresentableName, myKey, getDescription(), myExample, myProvider);
}
}
|
