SModel language
Last modified: 14 September 2021The purpose of SModel language is to query and modify MPS models. It allows you to investigate nodes, attributes, properties, links and many other essential qualities of your models. The language is needed to encode several different aspects of your languages - actions, refactorings, generator, to name the most prominent ones. You typically use the jetbrains.mps.lang.smodel language in combination with BaseLanguage.
tip
MPS allows you to down-cast from the concepts of the smodel concepts to the underlying Java API (Open API), may you need more power when manipulating the model. Check out the Open API documentation for details.
Treatment of null values
SModel language treats null values in a very safe manner. It is pretty common, in OO-languages, such as Java or C#, to have a lot of checks for null values in the form of expr == null and expr != null statements scattered across the code. These are necessary to prevent null pointer exceptions. However, they at the same time increase code clutter and often make the code more difficult to read. In order to alleviate this problem, MPS treats null values in a liberal way. For example, if you ask a null node for a property, you will get back a default value for the type of the property. If you ask a null node for its children list, you will get empty list, etc. If you call a behavior method on a null node, a null value is returned, provided the return type of the invoked method is a ClassifierType or a StringType. For a PrimitiveType, the default value of that type is returned. This should make your life as a language designer easier.
Operation parameters
A lot of the operations in the SModel language accept parameters. The parameters can be specified once you open the parameter list by entering < at the end of an operation. E.g. myNode.ancestors<concept = IfStatement, concept = ForStatement>.
The "+" symbol as a parameter to these operations means "include myself". That is, when the node, on which the operation is being invoked, matches the condition, "+" ensures that the node will also be included in the returned result - e.g. myNode.ancestors<concept = IfStatement, +> may return myNode, if it is an IfStatement.
Managing concurrent access
The access language eases the use of the model access API. It is needed for concurrent access. jetbrains.mps.lang.access must be imported for these statements to be available It contains the following commands:
write action with
read action with
command with
execute command in EDT with
execute in EDT with
undo-transparent command with
tip
The parameter of all these commands has to be of type SRepository. It can be obtained, for example, by calling Project.getRepository() or EditorContext.getRepository(). The global repository should not be used anymore.
write action with | Synchronous model write: Modifications to models can only be performed from within managed actions, which hold the appropriate write lock. The method obtains such a lock and executes the provided action. It should not be invoked from EDT (Event dispatching thread), otherwise, a UI freeze may occur. A lock cannot be upgraded. When owning the read lock, it is not allowed to ask for the write lock through this command.
|
|---|---|
read action with | Synchronous model read: Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock. The method obtains such a lock and executes the provided action.
|
command with | Synchronous model command: It represents a write action executed with respect to the platform undo mechanism. This method shall be invoked from EDT thread only. Unlike execute command in EDT, this method executes synchronously.
|
execute command in EDT with | Schedule command to run from EDT asynchronously: It represents a write action executed with respect to the platform undo mechanism and runs asynchronously from EDT thread. This method may be invoked from any thread.
|
execute in EDT with | Schedule asynchronous model read from EDT: Querying properties of models can only be performed from within managed actions, which hold the appropriate read lock. The method obtains such a lock and executes the provided action asynchronously on the EDT UI thread. Inside the action, it is safe to touch any UI elements and perform other EDT-bound actions of the IntelliJ platform.
|
undo-transparent command with | Undo-transparent command: The executed code has model write access and is treated as a command. The only difference is that changes from the transparent action merged with that of the previous undoable command.
|