lib/libc/stdtime/strftime.c

   1 /*
   2  * @(#)strftime.c       8.3
   3  * $NetBSD: src/lib/libc/time/strftime.c,v 1.16 2004/05/12 23:03:11 kleink Exp $
   4  * $DragonFly: src/lib/libc/stdtime/strftime.c,v 1.7 2008/10/19 20:15:58 swildner Exp $
   5  */
   6
   7 /*
   8 ** Based on the UCB version with the ID appearing below.
   9 ** This is ANSIish only when "multibyte character == plain character".
  10 */
  11
  12 /*
  13 ** We don't use these extensions in strftime operation even when
  14 ** supported by the local tzcode configuration.  A strictly
  15 ** conforming C application may leave them in undefined state.
  16 */
  17
  18 #ifdef _LIBC
  19 #undef TM_ZONE
  20 #undef TM_GMTOFF
  21 #endif
  22
  23 /*
  24 ** Copyright (c) 1989, 1993
  25 **      The Regents of the University of California.  All rights reserved.
  26 **
  27 ** Redistribution and use in source and binary forms, with or without
  28 ** modification, are permitted provided that the following conditions
  29 ** are met:
  30 ** 1. Redistributions of source code must retain the above copyright
  31 **    notice, this list of conditions and the following disclaimer.
  32 ** 2. Redistributions in binary form must reproduce the above copyright
  33 **    notice, this list of conditions and the following disclaimer in the
  34 **    documentation and/or other materials provided with the distribution.
  35 ** 3. All advertising materials mentioning features or use of this software
  36 **    must display the following acknowledgement:
  37 **      This product includes software developed by the University of
  38 **      California, Berkeley and its contributors.
  39 ** 4. Neither the name of the University nor the names of its contributors
  40 **    may be used to endorse or promote products derived from this software
  41 **    without specific prior written permission.
  42 **
  43 ** THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  44 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  45 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  46 ** ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  47 ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  48 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  49 ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  50 ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  51 ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  52 ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  53 ** SUCH DAMAGE.
  54 */
  55
  56 #include <sys/localedef.h>
  57 #include <fcntl.h>
  58 #include <locale.h>
  59 #include <time.h>
  60
  61 #include "private.h"
  62 #include "tzfile.h"
  63
  64 #define Locale  _CurrentTimeLocale
  65
  66 static char *   _add(const char *, char *, const char *);
  67 static char *   _conv(int, const char *, char *, const char *);
  68 static char *   _fmt(const char *, const struct tm *, char *,
  69                      const char *, int *);
  70 static char *   _yconv(int, int, int, int, char *, const char *);
  71
  72 #define NO_RUN_TIME_WARNINGS_ABOUT_YEAR_2000_PROBLEMS_THANK_YOU
  73
  74 #ifndef YEAR_2000_NAME
  75 #define YEAR_2000_NAME  "CHECK_STRFTIME_FORMATS_FOR_TWO_DIGIT_YEARS"
  76 #endif /* !defined YEAR_2000_NAME */
  77
  78 #define IN_NONE 0
  79 #define IN_SOME 1
  80 #define IN_THIS 2
  81 #define IN_ALL  3
  82
  83 size_t
  84 strftime(char * const s, const size_t maxsize, const char * const format,
  85          const struct tm * const t)
  86 {
  87         char *  p;
  88         int     warn;
  89
  90         tzset();
  91         warn = IN_NONE;
  92         p = _fmt(((format == NULL) ? "%c" : format), t, s, s + maxsize, &warn);
  93 #ifndef NO_RUN_TIME_WARNINGS_ABOUT_YEAR_2000_PROBLEMS_THANK_YOU
  94         if (warn != IN_NONE && getenv(YEAR_2000_NAME) != NULL) {
  95                 fprintf(stderr, "\n");
  96                 if (format == NULL)
  97                         fprintf(stderr, "NULL strftime format ");
  98                 else    fprintf(stderr, "strftime format \"%s\" ",
  99                                 format);
 100                 fprintf(stderr, "yields only two digits of years in ");
 101                 if (warn == IN_SOME)
 102                         fprintf(stderr, "some locales");
 103                 else if (warn == IN_THIS)
 104                         fprintf(stderr, "the current locale");
 105                 else    fprintf(stderr, "all locales");
 106                 fprintf(stderr, "\n");
 107         }
 108 #endif /* !defined NO_RUN_TIME_WARNINGS_ABOUT_YEAR_2000_PROBLEMS_THANK_YOU */
 109         if (p == s + maxsize)
 110                 return 0;
 111         *p = '\0';
 112         return p - s;
 113 }
 114
 115 static char *
 116 _fmt(const char *format, const struct tm * const t, char *pt,
 117      const char * const ptlim, int * warnp)
 118 {
 119         for ( ; *format; ++format) {
 120                 if (*format == '%') {
 121 label:
 122                         switch (*++format) {
 123                         case '\0':
 124                                 --format;
 125                                 break;
 126                         case 'A':
 127                                 pt = _add((t->tm_wday < 0 ||
 128                                         t->tm_wday >= DAYSPERWEEK) ?
 129                                         "?" : Locale->day[t->tm_wday],
 130                                         pt, ptlim);
 131                                 continue;
 132                         case 'a':
 133                                 pt = _add((t->tm_wday < 0 ||
 134                                         t->tm_wday >= DAYSPERWEEK) ?
 135                                         "?" : Locale->abday[t->tm_wday],
 136                                         pt, ptlim);
 137                                 continue;
 138                         case 'B':
 139                                 pt = _add((t->tm_mon < 0 ||
 140                                         t->tm_mon >= MONSPERYEAR) ?
 141                                         "?" : Locale->mon[t->tm_mon],
 142                                         pt, ptlim);
 143                                 continue;
 144                         case 'b':
 145                         case 'h':
 146                                 pt = _add((t->tm_mon < 0 ||
 147                                         t->tm_mon >= MONSPERYEAR) ?
 148                                         "?" : Locale->abmon[t->tm_mon],
 149                                         pt, ptlim);
 150                                 continue;
 151                         case 'C':
 152                                 /*
 153                                 ** %C used to do a...
 154                                 **      _fmt("%a %b %e %X %Y", t);
 155                                 ** ...whereas now POSIX 1003.2 calls for
 156                                 ** something completely different.
 157                                 ** (ado, 1993-05-24)
 158                                 */
 159                                 pt = _yconv(t->tm_year, TM_YEAR_BASE, 1, 0,
 160                                         pt, ptlim);
 161                                 continue;
 162                         case 'c':
 163                                 {
 164                                 int warn2 = IN_SOME;
 165
 166                                 pt = _fmt(Locale->d_t_fmt, t, pt, ptlim, &warn2);
 167                                 if (warn2 == IN_ALL)
 168                                         warn2 = IN_THIS;
 169                                 if (warn2 > *warnp)
 170                                         *warnp = warn2;
 171                                 }
 172                                 continue;
 173                         case 'D':
 174                                 pt = _fmt("%m/%d/%y", t, pt, ptlim, warnp);
 175                                 continue;
 176                         case 'd':
 177                                 pt = _conv(t->tm_mday, "%02d", pt, ptlim);
 178                                 continue;
 179                         case 'E':
 180                         case 'O':
 181                                 /*
 182                                 ** C99 locale modifiers.
 183                                 ** The sequences
 184                                 **      %Ec %EC %Ex %EX %Ey %EY
 185                                 **      %Od %oe %OH %OI %Om %OM
 186                                 **      %OS %Ou %OU %OV %Ow %OW %Oy
 187                                 ** are supposed to provide alternate
 188                                 ** representations.
 189                                 */
 190                                 goto label;
 191                         case 'e':
 192                                 pt = _conv(t->tm_mday, "%2d", pt, ptlim);
 193                                 continue;
 194                         case 'F':
 195                                 pt = _fmt("%Y-%m-%d", t, pt, ptlim, warnp);
 196                                 continue;
 197                         case 'H':
 198                                 pt = _conv(t->tm_hour, "%02d", pt, ptlim);
 199                                 continue;
 200                         case 'I':
 201                                 pt = _conv((t->tm_hour % 12) ?
 202                                         (t->tm_hour % 12) : 12,
 203                                         "%02d", pt, ptlim);
 204                                 continue;
 205                         case 'j':
 206                                 pt = _conv(t->tm_yday + 1, "%03d", pt, ptlim);
 207                                 continue;
 208                         case 'k':
 209                                 /*
 210                                 ** This used to be...
 211                                 **      _conv(t->tm_hour % 12 ?
 212                                 **              t->tm_hour % 12 : 12, 2, ' ');
 213                                 ** ...and has been changed to the below to
 214                                 ** match SunOS 4.1.1 and Arnold Robbins'
 215                                 ** strftime version 3.0. That is, "%k" and
 216                                 ** "%l" have been swapped.
 217                                 ** (ado, 1993-05-24)
 218                                 */
 219                                 pt = _conv(t->tm_hour, "%2d", pt, ptlim);
 220                                 continue;
 221 #ifdef KITCHEN_SINK
 222                         case 'K':
 223                                 /*
 224                                 ** After all this time, still unclaimed!
 225                                 */
 226                                 pt = _add("kitchen sink", pt, ptlim);
 227                                 continue;
 228 #endif /* defined KITCHEN_SINK */
 229                         case 'l':
 230                                 /*
 231                                 ** This used to be...
 232                                 **      _conv(t->tm_hour, 2, ' ');
 233                                 ** ...and has been changed to the below to
 234                                 ** match SunOS 4.1.1 and Arnold Robbin's
 235                                 ** strftime version 3.0. That is, "%k" and
 236                                 ** "%l" have been swapped.
 237                                 ** (ado, 1993-05-24)
 238                                 */
 239                                 pt = _conv((t->tm_hour % 12) ?
 240                                         (t->tm_hour % 12) : 12,
 241                                         "%2d", pt, ptlim);
 242                                 continue;
 243                         case 'M':
 244                                 pt = _conv(t->tm_min, "%02d", pt, ptlim);
 245                                 continue;
 246                         case 'm':
 247                                 pt = _conv(t->tm_mon + 1, "%02d", pt, ptlim);
 248                                 continue;
 249                         case 'n':
 250                                 pt = _add("\n", pt, ptlim);
 251                                 continue;
 252                         case 'p':
 253                                 pt = _add((t->tm_hour >= (HOURSPERDAY / 2)) ?
 254                                         Locale->am_pm[1] :
 255                                         Locale->am_pm[0],
 256                                         pt, ptlim);
 257                                 continue;
 258                         case 'R':
 259                                 pt = _fmt("%H:%M", t, pt, ptlim, warnp);
 260                                 continue;
 261                         case 'r':
 262                                 pt = _fmt(Locale->t_fmt_ampm, t, pt, ptlim,
 263                                         warnp);
 264                                 continue;
 265                         case 'S':
 266                                 pt = _conv(t->tm_sec, "%02d", pt, ptlim);
 267                                 continue;
 268                         case 's':
 269                                 {
 270                                         struct tm       tm;
 271                                         char            buf[INT_STRLEN_MAXIMUM(
 272                                                                 time_t) + 1];
 273                                         time_t          mkt;
 274
 275                                         tm = *t;
 276                                         mkt = mktime(&tm);
 277                                         /* CONSTCOND */
 278                                         if (TYPE_SIGNED(time_t))
 279                                                 sprintf(buf, "%ld",
 280                                                         (long) mkt);
 281                                         else    sprintf(buf, "%lu",
 282                                                         (unsigned long) mkt);
 283                                         pt = _add(buf, pt, ptlim);
 284                                 }
 285                                 continue;
 286                         case 'T':
 287                                 pt = _fmt("%H:%M:%S", t, pt, ptlim, warnp);
 288                                 continue;
 289                         case 't':
 290                                 pt = _add("\t", pt, ptlim);
 291                                 continue;
 292                         case 'U':
 293                                 pt = _conv((t->tm_yday + DAYSPERWEEK -
 294                                         t->tm_wday) / DAYSPERWEEK,
 295                                         "%02d", pt, ptlim);
 296                                 continue;
 297                         case 'u':
 298                                 /*
 299                                 ** From Arnold Robbins' strftime version 3.0:
 300                                 ** "ISO 8601: Weekday as a decimal number
 301                                 ** [1 (Monday) - 7]"
 302                                 ** (ado, 1993-05-24)
 303                                 */
 304                                 pt = _conv((t->tm_wday == 0) ?
 305                                         DAYSPERWEEK : t->tm_wday,
 306                                         "%d", pt, ptlim);
 307                                 continue;
 308                         case 'V':       /* ISO 8601 week number */
 309                         case 'G':       /* ISO 8601 year (four digits) */
 310                         case 'g':       /* ISO 8601 year (two digits) */
 311 /*
 312 ** From Arnold Robbins' strftime version 3.0: "the week number of the
 313 ** year (the first Monday as the first day of week 1) as a decimal number
 314 ** (01-53)."
 315 ** (ado, 1993-05-24)
 316 **
 317 ** From "http://www.ft.uni-erlangen.de/~mskuhn/iso-time.html" by Markus Kuhn:
 318 ** "Week 01 of a year is per definition the first week which has the
 319 ** Thursday in this year, which is equivalent to the week which contains
 320 ** the fourth day of January. In other words, the first week of a new year
 321 ** is the week which has the majority of its days in the new year. Week 01
 322 ** might also contain days from the previous year and the week before week
 323 ** 01 of a year is the last week (52 or 53) of the previous year even if
 324 ** it contains days from the new year. A week starts with Monday (day 1)
 325 ** and ends with Sunday (day 7). For example, the first week of the year
 326 ** 1997 lasts from 1996-12-30 to 1997-01-05..."
 327 ** (ado, 1996-01-02)
 328 */
 329                                 {
 330                                         int     year;
 331                                         int     base;
 332                                         int     yday;
 333                                         int     wday;
 334                                         int     w;
 335
 336                                         year = t->tm_year;
 337                                         base = TM_YEAR_BASE;
 338                                         yday = t->tm_yday;
 339                                         wday = t->tm_wday;
 340                                         for ( ; ; ) {
 341                                                 int     len;
 342                                                 int     bot;
 343                                                 int     top;
 344
 345                                                 len = isleap_sum(year, base) ?
 346                                                         DAYSPERLYEAR :
 347                                                         DAYSPERNYEAR;
 348                                                 /*
 349                                                 ** What yday (-3 ... 3) does
 350                                                 ** the ISO year begin on?
 351                                                 */
 352                                                 bot = ((yday + 11 - wday) %
 353                                                         DAYSPERWEEK) - 3;
 354                                                 /*
 355                                                 ** What yday does the NEXT
 356                                                 ** ISO year begin on?
 357                                                 */
 358                                                 top = bot -
 359                                                         (len % DAYSPERWEEK);
 360                                                 if (top < -3)
 361                                                         top += DAYSPERWEEK;
 362                                                 top += len;
 363                                                 if (yday >= top) {
 364                                                         ++base;
 365                                                         w = 1;
 366                                                         break;
 367                                                 }
 368                                                 if (yday >= bot) {
 369                                                         w = 1 + ((yday - bot) /
 370                                                                 DAYSPERWEEK);
 371                                                         break;
 372                                                 }
 373                                                 --base;
 374                                                 yday += isleap_sum(year, base) ?
 375                                                         DAYSPERLYEAR :
 376                                                         DAYSPERNYEAR;
 377                                         }
 378 #ifdef XPG4_1994_04_09
 379                                         if ((w == 52 &&
 380                                                 t->tm_mon == TM_JANUARY) ||
 381                                                 (w == 1 &&
 382                                                 t->tm_mon == TM_DECEMBER))
 383                                                         w = 53;
 384 #endif /* defined XPG4_1994_04_09 */
 385                                         if (*format == 'V')
 386                                                 pt = _conv(w, "%02d",
 387                                                         pt, ptlim);
 388                                         else if (*format == 'g') {
 389                                                 *warnp = IN_ALL;
 390                                                 pt = _yconv(year, base, 0, 1,
 391                                                         pt, ptlim);
 392                                         } else  pt = _yconv(year, base, 1, 1,
 393                                                         pt, ptlim);
 394                                 }
 395                                 continue;
 396                         case 'v':
 397                                 /*
 398                                 ** From Arnold Robbins' strftime version 3.0:
 399                                 ** "date as dd-bbb-YYYY"
 400                                 ** (ado, 1993-05-24)
 401                                 */
 402                                 pt = _fmt("%e-%b-%Y", t, pt, ptlim, warnp);
 403                                 continue;
 404                         case 'W':
 405                                 pt = _conv((t->tm_yday + DAYSPERWEEK -
 406                                         (t->tm_wday ?
 407                                         (t->tm_wday - 1) :
 408                                         (DAYSPERWEEK - 1))) / DAYSPERWEEK,
 409                                         "%02d", pt, ptlim);
 410                                 continue;
 411                         case 'w':
 412                                 pt = _conv(t->tm_wday, "%d", pt, ptlim);
 413                                 continue;
 414                         case 'X':
 415                                 pt = _fmt(Locale->t_fmt, t, pt, ptlim, warnp);
 416                                 continue;
 417                         case 'x':
 418                                 {
 419                                 int     warn2 = IN_SOME;
 420
 421                                 pt = _fmt(Locale->d_fmt, t, pt, ptlim, &warn2);
 422                                 if (warn2 == IN_ALL)
 423                                         warn2 = IN_THIS;
 424                                 if (warn2 > *warnp)
 425                                         *warnp = warn2;
 426                                 }
 427                                 continue;
 428                         case 'y':
 429                                 *warnp = IN_ALL;
 430                                 pt = _yconv(t->tm_year, TM_YEAR_BASE, 0, 1,
 431                                         pt, ptlim);
 432                                 continue;
 433                         case 'Y':
 434                                 pt = _yconv(t->tm_year, TM_YEAR_BASE, 1, 1,
 435                                         pt, ptlim);
 436                                 continue;
 437                         case 'Z':
 438 #ifdef TM_ZONE
 439                                 if (t->TM_ZONE != NULL)
 440                                         pt = _add(t->TM_ZONE, pt, ptlim);
 441                                 else
 442 #endif /* defined TM_ZONE */
 443                                 if (t->tm_isdst >= 0)
 444                                         pt = _add(tzname[t->tm_isdst != 0],
 445                                                 pt, ptlim);
 446                                 /*
 447                                 ** C99 says that %Z must be replaced by the
 448                                 ** empty string if the time zone is not
 449                                 ** determinable.
 450                                 */
 451                                 continue;
 452                         case 'z':
 453                                 {
 454                                 int             diff;
 455                                 char const *    sign;
 456
 457                                 if (t->tm_isdst < 0)
 458                                         continue;
 459 #ifdef TM_GMTOFF
 460                                 diff = (int)t->TM_GMTOFF;
 461 #else /* !defined TM_GMTOFF */
 462                                 /*
 463                                 ** C99 says that the UTC offset must
 464                                 ** be computed by looking only at
 465                                 ** tm_isdst. This requirement is
 466                                 ** incorrect, since it means the code
 467                                 ** must rely on magic (in this case
 468                                 ** altzone and timezone), and the
 469                                 ** magic might not have the correct
 470                                 ** offset. Doing things correctly is
 471                                 ** tricky and requires disobeying C99;
 472                                 ** see GNU C strftime for details.
 473                                 ** For now, punt and conform to the
 474                                 ** standard, even though it's incorrect.
 475                                 **
 476                                 ** C99 says that %z must be replaced by the
 477                                 ** empty string if the time zone is not
 478                                 ** determinable, so output nothing if the
 479                                 ** appropriate variables are not available.
 480                                 */
 481                                 {
 482                                         struct tm tmp;
 483                                         time_t lct, gct;
 484
 485                                         /*
 486                                         ** Get calendar time from t
 487                                         ** being treated as local.
 488                                         */
 489                                         tmp = *t; /* mktime discards const */
 490                                         lct = mktime(&tmp);
 491
 492                                         if (lct == (time_t)-1)
 493                                                 continue;
 494
 495                                         /*
 496                                         ** Get calendar time from t
 497                                         ** being treated as GMT.
 498                                         **/
 499                                         tmp = *t; /* mktime discards const */
 500                                         gct = timegm(&tmp);
 501
 502                                         if (gct == (time_t)-1)
 503                                                 continue;
 504
 505                                         /* LINTED difference will fit int */
 506                                         diff = (intmax_t)gct - (intmax_t)lct;
 507                                 }
 508 #endif /* !defined TM_GMTOFF */
 509                                 if (diff < 0) {
 510                                         sign = "-";
 511                                         diff = -diff;
 512                                 } else  sign = "+";
 513                                 pt = _add(sign, pt, ptlim);
 514                                 diff /= SECSPERMIN;
 515                                 diff = (diff / MINSPERHOUR) * 100 +
 516                                         (diff % MINSPERHOUR);
 517                                 pt = _conv(diff, "%04d", pt, ptlim);
 518                                 }
 519                                 continue;
 520                         case '+':
 521                                 pt = _fmt(Locale->d_t_fmt, t, pt, ptlim,
 522                                         warnp);
 523                                 continue;
 524                         case '%':
 525                         /*
 526                         ** X311J/88-090 (4.12.3.5): if conversion char is
 527                         ** undefined, behavior is undefined. Print out the
 528                         ** character itself as printf(3) also does.
 529                         */
 530                         default:
 531                                 break;
 532                         }
 533                 }
 534                 if (pt == ptlim)
 535                         break;
 536                 *pt++ = *format;
 537         }
 538         return pt;
 539 }
 540
 541 static char *
 542 _conv(const int n, const char * const format, char * const pt,
 543       const char * const ptlim)
 544 {
 545         char    buf[INT_STRLEN_MAXIMUM(int) + 1];
 546
 547         sprintf(buf, format, n);
 548         return _add(buf, pt, ptlim);
 549 }
 550
 551 static char *
 552 _add(const char *str, char *pt, const char * const ptlim)
 553 {
 554         while (pt < ptlim && (*pt = *str++) != '\0')
 555                 ++pt;
 556         return pt;
 557 }
 558
 559 /*
 560 ** POSIX and the C Standard are unclear or inconsistent about
 561 ** what %C and %y do if the year is negative or exceeds 9999.
 562 ** Use the convention that %C concatenated with %y yields the
 563 ** same output as %Y, and that %Y contains at least 4 bytes,
 564 ** with more only if necessary.
 565 */
 566
 567 static char *
 568 _yconv(const int a, const int b, const int convert_top, const int convert_yy,
 569        char *pt, const char * const ptlim)
 570 {
 571         int     lead;
 572         int     trail;
 573
 574 #define DIVISOR 100
 575         trail = a % DIVISOR + b % DIVISOR;
 576         lead = a / DIVISOR + b / DIVISOR + trail / DIVISOR;
 577         trail %= DIVISOR;
 578         if (trail < 0 && lead > 0) {
 579                 trail += DIVISOR;
 580                 --lead;
 581         } else if (lead < 0 && trail > 0) {
 582                 trail -= DIVISOR;
 583                 ++lead;
 584         }
 585         if (convert_top) {
 586                 if (lead == 0 && trail < 0)
 587                         pt = _add("-0", pt, ptlim);
 588                 else    pt = _conv(lead, "%02d", pt, ptlim);
 589         }
 590         if (convert_yy)
 591                 pt = _conv(((trail < 0) ? -trail : trail), "%02d", pt, ptlim);
 592         return pt;
 593 }