1;;; diary-lib.el --- diary functions 2 3;; Copyright (C) 1989, 1990, 1992, 1993, 1994, 1995, 2001, 2002, 2003, 4;; 2004, 2005, 2006, 2007 Free Software Foundation, Inc. 5 6;; Author: Edward M. Reingold <reingold@cs.uiuc.edu> 7;; Maintainer: Glenn Morris <rgm@gnu.org> 8;; Keywords: calendar 9 10;; This file is part of GNU Emacs. 11 12;; GNU Emacs is free software; you can redistribute it and/or modify 13;; it under the terms of the GNU General Public License as published by 14;; the Free Software Foundation; either version 2, or (at your option) 15;; any later version. 16 17;; GNU Emacs is distributed in the hope that it will be useful, 18;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20;; GNU General Public License for more details. 21 22;; You should have received a copy of the GNU General Public License 23;; along with GNU Emacs; see the file COPYING. If not, write to the 24;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 25;; Boston, MA 02110-1301, USA. 26 27;;; Commentary: 28 29;; This collection of functions implements the diary features as described 30;; in calendar.el. 31 32;;; Code: 33 34(require 'calendar) 35 36(defun diary-check-diary-file () 37 "Check that the file specified by `diary-file' exists and is readable. 38If so, return the expanded file name, otherwise signal an error." 39 (let ((d-file (substitute-in-file-name diary-file))) 40 (if (and d-file (file-exists-p d-file)) 41 (if (file-readable-p d-file) 42 d-file 43 (error "Diary file `%s' is not readable" diary-file)) 44 (error "Diary file `%s' does not exist" diary-file)))) 45 46;;;###autoload 47(defun diary (&optional arg) 48 "Generate the diary window for ARG days starting with the current date. 49If no argument is provided, the number of days of diary entries is governed 50by the variable `number-of-diary-entries'. A value of ARG less than 1 51does nothing. This function is suitable for execution in a `.emacs' file." 52 (interactive "P") 53 (diary-check-diary-file) 54 (let ((date (calendar-current-date))) 55 (diary-list-entries date (if arg (prefix-numeric-value arg))))) 56 57(define-obsolete-function-alias 'view-diary-entries 'diary-view-entries) 58(defun diary-view-entries (&optional arg) 59 "Prepare and display a buffer with diary entries. 60Searches the file named in `diary-file' for entries that 61match ARG days starting with the date indicated by the cursor position 62in the displayed three-month calendar." 63 (interactive "p") 64 (diary-check-diary-file) 65 (diary-list-entries (calendar-cursor-to-date t) arg)) 66 67(defun view-other-diary-entries (arg d-file) 68 "Prepare and display buffer of diary entries from an alternative diary file. 69Searches for entries that match ARG days, starting with the date indicated 70by the cursor position in the displayed three-month calendar. 71D-FILE specifies the file to use as the diary file." 72 (interactive 73 (list (prefix-numeric-value current-prefix-arg) 74 (read-file-name "Enter diary file name: " default-directory nil t))) 75 (let ((diary-file d-file)) 76 (diary-view-entries arg))) 77 78(autoload 'check-calendar-holidays "holidays" 79 "Check the list of holidays for any that occur on DATE. 80The value returned is a list of strings of relevant holiday descriptions. 81The holidays are those in the list `calendar-holidays'.") 82 83(autoload 'calendar-holiday-list "holidays" 84 "Form the list of holidays that occur on dates in the calendar window. 85The holidays are those in the list `calendar-holidays'.") 86 87(autoload 'diary-french-date "cal-french" 88 "French calendar equivalent of date diary entry.") 89 90(autoload 'diary-mayan-date "cal-mayan" 91 "Mayan calendar equivalent of date diary entry.") 92 93(autoload 'diary-iso-date "cal-iso" 94 "ISO calendar equivalent of date diary entry.") 95 96(autoload 'diary-julian-date "cal-julian" 97 "Julian calendar equivalent of date diary entry.") 98 99(autoload 'diary-astro-day-number "cal-julian" 100 "Astronomical (Julian) day number diary entry.") 101 102(autoload 'diary-chinese-date "cal-china" 103 "Chinese calendar equivalent of date diary entry.") 104 105(autoload 'diary-islamic-date "cal-islam" 106 "Islamic calendar equivalent of date diary entry.") 107 108(autoload 'list-islamic-diary-entries "cal-islam" 109 "Add any Islamic date entries from the diary file to `diary-entries-list'.") 110 111(autoload 'mark-islamic-diary-entries "cal-islam" 112 "Mark days in the calendar window that have Islamic date diary entries.") 113 114(autoload 'mark-islamic-calendar-date-pattern "cal-islam" 115 "Mark dates in calendar window that conform to Islamic date MONTH/DAY/YEAR.") 116 117(autoload 'diary-bahai-date "cal-bahai" 118 "Baha'i calendar equivalent of date diary entry.") 119 120(autoload 'list-bahai-diary-entries "cal-bahai" 121 "Add any Baha'i date entries from the diary file to `diary-entries-list'.") 122 123(autoload 'mark-bahai-diary-entries "cal-bahai" 124 "Mark days in the calendar window that have Baha'i date diary entries.") 125 126(autoload 'mark-bahai-calendar-date-pattern "cal-bahai" 127 "Mark dates in calendar window that conform to Baha'i date MONTH/DAY/YEAR.") 128 129(autoload 'diary-hebrew-date "cal-hebrew" 130 "Hebrew calendar equivalent of date diary entry.") 131 132(autoload 'diary-omer "cal-hebrew" 133 "Omer count diary entry.") 134 135(autoload 'diary-yahrzeit "cal-hebrew" 136 "Yahrzeit diary entry--entry applies if date is yahrzeit or the day before.") 137 138(autoload 'diary-parasha "cal-hebrew" 139 "Parasha diary entry--entry applies if date is a Saturday.") 140 141(autoload 'diary-rosh-hodesh "cal-hebrew" 142 "Rosh Hodesh diary entry.") 143 144(autoload 'list-hebrew-diary-entries "cal-hebrew" 145 "Add any Hebrew date entries from the diary file to `diary-entries-list'.") 146 147(autoload 'mark-hebrew-diary-entries "cal-hebrew" 148 "Mark days in the calendar window that have Hebrew date diary entries.") 149 150(autoload 'mark-hebrew-calendar-date-pattern "cal-hebrew" 151 "Mark dates in calendar window that conform to Hebrew date MONTH/DAY/YEAR.") 152 153(autoload 'diary-coptic-date "cal-coptic" 154 "Coptic calendar equivalent of date diary entry.") 155 156(autoload 'diary-ethiopic-date "cal-coptic" 157 "Ethiopic calendar equivalent of date diary entry.") 158 159(autoload 'diary-persian-date "cal-persia" 160 "Persian calendar equivalent of date diary entry.") 161 162(autoload 'diary-phases-of-moon "lunar" "Moon phases diary entry.") 163 164(autoload 'diary-sunrise-sunset "solar" 165 "Local time of sunrise and sunset as a diary entry.") 166 167(autoload 'diary-sabbath-candles "solar" 168 "Local time of candle lighting diary entry--applies if date is a Friday. 169No diary entry if there is no sunset on that date.") 170 171(defvar diary-syntax-table 172 (let ((st (copy-syntax-table (standard-syntax-table)))) 173 (modify-syntax-entry ?* "w" st) 174 (modify-syntax-entry ?: "w" st) 175 st) 176 "The syntax table used when parsing dates in the diary file. 177It is the standard syntax table used in Fundamental mode, but with the 178syntax of `*' and `:' changed to be word constituents.") 179 180(defvar diary-entries-list) 181(defvar displayed-year) 182(defvar displayed-month) 183(defvar entry) 184(defvar date) 185(defvar number) 186(defvar date-string) 187(defvar original-date) 188 189(defun diary-attrtype-convert (attrvalue type) 190 "Convert string ATTRVALUE to TYPE appropriate for a face description. 191Valid TYPEs are: string, symbol, int, stringtnil, tnil." 192 (let (ret) 193 (setq ret (cond ((eq type 'string) attrvalue) 194 ((eq type 'symbol) (read attrvalue)) 195 ((eq type 'int) (string-to-number attrvalue)) 196 ((eq type 'stringtnil) 197 (cond ((string= "t" attrvalue) t) 198 ((string= "nil" attrvalue) nil) 199 (t attrvalue))) 200 ((eq type 'tnil) 201 (cond ((string= "t" attrvalue) t) 202 ((string= "nil" attrvalue) nil))))) 203; (message "(%s)[%s]=[%s]" (print type) attrvalue ret) 204 ret)) 205 206 207(defun diary-pull-attrs (entry fileglobattrs) 208 "Pull the face-related attributes off the entry, merge with the 209fileglobattrs, and return the (possibly modified) entry and face 210data in a list of attrname attrvalue values. 211The entry will be modified to drop all tags that are used for face matching. 212If entry is nil, then the fileglobattrs are being searched for, 213the fileglobattrs variable is ignored, and 214diary-glob-file-regexp-prefix is prepended to the regexps before each 215search." 216 (save-excursion 217 (let (regexp regnum attrname attr-list attrname attrvalue type 218 ret-attr attr) 219 (if (null entry) 220 (progn 221 (setq ret-attr '() 222 attr-list diary-face-attrs) 223 (while attr-list 224 (goto-char (point-min)) 225 (setq attr (car attr-list) 226 regexp (nth 0 attr) 227 regnum (nth 1 attr) 228 attrname (nth 2 attr) 229 type (nth 3 attr) 230 regexp (concat diary-glob-file-regexp-prefix regexp)) 231 (setq attrvalue nil) 232 (if (re-search-forward regexp (point-max) t) 233 (setq attrvalue (match-string-no-properties regnum))) 234 (if (and attrvalue 235 (setq attrvalue (diary-attrtype-convert attrvalue type))) 236 (setq ret-attr (append ret-attr (list attrname attrvalue)))) 237 (setq attr-list (cdr attr-list))) 238 (setq fileglobattrs ret-attr)) 239 (progn 240 (setq ret-attr fileglobattrs 241 attr-list diary-face-attrs) 242 (while attr-list 243 (goto-char (point-min)) 244 (setq attr (car attr-list) 245 regexp (nth 0 attr) 246 regnum (nth 1 attr) 247 attrname (nth 2 attr) 248 type (nth 3 attr)) 249 (setq attrvalue nil) 250 (if (string-match regexp entry) 251 (progn 252 (setq attrvalue (match-string-no-properties regnum entry)) 253 (setq entry (replace-match "" t t entry)))) 254 (if (and attrvalue 255 (setq attrvalue (diary-attrtype-convert attrvalue type))) 256 (setq ret-attr (append ret-attr (list attrname attrvalue)))) 257 (setq attr-list (cdr attr-list))))) 258 (list entry ret-attr)))) 259 260(defun diary-set-maybe-redraw (symbol value) 261 "Set SYMBOL's value to VALUE, and redraw the diary if necessary. 262Redraws the diary if it is being displayed (note this is not the same as 263just visiting the `diary-file'), and SYMBOL's value is to be changed." 264 (let ((oldvalue (eval symbol))) 265 (custom-set-default symbol value) 266 (and (not (equal value oldvalue)) 267 (diary-live-p) 268 ;; Note this assumes diary was called without prefix arg. 269 (diary)))) 270 271;; This can be removed once the kill/yank treatment of invisible text 272;; (see etc/TODO) is fixed. -- gm 273(defcustom diary-header-line-flag t 274 "If non-nil, `simple-diary-display' will show a header line. 275The format of the header is specified by `diary-header-line-format'." 276 :group 'diary 277 :type 'boolean 278 :initialize 'custom-initialize-default 279 ;; FIXME overkill. 280 :set 'diary-set-maybe-redraw 281 :version "22.1") 282 283(defvar diary-selective-display nil) 284 285(defcustom diary-header-line-format 286 '(:eval (calendar-string-spread 287 (list (if diary-selective-display 288 "Selective display active - press \"s\" in calendar \ 289before edit/copy" 290 "Diary")) 291 ?\s (frame-width))) 292 "Format of the header line displayed by `simple-diary-display'. 293Only used if `diary-header-line-flag' is non-nil." 294 :group 'diary 295 :type 'sexp 296 :initialize 'custom-initialize-default 297 ;; FIXME overkill. 298 :set 'diary-set-maybe-redraw 299 :version "22.1") 300 301(defvar diary-saved-point) ; internal 302 303;; The first version of this also checked for diary-selective-display 304;; in the non-fancy case. This was an attempt to distinguish between 305;; displaying the diary and just visiting the diary file. However, 306;; when using fancy diary, calling diary when there are no entries to 307;; display does not create the fancy buffer, nor does it switch on 308;; selective-display in the diary buffer. This means some 309;; customizations will not take effect, eg: 310;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00466.html 311;; So the check for selective-display was dropped. This means the 312;; diary will be displayed if one customizes a diary variable while 313;; just visiting the diary-file. This is i) unlikely, and ii) no great loss. 314(defun diary-live-p () 315 "Return non-nil if the diary is being displayed." 316 (or (get-buffer fancy-diary-buffer) 317 (and diary-file 318 (find-buffer-visiting (substitute-in-file-name diary-file))))) 319 320(defcustom number-of-diary-entries 1 321 "Specifies how many days of diary entries are to be displayed initially. 322This variable affects the diary display when the command \\[diary] is used, 323or if the value of the variable `view-diary-entries-initially' is t. For 324example, if the default value 1 is used, then only the current day's diary 325entries will be displayed. If the value 2 is used, then both the current 326day's and the next day's entries will be displayed. 327 328The value can also be a vector such as [0 2 2 2 2 4 1]; this value 329says to display no diary entries on Sunday, the entries for 330the current date and the day after on Monday through Thursday, 331Friday through Monday's entries on Friday, and only Saturday's 332entries on Saturday. 333 334This variable does not affect the diary display with the `d' command 335from the calendar; in that case, the prefix argument controls the 336number of days of diary entries displayed." 337 :type '(choice (integer :tag "Entries") 338 (vector :value [0 0 0 0 0 0 0] 339 (integer :tag "Sunday") 340 (integer :tag "Monday") 341 (integer :tag "Tuesday") 342 (integer :tag "Wednesday") 343 (integer :tag "Thursday") 344 (integer :tag "Friday") 345 (integer :tag "Saturday"))) 346 :initialize 'custom-initialize-default 347 :set 'diary-set-maybe-redraw 348 :group 'diary) 349 350 351(defvar diary-modify-entry-list-string-function nil 352 "Function applied to entry string before putting it into the entries list. 353Can be used by programs integrating a diary list into other buffers (e.g. 354org.el and planner.el) to modify the string or add properties to it. 355The function takes a string argument and must return a string.") 356 357(defun add-to-diary-list (date string specifier &optional marker 358 globcolor literal) 359 "Add an entry to `diary-entries-list'. 360Do nothing if DATE or STRING is nil. DATE is the (MONTH DAY 361YEAR) for which the entry applies; STRING is the text of the 362entry as it will appear in the diary (i.e. with any format 363strings such as \"%d\" expanded); SPECIFIER is the date part of 364the entry as it appears in the diary-file; LITERAL is the entry 365as it appears in the diary-file (i.e. before expansion). If 366LITERAL is nil, it is taken to be the same as STRING. 367 368The entry is added to the list as (DATE STRING SPECIFIER LOCATOR 369GLOBCOLOR), where LOCATOR has the form (MARKER FILENAME LITERAL), 370FILENAME being the file containing the diary entry." 371 (when (and date string) 372 (if diary-file-name-prefix 373 (let ((prefix (funcall diary-file-name-prefix-function 374 (buffer-file-name)))) 375 (or (string= prefix "") 376 (setq string (format "[%s] %s" prefix string))))) 377 (and diary-modify-entry-list-string-function 378 (setq string (funcall diary-modify-entry-list-string-function 379 string))) 380 (setq diary-entries-list 381 (append diary-entries-list 382 (list (list date string specifier 383 (list marker (buffer-file-name) literal) 384 globcolor)))))) 385 386(define-obsolete-function-alias 'list-diary-entries 'diary-list-entries) 387(defun diary-list-entries (date number &optional list-only) 388 "Create and display a buffer containing the relevant lines in `diary-file'. 389The arguments are DATE and NUMBER; the entries selected are those 390for NUMBER days starting with date DATE. The other entries are hidden 391using selective display. If NUMBER is less than 1, this function does nothing. 392 393Returns a list of all relevant diary entries found, if any, in order by date. 394The list entries have the form ((MONTH DAY YEAR) STRING SPECIFIER) where 395\(MONTH DAY YEAR) is the date of the entry, STRING is the entry text, and 396SPECIFIER is the applicability. If the variable `diary-list-include-blanks' 397is t, this list includes a dummy diary entry consisting of the empty string 398for a date with no diary entries. 399 400After the list is prepared, the hooks `nongregorian-diary-listing-hook', 401`list-diary-entries-hook', `diary-display-hook', and `diary-hook' are run. 402These hooks have the following distinct roles: 403 404 `nongregorian-diary-listing-hook' can cull dates from the diary 405 and each included file. Usually used for Hebrew or Islamic 406 diary entries in files. Applied to *each* file. 407 408 `list-diary-entries-hook' adds or manipulates diary entries from 409 external sources. Used, for example, to include diary entries 410 from other files or to sort the diary entries. Invoked *once* only, 411 before the display hook is run. 412 413 `diary-display-hook' does the actual display of information. If this is 414 nil, simple-diary-display will be used. Use add-hook to set this to 415 fancy-diary-display, if desired. If you want no diary display, use 416 add-hook to set this to ignore. 417 418 `diary-hook' is run last. This can be used for an appointment 419 notification function. 420 421If LIST-ONLY is non-nil don't modify or display the buffer, only return a list." 422 (unless number 423 (setq number (if (vectorp number-of-diary-entries) 424 (aref number-of-diary-entries (calendar-day-of-week date)) 425 number-of-diary-entries))) 426 (when (> number 0) 427 (let ((original-date date);; save for possible use in the hooks 428 diary-entries-list 429 file-glob-attrs 430 (date-string (calendar-date-string date)) 431 (d-file (substitute-in-file-name diary-file))) 432 (message "Preparing diary...") 433 (save-excursion 434 (let ((diary-buffer (find-buffer-visiting d-file))) 435 (if (not diary-buffer) 436 (set-buffer (find-file-noselect d-file t)) 437 (set-buffer diary-buffer) 438 (or (verify-visited-file-modtime diary-buffer) 439 (revert-buffer t t)))) 440 ;; Setup things like the header-line-format and invisibility-spec. 441 (if (eq major-mode default-major-mode) 442 (diary-mode) 443 ;; This kludge is to make customizations to 444 ;; diary-header-line-flag after diary has been displayed 445 ;; take effect. Unconditionally calling (diary-mode) 446 ;; clobbers file local variables. 447 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-03/msg00363.html 448 ;; http://lists.gnu.org/archive/html/emacs-pretest-bug/2007-04/msg00404.html 449 (if (eq major-mode 'diary-mode) 450 (setq header-line-format (and diary-header-line-flag 451 diary-header-line-format)))) 452 ;; d-s-p is passed to the diary display function. 453 (let ((diary-saved-point (point))) 454 (save-excursion 455 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil ""))) 456 (with-syntax-table diary-syntax-table 457 (let ((mark (regexp-quote diary-nonmarking-symbol))) 458 (goto-char (point-min)) 459 (unless list-only 460 (let ((ol (make-overlay (point-min) (point-max) nil t nil))) 461 (set (make-local-variable 'diary-selective-display) t) 462 (overlay-put ol 'invisible 'diary) 463 (overlay-put ol 'evaporate t))) 464 (calendar-for-loop 465 i from 1 to number do 466 (let ((month (extract-calendar-month date)) 467 (day (extract-calendar-day date)) 468 (year (extract-calendar-year date)) 469 (entry-found (list-sexp-diary-entries date))) 470 (dolist (date-form diary-date-forms) 471 (let* 472 ((backup (when (eq (car date-form) 'backup) 473 (setq date-form (cdr date-form)) 474 t)) 475 (dayname 476 (format "%s\\|%s\\.?" 477 (calendar-day-name date) 478 (calendar-day-name date 'abbrev))) 479 (monthname 480 (format "\\*\\|%s\\|%s\\.?" 481 (calendar-month-name month) 482 (calendar-month-name month 'abbrev))) 483 (month (concat "\\*\\|0*" (int-to-string month))) 484 (day (concat "\\*\\|0*" (int-to-string day))) 485 (year 486 (concat 487 "\\*\\|0*" (int-to-string year) 488 (if abbreviated-calendar-year 489 (concat "\\|" (format "%02d" (% year 100))) 490 ""))) 491 (regexp 492 (concat 493 "\\(\\`\\|\^M\\|\n\\)" mark "?\\(" 494 (mapconcat 'eval date-form "\\)\\(?:") 495 "\\)")) 496 (case-fold-search t)) 497 (goto-char (point-min)) 498 (while (re-search-forward regexp nil t) 499 (if backup (re-search-backward "\\<" nil t)) 500 (if (and (or (char-equal (preceding-char) ?\^M) 501 (char-equal (preceding-char) ?\n)) 502 (not (looking-at " \\|\^I"))) 503 ;; Diary entry that consists only of date. 504 (backward-char 1) 505 ;; Found a nonempty diary entry--make it 506 ;; visible and add it to the list. 507 (setq entry-found t) 508 (let ((entry-start (point)) 509 date-start temp) 510 (re-search-backward "\^M\\|\n\\|\\`") 511 (setq date-start (point)) 512 ;; When selective display (rather than 513 ;; overlays) was used, diary file used to 514 ;; start in a blank line and end in a 515 ;; newline. Now that neither of these 516 ;; need be true, 'move handles the latter 517 ;; and 1/2 kludge the former. 518 (re-search-forward 519 "\^M\\|\n" nil 'move 520 (if (and (bobp) (not (looking-at "\^M\\|\n"))) 521 1 522 2)) 523 (while (looking-at " \\|\^I") 524 (re-search-forward "\^M\\|\n" nil 'move)) 525 (unless (and (eobp) (not (bolp))) 526 (backward-char 1)) 527 (unless list-only 528 (remove-overlays date-start (point) 529 'invisible 'diary)) 530 (setq entry (buffer-substring entry-start (point)) 531 temp (diary-pull-attrs entry file-glob-attrs) 532 entry (nth 0 temp)) 533 (add-to-diary-list 534 date 535 entry 536 (buffer-substring 537 (1+ date-start) (1- entry-start)) 538 (copy-marker entry-start) (nth 1 temp))))))) 539 (or entry-found 540 (not diary-list-include-blanks) 541 (add-to-diary-list date "" "" "" "")) 542 (setq date 543 (calendar-gregorian-from-absolute 544 (1+ (calendar-absolute-from-gregorian date)))) 545 (setq entry-found nil))))) 546 (goto-char (point-min)) 547 (run-hooks 'nongregorian-diary-listing-hook 548 'list-diary-entries-hook) 549 (unless list-only 550 (if diary-display-hook 551 (run-hooks 'diary-display-hook) 552 (simple-diary-display))) 553 (run-hooks 'diary-hook) 554 diary-entries-list)))))) 555 556(defun diary-unhide-everything () 557 (kill-local-variable 'diary-selective-display) 558 (remove-overlays (point-min) (point-max) 'invisible 'diary) 559 (kill-local-variable 'mode-line-format)) 560 561(defun include-other-diary-files () 562 "Include the diary entries from other diary files with those of diary-file. 563This function is suitable for use in `list-diary-entries-hook'; 564it enables you to use shared diary files together with your own. 565The files included are specified in the diaryfile by lines of this form: 566 #include \"filename\" 567This is recursive; that is, #include directives in diary files thus included 568are obeyed. You can change the `#include' to some other string by 569changing the variable `diary-include-string'." 570 (goto-char (point-min)) 571 (while (re-search-forward 572 (concat 573 "\\(?:\\`\\|\^M\\|\n\\)" 574 (regexp-quote diary-include-string) 575 " \"\\([^\"]*\\)\"") 576 nil t) 577 (let* ((diary-file (substitute-in-file-name 578 (match-string-no-properties 1))) 579 (diary-list-include-blanks nil) 580 (list-diary-entries-hook 'include-other-diary-files) 581 (diary-display-hook 'ignore) 582 (diary-hook nil)) 583 (if (file-exists-p diary-file) 584 (if (file-readable-p diary-file) 585 (unwind-protect 586 (setq diary-entries-list 587 (append diary-entries-list 588 (diary-list-entries original-date number))) 589 (with-current-buffer (find-buffer-visiting diary-file) 590 (diary-unhide-everything))) 591 (beep) 592 (message "Can't read included diary file %s" diary-file) 593 (sleep-for 2)) 594 (beep) 595 (message "Can't find included diary file %s" diary-file) 596 (sleep-for 2)))) 597 (goto-char (point-min))) 598 599(defun simple-diary-display () 600 "Display the diary buffer if there are any relevant entries or holidays." 601 (let* ((holiday-list (if holidays-in-diary-buffer 602 (check-calendar-holidays original-date))) 603 (hol-string (format "%s%s%s" 604 date-string 605 (if holiday-list ": " "") 606 (mapconcat 'identity holiday-list "; "))) 607 (msg (format "No diary entries for %s" hol-string)) 608 ;; If selected window is dedicated (to the calendar), 609 ;; need a new one to display the diary. 610 (pop-up-frames (window-dedicated-p (selected-window)))) 611 (calendar-set-mode-line (format "Diary for %s" hol-string)) 612 (if (or (not diary-entries-list) 613 (and (not (cdr diary-entries-list)) 614 (string-equal (car (cdr (car diary-entries-list))) ""))) 615 (if (< (length msg) (frame-width)) 616 (message "%s" msg) 617 (set-buffer (get-buffer-create holiday-buffer)) 618 (setq buffer-read-only nil) 619 (calendar-set-mode-line date-string) 620 (erase-buffer) 621 (insert (mapconcat 'identity holiday-list "\n")) 622 (goto-char (point-min)) 623 (set-buffer-modified-p nil) 624 (setq buffer-read-only t) 625 (display-buffer holiday-buffer) 626 (message "No diary entries for %s" date-string)) 627 (with-current-buffer 628 (find-buffer-visiting (substitute-in-file-name diary-file)) 629 (let ((window (display-buffer (current-buffer)))) 630 ;; d-s-p is passed from list-diary-entries. 631 (set-window-point window diary-saved-point) 632 (set-window-start window (point-min)))) 633 (message "Preparing diary...done")))) 634 635(defface diary-button '((((type pc) (class color)) 636 (:foreground "lightblue"))) 637 "Default face used for buttons." 638 :version "22.1" 639 :group 'diary) 640;; backward-compatibility alias 641(put 'diary-button-face 'face-alias 'diary-button) 642 643(define-button-type 'diary-entry 644 'action #'diary-goto-entry 645 'face 'diary-button) 646 647(defun diary-goto-entry (button) 648 (let* ((locator (button-get button 'locator)) 649 (marker (car locator)) 650 markbuf file) 651 ;; If marker pointing to diary location is valid, use that. 652 (if (and marker (setq markbuf (marker-buffer marker))) 653 (progn 654 (pop-to-buffer markbuf) 655 (goto-char (marker-position marker))) 656 ;; Marker is invalid (eg buffer has been killed). 657 (or (and (setq file (cadr locator)) 658 (file-exists-p file) 659 (find-file-other-window file) 660 (progn 661 (when (eq major-mode default-major-mode) (diary-mode)) 662 (goto-char (point-min)) 663 (if (re-search-forward (format "%s.*\\(%s\\)" 664 (regexp-quote (nth 2 locator)) 665 (regexp-quote (nth 3 locator))) 666 nil t) 667 (goto-char (match-beginning 1))))) 668 (message "Unable to locate this diary entry"))))) 669 670(defun fancy-diary-display () 671 "Prepare a diary buffer with relevant entries in a fancy, noneditable form. 672This function is provided for optional use as the `diary-display-hook'." 673 (with-current-buffer ;; Turn off selective-display in the diary file's buffer. 674 (find-buffer-visiting (substitute-in-file-name diary-file)) 675 (diary-unhide-everything)) 676 (if (or (not diary-entries-list) 677 (and (not (cdr diary-entries-list)) 678 (string-equal (car (cdr (car diary-entries-list))) ""))) 679 (let* ((holiday-list (if holidays-in-diary-buffer 680 (check-calendar-holidays original-date))) 681 (msg (format "No diary entries for %s %s" 682 (concat date-string (if holiday-list ":" "")) 683 (mapconcat 'identity holiday-list "; ")))) 684 (if (<= (length msg) (frame-width)) 685 (message "%s" msg) 686 (set-buffer (get-buffer-create holiday-buffer)) 687 (setq buffer-read-only nil) 688 (erase-buffer) 689 (insert (mapconcat 'identity holiday-list "\n")) 690 (goto-char (point-min)) 691 (set-buffer-modified-p nil) 692 (setq buffer-read-only t) 693 (display-buffer holiday-buffer) 694 (message "No diary entries for %s" date-string))) 695 (with-current-buffer;; Prepare the fancy diary buffer. 696 (make-fancy-diary-buffer) 697 (setq buffer-read-only nil) 698 (let ((entry-list diary-entries-list) 699 (holiday-list) 700 (holiday-list-last-month 1) 701 (holiday-list-last-year 1) 702 (date (list 0 0 0))) 703 (while entry-list 704 (if (not (calendar-date-equal date (car (car entry-list)))) 705 (progn 706 (setq date (car (car entry-list))) 707 (and holidays-in-diary-buffer 708 (calendar-date-compare 709 (list (list holiday-list-last-month 710 (calendar-last-day-of-month 711 holiday-list-last-month 712 holiday-list-last-year) 713 holiday-list-last-year)) 714 (list date)) 715 ;; We need to get the holidays for the next 3 months. 716 (setq holiday-list-last-month 717 (extract-calendar-month date)) 718 (setq holiday-list-last-year 719 (extract-calendar-year date)) 720 (progn 721 (increment-calendar-month 722 holiday-list-last-month holiday-list-last-year 1) 723 t) 724 (setq holiday-list 725 (let ((displayed-month holiday-list-last-month) 726 (displayed-year holiday-list-last-year)) 727 (calendar-holiday-list))) 728 (increment-calendar-month 729 holiday-list-last-month holiday-list-last-year 1)) 730 (let* ((date-string (calendar-date-string date)) 731 (date-holiday-list 732 (let ((h holiday-list) 733 (d)) 734 ;; Make a list of all holidays for date. 735 (while h 736 (if (calendar-date-equal date (car (car h))) 737 (setq d (append d (cdr (car h))))) 738 (setq h (cdr h))) 739 d))) 740 (insert (if (= (point) (point-min)) "" ?\n) date-string) 741 (if date-holiday-list (insert ": ")) 742 (let* ((l (current-column)) 743 (longest 0)) 744 (insert (mapconcat (lambda (x) 745 (if (< longest (length x)) 746 (setq longest (length x))) 747 x) 748 date-holiday-list 749 (concat "\n" (make-string l ? )))) 750 (insert ?\n (make-string (+ l longest) ?=) ?\n))))) 751 752 (setq entry (car (cdr (car entry-list)))) 753 (if (< 0 (length entry)) 754 (let ((this-entry (car entry-list)) 755 this-loc) 756 (if (setq this-loc (nth 3 this-entry)) 757 (insert-button (concat entry "\n") 758 ;; (MARKER FILENAME SPECIFIER LITERAL) 759 'locator (list (car this-loc) 760 (cadr this-loc) 761 (nth 2 this-entry) 762 (or (nth 2 this-loc) 763 (nth 1 this-entry))) 764 :type 'diary-entry) 765 (insert entry ?\n)) 766 (save-excursion 767 (let* ((marks (nth 4 this-entry)) 768 (faceinfo marks) 769 temp-face) 770 (when marks 771 (setq temp-face (make-symbol 772 (apply 773 'concat "temp-face-" 774 (mapcar (lambda (sym) 775 (if (stringp sym) 776 sym 777 (symbol-name sym))) 778 marks)))) 779 (make-face temp-face) 780 ;; Remove :face info from the marks, 781 ;; copy the face info into temp-face 782 (while (setq faceinfo (memq :face faceinfo)) 783 (copy-face (read (nth 1 faceinfo)) temp-face) 784 (setcar faceinfo nil) 785 (setcar (cdr faceinfo) nil)) 786 (setq marks (delq nil marks)) 787 ;; Apply the font aspects. 788 (apply 'set-face-attribute temp-face nil marks) 789 (search-backward entry) 790 (overlay-put 791 (make-overlay (match-beginning 0) (match-end 0)) 792 'face temp-face)))))) 793 (setq entry-list (cdr entry-list)))) 794 (set-buffer-modified-p nil) 795 (goto-char (point-min)) 796 (setq buffer-read-only t) 797 (display-buffer fancy-diary-buffer) 798 (fancy-diary-display-mode) 799 (calendar-set-mode-line date-string) 800 (message "Preparing diary...done")))) 801 802(defun make-fancy-diary-buffer () 803 "Create and return the initial fancy diary buffer." 804 (with-current-buffer (get-buffer-create fancy-diary-buffer) 805 (setq buffer-read-only nil) 806 (calendar-set-mode-line "Diary Entries") 807 (erase-buffer) 808 (set-buffer-modified-p nil) 809 (setq buffer-read-only t) 810 (get-buffer fancy-diary-buffer))) 811 812(defun print-diary-entries () 813 "Print a hard copy of the diary display. 814 815If the simple diary display is being used, prepare a temp buffer with the 816visible lines of the diary buffer, add a heading line composed from the mode 817line, print the temp buffer, and destroy it. 818 819If the fancy diary display is being used, just print the buffer. 820 821The hooks given by the variable `print-diary-entries-hook' are called to do 822the actual printing." 823 (interactive) 824 (if (bufferp (get-buffer fancy-diary-buffer)) 825 (with-current-buffer (get-buffer fancy-diary-buffer) 826 (run-hooks 'print-diary-entries-hook)) 827 (let ((diary-buffer 828 (find-buffer-visiting (substitute-in-file-name diary-file)))) 829 (if diary-buffer 830 (let ((temp-buffer (get-buffer-create " *Printable Diary Entries*")) 831 (heading)) 832 (with-current-buffer diary-buffer 833 (setq heading 834 (if (not (stringp mode-line-format)) 835 "All Diary Entries" 836 (string-match "^-*\\([^-].*[^-]\\)-*$" mode-line-format) 837 (match-string 1 mode-line-format))) 838 (let ((start (point-min)) 839 end) 840 (while 841 (progn 842 (setq end (next-single-char-property-change 843 start 'invisible)) 844 (if (get-char-property start 'invisible) 845 nil 846 (with-current-buffer temp-buffer 847 (insert-buffer-substring diary-buffer 848 start (or end (point-max))))) 849 (setq start end) 850 (and end (< end (point-max)))))) 851 (set-buffer temp-buffer) 852 (goto-char (point-min)) 853 (insert heading "\n" 854 (make-string (length heading) ?=) "\n") 855 (run-hooks 'print-diary-entries-hook) 856 (kill-buffer temp-buffer))) 857 (error "You don't have a diary buffer!"))))) 858 859(define-obsolete-function-alias 'show-all-diary-entries 'diary-show-all-entries) 860(defun diary-show-all-entries () 861 "Show all of the diary entries in the diary file. 862This function gets rid of the selective display of the diary file so that 863all entries, not just some, are visible. If there is no diary buffer, one 864is created." 865 (interactive) 866 (let ((d-file (diary-check-diary-file)) 867 (pop-up-frames (window-dedicated-p (selected-window)))) 868 (with-current-buffer (or (find-buffer-visiting d-file) 869 (find-file-noselect d-file t)) 870 (when (eq major-mode default-major-mode) (diary-mode)) 871 (diary-unhide-everything) 872 (display-buffer (current-buffer))))) 873 874(defcustom diary-mail-addr 875 (if (boundp 'user-mail-address) user-mail-address "") 876 "Email address that `diary-mail-entries' will send email to." 877 :group 'diary 878 :type 'string 879 :version "20.3") 880 881(defcustom diary-mail-days 7 882 "Default number of days for `diary-mail-entries' to check." 883 :group 'diary 884 :type 'integer 885 :version "20.3") 886 887;;;###autoload 888(defun diary-mail-entries (&optional ndays) 889 "Send a mail message showing diary entries for next NDAYS days. 890If no prefix argument is given, NDAYS is set to `diary-mail-days'. 891Mail is sent to the address specified by `diary-mail-addr'. 892 893You can call `diary-mail-entries' every night using an at/cron job. 894For example, this script will run the program at 2am daily. Since 895`emacs -batch' does not load your `.emacs' file, you must ensure that 896all relevant variables are set, as done here. 897 898#!/bin/sh 899# diary-rem.sh -- repeatedly run the Emacs diary-reminder 900emacs -batch \\ 901-eval \"(setq diary-mail-days 3 \\ 902 diary-file \\\"/path/to/diary.file\\\" \\ 903 european-calendar-style t \\ 904 diary-mail-addr \\\"user@host.name\\\" )\" \\ 905-l diary-lib -f diary-mail-entries 906at -f diary-rem.sh 0200 tomorrow 907 908You may have to tweak the syntax of the `at' command to suit your 909system. Alternatively, you can specify a cron entry: 9100 1 * * * diary-rem.sh 911to run it every morning at 1am." 912 (interactive "P") 913 (if (string-equal diary-mail-addr "") 914 (error "You must set `diary-mail-addr' to use this command") 915 (let ((diary-display-hook 'fancy-diary-display)) 916 (diary-list-entries (calendar-current-date) (or ndays diary-mail-days))) 917 (compose-mail diary-mail-addr 918 (concat "Diary entries generated " 919 (calendar-date-string (calendar-current-date)))) 920 (insert 921 (if (get-buffer fancy-diary-buffer) 922 (with-current-buffer fancy-diary-buffer (buffer-string)) 923 "No entries found")) 924 (call-interactively (get mail-user-agent 'sendfunc)))) 925 926(defun diary-name-pattern (string-array &optional abbrev-array paren) 927 "Return a regexp matching the strings in the array STRING-ARRAY. 928If the optional argument ABBREV-ARRAY is present, then the function 929`calendar-abbrev-construct' is used to construct abbreviations from the 930two supplied arrays. The returned regexp will then also match these 931abbreviations, with or without final `.' characters. If the optional 932argument PAREN is non-nil, the regexp is surrounded by parentheses." 933 (regexp-opt (append string-array 934 (if abbrev-array 935 (calendar-abbrev-construct abbrev-array 936 string-array)) 937 (if abbrev-array 938 (calendar-abbrev-construct abbrev-array 939 string-array 940 'period)) 941 nil) 942 paren)) 943 944(defvar marking-diary-entries nil 945 "True during the marking of diary entries, nil otherwise.") 946 947(defvar marking-diary-entry nil 948 "True during the marking of diary entries, if current entry is marking.") 949 950(defun mark-diary-entries (&optional redraw) 951 "Mark days in the calendar window that have diary entries. 952Each entry in the diary file visible in the calendar window is 953marked. After the entries are marked, the hooks 954`nongregorian-diary-marking-hook' and `mark-diary-entries-hook' 955are run. If the optional argument REDRAW is non-nil (which is 956the case interactively, for example) then any existing diary 957marks are first removed. This is intended to deal with deleted 958diary entries." 959 (interactive "p") 960 ;; To remove any deleted diary entries. Do not redraw when: 961 ;; i) processing #include diary files (else only get the marks from 962 ;; the last #include file processed). 963 ;; ii) called via calendar-redraw (since calendar has already been 964 ;; erased). 965 ;; Use of REDRAW handles both of these cases. 966 (when (and redraw mark-diary-entries-in-calendar) 967 (setq mark-diary-entries-in-calendar nil) 968 (redraw-calendar)) 969 (let ((marking-diary-entries t) 970 file-glob-attrs marks) 971 (with-current-buffer (find-file-noselect (diary-check-diary-file) t) 972 (save-excursion 973 (when (eq major-mode default-major-mode) (diary-mode)) 974 (setq mark-diary-entries-in-calendar t) 975 (message "Marking diary entries...") 976 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '()))) 977 (with-syntax-table diary-syntax-table 978 (dolist (date-form diary-date-forms) 979 (if (eq (car date-form) 'backup) 980 (setq date-form (cdr date-form))) ;; ignore 'backup directive 981 (let* ((dayname 982 (diary-name-pattern calendar-day-name-array 983 calendar-day-abbrev-array)) 984 (monthname 985 (format "%s\\|\\*" 986 (diary-name-pattern calendar-month-name-array 987 calendar-month-abbrev-array))) 988 (month "[0-9]+\\|\\*") 989 (day "[0-9]+\\|\\*") 990 (year "[0-9]+\\|\\*") 991 (l (length date-form)) 992 (d-name-pos (- l (length (memq 'dayname date-form)))) 993 (d-name-pos (if (/= l d-name-pos) (+ 2 d-name-pos))) 994 (m-name-pos (- l (length (memq 'monthname date-form)))) 995 (m-name-pos (if (/= l m-name-pos) (+ 2 m-name-pos))) 996 (d-pos (- l (length (memq 'day date-form)))) 997 (d-pos (if (/= l d-pos) (+ 2 d-pos))) 998 (m-pos (- l (length (memq 'month date-form)))) 999 (m-pos (if (/= l m-pos) (+ 2 m-pos))) 1000 (y-pos (- l (length (memq 'year date-form)))) 1001 (y-pos (if (/= l y-pos) (+ 2 y-pos))) 1002 (regexp 1003 (concat 1004 "\\(\\`\\|\^M\\|\n\\)\\(" 1005 (mapconcat 'eval date-form "\\)\\(") 1006 "\\)")) 1007 (case-fold-search t)) 1008 (goto-char (point-min)) 1009 (while (re-search-forward regexp nil t) 1010 (let* ((dd-name 1011 (if d-name-pos 1012 (match-string-no-properties d-name-pos))) 1013 (mm-name 1014 (if m-name-pos 1015 (match-string-no-properties m-name-pos))) 1016 (mm (string-to-number 1017 (if m-pos 1018 (match-string-no-properties m-pos) 1019 ""))) 1020 (dd (string-to-number 1021 (if d-pos 1022 (match-string-no-properties d-pos) 1023 ""))) 1024 (y-str (if y-pos 1025 (match-string-no-properties y-pos))) 1026 (yy (if (not y-str) 1027 0 1028 (if (and (= (length y-str) 2) 1029 abbreviated-calendar-year) 1030 (let* ((current-y 1031 (extract-calendar-year 1032 (calendar-current-date))) 1033 (y (+ (string-to-number y-str) 1034 (* 100 1035 (/ current-y 100))))) 1036 (if (> (- y current-y) 50) 1037 (- y 100) 1038 (if (> (- current-y y) 50) 1039 (+ y 100) 1040 y))) 1041 (string-to-number y-str))))) 1042 (let ((tmp (diary-pull-attrs (buffer-substring-no-properties 1043 (point) (line-end-position)) 1044 file-glob-attrs))) 1045 (setq entry (nth 0 tmp) 1046 marks (nth 1 tmp))) 1047 (if dd-name 1048 (mark-calendar-days-named 1049 (cdr (assoc-string 1050 dd-name 1051 (calendar-make-alist 1052 calendar-day-name-array 1053 0 nil calendar-day-abbrev-array) t)) marks) 1054 (if mm-name 1055 (setq mm 1056 (if (string-equal mm-name "*") 0 1057 (cdr (assoc-string 1058 mm-name 1059 (calendar-make-alist 1060 calendar-month-name-array 1061 1 nil calendar-month-abbrev-array) t))))) 1062 (mark-calendar-date-pattern mm dd yy marks)))))) 1063 (mark-sexp-diary-entries) 1064 (run-hooks 'nongregorian-diary-marking-hook 1065 'mark-diary-entries-hook)) 1066 (message "Marking diary entries...done"))))) 1067 1068(defun mark-sexp-diary-entries () 1069 "Mark days in the calendar window that have sexp diary entries. 1070Each entry in the diary file (or included files) visible in the calendar window 1071is marked. See the documentation for the function `list-sexp-diary-entries'." 1072 (let* ((sexp-mark (regexp-quote sexp-diary-entry-symbol)) 1073 (s-entry (concat "\\(\\`\\|\^M\\|\n\\)\\(" 1074 sexp-mark "(\\)\\|\\(" 1075 (regexp-quote diary-nonmarking-symbol) 1076 sexp-mark "(diary-remind\\)")) 1077 (file-glob-attrs (nth 1 (diary-pull-attrs nil '()))) 1078 m y first-date last-date mark file-glob-attrs) 1079 (with-current-buffer calendar-buffer 1080 (setq m displayed-month) 1081 (setq y displayed-year)) 1082 (increment-calendar-month m y -1) 1083 (setq first-date 1084 (calendar-absolute-from-gregorian (list m 1 y))) 1085 (increment-calendar-month m y 2) 1086 (setq last-date 1087 (calendar-absolute-from-gregorian 1088 (list m (calendar-last-day-of-month m y) y))) 1089 (goto-char (point-min)) 1090 (while (re-search-forward s-entry nil t) 1091 (setq marking-diary-entry (char-equal (preceding-char) ?\()) 1092 (re-search-backward "(") 1093 (let ((sexp-start (point)) 1094 sexp entry entry-start line-start marks) 1095 (forward-sexp) 1096 (setq sexp (buffer-substring-no-properties sexp-start (point))) 1097 (save-excursion 1098 (re-search-backward "\^M\\|\n\\|\\`") 1099 (setq line-start (point))) 1100 (forward-char 1) 1101 (if (and (or (char-equal (preceding-char) ?\^M) 1102 (char-equal (preceding-char) ?\n)) 1103 (not (looking-at " \\|\^I"))) 1104 (progn;; Diary entry consists only of the sexp 1105 (backward-char 1) 1106 (setq entry "")) 1107 (setq entry-start (point)) 1108 ;; Find end of entry 1109 (re-search-forward "\^M\\|\n" nil t) 1110 (while (looking-at " \\|\^I") 1111 (or (re-search-forward "\^M\\|\n" nil t) 1112 (re-search-forward "$" nil t))) 1113 (if (or (char-equal (preceding-char) ?\^M) 1114 (char-equal (preceding-char) ?\n)) 1115 (backward-char 1)) 1116 (setq entry (buffer-substring-no-properties entry-start (point))) 1117 (while (string-match "[\^M]" entry) 1118 (aset entry (match-beginning 0) ?\n ))) 1119 (calendar-for-loop date from first-date to last-date do 1120 (if (setq mark (diary-sexp-entry sexp entry 1121 (calendar-gregorian-from-absolute date))) 1122 (progn 1123 (setq marks (diary-pull-attrs entry file-glob-attrs) 1124 marks (nth 1 (diary-pull-attrs entry file-glob-attrs))) 1125 (mark-visible-calendar-date 1126 (calendar-gregorian-from-absolute date) 1127 (if (< 0 (length marks)) 1128 marks 1129 (if (consp mark) 1130 (car mark))))))))))) 1131 1132(defun mark-included-diary-files () 1133 "Mark the diary entries from other diary files with those of the diary file. 1134This function is suitable for use as the `mark-diary-entries-hook'; it enables 1135you to use shared diary files together with your own. The files included are 1136specified in the diary-file by lines of this form: 1137 #include \"filename\" 1138This is recursive; that is, #include directives in diary files thus included 1139are obeyed. You can change the `#include' to some other string by 1140changing the variable `diary-include-string'." 1141 (goto-char (point-min)) 1142 (while (re-search-forward 1143 (concat 1144 "\\(?:\\`\\|\^M\\|\n\\)" 1145 (regexp-quote diary-include-string) 1146 " \"\\([^\"]*\\)\"") 1147 nil t) 1148 (let* ((diary-file (substitute-in-file-name 1149 (match-string-no-properties 1))) 1150 (mark-diary-entries-hook 'mark-included-diary-files) 1151 (dbuff (find-buffer-visiting diary-file))) 1152 (if (file-exists-p diary-file) 1153 (if (file-readable-p diary-file) 1154 (progn 1155 (mark-diary-entries) 1156 (unless dbuff 1157 (kill-buffer (find-buffer-visiting diary-file)))) 1158 (beep) 1159 (message "Can't read included diary file %s" diary-file) 1160 (sleep-for 2)) 1161 (beep) 1162 (message "Can't find included diary file %s" diary-file) 1163 (sleep-for 2)))) 1164 (goto-char (point-min))) 1165 1166(defun mark-calendar-days-named (dayname &optional color) 1167 "Mark all dates in the calendar window that are day DAYNAME of the week. 11680 means all Sundays, 1 means all Mondays, and so on." 1169 (with-current-buffer calendar-buffer 1170 (let ((prev-month displayed-month) 1171 (prev-year displayed-year) 1172 (succ-month displayed-month) 1173 (succ-year displayed-year) 1174 (last-day) 1175 (day)) 1176 (increment-calendar-month succ-month succ-year 1) 1177 (increment-calendar-month prev-month prev-year -1) 1178 (setq day (calendar-absolute-from-gregorian 1179 (calendar-nth-named-day 1 dayname prev-month prev-year))) 1180 (setq last-day (calendar-absolute-from-gregorian 1181 (calendar-nth-named-day -1 dayname succ-month succ-year))) 1182 (while (<= day last-day) 1183 (mark-visible-calendar-date (calendar-gregorian-from-absolute day) color) 1184 (setq day (+ day 7)))))) 1185 1186(defun mark-calendar-date-pattern (month day year &optional color) 1187 "Mark all dates in the calendar window that conform to MONTH/DAY/YEAR. 1188A value of 0 in any position is a wildcard." 1189 (with-current-buffer calendar-buffer 1190 (let ((m displayed-month) 1191 (y displayed-year)) 1192 (increment-calendar-month m y -1) 1193 (calendar-for-loop i from 0 to 2 do 1194 (mark-calendar-month m y month day year color) 1195 (increment-calendar-month m y 1))))) 1196 1197(defun mark-calendar-month (month year p-month p-day p-year &optional color) 1198 "Mark dates in the MONTH/YEAR that conform to pattern P-MONTH/P_DAY/P-YEAR. 1199A value of 0 in any position of the pattern is a wildcard." 1200 (if (or (and (= month p-month) 1201 (or (= p-year 0) (= year p-year))) 1202 (and (= p-month 0) 1203 (or (= p-year 0) (= year p-year)))) 1204 (if (= p-day 0) 1205 (calendar-for-loop 1206 i from 1 to (calendar-last-day-of-month month year) do 1207 (mark-visible-calendar-date (list month i year) color)) 1208 (mark-visible-calendar-date (list month p-day year) color)))) 1209 1210(defun sort-diary-entries () 1211 "Sort the list of diary entries by time of day." 1212 (setq diary-entries-list (sort diary-entries-list 'diary-entry-compare))) 1213 1214(defun diary-entry-compare (e1 e2) 1215 "Returns t if E1 is earlier than E2." 1216 (or (calendar-date-compare e1 e2) 1217 (and (calendar-date-equal (car e1) (car e2)) 1218 (let* ((ts1 (cadr e1)) (t1 (diary-entry-time ts1)) 1219 (ts2 (cadr e2)) (t2 (diary-entry-time ts2))) 1220 (or (< t1 t2) 1221 (and (= t1 t2) 1222 (string-lessp ts1 ts2))))))) 1223 1224(defcustom diary-unknown-time 1225 -9999 1226 "Value returned by diary-entry-time when no time is found. 1227The default value -9999 causes entries with no recognizable time to be placed 1228before those with times; 9999 would place entries with no recognizable time 1229after those with times." 1230 :type 'integer 1231 :group 'diary 1232 :version "20.3") 1233 1234(defun diary-entry-time (s) 1235 "Return time at the beginning of the string S as a military-style integer. 1236For example, returns 1325 for 1:25pm. 1237 1238Returns `diary-unknown-time' (default value -9999) if no time is recognized. 1239The recognized forms are XXXX, X:XX, or XX:XX (military time), and XXam, 1240XXAM, XXpm, XXPM, XX:XXam, XX:XXAM XX:XXpm, or XX:XXPM. A period (.) can 1241be used instead of a colon (:) to separate the hour and minute parts." 1242 (let ((case-fold-search nil)) 1243 (cond ((string-match ; Military time 1244 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]?\\([0-9][0-9]\\)\\(\\>\\|[^ap]\\)" 1245 s) 1246 (+ (* 100 (string-to-number (match-string 1 s))) 1247 (string-to-number (match-string 2 s)))) 1248 ((string-match ; Hour only XXam or XXpm 1249 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)\\([ap]\\)m\\>" s) 1250 (+ (* 100 (% (string-to-number (match-string 1 s)) 12)) 1251 (if (equal ?a (downcase (aref s (match-beginning 2)))) 1252 0 1200))) 1253 ((string-match ; Hour and minute XX:XXam or XX:XXpm 1254 "\\`[ \t\n\\^M]*\\([0-9]?[0-9]\\)[:.]\\([0-9][0-9]\\)\\([ap]\\)m\\>" s) 1255 (+ (* 100 (% (string-to-number (match-string 1 s)) 12)) 1256 (string-to-number (match-string 2 s)) 1257 (if (equal ?a (downcase (aref s (match-beginning 3)))) 1258 0 1200))) 1259 (t diary-unknown-time)))) ; Unrecognizable 1260 1261;; Unrecognizable 1262 1263(defun list-sexp-diary-entries (date) 1264 "Add sexp entries for DATE from the diary file to `diary-entries-list'. 1265Also, Make them visible in the diary file. Returns t if any entries were 1266found. 1267 1268Sexp diary entries must be prefaced by a `sexp-diary-entry-symbol' (normally 1269`%%'). The form of a sexp diary entry is 1270 1271 %%(SEXP) ENTRY 1272 1273Both ENTRY and DATE are globally available when the SEXP is evaluated. If the 1274SEXP yields the value nil, the diary entry does not apply. If it yields a 1275non-nil value, ENTRY will be taken to apply to DATE; if the non-nil value is a 1276string, that string will be the diary entry in the fancy diary display. 1277 1278For example, the following diary entry will apply to the 21st of the month 1279if it is a weekday and the Friday before if the 21st is on a weekend: 1280 1281 &%%(let ((dayname (calendar-day-of-week date)) 1282 (day (extract-calendar-day date))) 1283 (or 1284 (and (= day 21) (memq dayname '(1 2 3 4 5))) 1285 (and (memq day '(19 20)) (= dayname 5))) 1286 ) UIUC pay checks deposited 1287 1288A number of built-in functions are available for this type of diary entry: 1289 1290 %%(diary-date MONTH DAY YEAR &optional MARK) text 1291 Entry applies if date is MONTH, DAY, YEAR if 1292 `european-calendar-style' is nil, and DAY, MONTH, YEAR if 1293 `european-calendar-style' is t. DAY, MONTH, and YEAR 1294 can be lists of integers, the constant t, or an integer. 1295 The constant t means all values. An optional parameter 1296 MARK specifies a face or single-character string to use 1297 when highlighting the day in the calendar. 1298 1299 %%(diary-float MONTH DAYNAME N &optional DAY MARK) text 1300 Entry will appear on the Nth DAYNAME of MONTH. 1301 (DAYNAME=0 means Sunday, 1 means Monday, and so on; 1302 if N is negative it counts backward from the end of 1303 the month. MONTH can be a list of months, a single 1304 month, or t to specify all months. Optional DAY means 1305 Nth DAYNAME of MONTH on or after/before DAY. DAY defaults 1306 to 1 if N>0 and the last day of the month if N<0. An 1307 optional parameter MARK specifies a face or single-character 1308 string to use when highlighting the day in the calendar. 1309 1310 %%(diary-block M1 D1 Y1 M2 D2 Y2 &optional MARK) text 1311 Entry will appear on dates between M1/D1/Y1 and M2/D2/Y2, 1312 inclusive. (If `european-calendar-style' is t, the 1313 order of the parameters should be changed to D1, M1, Y1, 1314 D2, M2, Y2.) An optional parameter MARK specifies a face 1315 or single-character string to use when highlighting the 1316 day in the calendar. 1317 1318 %%(diary-anniversary MONTH DAY YEAR &optional MARK) text 1319 Entry will appear on anniversary dates of MONTH DAY, YEAR. 1320 (If `european-calendar-style' is t, the order of the 1321 parameters should be changed to DAY, MONTH, YEAR.) Text 1322 can contain %d or %d%s; %d will be replaced by the number 1323 of years since the MONTH DAY, YEAR and %s will be replaced 1324 by the ordinal ending of that number (that is, `st', `nd', 1325 `rd' or `th', as appropriate. The anniversary of February 1326 29 is considered to be March 1 in a non-leap year. An 1327 optional parameter MARK specifies a face or single-character 1328 string to use when highlighting the day in the calendar. 1329 1330 %%(diary-cyclic N MONTH DAY YEAR &optional MARK) text 1331 Entry will appear every N days, starting MONTH DAY, YEAR. 1332 (If `european-calendar-style' is t, the order of the 1333 parameters should be changed to N, DAY, MONTH, YEAR.) Text 1334 can contain %d or %d%s; %d will be replaced by the number 1335 of repetitions since the MONTH DAY, YEAR and %s will 1336 be replaced by the ordinal ending of that number (that is, 1337 `st', `nd', `rd' or `th', as appropriate. An optional 1338 parameter MARK specifies a face or single-character string 1339 to use when highlighting the day in the calendar. 1340 1341 %%(diary-remind SEXP DAYS &optional MARKING) text 1342 Entry is a reminder for diary sexp SEXP. DAYS is either a 1343 single number or a list of numbers indicating the number(s) 1344 of days before the event that the warning(s) should occur. 1345 If the current date is (one of) DAYS before the event 1346 indicated by EXPR, then a suitable message (as specified 1347 by `diary-remind-message') appears. In addition to the 1348 reminders beforehand, the diary entry also appears on 1349 the date itself. If optional MARKING is non-nil then the 1350 *reminders* are marked on the calendar. Marking of 1351 reminders is independent of whether the entry *itself* is 1352 a marking or nonmarking one. 1353 1354 %%(diary-day-of-year) 1355 Diary entries giving the day of the year and the number of 1356 days remaining in the year will be made every day. Note 1357 that since there is no text, it makes sense only if the 1358 fancy diary display is used. 1359 1360 %%(diary-iso-date) 1361 Diary entries giving the corresponding ISO commercial date 1362 will be made every day. Note that since there is no text, 1363 it makes sense only if the fancy diary display is used. 1364 1365 %%(diary-french-date) 1366 Diary entries giving the corresponding French Revolutionary 1367 date will be made every day. Note that since there is no 1368 text, it makes sense only if the fancy diary display is used. 1369 1370 %%(diary-islamic-date) 1371 Diary entries giving the corresponding Islamic date will be 1372 made every day. Note that since there is no text, it 1373 makes sense only if the fancy diary display is used. 1374 1375 %%(diary-hebrew-date) 1376 Diary entries giving the corresponding Hebrew date will be 1377 made every day. Note that since there is no text, it 1378 makes sense only if the fancy diary display is used. 1379 1380 %%(diary-astro-day-number) Diary entries giving the corresponding 1381 astronomical (Julian) day number will be made every day. 1382 Note that since there is no text, it makes sense only if the 1383 fancy diary display is used. 1384 1385 %%(diary-julian-date) Diary entries giving the corresponding 1386 Julian date will be made every day. Note that since 1387 there is no text, it makes sense only if the fancy diary 1388 display is used. 1389 1390 %%(diary-sunrise-sunset) 1391 Diary entries giving the local times of sunrise and sunset 1392 will be made every day. Note that since there is no text, 1393 it makes sense only if the fancy diary display is used. 1394 Floating point required. 1395 1396 %%(diary-phases-of-moon) 1397 Diary entries giving the times of the phases of the moon 1398 will be when appropriate. Note that since there is no text, 1399 it makes sense only if the fancy diary display is used. 1400 Floating point required. 1401 1402 %%(diary-yahrzeit MONTH DAY YEAR) text 1403 Text is assumed to be the name of the person; the date is 1404 the date of death on the *civil* calendar. The diary entry 1405 will appear on the proper Hebrew-date anniversary and on the 1406 day before. (If `european-calendar-style' is t, the order 1407 of the parameters should be changed to DAY, MONTH, YEAR.) 1408 1409 %%(diary-rosh-hodesh) 1410 Diary entries will be made on the dates of Rosh Hodesh on 1411 the Hebrew calendar. Note that since there is no text, it 1412 makes sense only if the fancy diary display is used. 1413 1414 %%(diary-parasha) 1415 Diary entries giving the weekly parasha will be made on 1416 every Saturday. Note that since there is no text, it 1417 makes sense only if the fancy diary display is used. 1418 1419 %%(diary-omer) 1420 Diary entries giving the omer count will be made every day 1421 from Passover to Shavuot. Note that since there is no text, 1422 it makes sense only if the fancy diary display is used. 1423 1424Marking these entries is *extremely* time consuming, so these entries are 1425best if they are nonmarking." 1426 (let ((s-entry (concat "\\(\\`\\|\^M\\|\n\\)" 1427 (regexp-quote diary-nonmarking-symbol) 1428 "?" 1429 (regexp-quote sexp-diary-entry-symbol) 1430 "(")) 1431 entry-found file-glob-attrs marks) 1432 (goto-char (point-min)) 1433 (save-excursion 1434 (setq file-glob-attrs (nth 1 (diary-pull-attrs nil '())))) 1435 (while (re-search-forward s-entry nil t) 1436 (backward-char 1) 1437 (let ((sexp-start (point)) 1438 sexp entry specifier entry-start line-start) 1439 (forward-sexp) 1440 (setq sexp (buffer-substring-no-properties sexp-start (point))) 1441 (save-excursion 1442 (re-search-backward "\^M\\|\n\\|\\`") 1443 (setq line-start (point))) 1444 (setq specifier 1445 (buffer-substring-no-properties (1+ line-start) (point)) 1446 entry-start (1+ line-start)) 1447 (forward-char 1) 1448 (if (and (or (char-equal (preceding-char) ?\^M) 1449 (char-equal (preceding-char) ?\n)) 1450 (not (looking-at " \\|\^I"))) 1451 (progn;; Diary entry consists only of the sexp 1452 (backward-char 1) 1453 (setq entry "")) 1454 (setq entry-start (point)) 1455 (re-search-forward "\^M\\|\n" nil t) 1456 (while (looking-at " \\|\^I") 1457 (re-search-forward "\^M\\|\n" nil t)) 1458 (backward-char 1) 1459 (setq entry (buffer-substring-no-properties entry-start (point))) 1460 (while (string-match "[\^M]" entry) 1461 (aset entry (match-beginning 0) ?\n ))) 1462 (let ((diary-entry (diary-sexp-entry sexp entry date)) 1463 temp literal) 1464 (setq literal entry ; before evaluation 1465 entry (if (consp diary-entry) 1466 (cdr diary-entry) 1467 diary-entry)) 1468 (if diary-entry 1469 (progn 1470 (remove-overlays line-start (point) 'invisible 'diary) 1471 (if (< 0 (length entry)) 1472 (setq temp (diary-pull-attrs entry file-glob-attrs) 1473 entry (nth 0 temp) 1474 marks (nth 1 temp))))) 1475 (add-to-diary-list date 1476 entry 1477 specifier 1478 (if entry-start (copy-marker entry-start) 1479 nil) 1480 marks 1481 literal) 1482 (setq entry-found (or entry-found diary-entry))))) 1483 entry-found)) 1484 1485(defun diary-sexp-entry (sexp entry date) 1486 "Process a SEXP diary ENTRY for DATE." 1487 (let ((result (if calendar-debug-sexp 1488 (let ((stack-trace-on-error t)) 1489 (eval (car (read-from-string sexp)))) 1490 (condition-case nil 1491 (eval (car (read-from-string sexp))) 1492 (error 1493 (beep) 1494 (message "Bad sexp at line %d in %s: %s" 1495 (count-lines (point-min) (point)) 1496 diary-file sexp) 1497 (sleep-for 2)))))) 1498 (cond ((stringp result) result) 1499 ((and (consp result) 1500 (stringp (cdr result))) result) 1501 (result entry) 1502 (t nil)))) 1503 1504(defun diary-date (month day year &optional mark) 1505 "Specific date(s) diary entry. 1506Entry applies if date is MONTH, DAY, YEAR if `european-calendar-style' is nil, 1507and DAY, MONTH, YEAR if `european-calendar-style' is t. DAY, MONTH, and YEAR 1508can be lists of integers, the constant t, or an integer. The constant t means 1509all values. 1510 1511An optional parameter MARK specifies a face or single-character string to 1512use when highlighting the day in the calendar." 1513 (let ((dd (if european-calendar-style 1514 month 1515 day)) 1516 (mm (if european-calendar-style 1517 day 1518 month)) 1519 (m (extract-calendar-month date)) 1520 (y (extract-calendar-year date)) 1521 (d (extract-calendar-day date))) 1522 (if (and 1523 (or (and (listp dd) (memq d dd)) 1524 (equal d dd) 1525 (eq dd t)) 1526 (or (and (listp mm) (memq m mm)) 1527 (equal m mm) 1528 (eq mm t)) 1529 (or (and (listp year) (memq y year)) 1530 (equal y year) 1531 (eq year t))) 1532 (cons mark entry)))) 1533 1534(defun diary-block (m1 d1 y1 m2 d2 y2 &optional mark) 1535 "Block diary entry. 1536Entry applies if date is between, or on one of, two dates. 1537The order of the parameters is 1538M1, D1, Y1, M2, D2, Y2 if `european-calendar-style' is nil, and 1539D1, M1, Y1, D2, M2, Y2 if `european-calendar-style' is t. 1540 1541An optional parameter MARK specifies a face or single-character string to 1542use when highlighting the day in the calendar." 1543 1544 (let ((date1 (calendar-absolute-from-gregorian 1545 (if european-calendar-style 1546 (list d1 m1 y1) 1547 (list m1 d1 y1)))) 1548 (date2 (calendar-absolute-from-gregorian 1549 (if european-calendar-style 1550 (list d2 m2 y2) 1551 (list m2 d2 y2)))) 1552 (d (calendar-absolute-from-gregorian date))) 1553 (if (and (<= date1 d) (<= d date2)) 1554 (cons mark entry)))) 1555 1556(defun diary-float (month dayname n &optional day mark) 1557 "Floating diary entry--entry applies if date is the nth dayname of month. 1558Parameters are MONTH, DAYNAME, N. MONTH can be a list of months, the constant 1559t, or an integer. The constant t means all months. If N is negative, count 1560backward from the end of the month. 1561 1562An optional parameter DAY means the Nth DAYNAME on or after/before MONTH DAY. 1563Optional MARK specifies a face or single-character string to use when 1564highlighting the day in the calendar." 1565;; This is messy because the diary entry may apply, but the date on which it 1566;; is based can be in a different month/year. For example, asking for the 1567;; first Monday after December 30. For large values of |n| the problem is 1568;; more grotesque. 1569 (and (= dayname (calendar-day-of-week date)) 1570 (let* ((m (extract-calendar-month date)) 1571 (d (extract-calendar-day date)) 1572 (y (extract-calendar-year date)) 1573 (limit; last (n>0) or first (n<0) possible base date for entry 1574 (calendar-nth-named-absday (- n) dayname m y d)) 1575 (last-abs (if (> n 0) limit (+ limit 6))) 1576 (first-abs (if (> n 0) (- limit 6) limit)) 1577 (last (calendar-gregorian-from-absolute last-abs)) 1578 (first (calendar-gregorian-from-absolute first-abs)) 1579 ; m1, d1 is first possible base date 1580 (m1 (extract-calendar-month first)) 1581 (d1 (extract-calendar-day first)) 1582 (y1 (extract-calendar-year first)) 1583 ; m2, d2 is last possible base date 1584 (m2 (extract-calendar-month last)) 1585 (d2 (extract-calendar-day last)) 1586 (y2 (extract-calendar-year last))) 1587 (if (or (and (= m1 m2) ; only possible base dates in one month 1588 (or (eq month t) 1589 (if (listp month) 1590 (memq m1 month) 1591 (= m1 month))) 1592 (let ((d (or day (if (> n 0) 1593 1 1594 (calendar-last-day-of-month m1 y1))))) 1595 (and (<= d1 d) (<= d d2)))) 1596 ;; only possible base dates straddle two months 1597 (and (or (< y1 y2) 1598 (and (= y1 y2) (< m1 m2))) 1599 (or 1600 ;; m1, d1 works as a base date 1601 (and 1602 (or (eq month t) 1603 (if (listp month) 1604 (memq m1 month) 1605 (= m1 month))) 1606 (<= d1 (or day (if (> n 0) 1607 1 1608 (calendar-last-day-of-month m1 y1))))) 1609 ;; m2, d2 works as a base date 1610 (and (or (eq month t) 1611 (if (listp month) 1612 (memq m2 month) 1613 (= m2 month))) 1614 (<= (or day (if (> n 0) 1615 1 1616 (calendar-last-day-of-month m2 y2))) 1617 d2))))) 1618 (cons mark entry))))) 1619 1620 1621(defun diary-anniversary (month day &optional year mark) 1622 "Anniversary diary entry. 1623Entry applies if date is the anniversary of MONTH, DAY, YEAR if 1624`european-calendar-style' is nil, and DAY, MONTH, YEAR if 1625`european-calendar-style' is t. Diary entry can contain `%d' or `%d%s'; the 1626%d will be replaced by the number of years since the MONTH DAY, YEAR and the 1627%s will be replaced by the ordinal ending of that number (that is, `st', `nd', 1628`rd' or `th', as appropriate. The anniversary of February 29 is considered 1629to be March 1 in non-leap years. 1630 1631An optional parameter MARK specifies a face or single-character string to 1632use when highlighting the day in the calendar." 1633 (let* ((d (if european-calendar-style 1634 month 1635 day)) 1636 (m (if european-calendar-style 1637 day 1638 month)) 1639 (y (extract-calendar-year date)) 1640 (diff (if year (- y year) 100))) 1641 (if (and (= m 2) (= d 29) (not (calendar-leap-year-p y))) 1642 (setq m 3 1643 d 1)) 1644 (if (and (> diff 0) (calendar-date-equal (list m d y) date)) 1645 (cons mark (format entry diff (diary-ordinal-suffix diff)))))) 1646 1647(defun diary-cyclic (n month day year &optional mark) 1648 "Cycle diary entry--entry applies every N days starting at MONTH, DAY, YEAR. 1649If `european-calendar-style' is t, parameters are N, DAY, MONTH, YEAR. 1650ENTRY can contain `%d' or `%d%s'; the %d will be replaced by the number of 1651repetitions since the MONTH DAY, YEAR and %s will be replaced by the 1652ordinal ending of that number (that is, `st', `nd', `rd' or `th', as 1653appropriate. 1654 1655An optional parameter MARK specifies a face or single-character string to 1656use when highlighting the day in the calendar." 1657 (let* ((d (if european-calendar-style 1658 month 1659 day)) 1660 (m (if european-calendar-style 1661 day 1662 month)) 1663 (diff (- (calendar-absolute-from-gregorian date) 1664 (calendar-absolute-from-gregorian 1665 (list m d year)))) 1666 (cycle (/ diff n))) 1667 (if (and (>= diff 0) (zerop (% diff n))) 1668 (cons mark (format entry cycle (diary-ordinal-suffix cycle)))))) 1669 1670(defun diary-ordinal-suffix (n) 1671 "Ordinal suffix for N. (That is, `st', `nd', `rd', or `th', as appropriate.)" 1672 (if (or (memq (% n 100) '(11 12 13)) 1673 (< 3 (% n 10))) 1674 "th" 1675 (aref ["th" "st" "nd" "rd"] (% n 10)))) 1676 1677(defun diary-day-of-year () 1678 "Day of year and number of days remaining in the year of date diary entry." 1679 (calendar-day-of-year-string date)) 1680 1681(defcustom diary-remind-message 1682 '("Reminder: Only " 1683 (if (= 0 (% days 7)) 1684 (concat (int-to-string (/ days 7)) (if (= 7 days) " week" " weeks")) 1685 (concat (int-to-string days) (if (= 1 days) " day" " days"))) 1686 " until " 1687 diary-entry) 1688 "Pseudo-pattern giving form of reminder messages in the fancy diary 1689display. 1690 1691Used by the function `diary-remind', a pseudo-pattern is a list of 1692expressions that can involve the keywords `days' (a number), `date' (a list of 1693month, day, year), and `diary-entry' (a string)." 1694 :type 'sexp 1695 :group 'diary) 1696 1697(defun diary-remind (sexp days &optional marking) 1698 "Provide a reminder of a diary entry. 1699SEXP is a diary-sexp. DAYS is either a single number or a list of numbers 1700indicating the number(s) of days before the event that the warning(s) should 1701occur on. If the current date is (one of) DAYS before the event indicated by 1702SEXP, then a suitable message (as specified by `diary-remind-message' is 1703returned. 1704 1705In addition to the reminders beforehand, the diary entry also appears on the 1706date itself. 1707 1708A `diary-nonmarking-symbol' at the beginning of the line of the diary-remind 1709entry specifies that the diary entry (not the reminder) is non-marking. 1710Marking of reminders is independent of whether the entry itself is a marking 1711or nonmarking; if optional parameter MARKING is non-nil then the reminders are 1712marked on the calendar." 1713 (let ((diary-entry (eval sexp))) 1714 (cond 1715 ;; Diary entry applies on date 1716 ((and diary-entry 1717 (or (not marking-diary-entries) marking-diary-entry)) 1718 diary-entry) 1719 ;; Diary entry may apply to `days' before date 1720 ((and (integerp days) 1721 (not diary-entry); Diary entry does not apply to date 1722 (or (not marking-diary-entries) marking)) 1723 (let ((date (calendar-gregorian-from-absolute 1724 (+ (calendar-absolute-from-gregorian date) days)))) 1725 (when (setq diary-entry (eval sexp)) ; re-evaluate with adjusted date 1726 ;; Discard any mark portion from diary-anniversary, etc. 1727 (if (consp diary-entry) (setq diary-entry (cdr diary-entry))) 1728 (mapconcat 'eval diary-remind-message "")))) 1729 ;; Diary entry may apply to one of a list of days before date 1730 ((and (listp days) days) 1731 (or (diary-remind sexp (car days) marking) 1732 (diary-remind sexp (cdr days) marking)))))) 1733 1734(defun diary-redraw-calendar () 1735 "If `calendar-buffer' is live and diary entries are marked, redraw it." 1736 (and mark-diary-entries-in-calendar 1737 (save-excursion 1738 (redraw-calendar))) 1739 ;; Return value suitable for `write-contents-functions'. 1740 nil) 1741 1742(defun make-diary-entry (string &optional nonmarking file) 1743 "Insert a diary entry STRING which may be NONMARKING in FILE. 1744If omitted, NONMARKING defaults to nil and FILE defaults to 1745`diary-file'." 1746 (let ((pop-up-frames (window-dedicated-p (selected-window)))) 1747 (find-file-other-window (substitute-in-file-name (or file diary-file)))) 1748 (when (eq major-mode default-major-mode) (diary-mode)) 1749 (widen) 1750 (diary-unhide-everything) 1751 (goto-char (point-max)) 1752 (when (let ((case-fold-search t)) 1753 (search-backward "Local Variables:" 1754 (max (- (point-max) 3000) (point-min)) 1755 t)) 1756 (beginning-of-line) 1757 (insert "\n") 1758 (forward-line -1)) 1759 (insert 1760 (if (bolp) "" "\n") 1761 (if nonmarking diary-nonmarking-symbol "") 1762 string " ")) 1763 1764(defun insert-diary-entry (arg) 1765 "Insert a diary entry for the date indicated by point. 1766Prefix arg will make the entry nonmarking." 1767 (interactive "P") 1768 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t t) 1769 arg)) 1770 1771(defun insert-weekly-diary-entry (arg) 1772 "Insert a weekly diary entry for the day of the week indicated by point. 1773Prefix arg will make the entry nonmarking." 1774 (interactive "P") 1775 (make-diary-entry (calendar-day-name (calendar-cursor-to-date t)) 1776 arg)) 1777 1778(defun insert-monthly-diary-entry (arg) 1779 "Insert a monthly diary entry for the day of the month indicated by point. 1780Prefix arg will make the entry nonmarking." 1781 (interactive "P") 1782 (let ((calendar-date-display-form 1783 (if european-calendar-style 1784 '(day " * ") 1785 '("* " day)))) 1786 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t) 1787 arg))) 1788 1789(defun insert-yearly-diary-entry (arg) 1790 "Insert an annual diary entry for the day of the year indicated by point. 1791Prefix arg will make the entry nonmarking." 1792 (interactive "P") 1793 (let ((calendar-date-display-form 1794 (if european-calendar-style 1795 '(day " " monthname) 1796 '(monthname " " day)))) 1797 (make-diary-entry (calendar-date-string (calendar-cursor-to-date t) t) 1798 arg))) 1799 1800(defun insert-anniversary-diary-entry (arg) 1801 "Insert an anniversary diary entry for the date given by point. 1802Prefix arg will make the entry nonmarking." 1803 (interactive "P") 1804 (let ((calendar-date-display-form 1805 (if european-calendar-style 1806 '(day " " month " " year) 1807 '(month " " day " " year)))) 1808 (make-diary-entry 1809 (format "%s(diary-anniversary %s)" 1810 sexp-diary-entry-symbol 1811 (calendar-date-string (calendar-cursor-to-date t) nil t)) 1812 arg))) 1813 1814(defun insert-block-diary-entry (arg) 1815 "Insert a block diary entry for the days between the point and marked date. 1816Prefix arg will make the entry nonmarking." 1817 (interactive "P") 1818 (let ((calendar-date-display-form 1819 (if european-calendar-style 1820 '(day " " month " " year) 1821 '(month " " day " " year))) 1822 (cursor (calendar-cursor-to-date t)) 1823 (mark (or (car calendar-mark-ring) 1824 (error "No mark set in this buffer"))) 1825 start end) 1826 (if (< (calendar-absolute-from-gregorian mark) 1827 (calendar-absolute-from-gregorian cursor)) 1828 (setq start mark 1829 end cursor) 1830 (setq start cursor 1831 end mark)) 1832 (make-diary-entry 1833 (format "%s(diary-block %s %s)" 1834 sexp-diary-entry-symbol 1835 (calendar-date-string start nil t) 1836 (calendar-date-string end nil t)) 1837 arg))) 1838 1839(defun insert-cyclic-diary-entry (arg) 1840 "Insert a cyclic diary entry starting at the date given by point. 1841Prefix arg will make the entry nonmarking." 1842 (interactive "P") 1843 (let ((calendar-date-display-form 1844 (if european-calendar-style 1845 '(day " " month " " year) 1846 '(month " " day " " year)))) 1847 (make-diary-entry 1848 (format "%s(diary-cyclic %d %s)" 1849 sexp-diary-entry-symbol 1850 (calendar-read "Repeat every how many days: " 1851 (lambda (x) (> x 0))) 1852 (calendar-date-string (calendar-cursor-to-date t) nil t)) 1853 arg))) 1854 1855(defvar diary-mode-map 1856 (let ((map (make-sparse-keymap))) 1857 (define-key map "\C-c\C-s" 'diary-show-all-entries) 1858 (define-key map "\C-c\C-q" 'quit-window) 1859 map) 1860 "Keymap for `diary-mode'.") 1861 1862;;;###autoload 1863(define-derived-mode diary-mode fundamental-mode "Diary" 1864 "Major mode for editing the diary file." 1865 (set (make-local-variable 'font-lock-defaults) 1866 '(diary-font-lock-keywords t)) 1867 (add-to-invisibility-spec '(diary . nil)) 1868 (add-hook 'after-save-hook 'diary-redraw-calendar nil t) 1869 (if diary-header-line-flag 1870 (setq header-line-format diary-header-line-format))) 1871 1872 1873(defvar diary-fancy-date-pattern 1874 (concat 1875 (let ((dayname (diary-name-pattern calendar-day-name-array nil t)) 1876 (monthname (diary-name-pattern calendar-month-name-array nil t)) 1877 (day "[0-9]+") 1878 (month "[0-9]+") 1879 (year "-?[0-9]+")) 1880 (mapconcat 'eval calendar-date-display-form "")) 1881 ;; Optional ": holiday name" after the date. 1882 "\\(: .*\\)?") 1883 "Regular expression matching a date header in Fancy Diary.") 1884 1885(defconst diary-time-regexp 1886 ;; Accepted formats: 10:00 10.00 10h00 10h 10am 10:00am 10.00am 1887 ;; Use of "." as a separator annoyingly matches numbers, eg "123.45". 1888 ;; Hence often prefix this with "\\(^\\|\\s-\\)." 1889 (concat "[0-9]?[0-9]\\([AaPp][mM]\\|\\(" 1890 "[Hh]\\([0-9][0-9]\\)?\\|[:.][0-9][0-9]" 1891 "\\)\\([AaPp][Mm]\\)?\\)") 1892 "Regular expression matching a time of day.") 1893 1894(defface diary-anniversary '((t :inherit font-lock-keyword-face)) 1895 "Face used for anniversaries in the diary." 1896 :version "22.1" 1897 :group 'diary) 1898 1899(defface diary-time '((t :inherit font-lock-variable-name-face)) 1900 "Face used for times of day in the diary." 1901 :version "22.1" 1902 :group 'diary) 1903 1904(defvar fancy-diary-font-lock-keywords 1905 (list 1906 (list 1907 ;; Any number of " other holiday name" lines, followed by "==" line. 1908 (concat diary-fancy-date-pattern "\\(\n +.*\\)*\n=+$") 1909 '(0 (progn (put-text-property (match-beginning 0) (match-end 0) 1910 'font-lock-multiline t) 1911 diary-face))) 1912 '("^.*\\([aA]nniversary\\|[bB]irthday\\).*$" . 'diary-anniversary) 1913 '("^.*Yahrzeit.*$" . font-lock-reference-face) 1914 '("^\\(Erev \\)?Rosh Hodesh.*" . font-lock-function-name-face) 1915 '("^Day.*omer.*$" . font-lock-builtin-face) 1916 '("^Parashat.*$" . font-lock-comment-face) 1917 `(,(format "\\(^\\|\\s-\\)%s\\(-%s\\)?" diary-time-regexp 1918 diary-time-regexp) . 'diary-time)) 1919 "Keywords to highlight in fancy diary display") 1920 1921;; If region looks like it might start or end in the middle of a 1922;; multiline pattern, extend the region to encompass the whole pattern. 1923(defun diary-fancy-font-lock-fontify-region-function (beg end &optional verbose) 1924 "Function to use for `font-lock-fontify-region-function' in Fancy Diary. 1925Needed to handle multiline keyword in `fancy-diary-font-lock-keywords'." 1926 (goto-char beg) 1927 (forward-line 0) 1928 (if (looking-at "=+$") (forward-line -1)) 1929 (while (and (looking-at " +[^ ]") 1930 (zerop (forward-line -1)))) 1931 ;; This check not essential. 1932 (if (looking-at diary-fancy-date-pattern) 1933 (setq beg (line-beginning-position))) 1934 (goto-char end) 1935 (forward-line 0) 1936 (while (and (looking-at " +[^ ]") 1937 (zerop (forward-line 1)))) 1938 (if (looking-at "=+$") 1939 (setq end (line-beginning-position 2))) 1940 (font-lock-default-fontify-region beg end verbose)) 1941 1942(define-derived-mode fancy-diary-display-mode fundamental-mode 1943 "Diary" 1944 "Major mode used while displaying diary entries using Fancy Display." 1945 (set (make-local-variable 'font-lock-defaults) 1946 '(fancy-diary-font-lock-keywords 1947 t nil nil nil 1948 (font-lock-fontify-region-function 1949 . diary-fancy-font-lock-fontify-region-function))) 1950 (local-set-key "q" 'quit-window)) 1951 1952 1953(defun diary-font-lock-sexps (limit) 1954 "Recognize sexp diary entry for font-locking." 1955 (if (re-search-forward 1956 (concat "^" (regexp-quote diary-nonmarking-symbol) 1957 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)") 1958 limit t) 1959 (condition-case nil 1960 (save-restriction 1961 (narrow-to-region (point-min) limit) 1962 (let ((start (point))) 1963 (forward-sexp 1) 1964 (store-match-data (list start (point))) 1965 t)) 1966 (error t)))) 1967 1968(defun diary-font-lock-date-forms (month-array &optional symbol abbrev-array) 1969 "Create font-lock patterns for `diary-date-forms' using MONTH-ARRAY. 1970If given, optional SYMBOL must be a prefix to entries. 1971If optional ABBREV-ARRAY is present, the abbreviations constructed 1972from this array by the function `calendar-abbrev-construct' are 1973matched (with or without a final `.'), in addition to the full month 1974names." 1975 (let ((dayname (diary-name-pattern calendar-day-name-array 1976 calendar-day-abbrev-array t)) 1977 (monthname (format "\\(%s\\|\\*\\)" 1978 (diary-name-pattern month-array abbrev-array))) 1979 (month "\\([0-9]+\\|\\*\\)") 1980 (day "\\([0-9]+\\|\\*\\)") 1981 (year "-?\\([0-9]+\\|\\*\\)")) 1982 (mapcar (lambda (x) 1983 (cons 1984 (concat "^" (regexp-quote diary-nonmarking-symbol) "?" 1985 (if symbol (regexp-quote symbol) "") "\\(" 1986 (mapconcat 'eval 1987 ;; If backup, omit first item (backup) 1988 ;; and last item (not part of date) 1989 (if (equal (car x) 'backup) 1990 (nreverse (cdr (reverse (cdr x)))) 1991 x) 1992 "") 1993 ;; With backup, last item is not part of date 1994 (if (equal (car x) 'backup) 1995 (concat "\\)" (eval (car (reverse x)))) 1996 "\\)")) 1997 '(1 diary-face))) 1998 diary-date-forms))) 1999 2000(eval-when-compile (require 'cal-hebrew) 2001 (require 'cal-islam)) 2002 2003(defun diary-font-lock-keywords () 2004 "Return a value for the variable `diary-font-lock-keywords'." 2005 (append 2006 (diary-font-lock-date-forms calendar-month-name-array 2007 nil calendar-month-abbrev-array) 2008 (when (or (memq 'mark-hebrew-diary-entries 2009 nongregorian-diary-marking-hook) 2010 (memq 'list-hebrew-diary-entries 2011 nongregorian-diary-listing-hook)) 2012 (require 'cal-hebrew) 2013 (diary-font-lock-date-forms 2014 calendar-hebrew-month-name-array-leap-year 2015 hebrew-diary-entry-symbol)) 2016 (when (or (memq 'mark-islamic-diary-entries 2017 nongregorian-diary-marking-hook) 2018 (memq 'list-islamic-diary-entries 2019 nongregorian-diary-listing-hook)) 2020 (require 'cal-islam) 2021 (diary-font-lock-date-forms 2022 calendar-islamic-month-name-array 2023 islamic-diary-entry-symbol)) 2024 (list 2025 (cons 2026 (concat "^" (regexp-quote diary-include-string) ".*$") 2027 'font-lock-keyword-face) 2028 (cons 2029 (concat "^" (regexp-quote diary-nonmarking-symbol) 2030 "?\\(" (regexp-quote sexp-diary-entry-symbol) "\\)") 2031 '(1 font-lock-reference-face)) 2032 (cons 2033 (concat "^" (regexp-quote diary-nonmarking-symbol)) 2034 'font-lock-reference-face) 2035 (cons 2036 (concat "^" (regexp-quote diary-nonmarking-symbol) 2037 "?\\(" (regexp-quote hebrew-diary-entry-symbol) "\\)") 2038 '(1 font-lock-reference-face)) 2039 (cons 2040 (concat "^" (regexp-quote diary-nonmarking-symbol) 2041 "?\\(" (regexp-quote islamic-diary-entry-symbol) "\\)") 2042 '(1 font-lock-reference-face)) 2043 '(diary-font-lock-sexps . font-lock-keyword-face) 2044 `(,(concat "\\(^\\|\\s-\\)" 2045 diary-time-regexp "\\(-" diary-time-regexp "\\)?") 2046 . 'diary-time)))) 2047 2048(defvar diary-font-lock-keywords (diary-font-lock-keywords) 2049 "Forms to highlight in `diary-mode'.") 2050 2051;; Following code from Dave Love <fx@gnu.org>. 2052;; Import Outlook-format appointments from mail messages in Gnus or 2053;; Rmail using command `diary-from-outlook'. This, or the specialized 2054;; functions `diary-from-outlook-gnus' and `diary-from-outlook-rmail', 2055;; could be run from hooks to notice appointments automatically (in 2056;; which case they will prompt about adding to the diary). The 2057;; message formats recognized are customizable through 2058;; `diary-outlook-formats'. 2059 2060(defcustom diary-outlook-formats 2061 '( 2062 ;; When: 11 October 2001 12:00-14:00 (GMT) Greenwich Mean Time : Dublin, ... 2063 ;; [Current UK format? The timezone is meaningless. Sometimes the 2064 ;; Where is missing.] 2065 ("When: \\([0-9]+ [[:alpha:]]+ [0-9]+\\) \ 2066\\([^ ]+\\) [^\n]+ 2067\[^\n]+ 2068\\(?:Where: \\([^\n]+\\)\n+\\)? 2069\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*~\\*" 2070 . "\\1\n \\2 %s, \\3") 2071 ;; When: Tuesday, April 30, 2002 03:00 PM-03:30 PM (GMT) Greenwich Mean ... 2072 ;; [Old UK format?] 2073 ("^When: [[:alpha:]]+, \\([[:alpha:]]+\\) \\([0-9][0-9]*\\), \\([0-9]\\{4\\}\\) \ 2074\\([^ ]+\\) [^\n]+ 2075\[^\n]+ 2076\\(?:Where: \\([^\n]+\\)\\)?\n+" 2077 . "\\2 \\1 \\3\n \\4 %s, \\5") 2078 ( 2079 ;; German format, apparently. 2080 "^Zeit: [^ ]+, +\\([0-9]+\\)\. +\\([[:upper:]][[:lower:]][[:lower:]]\\)[^ ]* +\\([0-9]+\\) +\\([^ ]+\\).*$" 2081 . "\\1 \\2 \\3\n \\4 %s")) 2082 "Alist of regexps matching message text and replacement text. 2083 2084The regexp must match the start of the message text containing an 2085appointment, but need not include a leading `^'. If it matches the 2086current message, a diary entry is made from the corresponding 2087template. If the template is a string, it should be suitable for 2088passing to `replace-match', and so will have occurrences of `\\D' to 2089substitute the match for the Dth subexpression. It must also contain 2090a single `%s' which will be replaced with the text of the message's 2091Subject field. Any other `%' characters must be doubled, so that the 2092template can be passed to `format'. 2093 2094If the template is actually a function, it is called with the message 2095body text as argument, and may use `match-string' etc. to make a 2096template following the rules above." 2097 :type '(alist :key-type (regexp :tag "Regexp matching time/place") 2098 :value-type (choice 2099 (string :tag "Template for entry") 2100 (function :tag "Unary function providing template"))) 2101 :version "22.1" 2102 :group 'diary) 2103 2104 2105;; Dynamically bound. 2106(defvar body) 2107(defvar subject) 2108 2109(defun diary-from-outlook-internal (&optional test-only) 2110 "Snarf a diary entry from a message assumed to be from MS Outlook. 2111Assumes `body' is bound to a string comprising the body of the message and 2112`subject' is bound to a string comprising its subject. 2113Arg TEST-ONLY non-nil means return non-nil if and only if the 2114message contains an appointment, don't make a diary entry." 2115 (catch 'finished 2116 (let (format-string) 2117 (dotimes (i (length diary-outlook-formats)) 2118 (when (eq 0 (string-match (car (nth i diary-outlook-formats)) 2119 body)) 2120 (unless test-only 2121 (setq format-string (cdr (nth i diary-outlook-formats))) 2122 (save-excursion 2123 (save-window-excursion 2124 ;; Fixme: References to optional fields in the format 2125 ;; are treated literally, not replaced by the empty 2126 ;; string. I think this is an Emacs bug. 2127 (make-diary-entry 2128 (format (replace-match (if (functionp format-string) 2129 (funcall format-string body) 2130 format-string) 2131 t nil (match-string 0 body)) 2132 subject)) 2133 (save-buffer)))) 2134 (throw 'finished t)))) 2135 nil)) 2136 2137(defun diary-from-outlook (&optional noconfirm) 2138 "Maybe snarf diary entry from current Outlook-generated message. 2139Currently knows about Gnus and Rmail modes. Unless the optional 2140argument NOCONFIRM is non-nil (which is the case when this 2141function is called interactively), then if an entry is found the 2142user is asked to confirm its addition." 2143 (interactive "p") 2144 (let ((func (cond 2145 ((eq major-mode 'rmail-mode) 2146 #'diary-from-outlook-rmail) 2147 ((memq major-mode '(gnus-summary-mode gnus-article-mode)) 2148 #'diary-from-outlook-gnus) 2149 (t (error "Don't know how to snarf in `%s'" major-mode))))) 2150 (funcall func noconfirm))) 2151 2152 2153(defvar gnus-article-mime-handles) 2154(defvar gnus-article-buffer) 2155 2156(autoload 'gnus-fetch-field "gnus-util") 2157(autoload 'gnus-narrow-to-body "gnus") 2158(autoload 'mm-get-part "mm-decode") 2159 2160(defun diary-from-outlook-gnus (&optional noconfirm) 2161 "Maybe snarf diary entry from Outlook-generated message in Gnus. 2162Unless the optional argument NOCONFIRM is non-nil (which is the case when 2163this function is called interactively), then if an entry is found the 2164user is asked to confirm its addition. 2165Add this function to `gnus-article-prepare-hook' to notice appointments 2166automatically." 2167 (interactive "p") 2168 (with-current-buffer gnus-article-buffer 2169 (let ((subject (gnus-fetch-field "subject")) 2170 (body (if gnus-article-mime-handles 2171 ;; We're multipart. Don't get confused by part 2172 ;; buttons &c. Assume info is in first part. 2173 (mm-get-part (nth 1 gnus-article-mime-handles)) 2174 (save-restriction 2175 (gnus-narrow-to-body) 2176 (buffer-string))))) 2177 (when (diary-from-outlook-internal t) 2178 (when (or noconfirm (y-or-n-p "Snarf diary entry? ")) 2179 (diary-from-outlook-internal) 2180 (message "Diary entry added")))))) 2181 2182(custom-add-option 'gnus-article-prepare-hook 'diary-from-outlook-gnus) 2183 2184 2185(defvar rmail-buffer) 2186 2187(defun diary-from-outlook-rmail (&optional noconfirm) 2188 "Maybe snarf diary entry from Outlook-generated message in Rmail. 2189Unless the optional argument NOCONFIRM is non-nil (which is the case when 2190this function is called interactively), then if an entry is found the 2191user is asked to confirm its addition." 2192 (interactive "p") 2193 (with-current-buffer rmail-buffer 2194 (let ((subject (mail-fetch-field "subject")) 2195 (body (buffer-substring (save-excursion 2196 (rfc822-goto-eoh) 2197 (point)) 2198 (point-max)))) 2199 (when (diary-from-outlook-internal t) 2200 (when (or noconfirm (y-or-n-p "Snarf diary entry? ")) 2201 (diary-from-outlook-internal) 2202 (message "Diary entry added")))))) 2203 2204 2205(provide 'diary-lib) 2206 2207;; arch-tag: 22dd506e-2e33-410d-9ae1-095a0c1b2010 2208;;; diary-lib.el ends here 2209