| /* |
| * Copyright 2000-2012 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.psi.impl.source.javadoc; |
| |
| import com.intellij.lang.ASTNode; |
| import com.intellij.openapi.diagnostic.Logger; |
| import com.intellij.openapi.project.Project; |
| import com.intellij.psi.*; |
| import com.intellij.psi.codeStyle.JavaCodeStyleSettingsFacade; |
| import com.intellij.psi.impl.source.Constants; |
| import com.intellij.psi.impl.source.SourceTreeToPsiMap; |
| import com.intellij.psi.impl.source.tree.*; |
| import com.intellij.psi.javadoc.PsiDocComment; |
| import com.intellij.psi.javadoc.PsiDocTag; |
| import com.intellij.psi.tree.ChildRoleBase; |
| import com.intellij.psi.tree.IElementType; |
| import com.intellij.psi.tree.TokenSet; |
| import com.intellij.psi.util.PsiUtilCore; |
| import com.intellij.util.ArrayFactory; |
| import com.intellij.util.CharTable; |
| import com.intellij.util.text.CharArrayUtil; |
| import org.jetbrains.annotations.NotNull; |
| |
| import java.util.ArrayList; |
| import java.util.regex.Pattern; |
| |
| public class PsiDocCommentImpl extends LazyParseablePsiElement implements PsiDocComment, JavaTokenType, Constants { |
| private static final Logger LOG = Logger.getInstance("#com.intellij.psi.impl.source.javadoc.PsiDocCommentImpl"); |
| |
| private static final TokenSet TAG_BIT_SET = TokenSet.create(DOC_TAG); |
| private static final ArrayFactory<PsiDocTag> ARRAY_FACTORY = new ArrayFactory<PsiDocTag>() { |
| @NotNull |
| @Override |
| public PsiDocTag[] create(final int count) { |
| return count == 0 ? PsiDocTag.EMPTY_ARRAY : new PsiDocTag[count]; |
| } |
| }; |
| |
| @SuppressWarnings({"HardCodedStringLiteral"}) |
| private static final Pattern WS_PATTERN = Pattern.compile("\\s*"); |
| |
| |
| public PsiDocCommentImpl(CharSequence text) { |
| super(JavaDocElementType.DOC_COMMENT, text); |
| } |
| |
| @Override |
| public PsiDocCommentOwner getOwner() { |
| final PsiElement parent = getParent(); |
| if (parent instanceof PsiDocCommentOwner) { |
| final PsiDocCommentOwner owner = (PsiDocCommentOwner)parent; |
| if (owner.getDocComment() == this) { |
| return owner; |
| } |
| } |
| |
| return null; |
| } |
| |
| @Override |
| @NotNull |
| public PsiElement[] getDescriptionElements() { |
| ArrayList<PsiElement> array = new ArrayList<PsiElement>(); |
| for (ASTNode child = getFirstChildNode(); child != null; child = child.getTreeNext()) { |
| IElementType i = child.getElementType(); |
| if (i == DOC_TAG) break; |
| if (i != DOC_COMMENT_START && i != DOC_COMMENT_END && i != DOC_COMMENT_LEADING_ASTERISKS) { |
| array.add(child.getPsi()); |
| } |
| } |
| return PsiUtilCore.toPsiElementArray(array); |
| } |
| |
| @Override |
| @NotNull |
| public PsiDocTag[] getTags() { |
| return getChildrenAsPsiElements(TAG_BIT_SET, ARRAY_FACTORY); |
| } |
| |
| @Override |
| public PsiDocTag findTagByName(String name) { |
| if (getFirstChildNode().getElementType() == JavaDocElementType.DOC_COMMENT) { |
| if (getFirstChildNode().getText().indexOf(name) < 0) return null; |
| } |
| |
| for (ASTNode child = getFirstChildNode(); child != null; child = child.getTreeNext()) { |
| if (child.getElementType() == DOC_TAG) { |
| PsiDocTag tag = (PsiDocTag)SourceTreeToPsiMap.treeElementToPsi(child); |
| final CharSequence nameText = ((LeafElement)tag.getNameElement()).getChars(); |
| |
| if (nameText.length() > 0 && nameText.charAt(0) == '@' && CharArrayUtil.regionMatches(nameText, 1, name)) { |
| return tag; |
| } |
| } |
| } |
| |
| return null; |
| } |
| |
| @Override |
| @NotNull |
| public PsiDocTag[] findTagsByName(String name) { |
| ArrayList<PsiDocTag> array = new ArrayList<PsiDocTag>(); |
| PsiDocTag[] tags = getTags(); |
| name = "@" + name; |
| for (PsiDocTag tag : tags) { |
| if (tag.getNameElement().getText().equals(name)) { |
| array.add(tag); |
| } |
| } |
| return array.toArray(new PsiDocTag[array.size()]); |
| } |
| |
| @Override |
| public IElementType getTokenType() { |
| return getElementType(); |
| } |
| |
| @Override |
| public ASTNode findChildByRole(int role) { |
| LOG.assertTrue(ChildRole.isUnique(role)); |
| switch (role) { |
| default: |
| return null; |
| |
| case ChildRole.DOC_COMMENT_START: |
| return getFirstChildNode(); |
| |
| case ChildRole.DOC_COMMENT_END: |
| if (getLastChildNode().getElementType() == DOC_COMMENT_END) { |
| return getLastChildNode(); |
| } |
| else { |
| return null; |
| } |
| } |
| } |
| |
| private static boolean isWhitespaceCommentData(ASTNode docCommentData) { |
| return WS_PATTERN.matcher(docCommentData.getText()).matches(); |
| } |
| |
| private static void addNewLineToTag(CompositeElement tag, Project project) { |
| LOG.assertTrue(tag != null && tag.getElementType() == DOC_TAG); |
| ASTNode current = tag.getLastChildNode(); |
| while (current != null && current.getElementType() == DOC_COMMENT_DATA && isWhitespaceCommentData(current)) { |
| current = current.getTreePrev(); |
| } |
| if (current != null && current.getElementType() == DOC_COMMENT_LEADING_ASTERISKS) return; |
| final CharTable treeCharTab = SharedImplUtil.findCharTableByTree(tag); |
| final ASTNode newLine = Factory.createSingleLeafElement(DOC_COMMENT_DATA, "\n", 0, 1, treeCharTab, SharedImplUtil.getManagerByTree(tag)); |
| tag.addChild(newLine, null); |
| |
| ASTNode leadingWhitespaceAnchor = null; |
| if (JavaCodeStyleSettingsFacade.getInstance(project).isJavaDocLeadingAsterisksEnabled()) { |
| final TreeElement leadingAsterisk = Factory.createSingleLeafElement(DOC_COMMENT_LEADING_ASTERISKS, "*", 0, 1, treeCharTab, |
| SharedImplUtil.getManagerByTree(tag)); |
| |
| leadingWhitespaceAnchor = tag.addInternal(leadingAsterisk, leadingAsterisk, null, Boolean.TRUE); |
| } |
| |
| final TreeElement commentData = Factory.createSingleLeafElement(DOC_COMMENT_DATA, " ", 0, 1, treeCharTab, SharedImplUtil.getManagerByTree(tag)); |
| tag.addInternal(commentData, commentData, leadingWhitespaceAnchor, Boolean.TRUE); |
| } |
| |
| @Override |
| public TreeElement addInternal(TreeElement first, ASTNode last, ASTNode anchor, Boolean before) { |
| boolean needToAddNewline = false; |
| if (first == last && first.getElementType() == DOC_TAG) { |
| if (anchor == null) { |
| anchor = getLastChildNode(); // this is a '*/' |
| final ASTNode prevBeforeWS = TreeUtil.skipElementsBack(anchor.getTreePrev(), ElementType.JAVA_WHITESPACE_BIT_SET); |
| if (prevBeforeWS != null) { |
| anchor = prevBeforeWS; |
| before = Boolean.FALSE; |
| } |
| else { |
| before = Boolean.TRUE; |
| } |
| needToAddNewline = true; |
| } |
| |
| if (anchor.getElementType() != DOC_TAG) { |
| if (nodeOnSameLineWithCommentStartBlock(anchor) |
| || !nodeIsNextAfterAsterisks(anchor) |
| || !docTagEndsWithLineFeedAndAsterisks(first)) |
| { |
| final CharTable charTable = SharedImplUtil.findCharTableByTree(this); |
| final TreeElement newLine = Factory.createSingleLeafElement(DOC_COMMENT_DATA, "\n", 0, 1, charTable, getManager()); |
| final TreeElement leadingAsterisk = Factory.createSingleLeafElement(DOC_COMMENT_LEADING_ASTERISKS, "*", 0, 1, charTable, getManager()); |
| final TreeElement commentData = Factory.createSingleLeafElement(DOC_COMMENT_DATA, " ", 0, 1, charTable, getManager()); |
| final TreeElement indentWS = Factory.createSingleLeafElement(DOC_COMMENT_DATA, " ", 0, 1, charTable, getManager()); |
| |
| newLine.getTreeParent().addChild(indentWS); |
| newLine.getTreeParent().addChild(leadingAsterisk); |
| newLine.getTreeParent().addChild(commentData); |
| |
| super.addInternal(newLine, commentData, anchor, Boolean.FALSE); |
| |
| anchor = commentData; |
| before = Boolean.FALSE; |
| } |
| } |
| else { |
| needToAddNewline = true; |
| } |
| } |
| if(before) anchor.getTreeParent().addChildren(first, last.getTreeNext(), anchor); |
| else anchor.getTreeParent().addChildren(first, last.getTreeNext(), anchor.getTreeNext()); |
| |
| if (needToAddNewline) { |
| if (first.getTreePrev() != null && first.getTreePrev().getElementType() == DOC_TAG) { |
| addNewLineToTag((CompositeElement)first.getTreePrev(), getProject()); |
| } |
| if (first.getTreeNext() != null && first.getTreeNext().getElementType() == DOC_TAG) { |
| addNewLineToTag((CompositeElement)first, getProject()); |
| } |
| else { |
| removeEndingAsterisksFromTag((CompositeElement)first); |
| } |
| } |
| return first; |
| } |
| |
| private static void removeEndingAsterisksFromTag(CompositeElement tag) { |
| ASTNode current = tag.getLastChildNode(); |
| while (current != null && current.getElementType() == DOC_COMMENT_DATA) { |
| current = current.getTreePrev(); |
| } |
| if (current != null && current.getElementType() == DOC_COMMENT_LEADING_ASTERISKS) { |
| final ASTNode prevWhiteSpace = TreeUtil.skipElementsBack(current.getTreePrev(), ElementType.JAVA_WHITESPACE_BIT_SET); |
| ASTNode toBeDeleted = prevWhiteSpace.getTreeNext(); |
| while (toBeDeleted != null) { |
| ASTNode next = toBeDeleted.getTreeNext(); |
| tag.deleteChildInternal(toBeDeleted); |
| toBeDeleted = next; |
| } |
| } |
| } |
| |
| private static boolean nodeIsNextAfterAsterisks(@NotNull ASTNode node) { |
| ASTNode current = TreeUtil.findSiblingBackward(node, DOC_COMMENT_LEADING_ASTERISKS); |
| if (current == null || current == node) return false; |
| while (current.getTreeNext() != node) { |
| current = current.getTreeNext(); |
| CharSequence currentText = current.getChars(); |
| if (CharArrayUtil.shiftForward(currentText, 0, " \t") != currentText.length()) return false; |
| } |
| return true; |
| } |
| |
| private static boolean docTagEndsWithLineFeedAndAsterisks(@NotNull ASTNode node) { |
| assert (node.getElementType() == DOC_TAG); |
| ASTNode lastAsterisks = TreeUtil.findChildBackward(node, DOC_COMMENT_LEADING_ASTERISKS); |
| if (lastAsterisks == null || !lastAsterisks.getTreePrev().textContains('\n')) { |
| return false; |
| } |
| //So last asterisk is placed on new line, checking if after it there are no non-whitespace symbols |
| ASTNode last = node.getLastChildNode(); |
| ASTNode current = lastAsterisks; |
| while (current != last) { |
| current = current.getTreeNext(); |
| CharSequence currentText = current.getChars(); |
| if (CharArrayUtil.shiftForward(currentText, 0, " \t") != currentText.length()) return false; |
| } |
| return true; |
| } |
| |
| private static boolean nodeOnSameLineWithCommentStartBlock(@NotNull ASTNode node) { |
| ASTNode current = TreeUtil.findSiblingBackward(node, DOC_COMMENT_START); |
| if (current == null) return false; |
| if (current == node) return true; |
| while (current.getTreeNext() != node) { |
| current = current.getTreeNext(); |
| if (current.textContains('\n')) return false; |
| } |
| return true; |
| } |
| |
| @Override |
| public void deleteChildInternal(@NotNull ASTNode child) { |
| if (child.getElementType() == DOC_TAG) { |
| if (child.getTreeNext() == null || child.getTreeNext().getElementType() != DOC_TAG) { |
| ASTNode prev = child.getTreePrev(); |
| while (prev != null && prev.getElementType() == DOC_COMMENT_DATA) { |
| prev = prev.getTreePrev(); |
| } |
| ASTNode next = child.getTreeNext(); |
| while (next != null && (next.getElementType() == DOC_COMMENT_DATA || next.getElementType() == WHITE_SPACE)) { |
| next = next.getTreeNext(); |
| } |
| |
| if (prev != null && prev.getElementType() == DOC_COMMENT_LEADING_ASTERISKS && !(next instanceof PsiDocTag)) { |
| ASTNode leadingAsterisk = prev; |
| if (leadingAsterisk.getTreePrev() != null) { |
| super.deleteChildInternal(leadingAsterisk.getTreePrev()); |
| super.deleteChildInternal(leadingAsterisk); |
| } |
| } |
| else if (prev != null && prev.getElementType() == DOC_TAG) { |
| final CompositeElement compositePrev = (CompositeElement)prev; |
| final ASTNode lastPrevChild = compositePrev.getLastChildNode(); |
| ASTNode prevChild = lastPrevChild; |
| while (prevChild != null && prevChild.getElementType() == DOC_COMMENT_DATA) { |
| prevChild = prevChild.getTreePrev(); |
| } |
| if (prevChild != null && prevChild.getElementType() == DOC_COMMENT_LEADING_ASTERISKS) { |
| ASTNode current = prevChild; |
| while (current != null) { |
| final ASTNode nextChild = current.getTreeNext(); |
| compositePrev.deleteChildInternal(current); |
| current = nextChild; |
| } |
| } |
| } |
| else { |
| next = child.getTreeNext(); |
| if (next != null && next.getElementType() == WHITE_SPACE) { |
| next.getTreeParent().removeChild(next); |
| } |
| } |
| } |
| |
| } |
| super.deleteChildInternal(child); |
| } |
| |
| @Override |
| public int getChildRole(ASTNode child) { |
| LOG.assertTrue(child.getTreeParent() == this); |
| IElementType i = child.getElementType(); |
| if (i == DOC_TAG) { |
| return ChildRole.DOC_TAG; |
| } |
| else if (i == JavaDocElementType.DOC_COMMENT || i == DOC_INLINE_TAG) { |
| return ChildRole.DOC_CONTENT; |
| } |
| else if (i == DOC_COMMENT_LEADING_ASTERISKS) { |
| return ChildRole.DOC_COMMENT_ASTERISKS; |
| } |
| else if (i == DOC_COMMENT_START) { |
| return ChildRole.DOC_COMMENT_START; |
| } |
| else if (i == DOC_COMMENT_END) { |
| return ChildRole.DOC_COMMENT_END; |
| } |
| else { |
| return ChildRoleBase.NONE; |
| } |
| } |
| |
| @Override |
| public void accept(@NotNull PsiElementVisitor visitor) { |
| if (visitor instanceof JavaElementVisitor) { |
| ((JavaElementVisitor)visitor).visitDocComment(this); |
| } |
| else { |
| visitor.visitElement(this); |
| } |
| } |
| |
| public String toString() { |
| return "PsiDocComment"; |
| } |
| } |