progress_meter.C

/*
 * This file is part of the "Archon" framework.
 * (http://files3d.sourceforge.net)
 *
 * Copyright © 2002 by Kristian Spangsege and Brian Kristiansen.
 *
 * Permission to use, copy, modify, and distribute this software and
 * its documentation under the terms of the GNU General Public License is
 * hereby granted. No representations are made about the suitability of
 * this software for any purpose. It is provided "as is" without express
 * or implied warranty. See the GNU General Public License
 * (http://www.gnu.org/copyleft/gpl.html) for more details.
 *
 * The characters in this file are ISO8859-1 encoded.
 *
 * The documentation in this file is in "Doxygen" style
 * (http://www.doxygen.org).
 */

// Unix headers
#include <sys/time.h>
#include <unistd.h>

// ANSI-C headers
#include <stdio.h>
#include <stdlib.h>

// ANSI-C++ headers:
#include <iostream>

#include <archon/util/time.H>
#include <archon/util/progress_meter.H>


namespace Archon
{
  namespace Utilities
  {
    ProgressBase::ProgressBase(unsigned long totalWorkUnits):
      totalWorkUnits(totalWorkUnits), completedWorkUnits(0),
      updateTime(getTimeInMilliSeconds()),
      skippedWorkUnits(0), workUnitsPerUpdate(1) {}

    unsigned long ProgressBase::getTimeInMilliSeconds()
    {
      return Time::now().getMilliSeconds();
    }

    void ProgressBase::update()
    {
      if(completedWorkUnits == totalWorkUnits) return;

      skippedWorkUnits = 0;
      completedWorkUnits += workUnitsPerUpdate;

      // Estimate how many ticks to skip until next update
      const unsigned long now = getTimeInMilliSeconds();
      unsigned long timeSinceLastUpdate = now - updateTime;
      if(timeSinceLastUpdate == 0) timeSinceLastUpdate = 1;
      workUnitsPerUpdate = int(double(workUnitsPerUpdate) / timeSinceLastUpdate * millisBetweenUpdates);
      if(workUnitsPerUpdate == 0) workUnitsPerUpdate = 1;
      if(workUnitsPerUpdate > totalWorkUnits - completedWorkUnits) workUnitsPerUpdate = totalWorkUnits - completedWorkUnits;

      updateTime = now;

      display();
    }

    void ProgressBar::display()
    {
      const div_t d = div(static_cast<int>(width * 10 * static_cast<float>(completedWorkUnits)/totalWorkUnits), 10);

      std::cout << leadText << "|";
      int i=0;
      while(i<d.quot) ++i, std::cout << "#";
      if(extraResolution && i<width) ++i, std::cout << static_cast<char>(d.rem + '0');
      while(i<width) ++i, std::cout << "-";
      std::cout << "|";

      if(completedWorkUnits == totalWorkUnits) std::cout << "\n";
      else std::cout << std::flush << "\r";
    }

    void ProgressStatus::display()
    {
      char buffer[64];

      const float fraction = static_cast<float>(completedWorkUnits)/totalWorkUnits;

      sprintf(buffer, "%.1f", fraction*100);
      std::cout << leadText << completedWorkUnits << "/" << totalWorkUnits << ", " << buffer << "%, ";

      const unsigned long elapsedTime = updateTime - startTime;
      if(elapsedTime >= millisUntilFirstTotalTimeEstimate)
      {
        const unsigned long totalTime = static_cast<unsigned long>(elapsedTime/fraction);

        int seconds, minutes, hours;
        div_t d;

        seconds = (totalTime-elapsedTime)/1000;
        d = div(seconds, 60);
        seconds = d.rem;
        d = div(d.quot, 60);
        minutes = d.rem;
        hours = d.quot;
        sprintf(buffer, "%02d:%02d:%02d", hours, minutes, seconds);
        std::cout << "time left: " << buffer << ", ";

        seconds = totalTime/1000;
        d = div(seconds, 60);
        seconds = d.rem;
        d = div(d.quot, 60);
        minutes = d.rem;
        hours = d.quot;
        sprintf(buffer, "%02d:%02d:%02d", hours, minutes, seconds);
        std::cout << "time total: " << buffer;
      }
      else std::cout << "time left: ??:??:??, time total: ??:??:??";

      if(completedWorkUnits == totalWorkUnits) std::cout << "\n";
      else std::cout << std::flush << "  \r";
    }
  }
}

---