├── nano-agenda.png ├── README.md ├── nano-agenda.el └── LICENSE.txt /nano-agenda.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rougier/nano-agenda/HEAD/nano-agenda.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## GNU Emacs / N Λ N O Agenda 2 | 3 | N Λ N O agenda is a minimal view of your org agenda files. It displays 4 | a calendar view of current month (or the month corresponding to the 5 | current selected date) alongside a view of your agenda displaying 6 | timestamped entries. 7 | 8 | ![](nano-agenda.png) 9 | -------------------------------------------------------------------------------- /nano-agenda.el: -------------------------------------------------------------------------------- 1 | ;;; nano-agenda.el --- N Λ N O agenda -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2021-2023 Free Software Foundation, Inc. 4 | 5 | ;; Maintainer: Nicolas P. Rougier 6 | ;; URL: https://github.com/rougier/nano-agenda 7 | ;; Version: 0.3 8 | ;; Package-Requires: ((emacs "27.1")) 9 | ;; Keywords: convenience, org-mode, org-agenda 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;; This file is free software; you can redistribute it and/or modify 14 | ;; it under the terms of the GNU General Public License as published by 15 | ;; the Free Software Foundation; either version 3, or (at your option) 16 | ;; any later version. 17 | 18 | ;; This file is distributed in the hope that it will be useful, 19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 | ;; GNU General Public License for more details. 22 | 23 | ;; For a full copy of the GNU General Public License 24 | ;; see . 25 | 26 | ;;; Commentary: 27 | ;; 28 | ;; N Λ N O agenda is a minimal view of your org agenda files. It 29 | ;; displays a calendar view of current month (or the month 30 | ;; corresponding to the current selected date) alongside a view of 31 | ;; your agenda displaying timestamped entries. The agenda can be 32 | ;; navigated using arrows keys and killed using "q", "return" or 33 | ;; "escape". 34 | ;; 35 | ;; Usage example: 36 | ;; 37 | ;; M-x: nano-agenda 38 | ;; 39 | ;;; NEWS: 40 | ;; 41 | ;; Version 0.3.2 42 | ;; - Possibiliy to select and edit entries 43 | ;; 44 | ;; Version 0.3.1 45 | ;; - Specific face and marker for deadlines 46 | ;; 47 | ;; Version 0.3.0 48 | ;; - Use of a single buffer for calendar + agenda 49 | ;; - Added palette choice for colorizing the calendar 50 | ;; 51 | ;; Version 0.2.2 52 | ;; - Better entries sorting 53 | ;; - Include non timestamped entries 54 | ;; 55 | ;; Version 0.2.1 56 | ;; - Removed ts requirements 57 | ;; 58 | ;; Version 0.2 59 | ;; - Removed ts (MELPA) dependency 60 | ;; 61 | ;; Version 0.1 62 | ;; - Submission to ELPA 63 | ;; 64 | ;;; Code 65 | (require 'org) 66 | (require 'cl-lib) 67 | (require 'org-agenda) 68 | (require 'org-duration) 69 | (require 'calendar) 70 | (require 'holidays) 71 | 72 | 73 | (defgroup nano-agenda nil 74 | "N Λ N O agenda" 75 | :group 'nano) 76 | 77 | (defgroup nano-agenda-faces nil 78 | "N Λ N O agenda faces" 79 | :group 'nano-agenda) 80 | 81 | (defvar nano-agenda--current-selection (current-time) 82 | "Current selected date") 83 | 84 | (defvar nano-agenda--entry-overlay nil 85 | "Current selected date") 86 | 87 | (defvar nano-agenda--entry-select-mode nil 88 | "Flag for entry selection mode") 89 | 90 | (defvar nano-agenda--busy-levels (list) 91 | "Cached list of (date busy-level) for internal use") 92 | 93 | (defcustom nano-agenda-today-symbol "•" 94 | "Symbol to show current day" 95 | :group 'nano-agenda) 96 | 97 | (defcustom nano-agenda-deadline-symbol "!" 98 | "Symbol to show a deadline in calendar" 99 | :group 'nano-agenda) 100 | 101 | (defcustom nano-agenda-separation " " 102 | "Separation string between calenda and agenda entries" 103 | :group 'nano-agenda) 104 | 105 | (defcustom nano-agenda-sort-function #'nano-agenda-default-sort-function 106 | "Function to sort a day's entries. 107 | This function takes an entries list and returns the list in the desired order." 108 | :group 'nano-agenda) 109 | 110 | (defcustom nano-agenda-filter-entry-predicate #'nano-agenda-filter-entry 111 | "Predicate to decide if entry will be shown in the nano-agenda buffer. 112 | This function takes an entry and the selected date. Returns a value if the entry 113 | should be shown, otherwise, returns nil." 114 | :group 'nano-agenda) 115 | 116 | ;; See https://material.io/design/color/the-color-system.html 117 | (defvar nano-agenda-palettes 118 | '((red . ("#FFEBEE" "#FFCDD2" "#EF9A9A" "#E57373" "#EF5350" 119 | "#F44336" "#E53935" "#D32F2F" "#C62828" "#B71C1C")) 120 | (pink . ("#FCE4EC" "#F8BBD0" "#F48FB1" "#F06292" "#EC407A" 121 | "#E91E63" "#D81B60" "#C2185B" "#AD1457" "#880E4F")) 122 | (purple . ("#F3E5F5" "#E1BEE7" "#CE93D8" "#BA68C8" "#AB47BC" 123 | "#9C27B0" "#8E24AA" "#7B1FA2" "#6A1B9A" "#4A148C")) 124 | (deep-purple . ("#EDE7F6" "#D1C4E9" "#B39DDB" "#9575CD" "#7E57C2" 125 | "#673AB7" "#5E35B1" "#512DA8" "#4527A0" "#311B92")) 126 | (indigo . ("#E8EAF6" "#C5CAE9" "#9FA8DA" "#7986CB" "#5C6BC0" 127 | "#3F51B5" "#3949AB" "#303F9F" "#283593" "#1A237E")) 128 | (blue . ("#E3F2FD" "#BBDEFB" "#90CAF9" "#64B5F6" "#42A5F5" 129 | "#2196F3" "#1E88E5" "#1976D2" "#1565C0" "#0D47A1")) 130 | (light-blue . ("#E1F5FE" "#B3E5FC" "#81D4FA" "#4FC3F7" "#29B6F6" 131 | "#03A9F4" "#039BE5" "#0288D1" "#0277BD" "#01579B")) 132 | (cyan . ("#E0F7FA" "#B2EBF2" "#80DEEA" "#4DD0E1" "#26C6DA" 133 | "#00BCD4" "#00ACC1" "#0097A7" "#00838F" "#006064")) 134 | (teal . ("#E0F2F1" "#B2DFDB" "#80CBC4" "#4DB6AC" "#26A69A" 135 | "#009688" "#00897B" "#00796B" "#00695C" "#004D40")) 136 | (green . ("#E8F5E9" "#C8E6C9" "#A5D6A7" "#81C784" "#66BB6A" 137 | "#4CAF50" "#43A047" "#388E3C" "#2E7D32" "#1B5E20")) 138 | (light-green . ("#F1F8E9" "#DCEDC8" "#C5E1A5" "#AED581" "#9CCC65" 139 | "#8BC34A" "#7CB342" "#689F38" "#558B2F" "#33691E")) 140 | (lime . ("#F9FBE7" "#F0F4C3" "#E6EE9C" "#DCE775" "#D4E157" 141 | "#CDDC39" "#C0CA33" "#AFB42B" "#9E9D24" "#827717")) 142 | (yellow . ("#FFFDE7" "#FFF9C4" "#FFF59D" "#FFF176" "#FFEE58" 143 | "#FFEB3B" "#FDD835" "#FBC02D" "#F9A825" "#F57F17")) 144 | (amber . ("#FFF8E1" "#FFECB3" "#FFE082" "#FFD54F" "#FFCA28" 145 | "#FFC107" "#FFB300" "#FFA000" "#FF8F00" "#FF6F00")) 146 | (orange . ("#FFF3E0" "#FFE0B2" "#FFCC80" "#FFB74D" "#FFA726" 147 | "#FF9800" "#FB8C00" "#F57C00" "#EF6C00" "#E65100")) 148 | (deep-orange . ("#FBE9E7" "#FFCCBC" "#FFAB91" "#FF8A65" "#FF7043" 149 | "#FF5722" "#F4511E" "#E64A19" "#D84315" "#BF360C")) 150 | (brown . ("#EFEBE9" "#D7CCC8" "#BCAAA4" "#A1887F" "#8D6E63" 151 | "#795548" "#6D4C41" "#5D4037" "#4E342E" "#3E2723")) 152 | (grey . ("#FAFAFA" "#F5F5F5" "#EEEEEE" "#E0E0E0" "#BDBDBD" 153 | "#9E9E9E" "#757575" "#616161" "#424242" "#212121")) 154 | (blue-grey . ("#ECEFF1" "#CFD8DC" "#B0BEC5" "#90A4AE" "#78909C" 155 | "#607D8B" "#546E7A" "#455A64" "#37474F" "#263238")))) 156 | 157 | 158 | (defun nano-agenda-color-luminance (color) 159 | "Calculate the relative luminance of a color string (e.g. \"#ffaa00\", \"blue\"). 160 | Return a value between 0 and 1." 161 | (let* ((values (x-color-values color)) 162 | (red (/ (car values) 256.0)) 163 | (green (/ (cadr values) 256.0)) 164 | (blue (/ (caddr values) 256.0))) 165 | (/ (+ (* .2126 red) (* .7152 green) (* .0722 blue)) 255))) 166 | 167 | (defcustom nano-agenda-palette 'amber 168 | "Background colors to use to highlight a day in calendar 169 | view according to busy level." 170 | :type `(choice (const red) (const pink) (const purple) (const deep-purple) 171 | (const indigo) (const blue) (const light-blue) (const cyan) 172 | (const teal) (const green) (const light-green) (const lime) 173 | (const yellow) (const amber) (const orange) (const deep-orange) 174 | (const brown) (const grey) (const blue-grey)) 175 | :group 'nano-agenda-faces) 176 | 177 | (defface nano-agenda-default 178 | '((t :inherit default)) 179 | "Default face (for casual day)" 180 | :group 'nano-agenda-faces) 181 | 182 | (defface nano-agenda-selected 183 | '((t :inherit default :inverse-video t)) 184 | "Face for the selected day" 185 | :group 'nano-agenda-faces) 186 | 187 | (defface nano-agenda-time 188 | '((t :inherit font-lock-comment-face)) 189 | "Time face" 190 | :group 'nano-agenda-faces) 191 | 192 | (defface nano-agenda-current-day 193 | '((t :inherit bold)) 194 | "Current day face" 195 | :group 'nano-agenda-faces) 196 | 197 | (defface nano-agenda-weekend 198 | '((t :inherit font-lock-comment-face)) 199 | "Weekend face" 200 | :group 'nano-agenda-faces) 201 | 202 | (defface nano-agenda-holidays 203 | '((t :inherit font-lock-comment-face)) 204 | "Holidays face" 205 | :group 'nano-agenda-faces) 206 | 207 | (defface nano-agenda-outday 208 | '((t :inherit font-lock-comment-face)) 209 | "Out day face, that is, day outside curent month." 210 | :group 'nano-agenda-faces) 211 | 212 | (defface nano-agenda-day-name 213 | '((t :inherit font-lock-comment-face)) 214 | "Day name face (on second line)" 215 | :group 'nano-agenda-faces) 216 | 217 | (defface nano-agenda-month-name 218 | '((t :inherit bold)) 219 | "Month name face (on first line)" 220 | :group 'nano-agenda-faces) 221 | 222 | (defface nano-agenda-mouse 223 | '((t :inherit 'highlight )) 224 | "Mouse highlight face" 225 | :group 'nano-agenda-faces) 226 | 227 | (defface nano-agenda-button 228 | '((t :inherit font-lock-comment-face)) 229 | "Header button (left and right)" 230 | :group 'nano-agenda-faces) 231 | 232 | (defun nano-agenda-date (year month day) 233 | "Return a date correspondng to DAY/MONTH/YEAR." 234 | (encode-time 0 0 0 day month year)) 235 | 236 | (defun nano-agenda-date-equal (date1 date2) 237 | "Check if DATE1 is equal to DATE2." 238 | (and (eq (nano-agenda-date-day date1) 239 | (nano-agenda-date-day date2)) 240 | (eq (nano-agenda-date-month date1) 241 | (nano-agenda-date-month date2)) 242 | (eq (nano-agenda-date-year date1) 243 | (nano-agenda-date-year date2)))) 244 | 245 | (defun nano-agenda-date-inc (date &optional days months years) 246 | "Return DATE + DAYS day & MONTH months & YEARS years" 247 | (let ((days (or days 0)) 248 | (months (or months 0)) 249 | (years (or years 0)) 250 | (day (nano-agenda-date-day date)) 251 | (month (nano-agenda-date-month date)) 252 | (year (nano-agenda-date-year date))) 253 | (encode-time 0 0 0 (+ day days) (+ month months) (+ year years)))) 254 | 255 | (defun nano-agenda-date-dec (date &optional days months years) 256 | "Return DATE - DAYS day & MONTH months & YEARS years" 257 | (let ((days (or days 0)) 258 | (months (or months 0)) 259 | (years (or years 0))) 260 | (nano-agenda-date-inc date (- days) (- months) (- years)))) 261 | 262 | (defvar nano-agenda-hook nil 263 | "Normal hook run after agenda is build") 264 | 265 | (defvar nano-agenda-update-hook nil 266 | "Normal hook run after agenda is updated") 267 | 268 | (defvar nano-agenda-entry-edit-hook nil 269 | "Normal hook run after the editing buffer is shown") 270 | 271 | (defun nano-agenda-date-day (date) 272 | "Return DATE day of month (1-31)." 273 | (nth 3 (decode-time date))) 274 | 275 | (defun nano-agenda-date-month (date) 276 | "Return DATE month number (1-12)." 277 | (nth 4 (decode-time date))) 278 | 279 | (defun nano-agenda-date-year (date) 280 | "Return DATE year." 281 | (nth 5 (decode-time date))) 282 | 283 | (defun nano-agenda-date-doy (date) 284 | "Return DATE day of year (1-366)." 285 | (string-to-number (format-time-string "%j" date))) 286 | 287 | (defun nano-agenda-date-dow (date) 288 | "Return DATE day of week (0-6)." 289 | (nth 6 (decode-time date))) 290 | 291 | (defun nano-agenda-date-day-name (date) 292 | "Return DATE full day name." 293 | (format-time-string "%A" date)) 294 | 295 | (defun nano-agenda-date-month-name (date) 296 | "Return DATE full month name." 297 | (format-time-string "%B" date)) 298 | 299 | (defun nano-agenda-date-is-today (date) 300 | "Check if DATE is today." 301 | (nano-agenda-date-equal (current-time) date)) 302 | 303 | (defun nano-agenda-date-today () 304 | "Return today date." 305 | (current-time)) 306 | 307 | (defun nano-agenda-date-tomorrow () 308 | "Return tomorrow date." 309 | (nano-agenda-date-inc (nano-agenda-date-today) 1 0 0)) 310 | 311 | (defun nano-agenda-yesterday () 312 | "Return yesterday date." 313 | (nano-agenda-date-dec (nano-agenda-date-today) 1 0 0)) 314 | 315 | (defun nano-agenda-forward-day () 316 | "Move to next day in calendar" 317 | 318 | (interactive) 319 | (unless nano-agenda--entry-select-mode 320 | (setq nano-agenda--current-selection 321 | (nano-agenda-date-inc nano-agenda--current-selection 1)) 322 | (nano-agenda-update))) 323 | 324 | (defun nano-agenda-backward-day () 325 | "Move to previous day in calendar" 326 | 327 | (interactive) 328 | (unless nano-agenda--entry-select-mode 329 | (setq nano-agenda--current-selection 330 | (nano-agenda-date-dec nano-agenda--current-selection 1)) 331 | (nano-agenda-update))) 332 | 333 | (defun nano-agenda-forward-week () 334 | "Move to next week in calendar or next entry when 335 | entry-select-mode is active" 336 | 337 | (interactive) 338 | (if nano-agenda--entry-select-mode 339 | (nano-agenda-goto-next-entry) 340 | (progn (setq nano-agenda--current-selection 341 | (nano-agenda-date-inc nano-agenda--current-selection 7)) 342 | (nano-agenda-update)))) 343 | 344 | (defun nano-agenda-backward-week () 345 | "Move to previous week in calendar or previous entry when 346 | entry-select-mode is active" 347 | 348 | (interactive) 349 | (if nano-agenda--entry-select-mode 350 | (nano-agenda-goto-prev-entry) 351 | (progn 352 | (setq nano-agenda--current-selection 353 | (nano-agenda-date-dec nano-agenda--current-selection 7)) 354 | (nano-agenda-update)))) 355 | 356 | (defun nano-agenda-forward-month () 357 | "Move to next month in calendar" 358 | 359 | (interactive) 360 | (unless nano-agenda--entry-select-mode 361 | (setq nano-agenda--current-selection 362 | (nano-agenda-date-inc nano-agenda--current-selection 0 1)) 363 | (nano-agenda-update))) 364 | 365 | (defun nano-agenda-backward-month () 366 | "Move to previous month in calendar" 367 | 368 | (interactive) 369 | (unless nano-agenda--entry-select-mode 370 | (setq nano-agenda--current-selection 371 | (nano-agenda-date-dec nano-agenda--current-selection 0 1)) 372 | (nano-agenda-update))) 373 | 374 | (defun nano-agenda-forward-year () 375 | "Move to next year in calendar" 376 | 377 | (interactive) 378 | (unless nano-agenda--entry-select-mode 379 | (setq nano-agenda--current-selection 380 | (nano-agenda-date-inc nano-agenda--current-selection 0 0 1)) 381 | (nano-agenda-update))) 382 | 383 | (defun nano-agenda-backward-year () 384 | "Move to previous year in calendar" 385 | 386 | (interactive) 387 | (unless nano-agenda--entry-select-mode 388 | (setq nano-agenda--current-selection 389 | (nano-agenda-date-dec nano-agenda--current-selection 0 0 1)) 390 | (nano-agenda-update))) 391 | 392 | (defun nano-agenda-goto-today () 393 | "Goto current day in calendar" 394 | 395 | (interactive) 396 | (unless nano-agenda--entry-select-mode 397 | (setq nano-agenda--current-selection (nano-agenda-date-today)) 398 | (nano-agenda-update))) 399 | 400 | (defun nano-agenda-goto (&optional date) 401 | "Goto given DATE (default today) in calendar" 402 | 403 | (interactive) 404 | (unless nano-agenda--entry-select-mode 405 | (setq nano-agenda--current-selection (or date (nano-agenda-date-today))) 406 | (nano-agenda-update))) 407 | 408 | (define-minor-mode nano-agenda-mode 409 | "Minor mode for nano-agenda." 410 | :init nil 411 | :keymap `((,(kbd "") . nano-agenda-backward-day) 412 | (,(kbd "") . nano-agenda-forward-day) 413 | (,(kbd "") . nano-agenda-backward-week) 414 | (,(kbd "") . nano-agenda-forward-week) 415 | (,(kbd "") . nano-agenda-backward-month) 416 | (,(kbd "") . nano-agenda-forward-month) 417 | (,(kbd "") . nano-agenda-backward-year) 418 | (,(kbd "") . nano-agenda-forward-year) 419 | (,(kbd "") . nano-agenda-toggle-entry-select-mode) 420 | (,(kbd "") . org-agenda-goto) 421 | (,(kbd "r") . nano-agenda-refresh) 422 | (,(kbd ".") . nano-agenda-goto-today) 423 | (,(kbd "t") . nano-agenda-goto-today) 424 | (,(kbd "C-g") . nano-agenda-kill) 425 | (,(kbd "q") . nano-agenda-kill) 426 | ;; (,(kbd "") . nano-agenda-kill) 427 | (,(kbd "") . nano-agenda-kill)) 428 | 429 | (when nano-agenda-mode 430 | (setq buffer-read-only t) 431 | (setq cursor-type nil))) 432 | 433 | 434 | (defun nano-agenda--center-string (string size) 435 | (let* ((padding (/ (- size (length string)) 2)) 436 | (lpad (+ (length string) padding)) 437 | (lformat (format "%%%ds" lpad)) 438 | (rformat (format "%%%ds" (- size)))) 439 | (format rformat (format lformat string)))) 440 | 441 | 442 | (defun nano-agenda-select-window () 443 | "Function to select where to show agenda. Default 444 | behavior is to split vertically current window. 445 | 446 | (before) (after) 447 | +--------------------------+ +--------------------------+ 448 | | | | | 449 | | | | | 450 | | | -> | | 451 | | | +--------------------------+ 452 | | | | calendar / agenda | 453 | +--------------------------+ +--------------------------+" 454 | 455 | (let* ((agenda-buffer "*nano-agenda*") 456 | (agenda-window (get-buffer-window agenda-buffer))) 457 | (or agenda-window (split-window nil -10 'below)))) 458 | 459 | 460 | (defun nano-agenda-filter-entry (entry &optional date) 461 | "Function to decide whether an entry is 462 | displayed/counted. Default behavior is to select all entries." 463 | (let ((type (get-text-property 0 'type entry))) 464 | (and (not (string-equal type "upcoming-deadline")) 465 | (not (string-search ":CANCELLED:" entry))))) 466 | 467 | (defun nano-agenda-default-sort-function (entry-1 entry-2) 468 | "Function to decide the order ENTRIES will be shown to the user. 469 | Returns entries in `time-of-day' order." 470 | 471 | (let ((time-1 (get-text-property 0 'time-of-day entry-1)) 472 | (time-2 (get-text-property 0 'time-of-day entry-2))) 473 | (cond ((not time-1) t) 474 | ((not time-2) nil) 475 | (t (< time-1 time-2))))) 476 | 477 | (defun nano-agenda-format-entry (entry) 478 | "Function to display a specific (org) entry" 479 | 480 | (let* ((is-deadline (string-equal (get-text-property 0 'type entry) "deadline")) 481 | (org-marker (get-text-property 0 'org-marker entry)) 482 | (text (propertize (get-text-property 0 'txt entry) 483 | 'org-marker org-marker)) 484 | (text (replace-regexp-in-string ":.*:" "" text)) 485 | (text (org-link-display-format text)) 486 | (text (string-trim text)) 487 | (time-of-day (get-text-property 0 'time-of-day entry)) 488 | (hours (when time-of-day (floor (/ time-of-day 100)))) 489 | (minutes (when time-of-day (% time-of-day 100) -1)) 490 | (duration (get-text-property 0 'duration entry)) 491 | (text (if is-deadline 492 | (propertize (concat "[D] " text) 'face 'org-imminent-deadline) 493 | (propertize text 'face 'default)))) 494 | (if hours 495 | (concat (propertize (format "%02dh" hours) 'face 'nano-agenda-time) 496 | " - " 497 | text) 498 | text))) 499 | 500 | 501 | ;;;###autoload 502 | (defun nano-agenda () 503 | "Create windows & buffers associated with the agenda." 504 | 505 | (interactive) 506 | 507 | (let* ((agenda-buffer "*nano-agenda*") 508 | (agenda-window (nano-agenda-select-window))) 509 | (setq nano-agenda--entry-overlay nil) 510 | (setq nano-agenda--entry-select-mode nil) 511 | (select-window agenda-window) 512 | (switch-to-buffer agenda-buffer) 513 | (let ((message-log-max nil) 514 | (inhibit-message t)) 515 | (toggle-truncate-lines 1)) 516 | (set-window-dedicated-p agenda-window t) 517 | (set-window-margins agenda-window 2 2) 518 | (nano-agenda-mode t) 519 | (nano-agenda-update) 520 | (show-paren-local-mode -1) 521 | (run-hooks 'nano-agenda-hook))) 522 | 523 | (defun nano-agenda-update () 524 | "Update calendar and agenda according to selected date." 525 | 526 | (with-current-buffer "*nano-agenda*" 527 | (let ((inhibit-read-only t)) 528 | (erase-buffer) 529 | (goto-char (point-min)) 530 | (nano-agenda--populate-calendar) 531 | (goto-char (point-min)) 532 | (nano-agenda--populate-agenda) 533 | (set-window-margins (get-buffer-window) 2 2)) 534 | (run-hooks 'nano-agenda-update-hook))) 535 | 536 | (defun nano-agenda-kill () 537 | "Kill buffers and windows associated with the agenda." 538 | 539 | (interactive) 540 | (let* ((calendar-buffer "*nano-calendar*") 541 | (agenda-buffer "*nano-agenda*")) 542 | (if (get-buffer calendar-buffer) 543 | (kill-buffer calendar-buffer)) 544 | (if (get-buffer agenda-buffer) 545 | (kill-buffer agenda-buffer)))) 546 | 547 | (defun nano-agenda-refresh () 548 | "Reset the cache of busy levels." 549 | 550 | (interactive) 551 | (setq nano-agenda--busy-levels (list))) 552 | 553 | 554 | (defun nano-agenda--has-deadline (date) 555 | "Check if a cached entry has a deadline" 556 | 557 | (let* ((day (nano-agenda-date-day date)) 558 | (month (nano-agenda-date-month date)) 559 | (year (nano-agenda-date-year date)) 560 | (date (list month day year)) 561 | (entry (assoc date nano-agenda--busy-levels))) 562 | (when entry 563 | (nth 2 entry)))) 564 | 565 | (defun nano-agenda--busy-level (date) 566 | "Compute the busy level at a given date. This is done by 567 | counting the number of timed entries. Computed levels are cached 568 | for efficiency." 569 | 570 | (let* ((day (nano-agenda-date-day date)) 571 | (month (nano-agenda-date-month date)) 572 | (year (nano-agenda-date-year date)) 573 | (date (list month day year)) 574 | (level 0) 575 | (deadline nil) 576 | (entry (assoc date nano-agenda--busy-levels))) 577 | (if entry 578 | (cadr entry) 579 | (progn 580 | (dolist (file (org-agenda-files)) 581 | (dolist (entry (org-agenda-get-day-entries file date)) 582 | (when (string-equal (get-text-property 0 'type entry) "deadline") 583 | (setq deadline t)) 584 | (when (funcall nano-agenda-filter-entry-predicate entry date) 585 | (setq level (+ level 1))))) 586 | (add-to-list 'nano-agenda--busy-levels `(,date ,level ,deadline)) 587 | level)))) 588 | 589 | 590 | (defun nano-agenda--populate-agenda () 591 | "Populate the agenda according to current selected date." 592 | 593 | (let* ((selected nano-agenda--current-selection) 594 | (day (nano-agenda-date-day selected)) 595 | (month (nano-agenda-date-month selected)) 596 | (year (nano-agenda-date-year selected)) 597 | (date (list month day year)) 598 | (today (nano-agenda-date-today)) 599 | (is-today (nano-agenda-date-is-today selected)) 600 | (holidays (calendar-check-holidays date)) 601 | (entries '())) 602 | 603 | ;; Header (literal date + holidays (if any)) 604 | (forward-line) 605 | (end-of-line) 606 | (insert nano-agenda-separation) 607 | (insert (propertize (format-time-string "%A %-e %B %Y" selected) 608 | 'face 'nano-agenda-current-day)) 609 | (end-of-line) 610 | 611 | (if is-today 612 | (insert (propertize (format-time-string " (%H:%M)") 613 | 'face 'nano-agenda-time)) 614 | (when holidays 615 | (insert (propertize (format " %s" holidays) 616 | 'face 'nano-agenda-holidays)))) 617 | (forward-line 2) 618 | (end-of-line) 619 | 620 | ;; Body (default timed entries) 621 | 622 | ;; Collect entries from agenda files. 623 | (dolist (file (org-agenda-files)) 624 | (dolist (entry (org-agenda-get-day-entries file date)) 625 | (if (funcall nano-agenda-filter-entry-predicate entry date) 626 | (add-to-list 'entries entry)))) 627 | 628 | ;; Sort entries 629 | (setq entries (sort entries nano-agenda-sort-function)) 630 | 631 | ;; Display entries 632 | (let ((limit (if (< (length entries) 7) 7 5))) 633 | (dolist (entry (cl-subseq entries 0 (min limit (length entries)))) 634 | (insert nano-agenda-separation) 635 | (let* ((org-marker (get-text-property 0 'org-marker entry)) 636 | (entry-text (nano-agenda-format-entry entry)) 637 | (entry-beg (- (point) 1)) 638 | (entry-end (+ (point) (length entry-text) 1))) 639 | (insert (propertize (concat entry-text " ") 640 | 'overlay (cons entry-beg entry-end))) 641 | ;; org-agenda-goto check at beginning of line for an org marker 642 | ;; We thus need to propertize the full line with the org-marker. 643 | (add-text-properties (line-beginning-position) (line-end-position) 644 | `(org-marker ,org-marker))) 645 | (forward-line) 646 | (end-of-line)) 647 | (if (> (length entries) limit) 648 | (insert (concat nano-agenda-separation 649 | (format "+%S non-displayed event(s)" (- (length entries) limit)))))) 650 | 651 | (goto-char (point-min)))) 652 | 653 | 654 | (defun nano-agenda-select-entry () 655 | (interactive) 656 | (let* ((match (text-property-search-forward 'overlay nil nil t))) 657 | (when match 658 | (let* ((bounds (prop-match-value match)) 659 | (overlay (or nano-agenda--entry-overlay 660 | (make-overlay (car bounds) (cdr bounds))))) 661 | (setq nano-agenda--entry-overlay overlay) 662 | (move-overlay overlay (car bounds) (cdr bounds)) 663 | (overlay-put overlay 'face 'nano-agenda-selected))))) 664 | 665 | (defun nano-agenda-toggle-entry-select-mode () 666 | "Toggle entry select mode" 667 | 668 | (interactive) 669 | (if nano-agenda--entry-select-mode 670 | (progn 671 | (setq nano-agenda--entry-select-mode nil) 672 | (nano-agenda-update) 673 | (when nano-agenda--entry-overlay 674 | (overlay-put nano-agenda--entry-overlay 'face 'default))) 675 | (progn 676 | (setq nano-agenda--entry-select-mode t) 677 | (nano-agenda-update) 678 | (nano-agenda-goto-next-entry)))) 679 | 680 | (defun nano-agenda-goto-next-entry () 681 | "Select next entry (when in entry select mode)" 682 | (interactive) 683 | (when nano-agenda--entry-select-mode 684 | (when-let* ((match (text-property-search-forward 'overlay nil nil t)) 685 | (bounds (prop-match-value match)) 686 | (overlay (or nano-agenda--entry-overlay 687 | (make-overlay (car bounds) (cdr bounds))))) 688 | (setq nano-agenda--entry-overlay overlay) 689 | (move-overlay overlay (car bounds) (cdr bounds)) 690 | (overlay-put overlay 'face 'nano-agenda-selected)))) 691 | 692 | (defun nano-agenda-goto-prev-entry () 693 | "Select prev entry (when in entry select mode)" 694 | 695 | (interactive) 696 | (when nano-agenda--entry-select-mode 697 | (when-let* ((match (text-property-search-backward 'overlay nil nil t)) 698 | (bounds (prop-match-value match)) 699 | (overlay (or nano-agenda--entry-overlay 700 | (make-overlay (car bounds) (cdr bounds))))) 701 | (setq nano-agenda--entry-overlay overlay) 702 | (move-overlay overlay (car bounds) (cdr bounds)) 703 | (overlay-put overlay 'face 'nano-agenda-selected)))) 704 | 705 | 706 | (defun nano-agenda--populate-calendar () 707 | "Populate the calendar according to the month of the current selected date." 708 | 709 | ;; Header with prev/next buttons 710 | ;; ----------------------------- 711 | (let* ((selected nano-agenda--current-selection) 712 | (map-left (make-sparse-keymap)) 713 | (map-right (make-sparse-keymap))) 714 | 715 | (define-key map-left (kbd "") #'nano-agenda-backward-month) 716 | (define-key map-right (kbd "") #'nano-agenda-forward-month) 717 | 718 | (insert "\n") 719 | (insert (propertize "<" 'face 'nano-agenda-button 720 | 'mouse-face 'nano-agenda-mouse 721 | 'help-echo "Previous month" 722 | 'keymap map-left)) 723 | (insert (propertize (nano-agenda--center-string 724 | (format "%s %d" 725 | (nano-agenda-date-month-name selected) 726 | (nano-agenda-date-year selected)) 18) 727 | 'face 'nano-agenda-month-name)) 728 | (insert (propertize "> " 'face 'nano-agenda-button 729 | 'mouse-face 'nano-agenda-mouse 730 | 'help-echo "Next month" 731 | 'keymap map-right)) 732 | (insert "\n") 733 | (insert (propertize "Mo Tu We Th Fr " 734 | 'face 'nano-agenda-day-name)) 735 | (insert (propertize "Sa Su " 736 | 'face 'nano-agenda-day-name)) 737 | (insert "\n")) 738 | 739 | ;; Body with navigation keymap 740 | ;; --------------------------- 741 | (let* ((selected nano-agenda--current-selection) 742 | (today (nano-agenda-date-today)) 743 | (day (nano-agenda-date-day selected)) 744 | (month (nano-agenda-date-month selected)) 745 | (year (nano-agenda-date-year selected)) 746 | (start (nano-agenda-date year month 1)) 747 | (dow (mod (+ 6 (nano-agenda-date-dow start)) 7)) 748 | (start (nano-agenda-date-dec start dow))) 749 | 750 | (dotimes (row 6) 751 | (dotimes (col 7) 752 | (let* ((day (+ (* row 7) col)) 753 | (date (nano-agenda-date-inc start day)) 754 | 755 | ;; Slow 756 | (level (nano-agenda--busy-level date)) 757 | (backgrounds (alist-get nano-agenda-palette nano-agenda-palettes)) 758 | (level (min (length backgrounds) level)) 759 | (background (nth (- level 1) backgrounds)) 760 | (foreground (if (< (nano-agenda-color-luminance background) 0.5) 761 | "white" "black")) 762 | (map (make-sparse-keymap)) 763 | (is-today (nano-agenda-date-is-today date)) 764 | (has-deadline (nano-agenda--has-deadline date)) 765 | (is-selected (nano-agenda-date-equal date selected)) 766 | (is-selected-today (and is-selected is-today)) 767 | (is-outday (not (= (nano-agenda-date-month date) month))) 768 | (is-holidays (calendar-check-holidays (list 769 | (nano-agenda-date-month date) 770 | (nano-agenda-date-day date) 771 | (nano-agenda-date-year date)))) 772 | (is-weekend (or (= (nano-agenda-date-dow date) 0) 773 | (= (nano-agenda-date-dow date) 6))) 774 | (face (cond ;; (is-selected-today 'nano-agenda-selected-today) 775 | ;;(is-selected 'nano-agenda-selected) 776 | ((and is-selected 777 | (not nano-agenda--entry-select-mode)) 778 | 'nano-agenda-selected) 779 | ;; (is-today 'nano-agenda-today) 780 | (is-outday 'nano-agenda-outday) 781 | ((> level 0) `(:foreground ,foreground :background ,background )) 782 | (is-weekend 'nano-agenda-weekend) 783 | (is-holidays 'nano-agenda-holidays) 784 | (t 'nano-agenda-default)))) 785 | 786 | (define-key map (kbd "") 787 | `(lambda() (interactive) (nano-agenda-goto ,date))) 788 | 789 | (insert (propertize (format "%2d" (nano-agenda-date-day date)) 790 | 'face face 791 | 'mouse-face (cond (is-selected-today 'nano-agenda-selected-today) 792 | (is-selected 'nano-agenda-selected) 793 | (t 'nano-agenda-mouse)) 794 | 'help-echo (format "%s%s" (format-time-string "%A %-e %B %Y" date) 795 | (if is-holidays (format " (%s)" (nth 0 is-holidays)) 796 | "")) 797 | 'keymap map)) 798 | (if (< col 7) 799 | (insert (propertize (cond (is-today nano-agenda-today-symbol) 800 | (has-deadline nano-agenda-deadline-symbol) 801 | (t " ")) 802 | 'face face))))) 803 | (if (< row 5) (insert "\n"))))) 804 | 805 | (provide 'nano-agenda) 806 | ;;; nano-agenda.el ends here 807 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------