Module com.maroontress.clione

Package com.maroontress.clione

Interface SourceChar

All Known Implementing Classes:

Eof

public interface SourceChar

A character of the source file or EOF.

The SourceChar object represents a character that composes the token or EOF. It may also have one or more child characters in some cases. For example, it is the case that it represents:

• the character which is substituted for any digraph or trigraph sequence
• the character that follows a backslash (\) at the end of the line

Field Summary

Fields

Modifier and Type	Field	Description
static final List<SourceChar>	EMPTY_LIST	The empty unmodifiable list of SourceChar objects.
static final SourceChar	STATIC_EOF	Deprecated. Not for public use in the future.

Method Summary

Modifier and Type	Method	Description
List<SourceChar>	getChildren()	Returns the child characters.
String	getFilename()	Returns the filename.
SourceSpan	getSpan()	Returns location of this object in the source file.
boolean	isEof()	Returns whether this object represents EOF.
char	toChar()	Returns a char value corresponding to this object.

Field Details

EMPTY_LIST

static final List<SourceChar> EMPTY_LIST

The empty unmodifiable list of SourceChar objects.

STATIC_EOF

@Deprecated
static final SourceChar STATIC_EOF

Deprecated.

Not for public use in the future. This field is expected to be removed.

The SourceChar object representing the end of the source file.

This object behaves as follows:

• The isEof() method returns true
• The getFilename() method returns null
• The toChar() and getSpan() methods throw an IllegalStateException
• The getChildren() method returns EMPTY_LIST

Do not compare a SourceChar object with this object to determine whether it is EOF or not. Use the isEof() method instead.

Note that this is an immutable object.

Method Details

getFilename

String getFilename()

Returns the filename.

Returns:

The filename. Or null if no filename is specified.

isEof

boolean isEof()

Returns whether this object represents EOF.

Returns:

true if this represents EOF.

toChar

char toChar()

Returns a char value corresponding to this object.

This method throws an IllegalStateException if this object represents EOF.

Returns:

The char value.

Throws:

IllegalStateException - If this object represents EOF.

getSpan

SourceSpan getSpan()

Returns location of this object in the source file.

If this object has its child characters, its location depends on their location. So, its location may represent a range of the characters.

This method throws an IllegalStateException if this object represents EOF.

Returns:

The location.

Throws:

IllegalStateException - If this object represents EOF and has no child characters.

getChildren

List<SourceChar> getChildren()

Returns the child characters.

Returns:

The unmodifiable list containing the child characters, or EMPTY_LIST if this object has no child characters.