Browse Source
WorkingTreeIterator now optionally performs CRLF to LF conversion for
text files. A basic framework is left in place to support enabling
(or disabling) this feature based on gitattributes, and also to
support the more generic smudge/clean filter system. As there is
no gitattribute support yet in JGit this is left unimplemented,
but the mightNeedCleaning(), isBinary() and filterClean() methods
will provide reasonable places to plug that into in the future.
[sp: All bugs inside of WorkingTreeIterator are my fault, I wrote
most of it while cherry-picking this patch and building it on
top of Marc's original work.]
CQ: 4419
Bug: 301775
Change-Id: I0ca35cfbfe3f503729cbfc1d5034ad4abcd1097e
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
stable-0.9
Marc Strapetz
15 years ago
committed by
Shawn O. Pearce
12 changed files with 627 additions and 67 deletions
@ -0,0 +1,111 @@
|
||||
/* |
||||
* Copyright (C) 2010, Marc Strapetz <marc.strapetz@syntevo.com> |
||||
* and other copyright owners as documented in the project's IP log. |
||||
* |
||||
* This program and the accompanying materials are made available |
||||
* under the terms of the Eclipse Distribution License v1.0 which |
||||
* accompanies this distribution, is reproduced below, and is |
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
* |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or |
||||
* without modification, are permitted provided that the following |
||||
* conditions are met: |
||||
* |
||||
* - Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* |
||||
* - Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following |
||||
* disclaimer in the documentation and/or other materials provided |
||||
* with the distribution. |
||||
* |
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||
* names of its contributors may be used to endorse or promote |
||||
* products derived from this software without specific prior |
||||
* written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
*/ |
||||
|
||||
package org.eclipse.jgit.util.io; |
||||
|
||||
import java.io.ByteArrayInputStream; |
||||
import java.io.IOException; |
||||
import java.io.InputStream; |
||||
import java.io.UnsupportedEncodingException; |
||||
|
||||
import junit.framework.TestCase; |
||||
|
||||
public class EolCanonicalizingInputStreamTest extends TestCase { |
||||
|
||||
public void testLF() throws IOException { |
||||
final byte[] bytes = asBytes("1\n2\n3"); |
||||
test(bytes, bytes); |
||||
} |
||||
|
||||
public void testCR() throws IOException { |
||||
final byte[] bytes = asBytes("1\r2\r3"); |
||||
test(bytes, bytes); |
||||
} |
||||
|
||||
public void testCRLF() throws IOException { |
||||
test(asBytes("1\r\n2\r\n3"), asBytes("1\n2\n3")); |
||||
} |
||||
|
||||
public void testLFCR() throws IOException { |
||||
final byte[] bytes = asBytes("1\n\r2\n\r3"); |
||||
test(bytes, bytes); |
||||
} |
||||
|
||||
private void test(byte[] input, byte[] expected) throws IOException { |
||||
final InputStream bis1 = new ByteArrayInputStream(input); |
||||
final InputStream cis1 = new EolCanonicalizingInputStream(bis1); |
||||
int index1 = 0; |
||||
for (int b = cis1.read(); b != -1; b = cis1.read()) { |
||||
assertEquals(expected[index1], (byte) b); |
||||
index1++; |
||||
} |
||||
|
||||
assertEquals(expected.length, index1); |
||||
|
||||
for (int bufferSize = 1; bufferSize < 10; bufferSize++) { |
||||
final byte[] buffer = new byte[bufferSize]; |
||||
final InputStream bis2 = new ByteArrayInputStream(input); |
||||
final InputStream cis2 = new EolCanonicalizingInputStream(bis2); |
||||
|
||||
int read = 0; |
||||
for (int readNow = cis2.read(buffer, 0, buffer.length); readNow != -1 |
||||
&& read < expected.length; readNow = cis2.read(buffer, 0, |
||||
buffer.length)) { |
||||
for (int index2 = 0; index2 < readNow; index2++) { |
||||
assertEquals(expected[read + index2], buffer[index2]); |
||||
} |
||||
read += readNow; |
||||
} |
||||
|
||||
assertEquals(expected.length, read); |
||||
} |
||||
} |
||||
|
||||
private static byte[] asBytes(String in) { |
||||
try { |
||||
return in.getBytes("UTF-8"); |
||||
} catch (UnsupportedEncodingException ex) { |
||||
throw new AssertionError(); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,101 @@
|
||||
/* |
||||
* Copyright (C) 2010, Marc Strapetz <marc.strapetz@syntevo.com> |
||||
* and other copyright owners as documented in the project's IP log. |
||||
* |
||||
* This program and the accompanying materials are made available |
||||
* under the terms of the Eclipse Distribution License v1.0 which |
||||
* accompanies this distribution, is reproduced below, and is |
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
* |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or |
||||
* without modification, are permitted provided that the following |
||||
* conditions are met: |
||||
* |
||||
* - Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* |
||||
* - Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following |
||||
* disclaimer in the documentation and/or other materials provided |
||||
* with the distribution. |
||||
* |
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||
* names of its contributors may be used to endorse or promote |
||||
* products derived from this software without specific prior |
||||
* written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
*/ |
||||
package org.eclipse.jgit.treewalk; |
||||
|
||||
import org.eclipse.jgit.lib.Config; |
||||
import org.eclipse.jgit.lib.CoreConfig; |
||||
|
||||
/** |
||||
* Contains options used by the WorkingTreeIterator. |
||||
*/ |
||||
public class WorkingTreeOptions { |
||||
|
||||
/** |
||||
* Creates default options which reflect the original configuration of Git |
||||
* on Unix systems. |
||||
* |
||||
* @return created working tree options |
||||
*/ |
||||
public static WorkingTreeOptions createDefaultInstance() { |
||||
return new WorkingTreeOptions(false); |
||||
} |
||||
|
||||
/** |
||||
* Creates options based on the specified repository configuration. |
||||
* |
||||
* @param config |
||||
* repository configuration to create options for |
||||
* |
||||
* @return created working tree options |
||||
*/ |
||||
public static WorkingTreeOptions createConfigurationInstance(Config config) { |
||||
return new WorkingTreeOptions(config.get(CoreConfig.KEY).isAutoCRLF()); |
||||
} |
||||
|
||||
/** |
||||
* Indicates whether EOLs of text files should be converted to '\n' before |
||||
* calculating the blob ID. |
||||
**/ |
||||
private final boolean autoCRLF; |
||||
|
||||
/** |
||||
* Creates new options. |
||||
* |
||||
* @param autoCRLF |
||||
* indicates whether EOLs of text files should be converted to |
||||
* '\n' before calculating the blob ID. |
||||
*/ |
||||
public WorkingTreeOptions(boolean autoCRLF) { |
||||
this.autoCRLF = autoCRLF; |
||||
} |
||||
|
||||
/** |
||||
* Indicates whether EOLs of text files should be converted to '\n' before |
||||
* calculating the blob ID. |
||||
* |
||||
* @return true if EOLs should be canonicalized. |
||||
*/ |
||||
public boolean isAutoCRLF() { |
||||
return autoCRLF; |
||||
} |
||||
} |
||||
@ -0,0 +1,130 @@
|
||||
/* |
||||
* Copyright (C) 2010, Marc Strapetz <marc.strapetz@syntevo.com> |
||||
* and other copyright owners as documented in the project's IP log. |
||||
* |
||||
* This program and the accompanying materials are made available |
||||
* under the terms of the Eclipse Distribution License v1.0 which |
||||
* accompanies this distribution, is reproduced below, and is |
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
* |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or |
||||
* without modification, are permitted provided that the following |
||||
* conditions are met: |
||||
* |
||||
* - Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* |
||||
* - Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following |
||||
* disclaimer in the documentation and/or other materials provided |
||||
* with the distribution. |
||||
* |
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the |
||||
* names of its contributors may be used to endorse or promote |
||||
* products derived from this software without specific prior |
||||
* written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND |
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, |
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR |
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, |
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF |
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
*/ |
||||
|
||||
package org.eclipse.jgit.util.io; |
||||
|
||||
import java.io.IOException; |
||||
import java.io.InputStream; |
||||
|
||||
/** |
||||
* An input stream which canonicalizes EOLs bytes on the fly to '\n'. |
||||
* |
||||
* Note: Make sure to apply this InputStream only to text files! |
||||
*/ |
||||
public class EolCanonicalizingInputStream extends InputStream { |
||||
private final byte[] single = new byte[1]; |
||||
|
||||
private final byte[] buf = new byte[8096]; |
||||
|
||||
private final InputStream in; |
||||
|
||||
private int cnt; |
||||
|
||||
private int ptr; |
||||
|
||||
/** |
||||
* Creates a new InputStream, wrapping the specified stream |
||||
* |
||||
* @param in |
||||
* raw input stream |
||||
*/ |
||||
public EolCanonicalizingInputStream(InputStream in) { |
||||
this.in = in; |
||||
} |
||||
|
||||
@Override |
||||
public int read() throws IOException { |
||||
final int read = read(single, 0, 1); |
||||
return read == 1 ? single[0] & 0xff : -1; |
||||
} |
||||
|
||||
@Override |
||||
public int read(byte[] bs, int off, int len) throws IOException { |
||||
if (len == 0) |
||||
return 0; |
||||
|
||||
if (cnt == -1) |
||||
return -1; |
||||
|
||||
final int startOff = off; |
||||
final int end = off + len; |
||||
|
||||
while (off < end) { |
||||
if (ptr == cnt && !fillBuffer()) { |
||||
break; |
||||
} |
||||
|
||||
byte b = buf[ptr++]; |
||||
if (b != '\r') { |
||||
bs[off++] = b; |
||||
continue; |
||||
} |
||||
|
||||
if (ptr == cnt && !fillBuffer()) { |
||||
bs[off++] = '\r'; |
||||
break; |
||||
} |
||||
|
||||
if (buf[ptr] == '\n') { |
||||
bs[off++] = '\n'; |
||||
ptr++; |
||||
} else |
||||
bs[off++] = '\r'; |
||||
} |
||||
|
||||
return startOff == off ? -1 : off - startOff; |
||||
} |
||||
|
||||
@Override |
||||
public void close() throws IOException { |
||||
in.close(); |
||||
} |
||||
|
||||
private boolean fillBuffer() throws IOException { |
||||
cnt = in.read(buf, 0, buf.length); |
||||
if (cnt < 1) |
||||
return false; |
||||
ptr = 0; |
||||
return true; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue