cal-bahai.el 15.1 KB
Newer Older
1
;;; cal-bahai.el --- calendar functions for the Bahá'í calendar.
2

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

;; Author: John Wiegley <johnw@gnu.org>
;; Keywords: calendar
8
;; Human-Keywords: Bahá'í calendar, Bahá'í, Baha'i, Bahai, calendar, diary
9 10 11 12 13

;; This file is part of GNU Emacs.

;; 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
14
;; the Free Software Foundation; either version 3, or (at your option)
15 16 17 18 19 20 21 22 23
;; 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
;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
24 25
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
26 27 28 29

;;; Commentary:

;; This collection of functions implements the features of calendar.el
30
;; and diary.el that deal with the Bahá'í calendar.
31

32
;; The Bahá'í (http://www.bahai.org) calendar system is based on a
33
;; solar cycle of 19 months with 19 days each.  The four remaining
34
;; "intercalary" days are called the Ayyám-i-Há (days of Há), and are
35 36
;; placed between the 18th and 19th months.  They are meant as a time
;; of festivals preceding the 19th month, which is the month of
37
;; fasting.  In Gregorian leap years, there are 5 of these days (Há
38 39 40 41 42 43
;; has the numerical value of 5 in the arabic abjad, or
;; letter-to-number, reckoning).

;; Each month is named after an attribute of God, as are the 19 days
;; -- which have the same names as the months.  There is also a name
;; for each year in every 19 year cycle.  These cycles are called
44
;; Váhids.  A cycle of 19 Váhids (361 years) is called a Kullu-Shay,
45 46
;; which means "all things".

47
;; The calendar was named the "Badí` calendar" by its author, the Báb.
48 49 50 51
;; It uses a week of seven days, corresponding to the Gregorian week,
;; each of which has its own name, again patterned after the
;; attributes of God.

52
;; Note: The days of Ayyám-i-Há are encoded as zero and negative
53
;; offsets from the first day of the final month.  So, (19 -3 157) is
54
;; the first day of Ayyám-i-Há, in the year 157 BE.
55 56 57

;;; Code:

58
(require 'calendar)
59

60
(defconst calendar-bahai-month-name-array
61 62
  ["Bahá" "Jalál" "Jamál" "`Azamat" "Núr" "Rahmat" "Kalimát" "Kamál"
   "Asmá" "`Izzat" "Mashiyyat" "`Ilm" "Qudrat" "Qawl" "Masá'il"
63 64
   "Sharaf" "Sultán" "Mulk" "`Alá"]
  "Array of the month names in the Bahá'í calendar.")
65

66
(defconst calendar-bahai-epoch (calendar-absolute-from-gregorian '(3 21 1844))
67
  "Absolute date of start of Bahá'í calendar = March 21, 1844 AD.")
68

69
(defun calendar-bahai-leap-year-p (year)
Glenn Morris's avatar
Glenn Morris committed
70
  "True if Bahá'í YEAR is a leap year in the Bahá'í calendar."
71 72
  (calendar-leap-year-p (+ year 1844)))

73
(defconst calendar-bahai-leap-base
74
  (+ (/ 1844 4) (- (/ 1844 100)) (/ 1844 400))
Glenn Morris's avatar
Glenn Morris committed
75
  "Number of leap years between 1 and 1844 AD, inclusive.
76
Used by `calendar-bahai-to-absolute'.")
77

78
(defun calendar-bahai-to-absolute (date)
79
  "Compute absolute date from Bahá'í date DATE.
80 81 82
The absolute date is the number of days elapsed since the (imaginary)
Gregorian date Sunday, December 31, 1 BC."
  (let* ((month (extract-calendar-month date))
Glenn Morris's avatar
Glenn Morris committed
83 84 85 86 87 88 89 90 91
         (day (extract-calendar-day date))
         (year (extract-calendar-year date))
         (prior-years (+ (1- year) 1844))
         (leap-days (- (+ (/ prior-years 4) ; leap days in prior years
                          (- (/ prior-years 100))
                          (/ prior-years 400))
                       calendar-bahai-leap-base)))
    (+ (1- calendar-bahai-epoch)        ; days before epoch
       (* 365 (1- year))                ; days in prior years
92 93
       leap-days
       (calendar-sum m 1 (< m month) 19)
Glenn Morris's avatar
Glenn Morris committed
94 95 96
       (if (= month 19)
           (if (calendar-bahai-leap-year-p year) 5 4)
         0)
Glenn Morris's avatar
Glenn Morris committed
97
       day)))                           ; days so far this month
98

99 100 101
(define-obsolete-function-alias 'calendar-absolute-from-bahai
  'calendar-bahai-to-absolute "23.1")

102
(defun calendar-bahai-from-absolute (date)
Glenn Morris's avatar
Glenn Morris committed
103
  "Bahá'í date (month day year) corresponding to the absolute DATE."
104
  (if (< date calendar-bahai-epoch)
Glenn Morris's avatar
Glenn Morris committed
105
      (list 0 0 0)                      ; pre-Bahá'í date
106
    (let* ((greg (calendar-gregorian-from-absolute date))
Glenn Morris's avatar
Glenn Morris committed
107
           (gmonth (extract-calendar-month greg))
Glenn Morris's avatar
Glenn Morris committed
108
           (year (+ (- (extract-calendar-year greg) 1844)
Glenn Morris's avatar
Glenn Morris committed
109 110
                    (if (or (> gmonth 3)
                            (and (= gmonth 3)
Glenn Morris's avatar
Glenn Morris committed
111 112
                                 (>= (extract-calendar-day greg) 21)))
                        1 0)))
Glenn Morris's avatar
Glenn Morris committed
113
           (month                       ; search forward from Baha
114
            (1+ (calendar-sum m 1
115
                  (> date (calendar-bahai-to-absolute (list m 19 year)))
Glenn Morris's avatar
Glenn Morris committed
116
                  1)))
Glenn Morris's avatar
Glenn Morris committed
117
           (day                     ; calculate the day by subtraction
118
            (- date
119
               (1- (calendar-bahai-to-absolute (list month 1 year))))))
120 121
      (list month day year))))

122
;;;###cal-autoload
123
(defun calendar-bahai-date-string (&optional date)
124
  "String of Bahá'í date of Gregorian DATE.
125 126
Defaults to today's date if DATE is not given."
  (let* ((bahai-date (calendar-bahai-from-absolute
Glenn Morris's avatar
Glenn Morris committed
127 128
                      (calendar-absolute-from-gregorian
                       (or date (calendar-current-date)))))
129
         (y (extract-calendar-year bahai-date)))
Glenn Morris's avatar
Glenn Morris committed
130
    (if (< y 1)
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
        ""                              ; pre-Bahai
      (let* ((m (extract-calendar-month bahai-date))
             (d (extract-calendar-day bahai-date))
             (monthname (if (and (= m 19)
                                 (<= d 0))
                            "Ayyám-i-Há"
                          (aref calendar-bahai-month-name-array (1- m))))
             (day (int-to-string
                   (if (<= d 0)
                       (+ d (if (calendar-bahai-leap-year-p y) 5 4))
                     d)))
             (year (int-to-string y))
             (month (int-to-string m))
             dayname)
        ;; Can't call calendar-date-string because of monthname oddity.
        (mapconcat 'eval calendar-date-display-form "")))))
147

148
;;;###cal-autoload
149
(defun calendar-bahai-print-date ()
150
  "Show the Bahá'í calendar equivalent of the selected date."
151
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
152 153 154 155
  (let ((s (calendar-bahai-date-string (calendar-cursor-to-date t))))
   (if (string-equal s "")
       (message "Date is pre-Bahá'í")
     (message "Bahá'í date: %s" s))))
156

Glenn Morris's avatar
Glenn Morris committed
157 158 159
(define-obsolete-function-alias
  'calendar-print-bahai-date 'calendar-bahai-print-date "23.1")

160 161 162
(defun calendar-bahai-read-date ()
 "Interactively read the arguments for a Bahá'í date command.
Reads a year, month and day."
163 164
  (let* ((today (calendar-current-date))
         (year (calendar-read
165
                "Bahá'í calendar year (not 0): "
166
                (lambda (x) (not (zerop x)))
167 168 169 170 171 172
                (int-to-string
                 (extract-calendar-year
                  (calendar-bahai-from-absolute
                   (calendar-absolute-from-gregorian today))))))
         (completion-ignore-case t)
         (month (cdr (assoc
Glenn Morris's avatar
Glenn Morris committed
173 174 175 176 177
                      (completing-read
                       "Bahá'í calendar month name: "
                       (mapcar 'list
                               (append calendar-bahai-month-name-array nil))
                       nil t)
178
                      (calendar-make-alist calendar-bahai-month-name-array
179
                                           1))))
180
         (day (calendar-read "Bahá'í calendar day (1-19): "
Glenn Morris's avatar
Glenn Morris committed
181
                             (lambda (x) (and (< 0 x) (<= x 19))))))
182 183
    (list (list month day year))))

184 185 186
(define-obsolete-function-alias
  'calendar-bahai-prompt-for-date 'calendar-bahai-read-date "23.1")

187 188
;;;###cal-autoload
(defun calendar-bahai-goto-date (date &optional noecho)
Glenn Morris's avatar
Glenn Morris committed
189
  "Move cursor to Bahá'í date DATE; echo Bahá'í date unless NOECHO is non-nil."
190
  (interactive (calendar-bahai-read-date))
191
  (calendar-goto-date (calendar-gregorian-from-absolute
192
                       (calendar-bahai-to-absolute date)))
193 194
  (or noecho (calendar-bahai-print-date)))

Glenn Morris's avatar
Glenn Morris committed
195 196 197
(define-obsolete-function-alias
  'calendar-goto-bahai-date 'calendar-bahai-goto-date "23.1")

198 199
(defvar displayed-month)
(defvar displayed-year)
200

201
;;;###holiday-autoload
202
(defun holiday-bahai (month day string)
203 204
  "Holiday on MONTH, DAY (Bahá'í) called STRING.
If MONTH, DAY (Bahá'í) is visible, the value returned is corresponding
205 206
Gregorian date in the form of the list (((month day year) STRING)).  Returns
nil if it is not visible in the current calendar window."
207 208 209
  ;; Since the calendar window shows 3 months at a time, there are
  ;; approx +/- 45 days either side of the central month.
  ;; Since the Bahai months have 19 days, this means up to +/- 3 months.
210
  (let* ((bahai-date (calendar-bahai-from-absolute
Glenn Morris's avatar
Glenn Morris committed
211 212
                      (calendar-absolute-from-gregorian
                       (list displayed-month 15 displayed-year))))
213 214
         (m (extract-calendar-month bahai-date))
         (y (extract-calendar-year bahai-date))
Glenn Morris's avatar
Glenn Morris committed
215
         date)
216
    (unless (< m 1)                    ; Bahá'í calendar doesn't apply
217 218 219 220 221 222 223 224 225 226 227 228
      ;; Cf holiday-fixed, holiday-islamic.
      ;; With a +- 3 month calendar window, and 19 months per year,
      ;; month 16 is special.  When m16 is central is when the
      ;; end-of-year first appears.  When m1 is central, m16 is no
      ;; longer visible.  Hence we can do a one-sided test to see if
      ;; m16 is visible.  m16 is visible when the central month >= 13.
      ;; To see if other months are visible we can shift the range
      ;; accordingly.
      (increment-calendar-month m y (- 16 month) 19)
      (and (> m 12)                     ; Bahá'í date might be visible
           (calendar-date-is-visible-p
            (setq date (calendar-gregorian-from-absolute
229
                        (calendar-bahai-to-absolute (list month day y)))))
230
           (list (list date string))))))
231

Glenn Morris's avatar
Glenn Morris committed
232 233 234 235 236 237 238 239 240 241 242 243 244
(autoload 'holiday-fixed "holidays")

;;;###holiday-autoload
(defun holiday-bahai-new-year ()
  "Holiday entry for the Bahá'í New Year, if visible in the calendar window."
  (holiday-fixed 3 21
                 (format "Bahá'í New Year (Naw-Ruz) %d"
                         (- displayed-year (1- 1844)))))

;;;###holiday-autoload
(defun holiday-bahai-ridvan (&optional all)
  "Holidays related to Ridvan, as visible in the calendar window.
Only considers the first, ninth, and twelfth days, unless ALL or
245
`calendar-bahai-all-holidays-flag' is non-nil."
Glenn Morris's avatar
Glenn Morris committed
246 247 248 249
  (let ((ord ["First" "Second" "Third" "Fourth" "Fifth" "Sixth"
              "Seventh" "Eighth" "Ninth" "Tenth" "Eleventh" "Twelfth"])
        (show '(0 8 11))
        rid h)
250
    (if (or all calendar-bahai-all-holidays-flag)
Glenn Morris's avatar
Glenn Morris committed
251 252 253 254 255 256 257 258
        (setq show (number-sequence 0 11)))
    ;; More trouble than it was worth...?
    (dolist (i show (nreverse rid))
      (if (setq h (holiday-fixed (if (< i 10) 4 5)
                                 (+ i (if (< i 10) 21 -9))
                                 (format "%s Day of Ridvan" (aref ord i))))
          (push (car h) rid)))))

259
(autoload 'diary-list-entries-1 "diary-lib")
260

261
;;;###diary-autoload
262
(defun diary-bahai-list-entries ()
263
  "Add any Bahá'í date entries from the diary file to `diary-entries-list'.
264
Bahá'í date diary entries must be prefaced by `diary-bahai-entry-symbol'
265
\(normally a `B').  The same diary date forms govern the style of the
266 267
Bahá'í calendar entries, except that the Bahá'í month names cannot be
abbreviated.  The Bahá'í months are numbered from 1 to 19 with Bahá being
268 269 270
1 and 19 being `Alá.  If a Bahá'í 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
271
`diary-nongregorian-listing-hook'."
Glenn Morris's avatar
Glenn Morris committed
272
  (diary-list-entries-1 calendar-bahai-month-name-array
273
                        diary-bahai-entry-symbol
Glenn Morris's avatar
Glenn Morris committed
274 275 276 277 278 279
                        'calendar-bahai-from-absolute))
(define-obsolete-function-alias
  'list-bahai-diary-entries 'diary-bahai-list-entries "23.1")


(autoload 'calendar-mark-1 "diary-lib")
280

281
;;;###diary-autoload
Glenn Morris's avatar
Glenn Morris committed
282
(defun calendar-bahai-mark-date-pattern (month day year &optional color)
283
  "Mark dates in calendar window that conform to Bahá'í date MONTH/DAY/YEAR.
Glenn Morris's avatar
Glenn Morris committed
284 285 286
A value of 0 in any position is a wildcard.  Optional argument COLOR is
passed to `mark-visible-calendar-date' as MARK."
  (calendar-mark-1 month day year 'calendar-bahai-from-absolute
287
                   'calendar-bahai-to-absolute color))
Glenn Morris's avatar
Glenn Morris committed
288 289 290 291

(define-obsolete-function-alias
  'mark-bahai-calendar-date-pattern 'calendar-bahai-mark-date-pattern "23.1")

292

293
(autoload 'diary-mark-entries-1 "diary-lib")
294

295
;;;###diary-autoload
296
(defun diary-bahai-mark-entries ()
297
  "Mark days in the calendar window that have Bahá'í date diary entries.
298 299
Marks each entry in `diary-file' (or included files) visible in the calendar
window.  See `diary-bahai-list-entries' for more information."
300 301
  (diary-mark-entries-1 'calendar-bahai-mark-date-pattern
                        calendar-bahai-month-name-array
302
                        diary-bahai-entry-symbol
303
                        'calendar-bahai-from-absolute))
304

Glenn Morris's avatar
Glenn Morris committed
305 306 307
(define-obsolete-function-alias
  'mark-bahai-diary-entries 'diary-bahai-mark-entries "23.1")

Glenn Morris's avatar
Glenn Morris committed
308 309 310

(autoload 'diary-insert-entry-1 "diary-lib")

311
;;;###cal-autoload
312
(defun diary-bahai-insert-entry (arg)
313
  "Insert a diary entry.
314
For the Bahá'í date corresponding to the date indicated by point.
Glenn Morris's avatar
Glenn Morris committed
315
Prefix argument ARG makes the entry nonmarking."
316
  (interactive "P")
Glenn Morris's avatar
Glenn Morris committed
317
  (diary-insert-entry-1 nil arg calendar-bahai-month-name-array
318
                        diary-bahai-entry-symbol
Glenn Morris's avatar
Glenn Morris committed
319
                        'calendar-bahai-from-absolute))
320

Glenn Morris's avatar
Glenn Morris committed
321 322 323
(define-obsolete-function-alias
  'insert-bahai-diary-entry 'diary-bahai-insert-entry "23.1")

324
;;;###cal-autoload
325
(defun diary-bahai-insert-monthly-entry (arg)
326
  "Insert a monthly diary entry.
327
For the day of the Bahá'í month corresponding to the date indicated by point.
Glenn Morris's avatar
Glenn Morris committed
328
Prefix argument ARG makes the entry nonmarking."
329
  (interactive "P")
Glenn Morris's avatar
Glenn Morris committed
330
  (diary-insert-entry-1 'monthly arg calendar-bahai-month-name-array
331
                        diary-bahai-entry-symbol
Glenn Morris's avatar
Glenn Morris committed
332
                        'calendar-bahai-from-absolute))
333

Glenn Morris's avatar
Glenn Morris committed
334 335 336
(define-obsolete-function-alias
  'insert-monthly-bahai-diary-entry 'diary-bahai-insert-monthly-entry "23.1")

337
;;;###cal-autoload
338
(defun diary-bahai-insert-yearly-entry (arg)
339
  "Insert an annual diary entry.
340
For the day of the Bahá'í year corresponding to the date indicated by point.
Glenn Morris's avatar
Glenn Morris committed
341
Prefix argument ARG will make the entry nonmarking."
342
  (interactive "P")
Glenn Morris's avatar
Glenn Morris committed
343
  (diary-insert-entry-1 'yearly arg calendar-bahai-month-name-array
344
                        diary-bahai-entry-symbol
Glenn Morris's avatar
Glenn Morris committed
345
                        'calendar-bahai-from-absolute))
346

Glenn Morris's avatar
Glenn Morris committed
347 348 349
(define-obsolete-function-alias
  'insert-yearly-bahai-diary-entry 'diary-bahai-insert-yearly-entry "23.1")

350 351
(defvar date)

352
;; To be called from diary-list-sexp-entries, where DATE is bound.
353 354 355 356 357 358
;;;###diary-autoload
(defun diary-bahai-date ()
  "Bahá'í calendar equivalent of date diary entry."
  (format "Bahá'í date: %s" (calendar-bahai-date-string date)))


359 360
(provide 'cal-bahai)

361 362 363 364
;; Local Variables:
;; coding: utf-8
;; End:

365
;; arch-tag: c1cb1d67-862a-4264-a01c-41cb4df01f14
366
;;; cal-bahai.el ends here