1
0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-29 12:13:52 +00:00
CLI11/include/CLI/Timer.hpp
Henry Fredrick Schreiner 1619e863a2 Fixing name CLIUtils
2017-03-25 16:54:57 -04:00

98 lines
3.1 KiB
C++

#pragma once
// Distributed under the LGPL v2.1 license. See accompanying
// file LICENSE or https://github.com/CLIUtils/CLI11 for details.
#include <string>
#include <iostream>
#include <chrono>
#include <functional>
namespace CLI {
class Timer {
protected:
/// This is a typedef to make clocks easier to use
typedef std::chrono::high_resolution_clock clock;
/// This typedef is for points in time
typedef std::chrono::time_point<clock> time_point;
/// This is the type of a printing function, you can make your own
typedef std::function<std::string(std::string, std::string)> time_print_t;
/// This is the title of the timer
std::string title_;
/// This is the starting point (when the timer was created)
time_point start_;
/// This is the function that is used to format most of the timing message
time_print_t time_print_;
public:
/// Standard print function, this one is set by default
static std::string Simple(std::string title, std::string time) {
return title + ": " + time;
}
/// This is a fancy print function with --- headers
static std::string Big(std::string title, std::string time) {
return std::string("-----------------------------------------\n")
+ "| " + title + " | Time = " + time + "\n"
+ "-----------------------------------------";
}
public:
/// Standard constructor, can set title and print function
Timer(std::string title="Timer", time_print_t time_print = Simple)
: title_(title), time_print_(time_print), start_(clock::now()) {}
/// This formats the numerical value for the time string
std::string make_time_str() const {
time_point stop = clock::now();
std::chrono::duration<double, std::milli> elapsed = stop - start_;
double time = elapsed.count();
// LCOV_EXCL_START
if(time < 1)
return std::to_string(int(time*1000000)) + " ns";
else if(time < 10)
return std::to_string(int(time*100) / 100.) + " ms";
else if(time < 1000)
return std::to_string(int(time)) + " ms";
else if(time < 10000)
return std::to_string(int(time*10000) / 10. ) + " s";
else
return std::to_string(int(time*1000)) + " s";
// LCOV_EXCL_END
}
/// This is the main function, it creates a string
std::string to_string() const {
return time_print_(title_, make_time_str());
}
};
/// This class prints out the time upon destruction
class AutoTimer : public Timer {
public:
/// Reimplementing the constructor is required in GCC 4.7
AutoTimer(std::string title="Timer", time_print_t time_print = Simple)
: Timer(title, time_print) {}
// GCC 4.7 does not support using inheriting constructors.
/// This desctructor prints the string
~AutoTimer () {
std::cout << to_string() << std::endl;
}
};
}
/// This prints out the time if shifted into a std::cout like stream.
std::ostream & operator<< (std::ostream& in, const CLI::Timer& timer) {
return in << timer.to_string();
}