cal-china.el 35.6 KB
Newer Older
1
;;; cal-china.el --- calendar functions for the Chinese calendar
Edward M. Reingold's avatar
Edward M. Reingold committed
2

3
;; Copyright (C) 1995, 1997, 2001-2014 Free Software Foundation, Inc.
Edward M. Reingold's avatar
Edward M. Reingold committed
4 5

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
6
;; Maintainer: Glenn Morris <rgm@gnu.org>
Edward M. Reingold's avatar
Edward M. Reingold committed
7 8
;; Keywords: calendar
;; Human-Keywords: Chinese calendar, calendar, holidays, diary
9
;; Package: calendar
Edward M. Reingold's avatar
Edward M. Reingold committed
10 11 12

;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Edward M. Reingold's avatar
Edward M. Reingold committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Edward M. Reingold's avatar
Edward M. Reingold committed
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Edward M. Reingold's avatar
Edward M. Reingold committed
25 26 27

;;; Commentary:

28 29 30 31 32 33 34 35 36 37 38 39 40
;; See calendar.el.

;; The rules used for the Chinese calendar are those of Baolin Liu
;; (see L. E. Doggett's article "Calendars" in the Explanatory
;; Supplement to the Astronomical Almanac, second edition, 1992) for
;; the calendar as revised at the beginning of the Qing dynasty in
;; 1644.  The nature of the astronomical calculations is such that
;; precise calculations cannot be made without great expense in time,
;; so that the calendars produced may not agree perfectly with
;; published tables--but no two pairs of published tables agree
;; perfectly either!  Liu's rules produce a calendar for 2033 which is
;; not accepted by all authorities.  The date of Chinese New Year is
;; correct from 1644-2051.
41

42 43 44
;; Note to maintainers:
;; Use `chinese-year-cache-init' every few years to recenter the default
;; value of `chinese-year-cache'.
Edward M. Reingold's avatar
Edward M. Reingold committed
45

46
;;; Code:
47

Glenn Morris's avatar
Glenn Morris committed
48 49 50 51
(require 'calendar)
(require 'lunar)                        ; lunar-new-moon-on-or-after
;; solar-date-next-longitude brought in by lunar.
;;;(require 'solar)
52
;; calendar-astro-to-absolute and from-absolute are cal-autoloads.
Glenn Morris's avatar
Glenn Morris committed
53 54
;;;(require 'cal-julian)

Edward M. Reingold's avatar
Edward M. Reingold committed
55

56
(defgroup calendar-chinese nil
57
  "Chinese calendar support."
58
  :prefix "calendar-chinese-"
59
  :group 'calendar)
Edward M. Reingold's avatar
Edward M. Reingold committed
60

61 62 63
(define-obsolete-variable-alias 'chinese-calendar-time-zone
  'calendar-chinese-time-zone "23.1")

64
(defcustom calendar-chinese-time-zone
Edward M. Reingold's avatar
Edward M. Reingold committed
65 66 67
  '(if (< year 1928)
       (+ 465 (/ 40.0 60.0))
     480)
68
  "Minutes difference between local standard time for Chinese calendar and UTC.
69 70
Default is for Beijing.  This is an expression in `year' since it changed at
1928-01-01 00:00:00 from UT+7:45:40 to UT+8."
71
  :type 'sexp
72
  :group 'calendar-chinese)
Edward M. Reingold's avatar
Edward M. Reingold committed
73

74 75 76
;; It gets eval'd.
;;;###autoload
(put 'calendar-chinese-time-zone 'risky-local-variable t)
77 78
;;;###autoload
(put 'chinese-calendar-time-zone 'risky-local-variable t)
79

80 81 82

(define-obsolete-variable-alias 'chinese-calendar-location-name
  'calendar-chinese-location-name "23.1")
83 84 85

;; FIXME unused.
(defcustom calendar-chinese-location-name "Beijing"
86
  "Name of location used for calculation of Chinese calendar."
87
  :type 'string
88 89
  :group 'calendar-chinese)

90 91
(define-obsolete-variable-alias 'chinese-calendar-daylight-time-offset
  'calendar-chinese-daylight-time-offset "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
92

93
(defcustom calendar-chinese-daylight-time-offset 0
Glenn Morris's avatar
Glenn Morris committed
94 95 96
;; The correct value is as follows, but the Chinese calendrical
;; authorities do NOT use DST in determining astronomical events:
;;  60
97 98
  "Minutes difference between daylight saving and standard time.
Default is for no daylight saving time."
99
  :type 'integer
100 101
  :group 'calendar-chinese)

102 103
(define-obsolete-variable-alias 'chinese-calendar-standard-time-zone-name
  'calendar-chinese-standard-time-zone-name "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
104

105
(defcustom calendar-chinese-standard-time-zone-name
Edward M. Reingold's avatar
Edward M. Reingold committed
106 107 108
  '(if (< year 1928)
       "PMT"
     "CST")
109
  "Abbreviated name of standard time zone used for Chinese calendar.
110 111 112
This is an expression depending on `year' because it changed
at 1928-01-01 00:00:00 from `PMT' to `CST'."
  :type 'sexp
113
  :group 'calendar-chinese)
Edward M. Reingold's avatar
Edward M. Reingold committed
114

115 116
(define-obsolete-variable-alias 'chinese-calendar-daylight-time-zone-name
  'calendar-chinese-daylight-time-zone-name "23.1")
117 118

(defcustom calendar-chinese-daylight-time-zone-name "CDT"
119
  "Abbreviated name of daylight saving time zone used for Chinese calendar."
120
  :type 'string
121 122
  :group 'calendar-chinese)

123 124
(define-obsolete-variable-alias 'chinese-calendar-daylight-savings-starts
  'calendar-chinese-daylight-saving-start "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
125

126
(defcustom calendar-chinese-daylight-saving-start nil
Glenn Morris's avatar
Glenn Morris committed
127 128 129 130 131
;; The correct value is as follows, but the Chinese calendrical
;; authorities do NOT use DST in determining astronomical events:
;;  '(cond ((< 1986 year) (calendar-nth-named-day 1 0 4 year 10))
;;         ((= 1986 year) '(5 4 1986))
;;         (t nil))
132 133
  "Sexp giving the date on which daylight saving time starts.
Default is for no daylight saving time.  See documentation of
134 135
`calendar-daylight-savings-starts'."
  :type 'sexp
136
  :group 'calendar-chinese)
Edward M. Reingold's avatar
Edward M. Reingold committed
137

138 139
(define-obsolete-variable-alias 'chinese-calendar-daylight-savings-ends
  'calendar-chinese-daylight-saving-end "23.1")
140 141

(defcustom calendar-chinese-daylight-saving-end nil
Glenn Morris's avatar
Glenn Morris committed
142 143 144
;; The correct value is as follows, but the Chinese calendrical
;; authorities do NOT use DST in determining astronomical events:
;;  '(if (<= 1986 year) (calendar-nth-named-day 1 0 9 year 11))
145 146
  "Sexp giving the date on which daylight saving time ends.
Default is for no daylight saving time.  See documentation of
147 148
`calendar-daylight-savings-ends'."
  :type 'sexp
149 150
  :group 'calendar-chinese)

151 152
(define-obsolete-variable-alias 'chinese-calendar-daylight-savings-starts-time
  'calendar-chinese-daylight-saving-start-time "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
153

154
(defcustom calendar-chinese-daylight-saving-start-time 0
155 156
  "Number of minutes after midnight that daylight saving time starts.
Default is for no daylight saving time."
157
  :type 'integer
158
  :group 'calendar-chinese)
Edward M. Reingold's avatar
Edward M. Reingold committed
159

160 161
(define-obsolete-variable-alias 'chinese-calendar-daylight-savings-ends-time
  'calendar-chinese-daylight-saving-end-time "23.1")
162 163

(defcustom calendar-chinese-daylight-saving-end-time 0
164 165
  "Number of minutes after midnight that daylight saving time ends.
Default is for no daylight saving time."
166
  :type 'integer
167 168
  :group 'calendar-chinese)

169 170
(define-obsolete-variable-alias 'chinese-calendar-celestial-stem
  'calendar-chinese-celestial-stem "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
171

172
(defcustom calendar-chinese-celestial-stem
173
  ["Jia" "Yi" "Bing" "Ding" "Wu" "Ji" "Geng" "Xin" "Ren" "Gui"]
174
  "Prefixes used by `calendar-chinese-sexagesimal-name'."
175
  :group 'calendar-chinese
176 177 178 179 180 181 182 183 184 185 186
  :type '(vector (string :tag "Jia")
                 (string :tag "Yi")
                 (string :tag "Bing")
                 (string :tag "Ding")
                 (string :tag "Wu")
                 (string :tag "Ji")
                 (string :tag "Geng")
                 (string :tag "Xin")
                 (string :tag "Ren")
                 (string :tag "Gui")))

187 188
(define-obsolete-variable-alias 'chinese-calendar-terrestrial-branch
  'calendar-chinese-terrestrial-branch "23.1")
189 190

(defcustom calendar-chinese-terrestrial-branch
191
  ["Zi" "Chou" "Yin" "Mao" "Chen" "Si" "Wu" "Wei" "Shen" "You" "Xu" "Hai"]
192
  "Suffixes used by `calendar-chinese-sexagesimal-name'."
193
  :group 'calendar-chinese
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
  :type '(vector (string :tag "Zi")
                 (string :tag "Chou")
                 (string :tag "Yin")
                 (string :tag "Mao")
                 (string :tag "Chen")
                 (string :tag "Si")
                 (string :tag "Wu")
                 (string :tag "Wei")
                 (string :tag "Shen")
                 (string :tag "You")
                 (string :tag "Xu")
                 (string :tag "Hai")))

;;; End of user options.

209 210 211 212 213 214

(defun calendar-chinese-sexagesimal-name (n)
  "The N-th name of the Chinese sexagesimal cycle.
N congruent to 1 gives the first name, N congruent to 2 gives the second name,
..., N congruent to 60 gives the sixtieth name."
  (format "%s-%s"
215 216
          (aref calendar-chinese-celestial-stem (% (1- n) 10))
          (aref calendar-chinese-terrestrial-branch (% (1- n) 12))))
217

218
(defun calendar-chinese-zodiac-sign-on-or-after (d)
219
  "Absolute date of first new Zodiac sign on or after absolute date D.
Edward M. Reingold's avatar
Edward M. Reingold committed
220
The Zodiac signs begin when the sun's longitude is a multiple of 30 degrees."
221
 (let* ((year (calendar-extract-year (calendar-gregorian-from-absolute d)))
222
         (calendar-time-zone (eval calendar-chinese-time-zone)) ; uses year
Edward M. Reingold's avatar
Edward M. Reingold committed
223
         (calendar-daylight-time-offset
224
          calendar-chinese-daylight-time-offset)
Edward M. Reingold's avatar
Edward M. Reingold committed
225
         (calendar-standard-time-zone-name
226
          calendar-chinese-standard-time-zone-name)
Edward M. Reingold's avatar
Edward M. Reingold committed
227
         (calendar-daylight-time-zone-name
228 229 230
          calendar-chinese-daylight-time-zone-name)
         (calendar-daylight-savings-starts
          calendar-chinese-daylight-saving-start)
Edward M. Reingold's avatar
Edward M. Reingold committed
231
         (calendar-daylight-savings-ends
232
          calendar-chinese-daylight-saving-end)
Edward M. Reingold's avatar
Edward M. Reingold committed
233
         (calendar-daylight-savings-starts-time
234
          calendar-chinese-daylight-saving-start-time)
Edward M. Reingold's avatar
Edward M. Reingold committed
235
         (calendar-daylight-savings-ends-time
236
          calendar-chinese-daylight-saving-end-time))
Edward M. Reingold's avatar
Edward M. Reingold committed
237
   (floor
238
    (calendar-astro-to-absolute
239
     (solar-date-next-longitude (calendar-astro-from-absolute d) 30)))))
Edward M. Reingold's avatar
Edward M. Reingold committed
240

241
(defun calendar-chinese-new-moon-on-or-after (d)
242
  "Absolute date of first new moon on or after absolute date D."
243
  (let* ((year (calendar-extract-year (calendar-gregorian-from-absolute d)))
244
         (calendar-time-zone (eval calendar-chinese-time-zone))
Edward M. Reingold's avatar
Edward M. Reingold committed
245
         (calendar-daylight-time-offset
246
          calendar-chinese-daylight-time-offset)
Edward M. Reingold's avatar
Edward M. Reingold committed
247
         (calendar-standard-time-zone-name
248
          calendar-chinese-standard-time-zone-name)
Edward M. Reingold's avatar
Edward M. Reingold committed
249
         (calendar-daylight-time-zone-name
250 251 252
          calendar-chinese-daylight-time-zone-name)
         (calendar-daylight-savings-starts
          calendar-chinese-daylight-saving-start)
Edward M. Reingold's avatar
Edward M. Reingold committed
253
         (calendar-daylight-savings-ends
254
          calendar-chinese-daylight-saving-end)
Edward M. Reingold's avatar
Edward M. Reingold committed
255
         (calendar-daylight-savings-starts-time
256
          calendar-chinese-daylight-saving-start-time)
Edward M. Reingold's avatar
Edward M. Reingold committed
257
         (calendar-daylight-savings-ends-time
258
          calendar-chinese-daylight-saving-end-time))
Edward M. Reingold's avatar
Edward M. Reingold committed
259
    (floor
260
     (calendar-astro-to-absolute
261
      (lunar-new-moon-on-or-after (calendar-astro-from-absolute d))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
262

263
(defun calendar-chinese-month-list (start end)
Edward M. Reingold's avatar
Edward M. Reingold committed
264 265
  "List of starting dates of Chinese months from START to END."
  (if (<= start end)
266
      (let ((new-moon (calendar-chinese-new-moon-on-or-after start)))
Edward M. Reingold's avatar
Edward M. Reingold committed
267
        (if (<= new-moon end)
Edward M. Reingold's avatar
Edward M. Reingold committed
268
            (cons new-moon
269
                  (calendar-chinese-month-list (1+ new-moon) end))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
270

271
(defun calendar-chinese-number-months (list start)
272 273 274 275 276 277 278 279 280
  "Assign month numbers to the lunar months in LIST, starting with START.
Numbers are assigned sequentially, START, START+1, ..., 11, with
half numbers used for leap months.  First and last months of list
are never leap months."
  (when list
    (cons (list start (car list))       ; first month
          ;; Remaining months.
          (if (zerop (- 12 start (length list)))
              ;; List is too short for a leap month.
281
              (calendar-chinese-number-months (cdr list) (1+ start))
282
            (if (and (cddr list)        ; at least two more months...
283
                     (<= (nth 2 list)
284 285
                         (calendar-chinese-zodiac-sign-on-or-after
                          (cadr list))))
286 287
                ;; Next month is a leap month.
                (cons (list (+ start 0.5) (cadr list))
288
                      (calendar-chinese-number-months (cddr list) (1+ start)))
289
              ;; Next month is not a leap month.
290
              (calendar-chinese-number-months (cdr list) (1+ start)))))))
291

292
(defun calendar-chinese-compute-year (y)
Edward M. Reingold's avatar
Edward M. Reingold committed
293
  "Compute the structure of the Chinese year for Gregorian year Y.
Edward M. Reingold's avatar
Edward M. Reingold committed
294
The result is a list of pairs (i d), where month i begins on absolute date d,
Edward M. Reingold's avatar
Edward M. Reingold committed
295 296
of the Chinese months from the Chinese month following the solstice in
Gregorian year Y-1 to the Chinese month of the solstice of Gregorian year Y."
297
  (let* ((next-solstice (calendar-chinese-zodiac-sign-on-or-after
Edward M. Reingold's avatar
Edward M. Reingold committed
298 299
                         (calendar-absolute-from-gregorian
                          (list 12 15 y))))
300 301 302 303 304 305
         (list (calendar-chinese-month-list
                (1+ (calendar-chinese-zodiac-sign-on-or-after
                     (calendar-absolute-from-gregorian
                      (list 12 15 (1- y)))))
                next-solstice))
         (next-sign (calendar-chinese-zodiac-sign-on-or-after (car list))))
Edward M. Reingold's avatar
Edward M. Reingold committed
306
    (if (= (length list) 12)
Glenn Morris's avatar
Glenn Morris committed
307
        ;; No room for a leap month, just number them 12, 1, 2, ..., 11.
Edward M. Reingold's avatar
Edward M. Reingold committed
308
        (cons (list 12 (car list))
309
              (calendar-chinese-number-months (cdr list) 1))
Glenn Morris's avatar
Glenn Morris committed
310 311
      ;; Now we can assign numbers to the list for y.
      ;; The first month or two are special.
312
      (if (or (> (car list) next-sign) (>= next-sign (cadr list)))
Glenn Morris's avatar
Glenn Morris committed
313
          ;; First month on list is a leap month, second is not.
Edward M. Reingold's avatar
Edward M. Reingold committed
314
          (append (list (list 11.5 (car list))
315
                        (list 12 (cadr list)))
316
                  (calendar-chinese-number-months (cddr list) 1))
Glenn Morris's avatar
Glenn Morris committed
317
        ;; First month on list is not a leap month.
Edward M. Reingold's avatar
Edward M. Reingold committed
318
        (append (list (list 12 (car list)))
319
                (if (>= (calendar-chinese-zodiac-sign-on-or-after (cadr list))
320
                        (nth 2 list))
Glenn Morris's avatar
Glenn Morris committed
321
                    ;; Second month on list is a leap month.
322
                    (cons (list 12.5 (cadr list))
323
                          (calendar-chinese-number-months (cddr list) 1))
Glenn Morris's avatar
Glenn Morris committed
324
                  ;; Second month on list is not a leap month.
325
                  (calendar-chinese-number-months (cdr list) 1)))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
326

327
(defvar calendar-chinese-year-cache
328
  ;; Maintainers: delete existing value, position point at start of
329
  ;; empty line, then call  M-: (calendar-chinese-year-cache-init N)
330
  '((2005 (12 731956) (1 731986) (2 732015) (3 732045) (4 732074) (5 732104)
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
          (6 732133) (7 732163) (8 732193) (9 732222) (10 732252) (11 732281))
    (2006 (12 732311) (1 732340) (2 732370) (3 732399) (4 732429) (5 732458)
          (6 732488) (7 732517) (7.5 732547) (8 732576) (9 732606) (10 732636)
          (11 732665))
    (2007 (12 732695) (1 732725) (2 732754) (3 732783) (4 732813) (5 732842)
          (6 732871) (7 732901) (8 732930) (9 732960) (10 732990) (11 733020))
    (2008 (12 733049) (1 733079) (2 733109) (3 733138) (4 733167) (5 733197)
          (6 733226) (7 733255) (8 733285) (9 733314) (10 733344) (11 733374))
    (2009 (12 733403) (1 733433) (2 733463) (3 733493) (4 733522) (5 733551)
          (5.5 733581) (6 733610) (7 733639) (8 733669) (9 733698) (10 733728)
          (11 733757))
    (2010 (12 733787) (1 733817) (2 733847) (3 733876) (4 733906) (5 733935)
          (6 733965) (7 733994) (8 734023) (9 734053) (10 734082) (11 734112))
    (2011 (12 734141) (1 734171) (2 734201) (3 734230) (4 734260) (5 734290)
          (6 734319) (7 734349) (8 734378) (9 734407) (10 734437) (11 734466))
    (2012 (12 734496) (1 734525) (2 734555) (3 734584) (4 734614) (4.5 734644)
          (5 734673) (6 734703) (7 734732) (8 734762) (9 734791) (10 734821)
          (11 734850))
    (2013 (12 734880) (1 734909) (2 734939) (3 734968) (4 734998) (5 735027)
          (6 735057) (7 735087) (8 735116) (9 735146) (10 735175) (11 735205))
    (2014 (12 735234) (1 735264) (2 735293) (3 735323) (4 735352) (5 735382)
          (6 735411) (7 735441) (8 735470) (9 735500) (9.5 735530) (10 735559)
          (11 735589))
    (2015 (12 735618) (1 735648) (2 735677) (3 735707) (4 735736) (5 735765)
          (6 735795) (7 735824) (8 735854) (9 735884) (10 735914) (11 735943))
    (2016 (12 735973) (1 736002) (2 736032) (3 736061) (4 736091) (5 736120)
          (6 736149) (7 736179) (8 736208) (9 736238) (10 736268) (11 736297))
    (2017 (12 736327) (1 736357) (2 736386) (3 736416) (4 736445) (5 736475)
          (6 736504) (6.5 736533) (7 736563) (8 736592) (9 736622) (10 736651)
          (11 736681))
    (2018 (12 736711) (1 736741) (2 736770) (3 736800) (4 736829) (5 736859)
          (6 736888) (7 736917) (8 736947) (9 736976) (10 737006) (11 737035))
    (2019 (12 737065) (1 737095) (2 737125) (3 737154) (4 737184) (5 737213)
          (6 737243) (7 737272) (8 737301) (9 737331) (10 737360) (11 737389))
    (2020 (12 737419) (1 737449) (2 737478) (3 737508) (4 737538) (4.5 737568)
          (5 737597) (6 737627) (7 737656) (8 737685) (9 737715) (10 737744)
367 368 369 370 371 372 373 374 375 376 377 378 379
          (11 737774))
    (2021 (12 737803) (1 737833) (2 737862) (3 737892) (4 737922) (5 737951)
          (6 737981) (7 738010) (8 738040) (9 738069) (10 738099) (11 738128))
    (2022 (12 738158) (1 738187) (2 738217) (3 738246) (4 738276) (5 738305)
          (6 738335) (7 738365) (8 738394) (9 738424) (10 738453) (11 738483))
    (2023 (12 738512) (1 738542) (2 738571) (2.5 738601) (3 738630) (4 738659)
          (5 738689) (6 738719) (7 738748) (8 738778) (9 738808) (10 738837)
          (11 738867))
    (2024 (12 738896) (1 738926) (2 738955) (3 738985) (4 739014) (5 739043)
          (6 739073) (7 739102) (8 739132) (9 739162) (10 739191) (11 739221))
    (2025 (12 739251) (1 739280) (2 739310) (3 739339) (4 739369) (5 739398)
          (6 739427) (6.5 739457) (7 739486) (8 739516) (9 739545) (10 739575)
          (11 739605)))
380 381 382
  "Alist of Chinese year structures as determined by `chinese-year'.
The default can be nil, but some values are precomputed for efficiency.")

383
(defun calendar-chinese-year (y)
384 385 386 387
  "The structure of the Chinese year for Gregorian year Y.
The result is a list of pairs (i d), where month i begins on absolute date d,
of the Chinese months from the Chinese month following the solstice in
Gregorian year Y-1 to the Chinese month of the solstice of Gregorian year Y.
388 389
The list is cached in `calendar-chinese-year-cache' for further use."
  (let ((list (cdr (assoc y calendar-chinese-year-cache))))
390
    (or list
391 392
        (setq list (calendar-chinese-compute-year y)
              calendar-chinese-year-cache (append calendar-chinese-year-cache
393 394 395 396
                                         (list (cons y list)))))
    list))

;; Maintainer use.
397 398
(defun calendar-chinese-year-cache-init (year)
  "Insert an initialization value for `calendar-chinese-year-cache' after point.
399 400
Computes values for 10 years either side of YEAR."
  (setq year (- year 10))
401
  (let (calendar-chinese-year-cache end)
402 403 404
    (save-excursion
      (insert "'(")
      (dotimes (n 21)
405 406
        (princ (cons year (calendar-chinese-compute-year year))
               (current-buffer))
Glenn Morris's avatar
Glenn Morris committed
407 408
        (insert (if (= n 20) ")" "\n"))
        (setq year (1+ year)))
409 410 411 412 413 414 415 416 417
      (setq end (point)))
    (save-excursion
      ;; fill-column -/+ 5.
      (while (and (< (point) end)
                  (re-search-forward "^.\\{65,75\\})" end t))
        (delete-char 1)
        (insert "\n")))
    (indent-region (point) end)))

418
(defun calendar-chinese-to-absolute (date)
Edward M. Reingold's avatar
Edward M. Reingold committed
419
  "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
420 421
DATE is a Chinese date (cycle year month day).  The Gregorian date
Sunday, December 31, 1 BC is imaginary."
Edward M. Reingold's avatar
Edward M. Reingold committed
422
  (let* ((cycle (car date))
423 424 425
         (year (cadr date))
         (month (nth 2 date))
         (day (nth 3 date))
Glenn Morris's avatar
Glenn Morris committed
426 427 428 429
         (g-year (+ (* (1- cycle) 60)  ; years in prior cycles
                    (1- year)          ; prior years this cycle
                    -2636)))           ; years before absolute date 0
    (+ (1- day)                        ; prior days this month
430
       (cadr                    ; absolute date of start of this month
431 432 433 434 435 436
        (assoc month (append (memq (assoc 1 (calendar-chinese-year g-year))
                                   (calendar-chinese-year g-year))
                             (calendar-chinese-year (1+ g-year))))))))

(define-obsolete-function-alias 'calendar-absolute-from-chinese
  'calendar-chinese-to-absolute "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
437 438 439 440 441

(defun calendar-chinese-from-absolute (date)
  "Compute Chinese date (cycle year month day) corresponding to absolute DATE.
The absolute date is the number of days elapsed since the (imaginary)
Gregorian date Sunday, December 31, 1 BC."
442
  (let* ((g-year (calendar-extract-year
Edward M. Reingold's avatar
Edward M. Reingold committed
443
                  (calendar-gregorian-from-absolute date)))
Edward M. Reingold's avatar
Edward M. Reingold committed
444
         (c-year (+ g-year 2695))
445 446 447
         (list (append (calendar-chinese-year (1- g-year))
                       (calendar-chinese-year g-year)
                       (calendar-chinese-year (1+ g-year)))))
448
    (while (<= (cadr (cadr list)) date)
Glenn Morris's avatar
Glenn Morris committed
449 450
      ;; The first month on the list is in Chinese year c-year.
      ;; Date is on or after start of second month on list...
451
      (if (= 1 (caar (cdr list)))
Glenn Morris's avatar
Glenn Morris committed
452
          ;; Second month on list is a new Chinese year...
Edward M. Reingold's avatar
Edward M. Reingold committed
453
          (setq c-year (1+ c-year)))
Glenn Morris's avatar
Glenn Morris committed
454
      ;; ...so first month on list is of no interest.
Edward M. Reingold's avatar
Edward M. Reingold committed
455
      (setq list (cdr list)))
Edward M. Reingold's avatar
Edward M. Reingold committed
456
    (list (/ (1- c-year) 60)
457 458
          ;; Remainder of c-year/60 with 60 instead of 0.
          (1+ (mod (1- c-year) 60))
459 460
          (caar list)
          (1+ (- date (cadr (car list)))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
461

462
;; Bound in calendar-generate.
463 464 465
(defvar displayed-month)
(defvar displayed-year)

466
;;;###holiday-autoload
Edward M. Reingold's avatar
Edward M. Reingold committed
467
(defun holiday-chinese-new-year ()
468 469
  "Date of Chinese New Year, if visible in calendar.
Returns (((MONTH DAY YEAR) TEXT)), where the date is Gregorian."
Edward M. Reingold's avatar
Edward M. Reingold committed
470
  (let ((m displayed-month)
471 472
        (y displayed-year)
        chinese-new-year)
473 474 475
    ;; In the Gregorian calendar, CNY falls between Jan 21 and Feb 20.
    ;; Jan is visible if displayed-month = 12, 1, 2; Feb if d-m = 1, 2, 3.
    ;; If we shift the calendar forward one month, we can do a
Glenn Morris's avatar
Glenn Morris committed
476
    ;; one-sided test, namely: d-m <= 4 means CNY might be visible.
477
    (calendar-increment-month m y 1)    ; shift forward a month
478
    (and (< m 5)
479 480 481 482
         (calendar-date-is-visible-p
          (setq chinese-new-year
                (calendar-gregorian-from-absolute
                 (cadr (assoc 1 (calendar-chinese-year y))))))
483 484 485 486
         (list
          (list chinese-new-year
                (format "Chinese New Year (%s)"
                        (calendar-chinese-sexagesimal-name (+ y 57))))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
487

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
;;;###holiday-autoload
(defun holiday-chinese-qingming ()
  "Date of Chinese Qingming Festival, if visible in calendar.
Returns (((MONTH DAY YEAR) TEXT)), where the date is Gregorian."
  (when (memq displayed-month '(3 4 5)) ; is April visible?
    (list (list (calendar-gregorian-from-absolute
                 ;; 15 days after Vernal Equinox.
                 (+ 15
                    (calendar-chinese-zodiac-sign-on-or-after
                     (calendar-absolute-from-gregorian
                      (list 3 15 displayed-year)))))
                "Qingming Festival"))))

;;;###holiday-autoload
(defun holiday-chinese-winter-solstice ()
  "Date of Chinese winter solstice, if visible in calendar.
Returns (((MONTH DAY YEAR) TEXT)), where the date is Gregorian."
  (when (memq displayed-month '(11 12 1)) ; is December visible?
    (list (list (calendar-gregorian-from-absolute
                 (calendar-chinese-zodiac-sign-on-or-after
                  (calendar-absolute-from-gregorian
                   (list 12 15 (if (eq displayed-month 1)
                                   (1- displayed-year)
                                 displayed-year)))))
                "Winter Solstice Festival"))))

;;;###holiday-autoload
(defun holiday-chinese (month day string)
  "Holiday on Chinese MONTH, DAY called STRING.
If MONTH, DAY (Chinese) is visible, returns the corresponding
Gregorian date as the list (((month day year) STRING)).
Returns nil if it is not visible in the current calendar window."
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
  (let ((date
         (calendar-gregorian-from-absolute
          ;; A basic optimization.  Chinese year can only change if
          ;; Jan or Feb are visible.  FIXME can we do more?
          (if (memq displayed-month '(12 1 2 3))
              ;; This is calendar-nongregorian-visible-p adapted for
              ;; the form of chinese dates: (cycle year month day) as
              ;; opposed to (month day year).
              (let* ((m1 displayed-month)
                     (y1 displayed-year)
                     (m2 displayed-month)
                     (y2 displayed-year)
                     ;; Absolute date of first/last dates in calendar window.
                     (start-date (progn
                                   (calendar-increment-month m1 y1 -1)
                                   (calendar-absolute-from-gregorian
                                    (list m1 1 y1))))
                     (end-date (progn
                                 (calendar-increment-month m2 y2 1)
                                 (calendar-absolute-from-gregorian
                                  (list m2 (calendar-last-day-of-month m2 y2)
                                        y2))))
                     ;; Local date of first/last date in calendar window.
                     (local-start (calendar-chinese-from-absolute start-date))
                     (local-end (calendar-chinese-from-absolute end-date))
                     ;; When Chinese New Year is visible on the far
                     ;; right of the calendar, what is the earliest
                     ;; Chinese month in the previous year that might
                     ;; still visible?  This test doesn't have to be precise.
                     (local (if (< month 10) local-end local-start))
                     (cycle (car local))
                     (year (cadr local)))
                (calendar-chinese-to-absolute (list cycle year month day)))
            ;; Simple form for when new years are not visible.
            (+ (cadr (assoc month (calendar-chinese-year displayed-year)))
               (1- day))))))
556 557 558
    (if (calendar-date-is-visible-p date)
        (list (list date string)))))

559
;;;###cal-autoload
Edward M. Reingold's avatar
Edward M. Reingold committed
560 561 562 563 564 565 566
(defun calendar-chinese-date-string (&optional date)
  "String of Chinese date of Gregorian DATE.
Defaults to today's date if DATE is not given."
  (let* ((a-date (calendar-absolute-from-gregorian
                  (or date (calendar-current-date))))
         (c-date (calendar-chinese-from-absolute a-date))
         (cycle (car c-date))
567 568 569
         (year (cadr c-date))
         (month (nth 2 c-date))
         (day (nth 3 c-date))
570
         (this-month (calendar-chinese-to-absolute
Edward M. Reingold's avatar
Edward M. Reingold committed
571
                      (list cycle year month 1)))
572
         (next-month (calendar-chinese-to-absolute
573 574
                      (list (if (= year 60) (1+ cycle) cycle)
                            (if (= (floor month) 12) (1+ year) year)
575 576 577
                            ;; Remainder of (1+(floor month))/12, with
                            ;; 12 instead of 0.
                            (1+ (mod (floor month) 12))
578
                            1))))
579
    (format "Cycle %s, year %s (%s), %smonth %s%s, day %s (%s)"
Edward M. Reingold's avatar
Edward M. Reingold committed
580
            cycle
581
            year (calendar-chinese-sexagesimal-name year)
Edward M. Reingold's avatar
Edward M. Reingold committed
582 583 584 585 586
            (if (not (integerp month))
                "second "
              (if (< 30 (- next-month this-month))
                  "first "
                ""))
Edward M. Reingold's avatar
Edward M. Reingold committed
587
            (floor month)
588
            (if (integerp month)
589
                (format " (%s)" (calendar-chinese-sexagesimal-name
590
                                 (+ (* 12 year) month 50)))
591
              "")
592
            day (calendar-chinese-sexagesimal-name (+ a-date 15)))))
593

594
;;;###cal-autoload
595
(defun calendar-chinese-print-date ()
Edward M. Reingold's avatar
Edward M. Reingold committed
596 597 598 599 600 601
  "Show the Chinese date equivalents of date."
  (interactive)
  (message "Computing Chinese date...")
  (message "Chinese date: %s"
           (calendar-chinese-date-string (calendar-cursor-to-date t))))

602 603 604 605
(define-obsolete-function-alias 'calendar-print-chinese-date
  'calendar-chinese-print-date "23.1")

(defun calendar-chinese-months-to-alist (l)
606 607 608 609 610 611 612
  "Make list of months L into an assoc list."
  (and l (car l)
       (if (and (cdr l) (cadr l))
           (if (= (car l) (floor (cadr l)))
               (append
                (list (cons (format "%s (first)" (car l)) (car l))
                      (cons (format "%s (second)" (car l)) (cadr l)))
613
                (calendar-chinese-months-to-alist (cddr l)))
614
             (append
615
              (list (cons (number-to-string (car l)) (car l)))
616
              (calendar-chinese-months-to-alist (cdr l))))
617
         (list (cons (number-to-string (car l)) (car l))))))
618

619
(defun calendar-chinese-months (c y)
620 621 622 623
  "A list of the months in cycle C, year Y of the Chinese calendar."
  (memq 1 (append
           (mapcar (lambda (x)
                     (car x))
624
                   (calendar-chinese-year (calendar-extract-year
625 626 627
                                           (calendar-gregorian-from-absolute
                                            (calendar-chinese-to-absolute
                                             (list c y 1 1))))))
628 629
           (mapcar (lambda (x)
                     (if (> (car x) 11) (car x)))
630
                   (calendar-chinese-year (calendar-extract-year
631 632 633 634 635
                                           (calendar-gregorian-from-absolute
                                            (calendar-chinese-to-absolute
                                             (list (if (= y 60) (1+ c) c)
                                                   (if (= y 60) 1 y)
                                                   1 1)))))))))
636

637
;;;###cal-autoload
638
(defun calendar-chinese-goto-date (date &optional noecho)
Edward M. Reingold's avatar
Edward M. Reingold committed
639
  "Move cursor to Chinese date DATE.
640
Echo Chinese date unless NOECHO is non-nil."
Edward M. Reingold's avatar
Edward M. Reingold committed
641 642
  (interactive
   (let* ((c (calendar-chinese-from-absolute
643
              (calendar-absolute-from-gregorian (calendar-current-date))))
Edward M. Reingold's avatar
Edward M. Reingold committed
644
          (cycle (calendar-read
Edward M. Reingold's avatar
Edward M. Reingold committed
645
                  "Chinese calendar cycle number (>44): "
646
                  (lambda (x) (> x 44))
647
                  (number-to-string (car c))))
Edward M. Reingold's avatar
Edward M. Reingold committed
648
          (year (calendar-read
Edward M. Reingold's avatar
Edward M. Reingold committed
649
                 "Year in Chinese cycle (1..60): "
650
                 (lambda (x) (and (<= 1 x) (<= x 60)))
651
                 (number-to-string (cadr c))))
652 653
          (month-list (calendar-chinese-months-to-alist
                       (calendar-chinese-months cycle year)))
Edward M. Reingold's avatar
Edward M. Reingold committed
654 655 656 657 658
          (month (cdr (assoc
                       (completing-read "Chinese calendar month: "
                                        month-list nil t)
                       month-list)))
          (last (if (= month
659 660 661
                       (nth 2
                            (calendar-chinese-from-absolute
                             (+ 29
662
                                (calendar-chinese-to-absolute
663
                                 (list cycle year month 1))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
664 665 666 667
                    30
                  29))
          (day (calendar-read
                (format "Chinese calendar day (1-%d): " last)
668
                (lambda (x) (and (<= 1 x) (<= x last))))))
Edward M. Reingold's avatar
Edward M. Reingold committed
669 670
     (list (list cycle year month day))))
  (calendar-goto-date (calendar-gregorian-from-absolute
671 672 673 674 675
                       (calendar-chinese-to-absolute date)))
  (or noecho (calendar-chinese-print-date)))

(define-obsolete-function-alias 'calendar-goto-chinese-date
  'calendar-chinese-goto-date "23.1")
Edward M. Reingold's avatar
Edward M. Reingold committed
676

Glenn Morris's avatar
Glenn Morris committed
677 678
(defvar date)

Glenn Morris's avatar
Glenn Morris committed
679
;; To be called from diary-list-sexp-entries, where DATE is bound.
680
;;;###diary-autoload
Edward M. Reingold's avatar
Edward M. Reingold committed
681 682 683 684
(defun diary-chinese-date ()
  "Chinese calendar equivalent of date diary entry."
  (format "Chinese date: %s" (calendar-chinese-date-string date)))

685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
;;;; diary support

(autoload 'calendar-mark-1         "diary-lib")
(autoload 'diary-mark-entries-1    "diary-lib")
(autoload 'diary-list-entries-1    "diary-lib")
(autoload 'diary-insert-entry-1    "diary-lib")
(autoload 'diary-date-display-form "diary-lib")
(autoload 'diary-make-date         "diary-lib")
(autoload 'diary-ordinal-suffix    "diary-lib")
(defvar diary-sexp-entry-symbol)
(defvar entry)                    ;used by `diary-chinese-anniversary'

(defvar calendar-chinese-month-name-array
  ["正月" "二月" "三月" "四月" "五月" "六月"
   "七月" "八月" "九月" "十月" "冬月" "臘月"])

;;; NOTE: In the diary the cycle and year of a Chinese date is
;;; combined using this formula: (+ (* cycle 100) year).
;;;
;;; These two functions convert to and back from this representation.
(defun calendar-chinese-from-absolute-for-diary (date)
  (pcase-let ((`(,c ,y ,m ,d) (calendar-chinese-from-absolute date)))
    (list m d (+ (* c 100) y))))

(defun calendar-chinese-to-absolute-for-diary (date)
  (pcase-let ((`(,m ,d ,y) date))
    (calendar-chinese-to-absolute
     (list (floor y 100) (mod y 100) m d))))

(defun calendar-chinese-mark-date-pattern (month day year &optional color)
  (calendar-mark-1 month day year
                   #'calendar-chinese-from-absolute-for-diary
                   #'calendar-chinese-to-absolute-for-diary
                   color))

;;;###cal-autoload
(defun diary-chinese-mark-entries ()
  "Mark days in the calendar window that have Chinese date diary entries.
Marks each entry in `diary-file' (or included files) visible in the calendar
window.  See `diary-chinese-list-entries' for more information.

This function is provided for use with `diary-nongregorian-marking-hook'."
  (diary-mark-entries-1 #'calendar-chinese-mark-date-pattern
                        calendar-chinese-month-name-array
                        diary-chinese-entry-symbol
                        #'calendar-chinese-from-absolute-for-diary))

;;;###cal-autoload
(defun diary-chinese-list-entries ()
  "Add any Chinese date entries from the diary file to `diary-entries-list'.
Chinese date diary entries must be prefixed by `diary-chinese-entry-symbol'
\(normally a `C').  The same `diary-date-forms' govern the style
of the Chinese calendar entries.  If a Chinese date diary entry begins with
`diary-nonmarking-symbol', the entry will appear in the diary listing,
but will not be marked in the calendar.

This function is provided for use with `diary-nongregorian-listing-hook'."
  (diary-list-entries-1 calendar-chinese-month-name-array
                        diary-chinese-entry-symbol
                        #'calendar-chinese-from-absolute-for-diary))

;;;###cal-autoload
(defun diary-chinese-anniversary (month day &optional year mark)
  "Like `diary-anniversary' (which see) but accepts Chinese date."
  (pcase-let* ((ddate (diary-make-date month day year))
               (`(,dc ,dy ,dm ,dd)      ;diary chinese date
                (if year
                    (calendar-chinese-from-absolute
                     (calendar-chinese-to-absolute-for-diary ddate))
                  (list nil nil (calendar-extract-month ddate)
                        (calendar-extract-day ddate))))
               (`(,cc ,cy ,cm ,cd)      ;current chinese date
                (calendar-chinese-from-absolute
                 (calendar-absolute-from-gregorian date)))
               (diff (if (and dc dy)
                         (+ (* 60 (- cc dc)) (- cy dy))
                       100)))
    (and (> diff 0) (= dm cm) (= dd cd)
         (cons mark (format entry diff (diary-ordinal-suffix diff))))))

;;;###cal-autoload
(defun diary-chinese-insert-anniversary-entry (&optional arg)
  "Insert an anniversary diary entry for the Chinese date at point.
Prefix argument ARG makes the entry nonmarking."
  (interactive "P")
  (let ((calendar-date-display-form (diary-date-display-form)))
    (diary-make-entry
     (format "%s(diary-chinese-anniversary %s)"
             diary-sexp-entry-symbol
             (calendar-date-string
              (calendar-chinese-from-absolute-for-diary
               (calendar-absolute-from-gregorian (calendar-cursor-to-date t)))))
     arg)))

;;;###cal-autoload
(defun diary-chinese-insert-entry (&optional arg)
  "Insert a diary entry for the Chinese date at point."
  (interactive "P")
  (diary-insert-entry-1 nil arg calendar-chinese-month-name-array
                        diary-chinese-entry-symbol
                        #'calendar-chinese-from-absolute-for-diary))

;;;###cal-autoload
(defun diary-chinese-insert-monthly-entry (&optional arg)
  "Insert a monthly diary entry for the Chinese date at point."
  (interactive "P")
  (diary-insert-entry-1 'monthly arg calendar-chinese-month-name-array
                        diary-chinese-entry-symbol
                        #'calendar-chinese-from-absolute-for-diary))

;;;###cal-autoload
(defun diary-chinese-insert-yearly-entry (&optional arg)
  "Insert a yearly diary entry for the Chinese date at point."
  (interactive "P")
  (diary-insert-entry-1 'yearly arg calendar-chinese-month-name-array
                        diary-chinese-entry-symbol
                        #'calendar-chinese-from-absolute-for-diary))

803
(provide 'cal-china)
Edward M. Reingold's avatar
Edward M. Reingold committed
804

805
;;; cal-china.el ends here