;;; calendar.el --- calendar functions
;; Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1997,
-;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
+;; 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
;; Free Software Foundation, Inc.
;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
;; 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:
;;; Code:
-(require 'cal-loaddefs)
+(load "cal-loaddefs" nil t)
;; Avoid recursive load of calendar when loading cal-menu. Yuck.
(provide 'calendar)
:version "22.1"
:group 'calendar)
+;; See discussion in bug#1806.
+(defcustom calendar-split-width-threshold nil
+ "Value to use for `split-width-threshold' when creating a calendar.
+This only affects frames wider than the default value of
+`split-width-threshold'."
+ :type '(choice (const nil)
+ (integer))
+ :version "23.2"
+ :group 'calendar)
+
(defcustom calendar-week-start-day 0
"The day of the week on which a week in the calendar begins.
0 means Sunday (default), 1 means Monday, and so on.
(define-obsolete-variable-alias 'mark-diary-entries-in-calendar
'calendar-mark-diary-entries-flag "23.1")
+;; FIXME :set
(defcustom calendar-mark-diary-entries-flag nil
"Non-nil means mark dates with diary entries, in the calendar window.
The marking symbol is specified by the variable `diary-entry-marker'."
(defface calendar-today
'((t (:underline t)))
"Face for indicating today's date in the calendar.
-See `calendar-today-marker'."
+See the variable `calendar-today-marker'."
:group 'calendar-faces)
-;; Backward-compatibility alias. FIXME make obsolete.
-(put 'calendar-today-face 'face-alias 'calendar-today)
+
+(define-obsolete-face-alias 'calendar-today-face 'calendar-today "22.1")
(defface diary
'((((min-colors 88) (class color) (background light))
Used to mark diary entries in the calendar (see `diary-entry-marker'),
and to highlight the date header in the fancy diary."
:group 'calendar-faces)
-;; Backward-compatibility alias. FIXME make obsolete.
-(put 'diary-face 'face-alias 'diary)
+
+(define-obsolete-face-alias 'diary-face 'diary "22.1")
(defface holiday
'((((class color) (background light))
"Face for indicating in the calendar dates that have holidays.
See `calendar-holiday-marker'."
:group 'calendar-faces)
-;; Backward-compatibility alias. FIXME make obsolete.
-(put 'holiday-face 'face-alias 'holiday)
-;; These don't respect changes in font-lock-mode after loading.
-(defcustom diary-entry-marker (if (and font-lock-mode (display-color-p))
- 'diary
- "+")
+(define-obsolete-face-alias 'holiday-face 'holiday "22.1")
+
+;; These briefly checked font-lock-mode, but that is broken, since it
+;; is a buffer-local variable, and which buffer happens to be current
+;; when this file is loaded shouldn't make a difference. One could
+;; perhaps check global-font-lock-mode, or font-lock-global-modes; but
+;; this feature doesn't use font-lock, so there's no real reason it
+;; should respect those either. See bug#2199.
+;; They also used to check display-color-p, but that is a problem if
+;; loaded from --daemon. Since BW displays are rare now, this was
+;; also taken out. The way to keep it would be to have nil mean do a
+;; runtime check whenever this variable is used.
+(defcustom diary-entry-marker 'diary
"How to mark dates that have diary entries.
-The value can be either a single-character string or a face."
- :type '(choice string face)
- :group 'diary)
+The value can be either a single-character string (e.g. \"+\") or a face."
+ :type '(choice (string :tag "Single character string") face)
+ :group 'diary
+ :version "23.1")
-(defcustom calendar-today-marker (if (and font-lock-mode (display-color-p))
- 'calendar-today
- "=")
+(defcustom calendar-today-marker 'calendar-today
"How to mark today's date in the calendar.
-The value can be either a single-character string or a face.
+The value can be either a single-character string (e.g. \"=\") or a face.
Used by `calendar-mark-today'."
- :type '(choice string face)
- :group 'calendar)
+ :type '(choice (string :tag "Single character string") face)
+ :group 'calendar
+ :version "23.1")
-(defcustom calendar-holiday-marker (if (and font-lock-mode (display-color-p))
- 'holiday
- "*")
+(defcustom calendar-holiday-marker 'holiday
"How to mark notable dates in the calendar.
-The value can be either a single-character string or a face."
- :type '(choice string face)
- :group 'holidays)
+The value can be either a single-character string (e.g. \"*\") or a face."
+ :type '(choice (string :tag "Single character string") face)
+ :group 'holidays
+ :version "23.1")
(define-obsolete-variable-alias 'view-calendar-holidays-initially
'calendar-view-holidays-initially-flag "23.1")
(define-obsolete-variable-alias 'mark-holidays-in-calendar
'calendar-mark-holidays-flag "23.1")
+;; FIXME :set
(defcustom calendar-mark-holidays-flag nil
"Non-nil means mark dates of holidays in the calendar window.
The marking symbol is specified by the variable `calendar-holiday-marker'."
redisplays the diary for whatever date the cursor is moved to."
:type 'hook
+ :options '(calendar-update-mode-line)
:group 'calendar-hooks)
+(defcustom calendar-date-echo-text
+ "mouse-2: general menu\nmouse-3: menu for this date"
+ "String displayed when the cursor is over a date in the calendar.
+Can be either a fixed string, or a lisp expression that returns one.
+When this expression is evaluated, DAY, MONTH, and YEAR are
+integers appropriate to the relevant date. For example, to
+display the ISO date:
+
+ (setq calendar-date-echo-text '(format \"ISO date: %s\"
+ (calendar-iso-date-string
+ (list month day year))))
+Changing this variable without using customize has no effect on
+pre-existing calendar windows."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :risky t
+ :set (lambda (sym val)
+ (set sym val)
+ (calendar-redraw))
+ :type '(choice (string :tag "Fixed string")
+ (sexp :value
+ (format "ISO date: %s"
+ (calendar-iso-date-string
+ (list month day year)))))
+ :version "23.1")
+
+
+(defvar calendar-month-digit-width nil
+ "Width of the region with numbers in each month in the calendar.")
+
+(defvar calendar-month-width nil
+ "Full width of each month in the calendar.")
+
+(defvar calendar-right-margin nil
+ "Right margin of the calendar.")
+
+(defvar calendar-month-edges nil
+ "Alist of month edge columns.
+Each element has the form (N LEFT FIRST LAST RIGHT), where
+LEFT is the leftmost column associated with month segment N,
+FIRST and LAST are the first and last columns with day digits in,
+and LAST is the rightmost column.")
+
+(defun calendar-month-edges (segment)
+ "Compute the month edge columns for month SEGMENT.
+Returns a list (LEFT FIRST LAST RIGHT), where LEFT is the
+leftmost column associated with a month, FIRST and LAST are the
+first and last columns with day digits in, and LAST is the
+rightmost column."
+ ;; The leftmost column with a digit in it in this month segment.
+ (let* ((first (+ calendar-left-margin
+ (* segment calendar-month-width)))
+ ;; The rightmost column with a digit in it in this month segment.
+ (last (+ first (1- calendar-month-digit-width)))
+ (left (if (eq segment 0)
+ 0
+ (+ calendar-left-margin
+ (* segment calendar-month-width)
+ (- (/ calendar-intermonth-spacing 2)))))
+ ;; The rightmost edge of this month segment, dividing the
+ ;; space between months in two.
+ (right (+ calendar-left-margin
+ (* (1+ segment) calendar-month-width)
+ (- (/ calendar-intermonth-spacing 2)))))
+ (list left first last right)))
+
+(defun calendar-recompute-layout-variables ()
+ "Recompute some layout-related calendar \"constants\"."
+ (setq calendar-month-digit-width (+ (* 6 calendar-column-width)
+ calendar-day-digit-width)
+ calendar-month-width (+ (* 7 calendar-column-width)
+ calendar-intermonth-spacing)
+ calendar-right-margin (+ calendar-left-margin
+ (* 3 (* 7 calendar-column-width))
+ (* 2 calendar-intermonth-spacing))
+ calendar-month-edges nil)
+ (dotimes (i 3)
+ (push (cons i (calendar-month-edges i)) calendar-month-edges))
+ (setq calendar-month-edges (reverse calendar-month-edges)))
+
+;; FIXME add font-lock-keywords.
+(defun calendar-set-layout-variable (symbol value &optional minmax)
+ "Set SYMBOL's value to VALUE, an integer.
+A positive/negative MINMAX enforces a minimum/maximum value.
+Then redraw the calendar, if necessary."
+ (let ((oldvalue (symbol-value symbol)))
+ (custom-set-default symbol (if minmax
+ (if (< minmax 0)
+ (min value (- minmax))
+ (max value minmax))
+ value))
+ (unless (equal value oldvalue)
+ (calendar-recompute-layout-variables)
+ (calendar-redraw))))
+
+(defcustom calendar-left-margin 5
+ "Empty space to the left of the first month in the calendar."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :set 'calendar-set-layout-variable
+ :type 'integer
+ :version "23.1")
+
+;; Or you can view it as columns of width 2, with 1 space, no space
+;; after the last column, and a 5 space gap between month.
+;; FIXME check things work if this is odd.
+(defcustom calendar-intermonth-spacing 4
+ "Space between months in the calendar. Minimum value is 1."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :set (lambda (sym val)
+ (calendar-set-layout-variable sym val 1))
+ :type 'integer
+ :version "23.1")
+
+;; FIXME calendar-month-column-width?
+(defcustom calendar-column-width 3
+ "Width of each day column in the calendar. Minimum value is 3."
+ :initialize 'custom-initialize-default
+ :set (lambda (sym val)
+ (calendar-set-layout-variable sym val 3))
+ :type 'integer
+ :version "23.1")
+
+(defcustom calendar-day-header-width 2
+ "Width of the day column headers in the calendar.
+Must be at least one less than `calendar-column-width'."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :set (lambda (sym val)
+ (calendar-set-layout-variable sym val (- 1 calendar-column-width)))
+ :type 'integer
+ :version "23.1")
+
+;; FIXME a format specifier instead?
+(defcustom calendar-day-digit-width 2
+ "Width of the day digits in the calendar. Minimum value is 2."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :set (lambda (sym val)
+ (calendar-set-layout-variable sym val 2))
+ :type 'integer
+ :version "23.1")
+
+(defcustom calendar-intermonth-header nil
+ "Header text display in the space to the left of each calendar month.
+See `calendar-intermonth-text'."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :risky t
+ :set (lambda (sym val)
+ (set sym val)
+ (calendar-redraw))
+ :type '(choice (const nil :tag "Nothing")
+ (string :tag "Fixed string")
+ (sexp :value
+ (propertize "WK" 'font-lock-face
+ 'font-lock-function-name-face)))
+ :version "23.1")
+
+(defcustom calendar-intermonth-text nil
+ "Text to display in the space to the left of each calendar month.
+Can be nil, a fixed string, or a lisp expression that returns a string.
+When the expression is evaluated, the variables DAY, MONTH and YEAR
+are integers appropriate for the first day in each week.
+Will be truncated to the smaller of `calendar-left-margin' and
+`calendar-intermonth-spacing'. The last character is forced to be a space.
+For example, to display the ISO week numbers:
+
+ (setq calendar-week-start-day 1
+ calendar-intermonth-text
+ '(propertize
+ (format \"%2d\"
+ (car
+ (calendar-iso-from-absolute
+ (calendar-absolute-from-gregorian (list month day year)))))
+ 'font-lock-face 'font-lock-function-name-face))
+
+See also `calendar-intermonth-header'."
+ :group 'calendar
+ :initialize 'custom-initialize-default
+ :risky t
+ :set (lambda (sym val)
+ (set sym val)
+ (calendar-redraw))
+ :type '(choice (const nil :tag "Nothing")
+ (string :tag "Fixed string")
+ (sexp :value
+ (propertize
+ (format "%2d"
+ (car
+ (calendar-iso-from-absolute
+ (calendar-absolute-from-gregorian
+ (list month day year)))))
+ 'font-lock-face 'font-lock-function-name-face)))
+ :version "23.1")
+
(defcustom diary-file "~/diary"
"Name of the file in which one's personal diary of dates is kept.
(defcustom diary-iso-date-forms
'((month "[-/]" day "[^-/0-9]")
(year "[-/]" month "[-/]" day "[^0-9]")
- (monthname "-" day "[^-0-9]")
- (year "-" monthname "-" day "[^0-9]")
+ ;; Cannot allow [-/] as separators here, since it would also match
+ ;; the first element (bug#7377).
+ (monthname " *" day "[^-0-9]")
+ (year " *" monthname " *" day "[^0-9]")
(dayname "\\W"))
"List of pseudo-patterns describing the ISO style of dates.
-The defaults are: MONTH[-/]DAY; YEAR[-/]MONTH[-/]DAY; MONTHNAME-DAY;
-YEAR-MONTHNAME-DAY; DAYNAME. Normally you should not customize this,
+The defaults are: MONTH[-/]DAY; YEAR[-/]MONTH[-/]DAY; MONTHNAME DAY;
+YEAR MONTHNAME DAY; DAYNAME. Normally you should not customize this,
but `diary-date-forms' (which see)."
- :version "23.1"
+ :version "23.3" ; bug#7377
:type '(repeat (choice (cons :tag "Backup"
:value (backup . nil)
(const backup)
(repeat (list :inline t :format "%v"
(symbol :tag "Keyword")
(choice symbol regexp)))))
+ :set-after '(calendar-date-style diary-iso-date-forms
+ diary-european-date-forms
+ diary-american-date-forms)
:initialize 'custom-initialize-default
:set (lambda (symbol value)
(unless (equal value (eval symbol))
`calendar-american-date-display-form' provide some defaults for three common
styles."
:type 'sexp
+ :set-after '(calendar-date-style calendar-iso-date-display-form
+ calendar-european-date-display-form
+ calendar-american-date-display-form)
:group 'calendar)
(defun calendar-set-date-style (style)
;;; End of user options.
+(calendar-recompute-layout-variables)
+
+(defconst calendar-first-date-row 3
+ "First row in the calendar with actual dates.")
+
(defconst calendar-buffer "*Calendar*"
"Name of the buffer used for the calendar.")
(defconst lunar-phases-buffer "*Phases of Moon*"
"Name of the buffer used for the lunar phases.")
+(defconst solar-sunrises-buffer "*Sunrise/Sunset Times*"
+ "Name of buffer used for sunrise/sunset times.")
+
(defconst calendar-hebrew-yahrzeit-buffer "*Yahrzeits*"
"Name of the buffer used by `list-yahrzeit-dates'.")
and year, else uses the current date. If NODISPLAY is non-nil, don't
display the generated calendar."
(interactive "P")
- (set-buffer (get-buffer-create calendar-buffer))
- (calendar-mode)
- (let* ((pop-up-windows t)
- (split-height-threshold 1000)
- (date (if arg (calendar-read-date t)
- (calendar-current-date)))
- (month (calendar-extract-month date))
- (year (calendar-extract-year date)))
- (calendar-increment-month month year (- calendar-offset))
- ;; Display the buffer before calling calendar-generate-window so that it
- ;; can get a chance to adjust the window sizes to the frame size.
- (or nodisplay (pop-to-buffer calendar-buffer))
- (calendar-generate-window month year)
- (if (and calendar-view-diary-initially-flag
- (calendar-date-is-visible-p date))
- (diary-view-entries)))
+ (let ((buff (current-buffer)))
+ (set-buffer (get-buffer-create calendar-buffer))
+ (calendar-mode)
+ (let* ((pop-up-windows t)
+ ;; Not really needed now, but means we use exactly the same
+ ;; behavior as before in the non-wide case (see below).
+ (split-height-threshold 1000)
+ (split-width-threshold calendar-split-width-threshold)
+ (date (if arg (calendar-read-date t)
+ (calendar-current-date)))
+ (month (calendar-extract-month date))
+ (year (calendar-extract-year date)))
+ (calendar-increment-month month year (- calendar-offset))
+ ;; Display the buffer before calling calendar-generate-window so that it
+ ;; can get a chance to adjust the window sizes to the frame size.
+ (unless nodisplay
+ ;; We want a window configuration that looks something like
+ ;; X X | Y
+ ;; - -----
+ ;; C Z | C
+ ;; where C is the calendar, and the LHS is the traditional,
+ ;; non-wide frame, and the RHS is the wide frame case.
+ ;; We should end up in the same state regardless of whether the
+ ;; windows were initially split or not.
+ ;; Previously, we only thought about the non-wide case.
+ ;; We could just set split-height-threshold to 1000, relying on
+ ;; the fact that the window splitting treated a single window as
+ ;; a special case and would always split it (vertically). The
+ ;; same thing does not work in the wide-frame case, so now we do
+ ;; the splitting by hand.
+ ;; See discussion in bug#1806.
+ ;; Actually, this still does not do quite the right thing in the
+ ;; wide frame case if started from a configuration like the LHS.
+ ;; Eg if you start with a non-wide frame, call calendar, then
+ ;; make the frame wider. This one is problematic because you
+ ;; might need to split a totally unrelated window. Oh well, it
+ ;; seems unlikely, and perhaps respecting the original layout is
+ ;; the right thing in that case.
+ ;;
+ ;; Is this a wide frame? If so, split it horizontally.
+ (if (window-splittable-p t) (split-window-horizontally))
+ (pop-to-buffer calendar-buffer)
+ ;; Has the window already been split vertically?
+ (when (and (not (window-dedicated-p))
+ (window-full-height-p))
+ (let ((win (split-window-vertically)))
+ ;; In the upper window, show whatever was visible before.
+ ;; This looks better than using other-buffer.
+ (switch-to-buffer buff)
+ ;; Switch to the lower window with the calendar buffer.
+ (select-window win))))
+ (calendar-generate-window month year)
+ (if (and calendar-view-diary-initially-flag
+ (calendar-date-is-visible-p date))
+ (diary-view-entries))))
(if calendar-view-holidays-initially-flag
(let* ((diary-buffer (get-file-buffer diary-file))
(diary-window (if diary-buffer (get-buffer-window diary-buffer)))
;; Don't do any window-related stuff if we weren't called from a
;; window displaying the calendar.
(when in-calendar-window
- (if (or (one-window-p t) (not (window-full-width-p)))
+ ;; The second test used to be window-full-width-p.
+ ;; Not sure what it was/is for, except perhaps some way of saying
+ ;; "try not to mess with existing configurations".
+ ;; If did the wrong thing on wide frames, where we have done a
+ ;; horizontal split in calendar-basic-setup.
+ (if (or (one-window-p t) (not (window-safely-shrinkable-p)))
;; Don't mess with the window size, but ensure that the first
;; line is fully visible.
(set-window-vscroll nil 0)
(erase-buffer)
(calendar-increment-month month year -1)
(dotimes (i 3)
- (calendar-generate-month month year (+ 5 (* 25 i)))
+ (calendar-generate-month month year
+ (+ calendar-left-margin
+ (* calendar-month-width i)))
(calendar-increment-month month year 1)))
+(defun calendar-move-to-column (indent)
+ "Like `move-to-column', but indents if the line is too short."
+ (if (< (move-to-column indent) indent)
+ (indent-to indent)))
+
+(defun calendar-ensure-newline ()
+ "Move to the next line, adding a newline if necessary."
+ (or (zerop (forward-line 1))
+ (insert "\n")))
+
+(defun calendar-insert-at-column (indent string truncate)
+ "Move to column INDENT, adding spaces as needed.
+Inserts STRING so that it ends at INDENT. STRING is either a
+literal string, or a sexp to evaluate to return such. Truncates
+STRING to length TRUNCATE, ensure a trailing space."
+ (if (not (ignore-errors (stringp (setq string (eval string)))))
+ (calendar-move-to-column indent)
+ (if (> (length string) truncate)
+ (setq string (substring string 0 truncate)))
+ (or (string-match " $" string)
+ (if (= (length string) truncate)
+ (aset string (1- truncate) ?\s)
+ (setq string (concat string " "))))
+ (calendar-move-to-column (- indent (length string)))
+ (insert string)))
+
(defun calendar-generate-month (month year indent)
"Produce a calendar for MONTH, YEAR on the Gregorian calendar.
The calendar is inserted at the top of the buffer in which point is currently
calendar-week-start-day)
7))
(last (calendar-last-day-of-month month year))
+ (trunc (min calendar-intermonth-spacing
+ (1- calendar-left-margin)))
+ (day 1)
string)
(goto-char (point-min))
- (calendar-insert-indented
+ (calendar-move-to-column indent)
+ (insert
(calendar-string-spread
- (list (format "%s %d" (calendar-month-name month) year)) ?\s 20)
- indent t)
- (calendar-insert-indented "" indent) ; go to proper spot
+ (list (format "%s %d" (calendar-month-name month) year))
+ ?\s calendar-month-digit-width))
+ (calendar-ensure-newline)
+ (calendar-insert-at-column indent calendar-intermonth-header trunc)
;; Use the first two characters of each day to head the columns.
(dotimes (i 7)
(insert
(setq string
(calendar-day-name (mod (+ calendar-week-start-day i) 7) nil t))
(if enable-multibyte-characters
- (truncate-string-to-width string 2)
- (substring string 0 2)))
- " "))
- (calendar-insert-indented "" 0 t) ; force onto following line
- (calendar-insert-indented "" indent) ; go to proper spot
+ (truncate-string-to-width string calendar-day-header-width)
+ (substring string 0 calendar-day-header-width)))
+ (make-string (- calendar-column-width calendar-day-header-width) ?\s)))
+ (calendar-ensure-newline)
+ (calendar-insert-at-column indent calendar-intermonth-text trunc)
;; Add blank days before the first of the month.
- (dotimes (idummy blank-days) (insert " "))
+ (insert (make-string (* blank-days calendar-column-width) ?\s))
;; Put in the days of the month.
(dotimes (i last)
- (insert (format "%2d " (1+ i)))
- (add-text-properties
- (- (point) 3) (1- (point))
- '(mouse-face highlight
- help-echo "mouse-2: menu of operations for this date"))
- (and (zerop (mod (+ i 1 blank-days) 7))
- (/= i (1- last))
- (calendar-insert-indented "" 0 t) ; force onto following line
- (calendar-insert-indented "" indent))))) ; go to proper spot
-
-(defun calendar-insert-indented (string indent &optional newline)
- "Insert STRING at column INDENT.
-If the optional parameter NEWLINE is non-nil, leave point at start of next
-line, inserting a newline if there was no next line; otherwise, leave point
-after the inserted text. Returns t."
- ;; Try to move to that column.
- (move-to-column indent)
- ;; If line is too short, indent out to that column.
- (if (< (current-column) indent)
- (indent-to indent))
- (insert string)
- ;; Advance to next line, if requested.
- (when newline
- (end-of-line)
- (if (eobp)
- (newline)
- (forward-line 1)))
- t)
+ (setq day (1+ i))
+ ;; TODO should numbers be left-justified, centered...?
+ (insert (format (format "%%%dd%%s" calendar-day-digit-width) day
+ (make-string
+ (- calendar-column-width calendar-day-digit-width) ?\s)))
+ ;; 'date property prevents intermonth text confusing re-searches.
+ ;; (Tried intangible, it did not really work.)
+ (set-text-properties
+ (- (point) (1+ calendar-day-digit-width)) (1- (point))
+ `(mouse-face highlight help-echo ,(eval calendar-date-echo-text)
+ date t))
+ (when (and (zerop (mod (+ day blank-days) 7))
+ (/= day last))
+ (calendar-ensure-newline)
+ (setq day (1+ day)) ; first day of next week
+ (calendar-insert-at-column indent calendar-intermonth-text trunc)))))
(defun calendar-redraw ()
"Redraw the calendar display, if `calendar-buffer' is live."
(define-key map "Aa" 'appt-add)
(define-key map "Ad" 'appt-delete)
(define-key map "S" 'calendar-sunrise-sunset)
- (define-key map "M" 'calendar-phases-of-moon)
+ (define-key map "M" 'calendar-lunar-phases)
(define-key map " " 'scroll-other-window)
(define-key map "\d" 'scroll-other-window-down)
(define-key map "\C-c\C-l" 'calendar-redraw)
(define-key map [menu-bar edit] 'undefined)
(define-key map [menu-bar search] 'undefined)
- ;; This ignores the mouse-up event after the mouse-down that pops up the
- ;; context menu. It should not be necessary because the mouse-up event
- ;; should be eaten up by the menu-handling toolkit.
- ;; (define-key map [mouse-2] 'ignore)
- (easy-menu-define nil map nil cal-menu-moon-menu)
+ (easy-menu-define nil map nil cal-menu-sunmoon-menu)
(easy-menu-define nil map nil cal-menu-diary-menu)
(easy-menu-define nil map nil cal-menu-holidays-menu)
(easy-menu-define nil map nil cal-menu-goto-menu)
(easy-menu-define nil map nil cal-menu-scroll-menu)
+ ;; These are referenced in the default calendar-date-echo-text.
(define-key map [down-mouse-3]
(easy-menu-binding cal-menu-context-mouse-menu))
(define-key map [down-mouse-2]
(easy-menu-binding cal-menu-global-mouse-menu))
+ ;; Left-click moves us forward in time, right-click backwards.
+ ;; cf scroll-bar.el.
+ (define-key map [vertical-scroll-bar mouse-1] 'calendar-scroll-left)
+ (define-key map [vertical-scroll-bar drag-mouse-1] 'calendar-scroll-left)
+ ;; down-mouse-2 stays as scroll-bar-drag.
+ (define-key map [vertical-scroll-bar mouse-3] 'calendar-scroll-right)
+ (define-key map [vertical-scroll-bar drag-mouse-3] 'calendar-scroll-right)
+
map)
"Keymap for `calendar-mode'.")
-;; FIXME unused?
-(defun calendar-describe-mode ()
- "Create a help buffer with a brief description of the `calendar-mode'."
- (interactive)
- (help-setup-xref (list #'calendar-describe-mode) (interactive-p))
- (with-output-to-temp-buffer (help-buffer)
- (princ
- (format
- "Calendar Mode:\nFor a complete description, type %s\n%s\n"
- (substitute-command-keys
- "\\<calendar-mode-map>\\[describe-mode] from within the calendar")
- (substitute-command-keys "\\{calendar-mode-map}")))
- (print-help-return-message)))
-
;; Calendar mode is suitable only for specially formatted data.
(put 'calendar-mode 'mode-class 'special)
+(defun calendar-mode-line-entry (command echo &optional key string)
+ "Return a propertized string for `calendar-mode-line-format'.
+COMMAND is a command to run, ECHO is the help-echo text, KEY
+is COMMAND's keybinding, STRING describes the binding."
+ (propertize (or key
+ (substitute-command-keys
+ (format "\\<calendar-mode-map>\\[%s] %s" command string)))
+ 'help-echo (format "mouse-1: %s" echo)
+ 'mouse-face 'mode-line-highlight
+ 'keymap (make-mode-line-mouse-map 'mouse-1 command)))
+
;; After calendar-mode-map.
(defcustom calendar-mode-line-format
(list
- (propertize "<"
- 'help-echo "mouse-1: previous month"
- 'mouse-face 'mode-line-highlight
- 'keymap (make-mode-line-mouse-map 'mouse-1
- 'calendar-scroll-right))
+ (calendar-mode-line-entry 'calendar-scroll-right "previous month" "<")
"Calendar"
(concat
- (propertize
- (substitute-command-keys
- "\\<calendar-mode-map>\\[calendar-goto-info-node] info")
- 'help-echo "mouse-1: read Info on Calendar"
- 'mouse-face 'mode-line-highlight
- 'keymap (make-mode-line-mouse-map 'mouse-1 'calendar-goto-info-node))
+ (calendar-mode-line-entry 'calendar-goto-info-node "read Info on Calendar"
+ nil "info")
" / "
- (propertize
- (substitute-command-keys
- " \\<calendar-mode-map>\\[calendar-other-month] other")
- 'help-echo "mouse-1: choose another month"
- 'mouse-face 'mode-line-highlight
- 'keymap (make-mode-line-mouse-map
- 'mouse-1 'calendar-mouse-other-month))
+ (calendar-mode-line-entry 'calendar-other-month "choose another month"
+ nil "other")
" / "
- (propertize
- (substitute-command-keys
- "\\<calendar-mode-map>\\[calendar-goto-today] today")
- 'help-echo "mouse-1: go to today's date"
- 'mouse-face 'mode-line-highlight
- 'keymap (make-mode-line-mouse-map 'mouse-1 #'calendar-goto-today)))
+ (calendar-mode-line-entry 'calendar-goto-today "go to today's date"
+ nil "today"))
'(calendar-date-string (calendar-current-date) t)
- (propertize ">"
- 'help-echo "mouse-1: next month"
- 'mouse-face 'mode-line-highlight
- 'keymap (make-mode-line-mouse-map
- 'mouse-1 'calendar-scroll-left)))
+ (calendar-mode-line-entry 'calendar-scroll-left "next month" ">"))
"The mode line of the calendar buffer.
+This is a list of items that evaluate to strings. The elements
+are evaluated and concatenated, evenly separated by blanks.
+During evaluation, the variable `date' is available as the date
+nearest the cursor (or today's date if that fails). To update
+the mode-line as the cursor moves, add `calendar-update-mode-line'
+to `calendar-move-hook'. Here is an example that has the Hebrew date,
+the day number/days remaining in the year, and the ISO week/year numbers:
-This must be a list of items that evaluate to strings--those strings are
-evaluated and concatenated together, evenly separated by blanks. The variable
-`date' is available for use as the date under (or near) the cursor; `date'
-defaults to the current date if it is otherwise undefined. Here is an example
-value that has the Hebrew date, the day number/days remaining in the year,
-and the ISO week/year numbers in the mode. When `calendar-move-hook' is set
-to `calendar-update-mode-line', the mode line shows these values for the date
-under the cursor:
-
- (list
- \"\"
- '(calendar-hebrew-date-string date)
- '(let* ((year (calendar-extract-year date))
- (d (calendar-day-number date))
- (days-remaining
- (- (calendar-day-number (list 12 31 year)) d)))
- (format \"%d/%d\" d days-remaining))
- '(let* ((d (calendar-absolute-from-gregorian date))
- (iso-date (calendar-iso-from-absolute d)))
- (format \"ISO week %d of %d\"
- (calendar-extract-month iso-date)
- (calendar-extract-year iso-date)))
- \"\"))"
+ (list
+ \"\"
+ '(calendar-hebrew-date-string date)
+ '(let* ((year (calendar-extract-year date))
+ (d (calendar-day-number date))
+ (days-remaining
+ (- (calendar-day-number (list 12 31 year)) d)))
+ (format \"%d/%d\" d days-remaining))
+ '(let* ((d (calendar-absolute-from-gregorian date))
+ (iso-date (calendar-iso-from-absolute d)))
+ (format \"ISO week %d of %d\"
+ (calendar-extract-month iso-date)
+ (calendar-extract-year iso-date)))
+ \"\"))"
+ :risky t
:type 'sexp
:group 'calendar)
-(defun calendar-mouse-other-month (event)
- "Display a three-month calendar centered around a specified month and year.
-EVENT is the last mouse event."
- (interactive "e")
- (save-selected-window
- (select-window (posn-window (event-start event)))
- (call-interactively 'calendar-other-month)))
-
(defun calendar-goto-info-node ()
"Go to the info node for the calendar."
(interactive)
- (info "(emacs)Calendar/Diary"))
+ (info "(emacs)Calendar/Diary")
+ (fit-window-to-buffer))
(defvar calendar-mark-ring nil
"Used by `calendar-set-mark'.")
-(defun calendar-mode ()
+(define-derived-mode calendar-mode nil "Calendar"
"A major mode for the calendar window.
-
-For a complete description, type \
-\\<calendar-mode-map>\\[calendar-goto-info-node] from within the calendar.
+For a complete description, see the info node `Calendar/Diary'.
\\<calendar-mode-map>\\{calendar-mode-map}"
- (kill-all-local-variables)
- (setq major-mode 'calendar-mode
- mode-name "Calendar"
- buffer-read-only t
+ (setq buffer-read-only t
buffer-undo-list t
indent-tabs-mode nil)
- (use-local-map calendar-mode-map)
(calendar-update-mode-line)
(make-local-variable 'calendar-mark-ring)
(make-local-variable 'displayed-month) ; month in middle of window
(unless (boundp 'displayed-month) (setq displayed-month 1))
(unless (boundp 'displayed-year) (setq displayed-year 2001))
(set (make-local-variable 'font-lock-defaults)
- '(calendar-font-lock-keywords t))
- (run-mode-hooks 'calendar-mode-hook))
+ '(calendar-font-lock-keywords t)))
(defun calendar-string-spread (strings char length)
"Concatenate list of STRINGS separated with copies of CHAR to fill LENGTH.
"Update the calendar mode line with the current date and date style."
(if (bufferp (get-buffer calendar-buffer))
(with-current-buffer calendar-buffer
- (setq mode-line-format
- (calendar-string-spread
- (let ((date (condition-case nil
- (calendar-cursor-to-nearest-date)
- (error (calendar-current-date)))))
- (mapcar 'eval calendar-mode-line-format))
- ?\s (frame-width)))
+ (let ((start (- calendar-left-margin 2))
+ (date (condition-case nil
+ (calendar-cursor-to-nearest-date)
+ (error (calendar-current-date)))))
+ (setq mode-line-format
+ (concat (make-string (max 0 (+ start
+ (- (car (window-inside-edges))
+ (car (window-edges))))) ?\s)
+ (calendar-string-spread
+ (mapcar 'eval calendar-mode-line-format)
+ ?\s (- calendar-right-margin (1- start))))))
(force-mode-line-update))))
(defun calendar-window-list ()
"List of all calendar-related windows."
(let ((calendar-buffers (calendar-buffer-list))
list)
+ ;; Using 0 rather than t for last argument - see bug#2199.
+ ;; This is only used with calendar-hide-window, which ignores
+ ;; iconified frames anyway, so could use 'visible rather than 0.
(walk-windows (lambda (w)
(if (memq (window-buffer w) calendar-buffers)
(push w list)))
- nil t)
+ nil 0)
list))
(defun calendar-buffer-list ()
"List of all calendar-related buffers (as buffers, not strings)."
(let (buffs)
(dolist (b (list calendar-hebrew-yahrzeit-buffer lunar-phases-buffer
- holiday-buffer diary-fancy-buffer
+ holiday-buffer diary-fancy-buffer solar-sunrises-buffer
(get-file-buffer diary-file)
calendar-buffer calendar-other-calendars-buffer))
(and b (setq b (get-buffer b))
(t (set-buffer buffer)
(bury-buffer))))))
-(defun calendar-current-date ()
- "Return the current date in a list (month day year)."
- (let ((now (decode-time)))
- (list (nth 4 now) (nth 3 now) (nth 5 now))))
-
-(defun calendar-cursor-to-date (&optional error)
+(defun calendar-current-date (&optional offset)
+ "Return the current date in a list (month day year).
+Optional integer OFFSET is a number of days from the current date."
+ (let* ((now (decode-time))
+ (now (list (nth 4 now) (nth 3 now) (nth 5 now))))
+ (if (zerop (or offset 0))
+ now
+ (calendar-gregorian-from-absolute
+ (+ offset (calendar-absolute-from-gregorian now))))))
+
+(defun calendar-column-to-segment ()
+ "Convert current column to calendar month \"segment\".
+The left-most month returns 0, the next right 1, and so on."
+ (let ((col (max 0 (+ (current-column)
+ (/ calendar-intermonth-spacing 2)
+ (- calendar-left-margin)))))
+ (/ col (+ (* 7 calendar-column-width) calendar-intermonth-spacing))))
+
+(defun calendar-cursor-to-date (&optional error event)
"Return a list (month day year) of current cursor position.
If cursor is not on a specific date, signals an error if optional parameter
-ERROR is non-nil, otherwise just returns nil."
- (let* ((segment (/ (current-column) 25))
- (month (% (+ displayed-month segment -1) 12))
- (month (if (zerop month) 12 month))
- (year
- (cond
- ((and (= 12 month) (zerop segment)) (1- displayed-year))
- ((and (= 1 month) (= segment 2)) (1+ displayed-year))
- (t displayed-year))))
- (if (and (looking-at "[ 0-9]?[0-9][^0-9]")
- (< 2 (count-lines (point-min) (point))))
- (save-excursion
- (if (not (looking-at " "))
+ERROR is non-nil, otherwise just returns nil.
+If EVENT is non-nil, it's an event indicating the buffer position to
+use instead of point."
+ (with-current-buffer
+ (if event (window-buffer (posn-window (event-start event)))
+ (current-buffer))
+ (save-excursion
+ (and event (setq event (event-start event))
+ (goto-char (posn-point event)))
+ (let* ((segment (calendar-column-to-segment))
+ (month (% (+ displayed-month (1- segment)) 12)))
+ ;; Call with point on either of the two digits in a 2-digit date,
+ ;; or on or before the digit of a 1-digit date.
+ (if (not (and (looking-at "[ 0-9]?[0-9][^0-9]")
+ (get-text-property (point) 'date)))
+ (if error (error "Not on a date!"))
+ ;; Convert segment to real month and year.
+ (if (zerop month) (setq month 12))
+ ;; Go back to before the first date digit.
+ (or (looking-at " ")
(re-search-backward "[^0-9]"))
(list month
- (string-to-number (buffer-substring (1+ (point)) (+ 4 (point))))
- year))
- (if error (error "Not on a date!")))))
+ (string-to-number
+ (buffer-substring (1+ (point))
+ (+ 1 calendar-day-digit-width (point))))
+ (cond
+ ((and (= 12 month) (zerop segment)) (1- displayed-year))
+ ((and (= 1 month) (= segment 2)) (1+ displayed-year))
+ (t displayed-year))))))))
(add-to-list 'debug-ignored-errors "Not on a date!")
month (1+ month)))
(list month day year))))
-(defun calendar-other-month (month year)
- "Display a three-month calendar centered around MONTH and YEAR."
- (interactive (calendar-read-date 'noday))
- (unless (and (= month displayed-month)
- (= year displayed-year))
- (let ((old-date (calendar-cursor-to-date))
- (today (calendar-current-date)))
- (calendar-generate-window month year)
- (calendar-cursor-to-visible-date
- (cond
- ((calendar-date-is-visible-p old-date) old-date)
- ((calendar-date-is-visible-p today) today)
- (t (list month 1 year)))))))
-
-(defun calendar-set-mark (arg)
+(defun calendar-other-month (month year &optional event)
+ "Display a three-month calendar centered around MONTH and YEAR.
+EVENT is an event like `last-nonmenu-event'."
+ (interactive (let ((event (list last-nonmenu-event)))
+ (append (calendar-read-date 'noday) event)))
+ (save-selected-window
+ (and event
+ (setq event (event-start event))
+ (select-window (posn-window event)))
+ (unless (and (= month displayed-month)
+ (= year displayed-year))
+ (let ((old-date (calendar-cursor-to-date))
+ (today (calendar-current-date)))
+ (calendar-generate-window month year)
+ (calendar-cursor-to-visible-date
+ (cond
+ ((calendar-date-is-visible-p old-date) old-date)
+ ((calendar-date-is-visible-p today) today)
+ (t (list month 1 year))))))))
+
+(defun calendar-set-mark (arg &optional event)
"Mark the date under the cursor, or jump to marked date.
With no prefix argument, push current date onto marked date ring.
With argument ARG, jump to mark, pop it, and put point at end of ring."
- (interactive "P")
- (let ((date (calendar-cursor-to-date t)))
+ (interactive
+ (list current-prefix-arg last-nonmenu-event))
+ (let ((date (calendar-cursor-to-date t event)))
(if arg
(if (null calendar-mark-ring)
(error "No mark set in this buffer")
" -?[0-9]+")
. font-lock-function-name-face) ; month and year
(,(regexp-opt
- (list (substring (aref calendar-day-name-array 6) 0 2)
- (substring (aref calendar-day-name-array 0) 0 2)))
+ (list (substring (aref calendar-day-name-array 6)
+ 0 calendar-day-header-width)
+ (substring (aref calendar-day-name-array 0)
+ 0 calendar-day-header-width)))
;; Saturdays and Sundays are highlighted differently.
. font-lock-comment-face)
;; First two chars of each day are used in the calendar.
- (,(regexp-opt (mapcar (lambda (x) (substring x 0 2))
+ (,(regexp-opt (mapcar (lambda (x) (substring x 0 calendar-day-header-width))
calendar-day-name-array))
. font-lock-reference-face))
"Default keywords to highlight in Calendar mode.")
interpreted as BC; -1 being 1 BC, and so on."
(mod (calendar-absolute-from-gregorian date) 7))
+(defun calendar-week-end-day ()
+ "Return the index (0 for Sunday, etc.) of the last day of the week."
+ (mod (+ calendar-week-start-day 6) 7))
+
(defun calendar-unmark ()
"Delete all diary/holiday marks/highlighting from the calendar."
(interactive)
(calendar-cursor-to-visible-date date)
(setq mark
(or (and (stringp mark) (= (length mark) 1) mark) ; single-char
- (and font-lock-mode
- (or
+ ;; The next two use to also check font-lock-mode.
+ ;; See comments above diary-entry-marker for why
+ ;; this was dropped.
+;;; (and font-lock-mode
+;;; (or
(and (listp mark) (> (length mark) 0) mark) ; attrs
- (and (facep mark) mark))) ; face-name
- diary-entry-marker))
+ (and (facep mark) mark) ; )) face-name
+ diary-entry-marker))
(cond
;; Face or an attr-list that contained a face.
((facep mark)
this function to `calendar-today-visible-hook'."
(calendar-mark-visible-date (calendar-cursor-to-date) calendar-today-marker))
+;; FIXME why the car? Almost every usage calls list on the args.
(defun calendar-date-compare (date1 date2)
"Return t if DATE1 is before DATE2, nil otherwise.
The actual dates are in the car of DATE1 and DATE2."
(- date (% (- date dayname) 7)))
(defun calendar-nth-named-absday (n dayname month year &optional day)
- "The absolute date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
-A DAYNAME of 0 means Sunday, 1 means Monday, and so on. If N<0,
-return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
+ "Absolute date of the Nth DAYNAME after/before MONTH YEAR DAY.
+A DAYNAME of 0 means Sunday, 1 means Monday, and so on.
If N>0, return the Nth DAYNAME after MONTH DAY, YEAR (inclusive).
-
-If DAY is omitted, it defaults to 1 if N>0, and MONTH's last day otherwise."
+If N<0, return the Nth DAYNAME before MONTH DAY, YEAR (inclusive).
+DAY defaults to 1 if N>0, and MONTH's last day otherwise."
(if (> n 0)
(+ (* 7 (1- n))
(calendar-dayname-on-or-before
year))))))
(defun calendar-nth-named-day (n dayname month year &optional day)
- "The date of Nth DAYNAME in MONTH, YEAR before/after optional DAY.
+ "Date of the Nth DAYNAME after/before MONTH YEAR DAY.
Like `calendar-nth-named-absday', but returns a Gregorian date."
(calendar-gregorian-from-absolute
(calendar-nth-named-absday n dayname month year day)))
(format "Mayan date: %s"
(calendar-mayan-date-string date))))))
-(defun calendar-print-other-dates ()
- "Show dates on other calendars for date under the cursor."
- (interactive)
- (let ((date (calendar-cursor-to-date t)))
- (calendar-in-read-only-buffer calendar-other-calendars-buffer
- (calendar-set-mode-line (format "%s (Gregorian)"
- (calendar-date-string date)))
- (insert (mapconcat 'identity (calendar-other-dates date) "\n")))))
+(declare-function x-popup-menu "menu.c" (position menu))
+
+(defun calendar-print-other-dates (&optional event)
+ "Show dates on other calendars for date under the cursor.
+If called by a mouse-event, pops up a menu with the result."
+ (interactive (list last-nonmenu-event))
+ (let* ((date (calendar-cursor-to-date t event))
+ (title (format "%s (Gregorian)" (calendar-date-string date)))
+ (others (calendar-other-dates date))
+ selection)
+ (if (mouse-event-p event)
+ (and (setq selection (cal-menu-x-popup-menu event title
+ (mapcar 'list others)))
+ (call-interactively selection))
+ (calendar-in-read-only-buffer calendar-other-calendars-buffer
+ (calendar-set-mode-line title)
+ (insert (mapconcat 'identity others "\n"))))))
(defun calendar-print-day-of-year ()
"Show day number in year/days remaining in year for date under the cursor."
(let* ((edges (window-edges))
;; As per doc of window-width, total visible mode-line length.
(width (- (nth 2 edges) (car edges))))
+ ;; Hack for --daemon. See bug #2199.
+ ;; If no frame exists yet, we have no idea what width to use.
+ (and (= width 10)
+ (not window-system)
+ (setq width (or (getenv "COLUMNS") 80)))
(setq mode-line-format
(if buffer-file-name
`("-" mode-line-modified
;; byte-compile-dynamic: t
;; End:
-;; arch-tag: 19c61596-c8fb-4c69-bcf1-7dd739919cd8
;;; calendar.el ends here
HCoop / bpt / emacs.git / blobdiff