]> code.delx.au - gnu-emacs/blobdiff - lisp/calendar/cal-julian.el
Update for iso, islamic, julian, mayan, persian name changes.
[gnu-emacs] / lisp / calendar / cal-julian.el
index ff6a3f72e1b886813ee2cecaf2cb2736c29ae71f..af66c31e4c2f12e8069678638be9c49f97f19744 100644 (file)
@@ -1,7 +1,7 @@
 ;;; cal-julian.el --- calendar functions for the Julian calendar
 
-;; Copyright (C) 1995, 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007
-;;   Free Software Foundation, Inc.
+;; Copyright (C) 1995, 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+;;   2008  Free Software Foundation, Inc.
 
 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
 ;; Maintainer: Glenn Morris <rgm@gnu.org>
@@ -12,7 +12,7 @@
 
 ;; 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 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
 ;; any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 
 ;;; Commentary:
 
-;; This collection of functions implements the features of calendar.el and
-;; diary.el that deal with the Julian calendar.
-
-;; Technical details of all the calendrical calculations can be found in
-;; ``Calendrical Calculations: The Millennium Edition'' by Edward M. Reingold
-;; and Nachum Dershowitz, Cambridge University Press (2001).
+;; See calendar.el.
 
 ;;; Code:
 
-(defvar date)
-(defvar displayed-month)
-(defvar displayed-year)
-
 (require 'calendar)
 
-(defun calendar-julian-from-absolute (date)
-  "Compute the Julian (month day year) corresponding to the absolute DATE.
-The absolute date is the number of days elapsed since the (imaginary)
-Gregorian date Sunday, December 31, 1 BC."
-  (let* ((approx (/ (+ date 2) 366));; Approximation from below.
-         (year        ;; Search forward from the approximation.
-          (+ approx
-             (calendar-sum y approx
-                (>= date (calendar-absolute-from-julian (list 1 1 (1+ y))))
-                1)))
-         (month       ;; Search forward from January.
-          (1+ (calendar-sum m 1
-                 (> date
-                    (calendar-absolute-from-julian
-                     (list m
-                           (if (and (= m 2) (= (% year 4) 0))
-                               29
-                             (aref [31 28 31 30 31 30 31 31 30 31 30 31]
-                                   (1- m)))
-                           year)))
-                 1)))
-         (day         ;; Calculate the day by subtraction.
-          (- date (1- (calendar-absolute-from-julian (list month 1 year))))))
-    (list month day year)))
-
-(defun calendar-absolute-from-julian (date)
+(defun calendar-julian-to-absolute (date)
   "The number of days elapsed between the Gregorian date 12/31/1 BC and DATE.
 The Gregorian date Sunday, December 31, 1 BC is imaginary."
   (let ((month (extract-calendar-month date))
-        (day (extract-calendar-day date))
         (year (extract-calendar-year date)))
     (+ (calendar-day-number date)
-       (if (and (= (% year 100) 0)
-                (/= (% year 400) 0)
+       (if (and (zerop (% year 100))
+                (not (zerop (% year 400)))
                 (> month 2))
-           1 0);; Correct for Julian but not Gregorian leap year.
+           1 0)       ; correct for Julian but not Gregorian leap year
        (* 365 (1- year))
        (/ (1- year) 4)
        -2)))
 
+(define-obsolete-function-alias 'calendar-absolute-from-julian
+  'calendar-julian-to-absolute "23.1")
+
+;;;###cal-autoload
+(defun calendar-julian-from-absolute (date)
+  "Compute the Julian (month day year) corresponding to the absolute DATE.
+The absolute date is the number of days elapsed since the (imaginary)
+Gregorian date Sunday, December 31, 1 BC."
+  (let* ((approx (/ (+ date 2) 366))    ; approximation from below
+         (year                 ; search forward from the approximation
+          (+ approx
+             (calendar-sum y approx
+                           (>= date (calendar-julian-to-absolute
+                                     (list 1 1 (1+ y))))
+                           1)))
+         (month                         ; search forward from January
+          (1+ (calendar-sum m 1
+                            (> date
+                               (calendar-julian-to-absolute
+                                (list m
+                                      (if (and (= m 2) (zerop (% year 4)))
+                                          29
+                                        (aref [31 28 31 30 31 30 31
+                                                  31 30 31 30 31]
+                                              (1- m)))
+                                      year)))
+                            1)))
+         (day                       ; calculate the day by subtraction
+          (- date (1- (calendar-julian-to-absolute (list month 1 year))))))
+    (list month day year)))
+
+;;;###cal-autoload
 (defun calendar-julian-date-string (&optional date)
   "String of Julian date of Gregorian DATE.
 Defaults to today's date if DATE is not given.
 Driven by the variable `calendar-date-display-form'."
   (calendar-date-string
    (calendar-julian-from-absolute
-    (calendar-absolute-from-gregorian
-     (or date (calendar-current-date))))
+    (calendar-absolute-from-gregorian (or date (calendar-current-date))))
    nil t))
 
-(defun calendar-print-julian-date ()
+;;;###cal-autoload
+(defun calendar-julian-print-date ()
   "Show the Julian calendar equivalent of the date under the cursor."
   (interactive)
   (message "Julian date: %s"
            (calendar-julian-date-string (calendar-cursor-to-date t))))
 
-(defun calendar-goto-julian-date (date &optional noecho)
-  "Move cursor to Julian DATE; echo Julian date unless NOECHO is t."
+(define-obsolete-function-alias 'calendar-print-julian-date
+  'calendar-julian-print-date "23.1")
+
+;;;###cal-autoload
+(defun calendar-julian-goto-date (date &optional noecho)
+  "Move cursor to Julian DATE; echo Julian date unless NOECHO is non-nil."
   (interactive
    (let* ((today (calendar-current-date))
           (year (calendar-read
                  "Julian calendar year (>0): "
-                 '(lambda (x) (> x 0))
+                 (lambda (x) (> x 0))
                  (int-to-string
                   (extract-calendar-year
                    (calendar-julian-from-absolute
@@ -113,10 +114,10 @@ Driven by the variable `calendar-date-display-form'."
           (month-array calendar-month-name-array)
           (completion-ignore-case t)
           (month (cdr (assoc-string
-                        (completing-read
-                         "Julian calendar month name: "
-                         (mapcar 'list (append month-array nil))
-                         nil t)
+                       (completing-read
+                        "Julian calendar month name: "
+                        (mapcar 'list (append month-array nil))
+                        nil t)
                        (calendar-make-alist month-array 1) t)))
           (last
            (if (and (zerop (% year 4)) (= month 2))
@@ -125,81 +126,92 @@ Driven by the variable `calendar-date-display-form'."
           (day (calendar-read
                 (format "Julian calendar day (%d-%d): "
                         (if (and (= year 1) (= month 1)) 3 1) last)
-                '(lambda (x)
-                   (and (< (if (and (= year 1) (= month 1)) 2 0) x)
-                        (<= x last))))))
+                (lambda (x)
+                  (and (< (if (and (= year 1) (= month 1)) 2 0) x)
+                       (<= x last))))))
      (list (list month day year))))
   (calendar-goto-date (calendar-gregorian-from-absolute
-                       (calendar-absolute-from-julian date)))
-  (or noecho (calendar-print-julian-date)))
+                       (calendar-julian-to-absolute date)))
+  (or noecho (calendar-julian-print-date)))
+
+(define-obsolete-function-alias 'calendar-goto-julian-date
+  'calendar-julian-goto-date "23.1")
 
+;;;###holiday-autoload
 (defun holiday-julian (month day string)
-  "Holiday on MONTH, DAY  (Julian) called STRING.
+  "Holiday on MONTH, DAY (Julian) called STRING.
 If MONTH, DAY (Julian) is visible, the value returned is corresponding
 Gregorian date in the form of the list (((month day year) STRING)).  Returns
 nil if it is not visible in the current calendar window."
-  (let ((m1 displayed-month)
-        (y1 displayed-year)
-        (m2 displayed-month)
-        (y2 displayed-year)
-        (year))
-    (increment-calendar-month m1 y1 -1)
-    (increment-calendar-month m2 y2 1)
-    (let* ((start-date (calendar-absolute-from-gregorian
-                        (list m1 1 y1)))
-           (end-date (calendar-absolute-from-gregorian
-                      (list m2 (calendar-last-day-of-month m2 y2) y2)))
-           (julian-start (calendar-julian-from-absolute start-date))
-           (julian-end (calendar-julian-from-absolute end-date))
-           (julian-y1 (extract-calendar-year julian-start))
-           (julian-y2 (extract-calendar-year julian-end)))
-      (setq year (if (< 10 month) julian-y1 julian-y2))
-      (let ((date (calendar-gregorian-from-absolute
-                   (calendar-absolute-from-julian
-                    (list month day year)))))
-        (if (calendar-date-is-visible-p date)
-            (list (list date string)))))))
-
-(defun diary-julian-date ()
-  "Julian calendar equivalent of date diary entry."
-  (format "Julian date: %s" (calendar-julian-date-string date)))
-
-(defun calendar-absolute-from-astro (d)
+  (let ((gdate (calendar-nongregorian-visible-p
+                month day 'calendar-julian-to-absolute
+                'calendar-julian-from-absolute
+                ;; In the Gregorian case, we'd use the lower year when
+                ;; month >= 11. In the Julian case, there is an offset
+                ;; of two weeks (ie 1 Nov Greg = 19 Oct Julian). So we
+                ;; use month >= 10, since it can't cause any problems.
+                (lambda (m) (< m 10)))))
+    (if gdate (list (list gdate string)))))
+
+;;;###cal-autoload
+(defun calendar-astro-to-absolute (d)
   "Absolute date of astronomical (Julian) day number D."
   (- d 1721424.5))
 
+(define-obsolete-function-alias 'calendar-absolute-from-astro
+  'calendar-astro-to-absolute "23.1")
+
+;;;###cal-autoload
 (defun calendar-astro-from-absolute (d)
   "Astronomical (Julian) day number of absolute date D."
   (+ d 1721424.5))
 
+;;;###cal-autoload
 (defun calendar-astro-date-string (&optional date)
   "String of astronomical (Julian) day number after noon UTC of Gregorian DATE.
 Defaults to today's date if DATE is not given."
   (int-to-string
    (ceiling
     (calendar-astro-from-absolute
-     (calendar-absolute-from-gregorian
-      (or date (calendar-current-date)))))))
+     (calendar-absolute-from-gregorian (or date (calendar-current-date)))))))
 
-(defun calendar-print-astro-day-number ()
-  "Show astronomical (Julian) day number after noon UTC on date shown by cursor."
+;;;###cal-autoload
+(defun calendar-astro-print-day-number ()
+  "Show astronomical (Julian) day number after noon UTC on cursor date."
   (interactive)
   (message
    "Astronomical (Julian) day number (at noon UTC): %s.0"
    (calendar-astro-date-string (calendar-cursor-to-date t))))
 
-(defun calendar-goto-astro-day-number (daynumber &optional noecho)
+(define-obsolete-function-alias 'calendar-print-astro-day-number
+  'calendar-astro-print-day-number "23.1")
+
+;;;###cal-autoload
+(defun calendar-astro-goto-day-number (daynumber &optional noecho)
   "Move cursor to astronomical (Julian) DAYNUMBER.
-Echo astronomical (Julian) day number unless NOECHO is t."
+Echo astronomical (Julian) day number unless NOECHO is non-nil."
   (interactive (list (calendar-read
                       "Astronomical (Julian) day number (>1721425): "
-                      '(lambda (x) (> x 1721425)))))
+                      (lambda (x) (> x 1721425)))))
   (calendar-goto-date
    (calendar-gregorian-from-absolute
     (floor
-     (calendar-absolute-from-astro daynumber))))
-  (or noecho (calendar-print-astro-day-number)))
+     (calendar-astro-to-absolute daynumber))))
+  (or noecho (calendar-astro-print-day-number)))
+
+(define-obsolete-function-alias 'calendar-goto-astro-day-number
+  'calendar-astro-goto-day-number "23.1")
+
+(defvar date)
+
+;; To be called from list-sexp-diary-entries, where DATE is bound.
+;;;###diary-autoload
+(defun diary-julian-date ()
+  "Julian calendar equivalent of date diary entry."
+  (format "Julian date: %s" (calendar-julian-date-string date)))
 
+;; To be called from list-sexp-diary-entries, where DATE is bound.
+;;;###diary-autoload
 (defun diary-astro-day-number ()
   "Astronomical (Julian) day number diary entry."
   (format "Astronomical (Julian) day number at noon UTC: %s.0"
@@ -207,5 +219,5 @@ Echo astronomical (Julian) day number unless NOECHO is t."
 
 (provide 'cal-julian)
 
-;;; arch-tag: 0520acdd-1c60-4188-9aa8-9b8c24d856ae
+;; arch-tag: 0520acdd-1c60-4188-9aa8-9b8c24d856ae
 ;;; cal-julian.el ends here