This repository has been archived by the owner on Apr 21, 2023. It is now read-only.
provide a new generator infrastructure external lexer fragment #1287
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2019 itemis AG (http://www.itemis.eu) and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v1.0 | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v10.html | ||
| *******************************************************************************/ | ||
| package org.eclipse.xtext.xtext.generator.parser.antlr.ex; | ||
|
|
||
| import org.eclipse.xtend2.lib.StringConcatenationClient; | ||
| import org.eclipse.xtext.parser.antlr.Lexer; | ||
| import org.eclipse.xtext.xtext.generator.Issues; | ||
| import org.eclipse.xtext.xtext.generator.model.GuiceModuleAccess; | ||
| import org.eclipse.xtext.xtext.generator.model.IXtextGeneratorFileSystemAccess; | ||
| import org.eclipse.xtext.xtext.generator.model.TypeReference; | ||
| import org.eclipse.xtext.xtext.generator.parser.antlr.AbstractAntlrGeneratorFragment2; | ||
|
|
||
| import com.google.common.annotations.Beta; | ||
|
|
||
| /** | ||
|
There was a problem hiding this comment. Some description what this is actually good for would be nice. I actually don't have a clue. There was a problem hiding this comment. i am not sure if we want users encourage to use it There was a problem hiding this comment. @cdietrich We could write something like: There was a problem hiding this comment. sure. but this should be done only if people know what they do and understand what this is internal api There was a problem hiding this comment. Yes, this is an advanced topic. There was a problem hiding this comment. But without any comment it is even more advanced. Take Tamas' comment. There was a problem hiding this comment. I think |
||
| * Use this fragment if you want to use an external lexer , e.g: in case the generated lexer has to be customized. | ||
| * | ||
| * @since 2.20 | ||
| * @author dietrich - Initial contribution and API | ||
| */ | ||
| @Beta | ||
| public class ExternalAntlrLexerFragment extends AbstractAntlrGeneratorFragment2 { | ||
|
|
||
| private String lexerGrammar; | ||
|
|
||
| private boolean highlighting; | ||
|
|
||
| private boolean runtime; | ||
|
|
||
| private boolean contentAssist; | ||
|
|
||
| @Override | ||
| protected void doGenerate() { | ||
| if (runtime) { | ||
| StringConcatenationClient binding = new StringConcatenationClient() { | ||
| @Override | ||
| protected void appendTo(TargetStringConcatenation target) { | ||
| target.append("binder.bind(" + Lexer.class.getName() + ".class)"+ | ||
| ".annotatedWith(com.google.inject.name.Names.named(" + | ||
| "org.eclipse.xtext.parser.antlr.LexerBindings.RUNTIME" + | ||
| ")).to(" + lexerGrammar +".class);"); | ||
| } | ||
| }; | ||
| new GuiceModuleAccess.BindingFactory().addConfiguredBinding("RuntimeLexer", binding).contributeTo(getLanguage().getRuntimeGenModule()); | ||
| } | ||
| if (highlighting) { | ||
| if (this.getProjectConfig().getEclipsePlugin().getRoot() != null) { | ||
|
There was a problem hiding this comment. maybe put these expressions in some boolean variables e.g. |
||
| StringConcatenationClient binding = new StringConcatenationClient() { | ||
| @Override | ||
| protected void appendTo(TargetStringConcatenation target) { | ||
| target.append("binder.bind(" + Lexer.class.getName() + ".class)"+ | ||
| ".annotatedWith(com.google.inject.name.Names.named(" + | ||
| "org.eclipse.xtext.ide.LexerIdeBindings.HIGHLIGHTING" + | ||
| ")).to(" + lexerGrammar +".class);"); | ||
| } | ||
| }; | ||
| new GuiceModuleAccess.BindingFactory().addConfiguredBinding("HighlightingLexer", binding).contributeTo(getLanguage().getEclipsePluginGenModule()); | ||
| } | ||
| } | ||
| if (contentAssist) { | ||
| if (this.getProjectConfig().getGenericIde().getRoot() != null) { | ||
| StringConcatenationClient binding = new StringConcatenationClient() { | ||
| @Override | ||
| protected void appendTo(TargetStringConcatenation target) { | ||
| target.append("binder.bind(org.eclipse.xtext.ide.editor.contentassist.antlr.internal.Lexer.class)"+ | ||
| ".annotatedWith(com.google.inject.name.Names.named(" + | ||
| "org.eclipse.xtext.ide.LexerIdeBindings.CONTENT_ASSIST" + | ||
| ")).to(" + lexerGrammar +".class);"); | ||
| } | ||
| }; | ||
| new GuiceModuleAccess.BindingFactory().addConfiguredBinding("ContentAssistLexer", binding).contributeTo(getLanguage().getIdeGenModule()); | ||
|
|
||
| } | ||
| if (this.getProjectConfig().getEclipsePlugin().getRoot() != null) { | ||
| StringConcatenationClient binding = new StringConcatenationClient() { | ||
| @Override | ||
| protected void appendTo(TargetStringConcatenation target) { | ||
| target.append("binder.bind(org.eclipse.xtext.ide.editor.contentassist.antlr.internal.Lexer.class)"+ | ||
| ".annotatedWith(com.google.inject.name.Names.named(" + | ||
| "org.eclipse.xtext.ide.LexerIdeBindings.CONTENT_ASSIST" + | ||
| ")).to(" + lexerGrammar +".class);"); | ||
| } | ||
| }; | ||
| new GuiceModuleAccess.BindingFactory().addConfiguredBinding("ContentAssistLexer", binding).contributeTo(getLanguage().getEclipsePluginGenModule()); | ||
| } | ||
| } | ||
|
|
||
|
|
||
|
|
||
|
|
||
| IXtextGeneratorFileSystemAccess srcGenFsa = this.getProjectConfig().getRuntime().getSrcGen(); | ||
| IXtextGeneratorFileSystemAccess srcFsa = this.getProjectConfig().getRuntime().getSrc(); | ||
| if (contentAssist || highlighting) { | ||
szarnekow marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (this.getProjectConfig().getGenericIde().getRoot() != null) { | ||
| srcGenFsa = this.getProjectConfig().getGenericIde().getSrcGen(); | ||
| srcFsa = this.getProjectConfig().getGenericIde().getSrc(); | ||
| } else { | ||
| srcGenFsa = this.getProjectConfig().getEclipsePlugin().getSrcGen(); | ||
| srcFsa = this.getProjectConfig().getEclipsePlugin().getSrc(); | ||
| } | ||
| } | ||
| String srcGenPath = srcGenFsa.getPath(); | ||
| String srcPath = srcFsa.getPath(); | ||
| String grammarFile = srcPath + "/" + getLexerGrammar().replace('.', '/') + ".g"; | ||
| String generateTo = ""; | ||
| if (getLexerGrammar().lastIndexOf('.') != -1) { | ||
| generateTo = getLexerGrammar().substring(0, getLexerGrammar().lastIndexOf('.')); | ||
| } | ||
| generateTo = srcGenPath + "/" + generateTo.replace('.', '/'); | ||
| addAntlrParam("-fo"); | ||
| addAntlrParam(generateTo); | ||
| final String encoding = getCodeConfig().getEncoding(); | ||
| getAntlrTool().runWithEncodingAndParams(grammarFile, encoding, getAntlrParams()); | ||
|
|
||
| TypeReference lexerType = new TypeReference(getLexerGrammar()); | ||
| splitParserAndLexerIfEnabled(srcGenFsa, null /* parser */, lexerType); | ||
| normalizeTokens(srcGenFsa, getLexerGrammar().replace('.', '/') + ".tokens"); | ||
| suppressWarnings(srcGenFsa, lexerType); | ||
| normalizeLineDelimiters(srcGenFsa, lexerType); | ||
| } | ||
|
|
||
| @Override | ||
| protected void splitParserClassFile(IXtextGeneratorFileSystemAccess fsa, TypeReference parser) { | ||
| // no-op | ||
| } | ||
|
|
||
| @Override | ||
| protected void improveParserCodeQuality(IXtextGeneratorFileSystemAccess fsa, TypeReference parser) { | ||
| // no-op | ||
| } | ||
|
|
||
| @Override | ||
| public void checkConfiguration(Issues issues) { | ||
| super.checkConfiguration(issues); | ||
| if (contentAssist && highlighting || runtime && highlighting || contentAssist && runtime) { | ||
| issues.addError("Only one of those flags is allowed: contentAssist, runtime, highlighting flag"); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| public void setLexerGrammar(String lexerGrammar) { | ||
| this.lexerGrammar = lexerGrammar; | ||
| } | ||
|
|
||
| public String getLexerGrammar() { | ||
| return lexerGrammar; | ||
| } | ||
|
|
||
| public void setHighlighting(boolean highlighting) { | ||
| this.highlighting = highlighting; | ||
| } | ||
|
|
||
| public boolean isHighlighting() { | ||
| return highlighting; | ||
| } | ||
|
|
||
| public void setRuntime(boolean runtime) { | ||
| this.runtime = runtime; | ||
| } | ||
|
|
||
| public boolean isRuntime() { | ||
| return runtime; | ||
| } | ||
|
|
||
| public void setContentAssist(boolean contentAssist) { | ||
| this.contentAssist = contentAssist; | ||
| } | ||
|
|
||
| public boolean isContentAssist() { | ||
| return contentAssist; | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't put
@sincetags here, right?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes i would leave it out