apt-pkg/contrib/progress.cc

   1 // -*- mode: cpp; mode: fold -*-
   2 // Description                                                          /*{{{*/
   3 // $Id: progress.cc,v 1.12 2003/01/11 07:17:04 jgg Exp $
   4 /* ######################################################################
   5
   6    OpProgress - Operation Progress
   7
   8    ##################################################################### */
   9                                                                         /*}}}*/
  10 // Include Files                                                        /*{{{*/
  11 #ifdef __GNUG__
  12 #pragma implementation "apt-pkg/progress.h"
  13 #endif
  14 #include <apt-pkg/progress.h>
  15 #include <apt-pkg/error.h>
  16 #include <apt-pkg/configuration.h>
  17
  18 #include <apti18n.h>
  19
  20 #include <iostream>
  21 #include <stdio.h>
  22                                                                         /*}}}*/
  23
  24 using namespace std;
  25
  26 // OpProgress::OpProgress - Constructor                                 /*{{{*/
  27 // ---------------------------------------------------------------------
  28 /* */
  29 OpProgress::OpProgress() : Current(0), Total(0), Size(0), SubTotal(1),
  30                            LastPercent(0), Percent(0)
  31 {
  32    memset(&LastTime,0,sizeof(LastTime));
  33 }
  34                                                                         /*}}}*/
  35 // OpProgress::Progress - Sub progress with no state change             /*{{{*/
  36 // ---------------------------------------------------------------------
  37 /* Current is the Base Overall progress in units of Total. Cur is the sub
  38    progress in units of SubTotal. Size is a scaling factor that says what
  39    percent of Total SubTotal is. */
  40 void OpProgress::Progress(unsigned long Cur)
  41 {
  42    if (Total == 0 || Size == 0 || SubTotal == 0)
  43       Percent = 0;
  44    else
  45       Percent = (Current + Cur/((float)SubTotal)*Size)*100.0/Total;
  46    Update();
  47 }
  48                                                                         /*}}}*/
  49 // OpProgress::OverallProgress - Set the overall progress               /*{{{*/
  50 // ---------------------------------------------------------------------
  51 /* */
  52 void OpProgress::OverallProgress(unsigned long Current, unsigned long Total,
  53                                  unsigned long Size,const string &Op)
  54 {
  55    this->Current = Current;
  56    this->Total = Total;
  57    this->Size = Size;
  58    this->Op = Op;
  59    SubOp = string();
  60    if (Total == 0)
  61       Percent = 0;
  62    else
  63       Percent = Current*100.0/Total;
  64    Update();
  65 }
  66                                                                         /*}}}*/
  67 // OpProgress::SubProgress - Set the sub progress state                 /*{{{*/
  68 // ---------------------------------------------------------------------
  69 /* */
  70 void OpProgress::SubProgress(unsigned long SubTotal,const string &Op)
  71 {
  72    this->SubTotal = SubTotal;
  73    SubOp = Op;
  74    if (Total == 0)
  75       Percent = 0;
  76    else
  77       Percent = Current*100.0/Total;
  78    Update();
  79 }
  80                                                                         /*}}}*/
  81 // OpProgress::SubProgress - Set the sub progress state                 /*{{{*/
  82 // ---------------------------------------------------------------------
  83 /* */
  84 void OpProgress::SubProgress(unsigned long SubTotal)
  85 {
  86    this->SubTotal = SubTotal;
  87    if (Total == 0)
  88       Percent = 0;
  89    else
  90       Percent = Current*100.0/Total;
  91    Update();
  92 }
  93                                                                         /*}}}*/
  94 // OpProgress::CheckChange - See if the display should be updated       /*{{{*/
  95 // ---------------------------------------------------------------------
  96 /* Progress calls are made so frequently that if every one resulted in
  97    an update the display would be swamped and the system much slower.
  98    This provides an upper bound on the update rate. */
  99 bool OpProgress::CheckChange(float Interval)
 100 {
 101    // New major progress indication
 102    if (Op != LastOp)
 103    {
 104       MajorChange = true;
 105       LastOp = Op;
 106       return true;
 107    }
 108    MajorChange = false;
 109
 110    if (SubOp != LastSubOp)
 111    {
 112       LastSubOp = SubOp;
 113       return true;
 114    }
 115
 116    if ((int)LastPercent == (int)Percent)
 117       return false;
 118
 119    LastPercent = Percent;
 120
 121    if (Interval == 0)
 122       return false;
 123
 124    // Check time delta
 125    struct timeval Now;
 126    gettimeofday(&Now,0);
 127    double Diff = Now.tv_sec - LastTime.tv_sec + (Now.tv_usec - LastTime.tv_usec)/1000000.0;
 128    if (Diff < Interval)
 129       return false;
 130    LastTime = Now;
 131    return true;
 132 }
 133                                                                         /*}}}*/
 134 // OpTextProgress::OpTextProgress - Constructor                         /*{{{*/
 135 // ---------------------------------------------------------------------
 136 /* */
 137 OpTextProgress::OpTextProgress(Configuration &Config) :
 138                                NoUpdate(false), NoDisplay(false), LastLen(0)
 139 {
 140    if (Config.FindI("quiet",0) >= 1)
 141       NoUpdate = true;
 142    if (Config.FindI("quiet",0) >= 2)
 143       NoDisplay = true;
 144 };
 145                                                                         /*}}}*/
 146 // OpTextProgress::Done - Clean up the display                          /*{{{*/
 147 // ---------------------------------------------------------------------
 148 /* */
 149 void OpTextProgress::Done()
 150 {
 151    if (NoUpdate == false && OldOp.empty() == false)
 152    {
 153       char S[300];
 154       if (_error->PendingError() == true)
 155          snprintf(S,sizeof(S),_("%c%s... Error!"),'\r',OldOp.c_str());
 156       else
 157          snprintf(S,sizeof(S),_("%c%s... Done"),'\r',OldOp.c_str());
 158       Write(S);
 159       cout << endl;
 160       OldOp = string();
 161    }
 162
 163    if (NoUpdate == true && NoDisplay == false && OldOp.empty() == false)
 164    {
 165       OldOp = string();
 166       cout << endl;
 167    }
 168 }
 169                                                                         /*}}}*/
 170 // OpTextProgress::Update - Simple text spinner                         /*{{{*/
 171 // ---------------------------------------------------------------------
 172 /* */
 173 void OpTextProgress::Update()
 174 {
 175    if (CheckChange((NoUpdate == true?0:0.7)) == false)
 176       return;
 177
 178    // No percent spinner
 179    if (NoUpdate == true)
 180    {
 181       if (MajorChange == false)
 182          return;
 183       if (NoDisplay == false)
 184       {
 185          if (OldOp.empty() == false)
 186             cout << endl;
 187          OldOp = "a";
 188          cout << Op << "..." << flush;
 189       }
 190
 191       return;
 192    }
 193
 194    // Erase the old text and 'log' the event
 195    char S[300];
 196    if (MajorChange == true && OldOp.empty() == false)
 197    {
 198       snprintf(S,sizeof(S),"\r%s",OldOp.c_str());
 199       Write(S);
 200       cout << endl;
 201    }
 202
 203    // Print the spinner
 204    snprintf(S,sizeof(S),"\r%s... %u%%",Op.c_str(),(unsigned int)Percent);
 205    Write(S);
 206
 207    OldOp = Op;
 208 }
 209                                                                         /*}}}*/
 210 // OpTextProgress::Write - Write the progress string                    /*{{{*/
 211 // ---------------------------------------------------------------------
 212 /* This space fills the end to overwrite the previous text */
 213 void OpTextProgress::Write(const char *S)
 214 {
 215    cout << S;
 216    for (unsigned int I = strlen(S); I < LastLen; I++)
 217       cout << ' ';
 218    cout << '\r' << flush;
 219    LastLen = strlen(S);
 220 }
 221                                                                         /*}}}*/