Class DiffFormatter
- All Implemented Interfaces:
AutoCloseable
- Direct Known Subclasses:
PatchIdDiffFormatter
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intprivate intprivate booleanprivate RawTextComparatorprivate intprivate static final intprivate DiffAlgorithmprivate DiffConfigprivate static final byte[]Magic return content indicating it is empty or no content present.private Stringprivate static final byte[]private Stringprivate final OutputStreamprivate TreeFilterprivate ProgressMonitorprivate Booleanprivate ObjectReaderprivate RenameDetectorprivate Repositoryprivate ContentSource.Pair -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new formatter with a default level of context. -
Method Summary
Modifier and TypeMethodDescriptionprivate voidvoidclose()private booleanprivate booleanprivate DiffFormatter.FormatResultdetectRenames(List<DiffEntry> files) private EditListprivate static booleanprivate intfindCombinedEnd(List<Edit> edits, int i) voidflush()Flush the underlying output stream of this formatter.voidFormat a patch script from a list of difference entries.voidFormat a patch script for one file entry.voidFormats a list of edits in unified diff formatprivate Stringvoidformat(AnyObjectId a, AnyObjectId b) Format the differences between two trees.voidformat(FileHeader head, RawText a, RawText b) Format a patch script, reusing a previously parsed FileHeader.voidFormat the differences between two trees.voidFormat the differences between two trees.protected voidformatGitDiffFirstHeaderLine(ByteArrayOutputStream o, DiffEntry.ChangeType type, String oldPath, String newPath) Output the first header lineprivate voidprotected voidformatIndexLine(OutputStream o, DiffEntry ent) Format index lineprivate voidprivate static TreeFilterGet the prefix applied in front of new file paths.Get the prefix applied in front of old file paths.protected OutputStreamGet output streamGet path filterGet rename detectorprivate booleanbooleanGet if rename detection is enabledprivate static booleanisEndOfLineMissing(RawText text, int line) private static booleanprivate AbstractTreeIteratorprivate RawTextopen(DiffEntry.Side side, DiffEntry entry) private Stringscan(AnyObjectId a, AnyObjectId b) Determine the differences between two trees.Determine the differences between two trees.Determine the differences between two trees.voidsetAbbreviationLength(int count) Change the number of digits to show in an ObjectId.voidsetBinaryFileThreshold(int threshold) Set maximum file size for text files.voidsetContext(int lineCount) Change the number of lines of context to display.voidsetDetectRenames(boolean on) Enable or disable rename detection.voidSet the algorithm that constructs difference output.voidSet the line equivalence function for text file differences.voidsetNewPrefix(String prefix) Set the prefix applied in front of new file paths.voidsetOldPrefix(String prefix) Set the prefix applied in front of old file paths.voidsetPathFilter(TreeFilter filter) Set the filter to produce only specific paths.voidSet the progress monitor for long running rename detection.voidsetQuotePaths(boolean quote) Sets whether or not path names should be quoted.voidsetReader(ObjectReader reader, Config cfg) Set the repository the formatter can load object contents from.private voidsetReader(ObjectReader reader, Config cfg, boolean closeReader) voidsetRepository(Repository repository) Set the repository the formatter can load object contents from.private ContentSourcesource(AbstractTreeIterator iterator) toFileHeader(DiffEntry ent) Creates aFileHeaderrepresenting the givenDiffEntryupdateFollowFilter(List<DiffEntry> files) protected voidwriteAddedLine(RawText text, int line) Output an added line.protected voidwriteContextLine(RawText text, int line) Output a line of context (unmodified line).private static byte[]protected voidwriteHunkHeader(int aStartLine, int aEndLine, int bStartLine, int bEndLine) Output a hunk headerprotected voidWrite a standard patch script line.private voidwriteRange(char prefix, int begin, int cnt) protected voidwriteRemovedLine(RawText text, int line) Output a removed line
-
Field Details
-
DEFAULT_BINARY_FILE_THRESHOLD
private static final int DEFAULT_BINARY_FILE_THRESHOLD- See Also:
-
noNewLine
private static final byte[] noNewLine -
EMPTY
private static final byte[] EMPTYMagic return content indicating it is empty or no content present. -
out
-
reader
-
closeReader
private boolean closeReader -
diffCfg
-
context
private int context -
abbreviationLength
private int abbreviationLength -
diffAlgorithm
-
comparator
-
binaryFileThreshold
private int binaryFileThreshold -
oldPrefix
-
newPrefix
-
pathFilter
-
renameDetector
-
progressMonitor
-
source
-
repository
-
quotePaths
-
-
Constructor Details
-
DiffFormatter
Create a new formatter with a default level of context.- Parameters:
out- the stream the formatter will write line data to. This stream should have buffering arranged by the caller, as many small writes are performed to it.
-
-
Method Details
-
getOutputStream
Get output stream- Returns:
- the stream we are outputting data to
-
setRepository
Set the repository the formatter can load object contents from. Once a repository has been set, the formatter must be released to ensure the internal ObjectReader is able to release its resources.- Parameters:
repository- source repository holding referenced objects.
-
setReader
Set the repository the formatter can load object contents from.- Parameters:
reader- source reader holding referenced objects. Caller is responsible for closing the reader.cfg- config specifying diff algorithm and rename detection options.- Since:
- 4.5
-
setReader
-
setContext
public void setContext(int lineCount) Change the number of lines of context to display.- Parameters:
lineCount- number of lines of context to see before the first modification and after the last modification within a hunk of the modified file.
-
setAbbreviationLength
public void setAbbreviationLength(int count) Change the number of digits to show in an ObjectId.- Parameters:
count- number of digits to show in an ObjectId.
-
setDiffAlgorithm
Set the algorithm that constructs difference output.- Parameters:
alg- the algorithm to produce text file differences.- See Also:
-
setDiffComparator
Set the line equivalence function for text file differences.- Parameters:
cmp- The equivalence function used to determine if two lines of text are identical. The function can be changed to ignore various types of whitespace.- See Also:
-
setBinaryFileThreshold
public void setBinaryFileThreshold(int threshold) Set maximum file size for text files. Files larger than this size will be treated as though they are binary and not text. Default is 52428800 .- Parameters:
threshold- the limit, in bytes. Files larger than this size will be assumed to be binary, even if they aren't.
-
setOldPrefix
Set the prefix applied in front of old file paths.- Parameters:
prefix- the prefix in front of old paths. Typically this is the standard string"a/", but may be any prefix desired by the caller. Must not be null. Use the empty string to have no prefix at all.
-
getOldPrefix
Get the prefix applied in front of old file paths.- Returns:
- the prefix
- Since:
- 2.0
-
setNewPrefix
Set the prefix applied in front of new file paths.- Parameters:
prefix- the prefix in front of new paths. Typically this is the standard string"b/", but may be any prefix desired by the caller. Must not be null. Use the empty string to have no prefix at all.
-
getNewPrefix
Get the prefix applied in front of new file paths.- Returns:
- the prefix
- Since:
- 2.0
-
isDetectRenames
public boolean isDetectRenames()Get if rename detection is enabled- Returns:
- true if rename detection is enabled
-
setDetectRenames
public void setDetectRenames(boolean on) Enable or disable rename detection. Before enabling rename detection the repository must be set withsetRepository(Repository). Once enabled the detector can be configured away from its defaults by obtaining the instance directly fromgetRenameDetector()and invoking configuration.- Parameters:
on- if rename detection should be enabled.
-
getRenameDetector
Get rename detector- Returns:
- the rename detector if rename detection is enabled
-
setProgressMonitor
Set the progress monitor for long running rename detection.- Parameters:
pm- progress monitor to receive rename detection status through.
-
setQuotePaths
public void setQuotePaths(boolean quote) Sets whether or not path names should be quoted.By default the setting of git config
core.quotePathis active, but this can be overridden through this method.- Parameters:
quote- whether to quote path names- Since:
- 5.6
-
setPathFilter
Set the filter to produce only specific paths. If the filter is an instance ofFollowFilter, the filter path will be updated during successive scan or format invocations. The updated path can be obtained fromgetPathFilter().- Parameters:
filter- the tree filter to apply.
-
getPathFilter
Get path filter- Returns:
- the current path filter
-
flush
Flush the underlying output stream of this formatter.- Throws:
IOException- the stream's own flush method threw an exception.
-
close
public void close()Release the internal ObjectReader state.
- Specified by:
closein interfaceAutoCloseable- Since:
- 4.0
-
scan
Determine the differences between two trees. No output is created, instead only the file paths that are different are returned. Callers may choose to format these paths themselves, or convert them intoFileHeaderinstances with a complete edit list by callingtoFileHeader(DiffEntry).Either side may be null to indicate that the tree has beed added or removed. The diff will be computed against nothing.
- Parameters:
a- the old (or previous) side or nullb- the new (or updated) side or null- Returns:
- the paths that are different.
- Throws:
IOException- trees cannot be read or file contents cannot be read.
-
scan
Determine the differences between two trees. No output is created, instead only the file paths that are different are returned. Callers may choose to format these paths themselves, or convert them intoFileHeaderinstances with a complete edit list by callingtoFileHeader(DiffEntry).Either side may be null to indicate that the tree has beed added or removed. The diff will be computed against nothing.
- Parameters:
a- the old (or previous) side or nullb- the new (or updated) side or null- Returns:
- the paths that are different.
- Throws:
IOException- trees cannot be read or file contents cannot be read.
-
makeIteratorFromTreeOrNull
private AbstractTreeIterator makeIteratorFromTreeOrNull(RevTree tree) throws IncorrectObjectTypeException, IOException -
scan
Determine the differences between two trees. No output is created, instead only the file paths that are different are returned. Callers may choose to format these paths themselves, or convert them intoFileHeaderinstances with a complete edit list by callingtoFileHeader(DiffEntry).- Parameters:
a- the old (or previous) side.b- the new (or updated) side.- Returns:
- the paths that are different.
- Throws:
IOException- trees cannot be read or file contents cannot be read.
-
getDiffTreeFilterFor
-
source
-
detectRenames
- Throws:
IOException
-
isAdd
-
updateFollowFilter
-
isRename
-
format
Format the differences between two trees. The patch is expressed as instructions to modifyato make itb.Either side may be null to indicate that the tree has beed added or removed. The diff will be computed against nothing.
- Parameters:
a- the old (or previous) side or nullb- the new (or updated) side or null- Throws:
IOException- trees cannot be read, file contents cannot be read, or the patch cannot be output.
-
format
Format the differences between two trees. The patch is expressed as instructions to modifyato make itb.Either side may be null to indicate that the tree has beed added or removed. The diff will be computed against nothing.
- Parameters:
a- the old (or previous) side or nullb- the new (or updated) side or null- Throws:
IOException- trees cannot be read, file contents cannot be read, or the patch cannot be output.
-
format
Format the differences between two trees. The patch is expressed as instructions to modifyato make itb.Either side may be null to indicate that the tree has beed added or removed. The diff will be computed against nothing.
- Parameters:
a- the old (or previous) side or nullb- the new (or updated) side or null- Throws:
IOException- trees cannot be read, file contents cannot be read, or the patch cannot be output.
-
format
Format a patch script from a list of difference entries. Requiresscan(AbstractTreeIterator, AbstractTreeIterator)to have been called first.- Parameters:
entries- entries describing the affected files.- Throws:
IOException- a file's content cannot be read, or the output stream cannot be written to.
-
format
Format a patch script for one file entry.- Parameters:
ent- the entry to be formatted.- Throws:
IOException- a file's content cannot be read, or the output stream cannot be written to.
-
writeGitLinkText
-
format
-
quotePath
-
format
Format a patch script, reusing a previously parsed FileHeader.This formatter is primarily useful for editing an existing patch script to increase or reduce the number of lines of context within the script. All header lines are reused as-is from the supplied FileHeader.
- Parameters:
head- existing file header containing the header lines to copy.a- text source for the pre-image version of the content. This must match the content ofDiffEntry.getOldId().b- text source for the post-image version of the content. This must match the content ofDiffEntry.getNewId().- Throws:
IOException- writing to the supplied stream failed.
-
format
Formats a list of edits in unified diff format- Parameters:
edits- some differences which have been calculated between A and Ba- the text A which was comparedb- the text B which was compared- Throws:
IOException
-
writeContextLine
Output a line of context (unmodified line).- Parameters:
text- RawText for accessing raw dataline- the line number within text- Throws:
IOException
-
isEndOfLineMissing
-
writeAddedLine
Output an added line.- Parameters:
text- RawText for accessing raw dataline- the line number within text- Throws:
IOException
-
writeRemovedLine
Output a removed line- Parameters:
text- RawText for accessing raw dataline- the line number within text- Throws:
IOException
-
writeHunkHeader
protected void writeHunkHeader(int aStartLine, int aEndLine, int bStartLine, int bEndLine) throws IOException Output a hunk header- Parameters:
aStartLine- within first sourceaEndLine- within first sourcebStartLine- within second sourcebEndLine- within second source- Throws:
IOException
-
writeRange
- Throws:
IOException
-
writeLine
Write a standard patch script line.- Parameters:
prefix- prefix before the line, typically '-', '+', ' '.text- the text object to obtain the line from.cur- line number to output.- Throws:
IOException- the stream threw an exception while writing to it.
-
toFileHeader
public FileHeader toFileHeader(DiffEntry ent) throws IOException, CorruptObjectException, MissingObjectException Creates aFileHeaderrepresenting the givenDiffEntryThis method does not use the OutputStream associated with this DiffFormatter instance. It is therefore safe to instantiate this DiffFormatter instance with a
DisabledOutputStreamif this method is the only one that will be used.- Parameters:
ent- the DiffEntry to create the FileHeader for- Returns:
- a FileHeader representing the DiffEntry. The FileHeader's buffer
will contain only the header of the diff output. It will also
contain one
HunkHeader. - Throws:
IOException- the stream threw an exception while writing to it, or one of the blobs referenced by the DiffEntry could not be read.CorruptObjectException- one of the blobs referenced by the DiffEntry is corrupt.MissingObjectException- one of the blobs referenced by the DiffEntry is missing.
-
createFormatResult
private DiffFormatter.FormatResult createFormatResult(DiffEntry ent) throws IOException, CorruptObjectException, MissingObjectException -
diff
-
assertHaveReader
private void assertHaveReader() -
open
- Throws:
IOExceptionBinaryBlobException
-
formatGitDiffFirstHeaderLine
protected void formatGitDiffFirstHeaderLine(ByteArrayOutputStream o, DiffEntry.ChangeType type, String oldPath, String newPath) throws IOException Output the first header line- Parameters:
o- The stream the formatter will write the first header line totype- TheDiffEntry.ChangeTypeoldPath- old path to the filenewPath- new path to the file- Throws:
IOException- the stream threw an exception while writing to it.
-
formatHeader
- Throws:
IOException
-
formatIndexLine
Format index line- Parameters:
o- the stream the formatter will write line data toent- the DiffEntry to create the FileHeader for- Throws:
IOException- writing to the supplied stream failed.
-
formatOldNewPaths
- Throws:
IOException
-
findCombinedEnd
-
combineA
-
combineB
-
end
-