pattern_formatter-inl.h 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338
  1. // Copyright(c) 2015-present, Gabi Melman & spdlog contributors.
  2. // Distributed under the MIT License (http://opensource.org/licenses/MIT)
  3. #pragma once
  4. #ifndef SPDLOG_HEADER_ONLY
  5. #include <spdlog/pattern_formatter.h>
  6. #endif
  7. #include <spdlog/details/fmt_helper.h>
  8. #include <spdlog/details/log_msg.h>
  9. #include <spdlog/details/os.h>
  10. #ifndef SPDLOG_NO_TLS
  11. #include <spdlog/mdc.h>
  12. #endif
  13. #include <spdlog/fmt/fmt.h>
  14. #include <spdlog/formatter.h>
  15. #include <algorithm>
  16. #include <array>
  17. #include <cctype>
  18. #include <chrono>
  19. #include <cstring>
  20. #include <ctime>
  21. #include <iterator>
  22. #include <memory>
  23. #include <mutex>
  24. #include <string>
  25. #include <thread>
  26. #include <utility>
  27. #include <vector>
  28. namespace spdlog {
  29. namespace details {
  30. ///////////////////////////////////////////////////////////////////////
  31. // name & level pattern appender
  32. ///////////////////////////////////////////////////////////////////////
  33. class scoped_padder {
  34. public:
  35. scoped_padder(size_t wrapped_size, const padding_info &padinfo, memory_buf_t &dest)
  36. : padinfo_(padinfo),
  37. dest_(dest) {
  38. remaining_pad_ = static_cast<long>(padinfo.width_) - static_cast<long>(wrapped_size);
  39. if (remaining_pad_ <= 0) {
  40. return;
  41. }
  42. if (padinfo_.side_ == padding_info::pad_side::left) {
  43. pad_it(remaining_pad_);
  44. remaining_pad_ = 0;
  45. } else if (padinfo_.side_ == padding_info::pad_side::center) {
  46. auto half_pad = remaining_pad_ / 2;
  47. auto reminder = remaining_pad_ & 1;
  48. pad_it(half_pad);
  49. remaining_pad_ = half_pad + reminder; // for the right side
  50. }
  51. }
  52. template <typename T>
  53. static unsigned int count_digits(T n) {
  54. return fmt_helper::count_digits(n);
  55. }
  56. ~scoped_padder() {
  57. if (remaining_pad_ >= 0) {
  58. pad_it(remaining_pad_);
  59. } else if (padinfo_.truncate_) {
  60. long new_size = static_cast<long>(dest_.size()) + remaining_pad_;
  61. dest_.resize(static_cast<size_t>(new_size));
  62. }
  63. }
  64. private:
  65. void pad_it(long count) {
  66. fmt_helper::append_string_view(string_view_t(spaces_.data(), static_cast<size_t>(count)),
  67. dest_);
  68. }
  69. const padding_info &padinfo_;
  70. memory_buf_t &dest_;
  71. long remaining_pad_;
  72. string_view_t spaces_{" ", 64};
  73. };
  74. struct null_scoped_padder {
  75. null_scoped_padder(size_t /*wrapped_size*/,
  76. const padding_info & /*padinfo*/,
  77. memory_buf_t & /*dest*/) {}
  78. template <typename T>
  79. static unsigned int count_digits(T /* number */) {
  80. return 0;
  81. }
  82. };
  83. template <typename ScopedPadder>
  84. class name_formatter final : public flag_formatter {
  85. public:
  86. explicit name_formatter(padding_info padinfo)
  87. : flag_formatter(padinfo) {}
  88. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  89. ScopedPadder p(msg.logger_name.size(), padinfo_, dest);
  90. fmt_helper::append_string_view(msg.logger_name, dest);
  91. }
  92. };
  93. // log level appender
  94. template <typename ScopedPadder>
  95. class level_formatter final : public flag_formatter {
  96. public:
  97. explicit level_formatter(padding_info padinfo)
  98. : flag_formatter(padinfo) {}
  99. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  100. const string_view_t &level_name = level::to_string_view(msg.level);
  101. ScopedPadder p(level_name.size(), padinfo_, dest);
  102. fmt_helper::append_string_view(level_name, dest);
  103. }
  104. };
  105. // short log level appender
  106. template <typename ScopedPadder>
  107. class short_level_formatter final : public flag_formatter {
  108. public:
  109. explicit short_level_formatter(padding_info padinfo)
  110. : flag_formatter(padinfo) {}
  111. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  112. string_view_t level_name{level::to_short_c_str(msg.level)};
  113. ScopedPadder p(level_name.size(), padinfo_, dest);
  114. fmt_helper::append_string_view(level_name, dest);
  115. }
  116. };
  117. ///////////////////////////////////////////////////////////////////////
  118. // Date time pattern appenders
  119. ///////////////////////////////////////////////////////////////////////
  120. static const char *ampm(const tm &t) { return t.tm_hour >= 12 ? "PM" : "AM"; }
  121. static int to12h(const tm &t) { return t.tm_hour > 12 ? t.tm_hour - 12 : t.tm_hour; }
  122. // Abbreviated weekday name
  123. static std::array<const char *, 7> days{{"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}};
  124. template <typename ScopedPadder>
  125. class a_formatter final : public flag_formatter {
  126. public:
  127. explicit a_formatter(padding_info padinfo)
  128. : flag_formatter(padinfo) {}
  129. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  130. string_view_t field_value{days[static_cast<size_t>(tm_time.tm_wday)]};
  131. ScopedPadder p(field_value.size(), padinfo_, dest);
  132. fmt_helper::append_string_view(field_value, dest);
  133. }
  134. };
  135. // Full weekday name
  136. static std::array<const char *, 7> full_days{
  137. {"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"}};
  138. template <typename ScopedPadder>
  139. class A_formatter : public flag_formatter {
  140. public:
  141. explicit A_formatter(padding_info padinfo)
  142. : flag_formatter(padinfo) {}
  143. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  144. string_view_t field_value{full_days[static_cast<size_t>(tm_time.tm_wday)]};
  145. ScopedPadder p(field_value.size(), padinfo_, dest);
  146. fmt_helper::append_string_view(field_value, dest);
  147. }
  148. };
  149. // Abbreviated month
  150. static const std::array<const char *, 12> months{
  151. {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"}};
  152. template <typename ScopedPadder>
  153. class b_formatter final : public flag_formatter {
  154. public:
  155. explicit b_formatter(padding_info padinfo)
  156. : flag_formatter(padinfo) {}
  157. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  158. string_view_t field_value{months[static_cast<size_t>(tm_time.tm_mon)]};
  159. ScopedPadder p(field_value.size(), padinfo_, dest);
  160. fmt_helper::append_string_view(field_value, dest);
  161. }
  162. };
  163. // Full month name
  164. static const std::array<const char *, 12> full_months{{"January", "February", "March", "April",
  165. "May", "June", "July", "August", "September",
  166. "October", "November", "December"}};
  167. template <typename ScopedPadder>
  168. class B_formatter final : public flag_formatter {
  169. public:
  170. explicit B_formatter(padding_info padinfo)
  171. : flag_formatter(padinfo) {}
  172. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  173. string_view_t field_value{full_months[static_cast<size_t>(tm_time.tm_mon)]};
  174. ScopedPadder p(field_value.size(), padinfo_, dest);
  175. fmt_helper::append_string_view(field_value, dest);
  176. }
  177. };
  178. // Date and time representation (Thu Aug 23 15:35:46 2014)
  179. template <typename ScopedPadder>
  180. class c_formatter final : public flag_formatter {
  181. public:
  182. explicit c_formatter(padding_info padinfo)
  183. : flag_formatter(padinfo) {}
  184. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  185. const size_t field_size = 24;
  186. ScopedPadder p(field_size, padinfo_, dest);
  187. fmt_helper::append_string_view(days[static_cast<size_t>(tm_time.tm_wday)], dest);
  188. dest.push_back(' ');
  189. fmt_helper::append_string_view(months[static_cast<size_t>(tm_time.tm_mon)], dest);
  190. dest.push_back(' ');
  191. fmt_helper::append_int(tm_time.tm_mday, dest);
  192. dest.push_back(' ');
  193. // time
  194. fmt_helper::pad2(tm_time.tm_hour, dest);
  195. dest.push_back(':');
  196. fmt_helper::pad2(tm_time.tm_min, dest);
  197. dest.push_back(':');
  198. fmt_helper::pad2(tm_time.tm_sec, dest);
  199. dest.push_back(' ');
  200. fmt_helper::append_int(tm_time.tm_year + 1900, dest);
  201. }
  202. };
  203. // year - 2 digit
  204. template <typename ScopedPadder>
  205. class C_formatter final : public flag_formatter {
  206. public:
  207. explicit C_formatter(padding_info padinfo)
  208. : flag_formatter(padinfo) {}
  209. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  210. const size_t field_size = 2;
  211. ScopedPadder p(field_size, padinfo_, dest);
  212. fmt_helper::pad2(tm_time.tm_year % 100, dest);
  213. }
  214. };
  215. // Short MM/DD/YY date, equivalent to %m/%d/%y 08/23/01
  216. template <typename ScopedPadder>
  217. class D_formatter final : public flag_formatter {
  218. public:
  219. explicit D_formatter(padding_info padinfo)
  220. : flag_formatter(padinfo) {}
  221. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  222. const size_t field_size = 10;
  223. ScopedPadder p(field_size, padinfo_, dest);
  224. fmt_helper::pad2(tm_time.tm_mon + 1, dest);
  225. dest.push_back('/');
  226. fmt_helper::pad2(tm_time.tm_mday, dest);
  227. dest.push_back('/');
  228. fmt_helper::pad2(tm_time.tm_year % 100, dest);
  229. }
  230. };
  231. // year - 4 digit
  232. template <typename ScopedPadder>
  233. class Y_formatter final : public flag_formatter {
  234. public:
  235. explicit Y_formatter(padding_info padinfo)
  236. : flag_formatter(padinfo) {}
  237. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  238. const size_t field_size = 4;
  239. ScopedPadder p(field_size, padinfo_, dest);
  240. fmt_helper::append_int(tm_time.tm_year + 1900, dest);
  241. }
  242. };
  243. // month 1-12
  244. template <typename ScopedPadder>
  245. class m_formatter final : public flag_formatter {
  246. public:
  247. explicit m_formatter(padding_info padinfo)
  248. : flag_formatter(padinfo) {}
  249. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  250. const size_t field_size = 2;
  251. ScopedPadder p(field_size, padinfo_, dest);
  252. fmt_helper::pad2(tm_time.tm_mon + 1, dest);
  253. }
  254. };
  255. // day of month 1-31
  256. template <typename ScopedPadder>
  257. class d_formatter final : public flag_formatter {
  258. public:
  259. explicit d_formatter(padding_info padinfo)
  260. : flag_formatter(padinfo) {}
  261. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  262. const size_t field_size = 2;
  263. ScopedPadder p(field_size, padinfo_, dest);
  264. fmt_helper::pad2(tm_time.tm_mday, dest);
  265. }
  266. };
  267. // hours in 24 format 0-23
  268. template <typename ScopedPadder>
  269. class H_formatter final : public flag_formatter {
  270. public:
  271. explicit H_formatter(padding_info padinfo)
  272. : flag_formatter(padinfo) {}
  273. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  274. const size_t field_size = 2;
  275. ScopedPadder p(field_size, padinfo_, dest);
  276. fmt_helper::pad2(tm_time.tm_hour, dest);
  277. }
  278. };
  279. // hours in 12 format 1-12
  280. template <typename ScopedPadder>
  281. class I_formatter final : public flag_formatter {
  282. public:
  283. explicit I_formatter(padding_info padinfo)
  284. : flag_formatter(padinfo) {}
  285. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  286. const size_t field_size = 2;
  287. ScopedPadder p(field_size, padinfo_, dest);
  288. fmt_helper::pad2(to12h(tm_time), dest);
  289. }
  290. };
  291. // minutes 0-59
  292. template <typename ScopedPadder>
  293. class M_formatter final : public flag_formatter {
  294. public:
  295. explicit M_formatter(padding_info padinfo)
  296. : flag_formatter(padinfo) {}
  297. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  298. const size_t field_size = 2;
  299. ScopedPadder p(field_size, padinfo_, dest);
  300. fmt_helper::pad2(tm_time.tm_min, dest);
  301. }
  302. };
  303. // seconds 0-59
  304. template <typename ScopedPadder>
  305. class S_formatter final : public flag_formatter {
  306. public:
  307. explicit S_formatter(padding_info padinfo)
  308. : flag_formatter(padinfo) {}
  309. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  310. const size_t field_size = 2;
  311. ScopedPadder p(field_size, padinfo_, dest);
  312. fmt_helper::pad2(tm_time.tm_sec, dest);
  313. }
  314. };
  315. // milliseconds
  316. template <typename ScopedPadder>
  317. class e_formatter final : public flag_formatter {
  318. public:
  319. explicit e_formatter(padding_info padinfo)
  320. : flag_formatter(padinfo) {}
  321. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  322. auto millis = fmt_helper::time_fraction<std::chrono::milliseconds>(msg.time);
  323. const size_t field_size = 3;
  324. ScopedPadder p(field_size, padinfo_, dest);
  325. fmt_helper::pad3(static_cast<uint32_t>(millis.count()), dest);
  326. }
  327. };
  328. // microseconds
  329. template <typename ScopedPadder>
  330. class f_formatter final : public flag_formatter {
  331. public:
  332. explicit f_formatter(padding_info padinfo)
  333. : flag_formatter(padinfo) {}
  334. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  335. auto micros = fmt_helper::time_fraction<std::chrono::microseconds>(msg.time);
  336. const size_t field_size = 6;
  337. ScopedPadder p(field_size, padinfo_, dest);
  338. fmt_helper::pad6(static_cast<size_t>(micros.count()), dest);
  339. }
  340. };
  341. // nanoseconds
  342. template <typename ScopedPadder>
  343. class F_formatter final : public flag_formatter {
  344. public:
  345. explicit F_formatter(padding_info padinfo)
  346. : flag_formatter(padinfo) {}
  347. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  348. auto ns = fmt_helper::time_fraction<std::chrono::nanoseconds>(msg.time);
  349. const size_t field_size = 9;
  350. ScopedPadder p(field_size, padinfo_, dest);
  351. fmt_helper::pad9(static_cast<size_t>(ns.count()), dest);
  352. }
  353. };
  354. // seconds since epoch
  355. template <typename ScopedPadder>
  356. class E_formatter final : public flag_formatter {
  357. public:
  358. explicit E_formatter(padding_info padinfo)
  359. : flag_formatter(padinfo) {}
  360. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  361. const size_t field_size = 10;
  362. ScopedPadder p(field_size, padinfo_, dest);
  363. auto duration = msg.time.time_since_epoch();
  364. auto seconds = std::chrono::duration_cast<std::chrono::seconds>(duration).count();
  365. fmt_helper::append_int(seconds, dest);
  366. }
  367. };
  368. // AM/PM
  369. template <typename ScopedPadder>
  370. class p_formatter final : public flag_formatter {
  371. public:
  372. explicit p_formatter(padding_info padinfo)
  373. : flag_formatter(padinfo) {}
  374. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  375. const size_t field_size = 2;
  376. ScopedPadder p(field_size, padinfo_, dest);
  377. fmt_helper::append_string_view(ampm(tm_time), dest);
  378. }
  379. };
  380. // 12 hour clock 02:55:02 pm
  381. template <typename ScopedPadder>
  382. class r_formatter final : public flag_formatter {
  383. public:
  384. explicit r_formatter(padding_info padinfo)
  385. : flag_formatter(padinfo) {}
  386. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  387. const size_t field_size = 11;
  388. ScopedPadder p(field_size, padinfo_, dest);
  389. fmt_helper::pad2(to12h(tm_time), dest);
  390. dest.push_back(':');
  391. fmt_helper::pad2(tm_time.tm_min, dest);
  392. dest.push_back(':');
  393. fmt_helper::pad2(tm_time.tm_sec, dest);
  394. dest.push_back(' ');
  395. fmt_helper::append_string_view(ampm(tm_time), dest);
  396. }
  397. };
  398. // 24-hour HH:MM time, equivalent to %H:%M
  399. template <typename ScopedPadder>
  400. class R_formatter final : public flag_formatter {
  401. public:
  402. explicit R_formatter(padding_info padinfo)
  403. : flag_formatter(padinfo) {}
  404. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  405. const size_t field_size = 5;
  406. ScopedPadder p(field_size, padinfo_, dest);
  407. fmt_helper::pad2(tm_time.tm_hour, dest);
  408. dest.push_back(':');
  409. fmt_helper::pad2(tm_time.tm_min, dest);
  410. }
  411. };
  412. // ISO 8601 time format (HH:MM:SS), equivalent to %H:%M:%S
  413. template <typename ScopedPadder>
  414. class T_formatter final : public flag_formatter {
  415. public:
  416. explicit T_formatter(padding_info padinfo)
  417. : flag_formatter(padinfo) {}
  418. void format(const details::log_msg &, const std::tm &tm_time, memory_buf_t &dest) override {
  419. const size_t field_size = 8;
  420. ScopedPadder p(field_size, padinfo_, dest);
  421. fmt_helper::pad2(tm_time.tm_hour, dest);
  422. dest.push_back(':');
  423. fmt_helper::pad2(tm_time.tm_min, dest);
  424. dest.push_back(':');
  425. fmt_helper::pad2(tm_time.tm_sec, dest);
  426. }
  427. };
  428. // ISO 8601 offset from UTC in timezone (+-HH:MM)
  429. template <typename ScopedPadder>
  430. class z_formatter final : public flag_formatter {
  431. public:
  432. explicit z_formatter(padding_info padinfo)
  433. : flag_formatter(padinfo) {}
  434. z_formatter() = default;
  435. z_formatter(const z_formatter &) = delete;
  436. z_formatter &operator=(const z_formatter &) = delete;
  437. void format(const details::log_msg &msg, const std::tm &tm_time, memory_buf_t &dest) override {
  438. const size_t field_size = 6;
  439. ScopedPadder p(field_size, padinfo_, dest);
  440. auto total_minutes = get_cached_offset(msg, tm_time);
  441. bool is_negative = total_minutes < 0;
  442. if (is_negative) {
  443. total_minutes = -total_minutes;
  444. dest.push_back('-');
  445. } else {
  446. dest.push_back('+');
  447. }
  448. fmt_helper::pad2(total_minutes / 60, dest); // hours
  449. dest.push_back(':');
  450. fmt_helper::pad2(total_minutes % 60, dest); // minutes
  451. }
  452. private:
  453. log_clock::time_point last_update_{std::chrono::seconds(0)};
  454. int offset_minutes_{0};
  455. int get_cached_offset(const log_msg &msg, const std::tm &tm_time) {
  456. // refresh every 10 seconds
  457. if (msg.time - last_update_ >= std::chrono::seconds(10)) {
  458. offset_minutes_ = os::utc_minutes_offset(tm_time);
  459. last_update_ = msg.time;
  460. }
  461. return offset_minutes_;
  462. }
  463. };
  464. // Thread id
  465. template <typename ScopedPadder>
  466. class t_formatter final : public flag_formatter {
  467. public:
  468. explicit t_formatter(padding_info padinfo)
  469. : flag_formatter(padinfo) {}
  470. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  471. const auto field_size = ScopedPadder::count_digits(msg.thread_id);
  472. ScopedPadder p(field_size, padinfo_, dest);
  473. fmt_helper::append_int(msg.thread_id, dest);
  474. }
  475. };
  476. // Current pid
  477. template <typename ScopedPadder>
  478. class pid_formatter final : public flag_formatter {
  479. public:
  480. explicit pid_formatter(padding_info padinfo)
  481. : flag_formatter(padinfo) {}
  482. void format(const details::log_msg &, const std::tm &, memory_buf_t &dest) override {
  483. const auto pid = static_cast<uint32_t>(details::os::pid());
  484. auto field_size = ScopedPadder::count_digits(pid);
  485. ScopedPadder p(field_size, padinfo_, dest);
  486. fmt_helper::append_int(pid, dest);
  487. }
  488. };
  489. template <typename ScopedPadder>
  490. class v_formatter final : public flag_formatter {
  491. public:
  492. explicit v_formatter(padding_info padinfo)
  493. : flag_formatter(padinfo) {}
  494. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  495. ScopedPadder p(msg.payload.size(), padinfo_, dest);
  496. fmt_helper::append_string_view(msg.payload, dest);
  497. }
  498. };
  499. class ch_formatter final : public flag_formatter {
  500. public:
  501. explicit ch_formatter(char ch)
  502. : ch_(ch) {}
  503. void format(const details::log_msg &, const std::tm &, memory_buf_t &dest) override {
  504. dest.push_back(ch_);
  505. }
  506. private:
  507. char ch_;
  508. };
  509. // aggregate user chars to display as is
  510. class aggregate_formatter final : public flag_formatter {
  511. public:
  512. aggregate_formatter() = default;
  513. void add_ch(char ch) { str_ += ch; }
  514. void format(const details::log_msg &, const std::tm &, memory_buf_t &dest) override {
  515. fmt_helper::append_string_view(str_, dest);
  516. }
  517. private:
  518. std::string str_;
  519. };
  520. // mark the color range. expect it to be in the form of "%^colored text%$"
  521. class color_start_formatter final : public flag_formatter {
  522. public:
  523. explicit color_start_formatter(padding_info padinfo)
  524. : flag_formatter(padinfo) {}
  525. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  526. msg.color_range_start = dest.size();
  527. }
  528. };
  529. class color_stop_formatter final : public flag_formatter {
  530. public:
  531. explicit color_stop_formatter(padding_info padinfo)
  532. : flag_formatter(padinfo) {}
  533. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  534. msg.color_range_end = dest.size();
  535. }
  536. };
  537. // print source location
  538. template <typename ScopedPadder>
  539. class source_location_formatter final : public flag_formatter {
  540. public:
  541. explicit source_location_formatter(padding_info padinfo)
  542. : flag_formatter(padinfo) {}
  543. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  544. if (msg.source.empty()) {
  545. ScopedPadder p(0, padinfo_, dest);
  546. return;
  547. }
  548. size_t text_size;
  549. if (padinfo_.enabled()) {
  550. // calc text size for padding based on "filename:line"
  551. text_size = std::char_traits<char>::length(msg.source.filename) +
  552. ScopedPadder::count_digits(msg.source.line) + 1;
  553. } else {
  554. text_size = 0;
  555. }
  556. ScopedPadder p(text_size, padinfo_, dest);
  557. fmt_helper::append_string_view(msg.source.filename, dest);
  558. dest.push_back(':');
  559. fmt_helper::append_int(msg.source.line, dest);
  560. }
  561. };
  562. // print source filename
  563. template <typename ScopedPadder>
  564. class source_filename_formatter final : public flag_formatter {
  565. public:
  566. explicit source_filename_formatter(padding_info padinfo)
  567. : flag_formatter(padinfo) {}
  568. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  569. if (msg.source.empty()) {
  570. ScopedPadder p(0, padinfo_, dest);
  571. return;
  572. }
  573. size_t text_size =
  574. padinfo_.enabled() ? std::char_traits<char>::length(msg.source.filename) : 0;
  575. ScopedPadder p(text_size, padinfo_, dest);
  576. fmt_helper::append_string_view(msg.source.filename, dest);
  577. }
  578. };
  579. template <typename ScopedPadder>
  580. class short_filename_formatter final : public flag_formatter {
  581. public:
  582. explicit short_filename_formatter(padding_info padinfo)
  583. : flag_formatter(padinfo) {}
  584. #ifdef _MSC_VER
  585. #pragma warning(push)
  586. #pragma warning(disable : 4127) // consider using 'if constexpr' instead
  587. #endif // _MSC_VER
  588. static const char *basename(const char *filename) {
  589. // if the size is 2 (1 character + null terminator) we can use the more efficient strrchr
  590. // the branch will be elided by optimizations
  591. if (sizeof(os::folder_seps) == 2) {
  592. const char *rv = std::strrchr(filename, os::folder_seps[0]);
  593. return rv != nullptr ? rv + 1 : filename;
  594. } else {
  595. const std::reverse_iterator<const char *> begin(filename + std::strlen(filename));
  596. const std::reverse_iterator<const char *> end(filename);
  597. const auto it = std::find_first_of(begin, end, std::begin(os::folder_seps),
  598. std::end(os::folder_seps) - 1);
  599. return it != end ? it.base() : filename;
  600. }
  601. }
  602. #ifdef _MSC_VER
  603. #pragma warning(pop)
  604. #endif // _MSC_VER
  605. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  606. if (msg.source.empty()) {
  607. ScopedPadder p(0, padinfo_, dest);
  608. return;
  609. }
  610. auto filename = basename(msg.source.filename);
  611. size_t text_size = padinfo_.enabled() ? std::char_traits<char>::length(filename) : 0;
  612. ScopedPadder p(text_size, padinfo_, dest);
  613. fmt_helper::append_string_view(filename, dest);
  614. }
  615. };
  616. template <typename ScopedPadder>
  617. class source_linenum_formatter final : public flag_formatter {
  618. public:
  619. explicit source_linenum_formatter(padding_info padinfo)
  620. : flag_formatter(padinfo) {}
  621. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  622. if (msg.source.empty()) {
  623. ScopedPadder p(0, padinfo_, dest);
  624. return;
  625. }
  626. auto field_size = ScopedPadder::count_digits(msg.source.line);
  627. ScopedPadder p(field_size, padinfo_, dest);
  628. fmt_helper::append_int(msg.source.line, dest);
  629. }
  630. };
  631. // print source funcname
  632. template <typename ScopedPadder>
  633. class source_funcname_formatter final : public flag_formatter {
  634. public:
  635. explicit source_funcname_formatter(padding_info padinfo)
  636. : flag_formatter(padinfo) {}
  637. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  638. if (msg.source.empty()) {
  639. ScopedPadder p(0, padinfo_, dest);
  640. return;
  641. }
  642. size_t text_size =
  643. padinfo_.enabled() ? std::char_traits<char>::length(msg.source.funcname) : 0;
  644. ScopedPadder p(text_size, padinfo_, dest);
  645. fmt_helper::append_string_view(msg.source.funcname, dest);
  646. }
  647. };
  648. // print elapsed time since last message
  649. template <typename ScopedPadder, typename Units>
  650. class elapsed_formatter final : public flag_formatter {
  651. public:
  652. using DurationUnits = Units;
  653. explicit elapsed_formatter(padding_info padinfo)
  654. : flag_formatter(padinfo),
  655. last_message_time_(log_clock::now()) {}
  656. void format(const details::log_msg &msg, const std::tm &, memory_buf_t &dest) override {
  657. auto delta = (std::max)(msg.time - last_message_time_, log_clock::duration::zero());
  658. auto delta_units = std::chrono::duration_cast<DurationUnits>(delta);
  659. last_message_time_ = msg.time;
  660. auto delta_count = static_cast<size_t>(delta_units.count());
  661. auto n_digits = static_cast<size_t>(ScopedPadder::count_digits(delta_count));
  662. ScopedPadder p(n_digits, padinfo_, dest);
  663. fmt_helper::append_int(delta_count, dest);
  664. }
  665. private:
  666. log_clock::time_point last_message_time_;
  667. };
  668. // Class for formatting Mapped Diagnostic Context (MDC) in log messages.
  669. // Example: [logger-name] [info] [mdc_key_1:mdc_value_1 mdc_key_2:mdc_value_2] some message
  670. #ifndef SPDLOG_NO_TLS
  671. template <typename ScopedPadder>
  672. class mdc_formatter : public flag_formatter {
  673. public:
  674. explicit mdc_formatter(padding_info padinfo)
  675. : flag_formatter(padinfo) {}
  676. void format(const details::log_msg &, const std::tm &, memory_buf_t &dest) override {
  677. auto &mdc_map = mdc::get_context();
  678. if (mdc_map.empty()) {
  679. ScopedPadder p(0, padinfo_, dest);
  680. return;
  681. } else {
  682. format_mdc(mdc_map, dest);
  683. }
  684. }
  685. void format_mdc(const mdc::mdc_map_t &mdc_map, memory_buf_t &dest) {
  686. auto last_element = --mdc_map.end();
  687. for (auto it = mdc_map.begin(); it != mdc_map.end(); ++it) {
  688. auto &pair = *it;
  689. const auto &key = pair.first;
  690. const auto &value = pair.second;
  691. size_t content_size = key.size() + value.size() + 1; // 1 for ':'
  692. if (it != last_element) {
  693. content_size++; // 1 for ' '
  694. }
  695. ScopedPadder p(content_size, padinfo_, dest);
  696. fmt_helper::append_string_view(key, dest);
  697. fmt_helper::append_string_view(":", dest);
  698. fmt_helper::append_string_view(value, dest);
  699. if (it != last_element) {
  700. fmt_helper::append_string_view(" ", dest);
  701. }
  702. }
  703. }
  704. };
  705. #endif
  706. // Full info formatter
  707. // pattern: [%Y-%m-%d %H:%M:%S.%e] [%n] [%l] [%s:%#] %v
  708. class full_formatter final : public flag_formatter {
  709. public:
  710. explicit full_formatter(padding_info padinfo)
  711. : flag_formatter(padinfo) {}
  712. void format(const details::log_msg &msg, const std::tm &tm_time, memory_buf_t &dest) override {
  713. using std::chrono::duration_cast;
  714. using std::chrono::milliseconds;
  715. using std::chrono::seconds;
  716. // cache the date/time part for the next second.
  717. auto duration = msg.time.time_since_epoch();
  718. auto secs = duration_cast<seconds>(duration);
  719. if (cache_timestamp_ != secs || cached_datetime_.size() == 0) {
  720. cached_datetime_.clear();
  721. cached_datetime_.push_back('[');
  722. fmt_helper::append_int(tm_time.tm_year + 1900, cached_datetime_);
  723. cached_datetime_.push_back('-');
  724. fmt_helper::pad2(tm_time.tm_mon + 1, cached_datetime_);
  725. cached_datetime_.push_back('-');
  726. fmt_helper::pad2(tm_time.tm_mday, cached_datetime_);
  727. cached_datetime_.push_back(' ');
  728. fmt_helper::pad2(tm_time.tm_hour, cached_datetime_);
  729. cached_datetime_.push_back(':');
  730. fmt_helper::pad2(tm_time.tm_min, cached_datetime_);
  731. cached_datetime_.push_back(':');
  732. fmt_helper::pad2(tm_time.tm_sec, cached_datetime_);
  733. cached_datetime_.push_back('.');
  734. cache_timestamp_ = secs;
  735. }
  736. dest.append(cached_datetime_.begin(), cached_datetime_.end());
  737. auto millis = fmt_helper::time_fraction<milliseconds>(msg.time);
  738. fmt_helper::pad3(static_cast<uint32_t>(millis.count()), dest);
  739. dest.push_back(']');
  740. dest.push_back(' ');
  741. // append logger name if exists
  742. if (msg.logger_name.size() > 0) {
  743. dest.push_back('[');
  744. fmt_helper::append_string_view(msg.logger_name, dest);
  745. dest.push_back(']');
  746. dest.push_back(' ');
  747. }
  748. dest.push_back('[');
  749. // wrap the level name with color
  750. msg.color_range_start = dest.size();
  751. // fmt_helper::append_string_view(level::to_c_str(msg.level), dest);
  752. fmt_helper::append_string_view(level::to_string_view(msg.level), dest);
  753. msg.color_range_end = dest.size();
  754. dest.push_back(']');
  755. dest.push_back(' ');
  756. // add source location if present
  757. if (!msg.source.empty()) {
  758. dest.push_back('[');
  759. const char *filename =
  760. details::short_filename_formatter<details::null_scoped_padder>::basename(
  761. msg.source.filename);
  762. fmt_helper::append_string_view(filename, dest);
  763. dest.push_back(':');
  764. fmt_helper::append_int(msg.source.line, dest);
  765. dest.push_back(']');
  766. dest.push_back(' ');
  767. }
  768. #ifndef SPDLOG_NO_TLS
  769. // add mdc if present
  770. auto &mdc_map = mdc::get_context();
  771. if (!mdc_map.empty()) {
  772. dest.push_back('[');
  773. mdc_formatter_.format_mdc(mdc_map, dest);
  774. dest.push_back(']');
  775. dest.push_back(' ');
  776. }
  777. #endif
  778. // fmt_helper::append_string_view(msg.msg(), dest);
  779. fmt_helper::append_string_view(msg.payload, dest);
  780. }
  781. private:
  782. std::chrono::seconds cache_timestamp_{0};
  783. memory_buf_t cached_datetime_;
  784. #ifndef SPDLOG_NO_TLS
  785. mdc_formatter<null_scoped_padder> mdc_formatter_{padding_info{}};
  786. #endif
  787. };
  788. } // namespace details
  789. SPDLOG_INLINE pattern_formatter::pattern_formatter(std::string pattern,
  790. pattern_time_type time_type,
  791. std::string eol,
  792. custom_flags custom_user_flags)
  793. : pattern_(std::move(pattern)),
  794. eol_(std::move(eol)),
  795. pattern_time_type_(time_type),
  796. need_localtime_(false),
  797. last_log_secs_(0),
  798. custom_handlers_(std::move(custom_user_flags)) {
  799. std::memset(&cached_tm_, 0, sizeof(cached_tm_));
  800. compile_pattern_(pattern_);
  801. }
  802. // use by default full formatter for if pattern is not given
  803. SPDLOG_INLINE pattern_formatter::pattern_formatter(pattern_time_type time_type, std::string eol)
  804. : pattern_("%+"),
  805. eol_(std::move(eol)),
  806. pattern_time_type_(time_type),
  807. need_localtime_(true),
  808. last_log_secs_(0) {
  809. std::memset(&cached_tm_, 0, sizeof(cached_tm_));
  810. formatters_.push_back(details::make_unique<details::full_formatter>(details::padding_info{}));
  811. }
  812. SPDLOG_INLINE std::unique_ptr<formatter> pattern_formatter::clone() const {
  813. custom_flags cloned_custom_formatters;
  814. for (auto &it : custom_handlers_) {
  815. cloned_custom_formatters[it.first] = it.second->clone();
  816. }
  817. auto cloned = details::make_unique<pattern_formatter>(pattern_, pattern_time_type_, eol_,
  818. std::move(cloned_custom_formatters));
  819. cloned->need_localtime(need_localtime_);
  820. #if defined(__GNUC__) && __GNUC__ < 5
  821. return std::move(cloned);
  822. #else
  823. return cloned;
  824. #endif
  825. }
  826. SPDLOG_INLINE void pattern_formatter::format(const details::log_msg &msg, memory_buf_t &dest) {
  827. if (need_localtime_) {
  828. const auto secs =
  829. std::chrono::duration_cast<std::chrono::seconds>(msg.time.time_since_epoch());
  830. if (secs != last_log_secs_) {
  831. cached_tm_ = get_time_(msg);
  832. last_log_secs_ = secs;
  833. }
  834. }
  835. for (auto &f : formatters_) {
  836. f->format(msg, cached_tm_, dest);
  837. }
  838. // write eol
  839. details::fmt_helper::append_string_view(eol_, dest);
  840. }
  841. SPDLOG_INLINE void pattern_formatter::set_pattern(std::string pattern) {
  842. pattern_ = std::move(pattern);
  843. need_localtime_ = false;
  844. compile_pattern_(pattern_);
  845. }
  846. SPDLOG_INLINE void pattern_formatter::need_localtime(bool need) { need_localtime_ = need; }
  847. SPDLOG_INLINE std::tm pattern_formatter::get_time_(const details::log_msg &msg) {
  848. if (pattern_time_type_ == pattern_time_type::local) {
  849. return details::os::localtime(log_clock::to_time_t(msg.time));
  850. }
  851. return details::os::gmtime(log_clock::to_time_t(msg.time));
  852. }
  853. template <typename Padder>
  854. SPDLOG_INLINE void pattern_formatter::handle_flag_(char flag, details::padding_info padding) {
  855. // process custom flags
  856. auto it = custom_handlers_.find(flag);
  857. if (it != custom_handlers_.end()) {
  858. auto custom_handler = it->second->clone();
  859. custom_handler->set_padding_info(padding);
  860. formatters_.push_back(std::move(custom_handler));
  861. return;
  862. }
  863. // process built-in flags
  864. switch (flag) {
  865. case ('+'): // default formatter
  866. formatters_.push_back(details::make_unique<details::full_formatter>(padding));
  867. need_localtime_ = true;
  868. break;
  869. case 'n': // logger name
  870. formatters_.push_back(details::make_unique<details::name_formatter<Padder>>(padding));
  871. break;
  872. case 'l': // level
  873. formatters_.push_back(details::make_unique<details::level_formatter<Padder>>(padding));
  874. break;
  875. case 'L': // short level
  876. formatters_.push_back(
  877. details::make_unique<details::short_level_formatter<Padder>>(padding));
  878. break;
  879. case ('t'): // thread id
  880. formatters_.push_back(details::make_unique<details::t_formatter<Padder>>(padding));
  881. break;
  882. case ('v'): // the message text
  883. formatters_.push_back(details::make_unique<details::v_formatter<Padder>>(padding));
  884. break;
  885. case ('a'): // weekday
  886. formatters_.push_back(details::make_unique<details::a_formatter<Padder>>(padding));
  887. need_localtime_ = true;
  888. break;
  889. case ('A'): // short weekday
  890. formatters_.push_back(details::make_unique<details::A_formatter<Padder>>(padding));
  891. need_localtime_ = true;
  892. break;
  893. case ('b'):
  894. case ('h'): // month
  895. formatters_.push_back(details::make_unique<details::b_formatter<Padder>>(padding));
  896. need_localtime_ = true;
  897. break;
  898. case ('B'): // short month
  899. formatters_.push_back(details::make_unique<details::B_formatter<Padder>>(padding));
  900. need_localtime_ = true;
  901. break;
  902. case ('c'): // datetime
  903. formatters_.push_back(details::make_unique<details::c_formatter<Padder>>(padding));
  904. need_localtime_ = true;
  905. break;
  906. case ('C'): // year 2 digits
  907. formatters_.push_back(details::make_unique<details::C_formatter<Padder>>(padding));
  908. need_localtime_ = true;
  909. break;
  910. case ('Y'): // year 4 digits
  911. formatters_.push_back(details::make_unique<details::Y_formatter<Padder>>(padding));
  912. need_localtime_ = true;
  913. break;
  914. case ('D'):
  915. case ('x'): // datetime MM/DD/YY
  916. formatters_.push_back(details::make_unique<details::D_formatter<Padder>>(padding));
  917. need_localtime_ = true;
  918. break;
  919. case ('m'): // month 1-12
  920. formatters_.push_back(details::make_unique<details::m_formatter<Padder>>(padding));
  921. need_localtime_ = true;
  922. break;
  923. case ('d'): // day of month 1-31
  924. formatters_.push_back(details::make_unique<details::d_formatter<Padder>>(padding));
  925. need_localtime_ = true;
  926. break;
  927. case ('H'): // hours 24
  928. formatters_.push_back(details::make_unique<details::H_formatter<Padder>>(padding));
  929. need_localtime_ = true;
  930. break;
  931. case ('I'): // hours 12
  932. formatters_.push_back(details::make_unique<details::I_formatter<Padder>>(padding));
  933. need_localtime_ = true;
  934. break;
  935. case ('M'): // minutes
  936. formatters_.push_back(details::make_unique<details::M_formatter<Padder>>(padding));
  937. need_localtime_ = true;
  938. break;
  939. case ('S'): // seconds
  940. formatters_.push_back(details::make_unique<details::S_formatter<Padder>>(padding));
  941. need_localtime_ = true;
  942. break;
  943. case ('e'): // milliseconds
  944. formatters_.push_back(details::make_unique<details::e_formatter<Padder>>(padding));
  945. break;
  946. case ('f'): // microseconds
  947. formatters_.push_back(details::make_unique<details::f_formatter<Padder>>(padding));
  948. break;
  949. case ('F'): // nanoseconds
  950. formatters_.push_back(details::make_unique<details::F_formatter<Padder>>(padding));
  951. break;
  952. case ('E'): // seconds since epoch
  953. formatters_.push_back(details::make_unique<details::E_formatter<Padder>>(padding));
  954. break;
  955. case ('p'): // am/pm
  956. formatters_.push_back(details::make_unique<details::p_formatter<Padder>>(padding));
  957. need_localtime_ = true;
  958. break;
  959. case ('r'): // 12 hour clock 02:55:02 pm
  960. formatters_.push_back(details::make_unique<details::r_formatter<Padder>>(padding));
  961. need_localtime_ = true;
  962. break;
  963. case ('R'): // 24-hour HH:MM time
  964. formatters_.push_back(details::make_unique<details::R_formatter<Padder>>(padding));
  965. need_localtime_ = true;
  966. break;
  967. case ('T'):
  968. case ('X'): // ISO 8601 time format (HH:MM:SS)
  969. formatters_.push_back(details::make_unique<details::T_formatter<Padder>>(padding));
  970. need_localtime_ = true;
  971. break;
  972. case ('z'): // timezone
  973. formatters_.push_back(details::make_unique<details::z_formatter<Padder>>(padding));
  974. need_localtime_ = true;
  975. break;
  976. case ('P'): // pid
  977. formatters_.push_back(details::make_unique<details::pid_formatter<Padder>>(padding));
  978. break;
  979. case ('^'): // color range start
  980. formatters_.push_back(details::make_unique<details::color_start_formatter>(padding));
  981. break;
  982. case ('$'): // color range end
  983. formatters_.push_back(details::make_unique<details::color_stop_formatter>(padding));
  984. break;
  985. case ('@'): // source location (filename:filenumber)
  986. formatters_.push_back(
  987. details::make_unique<details::source_location_formatter<Padder>>(padding));
  988. break;
  989. case ('s'): // short source filename - without directory name
  990. formatters_.push_back(
  991. details::make_unique<details::short_filename_formatter<Padder>>(padding));
  992. break;
  993. case ('g'): // full source filename
  994. formatters_.push_back(
  995. details::make_unique<details::source_filename_formatter<Padder>>(padding));
  996. break;
  997. case ('#'): // source line number
  998. formatters_.push_back(
  999. details::make_unique<details::source_linenum_formatter<Padder>>(padding));
  1000. break;
  1001. case ('!'): // source funcname
  1002. formatters_.push_back(
  1003. details::make_unique<details::source_funcname_formatter<Padder>>(padding));
  1004. break;
  1005. case ('%'): // % char
  1006. formatters_.push_back(details::make_unique<details::ch_formatter>('%'));
  1007. break;
  1008. case ('u'): // elapsed time since last log message in nanos
  1009. formatters_.push_back(
  1010. details::make_unique<details::elapsed_formatter<Padder, std::chrono::nanoseconds>>(
  1011. padding));
  1012. break;
  1013. case ('i'): // elapsed time since last log message in micros
  1014. formatters_.push_back(
  1015. details::make_unique<details::elapsed_formatter<Padder, std::chrono::microseconds>>(
  1016. padding));
  1017. break;
  1018. case ('o'): // elapsed time since last log message in millis
  1019. formatters_.push_back(
  1020. details::make_unique<details::elapsed_formatter<Padder, std::chrono::milliseconds>>(
  1021. padding));
  1022. break;
  1023. case ('O'): // elapsed time since last log message in seconds
  1024. formatters_.push_back(
  1025. details::make_unique<details::elapsed_formatter<Padder, std::chrono::seconds>>(
  1026. padding));
  1027. break;
  1028. #ifndef SPDLOG_NO_TLS // mdc formatter requires TLS support
  1029. case ('&'):
  1030. formatters_.push_back(details::make_unique<details::mdc_formatter<Padder>>(padding));
  1031. break;
  1032. #endif
  1033. default: // Unknown flag appears as is
  1034. auto unknown_flag = details::make_unique<details::aggregate_formatter>();
  1035. if (!padding.truncate_) {
  1036. unknown_flag->add_ch('%');
  1037. unknown_flag->add_ch(flag);
  1038. formatters_.push_back((std::move(unknown_flag)));
  1039. }
  1040. // fix issue #1617 (prev char was '!' and should have been treated as funcname flag
  1041. // instead of truncating flag) spdlog::set_pattern("[%10!] %v") => "[ main] some
  1042. // message" spdlog::set_pattern("[%3!!] %v") => "[mai] some message"
  1043. else {
  1044. padding.truncate_ = false;
  1045. formatters_.push_back(
  1046. details::make_unique<details::source_funcname_formatter<Padder>>(padding));
  1047. unknown_flag->add_ch(flag);
  1048. formatters_.push_back((std::move(unknown_flag)));
  1049. }
  1050. break;
  1051. }
  1052. }
  1053. // Extract given pad spec (e.g. %8X, %=8X, %-8!X, %8!X, %=8!X, %-8!X, %+8!X)
  1054. // Advance the given it pass the end of the padding spec found (if any)
  1055. // Return padding.
  1056. SPDLOG_INLINE details::padding_info pattern_formatter::handle_padspec_(
  1057. std::string::const_iterator &it, std::string::const_iterator end) {
  1058. using details::padding_info;
  1059. using details::scoped_padder;
  1060. const size_t max_width = 64;
  1061. if (it == end) {
  1062. return padding_info{};
  1063. }
  1064. padding_info::pad_side side;
  1065. switch (*it) {
  1066. case '-':
  1067. side = padding_info::pad_side::right;
  1068. ++it;
  1069. break;
  1070. case '=':
  1071. side = padding_info::pad_side::center;
  1072. ++it;
  1073. break;
  1074. default:
  1075. side = details::padding_info::pad_side::left;
  1076. break;
  1077. }
  1078. if (it == end || !std::isdigit(static_cast<unsigned char>(*it))) {
  1079. return padding_info{}; // no padding if no digit found here
  1080. }
  1081. auto width = static_cast<size_t>(*it) - '0';
  1082. for (++it; it != end && std::isdigit(static_cast<unsigned char>(*it)); ++it) {
  1083. auto digit = static_cast<size_t>(*it) - '0';
  1084. width = width * 10 + digit;
  1085. }
  1086. // search for the optional truncate marker '!'
  1087. bool truncate;
  1088. if (it != end && *it == '!') {
  1089. truncate = true;
  1090. ++it;
  1091. } else {
  1092. truncate = false;
  1093. }
  1094. return details::padding_info{std::min<size_t>(width, max_width), side, truncate};
  1095. }
  1096. SPDLOG_INLINE void pattern_formatter::compile_pattern_(const std::string &pattern) {
  1097. auto end = pattern.end();
  1098. std::unique_ptr<details::aggregate_formatter> user_chars;
  1099. formatters_.clear();
  1100. for (auto it = pattern.begin(); it != end; ++it) {
  1101. if (*it == '%') {
  1102. if (user_chars) // append user chars found so far
  1103. {
  1104. formatters_.push_back(std::move(user_chars));
  1105. }
  1106. auto padding = handle_padspec_(++it, end);
  1107. if (it != end) {
  1108. if (padding.enabled()) {
  1109. handle_flag_<details::scoped_padder>(*it, padding);
  1110. } else {
  1111. handle_flag_<details::null_scoped_padder>(*it, padding);
  1112. }
  1113. } else {
  1114. break;
  1115. }
  1116. } else // chars not following the % sign should be displayed as is
  1117. {
  1118. if (!user_chars) {
  1119. user_chars = details::make_unique<details::aggregate_formatter>();
  1120. }
  1121. user_chars->add_ch(*it);
  1122. }
  1123. }
  1124. if (user_chars) // append raw chars found so far
  1125. {
  1126. formatters_.push_back(std::move(user_chars));
  1127. }
  1128. }
  1129. } // namespace spdlog