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.nio.charset.Charset;
50 import java.util.List;
51
52 import org.eclipse.jgit.diff.RawText;
53 import org.eclipse.jgit.merge.MergeChunk.ConflictState;
54
55 class MergeFormatterPass {
56
57 private final EolAwareOutputStream out;
58
59 private final MergeResult<RawText> res;
60
61 private final List<String> seqName;
62
63 private final Charset charset;
64
65 private final boolean threeWayMerge;
66
67 private String lastConflictingName; // is set to non-null whenever we are in
68 // a conflict
69
70 /**
71 * @param out
72 * the {@link java.io.OutputStream} where to write the textual
73 * presentation
74 * @param res
75 * the merge result which should be presented
76 * @param seqName
77 * When a conflict is reported each conflicting range will get a
78 * name. This name is following the "<<<<<<<
79 * " or ">>>>>>> " conflict markers. The
80 * names for the sequences are given in this list
81 * @param charset
82 * the character set used when writing conflict metadata
83 */
84 MergeFormatterPass(OutputStream out, MergeResult<RawText> res,
85 List<String> seqName, Charset charset) {
86 this.out = new EolAwareOutputStream(out);
87 this.res = res;
88 this.seqName = seqName;
89 this.charset = charset;
90 this.threeWayMerge = (res.getSequences().size() == 3);
91 }
92
93 void formatMerge() throws IOException {
94 boolean missingNewlineAtEnd = false;
95 for (MergeChunk chunk : res) {
96 RawText seq = res.getSequences().get(chunk.getSequenceIndex());
97 writeConflictMetadata(chunk);
98 // the lines with conflict-metadata are written. Now write the chunk
99 for (int i = chunk.getBegin(); i < chunk.getEnd(); i++)
100 writeLine(seq, i);
101 missingNewlineAtEnd = seq.isMissingNewlineAtEnd();
102 }
103 // one possible leftover: if the merge result ended with a conflict we
104 // have to close the last conflict here
105 if (lastConflictingName != null)
106 writeConflictEnd();
107 if (!missingNewlineAtEnd)
108 out.beginln();
109 }
110
111 private void writeConflictMetadata(MergeChunk chunk) throws IOException {
112 if (lastConflictingName != null
113 && chunk.getConflictState() != ConflictState.NEXT_CONFLICTING_RANGE) {
114 // found the end of an conflict
115 writeConflictEnd();
116 }
117 if (chunk.getConflictState() == ConflictState.FIRST_CONFLICTING_RANGE) {
118 // found the start of an conflict
119 writeConflictStart(chunk);
120 } else if (chunk.getConflictState() == ConflictState.NEXT_CONFLICTING_RANGE) {
121 // found another conflicting chunk
122 writeConflictChange(chunk);
123 }
124 }
125
126 private void writeConflictEnd() throws IOException {
127 writeln(">>>>>>> " + lastConflictingName); //$NON-NLS-1$
128 lastConflictingName = null;
129 }
130
131 private void writeConflictStart(MergeChunk chunk) throws IOException {
132 lastConflictingName = seqName.get(chunk.getSequenceIndex());
133 writeln("<<<<<<< " + lastConflictingName); //$NON-NLS-1$
134 }
135
136 private void writeConflictChange(MergeChunk chunk) throws IOException {
137 /*
138 * In case of a non-three-way merge I'll add the name of the conflicting
139 * chunk behind the equal signs. I also append the name of the last
140 * conflicting chunk after the ending greater-than signs. If somebody
141 * knows a better notation to present non-three-way merges - feel free
142 * to correct here.
143 */
144 lastConflictingName = seqName.get(chunk.getSequenceIndex());
145 writeln(threeWayMerge ? "=======" : "======= " //$NON-NLS-1$ //$NON-NLS-2$
146 + lastConflictingName);
147 }
148
149 private void writeln(String s) throws IOException {
150 out.beginln();
151 out.write((s + "\n").getBytes(charset)); //$NON-NLS-1$
152 }
153
154 private void writeLine(RawText seq, int i) throws IOException {
155 out.beginln();
156 seq.writeLine(out, i);
157 // still BOL? It was a blank line. But writeLine won't lf, so we do.
158 if (out.isBeginln())
159 out.write('\n');
160 }
161 }