/*
* 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.codeInspection.ex;
import com.intellij.codeInspection.CommonProblemDescriptor;
import com.intellij.codeInspection.HTMLComposer;
import com.intellij.codeInspection.InspectionsBundle;
import com.intellij.codeInspection.lang.HTMLComposerExtension;
import com.intellij.codeInspection.lang.InspectionExtensionsFactory;
import com.intellij.codeInspection.reference.*;
import com.intellij.lang.Language;
import com.intellij.openapi.extensions.Extensions;
import com.intellij.openapi.project.ProjectUtilCore;
import com.intellij.openapi.util.Comparing;
import com.intellij.openapi.util.Key;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFile;
import com.intellij.psi.util.PsiUtilCore;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.HashMap;
import java.util.Map;
/**
* @author max
*/
public abstract class HTMLComposerImpl extends HTMLComposer {
private final int[] myListStack;
private int myListStackTop;
private final Map<Key, HTMLComposerExtension> myExtensions = new HashMap<>();
private final Map<Language, HTMLComposerExtension> myLanguageExtensions = new HashMap<>();
@NonNls protected static final String BR = "<br>";
@NonNls protected static final String NBSP = " ";
@NonNls protected static final String CODE_CLOSING = "</code>";
@NonNls protected static final String CODE_OPENING = "<code>";
@NonNls protected static final String B_OPENING = "<b>";
@NonNls protected static final String B_CLOSING = "</b>";
@NonNls protected static final String CLOSE_TAG = "\">";
@NonNls protected static final String A_HREF_OPENING = "<a HREF=\"";
@NonNls protected static final String A_CLOSING = "</a>";
protected HTMLComposerImpl() {
myListStack = new int[5];
myListStackTop = -1;
for (InspectionExtensionsFactory factory : Extensions.getExtensions(InspectionExtensionsFactory.EP_NAME)) {
final HTMLComposerExtension extension = factory.createHTMLComposerExtension(this);
if (extension != null) {
myExtensions.put(extension.getID(), extension);
myLanguageExtensions.put(extension.getLanguage(), extension);
}
}
}
public abstract void compose(StringBuffer buf, RefEntity refEntity);
public void compose(StringBuffer buf, RefEntity refElement, CommonProblemDescriptor descriptor) {}
protected void genPageHeader(final StringBuffer buf, RefEntity refEntity) {
if (refEntity instanceof RefElement) {
RefElement refElement = (RefElement)refEntity;
appendHeading(buf, InspectionsBundle.message("inspection.export.results.capitalized.location"));
buf.append("<div class=\"location\">");
appendShortName(buf, refElement);
buf.append(BR);
buf.append("in ");
appendLocation(buf, refElement);
buf.append("</div>");
buf.append(BR).append(BR);
}
}
private void appendLocation(final StringBuffer buf, final RefElement refElement) {
final HTMLComposerExtension extension = getLanguageExtension(refElement);
if (extension != null) {
extension.appendLocation(refElement, buf);
}
if (refElement instanceof RefFile){
buf.append(InspectionsBundle.message("inspection.export.results.file"));
buf.append(NBSP);
appendElementReference(buf, refElement, false);
}
}
@Nullable
private HTMLComposerExtension getLanguageExtension(final RefElement refElement) {
final PsiElement element = refElement.getElement();
return element != null ? myLanguageExtensions.get(element.getLanguage()) : null;
}
private void appendShortName(final StringBuffer buf, RefElement refElement) {
final HTMLComposerExtension extension = getLanguageExtension(refElement);
if (extension != null) {
extension.appendShortName(refElement, buf);
} else {
refElement.accept(new RefVisitor() {
@Override public void visitFile(@NotNull RefFile file) {
final PsiFile psiFile = file.getElement();
if (psiFile != null) {
buf.append(B_OPENING);
buf.append(psiFile.getName());
buf.append(B_CLOSING);
}
}
});
}
}
protected void appendQualifiedName(StringBuffer buf, RefEntity refEntity) {
if (refEntity == null) return;
String qName = "";
while (!(refEntity instanceof RefProject)) {
if (qName.length() > 0) qName = "." + qName;
String name = null;
if (refEntity instanceof RefElement) {
final HTMLComposerExtension extension = getLanguageExtension((RefElement)refEntity);
if (extension != null) {
name = extension.getQualifiedName(refEntity);
}
}
if (name == null) {
name = refEntity.getName();
}
qName = name + qName;
if (Comparing.strEqual(refEntity.getName(), refEntity.getQualifiedName())) {
buf.append(qName);
return;
}
refEntity = refEntity.getOwner();
}
buf.append(qName);
}
@Override
public void appendElementReference(final StringBuffer buf, RefElement refElement) {
appendElementReference(buf, refElement, true);
}
@Override
public void appendElementReference(final StringBuffer buf, RefElement refElement, String linkText, @NonNls String frameName) {
final String url = ((RefElementImpl)refElement).getURL();
if (url != null) {
appendElementReference(buf, url, linkText, frameName);
}
}
@Override
public void appendElementReference(final StringBuffer buf, String url, String linkText, @NonNls String frameName) {
buf.append(A_HREF_OPENING);
buf.append(url);
if (frameName != null) {
@NonNls final String target = "\" target=\"";
buf.append(target);
buf.append(frameName);
}
buf.append("\">");
buf.append(linkText);
buf.append(A_CLOSING);
}
protected void appendQuickFix(@NonNls final StringBuffer buf, String text) {
buf.append(text);
}
@Override
public void appendElementReference(final StringBuffer buf, RefElement refElement, boolean isPackageIncluded) {
final HTMLComposerExtension extension = getLanguageExtension(refElement);
if (extension != null) {
extension.appendReferencePresentation(refElement, buf, isPackageIncluded);
} else if (refElement instanceof RefFile) {
buf.append(A_HREF_OPENING);
buf.append(((RefElementImpl)refElement).getURL());
buf.append("\">");
String refElementName = refElement.getName();
final PsiElement element = refElement.getElement();
if (element != null) {
final VirtualFile virtualFile = PsiUtilCore.getVirtualFile(element);
if (virtualFile != null) {
refElementName = ProjectUtilCore.displayUrlRelativeToProject(virtualFile, virtualFile.getPresentableUrl(), element.getProject(),
true, false);
}
}
buf.append(refElementName);
buf.append(A_CLOSING);
}
}
@Override
public String composeNumereables(int n, String statement, String singleEnding, String multipleEnding) {
final StringBuilder buf = new StringBuilder();
buf.append(n);
buf.append(' ');
buf.append(statement);
if (n % 10 == 1 && n % 100 != 11) {
buf.append(singleEnding);
}
else {
buf.append(multipleEnding);
}
return buf.toString();
}
@Override
public void appendElementInReferences(StringBuffer buf, RefElement refElement) {
if (refElement.getInReferences().size() > 0) {
appendHeading(buf, InspectionsBundle.message("inspection.export.results.used.from"));
startList(buf);
for (RefElement refCaller : refElement.getInReferences()) {
appendListItem(buf, refCaller);
}
doneList(buf);
}
}
@Override
public void appendElementOutReferences(StringBuffer buf, RefElement refElement) {
if (refElement.getOutReferences().size() > 0) {
appendHeading(buf, InspectionsBundle.message("inspection.export.results.uses"));
startList(buf);
for (RefElement refCallee : refElement.getOutReferences()) {
appendListItem(buf, refCallee);
}
doneList(buf);
}
}
@Override
public void appendListItem(StringBuffer buf, RefElement refElement) {
startListItem(buf);
appendElementReference(buf, refElement, true);
appendAdditionalListItemInfo(buf, refElement);
doneListItem(buf);
}
protected void appendAdditionalListItemInfo(StringBuffer buf, RefElement refElement) {
// Default appends nothing.
}
protected void appendResolution(StringBuffer buf, RefEntity where, String[] quickFixes) {
if (where instanceof RefElement && !where.isValid()) return;
if (quickFixes != null) {
boolean listStarted = false;
for (final String text : quickFixes) {
if (text == null) continue;
if (!listStarted) {
appendHeading(buf, InspectionsBundle.message("inspection.problem.resolution"));
startList(buf);
listStarted = true;
}
startListItem(buf);
appendQuickFix(buf, text);
doneListItem(buf);
}
if (listStarted) {
doneList(buf);
}
}
}
@Override
public void startList(@NonNls final StringBuffer buf) {
if (myListStackTop == -1) {
buf.append("<div class=\"problem-description\">");
}
buf.append("<ul>");
myListStackTop++;
myListStack[myListStackTop] = 0;
}
@Override
public void doneList(@NonNls StringBuffer buf) {
buf.append("</ul>");
if (myListStack[myListStackTop] != 0) {
buf.append("<table cellpadding=\"0\" border=\"0\" cellspacing=\"0\"><tr><td> </td></tr></table>");
}
if (myListStackTop == 0) {
buf.append("</div>");
}
myListStackTop--;
}
@Override
public void startListItem(@NonNls StringBuffer buf) {
myListStack[myListStackTop]++;
buf.append("<li>");
}
public static void doneListItem(@NonNls StringBuffer buf) {
buf.append("</li>");
}
@Override
public void appendNoProblems(StringBuffer buf) {
buf.append("<p class=\"problem-description-group\">");
buf.append(InspectionsBundle.message("inspection.export.results.no.problems.found"));
buf.append("</p>");
}
@Override
public <T> T getExtension(final Key<T> key) {
return (T)myExtensions.get(key);
}
}