org.spearce.jgit/src/org/spearce/jgit/lib/TextProgressMonitor.java

   1 /*
   2  * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
   3  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or
   8  * without modification, are permitted provided that the following
   9  * conditions are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  *
  14  * - Redistributions in binary form must reproduce the above
  15  *   copyright notice, this list of conditions and the following
  16  *   disclaimer in the documentation and/or other materials provided
  17  *   with the distribution.
  18  *
  19  * - Neither the name of the Git Development Community nor the
  20  *   names of its contributors may be used to endorse or promote
  21  *   products derived from this software without specific prior
  22  *   written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  25  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  26  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  34  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 package org.spearce.jgit.lib;
  40
  41 /**
  42  * A simple progress reporter printing on stderr
  43  */
  44 public class TextProgressMonitor implements ProgressMonitor {
  45         private boolean output;
  46
  47         private long taskBeganAt;
  48
  49         private String msg;
  50
  51         private int lastWorked;
  52
  53         private int totalWork;
  54
  55         /** Initialize a new progress monitor. */
  56         public TextProgressMonitor() {
  57                 taskBeganAt = System.currentTimeMillis();
  58         }
  59
  60         public void start(final int totalTasks) {
  61                 // Ignore the number of tasks.
  62                 taskBeganAt = System.currentTimeMillis();
  63         }
  64
  65         public void beginTask(final String title, final int total) {
  66                 endTask();
  67                 msg = title;
  68                 lastWorked = 0;
  69                 totalWork = total;
  70         }
  71
  72         public void update(final int completed) {
  73                 if (msg == null)
  74                         return;
  75
  76                 final int cmp = lastWorked + completed;
  77                 if (!output && System.currentTimeMillis() - taskBeganAt < 500)
  78                         return;
  79                 if (totalWork == UNKNOWN) {
  80                         display(cmp);
  81                         System.err.flush();
  82                 } else {
  83                         if ((cmp * 100 / totalWork) != (lastWorked * 100) / totalWork) {
  84                                 display(cmp);
  85                                 System.err.flush();
  86                         }
  87                 }
  88                 lastWorked = cmp;
  89                 output = true;
  90         }
  91
  92         private void display(final int cmp) {
  93                 final StringBuilder m = new StringBuilder();
  94                 m.append('\r');
  95                 m.append(msg);
  96                 m.append(": ");
  97                 while (m.length() < 25)
  98                         m.append(' ');
  99
 100                 if (totalWork == UNKNOWN) {
 101                         m.append(cmp);
 102                 } else {
 103                         final String twstr = String.valueOf(totalWork);
 104                         String cmpstr = String.valueOf(cmp);
 105                         while (cmpstr.length() < twstr.length())
 106                                 cmpstr = " " + cmpstr;
 107                         final int pcnt = (cmp * 100 / totalWork);
 108                         if (pcnt < 100)
 109                                 m.append(' ');
 110                         if (pcnt < 10)
 111                                 m.append(' ');
 112                         m.append(pcnt);
 113                         m.append("% (");
 114                         m.append(cmpstr);
 115                         m.append("/");
 116                         m.append(twstr);
 117                         m.append(")");
 118                 }
 119
 120                 System.err.print(m);
 121         }
 122
 123         public boolean isCancelled() {
 124                 return false;
 125         }
 126
 127         public void endTask() {
 128                 if (output) {
 129                         if (totalWork != UNKNOWN)
 130                                 display(totalWork);
 131                         System.err.println();
 132                 }
 133                 output = false;
 134                 msg = null;
 135         }
 136 }