xref: /aosp_15_r20/external/abseil-cpp/absl/time/format.cc (revision 9356374a3709195abf420251b3e825997ff56c0f)
1*9356374aSAndroid Build Coastguard Worker // Copyright 2017 The Abseil Authors.
2*9356374aSAndroid Build Coastguard Worker //
3*9356374aSAndroid Build Coastguard Worker // Licensed under the Apache License, Version 2.0 (the "License");
4*9356374aSAndroid Build Coastguard Worker // you may not use this file except in compliance with the License.
5*9356374aSAndroid Build Coastguard Worker // You may obtain a copy of the License at
6*9356374aSAndroid Build Coastguard Worker //
7*9356374aSAndroid Build Coastguard Worker //      https://www.apache.org/licenses/LICENSE-2.0
8*9356374aSAndroid Build Coastguard Worker //
9*9356374aSAndroid Build Coastguard Worker // Unless required by applicable law or agreed to in writing, software
10*9356374aSAndroid Build Coastguard Worker // distributed under the License is distributed on an "AS IS" BASIS,
11*9356374aSAndroid Build Coastguard Worker // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*9356374aSAndroid Build Coastguard Worker // See the License for the specific language governing permissions and
13*9356374aSAndroid Build Coastguard Worker // limitations under the License.
14*9356374aSAndroid Build Coastguard Worker 
15*9356374aSAndroid Build Coastguard Worker #include <string.h>
16*9356374aSAndroid Build Coastguard Worker 
17*9356374aSAndroid Build Coastguard Worker #include <cctype>
18*9356374aSAndroid Build Coastguard Worker #include <cstdint>
19*9356374aSAndroid Build Coastguard Worker #include <utility>
20*9356374aSAndroid Build Coastguard Worker 
21*9356374aSAndroid Build Coastguard Worker #include "absl/strings/match.h"
22*9356374aSAndroid Build Coastguard Worker #include "absl/strings/string_view.h"
23*9356374aSAndroid Build Coastguard Worker #include "absl/time/internal/cctz/include/cctz/time_zone.h"
24*9356374aSAndroid Build Coastguard Worker #include "absl/time/time.h"
25*9356374aSAndroid Build Coastguard Worker 
26*9356374aSAndroid Build Coastguard Worker namespace cctz = absl::time_internal::cctz;
27*9356374aSAndroid Build Coastguard Worker 
28*9356374aSAndroid Build Coastguard Worker namespace absl {
29*9356374aSAndroid Build Coastguard Worker ABSL_NAMESPACE_BEGIN
30*9356374aSAndroid Build Coastguard Worker 
31*9356374aSAndroid Build Coastguard Worker ABSL_DLL extern const char RFC3339_full[] = "%Y-%m-%d%ET%H:%M:%E*S%Ez";
32*9356374aSAndroid Build Coastguard Worker ABSL_DLL extern const char RFC3339_sec[] = "%Y-%m-%d%ET%H:%M:%S%Ez";
33*9356374aSAndroid Build Coastguard Worker 
34*9356374aSAndroid Build Coastguard Worker ABSL_DLL extern const char RFC1123_full[] = "%a, %d %b %E4Y %H:%M:%S %z";
35*9356374aSAndroid Build Coastguard Worker ABSL_DLL extern const char RFC1123_no_wday[] = "%d %b %E4Y %H:%M:%S %z";
36*9356374aSAndroid Build Coastguard Worker 
37*9356374aSAndroid Build Coastguard Worker namespace {
38*9356374aSAndroid Build Coastguard Worker 
39*9356374aSAndroid Build Coastguard Worker const char kInfiniteFutureStr[] = "infinite-future";
40*9356374aSAndroid Build Coastguard Worker const char kInfinitePastStr[] = "infinite-past";
41*9356374aSAndroid Build Coastguard Worker 
42*9356374aSAndroid Build Coastguard Worker struct cctz_parts {
43*9356374aSAndroid Build Coastguard Worker   cctz::time_point<cctz::seconds> sec;
44*9356374aSAndroid Build Coastguard Worker   cctz::detail::femtoseconds fem;
45*9356374aSAndroid Build Coastguard Worker };
46*9356374aSAndroid Build Coastguard Worker 
unix_epoch()47*9356374aSAndroid Build Coastguard Worker inline cctz::time_point<cctz::seconds> unix_epoch() {
48*9356374aSAndroid Build Coastguard Worker   return std::chrono::time_point_cast<cctz::seconds>(
49*9356374aSAndroid Build Coastguard Worker       std::chrono::system_clock::from_time_t(0));
50*9356374aSAndroid Build Coastguard Worker }
51*9356374aSAndroid Build Coastguard Worker 
52*9356374aSAndroid Build Coastguard Worker // Splits a Time into seconds and femtoseconds, which can be used with CCTZ.
53*9356374aSAndroid Build Coastguard Worker // Requires that 't' is finite. See duration.cc for details about rep_hi and
54*9356374aSAndroid Build Coastguard Worker // rep_lo.
Split(absl::Time t)55*9356374aSAndroid Build Coastguard Worker cctz_parts Split(absl::Time t) {
56*9356374aSAndroid Build Coastguard Worker   const auto d = time_internal::ToUnixDuration(t);
57*9356374aSAndroid Build Coastguard Worker   const int64_t rep_hi = time_internal::GetRepHi(d);
58*9356374aSAndroid Build Coastguard Worker   const int64_t rep_lo = time_internal::GetRepLo(d);
59*9356374aSAndroid Build Coastguard Worker   const auto sec = unix_epoch() + cctz::seconds(rep_hi);
60*9356374aSAndroid Build Coastguard Worker   const auto fem = cctz::detail::femtoseconds(rep_lo * (1000 * 1000 / 4));
61*9356374aSAndroid Build Coastguard Worker   return {sec, fem};
62*9356374aSAndroid Build Coastguard Worker }
63*9356374aSAndroid Build Coastguard Worker 
64*9356374aSAndroid Build Coastguard Worker // Joins the given seconds and femtoseconds into a Time. See duration.cc for
65*9356374aSAndroid Build Coastguard Worker // details about rep_hi and rep_lo.
Join(const cctz_parts & parts)66*9356374aSAndroid Build Coastguard Worker absl::Time Join(const cctz_parts& parts) {
67*9356374aSAndroid Build Coastguard Worker   const int64_t rep_hi = (parts.sec - unix_epoch()).count();
68*9356374aSAndroid Build Coastguard Worker   const uint32_t rep_lo =
69*9356374aSAndroid Build Coastguard Worker       static_cast<uint32_t>(parts.fem.count() / (1000 * 1000 / 4));
70*9356374aSAndroid Build Coastguard Worker   const auto d = time_internal::MakeDuration(rep_hi, rep_lo);
71*9356374aSAndroid Build Coastguard Worker   return time_internal::FromUnixDuration(d);
72*9356374aSAndroid Build Coastguard Worker }
73*9356374aSAndroid Build Coastguard Worker 
74*9356374aSAndroid Build Coastguard Worker }  // namespace
75*9356374aSAndroid Build Coastguard Worker 
FormatTime(absl::string_view format,absl::Time t,absl::TimeZone tz)76*9356374aSAndroid Build Coastguard Worker std::string FormatTime(absl::string_view format, absl::Time t,
77*9356374aSAndroid Build Coastguard Worker                        absl::TimeZone tz) {
78*9356374aSAndroid Build Coastguard Worker   if (t == absl::InfiniteFuture()) return std::string(kInfiniteFutureStr);
79*9356374aSAndroid Build Coastguard Worker   if (t == absl::InfinitePast()) return std::string(kInfinitePastStr);
80*9356374aSAndroid Build Coastguard Worker   const auto parts = Split(t);
81*9356374aSAndroid Build Coastguard Worker   return cctz::detail::format(std::string(format), parts.sec, parts.fem,
82*9356374aSAndroid Build Coastguard Worker                               cctz::time_zone(tz));
83*9356374aSAndroid Build Coastguard Worker }
84*9356374aSAndroid Build Coastguard Worker 
FormatTime(absl::Time t,absl::TimeZone tz)85*9356374aSAndroid Build Coastguard Worker std::string FormatTime(absl::Time t, absl::TimeZone tz) {
86*9356374aSAndroid Build Coastguard Worker   return FormatTime(RFC3339_full, t, tz);
87*9356374aSAndroid Build Coastguard Worker }
88*9356374aSAndroid Build Coastguard Worker 
FormatTime(absl::Time t)89*9356374aSAndroid Build Coastguard Worker std::string FormatTime(absl::Time t) {
90*9356374aSAndroid Build Coastguard Worker   return absl::FormatTime(RFC3339_full, t, absl::LocalTimeZone());
91*9356374aSAndroid Build Coastguard Worker }
92*9356374aSAndroid Build Coastguard Worker 
ParseTime(absl::string_view format,absl::string_view input,absl::Time * time,std::string * err)93*9356374aSAndroid Build Coastguard Worker bool ParseTime(absl::string_view format, absl::string_view input,
94*9356374aSAndroid Build Coastguard Worker                absl::Time* time, std::string* err) {
95*9356374aSAndroid Build Coastguard Worker   return absl::ParseTime(format, input, absl::UTCTimeZone(), time, err);
96*9356374aSAndroid Build Coastguard Worker }
97*9356374aSAndroid Build Coastguard Worker 
98*9356374aSAndroid Build Coastguard Worker // If the input string does not contain an explicit UTC offset, interpret
99*9356374aSAndroid Build Coastguard Worker // the fields with respect to the given TimeZone.
ParseTime(absl::string_view format,absl::string_view input,absl::TimeZone tz,absl::Time * time,std::string * err)100*9356374aSAndroid Build Coastguard Worker bool ParseTime(absl::string_view format, absl::string_view input,
101*9356374aSAndroid Build Coastguard Worker                absl::TimeZone tz, absl::Time* time, std::string* err) {
102*9356374aSAndroid Build Coastguard Worker   auto strip_leading_space = [](absl::string_view* sv) {
103*9356374aSAndroid Build Coastguard Worker     while (!sv->empty()) {
104*9356374aSAndroid Build Coastguard Worker       if (!std::isspace(sv->front())) return;
105*9356374aSAndroid Build Coastguard Worker       sv->remove_prefix(1);
106*9356374aSAndroid Build Coastguard Worker     }
107*9356374aSAndroid Build Coastguard Worker   };
108*9356374aSAndroid Build Coastguard Worker 
109*9356374aSAndroid Build Coastguard Worker   // Portable toolchains means we don't get nice constexpr here.
110*9356374aSAndroid Build Coastguard Worker   struct Literal {
111*9356374aSAndroid Build Coastguard Worker     const char* name;
112*9356374aSAndroid Build Coastguard Worker     size_t size;
113*9356374aSAndroid Build Coastguard Worker     absl::Time value;
114*9356374aSAndroid Build Coastguard Worker   };
115*9356374aSAndroid Build Coastguard Worker   static Literal literals[] = {
116*9356374aSAndroid Build Coastguard Worker       {kInfiniteFutureStr, strlen(kInfiniteFutureStr), InfiniteFuture()},
117*9356374aSAndroid Build Coastguard Worker       {kInfinitePastStr, strlen(kInfinitePastStr), InfinitePast()},
118*9356374aSAndroid Build Coastguard Worker   };
119*9356374aSAndroid Build Coastguard Worker   strip_leading_space(&input);
120*9356374aSAndroid Build Coastguard Worker   for (const auto& lit : literals) {
121*9356374aSAndroid Build Coastguard Worker     if (absl::StartsWith(input, absl::string_view(lit.name, lit.size))) {
122*9356374aSAndroid Build Coastguard Worker       absl::string_view tail = input;
123*9356374aSAndroid Build Coastguard Worker       tail.remove_prefix(lit.size);
124*9356374aSAndroid Build Coastguard Worker       strip_leading_space(&tail);
125*9356374aSAndroid Build Coastguard Worker       if (tail.empty()) {
126*9356374aSAndroid Build Coastguard Worker         *time = lit.value;
127*9356374aSAndroid Build Coastguard Worker         return true;
128*9356374aSAndroid Build Coastguard Worker       }
129*9356374aSAndroid Build Coastguard Worker     }
130*9356374aSAndroid Build Coastguard Worker   }
131*9356374aSAndroid Build Coastguard Worker 
132*9356374aSAndroid Build Coastguard Worker   std::string error;
133*9356374aSAndroid Build Coastguard Worker   cctz_parts parts;
134*9356374aSAndroid Build Coastguard Worker   const bool b =
135*9356374aSAndroid Build Coastguard Worker       cctz::detail::parse(std::string(format), std::string(input),
136*9356374aSAndroid Build Coastguard Worker                           cctz::time_zone(tz), &parts.sec, &parts.fem, &error);
137*9356374aSAndroid Build Coastguard Worker   if (b) {
138*9356374aSAndroid Build Coastguard Worker     *time = Join(parts);
139*9356374aSAndroid Build Coastguard Worker   } else if (err != nullptr) {
140*9356374aSAndroid Build Coastguard Worker     *err = std::move(error);
141*9356374aSAndroid Build Coastguard Worker   }
142*9356374aSAndroid Build Coastguard Worker   return b;
143*9356374aSAndroid Build Coastguard Worker }
144*9356374aSAndroid Build Coastguard Worker 
145*9356374aSAndroid Build Coastguard Worker // Functions required to support absl::Time flags.
AbslParseFlag(absl::string_view text,absl::Time * t,std::string * error)146*9356374aSAndroid Build Coastguard Worker bool AbslParseFlag(absl::string_view text, absl::Time* t, std::string* error) {
147*9356374aSAndroid Build Coastguard Worker   return absl::ParseTime(RFC3339_full, text, absl::UTCTimeZone(), t, error);
148*9356374aSAndroid Build Coastguard Worker }
149*9356374aSAndroid Build Coastguard Worker 
AbslUnparseFlag(absl::Time t)150*9356374aSAndroid Build Coastguard Worker std::string AbslUnparseFlag(absl::Time t) {
151*9356374aSAndroid Build Coastguard Worker   return absl::FormatTime(RFC3339_full, t, absl::UTCTimeZone());
152*9356374aSAndroid Build Coastguard Worker }
ParseFlag(const std::string & text,absl::Time * t,std::string * error)153*9356374aSAndroid Build Coastguard Worker bool ParseFlag(const std::string& text, absl::Time* t, std::string* error) {
154*9356374aSAndroid Build Coastguard Worker   return absl::ParseTime(RFC3339_full, text, absl::UTCTimeZone(), t, error);
155*9356374aSAndroid Build Coastguard Worker }
156*9356374aSAndroid Build Coastguard Worker 
UnparseFlag(absl::Time t)157*9356374aSAndroid Build Coastguard Worker std::string UnparseFlag(absl::Time t) {
158*9356374aSAndroid Build Coastguard Worker   return absl::FormatTime(RFC3339_full, t, absl::UTCTimeZone());
159*9356374aSAndroid Build Coastguard Worker }
160*9356374aSAndroid Build Coastguard Worker 
161*9356374aSAndroid Build Coastguard Worker ABSL_NAMESPACE_END
162*9356374aSAndroid Build Coastguard Worker }  // namespace absl
163