Allow factory suggestions to have parser context

[Zeranny]

Overview

Closely mirrors upstream changes in EngineHub/WorldEdit#2236

"This is a refactor to allow access to a ParserContext within the suggestion methods. This is required for any suggestions within the factory parser that are player-specific"

Description

This PR adds context as an option to the getSuggestions() method of parsers.
While no changes to existing Masks or Patterns are present, this change would allow for that to be done in future.

Originally I had gone through and added context to every parser in FAWE, allowing for the new getSuggestions(String argumentInput, int index, ParserContext context) method in RichParser to be abstract, replacing the existing method without context.
However, that would be a breaking change for any addon plugin using rich parsing such as Arceon.

While it does work & prevents breaking existing parsers, I don't think my approach of 2x methods looks the best so I would appreciate any thoughts on that.
I have tested against existing FAWE, Arceon, and my own custom masks/patterns to double check this is backwards compatible.

It's worth mentioning that my reason for pursuing this change is a custom mask I implemented which would benefit from player-specific tab completion.

Additionally as a basic example, this is a mask that wants a Y value, which can suggest the user's Y level:

Submitter Checklist

Edit tasklist title

Beta Give feedback Tasklist Submitter Checklist, more options

• Rename
• Copy markdown
• Delete tasklist

Delete tasklist

Delete tasklist block?

Are you sure? All relationships in this tasklist will be removed.

Cancel Delete

1. Make sure you are opening from a topic branch (**/feature/fix/docs/ branch** (right side)) and not your main branch.

   Make sure you are opening from a topic branch (/feature/fix/docs/ branch (right side)) and not your main branch.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
2. Ensure that the pull request title represents the desired changelog entry.

   Ensure that the pull request title represents the desired changelog entry.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
3. New public fields and methods are annotated with `@since TODO`.

   New public fields and methods are annotated with @since TODO.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove
4. I read and followed the [contribution guidelines](https://github.com/IntellectualSites/.github/blob/main/CONTRIBUTING.md).

   I read and followed the contribution guidelines.
   Options

   • Convert to issue
   • Toggle completion
   • Rename
   • Remove

Add item to Submitter Checklist

[dordsor21]

This should default to the new method with an empty parser context

[Zeranny]

This should default to the new method with an empty parser context

I've swapped them round 5c257f6

[dordsor21]

I meant that they should both default to each other so parsers can implement one of either method and it will still work. Similar is already done in extents https://github.com/IntellectualSites/FastAsyncWorldEdit/blob/main/worldedit-core/src/main/java/com/sk89q/worldedit/extent/InputExtent.java#L52-L59

[Zeranny]

Maybe a dumb question, but would there be any risk if someone did not overwrite one or both of them when using the API? Would the getSuggestions not just loop?

[dordsor21]

Yeah I suppose we're not necessarily going to always do suggestions? Return it to how it was but add a deprecation to it I think, as that method should never be called; overriding is fine but calling is not

[Zeranny]

Added the Deprecated tag & a note: 2873359

[NotMyFault]

Much appreciated!