1 /*
2 * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
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.lib;
46
47 import static java.nio.charset.StandardCharsets.UTF_8;
48
49 import java.io.IOException;
50 import java.io.OutputStreamWriter;
51 import java.io.PrintWriter;
52 import java.io.Writer;
53
54 /**
55 * A simple progress reporter printing on a stream.
56 */
57 public class TextProgressMonitor extends BatchingProgressMonitor {
58 private final Writer out;
59
60 private boolean write;
61
62 /**
63 * Initialize a new progress monitor.
64 */
65 public TextProgressMonitor() {
66 this(new PrintWriter(new OutputStreamWriter(System.err, UTF_8)));
67 }
68
69 /**
70 * Initialize a new progress monitor.
71 *
72 * @param out
73 * the stream to receive messages on.
74 */
75 public TextProgressMonitor(Writer out) {
76 this.out = out;
77 this.write = true;
78 }
79
80 /** {@inheritDoc} */
81 @Override
82 protected void onUpdate(String taskName, int workCurr) {
83 StringBuilder s = new StringBuilder();
84 format(s, taskName, workCurr);
85 send(s);
86 }
87
88 /** {@inheritDoc} */
89 @Override
90 protected void onEndTask(String taskName, int workCurr) {
91 StringBuilder s = new StringBuilder();
92 format(s, taskName, workCurr);
93 s.append("\n"); //$NON-NLS-1$
94 send(s);
95 }
96
97 private void format(StringBuilder s, String taskName, int workCurr) {
98 s.append("\r"); //$NON-NLS-1$
99 s.append(taskName);
100 s.append(": "); //$NON-NLS-1$
101 while (s.length() < 25)
102 s.append(' ');
103 s.append(workCurr);
104 }
105
106 /** {@inheritDoc} */
107 @Override
108 protected void onUpdate(String taskName, int cmp, int totalWork, int pcnt) {
109 StringBuilder s = new StringBuilder();
110 format(s, taskName, cmp, totalWork, pcnt);
111 send(s);
112 }
113
114 /** {@inheritDoc} */
115 @Override
116 protected void onEndTask(String taskName, int cmp, int totalWork, int pcnt) {
117 StringBuilder s = new StringBuilder();
118 format(s, taskName, cmp, totalWork, pcnt);
119 s.append("\n"); //$NON-NLS-1$
120 send(s);
121 }
122
123 private void format(StringBuilder s, String taskName, int cmp,
124 int totalWork, int pcnt) {
125 s.append("\r"); //$NON-NLS-1$
126 s.append(taskName);
127 s.append(": "); //$NON-NLS-1$
128 while (s.length() < 25)
129 s.append(' ');
130
131 String endStr = String.valueOf(totalWork);
132 String curStr = String.valueOf(cmp);
133 while (curStr.length() < endStr.length())
134 curStr = " " + curStr; //$NON-NLS-1$
135 if (pcnt < 100)
136 s.append(' ');
137 if (pcnt < 10)
138 s.append(' ');
139 s.append(pcnt);
140 s.append("% ("); //$NON-NLS-1$
141 s.append(curStr);
142 s.append("/"); //$NON-NLS-1$
143 s.append(endStr);
144 s.append(")"); //$NON-NLS-1$
145 }
146
147 private void send(StringBuilder s) {
148 if (write) {
149 try {
150 out.write(s.toString());
151 out.flush();
152 } catch (IOException err) {
153 write = false;
154 }
155 }
156 }
157 }