Package io.github.douira.glsl_preprocessor

Class StringLexerSource

java.lang.Object

io.github.douira.glsl_preprocessor.Source

io.github.douira.glsl_preprocessor.LexerSource

io.github.douira.glsl_preprocessor.StringLexerSource

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<Token>

public class StringLexerSource
extends LexerSource

A Source for lexing a String. This class is used by token pasting, but can be used by user code.

Constructor Summary

Constructors

Constructor	Description
StringLexerSource(String string)	Creates a new Source for lexing the given String.
StringLexerSource(String string, boolean ppvalid)	Creates a new Source for lexing the given String.
StringLexerSource(String string, String name, boolean ppvalid)	Creates a new Source for lexing the given String.

Method Summary

Modifier and Type	Method	Description
String	getName()	Returns the human-readable name of the current Source.
String	toString()

Methods inherited from class io.github.douira.glsl_preprocessor.LexerSource

close, getColumn, getLine, toBufferedReader, token

Methods inherited from class io.github.douira.glsl_preprocessor.Source

error, getPath, iterator, setListener, skipline, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

StringLexerSource

public StringLexerSource(String string,
 String name,
 boolean ppvalid)

Creates a new Source for lexing the given String.

Parameters:

string - The input string to lex.

name - The name of this source.

ppvalid - true if preprocessor directives are to be honoured within the string.

StringLexerSource

public StringLexerSource(String string)

Creates a new Source for lexing the given String. Equivalent to calling new StringLexerSource(string, false). By default, preprocessor directives are not honoured within the string.

Parameters:

string - The input string to lex.

StringLexerSource

public StringLexerSource(String string,
 boolean ppvalid)

Creates a new Source for lexing the given String. Equivalent to calling new StringLexerSource(string, "string literal", ppvalid).

Parameters:

string - The input string to lex.

ppvalid - true if preprocessor directives are to be honoured within the string.

Method Details

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Description copied from class: Source

Returns the human-readable name of the current Source.

Overrides:

getName in class Source