1 /*
2 * Copyright (C) 2009, Christian Halstrick <christian.halstrick@sap.com>
3 * Copyright (C) 2014, André de Oliveira <andre.oliveira@liferay.com>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.merge;
46
47 import java.io.IOException;
48 import java.io.OutputStream;
49 import java.util.List;
50
51 import org.eclipse.jgit.diff.RawText;
52 import org.eclipse.jgit.merge.MergeChunk.ConflictState;
53
54 class MergeFormatterPass {
55
56 private final EolAwareOutputStream out;
57
58 private final MergeResult<RawText> res;
59
60 private final List<String> seqName;
61
62 private final String charsetName;
63
64 private final boolean threeWayMerge;
65
66 private String lastConflictingName; // is set to non-null whenever we are in
67 // a conflict
68
69 MergeFormatterPass(OutputStream out, MergeResult<RawText> res, List<String> seqName,
70 String charsetName) {
71 this.out = new EolAwareOutputStream(out);
72 this.res = res;
73 this.seqName = seqName;
74 this.charsetName = charsetName;
75 this.threeWayMerge = (res.getSequences().size() == 3);
76 }
77
78 void formatMerge() throws IOException {
79 boolean missingNewlineAtEnd = false;
80 for (MergeChunk chunk : res) {
81 RawText seq = res.getSequences().get(chunk.getSequenceIndex());
82 writeConflictMetadata(chunk);
83 // the lines with conflict-metadata are written. Now write the chunk
84 for (int i = chunk.getBegin(); i < chunk.getEnd(); i++)
85 writeLine(seq, i);
86 missingNewlineAtEnd = seq.isMissingNewlineAtEnd();
87 }
88 // one possible leftover: if the merge result ended with a conflict we
89 // have to close the last conflict here
90 if (lastConflictingName != null)
91 writeConflictEnd();
92 if (!missingNewlineAtEnd)
93 out.beginln();
94 }
95
96 private void writeConflictMetadata(MergeChunk chunk) throws IOException {
97 if (lastConflictingName != null
98 && chunk.getConflictState() != ConflictState.NEXT_CONFLICTING_RANGE) {
99 // found the end of an conflict
100 writeConflictEnd();
101 }
102 if (chunk.getConflictState() == ConflictState.FIRST_CONFLICTING_RANGE) {
103 // found the start of an conflict
104 writeConflictStart(chunk);
105 } else if (chunk.getConflictState() == ConflictState.NEXT_CONFLICTING_RANGE) {
106 // found another conflicting chunk
107 writeConflictChange(chunk);
108 }
109 }
110
111 private void writeConflictEnd() throws IOException {
112 writeln(">>>>>>> " + lastConflictingName); //$NON-NLS-1$
113 lastConflictingName = null;
114 }
115
116 private void writeConflictStart(MergeChunk chunk) throws IOException {
117 lastConflictingName = seqName.get(chunk.getSequenceIndex());
118 writeln("<<<<<<< " + lastConflictingName); //$NON-NLS-1$
119 }
120
121 private void writeConflictChange(MergeChunk chunk) throws IOException {
122 /*
123 * In case of a non-three-way merge I'll add the name of the conflicting
124 * chunk behind the equal signs. I also append the name of the last
125 * conflicting chunk after the ending greater-than signs. If somebody
126 * knows a better notation to present non-three-way merges - feel free
127 * to correct here.
128 */
129 lastConflictingName = seqName.get(chunk.getSequenceIndex());
130 writeln(threeWayMerge ? "=======" : "======= " //$NON-NLS-1$ //$NON-NLS-2$
131 + lastConflictingName);
132 }
133
134 private void writeln(String s) throws IOException {
135 out.beginln();
136 out.write((s + "\n").getBytes(charsetName)); //$NON-NLS-1$
137 }
138
139 private void writeLine(RawText seq, int i) throws IOException {
140 out.beginln();
141 seq.writeLine(out, i);
142 // still BOL? It was a blank line. But writeLine won't lf, so we do.
143 if (out.isBeginln())
144 out.write('\n');
145 }
146 }