jps: log only builders that do something noticeable
[idea/community.git] / platform / lang-impl / src / com / intellij / codeInsight / actions / FormatChangedTextUtil.java
1 /*
2  * Copyright 2000-2011 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.actions;
17
18 import com.intellij.openapi.application.ApplicationManager;
19 import com.intellij.openapi.application.ReadAction;
20 import com.intellij.openapi.application.Result;
21 import com.intellij.openapi.diagnostic.Logger;
22 import com.intellij.openapi.editor.Document;
23 import com.intellij.openapi.editor.EditorFactory;
24 import com.intellij.openapi.editor.impl.EditorFactoryImpl;
25 import com.intellij.openapi.editor.markup.RangeHighlighter;
26 import com.intellij.openapi.module.ModifiableModuleModel;
27 import com.intellij.openapi.module.Module;
28 import com.intellij.openapi.module.ModuleManager;
29 import com.intellij.openapi.project.Project;
30 import com.intellij.openapi.roots.ModuleRootManager;
31 import com.intellij.openapi.util.Key;
32 import com.intellij.openapi.util.TextRange;
33 import com.intellij.openapi.vcs.VcsException;
34 import com.intellij.openapi.vcs.changes.Change;
35 import com.intellij.openapi.vcs.changes.ChangeListManager;
36 import com.intellij.openapi.vcs.changes.ContentRevision;
37 import com.intellij.openapi.vcs.ex.LineStatusTracker;
38 import com.intellij.openapi.vcs.ex.Range;
39 import com.intellij.openapi.vcs.ex.RangesBuilder;
40 import com.intellij.openapi.vcs.impl.LineStatusTrackerManager;
41 import com.intellij.openapi.vcs.impl.LineStatusTrackerManagerI;
42 import com.intellij.openapi.vfs.VirtualFile;
43 import com.intellij.psi.PsiDirectory;
44 import com.intellij.psi.PsiDocumentManager;
45 import com.intellij.psi.PsiFile;
46 import com.intellij.psi.PsiManager;
47 import com.intellij.util.Function;
48 import com.intellij.util.containers.ContainerUtil;
49 import com.intellij.util.containers.ContainerUtilRt;
50 import com.intellij.util.diff.FilesTooBigForDiffException;
51 import org.jetbrains.annotations.NotNull;
52 import org.jetbrains.annotations.Nullable;
53
54 import java.util.*;
55
56 public class FormatChangedTextUtil {
57   public static final Key<String> TEST_REVISION_CONTENT = Key.create("test.revision.content");
58   private static final Logger LOG = Logger.getInstance("#com.intellij.codeInsight.actions.FormatChangedTextUtil");
59
60   private FormatChangedTextUtil() {
61   }
62
63   /**
64    * Allows to answer if given file has changes in comparison with VCS.
65    * 
66    * @param file  target file
67    * @return      <code>true</code> if given file has changes; <code>false</code> otherwise
68    */
69   public static boolean hasChanges(@NotNull PsiFile file) {
70     final Project project = file.getProject();
71     final VirtualFile virtualFile = file.getVirtualFile();
72     if (virtualFile != null) {
73       final Change change = ChangeListManager.getInstance(project).getChange(virtualFile);
74       if (change != null && change.getType() == Change.Type.NEW) {
75         return true;
76       }
77     }
78
79     final LineStatusTrackerManagerI manager = LineStatusTrackerManager.getInstance(project);
80     if (manager == null) {
81       return false;
82     }
83     
84     final Document document = PsiDocumentManager.getInstance(project).getDocument(file);
85     if (document == null) {
86       return false;
87     }
88     final LineStatusTracker lineStatusTracker = manager.getLineStatusTracker(document);
89     if (lineStatusTracker == null) {
90       return false;
91     }
92     final List<Range> ranges = lineStatusTracker.getRanges();
93     return !ranges.isEmpty();
94   }
95
96   /**
97    * Allows to answer if any file below the given directory (any level of nesting) has changes in comparison with VCS.
98    * 
99    * @param directory  target directory to check
100    * @return           <code>true</code> if any file below the given directory has changes in comparison with VCS;
101    *                   <code>false</code> otherwise
102    */
103   public static boolean hasChanges(@NotNull PsiDirectory directory) {
104     return hasChanges(directory.getVirtualFile(), directory.getProject());
105   }
106
107   /**
108    * Allows to answer if given file or any file below the given directory (any level of nesting) has changes in comparison with VCS.
109    * 
110    * @param file     target directory to check
111    * @param project  target project
112    * @return         <code>true</code> if given file or any file below the given directory has changes in comparison with VCS;
113    *                 <code>false</code> otherwise
114    */
115   public static boolean hasChanges(@NotNull VirtualFile file, @NotNull Project project) {
116     final Collection<Change> changes = ChangeListManager.getInstance(project).getChangesIn(file);
117     for (Change change : changes) {
118       if (change.getType() == Change.Type.NEW || change.getType() == Change.Type.MODIFICATION) {
119         return true;
120       }
121     }
122     return false;
123   }
124
125   public static boolean hasChanges(@NotNull VirtualFile[] files, @NotNull Project project) {
126     for (VirtualFile file : files) {
127       if (hasChanges(file, project))
128         return true;
129     }
130     return false;
131   }
132
133   /**
134    * Allows to answer if any file that belongs to the given module has changes in comparison with VCS.
135    * 
136    * @param module  target module to check
137    * @return        <code>true</code> if any file that belongs to the given module has changes in comparison with VCS
138    *                <code>false</code> otherwise
139    */
140   public static boolean hasChanges(@NotNull Module module) {
141     final ModuleRootManager rootManager = ModuleRootManager.getInstance(module);
142     for (VirtualFile root : rootManager.getSourceRoots()) {
143       if (hasChanges(root, module.getProject())) {
144         return true;
145       }
146     }
147     return false;
148   }
149
150   /**
151    * Allows to answer if any file that belongs to the given project has changes in comparison with VCS.
152    * 
153    * @param project  target project to check
154    * @return         <code>true</code> if any file that belongs to the given project has changes in comparison with VCS
155    *                 <code>false</code> otherwise
156    */
157   public static boolean hasChanges(@NotNull final Project project) {
158     final ModifiableModuleModel moduleModel = new ReadAction<ModifiableModuleModel>() {
159       @Override
160       protected void run(Result<ModifiableModuleModel> result) throws Throwable {
161         result.setResult(ModuleManager.getInstance(project).getModifiableModel());
162       }
163     }.execute().getResultObject();
164     try {
165       for (Module module : moduleModel.getModules()) {
166         if (hasChanges(module)) {
167           return true;
168         }
169       }
170       return false;
171     }
172     finally {
173       moduleModel.dispose();
174     }
175   }
176
177   /**
178    * Allows to ask for the changed text of the given file (in comparison with VCS).
179    * 
180    * @param file  target file
181    * @return      collection of changed regions for the given file
182    */
183   @NotNull
184   public static Collection<TextRange> getChanges(@NotNull PsiFile file) {
185     final Set<TextRange> defaultResult = Collections.singleton(file.getTextRange());
186     final VirtualFile virtualFile = file.getVirtualFile();
187     if (virtualFile != null) {
188       final Change change = ChangeListManager.getInstance(file.getProject()).getChange(virtualFile);
189       if (change != null && change.getType() == Change.Type.NEW) {
190         return defaultResult;
191       }
192     }
193
194     final LineStatusTrackerManagerI manager = LineStatusTrackerManager.getInstance(file.getProject());
195     if (manager == null) {
196       return defaultResult;
197     }
198     final Document document = PsiDocumentManager.getInstance(file.getProject()).getDocument(file);
199     if (document == null) {
200       return defaultResult;
201     }
202     final LineStatusTracker lineStatusTracker = manager.getLineStatusTracker(document);
203     if (lineStatusTracker == null) {
204       return defaultResult;
205     }
206     final List<Range> ranges = lineStatusTracker.getRanges();
207     if (ranges == null || ranges.isEmpty()) {
208       return defaultResult;
209     }
210     
211     List<TextRange> result = new ArrayList<TextRange>();
212     for (Range range : ranges) {
213       if (range.getType() != Range.DELETED) {
214         final RangeHighlighter highlighter = range.getHighlighter();
215         if (highlighter != null) {
216           result.add(new TextRange(highlighter.getStartOffset(), highlighter.getEndOffset()));
217         }
218       }
219     }
220     return result;
221   }
222
223   @NotNull
224   public static List<PsiFile> getChangedFilesFromDirs(@NotNull Project project, @NotNull List<PsiDirectory> dirs)  {
225     ChangeListManager changeListManager = ChangeListManager.getInstance(project);
226     Collection<Change> changes = ContainerUtil.newArrayList();
227
228     for (PsiDirectory dir : dirs) {
229       changes.addAll(changeListManager.getChangesIn(dir.getVirtualFile()));
230     }
231
232     return getChangedFiles(project, changes);
233   }
234
235   @NotNull
236   public static List<PsiFile> getChangedFiles(@NotNull final Project project, @NotNull Collection<Change> changes) {
237     Function<Change, PsiFile> changeToPsiFileMapper = new Function<Change, PsiFile>() {
238       private PsiManager myPsiManager = PsiManager.getInstance(project);
239
240       @Override
241       public PsiFile fun(Change change) {
242         VirtualFile vFile = change.getVirtualFile();
243         return vFile != null ? myPsiManager.findFile(vFile) : null;
244       }
245     };
246
247     return ContainerUtil.mapNotNull(changes, changeToPsiFileMapper);
248   }
249
250   @NotNull
251   public static List<TextRange> getChangedTextRanges(@NotNull Project project, @NotNull PsiFile file) throws FilesTooBigForDiffException {
252     List<TextRange> cachedChangedLines = getCachedChangedLines(project, file);
253     if (cachedChangedLines != null) {
254       return cachedChangedLines;
255     }
256
257     if (ApplicationManager.getApplication().isUnitTestMode()) {
258       String testContent = file.getUserData(TEST_REVISION_CONTENT);
259       if (testContent != null) {
260         return calculateChangedTextRanges(file.getProject(), file, testContent);
261       }
262     }
263
264     Change change = ChangeListManager.getInstance(project).getChange(file.getVirtualFile());
265     if (change == null) {
266       return ContainerUtilRt.emptyList();
267     }
268     if (change.getType() == Change.Type.NEW) {
269       return ContainerUtil.newArrayList(file.getTextRange());
270     }
271
272     String contentFromVcs = getRevisionedContentFrom(change);
273     return contentFromVcs != null ? calculateChangedTextRanges(project, file, contentFromVcs)
274                                   : ContainerUtil.<TextRange>emptyList();
275   }
276
277   @Nullable
278   private static List<TextRange> getCachedChangedLines(@NotNull Project project, @NotNull PsiFile file) {
279     Document document = PsiDocumentManager.getInstance(project).getDocument(file);
280     if (document == null) {
281       return ContainerUtil.emptyList();
282     }
283
284     LineStatusTracker tracker = LineStatusTrackerManager.getInstance(project).getLineStatusTracker(document);
285     if (tracker != null) {
286       List<Range> ranges = tracker.getRanges();
287       return getChangedTextRanges(document, ranges);
288     }
289
290     return null;
291   }
292
293   @Nullable
294   private static String getRevisionedContentFrom(@NotNull Change change) {
295     ContentRevision revision = change.getBeforeRevision();
296     if (revision == null) {
297       return null;
298     }
299
300     try {
301       return revision.getContent();
302     }
303     catch (VcsException e) {
304       LOG.error("Can't get content for: " + change.getVirtualFile(), e);
305       return null;
306     }
307   }
308
309   @NotNull
310   private static List<TextRange> calculateChangedTextRanges(@NotNull Project project, 
311                                                             @NotNull PsiFile file, 
312                                                             @NotNull String contentFromVcs) throws FilesTooBigForDiffException 
313   {
314     Document documentFromVcs = ((EditorFactoryImpl)EditorFactory.getInstance()).createDocument(contentFromVcs, true, false);
315     Document document = PsiDocumentManager.getInstance(project).getDocument(file);
316
317     if (document == null) {
318       return ContainerUtil.emptyList();
319     }
320
321     List<Range> changedRanges = new RangesBuilder(document, documentFromVcs).getRanges();
322     return getChangedTextRanges(document, changedRanges);
323   }
324
325   @NotNull
326   private static List<TextRange> getChangedTextRanges(@NotNull Document document, @NotNull List<Range> changedRanges) {
327     List<TextRange> ranges = ContainerUtil.newArrayList();
328     for (Range range : changedRanges) {
329       if (range.getType() != Range.DELETED) {
330         int changeStartLine = range.getLine1();
331         int changeEndLine = range.getLine2();
332
333         int lineStartOffset = document.getLineStartOffset(changeStartLine);
334         int lineEndOffset = document.getLineEndOffset(changeEndLine - 1);
335
336         ranges.add(new TextRange(lineStartOffset, lineEndOffset));
337       }
338     }
339     return ranges;
340   }
341 }