|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.antlr.runtime.CommonTokenStream
org.antlr.runtime.TokenRewriteStream
public class TokenRewriteStream
Useful for dumping out the input stream after doing some augmentation or other manipulations. You can insert stuff, replace, and delete chunks. Note that the operations are done lazily--only if you convert the buffer to a String. This is very efficient because you are not moving data around all the time. As the buffer of tokens is converted to strings, the toString() method(s) check to see if there is an operation at the current index. If so, the operation is done and then normal String rendering continues on the buffer. This is like having multiple Turing machine instruction streams (programs) operating on a single input tape. :) Since the operations are done lazily at toString-time, operations do not screw up the token index values. That is, an insert operation at token index i does not change the index values for tokens i+1..n-1. Because operations never actually alter the buffer, you may always get the original token stream back without undoing anything. Since the instructions are queued up, you can easily simulate transactions and roll back any changes if there is an error just by removing instructions. For example, CharStream input = new ANTLRFileStream("input"); TLexer lex = new TLexer(input); TokenRewriteStream tokens = new TokenRewriteStream(lex); T parser = new T(tokens); parser.startRule(); Then in the rules, you can execute Token t,u; ... input.insertAfter(t, "text to put after t");} input.insertAfter(u, "text after u");} System.out.println(tokens.toString()); Actually, you have to cast the 'input' to a TokenRewriteStream. :( You can also have multiple "instruction streams" and get multiple rewrites from a single pass over the input. Just name the instruction streams and use that name again when printing the buffer. This could be useful for generating a C file and also its header file--all from the same buffer: tokens.insertAfter("pass1", t, "text to put after t");} tokens.insertAfter("pass2", u, "text after u");} System.out.println(tokens.toString("pass1")); System.out.println(tokens.toString("pass2")); If you don't use named rewrite streams, a "default" stream is used as the first example shows.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_PROGRAM_NAME
|
protected java.util.Map |
lastRewriteTokenIndexes
Map String (program name) -> Integer index |
static int |
MIN_TOKEN_INDEX
|
static int |
PROGRAM_INIT_SIZE
|
protected java.util.Map |
programs
You may have multiple, named streams of rewrite operations. |
Fields inherited from class org.antlr.runtime.CommonTokenStream |
---|
channel, channelOverrideMap, discardOffChannelTokens, discardSet, lastMarker, p, tokens, tokenSource |
Constructor Summary | |
---|---|
TokenRewriteStream()
|
|
TokenRewriteStream(TokenSource tokenSource)
|
|
TokenRewriteStream(TokenSource tokenSource,
int channel)
|
Method Summary | |
---|---|
protected java.lang.String |
catOpText(java.lang.Object a,
java.lang.Object b)
|
void |
delete(int index)
|
void |
delete(int from,
int to)
|
void |
delete(java.lang.String programName,
int from,
int to)
|
void |
delete(java.lang.String programName,
Token from,
Token to)
|
void |
delete(Token indexT)
|
void |
delete(Token from,
Token to)
|
void |
deleteProgram()
|
void |
deleteProgram(java.lang.String programName)
Reset the program so that no instructions exist |
protected java.util.List |
getKindOfOps(java.util.List rewrites,
java.lang.Class kind)
|
protected java.util.List |
getKindOfOps(java.util.List rewrites,
java.lang.Class kind,
int before)
Get all operations before an index of a particular kind |
int |
getLastRewriteTokenIndex()
|
protected int |
getLastRewriteTokenIndex(java.lang.String programName)
|
protected java.util.List |
getProgram(java.lang.String name)
|
protected void |
init()
|
void |
insertAfter(int index,
java.lang.Object text)
|
void |
insertAfter(java.lang.String programName,
int index,
java.lang.Object text)
|
void |
insertAfter(java.lang.String programName,
Token t,
java.lang.Object text)
|
void |
insertAfter(Token t,
java.lang.Object text)
|
void |
insertBefore(int index,
java.lang.Object text)
|
void |
insertBefore(java.lang.String programName,
int index,
java.lang.Object text)
|
void |
insertBefore(java.lang.String programName,
Token t,
java.lang.Object text)
|
void |
insertBefore(Token t,
java.lang.Object text)
|
protected java.util.Map |
reduceToSingleOperationPerIndex(java.util.List rewrites)
We need to combine operations and report invalid operations (like overlapping replaces that are not completed nested). |
void |
replace(int from,
int to,
java.lang.Object text)
|
void |
replace(int index,
java.lang.Object text)
|
void |
replace(java.lang.String programName,
int from,
int to,
java.lang.Object text)
|
void |
replace(java.lang.String programName,
Token from,
Token to,
java.lang.Object text)
|
void |
replace(Token indexT,
java.lang.Object text)
|
void |
replace(Token from,
Token to,
java.lang.Object text)
|
void |
rollback(int instructionIndex)
|
void |
rollback(java.lang.String programName,
int instructionIndex)
Rollback the instruction stream for a program so that the indicated instruction (via instructionIndex) is no longer in the stream. |
protected void |
setLastRewriteTokenIndex(java.lang.String programName,
int i)
|
java.lang.String |
toDebugString()
|
java.lang.String |
toDebugString(int start,
int end)
|
java.lang.String |
toOriginalString()
|
java.lang.String |
toOriginalString(int start,
int end)
|
java.lang.String |
toString()
|
java.lang.String |
toString(int start,
int end)
Return the text of all tokens from start to stop, inclusive. |
java.lang.String |
toString(java.lang.String programName)
|
java.lang.String |
toString(java.lang.String programName,
int start,
int end)
|
Methods inherited from class org.antlr.runtime.CommonTokenStream |
---|
consume, discardOffChannelTokens, discardTokenType, fillBuffer, get, getSourceName, getTokens, getTokens, getTokens, getTokens, getTokens, getTokenSource, index, LA, LB, LT, mark, release, reset, rewind, rewind, seek, setTokenSource, setTokenTypeChannel, size, skipOffTokenChannels, skipOffTokenChannelsReverse, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_PROGRAM_NAME
public static final int PROGRAM_INIT_SIZE
public static final int MIN_TOKEN_INDEX
protected java.util.Map programs
protected java.util.Map lastRewriteTokenIndexes
Constructor Detail |
---|
public TokenRewriteStream()
public TokenRewriteStream(TokenSource tokenSource)
public TokenRewriteStream(TokenSource tokenSource, int channel)
Method Detail |
---|
protected void init()
public void rollback(int instructionIndex)
public void rollback(java.lang.String programName, int instructionIndex)
public void deleteProgram()
public void deleteProgram(java.lang.String programName)
public void insertAfter(Token t, java.lang.Object text)
public void insertAfter(int index, java.lang.Object text)
public void insertAfter(java.lang.String programName, Token t, java.lang.Object text)
public void insertAfter(java.lang.String programName, int index, java.lang.Object text)
public void insertBefore(Token t, java.lang.Object text)
public void insertBefore(int index, java.lang.Object text)
public void insertBefore(java.lang.String programName, Token t, java.lang.Object text)
public void insertBefore(java.lang.String programName, int index, java.lang.Object text)
public void replace(int index, java.lang.Object text)
public void replace(int from, int to, java.lang.Object text)
public void replace(Token indexT, java.lang.Object text)
public void replace(Token from, Token to, java.lang.Object text)
public void replace(java.lang.String programName, int from, int to, java.lang.Object text)
public void replace(java.lang.String programName, Token from, Token to, java.lang.Object text)
public void delete(int index)
public void delete(int from, int to)
public void delete(Token indexT)
public void delete(Token from, Token to)
public void delete(java.lang.String programName, int from, int to)
public void delete(java.lang.String programName, Token from, Token to)
public int getLastRewriteTokenIndex()
protected int getLastRewriteTokenIndex(java.lang.String programName)
protected void setLastRewriteTokenIndex(java.lang.String programName, int i)
protected java.util.List getProgram(java.lang.String name)
public java.lang.String toOriginalString()
public java.lang.String toOriginalString(int start, int end)
public java.lang.String toString()
toString
in class CommonTokenStream
public java.lang.String toString(java.lang.String programName)
public java.lang.String toString(int start, int end)
TokenStream
toString
in interface TokenStream
toString
in class CommonTokenStream
public java.lang.String toString(java.lang.String programName, int start, int end)
protected java.util.Map reduceToSingleOperationPerIndex(java.util.List rewrites)
protected java.lang.String catOpText(java.lang.Object a, java.lang.Object b)
protected java.util.List getKindOfOps(java.util.List rewrites, java.lang.Class kind)
protected java.util.List getKindOfOps(java.util.List rewrites, java.lang.Class kind, int before)
public java.lang.String toDebugString()
public java.lang.String toDebugString(int start, int end)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |