-
Notifications
You must be signed in to change notification settings - Fork 823
/
BreadcrumbsImpl.java
372 lines (314 loc) · 12.7 KB
/
BreadcrumbsImpl.java
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
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.netbeans.modules.lsp.client.bindings;
import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Image;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.CharConversionException;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutionException;
import java.util.stream.Collectors;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.SwingUtilities;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.text.BadLocationException;
import javax.swing.text.Caret;
import javax.swing.text.Document;
import javax.swing.text.JTextComponent;
import javax.swing.text.Position;
import org.eclipse.lsp4j.DocumentSymbol;
import org.eclipse.lsp4j.DocumentSymbolParams;
import org.eclipse.lsp4j.SymbolInformation;
import org.eclipse.lsp4j.TextDocumentIdentifier;
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.netbeans.api.actions.Openable;
import org.netbeans.editor.SideBarFactory;
import org.netbeans.modules.editor.NbEditorUtilities;
import org.netbeans.modules.editor.breadcrumbs.spi.BreadcrumbsController;
import org.netbeans.modules.editor.breadcrumbs.spi.BreadcrumbsElement;
import org.netbeans.modules.lsp.client.LSPBindings;
import org.netbeans.modules.lsp.client.LSPBindings.BackgroundTask;
import org.netbeans.modules.lsp.client.Utils;
import org.openide.filesystems.FileObject;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.util.Exceptions;
import org.openide.util.ImageUtilities;
import org.openide.util.Lookup;
import org.openide.util.RequestProcessor;
import org.openide.util.lookup.Lookups;
import org.openide.xml.XMLUtil;
/**
*
* @author lahvac
*/
public class BreadcrumbsImpl implements BackgroundTask {
private static final RequestProcessor WORKER = new RequestProcessor(BreadcrumbsImpl.class.getName(), 1, false, false);
private final JTextComponent comp;
private final Document doc;
private volatile RootBreadcrumbsElementImpl rootElement;
public BreadcrumbsImpl(JTextComponent comp) {
this.comp = comp;
this.doc = comp.getDocument();
this.comp.addCaretListener(evt -> {
update();
});
}
@Override
public void run(LSPBindings bindings, FileObject file) {
try {
//TODO: modified while the query is running?
List<Either<SymbolInformation, DocumentSymbol>> symbols = bindings.getTextDocumentService().documentSymbol(new DocumentSymbolParams(new TextDocumentIdentifier(Utils.toURI(file)))).get();
this.rootElement = new RootBreadcrumbsElementImpl(file, doc, symbols.stream().map(this::toDocumentSymbol).collect(Collectors.toList()));
SwingUtilities.invokeLater(() -> update());
} catch (InterruptedException | ExecutionException ex) {
Exceptions.printStackTrace(ex);
}
}
private DocumentSymbol toDocumentSymbol(Either<SymbolInformation, DocumentSymbol> variants) {
if (variants.isRight()) return variants.getRight();
SymbolInformation left = variants.getLeft();
return new DocumentSymbol(left.getName(), left.getKind(), left.getLocation().getRange(), left.getLocation().getRange(), null, Collections.emptyList());
}
private void update() {
BreadcrumbsElement element = this.rootElement;
if (element == null) {
return ;
}
Caret caret = comp.getCaret();
if (caret != null && (!element.getChildren().isEmpty())) {
element = element.getChildren().get(0);
int caretPos = caret.getDot();
OUTER:
while (true) {
for (BreadcrumbsElement child : element.getChildren()) {
BreadcrumbsElementImpl impl = (BreadcrumbsElementImpl) child;
if (impl.startPos.getOffset() <= caretPos && caretPos <= impl.endPos.getOffset()) {
element = child;
continue OUTER;
}
}
break;
}
BreadcrumbsController.setBreadcrumbs(doc, element);
}
}
private static final class RootBreadcrumbsElementImpl implements BreadcrumbsElement {
private final List<BreadcrumbsElement> children;
public RootBreadcrumbsElementImpl(FileObject file, Document doc, List<DocumentSymbol> symbols) {
this.children = Collections.singletonList(new FileBreadcrumbsElementImpl(file, doc, this, symbols));
}
@Override
public String getHtmlDisplayName() {
return "";
}
@Override
public Image getIcon(int type) {
return BreadcrumbsController.NO_ICON;
}
@Override
public Image getOpenedIcon(int type) {
return BreadcrumbsController.NO_ICON;
}
@Override
public List<BreadcrumbsElement> getChildren() {
return children;
}
@Override
public Lookup getLookup() {
return Lookup.EMPTY;
}
@Override
public BreadcrumbsElement getParent() {
return null;
}
}
private static final class FileBreadcrumbsElementImpl implements BreadcrumbsElement {
private final FileObject file;
private final BreadcrumbsElement root;
private final List<BreadcrumbsElement> children;
public FileBreadcrumbsElementImpl(FileObject file, Document doc, BreadcrumbsElement root, List<DocumentSymbol> symbols) {
this.file = file;
this.root = root;
this.children = BreadcrumbsElementImpl.create(this, symbols, file, doc);
}
@Override
public String getHtmlDisplayName() {
return escape(file.getNameExt());
}
@Override
public Image getIcon(int type) {
try {
return DataObject.find(file).getNodeDelegate().getIcon(type);
} catch (DataObjectNotFoundException ex) {
return BreadcrumbsController.NO_ICON;
}
}
@Override
public Image getOpenedIcon(int type) {
try {
return DataObject.find(file).getNodeDelegate().getOpenedIcon(type);
} catch (DataObjectNotFoundException ex) {
return BreadcrumbsController.NO_ICON;
}
}
@Override
public List<BreadcrumbsElement> getChildren() {
return children;
}
@Override
public Lookup getLookup() {
return Lookup.EMPTY;
}
@Override
public BreadcrumbsElement getParent() {
return root;
}
}
private static final class BreadcrumbsElementImpl implements BreadcrumbsElement {
private final BreadcrumbsElement parent;
private final DocumentSymbol symbol;
private final Position startPos;
private final Position endPos;
private final List<BreadcrumbsElement> children;
private final Lookup lookup;
public BreadcrumbsElementImpl(BreadcrumbsElement parent, FileObject file, Document doc, DocumentSymbol symbol) throws BadLocationException {
this.parent = parent;
this.symbol = symbol;
this.startPos = doc.createPosition(Utils.getOffset(doc, symbol.getRange().getStart()));
this.endPos = doc.createPosition(Utils.getOffset(doc, symbol.getRange().getEnd()));
this.children = create(this, symbol.getChildren(), file, doc);
this.lookup = Lookups.fixed(new Openable() {
@Override
public void open() {
Utils.open(Utils.toURI(file), symbol.getRange());
}
});
}
@Override
public String getHtmlDisplayName() {
return escape(symbol.getName());
}
@Override
public Image getIcon(int type) {
return ImageUtilities.loadImage(Icons.getSymbolIconBase(symbol.getKind()));
}
@Override
public Image getOpenedIcon(int type) {
return getIcon(type);
}
@Override
public List<BreadcrumbsElement> getChildren() {
return children;
}
@Override
public Lookup getLookup() {
return lookup;
}
@Override
public BreadcrumbsElement getParent() {
return parent;
}
public static List<BreadcrumbsElement> create(BreadcrumbsElement parent, List<DocumentSymbol> symbols, FileObject file, Document doc) {
if (symbols == null) {
return Collections.emptyList();
}
return symbols.stream()
.map(c -> create(parent, file, doc, c))
.filter(e -> e != null)
.sorted((be1, be2) -> ((BreadcrumbsElementImpl) be1).startPos.getOffset() - ((BreadcrumbsElementImpl) be2).endPos.getOffset())
.collect(Collectors.toList());
}
private static BreadcrumbsElement create(BreadcrumbsElement parent, FileObject file, Document doc, DocumentSymbol symbol) {
try {
return new BreadcrumbsElementImpl(parent, file, doc, symbol);
} catch (BadLocationException ex) {
return null;
}
}
}
static String escape(String s) {
if (s != null) {
try {
return XMLUtil.toAttributeValue(s);
} catch (CharConversionException ex) {
}
}
return null;
}
public static SideBarFactory createSideBarFactory() {
SideBarFactory delegate = BreadcrumbsController.createSideBarFactory();
return new SideBarFactory() {
@Override
public JComponent createSideBar(JTextComponent target) {
return new LSPBreadcrumbPanel(delegate, target);
}
};
}
private static class LSPBreadcrumbPanel extends JPanel implements PropertyChangeListener, ChangeListener {
private final JTextComponent component;
private final JComponent sidebar;
public LSPBreadcrumbPanel(SideBarFactory delegate, JTextComponent component) {
this.component = component;
this.sidebar = delegate.createSideBar(component);
setLayout(new BorderLayout());
add(sidebar, BorderLayout.CENTER);
sidebar.addPropertyChangeListener(this);
LSPBindings.addChangeListener(this);
update();
}
private void update() {
WORKER.post(() -> {
FileObject file = NbEditorUtilities.getFileObject(component.getDocument());
LSPBindings bindings = file != null ? LSPBindings.getBindings(file) : null;
Runnable r;
if (bindings != null && Utils.isTrue(bindings.getInitResult().getCapabilities().getDocumentSymbolProvider())) {
r = () -> {
setPreferredSize(sidebar.getPreferredSize());
setMaximumSize(sidebar.getMaximumSize());
revalidate();
};
} else {
r = () -> {
setPreferredSize(new Dimension(0,0));
setMaximumSize(new Dimension(0,0));
revalidate();
};
}
SwingUtilities.invokeLater(r);
});
}
@Override
public void propertyChange(PropertyChangeEvent evt) {
String propertyName = evt.getPropertyName();
if (propertyName == null || "preferredSize".equals(propertyName) || "maximumSize".equals(propertyName)) {
update();
}
}
@Override
public void stateChanged(ChangeEvent e) {
update();
}
}
}