lisp/calendar/calendar.el

30 ;; This collection of functions implements a calendar window.  It
32 ;; previous and coming months, or for any other three-month period.
33 ;; The calendar can be scrolled forward and backward in the window to
38 ;; of holidays and other notable days for the period shown; the
42 ;; any date can be viewed in a separate window.  The diary and the
142   "The offset of the principal month from the center of the calendar window.
152 The diary is displayed in another window when the calendar is first displayed,
161   "Non-nil means mark dates with diary entries, in the calendar window.
242 The holidays are displayed in another window when the calendar is first
249   "Non-nil means mark dates of holidays in the calendar window.
311 (defcustom initial-calendar-window-hook nil
312   "List of functions to be called when the calendar window is first opened.
313 The functions invoked are called after the calendar window is opened, but
331 date is not visible in the window.
345 date is visible in the window.
409 window but will appear in a diary window.
431 diary window; only the continuation lines is shown.  For example, the
442 will appear in the diary window without the date line at the beginning.  This
443 facility allows the diary window to look neater, but can cause confusion if
468 Diary files can contain directives to include the contents of other files; for
500 See the documentation for the function `include-other-diary-files'."
752 A function `include-other-diary-files' is provided for use as the value of
760 obeyed.  You can change the \"#include\" to some other string by changing
761 the variable `diary-include-string'.  When you use `include-other-diary-files'
768        '(include-other-diary-files sort-diary-entries))
775   :options '(include-other-diary-files sort-diary-entries)
839 obeyed.  You can change the \"#include\" to some other string by changing the
842 function `include-other-diary-files' as part of `list-diary-entries-hook'."
927 (put 'other-holidays 'risky-local-variable t)
929 (defcustom other-holidays nil
1202   (append general-holidays local-holidays other-holidays
1208 list `other-holidays' in your .emacs file.  Similarly, by setting any
1225 site-init.el and `other-holidays' be set by the user.
1318 (defconst other-calendars-buffer "*Other Calendars*"
1319   "Name of the buffer used for the display of date on other calendars.")
1475   "Reposition the calendar window so the current date is visible."
1494 (autoload 'scroll-calendar-left "cal-move"
1498 (autoload 'scroll-calendar-right "cal-move"
1499   "Scroll the displayed calendar window right by ARG months."
1502 (autoload 'scroll-calendar-left-three-months "cal-move"
1503   "Scroll the displayed calendar window left by 3*ARG months."
1506 (autoload 'scroll-calendar-right-three-months "cal-move"
1507   "Scroll the displayed calendar window right by 3*ARG months."
1581 any other value the current frame is used.  Using any of the first
1590 (defcustom calendar-minimum-window-height 8
1591   "Minimum height `generate-calendar-window' should use for calendar window."
1618   "Create a buffer containing the holidays for the current calendar window.
1624   "Display a three-month calendar in another window.
1632 the current date to be displayed in another window.  The value of the variable
1636 Once in the calendar window, future or past months can be moved into view.
1643 and the minus sign are automatically prefixes.  The window is replotted as
1646 Diary entries can be marked on the calendar or displayed in another window.
1648 Use \\[describe-mode] for details of the key bindings in the calendar window.
1656 After preparing the calendar window initially, the hooks given by the variable
1657 `initial-calendar-window-hook' are run.
1660 every time the calendar window gets scrolled, if the current date is visible
1661 in the window.  If it is not visible, the hooks given by the variable
1664 to be replaced by asterisks to highlight it whenever it is in the window."
1680     (generate-calendar-window month year)
1684          (diary-window (if diary-buffer (get-buffer-window diary-buffer)))
1685          (split-height-threshold (if diary-window 2 1000)))
1688   (run-hooks 'initial-calendar-window-hook))
1690 (autoload 'view-other-diary-entries "diary-lib"
1702   "Create a buffer of the phases of the moon for the current calendar window."
1883   "Mark days in the calendar window that have diary entries.
1884 Each entry in diary file visible in the calendar window is marked."
2044   "Mark notable days in the calendar window."
2048   "Find holidays for the date specified by the cursor in the calendar window."
2051 (defun generate-calendar-window (&optional mon yr)
2052   "Generate the calendar window for the current date.
2064          (in-calendar-window (eq (window-buffer (selected-window))
2073     ;; Don't do any window-related stuff if we weren't called from a
2074     ;; window displaying the calendar
2075     (when in-calendar-window
2076       (if (or (one-window-p t) (/= (frame-width) (window-width)))
2077           ;; Don't mess with the window size, but ensure that the first
2079           (set-window-vscroll nil 0)
2080         ;; Adjust the window to exactly fit the displayed calendar
2081         (fit-window-to-buffer nil nil calendar-minimum-window-height))
2089          (and in-calendar-window (sit-for 0)))
2100 ;;; stands, almost all other calendar functions (eg holidays) would
2181           (generate-calendar-window displayed-month displayed-year)
2218     (define-key map "<"     'scroll-calendar-right)
2219     (define-key map "\C-x<" 'scroll-calendar-right)
2220     (define-key map [prior] 'scroll-calendar-right-three-months)
2221     (define-key map "\ev"   'scroll-calendar-right-three-months)
2222     (define-key map ">"     'scroll-calendar-left)
2223     (define-key map "\C-x>" 'scroll-calendar-left)
2224     (define-key map [next]  'scroll-calendar-left-three-months)
2225     (define-key map "\C-v"  'scroll-calendar-left-three-months)
2274     (define-key map " "   'scroll-other-window)
2275     (define-key map (kbd "DEL") 'scroll-other-window-down)
2278     (define-key map "o"   'calendar-other-month)
2286     (define-key map "D"   'view-other-diary-entries)
2301     (define-key map "po"  'calendar-print-other-dates)
2360 						 'mouse-scroll-calendar-right))
2372      " \\<calendar-mode-map>\\[calendar-other-month] other")
2376 	      'mouse-1 'mouse-calendar-other-month))
2389 			'mouse-1 'mouse-scroll-calendar-left)))
2417 (defun mouse-scroll-calendar-left (event)
2422   (save-selected-window
2423     (select-window (posn-window (event-start event)))
2424     (scroll-calendar-left 1)))
2426 (defun mouse-scroll-calendar-right (event)
2431   (save-selected-window
2432     (select-window (posn-window (event-start event)))
2433     (scroll-calendar-right 1)))
2435 (defun mouse-calendar-other-month (event)
2438   (save-selected-window
2439     (select-window (posn-window (event-start event)))
2440     (call-interactively 'calendar-other-month)))
2446   (let ((where (save-window-excursion
2450       (let (same-window-buffer-names)
2457   "A major mode for the calendar window.
2472   (make-local-variable 'displayed-month);;  Month in middle of window.
2473   (make-local-variable 'displayed-year)	;;  Year in middle of window.
2516 (defun calendar-window-list ()
2521 		    (if (memq (window-buffer w) calendar-buffers)
2531                         other-calendars-buffer))
2541   "Get out of the calendar window and hide it and related buffers."
2549       ;; calendar-related buffers with other calendar-related buffers
2551                 (mapcar 'calendar-hide-window (calendar-window-list)))
2552               (calendar-window-list)))))
2554 (defun calendar-hide-window (window)
2556   (let ((buffer (if (window-live-p window) (window-buffer window))))
2562                                       (window-frame window))))))
2564          ((and (display-multi-frame-p) (window-dedicated-p window))
2566               (delete-frame (window-frame window))
2567               (iconify-frame (window-frame window))))
2568          ((not (and (select-window window) (one-window-p window)))
2569           (delete-window window))
2660 (defun calendar-other-month (month year)
2668       (generate-calendar-window month year)
2686           ;; in other buffers to get the same effect.
2737 \(month nil year); if NODAY is any other non-nil value the value returned is
2911   "Return t if DATE is valid and is visible in the calendar window."
2941   "Mark DATE in the calendar window with MARK.
2991   "Replace the date under the cursor in the calendar window with asterisks.
2993 calendar window has been prepared."
3008   "Mark the date under the cursor in the calendar window.
3010 the `today-visible-calendar-hook' run after the calendar window has been
3090 (defun calendar-print-other-dates ()
3091   "Show dates on other calendars for date under the cursor."
3094     (with-current-buffer (get-buffer-create other-calendars-buffer)
3137       (display-buffer other-calendars-buffer))))
3146   (let* ((edges (window-edges))
3147          ;; As per doc of window-width, total visible mode-line length.