com.atlassian.clover.instr.java

Class CloverTokenStreamFilter

java.lang.Object

clover.antlr.TokenStreamBasicFilter

clover.antlr.TokenStreamHiddenTokenFilter

com.atlassian.clover.instr.java.CloverTokenStreamFilter

All Implemented Interfaces:

clover.antlr.ASdebug.IASDebugStream, clover.antlr.TokenStream

public class CloverTokenStreamFilter
extends clover.antlr.TokenStreamHiddenTokenFilter

A token stream that preserves whitespace tokens in hidden tokens, and maintains a linked list of tokens it has seen, and provides methods to insert instrumenting tokens into that list.

Version:

1.0

See Also:

TokenStreamHiddenTokenFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String	MARKER
static String	MARKER_PREFIX a marker to indicate add at the front when dumping token list to mark it as instrumented

Fields inherited from class clover.antlr.TokenStreamHiddenTokenFilter

firstHidden, hideMask, lastHiddenToken, nextMonitoredToken

Fields inherited from class clover.antlr.TokenStreamBasicFilter

discardMask, input

Constructor Summary

Constructors

Constructor and Description
CloverTokenStreamFilter(String filePath, clover.antlr.CharScanner input) A filtering token stream that hides java comments and whitespace from the parser, and builds a list of tokens that it has seen.

Method Summary

Modifier and Type	Method and Description
static void	guardAgainstDoubleInstrumentation(File orig, BufferedReader bin)
void	instrument(FileStructureInfo structure, FullFileInfo fileInfo, InstrumentationSession session, JavaInstrumentationConfig cfg) process directives, set final emitter state.
boolean	isEOLTerminated()
clover.antlr.Token	nextToken()
void	write(Writer outWriter) dump the token list, including hidden whitespace and comment tokens

Methods inherited from class clover.antlr.TokenStreamHiddenTokenFilter

consume, getDiscardMask, getHiddenAfter, getHiddenBefore, getHideMask, getInitialHiddenToken, hide, hide, LA

Methods inherited from class clover.antlr.TokenStreamBasicFilter

discard, discard, getEntireText, getOffsetInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MARKER_PREFIX

public static final String MARKER_PREFIX

a marker to indicate add at the front when dumping token list to mark it as instrumented

See Also:

Constant Field Values

MARKER

public static final String MARKER

See Also:

Constant Field Values

Constructor Detail

CloverTokenStreamFilter

public CloverTokenStreamFilter(String filePath,
                               clover.antlr.CharScanner input)

A filtering token stream that hides java comments and whitespace from the parser, and builds a list of tokens that it has seen.

Parameters:

filePath - path to original source, for reporting errors

input - the CharScanner to pull tokens from

See Also:

TokenStreamHiddenTokenFilter

Method Detail

guardAgainstDoubleInstrumentation

public static void guardAgainstDoubleInstrumentation(File orig,
                                                     BufferedReader bin)
                                              throws IOException,
                                                     CloverException

Throws:

IOException

CloverException

nextToken

public clover.antlr.Token nextToken()
                             throws clover.antlr.TokenStreamException

Specified by:

nextToken in interface clover.antlr.TokenStream

Overrides:

nextToken in class clover.antlr.TokenStreamHiddenTokenFilter

Throws:

clover.antlr.TokenStreamException

See Also:

TokenStream.nextToken()

instrument

public void instrument(FileStructureInfo structure,
                       FullFileInfo fileInfo,
                       InstrumentationSession session,
                       JavaInstrumentationConfig cfg)

process directives, set final emitter state. This leaves the token stream ready for output

write

public void write(Writer outWriter)
           throws IOException

dump the token list, including hidden whitespace and comment tokens

Parameters:

outWriter - a Writer to output the token list to

Throws:

IOException

isEOLTerminated

public boolean isEOLTerminated()