1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
|
// file : butl/timestamp -*- C++ -*-
// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
// license : MIT; see accompanying LICENSE file
#ifndef BUTL_TIMESTAMP
#define BUTL_TIMESTAMP
#include <chrono>
#include <iosfwd>
#include <butl/path>
namespace butl
{
// On all three main platforms that we target (GNU/Linux, Windows (both
// VC++ and GCC/MinGW64), and MacOS X) with recent C++ runtimes,
// system_clock has nanoseconds resolution and counts from the UNIX
// epoch. The latter is important since struct stat also returns times
// based on UNIX epoch.
//
// The underlying type for nanoseconds duration is signed integer type
// of at least 64 bits (currently int64_t). Because it is signed, we
// will overflow in year 2262 but by then the underlying type will
// most likely have changed to something larger than 64-bit.
//
// So to support other platforms that could possibly use a different
// system_clock resolutions (e.g., microseconds), we actually not going
// to assume anywhere (except perhaps timestamp.cxx) that we are dealing
// with nanoseconds or the 64-bit underlying type.
//
using std::chrono::system_clock;
// Note that the default-initialized timestamp has the timestamp_nonexistent
// value.
//
using timestamp = system_clock::time_point;
using duration = system_clock::duration;
// Generally-useful special values.
//
const timestamp timestamp_unknown {duration {-1}};
const timestamp timestamp_nonexistent {duration {0}};
// Human-readable representation. By default the timestamp is printed by
// localtime_r() in the local timezone, so tzset() from <time.h> should be
// called prior to using the corresponding operator or the to_stream()
// function (normally from main() or equivalent).
//
// The format argument in the to_stream() function is the put_time() format
// string except that it also supports the nanoseconds conversion specifier
// in the form %[<d>N] where <d> is the optional single delimiter character,
// for example '.'. If the nanoseconds part is 0, then it is not printed (nor
// the delimiter character).
//
// The special argument in the to_stream() function indicates whether the
// special timestamp_unknown and timestamp_nonexistent values should be
// printed as '<unknown>' and '<nonexistent>', respectively.
//
// The local argument in the to_stream() function indicates whether to use
// localtime_r() or gmtime_r().
//
// Note also that these operators/function may throw std::system_error.
//
// Finally, padding is not fully supported by these operators/function. They
// throw runtime_error if nanoseconds conversion specifier is present and
// the stream's width field has been set to non-zero value before the call.
//
// Potential improvements:
// - add flag to to_stream() to use
// - support %[<d>U] (microseconds) and %[<d>M] (milliseconds).
// - make to_stream() a manipulator, similar to put_time()
// - support %(N) version for non-optional printing
// - support for suffix %[<d>N<s>], for example %[N nsec]
//
std::ostream&
to_stream (std::ostream&,
const timestamp&,
const char* format,
bool special,
bool local);
inline std::ostream&
operator<< (std::ostream& os, const timestamp& ts)
{
return to_stream (os, ts, "%Y-%m-%d %H:%M:%S%[.N]", true, true);
}
std::ostream&
operator<< (std::ostream&, const duration&);
};
#endif // BUTL_TIMESTAMP
|
