cal-menu.el 16.6 KB
Newer Older
Richard M. Stallman's avatar
Richard M. Stallman committed
1 2
;;; cal-menu.el --- calendar functions for menu bar and popup menu support

3 4
;; Copyright (C) 1994, 1995, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
;;   2008  Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
5 6

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
Glenn Morris's avatar
Glenn Morris committed
7
;;         Lara Rios <lrios@coewl.cen.uiuc.edu>
8
;; Maintainer: Glenn Morris <rgm@gnu.org>
Richard M. Stallman's avatar
Richard M. Stallman committed
9 10 11 12 13
;; Keywords: calendar
;; Human-Keywords: calendar, popup menus, menu bar

;; This file is part of GNU Emacs.

14 15
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
16
;; the Free Software Foundation; either version 3, or (at your option)
17 18
;; any later version.

Richard M. Stallman's avatar
Richard M. Stallman committed
19
;; GNU Emacs is distributed in the hope that it will be useful,
20 21 22 23 24
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
26 27
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Richard M. Stallman's avatar
Richard M. Stallman committed
28 29 30 31 32 33 34 35

;;; Commentary:

;; This collection of functions implements menu bar and popup menu support for
;; calendar.el.

;;; Code:

36
(require 'calendar)
Glenn Morris's avatar
Glenn Morris committed
37

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
(defconst cal-menu-moon-menu
  '("Moon"
    ["Lunar Phases" calendar-phases-of-moon]))

(defconst cal-menu-diary-menu
  '("Diary"
    ["Other File" view-other-diary-entries]
    ["Cursor Date" diary-view-entries]
    ["Mark All" mark-diary-entries]
    ["Show All" diary-show-all-entries]
    ["Insert Diary Entry" insert-diary-entry]
    ["Insert Weekly" insert-weekly-diary-entry]
    ["Insert Monthly" insert-monthly-diary-entry]
    ["Insert Yearly" insert-yearly-diary-entry]
    ["Insert Anniversary" insert-anniversary-diary-entry]
    ["Insert Block" insert-block-diary-entry]
    ["Insert Cyclic" insert-cyclic-diary-entry]
    ("Insert Baha'i"
56 57 58
     ["One time" diary-bahai-insert-entry]
     ["Monthly" diary-bahai-insert-monthly-entry]
     ["Yearly" diary-bahai-insert-yearly-entry])
59 60 61 62 63 64 65 66 67 68
    ("Insert Islamic"
     ["One time" insert-islamic-diary-entry]
     ["Monthly" insert-monthly-islamic-diary-entry]
     ["Yearly" insert-yearly-islamic-diary-entry])
    ("Insert Hebrew"
     ["One time" insert-hebrew-diary-entry]
     ["Monthly" insert-monthly-hebrew-diary-entry]
     ["Yearly" insert-yearly-hebrew-diary-entry])))

(defun cal-menu-holiday-window-suffix ()
69
  "Return a string suffix for the \"Window\" entry in `cal-menu-holidays-menu'."
70 71 72 73 74 75 76 77 78 79 80 81 82
  (let ((my1 (calendar-increment-month -1))
        (my2 (calendar-increment-month 1)))
    (if (= (cdr my1) (cdr my2))
        (format "%s-%s, %d"
                (calendar-month-name (car my1) 'abbrev)
                (calendar-month-name (car my2) 'abbrev)
                (cdr my2))
      (format "%s, %d-%s, %d"
              (calendar-month-name (car my1) 'abbrev)
              (cdr my1)
              (calendar-month-name (car my2) 'abbrev)
              (cdr my2)))))

83 84
(defvar displayed-year)                 ; from generate-calendar

85 86 87 88 89
(defconst cal-menu-holidays-menu
  `("Holidays"
    ["For Cursor Date -" calendar-cursor-holidays
     :suffix (calendar-date-string (calendar-cursor-to-date) t t)
     :visible (calendar-cursor-to-date)]
90
    ["For Window -" calendar-list-holidays
91 92 93 94 95 96
     :suffix (cal-menu-holiday-window-suffix)]
    ["For Today -" cal-menu-today-holidays
     :suffix (calendar-date-string (calendar-current-date) t t)]
    "--"
    ,@(let ((l ()))
        ;; Show 11 years--5 before, 5 after year of middle month.
97 98
        ;; We used to use :suffix rather than :label and bumped into
        ;; an easymenu bug:
99
        ;; http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01813.html
100
        ;; The bug has since been fixed.
101
        (dotimes (i 11)
102
          (push (vector (format "hol-year-%d" i)
103 104 105 106
                        `(lambda ()
                           (interactive)
                           (holiday-list (+ displayed-year ,(- i 5))
                                         (+ displayed-year ,(- i 5))))
107 108
                        :label `(format "For Year %d"
                                       (+ displayed-year ,(- i 5))))
109
                l))
110 111 112 113 114 115
        (nreverse l))
    "--"
    ["Unmark Calendar" calendar-unmark]
    ["Mark Holidays" mark-calendar-holidays]))

(defconst cal-menu-goto-menu
116
  '("Go To"
117 118 119 120 121 122 123 124 125 126 127 128 129 130
    ["Today" calendar-goto-today]
    ["Beginning of Week" calendar-beginning-of-week]
    ["End of Week" calendar-end-of-week]
    ["Beginning of Month" calendar-beginning-of-month]
    ["End of Month" calendar-end-of-month]
    ["Beginning of Year" calendar-beginning-of-year]
    ["End of Year" calendar-end-of-year]
    ["Other Date" calendar-goto-date]
    ["Day of Year" calendar-goto-day-of-year]
    ["ISO Week" calendar-goto-iso-week]
    ["ISO Date" calendar-goto-iso-date]
    ["Astronomical Date" calendar-goto-astro-day-number]
    ["Hebrew Date" calendar-goto-hebrew-date]
    ["Persian Date" calendar-goto-persian-date]
131
    ["Baha'i Date" calendar-bahai-goto-date]
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
    ["Islamic Date" calendar-goto-islamic-date]
    ["Julian Date" calendar-goto-julian-date]
    ["Chinese Date" calendar-goto-chinese-date]
    ["Coptic Date" calendar-goto-coptic-date]
    ["Ethiopic Date" calendar-goto-ethiopic-date]
    ("Mayan Date"
     ["Next Tzolkin" calendar-next-tzolkin-date]
     ["Previous Tzolkin" calendar-previous-tzolkin-date]
     ["Next Haab" calendar-next-haab-date]
     ["Previous Haab" calendar-previous-haab-date]
     ["Next Round" calendar-next-calendar-round-date]
     ["Previous Round" calendar-previous-calendar-round-date])
    ["French Date" calendar-goto-french-date]))

(defconst cal-menu-scroll-menu
  '("Scroll"
148 149
    ["Forward 1 Month" calendar-scroll-left]
    ["Forward 3 Months" calendar-scroll-left-three-months]
150
    ["Forward 1 Year" "4\C-v"]
151 152
    ["Backward 1 Month" calendar-scroll-right]
    ["Backward 3 Months" calendar-scroll-right-three-months]
153
    ["Backward 1 Year" "4\ev"]))
154

155
(defun cal-menu-x-popup-menu (position menu)
156 157
  "Like `x-popup-menu', but print an error message if popups are unavailable.
POSITION and MENU are passed to `x-popup-menu'."
158 159
  (if (display-popup-menus-p)
      (x-popup-menu position menu)
160
    (error "Popup menus are not available on this system")))
161

162 163 164 165
(defun cal-menu-list-holidays-year ()
  "Display a list of the holidays of the selected date's year."
  (interactive)
  (let ((year (extract-calendar-year (calendar-cursor-to-date))))
166
    (holiday-list year year)))
167 168 169 170 171

(defun cal-menu-list-holidays-following-year ()
  "Display a list of the holidays of the following year."
  (interactive)
  (let ((year (1+ (extract-calendar-year (calendar-cursor-to-date)))))
172
    (holiday-list year year)))
173 174 175 176 177

(defun cal-menu-list-holidays-previous-year ()
  "Display a list of the holidays of the previous year."
  (interactive)
  (let ((year (1- (extract-calendar-year (calendar-cursor-to-date)))))
178
    (holiday-list year year)))
179

180 181 182
(defun calendar-event-to-date (&optional error)
  "Date of last event.
If event is not on a specific date, signals an error if optional parameter
183
ERROR is non-nil, otherwise just returns nil."
184 185
  (with-current-buffer
      (window-buffer (posn-window (event-start last-input-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
186
    (goto-char (posn-point (event-start last-input-event)))
187
    (calendar-cursor-to-date error)))
Richard M. Stallman's avatar
Richard M. Stallman committed
188

189
(defun calendar-mouse-goto-date (date)
190
  "Go to DATE in the buffer specified by `last-input-event'."
191 192 193
  (set-buffer (window-buffer (posn-window (event-start last-input-event))))
  (calendar-goto-date date))

Richard M. Stallman's avatar
Richard M. Stallman committed
194 195 196 197
(defun calendar-mouse-sunrise/sunset ()
  "Show sunrise/sunset times for mouse-selected date."
  (interactive)
  (save-excursion
198
    (calendar-mouse-goto-date (calendar-event-to-date))
Richard M. Stallman's avatar
Richard M. Stallman committed
199 200
    (calendar-sunrise-sunset)))

201 202 203 204 205 206 207
(defun cal-menu-today-holidays ()
  "Show holidays for today's date."
  (interactive)
  (save-excursion
    (calendar-cursor-to-date (calendar-current-date))
    (calendar-cursor-holidays)))

208
(autoload 'calendar-check-holidays "holidays")
209 210
(autoload 'diary-list-entries "diary-lib")

211
(defun calendar-mouse-holidays (&optional event)
212 213
  "Pop up menu of holidays for mouse selected date.
EVENT is the event that invoked this command."
214
  (interactive "e")
215
  (let* ((date (calendar-event-to-date))
216
         (l (mapcar 'list (calendar-check-holidays date)))
217
         (title (format "Holidays for %s" (calendar-date-string date)))
218
         (selection
219
          (cal-menu-x-popup-menu
220
           event
221 222
           (list title
                 (append (list title) (or l '("None")))))))
223
    (and selection (call-interactively selection))))
Richard M. Stallman's avatar
Richard M. Stallman committed
224

225 226
(defvar holidays-in-diary-buffer)       ; only called from calendar.el

227
(defun calendar-mouse-view-diary-entries (&optional date diary event)
228
  "Pop up menu of diary entries for mouse-selected date.
229 230 231
Use optional DATE and alternative file DIARY.  EVENT is the event
that invoked this command.  Shows holidays if `holidays-in-diary-buffer'
is non-nil."
232
  (interactive "i\ni\ne")
233
  (let* ((date (or date (calendar-event-to-date)))
234
         (diary-file (or diary diary-file))
235 236 237
         (diary-list-include-blanks nil)
         (diary-display-hook 'ignore)
         (diary-entries
238
          (mapcar (lambda (x) (split-string (cadr x) "\n"))
239
                  (diary-list-entries date 1 'list-only)))
240
         (holidays (if holidays-in-diary-buffer
241
                       (calendar-check-holidays date)))
242 243 244 245
         (title (concat "Diary entries "
                        (if diary (format "from %s " diary) "")
                        "for "
                        (calendar-date-string date)))
246
         (selection
247
          (cal-menu-x-popup-menu
248
           event
249 250 251
           (list title
                 (append
                  (list title)
252
                  (mapcar (lambda (x) (list (concat "     " x))) holidays)
253 254 255
                  (if holidays
                      (list "--shadow-etched-in" "--shadow-etched-in"))
                  (if diary-entries
256
                      (mapcar 'list (apply 'append diary-entries))
257
                    '("None")))))))
258
    (and selection (call-interactively selection))))
Richard M. Stallman's avatar
Richard M. Stallman committed
259

260
(defun calendar-mouse-view-other-diary-entries ()
261
  "Pop up menu of diary entries from alternative file on mouse-selected date."
262
  (interactive)
263 264 265
  (calendar-mouse-view-diary-entries
   (calendar-event-to-date)
   (read-file-name "Enter diary file name: " default-directory nil t)))
266

267 268 269 270
(defun calendar-mouse-insert-diary-entry ()
  "Insert diary entry for mouse-selected date."
  (interactive)
  (save-excursion
271
    (calendar-mouse-goto-date (calendar-event-to-date))
272 273
    (insert-diary-entry nil)))

274 275 276 277
(defun calendar-mouse-set-mark ()
  "Mark the date under the cursor."
  (interactive)
  (save-excursion
278
    (calendar-mouse-goto-date (calendar-event-to-date))
279 280
    (calendar-set-mark nil)))

281 282 283 284
(defun cal-tex-mouse-day ()
  "Make a buffer with LaTeX commands for the day mouse is on."
  (interactive)
  (save-excursion
285
    (calendar-mouse-goto-date (calendar-event-to-date))
286 287 288 289
    (cal-tex-cursor-day nil)))

(defun cal-tex-mouse-week ()
  "One page calendar for week indicated by cursor.
290
Holidays are included if `cal-tex-holidays' is non-nil."
291 292
  (interactive)
  (save-excursion
293
    (calendar-mouse-goto-date (calendar-event-to-date))
294 295 296 297 298 299 300
    (cal-tex-cursor-week nil)))

(defun cal-tex-mouse-week2 ()
  "Make a buffer with LaTeX commands for the week cursor is on.
The printed output will be on two pages."
  (interactive)
  (save-excursion
301
    (calendar-mouse-goto-date (calendar-event-to-date))
302 303
    (cal-tex-cursor-week2 nil)))

304
(defun cal-tex-mouse-week-iso ()
305
  "One page calendar for week indicated by cursor.
306
Holidays are included if `cal-tex-holidays' is non-nil."
307 308
  (interactive)
  (save-excursion
309
    (calendar-mouse-goto-date (calendar-event-to-date))
310
    (cal-tex-cursor-week-iso nil)))
311

312
(defun cal-tex-mouse-week-monday ()
313 314 315
  "One page calendar for week indicated by cursor."
  (interactive)
  (save-excursion
316
    (calendar-mouse-goto-date (calendar-event-to-date))
317
    (cal-tex-cursor-week-monday nil)))
318

319 320 321 322 323 324 325
(defun cal-tex-mouse-filofax-daily ()
  "Day-per-page Filofax calendar for week indicated by cursor."
  (interactive)
  (save-excursion
    (calendar-mouse-goto-date (calendar-event-to-date))
    (cal-tex-cursor-filofax-daily nil)))

326
(defun cal-tex-mouse-filofax-2week ()
327 328 329
  "One page Filofax calendar for week indicated by cursor."
  (interactive)
  (save-excursion
330
    (calendar-mouse-goto-date (calendar-event-to-date))
331
    (cal-tex-cursor-filofax-2week nil)))
332

333
(defun cal-tex-mouse-filofax-week ()
334 335 336
  "Two page Filofax calendar for week indicated by cursor."
  (interactive)
  (save-excursion
337
    (calendar-mouse-goto-date (calendar-event-to-date))
338
    (cal-tex-cursor-filofax-week nil)))
339 340 341 342 343 344

(defun cal-tex-mouse-month ()
  "Make a buffer with LaTeX commands for the month cursor is on.
Calendar is condensed onto one page."
  (interactive)
  (save-excursion
345
    (calendar-mouse-goto-date (calendar-event-to-date))
346 347 348 349 350 351 352
    (cal-tex-cursor-month nil)))

(defun cal-tex-mouse-month-landscape ()
  "Make a buffer with LaTeX commands for the month cursor is on.
The output is in landscape format, one month to a page."
  (interactive)
  (save-excursion
353
    (calendar-mouse-goto-date (calendar-event-to-date))
354 355 356 357 358 359
    (cal-tex-cursor-month-landscape nil)))

(defun cal-tex-mouse-year ()
  "Make a buffer with LaTeX commands for the year cursor is on."
  (interactive)
  (save-excursion
360
    (calendar-mouse-goto-date (calendar-event-to-date))
361 362 363 364 365 366
    (cal-tex-cursor-year nil)))

(defun cal-tex-mouse-filofax-year ()
  "Make a buffer with LaTeX commands for Filofax calendar of year cursor is on."
  (interactive)
  (save-excursion
367
    (calendar-mouse-goto-date (calendar-event-to-date))
368 369 370 371 372 373
    (cal-tex-cursor-filofax-year nil)))

(defun cal-tex-mouse-year-landscape ()
  "Make a buffer with LaTeX commands for the year cursor is on."
  (interactive)
  (save-excursion
374
    (calendar-mouse-goto-date (calendar-event-to-date))
375 376
    (cal-tex-cursor-year-landscape nil)))

377
(defun calendar-mouse-print-dates (&optional event)
378 379
  "Pop up menu of equivalent dates to mouse selected date.
EVENT is the event that invoked this command."
380 381
  (interactive "e")
  (let* ((date (calendar-event-to-date))
382 383 384 385 386 387 388 389
         (title (format "%s (Gregorian)" (calendar-date-string date)))
         (selection
          (cal-menu-x-popup-menu
           event
           (list title
                 (append (list title)
                         (mapcar 'list (calendar-other-dates date)))))))
    (and selection (call-interactively selection))))
Richard M. Stallman's avatar
Richard M. Stallman committed
390

391 392 393 394 395
(defun cal-menu-set-date-title (menu)
  "Convert date of last event to title suitable for MENU."
  (easy-menu-filter-return
   menu (calendar-date-string (calendar-event-to-date t) t nil)))

396
(easy-menu-define cal-menu-context-mouse-menu nil
397
  "Pop up menu for Mouse-2 for selected date in the calendar window."
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  '("foo" :filter cal-menu-set-date-title
    "--"
    ["Holidays" calendar-mouse-holidays]
    ["Mark date" calendar-mouse-set-mark]
    ["Sunrise/sunset" calendar-mouse-sunrise/sunset]
    ["Other calendars" calendar-mouse-print-dates]
    ("Prepare LaTeX buffer"
     ["Daily (1 page)" cal-tex-mouse-day]
     ["Weekly (1 page)" cal-tex-mouse-week]
     ["Weekly (2 pages)" cal-tex-mouse-week2]
     ["Weekly (other style; 1 page)" cal-tex-mouse-week-iso]
     ["Weekly (yet another style; 1 page)" cal-tex-mouse-week-monday]
     ["Monthly" cal-tex-mouse-month]
     ["Monthly (landscape)" cal-tex-mouse-month-landscape]
     ["Yearly" cal-tex-mouse-year]
     ["Yearly (landscape)" cal-tex-mouse-year-landscape]
     ("Filofax styles"
      ["Filofax Daily (one-day-per-page)" cal-tex-mouse-filofax-daily]
      ["Filofax Weekly (2-weeks-at-a-glance)" cal-tex-mouse-filofax-2week]
      ["Filofax Weekly (week-at-a-glance)" cal-tex-mouse-filofax-week]
      ["Filofax Yearly" cal-tex-mouse-filofax-year]))
    ["Diary entries" calendar-mouse-view-diary-entries]
    ["Insert diary entry" calendar-mouse-insert-diary-entry]
    ["Other diary file entries" calendar-mouse-view-other-diary-entries]))

(easy-menu-define cal-menu-global-mouse-menu nil
  "Menu bound to a mouse event, not specific to the mouse-click location."
  '("Calendar"
426 427
    ["Scroll forward" calendar-scroll-left-three-months]
    ["Scroll backward" calendar-scroll-right-three-months]
428
    ["Mark diary entries" mark-diary-entries]
429 430
    ["List holidays" calendar-list-holidays]
    ["Mark holidays" calendar-mark-holidays]
431 432 433 434
    ["Unmark" calendar-unmark]
    ["Lunar phases" calendar-phases-of-moon]
    ["Show diary" diary-show-all-entries]
    ["Exit calendar" exit-calendar]))
Richard M. Stallman's avatar
Richard M. Stallman committed
435

436 437 438 439 440 441
;; Undocumented and probably useless.
(defvar cal-menu-load-hook nil
  "Hook run on loading of the `cal-menu' package.")
(make-obsolete-variable 'cal-menu-load-hook
                        "it will be removed in future." "23.1")

Richard M. Stallman's avatar
Richard M. Stallman committed
442 443 444 445
(run-hooks 'cal-menu-load-hook)

(provide 'cal-menu)

446
;; arch-tag: aa81cf73-ce89-48a4-97ec-9ef861e87fe9
Richard M. Stallman's avatar
Richard M. Stallman committed
447
;;; cal-menu.el ends here