MultiHostRegistrar (Unofficial IntelliJ Community Edition API docs)

All Known Implementing Classes:

MultiHostRegistrarImpl
```
public interface MultiHostRegistrar
```
Provides ability to inject languages inside other PSI elements.
E.g. inject SQL inside XML tag text or inject RegExp into Java string literals.
These injected fragments are treated by IDE as separate tiny files in a specific language and corresponding code insight features,
like completion, highlighting, navigation become available there.
You can get hold of an instance of MultiHostRegistrar by registering your own implementation of MultiHostInjector and
implementing its MultiHostInjector.getLanguagesToInject(MultiHostRegistrar, com.intellij.psi.PsiElement) method.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`MultiHostRegistrar`	`addPlace(java.lang.String prefix, java.lang.String suffix, PsiLanguageInjectionHost host, TextRange rangeInsideHost)` Specifies the range in the host file to be considered as injected file part.
`void`	`doneInjecting()` The final part of the injecting process.
`MultiHostRegistrar`	`startInjecting(Language language)` Start injecting the `language` in this place. After you call `startInjecting(Language)` you will have to call `addPlace(String, String, PsiLanguageInjectionHost, TextRange)` one or several times and then call `doneInjecting()`. After that the text in ranges (denoted by one or several `addPlace(String, String, PsiLanguageInjectionHost, TextRange)` calls) will be treated by IDE as a code in the `language`. For example, in this Java fragment `String x = "<start>"+"</start>";` if you call - `startInjecting(XMLLanguage.getInstance());` - `addPlace(null, null, literal1, insideRange1);` - `addPlace(null, null, literal2, insideRange2);` - `doneInjecting();` You will have XML language injected in these string literals, along with its completion, navigation etc niceties.
`default MultiHostRegistrar`	`startInjecting(Language language, java.lang.String extension)` The variant of `startInjecting(Language)` with explicitly specified file extension.

- Method Detail
  - startInjecting
```
MultiHostRegistrar startInjecting(Language language)
```
    Start injecting the language in this place.
    After you call startInjecting(Language) you will have to call addPlace(String, String, PsiLanguageInjectionHost, TextRange) one or several times and then call doneInjecting().
    After that the text in ranges (denoted by one or several addPlace(String, String, PsiLanguageInjectionHost, TextRange) calls) will be treated by IDE as a code in the language.
    For example, in this Java fragment
    String x = "<start>"+"</start>";
    if you call
    - startInjecting(XMLLanguage.getInstance());
    - addPlace(null, null, literal1, insideRange1);
    - addPlace(null, null, literal2, insideRange2);
    - doneInjecting();
    You will have XML language injected in these string literals, along with its completion, navigation etc niceties.
    
    Returns:
    
    this
  - startInjecting
```
default MultiHostRegistrar startInjecting(Language language,
                                          java.lang.String extension)
```
    The variant of startInjecting(Language) with explicitly specified file extension.
    
    Parameters:
    
    extension - the created injected file name will have. Some parsers require specific extension. By default the extension is taken from the host file.
  - addPlace
```
MultiHostRegistrar addPlace(java.lang.String prefix,
                            java.lang.String suffix,
                            PsiLanguageInjectionHost host,
                            TextRange rangeInsideHost)
```
    Specifies the range in the host file to be considered as injected file part.
    
    Parameters:
    
    prefix - this part will be appended before.
    For example. to treat the following Java string literal as a HTML inner text:
    String html = "Hello <b>world</b>";
    You can call addPlace("<html><body>", "</body></html>", literal, insideRange);
    
    suffix - this part will be appended after.
    
    host - the text range of which the language will be injected into.
    
    rangeInsideHost - into which the language will be injected.
    For example, to inject something inside Java string literal String s = "xyz";
    you will have to call addPlace(prefix, suffix, literal, new TextRange(1, 4)); to inject inside double quotes.
    Injected file document text will be of length = 3 and equals to 'xyz'.
    If, however, you called addPlace(prefix, suffix, literal, new TextRange(0, 5)); instead,
    the injected file text would consist of five characters '"', 'x', 'y', 'z', '"'.
    
    See Also:
    
    for the required workflow.
  - doneInjecting
```
void doneInjecting()
```
    The final part of the injecting process. You have to call this method to tell the IDE you finished constructing the injection.
    
    See Also:
    
    for a required workflow.

Interface MultiHostRegistrar

Method Summary

Method Detail

startInjecting

startInjecting

addPlace

doneInjecting