/*
* Copyright 2000-2013 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.openapi.vcs;
import com.intellij.execution.ui.ConsoleViewContentType;
import com.intellij.lifecycle.PeriodicalTasksCloser;
import com.intellij.openapi.application.ApplicationManager;
import com.intellij.openapi.editor.markup.TextAttributes;
import com.intellij.openapi.progress.ProcessCanceledException;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.Computable;
import com.intellij.openapi.vcs.changes.VcsAnnotationLocalChangesListener;
import com.intellij.openapi.vcs.history.VcsHistoryCache;
import com.intellij.openapi.vcs.impl.ContentRevisionCache;
import com.intellij.openapi.vcs.impl.VcsDescriptor;
import com.intellij.openapi.vcs.update.UpdatedFiles;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.util.Processor;
import com.intellij.util.messages.Topic;
import org.jetbrains.annotations.NonNls;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import java.util.List;
/**
* Manages the version control systems used by a specific project.
*/
public abstract class ProjectLevelVcsManager {
public static final Topic<VcsListener> VCS_CONFIGURATION_CHANGED = Topic.create("VCS configuration changed", VcsListener.class);
public static final Topic<VcsListener> VCS_CONFIGURATION_CHANGED_IN_PLUGIN = Topic.create("VCS configuration changed in VCS plugin", VcsListener.class);
public abstract void iterateVfUnderVcsRoot(VirtualFile file, Processor<VirtualFile> processor);
/**
* Returns the <code>ProjectLevelVcsManager<code> instance for the specified project.
*
* @param project the project for which the instance is requested.
* @return the manager instance.
*/
public static ProjectLevelVcsManager getInstance(Project project) {
return PeriodicalTasksCloser.getInstance().safeGetComponent(project, ProjectLevelVcsManager.class);
}
/**
* Gets the instance of the component if the project wasn't disposed. If the project was
* disposed, throws ProcessCanceledException. Should only be used for calling from background
* threads (for example, committed changes refresh thread).
*
* @param project the project for which the component instance should be retrieved.
* @return component instance
*/
public static ProjectLevelVcsManager getInstanceChecked(final Project project) {
return ApplicationManager.getApplication().runReadAction(new Computable<ProjectLevelVcsManager>() {
public ProjectLevelVcsManager compute() {
if (project.isDisposed()) throw new ProcessCanceledException();
return getInstance(project);
}
});
}
/**
* Returns the list of all registered version control systems.
*
* @return the list of registered version control systems.
*/
public abstract VcsDescriptor[] getAllVcss();
/**
* Returns the version control system with the specified name.
*
* @param name the name of the VCS to find.
* @return the VCS instance, or null if none is found.
*/
@Nullable
public abstract AbstractVcs findVcsByName(@NonNls String name);
@Nullable
public abstract VcsDescriptor getDescriptor(final String name);
/**
* Checks if all files in the specified array are managed by the specified VCS.
*
* @param abstractVcs the VCS to check.
* @param files the files to check.
* @return true if all files are managed by the VCS, false otherwise.
*/
public abstract boolean checkAllFilesAreUnder(AbstractVcs abstractVcs, VirtualFile[] files);
/**
* Returns the VCS managing the specified file.
*
* @param file the file to check.
* @return the VCS instance, or null if the file does not belong to any module or the module
* it belongs to is not under version control.
*/
@Nullable
public abstract AbstractVcs getVcsFor(@NotNull VirtualFile file);
/**
* Returns the VCS managing the specified file path.
*
* @param file the file to check.
* @return the VCS instance, or null if the file does not belong to any module or the module
* it belongs to is not under version control.
*/
@Nullable
public abstract AbstractVcs getVcsFor(FilePath file);
/**
* Return the parent directory of the specified file which is mapped to a VCS.
*
* @param file the file for which the root is requested.
* @return the root, or null if the specified file is not in a VCS-managed directory.
*/
@Nullable
public abstract VirtualFile getVcsRootFor(@Nullable VirtualFile file);
/**
* Return the parent directory of the specified file path which is mapped to a VCS.
*
* @param file the file for which the root is requested.
* @return the root, or null if the specified file is not in a VCS-managed directory.
*/
@Nullable
public abstract VirtualFile getVcsRootFor(FilePath file);
@Nullable
public abstract VcsRoot getVcsRootObjectFor(final VirtualFile file);
@Nullable
public abstract VcsRoot getVcsRootObjectFor(FilePath file);
/**
* Checks if the specified VCS is used by any of the modules in the project.
*
* @param vcs the VCS to check.
* @return true if the VCS is used by any of the modules, false otherwise
*/
public abstract boolean checkVcsIsActive(AbstractVcs vcs);
/**
* Checks if the VCS with the specified name is used by any of the modules in the project.
*
* @param vcsName the name of the VCS to check.
* @return true if the VCS is used by any of the modules, false otherwise
*/
public abstract boolean checkVcsIsActive(@NonNls String vcsName);
/**
* Returns the list of VCSes used by at least one module in the project.
*
* @return the list of VCSes used in the project.
*/
public abstract AbstractVcs[] getAllActiveVcss();
public abstract boolean hasActiveVcss();
public abstract boolean hasAnyMappings();
@Deprecated
public abstract void addMessageToConsoleWindow(String message, TextAttributes attributes);
public abstract void addMessageToConsoleWindow(@Nullable String message, @NotNull ConsoleViewContentType contentType);
@NotNull
public abstract VcsShowSettingOption getStandardOption(@NotNull VcsConfiguration.StandardOption option,
@NotNull AbstractVcs vcs);
@NotNull
public abstract VcsShowConfirmationOption getStandardConfirmation(@NotNull VcsConfiguration.StandardConfirmation option,
AbstractVcs vcs);
@NotNull
public abstract VcsShowSettingOption getOrCreateCustomOption(@NotNull String vcsActionName,
@NotNull AbstractVcs vcs);
public abstract void showProjectOperationInfo(final UpdatedFiles updatedFiles, String displayActionName);
/**
* Adds a listener for receiving notifications about changes in VCS configuration for the project.
*
* @param listener the listener instance.
* @deprecated use {@link #VCS_CONFIGURATION_CHANGED} instead
* @since 6.0
*/
public abstract void addVcsListener(VcsListener listener);
/**
* Removes a listener for receiving notifications about changes in VCS configuration for the project.
*
* @param listener the listener instance.
* @deprecated use {@link #VCS_CONFIGURATION_CHANGED} instead
* @since 6.0
*/
public abstract void removeVcsListener(VcsListener listener);
/**
* Marks the beginning of a background VCS operation (commit or update).
*
* @since 6.0
*/
public abstract void startBackgroundVcsOperation();
/**
* Marks the end of a background VCS operation (commit or update).
*
* @since 6.0
*/
public abstract void stopBackgroundVcsOperation();
/**
* Checks if a background VCS operation (commit or update) is currently in progress.
*
* @return true if a background operation is in progress, false otherwise.
* @since 6.0
*/
public abstract boolean isBackgroundVcsOperationRunning();
public abstract List<VirtualFile> getRootsUnderVcsWithoutFiltering(final AbstractVcs vcs);
public abstract VirtualFile[] getRootsUnderVcs(@NotNull AbstractVcs vcs);
/**
* Also includes into list all modules under roots
*/
public abstract List<VirtualFile> getDetailedVcsMappings(final AbstractVcs vcs);
public abstract VirtualFile[] getAllVersionedRoots();
@NotNull
public abstract VcsRoot[] getAllVcsRoots();
public abstract void updateActiveVcss();
public abstract List<VcsDirectoryMapping> getDirectoryMappings();
public abstract List<VcsDirectoryMapping> getDirectoryMappings(AbstractVcs vcs);
@Nullable
public abstract VcsDirectoryMapping getDirectoryMappingFor(FilePath path);
/**
* This method can be used only when initially loading the project configuration!
*/
public abstract void setDirectoryMapping(final String path, final String activeVcsName);
public abstract void setDirectoryMappings(final List<VcsDirectoryMapping> items);
public abstract void iterateVcsRoot(final VirtualFile root, final Processor<FilePath> iterator);
public abstract void iterateVcsRoot(final VirtualFile root, final Processor<FilePath> iterator,
@Nullable VirtualFileFilter directoryFilter);
@Nullable
public abstract AbstractVcs findVersioningVcs(VirtualFile file);
public abstract CheckoutProvider.Listener getCompositeCheckoutListener();
// TODO: To be removed in IDEA 16.
@Deprecated
@Nullable
public abstract VcsEventsListenerManager getVcsEventsListenerManager();
public abstract VcsHistoryCache getVcsHistoryCache();
public abstract ContentRevisionCache getContentRevisionCache();
public abstract boolean isFileInContent(final VirtualFile vf);
public abstract boolean isIgnored(VirtualFile vf);
public abstract boolean dvcsUsedInProject();
@NotNull
public abstract VcsAnnotationLocalChangesListener getAnnotationLocalChangesListener();
}