Class SyntaxParser

java.lang.Object

io.github.syst3ms.skriptparser.parsing.SyntaxParser

public class SyntaxParser
extends Object

Contains the logic for parsing and interpreting single statements, sections and expressions inside of a script.

Field Summary

Fields

Modifier and Type	Field	Description
static final PatternType<Boolean>	BOOLEAN_PATTERN_TYPE	The pattern type representing Boolean
static final int	CONDITIONAL	Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to only return conditional expressions
static final PatternElement	CONTEXT_VALUE_PATTERN
static final ExpressionInfo<ExprBooleanOperators, Boolean>	EXPRESSION_BOOLEAN_OPERATORS
static final Pattern	LIST_SPLIT_PATTERN
static final int	MAYBE_CONDITIONAL	Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to return any expressions, conditional or not
static final int	NOT_CONDITIONAL	Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to only return expressions that are not conditional
static final PatternType<Object>	OBJECT_PATTERN_TYPE	The pattern type representing Object
static final PatternType<Object>	OBJECTS_PATTERN_TYPE

Constructor Summary

Constructors

Constructor	Description
SyntaxParser()

Method Summary

Modifier and Type	Method	Description
static Optional<? extends Expression<Boolean>>	parseBooleanExpression(String s, int conditional, ParserState parserState, SkriptLogger logger)	Parses a boolean expression from the given String
static <T> Optional<? extends ContextExpression<?, ? extends T>>	parseContextValue(String toParse, PatternType<T> expectedType, ParserState parserState, SkriptLogger logger)	Parses a ContextValue from the given String and expected return type
static Optional<? extends Effect>	parseEffect(String s, ParserState parserState, SkriptLogger logger)	Parses a line of code as an Effect
static <T> Optional<? extends Expression<? extends T>>	parseExpression(String s, PatternType<T> expectedType, ParserState parserState, SkriptLogger logger)	Parses an Expression from the given String and expected return type
static <T> Optional<? extends Expression<? extends T>>	parseListLiteral(String s, PatternType<T> expectedType, ParserState parserState, SkriptLogger logger)	Parses a list literal expression (of the form ..., ... and ...) from the given String and expected return type
static <T> Optional<? extends Expression<? extends T>>	parseLiteral(String s, PatternType<T> expectedType, ParserState parserState, SkriptLogger logger)	Parses a literal of a given type from the given String
static Optional<? extends CodeSection>	parseSection(FileSection section, ParserState parserState, SkriptLogger logger)	Parses a section of a file as a CodeSection
static Optional<? extends UnloadedTrigger>	parseTrigger(FileSection section, SkriptLogger logger)	Parses a section of a file as a Trigger

Methods inherited from class Object

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

Field Details

NOT_CONDITIONAL

public static final int NOT_CONDITIONAL

Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to only return expressions that are not conditional

See Also:

• parseBooleanExpression(String, int, ParserState, SkriptLogger)
• Constant Field Values

MAYBE_CONDITIONAL

public static final int MAYBE_CONDITIONAL

Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to return any expressions, conditional or not

See Also:

• parseBooleanExpression(String, int, ParserState, SkriptLogger)
• Constant Field Values

CONDITIONAL

public static final int CONDITIONAL

Tells parseBooleanExpression(String, int, ParserState, SkriptLogger) to only return conditional expressions

See Also:

• parseBooleanExpression(String, int, ParserState, SkriptLogger)
• Constant Field Values

LIST_SPLIT_PATTERN

public static final Pattern LIST_SPLIT_PATTERN

BOOLEAN_PATTERN_TYPE

public static final PatternType<Boolean> BOOLEAN_PATTERN_TYPE

The pattern type representing Boolean

OBJECT_PATTERN_TYPE

public static final PatternType<Object> OBJECT_PATTERN_TYPE

The pattern type representing Object

OBJECTS_PATTERN_TYPE

public static final PatternType<Object> OBJECTS_PATTERN_TYPE

CONTEXT_VALUE_PATTERN

public static final PatternElement CONTEXT_VALUE_PATTERN

EXPRESSION_BOOLEAN_OPERATORS

public static final ExpressionInfo<ExprBooleanOperators, Boolean> EXPRESSION_BOOLEAN_OPERATORS

Constructor Details

SyntaxParser

public SyntaxParser()

Method Details

parseExpression

public static <T>
Optional<? extends Expression<? extends T>> parseExpression(String s,
 PatternType<T> expectedType,
 ParserState parserState,
 SkriptLogger logger)

Parses an Expression from the given String and expected return type

Type Parameters:

T - the type of the expression

Parameters:

s - the string to be parsed as an expression

expectedType - the expected return type

parserState - the current parser state

logger - the logger

Returns:

an expression that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message.

parseBooleanExpression

public static Optional<? extends Expression<Boolean>> parseBooleanExpression(String s,
 int conditional,
 ParserState parserState,
 SkriptLogger logger)

Parses a boolean expression from the given String

Parameters:

s - the string to be parsed as an expression

conditional - a constant describing whether the result can be a condition

parserState - the current parser state

logger - the logger

Returns:

a boolean expression that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message.

See Also:

• NOT_CONDITIONAL
• MAYBE_CONDITIONAL
• CONDITIONAL

parseContextValue

public static <T>
Optional<? extends ContextExpression<?, ? extends T>> parseContextValue(String toParse,
 PatternType<T> expectedType,
 ParserState parserState,
 SkriptLogger logger)

Parses a ContextValue from the given String and expected return type

Type Parameters:

T - the type of the context value

Parameters:

toParse - the string to be parsed as a context value

expectedType - the expected return type

parserState - the current parser state

logger - the logger

Returns:

an expression that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message.

parseListLiteral

public static <T>
Optional<? extends Expression<? extends T>> parseListLiteral(String s,
 PatternType<T> expectedType,
 ParserState parserState,
 SkriptLogger logger)

Parses a list literal expression (of the form ..., ... and ...) from the given String and expected return type

Type Parameters:

T - the type of the list literal

Parameters:

s - the string to be parsed as a list literal

expectedType - the expected return type (must be plural)

parserState - the current parser state

logger - the logger

Returns:

a list literal that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message.

parseLiteral

public static <T>
Optional<? extends Expression<? extends T>> parseLiteral(String s,
 PatternType<T> expectedType,
 ParserState parserState,
 SkriptLogger logger)

Parses a literal of a given type from the given String

Type Parameters:

T - the type of the literal

Parameters:

s - the string to be parsed as a literal

expectedType - the expected return type

parserState - the current parser state

logger - the logger

Returns:

a literal that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message.

parseEffect

public static Optional<? extends Effect> parseEffect(String s,
 ParserState parserState,
 SkriptLogger logger)

Parses a line of code as an Effect

Parameters:

s - the line to be parsed

parserState - the current parser state

logger - the logger

Returns:

an effect that was successfully parsed, or null if the string is empty, no match was found or for another reason detailed in an error message

parseSection

public static Optional<? extends CodeSection> parseSection(FileSection section,
 ParserState parserState,
 SkriptLogger logger)

Parses a section of a file as a CodeSection

Parameters:

section - the section to be parsed

parserState - the current parser state

logger - the logger

Returns:

a section that was successfully parsed, or null if the section is empty, no match was found or for another reason detailed in an error message

parseTrigger

public static Optional<? extends UnloadedTrigger> parseTrigger(FileSection section,
 SkriptLogger logger)

Parses a section of a file as a Trigger

Parameters:

section - the section to be parsed

logger - the logger

Returns:

a trigger that was successfully parsed, or null if the section is empty, no match was found or for another reason detailed in an error message