zen coding works in empty files and end-of-file, tests
[idea/community.git] / xml / impl / src / com / intellij / codeInsight / completion / XmlSmartEnterProcessor.java
1 /*
2  * Copyright 2000-2009 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.intellij.codeInsight.completion;
17
18 import com.intellij.codeInsight.editorActions.smartEnter.SmartEnterProcessor;
19 import com.intellij.codeInsight.template.zencoding.XmlZenCodingTemplate;
20 import com.intellij.lang.ASTNode;
21 import com.intellij.openapi.diagnostic.Logger;
22 import com.intellij.openapi.editor.Document;
23 import com.intellij.openapi.editor.Editor;
24 import com.intellij.openapi.project.Project;
25 import com.intellij.openapi.util.TextRange;
26 import com.intellij.psi.PsiElement;
27 import com.intellij.psi.PsiFile;
28 import com.intellij.psi.util.PsiTreeUtil;
29 import com.intellij.psi.xml.XmlAttribute;
30 import com.intellij.psi.xml.XmlAttributeValue;
31 import com.intellij.psi.xml.XmlChildRole;
32 import com.intellij.psi.xml.XmlTag;
33 import com.intellij.util.IncorrectOperationException;
34 import com.intellij.util.text.CharArrayUtil;
35 import org.jetbrains.annotations.NotNull;
36 import org.jetbrains.annotations.Nullable;
37
38 /**
39  * @author spleaner
40  */
41 public class XmlSmartEnterProcessor extends SmartEnterProcessor {
42   private static final Logger LOG = Logger.getInstance("#com.intellij.codeInsight.completion.XmlSmartEnterProcessor");
43
44   public boolean process(@NotNull final Project project, @NotNull final Editor editor, @NotNull final PsiFile psiFile) {
45     if (!completeEndTag(project, editor, psiFile)) {
46       return XmlZenCodingTemplate.startZenCoding(editor, psiFile, null);
47     }
48     return true;
49   }
50
51   private boolean completeEndTag(Project project, Editor editor, PsiFile psiFile) {
52     final PsiElement atCaret = getStatementAtCaret(editor, psiFile);
53     XmlTag tagAtCaret = PsiTreeUtil.getParentOfType(atCaret, XmlTag.class);
54     if (tagAtCaret == null) {
55       return false;
56     }
57     try {
58       final ASTNode emptyTagEnd = XmlChildRole.EMPTY_TAG_END_FINDER.findChild(tagAtCaret.getNode());
59       final ASTNode endTagEnd = XmlChildRole.START_TAG_END_FINDER.findChild(tagAtCaret.getNode());
60       if (emptyTagEnd != null || endTagEnd != null) {
61         return false;
62       }
63
64       int insertionOffset = tagAtCaret.getTextRange().getEndOffset();
65       Document doc = editor.getDocument();
66       int caretAt = editor.getCaretModel().getOffset();
67       final CharSequence text = doc.getCharsSequence();
68       final int probableCommaOffset = CharArrayUtil.shiftForward(text, insertionOffset, " \t");
69       final PsiElement siebling = tagAtCaret.getNextSibling();
70       int caretTo = caretAt;
71       char ch;
72
73       if (caretAt < probableCommaOffset) {
74         final XmlAttribute xmlAttribute = PsiTreeUtil.getParentOfType(atCaret, XmlAttribute.class, false, XmlTag.class);
75
76         CharSequence tagNameText = null;
77         if (xmlAttribute != null) {
78           final ASTNode node = tagAtCaret.getNode();
79           if (node != null) {
80             final ASTNode tagName = XmlChildRole.START_TAG_NAME_FINDER.findChild(node);
81             if (tagName != null) {
82               tagNameText = tagName.getText();
83             }
84           }
85
86           final XmlAttributeValue valueElement = xmlAttribute.getValueElement();
87           final TextRange textRange = xmlAttribute.getTextRange();
88           caretAt = valueElement == null ? textRange.getStartOffset() : getClosingQuote(xmlAttribute).length() == 0 ? textRange.getEndOffset() : caretAt;
89         }
90
91         if (tagNameText == null) {
92           tagNameText = text.subSequence(tagAtCaret.getTextRange().getStartOffset() + 1, caretAt);
93         }
94
95         final PsiElement element = psiFile.findElementAt(probableCommaOffset);
96         final XmlTag tag = PsiTreeUtil.getParentOfType(element, XmlTag.class);
97         final CharSequence text2insert = getClosingPart(xmlAttribute, tagAtCaret, false);
98
99         if (tag != null && tag.getTextRange().getStartOffset() == probableCommaOffset) {
100           doc.insertString(caretAt, text2insert);
101           if (shouldInsertClosingTag(xmlAttribute, tagAtCaret)) {
102             doc.insertString(tag.getTextRange().getEndOffset() + text2insert.length(), "</" + tagAtCaret.getName() + ">");
103           }
104
105           caretTo = tag.getTextRange().getEndOffset() + text2insert.length();
106         }
107         else {
108           doc.insertString(caretAt, text2insert);
109           if (shouldInsertClosingTag(xmlAttribute, tagAtCaret)) {
110             doc.insertString(probableCommaOffset + text2insert.length(), "</" + tagNameText + ">");
111           }
112
113           caretTo = probableCommaOffset + text2insert.length();
114         }
115       }
116       else if (siebling instanceof XmlTag && siebling.getTextRange().getStartOffset() == caretAt) {
117         final XmlAttribute xmlAttribute = PsiTreeUtil.getParentOfType(atCaret, XmlAttribute.class, false, XmlTag.class);
118         final CharSequence text2insert = getClosingPart(xmlAttribute, tagAtCaret, false);
119
120         doc.insertString(caretAt, text2insert);
121         if (shouldInsertClosingTag(xmlAttribute, tagAtCaret)) {
122           doc.insertString(siebling.getTextRange().getEndOffset() + text2insert.length(), "</" + tagAtCaret.getName() + ">");
123         }
124
125         caretTo = siebling.getTextRange().getEndOffset() + text2insert.length();
126       }
127       else if (probableCommaOffset >= text.length() || ((ch = text.charAt(probableCommaOffset)) != '/' && ch != '>')) {
128         final XmlAttribute xmlAttribute = PsiTreeUtil.getParentOfType(atCaret, XmlAttribute.class, false, XmlTag.class);
129         final CharSequence text2insert = getClosingPart(xmlAttribute, tagAtCaret, true);
130
131         doc.insertString(insertionOffset, text2insert);
132         caretTo = insertionOffset + text2insert.length();
133       }
134
135       if (isUncommited(project)) {
136         commit(editor);
137         tagAtCaret = PsiTreeUtil.getParentOfType(getStatementAtCaret(editor, psiFile), XmlTag.class);
138         editor.getCaretModel().moveToOffset(caretTo);
139       }
140
141       reformat(tagAtCaret);
142       commit(editor);
143     }
144     catch (IncorrectOperationException e) {
145       LOG.error(e);
146     }
147     return true;
148   }
149
150   protected boolean shouldInsertClosingTag(final XmlAttribute xmlAttribute, final XmlTag tagAtCaret) {
151     return true;
152   }
153
154   protected String getClosingPart(final XmlAttribute xmlAttribute, final XmlTag tagAtCaret, final boolean emptyTag) {
155     return getClosingQuote(xmlAttribute) + (emptyTag ? "/>" : ">");
156   }
157
158   @NotNull
159   protected static CharSequence getClosingQuote(@Nullable final XmlAttribute attribute) {
160     if (attribute == null) {
161       return "";
162     }
163
164     final XmlAttributeValue element = attribute.getValueElement();
165     if (element == null) {
166       return "";
167     }
168
169     final String s = element.getText();
170     if (s != null && s.length() > 0) {
171       if (s.charAt(0) == '"' && s.charAt(s.length() - 1) != '"') {
172         return "\"";
173       }
174       else if (s.charAt(0) == '\'' && s.charAt(s.length() - 1) != '\'') {
175         return "'";
176       }
177     }
178
179     return "";
180   }
181 }