Package jetbrains.mps.smodel.language

Class LanguageRegistry

java.lang.Object

jetbrains.mps.smodel.language.LanguageRegistry

All Implemented Interfaces:

DeployListener, CoreComponent

public class LanguageRegistry
extends Object
implements CoreComponent, DeployListener

Preferred way to obtain instance of LanguageRegistry is to query ComponentHost, e.g. through jetbrains.mps.core.platform.Platform or Project.getComponent(Class) which is aware of the MPS platform. evgeny, 3/11/11

Nested Class Summary

Nested classes/interfaces inherited from interface jetbrains.mps.classloading.DeployListener

DeployListener.ResourceTrackerCallback

Constructor Summary

Constructors

Constructor	Description
LanguageRegistry(ClassLoaderManager loaderManager)

Method Summary

Modifier and Type	Method	Description
void	addRegistryListener(LanguageRegistryListener listener)
void	dispose()
Collection<SLanguage>	getAllLanguages()
GeneratorRuntime	getGenerator(Generator generator)	Deprecated. use getGenerator(SModuleReference) as it's SModuleReference that is generator identity.
GeneratorRuntime	getGenerator(SModuleReference generatorIdentity)
static LanguageRegistry	getInstance()	Deprecated. obtain instance through componentHost#findComponent(LanguageRegistry.class) or use context-specific alternative getInstance(SRepository).
static LanguageRegistry	getInstance(SRepository repository)	IMPORTANT: use componentHost#findComponent(LanguageRegistry.class) whenever \ possible instead of this method.
LanguageRuntime	getLanguage(String namespace)
LanguageRuntime	getLanguage(SLanguageId id)
LanguageRuntime	getLanguage(Language language)
LanguageRuntime	getLanguage(SLanguage language)
void	init()
void	onLoaded(Set<ReloadableModule> loadedModules, ProgressMonitor monitor)	Contract: The loaded modules are guaranteed to be deployed and module.getClassLoader() returns not-null.
void	onUnloaded(Set<ReloadableModule> unloadedModules, ProgressMonitor monitor)	Contract: The class loaders of the unloadedModules are still valid (i.e.
void	removeRegistryListener(LanguageRegistryListener listener)
String	toString()
void	withAvailableLanguages(Consumer<LanguageRuntime> operation)	Synchronous access to actual languages in the registry.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jetbrains.mps.classloading.DeployListener

onUnloaded

Constructor Detail

LanguageRegistry

public LanguageRegistry(ClassLoaderManager loaderManager)

Method Detail

getInstance

@Deprecated
public static LanguageRegistry getInstance()

Deprecated.

obtain instance through componentHost#findComponent(LanguageRegistry.class) or use context-specific alternative getInstance(SRepository).

getInstance

@NotNull
public static LanguageRegistry getInstance(@NotNull
                                           SRepository repository)

IMPORTANT: use componentHost#findComponent(LanguageRegistry.class) whenever \ possible instead of this method. USE OF THIS METHOD IS DISCOURAGED.

At the moment, there's only 1 global LanguageRegistry. However, we move slowly towards independent projects/non-global module repositories and thus would need repository-specific registries, and use of the method is the proper way to obtain registry and to think about proper context in the client code right away.

Returns:

collection of languages available in the given context

init

public void init()

Specified by:

init in interface CoreComponent

dispose

public void dispose()

Specified by:

dispose in interface CoreComponent

toString

public String toString()

Overrides:

toString in class Object

addRegistryListener

public void addRegistryListener(LanguageRegistryListener listener)

removeRegistryListener

public void removeRegistryListener(LanguageRegistryListener listener)

withAvailableLanguages

public void withAvailableLanguages(@NotNull
                                   Consumer<LanguageRuntime> operation)

Synchronous access to actual languages in the registry. It's guaranteed no change to the set of languages happen while this method is working. BEWARE, operation shall not perform model read/write as it might lead to dead-lock (a thread starts model write and waits for write on myRuntimeInstanceAccess, while another thread had grabbed myRuntimeInstanceAccess read lock and consumer operation trues to grab model lock).

Parameters:

operation - invoked for each actual LanguageRuntime, minimalistic and simple.

getAllLanguages

public Collection<SLanguage> getAllLanguages()

Returns:

snapshot of languages known to the registry at the given moment. May not reflect actual state (a language might get unloaded), but as long as it's about identity objects, it's not that important to keep the collection exact.

getLanguage

@Nullable
public LanguageRuntime getLanguage(SLanguage language)

getLanguage

@Nullable
public LanguageRuntime getLanguage(SLanguageId id)

getLanguage

@Nullable
public LanguageRuntime getLanguage(String namespace)

getLanguage

@Nullable
public LanguageRuntime getLanguage(Language language)

getGenerator

@Nullable
@Deprecated
public GeneratorRuntime getGenerator(Generator generator)

Deprecated.

use getGenerator(SModuleReference) as it's SModuleReference that is generator identity.

PROVISIONAL API, DO NOT USE Find respective runtime presentation of generator module FIXME shall decide whether need standalone GeneratorRegistry to supply GeneratorRuntimes FIXME or access to GeneratorRuntime through LanguageRegistry is enough.

getGenerator

@Nullable
public GeneratorRuntime getGenerator(@NotNull
                                     SModuleReference generatorIdentity)

Parameters:

generatorIdentity - we use SModuleReference to identify generator, not to introduce a dedicated SGenerator similar to SLanguage

onUnloaded

public void onUnloaded(Set<ReloadableModule> unloadedModules,
                       @NotNull
                       ProgressMonitor monitor)

Description copied from interface: DeployListener

Contract: The class loaders of the unloadedModules are still valid (i.e. not disposed) Modules are still deployed however the modules might be reloaded and the corresponding ModuleClassLoaders might get disposed, essentially meaning that ANY use of instances of these stale classes might trigger ModuleClassLoader.ModuleClassLoaderIsDisposedException.

Specified by:

onUnloaded in interface DeployListener

Parameters:

unloadedModules - are likely to be removed from the repository after this moment

See Also:

if for some reason you need to use the objects of the stale module classes after #unload event.

onLoaded

public void onLoaded(Set<ReloadableModule> loadedModules,
                     @NotNull
                     ProgressMonitor monitor)

Description copied from interface: DeployListener

Contract: The loaded modules are guaranteed to be deployed and module.getClassLoader() returns not-null. Essentially they are ready to give out classes. The modules will stay deployed until the corresponding notification in the #onUnloaded method.

Specified by:

onLoaded in interface DeployListener

Parameters:

loadedModules - are surely in the repository at this moment.

See Also:

ReloadableModule.getStatus()