cal: document the location of unicode bug. no code changes
[oweals/busybox.git] / coreutils / cal.c
1 /* vi: set sw=4 ts=4: */
2 /*
3  * Calendar implementation for busybox
4  *
5  * See original copyright at the end of this file
6  *
7  * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
8  */
9
10 /* BB_AUDIT SUSv3 compliant with -j and -y extensions (from util-linux). */
11 /* BB_AUDIT BUG: The output of 'cal -j 1752' is incorrect.  The upstream
12  * BB_AUDIT BUG: version in util-linux seems to be broken as well. */
13 /* http://www.opengroup.org/onlinepubs/007904975/utilities/cal.html */
14
15 /* Mar 16, 2003      Manuel Novoa III   (mjn3@codepoet.org)
16  *
17  * Major size reduction... over 50% (>1.5k) on i386.
18  */
19
20 #include "libbb.h"
21
22 /* We often use "unsigned" intead of "int", it's easier to div on most CPUs */
23
24 #define THURSDAY                4               /* for reformation */
25 #define SATURDAY                6               /* 1 Jan 1 was a Saturday */
26
27 #define FIRST_MISSING_DAY       639787          /* 3 Sep 1752 */
28 #define NUMBER_MISSING_DAYS     11              /* 11 day correction */
29
30 #define MAXDAYS                 42              /* max slots in a month array */
31 #define SPACE                   -1              /* used in day array */
32
33 static const unsigned char days_in_month[] ALIGN1 = {
34         0, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
35 };
36
37 static const unsigned char sep1752[] ALIGN1 = {
38                  1,     2,      14,     15,     16,
39         17,     18,     19,     20,     21,     22,     23,
40         24,     25,     26,     27,     28,     29,     30
41 };
42
43 /* Set to 0 or 1 in main */
44 #define julian ((unsigned)option_mask32)
45
46 /* leap year -- account for Gregorian reformation in 1752 */
47 static int leap_year(unsigned yr)
48 {
49         if (yr <= 1752)
50                 return !(yr % 4);
51         return (!(yr % 4) && (yr % 100)) || !(yr % 400);
52 }
53
54 /* number of centuries since 1700, not inclusive */
55 #define centuries_since_1700(yr) \
56         ((yr) > 1700 ? (yr) / 100 - 17 : 0)
57
58 /* number of centuries since 1700 whose modulo of 400 is 0 */
59 #define quad_centuries_since_1700(yr) \
60         ((yr) > 1600 ? ((yr) - 1600) / 400 : 0)
61
62 /* number of leap years between year 1 and this year, not inclusive */
63 #define leap_years_since_year_1(yr) \
64         ((yr) / 4 - centuries_since_1700(yr) + quad_centuries_since_1700(yr))
65
66 static void center(char *, unsigned, unsigned);
67 static void day_array(unsigned, unsigned, unsigned *);
68 static void trim_trailing_spaces_and_print(char *);
69
70 static void blank_string(char *buf, size_t buflen);
71 static char *build_row(char *p, unsigned *dp);
72
73 #define DAY_LEN         3               /* 3 spaces per day */
74 #define J_DAY_LEN       (DAY_LEN + 1)
75 #define WEEK_LEN        20              /* 7 * 3 - one space at the end */
76 #define J_WEEK_LEN      (WEEK_LEN + 7)
77 #define HEAD_SEP        2               /* spaces between day headings */
78
79 int cal_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
80 int cal_main(int argc UNUSED_PARAM, char **argv)
81 {
82         struct tm *local_time;
83         struct tm zero_tm;
84         time_t now;
85         unsigned month, year, flags, i;
86         char *month_names[12];
87         char day_headings[28];  /* 28 for julian, 21 for nonjulian */
88         char buf[40];
89
90         flags = getopt32(argv, "jy");
91         /* This sets julian = flags & 1: */
92         option_mask32 &= 1;
93         month = 0;
94         argv += optind;
95
96         if (!argv[0]) {
97                 time(&now);
98                 local_time = localtime(&now);
99                 year = local_time->tm_year + 1900;
100                 if (!(flags & 2)) { /* no -y */
101                         month = local_time->tm_mon + 1;
102                 }
103         } else {
104                 if (argv[1]) {
105                         if (argv[2]) {
106                                 bb_show_usage();
107                         }
108                         month = xatou_range(*argv++, 1, 12);
109                 }
110                 year = xatou_range(*argv, 1, 9999);
111         }
112
113         blank_string(day_headings, sizeof(day_headings) - 7 + 7*julian);
114
115         i = 0;
116         do {
117                 zero_tm.tm_mon = i;
118                 /* full month name according to locale */
119                 strftime(buf, sizeof(buf), "%B", &zero_tm);
120                 month_names[i] = xstrdup(buf);
121
122                 if (i < 7) {
123                         zero_tm.tm_wday = i;
124 //FIXME: unicode
125 //Bug 839:
126 //testcase with doublewidth Japanese chars: "LANG=zh_TW.utf8 cal"
127 //perhaps use wc[s]width() to probe terminal width
128                         /* abbreviated weekday name according to locale */
129                         strftime(buf, sizeof(buf), "%a", &zero_tm);
130                         strncpy(day_headings + i * (3+julian) + julian, buf, 2);
131                 }
132         } while (++i < 12);
133
134         if (month) {
135                 unsigned row, len, days[MAXDAYS];
136                 unsigned *dp = days;
137                 char lineout[30];
138
139                 day_array(month, year, dp);
140                 len = sprintf(lineout, "%s %d", month_names[month - 1], year);
141                 printf("%*s%s\n%s\n",
142                            ((7*julian + WEEK_LEN) - len) / 2, "",
143                            lineout, day_headings);
144                 for (row = 0; row < 6; row++) {
145                         build_row(lineout, dp)[0] = '\0';
146                         dp += 7;
147                         trim_trailing_spaces_and_print(lineout);
148                 }
149         } else {
150                 unsigned row, which_cal, week_len, days[12][MAXDAYS];
151                 unsigned *dp;
152                 char lineout[80];
153
154                 sprintf(lineout, "%u", year);
155                 center(lineout,
156                            (WEEK_LEN * 3 + HEAD_SEP * 2)
157                            + julian * (J_WEEK_LEN * 2 + HEAD_SEP
158                                                    - (WEEK_LEN * 3 + HEAD_SEP * 2)),
159                            0);
160                 puts("\n");             /* two \n's */
161                 for (i = 0; i < 12; i++) {
162                         day_array(i + 1, year, days[i]);
163                 }
164                 blank_string(lineout, sizeof(lineout));
165                 week_len = WEEK_LEN + julian * (J_WEEK_LEN - WEEK_LEN);
166                 for (month = 0; month < 12; month += 3-julian) {
167                         center(month_names[month], week_len, HEAD_SEP);
168                         if (!julian) {
169                                 center(month_names[month + 1], week_len, HEAD_SEP);
170                         }
171                         center(month_names[month + 2 - julian], week_len, 0);
172                         printf("\n%s%*s%s", day_headings, HEAD_SEP, "", day_headings);
173                         if (!julian) {
174                                 printf("%*s%s", HEAD_SEP, "", day_headings);
175                         }
176                         bb_putchar('\n');
177                         for (row = 0; row < (6*7); row += 7) {
178                                 for (which_cal = 0; which_cal < 3-julian; which_cal++) {
179                                         dp = days[month + which_cal] + row;
180                                         build_row(lineout + which_cal * (week_len + 2), dp);
181                                 }
182                                 /* blank_string took care of nul termination. */
183                                 trim_trailing_spaces_and_print(lineout);
184                         }
185                 }
186         }
187
188         fflush_stdout_and_exit(EXIT_SUCCESS);
189 }
190
191 /*
192  * day_array --
193  *      Fill in an array of 42 integers with a calendar.  Assume for a moment
194  *      that you took the (maximum) 6 rows in a calendar and stretched them
195  *      out end to end.  You would have 42 numbers or spaces.  This routine
196  *      builds that array for any month from Jan. 1 through Dec. 9999.
197  */
198 static void day_array(unsigned month, unsigned year, unsigned *days)
199 {
200         unsigned long temp;
201         unsigned i;
202         unsigned day, dw, dm;
203
204         memset(days, SPACE, MAXDAYS * sizeof(int));
205
206         if ((month == 9) && (year == 1752)) {
207                 /* Assumes the Gregorian reformation eliminates
208                  * 3 Sep. 1752 through 13 Sep. 1752.
209                  */
210                 unsigned j_offset = julian * 244;
211                 size_t oday = 0;
212
213                 do {
214                         days[oday+2] = sep1752[oday] + j_offset;
215                 } while (++oday < sizeof(sep1752));
216
217                 return;
218         }
219
220         /* day_in_year
221          * return the 1 based day number within the year
222          */
223         day = 1;
224         if ((month > 2) && leap_year(year)) {
225                 ++day;
226         }
227
228         i = month;
229         while (i) {
230                 day += days_in_month[--i];
231         }
232
233         /* day_in_week
234          * return the 0 based day number for any date from 1 Jan. 1 to
235          * 31 Dec. 9999.  Assumes the Gregorian reformation eliminates
236          * 3 Sep. 1752 through 13 Sep. 1752.  Returns Thursday for all
237          * missing days.
238          */
239         temp = (long)(year - 1) * 365 + leap_years_since_year_1(year - 1) + day;
240         if (temp < FIRST_MISSING_DAY) {
241                 dw = ((temp - 1 + SATURDAY) % 7);
242         } else {
243                 dw = (((temp - 1 + SATURDAY) - NUMBER_MISSING_DAYS) % 7);
244         }
245
246         if (!julian) {
247                 day = 1;
248         }
249
250         dm = days_in_month[month];
251         if ((month == 2) && leap_year(year)) {
252                 ++dm;
253         }
254
255         do {
256                 days[dw++] = day++;
257         } while (--dm);
258 }
259
260 static void trim_trailing_spaces_and_print(char *s)
261 {
262         char *p = s;
263
264         while (*p) {
265                 ++p;
266         }
267         while (p != s) {
268                 --p;
269                 if (!isspace(*p)) {
270                         p[1] = '\0';
271                         break;
272                 }
273         }
274
275         puts(s);
276 }
277
278 static void center(char *str, unsigned len, unsigned separate)
279 {
280         unsigned n = strlen(str);
281         len -= n;
282         printf("%*s%*s", (len/2) + n, str, (len/2) + (len % 2) + separate, "");
283 }
284
285 static void blank_string(char *buf, size_t buflen)
286 {
287         memset(buf, ' ', buflen);
288         buf[buflen-1] = '\0';
289 }
290
291 static char *build_row(char *p, unsigned *dp)
292 {
293         unsigned col, val, day;
294
295         memset(p, ' ', (julian + DAY_LEN) * 7);
296
297         col = 0;
298         do {
299                 day = *dp++;
300                 if (day != SPACE) {
301                         if (julian) {
302                                 ++p;
303                                 if (day >= 100) {
304                                         *p = '0';
305                                         p[-1] = (day / 100) + '0';
306                                         day %= 100;
307                                 }
308                         }
309                         val = day / 10;
310                         if (val > 0) {
311                                 *p = val + '0';
312                         }
313                         *++p = day % 10 + '0';
314                         p += 2;
315                 } else {
316                         p += DAY_LEN + julian;
317                 }
318         } while (++col < 7);
319
320         return p;
321 }
322
323 /*
324  * Copyright (c) 1989, 1993, 1994
325  *      The Regents of the University of California.  All rights reserved.
326  *
327  * This code is derived from software contributed to Berkeley by
328  * Kim Letkeman.
329  *
330  * Redistribution and use in source and binary forms, with or without
331  * modification, are permitted provided that the following conditions
332  * are met:
333  * 1. Redistributions of source code must retain the above copyright
334  *    notice, this list of conditions and the following disclaimer.
335  * 2. Redistributions in binary form must reproduce the above copyright
336  *    notice, this list of conditions and the following disclaimer in the
337  *    documentation and/or other materials provided with the distribution.
338  * 3. Neither the name of the University nor the names of its contributors
339  *    may be used to endorse or promote products derived from this software
340  *    without specific prior written permission.
341  *
342  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
343  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
344  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
345  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
346  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
347  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
348  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
349  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
350  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
351  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
352  * SUCH DAMAGE.
353  */