org.jamplate.impl.util

Class Parsing

java.lang.Object

org.jamplate.impl.util.Parsing

public final class Parsing
extends java.lang.Object

Useful functions for parsing sketches.

Since:

0.2.0 ~2021.02.20

Version:

0.2.0

Author:

LSafer

Method Summary

Modifier and Type	Method and Description
static @NotNull java.util.regex.Matcher	matcher(@NotNull Tree tree, @NotNull java.util.regex.Pattern pattern) Construct a new matcher over the current content of the document of the given tree with the range of the reference of the given tree as the region of it.
static @Nullable java.util.List<Reference>	parse(@NotNull Tree tree, @NotNull java.util.regex.Pattern pattern) Parse the whole given tree with the given pattern and return the references of the groups in the given pattern.
static @NotNull java.util.Set<Reference>	parseAll(@NotNull Tree tree, @NotNull java.util.regex.Pattern pattern, int zIndex) Parse all the ranges matching the given pattern in the given tree.
static @NotNull java.util.Set<java.util.List<Reference>>	parseAll(@NotNull Tree tree, @NotNull java.util.regex.Pattern startPattern, @NotNull java.util.regex.Pattern endPattern, int zIndex) Parse all the ranges starting with the given startPattern and ending with the given endPattern in the given tree.
static @Nullable Reference	parseFirst(@NotNull Tree tree, @NotNull java.util.regex.Pattern pattern, int zIndex) Parse the first range matching the given pattern in the given tree.
static @NotNull java.util.List<Reference>	parseFirst(@NotNull Tree tree, @NotNull java.util.regex.Pattern startPattern, @NotNull java.util.regex.Pattern endPattern, int zIndex) Parse all the ranges starting with the given startPattern and ending with the given endPattern in the given tree.

Methods inherited from class java.lang.Object

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

Method Detail

matcher

@NotNull
 @Contract(value="_,_->new",
          pure=true)
public static @NotNull java.util.regex.Matcher matcher(@NotNull
                                                                                                                     @NotNull Tree tree,
                                                                                                                     @NotNull
                                                                                                                     @NotNull java.util.regex.Pattern pattern)

Construct a new matcher over the current content of the document of the given tree with the range of the reference of the given tree as the region of it.

Parameters:

tree - the tree to get a matcher over its current content.

pattern - the pattern of the returned matcher.

Returns:

a matcher from the given pattern over the current content of the given tree.

Throws:

java.lang.NullPointerException - if the given tree or pattern is null.

java.lang.IllegalStateException - if the reference of the given tree is out of the bounds of its document.

java.io.IOError - if an I/O exception occurred while trying to read the document of the given tree.

DocumentNotFoundError - if the document of the given tree is not available for reading.

Since:

0.2.0 ~2021.05.15

parse

@Nullable
 @Contract(pure=true)
public static @Nullable java.util.List<Reference> parse(@NotNull
                                                                                          @NotNull Tree tree,
                                                                                          @NotNull
                                                                                          @NotNull java.util.regex.Pattern pattern)

Parse the whole given tree with the given pattern and return the references of the groups in the given pattern.

Parameters:

tree - the tree to be parsed.

pattern - the pattern to look for.

Returns:

an ordered list containing the references of the parsed groups. Or null if the given tree does not match the given pattern.

Throws:

java.lang.NullPointerException - if the given tree or pattern is null.

Since:

0.2.0 ~2021.05.30

parseAll

@NotNull
 @Contract(value="_,_,_->new",
          pure=true)
public static @NotNull java.util.Set<Reference> parseAll(@NotNull
                                                                                                                         @NotNull Tree tree,
                                                                                                                         @NotNull
                                                                                                                         @NotNull java.util.regex.Pattern pattern,
                                                                                                                         int zIndex)

Parse all the ranges matching the given pattern in the given tree.
The returned ranges will all have a dominance of NONE between them and the children of the given tree and will all have a dominance of NONE between another.
The returned set is not guaranteed to be mutable nor immutable.

Parameters:

tree - the tree to parse in.

pattern - the pattern to look for.

zIndex - the z-index to accept.

Returns:

a set of references that matches the given pattern in the given tree.

Throws:

java.lang.NullPointerException - if the given tree or pattern is null.

java.lang.IllegalStateException - if the reference of the given tree is out of the bounds of its document.

java.io.IOError - if an I/O exception occurred while trying to read the document of the given tree.

DocumentNotFoundError - if the document of the given tree is not available for reading.

Since:

0.2.0 ~2021.05.15

parseAll

@NotNull
 @Contract(value="_,_,_,_->new",
          pure=true)
public static @NotNull java.util.Set<java.util.List<Reference>> parseAll(@NotNull
                                                                                                                                           @NotNull Tree tree,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull java.util.regex.Pattern startPattern,
                                                                                                                                           @NotNull
                                                                                                                                           @NotNull java.util.regex.Pattern endPattern,
                                                                                                                                           int zIndex)

Parse all the ranges starting with the given startPattern and ending with the given endPattern in the given tree.
The returned set will be a set containing sets with each set having three references: one for the match, another for the starting sequence and a third for the ending sequence.
The returned ranges will all have a dominance of Dominance.NONE between them and the children of the given tree and will have a dominance of NONE between each set of ranges.
The returned set and its inner sets are not guaranteed to be mutable nor immutable.

Parameters:

tree - the tree to parse in.

startPattern - the pattern matching the start of the ranges to look for.

endPattern - the pattern matching the end of the ranges to look for.

zIndex - the z-index to accept.

Returns:

a set of sets of ranges that matches the given pattern in the given tree.

Throws:

java.lang.NullPointerException - if the given tree or startPattern or endPattern is null.

java.lang.IllegalStateException - if the reference of the given tree is out of the bounds of its document.

java.io.IOError - if an I/O exception occurred while trying to read the document of the given tree.

DocumentNotFoundError - if the document of the given tree is not available for reading.

Since:

0.2.0 ~2021.05.15

parseFirst

@Nullable
 @Contract(value="_,_,_->new",
          pure=true)
public static @Nullable Reference parseFirst(@NotNull
                                                                                                              @NotNull Tree tree,
                                                                                                              @NotNull
                                                                                                              @NotNull java.util.regex.Pattern pattern,
                                                                                                              int zIndex)

Parse the first range matching the given pattern in the given tree.
The returned range will all have a dominance of NONE between it and the children of the given tree.

Parameters:

tree - the tree to parse in.

pattern - the pattern to look for.

zIndex - the z-index to accept.

Returns:

a reference that matches the given pattern in the given tree. Or null if no match was found.

Throws:

java.lang.NullPointerException - if the given tree or pattern is null.

java.lang.IllegalStateException - if the reference of the given tree is out of the bounds of its document.

java.io.IOError - if an I/O exception occurred while trying to read the document of the given tree.

DocumentNotFoundError - if the document of the given tree is not available for reading.

Since:

0.2.0 ~2021.05.15

parseFirst

@NotNull
 @Contract(value="_,_,_,_->new",
          pure=true)
public static @NotNull java.util.List<Reference> parseFirst(@NotNull
                                                                                                                              @NotNull Tree tree,
                                                                                                                              @NotNull
                                                                                                                              @NotNull java.util.regex.Pattern startPattern,
                                                                                                                              @NotNull
                                                                                                                              @NotNull java.util.regex.Pattern endPattern,
                                                                                                                              int zIndex)

Parse all the ranges starting with the given startPattern and ending with the given endPattern in the given tree.
The returned set will be having three references: one for the match, another for the starting sequence and a third for the ending sequence.
The returned ranges will all have a dominance of Dominance.NONE between them and the children of the given tree.
The returned set and its inner sets are not guaranteed to be mutable nor immutable.

Parameters:

tree - the tree to parse in.

startPattern - the pattern matching the start of the range to look for.

endPattern - the pattern matching the end of the range to look for.

zIndex - the z-index to accept.

Returns:

a set of the references matching the given pattern in the given tree.

Throws:

java.lang.NullPointerException - if the given tree or startPattern or endPattern is null.

java.lang.IllegalStateException - if the reference of the given tree is out of the bounds of its document.

java.io.IOError - if an I/O exception occurred while trying to read the document of the given tree.

DocumentNotFoundError - if the document of the given tree is not available for reading.

Since:

0.2.0 ~2021.05.15