/*
* Copyright 2000-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 com.intellij.structuralsearch.plugin.ui;
import com.intellij.codeInsight.hint.TooltipController;
import com.intellij.codeInsight.hint.TooltipGroup;
import com.intellij.codeInsight.template.TemplateContextType;
import com.intellij.codeInsight.template.impl.TemplateEditorUtil;
import com.intellij.icons.AllIcons;
import com.intellij.ide.IdeTooltip;
import com.intellij.ide.IdeTooltipManager;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.command.CommandProcessor;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.editor.EditorFactory;
import com.intellij.openapi.editor.EditorSettings;
import com.intellij.openapi.editor.colors.EditorColors;
import com.intellij.openapi.editor.colors.EditorColorsManager;
import com.intellij.openapi.editor.colors.EditorColorsScheme;
import com.intellij.openapi.editor.ex.EditorEx;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.popup.Balloon;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.structuralsearch.*;
import com.intellij.structuralsearch.plugin.StructuralReplaceAction;
import com.intellij.structuralsearch.plugin.StructuralSearchAction;
import com.intellij.structuralsearch.plugin.replace.ui.ReplaceConfiguration;
import com.intellij.ui.HintHint;
import com.intellij.util.Producer;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import javax.swing.*;
import java.awt.*;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
/**
* @author Maxim.Mossienko
* Date: Apr 21, 2004
* Time: 7:50:48 PM
*/
public class UIUtil {
static Key<SubstitutionShortInfoHandler> LISTENER_KEY = Key.create("sslistener.key");
private static final String MODIFY_EDITOR_CONTENT = SSRBundle.message("modify.editor.content.command.name");
private static final TooltipGroup SS_INFO_TOOLTIP_GROUP = new TooltipGroup("SS_INFO_TOOLTIP_GROUP", 0);
@NonNls private static final String SS_GROUP = "structuralsearchgroup";
@NotNull
public static Editor createEditor(Document doc, final Project project, boolean editable, @Nullable TemplateContextType contextType) {
return createEditor(doc, project, editable, false, contextType);
}
@NotNull
public static Editor createEditor(@NotNull Document doc,
final Project project,
boolean editable,
boolean addToolTipForVariableHandler,
@Nullable TemplateContextType contextType) {
final Editor editor =
editable ? EditorFactory.getInstance().createEditor(doc, project) : EditorFactory.getInstance().createViewer(doc, project);
EditorSettings editorSettings = editor.getSettings();
editorSettings.setVirtualSpace(false);
editorSettings.setLineMarkerAreaShown(false);
editorSettings.setIndentGuidesShown(false);
editorSettings.setLineNumbersShown(false);
editorSettings.setFoldingOutlineShown(false);
editorSettings.setCaretRowShown(false);
if (!editable) {
final EditorColorsScheme globalScheme = EditorColorsManager.getInstance().getGlobalScheme();
Color c = globalScheme.getColor(EditorColors.READONLY_BACKGROUND_COLOR);
if (c == null) {
c = globalScheme.getDefaultBackground();
}
((EditorEx)editor).setBackgroundColor(c);
}
else {
((EditorEx)editor).setEmbeddedIntoDialogWrapper(true);
}
TemplateEditorUtil.setHighlighter(editor, contextType);
if (addToolTipForVariableHandler) {
SubstitutionShortInfoHandler handler = new SubstitutionShortInfoHandler(editor);
editor.addEditorMouseMotionListener(handler);
editor.getDocument().addDocumentListener(handler);
editor.getCaretModel().addCaretListener(handler);
editor.putUserData(LISTENER_KEY, handler);
}
return editor;
}
public static JComponent createOptionLine(JComponent[] options) {
JPanel tmp = new JPanel();
tmp.setLayout(new BoxLayout(tmp, BoxLayout.X_AXIS));
for (int i = 0; i < options.length; i++) {
if (i != 0) {
tmp.add(Box.createHorizontalStrut(com.intellij.util.ui.UIUtil.DEFAULT_HGAP));
}
tmp.add(options[i]);
}
tmp.add(Box.createHorizontalGlue());
return tmp;
}
public static JComponent createOptionLine(JComponent option) {
return createOptionLine(new JComponent[]{option});
}
public static void setContent(final Editor editor, String val, final int from, final int end, final Project project) {
final String value = val != null ? val : "";
CommandProcessor.getInstance().executeCommand(project, () -> ApplicationManager.getApplication().runWriteAction(() -> editor.getDocument().replaceString(from, (end == -1) ? editor.getDocument().getTextLength() : end, value)), MODIFY_EDITOR_CONTENT, SS_GROUP);
}
static String getShortParamString(Configuration config, String varname) {
if (config == null) return "";
final MatchOptions options = config.getMatchOptions();
NamedScriptableDefinition namedScriptableDefinition = options == null ? null : options.getVariableConstraint(varname);
final ReplacementVariableDefinition replacementVariableDefinition =
config instanceof ReplaceConfiguration ? ((ReplaceConfiguration)config).getOptions().getVariableDefinition(varname) : null;
if (replacementVariableDefinition != null) namedScriptableDefinition = replacementVariableDefinition;
return getShortParamString(namedScriptableDefinition);
}
@NotNull
public static String getShortParamString(NamedScriptableDefinition namedScriptableDefinition) {
if (namedScriptableDefinition == null) {
return SSRBundle.message("no.constraints.specified.tooltip.message");
}
final StringBuilder buf = new StringBuilder();
if (namedScriptableDefinition instanceof MatchVariableConstraint) {
final MatchVariableConstraint constraint = (MatchVariableConstraint)namedScriptableDefinition;
if (constraint.isPartOfSearchResults()) {
append(buf, SSRBundle.message("target.tooltip.message"));
}
if (constraint.getRegExp() != null && constraint.getRegExp().length() > 0) {
append(buf, SSRBundle.message("text.tooltip.message",
constraint.isInvertRegExp() ? SSRBundle.message("not.tooltip.message") : "", constraint.getRegExp()));
}
if (constraint.isWithinHierarchy() || constraint.isStrictlyWithinHierarchy()) {
append(buf, SSRBundle.message("within.hierarchy.tooltip.message"));
}
if (constraint.getNameOfExprType() != null && constraint.getNameOfExprType().length() > 0) {
append(buf, SSRBundle.message("exprtype.tooltip.message",
constraint.isInvertExprType() ? SSRBundle.message("not.tooltip.message") : "",
constraint.getNameOfExprType(),
constraint.isExprTypeWithinHierarchy() ? SSRBundle.message("supertype.tooltip.message") : ""));
}
if (constraint.getNameOfFormalArgType() != null && constraint.getNameOfFormalArgType().length() > 0) {
append(buf, SSRBundle.message("expected.type.tooltip.message",
constraint.isInvertFormalType() ? SSRBundle.message("not.tooltip.message") : "",
constraint.getNameOfFormalArgType(),
constraint.isFormalArgTypeWithinHierarchy() ? SSRBundle.message("supertype.tooltip.message") : ""));
}
if (StringUtil.isNotEmpty(constraint.getWithinConstraint())) {
final String text = StringUtil.unquoteString(constraint.getWithinConstraint());
append(buf, constraint.isInvertWithinConstraint()
? SSRBundle.message("not.within.constraints.tooltip.message", text)
: SSRBundle.message("within.constraints.tooltip.message", text));
}
final String name = constraint.getName();
if (!Configuration.CONTEXT_VAR_NAME.equals(name)) {
if (constraint.getMinCount() == constraint.getMaxCount()) {
append(buf, SSRBundle.message("occurs.tooltip.message", constraint.getMinCount()));
}
else {
append(buf, SSRBundle.message("min.occurs.tooltip.message", constraint.getMinCount(),
constraint.getMaxCount() == Integer.MAX_VALUE ?
StringUtil.decapitalize(SSRBundle.message("editvarcontraints.unlimited")) :
constraint.getMaxCount()));
}
}
}
final String script = namedScriptableDefinition.getScriptCodeConstraint();
if (script != null && script.length() > 2) {
final String str = SSRBundle.message("script.tooltip.message", StringUtil.stripQuotesAroundValue(script));
append(buf, str);
}
if (buf.length() == 0) {
return SSRBundle.message("no.constraints.specified.tooltip.message");
}
return buf.toString();
}
private static void append(final StringBuilder buf, final String str) {
if (buf.length() > 0) buf.append(", ");
buf.append(str);
}
public static void invokeAction(Configuration config, SearchContext context) {
if (config instanceof SearchConfiguration) {
StructuralSearchAction.triggerAction(config, context);
}
else {
StructuralReplaceAction.triggerAction(config, context);
}
}
static void showTooltip(@NotNull Editor editor, final int start, int end, @NotNull String text) {
final Rectangle visibleArea = editor.getScrollingModel().getVisibleArea();
final Point left = editor.logicalPositionToXY(editor.offsetToLogicalPosition(start));
final int documentLength = editor.getDocument().getTextLength();
if (end >= documentLength) end = documentLength;
final Point right = editor.logicalPositionToXY(editor.offsetToLogicalPosition(end));
final Point bestPoint = new Point(left.x + (right.x - left.x) / 2, right.y + editor.getLineHeight() / 2);
if (visibleArea.x > bestPoint.x) {
bestPoint.x = visibleArea.x;
}
else if (visibleArea.x + visibleArea.width < bestPoint.x) {
bestPoint.x = visibleArea.x + visibleArea.width - 5;
}
final Point p = SwingUtilities.convertPoint(editor.getContentComponent(), bestPoint,
editor.getComponent().getRootPane().getLayeredPane());
final HintHint hint = new HintHint(editor, bestPoint).setAwtTooltip(true).setHighlighterType(true).setShowImmediately(true)
.setCalloutShift(editor.getLineHeight() / 2 - 1);
TooltipController.getInstance().showTooltip(editor, p, text, visibleArea.width, false, SS_INFO_TOOLTIP_GROUP, hint);
}
public static void updateHighlighter(Editor editor, StructuralSearchProfile profile) {
TemplateEditorUtil.setHighlighter(editor, profile.getTemplateContextType());
}
public static MatchVariableConstraint getOrAddVariableConstraint(String varName, Configuration configuration) {
MatchVariableConstraint varInfo = configuration.getMatchOptions().getVariableConstraint(varName);
if (varInfo == null) {
varInfo = new MatchVariableConstraint();
varInfo.setName(varName);
configuration.getMatchOptions().addVariableConstraint(varInfo);
}
return varInfo;
}
public static boolean isTarget(String varName, MatchOptions matchOptions) {
if (Configuration.CONTEXT_VAR_NAME.equals(varName)) {
// Complete Match is default target
for (String name : matchOptions.getVariableConstraintNames()) {
if (!name.equals(Configuration.CONTEXT_VAR_NAME)) {
if (matchOptions.getVariableConstraint(name).isPartOfSearchResults()) {
return false;
}
}
}
return true;
}
final MatchVariableConstraint constraint = matchOptions.getVariableConstraint(varName);
if (constraint == null) {
return false;
}
return constraint.isPartOfSearchResults();
}
@NotNull
public static JComponent createCompleteMatchInfo(final Producer<Configuration> configurationProducer) {
final JLabel completeMatchInfo = new JLabel(AllIcons.RunConfigurations.Variables);
final Point location = completeMatchInfo.getLocation();
final JLabel label = new JLabel(SSRBundle.message("complete.match.variable.tooltip.message",
SSRBundle.message("no.constraints.specified.tooltip.message")));
final IdeTooltip tooltip = new IdeTooltip(completeMatchInfo, location, label);
tooltip.setPreferredPosition(Balloon.Position.atRight).setCalloutShift(6).setHint(true).setExplicitClose(true);
completeMatchInfo.addMouseListener(new MouseAdapter() {
@Override
public void mouseEntered(MouseEvent e) {
final Configuration configuration = configurationProducer.produce();
if (configuration == null) {
return;
}
final MatchOptions matchOptions = configuration.getMatchOptions();
final MatchVariableConstraint constraint =
getOrAddVariableConstraint(Configuration.CONTEXT_VAR_NAME, configuration);
if (isTarget(Configuration.CONTEXT_VAR_NAME, matchOptions)) {
constraint.setPartOfSearchResults(true);
}
label.setText(SSRBundle.message("complete.match.variable.tooltip.message", getShortParamString(constraint)));
final IdeTooltipManager tooltipManager = IdeTooltipManager.getInstance();
tooltipManager.show(tooltip, true);
}
@Override
public void mouseExited(MouseEvent e) {
IdeTooltipManager.getInstance().hide(tooltip);
}
});
return completeMatchInfo;
}
}