src.org.python.indexer.demos.Styler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jython-installer Show documentation
Show all versions of jython-installer Show documentation
Jython is an implementation of the high-level, dynamic, object-oriented
language Python written in 100% Pure Java, and seamlessly integrated with
the Java platform. It thus allows you to run Python on any Java platform.
/**
* Copyright 2009, Google Inc. All rights reserved.
* Licensed to PSF under a Contributor Agreement.
*/
package org.python.indexer.demos;
import org.antlr.runtime.ANTLRStringStream;
import org.antlr.runtime.BaseRecognizer;
import org.antlr.runtime.CommonToken;
import org.antlr.runtime.RecognitionException;
import org.antlr.runtime.RecognizerSharedState;
import org.antlr.runtime.Token;
import org.python.antlr.PythonLexer;
import org.python.antlr.PythonTree;
import org.python.antlr.RecordingErrorHandler;
import org.python.indexer.Def;
import org.python.indexer.Indexer;
import org.python.indexer.NBinding;
import org.python.indexer.StyleRun;
import org.python.indexer.ast.DefaultNodeVisitor;
import org.python.indexer.ast.NAssign;
import org.python.indexer.ast.NFunctionDef;
import org.python.indexer.ast.NModule;
import org.python.indexer.ast.NName;
import org.python.indexer.ast.NNode;
import org.python.indexer.ast.NNum;
import org.python.indexer.ast.NStr;
import org.python.indexer.ast.NUrl;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Decorates Python source with style runs from the index.
*/
class Styler extends DefaultNodeVisitor {
static final Pattern BUILTIN =
Pattern.compile("None|True|False|NotImplemented|Ellipsis|__debug__");
/**
* Matches the start of a triple-quote string.
*/
private static final Pattern TRISTRING_PREFIX =
Pattern.compile("^[ruRU]{0,2}['\"]{3}");
private Indexer indexer;
private String source;
private String path;
private List styles = new ArrayList();
private Linker linker;
/** Offsets of doc strings found by node visitor. */
private Set docOffsets = new HashSet();
public Styler(Indexer idx, Linker linker) {
this.indexer = idx;
this.linker = linker;
}
/**
* Entry point for decorating a source file.
* @param path absolute file path
* @param src file contents
*/
public List addStyles(String path, String src) throws Exception {
this.path = path;
source = src;
NModule m = indexer.getAstForFile(path);
if (m != null) {
m.visit(this);
highlightLexicalTokens();
}
return styles;
}
@Override
public boolean visit(NName n) {
NNode parent = n.getParent();
if (parent instanceof NFunctionDef) {
NFunctionDef fn = (NFunctionDef)parent;
if (n == fn.name) {
addStyle(n, StyleRun.Type.FUNCTION);
} else if (n == fn.kwargs || n == fn.varargs) {
addStyle(n, StyleRun.Type.PARAMETER);
}
return true;
}
if (BUILTIN.matcher(n.id).matches()) {
addStyle(n, StyleRun.Type.BUILTIN);
return true;
}
return true;
}
@Override
public boolean visit(NNum n) {
addStyle(n, StyleRun.Type.NUMBER);
return true;
}
@Override
public boolean visit(NStr n) {
String s = sourceString(n.start(), n.end());
if (TRISTRING_PREFIX.matcher(s).lookingAt()) {
addStyle(n.start(), n.end() - n.start(), StyleRun.Type.DOC_STRING);
docOffsets.add(n.start()); // don't re-highlight as a string
highlightDocString(n);
}
return true;
}
private void highlightDocString(NStr node) {
String s = sourceString(node.start(), node.end());
DocStringParser dsp = new DocStringParser(s, node, linker);
dsp.setResolveReferences(true);
styles.addAll(dsp.highlight());
}
/**
* Use scanner to find keywords, strings and comments.
*/
private void highlightLexicalTokens() {
RecognizerSharedState state = new RecognizerSharedState();
state.errorRecovery = true; // don't issue 10 billion errors
PythonLexer lex = new PythonLexer(
new ANTLRStringStream(source) {
@Override
public String getSourceName() {
return path;
}
},
state);
lex.setErrorHandler(new RecordingErrorHandler() {
@Override
public void error(String message, PythonTree t) {
// don't println
}
@Override
public void reportError(BaseRecognizer br, RecognitionException re) {
// don't println
}
});
Token tok;
while ((tok = lex.nextToken()).getType() != Token.EOF) {
switch (tok.getType()) {
case PythonLexer.STRING: {
int beg = ((CommonToken)tok).getStartIndex();
int end = ((CommonToken)tok).getStopIndex();
if (!docOffsets.contains(beg)) {
addStyle(beg, end - beg + 1, StyleRun.Type.STRING);
}
break;
}
case PythonLexer.COMMENT: {
int beg = ((CommonToken)tok).getStartIndex();
int end = ((CommonToken)tok).getStopIndex();
String comment = tok.getText();
addStyle(beg, end - beg + 1, StyleRun.Type.COMMENT);
break;
}
case PythonLexer.AND:
case PythonLexer.AS:
case PythonLexer.ASSERT:
case PythonLexer.BREAK:
case PythonLexer.CLASS:
case PythonLexer.CONTINUE:
case PythonLexer.DEF:
case PythonLexer.DELETE:
case PythonLexer.ELIF:
case PythonLexer.EXCEPT:
case PythonLexer.FINALLY:
case PythonLexer.FOR:
case PythonLexer.FROM:
case PythonLexer.GLOBAL:
case PythonLexer.IF:
case PythonLexer.IMPORT:
case PythonLexer.IN:
case PythonLexer.IS:
case PythonLexer.LAMBDA:
case PythonLexer.NOT:
case PythonLexer.OR:
case PythonLexer.ORELSE:
case PythonLexer.PASS:
case PythonLexer.PRINT:
case PythonLexer.RAISE:
case PythonLexer.RETURN:
case PythonLexer.TRY:
case PythonLexer.WHILE:
case PythonLexer.WITH:
case PythonLexer.YIELD: {
int beg = ((CommonToken)tok).getStartIndex();
int end = ((CommonToken)tok).getStopIndex();
addStyle(beg, end - beg + 1, StyleRun.Type.KEYWORD);
break;
}
}
}
}
private void addStyle(NNode e, int start, int len, StyleRun.Type type) {
if (e == null || e.getFile() == null) { // if it's an NUrl, for instance
return;
}
addStyle(start, len, type);
}
private void addStyle(NNode e, StyleRun.Type type) {
if (e != null) {
addStyle(e, e.start(), e.end() - e.start(), type);
}
}
private void addStyle(int beg, int len, StyleRun.Type type) {
styles.add(new StyleRun(type, beg, len));
}
private String sourceString(NNode e) {
return sourceString(e.start(), e.end());
}
private String sourceString(int beg, int end) {
int a = Math.max(beg, 0);
int b = Math.min(end, source.length());
b = Math.max(b, 0);
try {
return source.substring(a, b);
} catch (StringIndexOutOfBoundsException sx) {
System.out.println("whoops: beg=" + a + ", end=" + b + ", len=" + source.length());
return "";
}
}
}