├── .gitignore ├── Makefile ├── Cask ├── .travis.yml ├── features ├── support │ └── env.el ├── create-load.feature ├── step-definitions │ └── desktop+-steps.el └── special.feature ├── README.md ├── desktop+.el └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | 2 | check: 3 | cask exec ecukes --no-win 4 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (source gnu) 2 | (source melpa) 3 | 4 | (package-file "desktop+.el") 5 | 6 | (development 7 | (depends-on "f") 8 | (depends-on "ecukes") 9 | (depends-on "ert-runner") 10 | (depends-on "el-mock") 11 | (depends-on "undercover")) 12 | 13 | (depends-on "f") 14 | (depends-on "dash") 15 | (depends-on "names") 16 | 17 | 18 | ;; Local Variables: 19 | ;; mode: emacs-lisp 20 | ;; End: 21 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: emacs-lisp 2 | before_install: 3 | - curl -fsSkL https://gist.github.com/rejeep/ebcd57c3af83b049833b/raw > x.sh && source ./x.sh 4 | - evm install $EVM_EMACS --use --skip 5 | - evm list | sort 6 | - cask 7 | env: 8 | - EVM_EMACS=emacs-24.5-travis 9 | - EVM_EMACS=emacs-25.1-travis 10 | script: 11 | - emacs --version 12 | - make check 13 | - grep -r . sandbox/desktops 14 | -------------------------------------------------------------------------------- /features/support/env.el: -------------------------------------------------------------------------------- 1 | (require 'f) 2 | 3 | (defvar desktop+-support-path 4 | (f-dirname load-file-name)) 5 | 6 | (defvar desktop+-features-path 7 | (f-parent desktop+-support-path)) 8 | 9 | (defvar desktop+-root-path 10 | (f-parent desktop+-features-path)) 11 | 12 | (defvar desktop+-sandbox-path 13 | (f-expand "sandbox/" desktop+-root-path)) 14 | 15 | (add-to-list 'load-path desktop+-root-path) 16 | 17 | (require 'undercover) 18 | (undercover "*.el") 19 | 20 | (require 'desktop+) 21 | (require 'espuds) 22 | (require 'ert) 23 | (require 'cl) 24 | 25 | (Setup 26 | (setq desktop+-base-dir (concat desktop+-sandbox-path "/desktops/")) 27 | (when (f-exists? desktop+-sandbox-path) 28 | (f-delete desktop+-sandbox-path :force)) 29 | (f-mkdir desktop+-sandbox-path) 30 | (f-mkdir desktop+-base-dir) 31 | (f-mkdir (concat desktop+-sandbox-path "/my-project")) 32 | 33 | (add-to-list 'desktop-clear-preserve-buffers "desktop\\+.el") 34 | (find-file "desktop+.el") 35 | (setq test/initial-buffers (buffer-list))) 36 | 37 | (Before 38 | ;; Before each scenario is run 39 | ) 40 | 41 | (After 42 | ;; After each scenario is run 43 | ) 44 | 45 | (Teardown 46 | ;; After when everything has been run 47 | ) 48 | -------------------------------------------------------------------------------- /features/create-load.feature: -------------------------------------------------------------------------------- 1 | Feature: Create and load sessions 2 | 3 | Scenario: Create, load, create 4 | Given I am in a fresh Emacs instance 5 | 6 | When I call M-x "desktop+-create" RET "named-session" RET 7 | Then Desktop session "named-session" should exist 8 | 9 | Given I start an action chain 10 | And I press "C-x C-f" 11 | And I type "/tmp/foo" 12 | And I execute the action chain 13 | And I type "something" 14 | And I press "C-x C-s" 15 | 16 | Given I am in a fresh Emacs instance 17 | When I call M-x "desktop+-load" RET "named-session" RET 18 | Then Buffer "foo" should exist 19 | 20 | Given I switch to buffer "foo" 21 | And I call "emacs-lisp-mode" 22 | And I call M-x "desktop+-create" RET "new-session" RET 23 | And I call M-x "kill-buffer" RET "foo" RET 24 | When I call M-x "desktop+-load" RET "named-session" RET 25 | Then Buffer "foo" should exist 26 | 27 | When I switch to buffer "foo" 28 | Then Variable "major-mode" should be "emacs-lisp-mode" 29 | 30 | Scenario: Create & load autonamed sessions 31 | Given I am in a fresh Emacs instance 32 | And I switch to directory "my-project" 33 | 34 | Given I call "desktop+-create-auto" 35 | And I start an action chain 36 | And I press "C-x C-f" 37 | And I type "/tmp/foo" 38 | And I execute the action chain 39 | And I type "something" 40 | And I press "C-x C-s" 41 | 42 | Given I am in a fresh Emacs instance 43 | And I switch to directory "my-project" 44 | 45 | When I call "desktop+-load-auto" 46 | Then Buffer "foo" should exist 47 | -------------------------------------------------------------------------------- /features/step-definitions/desktop+-steps.el: -------------------------------------------------------------------------------- 1 | ;; This file contains your project specific step definitions. All 2 | ;; files in this directory whose names end with "-steps.el" will be 3 | ;; loaded automatically by Ecukes. 4 | 5 | (Given "^I am in a fresh Emacs instance$" 6 | (lambda () 7 | (desktop-kill) 8 | (setq desktop-dirname nil) 9 | (desktop-save-mode -1) 10 | (letf (((symbol-function 'yes-or-no-p) 11 | (lambda (&args) t))) 12 | (mapc (lambda (buffer) 13 | (when (not (memq buffer test/initial-buffers)) 14 | (kill-buffer buffer))) 15 | (buffer-list))) 16 | (switch-to-buffer "*scratch*") 17 | (cd desktop+-sandbox-path))) 18 | 19 | (Given "^I switch to directory \"\\([^\"]+\\)\"$" 20 | (lambda (name) 21 | (message "%s" default-directory) 22 | (cd name))) 23 | 24 | (When "^I call M-x \"\\([^\"]+\\)\" RET \"\\([^\"]+\\)\" RET$" 25 | (lambda (command arg) 26 | (When "I start an action chain") 27 | (When "I press \"M-x\"") 28 | (When (format "I type \"%s\"" command)) 29 | (When "I press \"RET\"") 30 | (When (format "I type \"%s\"" arg)) 31 | (When "I execute the action chain"))) 32 | 33 | (When "I rename the buffer \"\\([^\"]+\\)\"$" 34 | (lambda (name) 35 | (rename-buffer name))) 36 | 37 | (Then "^Desktop session \"\\([^\"]+\\)\" should exist$" 38 | (lambda (session) 39 | (let ((path (f-expand session desktop+-base-dir))) 40 | (cl-assert (f-exists? path) nil 41 | "Expected path `%s' to exist" 42 | path)))) 43 | 44 | (Then "^Buffer \"\\([^\"]+\\)\" should exist$" 45 | (lambda (name) 46 | (cl-assert (get-buffer name) nil 47 | "Expected buffer `%s' to exist; list of current buffers:\n%s" 48 | name (buffer-list)))) 49 | 50 | (Then "^Variable \"\\([^\"]+\\)\" should be \"\\([^\"]+\\)\"$" 51 | (lambda (var val) 52 | (cl-assert (string= val (symbol-value (intern var))) nil 53 | "Expected `%s' to be `%s'; found `%s' instead" 54 | var val (symbol-value (intern var))))) 55 | 56 | (Then "^Program \"\\([^\"]+\\)\" should be running$" 57 | (lambda (program) 58 | (cl-assert (get-buffer-process (current-buffer)) nil 59 | "No process running in the buffer") 60 | (let ((command (car (last (process-command 61 | (get-buffer-process (current-buffer))))))) 62 | (cl-assert (string= program command) nil 63 | "Expected process `%s' to be running; found `%s' instead" 64 | program command)))) 65 | 66 | (Given "^I sleep for \"\\([0-9]+\\)\" seconds?$" 67 | (lambda (seconds callback) 68 | (let* ((target (+ (float-time) (string-to-number seconds)))) 69 | ;; sometimes `sleep-for' returns early... 70 | ;; circumvent this by busy-waiting until enough time has passed 71 | (while (< (float-time) target) 72 | (sleep-for (- target (float-time)))) 73 | (funcall callback)))) 74 | -------------------------------------------------------------------------------- /features/special.feature: -------------------------------------------------------------------------------- 1 | Feature: Handle special buffers 2 | 3 | Scenario: Handle terminal buffer 4 | Given I am in a fresh Emacs instance 5 | When I call M-x "desktop+-create" RET "terminal" RET 6 | Then Desktop session "terminal" should exist 7 | 8 | When I switch to directory "/tmp" 9 | And I start an action chain 10 | And I press "M-x" 11 | And I type "term" 12 | And I press "RET C-S-" 13 | And I type "/bin/cat" 14 | And I execute the action chain 15 | And I rename the buffer "*my-terminal*" 16 | 17 | Given I am in a fresh Emacs instance 18 | When I call M-x "desktop-load" RET "terminal" RET 19 | Then Buffer "*my-terminal*" should exist 20 | When I switch to buffer "*my-terminal*" 21 | Then Variable "default-directory" should be "/tmp/" 22 | And Program "/bin/cat" should be running 23 | 24 | 25 | Scenario: Handle compilation buffer 26 | Given I am in a fresh Emacs instance 27 | When I call M-x "desktop+-create" RET "compilation" RET 28 | Then Desktop session "compilation" should exist 29 | 30 | When I switch to directory "/tmp" 31 | And I start an action chain 32 | And I press "M-x" 33 | And I type "compile" 34 | And I press "RET C-S-" 35 | And I type "echo OK" 36 | And I execute the action chain 37 | 38 | Given I am in a fresh Emacs instance 39 | When I call M-x "desktop+-load" RET "compilation" RET 40 | Then Buffer "*compilation*" should exist 41 | When I switch to buffer "*compilation*" 42 | And I press "g" 43 | Then I should see pattern "/tmp/" 44 | And I should see pattern "^echo OK" 45 | 46 | 47 | Scenario: Handle indirect buffer 48 | Given I am in a fresh Emacs instance 49 | When I call M-x "desktop+-create" RET "indirect-buffer" RET 50 | Then Desktop session "indirect-buffer" should exist 51 | 52 | And I start an action chain 53 | And I press "C-x C-f" 54 | And I type "/tmp/foo" 55 | And I execute the action chain 56 | And I type "some content" 57 | And I press "C-x C-s" 58 | And I press "C-x 4 c" 59 | Then Buffer "foo" should exist 60 | And Buffer "foo<2>" should exist 61 | 62 | Given I am in a fresh Emacs instance 63 | When I call M-x "desktop+-load" RET "indirect-buffer" RET 64 | Then Buffer "foo" should exist 65 | And Buffer "foo<2>" should exist 66 | When I switch to buffer "foo<2>" 67 | Then I should see pattern "some content" 68 | 69 | 70 | Scenario: Handle org agenda buffer 71 | Given I am in a fresh Emacs instance 72 | When I call M-x "desktop+-create" RET "org-agenda-list" RET 73 | Then Desktop session "org-agenda-list" should exist 74 | 75 | Given I start an action chain 76 | And I press "M-x" 77 | And I type "org-agenda" 78 | And I press "RET" 79 | And I press "a" 80 | And I execute the action chain 81 | Then Buffer "*Org Agenda*" should exist 82 | 83 | Given I am in a fresh Emacs instance 84 | When I call M-x "desktop+-load" RET "org-agenda-list" RET 85 | Then Buffer "*Org Agenda*" should exist 86 | 87 | Given I switch to buffer "*Org Agenda*" 88 | Then I should see "Monday" 89 | 90 | 91 | Scenario: Handle org todo buffer 92 | Given I am in a fresh Emacs instance 93 | When I call M-x "desktop+-create" RET "org-todo-list" RET 94 | Then Desktop session "org-todo-list" should exist 95 | 96 | Given I start an action chain 97 | And I press "M-x" 98 | And I type "org-agenda" 99 | And I press "RET" 100 | And I press "t" 101 | And I execute the action chain 102 | Then Buffer "*Org Agenda*" should exist 103 | 104 | Given I am in a fresh Emacs instance 105 | When I call M-x "desktop+-load" RET "org-todo-list" RET 106 | Then Buffer "*Org Agenda*" should exist 107 | 108 | Given I switch to buffer "*Org Agenda*" 109 | Then I should see "TODO" 110 | 111 | 112 | Scenario: Handle man buffer 113 | Given I am in a fresh Emacs instance 114 | When I call M-x "desktop+-create" RET "man" RET 115 | Then Desktop session "man" should exist 116 | 117 | When I start an action chain 118 | And I press "M-x" 119 | And I type "man" 120 | And I press "RET cat" 121 | And I execute the action chain 122 | Given I sleep for "1" second 123 | Then Buffer "*Man cat*" should exist 124 | 125 | Given I am in a fresh Emacs instance 126 | When I call M-x "desktop+-load" RET "man" RET 127 | Given I sleep for "1" second 128 | Then Buffer "*Man cat*" should exist 129 | 130 | Given I switch to buffer "*Man cat*" 131 | Then I should see "CAT" 132 | 133 | 134 | Scenario: Handle shell directory 135 | Given I am in a fresh Emacs instance 136 | When I call M-x "desktop+-create" RET "shell" RET 137 | Then Desktop session "shell" should exist 138 | 139 | When I switch to directory "/tmp" 140 | When I start an action chain 141 | And I press "M-x" 142 | And I type "shell" 143 | And I press "RET" 144 | And I execute the action chain 145 | 146 | Given I am in a fresh Emacs instance 147 | When I call M-x "desktop+-load" RET "shell" RET 148 | Then Buffer "*shell*" should exist 149 | When I switch to buffer "*shell*" 150 | Then Variable "default-directory" should be "/tmp/" 151 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # desktop+ 2 | [![Build-Status](https://travis-ci.org/ffevotte/desktop-plus.svg)](https://travis-ci.org/ffevotte/desktop-plus) [![Coverage-Status](https://coveralls.io/repos/ffevotte/desktop-plus/badge.svg?branch=master&service=github)](https://coveralls.io/github/ffevotte/desktop-plus?branch=master) [![Tag](https://img.shields.io/github/tag/ffevotte/desktop-plus.svg)](https://github.com/ffevotte/desktop-plus/releases) [![MELPA](http://melpa.org/packages/desktop+-badge.svg)](http://melpa.org/#/desktop%2B) [![License](https://img.shields.io/badge/license-GPL_v3-blue.svg)](http://www.gnu.org/licenses/gpl-3.0.html) 3 | 4 | `desktop+` extends `desktop` by providing more features related to sessions persistance. 5 | 6 | 7 | 1. Instead of relying on Emacs' starting directory to choose the session Emacs restarts, sessions are manipulated by name. All information about them is stored into a centralized directory. 8 | 9 | 2. Desktop sessions by default save only buffers associated to "real" files. Desktop+ extends this by handling also "special buffers". The list of currently supported special buffer types is: 10 | - compilation buffers (in `compilation-mode`) 11 | - terminal buffers (in `term-mode`) 12 | - org agenda & todo lists (in `org-agenda-mode`) 13 | - indirect buffers (a.k.a clones). 14 | - man pages (in `Man-mode`) 15 | - shell buffers (in `shell-mode`) 16 | 17 | 18 | 19 | ## Installation 20 | 21 | `desktop+` can be found on MELPA and it's the recommended way of installing it. 22 | 23 | Otherwise, you can install it manually. First install `desktop+` dependencies: 24 | [`dash`](http://github.com/magnars/dash.el) and 25 | [`f`](http://github.com/rejeep/f.el). Then: 26 | 27 | 1. clone the git repository: 28 | 29 | ```sh 30 | $ git clone https://github.com/ffevotte/desktop-plus.git 31 | ``` 32 | 33 | 2. tell emacs where to find it, for example by adding a snippet like this in 34 | your `init.el` file: 35 | 36 | ```lisp 37 | (add-to-list 'load-path "/path/to/desktop-plus") 38 | (require 'desktop+) 39 | ``` 40 | 41 | 42 | ## Usage 43 | 44 | ### From Emacs 45 | 46 | #### Named sessions 47 | 48 | Two functions are defined to manipulate desktop sessions by name: 49 | 50 | - `desktop-create`: create a new session and give it a name. 51 | 52 | - `desktop-load`: change the current session; the new session to be loaded is identified by its name, as given during session creation using `desktop-create`. The currently active session is identified in the title bar. 53 | 54 | As a special case, if the session name is left blank when calling one of these two functions, a name is automatically derived from the current working directory (see "Auto-named sessions" below). 55 | 56 | Once created or loaded, sessions are automatically saved when exiting emacs or changing session. 57 | 58 | #### Auto-named sessions 59 | 60 | It is also possible to create and load sessions without explicitly specifying a name. These sessions are then automatically named after the current working directory. This can be done either by leaving the session name blank when calling `desktop-create` or `desktop-load`, or by using their dedicated counterparts: 61 | 62 | - `desktop-create-auto`: create a new auto-named session. 63 | 64 | - `desktop-load-auto`: load a previously created auto-named session. 65 | 66 | 67 | ### From the shell command-line 68 | 69 | If you want to invoke Emacs from the command-line and specify a session to load at startup, you can define the following useful bash function: 70 | 71 | ```sh 72 | function emacs-desktop () { 73 | emacs --eval '(desktop-load "'"$1"'")' 74 | } 75 | ``` 76 | 77 | You can then invoke a named session directly from the command-line: 78 | 79 | ```sh 80 | $ emacs-desktop my-session 81 | ``` 82 | 83 | or an auto-named session: 84 | 85 | ```sh 86 | $ cd /path/to/working/directory 87 | $ emacs-desktop 88 | ``` 89 | 90 | ## Customization 91 | 92 | - `desktop+-base-dir`: directory where all information about desktop sessions are stored. The default value is `"~/.emacs.d/desktops/"`. 93 | 94 | - `desktop+-frame-title-function`: function called to get the new frame title format when the session changes. This function must take the desktop session name as a string argument and return a frame title format suitable for setting `frame-title-format`. 95 | 96 | Customize it to change the way session names are displayed. For example: 97 | 98 | ```lisp 99 | (defun my/desktop-frame-title-function (desktop-name) 100 | (list (concat "%b - Emacs [" desktop-name "]"))) 101 | 102 | (setq desktop+-frame-title-function 103 | 'my/desktop-frame-title-function) 104 | ``` 105 | 106 | - `desktop+-special-buffer-handlers`: list of special buffer types which should 107 | be handled specially. The default value contains all known types. You can 108 | remove some of them if you want. 109 | 110 | ```lisp 111 | ;; remove items from the list if you don't want a specific special buffer 112 | ;; type to be handled. 113 | ;; 114 | ;; The value of this variable should be changed before `desktop+` is loaded. 115 | (setq desktop+-special-buffer-handlers 116 | '(term-mode 117 | compilation-mode 118 | org-agenda-mode 119 | indirect-buffer 120 | Man-mode 121 | shell-mode)) 122 | ``` 123 | 124 | 125 | ## API 126 | 127 | - `(desktop+-add-handler NAME PRED SAVE-FN LOAD-FN)` 128 | 129 | Add handlers for special buffers. 130 | 131 | NAME is a symbol identifying the handler for later activation or deactivation. 132 | 133 | PRED should be a unary function used as a predicate to determine whether a buffer should be handled specially. When called in a buffer which should be handled, PRED should return non-nil. 134 | 135 | SAVE-FN should be a function taking no parameter, returning a list of all relevant parameters for the current buffer, which is assumed to be in the given major mode. 136 | 137 | LOAD-FN should be a function of the form `(lambda (name &rest args) ...)` allowing to restore a buffer named NAME in major mode MODE, from information stored in ARGS, as determined by SAVE-FN.. 138 | 139 | 140 | ## Contributing 141 | 142 | If you make improvements to this code or have suggestions, please do not 143 | hesitate to fork the repository or submit bug reports on 144 | [github](https://github.com/ffevotte/desktop-plus). The repository's URL is: 145 | 146 | https://github.com/ffevotte/desktop-plus.git 147 | 148 | ### Contributors 149 | 150 | - [Dryvenn](https://github.com/dryvenn) introduced auto-named sessions; 151 | - [Brian Malehorn](https://github.com/bmalehorn) contributed Man-mode and shell-mode buffers handling. 152 | 153 | Thanks! 154 | 155 | 156 | ## License 157 | 158 | Copyright (C) 2014-2017 François Févotte. 159 | 160 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU 161 | General Public License as published by the Free Software Foundation, either version 3 of the 162 | License, or (at your option) any later version. 163 | 164 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without 165 | even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 166 | General Public License for more details. 167 | 168 | You should have received a copy of the GNU General Public License along with this program. If not, 169 | see . 170 | -------------------------------------------------------------------------------- /desktop+.el: -------------------------------------------------------------------------------- 1 | ;;; desktop+.el --- Handle special buffers when saving & restoring sessions 2 | 3 | ;; Copyright (C) 2014-2015 François Févotte 4 | ;; Author: François Févotte 5 | ;; URL: https://github.com/ffevotte/desktop-plus 6 | ;; Version: 0.1.1 7 | ;; Package-Requires: ((emacs "24.4") (dash "2.11.0") (f "0.17.2")) 8 | 9 | ;; This file is NOT part of Emacs 10 | 11 | ;; This program is free software: you can redistribute it and/or modify 12 | ;; it under the terms of the GNU General Public License as published by 13 | ;; the Free Software Foundation, either version 3 of the License, or 14 | ;; (at your option) any later version. 15 | 16 | ;; This program is distributed in the hope that it will be useful, 17 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 18 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 19 | ;; GNU General Public License for more details. 20 | 21 | ;; You should have received a copy of the GNU General Public License 22 | ;; along with this program. If not, see . 23 | 24 | ;;; Commentary: 25 | 26 | ;; `desktop+' extends `desktop' by providing more features related to 27 | ;; sessions persistance. 28 | 29 | ;; Centralized directory storing all desktop sessions: 30 | ;; 31 | ;; Instead of relying on Emacs' starting directory to choose the session 32 | ;; Emacs restarts, two functions are provided to manipulate sessions by 33 | ;; name. 34 | ;; 35 | ;; `desktop+-create': create a new session and give it a name. 36 | ;; 37 | ;; `desktop+-load': change the current session; the new session to be loaded 38 | ;; is identified by its name, as given during session creation using 39 | ;; `desktop-create'. 40 | ;; 41 | ;; The currently active session is identified in the title bar. You can 42 | ;; customize `desktop+-frame-title-function' to change the way the active 43 | ;; session is displayed. 44 | ;; 45 | ;; All sessions managed this way are stored in the directory given by 46 | ;; `desktop+-base-dir'. 47 | 48 | ;; Handling of special buffers: 49 | ;; 50 | ;; Desktop sessions by default save only buffers associated to "real" files. 51 | ;; Desktop+ extends this by handling also "special buffers", such as those 52 | ;; in `compilation-mode' or `term-mode', or indirect buffers (aka clones). 53 | 54 | ;;; Code: 55 | (eval-when-compile 56 | (require 'dash)) 57 | 58 | (require 'desktop) 59 | (require 'f) 60 | 61 | ;; * Named sessions 62 | 63 | ;; ** Customizable options 64 | 65 | (defvar desktop+-base-dir "~/.emacs.d/desktops/" 66 | "Base directory for desktop files.") 67 | 68 | (defvar desktop+-frame-title-function 'desktop+--frame-title 69 | "Function returning the frame title when a desktop session is loaded. 70 | 71 | This function must accept the desktop name as a string argument 72 | and return a frame title format suitable for setting 73 | `frame-title-format'") 74 | 75 | ;; ** Entry points 76 | 77 | ;;;###autoload 78 | (defun desktop+-create (name) 79 | "Create a new session, identified by a name. 80 | The session is created in a subdirectory of `desktop+-base-dir'. 81 | It can afterwards be reloaded using `desktop+-load'. 82 | 83 | As a special case, if NAME is left blank, the session is 84 | automatically named after the current working directory." 85 | (interactive "MDesktop name: ") 86 | (desktop-kill) 87 | (setq desktop-dirname (desktop+--dirname name)) 88 | (make-directory desktop-dirname 'parents) 89 | (desktop-save desktop-dirname) 90 | (desktop+--set-frame-title) 91 | (desktop-save-mode 1)) 92 | 93 | ;;;###autoload 94 | (defun desktop+-create-auto () 95 | "Create a new session, identified by the current working directory. 96 | The session is created in a subdirectory of `desktop+-base-dir'. 97 | It can afterwards be reloaded using `desktop+-load'." 98 | (interactive) 99 | (desktop+-create "")) 100 | 101 | ;;;###autoload 102 | (defun desktop+-load (name) 103 | "Load a session previously created using `desktop+-create'. 104 | NAME is the name which was given at session creation. When 105 | called interactively, it is asked in the minibuffer with 106 | auto-completion. 107 | 108 | As a special case, if NAME is left blank, the session is 109 | automatically named after the current working directory." 110 | (interactive 111 | (list 112 | (completing-read "Desktop name: " 113 | (remove "." 114 | (remove ".." 115 | (directory-files desktop+-base-dir)))))) 116 | (desktop-change-dir (desktop+--dirname name)) 117 | (desktop+--set-frame-title) 118 | (desktop-save-mode 1)) 119 | 120 | ;;;###autoload 121 | (defun desktop+-load-auto () 122 | "Load a session previously created using `desktop+-create-auto'. 123 | The session is identified by the current working directory." 124 | (interactive) 125 | (desktop+-load "")) 126 | 127 | ;; ** Inner workings 128 | 129 | (defun desktop+--dirname (name) 130 | "Path to the desktop identified by NAME. 131 | As a special case, if NAME is blank, the directory is identified 132 | by the current working directory. 133 | 134 | This path is located under `desktop+-base-dir'." 135 | (f-join desktop+-base-dir 136 | (if (string= "" name) 137 | (replace-regexp-in-string "/" "-" (f-canonical default-directory)) 138 | name))) 139 | 140 | (defun desktop+--frame-title (desktop-name) 141 | "Default frame title function for sessions. 142 | 143 | Returns the following frame title format: 144 | '%b - Emacs [DESKTOP-NAME]'" 145 | (list (concat "%b - Emacs [" desktop-name "]"))) 146 | 147 | 148 | (defun desktop+--set-frame-title () 149 | "Set the frame title to show the currently active session." 150 | (setq frame-title-format 151 | (funcall desktop+-frame-title-function 152 | (file-name-nondirectory (directory-file-name desktop-dirname))))) 153 | 154 | 155 | ;; * Special buffers 156 | 157 | ;; ** Customizable options 158 | 159 | (defvar desktop+-special-buffer-handlers 160 | '(term-mode 161 | compilation-mode 162 | org-agenda-mode 163 | indirect-buffer 164 | Man-mode 165 | shell-mode) 166 | "List of special buffers to handle.") 167 | 168 | ;; ** Entry point 169 | 170 | ;;;###autoload 171 | (defun desktop+--advice--desktop-save (&rest args) 172 | "Also save special buffers." 173 | (desktop+--buffers-save)) 174 | ;;;###autoload 175 | (advice-add 'desktop-save :before #'desktop+--advice--desktop-save) 176 | 177 | ;;;###autoload 178 | (defun desktop+--advice--desktop-restore-frameset (&rest args) 179 | "Restore special buffers." 180 | (desktop+--buffers-load)) 181 | ;;;###autoload 182 | (advice-add 'desktop-restore-frameset :before #'desktop+--advice--desktop-restore-frameset) 183 | 184 | ;; ** Mode-specific handlers for special buffers 185 | 186 | (defvar desktop+--special-buffer-handlers-alist nil 187 | "Alist of handlers for special buffers.") 188 | 189 | (defun desktop+-add-handler (name pred save-fn load-fn) 190 | "Add handlers for special buffers. 191 | 192 | NAME is a symbol identifying the handler for later activation or 193 | deactivation. 194 | 195 | PRED should be a unary function used as a predicate to determine 196 | whether a buffer should be handled specially. When called in a 197 | buffer which should be handled, PRED should return non-nil. 198 | 199 | SAVE-FN should be a function taking no parameter, returning a 200 | list of all relevant parameters for the current buffer, which is 201 | assumed to be in the given major mode. 202 | 203 | LOAD-FN should be a function of the following form: 204 | 205 | (lambda (name &rest args) ...) 206 | 207 | allowing to restore a buffer named NAME in major mode MODE, 208 | from information stored in ARGS, as determined by SAVE-FN." 209 | (declare (indent 1)) 210 | (push (list name pred save-fn load-fn) 211 | desktop+--special-buffer-handlers-alist)) 212 | 213 | ;; *** Terminals 214 | 215 | (defun desktop+--term-mode-hook () 216 | (setq desktop-save-buffer #'desktop+--terminal-save-buffer)) 217 | 218 | (defun desktop+--terminal-save-buffer (dirname) 219 | "Return relevant parameters for saving a terminal buffer." 220 | (list :dir default-directory 221 | :command (car (last (process-command 222 | (get-buffer-process (current-buffer))))))) 223 | 224 | (defun desktop+--terminal-restore-buffer (file-name buffer-name misc) 225 | "Restore a terminal buffer." 226 | (when (null (get-buffer buffer-name)) 227 | (let ((default-directory (plist-get misc :dir))) 228 | (with-current-buffer (term (plist-get misc :command)) 229 | (rename-buffer buffer-name) 230 | (current-buffer))))) 231 | 232 | (when (memq 'term-mode desktop+-special-buffer-handlers) 233 | (add-hook 'term-mode-hook 'desktop+--term-mode-hook) 234 | (add-to-list 'desktop-buffer-mode-handlers 235 | '(term-mode . desktop+--terminal-restore-buffer))) 236 | 237 | ;; *** Compilation buffers 238 | 239 | (defun desktop+--compilation-mode-hook () 240 | (setq desktop-save-buffer #'desktop+--compilation-save-buffer)) 241 | 242 | (defun desktop+--compilation-save-buffer (dirname) 243 | "Return relevant parameters for saving a compilation buffer." 244 | (list :command compilation-arguments 245 | :dir compilation-directory)) 246 | 247 | (defun desktop+--compilation-restore-buffer (file-name buffer-name misc) 248 | "Restore a compilation buffer." 249 | (with-current-buffer (get-buffer-create buffer-name) 250 | (compilation-mode) 251 | (set (make-local-variable 'compilation-arguments) (plist-get misc :command)) 252 | (set (make-local-variable 'compilation-directory) (plist-get misc :dir)) 253 | (current-buffer))) 254 | 255 | (when (memq 'compilation-mode desktop+-special-buffer-handlers) 256 | (add-hook 'compilation-mode-hook 'desktop+--compilation-mode-hook) 257 | (add-to-list 'desktop-buffer-mode-handlers 258 | '(compilation-mode . desktop+--compilation-restore-buffer))) 259 | 260 | ;; *** Org Agenda buffers 261 | 262 | (defun desktop+--org-agenda-mode-hook () 263 | (setq desktop-save-buffer #'desktop+--org-agenda-save-buffer)) 264 | 265 | (defun desktop+--org-agenda-save-buffer (dirname) 266 | "Return relevant parameters for saving an org agenda buffer." 267 | (list :dir default-directory 268 | :type org-agenda-type)) 269 | 270 | (defun desktop+--org-agenda-restore-buffer (file-name buffer-name misc) 271 | "Restore an org agenda buffer." 272 | (let ((default-directory (plist-get misc :dir))) 273 | (save-window-excursion 274 | (cond 275 | ((eq (plist-get misc :type) 'todo) 276 | (org-todo-list)) 277 | ((eq (plist-get misc :type) 'agenda) 278 | (org-agenda-list)) 279 | (t 280 | (error "unknown org-agenda-type"))) 281 | (rename-buffer buffer-name) 282 | (current-buffer)))) 283 | 284 | (when (memq 'org-agenda-mode desktop+-special-buffer-handlers) 285 | (add-hook 'org-agenda-mode-hook 'desktop+--org-agenda-mode-hook) 286 | (add-to-list 'desktop-buffer-mode-handlers 287 | '(org-agenda-mode . desktop+--org-agenda-restore-buffer))) 288 | 289 | ;; *** Clones (indirect buffers) 290 | 291 | (desktop+-add-handler 'indirect-buffer 292 | #'buffer-base-buffer 293 | 294 | (lambda () 295 | `(:base ,(buffer-name (buffer-base-buffer)))) 296 | 297 | (lambda (name &rest args) 298 | (with-current-buffer (get-buffer (plist-get args :base)) 299 | (clone-indirect-buffer name nil)))) 300 | 301 | ;; *** Man-mode buffers 302 | 303 | (defun desktop+--Man-mode-hook () 304 | (setq desktop-save-buffer #'desktop+--Man-save-buffer)) 305 | 306 | (defun desktop+--Man-save-buffer (dirname) 307 | "Return relevant parameters for saving a `Man-mode' buffer." 308 | (list :arguments Man-arguments)) 309 | 310 | (defun desktop+--Man-restore-buffer (file-name buffer-name misc) 311 | "Restore a `Man-mode' buffer." 312 | (with-current-buffer (man (plist-get misc :arguments)) 313 | (rename-buffer buffer-name))) 314 | 315 | (when (memq 'Man-mode desktop+-special-buffer-handlers) 316 | (add-hook 'Man-mode-hook 'desktop+--Man-mode-hook) 317 | (add-to-list 'desktop-buffer-mode-handlers 318 | '(Man-mode . desktop+--Man-restore-buffer))) 319 | 320 | ;; *** shell-mode 321 | 322 | (defun desktop+--shell-mode-hook () 323 | (setq desktop-save-buffer #'desktop+--shell-save-buffer)) 324 | 325 | (defun desktop+--shell-save-buffer (dirname) 326 | "Return relevant parameters for saving a `shell-mode' buffer. 327 | 328 | Currently, it saves and restores the current working directory. 329 | 330 | The text in the buffer, as well as environment variables, shell 331 | variables and other state are lost." 332 | (list :dir default-directory)) 333 | 334 | (defun desktop+--shell-restore-buffer (file-name buffer-name misc) 335 | "Restore a `shell-mode' buffer." 336 | (let* ((dir (plist-get misc :dir)) 337 | (default-directory (if (file-directory-p dir) dir "/"))) 338 | (with-current-buffer (shell) 339 | (rename-buffer buffer-name)))) 340 | 341 | (when (memq 'shell-mode desktop+-special-buffer-handlers) 342 | (add-hook 'shell-mode-hook 'desktop+--shell-mode-hook) 343 | (add-to-list 'desktop-buffer-mode-handlers 344 | '(shell-mode . desktop+--shell-restore-buffer))) 345 | 346 | ;; ** Inner workings 347 | 348 | (defun desktop+--buffers-file () 349 | "Name of the file where special buffers configuration will be saved." 350 | (f-join desktop-dirname ".emacs-buffers")) 351 | 352 | (defun desktop+--create-buffer (key name &rest args) 353 | "Recreate a special buffer from saved parameters. 354 | 355 | KEY identifies the special buffer type, as registered in 356 | `desktop+-special-buffer-handlers'. 357 | 358 | NAME is the name of the buffer. 359 | 360 | ARGS is the relevant buffer parameters, as determined by the 361 | registered save handler. These parameters will be restored by 362 | calling the load handler." 363 | (let ((handler (assq key desktop+--special-buffer-handlers-alist))) 364 | (when handler 365 | (apply (nth 3 handler) name args)))) 366 | 367 | (defun desktop+--buffers-save () 368 | "Persistently save special buffers. 369 | Information is kept in the file pointed to by `desktop+--buffers-file'." 370 | (with-temp-buffer 371 | (mapc (lambda (b) 372 | (let ((data 373 | (with-current-buffer b 374 | (let ((handler 375 | (--first 376 | (and (memq (nth 0 it) desktop+-special-buffer-handlers) 377 | (funcall (nth 1 it))) 378 | desktop+--special-buffer-handlers-alist))) 379 | (when handler 380 | (append `(desktop+--create-buffer 381 | (quote ,(nth 0 handler)) 382 | ,(buffer-name)) 383 | (funcall (nth 2 handler)))))))) 384 | (if data 385 | (pp data (current-buffer))))) 386 | (buffer-list)) 387 | (write-region nil nil (desktop+--buffers-file) nil 'quiet))) 388 | 389 | (defun desktop+--buffers-load () 390 | "Load special buffers from the persistent session file. 391 | Information is kept in the file pointed to by 392 | `desktop+-desktop+--buffers-file'." 393 | (when (file-exists-p (desktop+--buffers-file)) 394 | (load-file (desktop+--buffers-file)))) 395 | 396 | (provide 'desktop+) 397 | 398 | ;;; desktop+.el ends here 399 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------