├── .gitignore ├── devel ├── init.el └── README.md ├── .travis.yml ├── frame-workflow-magit.el ├── Makefile ├── frame-workflow-editor.el ├── frame-workflow-exwm.el ├── helm-frame-workflow.el ├── README.org ├── frame-workflow.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | /.elpa/ 2 | /.elpa.test/ 3 | /emacs-travis.mk 4 | /emake.el 5 | /emake.mk 6 | *.elc 7 | -------------------------------------------------------------------------------- /devel/init.el: -------------------------------------------------------------------------------- 1 | ;; Init file for development 2 | 3 | (add-to-list 'load-path 4 | (expand-file-name ".." (file-name-directory load-file-name))) 5 | 6 | (require 'frame-workflow) 7 | 8 | (frame-workflow-define-subject "home" 9 | :observer-class frame-workflow-observer) 10 | 11 | (frame-workflow-define-subject "emacs-lisp") 12 | 13 | ;; TODO: Configure a modeline 14 | 15 | (prin1 frame-workflow--subject-list) 16 | -------------------------------------------------------------------------------- /devel/README.md: -------------------------------------------------------------------------------- 1 | # Init file for testing frame-workflow 2 | 3 | This is an Emacs initialization file to used run another Emacs instance for testing without breaking the currently running Emacs session. 4 | 5 | ## Usage 6 | 7 | Add this directory to the configuration of [Chemacs](https://github.com/plexus/chemacs): 8 | 9 | ``` emacs-lisp 10 | (("default" . ((user-emacs-directory . "~/.emacs.d"))) 11 | ("fwf-testing" . ((user-emacs-directory . "~/github/frame-workflow/devel")))) 12 | ``` 13 | 14 | Start Emacs with the config: 15 | 16 | ``` shell 17 | emacs --with-profile fwf-testing 18 | ``` 19 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: emacs-lisp 2 | sudo: required 3 | dist: trusty 4 | cache: 5 | - directories: 6 | - "$HOME/emacs" 7 | matrix: 8 | fast_finish: true 9 | allow_failures: 10 | - env: EMACS_VERSION=snapshot 11 | env: 12 | matrix: 13 | - EMACS_VERSION=25.1 14 | - EMACS_VERSION=25.2 15 | - EMACS_VERSION=25.3 16 | - EMACS_VERSION=26.1 17 | - EMACS_VERSION=snapshot 18 | before_install: 19 | - make setup 20 | install: 21 | - make install 22 | script: 23 | - make test # test uncompiled 24 | - make compile # test compilation 25 | - make test # test compiled 26 | - emacs -Q --batch --script devel/init.el 27 | -------------------------------------------------------------------------------- /frame-workflow-magit.el: -------------------------------------------------------------------------------- 1 | ;;; frame-workflow-magit.el --- Utilties that depend on magit -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 Akira Komamura 4 | 5 | ;; Author: Akira Komamura 6 | ;; Version: 1.0-pre 7 | ;; Package-Requires: ((emacs "25.1") (magit "2.0")) 8 | ;; Keywords: vc 9 | ;; URL: https://github.com/akirak/frame-workflow 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; License: 14 | 15 | ;; This program is free software: you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | ;; 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | ;; 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; This library provides extra utilities with magit dependency. 31 | 32 | ;;; Code: 33 | 34 | (require 'magit) 35 | 36 | ;;;###autoload 37 | (defun frame-workflow-magit-same-window () 38 | "Run `magit-status' in the same window. 39 | 40 | This function is intended as the value for 41 | `frame-workflow-directory-frame-action'." 42 | (let ((magit-display-buffer-function 43 | #'magit-display-buffer-same-window-except-diff-v1)) 44 | (call-interactively #'magit-status))) 45 | 46 | ;;;###autoload 47 | (defun frame-workflow-magit-only-window () 48 | "Make `magit-status' the only window in the frame." 49 | (frame-workflow-magit-same-window) 50 | (delete-other-windows)) 51 | 52 | (provide 'frame-workflow-magit) 53 | ;;; frame-workflow-magit.el ends here 54 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | EMAKE_SHA1 := 9095599536e5b3ad8c34a3dd3362dbb92ebf701f 2 | PACKAGE_LISP := frame-workflow.el frame-workflow-magit.el frame-workflow-editor.el helm-frame-workflow.el 3 | 4 | PACKAGE_ARCHIVES := gnu melpa 5 | #PACKAGE_TESTS := test-sample.el # normally, EMake would discover these in the test/ directory 6 | PACKAGE_TEST_DEPS := package-lint 7 | PACKAGE_TEST_ARCHIVES := gnu melpa 8 | 9 | EMACS ?= emacs 10 | CURL ?= curl 11 | 12 | EMAKE = PACKAGE_LISP="$(PACKAGE_LISP)" \ 13 | PACKAGE_ARCHIVES="$(PACKAGE_ARCHIVES)" \ 14 | PACKAGE_TEST_DEPS="$(PACKAGE_TEST_DEPS)" \ 15 | PACKAGE_TEST_ARCHIVES="$(PACKAGE_TEST_ARCHIVES)" \ 16 | $(EMACS) -batch -l emake.el \ 17 | --eval "(setq enable-dir-local-variables nil)" \ 18 | $(EMACS_ARGS) \ 19 | --eval "(emake (pop argv))" 20 | 21 | .PHONY: clean emacs setup install-emacs install lint compile 22 | 23 | clean:: ## clean all generated files 24 | rm -f *.elc # delete compiled files 25 | rm -rf .elpa/ # delete dependencies 26 | rm -rf .elpa.test/ 27 | rm -f emake.el 28 | 29 | emake.el: ## download the EMake script 30 | curl -O 'https://raw.githubusercontent.com/vermiculus/emake.el/$(EMAKE_SHA1)/emake.el' 31 | 32 | emacs-travis.mk: ## download the emacs-travis.mk Makefile 33 | $(CURL) -O 'https://raw.githubusercontent.com/flycheck/emacs-travis/master/emacs-travis.mk' 34 | 35 | emacs: emake.el ## report emacs version (installing $EMACS_VERSION if necessary) 36 | $(EMACS) -batch -l emake.el -f emake-verify-version 2>&1 || make install-emacs 37 | $(EMACS) --version 38 | 39 | setup: emacs 40 | 41 | install-emacs: emacs-travis.mk ## build and install a fresh emacs 42 | export PATH="$(HOME)/bin:$(PATH)" 43 | make -f emacs-travis.mk install_emacs 44 | 45 | .elpa: emake.el 46 | 47 | install: .elpa 48 | PACKAGE_FILE=frame-workflow.el $(EMAKE) install 49 | PACKAGE_FILE=frame-workflow-magit.el $(EMAKE) install 50 | PACKAGE_FILE=frame-workflow-editor.el $(EMAKE) install 51 | PACKAGE_FILE=helm-frame-workflow.el $(EMAKE) install 52 | lint: install 53 | $(EMAKE) test package-lint 54 | $(EMAKE) test checkdoc 55 | 56 | test: 57 | 58 | compile: install 59 | rm -f $(PACKAGE_LISP:.el=.elc) 60 | $(EMAKE) compile ~error-on-warn 61 | -------------------------------------------------------------------------------- /frame-workflow-editor.el: -------------------------------------------------------------------------------- 1 | ;;; frame-workflow-editor.el --- Temporary buffer for editing a Lisp object -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 by Akira Komamura 4 | 5 | ;; Author: Akira Komamura 6 | ;; Version: 0.1.0 7 | ;; Package-Requires: ((emacs "25.1")) 8 | ;; Keywords: convenience 9 | ;; URL: https://github.com/akirak/frame-workflow 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; License: 14 | 15 | ;; This program is free software: you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | ;; 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | ;; 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; This library provides `frame-workflow-editor-popup' command which creates a 31 | ;; temporary buffer of `emacs-lisp-mode'. 32 | 33 | ;;; Code: 34 | 35 | (defvar frame-workflow-editor-on-done) 36 | (make-variable-buffer-local 'frame-workflow-editor-on-done) 37 | 38 | (defvar frame-workflow-editor-mode-map 39 | (let ((map (make-sparse-keymap))) 40 | (define-key map (kbd "C-c C-c") #'frame-workflow-editor-done) 41 | (define-key map (kbd "C-c C-k") #'frame-workflow-editor-cancel) 42 | map) 43 | "Keymap for `frame-workflow-editor-mode'.") 44 | 45 | (define-derived-mode frame-workflow-editor-mode emacs-lisp-mode 46 | "Major mode for editing a Lisp object or expression." 47 | (use-local-map frame-workflow-editor-mode-map)) 48 | 49 | (defun frame-workflow-editor-popup (bufname insert-content on-done) 50 | "Pop to a buffer for editing a Lisp expression. 51 | 52 | BUFNAME is the name of a buffer. If there is a buffer of the same name, confirm 53 | discarding it." 54 | (declare (indent 1)) 55 | (catch 'abort 56 | (let (buf) 57 | (setq buf (get-buffer bufname)) 58 | (when (and buf (buffer-modified-p buf)) 59 | (if (yes-or-no-p (format "Buffer %s already exists and modified. Discard it?" 60 | bufname)) 61 | (progn (kill-buffer buf) 62 | (setq buf nil)) 63 | (pop-to-buffer buf) 64 | (throw 'abort 'conflict))) 65 | (with-current-buffer (or buf (generate-new-buffer bufname)) 66 | (erase-buffer) 67 | (kill-all-local-variables) 68 | (funcall insert-content) 69 | (set-buffer-modified-p nil) 70 | (frame-workflow-editor-mode) 71 | (setq frame-workflow-editor-on-done on-done) 72 | (setq-local header-line-format " C-c C-c to save, C-c C-k to cancel") 73 | (pop-to-buffer (current-buffer)))))) 74 | 75 | (defun frame-workflow-editor-done () 76 | (interactive) 77 | (funcall frame-workflow-editor-on-done) 78 | (kill-buffer)) 79 | 80 | (defun frame-workflow-editor-cancel () 81 | (interactive) 82 | (message "Aborted") 83 | (kill-buffer)) 84 | 85 | (provide 'frame-workflow-editor) 86 | ;;; frame-workflow-editor.el ends here 87 | -------------------------------------------------------------------------------- /frame-workflow-exwm.el: -------------------------------------------------------------------------------- 1 | ;;; frame-workflow-exwm.el --- Integrate frame-workflow with EXWM -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 by Akira Komamura 4 | 5 | ;; Author: Akira Komamura 6 | ;; Package-Version: 0.1 7 | ;; Package-Requires: ((emacs "25.1") (exwm "0.18")) 8 | ;; Keywords: frames unix 9 | ;; URL: https://github.com/akirak/frame-workflow 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; License: 14 | 15 | ;; This program is free software: you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | ;; 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | ;; 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; This library provides utilities to integrate frame-workflow with EXWM. 31 | 32 | ;;; Code: 33 | 34 | (require 'exwm-workspace) 35 | (require 'cl-lib) 36 | 37 | (defun frame-workflow-exwm--visible-workspace-index-alist () 38 | "Get an alist of visible EXWM workspaces." 39 | (cl-loop for i from 0 to (1- (exwm-workspace--count)) 40 | for frm = (exwm-workspace--workspace-from-frame-or-index i) 41 | when (exwm-workspace--active-p frm) 42 | collect (cons i frm))) 43 | 44 | (defun frame-workflow-exwm--format-with-index (index frame) 45 | "Return a string of INDEX:FRAME." 46 | (let ((name (frame-parameter frame 'workflow-prototype))) 47 | (concat (int-to-string index) 48 | (if name 49 | (concat ":" (symbol-name name)) 50 | "")))) 51 | 52 | (defun frame-workflow-exwm--2-combinations (list) 53 | "Return all combinations from LIST." 54 | (cl-loop for (i . r) on list by 'cdr 55 | append (cl-loop for j in r 56 | collect (list i j)))) 57 | 58 | (defun frame-workflow-exwm--select-two-visible-workspaces () 59 | "Select two visible workspaces." 60 | (pcase (frame-workflow-exwm--visible-workspace-index-alist) 61 | ;; Only one workspace: Do nothing 62 | (`(,_) nil) 63 | ;; Two workspaces 64 | (`((,_ . ,w1) (,_ . ,w2)) (list w1 w2)) 65 | ;; More than two workspaces: Select two via completing-read 66 | (wss (let* ((selections (frame-workflow-exwm--2-combinations wss)) 67 | (candidates (cl-loop for ((i1 . w1) (i2 . w2)) in selections 68 | collect (cons (concat (frame-workflow-exwm--format-with-index i1 w1) 69 | " <-> " 70 | (frame-workflow-exwm--format-with-index i2 w2)) 71 | (cons w1 w2)))) 72 | (result (completing-read "Workspaces to swap: " candidates nil t))) 73 | (pcase (cdr (assoc result candidates)) 74 | (`(,w1 . ,w2) (list w1 w2))))))) 75 | 76 | ;;;###autoload 77 | (defun frame-workflow-exwm-swap-workspaces (w1 w2) 78 | "Swap two workspaces. 79 | 80 | W1 and W2 are frames. 81 | 82 | If this function is called interactively, the user can select two workspaces 83 | from visible workspaces." 84 | (interactive (or (frame-workflow-exwm--select-two-visible-workspaces) 85 | '(nil nil))) 86 | (if (and (framep w1) (framep w2)) 87 | (exwm-workspace-swap w1 w2) 88 | (message "There is only one visible frame."))) 89 | 90 | (provide 'frame-workflow-exwm) 91 | ;;; frame-workflow-exwm.el ends here 92 | -------------------------------------------------------------------------------- /helm-frame-workflow.el: -------------------------------------------------------------------------------- 1 | ;;; helm-frame-workflow.el --- Helm sources for frame-workflow -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 by Akira Komamura 4 | 5 | ;; Author: Akira Komamura 6 | ;; Version: 1.0-pre 7 | ;; Package-Requires: ((emacs "25.1") (helm "2.7.0")) 8 | ;; URL: https://github.com/akirak/frame-workflow 9 | 10 | ;; This file is not part of GNU Emacs. 11 | 12 | ;;; License: 13 | 14 | ;; This program is free software: you can redistribute it and/or modify 15 | ;; it under the terms of the GNU General Public License as published by 16 | ;; the Free Software Foundation, either version 3 of the License, or 17 | ;; (at your option) any later version. 18 | ;; 19 | ;; This program is distributed in the hope that it will be useful, 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 | ;; GNU General Public License for more details. 23 | ;; 24 | ;; You should have received a copy of the GNU General Public License 25 | ;; along with this program. If not, see . 26 | 27 | ;;; Code: 28 | 29 | (require 'frame-workflow) 30 | (require 'helm) 31 | (require 'cl-lib) 32 | 33 | ;;;; Custom variables 34 | (defcustom helm-frame-workflow-exclude-current-frame t 35 | "Exclude the selected frame from candidates." 36 | :group 'helm-frame-workflow 37 | :type 'boolean) 38 | 39 | ;;;; Actions 40 | (defvar helm-frame-workflow-frame-actions 41 | '(("Select the frame" . frame-workflow--select-frame)) 42 | "Alist of actions on a frame.") 43 | 44 | (defvar helm-frame-workflow-subject-actions 45 | '(("Make a frame" . frame-workflow-make-frame) 46 | ("Edit the subject" . frame-workflow-edit-subject)) 47 | "Alist of actions on a subject.") 48 | 49 | ;;;; Classes for sources 50 | 51 | (defclass helm-frame-workflow-frames-class (helm-source-sync) 52 | ((candidates :initform 53 | (lambda () 54 | (helm-frame-workflow--exclude-selected-frame 55 | (mapcar (lambda (observer) 56 | (let* ((frame (oref observer frame)) 57 | (subject (frame-workflow--subject-name observer)) 58 | (title (frame-parameter frame 'name))) 59 | ;; TODO: Customizable format 60 | (cons (format "%-10s : %s" subject title) 61 | frame))) 62 | frame-workflow--observer-list)))) 63 | (action :initform 'helm-frame-workflow-frame-actions))) 64 | 65 | (defclass helm-frame-workflow-no-subject-frames-class (helm-source-sync) 66 | ((candidates :initform 67 | (lambda () 68 | (helm-frame-workflow--exclude-selected-frame 69 | (cl-loop for frame in (frame-list) 70 | unless (frame-parameter frame 'workflow) 71 | collect (cons (frame-parameter frame 'name) 72 | frame))))) 73 | (action :initform 'helm-frame-workflow-frame-actions))) 74 | 75 | (defclass helm-frame-workflow-subjects-class (helm-source-sync) 76 | ((candidates :initform 77 | (lambda () 78 | (mapcar (lambda (subject) 79 | (cons (oref subject name) 80 | subject)) 81 | frame-workflow--subject-list))) 82 | (action :initform 'helm-frame-workflow-subject-actions))) 83 | 84 | (defsubst helm-frame-workflow--exclude-selected-frame (candidates) 85 | "If necessary, exclude the selected frame from frame CANDIDATES." 86 | (if helm-frame-workflow-exclude-current-frame 87 | (cl-remove (selected-frame) candidates :key #'cdr :test #'eql) 88 | candidates)) 89 | 90 | ;;;; Concrete sources 91 | 92 | (defvar helm-frame-workflow-source-frames 93 | (helm-make-source "Frames with workflow" 94 | 'helm-frame-workflow-frames-class) 95 | "Helm source for frames with a subject.") 96 | 97 | (defvar helm-frame-workflow-source-no-subject-frames 98 | (helm-make-source "Frames without workflow" 99 | 'helm-frame-workflow-no-subject-frames-class) 100 | "Helm source for frames without a subject.") 101 | 102 | (defvar helm-frame-workflow-source-subjects 103 | (helm-make-source "Workflow subjects" 104 | 'helm-frame-workflow-subjects-class) 105 | "Helm source for workflow subjects.") 106 | 107 | ;;;; Command 108 | 109 | ;;;###autoload 110 | (defun helm-frame-workflow () 111 | "Helm command for frame-workflow." 112 | (interactive) 113 | (helm :sources '(helm-frame-workflow-source-frames 114 | helm-frame-workflow-source-no-subject-frames 115 | helm-frame-workflow-source-subjects) 116 | :buffer "*helm frame-workflow*" 117 | :prompt "frame-workflow: ")) 118 | 119 | (provide 'helm-frame-workflow) 120 | ;;; helm-frame-workflow.el ends here 121 | -------------------------------------------------------------------------------- /README.org: -------------------------------------------------------------------------------- 1 | #+title: frame-workflow.el: Per-Frame Workflow on Emacs 2 | 3 | [[https://travis-ci.org/akirak/frame-workflow.svg?branch=master]] 4 | 5 | =frame-workflow.el= lets you define and organize per-frame workflow for Emacs. This is yet another workspace solution such as eyebrowse, perspective, and framegroups. It is frame-oriented and supports frame-specific states and actions. It is also designed to integrate with [[https://github.com/alphapapa/frame-purpose.el][frame-purpose.el]] which lets you focus on particular things inside a frame. 6 | 7 | For background on frame-workflow, see [[https://github.com/akirak/frame-workflow/wiki/Inspirations][Inspirations]] in the Wiki. 8 | 9 | * Installation 10 | This package requires Emacs 25.1. 11 | 12 | The package is not available on MELPA at present, but it may be added in the future. Clone the repository and add the directory to =load-path=. Below is an example of MELPA-style recipe: 13 | 14 | #+BEGIN_SRC emacs-lisp 15 | (frame-workflow :fetcher github 16 | :repo "akirak/frame-workflow" 17 | :branch "eieio") 18 | #+END_SRC 19 | * Configuration 20 | #+BEGIN_SRC emacs-lisp 21 | (require 'frame-workflow) 22 | (frame-workflow-mode 1) 23 | 24 | ;; If you use helm-frame-workflow 25 | (autoload 'helm-frame-workflow "helm-frame-workflow") 26 | ;; Bind s-B on EXWM 27 | (exwm-input-set-key (kbd "s-B") 'helm-frame-workflow) 28 | #+END_SRC 29 | 30 | ** Subjects (or workspaces) 31 | A /subject/ is a type of frame in frame-workflow. You can create one frame or multiple frames for a subject. 32 | 33 | To define a subject, use =frame-workflow-define-subject=: 34 | 35 | #+BEGIN_SRC emacs-lisp 36 | (frame-workflow-define-subject "emacs-lisp" 37 | :make-frame '(frame-purpose-make-mode-frame 'emacs-lisp-mode)) 38 | #+END_SRC 39 | 40 | Every subject requires a name, which is a string to uniquely identify the subject. 41 | 42 | For more examples, see [[https://github.com/akirak/frame-workflow/wiki/Configuration-Examples][a Wiki page]]. 43 | 44 | ** Keybindings 45 | Frame-workflow provides a prefix map named =frame-workflow-prefix-map= for commands in the package. 46 | It may be convenient to bind a key to this command: 47 | 48 | #+begin_src emacs-lisp 49 | (global-set-key "s-g" #'frame-workflow-prefix-map) 50 | #+end_src 51 | 52 | You can also define keybindings to switch to a particular subject on this prefix map, and there are two ways to do that: 53 | 54 | - Customize =frame-workflow-prefix-subject-keys=. 55 | - Set =:key= option when you define a subject. 56 | 57 | The latter can be configured as in the following example: 58 | 59 | #+begin_src emacs-lisp 60 | (frame-workflow-define-subject "emacs-lisp" 61 | :key "e" 62 | ...) 63 | #+end_src 64 | 65 | Then you can use =s-g e= to switch to =emacs-lisp= subject. 66 | 67 | There is also a manual way. =frame-workflow-switch-frame= is a function that lets you switch to a frame for a given subject. You can use it to bind a key to switch to a particular workspace: 68 | 69 | #+BEGIN_SRC emacs-lisp 70 | (global-set-key (kbd "s-g e") 71 | (lambda () (interactive) (frame-workflow-switch-frame "emacs-lisp"))) 72 | #+END_SRC 73 | 74 | It is also a command that lets you select a subject via =completing-read=: 75 | 76 | #+BEGIN_SRC emacs-lisp 77 | (global-set-key "s-s" 'frame-workflow-switch-frame) 78 | #+END_SRC 79 | ** Directory subjects and projectile integration 80 | Frame-workflow provides a set of utilities to work with /directory subjects/. =frame-workflow-switch-directory-frame= function defines a subject for a directory and switches to a frame for the subject. 81 | 82 | If you are using projectile package, it may be a good idea to use this function as =projectile-switch-project-action=: 83 | 84 | #+begin_src emacs-lisp 85 | (setq projectile-switch-project-action #'frame-workflow-switch-directory-frame) 86 | #+end_src 87 | 88 | Directory subjects integrate with [[https://github.com/alphapapa/frame-purpose.el][frame-purpose.el]]. By default, frame-workflow uses frame-purpose to create a frame for a directory subject, so the frame becomes a purpose-specific frame for the directory. This means the buffer list on the frame is limited to buffers in the directory. If you want to turn off this feature, set =frame-workflow-use-frame-purpose-for-directory= to nil. 89 | 90 | By default, if magit is installed, a new frame for a directory subject runs =magit-status=. This can be changed to another function by customizing =frame-workflow-directory-frame-action=. If it is nil, directory subjects do nothing on frame creation. 91 | 92 | * Usage 93 | ** helm-frame-workflow 94 | =helm-frame-workflow= in =helm-frame-workflow.el= is a command which lets you switch to a frame or create a new frame for a subject. It provides access to all the basic functionalities of frame-workflow. 95 | ** Switching the context 96 | You can use the following commands to switch the context: 97 | 98 | - =frame-workflow-make-frame=, which creates a new frame of a given subject. 99 | - =frame-workflow-select-frame=, which selects an existing frame of a given subject. 100 | - =frame-workflow-switch-frame=, which selects an existing frame of a given subject if there is one. Otherwise, it creates a new frame. 101 | 102 | | | Select a frame | Create a frame | 103 | |-------------------------------+----------------+----------------| 104 | | =frame-workflow-make-frame= | No | Yes | 105 | | =frame-workflow-select-frame= | Yes | No | 106 | | =frame-workflow-switch-frame= | Yes | Yes | 107 | 108 | There is also =frame-workflow-switch-directory-frame=, which is like =frame-workflow-switch-frame= but switches to a frame for a directory subject. 109 | 110 | * Contribution 111 | Any comments and patches on this package are welcome. Create a ticket or a pull request on GitHub. 112 | * License 113 | GPL v3 114 | -------------------------------------------------------------------------------- /frame-workflow.el: -------------------------------------------------------------------------------- 1 | ;;; frame-workflow.el --- Frame-oriented workflow -*- lexical-binding: t -*- 2 | 3 | ;; Copyright (C) 2018 by Akira Komamura 4 | 5 | ;; Author: Akira Komamura 6 | ;; Version: 0.1.9 7 | ;; Package-Requires: ((emacs "25.1")) 8 | ;; Keywords: frames 9 | ;; URL: https://github.com/akirak/frame-workflow 10 | 11 | ;; This file is not part of GNU Emacs. 12 | 13 | ;;; License: 14 | 15 | ;; This program is free software: you can redistribute it and/or modify 16 | ;; it under the terms of the GNU General Public License as published by 17 | ;; the Free Software Foundation, either version 3 of the License, or 18 | ;; (at your option) any later version. 19 | ;; 20 | ;; This program is distributed in the hope that it will be useful, 21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 23 | ;; GNU General Public License for more details. 24 | ;; 25 | ;; You should have received a copy of the GNU General Public License 26 | ;; along with this program. If not, see . 27 | 28 | ;;; Commentary: 29 | 30 | ;; This is a rewrite of frame-workflow using EIEIO. 31 | 32 | ;;; Code: 33 | 34 | (require 'eieio) 35 | (require 'eieio-base) 36 | (require 'subr-x) 37 | (autoload 'eieio-customize-object "eieio-custom") 38 | (require 'frame-workflow-editor) 39 | 40 | (declare-function frame-workflow-magit-same-window "frame-workflow-magit") 41 | 42 | ;;;; Variables 43 | 44 | (defconst frame-workflow-switch-frame-function-prefix 45 | "frame-workflow-switch-to-subject/") 46 | 47 | (defvar frame-workflow--subject-list nil "Used by `eieio-instance-tracker'.") 48 | (defvar frame-workflow--observer-list nil "Used by `eieio-instance-tracker'.") 49 | 50 | (defvar frame-workflow--buffer-killed nil 51 | "Observer instance where a buffer was killed.") 52 | 53 | (defvar frame-workflow-prefix-map) 54 | (define-prefix-command 'frame-workflow-prefix-map) 55 | (cl-letf ((map frame-workflow-prefix-map)) 56 | (define-key map (kbd "R") #'frame-workflow-reload-layout) 57 | (define-key map (kbd "/") #'frame-workflow-select-frame) 58 | (define-key map (kbd "=") #'frame-workflow-make-frame)) 59 | 60 | (defvar frame-workflow-select-frame-hook nil 61 | "Hooks run after a frame is selected.") 62 | 63 | ;;;;; Modeline 64 | 65 | (defcustom frame-workflow-mode-line 66 | '(:eval (concat " Frame" 67 | ;; TODO: Make this a separate function 68 | (if-let ((name (frame-workflow--frame-subject-name))) 69 | (format "[%s]" name) 70 | ""))) 71 | "Mode line lighter for frame-workflow." 72 | :group 'frame-workflow 73 | :type 'sexp 74 | :risky t) 75 | 76 | ;;;; Other customizations 77 | 78 | (defcustom frame-workflow-directory-frame-action 79 | #'frame-workflow-maybe-magit 80 | "Function called after a directory frame is created. 81 | 82 | This function is called in `frame-workflow-make-directory-frame' 83 | after a directory frame is called. The function is called with 84 | `default-directory' set to the directory. 85 | 86 | If this value is nil, no function is called in directory frames." 87 | :type 'function 88 | :group 'frame-workflow) 89 | 90 | (defcustom frame-workflow-use-frame-purpose-for-directory t 91 | "Use frame-purpose to create a directory frame. 92 | 93 | If this value is non-nil, directory subjects defined by 94 | `frame-workflow-make-directory-frame' uses 95 | `frame-purpose-make-directory-frame' to create a new frame for a given 96 | directory. The frame becomes a purpose-specific frame for 97 | the directory, which makes it easy for you to focus on files in the 98 | directory." 99 | :type 'boolean 100 | :group 'frame-workflow) 101 | 102 | ;; Because this function is used inside a definition of 103 | ;; `frame-workflow-subject-keys' custom variable, it must be defined 104 | ;; before the variable. This is irregular, but I didn't find 105 | ;; a better solution. 106 | (defun frame-workflow-make-switch-subject (subject) 107 | "Make a command to switch to SUBJECT." 108 | (let ((func-name (intern (concat frame-workflow-switch-frame-function-prefix subject)))) 109 | (eval 110 | `(defun ,func-name () 111 | (interactive) 112 | (frame-workflow-switch-frame ,subject))))) 113 | 114 | ;; Add a name-based which-key replacement rule. 115 | (add-hook 'which-key-replacement-alist 116 | `((nil . ,frame-workflow-switch-frame-function-prefix) . 117 | (nil . ""))) 118 | 119 | (defcustom frame-workflow-subject-keys nil 120 | "Alist of keybindings to switch to a particular subject. 121 | 122 | These keybindings are accessible in `frame-workflow-prefix-map'." 123 | :type '(alist :key-type (string :tag "Key (usually one letter)") 124 | :value-type (string :tag "Subject")) 125 | :group 'frame-workflow 126 | :set (lambda (symbol value) 127 | (set-default symbol value) 128 | (cl-loop for (key . subject) in value 129 | do (define-key frame-workflow-prefix-map (kbd key) 130 | (frame-workflow-make-switch-subject subject))))) 131 | 132 | ;;;; Minor mode 133 | 134 | ;;;###autoload 135 | (define-minor-mode frame-workflow-mode 136 | "Toggle `frame-workflow-mode`." 137 | :global t 138 | :group 'frame-workflow 139 | :require 'frame-workflow 140 | :lighter frame-workflow-mode-line 141 | :init-value nil 142 | (if frame-workflow-mode 143 | (frame-workflow--enable) 144 | (frame-workflow--disable))) 145 | 146 | (defun frame-workflow--enable () 147 | "Turn on `frame-workflow-mode'." 148 | (add-hook 'kill-buffer-hook 'frame-workflow--kill-buffer-hook t) 149 | (add-hook 'delete-frame-functions 'frame-workflow--delete-frame t)) 150 | 151 | (defun frame-workflow--disable () 152 | "Turn off `frame-workflow-mode'." 153 | (remove-hook 'kill-buffer-hook 'frame-workflow--kill-buffer-hook) 154 | (remove-hook 'delete-frame-functions 'frame-workflow--delete-frame)) 155 | 156 | (defun frame-workflow--delete-frame (frame) 157 | "Run hooks for frame-workflow on deleting FRAME." 158 | (when-let ((observer (frame-parameter frame 'workflow))) 159 | (delete-instance observer))) 160 | 161 | (defun frame-workflow--kill-buffer-hook () 162 | "Hook run when a buffer is being killed." 163 | (when-let ((window (get-buffer-window))) 164 | (setq frame-workflow--buffer-killed 165 | (frame-workflow--frame-observer (window-frame window))) 166 | (run-with-timer 0.025 nil #'frame-workflow--post-kill-buffer))) 167 | 168 | ;;;; Subjects 169 | 170 | (defclass frame-workflow-subject (eieio-instance-tracker 171 | eieio-instance-inheritor 172 | ;; eieio-named 173 | eieio-persistent) 174 | ((tracking-symbol :initform frame-workflow--subject-list) 175 | (name :initarg :name 176 | :type string 177 | :documentation "Name to uniquely identify this type.") 178 | (observer-class :initarg :observer-class 179 | :initform 'frame-workflow-observer 180 | :type class 181 | :documentation "`frame-workflow-observer' class or its subclass.") 182 | (make-frame :initarg :make-frame 183 | :type (or function list) 184 | :initform #'make-frame 185 | :documentation "A function that returns a new frame.") 186 | (layout :initarg :layout 187 | :type list 188 | :initform nil 189 | :documentation "Lisp code run after frame creation.") 190 | (refocus :initarg :refocus 191 | :type list 192 | :initform nil 193 | :documentation "Lisp code run when explicitly switching to an 194 | existing frame of the subject.") 195 | (after-kill-buffer :initarg :after-kill-buffer 196 | :type list 197 | :initform nil 198 | :documentation "Lisp code run after a buffer is killed.")) 199 | "An object that specifies workflow on a frame.") 200 | 201 | (cl-defun frame-workflow-define-subject (name &rest args 202 | &key key 203 | &allow-other-keys) 204 | "Define a workflow subject. 205 | 206 | NAME is a string to uniquely identify the subject. 207 | 208 | ARGS is a plist of arguments passed to `frame-workflow-subject'. 209 | 210 | You can define KEY to switch to the subject. This is bound on 211 | `frame-workflow-prefix-map'. This should be a string." 212 | (declare (indent 1)) 213 | (cl-remf args :key) 214 | (let ((existing (frame-workflow--find-subject name)) 215 | (new (apply #'make-instance 'frame-workflow-subject 216 | :name name :file name 217 | args))) 218 | (when key 219 | (define-key frame-workflow-prefix-map (kbd key) 220 | (frame-workflow-make-switch-subject name))) 221 | (when existing 222 | (frame-workflow--replace-subject existing new)) 223 | new)) 224 | 225 | (cl-defmethod frame-workflow--replace-subject ((old frame-workflow-subject) 226 | (new frame-workflow-subject)) 227 | "Replace a subject OLD with NEW. 228 | 229 | This is used to update a subject of the same name." 230 | ;; Replace references to old subjects from observers 231 | (mapc (lambda (obj) 232 | (frame-workflow--maybe-replace-subject 233 | (cl-coerce obj 'frame-workflow-observer) 234 | old new)) 235 | frame-workflow--observer-list) 236 | ;; Delete the old subject from the instance list 237 | (delete-instance old)) 238 | 239 | (cl-defmethod frame-workflow--make-frame ((subject frame-workflow-subject)) 240 | "Create a frame of SUBJECT. 241 | 242 | SUBJECT is an object of `frame-workflow-subject' class or its subclass." 243 | (let* ((observer-class (oref subject observer-class)) 244 | (local-make-frame (oref subject make-frame)) 245 | (frame (cl-etypecase local-make-frame 246 | (function (funcall local-make-frame)) 247 | (list (eval local-make-frame)))) 248 | (observer (make-instance (if (fboundp observer-class) 249 | observer-class 250 | 'frame-workflow-observer) 251 | :subject subject :frame frame))) 252 | (set-frame-parameter frame 'workflow observer) 253 | (when-let ((layout (oref subject layout))) 254 | (with-selected-frame frame 255 | (eval layout))) 256 | frame)) 257 | 258 | ;;;;; Interactive editing 259 | (defun frame-workflow--subject-editor-name (name) 260 | "The name of a buffer to edit a subject with NAME." 261 | (format "*frame-workflow subject %s*" name)) 262 | 263 | ;;;; Observers 264 | 265 | (defclass frame-workflow-observer (eieio-instance-tracker) 266 | ((tracking-symbol :initform frame-workflow--observer-list) 267 | (subject :initarg :subject 268 | :type frame-workflow-subject 269 | :documentation "Frame subject which created this frame.") 270 | (subject-name :documentation "Name of the frame type." 271 | :reader frame-workflow--subject-name) 272 | (frame :initarg :frame 273 | :type frame 274 | :documentation "Emacs frame object.")) 275 | "An object that tracks events on a frame and holds ephemeral states.") 276 | 277 | (cl-defmethod frame-workflow--subject-name ((obj frame-workflow-observer)) 278 | (oref (oref obj subject) name)) 279 | 280 | (cl-defmethod frame-workflow--maybe-replace-subject ((obj frame-workflow-observer) 281 | (old frame-workflow-subject) 282 | (new frame-workflow-subject)) 283 | (when (eq (oref obj subject) old) 284 | (oset obj subject new))) 285 | 286 | ;;;; Utility functions 287 | 288 | (defun frame-workflow--subject-names () 289 | "Return a list of names lf all subject objects." 290 | (mapcar (lambda (obj) (oref obj name)) frame-workflow--subject-list)) 291 | 292 | (defun frame-workflow--find-subject (name) 293 | "Find a subject object with NAME." 294 | (eieio-instance-tracker-find name 'name 'frame-workflow--subject-list)) 295 | 296 | (defun frame-workflow--other-frame-subject-names () 297 | "Types names of frames excluding the selected frame." 298 | (cl-loop for instance in frame-workflow--observer-list 299 | unless (equal (oref instance frame) (selected-frame)) 300 | collect (frame-workflow--subject-name instance))) 301 | 302 | (defun frame-workflow--frame-observer (&optional frame) 303 | "Return the observer of FRAME if it has one." 304 | (let ((obj (frame-parameter frame 'workflow))) 305 | (when (frame-workflow-observer-p obj) 306 | obj))) 307 | 308 | (defun frame-workflow--frame-subject-name (&optional frame) 309 | "Get the subject name of FRAME." 310 | (when-let ((observer (frame-workflow--frame-observer frame))) 311 | (frame-workflow--subject-name observer))) 312 | 313 | (defun frame-workflow--find-frame-by-subject (subject) 314 | "Find a frame by SUBJECT. 315 | 316 | SUBJECT can be either the name of a subject or an instance. 317 | 318 | If there are multiple frames of the subject, this returns only the first one." 319 | (when-let ((subject (cl-typecase subject 320 | (frame-workflow-subject subject) 321 | (string (frame-workflow--find-subject subject)))) 322 | (observer (frame-workflow--find-observer 'subject subject))) 323 | (oref observer frame))) 324 | 325 | (cl-defun frame-workflow--select-frame (frame) 326 | "Internal function to select FRAME." 327 | ;; TODO: Make this customizable 328 | (select-frame-set-input-focus frame) 329 | (run-hooks 'frame-workflow-select-frame-hook)) 330 | 331 | (defun frame-workflow--find-observer (slot key &optional no-clean-up) 332 | "Find an observer instance that matches the condition. 333 | 334 | This function internally uses `eieio-instance-tracker-find' to find an instance 335 | whose SLOT is KEY. It also deletes observers that are linked to dead frames 336 | using `frame-workflow--clean-up-observers' before advance to ensure that 337 | the result is \"live\". To skip this clean-up step, set NO-CLEAN-UP to non-nil." 338 | (unless no-clean-up 339 | (frame-workflow--clean-up-observers)) 340 | (eieio-instance-tracker-find key slot 'frame-workflow--observer-list)) 341 | 342 | (defun frame-workflow--clean-up-observers () 343 | "Delete observers that are linked to dead frames." 344 | (mapc (lambda (observer) 345 | (unless (frame-live-p (oref observer frame)) 346 | (delete-instance observer))) 347 | frame-workflow--observer-list)) 348 | 349 | (defun frame-workflow--post-kill-buffer () 350 | "Hook run after a buffer is killed." 351 | (unwind-protect 352 | (when-let ((observer-non-nil frame-workflow--buffer-killed) 353 | (observer (cl-coerce observer-non-nil 354 | 'frame-workflow-observer)) 355 | (frame (oref observer frame)) 356 | (subject (oref observer subject)) 357 | (after-kill-buffer (oref subject after-kill-buffer))) 358 | (with-selected-frame frame 359 | (eval after-kill-buffer))) 360 | (setq frame-workflow--buffer-killed nil))) 361 | 362 | ;;;; Interactive commands 363 | 364 | (defun frame-workflow-make-frame (subject) 365 | "Create a frame of workflow SUBJECT." 366 | (interactive (list (completing-read "Create a frame: " 367 | (frame-workflow--subject-names)))) 368 | (unless frame-workflow-mode 369 | (user-error "Please turn on `frame-workflow-mode'")) 370 | (if-let ((subject (cl-etypecase subject 371 | (string (or (frame-workflow--find-subject subject) 372 | (frame-workflow-define-subject subject))) 373 | (frame-workflow-subject subject)))) 374 | (let ((frame (frame-workflow--make-frame subject))) 375 | (frame-workflow--select-frame frame) 376 | frame) 377 | (user-error "There is no subject named %s" subject))) 378 | 379 | (defun frame-workflow-replace-frame (subject) 380 | "Create a frame of workflow SUBJECT and delete the current frame." 381 | (interactive (list (completing-read "Create a frame: " 382 | (frame-workflow--subject-names)))) 383 | (unless frame-workflow-mode 384 | (user-error "Please turn on `frame-workflow-mode'")) 385 | (let ((orig-frame (selected-frame))) 386 | (frame-workflow-make-frame subject) 387 | (delete-frame orig-frame))) 388 | 389 | (defun frame-workflow-select-frame (subject) 390 | "Select a frame of workflow SUBJECT." 391 | (interactive (list (completing-read "Select a frame: " 392 | (frame-workflow--other-frame-subject-names)))) 393 | (unless frame-workflow-mode 394 | (user-error "Please turn on `frame-workflow-mode'")) 395 | (when-let ((frame (frame-workflow--find-frame-by-subject subject))) 396 | (if (equal frame (selected-frame)) 397 | (message "Same frame for %s" (cl-typecase subject 398 | (frame-workflow-subject (oref subject name)) 399 | (string subject))) 400 | (frame-workflow--select-frame frame)) 401 | (when-let ((observer (frame-workflow--frame-observer frame)) 402 | (subject (oref observer subject)) 403 | (refocus-hook (oref subject refocus))) 404 | (eval refocus-hook)) 405 | frame)) 406 | 407 | (defun frame-workflow-switch-frame (subject) 408 | "Select or create a frame of workflow SUBJECT." 409 | (interactive (list (completing-read "Select or create a frame: " 410 | (frame-workflow--subject-names)))) 411 | (unless frame-workflow-mode 412 | (user-error "Please turn on `frame-workflow-mode'")) 413 | (or (frame-workflow-select-frame subject) 414 | (frame-workflow-make-frame subject))) 415 | 416 | (defun frame-workflow-identify () 417 | "Display information on the workflow of the selected frame." 418 | (interactive) 419 | (unless frame-workflow-mode 420 | (user-error "Please turn on `frame-workflow-mode'")) 421 | (if-let ((workflow (frame-parameter nil 'workflow))) 422 | (message (frame-workflow--subject-name workflow)) 423 | (message "No workflow"))) 424 | 425 | (defun frame-workflow-edit-subject (subject) 426 | "Edit the definition of SUBJECT interactively." 427 | (interactive (list (completing-read "Edit a subject: " 428 | (frame-workflow--subject-names)))) 429 | (unless frame-workflow-mode 430 | (user-error "Please turn on `frame-workflow-mode'")) 431 | (if-let ((subject (cl-etypecase subject 432 | (frame-workflow-subject subject) 433 | (string (frame-workflow--find-subject subject)))) 434 | (name (oref subject name))) 435 | (frame-workflow-editor-popup (frame-workflow--subject-editor-name name) 436 | (lambda () 437 | (let ((standard-output (current-buffer))) 438 | (object-write subject))) 439 | (lambda () 440 | (let ((tmpfile (make-temp-file name))) 441 | (write-file tmpfile) 442 | (let ((obj (eieio-persistent-read tmpfile 'frame-workflow-subject t))) 443 | (frame-workflow--replace-subject subject obj))))) 444 | (user-error "There is no subject named %s" subject))) 445 | 446 | (defun frame-workflow-reload-layout (&optional frame) 447 | "Reload the default layout of FRAME." 448 | (interactive) 449 | (unless frame-workflow-mode 450 | (user-error "Please turn on `frame-workflow-mode'")) 451 | (when-let ((frame (or frame (selected-frame))) 452 | (observer (frame-workflow--frame-observer frame)) 453 | (subject (oref observer subject)) 454 | (layout (oref subject layout))) 455 | (with-selected-frame frame 456 | (eval layout)))) 457 | 458 | ;;;; Extra features 459 | ;;;;; Directory subjects 460 | 461 | ;;;###autoload 462 | (defun frame-workflow-switch-directory-frame (&optional dir) 463 | "Switch to a subject for DIR. 464 | 465 | This is intended for use as `projectile-switch-project-action'. 466 | 467 | This function defines a new subject for the given directory 468 | (if it is not defined yet) and selects or creates a frame 469 | for the subject. 470 | 471 | The name of the created subject will be name of the directory 472 | without its preceding path. 473 | 474 | If `frame-purpose-mode' is turned on and 475 | `frame-workflow-use-frame-purpose-for-directory' is non-nil, 476 | the created frame becomes a directory-purpose frame. 477 | 478 | If DIR is omitted, it defaults to `default-directory." 479 | (interactive) 480 | (unless frame-workflow-mode 481 | (user-error "Please turn on `frame-workflow-mode'")) 482 | (let* ((dir (expand-file-name (or dir default-directory))) 483 | (name (file-name-nondirectory (string-remove-suffix "/" dir))) 484 | (subject (or (frame-workflow--find-subject name) 485 | ;; TODO: Add a class for directory subjects and use it 486 | (frame-workflow-define-subject name 487 | :layout 488 | `(let ((default-directory ,dir)) 489 | (when (functionp frame-workflow-directory-frame-action) 490 | (funcall frame-workflow-directory-frame-action))) 491 | :make-frame 492 | `(let ((default-directory ,dir)) 493 | (if (and (bound-and-true-p frame-purpose-mode) 494 | frame-workflow-use-frame-purpose-for-directory) 495 | (frame-purpose-make-directory-frame ,dir) 496 | (make-frame))))))) 497 | (frame-workflow-switch-frame subject))) 498 | 499 | (defun frame-workflow-maybe-magit () 500 | "Run `magit-status' if it is available. Otherwise, run dired." 501 | (require 'frame-workflow-magit nil t) 502 | (if (fboundp #'frame-workflow-magit-same-window) 503 | (frame-workflow-magit-same-window) 504 | (dired default-directory))) 505 | 506 | (provide 'frame-workflow) 507 | ;;; frame-workflow.el ends here 508 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | --------------------------------------------------------------------------------