Package jetbrains.mps.project.structure.modules

Class GeneratorDescriptor

java.lang.Object

jetbrains.mps.project.structure.modules.ModuleDescriptor

jetbrains.mps.project.structure.modules.GeneratorDescriptor

All Implemented Interfaces:

Copyable<ModuleDescriptor>, CopyableDescriptor<ModuleDescriptor>

public class GeneratorDescriptor
extends ModuleDescriptor

Constructor Summary

Constructors

Constructor	Description
GeneratorDescriptor()

Method Summary

Modifier and Type	Method	Description
GeneratorDescriptor	copy()
String	getAlias()	While we keep machine-generated module name for Generator modules, alias is a part which Language Designer may pick to his liking.
boolean	getCompileInMPS()
Set<SModuleReference>	getDepGenerators()
protected int	getHeaderMarker()
String	getOutputPath()	FIXME Likely, SolutionDescriptor.getOutputPath(), LanguageDescriptor.getGenPath() and this one need to move to ModuleDescriptor.
List<MappingPriorityRule>	getPriorityRules()
SModuleReference	getSourceLanguage()
boolean	isGenerateTemplates()
void	load(ModelInputStream stream)
void	save(ModelOutputStream stream)
void	setAlias(String alias)
void	setGenerateTemplates(boolean generateTemplates)
void	setOutputPath(String path)
void	setSourceLanguage(SModuleReference sourceLanguage)
boolean	updateModuleRefs(SRepository repository)	Expects at least model read access (although likely no reason to invoke in any other case but from write that modified smth)

Methods inherited from class jetbrains.mps.project.structure.modules.ModuleDescriptor

addFacetDescriptor, copy0, getAdditionalJavaStubPaths, getDependencies, getDependencyVersions, getDeploymentDescriptor, getId, getLanguageVersions, getLoadException, getModelRootDescriptors, getModuleFacetDescriptors, getModuleReference, getModuleVersion, getNamespace, getSourcePaths, getTimestamp, getUsedDevkits, getUsedLanguages, hasDependencyVersions, hasLanguageVersions, isUseTransientOutput, needsExternalIdeaCompile, removeFacetDescriptor, setDeploymentDescriptor, setHasDependencyVersions, setHasLanguageVersions, setId, setLoadException, setModuleVersion, setNamespace, setNeedsExternalIdeaCompile, setTimestamp, setUseTransientOutput, updateFacetDescriptor, updateModelRefs

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratorDescriptor

public GeneratorDescriptor()

Method Detail

setSourceLanguage

public void setSourceLanguage(SModuleReference sourceLanguage)

setAlias

public void setAlias(String alias)

getAlias

public String getAlias()

While we keep machine-generated module name for Generator modules, alias is a part which Language Designer may pick to his liking. Note, Generator.getAlias() includes qualified name of source language as prefix, and value of this method is only a suffix, likely kept unchanged during module renames.

getSourceLanguage

@NotNull
public SModuleReference getSourceLanguage()

Returns:

identifier of a language this generator transforms

getDepGenerators

public Set<SModuleReference> getDepGenerators()

getPriorityRules

public List<MappingPriorityRule> getPriorityRules()

isGenerateTemplates

public boolean isGenerateTemplates()

setGenerateTemplates

public void setGenerateTemplates(boolean generateTemplates)

updateModuleRefs

public boolean updateModuleRefs(SRepository repository)

Expects at least model read access (although likely no reason to invoke in any other case but from write that modified smth)

Overrides:

updateModuleRefs in class ModuleDescriptor

Parameters:

repository - where to look old/new module references up.

getOutputPath

@Nullable
public String getOutputPath()

FIXME Likely, SolutionDescriptor.getOutputPath(), LanguageDescriptor.getGenPath() and this one need to move to ModuleDescriptor. I would do that once there's clear idea whether to use IFile, java.io.File or Path for these locations, and whether to keep these as module descriptor attributes or inside relevant facets.

Returns:

filesystem location where generated files for the generator go, or null if this module doesn't support output

setOutputPath

public void setOutputPath(@Nullable
                          String path)

getCompileInMPS

public boolean getCompileInMPS()

Overrides:

getCompileInMPS in class ModuleDescriptor

getHeaderMarker

protected int getHeaderMarker()

Overrides:

getHeaderMarker in class ModuleDescriptor

save

public void save(ModelOutputStream stream)
          throws IOException

Overrides:

save in class ModuleDescriptor

Throws:

IOException

load

public void load(ModelInputStream stream)
          throws IOException

Overrides:

load in class ModuleDescriptor

Throws:

IOException

copy

@NotNull
public GeneratorDescriptor copy()

Specified by:

copy in interface Copyable<ModuleDescriptor>

Overrides:

copy in class ModuleDescriptor

Returns:

full deep-copy of the T instance