Package jetbrains.mps.text.rt

Interface TextGenModelOutline

All Known Implementing Classes:

ModelOutline

public interface TextGenModelOutline

WORK IN PROGRESS FIXME document Tells the engine what the model output would look like (from TextGen perspective). Lives in j.m.text.rt as it is deemed to be exposed as part of TextGenDescriptor RT API.

Since:

3.3

Method Summary

Modifier and Type	Method	Description
SModel	getModel()
void	registerTextUnit(String unitName, String unitPath, Charset encoding, SNode... input)	Complete set of options to construct a text unit.
default void	registerTextUnit(String unitName, String path, SNode... input)
default void	registerTextUnit(String unitName, Charset encoding, SNode... input)	registerTextUnit(String, SNode...) alternative with explicit encoding
default void	registerTextUnit(String unitName, SNode... input)	mechanism to tell what unit to generate
void	registerTextUnit(TextUnit textUnit)	mechanism to tell what unit to generate

Method Detail

getModel

@NotNull
SModel getModel()

Returns:

model we build outline for

registerTextUnit

void registerTextUnit(@NotNull
                      TextUnit textUnit)

mechanism to tell what unit to generate

Parameters:

textUnit - text to generate

registerTextUnit

default void registerTextUnit(@NotNull
                              String unitName,
                              SNode... input)

mechanism to tell what unit to generate

Parameters:

unitName - name of the unit

input - sequence of inputs, primary input first. FIXME could be empty? Generally, why not?

registerTextUnit

default void registerTextUnit(@NotNull
                              String unitName,
                              @Nullable
                              Charset encoding,
                              SNode... input)

registerTextUnit(String, SNode...) alternative with explicit encoding

Parameters:

unitName - name of the unit

encoding - null indicates use default

input -

registerTextUnit

default void registerTextUnit(@NotNull
                              String unitName,
                              @Nullable
                              String path,
                              SNode... input)

registerTextUnit

void registerTextUnit(@NotNull
                      String unitName,
                      @Nullable
                      String unitPath,
                      @Nullable
                      Charset encoding,
                      SNode... input)

Complete set of options to construct a text unit. XXX perhaps, worth to add UnitBuilder to stop growing list of parameters. registerTextUnit(String, SNode...) alternative with an optional path and encoding

Parameters:

unitName - name of the unit

unitPath - path to the unit, defaults to qualified model name unless specified

encoding - null indicates use default

input -