Files
processing4/java/src/processing/mode/java/pdex/ErrorCheckerService.java
2015-08-28 21:13:34 -07:00

1650 lines
52 KiB
Java

/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
Part of the Processing project - http://processing.org
Copyright (c) 2012-15 The Processing Foundation
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2
as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package processing.mode.java.pdex;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import javax.swing.text.BadLocationException;
import javax.swing.text.Document;
import javax.swing.text.Element;
import javax.swing.text.PlainDocument;
import org.eclipse.jdt.core.JavaCore;
import org.eclipse.jdt.core.compiler.IProblem;
import org.eclipse.jdt.core.dom.AST;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.ASTParser;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.internal.compiler.impl.CompilerOptions;
import processing.app.Library;
import processing.app.Messages;
import processing.app.Preferences;
import processing.app.Sketch;
import processing.app.SketchCode;
import processing.app.Util;
import processing.app.syntax.SyntaxDocument;
import processing.app.ui.Editor;
import processing.app.ui.EditorStatus;
import processing.app.ui.ErrorTable;
import processing.core.PApplet;
import processing.mode.java.JavaMode;
import processing.mode.java.JavaEditor;
import processing.mode.java.preproc.PdePreprocessor;
/**
* The main error checking service
*/
@SuppressWarnings("unchecked")
public class ErrorCheckerService implements Runnable {
protected JavaEditor editor;
/** Error check happens every sleepTime milliseconds */
public static final int sleepTime = 1000;
/** The amazing eclipse ast parser */
protected ASTParser parser;
/**
* Used to indirectly stop the Error Checker Thread
*/
protected AtomicBoolean stopThread;
/**
* If true, Error Checking is paused. Calls to checkCode() become useless.
*/
protected AtomicBoolean pauseThread;
//protected ErrorWindow errorWindow;
/**
* IProblem[] returned by parser stored in here
*/
protected IProblem[] problems;
/**
* Class name of current sketch
*/
protected String className;
/**
* Source code of current sketch
*/
protected String sourceCode;
/**
* URLs of extra imports jar files stored here.
*/
protected URL[] classPath;
/**
* Stores all Problems in the sketch
*/
public List<Problem> problemsList;
/**
* How many lines are present till the initial class declaration? In static
* mode, this would include imports, class declaration and setup
* declaration. In nomral mode, this would include imports, class
* declaration only. It's fate is decided inside preprocessCode()
*/
public int mainClassOffset;
/**
* Fixed p5 offsets for all sketches
*/
public int defaultImportsOffset;
/**
* Is the sketch running in static mode or active mode?
*/
public boolean staticMode = false;
/**
* Compilation Unit for current sketch
*/
protected CompilationUnit cu;
/**
* The Compilation Unit generated during compile check
*/
protected CompilationUnit compileCheckCU;
/**
* This Compilation Unit points to the last error free CU
*/
protected CompilationUnit lastCorrectCU;
/**
* If true, compilation checker will be reloaded with updated classpath
* items.
*/
protected boolean loadCompClass = true;
/**
* Compiler Checker class. Note that methods for compilation checking are
* called from the compilationChecker object, not from this
*/
protected Class<?> checkerClass;
/**
* Compilation Checker object.
*/
protected CompilationChecker compilationChecker;
/**
* List of jar files to be present in compilation checker's classpath
*/
protected List<URL> classpathJars;
/**
* Timestamp - for measuring total overhead
*/
protected long lastTimeStamp = System.currentTimeMillis();
/**
* Used for displaying the rotating slash on the Problem Window title bar
*/
protected String[] slashAnimation = { "|", "/", "--", "\\", "|", "/", "--",
"\\" };
protected int slashAnimationIndex = 0;
/**
* Used to detect if the current tab index has changed and thus repaint the
* textarea.
*/
public int currentTab = 0, lastTab = 0;
/**
* Stores the current import statements in the program. Used to compare for
* changed import statements and update classpath if needed.
*/
protected ArrayList<ImportStatement> programImports;
/**
* List of imports when sketch was last checked. Used for checking for
* changed imports
*/
protected ArrayList<ImportStatement> previousImports = new ArrayList<ImportStatement>();
/**
* Teh Preprocessor
*/
protected XQPreprocessor xqpreproc;
/**
* Regexp for import statements. (Used from Processing source)
*/
final public String importRegexp = "(?:^|;)\\s*(import\\s+)((?:static\\s+)?\\S+)(\\s*;)";
/**
* Regexp for function declarations. (Used from Processing source)
*/
final Pattern FUNCTION_DECL = Pattern
.compile("(^|;)\\s*((public|private|protected|final|static)\\s+)*"
+ "(void|int|float|double|String|char|byte|boolean)"
+ "(\\s*\\[\\s*\\])?\\s+[a-zA-Z0-9]+\\s*\\(", Pattern.MULTILINE);
protected ErrorMessageSimplifier errorMsgSimplifier;
public ErrorCheckerService(JavaEditor debugEditor) {
this.editor = debugEditor;
stopThread = new AtomicBoolean(false);
pauseThread = new AtomicBoolean(false);
problemsList = new ArrayList<Problem>();
classpathJars = new ArrayList<URL>();
initParser();
//initializeErrorWindow();
xqpreproc = new XQPreprocessor();
PdePreprocessor pdePrepoc = new PdePreprocessor(null);
defaultImportsOffset = pdePrepoc.getCoreImports().length +
pdePrepoc.getDefaultImports().length + 1;
astGenerator = new ASTGenerator(this);
syntaxErrors = new AtomicBoolean(true);
containsErrors = new AtomicBoolean(true);
errorMsgSimplifier = new ErrorMessageSimplifier();
tempErrorLog = new TreeMap<String, IProblem>();
sketchChangedListener = new SketchChangedListener();
// for (final SketchCode sc : editor.getSketch().getCode()) {
// sc.getDocument().addDocumentListener(sketchChangedListener);
// }
}
/**
* Initializes ASTParser
*/
protected void initParser() {
try {
parser = ASTParser.newParser(AST.JLS8);
} catch (Exception e) {
System.err.println("Experimental Mode initialization failed. "
+ "Are you running the right version of Processing? ");
pauseThread();
} catch (Error e) {
System.err.println("Experimental Mode initialization failed. ");
e.printStackTrace();
pauseThread();
}
}
/**
* Error checking doesn't happen before this interval has ellapsed since the
* last runManualErrorCheck() call.
*/
private final static long errorCheckInterval = 500;
/**
* Bypass sleep time
*/
private volatile boolean noSleep = false;
/**
* The way the error checking happens is: DocumentListeners are added
* to each SketchCode object. Whenever the document is edited, runManualErrorCheck()
* is called. Internally, an atomic integer counter is incremented.
* The ECS thread checks the value of this counter evey sleepTime seconds.
* If the counter is non zero, error checking is done(in the ECS thread)
* and the counter is reset.
*/
public void run() {
stopThread.set(false);
checkCode();
lastErrorCheckCall = System.currentTimeMillis();
if (!hasSyntaxErrors()) {
// editor.showProblemListView(Language.text("editor.footer.console"));
editor.showConsole();
}
// Make sure astGen has at least one CU to start with
// This is when the loaded sketch already has syntax errors.
// Completion wouldn't be complete, but it'd be still something
// better than nothing
astGenerator.buildAST(cu);
handleErrorCheckingToggle();
while (!stopThread.get()) {
try {
// Take a nap.
if(!noSleep) {
Thread.sleep(sleepTime);
}
else {
noSleep = false;
Messages.log("Didn't sleep!");
}
} catch (Exception e) {
Messages.log("Oops! [ErrorCheckerThreaded]: " + e);
// e.printStackTrace();
}
updatePaintedThingys();
updateEditorStatus();
updateSketchCodeListeners();
if (pauseThread.get())
continue;
if(textModified.get() == 0)
continue;
// Check if a certain interval has passed after the call. Only then
// begin error check. Helps prevent unnecessary flickering. See #2677
if (System.currentTimeMillis() - lastErrorCheckCall > errorCheckInterval) {
Messages.log("Interval passed, starting error check");
checkCode();
checkForMissingImports();
}
}
astGenerator.disposeAllWindows();
compilationChecker = null;
checkerClass = null;
classLoader = null;
System.gc();
Messages.loge("Thread stopped: " + editor.getSketch().getName());
System.gc();
}
protected void updateSketchCodeListeners() {
for (SketchCode sc : editor.getSketch().getCode()) {
SyntaxDocument doc = (SyntaxDocument) sc.getDocument();
if (!hasSketchChangedListener(doc)) {
doc.addDocumentListener(sketchChangedListener);
}
}
}
boolean hasSketchChangedListener(SyntaxDocument doc) {
if (doc != null && doc.getDocumentListeners() != null) {
for (DocumentListener dl : doc.getDocumentListeners()) {
if (dl.equals(sketchChangedListener)) {
return true;
}
}
}
return false;
}
protected void checkForMissingImports() {
if (Preferences.getBoolean(JavaMode.SUGGEST_IMPORTS_PREF)) {
for (Problem p : problemsList) {
if(p.getIProblem().getID() == IProblem.UndefinedType) {
String args[] = p.getIProblem().getArguments();
if (args.length > 0) {
String missingClass = args[0];
Messages.log("Will suggest for type:" + missingClass);
//astGenerator.suggestImports(missingClass);
}
}
}
}
}
protected ASTGenerator astGenerator;
public ASTGenerator getASTGenerator() {
return astGenerator;
}
/**
* This thing acts as an event queue counter of sort.
* Since error checking happens on demand, anytime this counter
* goes above 0, error check is triggered, and counter reset.
* It's thread safe to avoid any mess.
*/
protected AtomicInteger textModified = new AtomicInteger();
/**
* Time stamp of last runManualErrorCheck() call.
*/
private volatile long lastErrorCheckCall = 0;
/**
* Triggers error check
*/
public void runManualErrorCheck() {
// log("Error Check.");
textModified.incrementAndGet();
lastErrorCheckCall = System.currentTimeMillis();
}
// TODO: Experimental, lookout for threading related issues
public void quickErrorCheck() {
noSleep = true;
}
protected SketchChangedListener sketchChangedListener;
protected class SketchChangedListener implements DocumentListener{
private SketchChangedListener(){
}
@Override
public void insertUpdate(DocumentEvent e) {
if (JavaMode.errorCheckEnabled) {
runManualErrorCheck();
//log("doc insert update, man error check..");
}
}
@Override
public void removeUpdate(DocumentEvent e) {
if (JavaMode.errorCheckEnabled){
runManualErrorCheck();
//log("doc remove update, man error check..");
}
}
@Override
public void changedUpdate(DocumentEvent e) {
if (JavaMode.errorCheckEnabled){
runManualErrorCheck();
//log("doc changed update, man error check..");
}
}
}
/**
* state = 1 > syntax check done<br>
* state = 2 > compilation check done
*/
public int compilationUnitState = 0;
protected boolean checkCode() {
// log("checkCode() " + textModified.get());
lastTimeStamp = System.currentTimeMillis();
try {
sourceCode = preprocessCode(editor.getSketch().getMainProgram());
compilationUnitState = 0;
syntaxCheck();
// log(editor.getSketch().getName() + "1 MCO " + mainClassOffset);
// No syntax errors, proceed for compilation check, Stage 2.
//if(hasSyntaxErrors()) astGenerator.buildAST(null);
if (!hasSyntaxErrors()) {
}
if (problems.length == 0 && !editor.hasJavaTabs()) {
//mainClassOffset++; // just a hack.
sourceCode = xqpreproc.doYourThing(sourceCode, programImports);
prepareCompilerClasspath();
// mainClassOffset = xqpreproc.mainClassOffset; // tiny, but
// // significant
// if (staticMode) {
// mainClassOffset++; // Extra line for setup() decl.
// }
// log(sourceCode);
// log("--------------------------");
compileCheck();
// log(editor.getSketch().getName() + "2 MCO " + mainClassOffset);
}
astGenerator.buildAST(cu);
if (!JavaMode.errorCheckEnabled) {
problemsList.clear();
Messages.log("Error Check disabled, so not updating UI.");
}
calcPdeOffsetsForProbList();
updateErrorTable();
editor.updateErrorBar(problemsList);
updateEditorStatus();
editor.getTextArea().repaint();
updatePaintedThingys();
editor.updateErrorToggle();
int x = textModified.get();
//log("TM " + x);
if (x >= 2) {
textModified.set(2);
x = 2;
}
if (x > 0)
textModified.set(x - 1);
else
textModified.set(0);
return true;
} catch (Exception e) {
Messages.log("Oops! [ErrorCheckerService.checkCode]: " + e);
e.printStackTrace();
}
return false;
}
protected AtomicBoolean syntaxErrors, containsErrors;
public boolean hasSyntaxErrors(){
return syntaxErrors.get();
}
public boolean hasErrors(){
return containsErrors.get();
}
public TreeMap<String, IProblem> tempErrorLog;
protected void syntaxCheck() {
syntaxErrors.set(true);
containsErrors.set(true);
parser.setSource(sourceCode.toCharArray());
parser.setKind(ASTParser.K_COMPILATION_UNIT);
Map<String, String> options = JavaCore.getOptions();
JavaCore.setComplianceOptions(JavaCore.VERSION_1_8, options);
options.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_8);
options.put(JavaCore.COMPILER_DOC_COMMENT_SUPPORT, JavaCore.ENABLED);
parser.setCompilerOptions(options);
if (cu == null)
cu = (CompilationUnit) parser.createAST(null);
else {
synchronized (cu) {
cu = (CompilationUnit) parser.createAST(null);
}
}
compilationUnitState = 1;
synchronized (problemsList) {
// Store errors returned by the ast parser
problems = cu.getProblems();
// log("Problem Count: " + problems.length);
// Populate the probList
problemsList = new ArrayList<Problem>();
for (int i = 0; i < problems.length; i++) {
int a[] = calculateTabIndexAndLineNumber(problems[i].getSourceLineNumber());
Problem p = new Problem(problems[i], a[0], a[1]);
problemsList.add(p);
// log(problems[i].getMessage());
// for (String j : problems[i].getArguments()) {
// log("arg " + j);
// }
// log(p.toString());
}
if (problems.length == 0) {
syntaxErrors.set(false);
containsErrors.set(false);
parser.setSource(sourceCode.toCharArray());
parser.setKind(ASTParser.K_COMPILATION_UNIT);
parser.setCompilerOptions(options);
lastCorrectCU = (CompilationUnit) parser.createAST(null);
} else {
syntaxErrors.set(true);
containsErrors.set(true);
}
}
}
protected URLClassLoader classLoader;
protected void compileCheck() {
// CU needs to be updated coz before compileCheck xqpreprocessor is run on
// the source code which makes some further changes
//TODO Check if this breaks things
parser.setSource(sourceCode.toCharArray());
parser.setKind(ASTParser.K_COMPILATION_UNIT);
Map<String, String> options = JavaCore.getOptions();
JavaCore.setComplianceOptions(JavaCore.VERSION_1_8, options);
options.put(JavaCore.COMPILER_SOURCE, JavaCore.VERSION_1_8);
options.put(JavaCore.COMPILER_DOC_COMMENT_SUPPORT, JavaCore.ENABLED);
parser.setCompilerOptions(options);
if (compileCheckCU == null) {
compileCheckCU = (CompilationUnit) parser.createAST(null);
} else {
synchronized (compileCheckCU) {
compileCheckCU = (CompilationUnit) parser.createAST(null);
}
}
if (!hasSyntaxErrors()) {
lastCorrectCU = compileCheckCU;
}
cu = compileCheckCU;
compilationUnitState = 2;
// Currently (Sept, 2012) I'm using Java's reflection api to load the
// CompilationChecker class(from CompilationChecker.jar) that houses the
// Eclispe JDT compiler, and call its getErrorsAsObj method to obtain
// errors. This way, I'm able to add the paths of contributed libraries
// to the classpath of CompilationChecker, dynamically. The eclipse compiler
// needs all referenced libraries in the classpath. Totally a hack. If you find
// a better method, do let me know.
try {
// NOTE TO SELF: If classpath contains null Strings
// URLClassLoader shoots NPE bullets.
// If imports have changed, reload classes with new classpath.
if (loadCompClass) {
classPath = new URL[classpathJars.size()];
classpathJars.toArray(classPath);
compilationChecker = null;
classLoader = null;
System.gc();
// log("CP Len -- " + classpath.length);
classLoader = new URLClassLoader(classPath);
compilationChecker = new CompilationChecker();
loadCompClass = false;
}
if (compilerSettings == null) {
prepareCompilerSetting();
}
synchronized (problemsList) {
problems = compilationChecker.getErrors(className, sourceCode,
compilerSettings, classLoader);
if (problems == null) {
return;
}
for (IProblem problem : problems) {
// added a -1 to line number because in compile check code
// an extra package statement is added, so all line numbers
// are increased by 1
int[] a = calculateTabIndexAndLineNumber(problem.getSourceLineNumber() - 1);
Problem p = new Problem(problem, a[0], a[1]);
if (problem.isError()) {
p.setType(Problem.ERROR);
containsErrors.set(true); // set flag
}
if (problem.isWarning()) {
p.setType(Problem.WARNING);
}
// If warnings are disabled, skip 'em
if (p.isWarning() && !JavaMode.warningsEnabled) {
continue;
}
problemsList.add(p);
}
}
} catch (Exception e) {
System.err.println("compileCheck() problem." + e);
e.printStackTrace();
pauseThread();
} catch (NoClassDefFoundError e) {
e.printStackTrace();
pauseThread();
} catch(OutOfMemoryError e) {
System.err.println("Out of memory while checking for errors.");
System.err.println("Close some sketches and then re-open this sketch.");
pauseThread();
}
}
/**
* Calculates PDE Offsets from Java Offsets for Problems
*/
private void calcPdeOffsetsForProbList() {
try {
PlainDocument javaSource = new PlainDocument();
javaSource.insertString(0, sourceCode, null);
// Code in pde tabs stored as PlainDocument
List<Document> pdeTabs = new ArrayList<>();
for (SketchCode sc : editor.getSketch().getCode()) {
PlainDocument tab = new PlainDocument();
if (editor.getSketch().getCurrentCode().equals(sc)) {
tab.insertString(0, sc.getDocumentText(), null);
} else {
tab.insertString(0, sc.getProgram(), null);
}
pdeTabs.add(tab);
}
int pkgNameOffset = ("package " + className + ";\n").length();
// package name is added only during compile check
if (compilationUnitState != 2) {
pkgNameOffset = 0;
}
for (Problem p : problemsList) {
int prbStart = p.getIProblem().getSourceStart() - pkgNameOffset;
int prbEnd = p.getIProblem().getSourceEnd() - pkgNameOffset;
int javaLineNumber = p.getSourceLineNumber() - 1;
// not sure if this is necessary [fry 150808]
if (compilationUnitState == 2) {
javaLineNumber--;
}
// errors on the first line were setting this to -1 [fry 150808]
if (javaLineNumber < 0) {
javaLineNumber = 0;
}
Element lineElement =
javaSource.getDefaultRootElement().getElement(javaLineNumber);
if (lineElement == null) {
Messages.log("calcPDEOffsetsForProbList(): " +
"Couldn't fetch Java line number " +
javaLineNumber + "\nProblem: " + p);
p.setPDEOffsets(-1, -1);
continue;
}
int lineStart = lineElement.getStartOffset();
int lineLength = lineElement.getEndOffset() - lineStart;
String javaLine = javaSource.getText(lineStart, lineLength);
Document doc = pdeTabs.get(p.getTabIndex());
Element pdeLineElement =
doc.getDefaultRootElement().getElement(p.getLineNumber());
if (pdeLineElement == null) {
Messages.log("calcPDEOffsetsForProbList(): " +
"Couldn't fetch pde line number " +
javaLineNumber + "\nProblem: " + p);
p.setPDEOffsets(-1,-1);
continue;
}
int pdeLineStart = pdeLineElement.getStartOffset();
int pdeLineLength = pdeLineElement.getEndOffset() - pdeLineStart;
String pdeLine =
pdeTabs.get(p.getTabIndex()).getText(pdeLineStart, pdeLineLength);
OffsetMatcher ofm = new OffsetMatcher(pdeLine, javaLine);
int pdeOffset =
ofm.getPdeOffForJavaOff(prbStart - lineStart, prbEnd - prbStart + 1);
p.setPDEOffsets(pdeOffset, pdeOffset + prbEnd - prbStart);
}
} catch (BadLocationException ble) {
ble.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
}
}
public CompilationUnit getLastCorrectCU() {
return lastCorrectCU;
}
public CompilationUnit getLatestCU() {
return compileCheckCU;
}
private int loadClassCounter = 0;
public URLClassLoader getSketchClassLoader() {
loadClassCounter++;
if (loadClassCounter > 100) {
loadClassCounter = 0;
classLoader = null;
System.gc();
classLoader = new URLClassLoader(classPath);
}
return classLoader;
}
/**
* Processes import statements to obtain class paths of contributed
* libraries. This would be needed for compilation check. Also, adds
* stuff(jar files, class files, candy) from the code folder. And it looks
* messed up.
*/
protected void prepareCompilerClasspath() {
if (!loadCompClass) {
return;
}
synchronized (classpathJars) {
// log("1..");
classpathJars = new ArrayList<URL>();
String entry = "";
boolean codeFolderChecked = false;
for (ImportStatement impstat : programImports) {
String item = impstat.getImportName();
int dot = item.lastIndexOf('.');
entry = (dot == -1) ? item : item.substring(0, dot);
entry = entry.substring(6).trim();
// log("Entry--" + entry);
if (ignorableImport(entry)) {
// log("Ignoring: " + entry);
continue;
}
Library library = null;
// Try to get the library classpath and add it to the list
try {
library = editor.getMode().getLibrary(entry);
String[] libraryPath =
PApplet.split(library.getClassPath().substring(1).trim(),
File.pathSeparatorChar);
for (String pathItem : libraryPath) {
classpathJars.add(new File(pathItem).toURI().toURL());
}
} catch (Exception e) {
if (library == null && !codeFolderChecked) {
// Look around in the code folder for jar files
if (editor.getSketch().hasCodeFolder()) {
File codeFolder = editor.getSketch().getCodeFolder();
// get a list of .jar files in the "code" folder
// (class files in subfolders should also be picked up)
String codeFolderClassPath = Util.contentsToClassPath(codeFolder);
codeFolderChecked = true;
// huh? doesn't this mean .length() == 0? [fry]
if (codeFolderClassPath.equalsIgnoreCase("")) {
String message = String.format("Cannot find \"%s\" library in code folder. Line %d in tab %s%n",
entry, impstat.getLineNumber(),
editor.getSketch().getCode(impstat.getTab()).getPrettyName());
Messages.log(message);
} else {
String codeFolderPath[] =
PApplet.split(codeFolderClassPath.substring(1).trim(),
File.pathSeparatorChar);
try {
for (String pathItem : codeFolderPath) {
classpathJars.add(new File(pathItem).toURI().toURL());
}
} catch (Exception e2) {
e2.printStackTrace();
}
}
}
}
}
}
// Also add jars specified in mode's search path
String modeJars[] = ((JavaMode) getEditor().getMode()).getSearchPath().split(File.pathSeparatorChar + "");
for (String mj : modeJars) {
try {
classpathJars.add(new File(mj).toURI().toURL());
} catch (MalformedURLException e) {
e.printStackTrace();
}
}
}
new Thread(new Runnable() {
public void run() {
astGenerator.loadJars(); // update jar file for completion lookup
}
}).start();
}
/**
* Ignore processing packages, java.*.*. etc.
*/
protected boolean ignorableImport(String packageName) {
return (packageName.startsWith("java.") ||
packageName.startsWith("javax."));
}
/** Options for the JDT Compiler */
protected Map<String, String> compilerSettings;
/** Set compiler options for JDT Compiler */
protected void prepareCompilerSetting() {
compilerSettings = new HashMap<String, String>();
compilerSettings.put(CompilerOptions.OPTION_LineNumberAttribute,
CompilerOptions.GENERATE);
compilerSettings.put(CompilerOptions.OPTION_SourceFileAttribute,
CompilerOptions.GENERATE);
compilerSettings.put(CompilerOptions.OPTION_Source,
CompilerOptions.VERSION_1_8);
compilerSettings.put(CompilerOptions.OPTION_ReportUnusedImport,
CompilerOptions.IGNORE);
compilerSettings.put(CompilerOptions.OPTION_ReportMissingSerialVersion,
CompilerOptions.IGNORE);
compilerSettings.put(CompilerOptions.OPTION_ReportRawTypeReference,
CompilerOptions.IGNORE);
compilerSettings.put(CompilerOptions.OPTION_ReportUncheckedTypeOperation,
CompilerOptions.IGNORE);
}
/**
* Updates the error table in the Error Window.
*/
public void updateErrorTable() {
try {
ErrorTable table = editor.getErrorTable();
table.clearRows();
// String[][] errorData = new String[problemsList.size()][3];
// int index = 0;
// for (int i = 0; i < problemsList.size(); i++) {
Sketch sketch = editor.getSketch();
for (Problem p : problemsList) {
String message = p.getMessage();
if (Preferences.getBoolean(JavaMode.SUGGEST_IMPORTS_PREF)) {
if (p.getIProblem().getID() == IProblem.UndefinedType) {
String[] args = p.getIProblem().getArguments();
if (args.length > 0) {
String missingClass = args[0];
String[] si = astGenerator.getSuggestImports(missingClass);
if (si != null && si.length > 0) {
p.setImportSuggestions(si);
// errorData[index][0] = "<html>" + p.getMessage() +
// " (<font color=#0000ff><u>Import Suggestions available</u></font>)</html>";
message += " (double-click for suggestions)";
}
}
}
}
table.addRow(p, message,
sketch.getCode(p.getTabIndex()).getPrettyName(),
Integer.toString(p.getLineNumber() + 1));
// Added +1 because lineNumbers internally are 0-indexed
// //TODO: This is temporary
// if (tempErrorLog.size() < 200) {
// tempErrorLog.put(p.getMessage(), p.getIProblem());
// }
}
// table.updateColumns();
// DefaultTableModel tm =
// new DefaultTableModel(errorData, XQErrorTable.columnNames);
// editor.updateTable(tm);
} catch (Exception e) {
Messages.loge("Exception at updateErrorTable()", e);
e.printStackTrace();
pauseThread();
}
}
/** Repaints the textarea if required */
private void updatePaintedThingys() {
// currentTab = editor.getSketch().getCodeIndex(editor.getSketch().getCurrentCode());
currentTab = editor.getSketch().getCurrentCodeIndex();
//log("Tab changed " + currentTab + " LT " + lastTab);
if (currentTab != lastTab) {
textModified.set(5);
lastTab = currentTab;
editor.getTextArea().repaint();
editor.statusEmpty();
}
}
protected int lastCaretLine = -1;
/**
* Updates editor status bar, depending on whether the caret is on an error
* line or not
*/
private void updateEditorStatus() {
if (editor.getStatusMode() == EditorStatus.EDIT) return;
// editor.statusNotice("Position: " +
// editor.getTextArea().getCaretLine());
if (JavaMode.errorCheckEnabled) {
List<LineMarker> errorPoints = editor.getErrorPoints();
synchronized (errorPoints) {
for (LineMarker emarker : errorPoints) {
if (emarker.getProblem().getLineNumber() == editor.getTextArea().getCaretLine()) {
if (emarker.getType() == LineMarker.WARNING) {
editor.statusMessage(emarker.getProblem().getMessage(),
JavaEditor.STATUS_INFO);
} else {
editor.statusMessage(emarker.getProblem().getMessage(),
JavaEditor.STATUS_COMPILER_ERR);
}
return;
}
}
}
}
// This line isn't an error line anymore, so probably just clear it
if (editor.statusMessageType == JavaEditor.STATUS_COMPILER_ERR) {
editor.statusEmpty();
return;
}
// if (editor.ta.getCaretLine() != lastCaretLine) {
// editor.statusEmpty();
// lastCaretLine = editor.ta.getCaretLine();
// }
}
/**
* Maps offset from java code to pde code. Returns a bunch of offsets as array
*
* @param line
* - line number in java code
* @param offset
* - offset from the start of the 'line'
* @return int[0] - tab number, int[1] - line number in the int[0] tab, int[2]
* - line start offset, int[3] - offset from line start. int[2] and
* int[3] are on TODO
*/
protected int[] JavaToPdeOffsets(int line, int offset) {
int codeIndex = 0;
int x = line - mainClassOffset;
if (x < 0) {
// log("Negative line number "
// + problem.getSourceLineNumber() + " , offset "
// + mainClassOffset);
x = line - 2; // Another -1 for 0 index
if (x < programImports.size() && x >= 0) {
ImportStatement is = programImports.get(x);
// log(is.importName + ", " + is.tab + ", "
// + is.lineNumber);
return new int[] { is.getTab(), is.getLineNumber() };
} else {
// Some seriously ugly stray error, just can't find the source
// line! Simply return first line for first tab.
return new int[] { 0, 1 };
}
}
try {
for (SketchCode sc : editor.getSketch().getCode()) {
if (sc.isExtension("pde")) {
int len = 0;
if (editor.getSketch().getCurrentCode().equals(sc)) {
len = Util.countLines(sc.getDocumentText()) + 1;
} else {
len = Util.countLines(sc.getProgram()) + 1;
}
// log("x,len, CI: " + x + "," + len + ","
// + codeIndex);
if (x >= len) {
// We're in the last tab and the line count is greater
// than the no.
// of lines in the tab,
if (codeIndex >= editor.getSketch().getCodeCount() - 1) {
// log("Exceeds lc " + x + "," + len
// + problem.toString());
// x = len
x = editor.getSketch().getCode(codeIndex)
.getLineCount();
// TODO: Obtain line having last non-white space
// character in the code.
break;
} else {
x -= len;
codeIndex++;
}
} else {
if (codeIndex >= editor.getSketch().getCodeCount()) {
codeIndex = editor.getSketch().getCodeCount() - 1;
}
break;
}
}
}
} catch (Exception e) {
System.err.println("Error inside ErrorCheckerService.JavaToPdeOffset()");
e.printStackTrace();
}
return new int[] { codeIndex, x };
}
protected String getPdeCodeAtLine(int tab, int linenumber){
if(linenumber < 0) return null;
editor.getSketch().setCurrentCode(tab);
return editor.getTextArea().getLineText(linenumber);
}
/**
* Calculates the tab number and line number of the error in that particular
* tab. Provides mapping between pure java and pde code.
*
* @param javalineNumber
* - int
* @return int[0] - tab number, int[1] - line number
*/
protected int[] calculateTabIndexAndLineNumber(int javalineNumber) {
// String[] lines = {};// = PApplet.split(sourceString, '\n');
int codeIndex = 0;
int x = javalineNumber - mainClassOffset;
if (x < 0) {
// log("Negative line number "
// + problem.getSourceLineNumber() + " , offset "
// + mainClassOffset);
x = javalineNumber - 2; // Another -1 for 0 index
if (x < programImports.size() && x >= 0) {
ImportStatement is = programImports.get(x);
// log(is.importName + ", " + is.tab + ", "
// + is.lineNumber);
return new int[] { is.getTab(), is.getLineNumber() };
} else {
// Some seriously ugly stray error, just can't find the source
// line! Simply return first line for first tab.
return new int[] { 0, 1 };
}
}
try {
for (SketchCode sc : editor.getSketch().getCode()) {
if (sc.isExtension("pde")) {
int len = 0;
if (editor.getSketch().getCurrentCode().equals(sc)) {
len = Util.countLines(sc.getDocumentText()) + 1;
} else {
len = Util.countLines(sc.getProgram()) + 1;
}
// log("x,len, CI: " + x + "," + len + ","
// + codeIndex);
if (x >= len) {
// We're in the last tab and the line count is greater
// than the no.
// of lines in the tab,
if (codeIndex >= editor.getSketch().getCodeCount() - 1) {
// log("Exceeds lc " + x + "," + len
// + problem.toString());
// x = len
x = editor.getSketch().getCode(codeIndex)
.getLineCount();
// TODO: Obtain line having last non-white space
// character in the code.
break;
} else {
x -= len;
codeIndex++;
}
} else {
if (codeIndex >= editor.getSketch().getCodeCount()) {
codeIndex = editor.getSketch().getCodeCount() - 1;
}
break;
}
}
}
} catch (Exception e) {
System.err.println("Things got messed up in ErrorCheckerService.calculateTabIndexAndLineNumber()");
}
return new int[] { codeIndex, x };
}
/**
* Returns line number of corresponding java source
*/
protected int getJavaLineNumFromPDElineNum(int tab, int pdeLineNum){
int jLineNum = programImports.size() + 1;
for (int i = 0; i < tab; i++) {
SketchCode sc = editor.getSketch().getCode(i);
int len = Util.countLines(sc.getProgram()) + 1;
jLineNum += len;
}
return jLineNum;
}
/**
* Fetches code from the editor tabs and pre-processes it into parsable pure
* java source. And there's a difference between parsable and compilable.
* XQPrerocessor.java makes this code compilable. <br>
* Handles: <li>Removal of import statements <li>Conversion of int(),
* char(), etc to PApplet.parseInt(), etc. <li>Replacing '#' with 0xff for
* color representation<li>Converts all 'color' datatypes to int
* (experimental) <li>Appends class declaration statement after determining
* the mode the sketch is in - ACTIVE or STATIC
*
* @return String - Pure java representation of PDE code. Note that this
* code is not yet compile ready.
*/
protected String preprocessCode(String pdeCode) {
programImports = new ArrayList<ImportStatement>();
StringBuilder rawCode = new StringBuilder();
final Sketch sketch = editor.getSketch();
try {
for (SketchCode sc : sketch.getCode()) {
if (sc.isExtension("pde")) {
try {
if (sketch.getCurrentCode().equals(sc)) {
rawCode.append(scrapImportStatements(sc.getDocumentText(),
sketch.getCodeIndex(sc)));
} else {
rawCode.append(scrapImportStatements(sc.getProgram(),
sketch.getCodeIndex(sc)));
}
rawCode.append('\n');
} catch (Exception e) {
e.printStackTrace();
}
rawCode.append('\n');
}
}
} catch (Exception e) {
Messages.log("Exception in preprocessCode()");
}
String sourceAlt = rawCode.toString();
// Replace comments with whitespaces
// sourceAlt = scrubComments(sourceAlt);
// Find all int(*), replace with PApplet.parseInt(*)
// \bint\s*\(\s*\b , i.e all exclusive "int("
String dataTypeFunc[] = { "int", "char", "float", "boolean", "byte" };
for (String dataType : dataTypeFunc) {
String dataTypeRegexp = "\\b" + dataType + "\\s*\\(";
Pattern pattern = Pattern.compile(dataTypeRegexp);
Matcher matcher = pattern.matcher(sourceAlt);
// while (matcher.find()) {
// System.out.print("Start index: " + matcher.start());
// log(" End index: " + matcher.end() + " ");
// log("-->" + matcher.group() + "<--");
// }
sourceAlt = matcher.replaceAll("PApplet.parse"
+ Character.toUpperCase(dataType.charAt(0))
+ dataType.substring(1) + "(");
}
// Find all #[web color] and replace with 0xff[webcolor]
// Should be 6 digits only.
final String webColorRegexp = "#{1}[A-F|a-f|0-9]{6}\\W";
Pattern webPattern = Pattern.compile(webColorRegexp);
Matcher webMatcher = webPattern.matcher(sourceAlt);
while (webMatcher.find()) {
// log("Found at: " + webMatcher.start());
String found = sourceAlt.substring(webMatcher.start(),
webMatcher.end());
// log("-> " + found);
sourceAlt = webMatcher.replaceFirst("0xff" + found.substring(1));
webMatcher = webPattern.matcher(sourceAlt);
}
// Replace all color data types with int
// Regex, Y U SO powerful?
final String colorTypeRegex = "color(?![a-zA-Z0-9_])(?=\\[*)(?!(\\s*\\())";
Pattern colorPattern = Pattern.compile(colorTypeRegex);
Matcher colorMatcher = colorPattern.matcher(sourceAlt);
sourceAlt = colorMatcher.replaceAll("int");
checkForChangedImports();
className = (editor == null) ?
"DefaultClass" : editor.getSketch().getName();
// Check whether the code is being written in STATIC mode(no function
// declarations) - append class declaration and void setup() declaration
Matcher matcher = FUNCTION_DECL.matcher(sourceAlt);
staticMode = !matcher.find();
StringBuilder sb = new StringBuilder();
sb.append(xqpreproc.prepareImports(programImports));
sb.append("public class " + className + " extends PApplet {\n");
if (staticMode) {
sb.append("public void setup() {\n");
}
sb.append(sourceAlt);
if (staticMode) {
sb.append("\nnoLoop();\n}");
}
sb.append("\n}");
sourceAlt = sb.toString();
int position = sourceAlt.indexOf("{") + 1;
mainClassOffset = 1;
for (int i = 0; i <= position; i++) {
if (sourceAlt.charAt(i) == '\n') {
mainClassOffset++;
}
}
if (staticMode) {
mainClassOffset++;
}
sourceAlt = substituteUnicode(sourceAlt);
sourceCode = sourceAlt;
return sourceAlt;
}
/**
* Now defunct.
* The super method that highlights any ASTNode in the pde editor =D
* @param awrap
* @return true - if highlighting happened correctly.
*/
private boolean highlightNode(ASTNodeWrapper awrap){
Messages.log("Highlighting: " + awrap);
try {
int pdeoffsets[] = awrap.getPDECodeOffsets(this);
int javaoffsets[] = awrap.getJavaCodeOffsets(this);
Messages.log("offsets: " +pdeoffsets[0] + "," +
pdeoffsets[1]+ "," +javaoffsets[1]+ "," +
javaoffsets[2]);
scrollToErrorLine(editor, pdeoffsets[0],
pdeoffsets[1],javaoffsets[1],
javaoffsets[2]);
return true;
} catch (Exception e) {
Messages.loge("Scrolling failed for " + awrap);
// e.printStackTrace();
}
return false;
}
public boolean highlightNode(ASTNode node){
ASTNodeWrapper awrap = new ASTNodeWrapper(node);
return highlightNode(awrap);
}
/**
* Scrolls to the error source in code. And selects the line text. Used by
* XQErrorTable and ErrorBar
*
* @param errorIndex
* - index of error
*/
public void scrollToErrorLine(int errorIndex) {
if (editor == null) {
return;
}
if (errorIndex < problemsList.size() && errorIndex >= 0) {
Problem p = problemsList.get(errorIndex);
scrollToErrorLine(p);
}
}
public void scrollToErrorLine(Problem p) {
if (editor == null) {
return;
}
if (p == null)
return;
try {
if(p.getPDELineStartOffset() == -1 || p.getPDELineStopOffset() == -1){
// bad offsets, don't highlight, just scroll.
editor.toFront();
editor.getSketch().setCurrentCode(p.getTabIndex());
}
else {
astGenerator.highlightPDECode(p.getTabIndex(),
p.getLineNumber(),
p.getPDELineStartOffset(),
(p.getPDELineStopOffset()
- p.getPDELineStartOffset() + 1));
}
// scroll, but within boundaries
// It's also a bit silly that if parameters to scrollTo() are out of range,
// a BadLocation Exception is thrown internally and caught in JTextArea AND
// even the stack trace gets printed! W/o letting me catch it later! SMH
// That's because 1) you can prevent it by not causing the BLE,
// and 2) there are so many JEditSyntax bugs that actually throwing the
// exception all the time would cause the editor to shut down over
// trivial/recoverable quirks. It's the least bad option. [fry]
final Document doc = editor.getTextArea().getDocument();
final int lineCount = Util.countLines(doc.getText(0, doc.getLength()));
if (p.getLineNumber() < lineCount && p.getLineNumber() >= 0) {
editor.getTextArea().scrollTo(p.getLineNumber(), 0);
}
editor.repaint();
} catch (Exception e) {
Messages.loge("Error while selecting text in scrollToErrorLine(), for problem: " + p, e);
}
// log("---");
}
/**
* Static method for scroll to a particular line in the PDE. Also highlights
* the length of the text. Requires the editor instance as arguement.
*
* @param edt
* @param tabIndex
* @param lineNoInTab
* - line number in the corresponding tab
* @param lineStartOffset
* - selection start offset(from line start non-whitespace offset)
* @param length
* - length of selection
* @return - true, if scroll was successful
*/
public static boolean scrollToErrorLine(Editor edt, int tabIndex, int lineNoInTab, int lineStartOffset, int length) {
if (edt == null) {
return false;
}
try {
edt.toFront();
edt.getSketch().setCurrentCode(tabIndex);
int lsno = edt.getTextArea()
.getLineStartNonWhiteSpaceOffset(lineNoInTab - 1) + lineStartOffset;
edt.setSelection(lsno, lsno + length);
edt.getTextArea().scrollTo(lineNoInTab - 1, 0);
edt.repaint();
Messages.log(lineStartOffset + " LSO,len " + length);
} catch (Exception e) {
System.err.println(e
+ " : Error while selecting text in static scrollToErrorLine()");
e.printStackTrace();
return false;
}
return true;
}
/**
* Checks if import statements in the sketch have changed. If they have,
* compiler classpath needs to be updated.
*/
protected void checkForChangedImports() {
// log("Imports: " + programImports.size() +
// " Prev Imp: "
// + previousImports.size());
if (programImports.size() != previousImports.size()) {
// log(1);
loadCompClass = true;
previousImports = programImports;
} else {
for (int i = 0; i < programImports.size(); i++) {
if (!programImports.get(i).getImportName().equals(previousImports
.get(i).getImportName())) {
// log(2);
loadCompClass = true;
previousImports = programImports;
break;
}
}
}
// log("load..? " + loadCompClass);
}
protected int pdeImportsCount;
public int getPdeImportsCount() {
return pdeImportsCount;
}
/**
* Removes import statements from tabSource, replaces each with white spaces
* and adds the import to the list of program imports
*
* @param tabProgram
* - Code in a tab
* @param tabNumber
* - index of the tab
* @return String - Tab code with imports replaced with white spaces
*/
protected String scrapImportStatements(String tabProgram, int tabNumber) {
//TODO: Commented out imports are still detected as main imports.
pdeImportsCount = 0;
String tabSource = new String(tabProgram);
do {
// log("-->\n" + sourceAlt + "\n<--");
String[] pieces = PApplet.match(tabSource, importRegexp);
// Stop the loop if we've removed all the import lines
if (pieces == null) {
break;
}
String piece = pieces[1] + pieces[2] + pieces[3];
int len = piece.length(); // how much to trim out
// programImports.add(piece); // the package name
// find index of this import in the program
int idx = tabSource.indexOf(piece);
// System.out.print("Import -> " + piece);
// log(" - "
// + Base.countLines(tabSource.substring(0, idx)) + " tab "
// + tabNumber);
int lineCount = Util.countLines(tabSource.substring(0, idx));
programImports.add(new ImportStatement(piece, tabNumber, lineCount));
// Remove the import from the main program
// Substitute with white spaces
String whiteSpace = "";
for (int j = 0; j < piece.length(); j++) {
whiteSpace += " ";
}
tabSource = tabSource.substring(0, idx) + whiteSpace
+ tabSource.substring(idx + len);
pdeImportsCount++;
} while (true);
// log(tabSource);
return tabSource;
}
/**
* Replaces non-ascii characters with their unicode escape sequences and
* stuff. Used as it is from
* processing.src.processing.mode.java.preproc.PdePreprocessor
*
* @param program
* - Input String containing non ascii characters
* @return String - Converted String
*/
public static String substituteUnicode(String program) {
// check for non-ascii chars (these will be/must be in unicode format)
char p[] = program.toCharArray();
int unicodeCount = 0;
for (int i = 0; i < p.length; i++) {
if (p[i] > 127) {
unicodeCount++;
}
}
if (unicodeCount == 0) {
return program;
}
// if non-ascii chars are in there, convert to unicode escapes
// add unicodeCount * 5.. replacing each unicode char
// with six digit uXXXX sequence (xxxx is in hex)
// (except for nbsp chars which will be a replaced with a space)
int index = 0;
char p2[] = new char[p.length + unicodeCount * 5];
for (int i = 0; i < p.length; i++) {
if (p[i] < 128) {
p2[index++] = p[i];
} else if (p[i] == 160) { // unicode for non-breaking space
p2[index++] = ' ';
} else {
int c = p[i];
p2[index++] = '\\';
p2[index++] = 'u';
char str[] = Integer.toHexString(c).toCharArray();
// add leading zeros, so that the length is 4
// for (int i = 0; i < 4 - str.length; i++) p2[index++] = '0';
for (int m = 0; m < 4 - str.length; m++)
p2[index++] = '0';
System.arraycopy(str, 0, p2, index, str.length);
index += str.length;
}
}
return new String(p2, 0, index);
}
public void handleErrorCheckingToggle() {
if (!JavaMode.errorCheckEnabled) {
Messages.log(editor.getSketch().getName() + " Error Checker paused.");
//editor.clearErrorPoints();
editor.getErrorPoints().clear();
problemsList.clear();
updateErrorTable();
updateEditorStatus();
editor.getTextArea().repaint();
editor.repaintErrorBar();
} else {
Messages.log(editor.getSketch().getName() + " Error Checker resumed.");
runManualErrorCheck();
}
}
/**
* Stops the Error Checker Service thread
*/
public void stopThread() {
Messages.loge("Stopping thread: " + editor.getSketch().getName());
stopThread.set(true);
}
/**
* Pauses the Error Checker Service thread
*/
public void pauseThread() {
pauseThread.set(true);
}
/**
* Resumes the Error Checker Service thread
*/
public void resumeThread() {
pauseThread.set(false);
}
public JavaEditor getEditor() {
return editor;
}
// public static void log(String message){
// if(ExperimentalMode.DEBUG)
// log(message);
// }
//
// public static void log2(String message){
// if(ExperimentalMode.DEBUG)
// System.out.print(message);
// }
public ArrayList<ImportStatement> getProgramImports() {
return programImports;
}
}