cal-mayan.el 14.7 KB
Newer Older
1
;;; cal-mayan.el --- calendar functions for the Mayan calendars
Jim Blandy's avatar
Jim Blandy committed
2

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 1992, 1993, 1995, 1997, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2006, 2007, 2008  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6

;; Author: Stewart M. Clamen <clamen@cs.cmu.edu>
Glenn Morris's avatar
Glenn Morris committed
7
;;         Edward M. Reingold <reingold@cs.uiuc.edu>
8
;; Maintainer: Glenn Morris <rgm@gnu.org>
Eric S. Raymond's avatar
Eric S. Raymond committed
9 10
;; Keywords: calendar
;; Human-Keywords: Mayan calendar, Maya, calendar, diary
Jim Blandy's avatar
Jim Blandy committed
11 12 13

;; This file is part of GNU Emacs.

14 15
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
16
;; the Free Software Foundation; either version 3, or (at your option)
17 18
;; any later version.

Jim Blandy's avatar
Jim Blandy committed
19
;; GNU Emacs is distributed in the hope that it will be useful,
20 21 22 23 24
;; 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
Erik Naggum's avatar
Erik Naggum committed
25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
26 27
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Jim Blandy's avatar
Jim Blandy committed
28 29 30

;;; Commentary:

31
;; See calendar.el.
Jim Blandy's avatar
Jim Blandy committed
32 33 34 35 36

;;; Code:

(require 'calendar)

37
(defconst calendar-mayan-days-before-absolute-zero 1137142
38
  "Number of days of the Mayan calendar epoch before absolute day 0.
39 40 41
This is the Goodman-Martinez-Thompson correlation used by almost all experts,
but some use 1137140.  Using 1232041 gives you Spinden's correlation; using
1142840 gives you Hochleitner's correlation.")
Jim Blandy's avatar
Jim Blandy committed
42 43 44 45 46 47

(defconst calendar-mayan-haab-at-epoch '(8 . 18)
  "Mayan haab date at the epoch.")

(defconst calendar-mayan-haab-month-name-array
  ["Pop" "Uo" "Zip" "Zotz" "Tzec" "Xul" "Yaxkin" "Mol" "Chen" "Yax"
48 49
   "Zac" "Ceh" "Mac" "Kankin" "Muan" "Pax" "Kayab" "Cumku"]
  "Names of the Mayan haab months.")
Jim Blandy's avatar
Jim Blandy committed
50 51 52 53 54 55

(defconst calendar-mayan-tzolkin-at-epoch '(4 . 20)
  "Mayan tzolkin date at the epoch.")

(defconst calendar-mayan-tzolkin-names-array
  ["Imix" "Ik" "Akbal" "Kan" "Chicchan" "Cimi" "Manik" "Lamat" "Muluc" "Oc"
56 57
   "Chuen" "Eb" "Ben" "Ix" "Men" "Cib" "Caban" "Etznab" "Cauac" "Ahau"]
  "Names of the Mayan tzolkin months.")
Jim Blandy's avatar
Jim Blandy committed
58 59 60

(defun calendar-mayan-long-count-from-absolute (date)
  "Compute the Mayan long count corresponding to the absolute DATE."
61 62 63 64 65 66 67 68 69 70
  (let* ((long-count (+ date calendar-mayan-days-before-absolute-zero))
         (baktun (/ long-count 144000))
         (remainder (% long-count 144000))
         (katun (/ remainder 7200))
         (remainder (% remainder 7200))
         (tun (/ remainder 360))
         (remainder (% remainder 360))
         (uinal (/ remainder 20))
         (kin (% remainder 20)))
    (list baktun katun tun uinal kin)))
Jim Blandy's avatar
Jim Blandy committed
71 72 73 74 75 76

(defun calendar-mayan-long-count-to-string (mayan-long-count)
  "Convert MAYAN-LONG-COUNT into traditional written form."
  (apply 'format (cons "%s.%s.%s.%s.%s" mayan-long-count)))

(defun calendar-string-to-mayan-long-count (str)
77
  "Given STR, a string of format \"%d.%d.%d.%d.%d\", return list of numbers."
78
  (let ((end 0)
79
        rlc)
80
    (condition-case nil
Jim Blandy's avatar
Jim Blandy committed
81
        (progn
82 83 84 85
          ;; cf split-string.
          (while (string-match "[0-9]+" str end)
            (setq rlc (cons (string-to-number (match-string 0 str)) rlc)
                  end (match-end 0)))
86
          (unless (= (length rlc) 5) (signal 'invalid-read-syntax nil)))
Jim Blandy's avatar
Jim Blandy committed
87
      (invalid-read-syntax nil))
88
    (nreverse rlc)))
Jim Blandy's avatar
Jim Blandy committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102

(defun calendar-mayan-haab-from-absolute (date)
  "Convert absolute DATE into a Mayan haab date (a pair)."
  (let* ((long-count (+ date calendar-mayan-days-before-absolute-zero))
         (day-of-haab
          (% (+ long-count
                (car calendar-mayan-haab-at-epoch)
                (* 20 (1- (cdr calendar-mayan-haab-at-epoch))))
             365))
         (day (% day-of-haab 20))
         (month (1+ (/ day-of-haab 20))))
    (cons day month)))

(defun calendar-mayan-haab-difference (date1 date2)
103
  "Number of days from Mayan haab DATE1 to next occurrence of haab date DATE2."
104
  (mod (+ (* 20 (- (cdr date2) (cdr date1)))
Glenn Morris's avatar
Glenn Morris committed
105
          (- (car date2) (car date1)))
106
       365))
Jim Blandy's avatar
Jim Blandy committed
107 108 109

(defun calendar-mayan-haab-on-or-before (haab-date date)
  "Absolute date of latest HAAB-DATE on or before absolute DATE."
110 111
  (- date
     (% (- date
Glenn Morris's avatar
Glenn Morris committed
112 113 114
           (calendar-mayan-haab-difference
            (calendar-mayan-haab-from-absolute 0) haab-date))
        365)))
Jim Blandy's avatar
Jim Blandy committed
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
;;;###cal-autoload
(defun calendar-mayan-date-string (&optional date)
  "String of Mayan date of Gregorian DATE; default today."
  (let* ((d (calendar-absolute-from-gregorian
             (or date (calendar-current-date))))
         (tzolkin (calendar-mayan-tzolkin-from-absolute d))
         (haab (calendar-mayan-haab-from-absolute d))
         (long-count (calendar-mayan-long-count-from-absolute d)))
    (format "Long count = %s; tzolkin = %s; haab = %s"
            (calendar-mayan-long-count-to-string long-count)
            (calendar-mayan-tzolkin-to-string tzolkin)
            (calendar-mayan-haab-to-string haab))))

;;;###cal-autoload
(defun calendar-print-mayan-date ()
  "Show the Mayan long count, tzolkin, and haab equivalents of date."
  (interactive)
  (message "Mayan date: %s"
           (calendar-mayan-date-string (calendar-cursor-to-date t))))

(defun calendar-read-mayan-haab-date ()
  "Prompt for a Mayan haab date."
  (let* ((completion-ignore-case t)
         (haab-day (calendar-read
                    "Haab kin (0-19): "
                    (lambda (x) (and (>= x 0) (< x 20)))))
         (haab-month-list (append calendar-mayan-haab-month-name-array
                                  (and (< haab-day 5) '("Uayeb"))))
         (haab-month (cdr
                      (assoc-string
                       (completing-read "Haab uinal: "
                                        (mapcar 'list haab-month-list)
                                        nil t)
                       (calendar-make-alist haab-month-list 1) t))))
    (cons haab-day haab-month)))

(defun calendar-read-mayan-tzolkin-date ()
  "Prompt for a Mayan tzolkin date."
  (let* ((completion-ignore-case t)
         (tzolkin-count (calendar-read
                         "Tzolkin kin (1-13): "
                         (lambda (x) (and (> x 0) (< x 14)))))
         (tzolkin-name-list (append calendar-mayan-tzolkin-names-array nil))
         (tzolkin-name (cdr
                        (assoc-string
                         (completing-read "Tzolkin uinal: "
                                          (mapcar 'list tzolkin-name-list)
                                          nil t)
                         (calendar-make-alist tzolkin-name-list 1) t))))
    (cons tzolkin-count tzolkin-name)))

167
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
168
(defun calendar-next-haab-date (haab-date &optional noecho)
169
  "Move cursor to next instance of Mayan HAAB-DATE.
170
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
171 172 173 174 175 176 177 178 179
  (interactive (list (calendar-read-mayan-haab-date)))
  (calendar-goto-date
   (calendar-gregorian-from-absolute
    (calendar-mayan-haab-on-or-before
     haab-date
     (+ 365
        (calendar-absolute-from-gregorian (calendar-cursor-to-date))))))
  (or noecho (calendar-print-mayan-date)))

180
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
181
(defun calendar-previous-haab-date (haab-date &optional noecho)
182
  "Move cursor to previous instance of Mayan HAAB-DATE.
183
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
184 185 186 187 188 189 190 191 192
  (interactive (list (calendar-read-mayan-haab-date)))
  (calendar-goto-date
   (calendar-gregorian-from-absolute
    (calendar-mayan-haab-on-or-before
     haab-date
     (1- (calendar-absolute-from-gregorian (calendar-cursor-to-date))))))
  (or noecho (calendar-print-mayan-date)))

(defun calendar-mayan-haab-to-string (haab)
193
  "Convert Mayan HAAB date (a pair) into its traditional written form."
194 195 196 197
  (let ((month (cdr haab)))
    (format "%d %s" (car haab)          ; day
            ;; 19th month consists of 5 special days
            (if (= month 19) "Uayeb"
Glenn Morris's avatar
Glenn Morris committed
198
              (aref calendar-mayan-haab-month-name-array (1- month))))))
Jim Blandy's avatar
Jim Blandy committed
199 200 201 202

(defun calendar-mayan-tzolkin-from-absolute (date)
  "Convert absolute DATE into a Mayan tzolkin date (a pair)."
  (let* ((long-count (+ date calendar-mayan-days-before-absolute-zero))
203 204 205 206 207 208 209
         ;; Remainder on division by 13,20 with 13,20 instead of zero.
         (day (1+ (mod
                   (1- (+ long-count (car calendar-mayan-tzolkin-at-epoch)))
                   13)))
         (name (1+ (mod
                    (1- (+ long-count (cdr calendar-mayan-tzolkin-at-epoch)))
                    20))))
Jim Blandy's avatar
Jim Blandy committed
210 211 212
    (cons day name)))

(defun calendar-mayan-tzolkin-difference (date1 date2)
213
  "Number of days from Mayan tzolkin DATE1 to next occurrence of tzolkin DATE2."
Jim Blandy's avatar
Jim Blandy committed
214 215
  (let ((number-difference (- (car date2) (car date1)))
        (name-difference (- (cdr date2) (cdr date1))))
216
    (mod (+ number-difference
Glenn Morris's avatar
Glenn Morris committed
217 218 219
            (* 13 (mod (* 3 (- number-difference name-difference))
                       20)))
         260)))
Jim Blandy's avatar
Jim Blandy committed
220 221 222

(defun calendar-mayan-tzolkin-on-or-before (tzolkin-date date)
  "Absolute date of latest TZOLKIN-DATE on or before absolute DATE."
223 224
  (- date
     (% (- date (calendar-mayan-tzolkin-difference
Glenn Morris's avatar
Glenn Morris committed
225 226 227
                 (calendar-mayan-tzolkin-from-absolute 0)
                 tzolkin-date))
        260)))
Jim Blandy's avatar
Jim Blandy committed
228

229
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
230
(defun calendar-next-tzolkin-date (tzolkin-date &optional noecho)
231
  "Move cursor to next instance of Mayan TZOLKIN-DATE.
232
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238 239 240 241
  (interactive (list (calendar-read-mayan-tzolkin-date)))
  (calendar-goto-date
   (calendar-gregorian-from-absolute
    (calendar-mayan-tzolkin-on-or-before
     tzolkin-date
     (+ 260
        (calendar-absolute-from-gregorian (calendar-cursor-to-date))))))
  (or noecho (calendar-print-mayan-date)))

242
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
243
(defun calendar-previous-tzolkin-date (tzolkin-date &optional noecho)
244
  "Move cursor to previous instance of Mayan TZOLKIN-DATE.
245
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249 250 251 252 253 254
  (interactive (list (calendar-read-mayan-tzolkin-date)))
  (calendar-goto-date
   (calendar-gregorian-from-absolute
    (calendar-mayan-tzolkin-on-or-before
     tzolkin-date
     (1- (calendar-absolute-from-gregorian (calendar-cursor-to-date))))))
  (or noecho (calendar-print-mayan-date)))

(defun calendar-mayan-tzolkin-to-string (tzolkin)
255
  "Convert Mayan TZOLKIN date (a pair) into its traditional written form."
Jim Blandy's avatar
Jim Blandy committed
256 257 258 259 260
  (format "%d %s"
          (car tzolkin)
          (aref calendar-mayan-tzolkin-names-array (1- (cdr tzolkin)))))

(defun calendar-mayan-tzolkin-haab-on-or-before (tzolkin-date haab-date date)
261 262
  "Absolute date that is Mayan TZOLKIN-DATE and HAAB-DATE.
Latest such date on or before DATE.
263
Returns nil if such a tzolkin-haab combination is impossible."
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268 269 270 271 272
  (let* ((haab-difference
          (calendar-mayan-haab-difference
           (calendar-mayan-haab-from-absolute 0)
           haab-date))
         (tzolkin-difference
          (calendar-mayan-tzolkin-difference
           (calendar-mayan-tzolkin-from-absolute 0)
           tzolkin-date))
         (difference (- tzolkin-difference haab-difference)))
273
    (if (zerop (% difference 5))
Jim Blandy's avatar
Jim Blandy committed
274
        (- date
275
           (mod (- date
Glenn Morris's avatar
Glenn Morris committed
276 277
                   (+ haab-difference (* 365 difference)))
                18980))
Jim Blandy's avatar
Jim Blandy committed
278 279
      nil)))

280
;;;###cal-autoload
281 282 283 284
(defun calendar-next-calendar-round-date (tzolkin-date haab-date
                                                       &optional noecho)
  "Move cursor to next instance of Mayan TZOLKIN-DATE HAAB-DATE combination.
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292 293 294 295 296 297
  (interactive (list (calendar-read-mayan-tzolkin-date)
                     (calendar-read-mayan-haab-date)))
  (let ((date (calendar-mayan-tzolkin-haab-on-or-before
               tzolkin-date haab-date
               (+ 18980 (calendar-absolute-from-gregorian
                         (calendar-cursor-to-date))))))
    (if (not date)
        (error "%s, %s does not exist in the Mayan calendar round"
               (calendar-mayan-tzolkin-to-string tzolkin-date)
               (calendar-mayan-haab-to-string haab-date))
      (calendar-goto-date (calendar-gregorian-from-absolute date))
      (or noecho (calendar-print-mayan-date)))))

298
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
299 300
(defun calendar-previous-calendar-round-date
  (tzolkin-date haab-date &optional noecho)
301
  "Move to previous instance of Mayan TZOLKIN-DATE HAAB-DATE combination.
302
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316
  (interactive (list (calendar-read-mayan-tzolkin-date)
                     (calendar-read-mayan-haab-date)))
  (let ((date (calendar-mayan-tzolkin-haab-on-or-before
               tzolkin-date haab-date
               (1- (calendar-absolute-from-gregorian
                    (calendar-cursor-to-date))))))
    (if (not date)
        (error "%s, %s does not exist in the Mayan calendar round"
               (calendar-mayan-tzolkin-to-string tzolkin-date)
               (calendar-mayan-haab-to-string haab-date))
      (calendar-goto-date (calendar-gregorian-from-absolute date))
      (or noecho (calendar-print-mayan-date)))))

(defun calendar-absolute-from-mayan-long-count (c)
317 318
  "Compute the absolute date corresponding to the Mayan Long Count C.
Long count is a list (baktun katun tun uinal kin)"
Glenn Morris's avatar
Glenn Morris committed
319 320 321 322 323
  (+ (* (nth 0 c) 144000)               ; baktun
     (* (nth 1 c) 7200)                 ; katun
     (* (nth 2 c) 360)                  ; tun
     (* (nth 3 c) 20)                   ; uinal
     (nth 4 c)                          ; kin (days)
324 325
     ;; Days before absolute date 0.
     (- calendar-mayan-days-before-absolute-zero)))
Jim Blandy's avatar
Jim Blandy committed
326

327 328 329 330 331 332 333
(defun calendar-mayan-long-count-common-era (lc)
  "Return non-nil if long count LC represents a date in the Common Era."
  (let ((base (calendar-mayan-long-count-from-absolute 1)))
    (while (and base (= (car lc) (car base)))
      (setq lc (cdr lc)
            base (cdr base)))
    (or (null lc) (> (car lc) (car base)))))
Jim Blandy's avatar
Jim Blandy committed
334

335
;;;###cal-autoload
Jim Blandy's avatar
Jim Blandy committed
336
(defun calendar-goto-mayan-long-count-date (date &optional noecho)
337 338
  "Move cursor to Mayan long count DATE.
Echo Mayan date unless NOECHO is non-nil."
Jim Blandy's avatar
Jim Blandy committed
339
  (interactive
340 341 342 343 344 345 346 347 348 349 350 351
   (let (datum)
     (while (not (setq datum
                       (calendar-string-to-mayan-long-count
                        (read-string
                         "Mayan long count (baktun.katun.tun.uinal.kin): "
                         (calendar-mayan-long-count-to-string
                          (calendar-mayan-long-count-from-absolute
                           (calendar-absolute-from-gregorian
                            (calendar-current-date))))))
                       datum (if (calendar-mayan-long-count-common-era datum)
                                 (list datum)))))
     datum))
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355
  (calendar-goto-date
   (calendar-gregorian-from-absolute
    (calendar-absolute-from-mayan-long-count date)))
  (or noecho (calendar-print-mayan-date)))
356

Glenn Morris's avatar
Glenn Morris committed
357 358 359
(defvar date)

;; To be called from list-sexp-diary-entries, where DATE is bound.
360
;;;###diary-autoload
Jim Blandy's avatar
Jim Blandy committed
361 362
(defun diary-mayan-date ()
  "Show the Mayan long count, haab, and tzolkin dates as a diary entry."
363
  (format "Mayan date: %s" (calendar-mayan-date-string date)))
Jim Blandy's avatar
Jim Blandy committed
364 365 366

(provide 'cal-mayan)

367
;; arch-tag: 54f35144-cd0f-4873-935a-a60129de07df
Jim Blandy's avatar
Jim Blandy committed
368
;;; cal-mayan.el ends here