cal-french.el 11.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1 2
;;; cal-french.el --- calendar functions for the French Revolutionary calendar.

3
;; Copyright (C) 1988, 89, 92, 94, 95, 1997 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
Eric S. Raymond's avatar
Eric S. Raymond committed
6 7
;; Keywords: calendar
;; Human-Keywords: French Revolutionary calendar, calendar, diary
Jim Blandy's avatar
Jim Blandy committed
8 9 10

;; This file is part of GNU Emacs.

11 12 13 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
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

Jim Blandy's avatar
Jim Blandy committed
16
;; GNU Emacs is distributed in the hope that it will be useful,
17 18 19 20 21
;; 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
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
25 26 27 28 29 30

;;; Commentary:

;; This collection of functions implements the features of calendar.el and
;; diary.el that deal with the French Revolutionary calendar.

31
;; Technical details of the French Revolutionary calendar can be found in
32 33
;; ``Calendrical Calculations'' by Nachum Dershowitz and Edward M. Reingold,
;; Cambridge University Press (1997), and in
34 35 36
;; ``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.
Jim Blandy's avatar
Jim Blandy committed
37 38 39 40 41 42 43 44 45 46 47

;; Comments, corrections, and improvements should be sent to
;;  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

;;; Code:

(require 'calendar)

48 49 50 51 52 53 54
(defun french-calendar-accents ()
  "True if diacritical marks are available."
  (and (or window-system
	   (terminal-coding-system))
       (or enable-multibyte-characters
	   (and (char-table-p standard-display-table)
		(equal (aref standard-display-table 161) [161])))))
55

Edward M. Reingold's avatar
Edward M. Reingold committed
56 57 58
(defconst french-calendar-epoch (calendar-absolute-from-gregorian '(9 22 1792))
  "Absolute date of start of French Revolutionary calendar = September 22, 1792.")

Jim Blandy's avatar
Jim Blandy committed
59
(defconst french-calendar-month-name-array
60 61 62 63 64 65
  ["Vende'miaire" "Brumaire" "Frimaire" "Nivo^se" "Pluvio^se" "Vento^se"
   "Germinal" "Flore'al" "Prairial" "Messidor" "Thermidor" "Fructidor"])

(defconst french-calendar-multibyte-month-name-array
  ["Vendmiaire" "Brumaire" "Frimaire" "Nivse" "Pluvise" "Ventse"
   "Germinal" "Floral" "Prairial" "Messidor" "Thermidor" "Fructidor"])
Jim Blandy's avatar
Jim Blandy committed
66 67 68 69 70

(defconst french-calendar-day-name-array
  ["Primidi" "Duodi" "Tridi" "Quartidi" "Quintidi" "Sextidi" "Septidi"
   "Octidi" "Nonidi" "Decadi"])

71
(defconst french-calendar-multibyte-special-days-array
72 73
  ["de la Vertu" "du Gnie" "du Labour" "de la Raison" "de la Rcompense"
   "de la Rvolution"])
74

Jim Blandy's avatar
Jim Blandy committed
75
(defconst french-calendar-special-days-array
76 77
  ["de la Vertu" "du Ge'nie" "du Labour" "de la Raison" "de la Re'compense"
   "de la Re'volution"])
Jim Blandy's avatar
Jim Blandy committed
78

79 80 81 82 83 84 85 86
(defun french-calendar-month-name-array ()
  (if (french-calendar-accents)
      french-calendar-multibyte-month-name-array
    french-calendar-month-name-array))

(defun french-calendar-day-name-array ()
  french-calendar-day-name-array)

87 88 89 90 91
(defun french-calendar-special-days-array ()
  (if (french-calendar-accents)
      french-calendar-multibyte-special-days-array
    french-calendar-special-days-array))

Jim Blandy's avatar
Jim Blandy committed
92 93 94
(defun french-calendar-leap-year-p (year)
  "True if YEAR is a leap year on the French Revolutionary calendar.
For Gregorian years 1793 to 1805, the years of actual operation of the
95
calendar, follows historical practice based on equinoxes (years 3, 7,
Jim Blandy's avatar
Jim Blandy committed
96 97 98 99 100 101 102 103 104 105 106 107
and 11 were leap years; 15 and 20 would have been leap years).  For later
years uses the proposed rule of Romme (never adopted)--leap years fall every
four years except century years not divisible 400 and century years that are
multiples of 4000."
  (or (memq year '(3 7 11));; Actual practice--based on equinoxes
      (memq year '(15 20)) ;; Anticipated practice--based on equinoxes
      (and (> year 20)     ;; Romme's proposal--never adopted
           (zerop (% year 4))
           (not (memq (% year 400) '(100 200 300)))
           (not (zerop (% year 4000))))))

(defun french-calendar-last-day-of-month (month year)
Richard M. Stallman's avatar
Richard M. Stallman committed
108
  "Return last day of MONTH, YEAR on the French Revolutionary calendar.
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115 116 117
The 13th month is not really a month, but the 5 (6 in leap years) day period of
`sansculottides' at the end of the year."
  (if (< month 13)
      30
    (if (french-calendar-leap-year-p year)
        6
      5)))

(defun calendar-absolute-from-french (date)
Richard M. Stallman's avatar
Richard M. Stallman committed
118
  "Compute absolute date from French Revolutionary date DATE.
Jim Blandy's avatar
Jim Blandy committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
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))
        (day (extract-calendar-day date))
        (year (extract-calendar-year date)))
    (+ (* 365 (1- year));; Days in prior years
       ;; Leap days in prior years
       (if (< year 20)
           (/ year 4);; Actual and anticipated practice (years 3, 7, 11, 15)
         ;; Romme's proposed rule (using the Principle of Inclusion/Exclusion)
         (+ (/ (1- year) 4);; Luckily, there were 4 leap years before year 20
            (- (/ (1- year) 100))
            (/ (1- year) 400)
            (- (/ (1- year) 4000))))
       (* 30 (1- month));; Days in prior months this year
       day;; Days so far this month
Edward M. Reingold's avatar
Edward M. Reingold committed
135
       (1- french-calendar-epoch))));; Days before start of calendar
Jim Blandy's avatar
Jim Blandy committed
136 137

(defun calendar-french-from-absolute (date)
Richard M. Stallman's avatar
Richard M. Stallman committed
138 139 140
  "Compute the French Revolutionary equivalent for absolute date DATE.
The result is a list of the form (MONTH DAY YEAR).
The absolute date is the number of days elapsed since the
Richard M. Stallman's avatar
Richard M. Stallman committed
141
\(imaginary) Gregorian date Sunday, December 31, 1 BC."
Edward M. Reingold's avatar
Edward M. Reingold committed
142
  (if (< date french-calendar-epoch)
Jim Blandy's avatar
Jim Blandy committed
143
      (list 0 0 0);; pre-French Revolutionary date
Edward M. Reingold's avatar
Edward M. Reingold committed
144 145
    (let* ((approx              ;; Approximation from below.
            (/ (- date french-calendar-epoch) 366))
Jim Blandy's avatar
Jim Blandy committed
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
           (year                ;; Search forward from the approximation.
            (+ approx
               (calendar-sum y approx
                 (>= date (calendar-absolute-from-french (list 1 1 (1+ y))))
                 1)))
           (month               ;; Search forward from Vendemiaire.
            (1+ (calendar-sum m 1
                  (> date
                     (calendar-absolute-from-french
                      (list m
                            (french-calendar-last-day-of-month m year)
                            year)))
                  1)))
           (day                   ;; Calculate the day by subtraction.
            (- date
               (1- (calendar-absolute-from-french (list month 1 year))))))
    (list month day year))))

164 165 166 167
(defun calendar-french-date-string (&optional date)
  "String of French Revolutionary date of Gregorian DATE.
Returns the empty string if DATE is pre-French Revolutionary.
Defaults to today's date if DATE is not given."
Jim Blandy's avatar
Jim Blandy committed
168 169
  (let* ((french-date (calendar-french-from-absolute
                       (calendar-absolute-from-gregorian
170
                        (or date (calendar-current-date)))))
Jim Blandy's avatar
Jim Blandy committed
171 172 173
         (y (extract-calendar-year french-date))
         (m (extract-calendar-month french-date))
         (d (extract-calendar-day french-date)))
174 175
    (cond
     ((< y 1) "")
176
     ((= m 13) (format (if (french-calendar-accents)
177 178
                           "Jour %s de l'Anne %d de la Rvolution"
                         "Jour %s de l'Anne'e %d de la Re'volution")
179
                       (aref (french-calendar-special-days-array) (1- d))
180
                       y))
181
     (t (format
182
         (if (french-calendar-accents)
183 184 185
             "Dcade %s, %s de %s de l'Anne %d de la Rvolution"
           "De'cade %s, %s de %s de l'Anne'e %d de la Re'volution")
         (make-string (1+ (/ (1- d) 10)) ?I)
186 187
         (aref (french-calendar-day-name-array) (% (1- d) 10))
         (aref (french-calendar-month-name-array) (1- m))
188
         y)))))
189 190 191 192

(defun calendar-print-french-date ()
  "Show the French Revolutionary calendar equivalent of the selected date."
  (interactive)
193 194
  (let ((f (calendar-french-date-string (calendar-cursor-to-date t)))
	(enable-multibyte-characters t))
195
    (if (string-equal f "")
Jim Blandy's avatar
Jim Blandy committed
196
        (message "Date is pre-French Revolution")
197
      (message "French Revolutionary date: %s" f))))
Jim Blandy's avatar
Jim Blandy committed
198

199 200 201 202 203 204 205 206 207 208
;; Convert a multibyte string to a singlebyte string
;; that represents the same characters in Latin-1.
(defun calendar-french-single-byteify (string)
  (if enable-multibyte-characters
      string
    (apply 'concat-chars
	   (mapcar (function (lambda (char) (logand char 255)))
		   (let ((enable-multibyte-characters t))
		     (string-to-list string))))))

Jim Blandy's avatar
Jim Blandy committed
209
(defun calendar-goto-french-date (date &optional noecho)
Richard M. Stallman's avatar
Richard M. Stallman committed
210
  "Move cursor to French Revolutionary date DATE.
Jim Blandy's avatar
Jim Blandy committed
211 212
Echo French Revolutionary date unless NOECHO is t."
  (interactive
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
   (let ((oldval enable-multibyte-characters)
	 (accents (french-calendar-accents))
	 (months (french-calendar-month-name-array))
	 (special-days (french-calendar-special-days-array)))
     (setq months (mapcar 'calendar-french-single-byteify months))
     (setq special-days
	   (mapcar 'calendar-french-single-byteify special-days))
     (let* ((year
	     (progn
	       (calendar-read
		(if accents
		    (calendar-french-single-byteify
		     "Anne de la Rvolution (>0): ")
		   "Anne'e de la Re'volution (>0): ")
		'(lambda (x) (> x 0))
		(int-to-string
		 (extract-calendar-year
		  (calendar-french-from-absolute
		   (calendar-absolute-from-gregorian
		    (calendar-current-date))))))))
	    (month-list
	     (mapcar 'list
		     (append months
			     (if (french-calendar-leap-year-p year)
				 (mapcar
				  '(lambda (x) (concat "Jour " x))
				  french-calendar-special-days-array)
			       (reverse
				(cdr;; we don't want rev. day in a non-leap yr.
				 (reverse
				  (mapcar
				   '(lambda (x)
				      (concat "Jour " x))
				   special-days))))))))
	    (completion-ignore-case t)
	    (month (cdr (assoc
			 (capitalize
			  (completing-read
			   "Mois ou Sansculottide: "
			   month-list
			   nil t))
			 (calendar-make-alist
			  month-list
			  1
			  '(lambda (x) (capitalize (car x)))))))
	    (decade (if (> month 12)
			1
260
		      (calendar-read
261 262 263 264 265 266 267 268 269 270 271 272 273
		       (if accents
			   (calendar-french-single-byteify
			    "Dcade (1-3): ")
			 "De'cade (1-3): ")
		       '(lambda (x) (memq x '(1 2 3))))))
	    (day (if (> month 12)
		     (- month 12)
		   (calendar-read
		    "Jour (1-10): "
		    '(lambda (x) (and (<= 1 x) (<= x 10))))))
	    (month (if (> month 12) 13 month))
	    (day (+ day (* 10 (1- decade)))))
       (list (list month day year)))))
Jim Blandy's avatar
Jim Blandy committed
274 275 276 277 278 279
  (calendar-goto-date (calendar-gregorian-from-absolute
                       (calendar-absolute-from-french date)))
  (or noecho (calendar-print-french-date)))

(defun diary-french-date ()
  "French calendar equivalent of date diary entry."
280
  (let ((f (calendar-french-date-string date)))
281 282
    (if (string-equal f "")
        "Date is pre-French Revolution"
283
      (format "French Revolutionary date: %s" f))))
Jim Blandy's avatar
Jim Blandy committed
284 285 286 287

(provide 'cal-french)

;;; cal-french.el ends here