;;; diary-lib.el --- diary functions
;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2001, 2002, 2003,
-;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
;; Maintainer: Glenn Morris <rgm@gnu.org>
;; 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:
-;; This collection of functions implements the diary features as described
-;; in calendar.el.
+;; See calendar.el.
;;; Code:
(require 'calendar)
+(eval-and-compile (load "diary-loaddefs" nil t))
-(eval-and-compile
- (load "diary-loaddefs" nil 'quiet))
+(defgroup diary nil
+ "Emacs diary."
+ :prefix "diary-"
+ :group 'calendar)
(defcustom diary-include-string "#include"
"The string indicating inclusion of another file of diary entries.
-See the documentation for the function `include-other-diary-files'."
+See the documentation for the function `diary-include-other-diary-files'."
:type 'string
:group 'diary)
(defcustom diary-face 'diary
"Face name to use for diary entries."
:type 'face
- :group 'diary)
+ :group 'calendar-faces)
(make-obsolete-variable 'diary-face "customize the face `diary' instead."
"23.1")
(defface diary-anniversary '((t :inherit font-lock-keyword-face))
"Face used for anniversaries in the fancy diary display."
:version "22.1"
- :group 'diary)
+ :group 'calendar-faces)
(defface diary-time '((t :inherit font-lock-variable-name-face))
- "Face used for times of day in the diary."
+ "Face used for times of day in the fancy diary display."
:version "22.1"
- :group 'diary)
+ :group 'calendar-faces)
(defface diary-button '((((type pc) (class color))
(:foreground "lightblue")))
- "Default face used for buttons."
+ "Face used for buttons in the fancy diary display."
:version "22.1"
- :group 'diary)
-;; Backward-compatibility alias. FIXME make obsolete.
-(put 'diary-button-face 'face-alias 'diary-button)
+ :group 'calendar-faces)
+
+(define-obsolete-face-alias 'diary-button-face 'diary-button "22.1")
;; Face markup of calendar and diary displays: Any entry line that
;; ends with [foo:value] where foo is a face attribute (except :box
specifies which face attribute (e.g. `:foreground') to modify, or
that this is a face (`:face') to apply. TYPE is the type of
attribute being applied. Available TYPES (see `diary-attrtype-convert')
-are: `string', `symbol', `int', `tnil',`stringtnil.'"
+are: `string', `symbol', `int', `tnil', `stringtnil.'"
:type '(repeat (list (string :tag "Regular expression")
(integer :tag "Sub-expression")
(symbol :tag "Attribute (e.g. :foreground)")
:type 'function
:group 'diary)
-(defcustom sexp-diary-entry-symbol "%%"
+(define-obsolete-variable-alias 'sexp-diary-entry-symbol
+ 'diary-sexp-entry-symbol "23.1")
+
+(defcustom diary-sexp-entry-symbol "%%"
"The string used to indicate a sexp diary entry in `diary-file'.
-See the documentation for the function `list-sexp-diary-entries'."
+See the documentation for the function `diary-list-sexp-entries'."
:type 'string
:group 'diary)
-(defcustom list-diary-entries-hook nil
+(defcustom diary-hook nil
+ "List of functions called after the display of the diary.
+Used for example by the appointment package - see `appt-activate'."
+ :type 'hook
+ :group 'diary)
+
+(define-obsolete-variable-alias 'diary-display-hook 'diary-display-function
+ "23.1")
+
+(defcustom diary-display-function 'diary-fancy-display
+ "Function used to display the diary.
+The two standard options are `diary-fancy-display' and `diary-simple-display'.
+
+For historical reasons, `nil' is the same as `diary-simple-display'
+\(so you must use `ignore' for no display). Also for historical
+reasons, this variable can be a list of functions to run. These
+uses are not recommended and may be removed at some point.
+
+When this function is called, the variable `diary-entries-list'
+is a list, in order by date, of all relevant diary entries in the
+form of ((MONTH DAY YEAR) STRING), where string is the diary
+entry for the given date. This can be used, for example, to
+produce a different buffer for display (perhaps combined with
+holidays), or hard copy output."
+ :type '(choice (const diary-fancy-display :tag "Fancy display")
+ (const diary-simple-display :tag "Basic display")
+ (const ignore :tag "No display")
+ (const nil :tag "Obsolete way to choose basic display")
+ (hook :tag "Obsolete form with list of display functions"))
+ :initialize 'custom-initialize-default
+ :set 'diary-set-maybe-redraw
+ :version "23.2" ; simple->fancy
+ :group 'diary)
+
+(define-obsolete-variable-alias 'list-diary-entries-hook
+ 'diary-list-entries-hook "23.1")
+
+(defcustom diary-list-entries-hook nil
"List of functions called after diary file is culled for relevant entries.
-You might wish to add `include-other-diary-files', in which case
-you will probably also want to add `mark-included-diary-files' to
-`mark-diary-entries-hook'. For example, you could use
+You might wish to add `diary-include-other-diary-files', in which case
+you will probably also want to add `diary-mark-included-diary-files' to
+`diary-mark-entries-hook'. For example, you could use
- (add-hook 'list-diary-entries-hook 'include-other-diary-files)
- (add-hook 'list-diary-entries-hook 'sort-diary-entries)
- (add-hook 'diary-display-hook 'fancy-diary-display)
+ (setq diary-display-function 'diary-fancy-display)
+ (add-hook 'diary-list-entries-hook 'diary-include-other-diary-files)
+ (add-hook 'diary-list-entries-hook 'diary-sort-entries)
in your `.emacs' file to cause the fancy diary buffer to be displayed with
diary entries from various included files, each day's entries sorted into
lexicographic order."
:type 'hook
- :options '(include-other-diary-files sort-diary-entries)
+ :options '(diary-include-other-diary-files diary-sort-entries)
:group 'diary)
-(defcustom mark-diary-entries-hook nil
+(define-obsolete-variable-alias 'mark-diary-entries-hook
+ 'diary-mark-entries-hook "23.1")
+
+(defcustom diary-mark-entries-hook nil
"List of functions called after marking diary entries in the calendar.
-You might wish to add `mark-included-diary-files', in which case
-you will probably also want to add `include-other-diary-files' to
-`list-diary-entries-hook'."
+You might wish to add `diary-mark-included-diary-files', in which case
+you will probably also want to add `diary-include-other-diary-files' to
+`diary-list-entries-hook'."
:type 'hook
- :options '(mark-included-diary-files)
+ :options '(diary-mark-included-diary-files)
:group 'diary)
-(defcustom nongregorian-diary-listing-hook nil
+(define-obsolete-variable-alias 'nongregorian-diary-listing-hook
+ 'diary-nongregorian-listing-hook "23.1")
+
+(defcustom diary-nongregorian-listing-hook nil
"List of functions called for listing diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries. You can use any or all of
-`list-hebrew-diary-entries', `list-islamic-diary-entries' and
-`diary-bahai-list-entries'. The documentation for these functions
+`diary-bahai-list-entries', `diary-hebrew-list-entries', and
+`diary-islamic-list-entries'. The documentation for these functions
describes the style of such diary entries."
:type 'hook
- :options '(list-hebrew-diary-entries
- list-islamic-diary-entries
- diary-bahai-list-entries)
+ :options '(diary-bahai-list-entries
+ diary-hebrew-list-entries
+ diary-islamic-list-entries)
:group 'diary)
-(defcustom nongregorian-diary-marking-hook nil
+(define-obsolete-variable-alias 'nongregorian-diary-marking-hook
+ 'diary-nongregorian-marking-hook "23.1")
+
+(defcustom diary-nongregorian-marking-hook nil
"List of functions called for marking diary file and included files.
As the files are processed for diary entries, these functions are used
to cull relevant entries. You can use any or all of
-`mark-hebrew-diary-entries', `mark-islamic-diary-entries' and
-`bahai-mark-diary-entries'. The documentation for these functions
+`diary-bahai-mark-entries', `diary-hebrew-mark-entries' and
+`diary-islamic-mark-entries'. The documentation for these functions
describes the style of such diary entries."
:type 'hook
- :options '(mark-hebrew-diary-entries
- mark-islamic-diary-entries
- diary-bahai-mark-entries)
+ :options '(diary-bahai-mark-entries
+ diary-hebrew-mark-entries
+ diary-islamic-mark-entries)
:group 'diary)
-(defcustom print-diary-entries-hook 'lpr-buffer
- "List of functions called after a temporary diary buffer is prepared.
-The buffer shows only the diary entries currently visible in the diary
-buffer. The default just does the printing. Other uses might include, for
-example, rearranging the lines into order by day and time, saving the buffer
-instead of deleting it, or changing the function used to do the printing."
+(define-obsolete-variable-alias 'print-diary-entries-hook
+ 'diary-print-entries-hook "23.1")
+
+(defcustom diary-print-entries-hook 'lpr-buffer
+ "Run by `diary-print-entries' after preparing a temporary diary buffer.
+The buffer shows only the diary entries currently visible in the
+diary buffer. The default just does the printing. Other uses
+might include, for example, rearranging the lines into order by
+day and time, saving the buffer instead of deleting it, or
+changing the function used to do the printing."
:type 'hook
:group 'diary)
(defcustom diary-unknown-time -9999
"Value returned by `diary-entry-time' when no time is found.
-The default value -9999 causes entries with no recognizable time to be placed
-before those with times; 9999 would place entries with no recognizable time
-after those with times."
+The default value -9999 causes entries with no recognizable time
+to be placed before those with times; 9999 would place entries
+with no recognizable time after those with times."
:type 'integer
:group 'diary
:version "20.3")
(defcustom diary-mail-addr
- (if (boundp 'user-mail-address) user-mail-address "")
+ (or (bound-and-true-p user-mail-address) "")
"Email address that `diary-mail-entries' will send email to."
:group 'diary
:type 'string
"Pseudo-pattern giving form of reminder messages in the fancy diary display.
Used by the function `diary-remind', a pseudo-pattern is a list of
-expressions that can involve the keywords `days' (a number), `date' (a list of
-month, day, year), and `diary-entry' (a string)."
+expressions that can involve the keywords `days' (a number), `date'
+\(a list of month, day, year), and `diary-entry' (a string)."
:type 'sexp
:group 'diary)
+(define-obsolete-variable-alias 'abbreviated-calendar-year
+ 'diary-abbreviated-year-flag "23.1")
+
+(defcustom diary-abbreviated-year-flag t
+ "Interpret a two-digit year DD in a diary entry as either 19DD or 20DD.
+This applies to the Gregorian, Hebrew, Islamic, and Baha'i calendars.
+When the current century is added to a two-digit year, if the result
+is more than 50 years in the future, the previous century is assumed.
+If the result is more than 50 years in the past, the next century is assumed.
+If this variable is nil, years must be written in full."
+ :type 'boolean
+ :group 'diary)
+
(defcustom diary-outlook-formats
'(
;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ...
:version "22.1"
:group 'diary)
+(defvar diary-header-line-flag)
+(defvar diary-header-line-format)
(defun diary-set-header (symbol value)
"Set SYMBOL's value to VALUE, and redraw the diary header if necessary."
(let ((oldvalue (symbol-value symbol))
- (dbuff (and diary-file
- (find-buffer-visiting
- (substitute-in-file-name diary-file)))))
+ (dbuff (and diary-file (find-buffer-visiting diary-file))))
(custom-set-default symbol value)
(and dbuff
(not (equal value oldvalue))
;; This can be removed once the kill/yank treatment of invisible text
;; (see etc/TODO) is fixed. -- gm
(defcustom diary-header-line-flag t
- "Non-nil means `simple-diary-display' will show a header line.
+ "Non-nil means `diary-simple-display' will show a header line.
The format of the header is specified by `diary-header-line-format'."
:group 'diary
:type 'boolean
"Some text is hidden - press \"s\" in calendar \
before edit/copy"
"Diary"))
- ?\s (frame-width)))
- "Format of the header line displayed by `simple-diary-display'.
+ ?\s (window-width)))
+ "Format of the header line displayed by `diary-simple-display'.
Only used if `diary-header-line-flag' is non-nil."
:group 'diary
:type 'sexp
;;;###cal-autoload
(defun diary-live-p ()
"Return non-nil if the diary is being displayed."
- (or (get-buffer fancy-diary-buffer)
- (and diary-file
- (find-buffer-visiting (substitute-in-file-name diary-file)))))
+ (or (get-buffer diary-fancy-buffer)
+ (and diary-file (find-buffer-visiting diary-file))))
;;;###cal-autoload
(defun diary-set-maybe-redraw (symbol value)
;; Note this assumes diary was called without prefix arg.
(diary))))
-(defcustom number-of-diary-entries 1
+(define-obsolete-variable-alias 'number-of-diary-entries
+ 'diary-number-of-entries "23.1")
+
+(defcustom diary-number-of-entries 1
"Specifies how many days of diary entries are to be displayed initially.
-This variable affects the diary display when the command \\[diary] is used,
-or if the value of the variable `view-diary-entries-initially' is non-nil.
-For example, if the default value 1 is used, then only the current day's diary
-entries will be displayed. If the value 2 is used, then both the current
-day's and the next day's entries will be displayed.
-
-The value can also be a vector such as [0 2 2 2 2 4 1]; this value
-says to display no diary entries on Sunday, the entries for
-the current date and the day after on Monday through Thursday,
-Friday through Monday's entries on Friday, and only Saturday's
-entries on Saturday.
+This variable affects the diary display when the command \\[diary] is
+used, or if the value of the variable `calendar-view-diary-initially-flag'
+is non-nil. For example, if the default value 1 is used, then only the
+current day's diary entries will be displayed. If the value 2 is used,
+then both the current day's and the next day's entries will be displayed.
+
+The value can also be a vector such as [0 2 2 2 2 4 1]; this value says
+to display no diary entries on Sunday, the entries for the current date
+and the day after on Monday through Thursday, Friday through Monday's
+entries on Friday, and only Saturday's entries on Saturday.
This variable does not affect the diary display with the `d' command
-from the calendar; in that case, the prefix argument controls the
-number of days of diary entries displayed."
+from the calendar; in that case, the prefix argument controls the number
+of days of diary entries displayed."
:type '(choice (integer :tag "Entries")
(vector :value [0 0 0 0 0 0 0]
(integer :tag "Sunday")
:set 'diary-set-maybe-redraw
:group 'diary)
-;;; More user options in calendar.el.
+;;; More user options in calendar.el, holidays.el.
(defun diary-check-diary-file ()
"Check that the file specified by `diary-file' exists and is readable.
If so, return the expanded file name, otherwise signal an error."
- (let ((d-file (substitute-in-file-name diary-file)))
- (if (and d-file (file-exists-p d-file))
- (if (file-readable-p d-file)
- d-file
- (error "Diary file `%s' is not readable" diary-file))
- (error "Diary file `%s' does not exist" diary-file))))
+ (if (and diary-file (file-exists-p diary-file))
+ (if (file-readable-p diary-file)
+ diary-file
+ (error "Diary file `%s' is not readable" diary-file))
+ (error "Diary file `%s' does not exist" diary-file)))
;;;###autoload
(defun diary (&optional arg)
"Generate the diary window for ARG days starting with the current date.
If no argument is provided, the number of days of diary entries is governed
-by the variable `number-of-diary-entries'. A value of ARG less than 1
+by the variable `diary-number-of-entries'. A value of ARG less than 1
does nothing. This function is suitable for execution in a `.emacs' file."
(interactive "P")
(diary-check-diary-file)
;;;###cal-autoload
(defun diary-view-entries (&optional arg)
"Prepare and display a buffer with diary entries.
-Searches the file named in `diary-file' for entries that
-match ARG days starting with the date indicated by the cursor position
+Searches the file named in `diary-file' for entries that match
+ARG days starting with the date indicated by the cursor position
in the displayed three-month calendar."
(interactive "p")
(diary-check-diary-file)
(diary-list-entries (calendar-cursor-to-date t) arg))
-(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries)
+(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries "22.1")
;;;###cal-autoload
-(defun view-other-diary-entries (arg dfile)
+(defun diary-view-other-diary-entries (arg dfile)
"Prepare and display buffer of diary entries from an alternative diary file.
Searches for entries that match ARG days, starting with the date indicated
by the cursor position in the displayed three-month calendar.
(let ((diary-file dfile))
(diary-view-entries arg)))
+;;;###cal-autoload
+(define-obsolete-function-alias 'view-other-diary-entries
+ 'diary-view-other-diary-entries "23.1")
+
(defvar diary-syntax-table
(let ((st (copy-syntax-table (standard-syntax-table))))
(modify-syntax-entry ?* "w" st)
attrname (nth 2 attr)
type (nth 3 attr)
attrvalue nil)
- ;; FIXME multiple matches?
- (if (string-match regexp entry)
- (setq attrvalue (match-string-no-properties regnum entry)
- entry (replace-match "" t t entry)))
+ ;; If multiple matches, replace all, use the last (which may
+ ;; be the first instance in the line, if the regexp is
+ ;; anchored with $).
+ (while (string-match regexp entry)
+ (setq attrvalue (match-string-no-properties regnum entry)
+ entry (replace-match "" t t entry)))
(and attrvalue
(setq attrvalue (diary-attrtype-convert attrvalue type))
(setq ret-attr (append ret-attr (list attrname attrvalue))))))
(defvar diary-entries-list) ; bound in diary-list-entries
-(defun add-to-diary-list (date string specifier &optional marker
+(defun diary-add-to-list (date string specifier &optional marker
globcolor literal)
"Add an entry to `diary-entries-list'.
-Do nothing if DATE or STRING is nil. DATE is the (MONTH DAY
+Do nothing if DATE or STRING are nil. DATE is the (MONTH DAY
YEAR) for which the entry applies; STRING is the text of the
entry as it will appear in the diary (i.e. with any format
strings such as \"%d\" expanded); SPECIFIER is the date part of
the entry as it appears in the diary-file; LITERAL is the entry
-as it appears in the diary-file (i.e. before expansion). If
-LITERAL is nil, it is taken to be the same as STRING.
+as it appears in the diary-file (i.e. before expansion).
+If LITERAL is nil, it is taken to be the same as STRING.
The entry is added to the list as (DATE STRING SPECIFIER LOCATOR
GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL),
(list marker (buffer-file-name) literal)
globcolor))))))
-(defvar number) ; not clear this should use number
+(define-obsolete-function-alias 'add-to-diary-list 'diary-add-to-list "23.1")
(defun diary-list-entries-2 (date mark globattr list-only
- &optional months symbol)
+ &optional months symbol gdate)
"Internal subroutine of `diary-list-entries'.
Find diary entries applying to DATE, by searching from point-min for
each element of `diary-date-forms'. MARK indicates an entry is non-marking.
non-nil, don't change the buffer, only return a list of entries.
Optional array MONTHS replaces `calendar-month-name-array', and
means months cannot be abbreviated. Optional string SYMBOL marks diary
-entries of the desired type. Returns non-nil if any entries were found."
- (let* ((month (extract-calendar-month date))
- (day (extract-calendar-day date))
- (year (extract-calendar-year date))
+entries of the desired type. If DATE is not Gregorian, then the
+Gregorian equivalent should be provided via GDATE. Returns non-nil if
+any entries were found."
+ (let* ((month (calendar-extract-month date))
+ (day (calendar-extract-day date))
+ (year (calendar-extract-year date))
(dayname (format "%s\\|%s\\.?" (calendar-day-name date)
(calendar-day-name date 'abbrev)))
(calendar-month-name-array (or months calendar-month-name-array))
(month (format "\\*\\|0*%d" month))
(day (format "\\*\\|0*%d" day))
(year (format "\\*\\|0*%d%s" year
- (if abbreviated-calendar-year
- ;; FIXME was %d in non-greg case.
+ (if diary-abbreviated-year-flag
(format "\\|%02d" (% year 100))
"")))
(case-fold-search t)
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(if backup (re-search-backward "\\<" nil t))
+ ;; regexp moves us past the end of date, onto the next line.
+ ;; Trailing whitespace after date not allowed (see diary-file).
(if (and (bolp) (not (looking-at "[ \t]")))
- ;; Diary entry that consists only of date.
+ ;; Diary entry that consists only of date.
(backward-char 1)
;; Found a nonempty diary entry--make it
;; visible and add it to the list.
+ (setq date-start (line-end-position 0))
;; Actual entry starts on the next-line?
(if (looking-at "[ \t]*\n[ \t]") (forward-line 1))
(setq entry-found t
- entry-start (point)
- ;; If bolp, must have done (forward-line 1).
- ;; FIXME Why number > 1?
- date-start (line-end-position (if (and (bolp) (> number 1))
- -1 0)))
+ entry-start (point))
(forward-line 1)
(while (looking-at "[ \t]") ; continued entry
(forward-line 1))
(setq temp (diary-pull-attrs
(buffer-substring-no-properties
entry-start (point)) globattr))
- (add-to-diary-list
- date (car temp)
+ (diary-add-to-list
+ (or gdate date) (car temp)
(buffer-substring-no-properties (1+ date-start) (1- entry-start))
(copy-marker entry-start) (cadr temp))))))
entry-found))
(defvar original-date) ; from diary-list-entries
(defvar file-glob-attrs)
(defvar list-only)
+(defvar number)
(defun diary-list-entries-1 (months symbol absfunc)
"List diary entries of a certain type.
(dotimes (idummy number)
(diary-list-entries-2
(funcall absfunc (calendar-absolute-from-gregorian gdate))
- diary-nonmarking-symbol file-glob-attrs list-only months symbol)
+ diary-nonmarking-symbol file-glob-attrs list-only months symbol gdate)
(setq gdate
(calendar-gregorian-from-absolute
(1+ (calendar-absolute-from-gregorian gdate))))))
(goto-char (point-min)))
;; FIXME non-greg and list hooks run same number of times?
-(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries)
(defun diary-list-entries (date number &optional list-only)
"Create and display a buffer containing the relevant lines in `diary-file'.
The arguments are DATE and NUMBER; the entries selected are those
is non-nil, this list includes a dummy diary entry consisting of the empty
string for a date with no diary entries.
-After the list is prepared, the hooks `nongregorian-diary-listing-hook',
-`list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run.
-These hooks have the following distinct roles:
-
- `nongregorian-diary-listing-hook' can cull dates from the diary
- and each included file, for example to process Islamic diary
- entries. Applied to *each* file.
+After the list is prepared, the following hooks are run:
- `list-diary-entries-hook' adds or manipulates diary entries from
- external sources. Used, for example, to include diary entries
- from other files or to sort the diary entries. Invoked *once* only,
- before the display hook is run.
+ `diary-nongregorian-listing-hook' can cull dates from the diary
+ and each included file, for example to process Islamic diary
+ entries. Applied to *each* file.
- `diary-display-hook' does the actual display of information. If this is
- nil, `simple-diary-display' will be used. Use `add-hook' to use
- `fancy-diary-display', if desired. If you want no diary display, use
- add-hook to set this to `ignore'.
+ `diary-list-entries-hook' adds or manipulates diary entries from
+ external sources. Used, for example, to include diary entries
+ from other files or to sort the diary entries. Invoked *once*
+ only, before the display hook is run.
- `diary-hook' is run last. This can be used for an appointment
- notification function.
+ `diary-hook' is run last, after the diary is displayed.
+ This is used e.g. by `appt-check'.
Functions called by these hooks may use the variables ORIGINAL-DATE
and NUMBER, which are the arguments with which this function was called.
Note that hook functions should _not_ use DATE, but ORIGINAL-DATE.
-\(Sexp diary entries may use DATE - see `list-sexp-diary-entries'.)
+\(Sexp diary entries may use DATE - see `diary-list-sexp-entries'.)
-If LIST-ONLY is non-nil don't modify or display the buffer, only return a list."
+This function displays the list using `diary-display-function', unless
+LIST-ONLY is non-nil, in which case it just returns the list."
(unless number
- (setq number (if (vectorp number-of-diary-entries)
- (aref number-of-diary-entries (calendar-day-of-week date))
- number-of-diary-entries)))
+ (setq number (if (vectorp diary-number-of-entries)
+ (aref diary-number-of-entries (calendar-day-of-week date))
+ diary-number-of-entries)))
(when (> number 0)
- (let ((original-date date) ; save for possible use in the hooks
- diary-entries-list
- file-glob-attrs
- (date-string (calendar-date-string date))
- (d-file (substitute-in-file-name diary-file)))
+ (let* ((original-date date) ; save for possible use in the hooks
+ (date-string (calendar-date-string date))
+ (diary-buffer (find-buffer-visiting diary-file))
+ diary-entries-list file-glob-attrs)
(message "Preparing diary...")
- (save-excursion
- (let ((diary-buffer (find-buffer-visiting d-file)))
- (if (not diary-buffer)
- (set-buffer (find-file-noselect d-file t))
- (set-buffer diary-buffer)
- (or (verify-visited-file-modtime diary-buffer)
- (revert-buffer t t))))
+ (save-current-buffer
+ (if (not diary-buffer)
+ (set-buffer (find-file-noselect diary-file t))
+ (set-buffer diary-buffer)
+ (or (verify-visited-file-modtime diary-buffer)
+ (revert-buffer t t)))
;; Setup things like the header-line-format and invisibility-spec.
- (if (eq major-mode default-major-mode)
+ (if (eq major-mode (default-value 'major-mode))
(diary-mode)
;; This kludge is to make customizations to
;; diary-header-line-flag after diary has been displayed
;; d-s-p is passed to the diary display function.
(let ((diary-saved-point (point)))
(save-excursion
- ;; FIXME move after goto? Syntax?
- (setq file-glob-attrs (cadr (diary-pull-attrs nil "")))
- (with-syntax-table diary-syntax-table
+ (save-restriction
+ (widen) ; bug#5093
+ (setq file-glob-attrs (cadr (diary-pull-attrs nil "")))
+ (with-syntax-table diary-syntax-table
+ (goto-char (point-min))
+ (unless list-only
+ (let ((ol (make-overlay (point-min) (point-max) nil t nil)))
+ (set (make-local-variable 'diary-selective-display) t)
+ (overlay-put ol 'invisible 'diary)
+ (overlay-put ol 'evaporate t)))
+ (dotimes (idummy number)
+ (let ((sexp-found (diary-list-sexp-entries date))
+ (entry-found (diary-list-entries-2
+ date diary-nonmarking-symbol
+ file-glob-attrs list-only)))
+ (if diary-list-include-blanks
+ (or sexp-found entry-found
+ (diary-add-to-list date "" "" "" "")))
+ (setq date
+ (calendar-gregorian-from-absolute
+ (1+ (calendar-absolute-from-gregorian date)))))))
(goto-char (point-min))
+ (run-hooks 'diary-nongregorian-listing-hook
+ 'diary-list-entries-hook)
(unless list-only
- (let ((ol (make-overlay (point-min) (point-max) nil t nil)))
- (set (make-local-variable 'diary-selective-display) t)
- (overlay-put ol 'invisible 'diary)
- (overlay-put ol 'evaporate t)))
- (dotimes (idummy number)
- (let ((sexp-found (list-sexp-diary-entries date))
- (entry-found (diary-list-entries-2
- date diary-nonmarking-symbol
- file-glob-attrs list-only)))
- (if diary-list-include-blanks
- (or sexp-found entry-found
- (add-to-diary-list date "" "" "" "")))
- (setq date
- (calendar-gregorian-from-absolute
- (1+ (calendar-absolute-from-gregorian date)))))))
- (goto-char (point-min))
- (run-hooks 'nongregorian-diary-listing-hook
- 'list-diary-entries-hook)
- (unless list-only
- (if diary-display-hook
- (run-hooks 'diary-display-hook)
- (simple-diary-display)))
- (run-hooks 'diary-hook)
- diary-entries-list))))))
+ (if (and diary-display-function
+ (listp diary-display-function))
+ ;; Backwards compatibility.
+ (run-hooks 'diary-display-function)
+ (funcall (or diary-display-function
+ 'diary-simple-display))))
+ (run-hooks 'diary-hook)
+ diary-entries-list)))))))
+
+(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries "22.1")
(defun diary-unhide-everything ()
"Show all invisible text in the diary."
(kill-local-variable 'diary-selective-display)
- (remove-overlays (point-min) (point-max) 'invisible 'diary)
+ (save-restriction ; bug#5477
+ (widen)
+ (remove-overlays (point-min) (point-max) 'invisible 'diary))
(kill-local-variable 'mode-line-format))
(defvar original-date) ; bound in diary-list-entries
(defvar number)
-(defun include-other-diary-files ()
+(defun diary-include-other-diary-files ()
"Include the diary entries from other diary files with those of `diary-file'.
-This function is suitable for use with `list-diary-entries-hook';
+This function is suitable for use with `diary-list-entries-hook';
it enables you to use shared diary files together with your own.
The files included are specified in the `diary-file' by lines of this form:
#include \"filename\"
This is recursive; that is, #include directives in diary files thus included
-are obeyed. You can change the `#include' to some other string by
-changing the variable `diary-include-string'."
+are obeyed. You can change the `#include' to some other string by changing
+the variable `diary-include-string'."
(goto-char (point-min))
(while (re-search-forward
(format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
nil t)
- (let ((diary-file (substitute-in-file-name
- (match-string-no-properties 1)))
- (diary-list-include-blanks nil)
- (list-diary-entries-hook 'include-other-diary-files)
- (diary-display-hook 'ignore)
- (diary-hook nil))
+ (let ((diary-file (match-string-no-properties 1))
+ (diary-list-entries-hook 'diary-include-other-diary-files)
+ (diary-display-function 'ignore)
+ diary-hook diary-list-include-blanks)
(if (file-exists-p diary-file)
(if (file-readable-p diary-file)
(unwind-protect
(sleep-for 2))))
(goto-char (point-min)))
+(define-obsolete-function-alias 'include-other-diary-files
+ 'diary-include-other-diary-files "23.1")
+
(defvar date-string) ; bound in diary-list-entries
(defun diary-display-no-entries ()
- "Common subroutine of `simple-diary-display' and `fancy-diary-display'.
+ "Common subroutine of `diary-simple-display' and `diary-fancy-display'.
Handles the case where there are no diary entries.
Returns a cons (NOENTRIES . HOLIDAY-STRING)."
- (let* ((holiday-list (if holidays-in-diary-buffer
+ (let* ((holiday-list (if diary-show-holidays-flag
(calendar-check-holidays original-date)))
(hol-string (format "%s%s%s"
date-string
(defvar diary-saved-point) ; bound in diary-list-entries
-(defun simple-diary-display ()
- "Display the diary buffer if there are any relevant entries or holidays."
+(defun diary-simple-display ()
+ "Display the diary buffer if there are any relevant entries or holidays.
+Entries that do not apply are made invisible. Holidays are shown
+in the mode line. This is an option for `diary-display-function'."
;; If selected window is dedicated (to the calendar), need a new one
;; to display the diary.
(let* ((pop-up-frames (or pop-up-frames
(window-dedicated-p (selected-window))))
- (dbuff (find-buffer-visiting (substitute-in-file-name diary-file)))
+ (dbuff (find-buffer-visiting diary-file))
(empty (diary-display-no-entries)))
;; This may be too wide, but when simple diary is used there is
;; nowhere else for the holidays to go. Also, it is documented in
- ;; holidays-in-diary-buffer that the holidays go in the mode-line.
+ ;; diary-show-holidays-flag that the holidays go in the mode-line.
;; FIXME however if there are no diary entries a separate buffer
;; is displayed - this is inconsistent.
(with-current-buffer dbuff
(set-window-start window (point-min))))
(message "Preparing diary...done"))))
-(define-button-type 'diary-entry
- 'action #'diary-goto-entry
- 'face 'diary-button)
+(define-obsolete-function-alias 'simple-diary-display
+ 'diary-simple-display "23.1")
+
+(define-button-type 'diary-entry 'action #'diary-goto-entry
+ 'face 'diary-button 'help-echo "Find this diary entry"
+ 'follow-link t)
(defun diary-goto-entry (button)
"Jump to the diary entry for the BUTTON at point."
(file-exists-p file)
(find-file-other-window file)
(progn
- (when (eq major-mode default-major-mode) (diary-mode))
+ (when (eq major-mode (default-value 'major-mode)) (diary-mode))
(goto-char (point-min))
(if (re-search-forward (format "%s.*\\(%s\\)"
(regexp-quote (nth 2 locator))
(goto-char (match-beginning 1)))))
(message "Unable to locate this diary entry")))))
-(defun fancy-diary-display ()
+(defun diary-fancy-display ()
"Prepare a diary buffer with relevant entries in a fancy, noneditable form.
-To use this function, add it to `diary-display-hook'."
+Holidays are shown unless `diary-show-holidays-flag' is nil.
+Days with no diary entries are not shown (even if that day is a
+holiday), unless `diary-list-include-blanks' is non-nil.
+
+This is an option for `diary-display-function'."
;; Turn off selective-display in the diary file's buffer.
- (with-current-buffer
- (find-buffer-visiting (substitute-in-file-name diary-file))
+ (with-current-buffer (find-buffer-visiting diary-file)
(diary-unhide-everything))
(unless (car (diary-display-no-entries)) ; no entries
;; Prepare the fancy diary buffer.
- (calendar-in-read-only-buffer fancy-diary-buffer
+ (calendar-in-read-only-buffer diary-fancy-buffer
(calendar-set-mode-line "Diary Entries")
(let ((holiday-list-last-month 1)
(holiday-list-last-year 1)
(dolist (entry diary-entries-list)
(unless (calendar-date-equal date (car entry))
(setq date (car entry))
- (and holidays-in-diary-buffer
+ (and diary-show-holidays-flag
(calendar-date-compare
(list (list holiday-list-last-month
(calendar-last-day-of-month
(list date))
;; We need to get the holidays for the next 3 months.
(setq holiday-list-last-month
- (extract-calendar-month date)
+ (calendar-extract-month date)
holiday-list-last-year
- (extract-calendar-year date))
+ (calendar-extract-year date))
(progn
- (increment-calendar-month
+ (calendar-increment-month
holiday-list-last-month holiday-list-last-year 1)
t)
(setq holiday-list
(let ((displayed-month holiday-list-last-month)
(displayed-year holiday-list-last-year))
(calendar-holiday-list)))
- (increment-calendar-month
+ (calendar-increment-month
holiday-list-last-month holiday-list-last-year 1))
- (let (date-holiday-list)
+ (let ((longest 0)
+ date-holiday-list cc)
;; Make a list of all holidays for date.
(dolist (h holiday-list)
(if (calendar-date-equal date (car h))
(cdr h)))))
(insert (if (bobp) "" ?\n) (calendar-date-string date))
(if date-holiday-list (insert ": "))
- (let ((l (current-column))
- (longest 0))
- (insert (mapconcat (lambda (x)
- (if (< longest (length x))
- (setq longest (length x)))
- x)
- date-holiday-list
- (concat "\n" (make-string l ? ))))
- (insert ?\n (make-string (+ l longest) ?=) ?\n))))
+ (setq cc (current-column))
+ (insert (mapconcat (lambda (x)
+ (setq longest (max longest (length x)))
+ x)
+ date-holiday-list
+ (concat "\n" (make-string cc ?\s))))
+ (insert ?\n (make-string (+ cc longest) ?=) ?\n)))
(let ((this-entry (cadr entry))
- this-loc)
+ this-loc marks temp-face)
(unless (zerop (length this-entry))
(if (setq this-loc (nth 3 entry))
- (insert-button (concat this-entry "\n")
+ (insert-button this-entry
;; (MARKER FILENAME SPECIFIER LITERAL)
'locator (list (car this-loc)
(cadr this-loc)
(or (nth 2 this-loc)
(nth 1 entry)))
:type 'diary-entry)
- (insert this-entry ?\n))
- (save-excursion
- (let* ((marks (nth 4 entry))
- (faceinfo marks)
- temp-face)
- (when marks
- (setq temp-face (make-symbol
- (apply
- 'concat "temp-face-"
- (mapcar (lambda (sym)
- (if (stringp sym)
- sym
- (symbol-name sym)))
- marks))))
- (make-face temp-face)
- ;; Remove :face info from the marks,
- ;; copy the face info into temp-face
- (while (setq faceinfo (memq :face faceinfo))
- (copy-face (read (nth 1 faceinfo)) temp-face)
- (setcar faceinfo nil)
- (setcar (cdr faceinfo) nil))
- (setq marks (delq nil marks))
- ;; Apply the font aspects.
- (apply 'set-face-attribute temp-face nil marks)
- (search-backward this-entry)
- (overlay-put
- (make-overlay (match-beginning 0) (match-end 0))
- 'face temp-face))))))))
- (fancy-diary-display-mode)
+ (insert this-entry))
+ (insert ?\n)
+ ;; Doesn't make sense to check font-lock-mode - see
+ ;; comments above diary-entry-marker in calendar.el.
+ (and ; font-lock-mode
+ (setq marks (nth 4 entry))
+ (save-excursion
+ (setq temp-face (calendar-make-temp-face marks))
+ (search-backward this-entry)
+ (overlay-put
+ (make-overlay (match-beginning 0) (match-end 0))
+ 'face temp-face)))))))
+ ;; FIXME can't remember what this check was for.
+ ;; To prevent something looping, or a minor optimization?
+ (if (eq major-mode 'diary-fancy-display-mode)
+ (run-hooks 'diary-fancy-display-mode-hook)
+ (diary-fancy-display-mode))
(calendar-set-mode-line date-string)
(message "Preparing diary...done"))))
+(define-obsolete-function-alias 'fancy-diary-display
+ 'diary-fancy-display "23.1")
+
;; FIXME modernize?
-(defun print-diary-entries ()
+(defun diary-print-entries ()
"Print a hard copy of the diary display.
If the simple diary display is being used, prepare a temp buffer with the
If the fancy diary display is being used, just print the buffer.
-The hooks given by the variable `print-diary-entries-hook' are called to do
+The hooks given by the variable `diary-print-entries-hook' are called to do
the actual printing."
(interactive)
- (if (bufferp (get-buffer fancy-diary-buffer))
- (with-current-buffer (get-buffer fancy-diary-buffer)
- (run-hooks 'print-diary-entries-hook))
- (let ((diary-buffer
- (find-buffer-visiting (substitute-in-file-name diary-file))))
- (if diary-buffer
- ;; Name affects printing?
- (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*"))
- heading)
- (with-current-buffer diary-buffer
- (setq heading
- (if (not (stringp mode-line-format))
- "All Diary Entries"
- (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
- (match-string 1 mode-line-format)))
- (let ((start (point-min))
- end)
- (while
- (progn
- (setq end (next-single-char-property-change
- start 'invisible))
- (unless (get-char-property start 'invisible)
- (with-current-buffer temp-buffer
- (insert-buffer-substring diary-buffer
- start (or end (point-max)))))
- (setq start end)
- (and end (< end (point-max))))))
- (set-buffer temp-buffer)
- (goto-char (point-min))
- (insert heading "\n"
- (make-string (length heading) ?=) "\n")
- (run-hooks 'print-diary-entries-hook)
- (kill-buffer temp-buffer)))
- (error "You don't have a diary buffer!")))))
+ (let ((diary-buffer (get-buffer diary-fancy-buffer))
+ temp-buffer heading start end)
+ (if diary-buffer
+ (with-current-buffer diary-buffer
+ (run-hooks 'diary-print-entries-hook))
+ (or (setq diary-buffer (find-buffer-visiting diary-file))
+ (error "You don't have a diary buffer!"))
+ ;; Name affects printing?
+ (setq temp-buffer (get-buffer-create " *Printable Diary Entries*"))
+ (with-current-buffer diary-buffer
+ (setq heading
+ (if (not (stringp mode-line-format))
+ "All Diary Entries"
+ (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format)
+ (match-string 1 mode-line-format))
+ start (point-min))
+ (while
+ (progn
+ (setq end (next-single-char-property-change start 'invisible))
+ (unless (get-char-property start 'invisible)
+ (with-current-buffer temp-buffer
+ (insert-buffer-substring diary-buffer start end)))
+ (setq start end)
+ (and end (< end (point-max))))))
+ (set-buffer temp-buffer)
+ (goto-char (point-min))
+ (insert heading "\n"
+ (make-string (length heading) ?=) "\n")
+ (run-hooks 'diary-print-entries-hook)
+ (kill-buffer temp-buffer))))
+
+(define-obsolete-function-alias 'print-diary-entries
+ 'diary-print-entries "23.1")
-(define-obsolete-function-alias 'show-all-diary-entries 'diary-show-all-entries)
;;;###cal-autoload
(defun diary-show-all-entries ()
"Show all of the diary entries in the diary file.
all entries, not just some, are visible. If there is no diary buffer, one
is created."
(interactive)
- (let ((d-file (diary-check-diary-file))
- (pop-up-frames (window-dedicated-p (selected-window))))
+ (let* ((d-file (diary-check-diary-file))
+ (pop-up-frames (or pop-up-frames
+ (window-dedicated-p (selected-window))))
+ (win (selected-window))
+ (height (window-height)))
(with-current-buffer (or (find-buffer-visiting d-file)
(find-file-noselect d-file t))
- (when (eq major-mode default-major-mode) (diary-mode))
+ (when (eq major-mode (default-value 'major-mode)) (diary-mode))
(diary-unhide-everything)
- (display-buffer (current-buffer)))))
+ (display-buffer (current-buffer))
+ (when (and (/= height (window-height win))
+ (with-current-buffer (window-buffer win)
+ (derived-mode-p 'calendar-mode)))
+ (fit-window-to-buffer win)))))
+
+(define-obsolete-function-alias 'show-all-diary-entries
+ 'diary-show-all-entries "22.1")
;;;###autoload
(defun diary-mail-entries (&optional ndays)
If no prefix argument is given, NDAYS is set to `diary-mail-days'.
Mail is sent to the address specified by `diary-mail-addr'.
-You can call `diary-mail-entries' every night using an at/cron job.
-For example, this script will run the program at 2am daily. Since
-`emacs -batch' does not load your `.emacs' file, you must ensure that
-all relevant variables are set, as done here.
-
-#!/bin/sh
-# diary-rem.sh -- repeatedly run the Emacs diary-reminder
-emacs -batch \\
--eval \"(setq diary-mail-days 3 \\
- diary-file \\\"/path/to/diary.file\\\" \\
- european-calendar-style t \\
- diary-mail-addr \\\"user@host.name\\\" )\" \\
--l diary-lib -f diary-mail-entries
-at -f diary-rem.sh 0200 tomorrow
-
-You may have to tweak the syntax of the `at' command to suit your
-system. Alternatively, you can specify a cron entry:
-0 1 * * * diary-rem.sh
-to run it every morning at 1am."
+Here is an example of a script to call `diary-mail-entries',
+suitable for regular scheduling using cron (or at). Note that
+since `emacs -script' does not load your `.emacs' file, you
+should ensure that all relevant variables are set.
+
+#!/usr/bin/emacs -script
+;; diary-rem.el - run the Emacs diary-reminder
+
+\(setq diary-mail-days 3
+ diary-file \"/path/to/diary.file\"
+ calendar-date-style 'european
+ diary-mail-addr \"user@host.name\")
+
+\(diary-mail-entries)
+
+# diary-rem.el ends here
+"
(interactive "P")
(if (string-equal diary-mail-addr "")
(error "You must set `diary-mail-addr' to use this command")
- (let ((diary-display-hook 'fancy-diary-display))
+ (let ((diary-display-function 'diary-fancy-display))
(diary-list-entries (calendar-current-date) (or ndays diary-mail-days)))
(compose-mail diary-mail-addr
(concat "Diary entries generated "
(calendar-date-string (calendar-current-date))))
(insert
- (if (get-buffer fancy-diary-buffer)
- (with-current-buffer fancy-diary-buffer (buffer-string))
+ (if (get-buffer diary-fancy-buffer)
+ (with-current-buffer diary-fancy-buffer (buffer-string))
"No entries found"))
(call-interactively (get mail-user-agent 'sendfunc))))
nil)
paren))
-(defvar marking-diary-entries nil
+(defvar diary-marking-entries-flag nil
"True during the marking of diary entries, nil otherwise.")
-(defvar marking-diary-entry nil
+(defvar diary-marking-entry-flag nil
"True during the marking of diary entries, if current entry is marking.")
-;; file-glob-attrs bound in mark-diary-entries.
+;; file-glob-attrs bound in diary-mark-entries.
(defun diary-mark-entries-1 (markfunc &optional months symbol absfunc)
"Mark diary entries of a certain type.
MARKFUNC is a function that marks entries of the appropriate type
(yy (if (not y-str)
0
(if (and (= (length y-str) 2)
- abbreviated-calendar-year)
+ diary-abbreviated-year-flag)
(let* ((current-y
- (extract-calendar-year
+ (calendar-extract-year
(if absfunc
(funcall
absfunc
(calendar-current-date)))
(calendar-current-date))))
(y (+ (string-to-number y-str)
- (* 100 (/ current-y 100)))))
- (if (> (- y current-y) 50)
+ ;; Current century, eg 2000.
+ (* 100 (/ current-y 100))))
+ (offset (- y current-y)))
+ ;; Add 2-digit year to current century.
+ ;; If more than 50 years in the future,
+ ;; assume last century. If more than 50
+ ;; years in the past, assume next century.
+ (if (> offset 50)
(- y 100)
- (if (> (- current-y y) 50)
+ (if (< offset -50)
(+ y 100)
y)))
(string-to-number y-str)))))
(buffer-substring-no-properties
(point) (line-end-position))
file-glob-attrs)))
- (if dd-name
- (mark-calendar-days-named
+ ;; Only mark all days of a given name if the pattern
+ ;; contains no more specific elements.
+ (if (and dd-name (not (or d-pos m-pos y-pos)))
+ (calendar-mark-days-named
(cdr (assoc-string dd-name
(calendar-make-alist
calendar-day-name-array
(funcall markfunc mm dd yy marks))))))))
;;;###cal-autoload
-(defun mark-diary-entries (&optional redraw)
+(defun diary-mark-entries (&optional redraw)
"Mark days in the calendar window that have diary entries.
Each entry in the diary file visible in the calendar window is
marked. After the entries are marked, the hooks
-`nongregorian-diary-marking-hook' and `mark-diary-entries-hook'
+`diary-nongregorian-marking-hook' and `diary-mark-entries-hook'
are run. If the optional argument REDRAW is non-nil (which is
the case interactively, for example) then any existing diary
marks are first removed. This is intended to deal with deleted
;; ii) called via calendar-redraw (since calendar has already been
;; erased).
;; Use of REDRAW handles both of these cases.
- (when (and redraw mark-diary-entries-in-calendar)
- (setq mark-diary-entries-in-calendar nil)
- (redraw-calendar))
- (let ((marking-diary-entries t)
+ (when (and redraw calendar-mark-diary-entries-flag)
+ (setq calendar-mark-diary-entries-flag nil)
+ (calendar-redraw))
+ (let ((diary-marking-entries-flag t)
file-glob-attrs)
(with-current-buffer (find-file-noselect (diary-check-diary-file) t)
(save-excursion
- (when (eq major-mode default-major-mode) (diary-mode))
- (setq mark-diary-entries-in-calendar t)
+ (when (eq major-mode (default-value 'major-mode)) (diary-mode))
+ (setq calendar-mark-diary-entries-flag t)
(message "Marking diary entries...")
(setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
(with-syntax-table diary-syntax-table
- (diary-mark-entries-1 'mark-calendar-date-pattern)
- (mark-sexp-diary-entries)
- (run-hooks 'nongregorian-diary-marking-hook
- 'mark-diary-entries-hook))
+ (diary-mark-entries-1 'calendar-mark-date-pattern)
+ (diary-mark-sexp-entries)
+ (run-hooks 'diary-nongregorian-marking-hook
+ 'diary-mark-entries-hook))
(message "Marking diary entries...done")))))
+;;;###cal-autoload
+(define-obsolete-function-alias 'mark-diary-entries 'diary-mark-entries "23.1")
(defun diary-sexp-entry (sexp entry date)
"Process a SEXP diary ENTRY for DATE."
(result entry)
(t nil))))
-(defvar displayed-year) ; bound in generate-calendar
+(defvar displayed-year) ; bound in calendar-generate
(defvar displayed-month)
-(defun mark-sexp-diary-entries ()
+(defun diary-mark-sexp-entries ()
"Mark days in the calendar window that have sexp diary entries.
Each entry in the diary file (or included files) visible in the calendar window
-is marked. See the documentation for the function `list-sexp-diary-entries'."
- (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol))
+is marked. See the documentation for the function `diary-list-sexp-entries'."
+ (let* ((sexp-mark (regexp-quote diary-sexp-entry-symbol))
(s-entry (format "^\\(%s(\\)\\|\\(%s%s(diary-remind\\)" sexp-mark
(regexp-quote diary-nonmarking-symbol)
sexp-mark))
(file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
- m y first-date last-date mark file-glob-attrs)
+ m y first-date last-date date mark file-glob-attrs
+ sexp-start sexp entry entry-start)
(with-current-buffer calendar-buffer
(setq m displayed-month
y displayed-year))
- (increment-calendar-month m y -1)
- (setq first-date
- (calendar-absolute-from-gregorian (list m 1 y)))
- (increment-calendar-month m y 2)
+ (calendar-increment-month m y -1)
+ (setq first-date (calendar-absolute-from-gregorian (list m 1 y)))
+ (calendar-increment-month m y 2)
(setq last-date
(calendar-absolute-from-gregorian
(list m (calendar-last-day-of-month m y) y)))
(goto-char (point-min))
(while (re-search-forward s-entry nil t)
- (setq marking-diary-entry (char-equal (preceding-char) ?\())
+ (setq diary-marking-entry-flag (char-equal (preceding-char) ?\())
(re-search-backward "(")
- (let ((sexp-start (point))
- sexp entry entry-start marks)
- (forward-sexp)
- (setq sexp (buffer-substring-no-properties sexp-start (point)))
- (forward-char 1)
- (if (and (bolp) (not (looking-at "[ \t]")))
- ;; Diary entry consists only of the sexp.
- (progn
- (backward-char 1)
- (setq entry ""))
- (setq entry-start (point))
- ;; Find end of entry.
- (forward-line 1)
- (while (looking-at "[ \t]")
- (forward-line 1))
- (if (bolp) (backward-char 1))
- (setq entry (buffer-substring-no-properties entry-start (point))))
- (calendar-for-loop date from first-date to last-date do
- (when (setq mark (diary-sexp-entry
- sexp entry
- (calendar-gregorian-from-absolute date)))
- ;; FIXME does this make sense?
- (setq marks (diary-pull-attrs entry file-glob-attrs)
- marks (nth 1 (diary-pull-attrs entry file-glob-attrs)))
- (mark-visible-calendar-date
- (calendar-gregorian-from-absolute date)
- (if (< 0 (length marks))
- marks
- (if (consp mark) (car mark))))))))))
-
-(defun mark-included-diary-files ()
+ (setq sexp-start (point))
+ (forward-sexp)
+ (setq sexp (buffer-substring-no-properties sexp-start (point)))
+ (forward-char 1)
+ (if (and (bolp) (not (looking-at "[ \t]")))
+ ;; Diary entry consists only of the sexp.
+ (progn
+ (backward-char 1)
+ (setq entry ""))
+ (setq entry-start (point))
+ ;; Find end of entry.
+ (forward-line 1)
+ (while (looking-at "[ \t]")
+ (forward-line 1))
+ (if (bolp) (backward-char 1))
+ (setq entry (buffer-substring-no-properties entry-start (point))))
+ (setq date (1- first-date))
+ ;; FIXME this loops over all visible dates.
+ ;; Could be optimized in many cases. Depends on whether t or * present.
+ (while (<= (setq date (1+ date)) last-date)
+ (when (setq mark (diary-sexp-entry
+ sexp entry
+ (calendar-gregorian-from-absolute date)))
+ (calendar-mark-visible-date
+ (calendar-gregorian-from-absolute date)
+ (or (cadr (diary-pull-attrs entry file-glob-attrs))
+ (if (consp mark) (car mark)))))))))
+
+(define-obsolete-function-alias 'mark-sexp-diary-entries
+ 'diary-mark-sexp-entries "23.1")
+
+(defun diary-mark-included-diary-files ()
"Mark the diary entries from other diary files with those of the diary file.
-This function is suitable for use with `mark-diary-entries-hook'; it enables
+This function is suitable for use with `diary-mark-entries-hook'; it enables
you to use shared diary files together with your own. The files included are
specified in the `diary-file' by lines of this form:
#include \"filename\"
This is recursive; that is, #include directives in diary files thus included
-are obeyed. You can change the `#include' to some other string by
-changing the variable `diary-include-string'."
+are obeyed. You can change the `#include' to some other string by changing
+the variable `diary-include-string'."
(goto-char (point-min))
(while (re-search-forward
(format "^%s \"\\([^\"]*\\)\"" (regexp-quote diary-include-string))
nil t)
- (let* ((diary-file (substitute-in-file-name
- (match-string-no-properties 1)))
- (mark-diary-entries-hook 'mark-included-diary-files)
+ (let* ((diary-file (match-string-no-properties 1))
+ (diary-mark-entries-hook 'diary-mark-included-diary-files)
(dbuff (find-buffer-visiting diary-file)))
(if (file-exists-p diary-file)
(if (file-readable-p diary-file)
(progn
- (mark-diary-entries)
+ (diary-mark-entries)
(unless dbuff
(kill-buffer (find-buffer-visiting diary-file))))
(beep)
(sleep-for 2))))
(goto-char (point-min)))
-(defun mark-calendar-days-named (dayname &optional color)
+(define-obsolete-function-alias 'mark-included-diary-files
+ 'diary-mark-included-diary-files "23.1")
+
+(defun calendar-mark-days-named (dayname &optional color)
"Mark all dates in the calendar window that are day DAYNAME of the week.
0 means all Sundays, 1 means all Mondays, and so on.
-Optional argument COLOR is passed to `mark-visible-calendar-date' as MARK."
+Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
(with-current-buffer calendar-buffer
(let ((prev-month displayed-month)
(prev-year displayed-year)
(succ-year displayed-year)
(last-day)
(day))
- (increment-calendar-month succ-month succ-year 1)
- (increment-calendar-month prev-month prev-year -1)
+ (calendar-increment-month succ-month succ-year 1)
+ (calendar-increment-month prev-month prev-year -1)
(setq day (calendar-absolute-from-gregorian
(calendar-nth-named-day 1 dayname prev-month prev-year))
last-day (calendar-absolute-from-gregorian
(calendar-nth-named-day -1 dayname succ-month succ-year)))
(while (<= day last-day)
- (mark-visible-calendar-date (calendar-gregorian-from-absolute day)
+ (calendar-mark-visible-date (calendar-gregorian-from-absolute day)
color)
(setq day (+ day 7))))))
-(defun mark-calendar-month (month year p-month p-day p-year &optional color)
+(define-obsolete-function-alias 'mark-calendar-days-named
+ 'calendar-mark-days-named "23.1")
+
+(defun calendar-mark-month (month year p-month p-day p-year &optional color)
"Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P-DAY/P-YEAR.
A value of 0 in any position of the pattern is a wildcard.
-Optional argument COLOR is passed to `mark-visible-calendar-date' as MARK."
+Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
(if (or (and (= month p-month)
(or (zerop p-year) (= year p-year)))
(and (zerop p-month)
(or (zerop p-year) (= year p-year))))
(if (zerop p-day)
(dotimes (i (calendar-last-day-of-month month year))
- (mark-visible-calendar-date (list month (1+ i) year) color))
- (mark-visible-calendar-date (list month p-day year) color))))
+ (calendar-mark-visible-date (list month (1+ i) year) color))
+ (calendar-mark-visible-date (list month p-day year) color))))
-(defun mark-calendar-date-pattern (month day year &optional color)
+(define-obsolete-function-alias 'mark-calendar-month
+ 'calendar-mark-month "23.1")
+
+(defun calendar-mark-date-pattern (month day year &optional color)
"Mark all dates in the calendar window that conform to MONTH/DAY/YEAR.
A value of 0 in any position is a wildcard. Optional argument COLOR is
-passed to `mark-visible-calendar-date' as MARK."
+passed to `calendar-mark-visible-date' as MARK."
(with-current-buffer calendar-buffer
(let ((m displayed-month)
(y displayed-year))
- (increment-calendar-month m y -1)
+ (calendar-increment-month m y -1)
(dotimes (idummy 3)
- (mark-calendar-month m y month day year color)
- (increment-calendar-month m y 1)))))
+ (calendar-mark-month m y month day year color)
+ (calendar-increment-month m y 1)))))
+(define-obsolete-function-alias 'mark-calendar-date-pattern
+ 'calendar-mark-date-pattern "23.1")
;; Bahai, Hebrew, Islamic.
(defun calendar-mark-complex (month day year fromabs &optional color)
"Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
The function FROMABS converts absolute dates to the appropriate date system.
-Optional argument COLOR is passed to `mark-visible-calendar-date' as MARK."
+Optional argument COLOR is passed to `calendar-mark-visible-date' as MARK."
;; Not one of the simple cases--check all visible dates for match.
;; Actually, the following code takes care of ALL of the cases, but
;; it's much too slow to be used for the simple (common) cases.
- (let ((m displayed-month)
- (y displayed-year)
- first-date last-date)
- (increment-calendar-month m y -1)
- (setq first-date (calendar-absolute-from-gregorian (list m 1 y)))
- (increment-calendar-month m y 2)
- (setq last-date (calendar-absolute-from-gregorian
- (list m (calendar-last-day-of-month m y) y)))
- (calendar-for-loop date from first-date to last-date do
- (let* ((i-date (funcall fromabs date))
- (i-month (extract-calendar-month i-date))
- (i-day (extract-calendar-day i-date))
- (i-year (extract-calendar-year i-date)))
- (and (or (zerop month)
- (= month i-month))
- (or (zerop day)
- (= day i-day))
- (or (zerop year)
- (= year i-year))
- (mark-visible-calendar-date
- (calendar-gregorian-from-absolute date) color))))))
+ (let* ((m displayed-month)
+ (y displayed-year)
+ (first-date (progn
+ (calendar-increment-month m y -1)
+ (calendar-absolute-from-gregorian (list m 1 y))))
+ (last-date (progn
+ (calendar-increment-month m y 2)
+ (calendar-absolute-from-gregorian
+ (list m (calendar-last-day-of-month m y) y))))
+ (date (1- first-date))
+ local-date)
+ (while (<= (setq date (1+ date)) last-date)
+ (setq local-date (funcall fromabs date))
+ (and (or (zerop month)
+ (= month (calendar-extract-month local-date)))
+ (or (zerop day)
+ (= day (calendar-extract-day local-date)))
+ (or (zerop year)
+ (= year (calendar-extract-year local-date)))
+ (calendar-mark-visible-date
+ (calendar-gregorian-from-absolute date) color)))))
;; Bahai, Islamic.
(defun calendar-mark-1 (month day year fromabs toabs &optional color)
"Mark dates in the calendar conforming to MONTH DAY YEAR of some system.
The function FROMABS converts absolute dates to the appropriate date system.
-The function TOABDS carries out the inverse operation. Optional argument
-COLOR is passed to `mark-visible-calendar-date' as MARK."
- (save-excursion
- (set-buffer calendar-buffer)
+The function TOABS carries out the inverse operation. Optional argument
+COLOR is passed to `calendar-mark-visible-date' as MARK."
+ (with-current-buffer calendar-buffer
(if (and (not (zerop month)) (not (zerop day)))
(if (not (zerop year))
;; Fully specified date.
(let ((date (calendar-gregorian-from-absolute
(funcall toabs (list month day year)))))
(if (calendar-date-is-visible-p date)
- (mark-visible-calendar-date date color)))
+ (calendar-mark-visible-date date color)))
;; Month and day in any year--this taken from the holiday stuff.
(let* ((i-date (funcall fromabs
(calendar-absolute-from-gregorian
(list displayed-month 15 displayed-year))))
- (m (extract-calendar-month i-date))
- (y (extract-calendar-year i-date))
+ (m (calendar-extract-month i-date))
+ (y (calendar-extract-year i-date))
date)
(unless (< m 1) ; calendar doesn't apply
- (increment-calendar-month m y (- 10 month))
- (if (> m 7) ; date might be visible
- (let ((date (calendar-gregorian-from-absolute
- (funcall toabs (list month day y)))))
- (if (calendar-date-is-visible-p date)
- (mark-visible-calendar-date date color)))))))
+ (calendar-increment-month m y (- 10 month))
+ (and (> m 7) ; date might be visible
+ (calendar-date-is-visible-p
+ (setq date (calendar-gregorian-from-absolute
+ (funcall toabs (list month day y)))))
+ (calendar-mark-visible-date date color)))))
(calendar-mark-complex month day year
'calendar-bahai-from-absolute color))))
Returns `diary-unknown-time' (default value -9999) if no time is recognized.
The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam,
-XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can
+XXAM, XXpm, XXPM, XX:XXam, XX:XXAM, XX:XXpm, or XX:XXPM. A period (.) can
be used instead of a colon (:) to separate the hour and minute parts."
- (let ((case-fold-search nil))
+ (let (case-fold-search)
(cond ((string-match ; military time
"\\`[ \t\n]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)"
s)
(and (= t1 t2)
(string-lessp ts1 ts2)))))))
-(defun sort-diary-entries ()
+(defun diary-sort-entries ()
"Sort the list of diary entries by time of day."
(setq diary-entries-list (sort diary-entries-list 'diary-entry-compare)))
+(define-obsolete-function-alias 'sort-diary-entries 'diary-sort-entries "23.1")
-(defun list-sexp-diary-entries (date)
+
+(defun diary-list-sexp-entries (date)
"Add sexp entries for DATE from the diary file to `diary-entries-list'.
-Also, make them visible in the diary file. Returns t if any entries were
-found.
+Also, make them visible in the diary. Returns t if any entries are found.
-Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally
-`%%'). The form of a sexp diary entry is
+Sexp diary entries must be prefaced by a `diary-sexp-entry-symbol'
+\(normally `%%'). The form of a sexp diary entry is
%%(SEXP) ENTRY
-Both ENTRY and DATE are globally available when the SEXP is evaluated. If the
-SEXP yields the value nil, the diary entry does not apply. If it yields a
-non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a
-string, that string will be the diary entry in the fancy diary display.
+Both ENTRY and DATE are available when the SEXP is evaluated. If
+the SEXP returns nil, the diary entry does not apply. If it
+returns a non-nil value, ENTRY will be taken to apply to DATE; if
+the value is a string, that string will be the diary entry in the
+fancy diary display.
-For example, the following diary entry will apply to the 21st of the month
-if it is a weekday and the Friday before if the 21st is on a weekend:
+For example, the following diary entry will apply to the 21st of
+the month if it is a weekday and the Friday before if the 21st is
+on a weekend:
&%%(let ((dayname (calendar-day-of-week date))
- (day (extract-calendar-day date)))
+ (day (calendar-extract-day date)))
(or
(and (= day 21) (memq dayname '(1 2 3 4 5)))
(and (memq day '(19 20)) (= dayname 5)))
) UIUC pay checks deposited
-A number of built-in functions are available for this type of diary entry:
-
- %%(diary-date MONTH DAY YEAR &optional MARK) text
- Entry applies if date is MONTH, DAY, YEAR if
- `european-calendar-style' is nil (otherwise DAY, MONTH,
- YEAR). DAY, MONTH, and YEAR can be lists of integers,
- `t' (meaning all values), or an integer. An optional
- parameter MARK specifies a face or single-character string
- to use when highlighting the day in the calendar.
-
- %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
- Entry will appear on the Nth DAYNAME of MONTH.
- (DAYNAME=0 means Sunday, 1 means Monday, and so on;
- if N is negative it counts backward from the end of
- the month. MONTH can be a list of months, a single
- month, or t to specify all months. Optional DAY means
- Nth DAYNAME of MONTH on or after/before DAY. DAY defaults
- to 1 if N>0 and the last day of the month if N<0. An
- optional parameter MARK specifies a face or single-character
- string to use when highlighting the day in the calendar.
-
- %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
- Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
- inclusive. (If `european-calendar-style' is non-nil, the
- order of the parameters should be changed to D1, M1, Y1,
- D2, M2, Y2.) An optional parameter MARK specifies a face
- or single-character string to use when highlighting the
- day in the calendar.
-
- %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
- Entry will appear on anniversary dates of MONTH DAY, YEAR.
- (If `european-calendar-style' is non-nil, the order of the
- parameters should be changed to DAY, MONTH, YEAR.) Text
- can contain %d or %d%s; %d will be replaced by the number
- of years since the MONTH DAY, YEAR and %s will be replaced
- by the ordinal ending of that number (that is, `st', `nd',
- `rd' or `th', as appropriate. The anniversary of February
- 29 is considered to be March 1 in a non-leap year. An
- optional parameter MARK specifies a face or single-character
- string to use when highlighting the day in the calendar.
-
- %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
- Entry will appear every N days, starting MONTH DAY, YEAR.
- (If `european-calendar-style' is non-nil, the order of the
- parameters should be changed to N, DAY, MONTH, YEAR.) Text
- can contain %d or %d%s; %d will be replaced by the number
- of repetitions since the MONTH DAY, YEAR and %s will
- be replaced by the ordinal ending of that number (that is,
- `st', `nd', `rd' or `th', as appropriate. An optional
- parameter MARK specifies a face or single-character string
- to use when highlighting the day in the calendar.
-
- %%(diary-remind SEXP DAYS &optional MARKING) text
- Entry is a reminder for diary sexp SEXP. DAYS is either a
- single number or a list of numbers indicating the number(s)
- of days before the event that the warning(s) should occur.
- If the current date is (one of) DAYS before the event
- indicated by EXPR, then a suitable message (as specified
- by `diary-remind-message') appears. In addition to the
- reminders beforehand, the diary entry also appears on
- the date itself. If optional MARKING is non-nil then the
- *reminders* are marked on the calendar. Marking of
- reminders is independent of whether the entry *itself* is
- a marking or nonmarking one.
-
- %%(diary-day-of-year)
- Diary entries giving the day of the year and the number of
- days remaining in the year will be made every day. Note
- that since there is no text, it makes sense only if the
- fancy diary display is used.
-
- %%(diary-iso-date)
- Diary entries giving the corresponding ISO commercial date
- will be made every day. Note that since there is no text,
- it makes sense only if the fancy diary display is used.
-
- %%(diary-french-date)
- Diary entries giving the corresponding French Revolutionary
- date will be made every day. Note that since there is no
- text, it makes sense only if the fancy diary display is used.
-
- %%(diary-islamic-date)
- Diary entries giving the corresponding Islamic date will be
- made every day. Note that since there is no text, it
- makes sense only if the fancy diary display is used.
-
- %%(diary-hebrew-date)
- Diary entries giving the corresponding Hebrew date will be
- made every day. Note that since there is no text, it
- makes sense only if the fancy diary display is used.
-
- %%(diary-astro-day-number) Diary entries giving the corresponding
- astronomical (Julian) day number will be made every day.
- Note that since there is no text, it makes sense only if the
- fancy diary display is used.
-
- %%(diary-julian-date) Diary entries giving the corresponding
- Julian date will be made every day. Note that since
- there is no text, it makes sense only if the fancy diary
- display is used.
-
- %%(diary-sunrise-sunset)
- Diary entries giving the local times of sunrise and sunset
- will be made every day. Note that since there is no text,
- it makes sense only if the fancy diary display is used.
- Floating point required.
-
- %%(diary-phases-of-moon)
- Diary entries giving the times of the phases of the moon
- will be when appropriate. Note that since there is no text,
- it makes sense only if the fancy diary display is used.
- Floating point required.
-
- %%(diary-yahrzeit MONTH DAY YEAR) text
- Text is assumed to be the name of the person; the date is
- the date of death on the *civil* calendar. The diary entry
- will appear on the proper Hebrew-date anniversary and on the
- day before. (If `european-calendar-style' is non-nil, the
- parameter order should be changed to DAY, MONTH, YEAR.)
-
- %%(diary-rosh-hodesh)
- Diary entries will be made on the dates of Rosh Hodesh on
- the Hebrew calendar. Note that since there is no text, it
- makes sense only if the fancy diary display is used.
-
- %%(diary-parasha)
- Diary entries giving the weekly parasha will be made on
- every Saturday. Note that since there is no text, it
- makes sense only if the fancy diary display is used.
-
- %%(diary-omer)
- Diary entries giving the omer count will be made every day
- from Passover to Shavuot. Note that since there is no text,
- it makes sense only if the fancy diary display is used.
-
-Marking these entries is *extremely* time consuming, so these entries are
-best if they are nonmarking."
+A number of built-in functions are available for this type of
+diary entry. In the following, the optional parameter MARK
+specifies a face or single-character string to use when
+highlighting the day in the calendar. For those functions that
+take MONTH, DAY, and YEAR as arguments, the order of the input
+parameters changes according to `calendar-date-style' (e.g. to
+DAY MONTH YEAR in the European style).
+
+ %%(diary-date MONTH DAY YEAR &optional MARK) text
+ Entry applies if date is MONTH, DAY, YEAR. DAY, MONTH, and YEAR can
+ be a list of integers, `t' (meaning all values), or an integer.
+
+ %%(diary-float MONTH DAYNAME N &optional DAY MARK) text
+ Entry will appear on the Nth DAYNAME after/before MONTH DAY.
+ DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
+ If N>0, use the Nth DAYNAME after MONTH DAY.
+ If N<0, use the Nth DAYNAME before MONTH DAY.
+ DAY defaults to 1 if N>0, and MONTH's last day otherwise.
+ MONTH can be a list of months, a single month, or `t' to
+ specify all months.
+
+ %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text
+ Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2,
+ inclusive.
+
+ %%(diary-anniversary MONTH DAY YEAR &optional MARK) text
+ Entry will appear on anniversary dates of MONTH DAY, YEAR.
+ Text can contain `%d' or `%d%s'; `%d' will be replaced by the
+ number of years since the MONTH DAY, YEAR, and `%s' by the
+ ordinal ending of that number (i.e. `st', `nd', `rd' or `th',
+ as appropriate). The anniversary of February 29 is
+ considered to be March 1 in a non-leap year.
+
+ %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text
+ Entry will appear every N days, starting MONTH DAY, YEAR.
+ Text can contain `%d' or `%d%s'; `%d' will be replaced by the
+ number of repetitions since the MONTH DAY, YEAR and `%s' by
+ the ordinal ending of that number (i.e. `st', `nd', `rd' or
+ `th', as appropriate).
+
+ %%(diary-remind SEXP DAYS &optional MARKING) text
+ Entry is a reminder for diary sexp SEXP. DAYS is either a
+ single number or a list of numbers indicating the number(s)
+ of days before the event that the warning(s) should occur.
+ A negative number -DAYS has the same meaning as a list (1 2 ... DAYS).
+ If the current date is (one of) DAYS before the event indicated
+ by EXPR, then a suitable message (as specified by
+ `diary-remind-message') appears. In addition to the
+ reminders beforehand, the diary entry also appears on the
+ date itself. If optional MARKING is non-nil then the
+ *reminders* are marked on the calendar. Marking of reminders
+ is independent of whether the entry *itself* is a marking or
+ non-marking one.
+
+ %%(diary-hebrew-yahrzeit MONTH DAY YEAR) text
+ Text is assumed to be the name of the person; the date is the
+ date of death on the *civil* calendar. The diary entry will
+ appear on the proper Hebrew-date anniversary and on the day
+ before.
+
+All the remaining functions do not accept any text, and so only
+make sense with `diary-fancy-display'. Most produce output every day.
+
+`diary-day-of-year' - day of year and number of days remaining
+`diary-iso-date' - ISO commercial date
+`diary-astro-day-number' - astronomical (Julian) day number
+`diary-sunrise-sunset' - local times of sunrise and sunset
+
+These functions give the date in alternative calendrical systems:
+
+`diary-bahai-date', `diary-chinese-date', `diary-coptic-date',
+`diary-ethiopic-date', `diary-french-date', `diary-hebrew-date',
+`diary-islamic-date', `diary-julian-date', `diary-mayan-date',
+`diary-persian-date'
+
+Theses functions only produce output on certain dates:
+
+`diary-lunar-phases' - phases of moon (on the appropriate days)
+`diary-hebrew-omer' - Omer count, within 50 days after Passover
+`diary-hebrew-parasha' - weekly parasha, every Saturday
+`diary-hebrew-rosh-hodesh' - Rosh Hodesh, or the day or Saturday before
+`diary-hebrew-sabbath-candles' - local time of candle lighting, on Fridays
+
+
+Marking these entries is *extremely* time consuming, so it is
+best if they are non-marking."
(let ((s-entry (format "^%s?%s(" (regexp-quote diary-nonmarking-symbol)
- (regexp-quote sexp-diary-entry-symbol)))
- entry-found file-glob-attrs marks)
+ (regexp-quote diary-sexp-entry-symbol)))
+ entry-found file-glob-attrs marks
+ sexp-start sexp entry specifier entry-start line-start
+ diary-entry temp literal)
(goto-char (point-min))
- (save-excursion
- (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))))
+ (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))
(while (re-search-forward s-entry nil t)
(backward-char 1)
- (let ((sexp-start (point))
- sexp entry specifier entry-start line-start)
- (forward-sexp)
- (setq sexp (buffer-substring-no-properties sexp-start (point))
- line-start (line-end-position 0)
- specifier
- (buffer-substring-no-properties (1+ line-start) (point))
- entry-start (1+ line-start))
- (forward-char 1)
- (if (and (bolp) (not (looking-at "[ \t]")))
- ;; Diary entry consists only of the sexp.
- (progn
- (backward-char 1)
- (setq entry ""))
- (setq entry-start (point))
- (forward-line 1)
- (while (looking-at "[ \t]")
- (forward-line 1))
- (backward-char 1)
- (setq entry (buffer-substring-no-properties entry-start (point))))
- (let ((diary-entry (diary-sexp-entry sexp entry date))
- temp literal)
- (setq literal entry ; before evaluation
- entry (if (consp diary-entry)
- (cdr diary-entry)
- diary-entry))
- (when diary-entry
- (remove-overlays line-start (point) 'invisible 'diary)
- (if (< 0 (length entry))
- (setq temp (diary-pull-attrs entry file-glob-attrs)
- entry (nth 0 temp)
- marks (nth 1 temp))))
- (add-to-diary-list date
- entry
- specifier
- (if entry-start (copy-marker entry-start))
- marks
- literal)
- (setq entry-found (or entry-found diary-entry)))))
+ (setq sexp-start (point))
+ (forward-sexp)
+ (setq sexp (buffer-substring-no-properties sexp-start (point))
+ line-start (line-end-position 0)
+ specifier
+ (buffer-substring-no-properties (1+ line-start) (point))
+ entry-start (1+ line-start))
+ (forward-char 1)
+ (if (and (bolp) (not (looking-at "[ \t]")))
+ ;; Diary entry consists only of the sexp.
+ (progn
+ (backward-char 1)
+ (setq entry ""))
+ (setq entry-start (point))
+ (forward-line 1)
+ (while (looking-at "[ \t]")
+ (forward-line 1))
+ (backward-char 1)
+ (setq entry (buffer-substring-no-properties entry-start (point))))
+ (setq diary-entry (diary-sexp-entry sexp entry date)
+ literal entry ; before evaluation
+ entry (if (consp diary-entry)
+ (cdr diary-entry)
+ diary-entry))
+ (when diary-entry
+ (remove-overlays line-start (point) 'invisible 'diary)
+ (if (< 0 (length entry))
+ (setq temp (diary-pull-attrs entry file-glob-attrs)
+ entry (nth 0 temp)
+ marks (nth 1 temp))))
+ (diary-add-to-list date entry specifier
+ (if entry-start (copy-marker entry-start))
+ marks literal)
+ (setq entry-found (or entry-found diary-entry)))
entry-found))
+(define-obsolete-function-alias 'list-sexp-diary-entries
+ 'diary-list-sexp-entries "23.1")
+
+(defun diary-make-date (a b c)
+ "Convert A B C into the internal calendar date form.
+The expected order of the inputs depends on `calendar-date-style',
+e.g. in the European case, A = day, B = month, C = year. Returns
+a list (MONTH DAY YEAR), i.e. the American style, which is the
+form used internally by the calendar and diary."
+ (cond ((eq calendar-date-style 'iso) ; YMD
+ (list b c a))
+ ((eq calendar-date-style 'european) ; DMY
+ (list b a c))
+ (t (list a b c))))
+
;;; Sexp diary functions.
;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
(defun diary-date (month day year &optional mark)
"Specific date(s) diary entry.
-Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil,
-and DAY, MONTH, YEAR otherwise. DAY, MONTH, and YEAR can be lists of
-integers, `t' (meaning all values), or an integer.
-
-An optional parameter MARK specifies a face or single-character string to
-use when highlighting the day in the calendar."
- (let ((dd (if european-calendar-style
- month
- day))
- (mm (if european-calendar-style
- day
- month))
- (m (extract-calendar-month date))
- (y (extract-calendar-year date))
- (d (extract-calendar-day date)))
- (if (and
- (or (and (listp dd) (memq d dd))
- (equal d dd)
- (eq dd t))
- (or (and (listp mm) (memq m mm))
- (equal m mm)
- (eq mm t))
- (or (and (listp year) (memq y year))
- (equal y year)
- (eq year t)))
- (cons mark entry))))
+Entry applies if date is MONTH, DAY, YEAR. Each parameter can be a
+list of integers, `t' (meaning all values), or an integer. The order
+of the input parameters changes according to `calendar-date-style'
+\(e.g. to DAY MONTH YEAR in the European style).
+
+An optional parameter MARK specifies a face or single-character string
+to use when highlighting the day in the calendar."
+ (let* ((ddate (diary-make-date month day year))
+ (dd (calendar-extract-day ddate))
+ (mm (calendar-extract-month ddate))
+ (yy (calendar-extract-year ddate))
+ (m (calendar-extract-month date))
+ (y (calendar-extract-year date))
+ (d (calendar-extract-day date)))
+ (and
+ (or (and (listp dd) (memq d dd))
+ (equal d dd)
+ (eq dd t))
+ (or (and (listp mm) (memq m mm))
+ (equal m mm)
+ (eq mm t))
+ (or (and (listp yy) (memq y yy))
+ (equal y yy)
+ (eq yy t))
+ (cons mark entry))))
;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
(defun diary-block (m1 d1 y1 m2 d2 y2 &optional mark)
"Block diary entry.
-Entry applies if date is between, or on one of, two dates.
-The order of the parameters is M1, D1, Y1, M2, D2, Y2 if
-`european-calendar-style' is nil, and D1, M1, Y1, D2, M2, Y2 otherwise.
-
-An optional parameter MARK specifies a face or single-character string to
-use when highlighting the day in the calendar."
+Entry applies if date is between, or on one of, two dates. The order
+of the input parameters changes according to `calendar-date-style'
+\(e.g. to D1, M1, Y1, D2, M2, Y2 in the European style).
+An optional parameter MARK specifies a face or single-character string
+to use when highlighting the day in the calendar."
(let ((date1 (calendar-absolute-from-gregorian
- (if european-calendar-style
- (list d1 m1 y1)
- (list m1 d1 y1))))
+ (diary-make-date m1 d1 y1)))
(date2 (calendar-absolute-from-gregorian
- (if european-calendar-style
- (list d2 m2 y2)
- (list m2 d2 y2))))
+ (diary-make-date m2 d2 y2)))
(d (calendar-absolute-from-gregorian date)))
- (if (and (<= date1 d) (<= d date2))
- (cons mark entry))))
+ (and (<= date1 d) (<= d date2)
+ (cons mark entry))))
;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
(defun diary-float (month dayname n &optional day mark)
- "Floating diary entry--entry applies if date is the nth dayname of month.
-Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, an integer,
-or `t' (meaning all months). If N is negative, count backward from the end
-of the month.
-
-An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY.
+ "Diary entry for the Nth DAYNAME after/before MONTH DAY.
+DAYNAME=0 means Sunday, DAYNAME=1 means Monday, and so on.
+If N>0, use the Nth DAYNAME after MONTH DAY.
+If N<0, use the Nth DAYNAME before MONTH DAY.
+DAY defaults to 1 if N>0, and MONTH's last day otherwise.
+MONTH can be a list of months, an integer, or `t' (meaning all months).
Optional MARK specifies a face or single-character string to use when
highlighting the day in the calendar."
;; This is messy because the diary entry may apply, but the date on which it
;; first Monday after December 30. For large values of |n| the problem is
;; more grotesque.
(and (= dayname (calendar-day-of-week date))
- (let* ((m (extract-calendar-month date))
- (d (extract-calendar-day date))
- (y (extract-calendar-year date))
+ (let* ((m (calendar-extract-month date))
+ (d (calendar-extract-day date))
+ (y (calendar-extract-year date))
;; Last (n>0) or first (n<0) possible base date for entry.
(limit
(calendar-nth-named-absday (- n) dayname m y d))
(last (calendar-gregorian-from-absolute last-abs))
(first (calendar-gregorian-from-absolute first-abs))
;; m1, d1 is first possible base date.
- (m1 (extract-calendar-month first))
- (d1 (extract-calendar-day first))
- (y1 (extract-calendar-year first))
+ (m1 (calendar-extract-month first))
+ (d1 (calendar-extract-day first))
+ (y1 (calendar-extract-year first))
;; m2, d2 is last possible base date.
- (m2 (extract-calendar-month last))
- (d2 (extract-calendar-day last))
- (y2 (extract-calendar-year last)))
+ (m2 (calendar-extract-month last))
+ (d2 (calendar-extract-day last))
+ (y2 (calendar-extract-year last)))
(if (or (and (= m1 m2) ; only possible base dates in one month
(or (eq month t)
(if (listp month)
;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
(defun diary-anniversary (month day &optional year mark)
"Anniversary diary entry.
-Entry applies if date is the anniversary of MONTH, DAY, YEAR if
-`european-calendar-style' is nil, and DAY, MONTH, YEAR otherwise. The
-diary entry can contain `%d' or `%d%s'; the %d will be replaced by the
-number of years since the MONTH DAY, YEAR and the %s will be replaced by
-the ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
-appropriate. The anniversary of February 29 is considered to be March 1
-in non-leap years.
-
-An optional parameter MARK specifies a face or single-character string to
-use when highlighting the day in the calendar."
- (let* ((d (if european-calendar-style
- month
- day))
- (m (if european-calendar-style
- day
- month))
- (y (extract-calendar-year date))
- (diff (if year (- y year) 100)))
- (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y)))
- (setq m 3
- d 1))
- (if (and (> diff 0) (calendar-date-equal (list m d y) date))
- (cons mark (format entry diff (diary-ordinal-suffix diff))))))
+Entry applies if date is the anniversary of MONTH, DAY, YEAR.
+The order of the input parameters changes according to
+`calendar-date-style' (e.g. to DAY MONTH YEAR in the European style).
+
+The diary entry can contain `%d' or `%d%s'; the %d will be replaced
+by the number of years since the MONTH, DAY, YEAR, and the %s will
+be replaced by the ordinal ending of that number (that is, `st',
+`nd', `rd' or `th', as appropriate). The anniversary of February 29
+is considered to be March 1 in non-leap years.
+
+An optional parameter MARK specifies a face or single-character
+string to use when highlighting the day in the calendar."
+ (let* ((ddate (diary-make-date month day year))
+ (dd (calendar-extract-day ddate))
+ (mm (calendar-extract-month ddate))
+ (yy (calendar-extract-year ddate))
+ (y (calendar-extract-year date))
+ (diff (if yy (- y yy) 100)))
+ (and (= mm 2) (= dd 29) (not (calendar-leap-year-p y))
+ (setq mm 3
+ dd 1))
+ (and (> diff 0) (calendar-date-equal (list mm dd y) date)
+ (cons mark (format entry diff (diary-ordinal-suffix diff))))))
;; To be called from diary-sexp-entry, where DATE, ENTRY are bound.
(defun diary-cyclic (n month day year &optional mark)
"Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR.
-If `european-calendar-style' is non-nil, parameters are N, DAY, MONTH, YEAR.
-ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of
-repetitions since the MONTH DAY, YEAR and %s will be replaced by the
-ordinal ending of that number (that is, `st', `nd', `rd' or `th', as
-appropriate.
-
-An optional parameter MARK specifies a face or single-character string to
-use when highlighting the day in the calendar."
- (let* ((d (if european-calendar-style
- month
- day))
- (m (if european-calendar-style
- day
- month))
- (diff (- (calendar-absolute-from-gregorian date)
+The order of the input parameters changes according to
+`calendar-date-style' (e.g. to N DAY MONTH YEAR in the European
+style). The entry can contain `%d' or `%d%s'; the %d will be
+replaced by the number of repetitions since the MONTH DAY YEAR,
+and %s by the ordinal ending of that number (that is, `st', `nd',
+`rd' or `th', as appropriate).
+
+An optional parameter MARK specifies a face or single-character
+string to use when highlighting the day in the calendar."
+ (or (> n 0)
+ (error "Day count must be positive"))
+ (let* ((diff (- (calendar-absolute-from-gregorian date)
(calendar-absolute-from-gregorian
- (list m d year))))
+ (diary-make-date month day year))))
(cycle (/ diff n)))
- (if (and (>= diff 0) (zerop (% diff n)))
- (cons mark (format entry cycle (diary-ordinal-suffix cycle))))))
+ (and (>= diff 0) (zerop (% diff n))
+ (cons mark (format entry cycle (diary-ordinal-suffix cycle))))))
(defun diary-day-of-year ()
"Day of year and number of days remaining in the year of date diary entry."
(defun diary-remind (sexp days &optional marking)
"Provide a reminder of a diary entry.
-SEXP is a diary-sexp. DAYS is either a single number or a list of numbers
-indicating the number(s) of days before the event that the warning(s) should
-occur on. If the current date is (one of) DAYS before the event indicated by
-SEXP, then a suitable message (as specified by `diary-remind-message' is
-returned.
-
-In addition to the reminders beforehand, the diary entry also appears on the
-date itself.
-
-A `diary-nonmarking-symbol' at the beginning of the line of the `diary-remind'
-entry specifies that the diary entry (not the reminder) is non-marking.
-Marking of reminders is independent of whether the entry itself is a marking
-or nonmarking; if optional parameter MARKING is non-nil then the reminders are
-marked on the calendar."
+SEXP is a diary-sexp. DAYS is either a single number or a list
+of numbers indicating the number(s) of days before the event that
+the warning(s) should occur on. A negative number -DAYS has the
+same meaning as a list (1 2 ... DAYS). If the current date
+is (one of) DAYS before the event indicated by SEXP, then this function
+returns a suitable message (as specified by `diary-remind-message').
+
+In addition to the reminders beforehand, the diary entry also
+appears on the date itself.
+
+A `diary-nonmarking-symbol' at the beginning of the line of the
+`diary-remind' entry specifies that the diary entry (not the
+reminder) is non-marking. Marking of reminders is independent of
+whether the entry itself is a marking or nonmarking; if optional
+parameter MARKING is non-nil then the reminders are marked on the
+calendar."
+ ;; `date' has a value at this point, from diary-sexp-entry.
+ ;; Convert a negative number to a list of days.
+ (and (integerp days)
+ (< days 0)
+ (setq days (number-sequence 1 (- days))))
(let ((diary-entry (eval sexp)))
(cond
;; Diary entry applies on date.
((and diary-entry
- (or (not marking-diary-entries) marking-diary-entry))
+ (or (not diary-marking-entries-flag) diary-marking-entry-flag))
diary-entry)
;; Diary entry may apply to `days' before date.
((and (integerp days)
(not diary-entry) ; diary entry does not apply to date
- (or (not marking-diary-entries) marking))
+ (or (not diary-marking-entries-flag) marking))
+ ;; Adjust date, and re-evaluate.
(let ((date (calendar-gregorian-from-absolute
(+ (calendar-absolute-from-gregorian date) days))))
- (when (setq diary-entry (eval sexp)) ; re-evaluate with adjusted date
+ (when (setq diary-entry (eval sexp))
;; Discard any mark portion from diary-anniversary, etc.
(if (consp diary-entry) (setq diary-entry (cdr diary-entry)))
(mapconcat 'eval diary-remind-message ""))))
;;; Diary insertion functions.
;;;###cal-autoload
-(defun make-diary-entry (string &optional nonmarking file)
+(defun diary-make-entry (string &optional nonmarking file)
"Insert a diary entry STRING which may be NONMARKING in FILE.
If omitted, NONMARKING defaults to nil and FILE defaults to
`diary-file'."
- (let ((pop-up-frames (window-dedicated-p (selected-window))))
- (find-file-other-window (substitute-in-file-name (or file diary-file))))
- (when (eq major-mode default-major-mode) (diary-mode))
+ (let ((pop-up-frames (or pop-up-frames
+ (window-dedicated-p (selected-window)))))
+ (find-file-other-window (or file diary-file)))
+ (when (eq major-mode (default-value 'major-mode)) (diary-mode))
(widen)
(diary-unhide-everything)
(goto-char (point-max))
- ;; FIXME cf hack-local-variables.
(when (let ((case-fold-search t))
(search-backward "Local Variables:"
(max (- (point-max) 3000) (point-min))
string " "))
;;;###cal-autoload
-(defun insert-diary-entry (arg)
+(define-obsolete-function-alias 'make-diary-entry 'diary-make-entry "23.1")
+
+;;;###cal-autoload
+(defun diary-insert-entry (arg &optional event)
"Insert a diary entry for the date indicated by point.
Prefix argument ARG makes the entry nonmarking."
- (interactive "P")
- (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t)
+ (interactive
+ (list current-prefix-arg last-nonmenu-event))
+ (diary-make-entry (calendar-date-string (calendar-cursor-to-date t event) t t)
arg))
;;;###cal-autoload
-(defun insert-weekly-diary-entry (arg)
+(define-obsolete-function-alias 'insert-diary-entry 'diary-insert-entry "23.1")
+
+;;;###cal-autoload
+(defun diary-insert-weekly-entry (arg)
"Insert a weekly diary entry for the day of the week indicated by point.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (make-diary-entry (calendar-day-name (calendar-cursor-to-date t))
+ (diary-make-entry (calendar-day-name (calendar-cursor-to-date t))
arg))
;;;###cal-autoload
-(defun insert-monthly-diary-entry (arg)
+(define-obsolete-function-alias 'insert-weekly-diary-entry
+ 'diary-insert-weekly-entry "23.1")
+
+(defun diary-date-display-form (&optional type)
+ "Return value for `calendar-date-display-form' using `calendar-date-style'.
+Optional symbol TYPE is either `monthly' or `yearly'."
+ (cond ((eq type 'monthly) (cond ((eq calendar-date-style 'iso)
+ '((format "*-*-%.2d"
+ (string-to-number day))))
+ ((eq calendar-date-style 'european)
+ '(day " * "))
+ (t '("* " day ))))
+ ((eq type 'yearly) (cond ((eq calendar-date-style 'iso)
+ '((format "*-%.2d-%.2d"
+ (string-to-number month)
+ (string-to-number day))))
+ ((eq calendar-date-style 'european)
+ '(day " " monthname))
+ (t '(monthname " " day))))
+ ;; Iso cannot contain "-", because this form used eg by
+ ;; insert-anniversary-diary-entry.
+ (t (cond ((eq calendar-date-style 'iso)
+ '((format "%s %.2d %.2d" year
+ (string-to-number month) (string-to-number day))))
+ ((eq calendar-date-style 'european)
+ '(day " " month " " year))
+ (t '(month " " day " " year))))))
+
+(defun diary-insert-entry-1 (&optional type nomark months symbol absfunc)
+ "Subroutine to insert a diary entry related to the date at point.
+TYPE is the type of entry (`monthly' or `yearly'). NOMARK non-nil
+means make the entry non-marking. Array MONTHS is used in place
+of `calendar-month-name-array'. String SYMBOL marks the type of
+diary entry. Function ABSFUNC converts absolute dates to dates of
+the appropriate type."
+ (let ((calendar-date-display-form (if type
+ (diary-date-display-form type)
+ calendar-date-display-form))
+ (calendar-month-name-array (or months calendar-month-name-array))
+ (date (calendar-cursor-to-date t)))
+ (diary-make-entry
+ (format "%s%s" (or symbol "")
+ (calendar-date-string
+ (if absfunc
+ (funcall absfunc (calendar-absolute-from-gregorian date))
+ date)
+ (not absfunc)
+ (not type)))
+ nomark)))
+
+;;;###cal-autoload
+(defun diary-insert-monthly-entry (arg)
"Insert a monthly diary entry for the day of the month indicated by point.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " * ")
- '("* " day))))
- (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
- arg)))
+ (diary-insert-entry-1 'monthly arg))
+
+;;;###cal-autoload
+(define-obsolete-function-alias 'insert-monthly-diary-entry
+ 'diary-insert-monthly-entry "23.1")
;;;###cal-autoload
-(defun insert-yearly-diary-entry (arg)
+(defun diary-insert-yearly-entry (arg)
"Insert an annual diary entry for the day of the year indicated by point.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " monthname)
- '(monthname " " day))))
- (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t)
- arg)))
+ (diary-insert-entry-1 'yearly arg))
;;;###cal-autoload
-(defun insert-anniversary-diary-entry (arg)
+(define-obsolete-function-alias 'insert-yearly-diary-entry
+ 'diary-insert-yearly-entry "23.1")
+
+;;;###cal-autoload
+(defun diary-insert-anniversary-entry (arg)
"Insert an anniversary diary entry for the date given by point.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " month " " year)
- '(month " " day " " year))))
- (make-diary-entry
+ (let ((calendar-date-display-form (diary-date-display-form)))
+ (diary-make-entry
(format "%s(diary-anniversary %s)"
- sexp-diary-entry-symbol
+ diary-sexp-entry-symbol
(calendar-date-string (calendar-cursor-to-date t) nil t))
arg)))
;;;###cal-autoload
-(defun insert-block-diary-entry (arg)
+(define-obsolete-function-alias 'insert-anniversary-diary-entry
+ 'diary-insert-anniversary-entry "23.1")
+
+;;;###cal-autoload
+(defun diary-insert-block-entry (arg)
"Insert a block diary entry for the days between the point and marked date.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " month " " year)
- '(month " " day " " year)))
+ (let ((calendar-date-display-form (diary-date-display-form))
(cursor (calendar-cursor-to-date t))
(mark (or (car calendar-mark-ring)
(error "No mark set in this buffer")))
end cursor)
(setq start cursor
end mark))
- (make-diary-entry
+ (diary-make-entry
(format "%s(diary-block %s %s)"
- sexp-diary-entry-symbol
+ diary-sexp-entry-symbol
(calendar-date-string start nil t)
(calendar-date-string end nil t))
arg)))
;;;###cal-autoload
-(defun insert-cyclic-diary-entry (arg)
+(define-obsolete-function-alias 'insert-block-diary-entry
+ 'diary-insert-block-entry "23.1")
+
+;;;###cal-autoload
+(defun diary-insert-cyclic-entry (arg)
"Insert a cyclic diary entry starting at the date given by point.
Prefix argument ARG makes the entry nonmarking."
(interactive "P")
- (let ((calendar-date-display-form
- (if european-calendar-style
- '(day " " month " " year)
- '(month " " day " " year))))
- (make-diary-entry
+ (let ((calendar-date-display-form (diary-date-display-form)))
+ (diary-make-entry
(format "%s(diary-cyclic %d %s)"
- sexp-diary-entry-symbol
+ diary-sexp-entry-symbol
(calendar-read "Repeat every how many days: "
(lambda (x) (> x 0)))
(calendar-date-string (calendar-cursor-to-date t) nil t))
arg)))
+;;;###cal-autoload
+(define-obsolete-function-alias 'insert-cyclic-diary-entry
+ 'diary-insert-cyclic-entry "23.1")
+
;;; Diary mode.
(defun diary-redraw-calendar ()
"If `calendar-buffer' is live and diary entries are marked, redraw it."
- (and mark-diary-entries-in-calendar
+ (and calendar-mark-diary-entries-flag
(save-excursion
- (redraw-calendar)))
+ (calendar-redraw)))
;; Return value suitable for `write-contents-functions'.
nil)
"Recognize sexp diary entry up to LIMIT for font-locking."
(if (re-search-forward
(format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol)
- (regexp-quote sexp-diary-entry-symbol))
+ (regexp-quote diary-sexp-entry-symbol))
limit t)
(condition-case nil
(save-restriction
(defmacro diary-font-lock-keywords-1 (markfunc listfunc feature months symbol)
"Subroutine of the function `diary-font-lock-keywords'.
-If MARKFUNC is a member of `nongregorian-diary-marking-hook', or
-LISTFUNC of `nongregorian-diary-listing-hook', then require FEATURE
-and return a font-lock pattern matching array of MONTHS and marking SYMBOL."
- `(when (or (memq ',markfunc nongregorian-diary-marking-hook)
- (memq ',listfunc nongregorian-diary-listing-hook))
+If MARKFUNC is a member of `diary-nongregorian-marking-hook', or
+LISTFUNC of `diary-nongregorian-listing-hook', then require FEATURE and
+return a font-lock pattern matching array of MONTHS and marking SYMBOL."
+ `(when (or (memq ',markfunc diary-nongregorian-marking-hook)
+ (memq ',listfunc diary-nongregorian-listing-hook))
(require ',feature)
(diary-font-lock-date-forms ,months ,symbol)))
(append
(diary-font-lock-date-forms calendar-month-name-array
nil calendar-month-abbrev-array)
- (diary-font-lock-keywords-1 mark-hebrew-diary-entries
- list-hebrew-diary-entries
+ (diary-font-lock-keywords-1 diary-hebrew-mark-entries
+ diary-hebrew-list-entries
cal-hebrew
calendar-hebrew-month-name-array-leap-year
- hebrew-diary-entry-symbol)
- (diary-font-lock-keywords-1 mark-islamic-diary-entries
- list-islamic-diary-entries
+ diary-hebrew-entry-symbol)
+ (diary-font-lock-keywords-1 diary-islamic-mark-entries
+ diary-islamic-list-entries
cal-islam
calendar-islamic-month-name-array
- islamic-diary-entry-symbol)
+ diary-islamic-entry-symbol)
(diary-font-lock-keywords-1 diary-bahai-mark-entries
diary-bahai-list-entries
cal-bahai
calendar-bahai-month-name-array
- bahai-diary-entry-symbol)
+ diary-bahai-entry-symbol)
(list
(cons
(format "^%s.*$" (regexp-quote diary-include-string))
'font-lock-keyword-face)
(cons
(format "^%s?\\(%s\\)" (regexp-quote diary-nonmarking-symbol)
- (regexp-quote sexp-diary-entry-symbol))
+ (regexp-quote diary-sexp-entry-symbol))
'(1 font-lock-reference-face))
(cons
(format "^%s" (regexp-quote diary-nonmarking-symbol))
(cons
(format "^%s?%s" (regexp-quote diary-nonmarking-symbol)
(regexp-opt (mapcar 'regexp-quote
- (list hebrew-diary-entry-symbol
- islamic-diary-entry-symbol
- bahai-diary-entry-symbol))
+ (list diary-hebrew-entry-symbol
+ diary-islamic-entry-symbol
+ diary-bahai-entry-symbol))
t))
'(1 font-lock-reference-face))
'(diary-font-lock-sexps . font-lock-keyword-face)
"\\(: .*\\)?")
"Regular expression matching a date header in Fancy Diary.")
-(defvar fancy-diary-font-lock-keywords
+(define-obsolete-variable-alias 'fancy-diary-font-lock-keywords
+ 'diary-fancy-font-lock-keywords "23.1")
+
+(defvar diary-fancy-font-lock-keywords
(list
(list
;; Any number of " other holiday name" lines, followed by "==" line.
;; multiline pattern, extend the region to encompass the whole pattern.
(defun diary-fancy-font-lock-fontify-region-function (beg end &optional verbose)
"Function to use for `font-lock-fontify-region-function' in Fancy Diary.
-Needed to handle multiline keyword in `fancy-diary-font-lock-keywords'.
+Needed to handle multiline keyword in `diary-fancy-font-lock-keywords'.
Fontify the region between BEG and END, quietly unless VERBOSE is non-nil."
(goto-char beg)
(forward-line 0)
(setq end (line-beginning-position 2)))
(font-lock-default-fontify-region beg end verbose))
-(define-derived-mode fancy-diary-display-mode fundamental-mode
+(defvar diary-fancy-overriding-map (let ((map (make-sparse-keymap)))
+ (define-key map "q" 'quit-window)
+ map)
+ "Keymap overriding minor-mode maps in `diary-fancy-display-mode'.")
+
+(define-derived-mode diary-fancy-display-mode fundamental-mode
"Diary"
"Major mode used while displaying diary entries using Fancy Display."
(set (make-local-variable 'font-lock-defaults)
- '(fancy-diary-font-lock-keywords
+ '(diary-fancy-font-lock-keywords
t nil nil nil
(font-lock-fontify-region-function
. diary-fancy-font-lock-fontify-region-function)))
- (local-set-key "q" 'quit-window))
+ (local-set-key "q" 'quit-window)
+ (set (make-local-variable 'minor-mode-overriding-map-alist)
+ (list (cons t diary-fancy-overriding-map)))
+ (view-mode 1))
+(define-obsolete-function-alias 'fancy-diary-display-mode
+ 'diary-fancy-display-mode "23.1")
;; Following code from Dave Love <fx@gnu.org>.
;; Import Outlook-format appointments from mail messages in Gnus or
;; `diary-outlook-formats'.
(defvar subject) ; bound in diary-from-outlook-gnus
+(defvar body)
(defun diary-from-outlook-internal (&optional test-only)
"Snarf a diary entry from a message assumed to be from MS Outlook.
;; Fixme: References to optional fields in the format
;; are treated literally, not replaced by the empty
;; string. I think this is an Emacs bug.
- (make-diary-entry
+ (diary-make-entry
(format (replace-match (if (functionp format-string)
(funcall format-string body)
format-string)
HCoop / bpt / emacs.git / blobdiff