lisp/calendar/cal-menu.el

   1 ;;; cal-menu.el --- calendar functions for menu bar and popup menu support
   2
   3 ;; Copyright (C) 1994, 1995, 2001, 2002, 2003, 2004, 2005, 2006, 2007
   4 ;;   Free Software Foundation, Inc.
   5
   6 ;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
   7 ;;      Lara Rios <lrios@coewl.cen.uiuc.edu>
   8 ;; Maintainer: Glenn Morris <rgm@gnu.org>
   9 ;; Keywords: calendar
  10 ;; Human-Keywords: calendar, popup menus, menu bar
  11
  12 ;; This file is part of GNU Emacs.
  13
  14 ;; GNU Emacs is free software; you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation; either version 3, or (at your option)
  17 ;; any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  27 ;; Boston, MA 02110-1301, USA.
  28
  29 ;;; Commentary:
  30
  31 ;; This collection of functions implements menu bar and popup menu support for
  32 ;; calendar.el.
  33
  34 ;;; Code:
  35
  36 (defvar displayed-year)
  37
  38 (defconst cal-menu-moon-menu
  39   '("Moon"
  40     ["Lunar Phases" calendar-phases-of-moon]))
  41
  42 (defconst cal-menu-diary-menu
  43   '("Diary"
  44     ["Other File" view-other-diary-entries]
  45     ["Cursor Date" diary-view-entries]
  46     ["Mark All" mark-diary-entries]
  47     ["Show All" diary-show-all-entries]
  48     ["Insert Diary Entry" insert-diary-entry]
  49     ["Insert Weekly" insert-weekly-diary-entry]
  50     ["Insert Monthly" insert-monthly-diary-entry]
  51     ["Insert Yearly" insert-yearly-diary-entry]
  52     ["Insert Anniversary" insert-anniversary-diary-entry]
  53     ["Insert Block" insert-block-diary-entry]
  54     ["Insert Cyclic" insert-cyclic-diary-entry]
  55     ("Insert Baha'i"
  56      [" " nil :suffix (calendar-bahai-date-string (calendar-cursor-to-date))]
  57      ["One time" diary-bahai-insert-entry]
  58      ["Monthly" diary-bahai-insert-monthly-entry]
  59      ["Yearly" diary-bahai-insert-yearly-entry])
  60     ("Insert Islamic"
  61      [" " nil :suffix (calendar-islamic-date-string (calendar-cursor-to-date))]
  62      ["One time" insert-islamic-diary-entry]
  63      ["Monthly" insert-monthly-islamic-diary-entry]
  64      ["Yearly" insert-yearly-islamic-diary-entry])
  65     ("Insert Hebrew"
  66      [" " nil :suffix (calendar-hebrew-date-string (calendar-cursor-to-date))]
  67      ["One time" insert-hebrew-diary-entry]
  68      ["Monthly" insert-monthly-hebrew-diary-entry]
  69      ["Yearly" insert-yearly-hebrew-diary-entry])))
  70
  71 (defun cal-menu-holiday-window-suffix ()
  72   (let ((my1 (calendar-increment-month -1))
  73         (my2 (calendar-increment-month 1)))
  74     (if (= (cdr my1) (cdr my2))
  75         (format "%s-%s, %d"
  76                 (calendar-month-name (car my1) 'abbrev)
  77                 (calendar-month-name (car my2) 'abbrev)
  78                 (cdr my2))
  79       (format "%s, %d-%s, %d"
  80               (calendar-month-name (car my1) 'abbrev)
  81               (cdr my1)
  82               (calendar-month-name (car my2) 'abbrev)
  83               (cdr my2)))))
  84
  85 (defconst cal-menu-holidays-menu
  86   `("Holidays"
  87     ["For Cursor Date -" calendar-cursor-holidays
  88      :suffix (calendar-date-string (calendar-cursor-to-date) t t)
  89      :visible (calendar-cursor-to-date)]
  90     ["For Window -" calendar-list-holidays
  91      :suffix (cal-menu-holiday-window-suffix)]
  92     ["For Today -" cal-menu-today-holidays
  93      :suffix (calendar-date-string (calendar-current-date) t t)]
  94     "--"
  95     ,@(let ((l ()))
  96         ;; Show 11 years--5 before, 5 after year of middle month.
  97         (dotimes (i 11)
  98           (push (vector "For Year"
  99                         `(lambda ()
 100                            (interactive)
 101                            (holiday-list (+ displayed-year ,(- i 5))
 102                                          (+ displayed-year ,(- i 5))))
 103                         :suffix `(number-to-string (+ displayed-year ,(- i 5))))
 104                 l))
 105         (nreverse l))
 106     "--"
 107     ["Unmark Calendar" calendar-unmark]
 108     ["Mark Holidays" mark-calendar-holidays]))
 109
 110 (defconst cal-menu-goto-menu
 111   '("Goto"
 112     ["Today" calendar-goto-today]
 113     ["Beginning of Week" calendar-beginning-of-week]
 114     ["End of Week" calendar-end-of-week]
 115     ["Beginning of Month" calendar-beginning-of-month]
 116     ["End of Month" calendar-end-of-month]
 117     ["Beginning of Year" calendar-beginning-of-year]
 118     ["End of Year" calendar-end-of-year]
 119     ["Other Date" calendar-goto-date]
 120     ["Day of Year" calendar-goto-day-of-year]
 121     ["ISO Week" calendar-goto-iso-week]
 122     ["ISO Date" calendar-goto-iso-date]
 123     ["Astronomical Date" calendar-goto-astro-day-number]
 124     ["Hebrew Date" calendar-goto-hebrew-date]
 125     ["Persian Date" calendar-goto-persian-date]
 126     ["Baha'i Date" calendar-bahai-goto-date]
 127     ["Islamic Date" calendar-goto-islamic-date]
 128     ["Julian Date" calendar-goto-julian-date]
 129     ["Chinese Date" calendar-goto-chinese-date]
 130     ["Coptic Date" calendar-goto-coptic-date]
 131     ["Ethiopic Date" calendar-goto-ethiopic-date]
 132     ("Mayan Date"
 133      ["Next Tzolkin" calendar-next-tzolkin-date]
 134      ["Previous Tzolkin" calendar-previous-tzolkin-date]
 135      ["Next Haab" calendar-next-haab-date]
 136      ["Previous Haab" calendar-previous-haab-date]
 137      ["Next Round" calendar-next-calendar-round-date]
 138      ["Previous Round" calendar-previous-calendar-round-date])
 139     ["French Date" calendar-goto-french-date]))
 140
 141 (defconst cal-menu-scroll-menu
 142   '("Scroll"
 143     ["Forward 1 Month" calendar-scroll-left]
 144     ["Forward 3 Months" calendar-scroll-left-three-months]
 145     ["Forward 1 Year" "4\C-v"]
 146     ["Backward 1 Month" calendar-scroll-right]
 147     ["Backward 3 Months" calendar-scroll-right-three-months]
 148     ["Backward 1 Year" "4\ev"]))
 149
 150 (defun cal-menu-x-popup-menu (position menu)
 151   "Like `x-popup-menu', but prints an error message if popup menus are
 152 not available."
 153   (if (display-popup-menus-p)
 154       (x-popup-menu position menu)
 155     (error "Popup menus are not available on this system")))
 156
 157 (defun cal-menu-list-holidays-year ()
 158   "Display a list of the holidays of the selected date's year."
 159   (interactive)
 160   (let ((year (extract-calendar-year (calendar-cursor-to-date))))
 161     (holiday-list year year)))
 162
 163 (defun cal-menu-list-holidays-following-year ()
 164   "Display a list of the holidays of the following year."
 165   (interactive)
 166   (let ((year (1+ (extract-calendar-year (calendar-cursor-to-date)))))
 167     (holiday-list year year)))
 168
 169 (defun cal-menu-list-holidays-previous-year ()
 170   "Display a list of the holidays of the previous year."
 171   (interactive)
 172   (let ((year (1- (extract-calendar-year (calendar-cursor-to-date)))))
 173     (holiday-list year year)))
 174
 175 (defun calendar-event-to-date (&optional error)
 176   "Date of last event.
 177 If event is not on a specific date, signals an error if optional parameter
 178 ERROR is t, otherwise just returns nil."
 179   (with-current-buffer
 180       (window-buffer (posn-window (event-start last-input-event)))
 181     (goto-char (posn-point (event-start last-input-event)))
 182     (calendar-cursor-to-date error)))
 183
 184 (defun calendar-mouse-sunrise/sunset ()
 185   "Show sunrise/sunset times for mouse-selected date."
 186   (interactive)
 187   (save-excursion
 188     (calendar-mouse-goto-date (calendar-event-to-date))
 189     (calendar-sunrise-sunset)))
 190
 191 (defun cal-menu-today-holidays ()
 192   "Show holidays for today's date."
 193   (interactive)
 194   (save-excursion
 195     (calendar-cursor-to-date (calendar-current-date))
 196     (calendar-cursor-holidays)))
 197
 198 (autoload 'calendar-check-holidays "holidays")
 199 (autoload 'diary-list-entries "diary-lib")
 200
 201 (defun calendar-mouse-holidays (&optional event)
 202   "Pop up menu of holidays for mouse selected date."
 203   (interactive "e")
 204   (let* ((date (calendar-event-to-date))
 205          (l (mapcar 'list (calendar-check-holidays date)))
 206          (selection
 207           (cal-menu-x-popup-menu
 208            event
 209            (list
 210             (format "Holidays for %s" (calendar-date-string date))
 211             (append
 212              (list (format "Holidays for %s" (calendar-date-string date)))
 213              (if l l '("None")))))))
 214     (and selection (call-interactively selection))))
 215
 216 (defun calendar-mouse-view-diary-entries (&optional date diary event)
 217   "Pop up menu of diary entries for mouse-selected date.
 218 Use optional DATE and alternative file DIARY.
 219
 220 Any holidays are shown if `holidays-in-diary-buffer' is t."
 221   (interactive "i\ni\ne")
 222   (let* ((date (or date (calendar-event-to-date)))
 223          (diary-file (if diary diary diary-file))
 224          (diary-list-include-blanks nil)
 225          (diary-display-hook 'ignore)
 226          (diary-entries
 227           (mapcar (lambda (x) (split-string (cadr x) "\n"))
 228                   (diary-list-entries date 1 'list-only)))
 229          (holidays (if holidays-in-diary-buffer
 230                        (calendar-check-holidays date)))
 231          (title (concat "Diary entries "
 232                         (if diary (format "from %s " diary) "")
 233                         "for "
 234                         (calendar-date-string date)))
 235          (selection
 236           (cal-menu-x-popup-menu
 237            event
 238            (list title
 239                  (append
 240                   (list title)
 241                   (mapcar (lambda (x) (list (concat "     " x))) holidays)
 242                   (if holidays
 243                       (list "--shadow-etched-in" "--shadow-etched-in"))
 244                   (if diary-entries
 245                       (mapcar 'list (apply 'append diary-entries))
 246                     '("None")))))))
 247     (and selection (call-interactively selection))))
 248
 249 (defun calendar-mouse-view-other-diary-entries ()
 250   "Pop up menu of diary entries from alternative file on mouse-selected date."
 251   (interactive)
 252   (calendar-mouse-view-diary-entries
 253    (calendar-event-to-date)
 254    (read-file-name "Enter diary file name: " default-directory nil t)))
 255
 256 (defun calendar-mouse-insert-diary-entry ()
 257   "Insert diary entry for mouse-selected date."
 258   (interactive)
 259   (save-excursion
 260     (calendar-mouse-goto-date (calendar-event-to-date))
 261     (insert-diary-entry nil)))
 262
 263 (defun calendar-mouse-set-mark ()
 264   "Mark the date under the cursor."
 265   (interactive)
 266   (save-excursion
 267     (calendar-mouse-goto-date (calendar-event-to-date))
 268     (calendar-set-mark nil)))
 269
 270 (defun cal-tex-mouse-day ()
 271   "Make a buffer with LaTeX commands for the day mouse is on."
 272   (interactive)
 273   (save-excursion
 274     (calendar-mouse-goto-date (calendar-event-to-date))
 275     (cal-tex-cursor-day nil)))
 276
 277 (defun cal-tex-mouse-week ()
 278   "One page calendar for week indicated by cursor.
 279 Holidays are included if `cal-tex-holidays' is t."
 280   (interactive)
 281   (save-excursion
 282     (calendar-mouse-goto-date (calendar-event-to-date))
 283     (cal-tex-cursor-week nil)))
 284
 285 (defun cal-tex-mouse-week2 ()
 286   "Make a buffer with LaTeX commands for the week cursor is on.
 287 The printed output will be on two pages."
 288   (interactive)
 289   (save-excursion
 290     (calendar-mouse-goto-date (calendar-event-to-date))
 291     (cal-tex-cursor-week2 nil)))
 292
 293 (defun cal-tex-mouse-week-iso ()
 294   "One page calendar for week indicated by cursor.
 295 Holidays are included if `cal-tex-holidays' is t."
 296   (interactive)
 297   (save-excursion
 298     (calendar-mouse-goto-date (calendar-event-to-date))
 299     (cal-tex-cursor-week-iso nil)))
 300
 301 (defun cal-tex-mouse-week-monday ()
 302   "One page calendar for week indicated by cursor."
 303   (interactive)
 304   (save-excursion
 305     (calendar-mouse-goto-date (calendar-event-to-date))
 306     (cal-tex-cursor-week-monday nil)))
 307
 308 (defun cal-tex-mouse-filofax-daily ()
 309   "Day-per-page Filofax calendar for week indicated by cursor."
 310   (interactive)
 311   (save-excursion
 312     (calendar-mouse-goto-date (calendar-event-to-date))
 313     (cal-tex-cursor-filofax-daily nil)))
 314
 315 (defun cal-tex-mouse-filofax-2week ()
 316   "One page Filofax calendar for week indicated by cursor."
 317   (interactive)
 318   (save-excursion
 319     (calendar-mouse-goto-date (calendar-event-to-date))
 320     (cal-tex-cursor-filofax-2week nil)))
 321
 322 (defun cal-tex-mouse-filofax-week ()
 323   "Two page Filofax calendar for week indicated by cursor."
 324   (interactive)
 325   (save-excursion
 326     (calendar-mouse-goto-date (calendar-event-to-date))
 327     (cal-tex-cursor-filofax-week nil)))
 328
 329 (defun cal-tex-mouse-month ()
 330   "Make a buffer with LaTeX commands for the month cursor is on.
 331 Calendar is condensed onto one page."
 332   (interactive)
 333   (save-excursion
 334     (calendar-mouse-goto-date (calendar-event-to-date))
 335     (cal-tex-cursor-month nil)))
 336
 337 (defun cal-tex-mouse-month-landscape ()
 338   "Make a buffer with LaTeX commands for the month cursor is on.
 339 The output is in landscape format, one month to a page."
 340   (interactive)
 341   (save-excursion
 342     (calendar-mouse-goto-date (calendar-event-to-date))
 343     (cal-tex-cursor-month-landscape nil)))
 344
 345 (defun cal-tex-mouse-year ()
 346   "Make a buffer with LaTeX commands for the year cursor is on."
 347   (interactive)
 348   (save-excursion
 349     (calendar-mouse-goto-date (calendar-event-to-date))
 350     (cal-tex-cursor-year nil)))
 351
 352 (defun cal-tex-mouse-filofax-year ()
 353   "Make a buffer with LaTeX commands for Filofax calendar of year cursor is on."
 354   (interactive)
 355   (save-excursion
 356     (calendar-mouse-goto-date (calendar-event-to-date))
 357     (cal-tex-cursor-filofax-year nil)))
 358
 359 (defun cal-tex-mouse-year-landscape ()
 360   "Make a buffer with LaTeX commands for the year cursor is on."
 361   (interactive)
 362   (save-excursion
 363     (calendar-mouse-goto-date (calendar-event-to-date))
 364     (cal-tex-cursor-year-landscape nil)))
 365
 366 (defun calendar-mouse-print-dates (&optional event)
 367   "Pop up menu of equivalent dates to mouse selected date."
 368   (interactive "e")
 369   (let* ((date (calendar-event-to-date))
 370         (selection
 371          (cal-menu-x-popup-menu
 372           event
 373           (list
 374            (concat (calendar-date-string date) " (Gregorian)")
 375            (append
 376             (list
 377              (concat (calendar-date-string date) " (Gregorian)")
 378              (list (calendar-day-of-year-string date))
 379              (list (format "ISO date: %s" (calendar-iso-date-string date)))
 380              (list (format "Julian date: %s"
 381                            (calendar-julian-date-string date)))
 382              (list
 383               (format "Astronomical (Julian) day number (at noon UTC): %s.0"
 384                            (calendar-astro-date-string date)))
 385              (list
 386               (format "Fixed (RD) date: %s"
 387                       (calendar-absolute-from-gregorian date)))
 388              (list (format "Hebrew date (before sunset): %s"
 389                            (calendar-hebrew-date-string date)))
 390              (list (format "Persian date: %s"
 391                            (calendar-persian-date-string date)))
 392              (list (format "Baha'i date (before sunset): %s"
 393                            (calendar-bahai-date-string date))))
 394             (let ((i (calendar-islamic-date-string date)))
 395               (if (not (string-equal i ""))
 396                   (list (list (format "Islamic date (before sunset): %s" i)))))
 397             (list
 398              (list (format "Chinese date: %s"
 399                            (calendar-chinese-date-string date))))
 400             ;; (list '("Chinese date (select to echo Chinese date)"
 401             ;;         . calendar-mouse-chinese-date))
 402             (let ((c (calendar-coptic-date-string date)))
 403               (if (not (string-equal c ""))
 404                   (list (list (format "Coptic date: %s" c)))))
 405             (let ((e (calendar-ethiopic-date-string date)))
 406               (if (not (string-equal e ""))
 407                   (list (list (format "Ethiopic date: %s" e)))))
 408             (let ((f (calendar-french-date-string date)))
 409               (if (not (string-equal f ""))
 410                   (list (list (format "French Revolutionary date: %s" f)))))
 411             (list
 412              (list
 413               (format "Mayan date: %s"
 414                       (calendar-mayan-date-string date)))))))))
 415         (and selection (call-interactively selection))))
 416
 417 (defun calendar-mouse-chinese-date ()
 418   "Show Chinese equivalent for mouse-selected date."
 419   (interactive)
 420   (save-excursion
 421     (calendar-mouse-goto-date (calendar-event-to-date))
 422     (calendar-print-chinese-date)))
 423
 424 (defun calendar-mouse-goto-date (date)
 425   (set-buffer (window-buffer (posn-window (event-start last-input-event))))
 426   (calendar-goto-date date))
 427
 428 (easy-menu-define cal-menu-context-mouse-menu nil
 429   "Pop up menu for Mouse-2 for selected date in the calendar window."
 430   '("foo" :filter cal-menu-set-date-title
 431     "--"
 432     ["Holidays" calendar-mouse-holidays]
 433     ["Mark date" calendar-mouse-set-mark]
 434     ["Sunrise/sunset" calendar-mouse-sunrise/sunset]
 435     ["Other calendars" calendar-mouse-print-dates]
 436     ("Prepare LaTeX buffer"
 437      ["Daily (1 page)" cal-tex-mouse-day]
 438      ["Weekly (1 page)" cal-tex-mouse-week]
 439      ["Weekly (2 pages)" cal-tex-mouse-week2]
 440      ["Weekly (other style; 1 page)" cal-tex-mouse-week-iso]
 441      ["Weekly (yet another style; 1 page)" cal-tex-mouse-week-monday]
 442      ["Monthly" cal-tex-mouse-month]
 443      ["Monthly (landscape)" cal-tex-mouse-month-landscape]
 444      ["Yearly" cal-tex-mouse-year]
 445      ["Yearly (landscape)" cal-tex-mouse-year-landscape]
 446      ("Filofax styles"
 447       ["Filofax Daily (one-day-per-page)" cal-tex-mouse-filofax-daily]
 448       ["Filofax Weekly (2-weeks-at-a-glance)" cal-tex-mouse-filofax-2week]
 449       ["Filofax Weekly (week-at-a-glance)" cal-tex-mouse-filofax-week]
 450       ["Filofax Yearly" cal-tex-mouse-filofax-year]))
 451     ["Diary entries" calendar-mouse-view-diary-entries]
 452     ["Insert diary entry" calendar-mouse-insert-diary-entry]
 453     ["Other diary file entries" calendar-mouse-view-other-diary-entries]))
 454
 455 (defun cal-menu-set-date-title (menu)
 456   (easy-menu-filter-return
 457    menu (calendar-date-string (calendar-event-to-date t) t nil)))
 458
 459 (easy-menu-define cal-menu-global-mouse-menu nil
 460   "Menu bound to a mouse event, not specific to the mouse-click location."
 461   '("Calendar"
 462     ["Scroll forward" calendar-scroll-left-three-months]
 463     ["Scroll backward" calendar-scroll-right-three-months]
 464     ["Mark diary entries" mark-diary-entries]
 465     ["List holidays" calendar-list-holidays]
 466     ["Mark holidays" calendar-mark-holidays]
 467     ["Unmark" calendar-unmark]
 468     ["Lunar phases" calendar-phases-of-moon]
 469     ["Show diary" diary-show-all-entries]
 470     ["Exit calendar" exit-calendar]))
 471
 472 (run-hooks 'cal-menu-load-hook)
 473
 474 (provide 'cal-menu)
 475
 476 ;; arch-tag: aa81cf73-ce89-48a4-97ec-9ef861e87fe9
 477 ;;; cal-menu.el ends here