aboutsummaryrefslogtreecommitdiffstats
path: root/sd-plugin/src/main/java/org/intellij/sdk/language/psi/impl/SdPsiImplUtil.java
blob: d22caa5adaa9c355ce8c069876482dc90aa8699b (plain) (blame)
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
package org.intellij.sdk.language.psi.impl;

import com.intellij.icons.AllIcons;
import com.intellij.lang.ASTNode;
import com.intellij.navigation.ItemPresentation;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.PsiReference;
import com.intellij.psi.util.PsiTreeUtil;
import org.intellij.sdk.language.SdIcons;
import org.intellij.sdk.language.SdReference;
import org.intellij.sdk.language.SdUtil;
import org.intellij.sdk.language.hierarchy.SdHierarchyUtil;
import org.intellij.sdk.language.psi.SdArgumentDefinition;
import org.intellij.sdk.language.psi.SdDeclaration;
import org.intellij.sdk.language.psi.SdDeclarationType;
import org.intellij.sdk.language.psi.SdDocumentDefinition;
import org.intellij.sdk.language.psi.SdDocumentFieldDefinition;
import org.intellij.sdk.language.psi.SdDocumentStructDefinition;
import org.intellij.sdk.language.psi.SdDocumentStructFieldDefinition;
import org.intellij.sdk.language.psi.SdDocumentSummaryDefinition;
import org.intellij.sdk.language.psi.SdElementFactory;
import org.intellij.sdk.language.psi.SdFile;
import org.intellij.sdk.language.psi.SdFirstPhaseDefinition;
import org.intellij.sdk.language.psi.SdIdentifier;
import org.intellij.sdk.language.psi.SdIdentifierVal;
import org.intellij.sdk.language.psi.SdFunctionDefinition;
import org.intellij.sdk.language.psi.SdIdentifierWithDashVal;
import org.intellij.sdk.language.psi.SdImportFieldDefinition;
import org.intellij.sdk.language.psi.SdItemRawScoreDefinition;
import org.intellij.sdk.language.psi.SdQueryDefinition;
import org.intellij.sdk.language.psi.SdRankProfileDefinition;
import org.intellij.sdk.language.psi.SdSchemaFieldDefinition;
import org.intellij.sdk.language.psi.SdStructFieldDefinition;
import org.intellij.sdk.language.psi.SdSummaryDefinition;
import org.intellij.sdk.language.psi.SdTypes;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.Icon;

/**
 * I this class there are implementations of methods from rules in the .bnf file. While generating the psi files
 * (classes and interfaces) the implementations would be taken from here.
 */
public class SdPsiImplUtil {
    
    @NotNull
    public static PsiReference getReference(SdIdentifier element) {
        return new SdReference(element, new TextRange(0, element.getName().length()));
    }
    
    public static SdDeclarationType getType(SdDeclaration declaration) {
        if (declaration instanceof SdSchemaFieldDefinition) {
            return SdDeclarationType.SCHEMA_FIELD;
        } else if (declaration instanceof SdDocumentSummaryDefinition) {
            return SdDeclarationType.DOCUMENT_SUMMARY;
        } else if (declaration instanceof SdImportFieldDefinition) {
            return SdDeclarationType.IMPORTED_FIELD;
        } else if (declaration instanceof SdRankProfileDefinition) {
            return SdDeclarationType.RANK_PROFILE;
        } else if (declaration instanceof SdFunctionDefinition) {
            return SdDeclarationType.MACRO;
        } else if (declaration instanceof SdArgumentDefinition) {
            return SdDeclarationType.MACRO_ARGUMENT;
        } else if (declaration instanceof SdDocumentDefinition) {
            return SdDeclarationType.DOCUMENT;
        } else if (declaration instanceof SdDocumentStructDefinition) {
            return SdDeclarationType.STRUCT;
        } else if (declaration instanceof SdDocumentStructFieldDefinition) {
            return SdDeclarationType.DOCUMENT_STRUCT_FIELD;
        } else if (declaration instanceof SdDocumentFieldDefinition) {
            return SdDeclarationType.DOCUMENT_FIELD;
        } else if (declaration instanceof SdStructFieldDefinition) {
            return SdDeclarationType.STRUCT_FIELD;
        } else if (declaration instanceof SdQueryDefinition) {
            return SdDeclarationType.QUERY;
        } else if (declaration instanceof SdItemRawScoreDefinition) {
            return SdDeclarationType.ITEM_RAW_SCORE;
        } else {
            return null;
        }
    }
    
    public static String getTypeName(SdDeclaration declaration) {
        return declaration.getType().toString();
    }
    
    public static boolean isFunctionName(SdIdentifier identifier, PsiElement file) {
        String name = identifier.getName();
        for (SdFunctionDefinition macro : PsiTreeUtil.collectElementsOfType(file, SdFunctionDefinition.class)) {
            if (name.equals(macro.getName())) {
                return true;
            }
        }
        return false;
    }
    
    public static boolean isOverride(SdFunctionDefinition macroDeclaration) {
        String macroName = macroDeclaration.getName();
        
        SdRankProfileDefinition curRankProfile = PsiTreeUtil.getParentOfType(macroDeclaration, SdRankProfileDefinition.class);
        if (curRankProfile != null) {
            curRankProfile = (SdRankProfileDefinition) SdUtil.getRankProfileParent(curRankProfile);
        }
        while (curRankProfile != null) {
            for (SdFunctionDefinition macro : PsiTreeUtil.collectElementsOfType(curRankProfile, SdFunctionDefinition.class)) {
                if (macro.getName().equals(macroName)) {
                    return true;
                }
            }
            curRankProfile = (SdRankProfileDefinition) SdUtil.getRankProfileParent(curRankProfile);
        }
        return false;
        
    }
    
    // ################################### //
    // ##### getName implementations ##### //
    // ################################### //

    @NotNull
    public static String getName(SdIdentifier element) {
        if (element != null) {
            // IMPORTANT: Convert embedded escaped spaces to simple spaces
            return element.getText().replaceAll("\\\\ ", " ");
        } else {
            return "";
        }
    }
    
    @NotNull
    public static String getName(SdDeclaration declaration) {
        ASTNode node;
        if (declaration instanceof SdImportFieldDefinition) {
            ASTNode asNode = declaration.getNode().findChildByType(SdTypes.AS);
            node = declaration.getNode().findChildByType(SdTypes.IDENTIFIER_VAL, asNode);
        } else if (declaration instanceof SdRankProfileDefinition || declaration instanceof SdDocumentSummaryDefinition 
                   || declaration instanceof SdQueryDefinition) {
            node = declaration.getNode().findChildByType(SdTypes.IDENTIFIER_WITH_DASH_VAL);
        } else {
            node = declaration.getNode().findChildByType(SdTypes.IDENTIFIER_VAL);
        }
        if (node != null) {
            return node.getText();
        } else {
            return "";
        }
    }
    
    @NotNull
    public static String getName(SdSummaryDefinition summary) {
        ASTNode node;
        node = summary.getNode().findChildByType(SdTypes.IDENTIFIER_WITH_DASH_VAL);
        if (node != null) {
            return node.getText();
        } else {
            return "";
        }
    }
    
    @NotNull
    public static String getName(SdFirstPhaseDefinition firstPhase) {
        SdRankProfileDefinition rankProfile = PsiTreeUtil.getParentOfType(firstPhase, SdRankProfileDefinition.class);
        if (rankProfile == null) {
            return "";
        }
        return "first-phase of " + rankProfile.getName();
    }
    
    // ################################### //
    // ##### setName implementations ##### //
    // ################################### //
    
    @NotNull
    public static PsiElement setName(SdIdentifierVal element, String newName) {
        ASTNode node =  element.getNode().getFirstChildNode();
        if (node != null) {
            SdIdentifierVal elementName = SdElementFactory.createIdentifierVal(element.getProject(), newName);
            ASTNode newNode = elementName.getFirstChild().getNode();
            element.getNode().replaceChild(node, newNode);
        }
        return element;
    }
    
    @NotNull
    public static PsiElement setName(SdIdentifierWithDashVal element, String newName) {
        ASTNode node =  element.getNode().getFirstChildNode();
        if (node != null) {
            SdIdentifierWithDashVal elementName = SdElementFactory.createIdentifierWithDashVal(element.getProject(), newName);
            ASTNode newNode = elementName.getFirstChild().getNode();
            element.getNode().replaceChild(node, newNode);
        }
        return element;
    }
    
    @NotNull
    public static PsiElement setName(SdDeclaration element, String newName) {
        ASTNode node;
        if (element instanceof SdImportFieldDefinition) {
            ASTNode asNode = element.getNode().findChildByType(SdTypes.AS);
            node = element.getNode().findChildByType(SdTypes.IDENTIFIER_VAL, asNode);
        } else {
            node = element.getNode().findChildByType(SdTypes.IDENTIFIER_VAL);
        }
        SdIdentifier elementName = null;
        if (node != null) {
            elementName = SdElementFactory.createIdentifierVal(element.getProject(), newName);
        } else {
            node = element.getNode().findChildByType(SdTypes.IDENTIFIER_WITH_DASH_VAL);
        }
        if (node != null) {
            elementName = SdElementFactory.createIdentifierWithDashVal(element.getProject(), newName);
        }
        if (elementName != null) {
            ASTNode newNode = elementName.getFirstChild().getNode();
            element.getNode().replaceChild(node, newNode);
        }
        return element;
    }
    
    // ##################################### //
    // # getNameIdentifier implementations # //
    // ##################################### //
    
    public static PsiElement getNameIdentifier(SdIdentifierVal element) {
        ASTNode keyNode = element.getNode().findChildByType(SdTypes.ID);
        if (keyNode != null) {
            return keyNode.getPsi();
        } else {
            return null;
        }
    }
    
    public static PsiElement getNameIdentifier(SdDeclaration element) {
        ASTNode keyNode = element.getNode().findChildByType(SdTypes.ID);
        if (keyNode != null) {
            return keyNode.getPsi();
        } else {
            return null;
        }
    }
    
    // ################################### //
    // # getPresentation implementations # //
    // ################################### //
    
    public static ItemPresentation getPresentation(final SdDeclaration element) {
        return new ItemPresentation() {
            @Nullable
            @Override
            public String getPresentableText() {
                if (element instanceof SdFunctionDefinition) {
                    return SdUtil.createFunctionDescription((SdFunctionDefinition) element);
                } 
                SdRankProfileDefinition rankProfileParent = PsiTreeUtil.getParentOfType(element, SdRankProfileDefinition.class);
                if (rankProfileParent != null) {
                    if (element instanceof SdQueryDefinition || element instanceof SdItemRawScoreDefinition) {
                        return element.getName() + " in " + rankProfileParent.getName();
                    }
                    return rankProfileParent.getName() + "." + element.getName();
                }
                return element.getName();
            }
            
            @Nullable
            @Override
            public String getLocationString() {
                return element.getContainingFile() != null ? element.getContainingFile().getName() : null;
            }
            
            @Nullable
            @Override
            public Icon getIcon(boolean unused) {
                if (element instanceof SdFile) {
                    return SdIcons.FILE;
                } else if (element instanceof SdSchemaFieldDefinition || element instanceof SdDocumentFieldDefinition ||
                           element instanceof SdQueryDefinition || element instanceof SdItemRawScoreDefinition) {
                    return AllIcons.Nodes.Field;
                } else if (element instanceof SdStructFieldDefinition  ||
                           element instanceof SdDocumentStructFieldDefinition) {
                    return SdIcons.STRUCT_FIELD;
                } else if (element instanceof SdImportFieldDefinition) {
                    return SdIcons.IMPORTED_FIELD;
                } else if (element instanceof SdFunctionDefinition) {
                    return AllIcons.Nodes.Method;
                    // Didn't use isOverride() here because it causes the Structure View to load too slow 
                    // return ((SdFunctionDefinition) element).isOverride() ? SdIcons.OVERRIDE_MACRO : AllIcons.Nodes.Method;
                } else if (element instanceof SdDocumentStructDefinition) {
                    return SdIcons.STRUCT;
                } else if (element instanceof SdRankProfileDefinition) {
                    return AllIcons.Nodes.Record;
                } else if (element instanceof SdDocumentSummaryDefinition) {
                    return SdIcons.DOCUMENT_SUMMARY;
                } else if (element instanceof SdDocumentDefinition) {
                    return SdIcons.DOCUMENT;
                }
                else {
                    return null;
                }
            }
        };
    }
    
    public static ItemPresentation getPresentation(final SdSummaryDefinition element) {
        return new ItemPresentation() {

            @Override
            public String getPresentableText() {
                return element.getName();
            }
            
            @Nullable
            @Override
            public String getLocationString() {
                return element.getContainingFile() != null ? element.getContainingFile().getName() : null;
            }
            
            @Override
            public Icon getIcon(boolean unused) {
                return SdIcons.SUMMARY;
            }
        };
    }
    
    public static ItemPresentation getPresentation(final SdFirstPhaseDefinition element) {
        return new ItemPresentation() {

            @Override
            public String getPresentableText() {
                SdRankProfileDefinition rankProfile = PsiTreeUtil.getParentOfType(element, SdRankProfileDefinition.class);
                if (rankProfile == null) {
                    return "";
                }
                return "first-phase of " + rankProfile.getName();
            }
            
            @Nullable
            @Override
            public String getLocationString() {
                return element.getContainingFile() != null ? element.getContainingFile().getName() : null;
            }
            
            @Override
            public Icon getIcon(boolean unused) {
                return SdIcons.FIRST_PHASE;
            }
        };
    }
    
}