├── title.png ├── screenshot.png ├── .gitignore ├── elcontext-test.el ├── elcontext-directory-test.el ├── elcontext-action-test.el ├── elcontext-location-test.el ├── elcontext-utils.el ├── README.md ├── README.org ├── elcontext-action.el ├── elcontext-directory.el ├── elcontext-time-test.el ├── elcontext-location.el ├── elcontext.el ├── elcontext-time.el └── COPYING /title.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rollacaster/elcontext/HEAD/title.png -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rollacaster/elcontext/HEAD/screenshot.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Compiled 2 | *.elc 3 | 4 | # Packaging 5 | .cask 6 | 7 | # Backup files 8 | *~ 9 | 10 | # Undo-tree save-files 11 | *.~undo-tree 12 | -------------------------------------------------------------------------------- /elcontext-test.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext --- Define context specific services in emacs -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | (require 'ht) 5 | 6 | (require 'elcontext-time-test) 7 | (require 'elcontext-location-test) 8 | (require 'elcontext-action-test) 9 | (require 'elcontext-directory-test) 10 | 11 | (ert-deftest elcontext-store-context-test () 12 | "Store a new location") 13 | 14 | ;;; elcontext-test.el ends here 15 | -------------------------------------------------------------------------------- /elcontext-directory-test.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext --- Define context specific services in emacs -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | (require 'ht) 5 | 6 | (ert-deftest elcontext-directory-valid-context () 7 | "Test if directory context is valid" 8 | (should (equal (elcontext-directory-valid-context (ht (:directory default-directory))) t)) 9 | (should (equal (elcontext-directory-valid-context (ht)) t))) 10 | 11 | (provide 'elcontext-directory-test) 12 | 13 | ;;; elcontext-directory-test.el ends here 14 | -------------------------------------------------------------------------------- /elcontext-action-test.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext --- Define context specific services in emacs -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | (require 'ht) 5 | 6 | (ert-deftest elcontext--mark-as-run-test () 7 | "Mark the last time a context was run." 8 | (should (equal (ht-get (elcontext--mark-as-run (ht) '(23131 49480 398032 0)) :last-run) 9 | (ht-get (ht (:last-run '(23131 49480 398032 0))) :last-run)))) 10 | 11 | (ert-deftest elcontext-action--same-day-test () 12 | "Check if two times have the same day." 13 | (should (elcontext-action--same-day 14 | (date-to-time "2018-01-14 13:00") 15 | (date-to-time "2018-01-14 00:00"))) 16 | (should-not (elcontext-action--same-day 17 | (date-to-time "2018-01-13 13:00") 18 | (date-to-time "2018-01-14 00:00")))) 19 | 20 | (ert-deftest elcontext-action-valid-context () 21 | "Should be t if last-run is not defined." 22 | (should (elcontext-action-valid-context (ht)))) 23 | 24 | (provide 'elcontext-action-test) 25 | 26 | ;;; elcontext-action-test.el ends here 27 | -------------------------------------------------------------------------------- /elcontext-location-test.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext --- Define context specific services in emacs -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | (require 'ht) 5 | (require 'elcontext-location) 6 | 7 | (ert-deftest elcontext--get-gps-test () 8 | "Get the lat/lon Coordinates" 9 | (let ((gps (elcontext-location-get-gps))) 10 | (should (numberp (ht-get gps :lon))) 11 | (should (numberp (ht-get gps :lat))))) 12 | 13 | (ert-deftest elcontext--distance-test () 14 | "Compute distance between two points" 15 | (let* ((coordA (ht (:lat 48.157262) (:lon 11.540225))) 16 | (coordB (ht (:lat 48.154438) (:lon 11.541286)))) 17 | (should (= (elcontext-location--distance coordA coordB) 0.3237273177020497)))) 18 | 19 | (ert-deftest elcontext--gps-to-sting-test () 20 | "Convert gps coordinat to a string." 21 | (should (equal (elcontext-location-to-string (ht (:location 22 | (ht (:lat 48.126011) 23 | (:lon 11.558044))))) 24 | "Lat: 48.126011 Lon: 11.558044"))) 25 | 26 | (ert-deftest elcontext-location-valid-context-teset () 27 | "Context is valid if no gps was specified." 28 | (should (equal (elcontext-location-valid-context (ht)) t))) 29 | 30 | (provide 'elcontext-location-test) 31 | 32 | ;;; elcontext-location-test.el ends here 33 | -------------------------------------------------------------------------------- /elcontext-utils.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; 23 | 24 | ;;; Code: 25 | 26 | (defun elcontext-utils-read-number-range (from to prompt &optional default) 27 | "Read a number range between FROM and TO with a PROMPT. 28 | 29 | The optional DEFAULT is used when the user enters emtpy input." 30 | (let ((number)) 31 | (while (not number) 32 | (let ((userInput (read-from-minibuffer prompt default))) 33 | (if (and 34 | (<= from (string-to-number userInput)) 35 | (>= to (string-to-number userInput))) 36 | (setq number userInput) 37 | (read-from-minibuffer (format "Please specify a number between %d-%d." from to))))) 38 | number)) 39 | 40 | (provide 'elcontext-utils) 41 | 42 | ;;; elcontext-utils.el ends here 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![img](./title.png) 2 | 3 | > Bring your editing experience to the next level with context-based actions for emacs 4 | 5 | 6 | # Installation 7 | 8 | `elcontext` is available on [MELPA](https://melpa.org). Add the MELPA repositories with the following code in your init file: 9 | 10 | ```emacs-lisp 11 | (require 'package) 12 | (add-to-list 'package-archives '("melpa" . "http://melpa.milkbox.net/packages/") t) 13 | (package-initialize) 14 | ``` 15 | 16 | Install `elcontext` by running: 17 | 18 | `M-x package-install RET elcontext RET` 19 | 20 | Add the following code to your init file to continuously check for valid contexts: 21 | 22 | ```emacs-lisp 23 | (require 'elcontext) 24 | (elcontext-global-mode) 25 | ``` 26 | 27 | Alternatively if you are using [use-package](https://github.com/jwiegley/use-package) you can use the following configuration: 28 | 29 | ```emacs-lisp 30 | (use-package elcontext 31 | :ensure t 32 | :config 33 | (elcontext-global-mode)) 34 | ``` 35 | 36 | 37 | # Usage 38 | 39 | Use `M-x elcontext` for on overview of all contexts. Within this overview several hydras will guide through the API, press `?` to open the help hydra. 40 | 41 | Contexts can consist of a 42 | 43 | - name, 44 | - location (only for macOS), 45 | - timespan, 46 | - directory, 47 | - and action. 48 | 49 | ![img](./screenshot.png) 50 | 51 | If a part of a context is omitted this part is always valid e.g. no location means anywhere, no time means anytime. Each command is triggered once a day. 52 | 53 | 54 | # Use Cases 55 | 56 | 57 | ### Work / Home development environment 58 | 59 | Start all work applications when you're in the office, stop them when you're home (and start others). This was the original reason to create `elcontext`. It integrates well with [prodigy](https://github.com/rejeep/prodigy.el). You can define all applications you need at work or home as prodigy-services. 60 | 61 | 62 | ### Add yours! 63 | 64 | If your using `elcontext` I am happy to hear about your use cases! 65 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | [[./title.png]] 2 | 3 | #+BEGIN_QUOTE 4 | Bring your editing experience to the next level with context-based 5 | actions for emacs 6 | #+END_QUOTE 7 | 8 | ** Installation 9 | =elcontext= is available on [[https://melpa.org][MELPA]]. Add the MELPA repositories with 10 | the following code in your init file: 11 | #+BEGIN_SRC emacs-lisp 12 | (require 'package) 13 | (add-to-list 'package-archives '("melpa" . "http://melpa.milkbox.net/packages/") t) 14 | (package-initialize) 15 | #+END_SRC 16 | 17 | Install =elcontext= by running: 18 | 19 | 20 | =M-x package-install RET elcontext RET= 21 | 22 | Add the following code to your init file to continuously check for valid contexts: 23 | #+BEGIN_SRC emacs-lisp 24 | (require 'elcontext) 25 | (elcontext-global-mode) 26 | #+END_SRC 27 | 28 | Alternatively if you are using [[https://github.com/jwiegley/use-package][use-package]] you can use the following configuration: 29 | #+BEGIN_SRC emacs-lisp 30 | (use-package elcontext 31 | :ensure t 32 | :config 33 | (elcontext-global-mode)) 34 | #+END_SRC 35 | 36 | ** Usage 37 | 38 | Use =M-x elcontext= for on overview of all contexts. Within this 39 | overview several hydras will guide through the API, press =?= to open 40 | the help hydra. 41 | 42 | Contexts can consist of a 43 | 44 | - name, 45 | - location (only for macOS), 46 | - timespan, 47 | - directory, 48 | - and action. 49 | 50 | [[./screenshot.png]] 51 | 52 | If a part of a context is omitted this part is always valid e.g. no location 53 | means anywhere, no time means anytime. Each command is triggered once a day. 54 | ** Use Cases 55 | **** Work / Home development environment 56 | Start all work applications when you're in the office, stop them when you're 57 | home (and start others). This was the original reason to create =elcontext=. It 58 | integrates well with [[https://github.com/rejeep/prodigy.el][prodigy]]. You can define all applications you need at work 59 | or home as prodigy-services. 60 | **** Add yours! 61 | If your using =elcontext= I am happy to hear about your use cases! 62 | 63 | -------------------------------------------------------------------------------- /elcontext-action.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'ht) 27 | 28 | (defun elcontext-action-run (context) 29 | "Run a CONTEXT action." 30 | (elcontext--mark-as-run context (current-time)) 31 | (eval (ht-get context :action))) 32 | 33 | (defun elcontext--mark-as-run (context time) 34 | "Update a CONTEXT with the last TIME it was run." 35 | (ht-set! context :last-run time) 36 | context) 37 | 38 | (defun elcontext-action-valid-context (context) 39 | "Check if the CONTEXT did already run today." 40 | (when (or (not (ht-get context :last-run)) 41 | (not (elcontext-action--same-day (ht-get context :last-run) 42 | (current-time)))) 43 | t)) 44 | 45 | (defun elcontext-action--same-day (time1 time2) 46 | "Check if TIME1 and TIME2 have the same day." 47 | (let* ((today (decode-time time1)) 48 | (year (nth 5 today)) 49 | (month (nth 4 today)) 50 | (day (nth 3 today)) 51 | (context-last-run (decode-time time2)) 52 | (context-year (nth 5 context-last-run)) 53 | (context-month (nth 4 context-last-run)) 54 | (context-day (nth 3 context-last-run))) 55 | (when (and (eq year context-year) 56 | (eq month context-month) 57 | (eq day context-day)) 58 | t))) 59 | 60 | (provide 'elcontext-action) 61 | 62 | ;;; elcontext-action.el ends here 63 | -------------------------------------------------------------------------------- /elcontext-directory.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'ht) 27 | (require 'hydra) 28 | 29 | (setq elcontext-directory--current "") 30 | (defun elcontext-directory-valid-context (context) 31 | "Check if the CONTEXT did already run today." 32 | (when (or (equal (ht-get context :directory) "") 33 | (equal (expand-file-name "" (ht-get context :directory)) 34 | (expand-file-name "" default-directory))) 35 | t)) 36 | 37 | (defhydra elcontext-directory-hydra (:hint nil :foreign-keys warn) 38 | " 39 | _s_: Set directory | %`elcontext-directory--current 40 | _e_: Edit location | 41 | 42 | _c_: Create directory 43 | _q_: Quit 44 | " 45 | ("s" (setq elcontext-directory--current (read-directory-name "Directory: "))) 46 | ("e" (setq elcontext-directory--current (read-directory-name "Directory: " elcontext--context-current))) 47 | ("c" (progn 48 | (ht-set! elcontext--context-current :directory elcontext-directory--current) 49 | (setq elcontext-directory--current "") 50 | (elcontext-hydra-create-context/body)) :exit t) 51 | ("q" (elcontext-hydra-create-context/body) :exit t)) 52 | 53 | (defun elcontext-directory-create (context) 54 | "Choose a new directory or a edit a existing CONTEXT directory from user input." 55 | (setq elcontext-directory--current (ht-get context :directory)) 56 | (elcontext-directory-hydra/body)) 57 | 58 | (provide 'elcontext-directory) 59 | 60 | ;;; elcontext-directory.el ends here 61 | -------------------------------------------------------------------------------- /elcontext-time-test.el: -------------------------------------------------------------------------------- 1 | ;;; timespan --- Handle timespans with elsip -*- lexical-binding: t -*- 2 | ;;; Commentary: 3 | ;;; Code: 4 | (require 'ht) 5 | (require 'elcontext-time) 6 | 7 | (ert-deftest elcontext-time--within-timespanp () 8 | "Test if a date is within a timespan." 9 | (should-error (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "12:00")))) 10 | (should-error (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:to "12:00")))) 11 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "12:00") (:to "15:00")))) 12 | (should-not (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "14:00") (:to "15:00")))) 13 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:days '("Fri"))))) 14 | (should-not (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:days '("Mon"))))) 15 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "12:00") (:to "15:00") (:days '("Mon" "Fri"))))) 16 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "13:00") (:to "13:10") (:days '("Fri"))))) 17 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "13:00") (:to "13:10")))) 18 | (should-not (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:00") (ht (:from "12:00") (:to "15:00") (:days '("Mon" "Tue"))))) 19 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:10") (ht (:from "13:00") (:to "14:00")))) 20 | (should (elcontext-time--within-timespanp (date-to-time "2017-12-01 13:10") (ht (:days '("Fri")) (:from "13:00") (:to "14:00"))))) 21 | 22 | (ert-deftest elcontext-time-timespan-to-string () 23 | "Test timespan conversion." 24 | (should (equal (elcontext-time-to-string (ht (:time (ht (:from "13:00") (:to "13:10"))))) "13:00-13:10")) 25 | (should (equal (elcontext-time-to-string (ht (:time (ht (:from "13:00") (:to "13:10") (:days '("Mon" "Tue")))))) "13:00-13:10 Mon,Tue")) 26 | (should (equal (elcontext-time-to-string (ht (:time (ht (:from "13:00") (:to "13:10") (:days '("Mon")))))) "13:00-13:10 Mon")) 27 | (should (equal (elcontext-time-to-string (ht (:time (ht (:days '("Tue")))))) "Tue")) 28 | (should (equal (elcontext-time-to-string (ht (:time (ht (:days '("Mon" "Tue")))))) "Mon,Tue"))) 29 | 30 | (ert-deftest elcontext-time-valid-context () 31 | "No time is a valid context." 32 | (should (equal (elcontext-time-valid-context (ht)) t))) 33 | 34 | (provide 'elcontext-time-test) 35 | 36 | ;;; elcontext-time-test.el ends here 37 | -------------------------------------------------------------------------------- /elcontext-location.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'ht) 27 | (require 'hydra) 28 | (require 'elcontext-utils) 29 | (when (string-equal system-type "darwin") 30 | (require 'osx-location)) 31 | 32 | (setq elcontext-location--current (ht)) 33 | 34 | (defun elcontext-location-edit (&optional lat lon) 35 | "Edit coordinates manually. Initial LAT and LON can be specified." 36 | (let ((lat (elcontext-utils-read-number-range 0 90 "Latitude: " (number-to-string lat))) 37 | (lon (elcontext-utils-read-number-range 0 90 "Longitude: " (number-to-string lon)))) 38 | (ht (:lat (string-to-number lat)) (:lon (string-to-number lon))))) 39 | 40 | (defun elcontext-location-valid-context (context) 41 | "Check if the CONTEXT is valid for current location." 42 | (let ((gps (ht-get context :location))) 43 | (if (and (ht? gps) (ht-get gps :lon) (ht-get gps :lat)) 44 | (elcontext-location--within-range (elcontext-location-get-gps) gps)) 45 | t)) 46 | 47 | (defun elcontext-location--within-range (gps1 gps2) 48 | "Ensure a GPS1 and GPS2 are wihtin 100 meters." 49 | (< (elcontext-location--distance gps1 gps2) 0.100)) 50 | 51 | (defun elcontext-location-get-gps () 52 | "Return the current gps." 53 | (ht (:lat osx-location-latitude) (:lon osx-location-longitude))) 54 | 55 | (defun elcontext-location--distance (from to) 56 | "Comutes the distance between FROM and TO in km." 57 | (let ((earth-radius 6371)) 58 | (* 2 earth-radius (asin (sqrt (elcontext-location--haversine from to)))))) 59 | 60 | (defun elcontext-location--haversine (from to) 61 | "Computes the haversine for two coordinates FROM and TO." 62 | (let ((dLat (elcontext-location--degree-to-radians (abs (- (ht-get to :lat) (ht-get from :lat))))) 63 | (dLon (elcontext-location--degree-to-radians (abs (- (ht-get to :lon) (ht-get from :lon))))) 64 | (lat1 (elcontext-location--degree-to-radians (ht-get from :lat))) 65 | (lat2 (elcontext-location--degree-to-radians (ht-get to :lat)))) 66 | (+ (expt (sin (/ dLat 2)) 2) (* (cos lat1) (cos lat2) (expt (sin (/ dLon 2)) 2))))) 67 | 68 | (defun elcontext-location--degree-to-radians (degrees) 69 | "Convert DEGREES to radians." 70 | (/ (* degrees pi) 180)) 71 | 72 | (defhydra elcontext-location-hydra (:hint nil :foreign-keys warn) 73 | " 74 | _l_: Current location | %(elcontext-location-to-string (ht (:location elcontext-location--current))) 75 | _e_: Edit location | 76 | 77 | _c_: Create location 78 | _q_: Quit 79 | " 80 | ("l" (setq elcontext-location--current (elcontext-location-get-gps))) 81 | ("e" (setq elcontext-location--current (elcontext-location-edit (ht-get elcontext-location--current :lat) 82 | (ht-get elcontext-location--current :lon)))) 83 | ("c" (progn 84 | (ht-set! elcontext--context-current :location elcontext-location--current) 85 | (setq elcontext-location--current (ht)) 86 | (elcontext-hydra-create-context/body)) :exit t) 87 | ("q" (elcontext-hydra-create-context/body) :exit t)) 88 | 89 | 90 | (defun elcontext-location-create (context) 91 | "Create a new location or a edit a existing CONTEXT location from user input." 92 | (if (string-equal system-type "darwin") 93 | (progn 94 | (setq elcontext-location--current (ht-get context :location)) 95 | (elcontext-location-hydra/body)) 96 | (message "Location Feature works only with macOS"))) 97 | 98 | (defun elcontext-location-to-string (context) 99 | "Format a CONTEXT location to a string." 100 | (let ((gps (ht-get context :location))) 101 | (if gps 102 | (let ((lat (ht-get gps :lat)) 103 | (lon (ht-get gps :lon))) 104 | (if (and lat lon) 105 | (concat "Lat: " (number-to-string lat) " Lon: " (number-to-string lon)) 106 | "")) 107 | ""))) 108 | 109 | (provide 'elcontext-location) 110 | 111 | ;;; elcontext-location.el ends here 112 | -------------------------------------------------------------------------------- /elcontext.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | ;; Version: 1.0.0 7 | ;; Package-Requires: ((ht "2.3") (hydra "0.14.0") (emacs "24.3") (f "0.20.0") (osx-location "0.4") (uuidgen "0.3")) 8 | ;; Keywords: calendar, convenience 9 | ;; URL: https://github.com/rollacaster/elcontext 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; Commentary: 14 | 15 | ;; Use M-x elcontext for on overview of all contexts. Within this overview 16 | ;; several hydras will guide through the API, press ? to open the help hydra. 17 | ;; Contexts can consist of name, location (only for macOS), timespan, directory, 18 | ;; and action. If a part of a context is omitted this part is always valid e.g. 19 | ;; no location means anywhere, no time means anytime. Each command is triggered 20 | ;; once per day. 21 | 22 | ;;; Code: 23 | 24 | (require 'ht) 25 | (require 'hydra) 26 | (require 'f) 27 | (require 'uuidgen) 28 | (require 'elcontext-time) 29 | (require 'elcontext-action) 30 | (require 'elcontext-location) 31 | (require 'elcontext-directory) 32 | (when (string-equal system-type "darwin") 33 | (require 'osx-location)) 34 | 35 | (defvar elcontext-contexts (ht)) 36 | 37 | (defface elcontext-success 38 | '((((class color)) :inherit 'success)) 39 | "Green color indicating a context which did run today." 40 | :group 'elcontext) 41 | 42 | (defvar elcontext-mode-map 43 | (let ((map (make-sparse-keymap))) 44 | (define-key map (kbd "c") 'elcontext-new-context) 45 | (define-key map (kbd "e") 'elcontext-edit-context) 46 | (define-key map (kbd "d") 'elcontext-delete-context) 47 | (define-key map (kbd "?") 'elcontext-hydra-help/body) 48 | map) 49 | "Keymap for `elcontext-mode'.") 50 | 51 | 52 | (define-derived-mode elcontext-mode tabulated-list-mode "Contexts" 53 | "Special mode for contexts." 54 | (setq mode-name "elcontext") 55 | (use-local-map elcontext-mode-map) 56 | (setq tabulated-list-format 57 | (vconcat (vector '("Name" 15 t)) 58 | (when (string-equal system-type "darwin") (vector '("Location" 25 t))) 59 | (vector '("Time" 25 t) '("Directory" 25 t) '("Action" 25 t)))) 60 | (setq tabulated-list-entries 'elcontext--get-contexts-for-table) 61 | (tabulated-list-init-header) 62 | (tabulated-list-print)) 63 | 64 | (defun elcontext () 65 | "Manage contexts in Emacs." 66 | (interactive) 67 | (get-buffer-create "**Contexts**") 68 | (switch-to-buffer "**Contexts**") 69 | (elcontext-mode)) 70 | 71 | (defun elcontext--get-contexts-for-table () 72 | "Return all context in table format." 73 | (ht-map (lambda (key context) 74 | (list key 75 | (vconcat 76 | (vector (if (elcontext-action-valid-context context) 77 | (ht-get context :name) 78 | (propertize (if (ht-get context :name) (ht-get context :name) "") 'face 'elcontext-success))) 79 | (when (string-equal system-type "darwin") 80 | (vector (elcontext-location-to-string context))) 81 | (vector (elcontext-time-to-string context) 82 | (ht-get context :directory) 83 | (prin1-to-string (ht-get context :action)))))) 84 | elcontext-contexts)) 85 | 86 | (defun elcontext-add-context (id context) 87 | "Store a context with ID and CONTEXT." 88 | (ht-set! elcontext-contexts id context)) 89 | 90 | (defun elcontext-check-contexts () 91 | "Execute contexts if they are valid." 92 | (interactive) 93 | (ht-each (lambda (name context) 94 | (if (and 95 | (elcontext-action-valid-context context) 96 | (elcontext-location-valid-context context) 97 | (elcontext-time-valid-context context) 98 | (elcontext-directory-valid-context context)) 99 | (elcontext-action-run context))) 100 | elcontext-contexts)) 101 | 102 | (setq elcontext--timer nil) 103 | (define-minor-mode elcontext-global-mode 104 | "Toogle elcontext-mode. Checks every minute for valid contexts" 105 | :lighter " elc" 106 | :group 'elcontext 107 | :global t 108 | :require 'elcontext 109 | (if (symbol-value 'elcontext-global-mode) 110 | (progn 111 | (setq elcontext--timer (run-at-time nil 5 'elcontext-check-contexts)) 112 | (when (string-equal system-type "darwin") 113 | (osx-location-watch))) 114 | (progn 115 | (cancel-timer elcontext--timer) 116 | (setq elcontext--timer nil)))) 117 | 118 | (setq elcontext--context-id nil) 119 | (setq elcontext--context-current 120 | (ht (:name nil) (:time (ht)) (:action nil) (:location (ht)) (:directory ""))) 121 | 122 | (defhydra elcontext-hydra-create-context (:hint nil :foreign-keys warn) 123 | (concat "_n_: Change name | Name %(ht-get elcontext--context-current :name)" 124 | (when (string-equal system-type "darwin") " 125 | _l_: Change location | Location %(elcontext-location-to-string elcontext--context-current)") 126 | " 127 | _t_: Change time | Time %(elcontext-time-to-string elcontext--context-current) 128 | _d_: Change directory | Directory %(ht-get elcontext--context-current :directory) 129 | _a_: Change action | Action %(ht-get elcontext--context-current :action) 130 | 131 | _c_: Create context 132 | _q_: Quit 133 | ") 134 | ("n" (ht-set! elcontext--context-current :name (read-from-minibuffer "Name: "))) 135 | ("l" (elcontext-location-create elcontext--context-current) :exit t) 136 | ("t" (elcontext-time-create elcontext--context-current) :exit t) 137 | ("d" (elcontext-directory-create elcontext--context-current) :exit t) 138 | ("a" (ht-set! elcontext--context-current :action (read-minibuffer "Action: "))) 139 | ("c" (progn 140 | (elcontext-add-context elcontext--context-id elcontext--context-current) 141 | (setq elcontext--context-current (ht (:name nil) (:time (ht)) (:action nil) (:location (ht)))) 142 | (tabulated-list-print)) :color blue) 143 | ("q" (progn 144 | (setq elcontext--context-id nil) 145 | (setq elcontext--context-current (ht (:name nil) (:time (ht)) (:action nil) (:location (ht))))) :exit t)) 146 | 147 | (defhydra elcontext-hydra-help (:hint nil :exit t) 148 | " 149 | **elcontext help** 150 | 151 | _c_: Create context 152 | _e_: Edit context 153 | _d_: Delete context 154 | 155 | _q_: Quit 156 | " 157 | ("c" (elcontext-new-context)) 158 | ("e" (elcontext-edit-context)) 159 | ("d" (elcontext-delete-context)) 160 | ("q" nil)) 161 | 162 | (defun elcontext-new-context () 163 | "Create a new context." 164 | (interactive) 165 | (setq elcontext--context-id (uuidgen-4)) 166 | (elcontext-hydra-create-context/body)) 167 | 168 | (defun elcontext-edit-context () 169 | "Edit context at point." 170 | (interactive) 171 | (let ((context-id (tabulated-list-get-id))) 172 | (setq elcontext--context-id context-id) 173 | (setq elcontext--context-current (ht-get elcontext-contexts context-id)) 174 | (condition-case nil 175 | (elcontext-hydra-create-context/body) 176 | (wrong-type-argument (user-error "No context found at point"))))) 177 | 178 | (defun elcontext-delete-context () 179 | "Delete context at point." 180 | (interactive) 181 | (let ((context (ht-get elcontext-contexts (tabulated-list-get-id)))) 182 | (condition-case nil 183 | (when (y-or-n-p (concat "Delete context " (ht-get context :name) "?")) 184 | (ht-remove! elcontext-contexts (tabulated-list-get-id)) 185 | (tabulated-list-print)) 186 | (wrong-type-argument (user-error "No context found at point"))))) 187 | 188 | (defun elcontext--save-contexts () 189 | "Save contexts to disk." 190 | (f-write-text (prin1-to-string elcontext-contexts) 'utf-8 191 | (expand-file-name ".contexts" user-emacs-directory))) 192 | 193 | (add-hook 'kill-emacs-hook 'elcontext--save-contexts) 194 | 195 | (defun elcontext--load-contexts () 196 | "Load contexts from disc." 197 | (when (f-exists? (expand-file-name ".contexts" user-emacs-directory)) 198 | (let ((saved-contexts (read (f-read-text (expand-file-name ".contexts" user-emacs-directory))))) 199 | (if (ht? saved-contexts) 200 | (setq elcontext-contexts saved-contexts) 201 | (setq elcontext-contexts (ht)))))) 202 | 203 | (elcontext--load-contexts) 204 | 205 | (provide 'elcontext) 206 | 207 | ;;; elcontext.el ends here 208 | -------------------------------------------------------------------------------- /elcontext-time.el: -------------------------------------------------------------------------------- 1 | ;;; elcontext.el --- Create context specific actions -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Thomas Sojka 4 | 5 | ;; Author: Thomas Sojka 6 | 7 | ;; This program is free software; you can redistribute it and/or modify 8 | ;; it under the terms of the GNU General Public License as published by 9 | ;; the Free Software Foundation, either version 3 of the License, or 10 | ;; (at your option) any later version. 11 | 12 | ;; This program is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ;; GNU General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this program. If not, see . 19 | 20 | ;;; Commentary: 21 | 22 | ;; 23 | 24 | ;;; Code: 25 | 26 | (require 'calendar) 27 | (require 'ht) 28 | (require 'dash) 29 | (require 's) 30 | (require 'hydra) 31 | (require 'elcontext-utils) 32 | 33 | (defun elcontext-time--date-to-calendardate (date) 34 | "Convert time to calendar DATE." 35 | (let ((month (nth 4 date)) 36 | (day (nth 3 date)) 37 | (year (nth 5 date))) 38 | (substring (calendar-day-name (cons month (cons day (cons year ())))) 0 3))) 39 | 40 | (defun elcontext-time--get-hour (timespan time) 41 | "Get the hour from a TIMESPAN for a certain TIME." 42 | (condition-case nil 43 | (car (split-string (ht-get* timespan time) ":")) 44 | (wrong-type-argument nil))) 45 | 46 | (defun elcontext-time--get-hour-number (timespan time) 47 | "Get the hour from a TIMESPAN for a certain TIME." 48 | (condition-case nil 49 | (string-to-number (elcontext-time--get-hour timespan time)) 50 | (wrong-type-argument nil))) 51 | 52 | (defun elcontext-time--get-minute (timespan time) 53 | "Get the minute from a TIMESPAN for a certain TIME." 54 | (condition-case nil 55 | (-last-item (split-string (ht-get* timespan time) ":")) 56 | (wrong-type-argument nil))) 57 | 58 | (defun elcontext-time--get-minute-number (timespan time) 59 | "Get the minute from a TIMESPAN for a certain TIME." 60 | (condition-case nil 61 | (string-to-number (elcontext-time--get-minute timespan time)) 62 | (wrong-type-argument nil))) 63 | 64 | (defun elcontext-time--within-timespanp (date timespan) 65 | "Check if a DATE is within a TIMESPAN." 66 | (let ((hour (nth 2 (decode-time date))) 67 | (minute (nth 1 (decode-time date))) 68 | (day (elcontext-time--date-to-calendardate (decode-time date))) 69 | (fromHour (elcontext-time--get-hour-number timespan :from)) 70 | (fromMinute (elcontext-time--get-minute-number timespan :from)) 71 | (toHour (elcontext-time--get-hour-number timespan :to)) 72 | (toMinute (elcontext-time--get-minute-number timespan :to)) 73 | (days (ht-get timespan :days))) 74 | (cond 75 | ((and (numberp fromHour) (not (numberp toHour))) (user-error "From hour was specified without To hour")) 76 | ((and (numberp toHour) (not (numberp fromHour))) (user-error "From hour was specified without To hour")) 77 | ((and (member day days) (not (numberp fromHour)) (not (numberp toHour))) t) 78 | ((and (not (member day days)) (not (numberp fromHour)) (not (numberp toHour))) nil) 79 | ((and (null days) (> hour fromHour) (< hour toHour)) t) 80 | ((and (null days) (>= hour fromHour) (>= minute fromMinute) (< hour toHour)) t) 81 | ((and (null days) (>= hour fromHour) (>= minute fromMinute) (<= hour toHour) (<= minute toMinute)) t) 82 | ((and (member day days) (> hour fromHour) (< hour toHour)) t) 83 | ((and (member day days) (>= hour fromHour) (>= minute fromMinute) (< hour toHour)) t) 84 | ((and (member day days) (>= hour fromHour) (>= minute fromMinute) (<= hour toHour) (<= minute toMinute)) t)))) 85 | 86 | (defun elcontext-time--pad-time (time) 87 | "Pad a TIME with leading 0s." 88 | (s-pad-left 2 "0" time)) 89 | 90 | (defun elcontext-time--format-from (timespan) 91 | "Format the from hourso of a TIMESPAN." 92 | (ht-get timespan :from)) 93 | 94 | (setq elcontext-time--current (ht)) 95 | 96 | (defhydra elcontext-time-hydra (:hint nil :foreign-keys warn) 97 | " 98 | _f_: Change from | From %(ht-get elcontext-time--current :from) 99 | _t_: Change to | To %(ht-get elcontext-time--current :to) 100 | _d_: Add days | Days %(ht-get elcontext-time--current :days) 101 | _r_: Remove days 102 | 103 | _c_: Create timespan 104 | _q_: Quit 105 | " 106 | ("f" (let ((from-hour (elcontext-time--pad-time (elcontext-time--read-hour (elcontext-time--get-hour elcontext-time--current :from)))) 107 | (from-minute (elcontext-time--pad-time (elcontext-time--read-minute (elcontext-time--get-minute elcontext-time--current :from))))) 108 | (ht-set! elcontext-time--current :from (concat from-hour ":" from-minute)))) 109 | ("t" (let ((to-hour (elcontext-time--pad-time (elcontext-time--read-hour (elcontext-time--get-hour elcontext-time--current :to)))) 110 | (to-minute (elcontext-time--pad-time (elcontext-time--read-minute (elcontext-time--get-minute elcontext-time--current :to))))) 111 | (ht-set! elcontext-time--current :to (concat to-hour ":" to-minute)))) 112 | ("d" (ht-set! elcontext-time--current :days 113 | (-snoc (ht-get elcontext-time--current :days) 114 | (elcontext-time--read-week-days (ht-get elcontext-time--current :days))))) 115 | ("r" (ht-set! elcontext-time--current :days 116 | (-remove-item (completing-read "Remove day:" (ht-get elcontext-time--current :days)) 117 | (ht-get elcontext-time--current :days)))) 118 | ("c" (progn 119 | (if (or (and (s-present? (ht-get elcontext-time--current :from)) (s-blank? (ht-get elcontext-time--current :to))) 120 | (and (s-present? (ht-get elcontext-time--current :to)) (s-blank? (ht-get elcontext-time--current :from)))) 121 | (progn 122 | (message "Please specify a from and to time.") 123 | (elcontext-time-hydra/body)) 124 | (progn 125 | (ht-set! elcontext--context-current :time elcontext-time--current) 126 | (setq elcontext-time--current (ht)) 127 | (elcontext-hydra-create-context/body)))) :exit t) 128 | ("q" (progn 129 | (setq elcontext-time--current (ht)) 130 | (ht-set! elcontext--context-current :time (ht)) 131 | (elcontext-hydra-create-context/body)) :exit t)) 132 | 133 | 134 | (defun elcontext-time--read-week-days (selected-days) 135 | "Read week days from user input ignoring SELECTED-DAYS." 136 | (completing-read "Week day: " 137 | (-difference '("Mon" "Tue" "Wed" "Thu" "Fri" "Sat" "Sun" ) selected-days) 138 | :require-match t)) 139 | 140 | (defun elcontext-time--read-hour (&optional hour) 141 | "Read an hour form user input. Can define default HOUR." 142 | (elcontext-utils-read-number-range 0 23 "Hour: " hour)) 143 | 144 | (defun elcontext-time--read-minute (&optional minute) 145 | "Read an minute form user input. Can define default MINUTE." 146 | (elcontext-utils-read-number-range 0 59 "Minute: " minute)) 147 | 148 | (defun elcontext-time-create (context) 149 | "Create a new timespan or a edit a existing CONTEXT timespan from user input." 150 | (setq elcontext-time--current (ht-get context :time)) 151 | (elcontext-time-hydra/body)) 152 | 153 | (defun elcontext-time-to-string (context) 154 | "Format a CONTEXT time to a string." 155 | (let ((timespan (ht-get context :time))) 156 | (if timespan 157 | (let ((from-hour (elcontext-time--get-hour timespan :from)) 158 | (from-minute (elcontext-time--get-minute timespan :from)) 159 | (to-hour (elcontext-time--get-hour timespan :to)) 160 | (to-minute (elcontext-time--get-minute timespan :to)) 161 | (days (ht-get timespan :days))) 162 | (concat 163 | (when (not (null from-hour)) 164 | (concat 165 | (elcontext-time--pad-time from-hour) ":" (elcontext-time--pad-time from-minute) 166 | "-" 167 | (elcontext-time--pad-time to-hour) ":" (elcontext-time--pad-time to-minute))) 168 | (when (not (null days)) 169 | (concat (when from-hour " ") 170 | (s-replace " " "," (s-replace ")" "" (s-replace "(" "" (format "%s" days)))))))) 171 | ""))) 172 | 173 | (defun elcontext-time-valid-context (context) 174 | "Check if the CONTEXT is valid for current time." 175 | (if (ht-get context :time) 176 | (elcontext-time--within-timespanp (current-time) (ht-get context :time))) 177 | t) 178 | 179 | (provide 'elcontext-time) 180 | 181 | ;;; elcontext-time.el ends here 182 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------