com.xilinx.rapidwright.edif

Class EDIFTokenizer

Object

com.xilinx.rapidwright.edif.EDIFTokenizer

All Implemented Interfaces:

AutoCloseable

public class EDIFTokenizer
extends Object
implements AutoCloseable

Tokenize an InputStream containing an EDIF. This class buffers its input internally. To minimize copying data, combining it with a BufferedInputStream should be avoided.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_TOKEN_LENGTH

Constructor Summary

Constructors

Constructor and Description
EDIFTokenizer(Path fileName, InputStream in, StringPool uniquifier)
EDIFTokenizer(Path fileName, InputStream in, StringPool uniquifier, int maxTokenLength)

Method Summary

Modifier and Type	Method and Description
static String	byteArrayToStringMulti(byte[] buffer, int start1, int length1, int start2, int length2) Read two separate locations from a buffer, concatenating them into a single string.
void	close()
long	getByteOffset()
Path	getFileName()
com.xilinx.rapidwright.edif.EDIFToken	getOptionalNextToken(boolean isShortLived) Get the next token object
String	getOptionalNextTokenString(boolean isShortLived) Get the next token string
StringPool	getUniquifier()
void	skip(long i) Skip ahead by some offset.

Methods inherited from class Object

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

Field Detail

DEFAULT_MAX_TOKEN_LENGTH

public static final int DEFAULT_MAX_TOKEN_LENGTH

See Also:

Constant Field Values

Constructor Detail

EDIFTokenizer

public EDIFTokenizer(Path fileName,
                     InputStream in,
                     StringPool uniquifier,
                     int maxTokenLength)

EDIFTokenizer

public EDIFTokenizer(Path fileName,
                     InputStream in,
                     StringPool uniquifier)

Method Detail

byteArrayToStringMulti

public static String byteArrayToStringMulti(byte[] buffer,
                                            int start1,
                                            int length1,
                                            int start2,
                                            int length2)

Read two separate locations from a buffer, concatenating them into a single string. Suppports multi-byte characters split between the two parts

Parameters:

buffer - the buffer to read from

start1 - first part start

length1 - first part length

start2 - second part start

length2 - second part length

Returns:

the string assembled from the two locations

getOptionalNextToken

public com.xilinx.rapidwright.edif.EDIFToken getOptionalNextToken(boolean isShortLived)

Get the next token object

Parameters:

isShortLived - skip uniquifying if true

Returns:

token object, or null if at end of file

getOptionalNextTokenString

public String getOptionalNextTokenString(boolean isShortLived)

Get the next token string

Parameters:

isShortLived - skip uniquifying if true

Returns:

token text, or null if at end of file

getFileName

public Path getFileName()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Throws:

IOException

skip

public void skip(long i)

Skip ahead by some offset. After skipping, this method tries to advance to the next token boundary. This is an educated guess that needs to be verified once the thread that reads the preceding part of the file catches up to this one.

Parameters:

i - offset to advance by

getUniquifier

public StringPool getUniquifier()

getByteOffset

public long getByteOffset()