Package com.intellij.vcsUtil

Class VcsFileUtil

java.lang.Object

com.intellij.vcsUtil.VcsFileUtil

public class VcsFileUtil
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILE_PATH_LIMIT If multiple paths are specified on the command line, this limit is used to split paths into chunks.

Constructor Summary

Constructors

Constructor and Description
VcsFileUtil()

Method Summary

Modifier and Type	Method and Description
static void	addFilesToVcsWithConfirmation(Project project, java.util.Collection<? extends VirtualFile> virtualFiles) Finds all VCSs related to the passed files, suggests user to add files to the respected VCSs honoring addition and silence settings and adds them if user or settings confirmed addition.
static void	addFilesToVcsWithConfirmation(Project project, VirtualFile... virtualFiles)
static java.util.List<java.util.List<java.lang.String>>	chunkArguments(java.util.List<java.lang.String> arguments) Chunk arguments on the command line
static java.util.List<java.util.List<java.lang.String>>	chunkArguments(java.util.List<java.lang.String> arguments, int groupSize) Chunk arguments on the command line
static java.util.List<java.util.List<java.lang.String>>	chunkFiles(VirtualFile root, java.util.Collection<? extends VirtualFile> files) The chunk paths
static java.util.List<java.util.List<java.lang.String>>	chunkPaths(VirtualFile root, java.util.Collection<? extends FilePath> files) The chunk paths
static void	foreachChunk(java.util.List<java.lang.String> arguments, int groupSize, ThrowableConsumer<? super java.util.List<java.lang.String>,? extends VcsException> consumer) Execute function for each chunk of arguments.
static <T> java.util.List<T>	foreachChunk(java.util.List<java.lang.String> arguments, int groupSize, ThrowableNotNullFunction<? super java.util.List<java.lang.String>,? extends java.util.List<? extends T>,? extends VcsException> processor) Execute function for each chunk of arguments and collect the result.
static java.lang.String	getRelativeFilePath(java.lang.String file, VirtualFile baseDir)
static java.lang.String	getRelativeFilePath(VirtualFile file, VirtualFile baseDir)
static boolean	isAncestor(FilePath ancestor, FilePath path, boolean strict)
static boolean	isAncestor(@SystemIndependent java.lang.String ancestor, @SystemIndependent java.lang.String path, boolean strict)
static boolean	isAncestor(VirtualFile root, FilePath path)
static boolean	isOctal(char ch) Check if character is octal digit
static void	markFilesDirty(Project project, java.util.Collection<? extends VirtualFile> affectedFiles)
static void	markFilesDirty(Project project, java.util.List<? extends FilePath> affectedFiles)
static java.lang.String	relativeOrFullPath(VirtualFile root, VirtualFile file) Get relative path
static java.lang.String	relativePath(java.io.File root, java.io.File path) Get relative path
static java.lang.String	relativePath(java.io.File root, FilePath path) Get relative path
static java.lang.String	relativePath(FilePath root, FilePath file) Get relative path
static java.lang.String	relativePath(java.io.File root, VirtualFile file) Get relative path
static java.lang.String	relativePath(VirtualFile root, FilePath path) Get relative path
static java.lang.String	relativePath(VirtualFile root, VirtualFile file) Get relative path
static java.util.List<java.lang.String>	toRelativeFiles(VirtualFile root, java.util.Collection<? extends VirtualFile> files) Covert list of files to relative paths
static java.util.List<java.lang.String>	toRelativePaths(VirtualFile root, java.util.Collection<? extends FilePath> filePaths) Covert list of files to relative paths
static java.lang.String	unescapeGitPath(java.lang.String path)
static java.lang.String	unescapeGitPath(java.lang.String path, java.lang.String encoding) Unescape path returned by Git.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FILE_PATH_LIMIT

public static final int FILE_PATH_LIMIT

If multiple paths are specified on the command line, this limit is used to split paths into chunks. The limit is less than OS limit to leave space to quoting, spaces, charset conversion, and commands arguments.

See Also:

Constant Field Values

Constructor Detail

VcsFileUtil

public VcsFileUtil()

Method Detail

foreachChunk

public static <T> java.util.List<T> foreachChunk(java.util.List<java.lang.String> arguments,
                                                 int groupSize,
                                                 ThrowableNotNullFunction<? super java.util.List<java.lang.String>,? extends java.util.List<? extends T>,? extends VcsException> processor)
                                          throws VcsException

Execute function for each chunk of arguments and collect the result. Check for being cancelled in process.

Type Parameters:

T - type of result value

Parameters:

arguments - the arguments to chunk

groupSize - size of argument groups that should be put in the same chunk (like a name and a value)

processor - function to execute on each chunk

Returns:

list of result values

Throws:

VcsException

foreachChunk

public static void foreachChunk(java.util.List<java.lang.String> arguments,
                                int groupSize,
                                ThrowableConsumer<? super java.util.List<java.lang.String>,? extends VcsException> consumer)
                         throws VcsException

Execute function for each chunk of arguments. Check for being cancelled in process.

Parameters:

arguments - the arguments to chunk

groupSize - size of argument groups that should be put in the same chunk (like a name and a value)

consumer - consumer to feed each chunk

Throws:

VcsException

chunkArguments

public static java.util.List<java.util.List<java.lang.String>> chunkArguments(java.util.List<java.lang.String> arguments)

Chunk arguments on the command line

Parameters:

arguments - the arguments to chunk

Returns:

a list of lists of arguments

chunkArguments

public static java.util.List<java.util.List<java.lang.String>> chunkArguments(java.util.List<java.lang.String> arguments,
                                                                              int groupSize)

Chunk arguments on the command line

Parameters:

arguments - the arguments to chunk, number of arguments should be divisible by groupSize

groupSize - size of argument groups that should be put in the same chunk

Returns:

a list of lists of arguments

chunkPaths

public static java.util.List<java.util.List<java.lang.String>> chunkPaths(VirtualFile root,
                                                                          java.util.Collection<? extends FilePath> files)

The chunk paths

Parameters:

root - the vcs root

files - the file list

Returns:

chunked relative paths

chunkFiles

public static java.util.List<java.util.List<java.lang.String>> chunkFiles(VirtualFile root,
                                                                          java.util.Collection<? extends VirtualFile> files)

The chunk paths

Parameters:

root - the vcs root

files - the file list

Returns:

chunked relative paths

getRelativeFilePath

public static java.lang.String getRelativeFilePath(VirtualFile file,
                                                   VirtualFile baseDir)

getRelativeFilePath

public static java.lang.String getRelativeFilePath(java.lang.String file,
                                                   VirtualFile baseDir)

isOctal

public static boolean isOctal(char ch)

Check if character is octal digit

Parameters:

ch - a character to test

Returns:

true if the octal digit, false otherwise

relativePath

public static java.lang.String relativePath(VirtualFile root,
                                            FilePath path)

Get relative path

Parameters:

root - a root path

path - a path to file (possibly deleted file)

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativePath

public static java.lang.String relativePath(java.io.File root,
                                            FilePath path)

Get relative path

Parameters:

root - a root path

path - a path to file (possibly deleted file)

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativePath

public static java.lang.String relativePath(java.io.File root,
                                            VirtualFile file)

Get relative path

Parameters:

root - a root path

file - a virtual file

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativePath

public static java.lang.String relativePath(VirtualFile root,
                                            VirtualFile file)

Get relative path

Parameters:

root - a root file

file - a virtual file

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativeOrFullPath

public static java.lang.String relativeOrFullPath(VirtualFile root,
                                                  VirtualFile file)

Get relative path

Parameters:

root - a root file

file - a virtual file

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativePath

public static java.lang.String relativePath(FilePath root,
                                            FilePath file)

Get relative path

Parameters:

root - a root path

file - a target path

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

relativePath

public static java.lang.String relativePath(java.io.File root,
                                            java.io.File path)

Get relative path

Parameters:

root - a root path

path - a path to file (possibly deleted file)

Returns:

a relative path

Throws:

java.lang.IllegalArgumentException - if path is not under root.

toRelativePaths

public static java.util.List<java.lang.String> toRelativePaths(VirtualFile root,
                                                               java.util.Collection<? extends FilePath> filePaths)

Covert list of files to relative paths

Parameters:

root - a vcs root

filePaths - a parameters to convert

Returns:

a list of relative paths

Throws:

java.lang.IllegalArgumentException - if some path is not under root.

toRelativeFiles

public static java.util.List<java.lang.String> toRelativeFiles(VirtualFile root,
                                                               java.util.Collection<? extends VirtualFile> files)

Covert list of files to relative paths

Parameters:

root - a vcs root

files - a parameters to convert

Returns:

a list of relative paths

Throws:

java.lang.IllegalArgumentException - if some path is not under root.

markFilesDirty

public static void markFilesDirty(Project project,
                                  java.util.Collection<? extends VirtualFile> affectedFiles)

markFilesDirty

public static void markFilesDirty(Project project,
                                  java.util.List<? extends FilePath> affectedFiles)

addFilesToVcsWithConfirmation

public static void addFilesToVcsWithConfirmation(Project project,
                                                 VirtualFile... virtualFiles)

addFilesToVcsWithConfirmation

public static void addFilesToVcsWithConfirmation(Project project,
                                                 java.util.Collection<? extends VirtualFile> virtualFiles)

Finds all VCSs related to the passed files, suggests user to add files to the respected VCSs honoring addition and silence settings and adds them if user or settings confirmed addition. Because of potentially long operation of collecting files it's highly recommended to invoke it on the pooled thread. Method works synchronously.

Parameters:

project - project we work in

virtualFiles - collection of virtual files to add; directories being added recursively

isAncestor

public static boolean isAncestor(@SystemIndependent java.lang.String ancestor,
                                 @SystemIndependent java.lang.String path,
                                 boolean strict)

See Also:

FileUtil.toCanonicalPath(java.lang.String)

isAncestor

public static boolean isAncestor(FilePath ancestor,
                                 FilePath path,
                                 boolean strict)

isAncestor

public static boolean isAncestor(VirtualFile root,
                                 FilePath path)

unescapeGitPath

public static java.lang.String unescapeGitPath(java.lang.String path,
                                               java.lang.String encoding)
                                        throws java.lang.IllegalArgumentException

Unescape path returned by Git.

If there are quotes in the file name, Git not only escapes them, but also encloses the file name into quotes: "\"quote"

If there are spaces in the file name, Git displays the name as is, without escaping spaces and without enclosing name in quotes.

Parameters:

path - a path to unescape

encoding - to use while converting char octets

Returns:

unescaped path ready to be searched in the VFS or file system.

Throws:

java.lang.IllegalArgumentException - if the path is invalid

unescapeGitPath

public static java.lang.String unescapeGitPath(java.lang.String path)