src/utils/ProgressBar.cpp

/*
 * Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 *
 * SUPPORT OPEN SCIENCE!  If you use OpenMD or its source code in your
 * research, please cite the appropriate papers when you publish your
 * work.  Good starting points are:
 *                                                                      
 * [1]  Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).             
 * [2]  Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).          
 * [3]  Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).          
 * [4]  Kuang & Gezelter,  J. Chem. Phys. 133, 164101 (2010).
 * [5]  Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
 */

#include <iostream>
#include <cstdlib>

#ifdef _MSC_VER
#include <Windows.h>
#include <stdio.h>
#include <io.h>
#define isatty _isatty
#define fileno _fileno
#else
#include <cstdio>
#include <sys/ioctl.h>
#include <unistd.h>
#endif

#ifdef IS_MPI
#include <mpi.h>
#endif

#include "utils/ProgressBar.hpp"

using namespace std;

namespace OpenMD {

  const char * progressSpinner_ = "|/-\\";

  ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
  }
  
  void ProgressBar::clear() {
#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
      cout << endl;
      cout.flush();
#ifdef IS_MPI
    }
#endif
    iteration_ = 0;
    value_ = 0;
    maximum_ = -1;
    start_ = time(NULL);
  }
  
  void ProgressBar::update() {

    int width;

#ifdef IS_MPI
    if (MPI::COMM_WORLD.Get_rank() == 0) {
#endif
      
      // only do the progress bar if we are actually running in a tty:
      if (isatty(fileno(stdout))  && (getenv("SGE_TASK_ID")==NULL)) {     
        // get the window width:

#ifdef _MSC_VER
        CONSOLE_SCREEN_BUFFER_INFO csbi;
        HANDLE hConsole = GetStdHandle( STD_OUTPUT_HANDLE );
        int ret = GetConsoleScreenBufferInfo(hConsole, &csbi);
        if(ret) {
          width = csbi.dwSize.X - 1;
        }
#else
        struct winsize w;
        ioctl(fileno(stdout), TIOCGWINSZ, &w);
        width = w.ws_col;
#endif

        // handle the case when the width is returned as a nonsensical value.
        if (width <= 0) width = 80;

        // We'll use:
        // 31 characters for the completion estimate, 
        //  6 for the % complete, 
        //  2 characters for the open and closing brackets.
        
        int avail = width - 31 - 6 - 2;       

        ++iteration_;

        if (maximum_ > 0.0) {

          // we know the maximum, so draw a progress bar
          
          RealType percent = value_ * 100.0 / maximum_;
          int hashes = int(percent * avail / 100.0);
          
          // compute the best estimate of the ending time:
          time_t current_ = time(NULL);
          time_t end_ = start_ + (current_ - start_) * (100.0/percent);
          struct tm * ender = localtime(&end_);
          char buffer[22];
          strftime(buffer, 22, "%a %b %d @ %I:%M %p", ender);

#ifdef _MSC_VER
          csbi.dwCursorPosition.X = 0;
          SetConsoleCursorPosition(hConsole, csbi.dwCursorPosition);
#else          
          cout << '\r';
#endif
          cout.width(3); 
          cout << right << int(percent);
          cout.width(3); 
          cout << "% [";
          cout.fill('#');
          if (hashes+1 < avail) {
            cout.width(hashes+1); 
            cout << progressSpinner_[iteration_ & 3];
          } else {
            cout.width(avail);
            cout << '#';            
          }
          cout.fill(' ');
          if (avail - hashes - 1  > 0) {
            cout.width(avail - hashes - 1);
            cout << ' ';
          }
          cout.width(11);
          cout << "] Estimate:";
          cout.width(22);
          cout << buffer;
                   
        }
        cout.flush();
      }
#ifdef IS_MPI
    }
#endif
  }
  
  void ProgressBar::setStatus(RealType val, RealType max) {
    value_ = val;
    maximum_ = max;
  }  
}
Revision:	1850
Committed:	Wed Feb 20 15:39:39 2013 UTC (12 years, 2 months ago) by gezelter
File size:	5475 byte(s)
Log Message:	Fixed a widespread typo in the license
#	User	Rev	Content
1	gezelter	1413	/*
2			* Copyright (c) 2010 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Redistributions of source code must retain the above copyright
10			* notice, this list of conditions and the following disclaimer.
11			*
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the
15			* distribution.
16			*
17			* This software is provided "AS IS," without a warranty of any
18			* kind. All express or implied conditions, representations and
19			* warranties, including any implied warranty of merchantability,
20			* fitness for a particular purpose or non-infringement, are hereby
21			* excluded. The University of Notre Dame and its licensors shall not
22			* be liable for any damages suffered by licensee as a result of
23			* using, modifying or distributing the software or its
24			* derivatives. In no event will the University of Notre Dame or its
25			* licensors be liable for any lost revenue, profit or data, or for
26			* direct, indirect, special, consequential, incidental or punitive
27			* damages, however caused and regardless of the theory of liability,
28			* arising out of the use of or inability to use software, even if the
29			* University of Notre Dame has been advised of the possibility of
30			* such damages.
31			*
32			* SUPPORT OPEN SCIENCE! If you use OpenMD or its source code in your
33			* research, please cite the appropriate papers when you publish your
34			* work. Good starting points are:
35			*
36			* [1] Meineke, et al., J. Comp. Chem. 26, 252-271 (2005).
37			* [2] Fennell & Gezelter, J. Chem. Phys. 124, 234104 (2006).
38	gezelter	1850	* [3] Sun, Lin & Gezelter, J. Chem. Phys. 128, 234107 (2008).
39	gezelter	1665	* [4] Kuang & Gezelter, J. Chem. Phys. 133, 164101 (2010).
40			* [5] Vardeman, Stocker & Gezelter, J. Chem. Theory Comput. 7, 834 (2011).
41	gezelter	1413	*/
42
43	gezelter	1431	#include <iostream>
44	chuckv	1433	#include <cstdlib>
45	gezelter	1767
46			#ifdef _MSC_VER
47			#include <Windows.h>
48			#include <stdio.h>
49			#include <io.h>
50			#define isatty _isatty
51			#define fileno _fileno
52			#else
53	gezelter	1629	#include <cstdio>
54	gezelter	1413	#include <sys/ioctl.h>
55	gezelter	1808	#include <unistd.h>
56	gezelter	1767	#endif
57
58	gezelter	1413	#ifdef IS_MPI
59			#include <mpi.h>
60	gezelter	1431	#endif
61	gezelter	1767
62	gezelter	1413	#include "utils/ProgressBar.hpp"
63
64	gezelter	1431	using namespace std;
65
66	gezelter	1413	namespace OpenMD {
67
68			const char * progressSpinner_ = "\|/-\\";
69
70			ProgressBar::ProgressBar() : value_(0.0), maximum_(-1.0), iteration_(0), start_(time(NULL)) {
71			}
72
73			void ProgressBar::clear() {
74			#ifdef IS_MPI
75			if (MPI::COMM_WORLD.Get_rank() == 0) {
76			#endif
77	gezelter	1431	cout << endl;
78			cout.flush();
79	gezelter	1413	#ifdef IS_MPI
80			}
81			#endif
82			iteration_ = 0;
83			value_ = 0;
84			maximum_ = -1;
85			start_ = time(NULL);
86			}
87
88			void ProgressBar::update() {
89	gezelter	1431
90			int width;
91
92	gezelter	1413	#ifdef IS_MPI
93			if (MPI::COMM_WORLD.Get_rank() == 0) {
94			#endif
95	gezelter	1431
96	gezelter	1421	// only do the progress bar if we are actually running in a tty:
97	chuckv	1432	if (isatty(fileno(stdout)) && (getenv("SGE_TASK_ID")==NULL)) {
98	gezelter	1421	// get the window width:
99	gezelter	1767
100			#ifdef _MSC_VER
101			CONSOLE_SCREEN_BUFFER_INFO csbi;
102	gezelter	1830	HANDLE hConsole = GetStdHandle( STD_OUTPUT_HANDLE );
103			int ret = GetConsoleScreenBufferInfo(hConsole, &csbi);
104	gezelter	1767	if(ret) {
105	gezelter	1830	width = csbi.dwSize.X - 1;
106	gezelter	1767	}
107			#else
108	gezelter	1421	struct winsize w;
109			ioctl(fileno(stdout), TIOCGWINSZ, &w);
110			width = w.ws_col;
111	gezelter	1767	#endif
112	gezelter	1413
113	gezelter	1431	// handle the case when the width is returned as a nonsensical value.
114			if (width <= 0) width = 80;
115
116	gezelter	1421	// We'll use:
117			// 31 characters for the completion estimate,
118			// 6 for the % complete,
119			// 2 characters for the open and closing brackets.
120
121	gezelter	1431	int avail = width - 31 - 6 - 2;
122
123	gezelter	1421	++iteration_;
124	gezelter	1431
125	gezelter	1421	if (maximum_ > 0.0) {
126	gezelter	1413
127	gezelter	1421	// we know the maximum, so draw a progress bar
128
129			RealType percent = value_ * 100.0 / maximum_;
130			int hashes = int(percent * avail / 100.0);
131
132			// compute the best estimate of the ending time:
133			time_t current_ = time(NULL);
134			time_t end_ = start_ + (current_ - start_) * (100.0/percent);
135			struct tm * ender = localtime(&end_);
136	gezelter	1431	char buffer[22];
137			strftime(buffer, 22, "%a %b %d @ %I:%M %p", ender);
138	gezelter	1794
139			#ifdef _MSC_VER
140			csbi.dwCursorPosition.X = 0;
141			SetConsoleCursorPosition(hConsole, csbi.dwCursorPosition);
142			#else
143	gezelter	1431	cout << '\r';
144	gezelter	1794	#endif
145	gezelter	1431	cout.width(3);
146			cout << right << int(percent);
147			cout.width(3);
148			cout << "% [";
149			cout.fill('#');
150			if (hashes+1 < avail) {
151			cout.width(hashes+1);
152			cout << progressSpinner_[iteration_ & 3];
153			} else {
154			cout.width(avail);
155			cout << '#';
156			}
157			cout.fill(' ');
158			if (avail - hashes - 1 > 0) {
159			cout.width(avail - hashes - 1);
160			cout << ' ';
161			}
162			cout.width(11);
163			cout << "] Estimate:";
164			cout.width(22);
165			cout << buffer;
166
167	gezelter	1421	}
168	gezelter	1431	cout.flush();
169	gezelter	1421	}
170	gezelter	1413	#ifdef IS_MPI
171			}
172			#endif
173			}
174
175			void ProgressBar::setStatus(RealType val, RealType max) {
176			value_ = val;
177			maximum_ = max;
178			}
179			}