1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
|
/*
* Copyright 2000-2009 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.lang;
import com.intellij.lang.folding.FoldingBuilder;
import com.intellij.lang.folding.FoldingDescriptor;
import com.intellij.lang.folding.LanguageFolding;
import com.intellij.lang.xml.XMLLanguage;
import com.intellij.openapi.diagnostic.Logger;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.progress.ProgressManager;
import com.intellij.openapi.project.DumbAware;
import com.intellij.openapi.util.TextRange;
import com.intellij.openapi.util.UnfairTextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiWhiteSpace;
import com.intellij.psi.impl.source.html.HtmlFileImpl;
import com.intellij.psi.tree.TokenSet;
import com.intellij.psi.util.PsiUtilCore;
import com.intellij.psi.xml.*;
import com.intellij.util.containers.ContainerUtil;
import com.intellij.xml.util.XmlTagUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.ArrayList;
import java.util.List;
public abstract class XmlCodeFoldingBuilder implements FoldingBuilder, DumbAware {
private static final Logger LOG = Logger.getInstance("#com.intellij.lang.xml.XmlFoldingBuilder");
private static final TokenSet XML_ATTRIBUTE_SET = TokenSet.create(XmlElementType.XML_ATTRIBUTE);
private static final int MIN_TEXT_RANGE_LENGTH = 3;
private static final String STYLE_ATTRIBUTE = "style";
@NotNull
public FoldingDescriptor[] buildFoldRegions(@NotNull ASTNode node, @NotNull Document document) {
final PsiElement psiElement = node.getPsi();
XmlDocument xmlDocument = null;
if (psiElement instanceof XmlFile) {
XmlFile file = (XmlFile)psiElement;
xmlDocument = file.getDocument();
}
else if (psiElement instanceof XmlDocument) {
xmlDocument = (XmlDocument)psiElement;
}
XmlElement rootTag = xmlDocument == null ? null : xmlDocument.getRootTag();
if (rootTag == null) {
rootTag = xmlDocument;
}
List<FoldingDescriptor> foldings = null;
if (rootTag != null) {
foldings = new ArrayList<FoldingDescriptor>();
doAddForChildren(xmlDocument, foldings, document);
}
return foldings != null ? foldings.toArray(new FoldingDescriptor[foldings.size()]):FoldingDescriptor.EMPTY;
}
protected void addElementsToFold(List<FoldingDescriptor> foldings, XmlElement tag, Document document) {
addToFold(foldings, tag, document);
doAddForChildren(tag, foldings, document);
}
protected void doAddForChildren(final XmlElement tag, final List<FoldingDescriptor> foldings, final Document document) {
final PsiElement[] children = tag.getChildren();
for (PsiElement child : children) {
ProgressManager.checkCanceled();
if (child instanceof XmlTag || child instanceof XmlConditionalSection) {
addElementsToFold(foldings, (XmlElement)child, document);
}
else if (child instanceof XmlComment) {
addToFold(foldings, child, document);
}
else if (child instanceof XmlText || child instanceof XmlProlog) {
final PsiElement[] grandChildren = child.getChildren();
for (PsiElement grandChild : grandChildren) {
ProgressManager.checkCanceled();
if (grandChild instanceof XmlComment) {
addToFold(foldings, grandChild, document);
}
}
}
else if(child instanceof XmlAttribute && isAttributeShouldBeFolded((XmlAttribute)child)) {
addToFold(foldings, child, document);
}
else {
final Language language = child.getLanguage();
if (!(language instanceof XMLLanguage) && language != Language.ANY) {
final FoldingBuilder foldingBuilder = LanguageFolding.INSTANCE.forLanguage(language);
if (foldingBuilder != null) {
final FoldingDescriptor[] foldingDescriptors = foldingBuilder.buildFoldRegions(child.getNode(), document);
ContainerUtil.addAll(foldings, foldingDescriptors);
}
}
}
}
}
@Nullable
public TextRange getRangeToFold(PsiElement element) {
if (element instanceof XmlTag) {
final ASTNode tagNode = element.getNode();
XmlToken tagNameElement = XmlTagUtil.getStartTagNameElement((XmlTag)element);
if (tagNameElement == null) return null;
int nameEnd = tagNameElement.getTextRange().getEndOffset();
int end = tagNode.getLastChildNode().getTextRange().getEndOffset() - 1; // last child node can be another tag in unbalanced tree
ASTNode[] attributes = tagNode.getChildren(XML_ATTRIBUTE_SET);
if (attributes.length > 0) {
ASTNode lastAttribute = attributes[attributes.length - 1];
ASTNode lastAttributeBeforeCR = null;
for (ASTNode child = tagNode.getFirstChildNode(); child != lastAttribute.getTreeNext(); child = child.getTreeNext()) {
if (child.getElementType() == XmlElementType.XML_ATTRIBUTE) {
lastAttributeBeforeCR = child;
} else if (child.getPsi() instanceof PsiWhiteSpace) {
if (child.textContains('\n')) break;
}
}
if (lastAttributeBeforeCR != null) {
int attributeEnd = lastAttributeBeforeCR.getTextRange().getEndOffset();
return new UnfairTextRange(attributeEnd, end);
}
}
return new UnfairTextRange(nameEnd, end);
} else if (element instanceof XmlComment) {
final XmlComment xmlComment = (XmlComment)element;
final TextRange textRange = element.getTextRange();
int commentStartOffset = getCommentStartOffset(xmlComment);
int commentEndOffset = getCommentStartEnd(xmlComment);
if (textRange.getEndOffset() - textRange.getStartOffset() > commentStartOffset + commentEndOffset) {
return new TextRange(textRange.getStartOffset() + commentStartOffset, textRange.getEndOffset() - commentEndOffset);
}
else {
return null;
}
}
else if (element instanceof XmlConditionalSection) {
final XmlConditionalSection conditionalSection = (XmlConditionalSection)element;
final TextRange textRange = element.getTextRange();
final PsiElement bodyStart = conditionalSection.getBodyStart();
int startOffset = bodyStart != null ? bodyStart.getStartOffsetInParent() : MIN_TEXT_RANGE_LENGTH;
int endOffset = MIN_TEXT_RANGE_LENGTH;
if (textRange.getEndOffset() - textRange.getStartOffset() > startOffset + endOffset) {
return new TextRange(textRange.getStartOffset() + startOffset, textRange.getEndOffset() - endOffset);
}
else {
return null;
}
}
else if (element instanceof XmlAttribute) {
final XmlAttributeValue valueElement = ((XmlAttribute)element).getValueElement();
return valueElement != null ? valueElement.getValueTextRange() : null;
}
else {
return null;
}
}
protected int getCommentStartOffset(final XmlComment element) {
return 4;
}
protected int getCommentStartEnd(final XmlComment element) {
return MIN_TEXT_RANGE_LENGTH;
}
protected boolean addToFold(List<FoldingDescriptor> foldings, PsiElement elementToFold, Document document) {
PsiUtilCore.ensureValid(elementToFold);
TextRange range = getRangeToFold(elementToFold);
if (range == null) return false;
if(range.getStartOffset() >= 0 &&
range.getEndOffset() <= elementToFold.getContainingFile().getTextRange().getEndOffset() &&
range.getEndOffset() <= document.getTextLength() // psi and document maybe not in sync after error
) {
int startLine = document.getLineNumber(range.getStartOffset());
int endLine = document.getLineNumber(range.getEndOffset() - 1);
if (startLine < endLine || elementToFold instanceof XmlAttribute) {
if (range.getStartOffset() + MIN_TEXT_RANGE_LENGTH < range.getEndOffset()) {
foldings.add(new FoldingDescriptor(elementToFold.getNode(), range));
return true;
}
}
}
return false;
}
public String getPlaceholderText(@NotNull ASTNode node) {
final PsiElement psi = node.getPsi();
if (psi instanceof XmlTag ||
psi instanceof XmlComment ||
psi instanceof XmlAttribute ||
psi instanceof XmlConditionalSection
) return "...";
return null;
}
public boolean isCollapsedByDefault(@NotNull ASTNode node) {
final PsiElement psi = node.getPsi();
final XmlCodeFoldingSettings foldingSettings = getFoldingSettings();
return (psi instanceof XmlTag && foldingSettings.isCollapseXmlTags())
|| (psi instanceof XmlAttribute && foldingSettings.isCollapseHtmlStyleAttribute());
}
private static boolean isAttributeShouldBeFolded(XmlAttribute child) {
return child.getContainingFile() instanceof HtmlFileImpl &&
STYLE_ATTRIBUTE.equalsIgnoreCase(child.getName());
}
protected abstract XmlCodeFoldingSettings getFoldingSettings();
}
|
