Fleet-compatible generation for Grammar-Kit #359
Conversation
KrylovBoris
force-pushed
the
Boris.Krylov/grammar-kit-for-fleet
branch
from
eb3c0eb
to
129503f
Compare
|
Please avoid changing any configuration files, including libraries xmls, idea/*.xml, and build scripts. |
|
please add entry in CHANGELOG.md |
|
Overall We don't want to have a separate |
| @@ -159,7 +159,7 @@ public ParserGenerator(@NotNull BnfFile psiFile, | |||
| myOutputPath = outputPath; | |||
| myPackagePrefix = packagePrefix; | |||
|
|
|||
| G = new GenOptions(myFile); | |||
| G = createGenerator(myFile); | |||
There was a problem hiding this comment.
Let's make genOptions a constructor param
| super(psiFile, sourcePath, outputPath, packagePrefix); | ||
| myPossibleImports = new LinkedList<>(); | ||
| var importList = psiFile.getAllPossibleAttributeValues(KnownAttribute.ELEMENT_TYPE_CLASS); | ||
| if (importList != null) myPossibleImports.addAll(psiFile.getAllPossibleAttributeValues(KnownAttribute.ELEMENT_TYPE_CLASS)); |
There was a problem hiding this comment.
Call getAllPossibleAttributeValues for the second time?
|
|
||
| public class FleetParserGenerator extends ParserGenerator { | ||
|
|
||
| private final Collection<String> myPossibleImports; |
| } | ||
| } | ||
|
|
||
| private void generateFileTypeClass() { |
There was a problem hiding this comment.
-
Already outdated.
FleetPsiBuilderis already gone. -
Parser does not refer to this class, so it shall not be generated as part of parser generation. We can have a separate generator action for that if needed.
| } | ||
|
|
||
| @NotNull | ||
| protected String adjustName(String importName) { |
There was a problem hiding this comment.
adjustName must happen in BNF PSI, not in the generator.
As we need to support both "generate-time" and "edit-time" (in-IDE support)
| ve.evaluate(context, out, "lexer.flex.template", new InputStreamReader(stream)); | ||
| return StringUtil.convertLineSeparators(out.toString()); | ||
| } | ||
|
|
||
| protected void putPackageName(@NotNull VelocityContext context, BnfFile bnfFile, @Nullable String packageName) { |
There was a problem hiding this comment.
Adding a method for each property is not good. It's a famous OO-spaghetti code.
One method for context creation would be better.
What is this PR for?
This PR aims to introduce additional functionality to the Grammar-Kit plugin that allows users to generate a parser and adjacent code that is compatible with Fleet's API.
Why were these changes made?
Currently, for plugin developers to port their IDEA plugins over to Fleet, they need to edit generated parser files or write them from scratch. To reduce the workload and allow for a more streamlined development process we introduce a way to generate Fleet-compatible code.
What is Fleet-compatible code?
For the parser to be compatible with Fleet, it needs to import packages from Fleet's own parsing core and not have PSI-related features. This could be achieved by tweaking imports and stopping Grammar-Kit from generating PSI.
What has been done?
For Fleet-specific generation logic, we created a separate
FleetParserGenerator, a subclass ofParserGenerator. To avoid copying large chunks of code from the parent, we introduced a bunch of small methods that are responsible for adjusting original namespaces and generating small parts of the parser code. We also introducedFleetGenOptions, a subclass of GenOptions, to control file generation.To interact with Fleet-specific parser, we added 2 actions to the plugin:
To generate lexers we use a new template file, which includes Fleet-specific imports.
We also introduced 2 Fleet-only attributes to BNF files:
adjustPackagesForFleetallows users to suppress moving generated files to "fleet/" directory. By default, when we generate files for Fleet, they are moved to "fleet/" directory, and "fleet." prefix is added to their respective package names. This is done to mimic Fleet's parser code layout and this option allows users to turn it off.generateFileTypeForFleetwas added by request of the Fleet team. Since almost allIFileTypeimplementations in Fleet are the same, this attribute was added to reduce the amount of boilerplate code, plugin developers have to write to make their parsers compilable. This attribute holds all the parameters to generateIFileTypeimplementation for Fleet.Finally, we added an optional parameter [-f] to the main function to switch from
ParserGeneratortoFleetParserGeneratorHow have the other parts of the plugin been affected?
Since all Fleet-specific generation is stored in a separate class, it should not affect other parts of the program.
What's your plans for the future?
In the future we plan to add support of introduced functionality in grammar-kit-gradle-plugin.