Top Description Fields Constructors Methods
org.python.indexer.demos

pack-priv Class Styler

extends DefaultNodeVisitor
Class Inheritance
Imports
org.antlr.runtime.ANTLRStringStream, .BaseRecognizer, .CommonToken, .RecognitionException, .RecognizerSharedState, .Token, org.python.antlr.PythonLexer, .PythonTree, .RecordingErrorHandler, org.python.indexer.Def, .Indexer, .NBinding, .StyleRun, org.python.indexer.ast.DefaultNodeVisitor, .NAssign, .NFunctionDef, .NModule, .NName, .NNode, .NNum, .NStr, .NUrl, java.util.ArrayList, .HashSet, .List, .Set, java.util.regex.Matcher, .Pattern
Decorates Python source with style runs from the index.

Field Summary

Modifier and TypeField and Description
pack-priv static final Pattern
BUILTIN

private Set<Integer>
docOffsets

Offsets of doc strings found by node visitor.

private Indexer
indexer

private Linker
linker

private String
path

private String
source

private List<StyleRun>
styles

private static final Pattern
TRISTRING_PREFIX

Matches the start of a triple-quote string.

Inherited from org.python.indexer.ast.DefaultNodeVisitor:
traverseIntoNodes

Constructor Summary

AccessConstructor and Description
public
Styler(Indexer idx, Linker linker)

Method Summary

Modifier and TypeMethod and Description
private void
addStyle(NNode e, int start, int len, StyleRun.Type type)

private void
addStyle(NNode e, StyleRun.Type type)

private void
addStyle(int beg, int len, StyleRun.Type type)

public List<StyleRun>
addStyles(String
absolute file path
path, String
file contents
src)

Entry point for decorating a source file.

private void
highlightDocString(NStr node)

private void
highlightLexicalTokens()

Use scanner to find keywords, strings and comments.

private String
sourceString(NNode e)

private String
sourceString(int beg, int end)

public boolean
visit(NName n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

public boolean
visit(NNum n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

public boolean
visit(NStr n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

Inherited from org.python.indexer.ast.DefaultNodeVisitor:
stopTraversalvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisitvisit

Field Detail

BUILTINback to summary
pack-priv static final Pattern BUILTIN
docOffsetsback to summary
private Set<Integer> docOffsets

Offsets of doc strings found by node visitor.

indexerback to summary
private Indexer indexer
linkerback to summary
private Linker linker
pathback to summary
private String path
sourceback to summary
private String source
stylesback to summary
private List<StyleRun> styles
TRISTRING_PREFIXback to summary
private static final Pattern TRISTRING_PREFIX

Matches the start of a triple-quote string.

Constructor Detail

Stylerback to summary
public Styler(Indexer idx, Linker linker)

Method Detail

addStyleback to summary
private void addStyle(NNode e, int start, int len, StyleRun.Type type)
addStyleback to summary
private void addStyle(NNode e, StyleRun.Type type)
addStyleback to summary
private void addStyle(int beg, int len, StyleRun.Type type)
addStylesback to summary
public List<StyleRun> addStyles(String path, String src) throws Exception

Entry point for decorating a source file.

Parameters
path:String

absolute file path

src:String

file contents

highlightDocStringback to summary
private void highlightDocString(NStr node)
highlightLexicalTokensback to summary
private void highlightLexicalTokens()

Use scanner to find keywords, strings and comments.

sourceStringback to summary
private String sourceString(NNode e)
sourceStringback to summary
private String sourceString(int beg, int end)
visitback to summary
public boolean visit(NName n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

Annotations
@Override
visitback to summary
public boolean visit(NNum n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

Annotations
@Override
visitback to summary
public boolean visit(NStr n)

Overrides org.python.indexer.ast.DefaultNodeVisitor.visit.

Implements org.python.indexer.ast.NNodeVisitor.visit.

Annotations
@Override