cal-menu.el 17.8 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

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

;; Author: Edward M. Reingold <reingold@cs.uiuc.edu>
;;	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 37
(defvar displayed-year)

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
(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"
     [" " nil :suffix (calendar-bahai-date-string (calendar-cursor-to-date))]
57 58 59
     ["One time" diary-bahai-insert-entry]
     ["Monthly" diary-bahai-insert-monthly-entry]
     ["Yearly" diary-bahai-insert-yearly-entry])
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    ("Insert Islamic"
     [" " nil :suffix (calendar-islamic-date-string (calendar-cursor-to-date))]
     ["One time" insert-islamic-diary-entry]
     ["Monthly" insert-monthly-islamic-diary-entry]
     ["Yearly" insert-yearly-islamic-diary-entry])
    ("Insert Hebrew"
     [" " nil :suffix (calendar-hebrew-date-string (calendar-cursor-to-date))]
     ["One time" insert-hebrew-diary-entry]
     ["Monthly" insert-monthly-hebrew-diary-entry]
     ["Yearly" insert-yearly-hebrew-diary-entry])))

(defun cal-menu-holiday-window-suffix ()
  (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)))))

(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 97
     :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.
        (dotimes (i 11)
Mark A. Hershberger's avatar
Mark A. Hershberger committed
98 99 100 101 102
	  (let ((y (+ 2007 -5 i)))
	    (push (vector (format "For Year %s" y)
			  (list (list 'lambda 'nil '(interactive)
				      (list 'list-holidays y y))))
                l)))
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
        (nreverse l))
    "--"
    ["Unmark Calendar" calendar-unmark]
    ["Mark Holidays" mark-calendar-holidays]))

(defconst cal-menu-goto-menu
  '("Goto"
    ["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]
124
    ["Baha'i Date" calendar-bahai-goto-date]
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
    ["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"
141 142
    ["Forward 1 Month" calendar-scroll-left]
    ["Forward 3 Months" calendar-scroll-left-three-months]
143
    ["Forward 1 Year" "4\C-v"]
144 145
    ["Backward 1 Month" calendar-scroll-right]
    ["Backward 3 Months" calendar-scroll-right-three-months]
146
    ["Backward 1 Year" "4\ev"]))
147

148 149 150 151 152
(defun cal-menu-x-popup-menu (position menu)
  "Like `x-popup-menu', but prints an error message if popup menus are
not available."
  (if (display-popup-menus-p)
      (x-popup-menu position menu)
153
    (error "Popup menus are not available on this system")))
154

155 156 157 158
(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))))
159
    (holiday-list year year)))
160 161 162 163 164

(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)))))
165
    (holiday-list year year)))
166 167 168 169 170

(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)))))
171
    (holiday-list year year)))
172

173 174 175 176
(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
ERROR is t, otherwise just returns nil."
177 178
  (with-current-buffer
      (window-buffer (posn-window (event-start last-input-event)))
Richard M. Stallman's avatar
Richard M. Stallman committed
179
    (goto-char (posn-point (event-start last-input-event)))
180
    (calendar-cursor-to-date error)))
Richard M. Stallman's avatar
Richard M. Stallman committed
181 182 183 184 185

(defun calendar-mouse-sunrise/sunset ()
  "Show sunrise/sunset times for mouse-selected date."
  (interactive)
  (save-excursion
186
    (calendar-mouse-goto-date (calendar-event-to-date))
Richard M. Stallman's avatar
Richard M. Stallman committed
187 188
    (calendar-sunrise-sunset)))

189 190 191 192 193 194 195
(defun cal-menu-today-holidays ()
  "Show holidays for today's date."
  (interactive)
  (save-excursion
    (calendar-cursor-to-date (calendar-current-date))
    (calendar-cursor-holidays)))

196
(autoload 'calendar-check-holidays "holidays")
197 198
(autoload 'diary-list-entries "diary-lib")

199
(defun calendar-mouse-holidays (&optional event)
200
  "Pop up menu of holidays for mouse selected date."
201
  (interactive "e")
202
  (let* ((date (calendar-event-to-date))
203
         (l (mapcar 'list (calendar-check-holidays date)))
204
         (selection
205
          (cal-menu-x-popup-menu
206 207 208 209 210 211 212
           event
           (list
            (format "Holidays for %s" (calendar-date-string date))
            (append
             (list (format "Holidays for %s" (calendar-date-string date)))
             (if l l '("None")))))))
    (and selection (call-interactively selection))))
Richard M. Stallman's avatar
Richard M. Stallman committed
213

214
(defun calendar-mouse-view-diary-entries (&optional date diary event)
215 216 217 218
  "Pop up menu of diary entries for mouse-selected date.
Use optional DATE and alternative file DIARY.

Any holidays are shown if `holidays-in-diary-buffer' is t."
219
  (interactive "i\ni\ne")
220
  (let* ((date (or date (calendar-event-to-date)))
221 222 223 224
         (diary-file (if diary diary diary-file))
         (diary-list-include-blanks nil)
         (diary-display-hook 'ignore)
         (diary-entries
225
          (mapcar (lambda (x) (split-string (cadr x) "\n"))
226
                  (diary-list-entries date 1 'list-only)))
227
         (holidays (if holidays-in-diary-buffer
228
                       (calendar-check-holidays date)))
229 230 231 232
         (title (concat "Diary entries "
                        (if diary (format "from %s " diary) "")
                        "for "
                        (calendar-date-string date)))
233
         (selection
234
          (cal-menu-x-popup-menu
235
           event
236 237 238
           (list title
                 (append
                  (list title)
239
                  (mapcar (lambda (x) (list (concat "     " x))) holidays)
240 241 242
                  (if holidays
                      (list "--shadow-etched-in" "--shadow-etched-in"))
                  (if diary-entries
243
                      (mapcar 'list (apply 'append diary-entries))
244
                    '("None")))))))
245
    (and selection (call-interactively selection))))
Richard M. Stallman's avatar
Richard M. Stallman committed
246

247
(defun calendar-mouse-view-other-diary-entries ()
248
  "Pop up menu of diary entries from alternative file on mouse-selected date."
249
  (interactive)
250 251 252
  (calendar-mouse-view-diary-entries
   (calendar-event-to-date)
   (read-file-name "Enter diary file name: " default-directory nil t)))
253

254 255 256 257
(defun calendar-mouse-insert-diary-entry ()
  "Insert diary entry for mouse-selected date."
  (interactive)
  (save-excursion
258
    (calendar-mouse-goto-date (calendar-event-to-date))
259 260
    (insert-diary-entry nil)))

261 262 263 264
(defun calendar-mouse-set-mark ()
  "Mark the date under the cursor."
  (interactive)
  (save-excursion
265
    (calendar-mouse-goto-date (calendar-event-to-date))
266 267
    (calendar-set-mark nil)))

268 269 270 271
(defun cal-tex-mouse-day ()
  "Make a buffer with LaTeX commands for the day mouse is on."
  (interactive)
  (save-excursion
272
    (calendar-mouse-goto-date (calendar-event-to-date))
273 274 275 276 277 278 279
    (cal-tex-cursor-day nil)))

(defun cal-tex-mouse-week ()
  "One page calendar for week indicated by cursor.
Holidays are included if `cal-tex-holidays' is t."
  (interactive)
  (save-excursion
280
    (calendar-mouse-goto-date (calendar-event-to-date))
281 282 283 284 285 286 287
    (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
288
    (calendar-mouse-goto-date (calendar-event-to-date))
289 290
    (cal-tex-cursor-week2 nil)))

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

299
(defun cal-tex-mouse-week-monday ()
300 301 302
  "One page calendar for week indicated by cursor."
  (interactive)
  (save-excursion
303
    (calendar-mouse-goto-date (calendar-event-to-date))
304
    (cal-tex-cursor-week-monday nil)))
305

306 307 308 309 310 311 312
(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)))

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

320
(defun cal-tex-mouse-filofax-week ()
321 322 323
  "Two page Filofax calendar for week indicated by cursor."
  (interactive)
  (save-excursion
324
    (calendar-mouse-goto-date (calendar-event-to-date))
325
    (cal-tex-cursor-filofax-week nil)))
326 327 328 329 330 331

(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
332
    (calendar-mouse-goto-date (calendar-event-to-date))
333 334 335 336 337 338 339
    (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
340
    (calendar-mouse-goto-date (calendar-event-to-date))
341 342 343 344 345 346
    (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
347
    (calendar-mouse-goto-date (calendar-event-to-date))
348 349 350 351 352 353
    (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
354
    (calendar-mouse-goto-date (calendar-event-to-date))
355 356 357 358 359 360
    (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
361
    (calendar-mouse-goto-date (calendar-event-to-date))
362 363
    (cal-tex-cursor-year-landscape nil)))

364
(defun calendar-mouse-print-dates (&optional event)
Richard M. Stallman's avatar
Richard M. Stallman committed
365
  "Pop up menu of equivalent dates to mouse selected date."
366 367
  (interactive "e")
  (let* ((date (calendar-event-to-date))
368
        (selection
369
         (cal-menu-x-popup-menu
370 371
          event
          (list
372
           (concat (calendar-date-string date) " (Gregorian)")
373 374 375 376 377 378 379 380
           (append
            (list
             (concat (calendar-date-string date) " (Gregorian)")
             (list (calendar-day-of-year-string date))
             (list (format "ISO date: %s" (calendar-iso-date-string date)))
             (list (format "Julian date: %s"
                           (calendar-julian-date-string date)))
             (list
Edward M. Reingold's avatar
Edward M. Reingold committed
381
              (format "Astronomical (Julian) day number (at noon UTC): %s.0"
382
                           (calendar-astro-date-string date)))
383
             (list
384
              (format "Fixed (RD) date: %s"
385
                      (calendar-absolute-from-gregorian date)))
386
             (list (format "Hebrew date (before sunset): %s"
387 388
                           (calendar-hebrew-date-string date)))
             (list (format "Persian date: %s"
389 390 391
                           (calendar-persian-date-string date)))
             (list (format "Baha'i date (before sunset): %s"
                           (calendar-bahai-date-string date))))
392 393 394
            (let ((i (calendar-islamic-date-string date)))
              (if (not (string-equal i ""))
                  (list (list (format "Islamic date (before sunset): %s" i)))))
395 396 397
            (list
             (list (format "Chinese date: %s"
                           (calendar-chinese-date-string date))))
398 399
            ;; (list '("Chinese date (select to echo Chinese date)"
            ;;         . calendar-mouse-chinese-date))
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
            (let ((c (calendar-coptic-date-string date)))
              (if (not (string-equal c ""))
                  (list (list (format "Coptic date: %s" c)))))
            (let ((e (calendar-ethiopic-date-string date)))
              (if (not (string-equal e ""))
                  (list (list (format "Ethiopic date: %s" e)))))
            (let ((f (calendar-french-date-string date)))
              (if (not (string-equal f ""))
                  (list (list (format "French Revolutionary date: %s" f)))))
            (list
             (list
              (format "Mayan date: %s"
                      (calendar-mayan-date-string date)))))))))
        (and selection (call-interactively selection))))

415 416 417 418
(defun calendar-mouse-chinese-date ()
  "Show Chinese equivalent for mouse-selected date."
  (interactive)
  (save-excursion
419
    (calendar-mouse-goto-date (calendar-event-to-date))
420
    (calendar-print-chinese-date)))
Richard M. Stallman's avatar
Richard M. Stallman committed
421

422 423 424 425
(defun calendar-mouse-goto-date (date)
  (set-buffer (window-buffer (posn-window (event-start last-input-event))))
  (calendar-goto-date date))

426
(easy-menu-define cal-menu-context-mouse-menu nil
427
  "Pop up menu for Mouse-2 for selected date in the calendar window."
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
  '("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]))

(defun cal-menu-set-date-title (menu)
  (easy-menu-filter-return
   menu (calendar-date-string (calendar-event-to-date t) t nil)))

(easy-menu-define cal-menu-global-mouse-menu nil
  "Menu bound to a mouse event, not specific to the mouse-click location."
  '("Calendar"
460 461
    ["Scroll forward" calendar-scroll-left-three-months]
    ["Scroll backward" calendar-scroll-right-three-months]
462
    ["Mark diary entries" mark-diary-entries]
463 464
    ["List holidays" calendar-list-holidays]
    ["Mark holidays" calendar-mark-holidays]
465 466 467 468
    ["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
469 470 471 472 473

(run-hooks 'cal-menu-load-hook)

(provide 'cal-menu)

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