Skip to content

Commit a563433

Browse files
cmagliefacchinm
cmaglie
authored and
facchinm
committed
Testing autocomplete with arduino-preprocessor
1 parent a9b6774 commit a563433

File tree

8 files changed

+235
-24
lines changed

8 files changed

+235
-24
lines changed

‎app/.classpath‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
<classpathentry kind="lib" path="lib/jsch-0.1.50.jar"/>
4444
<classpathentry kind="lib" path="lib/jssc-2.8.0-arduino1.jar"/>
4545
<classpathentry kind="lib" path="lib/rsyntaxtextarea-2.6.1.jar"/>
46-
<classpathentry kind="lib" path="lib/autocomplete-2.6.1.jar" sourcepath="/media/ricardo/Dados/Workspace/Arduino/arduino-dep/AutoComplete-2.6.1"/>
4746
<classpathentry kind="lib" path="lib/xml-apis-1.3.04.jar"/>
4847
<classpathentry kind="lib" path="lib/xml-apis-ext-1.3.04.jar"/>
4948
<classpathentry kind="lib" path="lib/xmlgraphics-commons-2.0.jar"/>
@@ -53,5 +52,6 @@
5352
<classpathentry kind="lib" path="test-lib/fest-swing-1.2.jar"/>
5453
<classpathentry kind="lib" path="test-lib/fest-util-1.1.2.jar"/>
5554
<classpathentry kind="lib" path="test-lib/jcip-annotations-1.0.jar"/>
55+
<classpathentry combineaccessrules="false" kind="src" path="/AutoComplete"/>
5656
<classpathentry kind="output" path="bin"/>
5757
</classpath>

‎app/src/cc/arduino/autocomplete/ArduinoCompletionsList.java‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package cc.arduino.autocomplete;
2+
3+
import java.util.ArrayList;
4+
import java.util.List;
5+
6+
public class ArduinoCompletionsList extends ArrayList<ArduinoCompletion> {
7+
}
8+
9+
class ArduinoCompletion {
10+
ArduinoCompletionDetail completion;
11+
String type;
12+
13+
public ArduinoCompletionDetail getCompletion() {
14+
return completion;
15+
}
16+
17+
public String getType() {
18+
return type;
19+
}
20+
}
21+
22+
class ArduinoCompletionDetail {
23+
List<CompletionChunk> chunks;
24+
String brief;
25+
26+
public List<CompletionChunk> getChunks() {
27+
return chunks;
28+
}
29+
30+
public String getBrief() {
31+
return brief;
32+
}
33+
}
34+
35+
class CompletionChunk {
36+
String typedtext;
37+
String t;
38+
String placeholder;
39+
String res;
40+
ArduinoCompletionDetail optional;
41+
42+
public String getTypedtext() {
43+
return typedtext;
44+
}
45+
46+
public String getT() {
47+
return t;
48+
}
49+
50+
public String getPlaceholder() {
51+
return placeholder;
52+
}
53+
54+
public String getRes() {
55+
return res;
56+
}
57+
58+
public ArduinoCompletionDetail getOptional() {
59+
return optional;
60+
}
61+
}

‎app/src/cc/arduino/autocomplete/BaseCCompletionProvider.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* @author Ricardo JL Rufino (ricardo@criativasoft.com.br)
88
* @date 28/04/2017
99
*/
10-
public class BaseCCompletionProvider extends DefaultCompletionProvider{
10+
public class BaseCCompletionProvider extends DefaultCompletionProvider {
1111

1212
@Override
1313
protected boolean isValidChar(char ch) {

‎app/src/cc/arduino/autocomplete/ClangCompletionProvider.java‎

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
package cc.arduino.autocomplete;
2+
3+
import java.util.ArrayList;
4+
import java.util.List;
5+
6+
import javax.swing.text.BadLocationException;
7+
import javax.swing.text.JTextComponent;
8+
9+
import org.fife.ui.autocomplete.Completion;
10+
import org.fife.ui.autocomplete.TemplateCompletion;
11+
12+
import com.fasterxml.jackson.databind.ObjectMapper;
13+
14+
import processing.app.Editor;
15+
import processing.app.EditorTab;
16+
17+
public class ClangCompletionProvider extends BaseCCompletionProvider {
18+
19+
private Editor editor;
20+
21+
public ClangCompletionProvider(Editor e) {
22+
super();
23+
editor = e;
24+
}
25+
26+
@Override
27+
public List<Completion> getCompletionByInputText(String inputText) {
28+
System.out.println("INPUTTEXT: " + inputText);
29+
return super.getCompletionByInputText(inputText);
30+
}
31+
32+
@Override
33+
protected List<Completion> getCompletionsImpl(JTextComponent textarea) {
34+
35+
// Retrieve current line and column
36+
EditorTab tab = editor.getCurrentTab();
37+
int line, col;
38+
try {
39+
int pos = tab.getTextArea().getCaretPosition();
40+
line = tab.getTextArea().getLineOfOffset(pos);
41+
col = pos - tab.getTextArea().getLineStartOffset(line);
42+
line++;
43+
col++;
44+
} catch (BadLocationException e1) {
45+
// Should never happen...
46+
e1.printStackTrace();
47+
return completions;
48+
}
49+
50+
try {
51+
// Run codecompletion engine
52+
String out = editor.getSketchController()
53+
.codeComplete(tab.getSketchFile(), line, col);
54+
55+
List<Completion> res = new ArrayList<>();
56+
res.add(new TemplateCompletion(this, "for", "interate over array",
57+
"for (int ${i} = 0; ${i} < ${array}.length; ${i}++) {\n ${cursor}\n}"));
58+
59+
// Parse engine output and build code completions
60+
ObjectMapper mapper = new ObjectMapper();
61+
ArduinoCompletionsList allCc;
62+
allCc = mapper.readValue(out, ArduinoCompletionsList.class);
63+
for (ArduinoCompletion cc : allCc) {
64+
if (cc.type.equals("macro")) {
65+
// for now skip macro
66+
continue;
67+
}
68+
String returnType;
69+
String typedText;
70+
String template = "";
71+
for (CompletionChunk chunk : cc.completion.chunks) {
72+
if (chunk.t != null) {
73+
template += "t";
74+
}
75+
if (chunk.res != null) {
76+
returnType = chunk.res;
77+
}
78+
if (chunk.typedtext != null) {
79+
typedText = chunk.typedtext;
80+
}
81+
}
82+
}
83+
} catch (Exception e) {
84+
e.printStackTrace();
85+
}
86+
return completions;
87+
}
88+
}

‎app/src/processing/app/EditorTab.java‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@
6969
import java.nio.file.Path;
7070
import java.io.File;
7171

72+
import org.fife.ui.autocomplete.AutoCompletion;
7273
import org.fife.ui.rsyntaxtextarea.RSyntaxDocument;
7374
import org.fife.ui.rsyntaxtextarea.RSyntaxTextArea;
7475
import org.fife.ui.rsyntaxtextarea.RSyntaxTextAreaEditorKit;
@@ -82,7 +83,7 @@
8283
import org.fife.ui.rtextarea.RecordableTextAction;
8384

8485
import cc.arduino.UpdatableBoardsLibsFakeURLsHandler;
85-
import cc.arduino.autocomplete.FakeCompletionProvider;
86+
import cc.arduino.autocomplete.ClangCompletionProvider;
8687
import processing.app.helpers.DocumentTextChangeListener;
8788
import processing.app.helpers.PreferencesMap;
8889
import processing.app.syntax.ArduinoTokenMakerFactory;
@@ -138,7 +139,17 @@ public EditorTab(Editor editor, SketchFile file, String contents)
138139
applyPreferences();
139140
add(scrollPane, BorderLayout.CENTER);
140141
textarea.addMouseWheelListener(this);
141-
textarea.setupAutoComplete(file.getSketch(), new FakeCompletionProvider());
142+
// SketchCompletionProvider completionProvider = new SketchCompletionProvider(
143+
// editor.getSketch(), textarea, new ClangCompletionProvider(editor));
144+
145+
AutoCompletion ac = new AutoCompletion(new ClangCompletionProvider(editor));
146+
ac.setAutoActivationEnabled(true);
147+
ac.setShowDescWindow(false);
148+
ac.setAutoCompleteSingleChoices(true);
149+
ac.setParameterAssistanceEnabled(true);
150+
// ac.setParamChoicesRenderer(new CompletionsRenderer());
151+
// ac.setListCellRenderer(new CompletionsRenderer());
152+
ac.install(textarea);
142153
}
143154

144155
private RSyntaxDocument createDocument(String contents) {

‎app/src/processing/app/SketchController.java‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -672,6 +672,40 @@ private File saveSketchInTempFolder() throws IOException {
672672
return Paths.get(tempFolder.getAbsolutePath(), sketch.getPrimaryFile().getFileName()).toFile();
673673
}
674674

675+
/**
676+
* Preprocess sketch and obtain code-completions.
677+
*
678+
* @return null if compilation failed, main class name if not
679+
*/
680+
public String codeComplete(SketchFile file, int line, int col) throws RunnerException, PreferencesMapException, IOException {
681+
// run the preprocessor
682+
for (CompilerProgressListener progressListener : editor.status.getCompilerProgressListeners()){
683+
progressListener.progress(20);
684+
}
685+
686+
ensureExistence();
687+
688+
boolean deleteTemp = false;
689+
File pathToSketch = sketch.getPrimaryFile().getFile();
690+
File requestedFile = file.getFile();
691+
if (sketch.isModified()) {
692+
// If any files are modified, make a copy of the sketch with the changes
693+
// saved, so arduino-builder will see the modifications.
694+
pathToSketch = saveSketchInTempFolder();
695+
// This takes into account when the sketch is copied into a temporary folder
696+
requestedFile = new File(pathToSketch.getParent(), requestedFile.getName());
697+
deleteTemp = true;
698+
}
699+
700+
try {
701+
return new Compiler(pathToSketch, sketch).codeComplete(editor.status.getCompilerProgressListeners(), requestedFile, line, col);
702+
} finally {
703+
// Make sure we clean up any temporary sketch copy
704+
if (deleteTemp)
705+
FileUtils.recursiveDelete(pathToSketch.getParentFile());
706+
}
707+
}
708+
675709
/**
676710
* Handle export to applet.
677711
*/

‎app/src/processing/app/syntax/SketchTextArea.java‎

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -124,22 +124,6 @@ public void setKeywords(PdeKeywords keywords) {
124124
setLinkGenerator(new DocLinkGenerator(pdeKeywords));
125125
}
126126

127-
public void setupAutoComplete(Sketch sketch, CompletionProvider provider) {
128-
129-
SketchCompletionProvider completionProvider = new SketchCompletionProvider(sketch, this, provider);
130-
131-
AutoCompletion ac = new AutoCompletion( completionProvider );
132-
133-
ac.setAutoActivationEnabled(true);
134-
ac.setShowDescWindow(false);
135-
ac.setAutoCompleteSingleChoices(true);
136-
ac.setParameterAssistanceEnabled(true);
137-
// ac.setParamChoicesRenderer(new CompletionsRenderer());
138-
// ac.setListCellRenderer(new CompletionsRenderer());
139-
ac.install(this);
140-
141-
}
142-
143127
private void installFeatures() throws IOException {
144128
setTheme(PreferencesData.get("editor.syntax_theme", "default"));
145129

‎arduino-core/src/cc/arduino/Compiler.java‎

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ public class Compiler implements MessageConsumer {
125125
}
126126

127127
enum BuilderAction {
128-
COMPILE("-compile"), DUMP_PREFS("-dump-prefs");
128+
COMPILE("-compile"), DUMP_PREFS("-dump-prefs"), CODE_COMPLETE("-code-complete-at");
129129

130130
final String value;
131131

@@ -143,6 +143,10 @@ enum BuilderAction {
143143
private final boolean verbose;
144144
private RunnerException exception;
145145

146+
private File codeCompleteFile;
147+
private int codeCompleteLine;
148+
private int codeCompleteCol;
149+
146150
public Compiler(Sketch data) {
147151
this(data.getPrimaryFile().getFile(), data);
148152
}
@@ -193,6 +197,34 @@ public String build(List<CompilerProgressListener> progListeners, boolean export
193197
return sketch.getPrimaryFile().getFileName();
194198
}
195199

200+
public String codeComplete(ArrayList<CompilerProgressListener> progListeners, File file, int line, int col) throws RunnerException, PreferencesMapException, IOException {
201+
this.buildPath = sketch.getBuildPath().getAbsolutePath();
202+
this.buildCache = BaseNoGui.getCachePath();
203+
204+
TargetBoard board = BaseNoGui.getTargetBoard();
205+
if (board == null) {
206+
throw new RunnerException("Board is not selected");
207+
}
208+
209+
TargetPlatform platform = board.getContainerPlatform();
210+
TargetPackage aPackage = platform.getContainerPackage();
211+
String vidpid = VIDPID();
212+
213+
ByteArrayOutputStream completions = new ByteArrayOutputStream();
214+
MessageConsumerOutputStream out = new MessageConsumerOutputStream(new ProgressAwareMessageConsumer(new I18NAwareMessageConsumer(new PrintStream(completions), System.err), progListeners), "\n");
215+
MessageConsumerOutputStream err = new MessageConsumerOutputStream(new I18NAwareMessageConsumer(System.err, Compiler.this), "\n");
216+
217+
codeCompleteFile = file;
218+
codeCompleteLine = line;
219+
codeCompleteCol = col;
220+
callArduinoBuilder(board, platform, aPackage, vidpid, BuilderAction.CODE_COMPLETE, out, err);
221+
222+
out.flush();
223+
err.flush();
224+
225+
return completions.toString();
226+
}
227+
196228
private String VIDPID() {
197229
BoardPort boardPort = BaseNoGui.getDiscoveryManager().find(PreferencesData.get("serial.port"));
198230
if (boardPort == null) {
@@ -234,6 +266,9 @@ private void callArduinoBuilder(TargetBoard board, TargetPlatform platform, Targ
234266
List<String> cmd = new ArrayList<>();
235267
cmd.add(BaseNoGui.getContentFile("arduino-builder").getAbsolutePath());
236268
cmd.add(action.value);
269+
if (action == BuilderAction.CODE_COMPLETE) {
270+
cmd.add(codeCompleteFile.getAbsolutePath() + ":" + codeCompleteLine + ":" + codeCompleteCol);
271+
}
237272
cmd.add("-logger=machine");
238273

239274
File installedPackagesFolder = new File(BaseNoGui.getSettingsFolder(), "packages");
@@ -280,9 +315,7 @@ private void callArduinoBuilder(TargetBoard board, TargetPlatform platform, Targ
280315
}
281316
}
282317

283-
//commandLine.addArgument("-debug-level=10", false);
284-
285-
if (verbose) {
318+
if (verbose && action != BuilderAction.CODE_COMPLETE) {
286319
cmd.add("-verbose");
287320
}
288321

0 commit comments

Comments
 (0)