Class WebIntegrationFragment
- java.lang.Object
-
- org.eclipse.xtext.xtext.generator.AbstractXtextGeneratorFragment
-
- org.eclipse.xtext.xtext.generator.web.WebIntegrationFragment
-
- All Implemented Interfaces:
IGuiceAwareGeneratorComponent
,IXtextGeneratorFragment
public class WebIntegrationFragment extends AbstractXtextGeneratorFragment
Main generator fragment for web integration.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
WebIntegrationFragment.Framework
-
Constructor Summary
Constructors Constructor Description WebIntegrationFragment()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addEnablePattern(java.lang.String pattern)
Enable a default pattern for syntax highlighting.void
addSuppressPattern(java.lang.String pattern)
Suppress a default pattern for syntax highlighting.void
checkConfiguration(Issues issues)
protected com.google.common.collect.Multimap<java.lang.String,java.lang.String>
createCodeMirrorPatterns(java.lang.String langId, java.util.Set<java.lang.String> keywords)
protected java.util.Collection<java.lang.String>
createOrionPatterns(java.lang.String langId, java.util.Set<java.lang.String> keywords)
void
generate()
protected java.lang.CharSequence
generateExtraKeywordsRegExp()
protected void
generateIndexDoc(java.lang.String hlModName)
protected void
generateJsHighlighting(java.lang.String langId)
protected java.lang.CharSequence
generateKeywords(java.util.List<java.lang.String> wordKeywords, java.util.List<java.lang.String> nonWordKeywords)
protected java.lang.CharSequence
generateKeywordsRegExp()
protected void
generateServerLauncher()
protected void
generateServlet()
protected void
generateStyleSheet()
protected void
generateWebXml()
GeneratorOption<WebIntegrationFragment.Framework>
getFramework()
BooleanGeneratorOption
getGenerateHtmlExample()
BooleanGeneratorOption
getGenerateJettyLauncher()
BooleanGeneratorOption
getGenerateJsHighlighting()
BooleanGeneratorOption
getGenerateServlet()
BooleanGeneratorOption
getGenerateWebXml()
protected TypeReference
getServerLauncherClass(org.eclipse.xtext.Grammar grammar)
protected TypeReference
getServletClass(org.eclipse.xtext.Grammar grammar)
void
setAceVersion(java.lang.String aceVersion)
void
setCodeMirrorVersion(java.lang.String codeMirrorVersion)
void
setFramework(java.lang.String frameworkName)
Choose one of the supported frameworks:"Orion"
,"Ace"
, or"CodeMirror"
void
setGenerateHtmlExample(boolean generateHtmlExample)
Whether an exampleindex.html
file for testing the web-based editor should be generated.void
setGenerateJettyLauncher(boolean generateJettyLauncher)
Whether a Java main-class for launching a local Jetty server should be generated.void
setGenerateJsHighlighting(boolean generateJsHighlighting)
Whether JavaScript-based syntax highlighting should be generated.void
setGenerateServlet(boolean generateServlet)
Whether a servlet for DSL-specific services should be generated.void
setGenerateWebXml(boolean generateWebXml)
Whether a web.xml file should be generated.void
setHighlightingModuleName(java.lang.String moduleName)
Name of the syntax highlighting RequireJS module to be generated.void
setHighlightingPath(java.lang.String path)
The path of the syntax highlighting JavaScript file to be generated.void
setIgnoreCase(boolean ignoreCase)
Whether the generated syntax highlighting should ignore case for language keywords.void
setJQueryVersion(java.lang.String jQueryVersion)
void
setKeywordsFilter(java.lang.String keywordsFilter)
Regular expression for filtering those language keywords that should be highlighted.void
setRequireJsTextVersion(java.lang.String requireJsTextVersion)
void
setRequireJsVersion(java.lang.String requireJsVersion)
void
setUseServlet3Api(boolean useServlet3Api)
Whether the Servlet 3 API (WebServlet
annotation) should be used for the generated servlet.-
Methods inherited from class org.eclipse.xtext.xtext.generator.AbstractXtextGeneratorFragment
getGrammar, getLanguage, getProjectConfig, initialize
-
-
-
-
Method Detail
-
setFramework
public void setFramework(java.lang.String frameworkName)
Choose one of the supported frameworks:"Orion"
,"Ace"
, or"CodeMirror"
-
setGenerateJsHighlighting
public void setGenerateJsHighlighting(boolean generateJsHighlighting)
Whether JavaScript-based syntax highlighting should be generated. The default istrue
.
-
setHighlightingModuleName
public void setHighlightingModuleName(java.lang.String moduleName)
Name of the syntax highlighting RequireJS module to be generated.
-
setHighlightingPath
public void setHighlightingPath(java.lang.String path)
The path of the syntax highlighting JavaScript file to be generated. The default is to derive the path from thehighlightingModuleName
property.
-
setKeywordsFilter
public void setKeywordsFilter(java.lang.String keywordsFilter)
Regular expression for filtering those language keywords that should be highlighted. The default is\w+
, i.e. keywords consisting only of letters and digits.
-
setGenerateServlet
public void setGenerateServlet(boolean generateServlet)
Whether a servlet for DSL-specific services should be generated. The default isfalse
.
-
setGenerateWebXml
public void setGenerateWebXml(boolean generateWebXml)
Whether a web.xml file should be generated. The default isfalse
(not necessary for Servlet 3 compatible containers).
-
setUseServlet3Api
public void setUseServlet3Api(boolean useServlet3Api)
Whether the Servlet 3 API (WebServlet
annotation) should be used for the generated servlet. The default istrue
.
-
setIgnoreCase
public void setIgnoreCase(boolean ignoreCase)
Whether the generated syntax highlighting should ignore case for language keywords.
-
setGenerateJettyLauncher
public void setGenerateJettyLauncher(boolean generateJettyLauncher)
Whether a Java main-class for launching a local Jetty server should be generated. The default isfalse
.
-
setGenerateHtmlExample
public void setGenerateHtmlExample(boolean generateHtmlExample)
Whether an exampleindex.html
file for testing the web-based editor should be generated. The default isfalse
.
-
addEnablePattern
public void addEnablePattern(java.lang.String pattern)
Enable a default pattern for syntax highlighting. See the documentation of the chosen framework for details.
-
addSuppressPattern
public void addSuppressPattern(java.lang.String pattern)
Suppress a default pattern for syntax highlighting. See the documentation of the chosen framework for details.
-
getServerLauncherClass
protected TypeReference getServerLauncherClass(org.eclipse.xtext.Grammar grammar)
-
getServletClass
protected TypeReference getServletClass(org.eclipse.xtext.Grammar grammar)
-
checkConfiguration
public void checkConfiguration(Issues issues)
- Specified by:
checkConfiguration
in interfaceIXtextGeneratorFragment
- Overrides:
checkConfiguration
in classAbstractXtextGeneratorFragment
-
generate
public void generate()
-
generateJsHighlighting
protected void generateJsHighlighting(java.lang.String langId)
-
generateKeywords
protected java.lang.CharSequence generateKeywords(java.util.List<java.lang.String> wordKeywords, java.util.List<java.lang.String> nonWordKeywords)
-
generateKeywordsRegExp
protected java.lang.CharSequence generateKeywordsRegExp()
-
generateExtraKeywordsRegExp
protected java.lang.CharSequence generateExtraKeywordsRegExp()
-
createOrionPatterns
protected java.util.Collection<java.lang.String> createOrionPatterns(java.lang.String langId, java.util.Set<java.lang.String> keywords)
-
createCodeMirrorPatterns
protected com.google.common.collect.Multimap<java.lang.String,java.lang.String> createCodeMirrorPatterns(java.lang.String langId, java.util.Set<java.lang.String> keywords)
-
generateIndexDoc
protected void generateIndexDoc(java.lang.String hlModName)
-
generateStyleSheet
protected void generateStyleSheet()
-
generateServerLauncher
protected void generateServerLauncher()
-
generateServlet
protected void generateServlet()
-
generateWebXml
protected void generateWebXml()
-
getFramework
@Pure public GeneratorOption<WebIntegrationFragment.Framework> getFramework()
-
getGenerateJsHighlighting
@Pure public BooleanGeneratorOption getGenerateJsHighlighting()
-
getGenerateServlet
@Pure public BooleanGeneratorOption getGenerateServlet()
-
getGenerateJettyLauncher
@Pure public BooleanGeneratorOption getGenerateJettyLauncher()
-
getGenerateWebXml
@Pure public BooleanGeneratorOption getGenerateWebXml()
-
getGenerateHtmlExample
@Pure public BooleanGeneratorOption getGenerateHtmlExample()
-
setRequireJsVersion
public void setRequireJsVersion(java.lang.String requireJsVersion)
-
setRequireJsTextVersion
public void setRequireJsTextVersion(java.lang.String requireJsTextVersion)
-
setJQueryVersion
public void setJQueryVersion(java.lang.String jQueryVersion)
-
setAceVersion
public void setAceVersion(java.lang.String aceVersion)
-
setCodeMirrorVersion
public void setCodeMirrorVersion(java.lang.String codeMirrorVersion)
-
-