]> code.delx.au - gnu-emacs/blobdiff - lisp/calendar/cal-mayan.el
Merge from trunk.
[gnu-emacs] / lisp / calendar / cal-mayan.el
index 56522c8dd36e4fc466c7659de5ffa36b01694c74..283c68cb32d123361082a871cd420006ddf20b51 100644 (file)
@@ -1,20 +1,21 @@
 ;;; cal-mayan.el --- calendar functions for the Mayan calendars
 
-;; Copyright (C) 1992, 1993, 1995, 1997, 2001, 2002, 2003, 2004, 2005,
-;;   2006, 2007, 2008  Free Software Foundation, Inc.
+;; Copyright (C) 1992-1993, 1995, 1997, 2001-2011
+;;   Free Software Foundation, Inc.
 
 ;; Author: Stewart M. Clamen <clamen@cs.cmu.edu>
 ;;         Edward M. Reingold <reingold@cs.uiuc.edu>
 ;; Maintainer: Glenn Morris <rgm@gnu.org>
 ;; Keywords: calendar
 ;; Human-Keywords: Mayan calendar, Maya, calendar, diary
+;; Package: calendar
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
-;; This collection of functions implements the features of calendar.el and
-;; diary.el that deal with the Mayan calendar.  It was written jointly by
-
-;;  Stewart M. Clamen                School of Computer Science
-;;  clamen@cs.cmu.edu                Carnegie Mellon University
-;;                                   5000 Forbes Avenue
-;;                                   Pittsburgh, PA 15213
-
-;; and
-
-;;  Edward M. Reingold               Department of Computer Science
-;;  (217) 333-6733                   University of Illinois at Urbana-Champaign
-;;  reingold@cs.uiuc.edu             1304 West Springfield Avenue
-;;                                   Urbana, Illinois 61801
-
-;; Technical details of the Mayan calendrical calculations can be found in
-;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
-;; and Nachum Dershowitz, Cambridge University Press (2001), and in
-;; ``Calendrical Calculations, Part II: Three Historical Calendars''
-;; by E. M. Reingold,  N. Dershowitz, and S. M. Clamen,
-;; Software--Practice and Experience, Volume 23, Number 4 (April, 1993),
-;; pages 383-404.
+;; See calendar.el.
 
 ;;; Code:
 
@@ -94,22 +72,19 @@ but some use 1137140.  Using 1232041 gives you Spinden's correlation; using
   "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)
+(defun calendar-mayan-string-from-long-count (str)
   "Given STR, a string of format \"%d.%d.%d.%d.%d\", return list of numbers."
-  (let ((c (length str))
-        (cc 0)
+  (let ((end 0)
         rlc)
-    (condition-case condition
+    (condition-case nil
         (progn
-          (while (< cc c)
-            (let* ((start (string-match "[0-9]+" str cc))
-                   (end (match-end 0))
-                   (datum (read (substring str start end))))
-              (setq rlc (cons datum rlc)
-                    cc end)))
+          ;; 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)))
           (unless (= (length rlc) 5) (signal 'invalid-read-syntax nil)))
       (invalid-read-syntax nil))
-    (reverse rlc)))
+    (nreverse rlc)))
 
 (defun calendar-mayan-haab-from-absolute (date)
   "Convert absolute DATE into a Mayan haab date (a pair)."
@@ -151,13 +126,16 @@ but some use 1137140.  Using 1232041 gives you Spinden's correlation; using
             (calendar-mayan-haab-to-string haab))))
 
 ;;;###cal-autoload
-(defun calendar-print-mayan-date ()
+(defun calendar-mayan-print-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 ()
+(define-obsolete-function-alias 'calendar-print-mayan-date
+  'calendar-mayan-print-date "23.1")
+
+(defun calendar-mayan-read-haab-date ()
   "Prompt for a Mayan haab date."
   (let* ((completion-ignore-case t)
          (haab-day (calendar-read
@@ -173,7 +151,7 @@ but some use 1137140.  Using 1232041 gives you Spinden's correlation; using
                        (calendar-make-alist haab-month-list 1) t))))
     (cons haab-day haab-month)))
 
-(defun calendar-read-mayan-tzolkin-date ()
+(defun calendar-mayan-read-tzolkin-date ()
   "Prompt for a Mayan tzolkin date."
   (let* ((completion-ignore-case t)
          (tzolkin-count (calendar-read
@@ -189,50 +167,54 @@ but some use 1137140.  Using 1232041 gives you Spinden's correlation; using
     (cons tzolkin-count tzolkin-name)))
 
 ;;;###cal-autoload
-(defun calendar-next-haab-date (haab-date &optional noecho)
+(defun calendar-mayan-next-haab-date (haab-date &optional noecho)
   "Move cursor to next instance of Mayan HAAB-DATE.
 Echo Mayan date unless NOECHO is non-nil."
-  (interactive (list (calendar-read-mayan-haab-date)))
+  (interactive (list (calendar-mayan-read-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)))
+  (or noecho (calendar-mayan-print-date)))
+
+(define-obsolete-function-alias 'calendar-next-haab-date
+  'calendar-mayan-next-haab-date "23.1")
 
 ;;;###cal-autoload
-(defun calendar-previous-haab-date (haab-date &optional noecho)
+(defun calendar-mayan-previous-haab-date (haab-date &optional noecho)
   "Move cursor to previous instance of Mayan HAAB-DATE.
 Echo Mayan date unless NOECHO is non-nil."
-  (interactive (list (calendar-read-mayan-haab-date)))
+  (interactive (list (calendar-mayan-read-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)))
+  (or noecho (calendar-mayan-print-date)))
+
+(define-obsolete-function-alias 'calendar-previous-haab-date
+  'calendar-mayan-previous-haab-date "23.1")
 
 (defun calendar-mayan-haab-to-string (haab)
   "Convert Mayan HAAB date (a pair) into its traditional written form."
-  (let ((month (cdr haab))
-        (day (car haab)))
-    ;; 19th month consists of 5 special days
-    (if (= month 19)
-        (format "%d Uayeb" day)
-      (format "%d %s"
-              day
+  (let ((month (cdr haab)))
+    (format "%d %s" (car haab)          ; day
+            ;; 19th month consists of 5 special days
+            (if (= month 19) "Uayeb"
               (aref calendar-mayan-haab-month-name-array (1- month))))))
 
 (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))
-         (day (calendar-mod
-               (+ long-count (car calendar-mayan-tzolkin-at-epoch))
-               13))
-         (name (calendar-mod
-                (+ long-count (cdr calendar-mayan-tzolkin-at-epoch))
-                20)))
+         ;; 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))))
     (cons day name)))
 
 (defun calendar-mayan-tzolkin-difference (date1 date2)
@@ -253,29 +235,35 @@ Echo Mayan date unless NOECHO is non-nil."
         260)))
 
 ;;;###cal-autoload
-(defun calendar-next-tzolkin-date (tzolkin-date &optional noecho)
+(defun calendar-mayan-next-tzolkin-date (tzolkin-date &optional noecho)
   "Move cursor to next instance of Mayan TZOLKIN-DATE.
 Echo Mayan date unless NOECHO is non-nil."
-  (interactive (list (calendar-read-mayan-tzolkin-date)))
+  (interactive (list (calendar-mayan-read-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)))
+  (or noecho (calendar-mayan-print-date)))
+
+(define-obsolete-function-alias 'calendar-next-tzolkin-date
+  'calendar-mayan-next-tzolkin-date "23.1")
 
 ;;;###cal-autoload
-(defun calendar-previous-tzolkin-date (tzolkin-date &optional noecho)
+(defun calendar-mayan-previous-tzolkin-date (tzolkin-date &optional noecho)
   "Move cursor to previous instance of Mayan TZOLKIN-DATE.
 Echo Mayan date unless NOECHO is non-nil."
-  (interactive (list (calendar-read-mayan-tzolkin-date)))
+  (interactive (list (calendar-mayan-read-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)))
+  (or noecho (calendar-mayan-print-date)))
+
+(define-obsolete-function-alias 'calendar-previous-tzolkin-date
+  'calendar-mayan-previous-tzolkin-date "23.1")
 
 (defun calendar-mayan-tzolkin-to-string (tzolkin)
   "Convert Mayan TZOLKIN date (a pair) into its traditional written form."
@@ -304,12 +292,12 @@ Returns nil if such a tzolkin-haab combination is impossible."
       nil)))
 
 ;;;###cal-autoload
-(defun calendar-next-calendar-round-date (tzolkin-date haab-date
+(defun calendar-mayan-next-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."
-  (interactive (list (calendar-read-mayan-tzolkin-date)
-                     (calendar-read-mayan-haab-date)))
+  (interactive (list (calendar-mayan-read-tzolkin-date)
+                     (calendar-mayan-read-haab-date)))
   (let ((date (calendar-mayan-tzolkin-haab-on-or-before
                tzolkin-date haab-date
                (+ 18980 (calendar-absolute-from-gregorian
@@ -319,15 +307,18 @@ Echo Mayan date unless NOECHO is non-nil."
                (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)))))
+      (or noecho (calendar-mayan-print-date)))))
+
+(define-obsolete-function-alias 'calendar-next-calendar-round-date
+  'calendar-mayan-next-round-date "23.1")
 
 ;;;###cal-autoload
-(defun calendar-previous-calendar-round-date
+(defun calendar-mayan-previous-round-date
   (tzolkin-date haab-date &optional noecho)
   "Move to previous instance of Mayan TZOLKIN-DATE HAAB-DATE combination.
 Echo Mayan date unless NOECHO is non-nil."
-  (interactive (list (calendar-read-mayan-tzolkin-date)
-                     (calendar-read-mayan-haab-date)))
+  (interactive (list (calendar-mayan-read-tzolkin-date)
+                     (calendar-mayan-read-haab-date)))
   (let ((date (calendar-mayan-tzolkin-haab-on-or-before
                tzolkin-date haab-date
                (1- (calendar-absolute-from-gregorian
@@ -337,9 +328,12 @@ Echo Mayan date unless NOECHO is non-nil."
                (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)))))
+      (or noecho (calendar-mayan-print-date)))))
 
-(defun calendar-absolute-from-mayan-long-count (c)
+(define-obsolete-function-alias 'calendar-previous-calendar-round-date
+  'calendar-mayan-previous-round-date "23.1")
+
+(defun calendar-mayan-long-count-to-absolute (c)
   "Compute the absolute date corresponding to the Mayan Long Count C.
 Long count is a list (baktun katun tun uinal kin)"
   (+ (* (nth 0 c) 144000)               ; baktun
@@ -350,6 +344,9 @@ Long count is a list (baktun katun tun uinal kin)"
      ;; Days before absolute date 0.
      (- calendar-mayan-days-before-absolute-zero)))
 
+(define-obsolete-function-alias 'calendar-absolute-from-mayan-long-count
+  'calendar-mayan-long-count-to-absolute "23.1")
+
 (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)))
@@ -359,30 +356,33 @@ Long count is a list (baktun katun tun uinal kin)"
     (or (null lc) (> (car lc) (car base)))))
 
 ;;;###cal-autoload
-(defun calendar-goto-mayan-long-count-date (date &optional noecho)
+(defun calendar-mayan-goto-long-count-date (date &optional noecho)
   "Move cursor to Mayan long count DATE.
 Echo Mayan date unless NOECHO is non-nil."
   (interactive
-   (let (lc)
-     (while (not lc)
-       (let ((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))))))))
-         (if (calendar-mayan-long-count-common-era datum)
-             (setq lc datum))))
-     (list lc)))
+   (let (datum)
+     (while (not (setq datum
+                       (calendar-mayan-string-from-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))
   (calendar-goto-date
    (calendar-gregorian-from-absolute
-    (calendar-absolute-from-mayan-long-count date)))
-  (or noecho (calendar-print-mayan-date)))
+    (calendar-mayan-long-count-to-absolute date)))
+  (or noecho (calendar-mayan-print-date)))
+
+(define-obsolete-function-alias 'calendar-goto-mayan-long-count-date
+  'calendar-mayan-goto-long-count-date "23.1")
 
 (defvar date)
 
-;; To be called from list-sexp-diary-entries, where DATE is bound.
+;; To be called from diary-list-sexp-entries, where DATE is bound.
 ;;;###diary-autoload
 (defun diary-mayan-date ()
   "Show the Mayan long count, haab, and tzolkin dates as a diary entry."
@@ -390,5 +390,4 @@ Echo Mayan date unless NOECHO is non-nil."
 
 (provide 'cal-mayan)
 
-;; arch-tag: 54f35144-cd0f-4873-935a-a60129de07df
 ;;; cal-mayan.el ends here