/*
* 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.diff.tools.util.text;
import com.intellij.diff.comparison.ComparisonManagerImpl;
import com.intellij.diff.comparison.ComparisonPolicy;
import com.intellij.diff.contents.DiffContent;
import com.intellij.diff.fragments.LineFragment;
import com.intellij.diff.lang.DiffIgnoredRangeProvider;
import com.intellij.diff.requests.ContentDiffRequest;
import com.intellij.diff.tools.util.base.HighlightPolicy;
import com.intellij.diff.tools.util.base.IgnorePolicy;
import com.intellij.diff.tools.util.base.TextDiffSettingsHolder.TextDiffSettings;
import com.intellij.diff.util.Side;
import com.intellij.openapi.Disposable;
import com.intellij.openapi.progress.ProgressIndicator;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.util.registry.Registry;
import com.intellij.util.ArrayUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
import static com.intellij.diff.tools.util.base.HighlightPolicy.*;
import static com.intellij.diff.tools.util.base.IgnorePolicy.*;
public class SmartTextDiffProvider extends TwosideTextDiffProviderBase implements TwosideTextDiffProvider {
private static final IgnorePolicy[] IGNORE_POLICIES = {DEFAULT, TRIM_WHITESPACES, IGNORE_WHITESPACES, IGNORE_WHITESPACES_CHUNKS, FORMATTING};
private static final HighlightPolicy[] HIGHLIGHT_POLICIES = {BY_LINE, BY_WORD, BY_WORD_SPLIT, DO_NOT_HIGHLIGHT};
@Nullable private final Project myProject;
@NotNull private final DiffContent myContent1;
@NotNull private final DiffContent myContent2;
@NotNull private final DiffIgnoredRangeProvider myProvider;
@Nullable
public static TwosideTextDiffProvider create(@Nullable Project project,
@NotNull ContentDiffRequest request,
@NotNull TextDiffSettings settings,
@NotNull Runnable rediff,
@NotNull Disposable disposable) {
DiffContent content1 = Side.LEFT.select(request.getContents());
DiffContent content2 = Side.RIGHT.select(request.getContents());
DiffIgnoredRangeProvider ignoredRangeProvider = getIgnoredRangeProvider(project, content1, content2);
if (ignoredRangeProvider == null) return null;
return new SmartTextDiffProvider(project, content1, content2, settings, rediff, disposable, ignoredRangeProvider);
}
@Nullable
public static TwosideTextDiffProvider.NoIgnore createNoIgnore(@Nullable Project project,
@NotNull ContentDiffRequest request,
@NotNull TextDiffSettings settings,
@NotNull Runnable rediff,
@NotNull Disposable disposable) {
DiffContent content1 = Side.LEFT.select(request.getContents());
DiffContent content2 = Side.RIGHT.select(request.getContents());
DiffIgnoredRangeProvider ignoredRangeProvider = getIgnoredRangeProvider(project, content1, content2);
if (ignoredRangeProvider == null) return null;
return new SmartTextDiffProvider.NoIgnore(project, content1, content2, settings, rediff, disposable, ignoredRangeProvider);
}
private SmartTextDiffProvider(@Nullable Project project,
@NotNull DiffContent content1,
@NotNull DiffContent content2,
@NotNull TextDiffSettings settings,
@NotNull Runnable rediff,
@NotNull Disposable disposable,
@NotNull DiffIgnoredRangeProvider ignoredRangeProvider) {
this(project, content1, content2, settings, rediff, disposable, ignoredRangeProvider, IGNORE_POLICIES, HIGHLIGHT_POLICIES);
}
private SmartTextDiffProvider(@Nullable Project project,
@NotNull DiffContent content1,
@NotNull DiffContent content2,
@NotNull TextDiffSettings settings,
@NotNull Runnable rediff,
@NotNull Disposable disposable,
@NotNull DiffIgnoredRangeProvider ignoredRangeProvider,
@NotNull IgnorePolicy[] ignorePolicies,
@NotNull HighlightPolicy[] highlightPolicies) {
super(settings, rediff, disposable, ignorePolicies, highlightPolicies);
myProject = project;
myContent1 = content1;
myContent2 = content2;
myProvider = ignoredRangeProvider;
}
@Nullable
@Override
protected String getText(@NotNull IgnorePolicy option) {
if (option == FORMATTING) return myProvider.getDescription();
return null;
}
@NotNull
@Override
protected List<LineFragment> doCompare(@NotNull CharSequence text1,
@NotNull CharSequence text2,
@NotNull IgnorePolicy ignorePolicy,
boolean innerFragments,
@NotNull ProgressIndicator indicator) {
if (ignorePolicy == FORMATTING) {
return compareIgnoreFormatting(text1, text2, innerFragments, indicator);
}
else {
ComparisonPolicy policy = ignorePolicy.getComparisonPolicy();
return SimpleTextDiffProvider.DEFAULT_COMPUTER.compute(text1, text2, policy, innerFragments, indicator);
}
}
@NotNull
private List<LineFragment> compareIgnoreFormatting(@NotNull CharSequence text1,
@NotNull CharSequence text2,
boolean innerFragments,
@NotNull ProgressIndicator indicator) {
List<TextRange> ranges1 = myProvider.getIgnoredRanges(myProject, text1, myContent1);
List<TextRange> ranges2 = myProvider.getIgnoredRanges(myProject, text2, myContent2);
ComparisonManagerImpl comparisonManager = ComparisonManagerImpl.getInstanceImpl();
return comparisonManager.compareLinesWithIgnoredRanges(text1, text2, ranges1, ranges2, innerFragments, indicator);
}
@Nullable
private static DiffIgnoredRangeProvider getIgnoredRangeProvider(@Nullable Project project,
@NotNull DiffContent content1,
@NotNull DiffContent content2) {
if (!Registry.is("diff.smart.ignore.enabled")) return null;
for (DiffIgnoredRangeProvider provider : DiffIgnoredRangeProvider.EP_NAME.getExtensions()) {
if (provider.accepts(project, content1) &&
provider.accepts(project, content2)) {
return provider;
}
}
return null;
}
public static class NoIgnore extends SmartTextDiffProvider implements TwosideTextDiffProvider.NoIgnore {
private NoIgnore(@Nullable Project project,
@NotNull DiffContent content1,
@NotNull DiffContent content2,
@NotNull TextDiffSettings settings,
@NotNull Runnable rediff,
@NotNull Disposable disposable,
@NotNull DiffIgnoredRangeProvider ignoredRangeProvider) {
super(project, content1, content2, settings, rediff, disposable, ignoredRangeProvider,
IGNORE_POLICIES, ArrayUtil.remove(HIGHLIGHT_POLICIES, DO_NOT_HIGHLIGHT));
}
@NotNull
@Override
public List<LineFragment> compare(@NotNull CharSequence text1, @NotNull CharSequence text2, @NotNull ProgressIndicator indicator) {
//noinspection ConstantConditions
return super.compare(text1, text2, indicator);
}
}
}