/*
* Copyright 2003-2017 JetBrains s.r.o.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jetbrains.mps.smodel.action;
import jetbrains.mps.kernel.model.SModelUtil;
import jetbrains.mps.smodel.adapter.MetaAdapterByDeclaration;
import jetbrains.mps.smodel.constraints.ModelConstraints;
import jetbrains.mps.smodel.presentation.NodePresentationUtil;
import jetbrains.mps.util.annotation.ToRemove;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.mps.openapi.language.SReferenceLink;
import org.jetbrains.mps.openapi.model.SNode;
/**
* Provides a textual presentation of a referent node.
*
* @author Radimir.Sorokin
*/
public interface IReferentPresentationProvider {
@NotNull
String getPresentation(@NotNull SNode referenceNode, @NotNull SNode referentNode);
/**
* Default referent presentation that used in `ref. presentation` cells.
*/
IReferentPresentationProvider DEFAULT_PRESENTATION =
(referenceNode, referentNode) -> NodePresentationUtil.presentation(referentNode, referenceNode);
/**
* Default matching text in completion menu.
*/
IReferentPresentationProvider DEFAULT_MATCHING_TEXT =
(referenceNode, referentNode) -> NodePresentationUtil.matchingText(referentNode, referenceNode);
/**
* Default visible matching text in completion menu.
*/
IReferentPresentationProvider DEFAULT_VISIBLE_MATCHING_TEXT =
(referenceNode, referentNode) -> NodePresentationUtil.visibleMatchingText(referentNode, referenceNode);
/**
* 3.4->3.5 compatibility method. after 3.5 use {@link #DEFAULT_PRESENTATION} instead
*/
@ToRemove(version = 2017.2)
static IReferentPresentationProvider getDefaultPresentation(@NotNull SReferenceLink link) {
return (referenceNode, referentNode) -> {
String legacyPresentation =
ModelConstraints.getReferenceDescriptor(referenceNode, link).getReferencePresentation(referentNode, false, false, true);
if (legacyPresentation != null) {
return legacyPresentation;
}
return NodePresentationUtil.presentation(referentNode, referenceNode);
};
}
/**
* 3.4->3.5 compatibility method. after 3.5 use {@link #DEFAULT_MATCHING_TEXT} instead
*/
@ToRemove(version = 2017.2)
static IReferentPresentationProvider getDefaultMatchingText(@NotNull SReferenceLink link) {
return (referenceNode, referentNode) -> {
String legacyMatchingText =
ModelConstraints.getReferenceDescriptor(referenceNode, link).getReferencePresentation(referentNode, false, false, false);
if (legacyMatchingText != null) {
return legacyMatchingText;
}
return NodePresentationUtil.matchingText(referentNode, referenceNode);
};
}
/**
* @deprecated use {@link #getDefaultMatchingText(SReferenceLink)} (for 3.4->3.5 compatibility) instead
*/
@Deprecated
@ToRemove(version = 3.5)
static IReferentPresentationProvider getDefaultMatchingText(@NotNull SNode linkDeclaration) {
SReferenceLink link = MetaAdapterByDeclaration.getReferenceLink(SModelUtil.getGenuineLinkDeclaration(linkDeclaration));
return link.isValid() ? getDefaultMatchingText(link) : DEFAULT_MATCHING_TEXT;
}
/**
* 3.4->3.5 compatibility method. after 3.5 use {@link #DEFAULT_VISIBLE_MATCHING_TEXT} instead
*/
@ToRemove(version = 2017.2)
static IReferentPresentationProvider getDefaultVisibleMatchingText(@NotNull SReferenceLink link) {
return (referenceNode, referentNode) -> {
String legacyMatchingText =
ModelConstraints.getReferenceDescriptor(referenceNode, link).getReferencePresentation(referentNode, true, false, false);
if (legacyMatchingText != null) {
return legacyMatchingText;
}
return NodePresentationUtil.visibleMatchingText(referentNode, referenceNode);
};
}
/**
* @deprecated use {@link #getDefaultVisibleMatchingText(SReferenceLink)} (for 3.4->3.5 compatibility) instead
*/
@Deprecated
@ToRemove(version = 3.5)
static IReferentPresentationProvider getDefaultVisibleMatchingText(@NotNull SNode linkDeclaration) {
SReferenceLink link = MetaAdapterByDeclaration.getReferenceLink(SModelUtil.getGenuineLinkDeclaration(linkDeclaration));
return link.isValid() ? getDefaultVisibleMatchingText(link) : DEFAULT_VISIBLE_MATCHING_TEXT;
}
}